@ahoo-wang/fetcher-cosec 0.9.0 → 0.9.2

package/dist/cosecRequestInterceptor.d.ts

@@ -1,9 +1,9 @@
 import { FetchExchange, Interceptor } from '@ahoo-wang/fetcher';
 import { CoSecOptions } from './types';
 /**
- * CoSec Request Interceptor
+ * Interceptor that automatically adds CoSec authentication headers to requests.
  *
- * Automatically adds CoSec authentication headers to requests:
+ * This interceptor adds the following headers to each request:
  * - CoSec-Device-Id: Device identifier (stored in localStorage or generated)
  * - CoSec-App-Id: Application identifier
  * - Authorization: Bearer token
@@ -21,7 +21,7 @@ export declare class CoSecRequestInterceptor implements Interceptor {
     private options;
     constructor(options: CoSecOptions);
     /**
-     * Intercept requests to add CoSec authentication headers
+     * Intercept requests to add CoSec authentication headers.
      *
      * This method adds the following headers to each request:
      * - CoSec-App-Id: The application identifier from the CoSec options
@@ -29,7 +29,7 @@ export declare class CoSecRequestInterceptor implements Interceptor {
      * - CoSec-Request-Id: A unique identifier for this specific request
      * - Authorization: Bearer token if available in token storage
      *
-     * @returns The modified exchange with CoSec authentication headers added
+     * @param exchange - The fetch exchange containing the request to process
      */
     intercept(exchange: FetchExchange): void;
 }

package/dist/cosecResponseInterceptor.d.ts

@@ -1,9 +1,7 @@
 import { CoSecOptions } from './types';
 import { FetchExchange, Interceptor } from '@ahoo-wang/fetcher';
 /**
- * CoSec Response Interceptor
- *
- * Handles automatic token refresh based on response codes
+ * Interceptor that handles automatic token refresh based on response codes.
  *
  * @remarks
  * This interceptor runs near the end of the response processing chain, just before
@@ -18,7 +16,7 @@ export declare class CoSecResponseInterceptor implements Interceptor {
     private options;
     constructor(options: CoSecOptions);
     /**
-     * Intercept responses to handle token refresh for unauthorized responses
+     * Intercept responses to handle token refresh for unauthorized responses.
      *
      * This method checks if a response has a 401 (UNAUTHORIZED) status code and attempts
      * to refresh the authentication token if one is available. If token refresh is successful,
@@ -26,7 +24,6 @@ export declare class CoSecResponseInterceptor implements Interceptor {
      * tokens are cleared and the original error is re-thrown.
      *
      * @param exchange - The fetch exchange containing the response to be processed
-     * @returns Promise<FetchExchange> The processed exchange, either with a refreshed token or original error
      * @throws Error if token refresh fails or other errors occur during processing
      */
     intercept(exchange: FetchExchange): Promise<void>;

package/dist/cosecResponseInterceptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cosecResponseInterceptor.d.ts","sourceRoot":"","sources":["../src/cosecResponseInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAiB,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;;;;;;;;;GAWG;AACH,qBAAa,wBAAyB,YAAW,WAAW;IAC1D,IAAI,SAA8B;IAClC,KAAK,SAAiC;IACtC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,EAAE,YAAY;IAIjC;;;;;;;;;;;OAWG;IACG,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAsBxD"}
+{"version":3,"file":"cosecResponseInterceptor.d.ts","sourceRoot":"","sources":["../src/cosecResponseInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,YAAY,EAAiB,MAAM,SAAS,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAEhE;;;;;;;;;GASG;AACH,qBAAa,wBAAyB,YAAW,WAAW;IAC1D,IAAI,SAA8B;IAClC,KAAK,SAAiC;IACtC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,EAAE,YAAY;IAIjC;;;;;;;;;;OAUG;IACG,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,IAAI,CAAC;CAsBxD"}

package/dist/deviceIdStorage.d.ts

@@ -1,29 +1,37 @@
 export declare const DEFAULT_COSEC_DEVICE_ID_KEY = "cosec-device-id";
 /**
- * Device ID storage class for managing device identifiers
+ * Storage class for managing device identifiers.
  */
 export declare class DeviceIdStorage {
     private readonly deviceIdKey;
     private storage;
     constructor(deviceIdKey?: string, storage?: Storage);
     /**
-     * Get the current device ID
+     * Get the current device ID.
+     *
+     * @returns The current device ID or null if not set
      */
     get(): string | null;
     /**
-     * Set a device ID
+     * Set a device ID.
+     *
+     * @param deviceId - The device ID to set
      */
     set(deviceId: string): void;
     /**
-     * Generate a new device ID
+     * Generate a new device ID.
+     *
+     * @returns A newly generated device ID
      */
     generateDeviceId(): string;
     /**
-     * Get or create a device ID
+     * Get or create a device ID.
+     *
+     * @returns The existing device ID if available, otherwise a newly generated one
      */
     getOrCreate(): string;
     /**
-     * Clear the stored device ID
+     * Clear the stored device ID.
      */
     clear(): void;
 }

package/dist/deviceIdStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"deviceIdStorage.d.ts","sourceRoot":"","sources":["../src/deviceIdStorage.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,2BAA2B,oBAAoB,CAAC;AAE7D;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,OAAO,CAAU;gBAGvB,WAAW,GAAE,MAAoC,EACjD,OAAO,GAAE,OAAsB;IAMjC;;OAEG;IACH,GAAG,IAAI,MAAM,GAAG,IAAI;IAIpB;;OAEG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI3B;;OAEG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;OAEG;IACH,WAAW,IAAI,MAAM;IAYrB;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd"}
+{"version":3,"file":"deviceIdStorage.d.ts","sourceRoot":"","sources":["../src/deviceIdStorage.ts"],"names":[],"mappings":"AAgBA,eAAO,MAAM,2BAA2B,oBAAoB,CAAC;AAE7D;;GAEG;AACH,qBAAa,eAAe;IAC1B,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAS;IACrC,OAAO,CAAC,OAAO,CAAU;gBAGvB,WAAW,GAAE,MAAoC,EACjD,OAAO,GAAE,OAAsB;IAMjC;;;;OAIG;IACH,GAAG,IAAI,MAAM,GAAG,IAAI;IAIpB;;;;OAIG;IACH,GAAG,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI;IAI3B;;;;OAIG;IACH,gBAAgB,IAAI,MAAM;IAI1B;;;;OAIG;IACH,WAAW,IAAI,MAAM;IAYrB;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd"}

package/dist/idGenerator.d.ts

@@ -2,12 +2,14 @@ export interface IdGenerator {
     generateId(): string;
 }
 /**
- * Nano ID implementation of IdGenerator
- * Generates unique request IDs using Nano ID
+ * Nano ID implementation of IdGenerator.
+ * Generates unique request IDs using Nano ID.
  */
 export declare class NanoIdGenerator implements IdGenerator {
     /**
-     * Generate a unique request ID
+     * Generate a unique request ID.
+     *
+     * @returns A unique request ID
      */
     generateId(): string;
 }

package/dist/idGenerator.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"idGenerator.d.ts","sourceRoot":"","sources":["../src/idGenerator.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,WAAW;IAC1B,UAAU,IAAI,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,eAAgB,YAAW,WAAW;IACjD;;OAEG;IACH,UAAU,IAAI,MAAM;CAGrB;AAED,eAAO,MAAM,WAAW,iBAAwB,CAAC"}
+{"version":3,"file":"idGenerator.d.ts","sourceRoot":"","sources":["../src/idGenerator.ts"],"names":[],"mappings":"AAeA,MAAM,WAAW,WAAW;IAC1B,UAAU,IAAI,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,qBAAa,eAAgB,YAAW,WAAW;IACjD;;;;OAIG;IACH,UAAU,IAAI,MAAM;CAGrB;AAED,eAAO,MAAM,WAAW,iBAAwB,CAAC"}

package/dist/inMemoryStorage.d.ts

@@ -1,5 +1,5 @@
 /**
- * In-memory storage fallback for environments without localStorage
+ * In-memory storage fallback for environments without localStorage.
  */
 export declare class InMemoryStorage implements Storage {
     private store;

package/dist/index.es.js

@@ -14,7 +14,9 @@ let d = (t = 21) => {
 };
 class l {
   /**
-   * Generate a unique request ID
+   * Generate a unique request ID.
+   *
+   * @returns A unique request ID
    */
   generateId() {
     return d();
@@ -26,7 +28,7 @@ class T {
     this.name = "CoSecRequestInterceptor", this.order = Number.MIN_SAFE_INTEGER + 1e3, this.options = e;
   }
   /**
-   * Intercept requests to add CoSec authentication headers
+   * Intercept requests to add CoSec authentication headers.
    *
    * This method adds the following headers to each request:
    * - CoSec-App-Id: The application identifier from the CoSec options
@@ -34,7 +36,7 @@ class T {
    * - CoSec-Request-Id: A unique identifier for this specific request
    * - Authorization: Bearer token if available in token storage
    *
-   * @returns The modified exchange with CoSec authentication headers added
+   * @param exchange - The fetch exchange containing the request to process
    */
   intercept(e) {
     const r = I.generateId(), n = this.options.deviceIdStorage.getOrCreate(), s = this.options.tokenStorage.get(), a = {
@@ -51,7 +53,7 @@ class D {
     this.name = "CoSecResponseInterceptor", this.order = Number.MAX_SAFE_INTEGER - 100, this.options = e;
   }
   /**
-   * Intercept responses to handle token refresh for unauthorized responses
+   * Intercept responses to handle token refresh for unauthorized responses.
    *
    * This method checks if a response has a 401 (UNAUTHORIZED) status code and attempts
    * to refresh the authentication token if one is available. If token refresh is successful,
@@ -59,7 +61,6 @@ class D {
    * tokens are cleared and the original error is re-thrown.
    *
    * @param exchange - The fetch exchange containing the response to be processed
-   * @returns Promise<FetchExchange> The processed exchange, either with a refreshed token or original error
    * @throws Error if token refresh fails or other errors occur during processing
    */
   async intercept(e) {
@@ -109,32 +110,40 @@ class y {
     this.deviceIdKey = e, this.storage = r;
   }
   /**
-   * Get the current device ID
+   * Get the current device ID.
+   *
+   * @returns The current device ID or null if not set
    */
   get() {
     return this.storage.getItem(this.deviceIdKey);
   }
   /**
-   * Set a device ID
+   * Set a device ID.
+   *
+   * @param deviceId - The device ID to set
    */
   set(e) {
     this.storage.setItem(this.deviceIdKey, e);
   }
   /**
-   * Generate a new device ID
+   * Generate a new device ID.
+   *
+   * @returns A newly generated device ID
    */
   generateDeviceId() {
     return I.generateId();
   }
   /**
-   * Get or create a device ID
+   * Get or create a device ID.
+   *
+   * @returns The existing device ID if available, otherwise a newly generated one
    */
   getOrCreate() {
     let e = this.get();
     return e || (e = this.generateDeviceId(), this.set(e)), e;
   }
   /**
-   * Clear the stored device ID
+   * Clear the stored device ID.
    */
   clear() {
     this.storage.removeItem(this.deviceIdKey);
@@ -146,21 +155,25 @@ class A {
     this.tokenKey = e, this.storage = r;
   }
   /**
-   * Get the current access token
+   * Get the current access token.
+   *
+   * @returns The current composite token or null if not set
    */
   get() {
     const e = this.storage.getItem(this.tokenKey);
     return e ? JSON.parse(e) : null;
   }
   /**
-   * Store a composite token
+   * Store a composite token.
+   *
+   * @param token - The composite token to store
    */
   set(e) {
     const r = JSON.stringify(e);
     this.storage.setItem(this.tokenKey, r);
   }
   /**
-   * Clear all tokens
+   * Clear all tokens.
    */
   clear() {
     this.storage.removeItem(this.tokenKey);

package/dist/tokenRefresher.d.ts

@@ -1,28 +1,31 @@
 /**
- * Access token interface
+ * Interface for access tokens.
  */
 export interface AccessToken {
     accessToken: string;
 }
 /**
- * Refresh token interface
+ * Interface for refresh tokens.
  */
 export interface RefreshToken {
     refreshToken: string;
 }
 /**
- * Composite token interface that contains both access and refresh tokens
- * accessToken and refreshToken always appear in pairs, no need to split them
+ * Composite token interface that contains both access and refresh tokens.
+ *
+ * accessToken and refreshToken always appear in pairs, no need to split them.
  */
 export interface CompositeToken extends AccessToken, RefreshToken {
 }
 /**
- * Token refresher interface
- * Provides a method to refresh tokens
+ * Interface for token refreshers.
+ *
+ * Provides a method to refresh tokens.
  */
 export interface TokenRefresher {
     /**
-     * Refresh the given token and return a new CompositeToken
+     * Refresh the given token and return a new CompositeToken.
+     *
      * @param token The token to refresh
      * @returns A Promise that resolves to a new CompositeToken
      */

package/dist/tokenRefresher.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokenRefresher.d.ts","sourceRoot":"","sources":["../src/tokenRefresher.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;GAGG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW,EAAE,YAAY;CAChE;AAED;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;OAIG;IACH,OAAO,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CACzD"}
+{"version":3,"file":"tokenRefresher.d.ts","sourceRoot":"","sources":["../src/tokenRefresher.ts"],"names":[],"mappings":"AAaA;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,WAAW,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,YAAY,EAAE,MAAM,CAAC;CACtB;AAED;;;;GAIG;AACH,MAAM,WAAW,cAAe,SAAQ,WAAW,EAAE,YAAY;CAAG;AAEpE;;;;GAIG;AACH,MAAM,WAAW,cAAc;IAC7B;;;;;OAKG;IACH,OAAO,CAAC,KAAK,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC,CAAC;CACzD"}

package/dist/tokenStorage.d.ts

@@ -1,22 +1,26 @@
 import { CompositeToken } from './tokenRefresher';
 export declare const DEFAULT_COSEC_TOKEN_KEY = "cosec-token";
 /**
- * Token storage class for managing access and refresh tokens
+ * Storage class for managing access and refresh tokens.
  */
 export declare class TokenStorage {
     private readonly tokenKey;
     private storage;
     constructor(tokenKey?: string, storage?: Storage);
     /**
-     * Get the current access token
+     * Get the current access token.
+     *
+     * @returns The current composite token or null if not set
      */
     get(): CompositeToken | null;
     /**
-     * Store a composite token
+     * Store a composite token.
+     *
+     * @param token - The composite token to store
      */
     set(token: CompositeToken): void;
     /**
-     * Clear all tokens
+     * Clear all tokens.
      */
     clear(): void;
 }

package/dist/tokenStorage.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"tokenStorage.d.ts","sourceRoot":"","sources":["../src/tokenStorage.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,eAAO,MAAM,uBAAuB,gBAAgB,CAAC;AAErD;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,OAAO,CAAU;gBAGvB,QAAQ,GAAE,MAAgC,EAC1C,OAAO,GAAE,OAAsB;IAMjC;;OAEG;IACH,GAAG,IAAI,cAAc,GAAG,IAAI;IAK5B;;OAEG;IACH,GAAG,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAKhC;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd"}
+{"version":3,"file":"tokenStorage.d.ts","sourceRoot":"","sources":["../src/tokenStorage.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD,eAAO,MAAM,uBAAuB,gBAAgB,CAAC;AAErD;;GAEG;AACH,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAS;IAClC,OAAO,CAAC,OAAO,CAAU;gBAGvB,QAAQ,GAAE,MAAgC,EAC1C,OAAO,GAAE,OAAsB;IAMjC;;;;OAIG;IACH,GAAG,IAAI,cAAc,GAAG,IAAI;IAK5B;;;;OAIG;IACH,GAAG,CAAC,KAAK,EAAE,cAAc,GAAG,IAAI;IAKhC;;OAEG;IACH,KAAK,IAAI,IAAI;CAGd"}

package/dist/types.d.ts

@@ -2,7 +2,7 @@ import { DeviceIdStorage } from './deviceIdStorage';
 import { TokenStorage } from './tokenStorage';
 import { TokenRefresher } from './tokenRefresher';
 /**
- * CoSec HTTP headers enumeration
+ * CoSec HTTP headers enumeration.
  */
 export declare enum CoSecHeaders {
     DEVICE_ID = "CoSec-Device-Id",
@@ -14,36 +14,37 @@ export declare enum ResponseCodes {
     UNAUTHORIZED = 401
 }
 /**
- * CoSec options interface
+ * CoSec options interface.
  */
 export interface CoSecOptions {
     /**
-     * Application ID to be sent in the CoSec-App-Id header
+     * Application ID to be sent in the CoSec-App-Id header.
      */
     appId: string;
     /**
-     * Device ID storage instance
+     * Device ID storage instance.
      */
     deviceIdStorage: DeviceIdStorage;
     /**
-     * Token storage instance
+     * Token storage instance.
      */
     tokenStorage: TokenStorage;
     /**
-     * Token refresher function
-     * Takes a CompositeToken and returns a Promise that resolves to a new CompositeToken
+     * Token refresher function.
+     *
+     * Takes a CompositeToken and returns a Promise that resolves to a new CompositeToken.
      */
     tokenRefresher: TokenRefresher;
 }
 /**
- * Authorization result interface
+ * Authorization result interface.
  */
 export interface AuthorizeResult {
     authorized: boolean;
     reason: string;
 }
 /**
- * Authorization result constants
+ * Authorization result constants.
  */
 export declare const AuthorizeResults: {
     ALLOW: {

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,oBAAY,YAAY;IACtB,SAAS,oBAAoB;IAC7B,MAAM,iBAAiB;IACvB,aAAa,kBAAkB;IAC/B,UAAU,qBAAqB;CAChC;AAED,oBAAY,aAAa;IACvB,YAAY,MAAM;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;OAGG;IACH,cAAc,EAAE,cAAc,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;CAM5B,CAAC"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAElD;;GAEG;AACH,oBAAY,YAAY;IACtB,SAAS,oBAAoB;IAC7B,MAAM,iBAAiB;IACvB,aAAa,kBAAkB;IAC/B,UAAU,qBAAqB;CAChC;AAED,oBAAY,aAAa;IACvB,YAAY,MAAM;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,eAAe,EAAE,eAAe,CAAC;IAEjC;;OAEG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;OAIG;IACH,cAAc,EAAE,cAAc,CAAC;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,UAAU,EAAE,OAAO,CAAC;IACpB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED;;GAEG;AACH,eAAO,MAAM,gBAAgB;;;;;;;;;;;;;;;;;;;;;CAM5B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ahoo-wang/fetcher-cosec",
-  "version": "0.9.0",
+  "version": "0.9.2",
   "description": "CoSec authentication integration for Fetcher HTTP client",
   "keywords": [
     "fetch",
@@ -35,7 +35,7 @@
   ],
   "dependencies": {
     "nanoid": "^5.1.5",
-    "@ahoo-wang/fetcher": "0.9.0"
+    "@ahoo-wang/fetcher": "0.9.2"
   },
   "devDependencies": {
     "@vitest/coverage-v8": "^3.2.4",