@okta/spa-platform 0.6.0 → 0.9.0

package/dist/types/orchestrators/HostOrchestrator/Host.d.ts

@@ -1,5 +1,13 @@
+/**
+ * @module
+ * @mergeModuleWith Orchestrators
+ */
 import type { HostOrchestrator as HO } from './index.ts';
 import { Token, EventEmitter, type Emitter, TokenOrchestrator } from '@okta/auth-foundation/core';
+/**
+ * Receives and fulfills delegated {@link AuthFoundation!Token | Token} requests from `HostOrchestrator.SubApp` instances
+ * @noNamespaceMerge
+ */
 export declare abstract class HostOrchestrator<E extends HO.HostEvents = HO.HostEvents> implements Emitter<E> {
     #private;
     protected readonly name: string;
@@ -12,10 +20,17 @@ export declare abstract class HostOrchestrator<E extends HO.HostEvents = HO.Host
     protected shouldActive(): boolean;
     activate(): void;
     close(): void;
+    /** @internal */
     protected parseRequest<K extends keyof HO.RequestEvent>(request: HO.RequestEvent[K], replyFn: any): Promise<any>;
+    /** @internal */
     protected handleHostActivated({ hostId }: HO.ActivatedEvent): void;
+    /** @internal */
     protected handleTokenRequest(event: HO.TokenRequest): Promise<HO.TokenResponse>;
+    /** @internal */
     protected handleAuthorizeRequest(event: HO.AuthorizeRequest): Promise<HO.AuthorizeResponse>;
+    /** @internal */
     protected handleProfileRequest(event: HO.TokenRequest): Promise<HO.ProfileResponse>;
+    protected handleInvalidateRequest(event: HO.InvalidateRequest): Promise<HO.InvalidateResponse>;
     abstract findToken(params: TokenOrchestrator.AuthorizeParams): Promise<Token | null | HO.ErrorResponse>;
+    abstract invalidateToken(tokenId: string): Promise<HO.InvalidateResponse>;
 }

package/dist/types/orchestrators/HostOrchestrator/OrchestrationBridge.d.ts

@@ -1,3 +1,7 @@
+/**
+ * @packageDocumentation
+ * @internal
+ */
 import type { HostOrchestrator } from './index.ts';
 import { TaskBridge } from '@okta/auth-foundation/core';
 export declare class OrchestrationBridge extends TaskBridge<HostOrchestrator.RequestEvent, HostOrchestrator.ResponseEvent> {

package/dist/types/orchestrators/HostOrchestrator/SubApp.d.ts

@@ -1,8 +1,18 @@
+/**
+ * @module
+ * @mergeModuleWith Orchestrators
+ */
 import type { HostOrchestrator as HO } from './index.ts';
 import { Token, TokenOrchestrator, EventEmitter } from '@okta/auth-foundation/core';
 export type SubAppBroadcastOptions = {
     timeout: number;
 };
+/**
+ * An implementation of {@link TokenOrchestrator} which delegates all token retrieval to a centralized broker,
+ * rather than acquiring tokens itself
+ *
+ * @overridePath orchestrators/HostOrchestrator/classes/SubApp.md
+ */
 export declare class SubAppOrchestrator<E extends HO.SubAppEvents = HO.SubAppEvents> extends TokenOrchestrator<E> {
     #private;
     readonly name: string;
@@ -20,10 +30,11 @@ export declare class SubAppOrchestrator<E extends HO.SubAppEvents = HO.SubAppEve
     }): Promise<boolean>;
     protected requestToken(params: TokenOrchestrator.AuthorizeParams): Promise<Token | null>;
     /**
-     * Retrieves a valid {@link Platform.Token | Token} to be used within an application
+     * Retrieves a valid {@link AuthFoundation!Token | Token} to be used within an application
      */
     getToken(params?: TokenOrchestrator.AuthorizeParams): Promise<Token | null>;
     authorize(input: string | URL | Request, init?: RequestInit & {
         dpopNonce?: string;
-    } & TokenOrchestrator.AuthorizeParams): Promise<Request>;
+    } & TokenOrchestrator.AuthorizeParams): ReturnType<TokenOrchestrator['authorize']>;
+    invalidateToken(id: string): Promise<void>;
 }

package/dist/types/orchestrators/HostOrchestrator/index.d.ts

@@ -1,42 +1,44 @@
 /**
  * @module
- * @mergeModuleWith TokenOrchestrators
+ * @mergeModuleWith Orchestrators
  */
 import { type TokenOrchestrator, type AcrValues, type JsonRecord, type TokenPrimitiveInit, Token } from '@okta/auth-foundation/core';
 import { HostOrchestrator as HostApp } from './Host.ts';
 import { SubAppOrchestrator } from './SubApp.ts';
+/**
+ * @overrideContent orchestrators/HostOrchestrator/doc.md
+ * @overridePath orchestrators/HostOrchestrator
+ */
 export declare namespace HostOrchestrator {
     /**
-     * Receives and fulfills delegated {@link Platform.Token | Token} requests from {@link HostOrchestrator.SubApp} instances
-     *
-     * @group Host
+     * @reexport
      */
-    abstract class Host<E extends HostEvents = HostEvents> extends HostApp<E> {
-    }
+    const Host: typeof HostApp;
+    type Host<E extends HostEvents = HostEvents> = InstanceType<typeof HostApp<E>>;
     /**
-     * A {@link AuthFoundation!TokenOrchestrator | TokenOrchestrator} instance which delegates all {@link Platform.Token | Token}
-     * requests to a {@link HostOrchestrator.Host}
-     *
-     * @group SubApp
+     * @reexport
      */
-    class SubApp<E extends SubAppEvents = SubAppEvents> extends SubAppOrchestrator<E> {
-    }
+    const SubApp: typeof SubAppOrchestrator;
+    type SubApp<E extends SubAppEvents = SubAppEvents> = InstanceType<typeof SubAppOrchestrator<E>>;
     /**
-     * A utility class to adapt any {@link AuthFoundation!TokenOrchestrator | TokenOrchestrator} instance into a {@link HostOrchestrator.Host}
+     * A utility class to adapt any {@link AuthFoundation!TokenOrchestrator | TokenOrchestrator} instance into a {@link HostOrchestrator}
      * @group ProxyHost
      */
     class ProxyHost<E extends HostEvents = HostEvents> extends HostOrchestrator.Host<E> {
         protected readonly orchestrator: Exclude<TokenOrchestrator, HostOrchestrator.SubApp>;
         constructor(name: string, orchestrator: Exclude<TokenOrchestrator, HostOrchestrator.SubApp>);
         findToken(params?: TokenOrchestrator.AuthorizeParams): Promise<Token | ErrorResponse>;
+        invalidateToken(tokenId: string): Promise<Partial<ErrorResponse>>;
     }
     /**
+     *
      * @group Host
      */
     type HostOptions = {
         allowedOrigins?: string[];
     };
     /**
+     * Map of events which can be emitted from {@link HostOrchestrator.emitter}
      * @group Host
      */
     type HostEvents = {
@@ -67,6 +69,7 @@ export declare namespace HostOrchestrator {
     } & TokenOrchestrator.Events;
     /**
      * @group Types
+     * @internal
      */
     type TokenRequestEventPayloads = {
         'TOKEN': TokenRequest;
@@ -74,9 +77,11 @@ export declare namespace HostOrchestrator {
         'PROFILE': TokenRequest;
     };
     /**
-     * @group Types
      * Payload for "host_activated" events.
      * Sent once a {@link HostOrchestrator.Host} instantiates. Used to detect multiple hosts
+     *
+     * @group Types
+     * @internal
      */
     type ActivatedEvent = {
         eventName: 'ACTIVATED';
@@ -85,6 +90,7 @@ export declare namespace HostOrchestrator {
     };
     /**
      * @group Types
+     * @internal
      */
     type PingEvent = {
         eventName: 'PING';
@@ -92,8 +98,19 @@ export declare namespace HostOrchestrator {
     };
     /**
      * @group Types
-     * Lose typing of the request event object structure. Provides slightly more type-safety than
+     */
+    type InvalidateEvent = {
+        eventName: 'INVALIDATE';
+        data: {
+            tokenId: string;
+        };
+    };
+    /**
+     * Loose typing of the request event object structure. Provides slightly more type-safety than
      * using `any` or `unknown` like most generic messaging APIs
+     *
+     * @group Types
+     * @internal
      */
     type RequestEvent = ({
         [K in keyof TokenRequestEventPayloads]: {
@@ -105,9 +122,11 @@ export declare namespace HostOrchestrator {
     } & {
         ACTIVATED: ActivatedEvent;
         PING: PingEvent;
+        INVALIDATE: InvalidateEvent;
     });
     /**
      * @group Types
+     * @internal
      */
     type TokenRequest = {
         issuer?: string;
@@ -118,15 +137,19 @@ export declare namespace HostOrchestrator {
     };
     /**
      * @group Types
+     * @internal
      */
     type AuthorizeRequest = TokenRequest & {
         url?: string;
         method?: string;
         nonce?: string;
     };
+    /** @group Types */
+    type InvalidateRequest = InvalidateEvent['data'];
     /**
-     * @group Types
      * Map of responses from a HostOrchestrator request event
+     * @group Types
+     * @internal
      */
     type ResponseEvent = {
         'TOKEN': TokenResponse;
@@ -134,37 +157,48 @@ export declare namespace HostOrchestrator {
         'PROFILE': ProfileResponse;
         'PING': PingResponse;
         'ACTIVATED': object;
+        'INVALIDATE': InvalidateResponse;
     };
     /**
      * @group Types
+     * @internal
      */
     type ErrorResponse = {
         error: string;
     };
     /**
      * @group Types
+     * @internal
      */
     type PingResponse = {
         message: 'PONG';
     };
     /**
      * @group Types
+     * @internal
      */
     type TokenResponse = {
         token: TokenPrimitiveInit;
     } | ErrorResponse;
     /**
      * @group Types
+     * @internal
      */
     type AuthorizeResponse = {
+        tokenId: string;
         tokenType: string;
         dpop?: string;
         authorization: string;
     } | ErrorResponse;
     /**
      * @group Types
+     * @internal
      */
     type ProfileResponse = {
         profile: JsonRecord;
     } | ErrorResponse;
+    /**
+     * @group Types
+     */
+    type InvalidateResponse = Partial<ErrorResponse>;
 }

package/dist/types/orchestrators/index.d.ts

@@ -1,5 +1,8 @@
 /**
- * @module TokenOrchestrators
+ * Browser-specific implementations of {@link AuthFoundation!TokenOrchestrator | TokenOrchestrator}.
+ *
+ * @module Orchestrators
+ * @overrideContent orchestrators/doc.md
  */
 export * from './AuthorizationCodeFlowOrchestrator.ts';
 export * from './HostOrchestrator/index.ts';

package/dist/types/platform/OAuth2Client.d.ts

@@ -1,13 +1,19 @@
 /**
- * @module
- * @mergeModuleWith Platform
+ * @packageDocumentation
+ * @internal
+ *
+ * Does not differ enough from base class to require further documentation
  */
 import { Token, OAuth2Client as OAuth2ClientBase, OAuth2ErrorResponse } from '@okta/auth-foundation/core';
 /**
  * Browser-specific implementation of {@link OAuth2Client}
  *
+ * @remarks
+ * Utilizies {@link SynchronizedResult} to prevent race conditions when using refresh tokens.
+ *
  * @group OAuth2Client
+ * @internal
  */
 export declare class OAuth2Client extends OAuth2ClientBase {
-    protected prepareRefreshRequest(token: Token, scopes?: string[]): Promise<Token | OAuth2ErrorResponse>;
+    protected sendRefreshRequest(request: Token.RefreshRequest, context: OAuth2ClientBase.TokenRequestContext): Promise<OAuth2ErrorResponse | Token>;
 }

package/dist/types/platform/defaults.d.ts

@@ -1,2 +1,10 @@
+/**
+ * @module
+ * @mergeModuleWith Platform
+ */
 import { type PlatformDependencies } from '@okta/auth-foundation/core';
+/**
+ * {@link AuthFoundation!PlatformDependencies | PlatformDependencies} implementations designed for browsers
+ *
+ */
 export declare const PlatformDefaults: PlatformDependencies;

package/dist/types/platform/index.d.ts

@@ -1,5 +1,11 @@
 /**
+ * > [!Tip]
+ * > See {@link AuthFoundation!Platform | Platform} explanation first.
+ *
+ * Provides browser-specific default implementations of
+ * {@link AuthFoundation!PlatformDependencies | PlatformDependencies}
  * @module Platform
+ * @see [SPA Platform: Platform](/api/spa-platform/#platform)
  */
 export * from './OAuth2Client.ts';
 /**

package/dist/types/utils/IndexedDBStore.d.ts

@@ -9,6 +9,7 @@
  */
 export declare class IndexedDBStore<T> {
     private readonly storeName;
+    static upgradeBlockedTimeoutMs: number;
     private readonly dbName;
     constructor(storeName: string);
     private keyStore;

package/dist/types/utils/SynchronizedResult.d.ts

@@ -4,8 +4,6 @@
  */
 export type SynchronizedResultOptions<T = any, R = any> = {
     timeout: number;
-    lockFreedDelay: number;
-    retries: number;
     seralizer?: (obj: T) => R;
     deseralizer?: (input: R) => T;
 };
@@ -24,12 +22,7 @@ export declare class SynchronizedResult<T, R = T> {
     private channel;
     private options;
     constructor(name: string, task: () => Promise<T>, options?: Partial<SynchronizedResultOptions<T, R>>);
-    private onResultFromOtherTab;
-    private onLockFreedPlusDelay;
-    private onTimeout;
-    private whenLockIsTaken;
-    private whenLockIsGranted;
-    exec(overrides?: Partial<SynchronizedResultOptions<T, R>>): Promise<T>;
+    exec(): Promise<T>;
     /**
      * Closes the underlying BroadcastChannel, useful for testing environments to avoid open handles
      *

package/dist/types/utils/isModernBrowser.d.ts

@@ -1,5 +1,6 @@
 /**
- * @module Utils
+ * @module
+ * @mergeModuleWith Platform
  */
 /**
  * Verifies the browser supports all features this library depends on

package/package.json

@@ -1 +1 @@
-{"name":"@okta/spa-platform","version":"0.6.0","type":"module","main":"dist/esm/index.js","module":"dist/esm/index.js","types":"dist/types/index.d.ts","license":"Apache-2.0","files":["./LICENSE","./dist","*.md","package.json"],"exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.js"},"./package.json":"./package.json"},"scripts":{"lint":"eslint --ext .js,.ts,.jsx .","build":"yarn build:esm && yarn build:types","build:watch":"yarn build:esm --watch & yarn build:types --watch","build:esm":"rollup -c","build:types":"tsc","test":"yarn test:unit","test:watch":"jest --watchAll","test:unit":"jest"},"dependencies":{},"peerDependencies":{"@okta/auth-foundation":"*","@okta/oauth2-flows":"*"},"peerDependenciesMeta":{"@okta/oauth2-flows":{"optional":true}},"devDependencies":{"@repo/eslint-config":"*","@repo/jest-helpers":"*","@repo/typescript-config":"*","@repo/rollup-config":"*","@okta/auth-foundation":"*","@okta/oauth2-flows":"*","eslint":"^8.56.0","jest":"^29.7.0","rollup":"^4.52.4","typescript":"^5.9.2"},"devEngines":{"runtime":{"name":"node","version":">=22.13.1","onFail":"warn"},"packageManager":{"name":"yarn","version":">=1.19.0","onFail":"warn"}},"okta":{"commitSha":"533d076fb5f59d4214751d8414be8f0f3adac2f5","fullVersion":"0.6.0-g533d076-g533d076"}}
+{"name":"@okta/spa-platform","version":"0.9.0","type":"module","main":"dist/esm/index.js","module":"dist/esm/index.js","types":"dist/types/index.d.ts","license":"Apache-2.0","files":["./LICENSE","./dist","*.md","package.json"],"exports":{".":{"types":"./dist/types/index.d.ts","import":"./dist/esm/index.js"},"./flows":{"types":"./dist/types/flows.d.ts","import":"./dist/esm/flows.js"},"./package.json":"./package.json"},"scripts":{"lint":"eslint --ext .js,.ts,.jsx .","build":"yarn build:esm && yarn build:types","build:watch":"yarn build:esm --watch & yarn build:types --watch","build:esm":"rollup -c","build:types":"tsc","test":"yarn test:unit","test:watch":"jest --watchAll","test:unit":"jest"},"dependencies":{},"peerDependencies":{"@okta/auth-foundation":"~0.9.*","@okta/oauth2-flows":"~0.9.*"},"peerDependenciesMeta":{"@okta/oauth2-flows":{"optional":true}},"devDependencies":{"@repo/eslint-config":"*","@repo/jest-helpers":"*","@repo/typescript-config":"*","@repo/rollup-config":"*","@okta/auth-foundation":"*","@okta/oauth2-flows":"*","eslint":"^8.56.0","fake-indexeddb":"^6.0.0","jest":"^29.7.0","rollup":"^4.52.4","typescript":"^5.9.2"},"devEngines":{"runtime":{"name":"node","version":">=22.13.1","onFail":"warn"},"packageManager":{"name":"yarn","version":">=1.19.0","onFail":"warn"}},"okta":{"commitSha":"a777274f98680847ae55a4d34a7101e07104c359","fullVersion":"0.9.0-ga777274-ga777274"}}