@axa-fr/oidc-client 7.27.11 → 7.27.12

package/README.md

@@ -434,6 +434,36 @@ pnpm start
 
 ```
 
+## Service worker protocol
+
+The `postMessage` protocol used between `OidcClient` and the service worker
+is publicly documented and versioned. Typed message constants, payload
+helpers and storage key conventions are exported from
+`@axa-fr/oidc-client` (and from
+`@axa-fr/oidc-client-service-worker/protocol`):
+
+```ts
+import {
+  OidcClient,
+  PROTOCOL_VERSION,
+  ServiceWorkerMessageType,
+  buildSecuredTokenPlaceholder,
+  TOKEN_PLACEHOLDERS,
+} from '@axa-fr/oidc-client';
+
+const oidcClient = OidcClient.get();
+
+const { state } = await oidcClient.signalServiceWorker<{ state: string }>({
+  type: ServiceWorkerMessageType.GET_STATE,
+  configurationName: 'default',
+  data: null,
+});
+```
+
+See [`PROTOCOL.md`](../oidc-client-service-worker/PROTOCOL.md) in the
+service-worker package for the full specification, including stability
+guarantees and per-message payload shapes.
+
 ## How It Works
 
 This component is a pure vanilla JS OIDC client library agnostic to any framework.

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export type { ServiceWorkerSignalMessage, ServiceWorkerSignalOptions } from './initWorker.js';
+export { signalServiceWorkerAsync } from './initWorker.js';
 export type { ILOidcLocation } from './location.js';
 export { OidcLocation } from './location.js';
 export { getFetchDefault } from './oidc.js';
@@ -5,6 +7,8 @@ export type { OidcUserInfo } from './oidcClient.js';
 export { OidcClient } from './oidcClient.js';
 export type { Tokens } from './parseTokens.js';
 export { TokenRenewMode } from './parseTokens.js';
+export type { ServiceWorkerMessage, ServiceWorkerMessageTypeKey, ServiceWorkerMessageTypeValue, ServiceWorkerResponse, } from './protocol.js';
+export { buildDpopSecuredPlaceholder, buildSecuredTokenPlaceholder, buildStorageKey, DPOP_TOKEN_PLACEHOLDER_PREFIX, isServiceWorkerMessageType, PROTOCOL_VERSION, ServiceWorkerMessageType, STORAGE_KEY_PREFIX, SW_CONTROLLER_CHANGE_RELOAD_COUNT_KEY, TOKEN_PLACEHOLDERS, } from './protocol.js';
 export { getParseQueryStringFromLocation, getPath } from './route-utils';
 export type { AuthorityConfiguration, Fetch, OidcConfiguration, StringMap } from './types.js';
 export { TokenAutomaticRenewMode } from './types.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,OAAO,EAAE,+BAA+B,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACzE,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,YAAY,EAAE,0BAA0B,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAC9F,OAAO,EAAE,wBAAwB,EAAE,MAAM,iBAAiB,CAAC;AAC3D,YAAY,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AACpD,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,eAAe,EAAE,MAAM,WAAW,CAAC;AAC5C,YAAY,EAAE,YAAY,EAAE,MAAM,iBAAiB,CAAC;AACpD,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,YAAY,EAAE,MAAM,EAAE,MAAM,kBAAkB,CAAC;AAC/C,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAClD,YAAY,EACV,oBAAoB,EACpB,2BAA2B,EAC3B,6BAA6B,EAC7B,qBAAqB,GACtB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,2BAA2B,EAC3B,4BAA4B,EAC5B,eAAe,EACf,6BAA6B,EAC7B,0BAA0B,EAC1B,gBAAgB,EAChB,wBAAwB,EACxB,kBAAkB,EAClB,qCAAqC,EACrC,kBAAkB,GACnB,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,+BAA+B,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AACzE,YAAY,EAAE,sBAAsB,EAAE,KAAK,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAC9F,OAAO,EAAE,uBAAuB,EAAE,MAAM,YAAY,CAAC"}