rerobe-js-orm 4.8.7 → 4.8.8

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/models/Merchant.d.ts

@@ -1,4 +1,35 @@
 import Base from '../Base';
+export type LabelTextSource = 'merchantName' | 'title' | 'price';
+export type LabelTextElement = {
+    source: LabelTextSource | string;
+    visible: boolean;
+    fontSize: number;
+    paddingTop: number;
+    transform: 'uppercase' | 'none' | string;
+};
+export type LabelBarcodeConfig = {
+    visible: boolean;
+    heightDots: number;
+    moduleWidth: 1 | 2;
+    paddingBottom: number;
+};
+export type LabelSkuConfig = {
+    visible: boolean;
+    fontSize: number;
+};
+export type LabelLayout = {
+    topElements: LabelTextElement[];
+    barcode: LabelBarcodeConfig;
+    sku: LabelSkuConfig;
+};
+export type LabelPrinterConfig = {
+    protocol: string;
+    widthMm: number;
+    heightMm: number;
+    dpi: number;
+    symbology: string;
+    layout: LabelLayout;
+};
 export default class Merchant extends Base {
     static MERCHANT_TYPES: {
         individual: string;
@@ -46,6 +77,58 @@ export default class Merchant extends Base {
         upgradeToStandalone: string;
     };
     static DEFAULT_MARKETPLACE_SELLER_CAPABILITIES: string[];
+    static LABEL_PRINTER_BARCODE_SYMBOLOGIES: {
+        code128: string;
+        ean13: string;
+    };
+    static LABEL_PRINTER_PROTOCOLS: {
+        zebraZpl: string;
+    };
+    static LABEL_PRINTER_CONFIG_DEFAULTS: {
+        protocol: string;
+        widthMm: number;
+        heightMm: number;
+        dpi: number;
+        symbology: string;
+        layout: {
+            topElements: {
+                source: string;
+                visible: boolean;
+                fontSize: number;
+                paddingTop: number;
+                transform: string;
+            }[];
+            barcode: {
+                visible: boolean;
+                heightDots: number;
+                moduleWidth: number;
+                paddingBottom: number;
+            };
+            sku: {
+                visible: boolean;
+                fontSize: number;
+            };
+        };
+    };
+    static DEFAULT_LABEL_LAYOUT: {
+        topElements: {
+            source: string;
+            visible: boolean;
+            fontSize: number;
+            paddingTop: number;
+            transform: string;
+        }[];
+        barcode: {
+            visible: boolean;
+            heightDots: number;
+            moduleWidth: number;
+            paddingBottom: number;
+        };
+        sku: {
+            visible: boolean;
+            fontSize: number;
+        };
+    };
     static INDUSTRY_TYPES: {
         beauty: string;
         clothing: string;
@@ -112,6 +195,8 @@ export default class Merchant extends Base {
     hasAutomatedPayouts?: boolean;
     hasAIQuickList?: boolean;
     hasReceiptPrinter?: boolean;
+    hasLabelPrinter?: boolean;
+    labelPrinterConfig?: LabelPrinterConfig;
     hasActiveWebshop?: boolean;
     stripeSubscription?: StripeSubscription;
     subscriptionStatus?: string;
@@ -124,6 +209,7 @@ export default class Merchant extends Base {
     featureAccess?: MerchantFeatureAccess | null;
     isMarketplaceSeller?: boolean;
     constructor(props?: any);
+    static normalizeLabelPrinterConfig(input?: Partial<LabelPrinterConfig> | Record<string, any> | null): LabelPrinterConfig;
     toObj(): MerchantObj;
     toMerchantMutableData(): MerchantMutableData;
     isManagedMarketplaceMerchant(): boolean;

package/lib/models/Merchant.js

@@ -90,6 +90,82 @@ class Merchant extends Base_1.default {
         if (props === null || props === void 0 ? void 0 : props.hasReceiptPrinter) {
             this.hasReceiptPrinter = props.hasReceiptPrinter;
         }
+        if (props === null || props === void 0 ? void 0 : props.hasLabelPrinter) {
+            this.hasLabelPrinter = props.hasLabelPrinter;
+        }
+        if ((props === null || props === void 0 ? void 0 : props.labelPrinterConfig) && typeof props.labelPrinterConfig === 'object') {
+            this.labelPrinterConfig = Merchant.normalizeLabelPrinterConfig(props.labelPrinterConfig);
+        }
+    }
+    // Coerce arbitrary input into a fully-populated, type-safe LabelPrinterConfig
+    // by layering it over the defaults. Migrates legacy `showFields` shapes
+    // into the new `layout` schema so older stored configs keep working.
+    static normalizeLabelPrinterConfig(input) {
+        const defaults = Merchant.LABEL_PRINTER_CONFIG_DEFAULTS;
+        const raw = (input || {});
+        const protocol = typeof raw.protocol === 'string' && raw.protocol ? raw.protocol : defaults.protocol;
+        const symbology = typeof raw.symbology === 'string' && raw.symbology ? raw.symbology : defaults.symbology;
+        const layout = (() => {
+            const fallback = defaults.layout;
+            const rawLayout = raw.layout && typeof raw.layout === 'object' ? raw.layout : null;
+            const legacyShowFields = raw.showFields && typeof raw.showFields === 'object' ? raw.showFields : null;
+            if (!rawLayout && legacyShowFields) {
+                return {
+                    topElements: fallback.topElements.map((el) => (Object.assign(Object.assign({}, el), { visible: legacyShowFields[el.source] !== false }))),
+                    barcode: Object.assign({}, fallback.barcode),
+                    sku: Object.assign(Object.assign({}, fallback.sku), { visible: legacyShowFields.sku !== false }),
+                };
+            }
+            if (!rawLayout) {
+                return {
+                    topElements: fallback.topElements.map((el) => (Object.assign({}, el))),
+                    barcode: Object.assign({}, fallback.barcode),
+                    sku: Object.assign({}, fallback.sku),
+                };
+            }
+            const rawTop = Array.isArray(rawLayout.topElements) ? rawLayout.topElements : [];
+            const topElements = rawTop
+                .map((entry, index) => {
+                if (!entry || typeof entry !== 'object')
+                    return null;
+                const fb = fallback.topElements.find((e) => e.source === entry.source) ||
+                    fallback.topElements[index] ||
+                    fallback.topElements[0];
+                return {
+                    source: typeof entry.source === 'string' ? entry.source : fb.source,
+                    visible: typeof entry.visible === 'boolean' ? entry.visible : fb.visible,
+                    fontSize: Number(entry.fontSize) > 0 ? Number(entry.fontSize) : fb.fontSize,
+                    paddingTop: Number(entry.paddingTop) >= 0 ? Number(entry.paddingTop) : fb.paddingTop,
+                    transform: entry.transform === 'uppercase' || entry.transform === 'none' ? entry.transform : fb.transform,
+                };
+            })
+                .filter(Boolean);
+            const rawBarcode = (rawLayout.barcode || {});
+            const barcode = {
+                visible: typeof rawBarcode.visible === 'boolean' ? rawBarcode.visible : fallback.barcode.visible,
+                heightDots: Number(rawBarcode.heightDots) > 0 ? Number(rawBarcode.heightDots) : fallback.barcode.heightDots,
+                moduleWidth: rawBarcode.moduleWidth === 2 ? 2 : 1,
+                paddingBottom: Number(rawBarcode.paddingBottom) >= 0 ? Number(rawBarcode.paddingBottom) : fallback.barcode.paddingBottom,
+            };
+            const rawSku = (rawLayout.sku || {});
+            const sku = {
+                visible: typeof rawSku.visible === 'boolean' ? rawSku.visible : fallback.sku.visible,
+                fontSize: Number(rawSku.fontSize) > 0 ? Number(rawSku.fontSize) : fallback.sku.fontSize,
+            };
+            return {
+                topElements: topElements.length > 0 ? topElements : fallback.topElements.map((el) => (Object.assign({}, el))),
+                barcode,
+                sku,
+            };
+        })();
+        return {
+            protocol,
+            widthMm: Number(raw.widthMm) > 0 ? Number(raw.widthMm) : defaults.widthMm,
+            heightMm: Number(raw.heightMm) > 0 ? Number(raw.heightMm) : defaults.heightMm,
+            dpi: Number(raw.dpi) > 0 ? Number(raw.dpi) : defaults.dpi,
+            symbology,
+            layout,
+        };
     }
     toObj() {
         const mObj = {
@@ -166,6 +242,12 @@ class Merchant extends Base_1.default {
         if (this.hasReceiptPrinter) {
             mObj.hasReceiptPrinter = this.hasReceiptPrinter;
         }
+        if (this.hasLabelPrinter) {
+            mObj.hasLabelPrinter = this.hasLabelPrinter;
+        }
+        if (this.labelPrinterConfig) {
+            mObj.labelPrinterConfig = this.labelPrinterConfig;
+        }
         if (this.organizationNumbers && Object.keys(this.organizationNumbers).length > 0) {
             mObj.organizationNumbers = this.organizationNumbers;
         }
@@ -222,6 +304,10 @@ Merchant.MERCHANT_ACCOUNT_CLASSES = merchant_constants_1.MERCHANT_ACCOUNT_CLASSE
 Merchant.MERCHANT_RELATIONSHIP_TYPES = merchant_constants_1.MERCHANT_RELATIONSHIP_TYPES;
 Merchant.MARKETPLACE_SELLER_CAPABILITIES = merchant_constants_1.MARKETPLACE_SELLER_CAPABILITIES;
 Merchant.DEFAULT_MARKETPLACE_SELLER_CAPABILITIES = merchant_constants_1.DEFAULT_MARKETPLACE_SELLER_CAPABILITIES;
+Merchant.LABEL_PRINTER_BARCODE_SYMBOLOGIES = merchant_constants_1.LABEL_PRINTER_BARCODE_SYMBOLOGIES;
+Merchant.LABEL_PRINTER_PROTOCOLS = merchant_constants_1.LABEL_PRINTER_PROTOCOLS;
+Merchant.LABEL_PRINTER_CONFIG_DEFAULTS = merchant_constants_1.LABEL_PRINTER_CONFIG_DEFAULTS;
+Merchant.DEFAULT_LABEL_LAYOUT = merchant_constants_1.DEFAULT_LABEL_LAYOUT;
 Merchant.INDUSTRY_TYPES = merchant_constants_1.INDUSTRY_TYPES;
 Merchant.UNIT_SYSTEM_TYPES = merchant_constants_1.UNIT_SYSTEM_TYPES;
 Merchant.METRIC_WEIGHT_TYPES = merchant_constants_1.METRIC_WEIGHT_TYPES;

package/lib/models/Product.js

@@ -1072,6 +1072,17 @@ class Product extends Base_1.default {
                     name: 'sku',
                     type: 'string',
                 },
+                {
+                    // Flat array of every non-empty `variantInventory[].sku` so a
+                    // scanner / search bar can resolve a variant-level barcode to
+                    // the parent product. Maintained by the onWriteProduct trigger
+                    // (projection of variantInventory.sku → variantSkus). Empty
+                    // array for single-SKU products.
+                    facet: true,
+                    optional: true,
+                    name: 'variantSkus',
+                    type: 'string[]',
+                },
                 {
                     facet: true,
                     optional: true,

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

@@ -52,11 +52,39 @@ type MerchantSystemOnlyMutableData = {
     hasAutomatedPayouts?: boolean;
     hasAIQuickList?: boolean;
     hasReceiptPrinter?: boolean;
+    hasLabelPrinter?: boolean;
+    labelPrinterConfig?: LabelPrinterConfigData;
     hasActiveWebshop?: boolean;
     subscriptionStatus?: string;
     channelPartners?: string[];
     isMarketplaceSeller?: boolean;
 };
+type LabelPrinterConfigData = {
+    protocol: string;
+    widthMm: number;
+    heightMm: number;
+    dpi: number;
+    symbology: string;
+    layout: {
+        topElements: {
+            source: string;
+            visible: boolean;
+            fontSize: number;
+            paddingTop: number;
+            transform: string;
+        }[];
+        barcode: {
+            visible: boolean;
+            heightDots: number;
+            moduleWidth: 1 | 2;
+            paddingBottom: number;
+        };
+        sku: {
+            visible: boolean;
+            fontSize: number;
+        };
+    };
+};
 type MerchantObj = MerchantMutableData & MerchantSystemOnlyMutableData;
 type MerchantTypes = 'INDIVIDUAL' | 'BUSINESS';
 type MerchantAccountMode = 'STANDALONE' | 'MANAGED';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rerobe-js-orm",
-  "version": "4.8.7",
+  "version": "4.8.8",
   "description": "ReRobe's Javascript ORM Framework",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",