@proxima-io/storefront-core 0.2.0 → 0.3.0

package/dist/fixtures-commerce.d.ts

@@ -0,0 +1,140 @@
+/**
+ * Per-app commerce fixtures — logic lives in SDK; JSON is injected per website.
+ */
+import type { BuyerProfile, Cart, CategoryNavTreeResponse, CustomerAddress, GuestOrderPayload, GuestOrderResult, Order, OrderListResponse, ProductListingFilters, ProductListingSortOption, ProximaWebsiteResponse, StorefrontBrandListingResponse, StorefrontCategoryListingResponse, StorefrontProductListingResponse, StorefrontSearchResponse, UbigeoResult } from "./index.js";
+export type StorefrontDataMode = "fixtures" | "live";
+/** Raw catalog entity as stored in apps/{slug}/src/fixtures/catalog-items.json */
+export type FixtureCatalogItem = Record<string, unknown>;
+export interface FixtureBundleInput {
+    catalog: FixtureCatalogItem[];
+    categoryNavTree: CategoryNavTreeResponse;
+    cart?: Cart | null;
+    categoryProductMap?: Record<string, string[]>;
+    customerAddresses?: CustomerAddress[];
+}
+export interface FixtureProductListingParams {
+    filters?: ProductListingFilters;
+    sort?: ProductListingSortOption | string;
+    page?: number;
+    page_size?: number;
+    currency?: string;
+    locale?: string;
+}
+export interface FixtureSearchParams {
+    q: string;
+    limit?: number;
+    currency?: string;
+    locale?: string;
+}
+export interface FixtureCartMutationParams {
+    token?: string | null;
+    sessionId?: string | null;
+    variantId: number;
+    quantity?: number;
+}
+export declare class FixtureGuestOrderError extends Error {
+    readonly code: "CART_NOT_FOUND" | "OUT_OF_STOCK" | "SERVER_ERROR" | "VARIANT_NOT_FOUND";
+    constructor(code: "CART_NOT_FOUND" | "OUT_OF_STOCK" | "SERVER_ERROR" | "VARIANT_NOT_FOUND", message: string);
+}
+export interface FixtureBundle extends FixtureBundleInput {
+    getCart(sessionId?: string | null): Cart;
+    addToCart(sessionId: string | null | undefined, variantId: number, quantity: number): Cart;
+    updateCartItem(sessionId: string | null | undefined, variantId: number, quantity: number): Cart;
+    removeCartItem(sessionId: string | null | undefined, variantId: number): Cart;
+    getCategoryNavTree(): CategoryNavTreeResponse;
+    getCategoryProducts(slug: string, params?: FixtureListingParams): StorefrontCategoryListingResponse;
+    getBrandProducts(slug: string, params?: FixtureBrandListingParams): StorefrontBrandListingResponse;
+    getProductListing(params?: FixtureProductListingParams): StorefrontProductListingResponse;
+    searchProducts(params: FixtureSearchParams): StorefrontSearchResponse;
+    getCustomerAddresses(): CustomerAddress[];
+    processGuestCheckout(sessionId: string, payload: GuestOrderPayload): GuestOrderResult;
+}
+export interface FixtureListingParams {
+    page?: number;
+    pageSize?: number;
+    sort?: string;
+    brand?: string;
+    currency?: string;
+    locale?: string;
+}
+export interface FixtureBrandListingParams extends FixtureListingParams {
+    category?: string;
+}
+export interface StorefrontDataSourceConfig {
+    mode: StorefrontDataMode;
+    fixtures: FixtureBundle;
+    apiConfig: {
+        baseUrl: string;
+    };
+    website: Pick<ProximaWebsiteResponse, "business_id" | "locale" | "currency">;
+}
+export interface StorefrontCartParams {
+    token?: string | null;
+    sessionId?: string | null;
+}
+export interface StorefrontDataSource {
+    getCart(params?: StorefrontCartParams): Promise<Cart>;
+    addToCart(params: FixtureCartMutationParams): Promise<Cart>;
+    updateCartItem(params: FixtureCartMutationParams & {
+        quantity: number;
+    }): Promise<Cart>;
+    removeCartItem(params: Omit<FixtureCartMutationParams, "quantity">): Promise<Cart>;
+    getCategoryNavTree(params?: {
+        maxDepth?: number;
+        locale?: string;
+    }): Promise<CategoryNavTreeResponse>;
+    getCategoryProducts(slug: string, params?: FixtureListingParams & {
+        brand?: string;
+        q?: string;
+    }): Promise<StorefrontCategoryListingResponse>;
+    getBrandProducts(slug: string, params?: FixtureBrandListingParams & {
+        q?: string;
+    }): Promise<StorefrontBrandListingResponse>;
+    getProductListing(params?: FixtureProductListingParams): Promise<StorefrontProductListingResponse>;
+    searchProducts(params: FixtureSearchParams): Promise<StorefrontSearchResponse>;
+    getCustomerAddresses(params?: {
+        token?: string | null;
+    }): Promise<CustomerAddress[]>;
+    getBuyerProfile(params: {
+        token: string;
+    }): Promise<BuyerProfile>;
+    getOrders(params: {
+        token: string;
+        page?: number;
+        size?: number;
+    }): Promise<OrderListResponse>;
+    getOrder(params: {
+        token: string;
+        orderId: string;
+    }): Promise<Order>;
+    searchUbigeo(params: {
+        q: string;
+    }): Promise<UbigeoResult[]>;
+    processGuestCheckout(payload: GuestOrderPayload): Promise<GuestOrderResult>;
+}
+export interface ResolveStorefrontDataSourceOptions {
+    request: Request;
+    fixtures: FixtureBundle;
+    apiConfig: {
+        baseUrl: string;
+        domain?: string;
+        serviceKey?: string;
+    };
+    resolveMode: (host: string) => StorefrontDataMode;
+    getRequestHost: (request: Request) => string;
+    getFixtureWebsite: () => Pick<ProximaWebsiteResponse, "business_id" | "locale" | "currency" | "data_mode">;
+    fetchLiveWebsite: () => Promise<Pick<ProximaWebsiteResponse, "business_id" | "locale" | "currency" | "data_mode">>;
+}
+export interface ValidateFixtureBundleOptions {
+    /** Product slugs referenced from composition fixtures (e.g. home.json collections) */
+    compositionProductSlugs?: string[];
+}
+export declare function createFixtureBundle(input: FixtureBundleInput): FixtureBundle;
+export declare function validateFixtureBundle(input: FixtureBundleInput, options?: ValidateFixtureBundleOptions): string[];
+export declare function createStorefrontDataSource(config: StorefrontDataSourceConfig): StorefrontDataSource;
+/**
+ * Resolve mode + website then return a StorefrontDataSource.
+ * Apps inject env-specific callbacks; all commerce/live vs fixtures routing stays in SDK.
+ */
+export declare function resolveStorefrontDataSourceForRequest(options: ResolveStorefrontDataSourceOptions): Promise<StorefrontDataSource>;
+//# sourceMappingURL=fixtures-commerce.d.ts.map

package/dist/fixtures-commerce.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"fixtures-commerce.d.ts","sourceRoot":"","sources":["../src/fixtures-commerce.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,OAAO,KAAK,EACV,YAAY,EACZ,IAAI,EAGJ,uBAAuB,EACvB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,KAAK,EACL,iBAAiB,EACjB,qBAAqB,EACrB,wBAAwB,EACxB,sBAAsB,EACtB,8BAA8B,EAC9B,iCAAiC,EACjC,gCAAgC,EAEhC,wBAAwB,EAExB,YAAY,EACb,MAAM,YAAY,CAAC;AAMpB,MAAM,MAAM,kBAAkB,GAAG,UAAU,GAAG,MAAM,CAAC;AAErD,kFAAkF;AAClF,MAAM,MAAM,kBAAkB,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;AAEzD,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,kBAAkB,EAAE,CAAC;IAC9B,eAAe,EAAE,uBAAuB,CAAC;IACzC,IAAI,CAAC,EAAE,IAAI,GAAG,IAAI,CAAC;IACnB,kBAAkB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC;IAC9C,iBAAiB,CAAC,EAAE,eAAe,EAAE,CAAC;CACvC;AAED,MAAM,WAAW,2BAA2B;IAC1C,OAAO,CAAC,EAAE,qBAAqB,CAAC;IAChC,IAAI,CAAC,EAAE,wBAAwB,GAAG,MAAM,CAAC;IACzC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,mBAAmB;IAClC,CAAC,EAAE,MAAM,CAAC;IACV,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,qBAAa,sBAAuB,SAAQ,KAAK;aAE7B,IAAI,EAAE,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,mBAAmB;gBAA9E,IAAI,EAAE,gBAAgB,GAAG,cAAc,GAAG,cAAc,GAAG,mBAAmB,EAC9F,OAAO,EAAE,MAAM;CAKlB;AAED,MAAM,WAAW,aAAc,SAAQ,kBAAkB;IACvD,OAAO,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,GAAG,IAAI,CAAC;IACzC,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAC3F,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAC;IAChG,cAAc,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI,GAAG,SAAS,EAAE,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IAC9E,kBAAkB,IAAI,uBAAuB,CAAC;IAC9C,mBAAmB,CACjB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,oBAAoB,GAC5B,iCAAiC,CAAC;IACrC,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,yBAAyB,GACjC,8BAA8B,CAAC;IAClC,iBAAiB,CAAC,MAAM,CAAC,EAAE,2BAA2B,GAAG,gCAAgC,CAAC;IAC1F,cAAc,CAAC,MAAM,EAAE,mBAAmB,GAAG,wBAAwB,CAAC;IACtE,oBAAoB,IAAI,eAAe,EAAE,CAAC;IAC1C,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,iBAAiB,GAAG,gBAAgB,CAAC;CACvF;AAED,MAAM,WAAW,oBAAoB;IACnC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAA0B,SAAQ,oBAAoB;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,kBAAkB,CAAC;IACzB,QAAQ,EAAE,aAAa,CAAC;IACxB,SAAS,EAAE;QAAE,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAC/B,OAAO,EAAE,IAAI,CAAC,sBAAsB,EAAE,aAAa,GAAG,QAAQ,GAAG,UAAU,CAAC,CAAC;CAC9E;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACtB,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CAC3B;AAED,MAAM,WAAW,oBAAoB;IACnC,OAAO,CAAC,MAAM,CAAC,EAAE,oBAAoB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACtD,SAAS,CAAC,MAAM,EAAE,yBAAyB,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAC5D,cAAc,CAAC,MAAM,EAAE,yBAAyB,GAAG;QAAE,QAAQ,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACxF,cAAc,CAAC,MAAM,EAAE,IAAI,CAAC,yBAAyB,EAAE,UAAU,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IACnF,kBAAkB,CAAC,MAAM,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,uBAAuB,CAAC,CAAC;IACtG,mBAAmB,CACjB,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,oBAAoB,GAAG;QAAE,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAC7D,OAAO,CAAC,iCAAiC,CAAC,CAAC;IAC9C,gBAAgB,CACd,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE,yBAAyB,GAAG;QAAE,CAAC,CAAC,EAAE,MAAM,CAAA;KAAE,GAClD,OAAO,CAAC,8BAA8B,CAAC,CAAC;IAC3C,iBAAiB,CAAC,MAAM,CAAC,EAAE,2BAA2B,GAAG,OAAO,CAAC,gCAAgC,CAAC,CAAC;IACnG,cAAc,CAAC,MAAM,EAAE,mBAAmB,GAAG,OAAO,CAAC,wBAAwB,CAAC,CAAC;IAC/E,oBAAoB,CAAC,MAAM,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,GAAG,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC;IACrF,eAAe,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,CAAC,CAAC;IAClE,SAAS,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,IAAI,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;IAC/F,QAAQ,CAAC,MAAM,EAAE;QAAE,KAAK,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,KAAK,CAAC,CAAC;IACrE,YAAY,CAAC,MAAM,EAAE;QAAE,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,YAAY,EAAE,CAAC,CAAC;IAC7D,oBAAoB,CAAC,OAAO,EAAE,iBAAiB,GAAG,OAAO,CAAC,gBAAgB,CAAC,CAAC;CAC7E;AAED,MAAM,WAAW,kCAAkC;IACjD,OAAO,EAAE,OAAO,CAAC;IACjB,QAAQ,EAAE,aAAa,CAAC;IACxB,SAAS,EAAE;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE,CAAC;IACrE,WAAW,EAAE,CAAC,IAAI,EAAE,MAAM,KAAK,kBAAkB,CAAC;IAClD,cAAc,EAAE,CAAC,OAAO,EAAE,OAAO,KAAK,MAAM,CAAC;IAC7C,iBAAiB,EAAE,MAAM,IAAI,CAC3B,sBAAsB,EACtB,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CACpD,CAAC;IACF,gBAAgB,EAAE,MAAM,OAAO,CAC7B,IAAI,CAAC,sBAAsB,EAAE,aAAa,GAAG,QAAQ,GAAG,UAAU,GAAG,WAAW,CAAC,CAClF,CAAC;CACH;AAED,MAAM,WAAW,4BAA4B;IAC3C,sFAAsF;IACtF,uBAAuB,CAAC,EAAE,MAAM,EAAE,CAAC;CACpC;AA6fD,wBAAgB,mBAAmB,CAAC,KAAK,EAAE,kBAAkB,GAAG,aAAa,CAuE5E;AAMD,wBAAgB,qBAAqB,CACnC,KAAK,EAAE,kBAAkB,EACzB,OAAO,GAAE,4BAAiC,GACzC,MAAM,EAAE,CA0CV;AAMD,wBAAgB,0BAA0B,CAAC,MAAM,EAAE,0BAA0B,GAAG,oBAAoB,CA+MnG;AAED;;;GAGG;AACH,wBAAsB,qCAAqC,CACzD,OAAO,EAAE,kCAAkC,GAC1C,OAAO,CAAC,oBAAoB,CAAC,CAoB/B"}