@swell/apps-sdk 1.0.74 → 1.0.76

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

@@ -6,15 +6,28 @@ import type { SwellThemeConfig, SwellThemeVersion } from 'types/swell';
 export declare class ThemeLoader {
     private static cache;
     private swell;
+    private manifest;
+    private configs;
+    private configPaths;
     constructor(swell: Swell);
+    init(themeConfigs?: Map<string, SwellThemeConfig>): Promise<void>;
     /**
      * Loads theme configs for this version.
      */
     loadTheme(): Promise<SwellThemeConfig[]>;
+    /**
+     * Load theme configs from internal data, typically in the editor.
+     */
+    setConfigs(themeConfigs: Map<string, SwellThemeConfig>): void;
     /**
      * Preloads a theme version and configs. This is used to optimize initial theme load.
      */
     preloadTheme(version: SwellThemeVersion, configs: SwellThemeConfig[]): Promise<void>;
+    /**
+     * Fetches a theme config by file path.
+     */
+    fetchThemeConfig(filePath: string): Promise<SwellThemeConfig | null>;
+    fetchThemeConfigsByPath(pathPrefix: string, pathSuffix?: string): Promise<SwellThemeConfig[]>;
     /**
      * Load all theme configs.
      */
@@ -40,9 +53,13 @@ export declare class ThemeLoader {
      */
     private fetchManifest;
     /**
-     * Fetches theme configs via Swell Backend API.
+     * Fetches many theme configs via Swell Backend API.
      */
     private fetchThemeConfigsFromSource;
+    /**
+     * Fetches one theme config via Swell Backend API.
+     */
+    private fetchThemeConfigsFromSourceByPath;
     /**
      * Generates a Swell API query filter for this theme version.
      */

package/dist/src/theme.d.ts

@@ -1,8 +1,8 @@
 import { Swell, StorefrontResource, SwellStorefrontCollection, SwellStorefrontRecord, SwellStorefrontSingleton } from './api';
 import { ShopifyCompatibility } from './compatibility/shopify';
 import { LiquidSwell, ThemeFont, ThemeForm } from './liquid';
-import type { FormatInput } from 'swell-js';
-import type { ThemeGlobals, ThemeConfigs, ThemeSettings, ThemeResources, ThemeFormConfig, ThemeFormErrorMessages, ThemePresetSchema, ThemeSectionGroup, ThemeSectionGroupInfo, ThemeSectionSchema, ThemeSectionConfig, ThemeSectionSettings, ThemeSettingFieldSchema, ThemeSettingSectionSchema, ThemePageSectionSchema, ThemePageTemplateConfig, ThemeLayoutSectionGroupConfig, SwellData, SwellMenu, SwellRecord, SwellAppConfig, SwellThemeConfig, SwellThemeVersion, SwellAppStorefrontThemeProps, SwellAppShopifyCompatibilityConfig, SwellPageRequest, ThemePage } from 'types/swell';
+import { ThemeLoader } from './theme/theme-loader';
+import type { ThemeGlobals, ThemeConfigs, ThemeSettings, ThemeResources, ThemeFormConfig, ThemeFormErrorMessages, ThemePresetSchema, ThemeSectionGroup, ThemeSectionGroupInfo, ThemeSectionSchema, ThemeSectionConfig, ThemeSectionSettings, ThemeSettingFieldSchema, ThemeSettingSectionSchema, ThemePageSectionSchema, ThemePageTemplateConfig, ThemeLayoutSectionGroupConfig, SwellData, SwellMenu, SwellRecord, SwellAppConfig, SwellThemeConfig, SwellThemeVersion, SwellAppStorefrontThemeProps, SwellAppShopifyCompatibilityConfig } from 'types/swell';
 export declare class SwellTheme {
     swell: Swell;
     props: SwellAppStorefrontThemeProps;
@@ -10,8 +10,9 @@ export declare class SwellTheme {
     forms?: ThemeFormConfig[];
     resources?: ThemeResources;
     liquidSwell: LiquidSwell;
+    themeLoader: ThemeLoader;
     themeConfigs: Map<string, SwellThemeConfig> | null;
-    page?: ThemeSettings;
+    page: any;
     pageId: string | undefined;
     shopifyCompatibility: ShopifyCompatibility | null;
     shopifyCompatibilityClass: typeof ShopifyCompatibility;
@@ -34,11 +35,11 @@ export declare class SwellTheme {
         geo: SwellData;
         configs: ThemeConfigs;
     }>;
-    resolvePageData(store: SwellData, configs: ThemeConfigs, session?: SwellData, pageId?: string): Promise<{
+    resolvePageData(store: SwellData, configs: SwellData, session?: SwellData, pageId?: string): Promise<{
         settings: ThemeSettings;
-        request: SwellPageRequest;
-        page: ThemePage;
-        cart: SwellStorefrontSingleton | object;
+        request: ThemeSettings;
+        page: ThemeSettings;
+        cart: SwellStorefrontSingleton | {};
         account: SwellStorefrontSingleton | null;
         customer?: SwellStorefrontSingleton | null;
     }>;
@@ -89,7 +90,7 @@ export declare class SwellTheme {
     updateSettings(form: Record<string, {
         value: unknown;
     } | undefined>, config: object): ThemeSettings;
-    resolveTranslationLocale(translationsConfig: ThemeSettings, localeCode: string): ThemeSettings;
+    resolveTranslationLocale(translationsConfig: ThemeSettings, localeCode: string): any;
     setCompatibilityConfigs(configs: ThemeConfigs, localeCode: string): Promise<void>;
     setCompatibilityData(pageData: SwellData): void;
     resolveLookupSetting(setting: ThemeSettingFieldSchema, value: any): SwellData | SwellStorefrontRecord | SwellStorefrontCollection | null;
@@ -101,6 +102,7 @@ export declare class SwellTheme {
     lang(key: string, data?: any, fallback?: string): Promise<string>;
     resolveFontSetting(value: string): ThemeFont | null;
     resolveUrlSetting(value: string): string;
+    resolveImageSetting(value: string): string;
     getAllThemeConfigs(): Promise<Map<string, SwellThemeConfig>>;
     /**
      * Preloads updated theme configs. Used to optimize initial theme load.
@@ -108,6 +110,7 @@ export declare class SwellTheme {
     preloadThemeConfigs(version: SwellThemeVersion, configs: SwellThemeConfig[]): Promise<void>;
     getPageConfigPath(pageId: string): string | null;
     getThemeConfig(filePath: string): Promise<SwellThemeConfig | null>;
+    getThemeConfigsByPath(pathPrefix: string, pathSuffix?: string): Promise<Map<string, SwellThemeConfig>>;
     getThemeTemplateConfig(filePath: string): Promise<SwellThemeConfig | null>;
     getThemeTemplateConfigByType(type: string, name: string): Promise<SwellThemeConfig | null>;
     getAssetUrl(filePath: string): Promise<string | null>;
@@ -115,13 +118,13 @@ export declare class SwellTheme {
     renderTemplateString(templateString: string, data?: SwellData): Promise<string>;
     getSectionSchema(sectionName: string): Promise<Partial<ThemeSectionSchema> | undefined>;
     getSectionConfigWithSchemaTagOnly(config: SwellThemeConfig): SwellThemeConfig | null;
-    renderThemeTemplate(filePath: `${string}.liquid`, data?: SwellData): Promise<string>;
-    renderThemeTemplate(filePath: `${string}.json`, data?: SwellData): Promise<ThemePageTemplateConfig>;
     renderThemeTemplate(filePath: string, data?: SwellData): Promise<string | ThemePageTemplateConfig>;
     renderLayoutTemplate(name: string, data?: SwellData): Promise<string>;
     renderPageTemplate(name: string, data?: SwellData, altTemplateId?: string): Promise<string | ThemePageTemplateConfig>;
     renderPage(pageData?: SwellData, altTemplateId?: string): Promise<string | ThemePageTemplateConfig>;
-    renderAllSections(sectionsIds: string | Array<string>, pageData?: SwellData): Promise<Record<string, string>>;
+    renderAllSections(sectionsIds: string | Array<string>, pageData?: SwellData): Promise<{
+        [key: string]: string;
+    }>;
     renderSection(sectionId: string, pageData?: SwellData): Promise<string | ThemePageTemplateConfig>;
     renderLayout(data?: SwellData): Promise<string>;
     getContentForHeader(): string;
@@ -147,11 +150,12 @@ export declare class SwellTheme {
     renderTemplateSections(sectionGroup: ThemeSectionGroup, data?: SwellData): Promise<string>;
     renderTranslation(key: string, data?: any, fallback?: string): Promise<string>;
     renderTranslationValue(localeCode: string, langConfig: any, key: string, data?: any, fallback?: string): Promise<string>;
-    renderCurrency(amount: number, params?: FormatInput): string;
+    renderCurrency(amount: number, params: any): string;
 }
-export declare class PageError extends Error {
+export declare class PageError {
     title: string;
     status: number;
+    message: string;
     description?: string;
     constructor(title?: string | Error, status?: number, description?: string);
     toString(): string;

package/dist/types/swell.d.ts

@@ -1,5 +1,5 @@
 import type { FormatInput } from 'swell-js';
-import type { SwellStorefrontRecord, SwellStorefrontResource } from '../src/resources';
+import type { SwellStorefrontRecord, SwellStorefrontResource, SwellStorefrontSingleton } from '../src/resources';
 import type { Swell, SwellStorefrontCollection, StorefrontResource } from '../src/api';
 import type { ShopifySettingSchema, ShopifySettingsData, ShopifySettingsSchema } from './shopify';
 export interface SwellApiParams {
@@ -252,12 +252,19 @@ export interface ThemeSwellPage extends SwellAppStorefrontThemePage, ThemePageAd
 export type ThemePage = ThemeSwellPage | ThemeCustomPage;
 export interface ThemeGlobals extends SwellData {
     store: SwellData;
-    request: SwellPageRequest;
     settings: ThemeSettings;
+    session: SwellData;
+    request: SwellPageRequest;
+    menus?: Record<string, SwellMenu>;
     page: ThemePage;
+    cart: SwellStorefrontSingleton | {};
+    account: SwellStorefrontSingleton | null;
+    customer?: SwellStorefrontSingleton | null;
+    geo: SwellSettingsGeo;
     configs: ThemeConfigs;
-    menus?: Record<string, SwellMenu>;
     translations: Record<string, unknown>;
+    canonical_url: string;
+    shopify_compatibility: boolean;
     [key: string]: any;
 }
 export interface ThemeConfigs {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swell/apps-sdk",
   "type": "module",
-  "version": "1.0.74",
+  "version": "1.0.76",
   "description": "Swell SDK for building isomorphic apps.",
   "author": "Swell",
   "license": "MIT",