@swell/apps-sdk 1.0.68 → 1.0.70

package/dist/src/api.d.ts

@@ -1,11 +1,12 @@
 import SwellJS from 'swell-js';
-import type { SwellAppConfig, SwellErrorOptions, SwellMenu, SwellData, CFThemeEnv, SwellAppShopifyCompatibilityConfig } from '../types/swell';
+import qs from 'qs';
+import type { SwellApiParams, SwellAppConfig, SwellErrorOptions, SwellMenu, SwellData, CFThemeEnv, SwellAppShopifyCompatibilityConfig } from '../types/swell';
 export * from './resources';
 export declare class Swell {
     url: URL;
-    headers: SwellData;
-    swellHeaders: SwellData;
-    queryParams: SwellData;
+    headers: Record<string, string | undefined>;
+    swellHeaders: Record<string, string | undefined>;
+    queryParams: qs.ParsedQs;
     workerEnv?: CFThemeEnv;
     config?: SwellAppConfig;
     shopifyCompatibilityConfig?: SwellAppShopifyCompatibilityConfig;
@@ -17,24 +18,12 @@ export declare class Swell {
     isEditor: boolean;
     sentResponse: boolean;
     storefront_url?: string;
-    constructor(params: {
-        url: URL | string;
-        config?: SwellAppConfig;
-        shopifyCompatibilityConfig?: SwellAppShopifyCompatibilityConfig;
-        headers?: SwellData;
-        swellHeaders?: SwellData;
-        serverHeaders?: Headers | SwellData;
-        queryParams?: URLSearchParams | SwellData;
-        workerEnv?: CFThemeEnv;
-        getCookie?: (name: string) => string | undefined;
-        setCookie?: (name: string, value: string, options: any) => void;
-        [key: string]: any;
-    });
-    static formatHeaders(serverHeaders?: Headers | SwellData): {
-        headers: SwellData;
-        swellHeaders: SwellData;
+    constructor(params: SwellApiParams);
+    static formatHeaders(serverHeaders?: Headers | Record<string, string | undefined>): {
+        headers: Record<string, string | undefined>;
+        swellHeaders: Record<string, string | undefined>;
     };
-    static formatQueryParams(queryParams?: URLSearchParams | SwellData): SwellData;
+    static formatQueryParams(queryParams?: URLSearchParams | Record<string, string | undefined>): qs.ParsedQs;
     /**
      * Fetches a resource.
      * First attempts to fetch from cache.
@@ -73,7 +62,7 @@ export declare class SwellBackendAPI {
         accessToken: string;
         apiHost?: string;
     });
-    makeRequest(method: string, url: string, data?: object): Promise<any>;
+    makeRequest<T>(method: string, url: string, data?: object): Promise<T>;
     stringifyQuery(queryObject: object, prefix?: string): string;
     get(url: string, query?: SwellData): Promise<SwellData>;
     put(url: string, data: SwellData): Promise<SwellData>;

package/dist/src/compatibility/shopify-objects/filter.d.ts

@@ -1,5 +1,5 @@
 import { ShopifyCompatibility } from '../shopify';
 import { ShopifyResource } from './resource';
-import type { SwellData, SwellRecord } from 'types/swell';
-export default function ShopifyFilter(instance: ShopifyCompatibility, filter: SwellRecord): ShopifyResource;
-export declare function ShopifyFilterValue(instance: ShopifyCompatibility, filterOption: SwellData, filter: SwellRecord, paramSuffix?: string): ShopifyResource;
+import type { SwellProductFilter, SwellProductFilterOption } from 'types/swell';
+export default function ShopifyFilter(instance: ShopifyCompatibility, filter: SwellProductFilter): ShopifyResource;
+export declare function ShopifyFilterValue(instance: ShopifyCompatibility, filterOption: SwellProductFilterOption, filter: SwellProductFilter, paramSuffix?: string): ShopifyResource;

package/dist/src/compatibility/shopify.d.ts

@@ -3,8 +3,8 @@ import { ThemeFont } from '@/liquid/font';
 import { ThemeForm } from '@/liquid/form';
 import { SwellTheme } from '@/theme';
 import { ShopifyResource } from './shopify-objects';
-import type { ThemeGlobals, ThemeSettings, ThemePresetSchema, ThemeEditorSchema, ThemeSectionSchemaData, SwellData, SwellMenu, SwellRecord, SwellAppShopifyCompatibilityConfig } from '../../types/swell';
-import type { ShopifySettingsData, ShopifySettingsSchema, ShopifySectionSchema, ShopifyPageResourceMap, ShopifyObjectResourceMap, ShopifyFormResourceMap, ShopifyQueryParamsMap } from '../../types/shopify';
+import type { ThemeGlobals, ThemeSettings, ThemePresetSchema, ThemeEditorSchema, ThemeSectionSchemaData, SwellData, SwellMenu, SwellAppShopifyCompatibilityConfig, SwellSettingsGeo } from '../../types/swell';
+import type { ShopifySettingsData, ShopifySettingsSchema, ShopifySectionSchema, ShopifyPageResourceMap, ShopifyObjectResourceMap, ShopifyFormResourceMap, ShopifyQueryParamsMap, ShopifyLocalizationConfig } from '../../types/shopify';
 export declare class ShopifyCompatibility {
     theme: SwellTheme;
     swell: Swell;
@@ -13,10 +13,8 @@ export declare class ShopifyCompatibility {
     objectResourceMap: ShopifyObjectResourceMap;
     formResourceMap: ShopifyFormResourceMap;
     queryParamsMap: ShopifyQueryParamsMap;
-    editorLocaleConfig: {
-        [key: string]: any;
-    } | undefined;
     shopifyCompatibilityConfig?: SwellAppShopifyCompatibilityConfig;
+    editorLocaleConfig?: Record<string, ShopifyLocalizationConfig | undefined>;
     constructor(theme: SwellTheme);
     adaptGlobals(globals: ThemeGlobals): void;
     /**
@@ -83,10 +81,10 @@ export declare class ShopifyCompatibility {
     getPresetsConfig(settingsData: ShopifySettingsData): ThemePresetSchema[];
     getEditorConfig(settingsSchema: ShopifySettingsSchema): ThemeEditorSchema;
     getSectionConfigSchema(sectionSchema: ShopifySectionSchema): ThemeSectionSchemaData;
-    getLocaleConfig(theme: SwellTheme, localeCode?: string, suffix?: string): Promise<any>;
-    getEditorLocaleConfig(theme: SwellTheme, localeCode: string): Promise<any>;
-    renderSchemaTranslations(theme: SwellTheme, schema: SwellData, localeCode?: string): Promise<any>;
-    renderSchemaTranslationValue(theme: SwellTheme, schemaValue: any, localCode: string, editorLocaleConfig: any): Promise<any>;
+    getLocaleConfig(theme: SwellTheme, localeCode?: string, suffix?: string): Promise<ShopifyLocalizationConfig>;
+    getEditorLocaleConfig(theme: SwellTheme, localeCode: string): Promise<ShopifyLocalizationConfig>;
+    renderSchemaTranslations<T>(theme: SwellTheme, schema: T, localeCode?: string): Promise<T>;
+    renderSchemaTranslationValue<T>(theme: SwellTheme, schemaValue: T, localCode: string, editorLocaleConfig: ShopifyLocalizationConfig): Promise<T>;
     getPageType(pageId: string): string;
     getPageRouteUrl(pageId: string): string;
     getPageRoutes(): {
@@ -115,7 +113,7 @@ export declare class ShopifyCompatibility {
     getObjectResourceMap(): ShopifyObjectResourceMap;
     getFormResourceMap(): ShopifyFormResourceMap;
     getQueryParamsMap(): ShopifyQueryParamsMap;
-    getAllCountryOptionTags(geoSettings: SwellRecord): any;
+    getAllCountryOptionTags(geoSettings: SwellSettingsGeo): string;
     isScriptFormActionUrl(url: string): boolean;
     isScriptUrl(url: string): boolean;
     needRedirectToPageStart(formId: string): boolean;

package/dist/src/theme.d.ts

@@ -1,7 +1,8 @@
 import { Swell, StorefrontResource, SwellStorefrontCollection, SwellStorefrontRecord, SwellStorefrontSingleton } from './api';
 import { ShopifyCompatibility } from './compatibility/shopify';
 import { LiquidSwell, ThemeFont, ThemeForm } from './liquid';
-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';
+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';
 export declare class SwellTheme {
     swell: Swell;
     props: SwellAppStorefrontThemeProps;
@@ -10,7 +11,7 @@ export declare class SwellTheme {
     resources?: ThemeResources;
     liquidSwell: LiquidSwell;
     themeConfigs: Map<string, SwellThemeConfig> | null;
-    page: any;
+    page?: ThemeSettings;
     pageId: string | undefined;
     shopifyCompatibility: ShopifyCompatibility | null;
     shopifyCompatibilityClass: typeof ShopifyCompatibility;
@@ -33,11 +34,11 @@ export declare class SwellTheme {
         geo: SwellData;
         configs: ThemeConfigs;
     }>;
-    resolvePageData(store: SwellData, configs: SwellData, session?: SwellData, pageId?: string): Promise<{
+    resolvePageData(store: SwellData, configs: ThemeConfigs, session?: SwellData, pageId?: string): Promise<{
         settings: ThemeSettings;
-        request: ThemeSettings;
-        page: ThemeSettings;
-        cart: SwellStorefrontSingleton | {};
+        request: SwellPageRequest;
+        page: ThemePage;
+        cart: SwellStorefrontSingleton | object;
         account: SwellStorefrontSingleton | null;
         customer?: SwellStorefrontSingleton | null;
     }>;
@@ -88,7 +89,7 @@ export declare class SwellTheme {
     updateSettings(form: Record<string, {
         value: unknown;
     } | undefined>, config: object): ThemeSettings;
-    resolveTranslationLocale(translationsConfig: ThemeSettings, localeCode: string): any;
+    resolveTranslationLocale(translationsConfig: ThemeSettings, localeCode: string): ThemeSettings;
     setCompatibilityConfigs(configs: ThemeConfigs, localeCode: string): Promise<void>;
     setCompatibilityData(pageData: SwellData): void;
     resolveLookupSetting(setting: ThemeSettingFieldSchema, value: any): SwellData | SwellStorefrontRecord | SwellStorefrontCollection | null;
@@ -114,13 +115,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<{
-        [key: string]: string;
-    }>;
+    renderAllSections(sectionsIds: string | Array<string>, pageData?: SwellData): Promise<Record<string, string>>;
     renderSection(sectionId: string, pageData?: SwellData): Promise<string | ThemePageTemplateConfig>;
     renderLayout(data?: SwellData): Promise<string>;
     getContentForHeader(): string;
@@ -146,12 +147,11 @@ 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: any): string;
+    renderCurrency(amount: number, params?: FormatInput): string;
 }
-export declare class PageError {
+export declare class PageError extends Error {
     title: string;
     status: number;
-    message: string;
     description?: string;
     constructor(title?: string | Error, status?: number, description?: string);
     toString(): string;

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

@@ -16,7 +16,7 @@ export declare function removeCircularReferences(value: any): any;
 export declare function dehydrateSwellRefsInStorefrontResources(obj: any): any;
 export declare function resolveAsyncResources(response: any, resolveStorefrontResources?: boolean, resolveWithResourceMetadata?: boolean): Promise<any>;
 export declare function stringifyQueryParams(queryParams: SwellData): string;
-export declare function scopeCustomCSS(custom_css: string, sectionID: string): string;
+export declare function scopeCustomCSS(custom_css: string | string[], sectionID: string): string;
 export declare function extractSettingsFromForm(form: Record<string, {
     value: unknown;
 } | undefined>, preset: object): ThemeSettings;

package/dist/types/shopify.d.ts

@@ -3,7 +3,7 @@ import type { ShopifyResource } from '../src/compatibility/shopify-objects/resou
 import type { ShopifyCompatibility } from '../src/compatibility/shopify';
 import type { StorefrontResource } from '../src/resources';
 export type ShopifyBasicInputType = 'text' | 'textarea' | 'select' | 'checkbox' | 'radio' | 'number' | 'range';
-export type ShopifySpecializedInputType = 'article' | 'blog' | 'collection' | 'collection_list' | 'color' | 'color_background' | 'color_scheme' | 'color_scheme_group' | 'font_picker' | 'header' | 'paragraph' | 'html' | 'image_picker' | 'inline_richtext' | 'link_list' | 'liquid' | 'page' | 'page' | 'product' | 'product_list' | 'richtext' | 'text_alignment' | 'url' | 'video' | 'video_url';
+export type ShopifySpecializedInputType = 'article' | 'blog' | 'collection' | 'collection_list' | 'color' | 'color_background' | 'color_scheme' | 'color_scheme_group' | 'font_picker' | 'header' | 'paragraph' | 'html' | 'image_picker' | 'inline_richtext' | 'link_list' | 'liquid' | 'page' | 'product' | 'product_list' | 'richtext' | 'text_alignment' | 'url' | 'video' | 'video_url';
 export interface ShopifyBgStyleSchema {
     solid: string;
     gradient: string;
@@ -123,4 +123,10 @@ export interface ShopifyQueryParams {
     to: string | ((param: string, value: string) => SwellData);
 }
 export type ShopifyQueryParamsMap = Array<ShopifyQueryParams>;
+export interface ShopifyLocalizationSection {
+    [key: string]: string | ShopifyLocalizationSection;
+}
+export interface ShopifyLocalizationConfig {
+    [key: string]: ShopifyLocalizationSection;
+}
 export {};

package/dist/types/swell.d.ts

@@ -1,6 +1,21 @@
+import type { FormatInput } from 'swell-js';
 import type { SwellStorefrontRecord, SwellStorefrontResource } from '../src/resources';
 import type { Swell, SwellStorefrontCollection, StorefrontResource } from '../src/api';
-import type { ShopifySettingSchema } from './shopify';
+import type { ShopifySettingSchema, ShopifySettingsData, ShopifySettingsSchema } from './shopify';
+export interface SwellApiParams {
+    url: URL | string;
+    config?: SwellAppConfig;
+    shopifyCompatibilityConfig?: SwellAppShopifyCompatibilityConfig;
+    headers?: Record<string, string | undefined>;
+    swellHeaders?: Record<string, string | undefined>;
+    serverHeaders?: Headers | Record<string, string | undefined>;
+    queryParams?: URLSearchParams | Record<string, string | undefined>;
+    workerEnv?: CFThemeEnv;
+    isEditor?: boolean;
+    getCookie?: (name: string) => string | undefined;
+    setCookie?: (name: string, value: string, options: object | undefined, swell: Swell) => void;
+    [key: string]: unknown;
+}
 export interface SwellAppConfig {
     id: string;
     name: string;
@@ -62,6 +77,58 @@ export interface SwellAppStorefrontThemeResources {
     singletons: Record<string, string>;
     records: Record<string, string>;
 }
+export interface SwellSettingsGeoItem {
+    id: string;
+    name: string;
+}
+export interface SwellSettingsGeoCountry extends SwellSettingsGeoItem {
+    state_label?: string;
+}
+export interface SwellSettingsGeoState extends SwellSettingsGeoItem {
+    country: string;
+}
+export type SwellSettingsGeoTimezone = SwellSettingsGeoItem;
+export type SwellSettingsGeoCurrency = SwellSettingsGeoItem;
+export type SwellSettingsGeoLocale = SwellSettingsGeoItem;
+export interface SwellSettingsGeo {
+    id: 'geo';
+    countries: SwellSettingsGeoCountry[];
+    currencies: SwellSettingsGeoCurrency[];
+    locales: SwellSettingsGeoLocale[];
+    states: SwellSettingsGeoState[];
+    timezones: SwellSettingsGeoTimezone[];
+}
+export interface SwellPageRequest {
+    host: string;
+    origin: string;
+    path: string;
+    query: QueryParams;
+    locale: string;
+    currency: string;
+    is_editor: boolean;
+    is_preview: boolean;
+    design_mode?: boolean;
+    visual_section_preview?: boolean;
+    page_type?: string;
+}
+export interface SwellProductFilterOption {
+    value: unknown;
+    label?: string;
+    count?: number;
+    active?: boolean;
+}
+export interface SwellProductFilter {
+    id: string;
+    label: string;
+    type: string;
+    options?: SwellProductFilterOption[];
+    interval?: number;
+    range_min?: number;
+    range_max?: number;
+    param_name: string;
+    active_options?: SwellProductFilterOption[];
+    inactive_options?: SwellProductFilterOption[];
+}
 export interface SwellErrorOptions {
     status?: number;
     method?: string;
@@ -118,7 +185,7 @@ export declare enum SwellMenuItemType {
     Category = "category",
     Page = "page",
     Blog = "blog",
-    BlogCatgory = "blog_category",
+    BlogCategory = "blog_category",
     Content = "content",
     ContentList = "content_list",
     Url = "url",
@@ -139,6 +206,7 @@ export interface SwellMenuItem {
     child_current?: boolean;
     child_active?: boolean;
 }
+export type QueryParams = import('qs').ParsedQs;
 export type StorefrontResourceGetter<T extends SwellData = SwellData> = (this: SwellStorefrontResource<T>) => Promise<T | null> | T | null;
 export interface ThemeSettings {
     [key: string]: any;
@@ -154,20 +222,42 @@ export interface ThemeSectionBase {
     settings: ThemeSettings;
     blocks?: ThemeSettingsBlock[];
     block_order?: string[];
-    custom_css?: string;
+    custom_css?: string | string[];
     disabled?: boolean;
 }
 export interface ThemeSectionSettings extends ThemeSettings {
     section: ThemeSectionBase;
 }
-export type ThemePage = Record<string, any>;
+export interface ThemePageSchema {
+    layout?: string;
+    page?: {
+        slug?: string;
+        label?: string;
+        description?: string;
+    };
+}
+interface ThemePageAdditionalProps {
+    description?: string;
+    current: number;
+    label: string;
+    slug?: string;
+}
+export interface ThemeCustomPage extends ThemePageAdditionalProps {
+    custom: true;
+    id: string;
+}
+export interface ThemeSwellPage extends SwellAppStorefrontThemePage, ThemePageAdditionalProps {
+    custom: false;
+}
+export type ThemePage = ThemeSwellPage | ThemeCustomPage;
 export interface ThemeGlobals extends SwellData {
     store: SwellData;
-    request: SwellData;
+    request: SwellPageRequest;
     settings: ThemeSettings;
     page: ThemePage;
     configs: ThemeConfigs;
     menus?: Record<string, SwellMenu>;
+    translations: Record<string, unknown>;
     [key: string]: any;
 }
 export interface ThemeConfigs {
@@ -176,8 +266,8 @@ export interface ThemeConfigs {
     presets: ThemePresetSchema[];
     translations: ThemeSettings;
     [key: string]: any;
-    settings_schema?: any;
-    settings_data?: any;
+    settings_schema?: ShopifySettingsSchema;
+    settings_data?: ShopifySettingsData;
 }
 export interface ThemeResourceFactory {
     new (swell: Swell): StorefrontResource;
@@ -208,6 +298,7 @@ export interface ThemeSection {
 interface ThemeSectionGroupBase {
     id?: string;
     type?: string;
+    name?: string;
     order?: string[];
 }
 export interface ThemeSectionGroup extends ThemeSectionGroupBase {
@@ -342,13 +433,7 @@ export type RenderTemplate = (config: SwellThemeConfig | null, data?: SwellData)
 export type RenderTemplateString = (templateString: string, data?: SwellData) => Promise<string>;
 export type RenderTemplateSections = (sections: ThemeSectionGroup, data?: SwellData) => Promise<string>;
 export type RenderTranslation = (key: string, data?: unknown, locale?: string) => Promise<string>;
-interface RenderCurrencyParams {
-    code?: string;
-    rate?: number;
-    locale?: string;
-    decimals?: number;
-}
-export type RenderCurrency = (amount: number, params?: RenderCurrencyParams) => string;
+export type RenderCurrency = (amount: number, params?: FormatInput) => string;
 export type ResolveFilePath = (fileName: string, extName?: string) => string;
 export interface ThemeFontConfig {
     family: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@swell/apps-sdk",
   "type": "module",
-  "version": "1.0.68",
+  "version": "1.0.70",
   "description": "Swell SDK for building isomorphic apps.",
   "author": "Swell",
   "license": "MIT",
@@ -32,6 +32,7 @@
     "prebuild": "rimraf dist",
     "build": "node scripts/build.mjs",
     "postbuild": "tsc --project tsconfig.build.json",
+    "prepare": "git config core.hooksPath .git-hooks || echo 'Not in a git repo'",
     "prepublishOnly": "npm i && npm run build",
     "watch": "node scripts/build.mjs watch",
     "test": "jest --silent"