@ahoo-wang/fetcher-cosec 0.8.2 → 0.8.3

package/dist/cosecRequestInterceptor.d.ts

@@ -8,6 +8,12 @@ import { CoSecOptions } from './types';
  * - CoSec-App-Id: Application identifier
  * - Authorization: Bearer token
  * - CoSec-Request-Id: Unique request identifier for each request
+ *
+ * @remarks
+ * This interceptor runs after the basic request processing interceptors but before
+ * the actual HTTP request is made. The order is set to Number.MIN_SAFE_INTEGER + 1000
+ * to allow for other authentication or preprocessing interceptors to run earlier
+ * while ensuring it runs before FetchInterceptor.
  */
 export declare class CoSecRequestInterceptor implements Interceptor {
     name: string;
@@ -16,6 +22,15 @@ export declare class CoSecRequestInterceptor implements Interceptor {
     constructor(options: CoSecOptions);
     /**
      * 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
+     * - CoSec-Device-Id: A unique device identifier, either retrieved from storage or generated
+     * - CoSec-Request-Id: A unique identifier for this specific request
+     * - Authorization: Bearer token if available in token storage
+     *
+     * @param exchange - The fetch exchange containing the request to be processed
+     * @returns The modified exchange with CoSec authentication headers added
      */
     intercept(exchange: FetchExchange): FetchExchange;
 }

package/dist/cosecRequestInterceptor.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"cosecRequestInterceptor.d.ts","sourceRoot":"","sources":["../src/cosecRequestInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAkB,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAAgB,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrD;;;;;;;;GAQG;AACH,qBAAa,uBAAwB,YAAW,WAAW;IACzD,IAAI,SAA6B;IACjC,KAAK,SAA2B;IAChC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,EAAE,YAAY;IAIjC;;OAEG;IACH,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa;CAwBlD"}
+{"version":3,"file":"cosecRequestInterceptor.d.ts","sourceRoot":"","sources":["../src/cosecRequestInterceptor.ts"],"names":[],"mappings":"AAaA,OAAO,EAAkB,aAAa,EAAE,WAAW,EAAE,MAAM,oBAAoB,CAAC;AAChF,OAAO,EAAgB,YAAY,EAAE,MAAM,SAAS,CAAC;AAGrD;;;;;;;;;;;;;;GAcG;AACH,qBAAa,uBAAwB,YAAW,WAAW;IACzD,IAAI,SAA6B;IACjC,KAAK,SAAkC;IACvC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,EAAE,YAAY;IAIjC;;;;;;;;;;;OAWG;IACH,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,aAAa;CAwBlD"}

package/dist/cosecResponseInterceptor.d.ts

@@ -4,12 +4,31 @@ import { FetchExchange, Interceptor } from '@ahoo-wang/fetcher';
  * CoSec Response Interceptor
  *
  * Handles automatic token refresh based on response codes
+ *
+ * @remarks
+ * This interceptor runs near the end of the response processing chain, just before
+ * the final response is returned. The order is set to Number.MAX_SAFE_INTEGER - 100
+ * to ensure it runs after most other response interceptors but still allows for
+ * final processing interceptors to run afterward. This order aligns with other
+ * response enhancement interceptors like EventStreamInterceptor.
  */
 export declare class CoSecResponseInterceptor implements Interceptor {
     name: string;
     order: number;
     private options;
     constructor(options: CoSecOptions);
+    /**
+     * 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,
+     * the original request is retried with the new token. If token refresh fails, stored
+     * 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<FetchExchange>;
 }
 //# sourceMappingURL=cosecResponseInterceptor.d.ts.map

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;;;;GAIG;AACH,qBAAa,wBAAyB,YAAW,WAAW;IAC1D,IAAI,SAA8B;IAClC,KAAK,SAA2B;IAChC,OAAO,CAAC,OAAO,CAAe;gBAElB,OAAO,EAAE,YAAY;IAI3B,SAAS,CAAC,QAAQ,EAAE,aAAa,GAAG,OAAO,CAAC,aAAa,CAAC;CAsBjE"}
+{"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,aAAa,CAAC;CAsBjE"}

package/dist/index.es.js

@@ -23,10 +23,19 @@ class l {
 const I = new l();
 class T {
   constructor(e) {
-    this.name = "CoSecRequestInterceptor", this.order = Number.MIN_SAFE_INTEGER, this.options = e;
+    this.name = "CoSecRequestInterceptor", this.order = Number.MIN_SAFE_INTEGER + 1e3, this.options = e;
   }
   /**
    * 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
+   * - CoSec-Device-Id: A unique device identifier, either retrieved from storage or generated
+   * - CoSec-Request-Id: A unique identifier for this specific request
+   * - Authorization: Bearer token if available in token storage
+   *
+   * @param exchange - The fetch exchange containing the request to be processed
+   * @returns The modified exchange with CoSec authentication headers added
    */
   intercept(e) {
     const r = I.generateId(), n = this.options.deviceIdStorage.getOrCreate(), s = this.options.tokenStorage.get(), a = {
@@ -40,8 +49,20 @@ class T {
 }
 class D {
   constructor(e) {
-    this.name = "CoSecResponseInterceptor", this.order = Number.MAX_SAFE_INTEGER, this.options = e;
+    this.name = "CoSecResponseInterceptor", this.order = Number.MAX_SAFE_INTEGER - 100, this.options = e;
   }
+  /**
+   * 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,
+   * the original request is retried with the new token. If token refresh fails, stored
+   * 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) {
     const r = e.response;
     if (!r || r.status !== c.UNAUTHORIZED)

package/dist/index.umd.js

@@ -1 +1 @@
-(function(r,s){typeof exports=="object"&&typeof module<"u"?s(exports):typeof define=="function"&&define.amd?define(["exports"],s):(r=typeof globalThis<"u"?globalThis:r||self,s(r.FetcherCoSec={}))})(this,(function(r){"use strict";var s=(t=>(t.DEVICE_ID="CoSec-Device-Id",t.APP_ID="CoSec-App-Id",t.AUTHORIZATION="Authorization",t.REQUEST_ID="CoSec-Request-Id",t))(s||{}),c=(t=>(t[t.UNAUTHORIZED=401]="UNAUTHORIZED",t))(c||{});const g={ALLOW:{authorized:!0,reason:"Allow"},EXPLICIT_DENY:{authorized:!1,reason:"Explicit Deny"},IMPLICIT_DENY:{authorized:!1,reason:"Implicit Deny"},TOKEN_EXPIRED:{authorized:!1,reason:"Token Expired"},TOO_MANY_REQUESTS:{authorized:!1,reason:"Too Many Requests"}},T="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";let f=(t=21)=>{let e="",o=crypto.getRandomValues(new Uint8Array(t|=0));for(;t--;)e+=T[o[t]&63];return e};class d{generateId(){return f()}}const u=new d;class p{constructor(e){this.name="CoSecRequestInterceptor",this.order=Number.MIN_SAFE_INTEGER,this.options=e}intercept(e){const o=u.generateId(),i=this.options.deviceIdStorage.getOrCreate(),n=this.options.tokenStorage.get(),S={...e.request,headers:{...e.request.headers}},a=S.headers;return a[s.APP_ID]=this.options.appId,a[s.DEVICE_ID]=i,a[s.REQUEST_ID]=o,n&&(a[s.AUTHORIZATION]=`Bearer ${n.accessToken}`),e.request=S,e}}class D{constructor(e){this.name="CoSecResponseInterceptor",this.order=Number.MAX_SAFE_INTEGER,this.options=e}async intercept(e){const o=e.response;if(!o||o.status!==c.UNAUTHORIZED)return e;const i=this.options.tokenStorage.get();if(!i)return e;try{const n=await this.options.tokenRefresher.refresh(i);return this.options.tokenStorage.set(n),e.fetcher.request(e.url,e.request)}catch(n){throw this.options.tokenStorage.clear(),n}}}class h{constructor(){this.store=new Map}get length(){return this.store.size}clear(){this.store.clear()}getItem(e){const o=this.store.get(e);return o!==void 0?o:null}key(e){return Array.from(this.store.keys())[e]||null}removeItem(e){this.store.has(e)&&this.store.delete(e)}setItem(e,o){this.store.set(e,o)}}function I(){return typeof window<"u"&&window.localStorage?window.localStorage:new h}const l="cosec-device-id";class _{constructor(e=l,o=I()){this.deviceIdKey=e,this.storage=o}get(){return this.storage.getItem(this.deviceIdKey)}set(e){this.storage.setItem(this.deviceIdKey,e)}generateDeviceId(){return u.generateId()}getOrCreate(){let e=this.get();return e||(e=this.generateDeviceId(),this.set(e)),e}clear(){this.storage.removeItem(this.deviceIdKey)}}const E="cosec-token";class y{constructor(e=E,o=I()){this.tokenKey=e,this.storage=o}get(){const e=this.storage.getItem(this.tokenKey);return e?JSON.parse(e):null}set(e){const o=JSON.stringify(e);this.storage.setItem(this.tokenKey,o)}clear(){this.storage.removeItem(this.tokenKey)}}r.AuthorizeResults=g,r.CoSecHeaders=s,r.CoSecRequestInterceptor=p,r.CoSecResponseInterceptor=D,r.DEFAULT_COSEC_DEVICE_ID_KEY=l,r.DEFAULT_COSEC_TOKEN_KEY=E,r.DeviceIdStorage=_,r.InMemoryStorage=h,r.NanoIdGenerator=d,r.ResponseCodes=c,r.TokenStorage=y,r.getStorage=I,r.idGenerator=u,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})}));
+(function(r,s){typeof exports=="object"&&typeof module<"u"?s(exports):typeof define=="function"&&define.amd?define(["exports"],s):(r=typeof globalThis<"u"?globalThis:r||self,s(r.FetcherCoSec={}))})(this,(function(r){"use strict";var s=(t=>(t.DEVICE_ID="CoSec-Device-Id",t.APP_ID="CoSec-App-Id",t.AUTHORIZATION="Authorization",t.REQUEST_ID="CoSec-Request-Id",t))(s||{}),c=(t=>(t[t.UNAUTHORIZED=401]="UNAUTHORIZED",t))(c||{});const g={ALLOW:{authorized:!0,reason:"Allow"},EXPLICIT_DENY:{authorized:!1,reason:"Explicit Deny"},IMPLICIT_DENY:{authorized:!1,reason:"Implicit Deny"},TOKEN_EXPIRED:{authorized:!1,reason:"Token Expired"},TOO_MANY_REQUESTS:{authorized:!1,reason:"Too Many Requests"}},T="useandom-26T198340PX75pxJACKVERYMINDBUSHWOLF_GQZbfghjklqvwyzrict";let f=(t=21)=>{let e="",o=crypto.getRandomValues(new Uint8Array(t|=0));for(;t--;)e+=T[o[t]&63];return e};class d{generateId(){return f()}}const u=new d;class p{constructor(e){this.name="CoSecRequestInterceptor",this.order=Number.MIN_SAFE_INTEGER+1e3,this.options=e}intercept(e){const o=u.generateId(),i=this.options.deviceIdStorage.getOrCreate(),n=this.options.tokenStorage.get(),S={...e.request,headers:{...e.request.headers}},a=S.headers;return a[s.APP_ID]=this.options.appId,a[s.DEVICE_ID]=i,a[s.REQUEST_ID]=o,n&&(a[s.AUTHORIZATION]=`Bearer ${n.accessToken}`),e.request=S,e}}class D{constructor(e){this.name="CoSecResponseInterceptor",this.order=Number.MAX_SAFE_INTEGER-100,this.options=e}async intercept(e){const o=e.response;if(!o||o.status!==c.UNAUTHORIZED)return e;const i=this.options.tokenStorage.get();if(!i)return e;try{const n=await this.options.tokenRefresher.refresh(i);return this.options.tokenStorage.set(n),e.fetcher.request(e.url,e.request)}catch(n){throw this.options.tokenStorage.clear(),n}}}class h{constructor(){this.store=new Map}get length(){return this.store.size}clear(){this.store.clear()}getItem(e){const o=this.store.get(e);return o!==void 0?o:null}key(e){return Array.from(this.store.keys())[e]||null}removeItem(e){this.store.has(e)&&this.store.delete(e)}setItem(e,o){this.store.set(e,o)}}function I(){return typeof window<"u"&&window.localStorage?window.localStorage:new h}const l="cosec-device-id";class _{constructor(e=l,o=I()){this.deviceIdKey=e,this.storage=o}get(){return this.storage.getItem(this.deviceIdKey)}set(e){this.storage.setItem(this.deviceIdKey,e)}generateDeviceId(){return u.generateId()}getOrCreate(){let e=this.get();return e||(e=this.generateDeviceId(),this.set(e)),e}clear(){this.storage.removeItem(this.deviceIdKey)}}const E="cosec-token";class y{constructor(e=E,o=I()){this.tokenKey=e,this.storage=o}get(){const e=this.storage.getItem(this.tokenKey);return e?JSON.parse(e):null}set(e){const o=JSON.stringify(e);this.storage.setItem(this.tokenKey,o)}clear(){this.storage.removeItem(this.tokenKey)}}r.AuthorizeResults=g,r.CoSecHeaders=s,r.CoSecRequestInterceptor=p,r.CoSecResponseInterceptor=D,r.DEFAULT_COSEC_DEVICE_ID_KEY=l,r.DEFAULT_COSEC_TOKEN_KEY=E,r.DeviceIdStorage=_,r.InMemoryStorage=h,r.NanoIdGenerator=d,r.ResponseCodes=c,r.TokenStorage=y,r.getStorage=I,r.idGenerator=u,Object.defineProperty(r,Symbol.toStringTag,{value:"Module"})}));

package/package.json

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