@ahoo-wang/fetcher-react 3.4.6 → 3.5.1

package/dist/cosec/SecurityContext.d.ts

@@ -0,0 +1,80 @@
+import { UseSecurityReturn } from './useSecurity';
+import { ReactNode } from 'react';
+import { TokenStorage } from '@ahoo-wang/fetcher-cosec';
+/**
+ * Type alias for the security context value, which is the same as the return type of useSecurity hook.
+ * Provides access to current user information, authentication status, and authentication methods.
+ */
+export type SecurityContext = UseSecurityReturn;
+/**
+ * React context for managing authentication state across the component tree.
+ * This context provides a way to share authentication state and methods between components
+ * without prop drilling. It should be used with SecurityProvider to wrap the application.
+ */
+export declare const SecurityContext: import('react').Context<UseSecurityReturn | undefined>;
+/**
+ * Props for the SecurityProvider component.
+ */
+export interface SecurityContextOptions {
+    /**
+     * The token storage instance used to manage authentication tokens.
+     * This should be a valid TokenStorage implementation that handles token persistence and retrieval.
+     */
+    tokenStorage: TokenStorage;
+    /**
+     * The child components that will have access to the security context.
+     */
+    children: ReactNode;
+}
+/**
+ * Provider component that supplies authentication state and methods to its child components.
+ * This component wraps the application or a portion of it to provide access to authentication
+ * functionality through the useSecurityContext hook.
+ *
+ * @param tokenStorage - The token storage instance for managing authentication tokens.
+ * @param children - The child components that will have access to the security context.
+ * @returns A React element that provides the security context to its children.
+ * @throws {Error} May throw errors if tokenStorage operations fail during initialization.
+ * @example
+ * ```tsx
+ * import { SecurityProvider } from '@ahoo-wang/fetcher-react/cosec';
+ * import { tokenStorage } from './tokenStorage';
+ *
+ * function App() {
+ *   return (
+ *     <SecurityProvider tokenStorage={tokenStorage}>
+ *       <MyApp />
+ *     </SecurityProvider>
+ *   );
+ * }
+ * ```
+ */
+export declare function SecurityProvider({ tokenStorage, children, }: SecurityContextOptions): import("react/jsx-runtime").JSX.Element;
+/**
+ * Hook to access the security context within components wrapped by SecurityProvider.
+ * This hook provides reactive access to authentication state and methods throughout the component tree.
+ *
+ * @returns The security context containing currentUser, authenticated status, signIn, and signOut methods.
+ * @throws {Error} Throws an error if used outside of a SecurityProvider component.
+ * @example
+ * ```tsx
+ * import { useSecurityContext } from '@ahoo-wang/fetcher-react/cosec';
+ *
+ * function UserProfile() {
+ *   const { currentUser, authenticated, signOut } = useSecurityContext();
+ *
+ *   if (!authenticated) {
+ *     return <div>Please sign in</div>;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       <p>Welcome, {currentUser?.sub}!</p>
+ *       <button onClick={signOut}>Sign Out</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function useSecurityContext(): SecurityContext;
+//# sourceMappingURL=SecurityContext.d.ts.map

package/dist/cosec/SecurityContext.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SecurityContext.d.ts","sourceRoot":"","sources":["../../src/cosec/SecurityContext.tsx"],"names":[],"mappings":"AAaA,OAAO,EAAe,iBAAiB,EAAE,MAAM,eAAe,CAAC;AAC/D,OAAO,EAAiB,SAAS,EAAc,MAAM,OAAO,CAAC;AAC7D,OAAO,EAAE,YAAY,EAAE,MAAM,0BAA0B,CAAC;AAExD;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,iBAAiB,CAAC;AAEhD;;;;GAIG;AACH,eAAO,MAAM,eAAe,wDAE3B,CAAC;AAEF;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;;OAGG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;OAEG;IACH,QAAQ,EAAE,SAAS,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,wBAAgB,gBAAgB,CAAC,EAC/B,YAAY,EACZ,QAAQ,GACT,EAAE,sBAAsB,2CAOxB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,IAAI,eAAe,CAQpD"}

package/dist/cosec/index.d.ts

@@ -0,0 +1,3 @@
+export * from './SecurityContext';
+export * from './useSecurity';
+//# sourceMappingURL=index.d.ts.map

package/dist/cosec/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/cosec/index.ts"],"names":[],"mappings":"AAaA,cAAc,mBAAmB,CAAC;AAClC,cAAc,eAAe,CAAC"}

package/dist/cosec/useSecurity.d.ts

@@ -0,0 +1,65 @@
+import { TokenStorage, CompositeToken, CoSecJwtPayload } from '@ahoo-wang/fetcher-cosec';
+/**
+ * Return type for the useSecurity hook.
+ */
+export interface UseSecurityReturn {
+    /**
+     * The current authenticated user's JWT payload, or null if not authenticated.
+     * Contains user information extracted from the access token.
+     */
+    currentUser: CoSecJwtPayload | null;
+    /**
+     * Boolean indicating whether the user is currently authenticated.
+     * True if a valid token exists and the user is signed in, false otherwise.
+     */
+    authenticated: boolean;
+    /**
+     * Function to sign in with a composite token.
+     * @param compositeToken - The composite token containing access and refresh tokens.
+     */
+    signIn: (compositeToken: CompositeToken) => void;
+    /**
+     * Function to sign out the current user.
+     */
+    signOut: () => void;
+}
+/**
+ * Hook for managing authentication state and operations using CoSec tokens.
+ *
+ * This hook provides reactive access to the current user information, authentication status,
+ * and methods to sign in and sign out. It integrates with the TokenStorage to persist tokens
+ * and updates the state reactively when tokens change.
+ *
+ * @param tokenStorage - The token storage instance used to manage authentication tokens.
+ *                      This should be a valid TokenStorage implementation that handles
+ *                      token persistence and retrieval.
+ * @returns An object containing:
+ *          - currentUser: The current authenticated user's JWT payload, or null if not authenticated.
+ *          - authenticated: Boolean indicating whether the user is currently authenticated.
+ *          - signIn: Function to authenticate with a composite token.
+ *          - signOut: Function to sign out the current user.
+ * @throws {Error} May throw errors if tokenStorage operations fail, such as invalid tokens
+ *                 or storage access issues (implementation dependent).
+ * @example
+ * ```typescript
+ * import { useSecurity } from '@ahoo-wang/fetcher-react/cosec';
+ * import { tokenStorage } from './tokenStorage';
+ *
+ * function App() {
+ *   const { currentUser, authenticated, signIn, signOut } = useSecurity(tokenStorage);
+ *
+ *   if (!authenticated) {
+ *     return <button onClick={() => signIn(compositeToken)}>Sign In</button>;
+ *   }
+ *
+ *   return (
+ *     <div>
+ *       <p>Welcome, {currentUser?.sub}!</p>
+ *       <button onClick={signOut}>Sign Out</button>
+ *     </div>
+ *   );
+ * }
+ * ```
+ */
+export declare function useSecurity(tokenStorage: TokenStorage): UseSecurityReturn;
+//# sourceMappingURL=useSecurity.d.ts.map

package/dist/cosec/useSecurity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"useSecurity.d.ts","sourceRoot":"","sources":["../../src/cosec/useSecurity.ts"],"names":[],"mappings":"AAeA,OAAO,EACL,YAAY,EACZ,cAAc,EACd,eAAe,EAChB,MAAM,0BAA0B,CAAC;AAElC;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,WAAW,EAAE,eAAe,GAAG,IAAI,CAAC;IAEpC;;;OAGG;IACH,aAAa,EAAE,OAAO,CAAC;IAEvB;;;OAGG;IACH,MAAM,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,IAAI,CAAC;IAEjD;;OAEG;IACH,OAAO,EAAE,MAAM,IAAI,CAAC;CACrB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAqCG;AACH,wBAAgB,WAAW,CAAC,YAAY,EAAE,YAAY,GAAG,iBAAiB,CAezE"}

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from './core';
+export * from './cosec';
 export * from './storage';
 export * from './fetcher';
 export * from './wow';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,QAAQ,CAAC;AACvB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAaA,cAAc,QAAQ,CAAC;AACvB,cAAc,SAAS,CAAC;AACxB,cAAc,WAAW,CAAC;AAC1B,cAAc,WAAW,CAAC;AAC1B,cAAc,OAAO,CAAC;AACtB,cAAc,YAAY,CAAC"}