auth-vir 4.0.0 → 5.0.0

package/dist/mock-csrf-token-store.js

@@ -1,107 +0,0 @@
-/**
- * Create an empty `accessRecord` object, this is to be used in conjunction with
- * {@link createMockLocalStorage}.
- *
- * @category Mock
- */
-export function createEmptyMockLocalStorageAccessRecord() {
-    return {
-        getItem: [],
-        removeItem: [],
-        setItem: [],
-        key: [],
-    };
-}
-/**
- * Create a LocalStorage mock.
- *
- * @category Mock
- */
-export function createMockLocalStorage(
-/** Set values in here to initialize the mocked localStorage data store contents. */
-init = {}) {
-    const store = init;
-    const accessRecord = createEmptyMockLocalStorageAccessRecord();
-    const mockLocalStorage = {
-        clear() {
-            Object.keys(store).forEach((key) => {
-                delete store[key];
-            });
-        },
-        getItem(key) {
-            accessRecord.getItem.push(key);
-            return store[key] ?? null;
-        },
-        get length() {
-            return Object.keys(store).length;
-        },
-        key(index) {
-            accessRecord.key.push(index);
-            return Object.keys(store)[index] ?? null;
-        },
-        removeItem(key) {
-            accessRecord.removeItem.push(key);
-            delete store[key];
-        },
-        setItem(key, value) {
-            accessRecord.setItem.push({
-                key,
-                value,
-            });
-            store[key] = value;
-        },
-    };
-    return {
-        localStorage: mockLocalStorage,
-        store,
-        accessRecord,
-    };
-}
-/**
- * Create an empty `accessRecord` object, this is to be used in conjunction with
- * {@link createMockCsrfTokenStore}.
- *
- * @category Mock
- */
-export function createEmptyMockCsrfTokenStoreAccessRecord() {
-    return {
-        getCsrfToken: 0,
-        setCsrfToken: [],
-        deleteCsrfToken: 0,
-    };
-}
-/**
- * Create a mock {@link CsrfTokenStore} backed by a simple in-memory object, for use in tests.
- *
- * @category Mock
- */
-export function createMockCsrfTokenStore(
-/** Set an initial value to initialize the mocked store contents. */
-init) {
-    let storedValue = init;
-    const accessRecord = createEmptyMockCsrfTokenStoreAccessRecord();
-    const csrfTokenStore = {
-        getCsrfToken() {
-            accessRecord.getCsrfToken++;
-            return Promise.resolve(storedValue);
-        },
-        setCsrfToken(value) {
-            accessRecord.setCsrfToken.push(value);
-            storedValue = value;
-            return Promise.resolve();
-        },
-        deleteCsrfToken() {
-            accessRecord.deleteCsrfToken++;
-            storedValue = undefined;
-            return Promise.resolve();
-        },
-    };
-    return {
-        csrfTokenStore,
-        /** The current value held in the mock store. */
-        get storedValue() {
-            return storedValue;
-        },
-        accessRecord,
-    };
-}

package/src/csrf-token-store.ts

@@ -1,54 +0,0 @@
-import {LocalDbClient} from 'local-db-client';
-import {defineShape} from 'object-shape-tester';
-
-const csrfTokenDbShapes = {
-    csrfToken: defineShape(''),
-} as const;
-
-/**
- * The interface used for overriding the default CSRF token store in storage functions.
- *
- * @category Internal
- */
-export type CsrfTokenStore = {
-    /** Retrieves the stored CSRF token, if any. */
-    getCsrfToken(): Promise<string | undefined>;
-    /** Stores a CSRF token. */
-    setCsrfToken(value: string): Promise<void>;
-    /** Deletes the stored CSRF token. */
-    deleteCsrfToken(): Promise<void>;
-};
-
-async function createDefaultCsrfTokenStore(): Promise<CsrfTokenStore> {
-    const client = await LocalDbClient.createClient(csrfTokenDbShapes, {
-        storeName: 'auth-vir-csrf',
-    });
-
-    return {
-        async getCsrfToken() {
-            return (await client.load.csrfToken()) || undefined;
-        },
-        async setCsrfToken(value) {
-            await client.set.csrfToken(value);
-        },
-        async deleteCsrfToken() {
-            await client.delete.csrfToken();
-        },
-    };
-}
-
-/**
- * The default {@link LocalDbClient} instance used for storing CSRF tokens. This uses a dedicated
- * store name to avoid collisions with other storage. Lazily initialized to avoid crashes in Node.js
- * environments where IndexedDB is not available.
- *
- * @category Internal
- */
-export async function getDefaultCsrfTokenStore(): Promise<CsrfTokenStore> {
-    if (!cachedStorePromise) {
-        cachedStorePromise = createDefaultCsrfTokenStore();
-    }
-    return cachedStorePromise;
-}
-
-let cachedStorePromise: Promise<CsrfTokenStore> | undefined;

package/src/mock-csrf-token-store.ts

@@ -1,141 +0,0 @@
-import {type CsrfTokenStore} from './csrf-token-store.js';
-
-/**
- * `accessRecord` type for {@link createMockLocalStorage}'s output.
- *
- * @category Internal
- */
-export type MockLocalStorageAccessRecord = {
-    getItem: string[];
-    removeItem: string[];
-    setItem: {key: string; value: string}[];
-    key: number[];
-};
-
-/**
- * Create an empty `accessRecord` object, this is to be used in conjunction with
- * {@link createMockLocalStorage}.
- *
- * @category Mock
- */
-export function createEmptyMockLocalStorageAccessRecord(): MockLocalStorageAccessRecord {
-    return {
-        getItem: [],
-        removeItem: [],
-        setItem: [],
-        key: [],
-    };
-}
-
-/**
- * Create a LocalStorage mock.
- *
- * @category Mock
- */
-export function createMockLocalStorage(
-    /** Set values in here to initialize the mocked localStorage data store contents. */
-    init: Record<string, string> = {},
-) {
-    const store: Record<string, string> = init;
-    const accessRecord = createEmptyMockLocalStorageAccessRecord();
-
-    const mockLocalStorage: Storage = {
-        clear() {
-            Object.keys(store).forEach((key) => {
-                delete store[key];
-            });
-        },
-        getItem(key) {
-            accessRecord.getItem.push(key);
-            return store[key] ?? null;
-        },
-        get length() {
-            return Object.keys(store).length;
-        },
-        key(index) {
-            accessRecord.key.push(index);
-            return Object.keys(store)[index] ?? null;
-        },
-        removeItem(key) {
-            accessRecord.removeItem.push(key);
-            delete store[key];
-        },
-        setItem(key, value) {
-            accessRecord.setItem.push({
-                key,
-                value,
-            });
-            store[key] = value;
-        },
-    };
-
-    return {
-        localStorage: mockLocalStorage,
-        store,
-        accessRecord,
-    };
-}
-
-/**
- * `accessRecord` type for {@link createMockCsrfTokenStore}'s output.
- *
- * @category Internal
- */
-export type MockCsrfTokenStoreAccessRecord = {
-    getCsrfToken: number;
-    setCsrfToken: string[];
-    deleteCsrfToken: number;
-};
-
-/**
- * Create an empty `accessRecord` object, this is to be used in conjunction with
- * {@link createMockCsrfTokenStore}.
- *
- * @category Mock
- */
-export function createEmptyMockCsrfTokenStoreAccessRecord(): MockCsrfTokenStoreAccessRecord {
-    return {
-        getCsrfToken: 0,
-        setCsrfToken: [],
-        deleteCsrfToken: 0,
-    };
-}
-
-/**
- * Create a mock {@link CsrfTokenStore} backed by a simple in-memory object, for use in tests.
- *
- * @category Mock
- */
-export function createMockCsrfTokenStore(
-    /** Set an initial value to initialize the mocked store contents. */
-    init?: string | undefined,
-) {
-    let storedValue: string | undefined = init;
-    const accessRecord = createEmptyMockCsrfTokenStoreAccessRecord();
-
-    const csrfTokenStore: CsrfTokenStore = {
-        getCsrfToken() {
-            accessRecord.getCsrfToken++;
-            return Promise.resolve(storedValue);
-        },
-        setCsrfToken(value: string) {
-            accessRecord.setCsrfToken.push(value);
-            storedValue = value;
-            return Promise.resolve();
-        },
-        deleteCsrfToken() {
-            accessRecord.deleteCsrfToken++;
-            storedValue = undefined;
-            return Promise.resolve();
-        },
-    };
-
-    return {
-        csrfTokenStore,
-        /** The current value held in the mock store. */
-        get storedValue() {
-            return storedValue;
-        },
-        accessRecord,
-    };
-}