rerobe-js-orm 2.4.85 → 2.4.86

package/lib/helpers/Utilities.d.ts

@@ -7,6 +7,11 @@ export default class Utilities {
     getWeekNumberFromDate(dateString: string): string;
     capitalizeString(s: string): string;
     startCase(s: string): string;
+    camelCase(s: string): string;
     constantCase(str: string): any;
     makeRandId(length: number): string;
+    sanitizeString(v: any): string;
+    sanitzeStringArr(v: any): string[];
+    sanitizeNumber(v: any, to?: number): number;
+    sanitizeMillisTimeStamp(t: any): number;
 }

package/lib/helpers/Utilities.js

@@ -47,6 +47,9 @@ class Utilities {
     startCase(s) {
         return lodash_1.startCase(s);
     }
+    camelCase(s) {
+        return lodash_1.camelCase(s);
+    }
     constantCase(str) {
         return lodash_1.snakeCase(str).toUpperCase();
     }
@@ -60,5 +63,26 @@ class Utilities {
         }
         return result;
     }
+    sanitizeString(v) {
+        if (v && (typeof v === 'string' || typeof v === 'number')) {
+            return String(v);
+        }
+        return '';
+    }
+    sanitzeStringArr(v) {
+        if (v && Array.isArray(v)) {
+            return v.filter((e) => e).map((e) => String(e));
+        }
+        return [];
+    }
+    sanitizeNumber(v, to = 1) {
+        return Number.isNaN(parseFloat(String(v))) ? Number(to) : parseFloat(String(v));
+    }
+    sanitizeMillisTimeStamp(t) {
+        if (t && typeof t === 'number') {
+            return t;
+        }
+        return 0;
+    }
 }
 exports.default = Utilities;

package/lib/models/Product.d.ts

@@ -10,11 +10,29 @@ export default class Product extends Base {
     toObj(): CompleteProduct;
     toProductInputObjForShopify(location?: string): any;
     toObjForTextTranslation(): TranslatableAttributes;
+    toObjForTypesense(): TypesenseProductObj;
     updateSelfFromTranslatedTextArray(translatedTextArray?: string[]): void;
     autoCreateTitle(): string;
     autoCreateDescriptionHTML(): string;
+    generateSchemaForTypesense(name?: string): {
+        default_sorting_field: string;
+        fields: ({
+            facet: boolean;
+            name: string;
+            type: string;
+            optional?: undefined;
+        } | {
+            facet: boolean;
+            optional: boolean;
+            name: string;
+            type: string;
+        })[];
+        name: string;
+    };
     private materialCompTagsArrayForShopify;
     private materialCompJoinedString;
     private measurementsJoinedString;
     private convertMaterialCompJoinedStrToObj;
+    private sanitizeMaterialComp;
+    private sanitizeCommission;
 }

package/lib/models/Product.js

@@ -117,7 +117,7 @@ class Product extends Base_1.default {
     }
     toPartialObj() {
         return Object.assign(Object.assign({}, this.attributes), this.filterAttributes);
-    }
+    } // ToDo: Deprecate soon
     toObj() {
         return Object.assign(Object.assign(Object.assign(Object.assign({}, this.attributes), this.filterAttributes), this.consignmentAttributes), this.timestampAttributes);
     }
@@ -228,6 +228,83 @@ class Product extends Base_1.default {
             condition: this.filterAttributes.condition || this.FIELD_NOT_TRANSLATABLE_KEY,
         };
     }
+    toObjForTypesense() {
+        const stagedObj = {
+            brand: this.utilities.sanitizeString(this.filterAttributes.brand),
+            clothingSize: this.utilities.sanitzeStringArr(this.filterAttributes.clothingSize),
+            jeanSize: this.utilities.sanitizeString(this.filterAttributes.jeanSize),
+            shoeSize: this.utilities.sanitizeString(this.filterAttributes.shoeSize),
+            condition: this.utilities.sanitizeString(this.filterAttributes.condition),
+            featuredCollections: this.utilities.sanitzeStringArr(this.filterAttributes.featuredCollections),
+            isOnSale: this.utilities.sanitizeString(this.consignmentAttributes.isOnSale),
+            merchants: this.utilities.sanitzeStringArr(this.attributes.merchants),
+            price: this.utilities.sanitizeNumber(this.attributes.price),
+            suggestedResalePrice: this.utilities.sanitizeNumber(this.consignmentAttributes.suggestedResalePrice),
+            salePrice: this.utilities.sanitizeNumber(this.consignmentAttributes.salePrice),
+            compareAtPrice: this.utilities.sanitizeNumber(this.attributes.compareAtPrice),
+            costPerItem: this.utilities.sanitizeNumber(this.attributes.costPerItem),
+            priceRange: this.utilities.sanitizeString(this.filterAttributes.priceRange),
+            productCategory: this.utilities.sanitizeString(this.filterAttributes.productCategory),
+            productType: this.utilities.sanitizeString(this.filterAttributes.productType),
+            productStyle: this.utilities.sanitzeStringArr(this.filterAttributes.productStyle),
+            reRobeCommission: this.sanitizeCommission(),
+            rfidTag: this.utilities.sanitizeString(this.attributes.rfidTag),
+            salesChannel: this.utilities.sanitzeStringArr(this.consignmentAttributes.salesChannel),
+            status: this.utilities.sanitizeString(this.consignmentAttributes.status),
+            tags: this.utilities.sanitzeStringArr(this.filterAttributes.tags),
+            title: this.utilities.sanitizeString(this.attributes.title),
+            vendorName: this.utilities.sanitizeString(this.attributes.vendorName),
+            createdAtTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.createdAtTimestamp),
+            updatedAtTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.updatedAtTimestamp),
+            sellRequestReviewTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellRequestReviewTimestamp),
+            sellRequestReviewDraftTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellRequestReviewDraftTimestamp),
+            rejectedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.rejectedTimestamp),
+            holdTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.holdTimestamp),
+            acceptedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.acceptedTimestamp),
+            sellerToDropOffTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellerToDropOffTimestamp),
+            sellerToShipTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellerToShipTimestamp),
+            sellerToGetPickUpTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellerToGetPickUpTimestamp),
+            qualityControlTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.qualityControlTimestamp),
+            pendingPublicationTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.pendingPublicationTimestamp),
+            listedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.listedTimestamp),
+            clearanceTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.clearanceTimestamp),
+            reservedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.reservedTimestamp),
+            soldTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.soldTimestamp),
+            returnedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.returnedTimestamp),
+            soldSellerToBePaidTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.soldSellerToBePaidTimestamp),
+            soldSellerPaidTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.soldSellerPaidTimestamp),
+            sellerSelfRejectTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellerSelfRejectTimestamp),
+            liquidationRequestedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.liquidationRequestedTimestamp),
+            sellerLiquidatedTimestamp: this.utilities.sanitizeMillisTimeStamp(this.timestampAttributes.sellerLiquidatedTimestamp),
+            availableForSale: !!this.attributes.availableForSale,
+            color: this.utilities.sanitizeString(this.filterAttributes.color),
+            description: this.utilities.sanitizeString(this.attributes.description),
+            discountType: this.utilities.sanitizeString(this.consignmentAttributes.discountType),
+            discountValue: this.utilities.sanitizeNumber(this.consignmentAttributes.discountValue, 0),
+            id: this.utilities.sanitizeString(this.filterAttributes.documentId),
+            gender: this.utilities.sanitizeString(this.filterAttributes.gender),
+            handle: this.utilities.sanitizeString(this.attributes.handle),
+            imageUrls: this.utilities.sanitzeStringArr(this.attributes.imageUrls),
+            sellRequestImageUrls: this.utilities.sanitzeStringArr(this.consignmentAttributes.sellRequestImageUrls),
+            reservedBy: this.utilities.sanitzeStringArr(this.attributes.reservedBy),
+            'materialComposition.names': Object.keys(this.sanitizeMaterialComp()),
+            'inventoryLocations.ids': this.consignmentAttributes.inventoryLocations && Array.isArray(this.consignmentAttributes.inventoryLocations)
+                ? this.consignmentAttributes.inventoryLocations.map((c) => String(c.id))
+                : [],
+        };
+        this.consignmentAttributes.inventoryLocations.forEach((l) => {
+            if (l.id) {
+                stagedObj[`inventoryLocations.${l.id}.availableAmount`] = l.availableAmount || 0;
+                stagedObj[`inventoryLocations.${l.id}.incomingAmount`] = l.incomingAmount || 0;
+            }
+        });
+        Object.values(this.sanitizeMaterialComp()).forEach((v, i) => {
+            if (v) {
+                stagedObj[`materialComposition.${Object.keys(this.sanitizeMaterialComp())[i]}.value`] = v;
+            }
+        });
+        return stagedObj;
+    }
     updateSelfFromTranslatedTextArray(translatedTextArray = []) {
         const checkFieldTranslated = (val) => {
             return val !== this.FIELD_NOT_TRANSLATABLE_KEY;
@@ -326,6 +403,261 @@ class Product extends Base_1.default {
             return acc;
         }, '');
     }
+    generateSchemaForTypesense(name = 'prod_products_202101061') {
+        return {
+            default_sorting_field: 'createdAtTimestamp',
+            fields: [
+                {
+                    facet: true,
+                    name: 'brand',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'clothingSize',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    name: 'jeanSize',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'shoeSize',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'condition',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'featuredCollections',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'isOnSale',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: false,
+                    name: 'merchants',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    name: 'price',
+                    type: 'float',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'suggestedResalePrice',
+                    type: 'float',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'salePrice',
+                    type: 'float',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'compareAtPrice',
+                    type: 'float',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'costPerItem',
+                    type: 'float',
+                },
+                {
+                    facet: true,
+                    name: 'priceRange',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'productCategory',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'productType',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'productStyle',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    name: 'reRobeCommission',
+                    type: 'float',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'rfidTag',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'salesChannel',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    name: 'status',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'tags',
+                    type: 'string[]',
+                },
+                {
+                    facet: false,
+                    name: 'title',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'vendorName',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: '.*Timestamp',
+                    type: 'int32',
+                },
+                {
+                    facet: false,
+                    name: 'createdAtTimestamp',
+                    type: 'int32',
+                },
+                {
+                    facet: false,
+                    name: 'updatedAtTimestamp',
+                    type: 'int32',
+                },
+                {
+                    facet: false,
+                    name: 'availableForSale',
+                    type: 'bool',
+                },
+                {
+                    facet: true,
+                    name: 'color',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    name: 'description',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'discountType',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'discountValue',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    name: 'id',
+                    type: 'string',
+                },
+                {
+                    facet: true,
+                    name: 'gender',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'handle',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    name: 'imageUrls',
+                    type: 'string[]',
+                },
+                {
+                    facet: false,
+                    name: 'sellRequestImageUrls',
+                    type: 'string[]',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'notesForProductionTeam',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'nextAvailableSeason',
+                    type: 'string',
+                },
+                {
+                    facet: false,
+                    optional: true,
+                    name: 'reservedBy',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'inventoryLocations.ids',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'inventoryLocations..*.availableAmount',
+                    type: 'int32',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'inventoryLocations..*.incomingAmount',
+                    type: 'int32',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'materialComposition.names',
+                    type: 'string[]',
+                },
+                {
+                    facet: true,
+                    optional: true,
+                    name: 'materialComposition..*.value',
+                    type: 'int32',
+                },
+            ],
+            name,
+        };
+    }
     materialCompTagsArrayForShopify() {
         return Object.keys(this.filterAttributes.materialComposition).reduce((acc, cur, idx) => {
             acc.push(`${cur} ${Object.values(this.filterAttributes.materialComposition)[idx]}`);
@@ -367,5 +699,41 @@ class Product extends Base_1.default {
         }
         return materialObj;
     }
+    sanitizeMaterialComp() {
+        let materialComp = this.filterAttributes.materialComposition;
+        if (materialComp && Array.isArray(materialComp)) {
+            materialComp = materialComp.reduce((acc, cur) => {
+                const camelKey = this.utilities.camelCase(cur);
+                acc[camelKey] = 100;
+                return acc;
+            }, {});
+        }
+        if (typeof materialComp !== 'object') {
+            materialComp = {};
+        }
+        if (materialComp && Object.keys(materialComp).length > 0) {
+            const mcKeys = Object.keys(materialComp);
+            const mcValues = Object.values(materialComp);
+            materialComp = mcKeys.reduce((acc, curr, ind) => {
+                if (curr.charCodeAt(0) >= 65 && curr.charCodeAt(0) <= 90) {
+                    return acc;
+                }
+                const camelKey = this.utilities.camelCase(curr);
+                acc[camelKey] = Number(mcValues[ind]);
+                return acc;
+            }, {});
+        }
+        return materialComp;
+    }
+    sanitizeCommission() {
+        const com = this.consignmentAttributes.reRobeCommission;
+        if (Number.isNaN(parseFloat(String(com)))) {
+            return 0.5;
+        }
+        if (parseFloat(String(com)) <= 1) {
+            return parseFloat(String(com));
+        }
+        return parseFloat(String(com)) / 100;
+    }
 }
 exports.default = Product;

package/lib/types/rerobe-product-types.d.ts

@@ -231,3 +231,65 @@ declare type InventoryLocation = {
     incomingAmount: number;
     availableAmount: number;
 };
+declare type TypesenseProductObj = {
+    brand: string;
+    clothingSize: string[];
+    jeanSize: string;
+    shoeSize: string;
+    condition: string;
+    featuredCollections: string[];
+    isOnSale: string;
+    merchants: string[];
+    price: number;
+    suggestedResalePrice: number;
+    salePrice: number;
+    compareAtPrice: number;
+    costPerItem: number;
+    priceRange: string;
+    productCategory: string;
+    productType: string;
+    productStyle: string[];
+    reRobeCommission: number;
+    rfidTag: string;
+    salesChannel: string[];
+    status: string;
+    tags: string[];
+    title: string;
+    vendorName: string;
+    createdAtTimestamp: number;
+    updatedAtTimestamp: number;
+    sellRequestReviewTimestamp: number;
+    sellRequestReviewDraftTimestamp: number;
+    rejectedTimestamp: number;
+    holdTimestamp: number;
+    acceptedTimestamp: number;
+    sellerToDropOffTimestamp: number;
+    sellerToShipTimestamp: number;
+    sellerToGetPickUpTimestamp: number;
+    qualityControlTimestamp: number;
+    pendingPublicationTimestamp: number;
+    listedTimestamp: number;
+    clearanceTimestamp: number;
+    reservedTimestamp: number;
+    soldTimestamp: number;
+    returnedTimestamp: number;
+    soldSellerToBePaidTimestamp: number;
+    soldSellerPaidTimestamp: number;
+    sellerSelfRejectTimestamp: number;
+    liquidationRequestedTimestamp: number;
+    sellerLiquidatedTimestamp: number;
+    availableForSale: boolean;
+    color: string;
+    description: string;
+    discountType: string;
+    discountValue: number;
+    id: string;
+    gender: string;
+    handle: string;
+    imageUrls: string[];
+    sellRequestImageUrls: string[];
+    reservedBy: string[];
+    'inventoryLocations.ids': string[];
+    'materialComposition.names': string[];
+    [key: string]: any;
+};

package/package.json

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