@swell/apps-sdk 1.0.138 → 1.0.140

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

@@ -4,7 +4,6 @@ export type CreateCacheOptions = OriginalCreateCacheOptions & {
     kvStore?: CFWorkerKV;
     workerCtx?: CFWorkerContext;
 };
-export declare const CF_KV_NAMESPACE = "THEME";
 /**
  * Cache supports memory or KV
  * The KV layer supports namespacing and compression
@@ -13,15 +12,21 @@ export declare class Cache {
     private client;
     private workerCtx?;
     constructor(options?: CreateCacheOptions);
-    fetch<T>(key: string, fetchFn: () => T | Promise<T>): Promise<T>;
+    fetch<T>(key: string, fetchFn: () => T | Promise<T>, ttl?: number): Promise<T>;
+    /**
+     * Fetch cache using SWR (stale-while-revalidate)
+     *
+     * This will always return the cached value immediately if exists
+     */
     fetchSWR<T>(key: string, fetchFn: () => T | Promise<T>, ttl?: number): Promise<T>;
-    get<T>(key: string): Promise<T | null>;
+    get<T>(key: string): Promise<T | undefined>;
     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.
+     *
+     * __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

@@ -1,15 +1,18 @@
+import type { KeyvStoreAdapter } from 'keyv';
 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;
+export declare class CFWorkerKVKeyvAdapter implements KeyvStoreAdapter {
     private store;
+    namespace: string;
+    opts: unknown;
     constructor(store: CFWorkerKV);
     has(key: string): Promise<boolean>;
-    get(key: string): Promise<any>;
-    set(key: string, value: any): Promise<any>;
-    delete(key: string): Promise<void>;
+    get<T>(key: string): Promise<T | undefined>;
+    set(key: string, value: string, ttl?: number): Promise<void>;
+    delete(key: string): Promise<boolean>;
     clear(): Promise<void>;
+    on(_event: string, _listener: (...args: unknown[]) => void): CFWorkerKVKeyvAdapter;
 }

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

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

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

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

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

@@ -1,6 +1,6 @@
-import { Swell } from '@/api';
 import { ThemeCache } from '../cache';
-import type { SwellThemeConfig, SwellThemeVersion } from 'types/swell';
+import type { Swell } from '@/api';
+import type { SwellThemeConfig, SwellThemePreload } from 'types/swell';
 /**
  * Responsible for loading a theme.
  */
@@ -27,7 +27,7 @@ export declare class ThemeLoader {
     /**
      * Preloads a theme version and configs. This is used to optimize initial theme load.
      */
-    preloadTheme(version: SwellThemeVersion, configs: SwellThemeConfig[]): Promise<void>;
+    preloadTheme(payload: SwellThemePreload): Promise<void>;
     /**
      * Fetches a theme config by file path.
      */
@@ -53,6 +53,10 @@ export declare class ThemeLoader {
      * Caches a theme config by hash.
      */
     private cacheThemeConfig;
+    /**
+     * Caches a CDN file url by config hash.
+     */
+    private cacheThemeFileUrl;
     /**
      * Fetches the manifest (set of config hashes) for a theme version.
      */
@@ -68,6 +72,7 @@ export declare class ThemeLoader {
      * but we probably need to find why that happens in the first place (TODO).
      */
     private fetchThemeConfigsFromSourceByPath;
+    private getThemeId;
     /**
      * Generates a Swell API query filter for this theme version.
      */

package/dist/src/theme.d.ts

@@ -3,7 +3,7 @@ import { ShopifyCompatibility } from './compatibility/shopify';
 import { LiquidSwell, ThemeFont, ThemeForm } from './liquid';
 import { ThemeLoader } from './theme/theme-loader';
 import type { FormatInput } from 'swell-js';
-import type { ThemeGlobals, ThemeConfigs, ThemeSettings, ThemeResources, ThemeFormConfig, ThemeFormErrorMessages, ThemeLocaleConfig, ThemePresetSchema, ThemeSectionGroup, ThemeSectionGroupInfo, ThemeSectionSchema, ThemeSectionConfig, ThemeSectionSettings, ThemeSettingFieldSchema, ThemeSettingSectionSchema, ThemePageSectionSchema, ThemePageTemplateConfig, ThemeLayoutSectionGroupConfig, SwellData, SwellMenu, SwellRecord, SwellAppConfig, SwellThemeConfig, SwellThemeVersion, SwellAppStorefrontThemeProps, SwellAppShopifyCompatibilityConfig, ThemePage, SwellPageRequest, SwellSettingsGeo } from '../types/swell';
+import type { ThemeGlobals, ThemeConfigs, ThemeSettings, ThemeResources, ThemeFormConfig, ThemeFormErrorMessages, ThemeLocaleConfig, ThemePresetSchema, ThemeSectionGroup, ThemeSectionGroupInfo, ThemeSectionSchema, ThemeSectionConfig, ThemeSectionSettings, ThemeSettingFieldSchema, ThemeSettingSectionSchema, ThemePageSectionSchema, ThemePageTemplateConfig, ThemeLayoutSectionGroupConfig, SwellData, SwellMenu, SwellRecord, SwellAppConfig, SwellThemeConfig, SwellThemePreload, SwellAppStorefrontThemeProps, SwellAppShopifyCompatibilityConfig, ThemePage, SwellPageRequest, SwellSettingsGeo } from '../types/swell';
 export declare class SwellTheme {
     swell: Swell;
     props: SwellAppStorefrontThemeProps;
@@ -46,7 +46,7 @@ export declare class SwellTheme {
         account: SwellStorefrontSingleton | null;
         customer?: SwellStorefrontSingleton | null;
     }>;
-    fetchSingletonResourceCached<R>(key: string, handler: () => Promise<R>, defaultValue: R): Promise<R | undefined>;
+    fetchSingletonResourceCached<R>(key: string, handler: () => Promise<R>, defaultValue: () => R | Promise<R>): Promise<R | undefined>;
     fetchCart(): Promise<StorefrontResource>;
     fetchAccount(): Promise<StorefrontResource | null>;
     getFormConfig(formType: string): ThemeFormConfig | undefined;
@@ -109,7 +109,7 @@ export declare class SwellTheme {
     /**
      * Preloads updated theme configs. Used to optimize initial theme load.
      */
-    preloadThemeConfigs(version: SwellThemeVersion, configs: SwellThemeConfig[]): Promise<void>;
+    preloadThemeConfigs(payload: SwellThemePreload): Promise<void>;
     getPageConfigPath(pageId: string, altTemplate?: string): string | null;
     getThemeConfig(filePath: string): Promise<SwellThemeConfig | null>;
     getThemeConfigsByPath(pathPrefix: string, pathSuffix?: string): Promise<Map<string, SwellThemeConfig>>;

package/dist/types/swell.d.ts

@@ -175,18 +175,33 @@ export interface SwellCollectionPage {
     end: number;
 }
 export type SwellCollectionPages = Record<string, SwellCollectionPage>;
-export interface SwellThemeConfig extends SwellRecord {
+export interface SwellFile {
+    id: string;
+    md5: string;
+    url: string;
+    length: number;
+    filename: string | null;
+    content_type: string;
+    date_uploaded: string;
+}
+export interface SwellThemeConfig {
     id: string;
     type: string;
+    name: string;
+    hash: string;
+    file: SwellFile;
     file_data: string;
     file_path: string;
 }
+export type SwellThemeManifest = Record<string, string>;
 export interface SwellThemeVersion extends SwellRecord {
     manifest: SwellThemeManifest;
     hash: string;
 }
-export interface SwellThemeManifest {
-    [key: string]: string;
+export interface SwellThemePreload {
+    api: number;
+    version?: SwellThemeVersion;
+    configs?: SwellThemeConfig[];
 }
 export interface SwellMenu {
     id: string;
@@ -509,7 +524,7 @@ export interface ThemeFormConfig {
     url: string;
     return_url?: string;
     params?: ThemeFormConfigParam[];
-    handler?: () => void;
+    handler?: (...args: any[]) => any;
 }
 export interface ThemeFormErrorMessage {
     code?: string;
@@ -550,11 +565,11 @@ export interface CFWorkerKVListResponse {
 export interface CFWorkerKV {
     get(key: string, type?: 'text', options?: CFWorkerKVGetOptions<'text'>): Promise<string | null>;
     get(key: string, type?: 'arrayBuffer', options?: CFWorkerKVGetOptions<'arrayBuffer'>): Promise<ArrayBuffer | null>;
-    get(key: string, type?: 'stream', options?: CFWorkerKVGetOptions<'stream'>): Promise<ReadableStream | null>;
+    get(key: string, type?: 'stream', options?: CFWorkerKVGetOptions<'stream'>): Promise<ReadableStream<Uint8Array> | null>;
     get<T>(key: string, type?: 'json', options?: CFWorkerKVGetOptions<'json'>): Promise<T | null>;
     getWithMetadata(key: string, type?: 'text', options?: CFWorkerKVGetOptions<'text'>): Promise<CFWorkerKVGetMetadataResponse<string>>;
     getWithMetadata(key: string, type?: 'arrayBuffer', options?: CFWorkerKVGetOptions<'arrayBuffer'>): Promise<CFWorkerKVGetMetadataResponse<ArrayBuffer>>;
-    getWithMetadata(key: string, type?: 'stream', options?: CFWorkerKVGetOptions<'stream'>): Promise<CFWorkerKVGetMetadataResponse<ReadableStream>>;
+    getWithMetadata(key: string, type?: 'stream', options?: CFWorkerKVGetOptions<'stream'>): Promise<CFWorkerKVGetMetadataResponse<ReadableStream<Uint8Array>>>;
     getWithMetadata<T>(key: string, type?: 'json', options?: CFWorkerKVGetOptions<'json'>): Promise<CFWorkerKVGetMetadataResponse<T>>;
     put(key: string, value: string | ReadableStream | ArrayBuffer, options?: CFWorkerKVPutOptions): Promise<void>;
     delete(key: string): Promise<void>;
@@ -564,7 +579,7 @@ export interface CFThemeEnv {
     THEME?: CFWorkerKV;
 }
 export interface CFWorkerContext {
-    waitUntil(promise: Promise<any>): void;
+    waitUntil(promise: Promise<unknown>): void;
     passThroughOnException(): void;
 }
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swell/apps-sdk",
   "type": "module",
-  "version": "1.0.138",
+  "version": "1.0.140",
   "description": "Swell SDK for building isomorphic apps.",
   "author": "Swell",
   "license": "MIT",
@@ -40,11 +40,11 @@
   "dependencies": {
     "@swell/easyblocks-core": "^1.0.19",
     "bluebird": "^3.7.2",
-    "cache-manager": "^6.3.2",
+    "cache-manager": "^7.0.1",
     "color": "^4.2.3",
     "country-flag-icons": "1.5.18",
     "json5": "^2.2.3",
-    "keyv": "^5.2.3",
+    "keyv": "^5.3.4",
     "liquidjs": "^10.21.0",
     "lodash": "^4.17.21",
     "lodash-es": "^4.17.21",