rerobe-js-orm 3.4.7 → 3.4.8

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

@@ -14,91 +14,143 @@ export namespace CUSTOMER_CREDIT_REASONS {
     const customerCompensation: string;
     const refund: string;
 }
-export const SellerProductLedgerStatusStatusDescriptionsActions: {
-    Pending: {
-        description: string;
-        action: string;
-    };
-    "To Pay": {
-        description: string;
-        action: string;
-    };
-    Paid: {
-        description: string;
-        action: string;
-    };
-    Disputed: {
-        description: string;
-        action: string;
-    };
-    Resolved: {
-        description: string;
-        action: string;
-    };
-    Refunded: {
-        description: string;
-        action: string;
-    };
-    Cancelled: {
-        description: string;
-        action: string;
-    };
-    "In Progress": {
-        description: string;
-        action: string;
-    };
-};
-export namespace SellerLedgerActivityLogActionsDescriptions {
-    namespace ITEM_SOLD {
+export namespace SellerProductLedgerStatusDescriptions {
+    namespace PENDING_RETURN_PERIOD_COMPLETION {
+        const label: string;
         const description: string;
-        const action: string;
     }
-    namespace ITEM_RETURNED {
+    namespace RETURNED_AND_RELISTED {
+        const label_1: string;
+        export { label_1 as label };
         const description_1: string;
         export { description_1 as description };
-        const action_1: string;
-        export { action_1 as action };
     }
-    namespace PAYMENT_INITIATED {
+    namespace SELLER_LIQUIDATED {
+        const label_2: string;
+        export { label_2 as label };
         const description_2: string;
         export { description_2 as description };
-        const action_2: string;
-        export { action_2 as action };
     }
-    namespace PAYMENT_COMPLETED {
+    namespace MERCHANT_DONATED {
+        const label_3: string;
+        export { label_3 as label };
         const description_3: string;
         export { description_3 as description };
-        const action_3: string;
-        export { action_3 as action };
     }
-    namespace PAYMENT_FAILED {
+    namespace SELLER_TO_BE_PAID {
+        const label_4: string;
+        export { label_4 as label };
         const description_4: string;
         export { description_4 as description };
-        const action_4: string;
-        export { action_4 as action };
     }
-    namespace DISPUTE_RAISED {
+    namespace PAYMENT_IN_PROGRESS {
+        const label_5: string;
+        export { label_5 as label };
         const description_5: string;
         export { description_5 as description };
-        const action_5: string;
-        export { action_5 as action };
     }
-    namespace DISPUTE_RESOLVED {
+    namespace SELLER_PAID {
+        const label_6: string;
+        export { label_6 as label };
         const description_6: string;
         export { description_6 as description };
-        const action_6: string;
-        export { action_6 as action };
     }
-    namespace REFUND_ISSUED {
+    namespace DISPUTED {
+        const label_7: string;
+        export { label_7 as label };
         const description_7: string;
         export { description_7 as description };
-        const action_7: string;
-        export { action_7 as action };
     }
-    namespace TRANSACTION_CANCELLED {
+    namespace RESOLVED {
+        const label_8: string;
+        export { label_8 as label };
         const description_8: string;
         export { description_8 as description };
-        const action_8: string;
-        export { action_8 as action };
+    }
+    namespace DIRECT_SALE_PENDING {
+        const label_9: string;
+        export { label_9 as label };
+        const description_9: string;
+        export { description_9 as description };
+    }
+    namespace DIRECT_SALE_COMPLETED {
+        const label_10: string;
+        export { label_10 as label };
+        const description_10: string;
+        export { description_10 as description };
+    }
+}
+export namespace SellerProductLedgerActivityLogActionDescriptions {
+    namespace STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION {
+        const label_11: string;
+        export { label_11 as label };
+        const description_11: string;
+        export { description_11 as description };
+    }
+    namespace STATUS_CHANGED_TO_RETURNED_AND_RELISTED {
+        const label_12: string;
+        export { label_12 as label };
+        const description_12: string;
+        export { description_12 as description };
+    }
+    namespace STATUS_CHANGED_TO_SELLER_LIQUIDATED {
+        const label_13: string;
+        export { label_13 as label };
+        const description_13: string;
+        export { description_13 as description };
+    }
+    namespace STATUS_CHANGED_TO_MERCHANT_DONATED {
+        const label_14: string;
+        export { label_14 as label };
+        const description_14: string;
+        export { description_14 as description };
+    }
+    namespace STATUS_CHANGED_TO_SELLER_TO_BE_PAID {
+        const label_15: string;
+        export { label_15 as label };
+        const description_15: string;
+        export { description_15 as description };
+    }
+    namespace STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS {
+        const label_16: string;
+        export { label_16 as label };
+        const description_16: string;
+        export { description_16 as description };
+    }
+    namespace STATUS_CHANGED_TO_SELLER_PAID {
+        const label_17: string;
+        export { label_17 as label };
+        const description_17: string;
+        export { description_17 as description };
+    }
+    namespace STATUS_CHANGED_TO_DISPUTED {
+        const label_18: string;
+        export { label_18 as label };
+        const description_18: string;
+        export { description_18 as description };
+    }
+    namespace STATUS_CHANGED_TO_RESOLVED {
+        const label_19: string;
+        export { label_19 as label };
+        const description_19: string;
+        export { description_19 as description };
+    }
+    namespace STATUS_CHANGED_TO_DIRECT_SALE_PENDING {
+        const label_20: string;
+        export { label_20 as label };
+        const description_20: string;
+        export { description_20 as description };
+    }
+    namespace STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED {
+        const label_21: string;
+        export { label_21 as label };
+        const description_21: string;
+        export { description_21 as description };
+    }
+    namespace MERCHANT_ADJUSTMENT_MADE {
+        const label_22: string;
+        export { label_22 as label };
+        const description_22: string;
+        export { description_22 as description };
     }
 }

package/lib/constants/ledger-constants.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SellerLedgerActivityLogActionsDescriptions = exports.SellerProductLedgerStatusStatusDescriptionsActions = exports.CUSTOMER_CREDIT_REASONS = exports.TRANSACTION_TYPES = void 0;
+exports.SellerProductLedgerActivityLogActionDescriptions = exports.SellerProductLedgerStatusDescriptions = exports.CUSTOMER_CREDIT_REASONS = exports.TRANSACTION_TYPES = void 0;
 exports.TRANSACTION_TYPES = {
     merchantCredit: 'MERCHANT_CREDIT',
     merchantDebit: 'MERCHANT_DEBIT',
@@ -17,75 +17,99 @@ exports.CUSTOMER_CREDIT_REASONS = {
     customerCompensation: 'CUSTOMER_COMPENSATION',
     refund: 'REFUND',
 };
-exports.SellerProductLedgerStatusStatusDescriptionsActions = {
-    [SellerProductLedgerStatus.PENDING]: {
-        description: 'This status is assigned when an item is sold but is still within the return or refund period. The transaction is recorded but not finalized.',
-        action: 'Monitor for returns or disputes.',
+exports.SellerProductLedgerStatusDescriptions = {
+    [SellerProductLedgerStatus.PENDING_RETURN_PERIOD_COMPLETION]: {
+        label: 'The sold product is in a return period; payment to the seller is pending its completion',
+        description: 'This status is assigned when an item is sold but is still within the return or refund period. Payment to the seller is pending its completion.',
     },
-    [SellerProductLedgerStatus.TO_PAY]: {
-        description: 'Once the return period has expired without a return or dispute, the transaction status updates to indicate the merchant owes payment to the seller.',
-        action: 'Prepare to disburse payment to the seller.',
+    [SellerProductLedgerStatus.RETURNED_AND_RELISTED]: {
+        label: 'Item has been returned and is now listed again for sale.',
+        description: 'Indicates the item was returned and has been relisted for sale. Customer was refunded and no payment will occur for seller.',
     },
-    [SellerProductLedgerStatus.PAID]: {
+    [SellerProductLedgerStatus.SELLER_LIQUIDATED]: {
+        label: 'Item was returned and relisted but then seller decides to take item back.',
+        description: 'Indicates the item was returned and has been relisted for sale, but seller takes it back, meaning inventory is no longer held by merchant and seller is not owed any money.',
+    },
+    [SellerProductLedgerStatus.MERCHANT_DONATED]: {
+        label: 'Item was returned and relisted but merchant decides to donate item and seller does not want it back.',
+        description: 'Indicates the item was returned and has been relisted for sale, but merchant no longer wants to sell it and seller does not want it back, meaning inventory is no longer held by merchant and seller is not owed any money.',
+    },
+    [SellerProductLedgerStatus.SELLER_TO_BE_PAID]: {
+        label: 'Item has cleared the returned period and the seller is now ready to be paid their share of the sale.',
+        description: 'Once the return period has expired without a return or dispute, the merchant owes payment to the seller.',
+    },
+    [SellerProductLedgerStatus.PAYMENT_IN_PROGRESS]: {
+        label: 'Payment to the seller has been initiated and is currently being processed.',
+        description: 'The merchant has initiated the payment and it is now on its way to the seller.',
+    },
+    [SellerProductLedgerStatus.SELLER_PAID]: {
+        label: 'Payment to the seller is complete.',
         description: 'This status indicates that payment has been disbursed to the seller.',
-        action: 'Archive the transaction for record-keeping and financial reconciliation.',
     },
     [SellerProductLedgerStatus.DISPUTED]: {
-        description: 'If the buyer raises a dispute within the return period (or possibly slightly beyond, depending on policy), this status is used.',
-        action: "Hold the transaction from proceeding to 'To Pay' until the dispute is resolved.",
+        label: 'Transaction is under dispute.',
+        description: 'A dispute has been raised concerning this transaction, possibly due to issues with the item, payment, or fulfillment. The dispute resolution process is in progress.',
     },
     [SellerProductLedgerStatus.RESOLVED]: {
-        description: 'Post-dispute, whether the dispute is resolved in favor of the seller or the buyer, this status indicates a conclusion has been reached.',
-        action: "If resolved in favor of the seller, move to 'To Pay' or 'Paid' as appropriate. If in favor of the buyer, adjust the ledger to reflect the return/refund.",
-    },
-    [SellerProductLedgerStatus.REFUNDED]: {
-        description: 'Indicates that a return was processed, and the buyer was refunded, canceling the obligation to pay the seller.',
-        action: 'Adjust the ledger to remove the obligation for payment to the seller.',
+        label: 'Dispute has been resolved.',
+        description: 'The dispute related to this transaction has been resolved. The outcome could result in a payment to the seller, a refund to the buyer, or another resolution.',
     },
-    [SellerProductLedgerStatus.CANCELLED]: {
-        description: 'The transaction was cancelled before completion due to various reasons (e.g., item out of stock, order error).',
-        action: 'No payment obligation; adjust ledger to reflect cancellation.',
+    [SellerProductLedgerStatus.DIRECT_SALE_PENDING]: {
+        label: 'Direct sale transaction is pending.',
+        description: 'This status is used for items sold directly by the platform, pending completion of the sale process. Payment processing or shipment may still be in progress.',
     },
-    [SellerProductLedgerStatus.IN_PROGRESS]: {
-        description: "For use in cases where payment is being processed but hasn't been finalized yet (e.g., bank transfers).",
-        action: "Monitor until payment is completed, then change to 'Paid'.",
+    [SellerProductLedgerStatus.DIRECT_SALE_COMPLETED]: {
+        label: 'Direct sale transaction is completed.',
+        description: 'Indicates that a direct sale transaction has been completed successfully. The item has been sold, shipped, and no return is expected. Payment has been processed accordingly.',
     },
 };
-exports.SellerLedgerActivityLogActionsDescriptions = {
-    [SellerLedgerActivityLogAction.ITEM_SOLD]: {
-        description: 'A product has been sold.',
-        action: 'Record the sale and monitor the return period.',
-    },
-    [SellerLedgerActivityLogAction.ITEM_RETURNED]: {
-        description: 'A sold product has been returned.',
-        action: 'Process the return and update the ledger accordingly.',
-    },
-    [SellerLedgerActivityLogAction.PAYMENT_INITIATED]: {
-        description: 'Payment to the seller has been initiated.',
-        action: 'Monitor the payment process until completion.',
-    },
-    [SellerLedgerActivityLogAction.PAYMENT_COMPLETED]: {
-        description: 'Payment to the seller has been successfully completed.',
-        action: "Update the ledger to reflect the payment status as 'Paid'.",
-    },
-    [SellerLedgerActivityLogAction.PAYMENT_FAILED]: {
-        description: 'Payment to the seller has failed.',
-        action: 'Investigate the failure reason and attempt to reprocess the payment.',
-    },
-    [SellerLedgerActivityLogAction.DISPUTE_RAISED]: {
-        description: 'A dispute has been raised regarding a transaction.',
-        action: 'Hold the transaction and engage in dispute resolution processes.',
-    },
-    [SellerLedgerActivityLogAction.DISPUTE_RESOLVED]: {
-        description: 'The dispute has been resolved.',
-        action: 'Update the transaction status based on the resolution outcome.',
-    },
-    [SellerLedgerActivityLogAction.REFUND_ISSUED]: {
-        description: 'A refund has been issued for a transaction.',
-        action: 'Adjust the ledger to reflect the refunded transaction.',
-    },
-    [SellerLedgerActivityLogAction.TRANSACTION_CANCELLED]: {
-        description: 'The transaction has been cancelled.',
-        action: 'Update the ledger to cancel the transaction and adjust any related financial records.',
+exports.SellerProductLedgerActivityLogActionDescriptions = {
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION]: {
+        label: 'Pending Return Period Completion',
+        description: 'The item has been sold, and the transaction is now in the return period. Payment to the seller is pending the completion of this period.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_RETURNED_AND_RELISTED]: {
+        label: 'Returned and Relisted',
+        description: 'The sold item has been returned and is now relisted for sale. The transaction has been reverted, and no payment is processed to the seller.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_SELLER_LIQUIDATED]: {
+        label: 'Seller liquidated',
+        description: 'The sold item was  returned and relisted for sale, but seller decided to take it back',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_MERCHANT_DONATED]: {
+        label: 'Merchant Donated',
+        description: "The sold item was returned and relisted for sale, but merchant decided to donate it and seller didn't want to take it back",
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_SELLER_TO_BE_PAID]: {
+        label: 'Seller to be Paid',
+        description: 'The return period has completed without a return, and the seller is now due to be paid for the sale.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS]: {
+        label: 'Payment in Progress',
+        description: 'Payment to the seller has been initiated and is currently being processed.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_SELLER_PAID]: {
+        label: 'Seller Paid',
+        description: 'The seller has been paid, completing the transaction for the sold item.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_DISPUTED]: {
+        label: 'Disputed',
+        description: 'A dispute has been raised concerning the transaction. The dispute process is underway to resolve the issue.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_RESOLVED]: {
+        label: 'Resolved',
+        description: 'The dispute or issue affecting the transaction has been resolved.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_DIRECT_SALE_PENDING]: {
+        label: 'Direct Sale Pending',
+        description: 'A direct sale transaction is pending completion. This status is used for items sold directly by the platform.',
+    },
+    [SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED]: {
+        label: 'Direct Sale Completed',
+        description: 'A direct sale transaction has been completed successfully.',
+    },
+    [SellerProductLedgerActivityLogAction.MERCHANT_ADJUSTMENT_MADE]: {
+        label: 'Merchant Adjustment Made',
+        description: 'An adjustment (e.g., payment adjustment) has been made by the merchant.',
     },
 };

package/lib/helpers/SellerProductLedgerHelpers.d.ts

@@ -0,0 +1,3 @@
+export default class SellerProductLedgerHelpers {
+    static buildActivityLog(payload: any): ActivityLog;
+}

package/lib/helpers/SellerProductLedgerHelpers.js

@@ -0,0 +1,20 @@
+"use strict";
+// @ts-ignore
+Object.defineProperty(exports, "__esModule", { value: true });
+const Utilities_1 = require("./Utilities");
+const utilities = new Utilities_1.default();
+class SellerProductLedgerHelpers {
+    static buildActivityLog(payload) {
+        return {
+            documentId: utilities.makeRandId(28),
+            timestamp: Date.now(),
+            sellerProductLedgerId: payload.sellerProductLedgerId || '',
+            action: (payload === null || payload === void 0 ? void 0 : payload.action) || SellerProductLedgerActivityLogAction.STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION,
+            details: (payload === null || payload === void 0 ? void 0 : payload.details) || '',
+            actorId: (payload === null || payload === void 0 ? void 0 : payload.actorId) || 'system',
+            actorType: (payload === null || payload === void 0 ? void 0 : payload.actorType) || AcivityLogActorTypes.SYSTEM,
+            data: (payload === null || payload === void 0 ? void 0 : payload.data) || {},
+        };
+    }
+}
+exports.default = SellerProductLedgerHelpers;

package/lib/models/SellerProductLedger.d.ts

@@ -3,12 +3,14 @@ export default class SellerProductLedger extends Base {
     documentId: string;
     createdAtTimestamp: number;
     updatedAtTimestamp: number;
+    pendingReturnPeriodStartTimestamp: number;
     merchantId: string;
     merchantCurrency: string;
     sellerId: string;
     sellerFirstName: string;
     sellerLastName: string;
     sellerEmail: string;
+    saleType: SaleType;
     productId: string;
     orderId: string;
     productTitle: string;
@@ -18,7 +20,7 @@ export default class SellerProductLedger extends Base {
     amountOwedToSeller: string | number;
     status: SellerProductLedgerStatus;
     feesForSeller: Fee[];
-    activityLog: ActivityLog[];
+    tags: string[];
     constructor(props?: any);
     toObj(): SellerProductLedgerType;
     generateSchemaForTypesense(name?: string): {
@@ -31,6 +33,5 @@ export default class SellerProductLedger extends Base {
         name: string;
     };
     toObjForTypesense(): TypesenseSellerProductLedgerObj;
-    addActivityLogEntry(logEntry: ActivityLog): void;
     addFeeEntry(feeEntry: Fee): void;
 }

package/lib/models/SellerProductLedger.js

@@ -7,6 +7,7 @@ class SellerProductLedger extends Base_1.default {
         this.documentId = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.documentId) || this.utilities.makeRandId(28);
         this.createdAtTimestamp = this.utilities.sanitizeMillisTimeStamp(props === null || props === void 0 ? void 0 : props.createdAtTimestamp);
         this.updatedAtTimestamp = this.utilities.sanitizeMillisTimeStamp(props === null || props === void 0 ? void 0 : props.createdAtTimestamp);
+        this.pendingReturnPeriodStartTimestamp = this.utilities.sanitizeMillisTimeStamp(props === null || props === void 0 ? void 0 : props.pendingReturnPeriodStartTimestamp);
         this.merchantId = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.merchantId);
         this.merchantCurrency = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.merchantCurrency);
         this.sellerId = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.sellerId);
@@ -14,21 +15,23 @@ class SellerProductLedger extends Base_1.default {
         this.sellerFirstName = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.sellerFirstName);
         this.sellerLastName = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.sellerLastName);
         this.sellerEmail = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.sellerEmail);
+        this.saleType = this.utilities.sanitizeString((props === null || props === void 0 ? void 0 : props.saleType) || SaleType.CONSIGNMENT);
         this.productId = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.productId);
         this.productTitle = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.productTitle);
         this.productImgUrl = this.utilities.sanitizeString(props === null || props === void 0 ? void 0 : props.productImgUrl);
         this.merchantCommission = this.utilities.sanitizeNumber(props === null || props === void 0 ? void 0 : props.merchantCommission);
         this.priceSold = this.utilities.sanitizeNumber(props === null || props === void 0 ? void 0 : props.priceSold);
         this.amountOwedToSeller = this.utilities.sanitizeNumber(props === null || props === void 0 ? void 0 : props.amountOwedToSeller);
-        this.status = this.utilities.sanitizeString((props === null || props === void 0 ? void 0 : props.status) || SellerProductLedgerStatus.PENDING);
+        this.status = this.utilities.sanitizeString((props === null || props === void 0 ? void 0 : props.status) || SellerProductLedgerStatus.PENDING_RETURN_PERIOD_COMPLETION);
         this.feesForSeller = Array.isArray(props === null || props === void 0 ? void 0 : props.feesForSeller) ? props === null || props === void 0 ? void 0 : props.feesForSeller : [];
-        this.activityLog = Array.isArray(props === null || props === void 0 ? void 0 : props.activityLog) ? props === null || props === void 0 ? void 0 : props.activityLog : [];
+        this.tags = this.utilities.sanitzeStringArr(props === null || props === void 0 ? void 0 : props.tags);
     }
     toObj() {
         const ledgerObj = {
             documentId: this.documentId,
             createdAtTimestamp: this.createdAtTimestamp,
             updatedAtTimestamp: this.updatedAtTimestamp,
+            pendingReturnPeriodStartTimestamp: this.pendingReturnPeriodStartTimestamp,
             merchantId: this.merchantId,
             merchantCurrency: this.merchantCurrency,
             sellerId: this.sellerId,
@@ -44,7 +47,7 @@ class SellerProductLedger extends Base_1.default {
             amountOwedToSeller: this.amountOwedToSeller,
             status: this.status,
             feesForSeller: this.feesForSeller,
-            activityLog: this.activityLog,
+            tags: this.tags,
         };
         return ledgerObj;
     }
@@ -61,6 +64,7 @@ class SellerProductLedger extends Base_1.default {
                 { name: 'sellerFirstName', type: 'string', facet: false },
                 { name: 'sellerLastName', type: 'string', facet: false },
                 { name: 'sellerEmail', type: 'string', facet: true },
+                { name: 'saleType', type: 'string', facet: true },
                 { name: 'productId', type: 'string', facet: true },
                 { name: 'orderId', type: 'string', facet: true },
                 { name: 'productTitle', type: 'string', facet: true },
@@ -70,7 +74,6 @@ class SellerProductLedger extends Base_1.default {
                 { name: 'amountOwedToSeller', type: 'float', facet: true },
                 { name: 'status', type: 'string', facet: true },
                 { name: 'feesForSeller', type: 'object[]', facet: false },
-                { name: 'activityLog', type: 'object[]', facet: false },
             ],
             name,
         };
@@ -80,12 +83,14 @@ class SellerProductLedger extends Base_1.default {
             documentId: this.utilities.sanitizeString(this.documentId),
             createdAtTimestamp: this.utilities.sanitizeMillisTimeStamp(this.createdAtTimestamp),
             updatedAtTimestamp: this.utilities.sanitizeMillisTimeStamp(this.updatedAtTimestamp),
+            pendingReturnPeriodStartTimestamp: this.utilities.sanitizeMillisTimeStamp(this.pendingReturnPeriodStartTimestamp),
             merchantId: this.utilities.sanitizeString(this.merchantId),
             merchantCurrency: this.utilities.sanitizeString(this.merchantCurrency),
             sellerId: this.utilities.sanitizeString(this.sellerId),
             sellerFirstName: this.utilities.sanitizeString(this.sellerFirstName),
             sellerLastName: this.utilities.sanitizeString(this.sellerLastName),
             sellerEmail: this.utilities.sanitizeString(this.sellerEmail),
+            saleType: this.utilities.sanitizeString(this.saleType),
             productId: this.utilities.sanitizeString(this.productId),
             orderId: this.utilities.sanitizeString(this.orderId),
             productTitle: this.utilities.sanitizeString(this.productTitle),
@@ -98,21 +103,10 @@ class SellerProductLedger extends Base_1.default {
                 name: this.utilities.sanitizeString(fee.name),
                 amount: this.utilities.sanitizeNumber(fee.amount),
             })),
-            activityLog: this.activityLog.map((log) => ({
-                logId: this.utilities.sanitizeString(log.logId),
-                timestamp: this.utilities.sanitizeMillisTimeStamp(log.timestamp),
-                action: this.utilities.sanitizeString(log.action),
-                details: this.utilities.sanitizeString(log.details),
-                actorId: this.utilities.sanitizeString(log.actorId),
-                actorType: this.utilities.sanitizeString(log.actorType),
-                data: (log === null || log === void 0 ? void 0 : log.data) && Object.keys(log === null || log === void 0 ? void 0 : log.data).length ? log === null || log === void 0 ? void 0 : log.data : {},
-            })),
+            tags: this.utilities.sanitzeStringArr(this.tags),
         };
         return stagedObj;
     }
-    addActivityLogEntry(logEntry) {
-        this.activityLog.push(logEntry);
-    }
     addFeeEntry(feeEntry) {
         this.feesForSeller.push(feeEntry);
     }

package/lib/types/ledger-transaction-types.d.ts

@@ -89,13 +89,14 @@ declare type SellerProductLedgerType = {
     documentId: string;
     createdAtTimestamp: number;
     updatedAtTimestamp: number;
+    pendingReturnPeriodStartTimestamp: number;
     merchantId: string;
     merchantCurrency: string;
     sellerId: string;
     sellerFirstName: string;
     sellerLastName: string;
     sellerEmail: string;
-    orderId: string;
+    orderId?: string;
     productId: string;
     productTitle: string;
     productImgUrl: string;
@@ -104,18 +105,20 @@ declare type SellerProductLedgerType = {
     amountOwedToSeller: string | number;
     status: SellerProductLedgerStatus;
     feesForSeller: Fee[];
-    activityLog: ActivityLog[];
+    tags?: string[];
 };
 declare type TypesenseSellerProductLedgerObj = {
     documentId: string;
     createdAtTimestamp: number;
     updatedAtTimestamp: number;
+    pendingReturnPeriodStartTimestamp: number;
     merchantId: string;
     merchantCurrency: string;
     sellerId: string;
     sellerFirstName: string;
     sellerLastName: string;
     sellerEmail: string;
+    saleType: string;
     productId: string;
     orderId: string;
     productTitle: string;
@@ -125,39 +128,54 @@ declare type TypesenseSellerProductLedgerObj = {
     amountOwedToSeller: string | number;
     status: string;
     feesForSeller: Fee[];
-    activityLog: ActivityLog[];
+    tags: string[];
 };
 interface Fee {
     name: string;
     amount: number;
 }
+declare enum SaleType {
+    CONSIGNMENT = "CONSIGNMENT",
+    DIRECT_SALE = "DIRECT_SALE"
+}
 declare enum SellerProductLedgerStatus {
-    PENDING = "Pending",
-    TO_PAY = "To Pay",
-    PAID = "Paid",
-    DISPUTED = "Disputed",
-    RESOLVED = "Resolved",
-    REFUNDED = "Refunded",
-    CANCELLED = "Cancelled",
-    IN_PROGRESS = "In Progress"
+    PENDING_RETURN_PERIOD_COMPLETION = "PENDING_RETURN_PERIOD_COMPLETION",
+    RETURNED_AND_RELISTED = "RETURNED_AND_RELISTED",
+    SELLER_LIQUIDATED = "SELLER_LIQUIDATED",
+    MERCHANT_DONATED = "MERCHANT_DONATED",
+    SELLER_TO_BE_PAID = "SELLER_TO_BE_PAID",
+    PAYMENT_IN_PROGRESS = "PAYMENT_IN_PROGRESS",
+    SELLER_PAID = "SELLER_PAID",
+    DISPUTED = "DISPUTED",
+    RESOLVED = "RESOLVED",
+    DIRECT_SALE_PENDING = "DIRECT_SALE_PENDING",
+    DIRECT_SALE_COMPLETED = "DIRECT_SALE_COMPLETED"
 }
-declare enum SellerLedgerActivityLogAction {
-    ITEM_SOLD = "ITEM_SOLD",
-    ITEM_RETURNED = "ITEM_RETURNED",
-    PAYMENT_INITIATED = "PAYMENT_INITIATED",
-    PAYMENT_COMPLETED = "PAYMENT_COMPLETED",
-    PAYMENT_FAILED = "PAYMENT_FAILED",
-    DISPUTE_RAISED = "DISPUTE_RAISED",
-    DISPUTE_RESOLVED = "DISPUTE_RESOLVED",
-    REFUND_ISSUED = "REFUND_ISSUED",
-    TRANSACTION_CANCELLED = "TRANSACTION_CANCELLED"
+declare enum SellerProductLedgerActivityLogAction {
+    STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION = "STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION",
+    STATUS_CHANGED_TO_RETURNED_AND_RELISTED = "STATUS_CHANGED_TO_RETURNED_AND_RELISTED",
+    STATUS_CHANGED_TO_SELLER_LIQUIDATED = "STATUS_CHANGED_TO_SELLER_LIQUIDATED",
+    STATUS_CHANGED_TO_MERCHANT_DONATED = "STATUS_CHANGED_TO_MERCHANT_DONATED",
+    STATUS_CHANGED_TO_SELLER_TO_BE_PAID = "STATUS_CHANGED_TO_SELLER_TO_BE_PAID",
+    STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS = "STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS",
+    STATUS_CHANGED_TO_SELLER_PAID = "STATUS_CHANGED_TO_SELLER_PAID",
+    STATUS_CHANGED_TO_DISPUTED = "STATUS_CHANGED_TO_DISPUTED",
+    STATUS_CHANGED_TO_RESOLVED = "STATUS_CHANGED_TO_RESOLVED",
+    STATUS_CHANGED_TO_DIRECT_SALE_PENDING = "STATUS_CHANGED_TO_DIRECT_SALE_PENDING",
+    STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED = "STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED",
+    MERCHANT_ADJUSTMENT_MADE = "MERCHANT_ADJUSTMENT_MADE"
+}
+declare enum AcivityLogActorTypes {
+    SYSTEM = "SYSTEM",
+    MERCHANT = "MERCHANT"
 }
 interface ActivityLog {
-    logId: string;
+    documentId: string;
+    sellerProductLedgerId: string;
     timestamp: number;
-    action: SellerLedgerActivityLogAction;
+    action: SellerProductLedgerActivityLogAction;
     details: string;
     actorId: string;
-    actorType: string;
+    actorType: AcivityLogActorTypes;
     data?: any;
 }

package/lib/types/ledger-transaction-types.js

@@ -1,24 +1,40 @@
 "use strict";
+var SaleType;
+(function (SaleType) {
+    SaleType["CONSIGNMENT"] = "CONSIGNMENT";
+    SaleType["DIRECT_SALE"] = "DIRECT_SALE";
+})(SaleType || (SaleType = {}));
 var SellerProductLedgerStatus;
 (function (SellerProductLedgerStatus) {
-    SellerProductLedgerStatus["PENDING"] = "Pending";
-    SellerProductLedgerStatus["TO_PAY"] = "To Pay";
-    SellerProductLedgerStatus["PAID"] = "Paid";
-    SellerProductLedgerStatus["DISPUTED"] = "Disputed";
-    SellerProductLedgerStatus["RESOLVED"] = "Resolved";
-    SellerProductLedgerStatus["REFUNDED"] = "Refunded";
-    SellerProductLedgerStatus["CANCELLED"] = "Cancelled";
-    SellerProductLedgerStatus["IN_PROGRESS"] = "In Progress";
+    SellerProductLedgerStatus["PENDING_RETURN_PERIOD_COMPLETION"] = "PENDING_RETURN_PERIOD_COMPLETION";
+    SellerProductLedgerStatus["RETURNED_AND_RELISTED"] = "RETURNED_AND_RELISTED";
+    SellerProductLedgerStatus["SELLER_LIQUIDATED"] = "SELLER_LIQUIDATED";
+    SellerProductLedgerStatus["MERCHANT_DONATED"] = "MERCHANT_DONATED";
+    SellerProductLedgerStatus["SELLER_TO_BE_PAID"] = "SELLER_TO_BE_PAID";
+    SellerProductLedgerStatus["PAYMENT_IN_PROGRESS"] = "PAYMENT_IN_PROGRESS";
+    SellerProductLedgerStatus["SELLER_PAID"] = "SELLER_PAID";
+    SellerProductLedgerStatus["DISPUTED"] = "DISPUTED";
+    SellerProductLedgerStatus["RESOLVED"] = "RESOLVED";
+    SellerProductLedgerStatus["DIRECT_SALE_PENDING"] = "DIRECT_SALE_PENDING";
+    SellerProductLedgerStatus["DIRECT_SALE_COMPLETED"] = "DIRECT_SALE_COMPLETED";
 })(SellerProductLedgerStatus || (SellerProductLedgerStatus = {}));
-var SellerLedgerActivityLogAction;
-(function (SellerLedgerActivityLogAction) {
-    SellerLedgerActivityLogAction["ITEM_SOLD"] = "ITEM_SOLD";
-    SellerLedgerActivityLogAction["ITEM_RETURNED"] = "ITEM_RETURNED";
-    SellerLedgerActivityLogAction["PAYMENT_INITIATED"] = "PAYMENT_INITIATED";
-    SellerLedgerActivityLogAction["PAYMENT_COMPLETED"] = "PAYMENT_COMPLETED";
-    SellerLedgerActivityLogAction["PAYMENT_FAILED"] = "PAYMENT_FAILED";
-    SellerLedgerActivityLogAction["DISPUTE_RAISED"] = "DISPUTE_RAISED";
-    SellerLedgerActivityLogAction["DISPUTE_RESOLVED"] = "DISPUTE_RESOLVED";
-    SellerLedgerActivityLogAction["REFUND_ISSUED"] = "REFUND_ISSUED";
-    SellerLedgerActivityLogAction["TRANSACTION_CANCELLED"] = "TRANSACTION_CANCELLED";
-})(SellerLedgerActivityLogAction || (SellerLedgerActivityLogAction = {}));
+var SellerProductLedgerActivityLogAction;
+(function (SellerProductLedgerActivityLogAction) {
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION"] = "STATUS_CHANGED_TO_PENDING_RETURN_PERIOD_COMPLETION";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_RETURNED_AND_RELISTED"] = "STATUS_CHANGED_TO_RETURNED_AND_RELISTED";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_SELLER_LIQUIDATED"] = "STATUS_CHANGED_TO_SELLER_LIQUIDATED";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_MERCHANT_DONATED"] = "STATUS_CHANGED_TO_MERCHANT_DONATED";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_SELLER_TO_BE_PAID"] = "STATUS_CHANGED_TO_SELLER_TO_BE_PAID";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS"] = "STATUS_CHANGED_TO_PAYMENT_IN_PROGRESS";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_SELLER_PAID"] = "STATUS_CHANGED_TO_SELLER_PAID";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_DISPUTED"] = "STATUS_CHANGED_TO_DISPUTED";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_RESOLVED"] = "STATUS_CHANGED_TO_RESOLVED";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_DIRECT_SALE_PENDING"] = "STATUS_CHANGED_TO_DIRECT_SALE_PENDING";
+    SellerProductLedgerActivityLogAction["STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED"] = "STATUS_CHANGED_TO_DIRECT_SALE_COMPLETED";
+    SellerProductLedgerActivityLogAction["MERCHANT_ADJUSTMENT_MADE"] = "MERCHANT_ADJUSTMENT_MADE";
+})(SellerProductLedgerActivityLogAction || (SellerProductLedgerActivityLogAction = {}));
+var AcivityLogActorTypes;
+(function (AcivityLogActorTypes) {
+    AcivityLogActorTypes["SYSTEM"] = "SYSTEM";
+    AcivityLogActorTypes["MERCHANT"] = "MERCHANT";
+})(AcivityLogActorTypes || (AcivityLogActorTypes = {}));

package/package.json

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