@zapier/zapier-sdk 0.45.2 → 0.46.1

package/dist/cache.d.ts

@@ -0,0 +1,50 @@
+/**
+ * Best-effort cache for the SDK.
+ *
+ * The SDK uses this to avoid re-fetching values it can recreate, primarily
+ * client_credentials access tokens. Cache entries may disappear at any time:
+ * a miss is normal and callers must be able to rebuild the value.
+ *
+ * The default cache is in-memory. When the CLI package is installed, the SDK
+ * can opportunistically use its filesystem + keychain cache. Browser and
+ * minimal server deployments fall back to memory unless a caller injects a
+ * Redis, database, or environment-specific cache.
+ *
+ * Secrets: adapters receive a `secret: true` flag on `set` and decide
+ * what to do with it (keychain for the filesystem adapter; ignored for
+ * the in-memory adapter; user adapters can throw, plaintext, encrypt —
+ * their call). The value returned by `get` is always the plain secret.
+ */
+export interface ZapierCacheEntry {
+    value: string;
+    /** Millisecond epoch. Undefined means "no expiration recorded." */
+    expiresAt?: number;
+}
+export interface ZapierCacheSetOptions {
+    /**
+     * Hint that this value is sensitive. Adapters may use a more secure
+     * backend (e.g. the OS keychain for the filesystem adapter); adapters
+     * without a secure backend may throw, warn, or accept — their call.
+     */
+    secret?: boolean;
+    /** Time-to-live in seconds from now. */
+    ttl?: number;
+}
+export interface ZapierCache {
+    get(key: string): Promise<ZapierCacheEntry | undefined>;
+    set(key: string, value: string, options?: ZapierCacheSetOptions): Promise<void>;
+    delete(key: string): Promise<void>;
+    /**
+     * Optional mutex for caches that can coordinate beyond one JavaScript
+     * process. The SDK re-checks the cache inside the lock before rebuilding.
+     */
+    withLock?<T>(key: string, fn: () => Promise<T>): Promise<T>;
+}
+/**
+ * Simplest possible adapter: a Map. No persistence, no locking (single
+ * process only), no differentiation between secrets and non-secrets.
+ * This is the default when cli-login isn't installed and no custom
+ * cache is provided.
+ */
+export declare function createMemoryCache(): ZapierCache;
+//# sourceMappingURL=cache.d.ts.map

package/dist/cache.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cache.d.ts","sourceRoot":"","sources":["../src/cache.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AAEH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,MAAM,CAAC;IACd,mEAAmE;IACnE,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,wCAAwC;IACxC,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,WAAW;IAC1B,GAAG,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,GAAG,SAAS,CAAC,CAAC;IACxD,GAAG,CACD,GAAG,EAAE,MAAM,EACX,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE,qBAAqB,GAC9B,OAAO,CAAC,IAAI,CAAC,CAAC;IACjB,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnC;;;OAGG;IACH,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC,CAAC;CAC7D;AAED;;;;;GAKG;AACH,wBAAgB,iBAAiB,IAAI,WAAW,CAsB/C"}

package/dist/cache.js

@@ -0,0 +1,47 @@
+/**
+ * Best-effort cache for the SDK.
+ *
+ * The SDK uses this to avoid re-fetching values it can recreate, primarily
+ * client_credentials access tokens. Cache entries may disappear at any time:
+ * a miss is normal and callers must be able to rebuild the value.
+ *
+ * The default cache is in-memory. When the CLI package is installed, the SDK
+ * can opportunistically use its filesystem + keychain cache. Browser and
+ * minimal server deployments fall back to memory unless a caller injects a
+ * Redis, database, or environment-specific cache.
+ *
+ * Secrets: adapters receive a `secret: true` flag on `set` and decide
+ * what to do with it (keychain for the filesystem adapter; ignored for
+ * the in-memory adapter; user adapters can throw, plaintext, encrypt —
+ * their call). The value returned by `get` is always the plain secret.
+ */
+/**
+ * Simplest possible adapter: a Map. No persistence, no locking (single
+ * process only), no differentiation between secrets and non-secrets.
+ * This is the default when cli-login isn't installed and no custom
+ * cache is provided.
+ */
+export function createMemoryCache() {
+    const store = new Map();
+    return {
+        async get(key) {
+            const entry = store.get(key);
+            if (!entry)
+                return undefined;
+            if (entry.expiresAt !== undefined && entry.expiresAt <= Date.now()) {
+                store.delete(key);
+                return undefined;
+            }
+            return { value: entry.value, expiresAt: entry.expiresAt };
+        },
+        async set(key, value, options) {
+            const expiresAt = options?.ttl
+                ? Date.now() + options.ttl * 1000
+                : undefined;
+            store.set(key, { value, expiresAt });
+        },
+        async delete(key) {
+            store.delete(key);
+        },
+    };
+}