rerobe-js-orm 4.8.7 → 4.9.0

package/lib/constants/marketplace-constants.d.ts

@@ -0,0 +1,52 @@
+export declare const MARKETPLACE_LISTING_STATUSES: {
+    readonly active: "ACTIVE";
+    readonly paused: "PAUSED";
+    readonly removed: "REMOVED";
+};
+export type MarketplaceListingStatusValue = typeof MARKETPLACE_LISTING_STATUSES[keyof typeof MARKETPLACE_LISTING_STATUSES];
+export declare const MARKETPLACE_COMMISSION_BASES: {
+    readonly lineNetExcludingTax: "LINE_NET_EXCLUDING_TAX";
+    readonly originalCommissionShare: "ORIGINAL_COMMISSION_SHARE";
+};
+export type MarketplaceCommissionBasisValue = typeof MARKETPLACE_COMMISSION_BASES[keyof typeof MARKETPLACE_COMMISSION_BASES];
+export declare const MARKETPLACE_RELATIONSHIP_TYPES: {
+    readonly marketplaceSeller: "MARKETPLACE_SELLER";
+};
+export type MarketplaceRelationshipTypeValue = typeof MARKETPLACE_RELATIONSHIP_TYPES[keyof typeof MARKETPLACE_RELATIONSHIP_TYPES];
+export declare const MARKETPLACE_FEE_TYPES: {
+    readonly stripe: "STRIPE";
+    readonly ribbn: "RIBBN";
+    readonly marketplace: "MARKETPLACE";
+};
+export type MarketplaceFeeTypeValue = typeof MARKETPLACE_FEE_TYPES[keyof typeof MARKETPLACE_FEE_TYPES];
+export declare const MARKETPLACE_FEE_ALLOCATION_BASES: {
+    readonly evenPerSeller: "EVEN_PER_SELLER";
+    readonly proportionalToLineNet: "PROPORTIONAL_TO_LINE_NET";
+};
+export type MarketplaceFeeAllocationBasisValue = typeof MARKETPLACE_FEE_ALLOCATION_BASES[keyof typeof MARKETPLACE_FEE_ALLOCATION_BASES];
+export declare const MARKETPLACE_LEDGER_STATUSES: {
+    readonly pendingReturnPeriod: "PENDING_RETURN_PERIOD";
+    readonly payable: "PAYABLE";
+    readonly paidOut: "PAID_OUT";
+    readonly returnedBeforePayout: "RETURNED_BEFORE_PAYOUT";
+    readonly refundedAfterPayout: "REFUNDED_AFTER_PAYOUT";
+    readonly transferReversed: "TRANSFER_REVERSED";
+};
+export type MarketplaceLedgerStatusValue = typeof MARKETPLACE_LEDGER_STATUSES[keyof typeof MARKETPLACE_LEDGER_STATUSES];
+export declare const MARKETPLACE_INVENTORY_POLICY_KINDS: {
+    readonly multivariantLocation: "MULTIVARIANT_LOCATION";
+    readonly oneOfAKind: "ONE_OF_A_KIND";
+    readonly untrackedStock: "UNTRACKED_STOCK";
+};
+export type MarketplaceInventoryPolicyKindValue = typeof MARKETPLACE_INVENTORY_POLICY_KINDS[keyof typeof MARKETPLACE_INVENTORY_POLICY_KINDS];
+export declare const STOCK_STATUSES: {
+    readonly inStockUnlimited: "IN_STOCK_UNLIMITED";
+};
+export type StockStatusValue = typeof STOCK_STATUSES[keyof typeof STOCK_STATUSES];
+export declare const MARKETPLACE_SELLER_DEFAULT_COMMISSION = "1";
+export declare const DEFAULT_MARKETPLACE_LISTING_STATUS: MarketplaceListingStatusValue;
+export declare const DEFAULT_MARKETPLACE_COMMISSION_BASIS: MarketplaceCommissionBasisValue;
+export declare const DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE: MarketplaceRelationshipTypeValue;
+export declare const DEFAULT_STRIPE_FEE_ALLOCATION_BASIS: MarketplaceFeeAllocationBasisValue;
+export declare const DEFAULT_RIBBN_FEE_ALLOCATION_BASIS: MarketplaceFeeAllocationBasisValue;
+export declare const DEFAULT_MARKETPLACE_LEDGER_STATUS: MarketplaceLedgerStatusValue;

package/lib/constants/marketplace-constants.js

@@ -0,0 +1,82 @@
+"use strict";
+// Source of truth for marketplace-related string values that flow through
+// the ORM, backend, and clients. Keep names stable, since these values get
+// persisted on Firestore documents (product.marketplace, order.lineItems[].
+// marketplace, MerchantRelationship, marketplace ledger entries) and indexed
+// in Typesense.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DEFAULT_MARKETPLACE_LEDGER_STATUS = exports.DEFAULT_RIBBN_FEE_ALLOCATION_BASIS = exports.DEFAULT_STRIPE_FEE_ALLOCATION_BASIS = exports.DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE = exports.DEFAULT_MARKETPLACE_COMMISSION_BASIS = exports.DEFAULT_MARKETPLACE_LISTING_STATUS = exports.MARKETPLACE_SELLER_DEFAULT_COMMISSION = exports.STOCK_STATUSES = exports.MARKETPLACE_INVENTORY_POLICY_KINDS = exports.MARKETPLACE_LEDGER_STATUSES = exports.MARKETPLACE_FEE_ALLOCATION_BASES = exports.MARKETPLACE_FEE_TYPES = exports.MARKETPLACE_RELATIONSHIP_TYPES = exports.MARKETPLACE_COMMISSION_BASES = exports.MARKETPLACE_LISTING_STATUSES = void 0;
+exports.MARKETPLACE_LISTING_STATUSES = {
+    active: 'ACTIVE',
+    paused: 'PAUSED',
+    removed: 'REMOVED',
+};
+// Commission basis controls how a marketplace cut is computed against an
+// individual line item at sale time. Snapshots persist this value alongside
+// the calculated amounts so refunds/payouts can replay the exact rule that
+// was in force when the sale occurred.
+exports.MARKETPLACE_COMMISSION_BASES = {
+    // Marketplace commission = marketplaceRate * line tax-exclusive net.
+    // Original product commission still applies on top, so seller and managed
+    // merchant proceeds are independent.
+    lineNetExcludingTax: 'LINE_NET_EXCLUDING_TAX',
+    // Marketplace commission comes out of the original product commission
+    // pool, so the managed merchant absorbs the marketplace cut and the
+    // seller payout is unaffected.
+    originalCommissionShare: 'ORIGINAL_COMMISSION_SHARE',
+};
+exports.MARKETPLACE_RELATIONSHIP_TYPES = {
+    // Mirror of MERCHANT_RELATIONSHIP_TYPES.marketplaceSeller in
+    // merchant-constants.js. Re-exported here to keep marketplace semantics
+    // self-contained for callers that import marketplace-* only.
+    marketplaceSeller: 'MARKETPLACE_SELLER',
+};
+// Categorizes which fee bucket a `FeeAllocationPolicy` is distributing across
+// marketplace line items. Stored on snapshots as part of fee provenance.
+exports.MARKETPLACE_FEE_TYPES = {
+    stripe: 'STRIPE',
+    ribbn: 'RIBBN',
+    marketplace: 'MARKETPLACE',
+};
+// Identifies which strategy `FeeAllocationPolicyRegistry` should hand back
+// when allocating a basket-level fee across marketplace line items.
+exports.MARKETPLACE_FEE_ALLOCATION_BASES = {
+    evenPerSeller: 'EVEN_PER_SELLER',
+    proportionalToLineNet: 'PROPORTIONAL_TO_LINE_NET',
+};
+// Lifecycle of a marketplace ledger entry that backs payouts/refunds for a
+// single parent order line item.
+exports.MARKETPLACE_LEDGER_STATUSES = {
+    pendingReturnPeriod: 'PENDING_RETURN_PERIOD',
+    payable: 'PAYABLE',
+    paidOut: 'PAID_OUT',
+    returnedBeforePayout: 'RETURNED_BEFORE_PAYOUT',
+    refundedAfterPayout: 'REFUNDED_AFTER_PAYOUT',
+    transferReversed: 'TRANSFER_REVERSED',
+};
+// Inventory tracking modes that the InventoryPolicy registry uses to decide
+// how to decrement/restore stock for a given product. The constant gives
+// callers a stable way to refer to a policy by kind even though dispatch is
+// by `canHandle(product)` rather than by name.
+exports.MARKETPLACE_INVENTORY_POLICY_KINDS = {
+    multivariantLocation: 'MULTIVARIANT_LOCATION',
+    oneOfAKind: 'ONE_OF_A_KIND',
+    untrackedStock: 'UNTRACKED_STOCK',
+};
+// Stock status sentinels that drive inventory behavior across the ORM,
+// backend, and web-app. `inStockUnlimited` flags products (e.g. cafe items,
+// services) that must skip per-location quantity decrements at sale time
+// and skip restoration on refund.
+exports.STOCK_STATUSES = {
+    inStockUnlimited: 'IN_STOCK_UNLIMITED',
+};
+// Default `reRobeCommission` for a managed marketplace seller's own product
+// document. Marketplace commission is layered separately at sale time via
+// the relationship's `marketplaceCommission`.
+exports.MARKETPLACE_SELLER_DEFAULT_COMMISSION = '1';
+exports.DEFAULT_MARKETPLACE_LISTING_STATUS = exports.MARKETPLACE_LISTING_STATUSES.active;
+exports.DEFAULT_MARKETPLACE_COMMISSION_BASIS = exports.MARKETPLACE_COMMISSION_BASES.lineNetExcludingTax;
+exports.DEFAULT_MARKETPLACE_RELATIONSHIP_TYPE = exports.MARKETPLACE_RELATIONSHIP_TYPES.marketplaceSeller;
+exports.DEFAULT_STRIPE_FEE_ALLOCATION_BASIS = exports.MARKETPLACE_FEE_ALLOCATION_BASES.evenPerSeller;
+exports.DEFAULT_RIBBN_FEE_ALLOCATION_BASIS = exports.MARKETPLACE_FEE_ALLOCATION_BASES.proportionalToLineNet;
+exports.DEFAULT_MARKETPLACE_LEDGER_STATUS = exports.MARKETPLACE_LEDGER_STATUSES.pendingReturnPeriod;

package/lib/constants/merchant-constants.d.ts

@@ -75,6 +75,41 @@ export namespace UNIT_SYSTEM_TYPES {
     let metric: string;
     let imperial: string;
 }
+export namespace LABEL_PRINTER_BARCODE_SYMBOLOGIES {
+    let code128: string;
+    let ean13: string;
+}
+export namespace LABEL_PRINTER_PROTOCOLS {
+    let zebraZpl: string;
+}
+export namespace DEFAULT_LABEL_LAYOUT {
+    let topElements: {
+        source: string;
+        visible: boolean;
+        fontSize: number;
+        paddingTop: number;
+        transform: string;
+    }[];
+    namespace barcode {
+        let visible: boolean;
+        let heightDots: number;
+        let moduleWidth: number;
+        let paddingBottom: number;
+    }
+    namespace sku {
+        let visible_1: boolean;
+        export { visible_1 as visible };
+        export let fontSize: number;
+    }
+}
+export namespace LABEL_PRINTER_CONFIG_DEFAULTS {
+    export let protocol: string;
+    export let widthMm: number;
+    export let heightMm: number;
+    export let dpi: number;
+    export let symbology: string;
+    export { DEFAULT_LABEL_LAYOUT as layout };
+}
 export namespace METRIC_WEIGHT_TYPES {
     let kilogram: string;
     let gram: string;

package/lib/constants/merchant-constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.AUTOMATED_PAYOUT_MONTH_DAYS = exports.AUTOMATED_PAYOUT_BUSINESS_DAYS = exports.AUTOMATED_PAYOUT_SCHEDULE = exports.SUBSCRIPTION_STATUSES = exports.RIBBN_WEBHOOK_EVENT_DICT = exports.IMPERIAL_WEIGHT_TYPES = exports.METRIC_WEIGHT_TYPES = exports.UNIT_SYSTEM_TYPES = exports.INDUSTRY_TYPE_OPTIONS = exports.INDUSTRY_TYPES = exports.PAYMENT_TIERS = exports.DEFAULT_MARKETPLACE_SELLER_CAPABILITIES = exports.MARKETPLACE_SELLER_CAPABILITIES = exports.MERCHANT_RELATIONSHIP_TYPES = exports.MERCHANT_ACCOUNT_CLASSES = exports.MERCHANT_ACCOUNT_MODES = exports.MERCHANT_TYPES = void 0;
+exports.AUTOMATED_PAYOUT_MONTH_DAYS = exports.AUTOMATED_PAYOUT_BUSINESS_DAYS = exports.AUTOMATED_PAYOUT_SCHEDULE = exports.SUBSCRIPTION_STATUSES = exports.RIBBN_WEBHOOK_EVENT_DICT = exports.IMPERIAL_WEIGHT_TYPES = exports.METRIC_WEIGHT_TYPES = exports.LABEL_PRINTER_CONFIG_DEFAULTS = exports.DEFAULT_LABEL_LAYOUT = exports.LABEL_PRINTER_PROTOCOLS = exports.LABEL_PRINTER_BARCODE_SYMBOLOGIES = exports.UNIT_SYSTEM_TYPES = exports.INDUSTRY_TYPE_OPTIONS = exports.INDUSTRY_TYPES = exports.PAYMENT_TIERS = exports.DEFAULT_MARKETPLACE_SELLER_CAPABILITIES = exports.MARKETPLACE_SELLER_CAPABILITIES = exports.MERCHANT_RELATIONSHIP_TYPES = exports.MERCHANT_ACCOUNT_CLASSES = exports.MERCHANT_ACCOUNT_MODES = exports.MERCHANT_TYPES = void 0;
 exports.MERCHANT_TYPES = {
     individual: 'INDIVIDUAL',
     business: 'BUSINESS',
@@ -83,6 +83,40 @@ exports.UNIT_SYSTEM_TYPES = {
     metric: 'METRIC',
     imperial: 'IMPERIAL',
 };
+// Label printer config controls how price-tag labels are rendered for both
+// the marketplace merchant (channel partner) and any merchants they manage.
+// Source of truth lives on the parent merchant doc; managed merchants read
+// it via the `getMarketplaceParentLabelConfig` API. Connection to the
+// physical printer is per-browser/per-device (WebUSB), not stored here.
+exports.LABEL_PRINTER_BARCODE_SYMBOLOGIES = {
+    code128: 'CODE128',
+    ean13: 'EAN13',
+};
+exports.LABEL_PRINTER_PROTOCOLS = {
+    // ZPL is what the Zebra ZD421 family speaks. Future-proofed for additional
+    // protocols (e.g. Epson ePOS-Print) via the same setting shape.
+    zebraZpl: 'ZEBRA_ZPL',
+};
+// Sensible defaults sized for a standard 50x30 mm clothing price tag on a
+// 203 dpi Zebra ZD421. Stored as plain numbers/strings so they survive
+// Firestore round-trips without conversion.
+exports.DEFAULT_LABEL_LAYOUT = {
+    topElements: [
+        { source: 'merchantName', visible: true, fontSize: 20, paddingTop: 0, transform: 'uppercase' },
+        { source: 'title', visible: true, fontSize: 18, paddingTop: 4, transform: 'none' },
+        { source: 'price', visible: true, fontSize: 30, paddingTop: 8, transform: 'none' },
+    ],
+    barcode: { visible: true, heightDots: 32, moduleWidth: 1, paddingBottom: 8 },
+    sku: { visible: true, fontSize: 14 },
+};
+exports.LABEL_PRINTER_CONFIG_DEFAULTS = {
+    protocol: 'ZEBRA_ZPL',
+    widthMm: 30,
+    heightMm: 20,
+    dpi: 203,
+    symbology: 'CODE128',
+    layout: exports.DEFAULT_LABEL_LAYOUT,
+};
 exports.METRIC_WEIGHT_TYPES = {
     kilogram: 'KILOGRAM',
     gram: 'GRAM',

package/lib/constants/product-constants.d.ts

@@ -1,4 +1,9 @@
 export function getDefaultTaxCategory(isConsignment: any, countryCode: any): any;
+export function getProductStateLabel(value: any): any;
+export function getRetailEditableProductStateOptions(): {
+    value: string;
+    label: any;
+}[];
 export namespace SELLER_DRIVEN_STATES {
     let sellerDonated: string;
     let sellRequestReview: string;
@@ -122,6 +127,7 @@ export namespace ADMIN_SIMPLIFIED_STATES {
     let listed_2: string;
     export { listed_2 as listed };
 }
+export const RETAIL_EDITABLE_PRODUCT_STATES: string[];
 export namespace PRODUCT_STATE_LABELS {
     let archived_2: string;
     export { archived_2 as archived };

package/lib/constants/product-constants.js

@@ -1,7 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.PRODUCT_CLASS_VALUES = exports.CONSIGNMENT_TAX_DEFAULTS = exports.TAX_CATEGORIES = exports.ADMIN_STATES = exports.PAYOUT_SYSTEM = exports.PAYOUT_METHOD = exports.PUBLISH_TYPE = exports.MEASUREMENT_FIELDS_DICT = exports.MEASUREMENT_CATEGORY = exports.PRODUCT_STATE_LABELS_ADMIN_VIEW = exports.PRODUCT_STATE_LABELS = exports.ADMIN_SIMPLIFIED_STATES = exports.PRODUCT_STATES = exports.SYSTEM_DRIVEN_STATES = exports.ADMIN_ACTION_DRIVEN_STATES = exports.ADMIN_DRIVEN_STATES = exports.SELLER_DRIVEN_STATES = void 0;
+exports.PRODUCT_CLASS_VALUES = exports.CONSIGNMENT_TAX_DEFAULTS = exports.TAX_CATEGORIES = exports.ADMIN_STATES = exports.PAYOUT_SYSTEM = exports.PAYOUT_METHOD = exports.PUBLISH_TYPE = exports.MEASUREMENT_FIELDS_DICT = exports.MEASUREMENT_CATEGORY = exports.PRODUCT_STATE_LABELS_ADMIN_VIEW = exports.PRODUCT_STATE_LABELS = exports.RETAIL_EDITABLE_PRODUCT_STATES = exports.ADMIN_SIMPLIFIED_STATES = exports.PRODUCT_STATES = exports.SYSTEM_DRIVEN_STATES = exports.ADMIN_ACTION_DRIVEN_STATES = exports.ADMIN_DRIVEN_STATES = exports.SELLER_DRIVEN_STATES = void 0;
 exports.getDefaultTaxCategory = getDefaultTaxCategory;
+exports.getProductStateLabel = getProductStateLabel;
+exports.getRetailEditableProductStateOptions = getRetailEditableProductStateOptions;
 exports.SELLER_DRIVEN_STATES = {
     sellerDonated: 'SELLER_DONATED',
     sellRequestReview: 'SELL_REQUEST_REVIEW',
@@ -87,6 +89,21 @@ exports.ADMIN_SIMPLIFIED_STATES = {
     pendingPublication: 'PENDING_PUBLICATION',
     listed: 'LISTED',
 };
+// Hand-picked subset of PRODUCT_STATES that retail merchants can pick
+// from inside the products-v2 stock-management section. Excludes
+// states only the consignment / sell-request flows write (e.g.
+// SELL_REQUEST_REVIEW, ACCEPTED, REJECTED, SOLD, RESERVED) and
+// states owned by backend triggers (e.g. SOLD_SELLER_PAID,
+// LIQUIDATION_REQUESTED). Order is the order surfaced in the UI.
+exports.RETAIL_EDITABLE_PRODUCT_STATES = [
+    exports.PRODUCT_STATES.draft,
+    exports.PRODUCT_STATES.qualityControl,
+    exports.PRODUCT_STATES.pendingPublication,
+    exports.PRODUCT_STATES.listed,
+    exports.PRODUCT_STATES.availableInStore,
+    exports.PRODUCT_STATES.hold,
+    exports.PRODUCT_STATES.archived,
+];
 exports.PRODUCT_STATE_LABELS = {
     archived: 'Archived',
     sellRequestReview: 'Waiting for approval',
@@ -260,3 +277,28 @@ exports.PRODUCT_CLASS_VALUES = {
     SUPPLY: 'SUPPLY',
     DIGITAL: 'DIGITAL',
 };
+// Reverse lookup table built from PRODUCT_STATES so callers can resolve
+// the merchant-facing label from a stored value (e.g. 'LISTED' →
+// 'Published for sale') without iterating PRODUCT_STATES at every call
+// site. Falls back to the raw value if no label is registered.
+const VALUE_TO_LABEL_KEY = Object.entries(exports.PRODUCT_STATES).reduce((acc, [labelKey, value]) => {
+    acc[value] = labelKey;
+    return acc;
+}, {});
+function getProductStateLabel(value) {
+    if (!value)
+        return '';
+    const labelKey = VALUE_TO_LABEL_KEY[String(value)];
+    if (labelKey && exports.PRODUCT_STATE_LABELS[labelKey])
+        return exports.PRODUCT_STATE_LABELS[labelKey];
+    return String(value);
+}
+// Build the option list (value + merchant-facing label) the retail
+// stock-management section should expose. Order matches the order
+// surfaced in the UI; values are the canonical PRODUCT_STATES.
+function getRetailEditableProductStateOptions() {
+    return exports.RETAIL_EDITABLE_PRODUCT_STATES.map((value) => ({
+        value,
+        label: getProductStateLabel(value),
+    }));
+}

package/lib/constants/tax-constants.d.ts

@@ -0,0 +1,19 @@
+export declare const TAX_CATEGORY_RATES: {
+    [countryCode: string]: {
+        [category: string]: number;
+    };
+};
+export declare const TAX_CATEGORIES: {
+    readonly STANDARD: "STANDARD";
+    readonly FOOD: "FOOD";
+    readonly CULTURE: "CULTURE";
+    readonly EXEMPT: "EXEMPT";
+};
+export type TaxCategoryValue = typeof TAX_CATEGORIES[keyof typeof TAX_CATEGORIES];
+export declare const TAX_CATEGORY_BASE_LABELS: {
+    [category: string]: string;
+};
+export declare const TAX_CATEGORY_ALIASES: {
+    [alias: string]: TaxCategoryValue;
+};
+export declare const FALLBACK_TAX_COUNTRY_CODE = "SE";

package/lib/constants/tax-constants.js

@@ -0,0 +1,70 @@
+"use strict";
+// Tax rate tables and category constants used by product creation/editing
+// flows and by every storefront/POS surface that needs to convert between
+// the canonical net (tax-exclusive) storage value and the displayable
+// gross (tax-inclusive) value.
+//
+// Mirrors the ribbn-web-app `lib/utilities/tax.ts` shim that originated
+// these values during the Retail Product Forms work, lifted into ORM so
+// backend, mobile, and web all consume the same tables.
+//
+// Rates are conservative typical-2025 values for the most common
+// categories per country. EXEMPT is always 0. Extend the map below for
+// more precision (regional VAT, split rates, etc.).
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.FALLBACK_TAX_COUNTRY_CODE = exports.TAX_CATEGORY_ALIASES = exports.TAX_CATEGORY_BASE_LABELS = exports.TAX_CATEGORIES = exports.TAX_CATEGORY_RATES = void 0;
+exports.TAX_CATEGORY_RATES = {
+    SE: { STANDARD: 0.25, FOOD: 0.12, CULTURE: 0.06, EXEMPT: 0 },
+    NO: { STANDARD: 0.25, FOOD: 0.15, CULTURE: 0.12, EXEMPT: 0 },
+    DK: { STANDARD: 0.25, FOOD: 0.25, CULTURE: 0.25, EXEMPT: 0 },
+    FI: { STANDARD: 0.24, FOOD: 0.14, CULTURE: 0.1, EXEMPT: 0 },
+    DE: { STANDARD: 0.19, FOOD: 0.07, CULTURE: 0.07, EXEMPT: 0 },
+    GB: { STANDARD: 0.2, FOOD: 0, CULTURE: 0, EXEMPT: 0 },
+    FR: { STANDARD: 0.2, FOOD: 0.055, CULTURE: 0.055, EXEMPT: 0 },
+    IT: { STANDARD: 0.22, FOOD: 0.1, CULTURE: 0.04, EXEMPT: 0 },
+    ES: { STANDARD: 0.21, FOOD: 0.1, CULTURE: 0.04, EXEMPT: 0 },
+    NL: { STANDARD: 0.21, FOOD: 0.09, CULTURE: 0.09, EXEMPT: 0 },
+    BE: { STANDARD: 0.21, FOOD: 0.06, CULTURE: 0.06, EXEMPT: 0 },
+    PL: { STANDARD: 0.23, FOOD: 0.05, CULTURE: 0.08, EXEMPT: 0 },
+    CZ: { STANDARD: 0.21, FOOD: 0.12, CULTURE: 0.12, EXEMPT: 0 },
+    PT: { STANDARD: 0.23, FOOD: 0.06, CULTURE: 0.06, EXEMPT: 0 },
+    IE: { STANDARD: 0.23, FOOD: 0, CULTURE: 0.09, EXEMPT: 0 },
+    US: { STANDARD: 0.07, FOOD: 0, CULTURE: 0, EXEMPT: 0 },
+};
+exports.TAX_CATEGORIES = {
+    STANDARD: 'STANDARD',
+    FOOD: 'FOOD',
+    CULTURE: 'CULTURE',
+    EXEMPT: 'EXEMPT',
+};
+exports.TAX_CATEGORY_BASE_LABELS = {
+    STANDARD: 'Standard',
+    FOOD: 'Food & Beverages',
+    CULTURE: 'Books & Culture',
+    EXEMPT: 'Exempt',
+};
+// Aliases the normalizer accepts and maps to a canonical TAX_CATEGORIES
+// value. Keeping these explicit (rather than only doing toUpperCase)
+// preserves backwards compat with documents that stored the human label
+// (e.g. "Books & Culture") in the `taxCategory` field.
+exports.TAX_CATEGORY_ALIASES = {
+    STANDARD: exports.TAX_CATEGORIES.STANDARD,
+    Standard: exports.TAX_CATEGORIES.STANDARD,
+    'Standard rate': exports.TAX_CATEGORIES.STANDARD,
+    standard: exports.TAX_CATEGORIES.STANDARD,
+    FOOD: exports.TAX_CATEGORIES.FOOD,
+    Food: exports.TAX_CATEGORIES.FOOD,
+    'Food & Beverages': exports.TAX_CATEGORIES.FOOD,
+    'Food and Beverages': exports.TAX_CATEGORIES.FOOD,
+    'food & beverages': exports.TAX_CATEGORIES.FOOD,
+    CULTURE: exports.TAX_CATEGORIES.CULTURE,
+    Culture: exports.TAX_CATEGORIES.CULTURE,
+    'Books & Culture': exports.TAX_CATEGORIES.CULTURE,
+    'Books and Culture': exports.TAX_CATEGORIES.CULTURE,
+    'books & culture': exports.TAX_CATEGORIES.CULTURE,
+    EXEMPT: exports.TAX_CATEGORIES.EXEMPT,
+    Exempt: exports.TAX_CATEGORIES.EXEMPT,
+    'Tax exempt': exports.TAX_CATEGORIES.EXEMPT,
+    'tax exempt': exports.TAX_CATEGORIES.EXEMPT,
+};
+exports.FALLBACK_TAX_COUNTRY_CODE = 'SE';

package/lib/factories/Product/RetailProductFactory.d.ts

@@ -0,0 +1,102 @@
+import Product from '../../models/Product';
+export interface RetailOwnershipInput {
+    sellerMerchantId: string;
+    sellerMerchantName?: string;
+    isMarketplaceSeller?: boolean;
+}
+export interface RetailAccountingInput {
+    price: string;
+    taxCategory?: string | null;
+    isTaxable?: 'yes' | 'no';
+    costPerItem?: string;
+    compareAtPrice?: string;
+    reRobeCommission?: string;
+}
+export interface RetailLocationInput {
+    locationId?: string;
+    locationName?: string;
+}
+export interface ClothingDetailsInput {
+    brand?: string;
+    gender?: string;
+    productCategory?: string;
+    productType?: string;
+    color?: string;
+    size?: string;
+    productStyle?: string[];
+    materialComposition?: {
+        [k: string]: string;
+    } | string;
+    measurementCategory?: string;
+    standardSize?: string;
+    internationalSize?: string;
+    condition?: string;
+    conditionRemarks?: string;
+    productRemarks?: string;
+    careInstructions?: string;
+    description?: string;
+}
+export interface NonClothingDetailsInput {
+    brand?: string;
+    productCategory?: string;
+    description?: string;
+}
+interface BaseRetailInput {
+    ownership: RetailOwnershipInput;
+    accounting: RetailAccountingInput;
+    location?: RetailLocationInput;
+    sku?: string;
+    title: string;
+    imageUrls?: string[];
+    coverPhotoUrl?: string;
+    tags?: string[];
+}
+export interface OneOfAKindClothingInput extends BaseRetailInput {
+    details?: ClothingDetailsInput;
+}
+export interface MultivariantClothingInput extends BaseRetailInput {
+    details?: ClothingDetailsInput;
+    variantInventory: any[];
+}
+export interface TrackedRetailInput extends BaseRetailInput {
+    details?: NonClothingDetailsInput;
+    quantity: number;
+    variantTaxable?: 'yes' | 'no';
+}
+export interface UntrackedRetailInput extends BaseRetailInput {
+    details?: NonClothingDetailsInput;
+}
+interface ResolvedAccounting {
+    price: string;
+    taxCategory: string;
+    isTaxable: 'yes' | 'no';
+    costPerItem: string;
+    compareAtPrice: string;
+    reRobeCommission?: string;
+}
+interface ResolvedDefaults {
+    status: string;
+    availableForSale: boolean;
+}
+export default class RetailProductFactory {
+    static fromOneOfAKindClothing(input: OneOfAKindClothingInput): Product;
+    static fromMultivariantClothing(input: MultivariantClothingInput): Product;
+    static fromTrackedRetail(input: TrackedRetailInput): Product;
+    static fromUntrackedRetail(input: UntrackedRetailInput): Product;
+    static resolveOwnership(ownership: RetailOwnershipInput): {
+        merchantId: string;
+        vendorId: string;
+        merchants: string[];
+        vendorName: string;
+    };
+    static resolveDefaults(ownership: RetailOwnershipInput): ResolvedDefaults;
+    static resolveAccounting(accounting: RetailAccountingInput, ownership: RetailOwnershipInput): ResolvedAccounting;
+    private static buildBaseAttributes;
+    private static normalizeClothingDetails;
+    private static normalizeNonClothingDetails;
+    private static buildInventoryLocationsForFixedQuantity;
+    private static coerceNonNegativeQuantity;
+    private static aggregateQuantityFromVariantInventory;
+    private static aggregateLocationsFromVariantInventory;
+}
+export {};