@icp-sdk/auth 8.0.2 → 9.0.0

package/dist/esm/client/storage.js

@@ -1,90 +0,0 @@
-import { IdbKeyVal } from './db.js';
-export const KEY_STORAGE_KEY = 'identity';
-export const KEY_STORAGE_DELEGATION = 'delegation';
-export const KEY_VECTOR = 'iv';
-// Increment if any fields are modified
-export const DB_VERSION = 1;
-/**
- * Legacy implementation of AuthClientStorage, for use where IndexedDb is not available
- */
-export class LocalStorage {
-    prefix;
-    _localStorage;
-    constructor(prefix = 'ic-', _localStorage) {
-        this.prefix = prefix;
-        this._localStorage = _localStorage;
-    }
-    get(key) {
-        return Promise.resolve(this._getLocalStorage().getItem(this.prefix + key));
-    }
-    set(key, value) {
-        this._getLocalStorage().setItem(this.prefix + key, value);
-        return Promise.resolve();
-    }
-    remove(key) {
-        this._getLocalStorage().removeItem(this.prefix + key);
-        return Promise.resolve();
-    }
-    _getLocalStorage() {
-        if (this._localStorage) {
-            return this._localStorage;
-        }
-        const ls = globalThis.localStorage;
-        if (!ls) {
-            throw new Error('Could not find local storage.');
-        }
-        return ls;
-    }
-}
-/**
- * IdbStorage is an interface for simple storage of string key-value pairs built on {@link IdbKeyVal}
- *
- * It replaces {@link LocalStorage}
- * @see implements {@link AuthClientStorage}
- */
-export class IdbStorage {
-    #options;
-    /**
-     * @param options - DBCreateOptions
-     * @param options.dbName - name for the indexeddb database
-     * @param options.storeName - name for the indexeddb Data Store
-     * @param options.version - version of the database. Increment to safely upgrade
-     * @example
-     * ```ts
-     * const storage = new IdbStorage({ dbName: 'my-db', storeName: 'my-store', version: 2 });
-     * ```
-     */
-    constructor(options) {
-        this.#options = options ?? {};
-    }
-    // Initializes a KeyVal on first request
-    initializedDb;
-    get _db() {
-        return new Promise((resolve, reject) => {
-            if (this.initializedDb) {
-                resolve(this.initializedDb);
-                return;
-            }
-            IdbKeyVal.create(this.#options)
-                .then((db) => {
-                this.initializedDb = db;
-                resolve(db);
-            })
-                .catch(reject);
-        });
-    }
-    async get(key) {
-        const db = await this._db;
-        return await db.get(key);
-        // return (await db.get<string>(key)) ?? null;
-    }
-    async set(key, value) {
-        const db = await this._db;
-        await db.set(key, value);
-    }
-    async remove(key) {
-        const db = await this._db;
-        await db.remove(key);
-    }
-}
-//# sourceMappingURL=storage.js.map

package/dist/esm/client/storage.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"storage.js","sourceRoot":"","sources":["../../../src/client/storage.ts"],"names":[],"mappings":"AAAA,OAAO,EAAwB,SAAS,EAAE,MAAM,SAAS,CAAC;AAE1D,MAAM,CAAC,MAAM,eAAe,GAAG,UAAU,CAAC;AAC1C,MAAM,CAAC,MAAM,sBAAsB,GAAG,YAAY,CAAC;AACnD,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,CAAC;AAC/B,uCAAuC;AACvC,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,CAAC;AAe5B;;GAEG;AACH,MAAM,OAAO,YAAY;IAEL;IACC;IAFnB,YACkB,SAAS,KAAK,EACb,aAAuB;QADxB,WAAM,GAAN,MAAM,CAAQ;QACb,kBAAa,GAAb,aAAa,CAAU;IACvC,CAAC;IAEG,GAAG,CAAC,GAAW;QACpB,OAAO,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC,CAAC;IAC7E,CAAC;IAEM,GAAG,CAAC,GAAW,EAAE,KAAa;QACnC,IAAI,CAAC,gBAAgB,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,EAAE,KAAK,CAAC,CAAC;QAC1D,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEM,MAAM,CAAC,GAAW;QACvB,IAAI,CAAC,gBAAgB,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,MAAM,GAAG,GAAG,CAAC,CAAC;QACtD,OAAO,OAAO,CAAC,OAAO,EAAE,CAAC;IAC3B,CAAC;IAEO,gBAAgB;QACtB,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;YACvB,OAAO,IAAI,CAAC,aAAa,CAAC;QAC5B,CAAC;QAED,MAAM,EAAE,GAAG,UAAU,CAAC,YAAY,CAAC;QACnC,IAAI,CAAC,EAAE,EAAE,CAAC;YACR,MAAM,IAAI,KAAK,CAAC,+BAA+B,CAAC,CAAC;QACnD,CAAC;QAED,OAAO,EAAE,CAAC;IACZ,CAAC;CACF;AAED;;;;;GAKG;AACH,MAAM,OAAO,UAAU;IACrB,QAAQ,CAAkB;IAE1B;;;;;;;;;OASG;IACH,YAAY,OAAyB;QACnC,IAAI,CAAC,QAAQ,GAAG,OAAO,IAAI,EAAE,CAAC;IAChC,CAAC;IAED,wCAAwC;IAChC,aAAa,CAAwB;IAC7C,IAAI,GAAG;QACL,OAAO,IAAI,OAAO,CAAC,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACrC,IAAI,IAAI,CAAC,aAAa,EAAE,CAAC;gBACvB,OAAO,CAAC,IAAI,CAAC,aAAa,CAAC,CAAC;gBAC5B,OAAO;YACT,CAAC;YACD,SAAS,CAAC,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC;iBAC5B,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE;gBACX,IAAI,CAAC,aAAa,GAAG,EAAE,CAAC;gBACxB,OAAO,CAAC,EAAE,CAAC,CAAC;YACd,CAAC,CAAC;iBACD,KAAK,CAAC,MAAM,CAAC,CAAC;QACnB,CAAC,CAAC,CAAC;IACL,CAAC;IAEM,KAAK,CAAC,GAAG,CAAa,GAAW;QACtC,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC;QAC1B,OAAO,MAAM,EAAE,CAAC,GAAG,CAAI,GAAG,CAAC,CAAC;QAC5B,8CAA8C;IAChD,CAAC;IAEM,KAAK,CAAC,GAAG,CAAa,GAAW,EAAE,KAAQ;QAChD,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC;QAC1B,MAAM,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;IAC3B,CAAC;IAEM,KAAK,CAAC,MAAM,CAAC,GAAW;QAC7B,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,GAAG,CAAC;QAC1B,MAAM,EAAE,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;IACvB,CAAC;CACF"}

package/src/client/idle-manager.ts

@@ -1,162 +0,0 @@
-type IdleCB = () => unknown;
-
-export type IdleManagerOptions = {
-  /**
-   * Callback after the user has gone idle
-   */
-  onIdle?: IdleCB;
-  /**
-   * timeout in ms
-   * @default 30 minutes [600_000]
-   */
-  idleTimeout?: number;
-  /**
-   * capture scroll events
-   * @default false
-   */
-  captureScroll?: boolean;
-  /**
-   * scroll debounce time in ms
-   * @default 100
-   */
-  scrollDebounce?: number;
-};
-
-const events = ['mousedown', 'mousemove', 'keydown', 'touchstart', 'wheel'];
-
-/**
- * Detects if the user has been idle for a duration of `idleTimeout` ms, and calls `onIdle` and registered callbacks.
- * By default, the IdleManager will log a user out after 10 minutes of inactivity.
- * To override these defaults, you can pass an `onIdle` callback, or configure a custom `idleTimeout` in milliseconds.
- *
- * IdleManager is a singleton: multiple calls to `create()` return the same instance,
- * registering any new `onIdle` callback. Call `exit()` to tear down the singleton.
- */
-export class IdleManager {
-  static #instance: IdleManager | undefined;
-
-  #callbacks: IdleCB[] = [];
-  #idleTimeout: number;
-  #timeoutID?: number = undefined;
-  #resetTimer: () => void;
-
-  /**
-   * Creates or returns the singleton {@link IdleManager}.
-   * If the instance already exists, any provided `onIdle` callback is registered
-   * on the existing instance.
-   * @param {IdleManagerOptions} options Optional configuration
-   * @see {@link IdleManagerOptions}
-   * @param options.onIdle Callback once user has been idle. Use to prompt for fresh sign-in, and use `Actor.agentOf(your_actor).invalidateIdentity()` to protect the user
-   * @param options.idleTimeout timeout in ms
-   * @param options.captureScroll capture scroll events
-   * @param options.scrollDebounce scroll debounce time in ms
-   */
-  public static create(
-    options: {
-      /**
-       * Callback after the user has gone idle
-       * @see {@link IdleCB}
-       */
-      onIdle?: () => unknown;
-      /**
-       * timeout in ms
-       * @default 10 minutes [600_000]
-       */
-      idleTimeout?: number;
-      /**
-       * capture scroll events
-       * @default false
-       */
-      captureScroll?: boolean;
-      /**
-       * scroll debounce time in ms
-       * @default 100
-       */
-      scrollDebounce?: number;
-    } = {},
-  ): IdleManager {
-    if (IdleManager.#instance) {
-      if (options.onIdle) {
-        IdleManager.#instance.registerCallback(options.onIdle);
-      }
-      return IdleManager.#instance;
-    }
-    const instance = new IdleManager(options);
-    IdleManager.#instance = instance;
-    return instance;
-  }
-
-  /**
-   * @param options {@link IdleManagerOptions}
-   */
-  private constructor(options: IdleManagerOptions = {}) {
-    const { onIdle, idleTimeout = 10 * 60 * 1000 } = options || {};
-
-    this.#callbacks = onIdle ? [onIdle] : [];
-    this.#idleTimeout = idleTimeout;
-
-    // Store the bound function once so the same reference is used
-    // for both addEventListener and removeEventListener.
-    this.#resetTimer = this._resetTimer.bind(this);
-
-    window.addEventListener('load', this.#resetTimer, true);
-
-    events.forEach((name) => {
-      document.addEventListener(name, this.#resetTimer, true);
-    });
-
-    const debounce = (func: (...args: unknown[]) => void, wait: number) => {
-      let timeout: number | undefined;
-      return (...args: unknown[]) => {
-        const context = this;
-        const later = () => {
-          timeout = undefined;
-          func.apply(context, args);
-        };
-        clearTimeout(timeout);
-        timeout = window.setTimeout(later, wait);
-      };
-    };
-
-    if (options?.captureScroll) {
-      // debounce scroll events
-      const scroll = debounce(this.#resetTimer, options?.scrollDebounce ?? 100);
-      window.addEventListener('scroll', scroll, true);
-    }
-
-    this.#resetTimer();
-  }
-
-  /**
-   * @param {IdleCB} callback function to be called when user goes idle
-   */
-  public registerCallback(callback: IdleCB): void {
-    this.#callbacks.push(callback);
-  }
-
-  /**
-   * Tears down listeners, fires all callbacks, and clears the singleton.
-   */
-  public exit(): void {
-    clearTimeout(this.#timeoutID);
-    window.removeEventListener('load', this.#resetTimer, true);
-
-    events.forEach((name) => {
-      document.removeEventListener(name, this.#resetTimer, true);
-    });
-    this.#callbacks.forEach((cb) => {
-      cb();
-    });
-
-    IdleManager.#instance = undefined;
-  }
-
-  /**
-   * Resets the timeouts during cleanup
-   */
-  private _resetTimer(): void {
-    const exit = this.exit.bind(this);
-    window.clearTimeout(this.#timeoutID);
-    this.#timeoutID = window.setTimeout(exit, this.#idleTimeout);
-  }
-}

package/src/client/storage.ts

@@ -1,114 +0,0 @@
-import { type DBCreateOptions, IdbKeyVal } from './db.js';
-
-export const KEY_STORAGE_KEY = 'identity';
-export const KEY_STORAGE_DELEGATION = 'delegation';
-export const KEY_VECTOR = 'iv';
-// Increment if any fields are modified
-export const DB_VERSION = 1;
-
-export type StoredKey = string | CryptoKeyPair;
-
-/**
- * Interface for persisting user authentication data
- */
-export interface AuthClientStorage {
-  get(key: string): Promise<StoredKey | null>;
-
-  set(key: string, value: StoredKey): Promise<void>;
-
-  remove(key: string): Promise<void>;
-}
-
-/**
- * Legacy implementation of AuthClientStorage, for use where IndexedDb is not available
- */
-export class LocalStorage implements AuthClientStorage {
-  constructor(
-    public readonly prefix = 'ic-',
-    private readonly _localStorage?: Storage,
-  ) {}
-
-  public get(key: string): Promise<string | null> {
-    return Promise.resolve(this._getLocalStorage().getItem(this.prefix + key));
-  }
-
-  public set(key: string, value: string): Promise<void> {
-    this._getLocalStorage().setItem(this.prefix + key, value);
-    return Promise.resolve();
-  }
-
-  public remove(key: string): Promise<void> {
-    this._getLocalStorage().removeItem(this.prefix + key);
-    return Promise.resolve();
-  }
-
-  private _getLocalStorage() {
-    if (this._localStorage) {
-      return this._localStorage;
-    }
-
-    const ls = globalThis.localStorage;
-    if (!ls) {
-      throw new Error('Could not find local storage.');
-    }
-
-    return ls;
-  }
-}
-
-/**
- * IdbStorage is an interface for simple storage of string key-value pairs built on {@link IdbKeyVal}
- *
- * It replaces {@link LocalStorage}
- * @see implements {@link AuthClientStorage}
- */
-export class IdbStorage implements AuthClientStorage {
-  #options: DBCreateOptions;
-
-  /**
-   * @param options - DBCreateOptions
-   * @param options.dbName - name for the indexeddb database
-   * @param options.storeName - name for the indexeddb Data Store
-   * @param options.version - version of the database. Increment to safely upgrade
-   * @example
-   * ```ts
-   * const storage = new IdbStorage({ dbName: 'my-db', storeName: 'my-store', version: 2 });
-   * ```
-   */
-  constructor(options?: DBCreateOptions) {
-    this.#options = options ?? {};
-  }
-
-  // Initializes a KeyVal on first request
-  private initializedDb: IdbKeyVal | undefined;
-  get _db(): Promise<IdbKeyVal> {
-    return new Promise((resolve, reject) => {
-      if (this.initializedDb) {
-        resolve(this.initializedDb);
-        return;
-      }
-      IdbKeyVal.create(this.#options)
-        .then((db) => {
-          this.initializedDb = db;
-          resolve(db);
-        })
-        .catch(reject);
-    });
-  }
-
-  public async get<T = string>(key: string): Promise<T | null> {
-    const db = await this._db;
-    return await db.get<T>(key);
-    // return (await db.get<string>(key)) ?? null;
-  }
-
-  public async set<T = string>(key: string, value: T): Promise<void> {
-    const db = await this._db;
-    await db.set(key, value);
-  }
-
-  public async remove(key: string): Promise<void> {
-    const db = await this._db;
-    await db.remove(key);
-  }
-}