@intra-mart/smartlime 1.5.0 → 2.0.0-dev.20241121

package/lib/_shared/renderTarget.d.ts

@@ -1,14 +1,14 @@
-type ForceRender = () => void;
-export declare const createRenderTarget: () => {
-    addEventListener: (callback: ForceRender) => void;
-    removeEventListener: (callback: ForceRender) => void;
-    dispatch: () => void;
+type ForceRender<T> = (args?: T) => void;
+export declare const createRenderTarget: <T = undefined>() => {
+    addEventListener: (callback: ForceRender<T>) => void;
+    removeEventListener: (callback: ForceRender<T>) => void;
+    dispatch: (args?: T | undefined) => void;
 };
-export type CreateRenderTarget = typeof createRenderTarget;
-export type RenderTarget = ReturnType<CreateRenderTarget>;
-export declare const useRenderTarget: () => {
-    addEventListener: (callback: ForceRender) => void;
-    removeEventListener: (callback: ForceRender) => void;
-    dispatch: () => void;
+export type CreateRenderTarget<T = undefined> = typeof createRenderTarget<T>;
+export type RenderTarget<T = undefined> = ReturnType<CreateRenderTarget<T>>;
+export declare const useRenderTarget: <T = undefined>() => {
+    addEventListener: (callback: ForceRender<T>) => void;
+    removeEventListener: (callback: ForceRender<T>) => void;
+    dispatch: (args?: T | undefined) => void;
 };
 export {};

package/lib/_shared/renderTarget.js

@@ -12,11 +12,11 @@ export const createRenderTarget = () => {
             }
         }
     };
-    const dispatch = () => {
+    const dispatch = (args) => {
         for (let i = 0, l = listenerList.length; i < l; i++) {
             const listener = listenerList[i];
             if (listener)
-                listener();
+                listener(args);
         }
     };
     return {

package/lib/packages/OAuth/Context.d.ts

@@ -1,6 +1,17 @@
 /// <reference types="react" />
-import { AuthState, StartAuthResult } from '.';
 import { RenderTarget } from '../../_shared/renderTarget';
+import { AuthSessionResult } from 'expo-auth-session';
+import { IMOAuthError } from './IMOAuthError';
+export type AuthState = 'initializing' | 'unauthorized' | 'authorized';
+export type StartAuthResult = {
+    readonly type: 'cancel' | 'dismiss' | 'opened' | 'locked' | 'error';
+    readonly detail: AuthSessionResult;
+} | {
+    readonly type: 'success';
+} | {
+    readonly type: 'exception';
+    readonly exceptionDetail: unknown;
+};
 export interface OAuthContext {
     getAuthState: () => AuthState;
     getToken: () => string | null;
@@ -10,5 +21,6 @@ export interface OAuthContext {
     startAuth: () => Promise<StartAuthResult>;
     tokenRenderTarget: RenderTarget;
     authStateRenderTarget: RenderTarget;
+    authErrorRenderTarget: RenderTarget<IMOAuthError>;
 }
 export declare const Context: import("react").Context<OAuthContext | null>;

package/lib/packages/OAuth/hooks/index.d.ts

@@ -3,3 +3,4 @@ export * from './useIMToken';
 export * from './useStartAuth';
 export * from './useAuthState';
 export * from './useAuthStateEffect';
+export * from './useAuthError';

package/lib/packages/OAuth/hooks/index.js

@@ -3,3 +3,4 @@ export * from './useIMToken';
 export * from './useStartAuth';
 export * from './useAuthState';
 export * from './useAuthStateEffect';
+export * from './useAuthError';

package/lib/packages/OAuth/hooks/useAuthError.d.ts

@@ -0,0 +1,2 @@
+import { IMOAuthError } from '../IMOAuthError';
+export declare const useAuthError: (callBack: (error?: IMOAuthError) => void) => void;

package/lib/packages/OAuth/hooks/useAuthError.js

@@ -0,0 +1,15 @@
+import { useContext, useEffect } from 'react';
+import { Context as DefaultContext } from '../Context';
+import { IMOAuthError } from '../IMOAuthError';
+export const useAuthError = (callBack) => {
+    const oauthContext = useContext(DefaultContext);
+    if (oauthContext == null) {
+        throw new IMOAuthError('useAuthError requires either a Context provide or an ancestor element with a IMOAuthProvider.');
+    }
+    useEffect(() => {
+        oauthContext.authErrorRenderTarget.addEventListener(callBack);
+        return () => {
+            oauthContext.authErrorRenderTarget.removeEventListener(callBack);
+        };
+    }, [callBack]);
+};

package/lib/packages/OAuth/hooks/useAuthState.d.ts

@@ -1,2 +1,2 @@
 import { Context as DefaultContext } from '../Context';
-export declare const useAuthState: (Context?: typeof DefaultContext) => import("..").AuthState;
+export declare const useAuthState: (Context?: typeof DefaultContext) => import("../Context").AuthState;

package/lib/packages/OAuth/hooks/useAuthStateEffect.d.ts

@@ -1,4 +1,4 @@
-import { AuthState } from '..';
+import { AuthState } from '../Context';
 /**
  * sugar syntax that sets the return value of "useAuthState" to the deps of "useEffect"
  * this may be deprecated in the future

package/lib/packages/OAuth/hooks/useStartAuth.d.ts

@@ -1,2 +1,2 @@
 import { Context as DefaultContext } from '../Context';
-export declare const useStartAuth: (Context?: typeof DefaultContext) => () => Promise<import("..").StartAuthResult>;
+export declare const useStartAuth: (Context?: typeof DefaultContext) => () => Promise<import("../Context").StartAuthResult>;

package/lib/packages/OAuth/index.d.ts

@@ -1,22 +1,13 @@
 /// <reference types="react" />
-import { AuthSessionResult, Prompt } from 'expo-auth-session';
+import * as SecureStore from 'expo-secure-store';
+import { Prompt } from 'expo-auth-session';
 import { Context as DefaultContext } from './Context';
-export type AuthState = 'initializing' | 'unauthorized' | 'authorized';
 export type TokenState = {
     baseUrl: string;
     accessToken: string;
     refreshToken?: string;
     expirationDate?: number;
 };
-export type StartAuthResult = {
-    readonly type: 'cancel' | 'dismiss' | 'opened' | 'locked' | 'error';
-    readonly detail: AuthSessionResult;
-} | {
-    readonly type: 'success';
-} | {
-    readonly type: 'exception';
-    readonly exceptionDetail: unknown;
-};
 export declare const IMPrompt: {
     readonly Login: Prompt.Login;
     readonly None: Prompt.None;
@@ -29,12 +20,16 @@ interface RequestConfig {
     state?: string;
     prompt?: Prompt.Login | Prompt.None;
 }
+interface SecureStoreConfig {
+    storeKey?: string;
+    keychainAccessible?: SecureStore.KeychainAccessibilityConstant;
+}
 interface IMOAuthProps {
     children: JSX.Element;
     requestConfig: RequestConfig;
     remainingTimeToRunRefresh?: number;
-    storageKey?: string;
+    secureStore?: SecureStoreConfig;
     oauthContext?: typeof DefaultContext;
 }
-export declare const IMOAuth: ({ children, requestConfig, remainingTimeToRunRefresh, storageKey, oauthContext, }: IMOAuthProps) => import("react").JSX.Element;
+export declare const IMOAuth: ({ children, requestConfig, remainingTimeToRunRefresh, secureStore, oauthContext, }: IMOAuthProps) => import("react").JSX.Element;
 export {};

package/lib/packages/OAuth/index.js

@@ -1,7 +1,7 @@
 import * as SecureStore from 'expo-secure-store';
 import { exchangeCodeAsync, loadAsync, Prompt, refreshAsync, } from 'expo-auth-session';
 import { useCallback, useLayoutEffect, useMemo, useRef, } from 'react';
-import { Context as DefaultContext } from './Context';
+import { Context as DefaultContext, } from './Context';
 import { IMOAuthError } from './IMOAuthError';
 import { useRenderTarget } from '../../_shared/renderTarget';
 import { useIMBaseUrl } from '../..';
@@ -51,10 +51,17 @@ const useDiscovery = () => {
         };
     }, [encodedBaseUrl]);
 };
-const useStorageKey = (storageKey) => {
+const useStoreConfig = (secureStore) => {
+    const storeKey = secureStore?.storeKey;
+    const keychainAccessible = secureStore?.keychainAccessible;
     return useMemo(() => {
-        return storageKey ? storageKey : DEFAULT_STORAGE_KEY;
-    }, [storageKey]);
+        return {
+            storeKey: storeKey ? storeKey : DEFAULT_STORAGE_KEY,
+            keychainAccessible: keychainAccessible !== void 0
+                ? keychainAccessible
+                : SecureStore.WHEN_UNLOCKED,
+        };
+    }, [storeKey, keychainAccessible]);
 };
 const useRemainingTimeToRunRefresh = (remainingTimeToRunRefresh) => {
     return useMemo(() => {
@@ -63,20 +70,26 @@ const useRemainingTimeToRunRefresh = (remainingTimeToRunRefresh) => {
             : DEFAULT_REMAINING_TIME_TO_RUN_REFRESH;
     }, [remainingTimeToRunRefresh]);
 };
-const saveTokenStorage = async (storageKey, baseUrl, accessToken, refreshToken, expirationDate) => {
+const saveTokenStorage = async (storeConfig, baseUrl, accessToken, refreshToken, expirationDate) => {
     const item = {
         baseUrl,
         accessToken,
         refreshToken,
         expirationDate,
     };
-    return await SecureStore.setItemAsync(storageKey, JSON.stringify(item));
+    return await SecureStore.setItemAsync(storeConfig.storeKey, JSON.stringify(item), {
+        keychainAccessible: storeConfig.keychainAccessible,
+    });
 };
-const deleteTokenStorage = async (tokenStorageKey) => {
-    return await SecureStore.deleteItemAsync(tokenStorageKey);
+const deleteTokenStorage = async (storeConfig) => {
+    return await SecureStore.deleteItemAsync(storeConfig.storeKey, {
+        keychainAccessible: storeConfig.keychainAccessible,
+    });
 };
-const getTokenStorage = async (storageKey) => {
-    const state = await SecureStore.getItemAsync(storageKey);
+const getTokenStorage = async (storeConfig) => {
+    const state = await SecureStore.getItemAsync(storeConfig.storeKey, {
+        keychainAccessible: storeConfig.keychainAccessible,
+    });
     if (state == null)
         return;
     const result = JSON.parse(state);
@@ -116,7 +129,7 @@ const checkExpirationDateOfToken = (expirationDate, remainingTimeToRunRefresh) =
         return true;
     return false;
 };
-const useRefresh = (storageKey, refreshTokenRef, expirationDateRef, requestConfig, discovery, setToken, destroy) => {
+const useRefresh = (storeConfig, refreshTokenRef, expirationDateRef, requestConfig, discovery, setToken, destroy) => {
     const baseUrl = useIMBaseUrl();
     const lockedRef = useRef(false);
     const waitingLineRef = useRef([]);
@@ -163,7 +176,7 @@ const useRefresh = (storageKey, refreshTokenRef, expirationDateRef, requestConfi
                 }, discovery);
                 const { accessToken, refreshToken, expiresIn } = tokenResponse;
                 const expirationDate = expiresIn ? createExpirationDate(expiresIn) : 0;
-                await saveTokenStorage(storageKey, baseUrl, accessToken, refreshToken, expirationDate);
+                await saveTokenStorage(storeConfig, baseUrl, accessToken, refreshToken, expirationDate);
                 refreshTokenRef.current = refreshToken ? refreshToken : null;
                 expirationDateRef.current = expirationDate;
                 setToken(accessToken);
@@ -178,36 +191,49 @@ const useRefresh = (storageKey, refreshTokenRef, expirationDateRef, requestConfi
                 throw error;
             }
         }
-    }, [storageKey, requestConfig, discovery, destroy]);
+    }, [storeConfig, requestConfig, discovery, destroy]);
 };
-const useStartAuth = (storageKey, remainingTimeToRunRefresh, refreshTokenRef, expirationDateRef, requestConfig, discovery, setToken, refresh, setAuthState) => {
+const useStartAuth = (storeConfig, remainingTimeToRunRefresh, refreshTokenRef, expirationDateRef, requestConfig, discovery, setToken, refresh, setAuthState, authErrorRenderTarget) => {
     const currentBaseUrl = useIMBaseUrl();
     useLayoutEffect(() => {
         (async () => {
-            const tokenState = await getTokenStorage(storageKey);
-            if (tokenState) {
-                const { baseUrl, accessToken, refreshToken, expirationDate } = tokenState;
-                const expired = checkExpirationDateOfToken(expirationDate ? expirationDate : 0, remainingTimeToRunRefresh);
-                refreshTokenRef.current = refreshToken ? refreshToken : null;
-                expirationDateRef.current = expirationDate ? expirationDate : null;
-                if (currentBaseUrl === baseUrl) {
-                    if (expired) {
-                        await refresh(); // NOTE consideration of how users can catch errors thrown here.
+            try {
+                const tokenState = await getTokenStorage(storeConfig);
+                if (tokenState) {
+                    const { baseUrl, accessToken, refreshToken, expirationDate } = tokenState;
+                    const expired = checkExpirationDateOfToken(expirationDate ? expirationDate : 0, remainingTimeToRunRefresh);
+                    refreshTokenRef.current = refreshToken ? refreshToken : null;
+                    expirationDateRef.current = expirationDate ? expirationDate : null;
+                    if (currentBaseUrl === baseUrl) {
+                        if (expired) {
+                            await refresh(); // NOTE consideration of how users can catch errors thrown here.
+                        }
+                        else {
+                            setToken(accessToken);
+                        }
+                        setAuthState('authorized');
                     }
                     else {
-                        setToken(accessToken);
+                        setAuthState('unauthorized');
                     }
-                    setAuthState('authorized');
                 }
                 else {
                     setAuthState('unauthorized');
                 }
             }
-            else {
+            catch (e) {
                 setAuthState('unauthorized');
+                authErrorRenderTarget.dispatch(new IMOAuthError('an exception occurred while checking the token state.', {
+                    cause: e,
+                }));
             }
         })();
-    }, [storageKey, remainingTimeToRunRefresh, refresh]);
+    }, [
+        storeConfig.storeKey,
+        storeConfig.keychainAccessible,
+        remainingTimeToRunRefresh,
+        refresh,
+    ]);
     const startAuth = useCallback(async () => {
         const authRequest = await loadAsync({
             ...requestConfig,
@@ -236,7 +262,7 @@ const useStartAuth = (storageKey, remainingTimeToRunRefresh, refreshTokenRef, ex
             }, discovery);
             const { accessToken, refreshToken, expiresIn } = tokenResponse;
             const expirationDate = expiresIn ? createExpirationDate(expiresIn) : 0;
-            await saveTokenStorage(storageKey, currentBaseUrl, accessToken, refreshToken, expirationDate);
+            await saveTokenStorage(storeConfig, currentBaseUrl, accessToken, refreshToken, expirationDate);
             refreshTokenRef.current = refreshToken ? refreshToken : null;
             expirationDateRef.current = expirationDate;
             setToken(accessToken);
@@ -256,14 +282,14 @@ const useStartAuth = (storageKey, remainingTimeToRunRefresh, refreshTokenRef, ex
     }, [requestConfig, discovery]);
     return startAuth;
 };
-const useDestroy = (storageKey, refreshTokenRef, expirationDateRef, setToken, setAuthState) => {
+const useDestroy = (storeConfig, refreshTokenRef, expirationDateRef, setToken, setAuthState) => {
     return useCallback(async () => {
-        await deleteTokenStorage(storageKey);
+        await deleteTokenStorage(storeConfig);
         setToken(null);
         refreshTokenRef.current = null;
         expirationDateRef.current = null;
         setAuthState('unauthorized');
-    }, [storageKey, setAuthState]);
+    }, [storeConfig, setAuthState]);
 };
 const useGetTokenAsync = (tokenRef, expirationDateRef, remainingTimeToRunRefresh, refresh) => {
     return useCallback(async () => {
@@ -276,7 +302,7 @@ const useGetTokenAsync = (tokenRef, expirationDateRef, remainingTimeToRunRefresh
         return tokenRef.current;
     }, [refresh]);
 };
-export const IMOAuth = ({ children, requestConfig, remainingTimeToRunRefresh, storageKey, oauthContext, }) => {
+export const IMOAuth = ({ children, requestConfig, remainingTimeToRunRefresh, secureStore, oauthContext, }) => {
     const Context = oauthContext || DefaultContext;
     const contextRef = useRef();
     const authStateRenderTarget = useRenderTarget();
@@ -285,13 +311,14 @@ export const IMOAuth = ({ children, requestConfig, remainingTimeToRunRefresh, st
     const [tokenRef, setToken, getToken] = useTokenRef(tokenRenderTarget);
     const refreshTokenRef = useRef(null);
     const expirationDateRef = useRef(null);
-    const _storageKey = useStorageKey(storageKey);
+    const storeConfig = useStoreConfig(secureStore);
     const _remainingTimeToRunRefresh = useRemainingTimeToRunRefresh(remainingTimeToRunRefresh);
     const _requestConfig = useRequestConfig(requestConfig);
     const _discovery = useDiscovery();
-    const destroy = useDestroy(_storageKey, refreshTokenRef, expirationDateRef, setToken, setAuthState);
-    const refresh = useRefresh(_storageKey, refreshTokenRef, expirationDateRef, _requestConfig, _discovery, setToken, destroy);
-    const startAuth = useStartAuth(_storageKey, _remainingTimeToRunRefresh, refreshTokenRef, expirationDateRef, _requestConfig, _discovery, setToken, refresh, setAuthState);
+    const authErrorRenderTarget = useRenderTarget();
+    const destroy = useDestroy(storeConfig, refreshTokenRef, expirationDateRef, setToken, setAuthState);
+    const refresh = useRefresh(storeConfig, refreshTokenRef, expirationDateRef, _requestConfig, _discovery, setToken, destroy);
+    const startAuth = useStartAuth(storeConfig, _remainingTimeToRunRefresh, refreshTokenRef, expirationDateRef, _requestConfig, _discovery, setToken, refresh, setAuthState, authErrorRenderTarget);
     const getTokenAsync = useGetTokenAsync(tokenRef, expirationDateRef, _remainingTimeToRunRefresh, refresh);
     contextRef.current = {
         getAuthState,
@@ -302,6 +329,7 @@ export const IMOAuth = ({ children, requestConfig, remainingTimeToRunRefresh, st
         startAuth,
         tokenRenderTarget,
         authStateRenderTarget,
+        authErrorRenderTarget,
     };
     return (<Context.Provider value={contextRef.current}>{children}</Context.Provider>);
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@intra-mart/smartlime",
   "description": "expoで使用できるintra mart accelplatform SDK",
-  "version": "1.5.0",
+  "version": "2.0.0-dev.20241121",
   "keywords": [
     "intra-mart",
     "AccelPlatform",