@swell/apps-sdk 1.0.39 → 1.0.40

package/dist/src/api.d.ts

@@ -1,7 +1,6 @@
 import SwellJS from 'swell-js';
-import { Cache } from './cache';
-export * from './resources';
 import type { SwellAppConfig, SwellErrorOptions, SwellMenu, SwellData, CFThemeEnv, SwellAppShopifyCompatibilityConfig } from '../types/swell';
+export * from './resources';
 export declare class Swell {
     url: URL;
     headers: SwellData;
@@ -16,7 +15,6 @@ export declare class Swell {
     isPreview: boolean;
     isEditor: boolean;
     sentResponse: boolean;
-    static cache: Map<string, Cache>;
     storefront_url?: string;
     constructor(params: {
         url: URL | string;
@@ -36,40 +34,17 @@ export declare class Swell {
         swellHeaders: SwellData;
     };
     static formatQueryParams(queryParams?: URLSearchParams | SwellData): SwellData;
-    getClientProps(): {
-        url: URL;
-        headers: SwellData;
-        swellHeaders: SwellData;
-        queryParams: SwellData;
-        instanceId: string;
-        isPreview: boolean;
-        isEditor: boolean;
-        cache: unknown[][];
-        storefrontSettingStates: {
-            state: any;
-            menuState: any;
-            paymentState: any;
-            subscriptionState: any;
-            sessionState: any;
-        };
-    };
-    getStorefrontInstance(params: SwellData): typeof SwellJS;
-    isStorefrontRequestCacheable(method: string, url: string): boolean;
-    getCacheableStorefrontRequestHandler<T>(storefront: typeof SwellJS): (method: string, url: string, id?: any, data?: any, opt?: any) => T | Promise<T | undefined> | undefined;
-    getCacheInstance(): Cache;
-    setCacheValues(values: any[]): void;
-    getCacheKeyPrefix(): string;
-    getCacheKey(key: string, args?: unknown[]): string;
-    setCachedSync(key: string, args: unknown[], value: unknown, timeout?: number, isSync?: boolean): void | Promise<void>;
-    getCachedSync<T>(key: string, args?: unknown[] | (() => Promise<T> | T), handler?: () => Promise<T> | T, timeout?: number, isSync?: boolean): Promise<T | undefined> | T | undefined;
-    resolveCacheHandler<T>(cacheInstance: Cache, cacheKey: string, cacheHandler: () => Promise<T> | T, timeout?: number, isSync?: boolean): Promise<T> | T | undefined;
-    setCached(key: string, args: unknown[], value: unknown, timeout?: number): Promise<any>;
-    getCached<T>(key: string, args?: unknown[] | (() => Promise<T> | T), handler?: () => Promise<T> | T, timeout?: number): Promise<T | undefined>;
-    getCachedVersion<T>(key: string[], version: string, handler: () => Promise<T> | T, timeout?: number): Promise<T | undefined>;
-    getCachedResource<T>(key: string, args: unknown[] | (() => Promise<T>), handler?: () => Promise<T>, timeout?: number): Promise<T | undefined>;
+    /**
+     * Fetches a theme version resource
+     * First attempts to fetch from cache.
+     */
+    getCachedThemeVersion<T>(key: string, version: string, handler: () => T | Promise<T>): Promise<T>;
+    /**
+     * Fetches a resource.
+     * First attempts to fetch from cache.
+     */
+    getCachedResource<T>(key: string, args: unknown[], handler: () => T | Promise<T>): Promise<T | undefined>;
     updateCacheModified(cacheModified: string): Promise<void>;
-    deleteCachedVersion(key: string): Promise<void>;
-    clearCache(prefix: string): Promise<void>;
     getAppSettings(): Promise<SwellData>;
     getStorefrontSettings(): Promise<SwellData>;
     getStorefrontMenus(): SwellMenu[];
@@ -77,6 +52,22 @@ export declare class Swell {
     put(...args: Parameters<SwellBackendAPI['put']>): Promise<SwellData | undefined>;
     post(...args: Parameters<SwellBackendAPI['post']>): Promise<SwellData | undefined>;
     delete(...args: Parameters<SwellBackendAPI['delete']>): Promise<SwellData | undefined>;
+    private getStorefrontInstance;
+    private isStorefrontRequestCacheable;
+    private getCacheableStorefrontRequestHandler;
+    /**
+     * Caches client theme in perstent cache + in memory.
+     */
+    private getThemeCache;
+    /**
+     * Caches client resources in memory.
+     */
+    private getResourceCache;
+    /**
+     * Caches client storefront API requests in memory.
+     */
+    private getRequestCache;
+    private getCacheKey;
 }
 export declare class SwellBackendAPI {
     apiHost: string;

package/dist/src/cache/cache.d.ts

@@ -0,0 +1,15 @@
+import { type CreateCacheOptions } from 'cache-manager';
+export declare class Cache {
+    private client;
+    constructor(options?: CreateCacheOptions);
+    fetch<T>(key: string, fetchFn: () => T | Promise<T>): Promise<T>;
+    get<T>(key: string): Promise<T | null>;
+    set<T>(key: string, value: T, ttl?: number): Promise<T>;
+    flush(key: string): Promise<void>;
+    /**
+     * Flushes the entire cache.
+     * Warning: If the cache store is shared among many cache clients,
+     *          this will flush entries for other clients.
+     */
+    flushAll(): Promise<void>;
+}

package/dist/src/cache/cf-worker-kv-keyv-adapter.d.ts

@@ -0,0 +1,19 @@
+import type { CFWorkerKV } from 'types/swell';
+/**
+ * CloudFlare Workers KV adapter for Keyv.
+ * Includes namespacing to prevent conflicts within shared storage.
+ */
+export declare class CFWorkerKVKeyvAdapter {
+    private namespace;
+    private store;
+    constructor(namespace: string, store: CFWorkerKV);
+    has(key: string): Promise<boolean>;
+    get(key: string): Promise<any>;
+    set(key: string, value: any): Promise<any>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+    /**
+     * Generates a namespaced cache key.
+     */
+    private cacheKey;
+}

package/dist/src/cache/index.d.ts

@@ -0,0 +1,5 @@
+import { Cache } from './cache';
+import { RequestCache } from './request-cache';
+import { ResourceCache } from './resource-cache';
+import { ThemeCache } from './theme-cache';
+export { Cache, RequestCache, ResourceCache, ThemeCache };

package/dist/src/cache/request-cache.d.ts

@@ -0,0 +1,4 @@
+import { Cache } from './cache';
+export declare class RequestCache extends Cache {
+    constructor();
+}

package/dist/src/cache/resource-cache.d.ts

@@ -0,0 +1,5 @@
+import { type CreateCacheOptions } from 'cache-manager';
+import { Cache } from './cache';
+export declare class ResourceCache extends Cache {
+    constructor(options?: CreateCacheOptions);
+}

package/dist/src/cache/theme-cache.d.ts

@@ -0,0 +1,9 @@
+import type { CFWorkerKV } from 'types/swell';
+import { Cache } from './cache';
+/**
+ * Theme cache is a 2-layer cache (memory, KV*)
+ * The KV layer supports namespacing and compression.
+ */
+export declare class ThemeCache extends Cache {
+    constructor(namespace: string, store?: CFWorkerKV);
+}

package/dist/src/resources.d.ts

@@ -3,7 +3,6 @@ import { ShopifyCompatibility } from './compatibility/shopify';
 import type { SwellData, SwellRecord, SwellCollection, InferSwellCollection, SwellCollectionPages, StorefrontResourceGetter } from '../types/swell';
 export declare const MAX_QUERY_PAGE_LIMIT = 100;
 export declare const DEFAULT_QUERY_PAGE_LIMIT = 15;
-export declare const CACHE_TIMEOUT_RESOURCES: number;
 export declare class StorefrontResource<T extends SwellData = SwellData> {
     _getter?: StorefrontResourceGetter<T>;
     _getterHash?: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swell/apps-sdk",
   "type": "module",
-  "version": "1.0.39",
+  "version": "1.0.40",
   "description": "Swell SDK for building isomorphic apps.",
   "author": "Swell",
   "license": "MIT",
@@ -38,11 +38,15 @@
   },
   "dependencies": {
     "@swell/easyblocks-core": "^1.0.10",
+    "@types/lodash": "^4.17.5",
+    "cache-manager": "^6.3.2",
     "color": "^4.2.3",
+    "keyv": "^5.2.3",
     "liquidjs": "^10.16.1",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",
     "qs": "^6.12.3",
+    "quick-lru": "^7.0.0",
     "strftime": "^0.10.3",
     "swell-js": "^4.2.3"
   },
@@ -51,7 +55,6 @@
     "@kruining/waterlogged": "^1.1.45",
     "@types/color": "^3.0.6",
     "@types/jest": "29.5.14",
-    "@types/lodash": "^4.17.5",
     "@types/lodash-es": "^4.17.12",
     "@types/qs": "^6.9.15",
     "@types/react": "^18.2.64",

package/dist/src/cache.d.ts

@@ -1,18 +0,0 @@
-import type { CFWorkerKV } from 'types/swell';
-export declare class Cache {
-    private map;
-    private kvStore?;
-    private timeoutDefault;
-    constructor(kvStore?: CFWorkerKV, timeoutDefault?: number);
-    setValues(values: Array<[string, unknown]>): void;
-    getValues(): unknown[][];
-    get<T>(key: string): Promise<T | undefined>;
-    getSync<T>(key: string): T | undefined;
-    set(key: string, value: any, timeout?: number): Promise<void>;
-    setSync(key: string, value: any, timeout?: number): void;
-    delete(key: string): Promise<void>;
-    deleteSync(key: string): void;
-    has(key: string): Promise<boolean>;
-    hasSync(key: string): boolean;
-    clear(prefix?: string): Promise<void>;
-}