astro-tokenkit 1.0.17 → 1.0.18

package/dist/index.d.ts

@@ -176,6 +176,37 @@ interface RetryConfig {
     /** Initial delay in ms */
     delay?: number;
 }
+/**
+ * Idle timeout configuration
+ */
+interface IdleConfig {
+    /** Idle timeout in seconds */
+    timeout: number;
+    /**
+     * Callback when idle timeout is reached.
+     * NOTE: This function is only used if you manually initialize IdleManager.
+     * If using the Astro integration, use window.addEventListener('tk:idle', ...) instead.
+     */
+    onIdle?: () => void;
+    /** Whether to automatically logout on idle (default: true) */
+    autoLogout?: boolean;
+    /** Whether to monitor activity only on the active tab (default: true) */
+    activeTabOnly?: boolean;
+    /**
+     * Custom data to pass to the 'tk:idle' event.
+     * Ideal for configuring client-side alerts (e.g. SweetAlert).
+     */
+    alert?: AlertOptions | any;
+}
+/**
+ * Alert options for client-side notifications (e.g. SweetAlert)
+ */
+interface AlertOptions {
+    title?: string;
+    text?: string;
+    icon?: 'success' | 'error' | 'warning' | 'info' | 'question' | string;
+    [key: string]: any;
+}
 /**
  * Request interceptor
  */
@@ -212,7 +243,9 @@ interface ClientConfig {
     retry?: RetryConfig;
     /** Interceptors */
     interceptors?: InterceptorsConfig;
-    /** AsyncLocalStorage instance */
+    /** Idle timeout configuration */
+    idle?: IdleConfig;
+    /** AsyncLocalStorage instance (Node only) */
     context?: AsyncLocalStorage<any>;
     /** Custom context store getter */
     getContextStore?: () => TokenKitContext | undefined | null;
@@ -413,6 +446,13 @@ declare function createClient(config?: Partial<TokenKitConfig>): APIClient;
  * Astro integration for TokenKit
  *
  * This integration facilitates the setup of TokenKit in an Astro project.
+ * It performs the following:
+ * - Sets the global configuration for the API client.
+ * - Injects the configuration into the client-side via Vite's `define`.
+ * - Automatically registers the TokenKit middleware (unless `autoMiddleware` is set to `false`).
+ * - Injects a client-side script (`astro-tokenkit/client-init`) to handle idle session monitoring and automatic logout.
+ *
+ * @param config - TokenKit configuration options.
  *
  * @example
  * ```ts
@@ -426,6 +466,10 @@ declare function createClient(config?: Partial<TokenKitConfig>): APIClient;
  *       auth: {
  *         login: '/auth/login',
  *         refresh: '/auth/refresh',
+ *       },
+ *       idle: {
+ *         timeout: 3600, // 1 hour
+ *         alert: { title: 'Session Expired' }
  *       }
  *     })
  *   ]
@@ -434,7 +478,18 @@ declare function createClient(config?: Partial<TokenKitConfig>): APIClient;
  */
 declare function tokenKit(config: TokenKitConfig): AstroIntegration;
 /**
- * Helper to define middleware in a separate file if needed
+ * Helper to create the TokenKit middleware.
+ *
+ * Use this if you have `autoMiddleware: false` in your integration configuration
+ * and want to manually register the middleware in your `src/middleware.ts` file.
+ *
+ * @example
+ * ```ts
+ * // src/middleware.ts
+ * import { defineMiddleware } from 'astro-tokenkit';
+ *
+ * export const onRequest = defineMiddleware();
+ * ```
  */
 declare const defineMiddleware: () => astro.MiddlewareHandler;
 

package/dist/index.js

@@ -1225,7 +1225,7 @@ class APIClient {
                 throw new Error('Auth is not configured for this client');
             }
             const context = getContextStore();
-            return this.tokenManager.login(context, credentials, options);
+            return yield this.tokenManager.login(context, credentials, options);
         });
     }
     /**
@@ -1282,6 +1282,13 @@ function createClient(config) {
  * Astro integration for TokenKit
  *
  * This integration facilitates the setup of TokenKit in an Astro project.
+ * It performs the following:
+ * - Sets the global configuration for the API client.
+ * - Injects the configuration into the client-side via Vite's `define`.
+ * - Automatically registers the TokenKit middleware (unless `autoMiddleware` is set to `false`).
+ * - Injects a client-side script (`astro-tokenkit/client-init`) to handle idle session monitoring and automatic logout.
+ *
+ * @param config - TokenKit configuration options.
  *
  * @example
  * ```ts
@@ -1295,6 +1302,10 @@ function createClient(config) {
  *       auth: {
  *         login: '/auth/login',
  *         refresh: '/auth/refresh',
+ *       },
+ *       idle: {
+ *         timeout: 3600, // 1 hour
+ *         alert: { title: 'Session Expired' }
  *       }
  *     })
  *   ]
@@ -1312,7 +1323,7 @@ function tokenKit(config) {
     return {
         name: 'astro-tokenkit',
         hooks: {
-            'astro:config:setup': ({ updateConfig, addMiddleware }) => {
+            'astro:config:setup': ({ updateConfig, addMiddleware, injectScript }) => {
                 updateConfig({
                     vite: {
                         define: {
@@ -1327,13 +1338,26 @@ function tokenKit(config) {
                         order: 'pre'
                     });
                 }
+                // Always inject the client-side script for idle monitoring
+                injectScript('page', `import 'astro-tokenkit/client-init';`);
                 logger.debug('[TokenKit] Integration initialized');
             },
         },
     };
 }
 /**
- * Helper to define middleware in a separate file if needed
+ * Helper to create the TokenKit middleware.
+ *
+ * Use this if you have `autoMiddleware: false` in your integration configuration
+ * and want to manually register the middleware in your `src/middleware.ts` file.
+ *
+ * @example
+ * ```ts
+ * // src/middleware.ts
+ * import { defineMiddleware } from 'astro-tokenkit';
+ *
+ * export const onRequest = defineMiddleware();
+ * ```
  */
 const defineMiddleware = () => createMiddleware();