@sanity/cli-core 0.0.2-alpha.0

package/dist/services/cliUserConfig.js

@@ -0,0 +1,103 @@
+import { mkdir } from 'node:fs/promises';
+import { homedir } from 'node:os';
+import { dirname, join as joinPath } from 'node:path';
+import { z } from 'zod';
+import { debug } from '../debug.js';
+import { readJsonFile } from '../util/readJsonFile.js';
+import { writeJsonFile } from '../util/writeJsonFile.js';
+const cliUserConfigSchema = {
+    authToken: z.string().optional(),
+    telemetryConsent: z.object({
+        updatedAt: z.number().optional(),
+        value: z.object({
+            status: z.enum([
+                'undetermined',
+                'unset',
+                'granted',
+                'denied'
+            ]),
+            type: z.string()
+        }).passthrough()
+    }).optional()
+};
+/**
+ * Set the config value for the given property.
+ * Validates that the passed value adheres to the defined CLI config schema.
+ *
+ * @param prop - The property to set the value for
+ * @param value - The value to set
+ * @internal
+ */ export async function setConfig(prop, value) {
+    const config = await readConfig();
+    const valueSchema = cliUserConfigSchema[prop];
+    if (!valueSchema) {
+        throw new Error(`No schema defined for config property "${prop}"`);
+    }
+    const { error, success } = valueSchema.safeParse(value);
+    if (!success) {
+        const message = error.issues.map(({ message, path })=>`[${path.join('.')}] ${message}`).join('\n');
+        throw new Error(`Invalid value for config property "${prop}": ${message}`);
+    }
+    const configPath = getCliUserConfigPath();
+    await mkdir(dirname(configPath), {
+        recursive: true
+    });
+    await writeJsonFile(configPath, {
+        ...config,
+        [prop]: value
+    }, {
+        pretty: true
+    });
+}
+/**
+ * Get the config value for the given property
+ *
+ * @param prop - The property to get the value for
+ * @returns The value of the given property
+ * @internal
+ */ export async function getConfig(prop) {
+    const config = await readConfig();
+    const valueSchema = cliUserConfigSchema[prop];
+    if (!valueSchema) {
+        throw new Error(`No schema defined for config property "${prop}"`);
+    }
+    const { error, success } = valueSchema.safeParse(config[prop]);
+    if (!success) {
+        const message = error.issues.map(({ message, path })=>`[${path.join('.')}] ${message}`).join('\n');
+        throw new Error(`Invalid value for config property "${prop}": ${message}`);
+    }
+    return config[prop];
+}
+/**
+ * Read the whole configuration from file system. If the file does not exist or could
+ * not be loaded, an empty configuration object is returned.
+ *
+ * @returns The whole CLI configuration.
+ * @internal
+ */ async function readConfig() {
+    const defaultConfig = {};
+    try {
+        const config = await readJsonFile(getCliUserConfigPath());
+        if (!config || typeof config !== 'object' || Array.isArray(config)) {
+            throw new Error('Invalid config file - expected an object');
+        }
+        return config;
+    } catch (err) {
+        debug('Failed to read CLI config file: %s', err instanceof Error ? err.message : `${err}`);
+        return defaultConfig;
+    }
+}
+/**
+ * Get the file system location for the CLI user configuration file.
+ * Takes into account the active environment (staging vs production).
+ * The file is located in the user's home directory under the `.config` directory.
+ *
+ * @returns The path to the CLI configuration file.
+ * @internal
+ */ function getCliUserConfigPath() {
+    const sanityEnvSuffix = process.env.SANITY_INTERNAL_ENV === 'staging' ? '-staging' : '';
+    const cliConfigPath = process.env.SANITY_CLI_CONFIG_PATH || joinPath(homedir(), '.config', `sanity${sanityEnvSuffix}`, 'config.json');
+    return cliConfigPath;
+}
+
+//# sourceMappingURL=cliUserConfig.js.map

package/dist/services/cliUserConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/cliUserConfig.ts"],"sourcesContent":["import {mkdir} from 'node:fs/promises'\nimport {homedir} from 'node:os'\nimport {dirname, join as joinPath} from 'node:path'\n\nimport {z} from 'zod'\n\nimport {debug} from '../debug.js'\nimport {readJsonFile} from '../util/readJsonFile.js'\nimport {writeJsonFile} from '../util/writeJsonFile.js'\n\nconst cliUserConfigSchema = {\n  authToken: z.string().optional(),\n  telemetryConsent: z\n    .object({\n      updatedAt: z.number().optional(),\n      value: z\n        .object({\n          status: z.enum(['undetermined', 'unset', 'granted', 'denied']),\n          type: z.string(),\n        })\n        .passthrough(),\n    })\n    .optional(),\n}\n\n/**\n * The CLI user configuration schema.\n *\n * @internal\n */\ntype CliUserConfig = z.infer<z.ZodObject<typeof cliUserConfigSchema>>\n\n/**\n * Set the config value for the given property.\n * Validates that the passed value adheres to the defined CLI config schema.\n *\n * @param prop - The property to set the value for\n * @param value - The value to set\n * @internal\n */\nexport async function setConfig<P extends keyof CliUserConfig>(prop: P, value: CliUserConfig[P]) {\n  const config = await readConfig()\n  const valueSchema = cliUserConfigSchema[prop]\n  if (!valueSchema) {\n    throw new Error(`No schema defined for config property \"${prop}\"`)\n  }\n\n  const {error, success} = valueSchema.safeParse(value)\n  if (!success) {\n    const message = error.issues\n      .map(({message, path}) => `[${path.join('.')}] ${message}`)\n      .join('\\n')\n\n    throw new Error(`Invalid value for config property \"${prop}\": ${message}`)\n  }\n\n  const configPath = getCliUserConfigPath()\n  await mkdir(dirname(configPath), {recursive: true})\n  await writeJsonFile(configPath, {...config, [prop]: value}, {pretty: true})\n}\n\n/**\n * Get the config value for the given property\n *\n * @param prop - The property to get the value for\n * @returns The value of the given property\n * @internal\n */\nexport async function getConfig<P extends keyof CliUserConfig>(prop: P): Promise<CliUserConfig[P]> {\n  const config = await readConfig()\n  const valueSchema = cliUserConfigSchema[prop]\n  if (!valueSchema) {\n    throw new Error(`No schema defined for config property \"${prop}\"`)\n  }\n\n  const {error, success} = valueSchema.safeParse(config[prop])\n  if (!success) {\n    const message = error.issues\n      .map(({message, path}) => `[${path.join('.')}] ${message}`)\n      .join('\\n')\n\n    throw new Error(`Invalid value for config property \"${prop}\": ${message}`)\n  }\n\n  return config[prop]\n}\n\n/**\n * Read the whole configuration from file system. If the file does not exist or could\n * not be loaded, an empty configuration object is returned.\n *\n * @returns The whole CLI configuration.\n * @internal\n */\nasync function readConfig(): Promise<CliUserConfig> {\n  const defaultConfig: CliUserConfig = {}\n  try {\n    const config = await readJsonFile(getCliUserConfigPath())\n    if (!config || typeof config !== 'object' || Array.isArray(config)) {\n      throw new Error('Invalid config file - expected an object')\n    }\n    return config\n  } catch (err: unknown) {\n    debug('Failed to read CLI config file: %s', err instanceof Error ? err.message : `${err}`)\n    return defaultConfig\n  }\n}\n\n/**\n * Get the file system location for the CLI user configuration file.\n * Takes into account the active environment (staging vs production).\n * The file is located in the user's home directory under the `.config` directory.\n *\n * @returns The path to the CLI configuration file.\n * @internal\n */\nfunction getCliUserConfigPath() {\n  const sanityEnvSuffix = process.env.SANITY_INTERNAL_ENV === 'staging' ? '-staging' : ''\n  const cliConfigPath =\n    process.env.SANITY_CLI_CONFIG_PATH ||\n    joinPath(homedir(), '.config', `sanity${sanityEnvSuffix}`, 'config.json')\n\n  return cliConfigPath\n}\n"],"names":["mkdir","homedir","dirname","join","joinPath","z","debug","readJsonFile","writeJsonFile","cliUserConfigSchema","authToken","string","optional","telemetryConsent","object","updatedAt","number","value","status","enum","type","passthrough","setConfig","prop","config","readConfig","valueSchema","Error","error","success","safeParse","message","issues","map","path","configPath","getCliUserConfigPath","recursive","pretty","getConfig","defaultConfig","Array","isArray","err","sanityEnvSuffix","process","env","SANITY_INTERNAL_ENV","cliConfigPath","SANITY_CLI_CONFIG_PATH"],"mappings":"AAAA,SAAQA,KAAK,QAAO,mBAAkB;AACtC,SAAQC,OAAO,QAAO,UAAS;AAC/B,SAAQC,OAAO,EAAEC,QAAQC,QAAQ,QAAO,YAAW;AAEnD,SAAQC,CAAC,QAAO,MAAK;AAErB,SAAQC,KAAK,QAAO,cAAa;AACjC,SAAQC,YAAY,QAAO,0BAAyB;AACpD,SAAQC,aAAa,QAAO,2BAA0B;AAEtD,MAAMC,sBAAsB;IAC1BC,WAAWL,EAAEM,MAAM,GAAGC,QAAQ;IAC9BC,kBAAkBR,EACfS,MAAM,CAAC;QACNC,WAAWV,EAAEW,MAAM,GAAGJ,QAAQ;QAC9BK,OAAOZ,EACJS,MAAM,CAAC;YACNI,QAAQb,EAAEc,IAAI,CAAC;gBAAC;gBAAgB;gBAAS;gBAAW;aAAS;YAC7DC,MAAMf,EAAEM,MAAM;QAChB,GACCU,WAAW;IAChB,GACCT,QAAQ;AACb;AASA;;;;;;;CAOC,GACD,OAAO,eAAeU,UAAyCC,IAAO,EAAEN,KAAuB;IAC7F,MAAMO,SAAS,MAAMC;IACrB,MAAMC,cAAcjB,mBAAmB,CAACc,KAAK;IAC7C,IAAI,CAACG,aAAa;QAChB,MAAM,IAAIC,MAAM,CAAC,uCAAuC,EAAEJ,KAAK,CAAC,CAAC;IACnE;IAEA,MAAM,EAACK,KAAK,EAAEC,OAAO,EAAC,GAAGH,YAAYI,SAAS,CAACb;IAC/C,IAAI,CAACY,SAAS;QACZ,MAAME,UAAUH,MAAMI,MAAM,CACzBC,GAAG,CAAC,CAAC,EAACF,OAAO,EAAEG,IAAI,EAAC,GAAK,CAAC,CAAC,EAAEA,KAAK/B,IAAI,CAAC,KAAK,EAAE,EAAE4B,SAAS,EACzD5B,IAAI,CAAC;QAER,MAAM,IAAIwB,MAAM,CAAC,mCAAmC,EAAEJ,KAAK,GAAG,EAAEQ,SAAS;IAC3E;IAEA,MAAMI,aAAaC;IACnB,MAAMpC,MAAME,QAAQiC,aAAa;QAACE,WAAW;IAAI;IACjD,MAAM7B,cAAc2B,YAAY;QAAC,GAAGX,MAAM;QAAE,CAACD,KAAK,EAAEN;IAAK,GAAG;QAACqB,QAAQ;IAAI;AAC3E;AAEA;;;;;;CAMC,GACD,OAAO,eAAeC,UAAyChB,IAAO;IACpE,MAAMC,SAAS,MAAMC;IACrB,MAAMC,cAAcjB,mBAAmB,CAACc,KAAK;IAC7C,IAAI,CAACG,aAAa;QAChB,MAAM,IAAIC,MAAM,CAAC,uCAAuC,EAAEJ,KAAK,CAAC,CAAC;IACnE;IAEA,MAAM,EAACK,KAAK,EAAEC,OAAO,EAAC,GAAGH,YAAYI,SAAS,CAACN,MAAM,CAACD,KAAK;IAC3D,IAAI,CAACM,SAAS;QACZ,MAAME,UAAUH,MAAMI,MAAM,CACzBC,GAAG,CAAC,CAAC,EAACF,OAAO,EAAEG,IAAI,EAAC,GAAK,CAAC,CAAC,EAAEA,KAAK/B,IAAI,CAAC,KAAK,EAAE,EAAE4B,SAAS,EACzD5B,IAAI,CAAC;QAER,MAAM,IAAIwB,MAAM,CAAC,mCAAmC,EAAEJ,KAAK,GAAG,EAAEQ,SAAS;IAC3E;IAEA,OAAOP,MAAM,CAACD,KAAK;AACrB;AAEA;;;;;;CAMC,GACD,eAAeE;IACb,MAAMe,gBAA+B,CAAC;IACtC,IAAI;QACF,MAAMhB,SAAS,MAAMjB,aAAa6B;QAClC,IAAI,CAACZ,UAAU,OAAOA,WAAW,YAAYiB,MAAMC,OAAO,CAAClB,SAAS;YAClE,MAAM,IAAIG,MAAM;QAClB;QACA,OAAOH;IACT,EAAE,OAAOmB,KAAc;QACrBrC,MAAM,sCAAsCqC,eAAehB,QAAQgB,IAAIZ,OAAO,GAAG,GAAGY,KAAK;QACzF,OAAOH;IACT;AACF;AAEA;;;;;;;CAOC,GACD,SAASJ;IACP,MAAMQ,kBAAkBC,QAAQC,GAAG,CAACC,mBAAmB,KAAK,YAAY,aAAa;IACrF,MAAMC,gBACJH,QAAQC,GAAG,CAACG,sBAAsB,IAClC7C,SAASH,WAAW,WAAW,CAAC,MAAM,EAAE2C,iBAAiB,EAAE;IAE7D,OAAOI;AACT"}

package/dist/services/getCliToken.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Get the CLI authentication token from the environment or the config file
+ *
+ * @returns A promise that resolves to a CLI token, or undefined if no token is found
+ * @internal
+ */
+export declare function getCliToken(): Promise<string | undefined>;

package/dist/services/getCliToken.js

@@ -0,0 +1,21 @@
+import { getConfig } from './cliUserConfig.js';
+let cachedToken;
+/**
+ * Get the CLI authentication token from the environment or the config file
+ *
+ * @returns A promise that resolves to a CLI token, or undefined if no token is found
+ * @internal
+ */ export async function getCliToken() {
+    if (cachedToken !== undefined) {
+        return cachedToken;
+    }
+    const token = process.env.SANITY_AUTH_TOKEN;
+    if (token) {
+        cachedToken = token.trim();
+        return cachedToken;
+    }
+    cachedToken = await getConfig('authToken');
+    return cachedToken;
+}
+
+//# sourceMappingURL=getCliToken.js.map

package/dist/services/getCliToken.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/services/getCliToken.ts"],"sourcesContent":["import {getConfig} from './cliUserConfig.js'\n\nlet cachedToken: string | undefined\n\n/**\n * Get the CLI authentication token from the environment or the config file\n *\n * @returns A promise that resolves to a CLI token, or undefined if no token is found\n * @internal\n */\nexport async function getCliToken(): Promise<string | undefined> {\n  if (cachedToken !== undefined) {\n    return cachedToken\n  }\n\n  const token = process.env.SANITY_AUTH_TOKEN\n  if (token) {\n    cachedToken = token.trim()\n    return cachedToken\n  }\n\n  cachedToken = await getConfig('authToken')\n  return cachedToken\n}\n"],"names":["getConfig","cachedToken","getCliToken","undefined","token","process","env","SANITY_AUTH_TOKEN","trim"],"mappings":"AAAA,SAAQA,SAAS,QAAO,qBAAoB;AAE5C,IAAIC;AAEJ;;;;;CAKC,GACD,OAAO,eAAeC;IACpB,IAAID,gBAAgBE,WAAW;QAC7B,OAAOF;IACT;IAEA,MAAMG,QAAQC,QAAQC,GAAG,CAACC,iBAAiB;IAC3C,IAAIH,OAAO;QACTH,cAAcG,MAAMI,IAAI;QACxB,OAAOP;IACT;IAEAA,cAAc,MAAMD,UAAU;IAC9B,OAAOC;AACT"}

package/dist/types.d.ts

@@ -0,0 +1,7 @@
+import { type Command } from '@oclif/core';
+export interface Output {
+    error: Command['error'];
+    log: Command['log'];
+    warn: Command['warn'];
+}
+export type RequireProps<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;

package/dist/types.js

@@ -0,0 +1,3 @@
+export { };
+
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/types.ts"],"sourcesContent":["import {type Command} from '@oclif/core'\n\nexport interface Output {\n  error: Command['error']\n  log: Command['log']\n  warn: Command['warn']\n}\n\nexport type RequireProps<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>\n"],"names":[],"mappings":"AAQA,WAAkF"}

package/dist/util/NotFoundError.d.ts

@@ -0,0 +1,20 @@
+/**
+ * Error thrown when a file or directory is not found
+ *
+ * `code` is always `ENOENT` to mirror Node.js behavior when a file is not found
+ *
+ * @internal
+ */
+export declare class NotFoundError extends Error {
+    code: string;
+    path?: string;
+    constructor(message: string, path?: string);
+}
+/**
+ * Returns whether or not the given error is a `NotFoundError`
+ *
+ * @param err - The error to check
+ * @returns `true` if the error is a `NotFoundError`, `false` otherwise
+ * @internal
+ */
+export declare function isNotFoundError(err: unknown): err is NotFoundError;

package/dist/util/NotFoundError.js

@@ -0,0 +1,27 @@
+import { isRecord } from './isRecord.js';
+/**
+ * Error thrown when a file or directory is not found
+ *
+ * `code` is always `ENOENT` to mirror Node.js behavior when a file is not found
+ *
+ * @internal
+ */ export class NotFoundError extends Error {
+    code = 'ENOENT';
+    path;
+    constructor(message, path){
+        super(message);
+        this.path = path;
+        this.name = 'NotFoundError';
+    }
+}
+/**
+ * Returns whether or not the given error is a `NotFoundError`
+ *
+ * @param err - The error to check
+ * @returns `true` if the error is a `NotFoundError`, `false` otherwise
+ * @internal
+ */ export function isNotFoundError(err) {
+    return isRecord(err) && 'name' in err && err.name === 'NotFoundError' && 'code' in err && err.code === 'ENOENT' && 'message' in err && typeof err.message === 'string';
+}
+
+//# sourceMappingURL=NotFoundError.js.map

package/dist/util/NotFoundError.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/NotFoundError.ts"],"sourcesContent":["import {isRecord} from './isRecord.js'\n\n/**\n * Error thrown when a file or directory is not found\n *\n * `code` is always `ENOENT` to mirror Node.js behavior when a file is not found\n *\n * @internal\n */\nexport class NotFoundError extends Error {\n  code = 'ENOENT'\n  path?: string\n\n  constructor(message: string, path?: string) {\n    super(message)\n    this.path = path\n    this.name = 'NotFoundError'\n  }\n}\n\n/**\n * Returns whether or not the given error is a `NotFoundError`\n *\n * @param err - The error to check\n * @returns `true` if the error is a `NotFoundError`, `false` otherwise\n * @internal\n */\nexport function isNotFoundError(err: unknown): err is NotFoundError {\n  return (\n    isRecord(err) &&\n    'name' in err &&\n    err.name === 'NotFoundError' &&\n    'code' in err &&\n    err.code === 'ENOENT' &&\n    'message' in err &&\n    typeof err.message === 'string'\n  )\n}\n"],"names":["isRecord","NotFoundError","Error","code","path","message","name","isNotFoundError","err"],"mappings":"AAAA,SAAQA,QAAQ,QAAO,gBAAe;AAEtC;;;;;;CAMC,GACD,OAAO,MAAMC,sBAAsBC;IACjCC,OAAO,SAAQ;IACfC,KAAa;IAEb,YAAYC,OAAe,EAAED,IAAa,CAAE;QAC1C,KAAK,CAACC;QACN,IAAI,CAACD,IAAI,GAAGA;QACZ,IAAI,CAACE,IAAI,GAAG;IACd;AACF;AAEA;;;;;;CAMC,GACD,OAAO,SAASC,gBAAgBC,GAAY;IAC1C,OACER,SAASQ,QACT,UAAUA,OACVA,IAAIF,IAAI,KAAK,mBACb,UAAUE,OACVA,IAAIL,IAAI,KAAK,YACb,aAAaK,OACb,OAAOA,IAAIH,OAAO,KAAK;AAE3B"}

package/dist/util/__tests__/createExpiringConfig.test.js

@@ -0,0 +1,309 @@
+import { beforeEach, describe, expect, test, vi } from 'vitest';
+import { createExpiringConfig } from '../createExpiringConfig.js';
+describe('createExpiringConfig', ()=>{
+    let mockStore;
+    let fetchValue;
+    let onCacheHit;
+    let onFetch;
+    let onRevalidate;
+    beforeEach(()=>{
+        // Mock ConfigStore
+        mockStore = {
+            delete: vi.fn(),
+            get: vi.fn(),
+            set: vi.fn()
+        };
+        // Reset all mocks
+        fetchValue = vi.fn();
+        onCacheHit = vi.fn();
+        onFetch = vi.fn();
+        onRevalidate = vi.fn();
+    });
+    test('returns fetched value when cache is empty', async ()=>{
+        const testValue = 'test-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(testValue),
+            key: 'test-key',
+            onCacheHit,
+            onFetch,
+            onRevalidate,
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        const result = await config.get();
+        expect(result).toBe(testValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onFetch).toHaveBeenCalledOnce();
+        expect(onCacheHit).not.toHaveBeenCalled();
+        expect(onRevalidate).not.toHaveBeenCalled();
+        expect(mockStore.set).toHaveBeenCalledWith('test-key', {
+            updatedAt: expect.any(Number),
+            value: testValue
+        });
+    });
+    test('returns cached value when it has not expired', async ()=>{
+        const cachedValue = 'cached-value';
+        const ttl = 5000;
+        const updatedAt = Date.now() - 1000 // 1 second ago (not expired)
+        ;
+        const config = createExpiringConfig({
+            fetchValue,
+            key: 'test-key',
+            onCacheHit,
+            onFetch,
+            onRevalidate,
+            store: mockStore,
+            ttl
+        });
+        // Mock cached value that hasn't expired
+        vi.mocked(mockStore.get).mockReturnValue({
+            updatedAt,
+            value: cachedValue
+        });
+        const result = await config.get();
+        expect(result).toBe(cachedValue);
+        expect(fetchValue).not.toHaveBeenCalled();
+        expect(onCacheHit).toHaveBeenCalledOnce();
+        expect(onFetch).not.toHaveBeenCalled();
+        expect(onRevalidate).not.toHaveBeenCalled();
+        expect(mockStore.set).not.toHaveBeenCalled();
+    });
+    test('fetches new value when cached value has expired', async ()=>{
+        const newValue = 'new-value';
+        const ttl = 1000;
+        const updatedAt = Date.now() - 2000 // 2 seconds ago (expired)
+        ;
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(newValue),
+            key: 'test-key',
+            onCacheHit,
+            onFetch,
+            onRevalidate,
+            store: mockStore,
+            ttl
+        });
+        // Mock expired cached value
+        vi.mocked(mockStore.get).mockReturnValue({
+            updatedAt,
+            value: 'old-value'
+        });
+        const result = await config.get();
+        expect(result).toBe(newValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onRevalidate).toHaveBeenCalledOnce();
+        expect(onFetch).toHaveBeenCalledOnce();
+        expect(onCacheHit).not.toHaveBeenCalled();
+        expect(mockStore.set).toHaveBeenCalledWith('test-key', {
+            updatedAt: expect.any(Number),
+            value: newValue
+        });
+    });
+    test('deletes cached value from store', ()=>{
+        const config = createExpiringConfig({
+            fetchValue,
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        config.delete();
+        expect(mockStore.delete).toHaveBeenCalledWith('test-key');
+    });
+    test('handles concurrent get() calls correctly', async ()=>{
+        const testValue = 'test-value';
+        let resolvePromise;
+        const delayedFetch = new Promise((resolve)=>{
+            resolvePromise = resolve;
+        });
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockReturnValue(delayedFetch),
+            key: 'test-key',
+            onFetch,
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        // Start multiple concurrent get() calls
+        const promise1 = config.get();
+        const promise2 = config.get();
+        const promise3 = config.get();
+        // Resolve the fetch
+        resolvePromise(testValue);
+        const [result1, result2, result3] = await Promise.all([
+            promise1,
+            promise2,
+            promise3
+        ]);
+        expect(result1).toBe(testValue);
+        expect(result2).toBe(testValue);
+        expect(result3).toBe(testValue);
+        expect(fetchValue).toHaveBeenCalledOnce(); // Only one fetch should happen
+        expect(onFetch).toHaveBeenCalledOnce();
+    });
+    test('handles synchronous fetchValue function', async ()=>{
+        const testValue = 'sync-value';
+        const syncFetchValue = vi.fn().mockReturnValue(testValue);
+        const config = createExpiringConfig({
+            fetchValue: syncFetchValue,
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        const result = await config.get();
+        expect(result).toBe(testValue);
+        expect(syncFetchValue).toHaveBeenCalledOnce();
+    });
+    test('handles fetchValue throwing an error', async ()=>{
+        const error = new Error('Fetch failed');
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockRejectedValue(error),
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        await expect(config.get()).rejects.toThrow('Fetch failed');
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(mockStore.set).not.toHaveBeenCalled();
+    });
+    test('handles different data types as cached values', async ()=>{
+        const objectValue = {
+            key: 'value',
+            number: 42
+        };
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(objectValue),
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        const result = await config.get();
+        expect(result).toEqual(objectValue);
+        expect(mockStore.set).toHaveBeenCalledWith('test-key', {
+            updatedAt: expect.any(Number),
+            value: objectValue
+        });
+    });
+    test('works with TTL of 0 (immediate expiration)', async ()=>{
+        const testValue = 'test-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(testValue),
+            key: 'test-key',
+            onRevalidate,
+            store: mockStore,
+            ttl: 0
+        });
+        // Mock cached value that would be immediately expired
+        // Use a timestamp from 1ms ago to ensure it's > ttl (0)
+        vi.mocked(mockStore.get).mockReturnValue({
+            updatedAt: Date.now() - 1,
+            value: 'old-value'
+        });
+        const result = await config.get();
+        expect(result).toBe(testValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onRevalidate).toHaveBeenCalledOnce();
+    });
+    test('works without optional callback functions', async ()=>{
+        const testValue = 'test-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(testValue),
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        const result = await config.get();
+        expect(result).toBe(testValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+    });
+    test('handles cached value without updatedAt timestamp', async ()=>{
+        const newValue = 'new-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(newValue),
+            key: 'test-key',
+            onFetch,
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock cached value without updatedAt (invalid cache entry)
+        vi.mocked(mockStore.get).mockReturnValue({
+            value: 'old-value'
+        });
+        const result = await config.get();
+        expect(result).toBe(newValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onFetch).toHaveBeenCalledOnce();
+    });
+    test('handles cached value without value property', async ()=>{
+        const newValue = 'new-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(newValue),
+            key: 'test-key',
+            onFetch,
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock cached entry without value property
+        vi.mocked(mockStore.get).mockReturnValue({
+            updatedAt: Date.now()
+        });
+        const result = await config.get();
+        expect(result).toBe(newValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onFetch).toHaveBeenCalledOnce();
+    });
+    test('stores timestamp correctly when caching new values', async ()=>{
+        const testValue = 'test-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(testValue),
+            key: 'test-key',
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache
+        vi.mocked(mockStore.get).mockReturnValue(undefined);
+        await config.get();
+        expect(mockStore.set).toHaveBeenCalledWith('test-key', {
+            updatedAt: expect.any(Number),
+            value: testValue
+        });
+    });
+    test('subsequent requests after cache is populated use cached value', async ()=>{
+        const testValue = 'test-value';
+        const config = createExpiringConfig({
+            fetchValue: fetchValue.mockResolvedValue(testValue),
+            key: 'test-key',
+            onCacheHit,
+            onFetch,
+            store: mockStore,
+            ttl: 5000
+        });
+        // Mock empty cache for first request
+        vi.mocked(mockStore.get).mockReturnValueOnce(undefined);
+        // First request should fetch
+        const result1 = await config.get();
+        // Mock cache populated for subsequent request
+        vi.mocked(mockStore.get).mockReturnValueOnce({
+            updatedAt: Date.now(),
+            value: testValue
+        });
+        // Second request should hit cache
+        const result2 = await config.get();
+        expect(result1).toBe(testValue);
+        expect(result2).toBe(testValue);
+        expect(fetchValue).toHaveBeenCalledOnce();
+        expect(onFetch).toHaveBeenCalledOnce();
+        expect(onCacheHit).toHaveBeenCalledOnce();
+    });
+});
+
+//# sourceMappingURL=createExpiringConfig.test.js.map

package/dist/util/__tests__/createExpiringConfig.test.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../../src/util/__tests__/createExpiringConfig.test.ts"],"sourcesContent":["import type ConfigStore from 'configstore'\n\nimport {beforeEach, describe, expect, test, vi} from 'vitest'\n\nimport {createExpiringConfig} from '../createExpiringConfig.js'\n\ndescribe('createExpiringConfig', () => {\n  let mockStore: ConfigStore\n  let fetchValue: ReturnType<typeof vi.fn>\n  let onCacheHit: ReturnType<typeof vi.fn>\n  let onFetch: ReturnType<typeof vi.fn>\n  let onRevalidate: ReturnType<typeof vi.fn>\n\n  beforeEach(() => {\n    // Mock ConfigStore\n    mockStore = {\n      delete: vi.fn(),\n      get: vi.fn(),\n      set: vi.fn(),\n    } as unknown as ConfigStore\n\n    // Reset all mocks\n    fetchValue = vi.fn()\n    onCacheHit = vi.fn()\n    onFetch = vi.fn()\n    onRevalidate = vi.fn()\n  })\n\n  test('returns fetched value when cache is empty', async () => {\n    const testValue = 'test-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(testValue),\n      key: 'test-key',\n      onCacheHit,\n      onFetch,\n      onRevalidate,\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    const result = await config.get()\n\n    expect(result).toBe(testValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onFetch).toHaveBeenCalledOnce()\n    expect(onCacheHit).not.toHaveBeenCalled()\n    expect(onRevalidate).not.toHaveBeenCalled()\n    expect(mockStore.set).toHaveBeenCalledWith('test-key', {\n      updatedAt: expect.any(Number),\n      value: testValue,\n    })\n  })\n\n  test('returns cached value when it has not expired', async () => {\n    const cachedValue = 'cached-value'\n    const ttl = 5000\n    const updatedAt = Date.now() - 1000 // 1 second ago (not expired)\n\n    const config = createExpiringConfig({\n      fetchValue,\n      key: 'test-key',\n      onCacheHit,\n      onFetch,\n      onRevalidate,\n      store: mockStore,\n      ttl,\n    })\n\n    // Mock cached value that hasn't expired\n    vi.mocked(mockStore.get).mockReturnValue({\n      updatedAt,\n      value: cachedValue,\n    })\n\n    const result = await config.get()\n\n    expect(result).toBe(cachedValue)\n    expect(fetchValue).not.toHaveBeenCalled()\n    expect(onCacheHit).toHaveBeenCalledOnce()\n    expect(onFetch).not.toHaveBeenCalled()\n    expect(onRevalidate).not.toHaveBeenCalled()\n    expect(mockStore.set).not.toHaveBeenCalled()\n  })\n\n  test('fetches new value when cached value has expired', async () => {\n    const newValue = 'new-value'\n    const ttl = 1000\n    const updatedAt = Date.now() - 2000 // 2 seconds ago (expired)\n\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(newValue),\n      key: 'test-key',\n      onCacheHit,\n      onFetch,\n      onRevalidate,\n      store: mockStore,\n      ttl,\n    })\n\n    // Mock expired cached value\n    vi.mocked(mockStore.get).mockReturnValue({\n      updatedAt,\n      value: 'old-value',\n    })\n\n    const result = await config.get()\n\n    expect(result).toBe(newValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onRevalidate).toHaveBeenCalledOnce()\n    expect(onFetch).toHaveBeenCalledOnce()\n    expect(onCacheHit).not.toHaveBeenCalled()\n    expect(mockStore.set).toHaveBeenCalledWith('test-key', {\n      updatedAt: expect.any(Number),\n      value: newValue,\n    })\n  })\n\n  test('deletes cached value from store', () => {\n    const config = createExpiringConfig({\n      fetchValue,\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    config.delete()\n\n    expect(mockStore.delete).toHaveBeenCalledWith('test-key')\n  })\n\n  test('handles concurrent get() calls correctly', async () => {\n    const testValue = 'test-value'\n    let resolvePromise: (value: string) => void\n    const delayedFetch = new Promise<string>((resolve) => {\n      resolvePromise = resolve\n    })\n\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockReturnValue(delayedFetch),\n      key: 'test-key',\n      onFetch,\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    // Start multiple concurrent get() calls\n    const promise1 = config.get()\n    const promise2 = config.get()\n    const promise3 = config.get()\n\n    // Resolve the fetch\n    resolvePromise!(testValue)\n\n    const [result1, result2, result3] = await Promise.all([promise1, promise2, promise3])\n\n    expect(result1).toBe(testValue)\n    expect(result2).toBe(testValue)\n    expect(result3).toBe(testValue)\n    expect(fetchValue).toHaveBeenCalledOnce() // Only one fetch should happen\n    expect(onFetch).toHaveBeenCalledOnce()\n  })\n\n  test('handles synchronous fetchValue function', async () => {\n    const testValue = 'sync-value'\n    const syncFetchValue = vi.fn().mockReturnValue(testValue)\n\n    const config = createExpiringConfig({\n      fetchValue: syncFetchValue,\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    const result = await config.get()\n\n    expect(result).toBe(testValue)\n    expect(syncFetchValue).toHaveBeenCalledOnce()\n  })\n\n  test('handles fetchValue throwing an error', async () => {\n    const error = new Error('Fetch failed')\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockRejectedValue(error),\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    await expect(config.get()).rejects.toThrow('Fetch failed')\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(mockStore.set).not.toHaveBeenCalled()\n  })\n\n  test('handles different data types as cached values', async () => {\n    const objectValue = {key: 'value', number: 42}\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(objectValue),\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    const result = await config.get()\n\n    expect(result).toEqual(objectValue)\n    expect(mockStore.set).toHaveBeenCalledWith('test-key', {\n      updatedAt: expect.any(Number),\n      value: objectValue,\n    })\n  })\n\n  test('works with TTL of 0 (immediate expiration)', async () => {\n    const testValue = 'test-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(testValue),\n      key: 'test-key',\n      onRevalidate,\n      store: mockStore,\n      ttl: 0,\n    })\n\n    // Mock cached value that would be immediately expired\n    // Use a timestamp from 1ms ago to ensure it's > ttl (0)\n    vi.mocked(mockStore.get).mockReturnValue({\n      updatedAt: Date.now() - 1,\n      value: 'old-value',\n    })\n\n    const result = await config.get()\n\n    expect(result).toBe(testValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onRevalidate).toHaveBeenCalledOnce()\n  })\n\n  test('works without optional callback functions', async () => {\n    const testValue = 'test-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(testValue),\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    const result = await config.get()\n\n    expect(result).toBe(testValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n  })\n\n  test('handles cached value without updatedAt timestamp', async () => {\n    const newValue = 'new-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(newValue),\n      key: 'test-key',\n      onFetch,\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock cached value without updatedAt (invalid cache entry)\n    vi.mocked(mockStore.get).mockReturnValue({\n      value: 'old-value',\n      // updatedAt is missing\n    })\n\n    const result = await config.get()\n\n    expect(result).toBe(newValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onFetch).toHaveBeenCalledOnce()\n  })\n\n  test('handles cached value without value property', async () => {\n    const newValue = 'new-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(newValue),\n      key: 'test-key',\n      onFetch,\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock cached entry without value property\n    vi.mocked(mockStore.get).mockReturnValue({\n      updatedAt: Date.now(),\n      // value is missing\n    })\n\n    const result = await config.get()\n\n    expect(result).toBe(newValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onFetch).toHaveBeenCalledOnce()\n  })\n\n  test('stores timestamp correctly when caching new values', async () => {\n    const testValue = 'test-value'\n\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(testValue),\n      key: 'test-key',\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache\n    vi.mocked(mockStore.get).mockReturnValue(undefined)\n\n    await config.get()\n\n    expect(mockStore.set).toHaveBeenCalledWith('test-key', {\n      updatedAt: expect.any(Number),\n      value: testValue,\n    })\n  })\n\n  test('subsequent requests after cache is populated use cached value', async () => {\n    const testValue = 'test-value'\n    const config = createExpiringConfig({\n      fetchValue: fetchValue.mockResolvedValue(testValue),\n      key: 'test-key',\n      onCacheHit,\n      onFetch,\n      store: mockStore,\n      ttl: 5000,\n    })\n\n    // Mock empty cache for first request\n    vi.mocked(mockStore.get).mockReturnValueOnce(undefined)\n\n    // First request should fetch\n    const result1 = await config.get()\n\n    // Mock cache populated for subsequent request\n    vi.mocked(mockStore.get).mockReturnValueOnce({\n      updatedAt: Date.now(),\n      value: testValue,\n    })\n\n    // Second request should hit cache\n    const result2 = await config.get()\n\n    expect(result1).toBe(testValue)\n    expect(result2).toBe(testValue)\n    expect(fetchValue).toHaveBeenCalledOnce()\n    expect(onFetch).toHaveBeenCalledOnce()\n    expect(onCacheHit).toHaveBeenCalledOnce()\n  })\n})\n"],"names":["beforeEach","describe","expect","test","vi","createExpiringConfig","mockStore","fetchValue","onCacheHit","onFetch","onRevalidate","delete","fn","get","set","testValue","config","mockResolvedValue","key","store","ttl","mocked","mockReturnValue","undefined","result","toBe","toHaveBeenCalledOnce","not","toHaveBeenCalled","toHaveBeenCalledWith","updatedAt","any","Number","value","cachedValue","Date","now","newValue","resolvePromise","delayedFetch","Promise","resolve","promise1","promise2","promise3","result1","result2","result3","all","syncFetchValue","error","Error","mockRejectedValue","rejects","toThrow","objectValue","number","toEqual","mockReturnValueOnce"],"mappings":"AAEA,SAAQA,UAAU,EAAEC,QAAQ,EAAEC,MAAM,EAAEC,IAAI,EAAEC,EAAE,QAAO,SAAQ;AAE7D,SAAQC,oBAAoB,QAAO,6BAA4B;AAE/DJ,SAAS,wBAAwB;IAC/B,IAAIK;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IACJ,IAAIC;IAEJV,WAAW;QACT,mBAAmB;QACnBM,YAAY;YACVK,QAAQP,GAAGQ,EAAE;YACbC,KAAKT,GAAGQ,EAAE;YACVE,KAAKV,GAAGQ,EAAE;QACZ;QAEA,kBAAkB;QAClBL,aAAaH,GAAGQ,EAAE;QAClBJ,aAAaJ,GAAGQ,EAAE;QAClBH,UAAUL,GAAGQ,EAAE;QACfF,eAAeN,GAAGQ,EAAE;IACtB;IAEAT,KAAK,6CAA6C;QAChD,MAAMY,YAAY;QAClB,MAAMC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACF;YACzCG,KAAK;YACLV;YACAC;YACAC;YACAS,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMC,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACV;QACpBb,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOO,SAASiB,oBAAoB;QACpCxB,OAAOM,YAAYmB,GAAG,CAACC,gBAAgB;QACvC1B,OAAOQ,cAAciB,GAAG,CAACC,gBAAgB;QACzC1B,OAAOI,UAAUQ,GAAG,EAAEe,oBAAoB,CAAC,YAAY;YACrDC,WAAW5B,OAAO6B,GAAG,CAACC;YACtBC,OAAOlB;QACT;IACF;IAEAZ,KAAK,gDAAgD;QACnD,MAAM+B,cAAc;QACpB,MAAMd,MAAM;QACZ,MAAMU,YAAYK,KAAKC,GAAG,KAAK,KAAK,6BAA6B;;QAEjE,MAAMpB,SAASX,qBAAqB;YAClCE;YACAW,KAAK;YACLV;YACAC;YACAC;YACAS,OAAOb;YACPc;QACF;QAEA,wCAAwC;QACxChB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAAC;YACvCQ;YACAG,OAAOC;QACT;QAEA,MAAMV,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACS;QACpBhC,OAAOK,YAAYoB,GAAG,CAACC,gBAAgB;QACvC1B,OAAOM,YAAYkB,oBAAoB;QACvCxB,OAAOO,SAASkB,GAAG,CAACC,gBAAgB;QACpC1B,OAAOQ,cAAciB,GAAG,CAACC,gBAAgB;QACzC1B,OAAOI,UAAUQ,GAAG,EAAEa,GAAG,CAACC,gBAAgB;IAC5C;IAEAzB,KAAK,mDAAmD;QACtD,MAAMkC,WAAW;QACjB,MAAMjB,MAAM;QACZ,MAAMU,YAAYK,KAAKC,GAAG,KAAK,KAAK,0BAA0B;;QAE9D,MAAMpB,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACoB;YACzCnB,KAAK;YACLV;YACAC;YACAC;YACAS,OAAOb;YACPc;QACF;QAEA,4BAA4B;QAC5BhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAAC;YACvCQ;YACAG,OAAO;QACT;QAEA,MAAMT,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACY;QACpBnC,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOQ,cAAcgB,oBAAoB;QACzCxB,OAAOO,SAASiB,oBAAoB;QACpCxB,OAAOM,YAAYmB,GAAG,CAACC,gBAAgB;QACvC1B,OAAOI,UAAUQ,GAAG,EAAEe,oBAAoB,CAAC,YAAY;YACrDC,WAAW5B,OAAO6B,GAAG,CAACC;YACtBC,OAAOI;QACT;IACF;IAEAlC,KAAK,mCAAmC;QACtC,MAAMa,SAASX,qBAAqB;YAClCE;YACAW,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEAJ,OAAOL,MAAM;QAEbT,OAAOI,UAAUK,MAAM,EAAEkB,oBAAoB,CAAC;IAChD;IAEA1B,KAAK,4CAA4C;QAC/C,MAAMY,YAAY;QAClB,IAAIuB;QACJ,MAAMC,eAAe,IAAIC,QAAgB,CAACC;YACxCH,iBAAiBG;QACnB;QAEA,MAAMzB,SAASX,qBAAqB;YAClCE,YAAYA,WAAWe,eAAe,CAACiB;YACvCrB,KAAK;YACLT;YACAU,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,wCAAwC;QACxC,MAAMmB,WAAW1B,OAAOH,GAAG;QAC3B,MAAM8B,WAAW3B,OAAOH,GAAG;QAC3B,MAAM+B,WAAW5B,OAAOH,GAAG;QAE3B,oBAAoB;QACpByB,eAAgBvB;QAEhB,MAAM,CAAC8B,SAASC,SAASC,QAAQ,GAAG,MAAMP,QAAQQ,GAAG,CAAC;YAACN;YAAUC;YAAUC;SAAS;QAEpF1C,OAAO2C,SAASpB,IAAI,CAACV;QACrBb,OAAO4C,SAASrB,IAAI,CAACV;QACrBb,OAAO6C,SAAStB,IAAI,CAACV;QACrBb,OAAOK,YAAYmB,oBAAoB,IAAG,+BAA+B;QACzExB,OAAOO,SAASiB,oBAAoB;IACtC;IAEAvB,KAAK,2CAA2C;QAC9C,MAAMY,YAAY;QAClB,MAAMkC,iBAAiB7C,GAAGQ,EAAE,GAAGU,eAAe,CAACP;QAE/C,MAAMC,SAASX,qBAAqB;YAClCE,YAAY0C;YACZ/B,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMC,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACV;QACpBb,OAAO+C,gBAAgBvB,oBAAoB;IAC7C;IAEAvB,KAAK,wCAAwC;QAC3C,MAAM+C,QAAQ,IAAIC,MAAM;QACxB,MAAMnC,SAASX,qBAAqB;YAClCE,YAAYA,WAAW6C,iBAAiB,CAACF;YACzChC,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMrB,OAAOc,OAAOH,GAAG,IAAIwC,OAAO,CAACC,OAAO,CAAC;QAC3CpD,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOI,UAAUQ,GAAG,EAAEa,GAAG,CAACC,gBAAgB;IAC5C;IAEAzB,KAAK,iDAAiD;QACpD,MAAMoD,cAAc;YAACrC,KAAK;YAASsC,QAAQ;QAAE;QAC7C,MAAMxC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACsC;YACzCrC,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMC,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQiC,OAAO,CAACF;QACvBrD,OAAOI,UAAUQ,GAAG,EAAEe,oBAAoB,CAAC,YAAY;YACrDC,WAAW5B,OAAO6B,GAAG,CAACC;YACtBC,OAAOsB;QACT;IACF;IAEApD,KAAK,8CAA8C;QACjD,MAAMY,YAAY;QAClB,MAAMC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACF;YACzCG,KAAK;YACLR;YACAS,OAAOb;YACPc,KAAK;QACP;QAEA,sDAAsD;QACtD,wDAAwD;QACxDhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAAC;YACvCQ,WAAWK,KAAKC,GAAG,KAAK;YACxBH,OAAO;QACT;QAEA,MAAMT,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACV;QACpBb,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOQ,cAAcgB,oBAAoB;IAC3C;IAEAvB,KAAK,6CAA6C;QAChD,MAAMY,YAAY;QAClB,MAAMC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACF;YACzCG,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMC,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACV;QACpBb,OAAOK,YAAYmB,oBAAoB;IACzC;IAEAvB,KAAK,oDAAoD;QACvD,MAAMkC,WAAW;QACjB,MAAMrB,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACoB;YACzCnB,KAAK;YACLT;YACAU,OAAOb;YACPc,KAAK;QACP;QAEA,4DAA4D;QAC5DhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAAC;YACvCW,OAAO;QAET;QAEA,MAAMT,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACY;QACpBnC,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOO,SAASiB,oBAAoB;IACtC;IAEAvB,KAAK,+CAA+C;QAClD,MAAMkC,WAAW;QACjB,MAAMrB,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACoB;YACzCnB,KAAK;YACLT;YACAU,OAAOb;YACPc,KAAK;QACP;QAEA,2CAA2C;QAC3ChB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAAC;YACvCQ,WAAWK,KAAKC,GAAG;QAErB;QAEA,MAAMZ,SAAS,MAAMR,OAAOH,GAAG;QAE/BX,OAAOsB,QAAQC,IAAI,CAACY;QACpBnC,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOO,SAASiB,oBAAoB;IACtC;IAEAvB,KAAK,sDAAsD;QACzD,MAAMY,YAAY;QAElB,MAAMC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACF;YACzCG,KAAK;YACLC,OAAOb;YACPc,KAAK;QACP;QAEA,mBAAmB;QACnBhB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAES,eAAe,CAACC;QAEzC,MAAMP,OAAOH,GAAG;QAEhBX,OAAOI,UAAUQ,GAAG,EAAEe,oBAAoB,CAAC,YAAY;YACrDC,WAAW5B,OAAO6B,GAAG,CAACC;YACtBC,OAAOlB;QACT;IACF;IAEAZ,KAAK,iEAAiE;QACpE,MAAMY,YAAY;QAClB,MAAMC,SAASX,qBAAqB;YAClCE,YAAYA,WAAWU,iBAAiB,CAACF;YACzCG,KAAK;YACLV;YACAC;YACAU,OAAOb;YACPc,KAAK;QACP;QAEA,qCAAqC;QACrChB,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAE6C,mBAAmB,CAACnC;QAE7C,6BAA6B;QAC7B,MAAMsB,UAAU,MAAM7B,OAAOH,GAAG;QAEhC,8CAA8C;QAC9CT,GAAGiB,MAAM,CAACf,UAAUO,GAAG,EAAE6C,mBAAmB,CAAC;YAC3C5B,WAAWK,KAAKC,GAAG;YACnBH,OAAOlB;QACT;QAEA,kCAAkC;QAClC,MAAM+B,UAAU,MAAM9B,OAAOH,GAAG;QAEhCX,OAAO2C,SAASpB,IAAI,CAACV;QACrBb,OAAO4C,SAASrB,IAAI,CAACV;QACrBb,OAAOK,YAAYmB,oBAAoB;QACvCxB,OAAOO,SAASiB,oBAAoB;QACpCxB,OAAOM,YAAYkB,oBAAoB;IACzC;AACF"}

package/dist/util/createExpiringConfig.d.ts

@@ -0,0 +1,32 @@
+import type ConfigStore from 'configstore';
+export interface ExpiringConfigOptions<Type> {
+    /** Fetch value */
+    fetchValue: () => Promise<Type> | Type;
+    /** Config key */
+    key: string;
+    /** Config store */
+    store: ConfigStore;
+    /** TTL (milliseconds) */
+    ttl: number;
+    /** Subscribe to cache hit event */
+    onCacheHit?: () => void;
+    /** Subscribe to fetch event */
+    onFetch?: () => void;
+    /** Subscribe to revalidate event */
+    onRevalidate?: () => void;
+}
+export interface ExpiringConfigApi<Type> {
+    /**
+     * Delete the cached value.
+     */
+    delete: () => void;
+    /**
+     * Attempt to get the cached value. If there is no cached value, or the cached value has expired,
+     * fetch, cache, and return the value.
+     */
+    get: () => Promise<Type>;
+}
+/**
+ * Create a config in the provided config store that expires after the provided TTL.
+ */
+export declare function createExpiringConfig<Type>({ fetchValue, key, onCacheHit, onFetch, onRevalidate, store, ttl, }: ExpiringConfigOptions<Type>): ExpiringConfigApi<Type>;

package/dist/util/createExpiringConfig.js

@@ -0,0 +1,35 @@
+/**
+ * Create a config in the provided config store that expires after the provided TTL.
+ */ export function createExpiringConfig({ fetchValue, key, onCacheHit = ()=>null, onFetch = ()=>null, onRevalidate = ()=>null, store, ttl }) {
+    let currentFetch = null;
+    return {
+        delete () {
+            store.delete(key);
+        },
+        async get () {
+            const { updatedAt, value } = store.get(key) ?? {};
+            if (value && updatedAt) {
+                const hasExpired = Date.now() - updatedAt > ttl;
+                if (!hasExpired) {
+                    onCacheHit();
+                    return value;
+                }
+                onRevalidate();
+            }
+            if (currentFetch) {
+                return currentFetch;
+            }
+            onFetch();
+            currentFetch = Promise.resolve(fetchValue());
+            const nextValue = await currentFetch;
+            currentFetch = null;
+            store.set(key, {
+                updatedAt: Date.now(),
+                value: nextValue
+            });
+            return nextValue;
+        }
+    };
+}
+
+//# sourceMappingURL=createExpiringConfig.js.map

package/dist/util/createExpiringConfig.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/util/createExpiringConfig.ts"],"sourcesContent":["import type ConfigStore from 'configstore'\n\nexport interface ExpiringConfigOptions<Type> {\n  /** Fetch value */\n  fetchValue: () => Promise<Type> | Type\n  /** Config key */\n  key: string\n  /** Config store */\n  store: ConfigStore\n  /** TTL (milliseconds) */\n  ttl: number\n\n  /** Subscribe to cache hit event */\n  onCacheHit?: () => void\n  /** Subscribe to fetch event */\n  onFetch?: () => void\n  /** Subscribe to revalidate event */\n  onRevalidate?: () => void\n}\n\nexport interface ExpiringConfigApi<Type> {\n  /**\n   * Delete the cached value.\n   */\n  delete: () => void\n  /**\n   * Attempt to get the cached value. If there is no cached value, or the cached value has expired,\n   * fetch, cache, and return the value.\n   */\n  get: () => Promise<Type>\n}\n\n/**\n * Create a config in the provided config store that expires after the provided TTL.\n */\nexport function createExpiringConfig<Type>({\n  fetchValue,\n  key,\n  onCacheHit = () => null,\n  onFetch = () => null,\n  onRevalidate = () => null,\n  store,\n  ttl,\n}: ExpiringConfigOptions<Type>): ExpiringConfigApi<Type> {\n  let currentFetch: Promise<Type> | null = null\n  return {\n    delete() {\n      store.delete(key)\n    },\n    async get() {\n      const {updatedAt, value} = store.get(key) ?? {}\n\n      if (value && updatedAt) {\n        const hasExpired = Date.now() - updatedAt > ttl\n\n        if (!hasExpired) {\n          onCacheHit()\n          return value\n        }\n\n        onRevalidate()\n      }\n\n      if (currentFetch) {\n        return currentFetch\n      }\n      onFetch()\n\n      currentFetch = Promise.resolve(fetchValue())\n      const nextValue = await currentFetch\n      currentFetch = null\n\n      store.set(key, {\n        updatedAt: Date.now(),\n        value: nextValue,\n      })\n\n      return nextValue\n    },\n  }\n}\n"],"names":["createExpiringConfig","fetchValue","key","onCacheHit","onFetch","onRevalidate","store","ttl","currentFetch","delete","get","updatedAt","value","hasExpired","Date","now","Promise","resolve","nextValue","set"],"mappings":"AAgCA;;CAEC,GACD,OAAO,SAASA,qBAA2B,EACzCC,UAAU,EACVC,GAAG,EACHC,aAAa,IAAM,IAAI,EACvBC,UAAU,IAAM,IAAI,EACpBC,eAAe,IAAM,IAAI,EACzBC,KAAK,EACLC,GAAG,EACyB;IAC5B,IAAIC,eAAqC;IACzC,OAAO;QACLC;YACEH,MAAMG,MAAM,CAACP;QACf;QACA,MAAMQ;YACJ,MAAM,EAACC,SAAS,EAAEC,KAAK,EAAC,GAAGN,MAAMI,GAAG,CAACR,QAAQ,CAAC;YAE9C,IAAIU,SAASD,WAAW;gBACtB,MAAME,aAAaC,KAAKC,GAAG,KAAKJ,YAAYJ;gBAE5C,IAAI,CAACM,YAAY;oBACfV;oBACA,OAAOS;gBACT;gBAEAP;YACF;YAEA,IAAIG,cAAc;gBAChB,OAAOA;YACT;YACAJ;YAEAI,eAAeQ,QAAQC,OAAO,CAAChB;YAC/B,MAAMiB,YAAY,MAAMV;YACxBA,eAAe;YAEfF,MAAMa,GAAG,CAACjB,KAAK;gBACbS,WAAWG,KAAKC,GAAG;gBACnBH,OAAOM;YACT;YAEA,OAAOA;QACT;IACF;AACF"}