@shoppexio/storefront 0.3.1 → 0.3.7

package/dist/index.d.cts

@@ -540,6 +540,10 @@ type StorefrontAddon = StorefrontAnnouncementBarAddon | StorefrontCountdownBarAd
 interface StorefrontAddonBootstrap {
     items: StorefrontAddon[];
 }
+interface StorefrontOnlineUsers {
+    count: number;
+    window_seconds: number;
+}
 type StorefrontItem = {
     item_type: 'PRODUCT' | 'GROUP';
     uniqid: string;
@@ -634,7 +638,7 @@ interface CartPayload {
     coupon?: string;
 }
 interface CartAppliedDiscount {
-    source: 'AUTOMATIC_PRODUCT_DEAL' | 'BUNDLE_DEAL' | 'COUPON';
+    source: 'PRODUCT_DISCOUNT' | 'VOLUME_DISCOUNT' | 'AUTOMATIC_PRODUCT_DEAL' | 'BUNDLE_DEAL' | 'COUPON';
     source_id: string | null;
     source_uniqid: string | null;
     label: string;
@@ -870,6 +874,31 @@ type ResolvedThemeSettings = {
     };
 };
 
+type JsonRecord = Record<string, unknown>;
+interface PublishedBuilderSettings {
+    version: number;
+    revision: number;
+    theme: {
+        content: JsonRecord;
+        layout: JsonRecord;
+        style_slots: JsonRecord;
+        pages?: unknown[];
+        terms?: JsonRecord;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface PublishedThemeSettingsPayload {
+    settings: ResolvedThemeSettings;
+    builder_settings: PublishedBuilderSettings | null;
+    content: JsonRecord;
+    style_slots: JsonRecord;
+}
+declare function fetchPublishedBuilderSettings(shopSlug: string): Promise<PublishedThemeSettingsPayload | null>;
+declare function fetchPublishedThemeSettings(shopSlug: string): Promise<ResolvedThemeSettings | null>;
+declare function resolveDefaults(config: ThemeConfig): ResolvedThemeSettings;
+declare function mergeSettings(defaults: ResolvedThemeSettings, overrides: Partial<ResolvedThemeSettings>): ResolvedThemeSettings;
+
 /**
  * Store Module
  *
@@ -895,6 +924,9 @@ declare function getStoreBannerUrl(): Promise<string | null>;
 interface GetStorefrontProductsPageOptions {
     cursor?: string | null;
     limit?: number;
+    sort?: 'featured' | 'newest' | 'price-asc' | 'price-desc' | string | null;
+    category?: string | null;
+    hideOutOfStock?: boolean;
 }
 declare function getProducts(): Promise<SDKResponse<Product[]>>;
 declare function getStorefrontProductsPage(options?: GetStorefrontProductsPageOptions): Promise<SDKResponse<{
@@ -1032,6 +1064,10 @@ declare function getMenus(): Promise<SDKResponse<Menu[]>>;
  * Get a menu by its exact title.
  */
 declare function getMenuByTitle(title: string): Promise<SDKResponse<Menu>>;
+/**
+ * Get a menu by its exact title.
+ */
+declare function getMenu(title: string): Promise<SDKResponse<Menu>>;
 /**
  * Get a menu by canonical slot. The backend resolves legacy menu titles too.
  */
@@ -1040,6 +1076,11 @@ declare function getMenuSlotTitles(slot: NavigationMenuSlot): string[];
 
 declare function trackPageView(cartValue?: number, itemCount?: number): Promise<void>;
 
+declare function getStorefrontOnlineUsers(): Promise<SDKResponse<StorefrontOnlineUsers>>;
+declare function touchStorefrontPresence(): Promise<SDKResponse<{
+    pong: string;
+}>>;
+
 /**
  * Formatting Utilities
  */
@@ -1056,10 +1097,6 @@ declare function getCacheStats(): CacheStats;
 declare function clearCache(): void;
 declare function invalidateCache(prefixOrKey: string): void;
 
-declare function fetchPublishedThemeSettings(shopSlug: string): Promise<ResolvedThemeSettings | null>;
-declare function resolveDefaults(config: ThemeConfig): ResolvedThemeSettings;
-declare function mergeSettings(defaults: ResolvedThemeSettings, overrides: Partial<ResolvedThemeSettings>): ResolvedThemeSettings;
-
 /**
  * Shoppex Storefront SDK
  *
@@ -1134,18 +1171,22 @@ declare const shoppex: {
     getPages: typeof getPages;
     getPage: typeof getPage;
     getMenus: typeof getMenus;
+    getMenu: typeof getMenu;
     getMenuBySlot: typeof getMenuBySlot;
     getMenuByTitle: typeof getMenuByTitle;
     getMenuSlotTitles: typeof getMenuSlotTitles;
     trackPageView: typeof trackPageView;
+    getStorefrontOnlineUsers: typeof getStorefrontOnlineUsers;
+    touchStorefrontPresence: typeof touchStorefrontPresence;
     createFormatter: typeof createFormatter;
     formatPrice: typeof formatPrice;
     clearCache: typeof clearCache;
     invalidateCache: typeof invalidateCache;
     getCacheStats: typeof getCacheStats;
+    fetchPublishedBuilderSettings: typeof fetchPublishedBuilderSettings;
     fetchPublishedThemeSettings: typeof fetchPublishedThemeSettings;
     resolveDefaults: typeof resolveDefaults;
     mergeSettings: typeof mergeSettings;
 };
 
-export { type AffiliateValidation, type ApiResponse, type BlockDefinition, type BlockInstance, type BuyerRewardActivityItem, type BuyerRewards, type CartAddOptions, type CartAddon, type CartAppliedDiscount, CartError, type CartItem, type CartMetadata, type CartPayload, type CartQuote, type CartStats, type Category, type CouponValidation, type CouponValidationOptions, type CursorPagination, type CustomFieldDefinition, type EligibleBundleDeal, type EligibleBundleDealProduct, type EligibleCartDeal, type Feedback, type Invoice, type InvoiceProduct, type Menu, type MenuItem, NetworkError, NotInitializedError, type Page, type PageLayout, type PriceVariant, type Product, type ProductAddon, type ProductBundle, type ProductBundleProduct, type ProductCategory, type ProductFaq, type ProductFeedback, type ProductGroup, type ProductImage, type ProductVariant, type ResolvedThemeSettings, type RewardActionType, type RewardGrantStatus, type RewardProgramSummary, type RewardProgramTeaserItem, type RewardReason, type SDKResponse, type SectionDefinition, type SettingField, type Shop, type ShopFeedback, type ShopTheme, type ShoppexConfig, ShoppexError, type ShoppexInitOptions, type StorefrontAddon, type StorefrontAddonBootstrap, type StorefrontAnnouncementBarAddon, type StorefrontCountdownBarAddon, type StorefrontCouponPopupModalAddon, type StorefrontCustomField, type StorefrontData, type StorefrontItem, type StorefrontPromoInfoCardAddon, type StorefrontRecentPurchasePopupAddon, type Subscription, type SubscriptionFlags, type SubscriptionInterval, type ThemeBlockManifest, type ThemeConfig, type TrustedChecks, ValidationError, buildStorefrontCustomFieldPayload, shoppex as default, fetchPublishedThemeSettings, getMenuBySlot, getMenuByTitle, getMenuSlotTitles, isStorefrontCheckboxCustomFieldValueChecked, mergeSettings, normalizeStorefrontCustomFields, resolveDefaults, shoppex, trackPageView, validateStorefrontCustomFieldValue };
+export { type AffiliateValidation, type ApiResponse, type BlockDefinition, type BlockInstance, type BuyerRewardActivityItem, type BuyerRewards, type CartAddOptions, type CartAddon, type CartAppliedDiscount, CartError, type CartItem, type CartMetadata, type CartPayload, type CartQuote, type CartStats, type Category, type CouponValidation, type CouponValidationOptions, type CursorPagination, type CustomFieldDefinition, type EligibleBundleDeal, type EligibleBundleDealProduct, type EligibleCartDeal, type Feedback, type Invoice, type InvoiceProduct, type Menu, type MenuItem, NetworkError, NotInitializedError, type Page, type PageLayout, type PriceVariant, type Product, type ProductAddon, type ProductBundle, type ProductBundleProduct, type ProductCategory, type ProductFaq, type ProductFeedback, type ProductGroup, type ProductImage, type ProductVariant, type PublishedBuilderSettings, type PublishedThemeSettingsPayload, type ResolvedThemeSettings, type RewardActionType, type RewardGrantStatus, type RewardProgramSummary, type RewardProgramTeaserItem, type RewardReason, type SDKResponse, type SectionDefinition, type SettingField, type Shop, type ShopFeedback, type ShopTheme, type ShoppexConfig, ShoppexError, type ShoppexInitOptions, type StorefrontAddon, type StorefrontAddonBootstrap, type StorefrontAnnouncementBarAddon, type StorefrontCountdownBarAddon, type StorefrontCouponPopupModalAddon, type StorefrontCustomField, type StorefrontData, type StorefrontItem, type StorefrontOnlineUsers, type StorefrontPromoInfoCardAddon, type StorefrontRecentPurchasePopupAddon, type Subscription, type SubscriptionFlags, type SubscriptionInterval, type ThemeBlockManifest, type ThemeConfig, type TrustedChecks, ValidationError, buildStorefrontCustomFieldPayload, shoppex as default, fetchPublishedBuilderSettings, fetchPublishedThemeSettings, getMenu, getMenuBySlot, getMenuByTitle, getMenuSlotTitles, getMenus, getStorefrontOnlineUsers, isStorefrontCheckboxCustomFieldValueChecked, mergeSettings, normalizeStorefrontCustomFields, resolveDefaults, shoppex, touchStorefrontPresence, trackPageView, validateStorefrontCustomFieldValue };

package/dist/index.d.ts

@@ -540,6 +540,10 @@ type StorefrontAddon = StorefrontAnnouncementBarAddon | StorefrontCountdownBarAd
 interface StorefrontAddonBootstrap {
     items: StorefrontAddon[];
 }
+interface StorefrontOnlineUsers {
+    count: number;
+    window_seconds: number;
+}
 type StorefrontItem = {
     item_type: 'PRODUCT' | 'GROUP';
     uniqid: string;
@@ -634,7 +638,7 @@ interface CartPayload {
     coupon?: string;
 }
 interface CartAppliedDiscount {
-    source: 'AUTOMATIC_PRODUCT_DEAL' | 'BUNDLE_DEAL' | 'COUPON';
+    source: 'PRODUCT_DISCOUNT' | 'VOLUME_DISCOUNT' | 'AUTOMATIC_PRODUCT_DEAL' | 'BUNDLE_DEAL' | 'COUPON';
     source_id: string | null;
     source_uniqid: string | null;
     label: string;
@@ -870,6 +874,31 @@ type ResolvedThemeSettings = {
     };
 };
 
+type JsonRecord = Record<string, unknown>;
+interface PublishedBuilderSettings {
+    version: number;
+    revision: number;
+    theme: {
+        content: JsonRecord;
+        layout: JsonRecord;
+        style_slots: JsonRecord;
+        pages?: unknown[];
+        terms?: JsonRecord;
+        [key: string]: unknown;
+    };
+    [key: string]: unknown;
+}
+interface PublishedThemeSettingsPayload {
+    settings: ResolvedThemeSettings;
+    builder_settings: PublishedBuilderSettings | null;
+    content: JsonRecord;
+    style_slots: JsonRecord;
+}
+declare function fetchPublishedBuilderSettings(shopSlug: string): Promise<PublishedThemeSettingsPayload | null>;
+declare function fetchPublishedThemeSettings(shopSlug: string): Promise<ResolvedThemeSettings | null>;
+declare function resolveDefaults(config: ThemeConfig): ResolvedThemeSettings;
+declare function mergeSettings(defaults: ResolvedThemeSettings, overrides: Partial<ResolvedThemeSettings>): ResolvedThemeSettings;
+
 /**
  * Store Module
  *
@@ -895,6 +924,9 @@ declare function getStoreBannerUrl(): Promise<string | null>;
 interface GetStorefrontProductsPageOptions {
     cursor?: string | null;
     limit?: number;
+    sort?: 'featured' | 'newest' | 'price-asc' | 'price-desc' | string | null;
+    category?: string | null;
+    hideOutOfStock?: boolean;
 }
 declare function getProducts(): Promise<SDKResponse<Product[]>>;
 declare function getStorefrontProductsPage(options?: GetStorefrontProductsPageOptions): Promise<SDKResponse<{
@@ -1032,6 +1064,10 @@ declare function getMenus(): Promise<SDKResponse<Menu[]>>;
  * Get a menu by its exact title.
  */
 declare function getMenuByTitle(title: string): Promise<SDKResponse<Menu>>;
+/**
+ * Get a menu by its exact title.
+ */
+declare function getMenu(title: string): Promise<SDKResponse<Menu>>;
 /**
  * Get a menu by canonical slot. The backend resolves legacy menu titles too.
  */
@@ -1040,6 +1076,11 @@ declare function getMenuSlotTitles(slot: NavigationMenuSlot): string[];
 
 declare function trackPageView(cartValue?: number, itemCount?: number): Promise<void>;
 
+declare function getStorefrontOnlineUsers(): Promise<SDKResponse<StorefrontOnlineUsers>>;
+declare function touchStorefrontPresence(): Promise<SDKResponse<{
+    pong: string;
+}>>;
+
 /**
  * Formatting Utilities
  */
@@ -1056,10 +1097,6 @@ declare function getCacheStats(): CacheStats;
 declare function clearCache(): void;
 declare function invalidateCache(prefixOrKey: string): void;
 
-declare function fetchPublishedThemeSettings(shopSlug: string): Promise<ResolvedThemeSettings | null>;
-declare function resolveDefaults(config: ThemeConfig): ResolvedThemeSettings;
-declare function mergeSettings(defaults: ResolvedThemeSettings, overrides: Partial<ResolvedThemeSettings>): ResolvedThemeSettings;
-
 /**
  * Shoppex Storefront SDK
  *
@@ -1134,18 +1171,22 @@ declare const shoppex: {
     getPages: typeof getPages;
     getPage: typeof getPage;
     getMenus: typeof getMenus;
+    getMenu: typeof getMenu;
     getMenuBySlot: typeof getMenuBySlot;
     getMenuByTitle: typeof getMenuByTitle;
     getMenuSlotTitles: typeof getMenuSlotTitles;
     trackPageView: typeof trackPageView;
+    getStorefrontOnlineUsers: typeof getStorefrontOnlineUsers;
+    touchStorefrontPresence: typeof touchStorefrontPresence;
     createFormatter: typeof createFormatter;
     formatPrice: typeof formatPrice;
     clearCache: typeof clearCache;
     invalidateCache: typeof invalidateCache;
     getCacheStats: typeof getCacheStats;
+    fetchPublishedBuilderSettings: typeof fetchPublishedBuilderSettings;
     fetchPublishedThemeSettings: typeof fetchPublishedThemeSettings;
     resolveDefaults: typeof resolveDefaults;
     mergeSettings: typeof mergeSettings;
 };
 
-export { type AffiliateValidation, type ApiResponse, type BlockDefinition, type BlockInstance, type BuyerRewardActivityItem, type BuyerRewards, type CartAddOptions, type CartAddon, type CartAppliedDiscount, CartError, type CartItem, type CartMetadata, type CartPayload, type CartQuote, type CartStats, type Category, type CouponValidation, type CouponValidationOptions, type CursorPagination, type CustomFieldDefinition, type EligibleBundleDeal, type EligibleBundleDealProduct, type EligibleCartDeal, type Feedback, type Invoice, type InvoiceProduct, type Menu, type MenuItem, NetworkError, NotInitializedError, type Page, type PageLayout, type PriceVariant, type Product, type ProductAddon, type ProductBundle, type ProductBundleProduct, type ProductCategory, type ProductFaq, type ProductFeedback, type ProductGroup, type ProductImage, type ProductVariant, type ResolvedThemeSettings, type RewardActionType, type RewardGrantStatus, type RewardProgramSummary, type RewardProgramTeaserItem, type RewardReason, type SDKResponse, type SectionDefinition, type SettingField, type Shop, type ShopFeedback, type ShopTheme, type ShoppexConfig, ShoppexError, type ShoppexInitOptions, type StorefrontAddon, type StorefrontAddonBootstrap, type StorefrontAnnouncementBarAddon, type StorefrontCountdownBarAddon, type StorefrontCouponPopupModalAddon, type StorefrontCustomField, type StorefrontData, type StorefrontItem, type StorefrontPromoInfoCardAddon, type StorefrontRecentPurchasePopupAddon, type Subscription, type SubscriptionFlags, type SubscriptionInterval, type ThemeBlockManifest, type ThemeConfig, type TrustedChecks, ValidationError, buildStorefrontCustomFieldPayload, shoppex as default, fetchPublishedThemeSettings, getMenuBySlot, getMenuByTitle, getMenuSlotTitles, isStorefrontCheckboxCustomFieldValueChecked, mergeSettings, normalizeStorefrontCustomFields, resolveDefaults, shoppex, trackPageView, validateStorefrontCustomFieldValue };
+export { type AffiliateValidation, type ApiResponse, type BlockDefinition, type BlockInstance, type BuyerRewardActivityItem, type BuyerRewards, type CartAddOptions, type CartAddon, type CartAppliedDiscount, CartError, type CartItem, type CartMetadata, type CartPayload, type CartQuote, type CartStats, type Category, type CouponValidation, type CouponValidationOptions, type CursorPagination, type CustomFieldDefinition, type EligibleBundleDeal, type EligibleBundleDealProduct, type EligibleCartDeal, type Feedback, type Invoice, type InvoiceProduct, type Menu, type MenuItem, NetworkError, NotInitializedError, type Page, type PageLayout, type PriceVariant, type Product, type ProductAddon, type ProductBundle, type ProductBundleProduct, type ProductCategory, type ProductFaq, type ProductFeedback, type ProductGroup, type ProductImage, type ProductVariant, type PublishedBuilderSettings, type PublishedThemeSettingsPayload, type ResolvedThemeSettings, type RewardActionType, type RewardGrantStatus, type RewardProgramSummary, type RewardProgramTeaserItem, type RewardReason, type SDKResponse, type SectionDefinition, type SettingField, type Shop, type ShopFeedback, type ShopTheme, type ShoppexConfig, ShoppexError, type ShoppexInitOptions, type StorefrontAddon, type StorefrontAddonBootstrap, type StorefrontAnnouncementBarAddon, type StorefrontCountdownBarAddon, type StorefrontCouponPopupModalAddon, type StorefrontCustomField, type StorefrontData, type StorefrontItem, type StorefrontOnlineUsers, type StorefrontPromoInfoCardAddon, type StorefrontRecentPurchasePopupAddon, type Subscription, type SubscriptionFlags, type SubscriptionInterval, type ThemeBlockManifest, type ThemeConfig, type TrustedChecks, ValidationError, buildStorefrontCustomFieldPayload, shoppex as default, fetchPublishedBuilderSettings, fetchPublishedThemeSettings, getMenu, getMenuBySlot, getMenuByTitle, getMenuSlotTitles, getMenus, getStorefrontOnlineUsers, isStorefrontCheckboxCustomFieldValueChecked, mergeSettings, normalizeStorefrontCustomFields, resolveDefaults, shoppex, touchStorefrontPresence, trackPageView, validateStorefrontCustomFieldValue };