@civic/auth 0.6.0-beta.3 → 0.6.0

package/dist/shared/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "@civic/auth:0.6.0-beta.3";
+export declare const VERSION = "@civic/auth:0.6.0";
 //# sourceMappingURL=version.d.ts.map

package/dist/shared/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/shared/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,6BAA6B,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["../../src/shared/version.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,OAAO,sBAAsB,CAAC"}

package/dist/shared/version.js

@@ -1,3 +1,3 @@
 // This is an auto-generated file. Do not edit.
-export const VERSION = "@civic/auth:0.6.0-beta.3";
+export const VERSION = "@civic/auth:0.6.0";
 //# sourceMappingURL=version.js.map

package/dist/shared/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/shared/version.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAE/C,MAAM,CAAC,MAAM,OAAO,GAAG,0BAA0B,CAAC","sourcesContent":["// This is an auto-generated file. Do not edit.\n\nexport const VERSION = \"@civic/auth:0.6.0-beta.3\";\n"]}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["../../src/shared/version.ts"],"names":[],"mappings":"AAAA,+CAA+C;AAE/C,MAAM,CAAC,MAAM,OAAO,GAAG,mBAAmB,CAAC","sourcesContent":["// This is an auto-generated file. Do not edit.\n\nexport const VERSION = \"@civic/auth:0.6.0\";\n"]}

package/dist/vanillajs/auth/AuthenticationEvents.d.ts

@@ -0,0 +1,11 @@
+import type { AuthEvent } from "../types/index.js";
+export type AuthEventListener<T = unknown> = (payload?: T) => void;
+export declare class AuthenticationEvents {
+    private listeners;
+    private logger;
+    on<T>(event: AuthEvent, listener: AuthEventListener<T>): void;
+    off<T>(event: AuthEvent, listener: AuthEventListener<T>): void;
+    emit<T>(event: AuthEvent, payload?: T): void;
+    removeAllListeners(event?: AuthEvent): void;
+}
+//# sourceMappingURL=AuthenticationEvents.d.ts.map

package/dist/vanillajs/auth/AuthenticationEvents.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationEvents.d.ts","sourceRoot":"","sources":["../../../src/vanillajs/auth/AuthenticationEvents.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,mBAAmB,CAAC;AAGnD,MAAM,MAAM,iBAAiB,CAAC,CAAC,GAAG,OAAO,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,IAAI,CAAC;AAEnE,qBAAa,oBAAoB;IAC/B,OAAO,CAAC,SAAS,CAA2D;IAC5E,OAAO,CAAC,MAAM,CAAsB;IAEpC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI;IAO7D,GAAG,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,QAAQ,EAAE,iBAAiB,CAAC,CAAC,CAAC,GAAG,IAAI;IAU9D,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,SAAS,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,IAAI;IAY5C,kBAAkB,CAAC,KAAK,CAAC,EAAE,SAAS,GAAG,IAAI;CAO5C"}

package/dist/vanillajs/auth/AuthenticationEvents.js

@@ -0,0 +1,36 @@
+import { getCurrentLogger } from "../utils/logger.js";
+export class AuthenticationEvents {
+    listeners = new Map();
+    logger = getCurrentLogger();
+    on(event, listener) {
+        if (!this.listeners.has(event)) {
+            this.listeners.set(event, []);
+        }
+        this.listeners.get(event)?.push(listener);
+    }
+    off(event, listener) {
+        const eventListeners = this.listeners.get(event);
+        if (eventListeners) {
+            this.listeners.set(event, eventListeners.filter((l) => l !== listener));
+        }
+    }
+    emit(event, payload) {
+        this.listeners.get(event)?.forEach((listener) => {
+            try {
+                listener(payload);
+            }
+            catch (error) {
+                this.logger.error(`Error in event listener for ${event}:`, error);
+            }
+        });
+    }
+    removeAllListeners(event) {
+        if (event) {
+            this.listeners.delete(event);
+        }
+        else {
+            this.listeners.clear();
+        }
+    }
+}
+//# sourceMappingURL=AuthenticationEvents.js.map

package/dist/vanillajs/auth/AuthenticationEvents.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AuthenticationEvents.js","sourceRoot":"","sources":["../../../src/vanillajs/auth/AuthenticationEvents.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAItD,MAAM,OAAO,oBAAoB;IACvB,SAAS,GAAiD,IAAI,GAAG,EAAE,CAAC;IACpE,MAAM,GAAG,gBAAgB,EAAE,CAAC;IAEpC,EAAE,CAAI,KAAgB,EAAE,QAA8B;QACpD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,EAAE,CAAC;YAC/B,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;QAChC,CAAC;QACA,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAA4B,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IACxE,CAAC;IAED,GAAG,CAAI,KAAgB,EAAE,QAA8B;QACrD,MAAM,cAAc,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,cAAc,EAAE,CAAC;YACnB,IAAI,CAAC,SAAS,CAAC,GAAG,CAChB,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAC7C,CAAC;QACJ,CAAC;IACH,CAAC;IAED,IAAI,CAAI,KAAgB,EAAE,OAAW;QAClC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAA4B,EAAE,OAAO,CAC5D,CAAC,QAAQ,EAAE,EAAE;YACX,IAAI,CAAC;gBACH,QAAQ,CAAC,OAAO,CAAC,CAAC;YACpB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,+BAA+B,KAAK,GAAG,EAAE,KAAK,CAAC,CAAC;YACpE,CAAC;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED,kBAAkB,CAAC,KAAiB;QAClC,IAAI,KAAK,EAAE,CAAC;YACV,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QAC/B,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,CAAC;QACzB,CAAC;IACH,CAAC;CACF","sourcesContent":["import type { AuthEvent } from \"../types/index.js\";\nimport { getCurrentLogger } from \"../utils/logger.js\";\n\nexport type AuthEventListener<T = unknown> = (payload?: T) => void;\n\nexport class AuthenticationEvents {\n  private listeners: Map<AuthEvent, AuthEventListener<unknown>[]> = new Map();\n  private logger = getCurrentLogger();\n\n  on<T>(event: AuthEvent, listener: AuthEventListener<T>): void {\n    if (!this.listeners.has(event)) {\n      this.listeners.set(event, []);\n    }\n    (this.listeners.get(event) as AuthEventListener<T>[])?.push(listener);\n  }\n\n  off<T>(event: AuthEvent, listener: AuthEventListener<T>): void {\n    const eventListeners = this.listeners.get(event);\n    if (eventListeners) {\n      this.listeners.set(\n        event,\n        eventListeners.filter((l) => l !== listener),\n      );\n    }\n  }\n\n  emit<T>(event: AuthEvent, payload?: T): void {\n    (this.listeners.get(event) as AuthEventListener<T>[])?.forEach(\n      (listener) => {\n        try {\n          listener(payload);\n        } catch (error) {\n          this.logger.error(`Error in event listener for ${event}:`, error);\n        }\n      },\n    );\n  }\n\n  removeAllListeners(event?: AuthEvent): void {\n    if (event) {\n      this.listeners.delete(event);\n    } else {\n      this.listeners.clear();\n    }\n  }\n}\n"]}

package/dist/vanillajs/auth/CivicAuth.d.ts

@@ -0,0 +1,147 @@
+import type { AuthenticationEvents } from "./AuthenticationEvents.js";
+import { type StorageAdapter } from "../storage/StorageAdapter.js";
+import type { DisplayMode } from "../../types.js";
+import type { AuthResult } from "../types/index.js";
+/**
+ * Error codes for CivicAuth errors
+ */
+export declare enum CivicAuthErrorCode {
+    CONFIG_REQUIRED = "CONFIG_REQUIRED",
+    INIT_FAILED = "INIT_FAILED",
+    ENDPOINTS_NOT_INITIALIZED = "ENDPOINTS_NOT_INITIALIZED",
+    CONTAINER_NOT_FOUND = "CONTAINER_NOT_FOUND",
+    AUTH_PROCESS_TIMEOUT = "AUTH_PROCESS_TIMEOUT",
+    IFRAME_LOAD_ERROR = "IFRAME_LOAD_ERROR",
+    INVALID_MESSAGE = "INVALID_MESSAGE"
+}
+/**
+ * Configuration options for the CivicAuth client
+ */
+export interface CivicAuthClientConfig {
+    /** OAuth client ID */
+    clientId: string;
+    /** URL to redirect to after authentication */
+    redirectUrl: string;
+    /** Base URL of the OAuth server */
+    oauthServerBaseUrl: string;
+    /** Array of OAuth scopes to request */
+    scopes: string[];
+    /** HTML element or element ID where the auth iframe will be mounted */
+    targetContainerElement: HTMLElement | string;
+    /** Text signals for success and error states */
+    textSignals: {
+        /** Text to display on successful authentication */
+        success: string;
+        /** Optional text to display on authentication error */
+        error?: string;
+    };
+    /** Display mode for the authentication UI */
+    displayMode?: DisplayMode;
+    /**
+     * Timeout duration in milliseconds for the entire authentication process.
+     * If the authentication process takes longer than this duration, it will be cancelled
+     * and an error will be thrown.
+     */
+    authProcessTimeout?: number;
+    /** Event handlers for authentication events */
+    events?: AuthenticationEvents;
+    /** Custom ID for the auth iframe */
+    iframeId?: string;
+    /** Custom storage adapter for auth state */
+    storageAdapter?: StorageAdapter;
+    /** OAuth prompt parameter */
+    prompt?: string;
+    /** Initial state for OAuth flow */
+    initialState?: string;
+    /** Logging configuration */
+    logging?: LoggingConfig;
+}
+export interface LoggingConfig {
+    enabled: boolean;
+    namespace?: string;
+    level?: "debug" | "info" | "warn" | "error";
+}
+/**
+ * CivicAuth client for handling OAuth authentication
+ */
+export declare class CivicAuth {
+    private config;
+    private iframeElement?;
+    private observer?;
+    private authPromise?;
+    private authPromiseResolve?;
+    private authPromiseReject?;
+    private authProcessTimeoutHandle?;
+    private messageEventHandler?;
+    private storage;
+    private endpoints?;
+    private logger;
+    /**
+     * Private constructor for CivicAuth.
+     * Use {@link CivicAuth.create} to create a new instance.
+     * @param config - Configuration options for the auth client
+     * @throws {CivicAuthError} If required configuration is missing
+     * @private
+     */
+    private constructor();
+    /**
+     * Creates and initializes a new instance of CivicAuth.
+     * This is the recommended way to create a CivicAuth instance.
+     *
+     * @param config - Configuration options for the auth client
+     * @returns A promise that resolves with the initialized CivicAuth instance
+     * @throws {CivicAuthError} If initialization fails or required configuration is missing
+     *
+     * @example
+     * ```typescript
+     * const auth = await CivicAuth.create({
+     *   clientId: "your-client-id",
+     *   redirectUrl: "https://your-app.com/callback",
+     *   oauthServerBaseUrl: "https://auth-server.com/",
+     *   scopes: ["openid", "profile"],
+     *   targetContainerElement: "auth-container",
+     *   textSignals: {
+     *     success: "Authentication successful!"
+     *   }
+     * });
+     * ```
+     */
+    static create(config: CivicAuthClientConfig): Promise<CivicAuth>;
+    /**
+     * Initializes the auth client and checks for callback handling
+     * @throws {CivicAuthError} If initialization fails
+     */
+    private init;
+    /**
+     * Gets the container element for the auth iframe
+     * @returns The container element or null if not found
+     */
+    private getContainerElement;
+    /**
+     * Builds the authentication URL with PKCE challenge
+     * @returns The complete authentication URL
+     * @throws {CivicAuthError} If endpoints are not initialized
+     */
+    private buildAuthUrl;
+    private handleIframeMessage;
+    private logIncomingMessage;
+    private isValidMessageSource;
+    private handleValidMessage;
+    private handleAuthSuccess;
+    private handleAuthError;
+    private setupSignalObserver;
+    private handleNewTabAuth;
+    private handleIframeAuth;
+    /**
+     * Starts the authentication process
+     * @returns A promise that resolves with the authentication result
+     * @throws {CivicAuthError} If authentication fails or times out
+     */
+    startAuthentication(): Promise<AuthResult>;
+    /**
+     * Cleans up resources and event listeners
+     */
+    cleanup(): void;
+    private handleCallback;
+}
+//# sourceMappingURL=CivicAuth.d.ts.map

package/dist/vanillajs/auth/CivicAuth.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"CivicAuth.d.ts","sourceRoot":"","sources":["../../../src/vanillajs/auth/CivicAuth.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,oBAAoB,EAAE,MAAM,2BAA2B,CAAC;AACtE,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,8BAA8B,CAAC;AAGtC,OAAO,KAAK,EAAa,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAE7D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAUpD;;GAEG;AACH,oBAAY,kBAAkB;IAC5B,eAAe,oBAAoB;IACnC,WAAW,gBAAgB;IAC3B,yBAAyB,8BAA8B;IACvD,mBAAmB,wBAAwB;IAC3C,oBAAoB,yBAAyB;IAC7C,iBAAiB,sBAAsB;IACvC,eAAe,oBAAoB;CACpC;AAkCD;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC,sBAAsB;IACtB,QAAQ,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,CAAC;IAC3B,uCAAuC;IACvC,MAAM,EAAE,MAAM,EAAE,CAAC;IACjB,uEAAuE;IACvE,sBAAsB,EAAE,WAAW,GAAG,MAAM,CAAC;IAC7C,gDAAgD;IAChD,WAAW,EAAE;QACX,mDAAmD;QACnD,OAAO,EAAE,MAAM,CAAC;QAChB,uDAAuD;QACvD,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB,CAAC;IACF,6CAA6C;IAC7C,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B;;;;OAIG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,+CAA+C;IAC/C,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAC9B,oCAAoC;IACpC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,4CAA4C;IAC5C,cAAc,CAAC,EAAE,cAAc,CAAC;IAChC,6BAA6B;IAC7B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,4BAA4B;IAC5B,OAAO,CAAC,EAAE,aAAa,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,OAAO,CAAC;IACjB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,GAAG,MAAM,GAAG,OAAO,CAAC;CAC7C;AAED;;GAEG;AACH,qBAAa,SAAS;IACpB,OAAO,CAAC,MAAM,CAAwB;IACtC,OAAO,CAAC,aAAa,CAAC,CAAoB;IAC1C,OAAO,CAAC,QAAQ,CAAC,CAAmB;IACpC,OAAO,CAAC,WAAW,CAAC,CAAsB;IAC1C,OAAO,CAAC,kBAAkB,CAAC,CAA8B;IACzD,OAAO,CAAC,iBAAiB,CAAC,CAA2B;IACrD,OAAO,CAAC,wBAAwB,CAAC,CAAS;IAC1C,OAAO,CAAC,mBAAmB,CAAC,CAAgC;IAC5D,OAAO,CAAC,OAAO,CAAiB;IAChC,OAAO,CAAC,SAAS,CAAC,CAAY;IAC9B,OAAO,CAAC,MAAM,CAAkC;IAEhD;;;;;;OAMG;IACH,OAAO;IA0DP;;;;;;;;;;;;;;;;;;;;;OAqBG;WACiB,MAAM,CACxB,MAAM,EAAE,qBAAqB,GAC5B,OAAO,CAAC,SAAS,CAAC;IAMrB;;;OAGG;YACW,IAAI;IA4BlB;;;OAGG;IACH,OAAO,CAAC,mBAAmB;IAe3B;;;;OAIG;YACW,YAAY;IA4B1B,OAAO,CAAC,mBAAmB;IAW3B,OAAO,CAAC,kBAAkB;IAa1B,OAAO,CAAC,oBAAoB;IA0B5B,OAAO,CAAC,kBAAkB;IA2B1B,OAAO,CAAC,iBAAiB;IASzB,OAAO,CAAC,eAAe;IAcvB,OAAO,CAAC,mBAAmB;YAeb,gBAAgB;YAiBhB,gBAAgB;IAiH9B;;;;OAIG;IACG,mBAAmB,IAAI,OAAO,CAAC,UAAU,CAAC;IA0EhD;;OAEG;IACI,OAAO,IAAI,IAAI;YAgCR,cAAc;CA+C7B"}