@nextblock-cms/ecom 0.0.9 → 0.8.0

package/lib/types.d.ts

@@ -0,0 +1,245 @@
+import { CheckoutSessionInput } from './customer';
+import { CurrencyRecord, PriceMap, SalePriceMap } from './currency';
+export type TranslationMap = Record<string, string>;
+export type { CurrencyRecord, PriceMap, SalePriceMap };
+export type ProductType = 'physical' | 'digital';
+export type EcommercePaymentProvider = 'stripe' | 'freemius';
+export interface EnabledPaymentProviders {
+    stripe: boolean;
+    freemius: boolean;
+}
+export declare const DEFAULT_ENABLED_PAYMENT_PROVIDERS: EnabledPaymentProviders;
+export declare function normalizeEnabledPaymentProviders(value: unknown): EnabledPaymentProviders;
+export declare function derivePaymentProviderFromProductType(productType: ProductType): EcommercePaymentProvider;
+export interface ProductAttributeTerm {
+    id: string;
+    attribute_id: string;
+    value: string;
+    slug: string;
+    sort_order?: number | null;
+    value_translations?: TranslationMap | null;
+}
+export interface ProductAttribute {
+    id: string;
+    name: string;
+    slug: string;
+    name_translations?: TranslationMap | null;
+    terms: ProductAttributeTerm[];
+}
+export interface ProductVariantOption {
+    attribute_id: string;
+    attribute_name: string;
+    term_id: string;
+    term_value: string;
+    term_slug?: string;
+}
+export interface ProductVariant {
+    id: string;
+    combination_key: string;
+    sku: string;
+    upc?: string | null;
+    price: number;
+    prices?: PriceMap | null;
+    sale_price?: number | null;
+    sale_prices?: SalePriceMap | null;
+    sale_start_at?: string | null;
+    sale_end_at?: string | null;
+    scheduled_price?: number | null;
+    scheduled_prices?: PriceMap | null;
+    scheduled_price_at?: string | null;
+    stock_quantity: number;
+    attribute_term_ids: string[];
+    selected_options: ProductVariantOption[];
+    label: string;
+    main_media_id?: string | null;
+    image_url?: string | null;
+}
+export interface Category {
+    id: string;
+    name: string;
+    slug: string;
+    description?: string | null;
+    name_translations?: Record<string, string> | null;
+    description_translations?: Record<string, string> | null;
+}
+export interface Product {
+    id: string;
+    title: string;
+    slug: string;
+    categories?: Category[];
+    sku: string;
+    upc?: string | null;
+    price: number;
+    prices?: PriceMap | null;
+    sale_price?: number | null;
+    sale_prices?: SalePriceMap | null;
+    sale_start_at?: string | null;
+    sale_end_at?: string | null;
+    scheduled_price?: number | null;
+    scheduled_prices?: PriceMap | null;
+    scheduled_price_at?: string | null;
+    is_taxable?: boolean;
+    product_type?: ProductType;
+    payment_provider?: EcommercePaymentProvider;
+    price_range_min?: number | null;
+    price_range_max?: number | null;
+    image_url?: string;
+    images?: {
+        url: string;
+        alt?: string;
+    }[];
+    short_description?: string | null;
+    description_json?: any;
+    description_blocks?: any[];
+    stock?: number | null;
+    freemius_product_id?: string;
+    freemius_plan_id?: string;
+    trial_period_days?: number | null;
+    trial_requires_payment_method?: boolean | null;
+    custom_props?: any;
+    language_id: number;
+    translation_group_id: string;
+    language_code?: string;
+    has_variants?: boolean;
+    variant_id?: string;
+    variant_label?: string;
+    selected_options?: ProductVariantOption[];
+    attributes?: ProductAttribute[];
+    variants?: ProductVariant[];
+    product_variants?: Array<{
+        id: string;
+        price: number;
+        prices?: PriceMap | null;
+        sale_price?: number | null;
+        sale_prices?: SalePriceMap | null;
+        sale_start_at?: string | null;
+        sale_end_at?: string | null;
+        scheduled_price?: number | null;
+        scheduled_prices?: PriceMap | null;
+        scheduled_price_at?: string | null;
+    }>;
+    freemius_plans?: Array<{
+        id: string;
+        name: string;
+        title: string | null;
+        freemius_pricing: Array<{
+            id: string;
+            license_quota: number | null;
+            api_monthly_price: number | null;
+            api_annual_price: number | null;
+            api_lifetime_price: number | null;
+            override_monthly_price: number | null;
+            override_annual_price: number | null;
+            override_lifetime_price: number | null;
+            is_active: boolean;
+        }>;
+    }>;
+}
+export interface ShippingZone {
+    id: string;
+    name: string;
+    priority_order: number;
+    countries: string[];
+    states: string[];
+}
+export interface TaxRate {
+    id: string;
+    country_code: string;
+    state_code?: string | null;
+    tax_name: string;
+    tax_rate: number;
+    created_at?: string | null;
+    updated_at?: string | null;
+}
+export type TaxCalculationMode = 'manual' | 'automatic';
+export interface EcommerceSettings {
+    trackQuantities: boolean;
+    enableTaxes: boolean;
+    taxCalculationMode: TaxCalculationMode;
+}
+export interface TaxCalculationLine {
+    id?: string;
+    name: string;
+    rate: number;
+    amount: number;
+    country_code: string;
+    state_code?: string | null;
+}
+export interface TaxCalculationResult {
+    enabled: boolean;
+    mode: TaxCalculationMode;
+    amount: number;
+    taxableSubtotal: number;
+    lines: TaxCalculationLine[];
+    isPendingExternalCalculation?: boolean;
+}
+export type BillingCycle = 'monthly' | 'annual' | 'lifetime';
+export type CartItemProvider = EcommercePaymentProvider;
+export type CartItem = Product & {
+    quantity: number;
+    product_id: string;
+    currency_code?: string;
+    /** Which payment provider handles this cart item */
+    provider?: CartItemProvider;
+    /** For Freemius items: the selected billing cycle */
+    billing_cycle?: BillingCycle;
+    /** For Freemius items: explicitly requested trial mode (free vs paid) */
+    trial_preference?: 'free' | 'paid';
+    /** The MSRP/Original price before any sale_price logic */
+    original_price?: number;
+};
+export declare function getProductPaymentProvider(value: Pick<Product, 'payment_provider' | 'product_type' | 'freemius_product_id'> | Pick<CartItem, 'provider' | 'payment_provider' | 'product_type' | 'freemius_product_id'> | null | undefined): EcommercePaymentProvider | null;
+export declare function isDigitalProduct(value: Pick<Product, 'payment_provider' | 'product_type' | 'freemius_product_id'> | Pick<CartItem, 'provider' | 'payment_provider' | 'product_type' | 'freemius_product_id'> | null | undefined): boolean;
+export interface CheckoutProviderError {
+    error: string;
+    errorKey?: string;
+    errorParams?: Record<string, string | number>;
+    errorStatus?: number;
+}
+/** Helper to check if a cart item is a Freemius digital product */
+export declare function isDigitalItem(item: Pick<CartItem, 'provider' | 'payment_provider' | 'product_type' | 'freemius_product_id'>): boolean;
+export interface PaymentProvider {
+    createCheckoutSession(input: CheckoutSessionInput): Promise<{
+        url: string | null;
+        error?: string;
+        errorKey?: string;
+        errorParams?: Record<string, string | number>;
+        errorStatus?: number;
+        customProps?: any;
+    }>;
+    getProviderName(): string;
+}
+export interface FreemiusPlanAPI {
+    id: number;
+    name: string;
+    title: string;
+    description: string;
+    trial_period?: number | string | null;
+    is_require_subscription?: boolean | number | string | null;
+    created: string;
+    updated: string;
+}
+export interface FreemiusPricingAPI {
+    id: number;
+    plan_id: number;
+    currency: string;
+    monthly_price: number | null;
+    annual_price: number | null;
+    lifetime_price: number | null;
+    licenses: number;
+}
+/** Resolved pricing tier for the storefront (override takes precedence over api) */
+export interface ResolvedPricingTier {
+    id: string;
+    license_quota: number;
+    monthly_price: number | null;
+    annual_price: number | null;
+    lifetime_price: number | null;
+    is_active: boolean;
+}
+export interface ResolvedPlanWithPricing {
+    id: string;
+    name: string;
+    title: string;
+    pricing: ResolvedPricingTier[];
+}

package/lib/use-cart.d.ts

@@ -0,0 +1,11 @@
+import { useCartStore } from './cart-store';
+/**
+ * A wrapper to safely use the cart store with hydration support.
+ * This prevents hydration mismatches because the persisted state in localStorage
+ * differs from the server-rendered HTML.
+ */
+export declare const useCart: <T>(selector: (state: ReturnType<typeof useCartStore.getState>) => T) => T | undefined;
+/**
+ * Hook to check if the store has hydrated.
+ */
+export declare const useIsCartHydrated: () => boolean;

package/lib/variation-utils.d.ts

@@ -0,0 +1,72 @@
+import { PriceMap, ProductAttribute, ProductAttributeTerm, ProductVariant, ProductVariantOption, SalePriceMap, TranslationMap } from './types';
+export interface VariationSelectionGroup {
+    attribute_id: string;
+    attribute_name: string;
+    terms: ProductAttributeTerm[];
+}
+export interface ProductVariantDraft {
+    id?: string;
+    combination_key: string;
+    sku: string;
+    upc?: string | null;
+    price: number;
+    prices: PriceMap;
+    sale_price?: number | null;
+    sale_prices: SalePriceMap;
+    sale_start_at?: string | null;
+    sale_end_at?: string | null;
+    stock_quantity: number;
+    main_media_id?: string | null;
+    main_image_url?: string | null;
+    attribute_term_ids: string[];
+    selected_options: ProductVariantOption[];
+    label: string;
+}
+export declare function resolveTranslatedText(baseValue: string, translations?: TranslationMap | null, languageCode?: string | null): string;
+export declare function resolveAttributeName(attribute: ProductAttribute, languageCode?: string | null): string;
+export declare function resolveTermValue(term: ProductAttributeTerm, languageCode?: string | null): string;
+export declare function buildCombinationKey(attributeTermIds: string[]): string;
+export declare function buildVariantLabel(options: ProductVariantOption[]): string;
+export declare function generateVariantDrafts(params: {
+    baseSku: string;
+    basePrice: number;
+    basePrices?: PriceMap | null;
+    baseSalePrice?: number | null;
+    baseSalePrices?: SalePriceMap | null;
+    selectedAttributes: VariationSelectionGroup[];
+    previousVariants?: ProductVariantDraft[];
+}): {
+    id: string | undefined;
+    combination_key: string;
+    sku: string;
+    upc: string | null;
+    price: number;
+    prices: PriceMap;
+    sale_price: number | null;
+    sale_prices: SalePriceMap;
+    sale_start_at: string | null;
+    sale_end_at: string | null;
+    stock_quantity: number;
+    main_media_id: string | null;
+    main_image_url: string | null;
+    attribute_term_ids: string[];
+    selected_options: ProductVariantOption[];
+    label: string;
+}[];
+export declare function extractSelectedTermsByAttribute(variants: Array<{
+    selected_options?: ProductVariantOption[];
+}>): Record<string, string[]>;
+export declare function findMatchingVariant(variants: ProductVariant[], selections: Record<string, string | undefined>): ProductVariant | null;
+export declare function getAvailableTermIdsForAttribute(variants: ProductVariant[], attributeId: string, selections: Record<string, string | undefined>): Set<string>;
+export declare function chooseInitialVariantSelections(attributes: ProductAttribute[], variants: ProductVariant[]): Record<string, string>;
+export declare function normalizeSelectionsToAvailableVariants(attributes: ProductAttribute[], variants: ProductVariant[], selections: Record<string, string | undefined>): {
+    [x: string]: string | undefined;
+};
+export declare function mapRawVariantRelations(rawVariants?: any[], languageCode?: string | null): {
+    attributes: ProductAttribute[];
+    variants: ProductVariant[];
+};
+export declare function getVariantEffectivePriceRange(variants: Array<Pick<ProductVariant, 'price' | 'sale_price' | 'sale_start_at' | 'sale_end_at'>>, now?: Date): {
+    min: number;
+    max: number;
+} | null;

package/lib/zod-config.d.ts

@@ -0,0 +1,2 @@
+import { z } from 'zod';
+export { z };

package/package.json

@@ -1,6 +1,51 @@
 {
   "name": "@nextblock-cms/ecom",
-  "version": "0.0.9",
+  "version": "0.8.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nextblock-cms/packages.git"
+  },
   "type": "module",
-  "dependencies": {}
+  "dependencies": {
+    "@nextblock-cms/db": "^0.8.0",
+    "@nextblock-cms/ui": "^0.8.0",
+    "@nextblock-cms/utils": "^0.8.0",
+    "@freemius/checkout": "^1.4.1",
+    "@freemius/sdk": "^0.3.0",
+    "@hookform/resolvers": "^5.2.2",
+    "@supabase/supabase-js": "^2.105.1",
+    "lucide-react": "^0.577.0",
+    "papaparse": "^5.5.3",
+    "postgres": "^3.4.9",
+    "react-hook-form": "^7.74.0",
+    "server-only": "^0.0.1",
+    "sonner": "^2.0.7",
+    "stripe": "^20.4.1",
+    "zod": "^4.3.6",
+    "zustand": "^5.0.12"
+  },
+  "peerDependencies": {
+    "next": "^16.2.7",
+    "react": "^19.2.5",
+    "react-dom": "^19.2.5"
+  },
+  "main": "./index.cjs.js",
+  "module": "./index.es.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "import": "./index.es.js",
+      "require": "./index.cjs.js"
+    },
+    "./server": {
+      "types": "./server.d.ts",
+      "import": "./server.es.js",
+      "require": "./server.cjs.js"
+    },
+    "./package.json": "./package.json"
+  }
 }