@icp-sdk/auth 4.0.0-beta.1

package/dist/esm/client/db.js

@@ -0,0 +1,83 @@
+import { openDB } from "idb";
+import { DB_VERSION, KEY_STORAGE_DELEGATION, KEY_STORAGE_KEY } from "./storage.js";
+const AUTH_DB_NAME = "auth-client-db";
+const OBJECT_STORE_NAME = "ic-keyval";
+const _openDbStore = async (dbName = AUTH_DB_NAME, storeName = OBJECT_STORE_NAME, version) => {
+  if (localStorage?.getItem(KEY_STORAGE_DELEGATION)) {
+    localStorage.removeItem(KEY_STORAGE_DELEGATION);
+    localStorage.removeItem(KEY_STORAGE_KEY);
+  }
+  return await openDB(dbName, version, {
+    upgrade: (database) => {
+      if (database.objectStoreNames.contains(storeName)) {
+        database.clear(storeName);
+      }
+      database.createObjectStore(storeName);
+    }
+  });
+};
+async function _getValue(db, storeName, key) {
+  return await db.get(storeName, key);
+}
+async function _setValue(db, storeName, key, value) {
+  return await db.put(storeName, value, key);
+}
+async function _removeValue(db, storeName, key) {
+  return await db.delete(storeName, key);
+}
+class IdbKeyVal {
+  // Do not use - instead prefer create
+  constructor(_db, _storeName) {
+    this._db = _db;
+    this._storeName = _storeName;
+  }
+  /**
+   * @param {DBCreateOptions} options - DBCreateOptions
+   * @param {DBCreateOptions['dbName']} options.dbName name for the indexeddb database
+   * @default
+   * @param {DBCreateOptions['storeName']} options.storeName name for the indexeddb Data Store
+   * @default
+   * @param {DBCreateOptions['version']} options.version version of the database. Increment to safely upgrade
+   */
+  static async create(options) {
+    const {
+      dbName = AUTH_DB_NAME,
+      storeName = OBJECT_STORE_NAME,
+      version = DB_VERSION
+    } = options ?? {};
+    const db = await _openDbStore(dbName, storeName, version);
+    return new IdbKeyVal(db, storeName);
+  }
+  /**
+   * Basic setter
+   * @param {IDBValidKey} key string | number | Date | BufferSource | IDBValidKey[]
+   * @param value value to set
+   * @returns void
+   */
+  async set(key, value) {
+    return await _setValue(this._db, this._storeName, key, value);
+  }
+  /**
+   * Basic getter
+   * Pass in a type T for type safety if you know the type the value will have if it is found
+   * @param {IDBValidKey} key string | number | Date | BufferSource | IDBValidKey[]
+   * @returns `Promise<T | null>`
+   * @example
+   * await get<string>('exampleKey') -> 'exampleValue'
+   */
+  async get(key) {
+    return await _getValue(this._db, this._storeName, key) ?? null;
+  }
+  /**
+   * Remove a key
+   * @param key {@link IDBValidKey}
+   * @returns void
+   */
+  async remove(key) {
+    return await _removeValue(this._db, this._storeName, key);
+  }
+}
+export {
+  IdbKeyVal
+};
+//# sourceMappingURL=db.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"db.js","sources":["../../../src/client/db.ts"],"sourcesContent":["import { type IDBPDatabase, openDB } from 'idb';\nimport { DB_VERSION, KEY_STORAGE_DELEGATION, KEY_STORAGE_KEY } from './storage.ts';\n\ntype Database = IDBPDatabase<unknown>;\ntype IDBValidKey = string | number | Date | BufferSource | IDBValidKey[];\nconst AUTH_DB_NAME = 'auth-client-db';\nconst OBJECT_STORE_NAME = 'ic-keyval';\n\nconst _openDbStore = async (\n  dbName = AUTH_DB_NAME,\n  storeName = OBJECT_STORE_NAME,\n  version: number,\n) => {\n  // Clear legacy stored delegations\n  if (localStorage?.getItem(KEY_STORAGE_DELEGATION)) {\n    localStorage.removeItem(KEY_STORAGE_DELEGATION);\n    localStorage.removeItem(KEY_STORAGE_KEY);\n  }\n  return await openDB(dbName, version, {\n    upgrade: (database) => {\n      if (database.objectStoreNames.contains(storeName)) {\n        database.clear(storeName);\n      }\n      database.createObjectStore(storeName);\n    },\n  });\n};\n\nasync function _getValue<T>(\n  db: Database,\n  storeName: string,\n  key: IDBValidKey,\n): Promise<T | undefined> {\n  return await db.get(storeName, key);\n}\n\nasync function _setValue<T>(\n  db: Database,\n  storeName: string,\n  key: IDBValidKey,\n  value: T,\n): Promise<IDBValidKey> {\n  return await db.put(storeName, value, key);\n}\n\nasync function _removeValue(db: Database, storeName: string, key: IDBValidKey): Promise<void> {\n  return await db.delete(storeName, key);\n}\n\nexport type DBCreateOptions = {\n  dbName?: string;\n  storeName?: string;\n  version?: number;\n};\n\n/**\n * Simple Key Value store\n * Defaults to `'auth-client-db'` with an object store of `'ic-keyval'`\n */\nexport class IdbKeyVal {\n  /**\n   * @param {DBCreateOptions} options - DBCreateOptions\n   * @param {DBCreateOptions['dbName']} options.dbName name for the indexeddb database\n   * @default\n   * @param {DBCreateOptions['storeName']} options.storeName name for the indexeddb Data Store\n   * @default\n   * @param {DBCreateOptions['version']} options.version version of the database. Increment to safely upgrade\n   */\n  public static async create(options?: DBCreateOptions): Promise<IdbKeyVal> {\n    const {\n      dbName = AUTH_DB_NAME,\n      storeName = OBJECT_STORE_NAME,\n      version = DB_VERSION,\n    } = options ?? {};\n    const db = await _openDbStore(dbName, storeName, version);\n    return new IdbKeyVal(db, storeName);\n  }\n\n  // Do not use - instead prefer create\n  private constructor(\n    private _db: Database,\n    private _storeName: string,\n  ) {}\n\n  /**\n   * Basic setter\n   * @param {IDBValidKey} key string | number | Date | BufferSource | IDBValidKey[]\n   * @param value value to set\n   * @returns void\n   */\n  public async set<T>(key: IDBValidKey, value: T) {\n    return await _setValue<T>(this._db, this._storeName, key, value);\n  }\n  /**\n   * Basic getter\n   * Pass in a type T for type safety if you know the type the value will have if it is found\n   * @param {IDBValidKey} key string | number | Date | BufferSource | IDBValidKey[]\n   * @returns `Promise<T | null>`\n   * @example\n   * await get<string>('exampleKey') -> 'exampleValue'\n   */\n  public async get<T>(key: IDBValidKey): Promise<T | null> {\n    return (await _getValue<T>(this._db, this._storeName, key)) ?? null;\n  }\n\n  /**\n   * Remove a key\n   * @param key {@link IDBValidKey}\n   * @returns void\n   */\n  public async remove(key: IDBValidKey) {\n    return await _removeValue(this._db, this._storeName, key);\n  }\n}\n"],"names":[],"mappings":";;AAKA,MAAM,eAAe;AACrB,MAAM,oBAAoB;AAE1B,MAAM,eAAe,OACnB,SAAS,cACT,YAAY,mBACZ,YACG;AAEH,MAAI,cAAc,QAAQ,sBAAsB,GAAG;AACjD,iBAAa,WAAW,sBAAsB;AAC9C,iBAAa,WAAW,eAAe;AAAA,EACzC;AACA,SAAO,MAAM,OAAO,QAAQ,SAAS;AAAA,IACnC,SAAS,CAAC,aAAa;AACrB,UAAI,SAAS,iBAAiB,SAAS,SAAS,GAAG;AACjD,iBAAS,MAAM,SAAS;AAAA,MAC1B;AACA,eAAS,kBAAkB,SAAS;AAAA,IACtC;AAAA,EAAA,CACD;AACH;AAEA,eAAe,UACb,IACA,WACA,KACwB;AACxB,SAAO,MAAM,GAAG,IAAI,WAAW,GAAG;AACpC;AAEA,eAAe,UACb,IACA,WACA,KACA,OACsB;AACtB,SAAO,MAAM,GAAG,IAAI,WAAW,OAAO,GAAG;AAC3C;AAEA,eAAe,aAAa,IAAc,WAAmB,KAAiC;AAC5F,SAAO,MAAM,GAAG,OAAO,WAAW,GAAG;AACvC;AAYO,MAAM,UAAU;AAAA;AAAA,EAoBb,YACE,KACA,YACR;AAFQ,SAAA,MAAA;AACA,SAAA,aAAA;AAAA,EACP;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAdH,aAAoB,OAAO,SAA+C;AACxE,UAAM;AAAA,MACJ,SAAS;AAAA,MACT,YAAY;AAAA,MACZ,UAAU;AAAA,IAAA,IACR,WAAW,CAAA;AACf,UAAM,KAAK,MAAM,aAAa,QAAQ,WAAW,OAAO;AACxD,WAAO,IAAI,UAAU,IAAI,SAAS;AAAA,EACpC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAcA,MAAa,IAAO,KAAkB,OAAU;AAC9C,WAAO,MAAM,UAAa,KAAK,KAAK,KAAK,YAAY,KAAK,KAAK;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAa,IAAO,KAAqC;AACvD,WAAQ,MAAM,UAAa,KAAK,KAAK,KAAK,YAAY,GAAG,KAAM;AAAA,EACjE;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAOA,MAAa,OAAO,KAAkB;AACpC,WAAO,MAAM,aAAa,KAAK,KAAK,KAAK,YAAY,GAAG;AAAA,EAC1D;AACF;"}

package/dist/esm/client/idle-manager.d.ts

@@ -0,0 +1,81 @@
+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;
+};
+/**
+ * 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
+ */
+export declare class IdleManager {
+    callbacks: IdleCB[];
+    idleTimeout: IdleManagerOptions['idleTimeout'];
+    timeoutID?: number;
+    /**
+     * Creates an {@link IdleManager}
+     * @param {IdleManagerOptions} options Optional configuration
+     * @see {@link IdleManagerOptions}
+     * @param options.onIdle Callback once user has been idle. Use to prompt for fresh login, 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
+     */
+    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;
+    /**
+     * @protected
+     * @param options {@link IdleManagerOptions}
+     */
+    protected constructor(options?: IdleManagerOptions);
+    /**
+     * @param {IdleCB} callback function to be called when user goes idle
+     */
+    registerCallback(callback: IdleCB): void;
+    /**
+     * Cleans up the idle manager and its listeners
+     */
+    exit(): void;
+    /**
+     * Resets the timeouts during cleanup
+     */
+    _resetTimer(): void;
+}
+export {};

package/dist/esm/client/idle-manager.js

@@ -0,0 +1,81 @@
+const events = ["mousedown", "mousemove", "keydown", "touchstart", "wheel"];
+class IdleManager {
+  callbacks = [];
+  idleTimeout = 10 * 60 * 1e3;
+  timeoutID = void 0;
+  /**
+   * Creates an {@link IdleManager}
+   * @param {IdleManagerOptions} options Optional configuration
+   * @see {@link IdleManagerOptions}
+   * @param options.onIdle Callback once user has been idle. Use to prompt for fresh login, 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
+   */
+  static create(options = {}) {
+    return new IdleManager(options);
+  }
+  /**
+   * @protected
+   * @param options {@link IdleManagerOptions}
+   */
+  constructor(options = {}) {
+    const { onIdle, idleTimeout = 10 * 60 * 1e3 } = options || {};
+    this.callbacks = onIdle ? [onIdle] : [];
+    this.idleTimeout = idleTimeout;
+    const _resetTimer = this._resetTimer.bind(this);
+    window.addEventListener("load", _resetTimer, true);
+    events.forEach((name) => {
+      document.addEventListener(name, _resetTimer, true);
+    });
+    const debounce = (func, wait) => {
+      let timeout;
+      return (...args) => {
+        const context = this;
+        const later = () => {
+          timeout = void 0;
+          func.apply(context, args);
+        };
+        clearTimeout(timeout);
+        timeout = window.setTimeout(later, wait);
+      };
+    };
+    if (options?.captureScroll) {
+      const scroll = debounce(_resetTimer, options?.scrollDebounce ?? 100);
+      window.addEventListener("scroll", scroll, true);
+    }
+    _resetTimer();
+  }
+  /**
+   * @param {IdleCB} callback function to be called when user goes idle
+   */
+  registerCallback(callback) {
+    this.callbacks.push(callback);
+  }
+  /**
+   * Cleans up the idle manager and its listeners
+   */
+  exit() {
+    clearTimeout(this.timeoutID);
+    window.removeEventListener("load", this._resetTimer, true);
+    const _resetTimer = this._resetTimer.bind(this);
+    events.forEach((name) => {
+      document.removeEventListener(name, _resetTimer, true);
+    });
+    this.callbacks.forEach((cb) => {
+      cb();
+    });
+  }
+  /**
+   * Resets the timeouts during cleanup
+   */
+  _resetTimer() {
+    const exit = this.exit.bind(this);
+    window.clearTimeout(this.timeoutID);
+    this.timeoutID = window.setTimeout(exit, this.idleTimeout);
+  }
+}
+export {
+  IdleManager
+};
+//# sourceMappingURL=idle-manager.js.map

package/dist/esm/client/idle-manager.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"idle-manager.js","sources":["../../../src/client/idle-manager.ts"],"sourcesContent":["type IdleCB = () => unknown;\n\nexport type IdleManagerOptions = {\n  /**\n   * Callback after the user has gone idle\n   */\n  onIdle?: IdleCB;\n  /**\n   * timeout in ms\n   * @default 30 minutes [600_000]\n   */\n  idleTimeout?: number;\n  /**\n   * capture scroll events\n   * @default false\n   */\n  captureScroll?: boolean;\n  /**\n   * scroll debounce time in ms\n   * @default 100\n   */\n  scrollDebounce?: number;\n};\n\nconst events = ['mousedown', 'mousemove', 'keydown', 'touchstart', 'wheel'];\n\n/**\n * Detects if the user has been idle for a duration of `idleTimeout` ms, and calls `onIdle` and registered callbacks.\n * By default, the IdleManager will log a user out after 10 minutes of inactivity.\n * To override these defaults, you can pass an `onIdle` callback, or configure a custom `idleTimeout` in milliseconds\n */\nexport class IdleManager {\n  callbacks: IdleCB[] = [];\n  idleTimeout: IdleManagerOptions['idleTimeout'] = 10 * 60 * 1000;\n  timeoutID?: number = undefined;\n\n  /**\n   * Creates an {@link IdleManager}\n   * @param {IdleManagerOptions} options Optional configuration\n   * @see {@link IdleManagerOptions}\n   * @param options.onIdle Callback once user has been idle. Use to prompt for fresh login, and use `Actor.agentOf(your_actor).invalidateIdentity()` to protect the user\n   * @param options.idleTimeout timeout in ms\n   * @param options.captureScroll capture scroll events\n   * @param options.scrollDebounce scroll debounce time in ms\n   */\n  public static create(\n    options: {\n      /**\n       * Callback after the user has gone idle\n       * @see {@link IdleCB}\n       */\n      onIdle?: () => unknown;\n      /**\n       * timeout in ms\n       * @default 10 minutes [600_000]\n       */\n      idleTimeout?: number;\n      /**\n       * capture scroll events\n       * @default false\n       */\n      captureScroll?: boolean;\n      /**\n       * scroll debounce time in ms\n       * @default 100\n       */\n      scrollDebounce?: number;\n    } = {},\n  ): IdleManager {\n    return new IdleManager(options);\n  }\n\n  /**\n   * @protected\n   * @param options {@link IdleManagerOptions}\n   */\n  protected constructor(options: IdleManagerOptions = {}) {\n    const { onIdle, idleTimeout = 10 * 60 * 1000 } = options || {};\n\n    this.callbacks = onIdle ? [onIdle] : [];\n    this.idleTimeout = idleTimeout;\n\n    const _resetTimer = this._resetTimer.bind(this);\n\n    window.addEventListener('load', _resetTimer, true);\n\n    events.forEach((name) => {\n      document.addEventListener(name, _resetTimer, true);\n    });\n\n    const debounce = (func: (...args: unknown[]) => void, wait: number) => {\n      let timeout: number | undefined;\n      return (...args: unknown[]) => {\n        const context = this;\n        const later = () => {\n          timeout = undefined;\n          func.apply(context, args);\n        };\n        clearTimeout(timeout);\n        timeout = window.setTimeout(later, wait);\n      };\n    };\n\n    if (options?.captureScroll) {\n      // debounce scroll events\n      const scroll = debounce(_resetTimer, options?.scrollDebounce ?? 100);\n      window.addEventListener('scroll', scroll, true);\n    }\n\n    _resetTimer();\n  }\n\n  /**\n   * @param {IdleCB} callback function to be called when user goes idle\n   */\n  public registerCallback(callback: IdleCB): void {\n    this.callbacks.push(callback);\n  }\n\n  /**\n   * Cleans up the idle manager and its listeners\n   */\n  public exit(): void {\n    clearTimeout(this.timeoutID);\n    window.removeEventListener('load', this._resetTimer, true);\n\n    const _resetTimer = this._resetTimer.bind(this);\n    events.forEach((name) => {\n      document.removeEventListener(name, _resetTimer, true);\n    });\n    this.callbacks.forEach((cb) => {\n      cb();\n    });\n  }\n\n  /**\n   * Resets the timeouts during cleanup\n   */\n  _resetTimer(): void {\n    const exit = this.exit.bind(this);\n    window.clearTimeout(this.timeoutID);\n    this.timeoutID = window.setTimeout(exit, this.idleTimeout);\n  }\n}\n"],"names":[],"mappings":"AAwBA,MAAM,SAAS,CAAC,aAAa,aAAa,WAAW,cAAc,OAAO;AAOnE,MAAM,YAAY;AAAA,EACvB,YAAsB,CAAA;AAAA,EACtB,cAAiD,KAAK,KAAK;AAAA,EAC3D,YAAqB;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAWrB,OAAc,OACZ,UAqBI,IACS;AACb,WAAO,IAAI,YAAY,OAAO;AAAA,EAChC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMU,YAAY,UAA8B,IAAI;AACtD,UAAM,EAAE,QAAQ,cAAc,KAAK,KAAK,IAAA,IAAS,WAAW,CAAA;AAE5D,SAAK,YAAY,SAAS,CAAC,MAAM,IAAI,CAAA;AACrC,SAAK,cAAc;AAEnB,UAAM,cAAc,KAAK,YAAY,KAAK,IAAI;AAE9C,WAAO,iBAAiB,QAAQ,aAAa,IAAI;AAEjD,WAAO,QAAQ,CAAC,SAAS;AACvB,eAAS,iBAAiB,MAAM,aAAa,IAAI;AAAA,IACnD,CAAC;AAED,UAAM,WAAW,CAAC,MAAoC,SAAiB;AACrE,UAAI;AACJ,aAAO,IAAI,SAAoB;AAC7B,cAAM,UAAU;AAChB,cAAM,QAAQ,MAAM;AAClB,oBAAU;AACV,eAAK,MAAM,SAAS,IAAI;AAAA,QAC1B;AACA,qBAAa,OAAO;AACpB,kBAAU,OAAO,WAAW,OAAO,IAAI;AAAA,MACzC;AAAA,IACF;AAEA,QAAI,SAAS,eAAe;AAE1B,YAAM,SAAS,SAAS,aAAa,SAAS,kBAAkB,GAAG;AACnE,aAAO,iBAAiB,UAAU,QAAQ,IAAI;AAAA,IAChD;AAEA,gBAAA;AAAA,EACF;AAAA;AAAA;AAAA;AAAA,EAKO,iBAAiB,UAAwB;AAC9C,SAAK,UAAU,KAAK,QAAQ;AAAA,EAC9B;AAAA;AAAA;AAAA;AAAA,EAKO,OAAa;AAClB,iBAAa,KAAK,SAAS;AAC3B,WAAO,oBAAoB,QAAQ,KAAK,aAAa,IAAI;AAEzD,UAAM,cAAc,KAAK,YAAY,KAAK,IAAI;AAC9C,WAAO,QAAQ,CAAC,SAAS;AACvB,eAAS,oBAAoB,MAAM,aAAa,IAAI;AAAA,IACtD,CAAC;AACD,SAAK,UAAU,QAAQ,CAAC,OAAO;AAC7B,SAAA;AAAA,IACF,CAAC;AAAA,EACH;AAAA;AAAA;AAAA;AAAA,EAKA,cAAoB;AAClB,UAAM,OAAO,KAAK,KAAK,KAAK,IAAI;AAChC,WAAO,aAAa,KAAK,SAAS;AAClC,SAAK,YAAY,OAAO,WAAW,MAAM,KAAK,WAAW;AAAA,EAC3D;AACF;"}

package/dist/esm/client/index.d.ts

@@ -0,0 +1,4 @@
+export * from './auth-client.ts';
+export { type DBCreateOptions, IdbKeyVal } from './db.ts';
+export * from './idle-manager.ts';
+export { type AuthClientStorage, IdbStorage, KEY_STORAGE_DELEGATION, KEY_STORAGE_KEY, LocalStorage, } from './storage.ts';

package/dist/esm/client/index.js

@@ -0,0 +1,15 @@
+import { AuthClient, ERROR_USER_INTERRUPT } from "./auth-client.js";
+import { IdbKeyVal } from "./db.js";
+import { IdleManager } from "./idle-manager.js";
+import { IdbStorage, KEY_STORAGE_DELEGATION, KEY_STORAGE_KEY, LocalStorage } from "./storage.js";
+export {
+  AuthClient,
+  ERROR_USER_INTERRUPT,
+  IdbKeyVal,
+  IdbStorage,
+  IdleManager,
+  KEY_STORAGE_DELEGATION,
+  KEY_STORAGE_KEY,
+  LocalStorage
+};
+//# sourceMappingURL=index.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/esm/client/storage.d.ts

@@ -0,0 +1,51 @@
+import { DBCreateOptions, IdbKeyVal } from './db.ts';
+export declare const KEY_STORAGE_KEY = "identity";
+export declare const KEY_STORAGE_DELEGATION = "delegation";
+export declare const KEY_VECTOR = "iv";
+export declare 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 declare class LocalStorage implements AuthClientStorage {
+    readonly prefix: string;
+    private readonly _localStorage?;
+    constructor(prefix?: string, _localStorage?: Storage | undefined);
+    get(key: string): Promise<string | null>;
+    set(key: string, value: string): Promise<void>;
+    remove(key: string): Promise<void>;
+    private _getLocalStorage;
+}
+/**
+ * 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 declare class IdbStorage implements AuthClientStorage {
+    #private;
+    /**
+     * @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);
+    private initializedDb;
+    get _db(): Promise<IdbKeyVal>;
+    get<T = string>(key: string): Promise<T | null>;
+    set<T = string>(key: string, value: T): Promise<void>;
+    remove(key: string): Promise<void>;
+}

package/dist/esm/client/storage.js

@@ -0,0 +1,83 @@
+import { IdbKeyVal } from "./db.js";
+const KEY_STORAGE_KEY = "identity";
+const KEY_STORAGE_DELEGATION = "delegation";
+const KEY_VECTOR = "iv";
+const DB_VERSION = 1;
+class 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;
+  }
+}
+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) => {
+      if (this.initializedDb) {
+        resolve(this.initializedDb);
+        return;
+      }
+      IdbKeyVal.create(this.#options).then((db) => {
+        this.initializedDb = db;
+        resolve(db);
+      });
+    });
+  }
+  async get(key) {
+    const db = await this._db;
+    return await db.get(key);
+  }
+  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);
+  }
+}
+export {
+  DB_VERSION,
+  IdbStorage,
+  KEY_STORAGE_DELEGATION,
+  KEY_STORAGE_KEY,
+  KEY_VECTOR,
+  LocalStorage
+};
+//# sourceMappingURL=storage.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"storage.js","sources":["../../../src/client/storage.ts"],"sourcesContent":["import { type DBCreateOptions, IdbKeyVal } from './db.ts';\n\nexport const KEY_STORAGE_KEY = 'identity';\nexport const KEY_STORAGE_DELEGATION = 'delegation';\nexport const KEY_VECTOR = 'iv';\n// Increment if any fields are modified\nexport const DB_VERSION = 1;\n\nexport type StoredKey = string | CryptoKeyPair;\n\n/**\n * Interface for persisting user authentication data\n */\nexport interface AuthClientStorage {\n  get(key: string): Promise<StoredKey | null>;\n\n  set(key: string, value: StoredKey): Promise<void>;\n\n  remove(key: string): Promise<void>;\n}\n\n/**\n * Legacy implementation of AuthClientStorage, for use where IndexedDb is not available\n */\nexport class LocalStorage implements AuthClientStorage {\n  constructor(\n    public readonly prefix = 'ic-',\n    private readonly _localStorage?: Storage,\n  ) {}\n\n  public get(key: string): Promise<string | null> {\n    return Promise.resolve(this._getLocalStorage().getItem(this.prefix + key));\n  }\n\n  public set(key: string, value: string): Promise<void> {\n    this._getLocalStorage().setItem(this.prefix + key, value);\n    return Promise.resolve();\n  }\n\n  public remove(key: string): Promise<void> {\n    this._getLocalStorage().removeItem(this.prefix + key);\n    return Promise.resolve();\n  }\n\n  private _getLocalStorage() {\n    if (this._localStorage) {\n      return this._localStorage;\n    }\n\n    const ls = globalThis.localStorage;\n    if (!ls) {\n      throw new Error('Could not find local storage.');\n    }\n\n    return ls;\n  }\n}\n\n/**\n * IdbStorage is an interface for simple storage of string key-value pairs built on {@link IdbKeyVal}\n *\n * It replaces {@link LocalStorage}\n * @see implements {@link AuthClientStorage}\n */\nexport class IdbStorage implements AuthClientStorage {\n  #options: DBCreateOptions;\n\n  /**\n   * @param options - DBCreateOptions\n   * @param options.dbName - name for the indexeddb database\n   * @param options.storeName - name for the indexeddb Data Store\n   * @param options.version - version of the database. Increment to safely upgrade\n   * @example\n   * ```ts\n   * const storage = new IdbStorage({ dbName: 'my-db', storeName: 'my-store', version: 2 });\n   * ```\n   */\n  constructor(options?: DBCreateOptions) {\n    this.#options = options ?? {};\n  }\n\n  // Initializes a KeyVal on first request\n  private initializedDb: IdbKeyVal | undefined;\n  get _db(): Promise<IdbKeyVal> {\n    return new Promise((resolve) => {\n      if (this.initializedDb) {\n        resolve(this.initializedDb);\n        return;\n      }\n      IdbKeyVal.create(this.#options).then((db) => {\n        this.initializedDb = db;\n        resolve(db);\n      });\n    });\n  }\n\n  public async get<T = string>(key: string): Promise<T | null> {\n    const db = await this._db;\n    return await db.get<T>(key);\n    // return (await db.get<string>(key)) ?? null;\n  }\n\n  public async set<T = string>(key: string, value: T): Promise<void> {\n    const db = await this._db;\n    await db.set(key, value);\n  }\n\n  public async remove(key: string): Promise<void> {\n    const db = await this._db;\n    await db.remove(key);\n  }\n}\n"],"names":[],"mappings":";AAEO,MAAM,kBAAkB;AACxB,MAAM,yBAAyB;AAC/B,MAAM,aAAa;AAEnB,MAAM,aAAa;AAkBnB,MAAM,aAA0C;AAAA,EACrD,YACkB,SAAS,OACR,eACjB;AAFgB,SAAA,SAAA;AACC,SAAA,gBAAA;AAAA,EAChB;AAAA,EAEI,IAAI,KAAqC;AAC9C,WAAO,QAAQ,QAAQ,KAAK,iBAAA,EAAmB,QAAQ,KAAK,SAAS,GAAG,CAAC;AAAA,EAC3E;AAAA,EAEO,IAAI,KAAa,OAA8B;AACpD,SAAK,mBAAmB,QAAQ,KAAK,SAAS,KAAK,KAAK;AACxD,WAAO,QAAQ,QAAA;AAAA,EACjB;AAAA,EAEO,OAAO,KAA4B;AACxC,SAAK,iBAAA,EAAmB,WAAW,KAAK,SAAS,GAAG;AACpD,WAAO,QAAQ,QAAA;AAAA,EACjB;AAAA,EAEQ,mBAAmB;AACzB,QAAI,KAAK,eAAe;AACtB,aAAO,KAAK;AAAA,IACd;AAEA,UAAM,KAAK,WAAW;AACtB,QAAI,CAAC,IAAI;AACP,YAAM,IAAI,MAAM,+BAA+B;AAAA,IACjD;AAEA,WAAO;AAAA,EACT;AACF;AAQO,MAAM,WAAwC;AAAA,EACnD;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYA,YAAY,SAA2B;AACrC,SAAK,WAAW,WAAW,CAAA;AAAA,EAC7B;AAAA;AAAA,EAGQ;AAAA,EACR,IAAI,MAA0B;AAC5B,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC9B,UAAI,KAAK,eAAe;AACtB,gBAAQ,KAAK,aAAa;AAC1B;AAAA,MACF;AACA,gBAAU,OAAO,KAAK,QAAQ,EAAE,KAAK,CAAC,OAAO;AAC3C,aAAK,gBAAgB;AACrB,gBAAQ,EAAE;AAAA,MACZ,CAAC;AAAA,IACH,CAAC;AAAA,EACH;AAAA,EAEA,MAAa,IAAgB,KAAgC;AAC3D,UAAM,KAAK,MAAM,KAAK;AACtB,WAAO,MAAM,GAAG,IAAO,GAAG;AAAA,EAE5B;AAAA,EAEA,MAAa,IAAgB,KAAa,OAAyB;AACjE,UAAM,KAAK,MAAM,KAAK;AACtB,UAAM,GAAG,IAAI,KAAK,KAAK;AAAA,EACzB;AAAA,EAEA,MAAa,OAAO,KAA4B;AAC9C,UAAM,KAAK,MAAM,KAAK;AACtB,UAAM,GAAG,OAAO,GAAG;AAAA,EACrB;AACF;"}

package/dist/esm/index.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/esm/index.js

@@ -0,0 +1,4 @@
+throw new Error(
+  "There are no exports in the root module of this package. Import from submodules instead. Use intellisense or the docs to find the available submodules."
+);
+//# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/index.ts"],"sourcesContent":["throw new Error(\n  'There are no exports in the root module of this package. Import from submodules instead. Use intellisense or the docs to find the available submodules.',\n);\n"],"names":[],"mappings":"AAAA,MAAM,IAAI;AAAA,EACR;AACF;"}

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@icp-sdk/auth",
+  "version": "4.0.0-beta.1",
+  "author": "DFINITY Stiftung <sdk@dfinity.org>",
+  "license": "Apache-2.0",
+  "description": "Authentication library for Internet Computer web apps",
+  "homepage": "https://js.icp.build/auth/",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dfinity/icp-js-auth.git"
+  },
+  "bugs": {
+    "url": "https://github.com/dfinity/icp-js-auth/issues"
+  },
+  "sideEffects": false,
+  "type": "module",
+  "types": "./dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./client": {
+      "types": "./dist/esm/client/index.d.ts",
+      "import": "./dist/esm/client/index.js",
+      "default": "./dist/esm/client/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "src",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "devDependencies": {
+    "@biomejs/biome": "^2.2.4",
+    "@icp-sdk/core": "^4.0.4",
+    "@tanstack/config": "^0.20.2",
+    "fake-indexeddb": "^6.2.2",
+    "jsdom": "^27.0.0",
+    "publint": "^0.3.13",
+    "typescript": "^5.9.2",
+    "vite": "^7.1.7",
+    "vitest": "3.2.4"
+  },
+  "peerDependencies": {
+    "@icp-sdk/core": "^4.0.4"
+  },
+  "dependencies": {
+    "idb": "^8.0.3"
+  },
+  "scripts": {
+    "build": "vite build && pnpm lint:package",
+    "test": "vitest",
+    "codestyle:check": "biome check",
+    "codestyle:fix": "biome check --write",
+    "lint:package": "publint --strict"
+  }
+}