@collctiv/l2s-models 1.0.0

package/README.md

@@ -0,0 +1,2 @@
+# l2s-models
+L2S models, interfaces, types and enums

package/dist/entities/giftCard.d.ts

@@ -0,0 +1,24 @@
+import { type IDataEntity, type ICreatable } from "../global/interfaces.js";
+import { Country, Currency } from "../global/enums.js";
+export declare class GiftCard implements IDataEntity, ICreatable {
+    id: string;
+    create_date: Date;
+    name: string;
+    description: string;
+    categories: string[];
+    image: string;
+    terms_conditions: string;
+    current_provider: GiftCardProviderType;
+    providers: Partial<Record<GiftCardProviderType, GiftCardProvider>>;
+    region: Country;
+    currency: Currency;
+    in_stock: boolean;
+    constructor(args?: Partial<GiftCard>);
+}
+export type GiftCardProviderType = "mbl" | "tillo";
+export type GiftCardProvider = {
+    min_value: number;
+    max_value: number;
+    product_code: string;
+};
+//# sourceMappingURL=giftCard.d.ts.map

package/dist/entities/giftCard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"giftCard.d.ts","sourceRoot":"","sources":["../../entities/giftCard.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAE5E,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAEvD,qBACa,QAAS,YAAW,WAAW,EAAE,UAAU;IAE7C,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;IAClB,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,UAAU,EAAE,MAAM,EAAE,CAAM;IAC1B,KAAK,EAAE,MAAM,CAAC;IACd,gBAAgB,EAAE,MAAM,CAAC;IACzB,gBAAgB,EAAE,oBAAoB,CAAC;IACvC,SAAS,EAAE,OAAO,CAAC,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,CAAC,CAAC,CAAC;IACnE,MAAM,EAAE,OAAO,CAAC;IAChB,QAAQ,EAAE,QAAQ,CAAC;IACnB,QAAQ,EAAE,OAAO,CAAC;gBAEN,IAAI,GAAE,OAAO,CAAC,QAAQ,CAAM;CAGlD;AAED,MAAM,MAAM,oBAAoB,GAAG,KAAK,GAAG,OAAO,CAAC;AAEnD,MAAM,MAAM,gBAAgB,GAAG;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,YAAY,EAAE,MAAM,CAAC;CACxB,CAAA"}

package/dist/entities/giftCard.js

@@ -0,0 +1,34 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import {} from "../global/interfaces.js";
+import { Collection } from "../global/decorators.js";
+import { Country, Currency } from "../global/enums.js";
+let GiftCard = class GiftCard {
+    id;
+    create_date;
+    name;
+    description;
+    categories = [];
+    image;
+    terms_conditions;
+    current_provider;
+    providers;
+    region;
+    currency;
+    in_stock;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+};
+GiftCard = __decorate([
+    Collection("gift_cards"),
+    __metadata("design:paramtypes", [Object])
+], GiftCard);
+export { GiftCard };

package/dist/entities/kyc.d.ts

@@ -0,0 +1,21 @@
+import { KycProviderType } from "../global/enums.js";
+import { KycEvent } from "./kycEvent.js";
+export declare class Kyc {
+    status: KycStatus;
+    session: KycSession;
+    current: KycEvent;
+    date: Date;
+    constructor(args?: Partial<Kyc>);
+}
+export declare enum KycStatus {
+    Approved = "approved",
+    AwaitingReview = "awaiting_review",
+    NotCompleted = "not_completed",
+    Rejected = "rejected",
+    Retry = "retry"
+}
+export type KycSession = {
+    id: string;
+    provider: KycProviderType;
+};
+//# sourceMappingURL=kyc.d.ts.map

package/dist/entities/kyc.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kyc.d.ts","sourceRoot":"","sources":["../../entities/kyc.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAEzC,qBAAa,GAAG;IAEL,MAAM,EAAE,SAAS,CAAC;IAClB,OAAO,EAAE,UAAU,CAAC;IACpB,OAAO,EAAE,QAAQ,CAAC;IAClB,IAAI,EAAE,IAAI,CAAC;gBAEC,IAAI,GAAE,OAAO,CAAC,GAAG,CAAM;CAG7C;AAED,oBAAY,SAAS;IACjB,QAAQ,aAAa;IACrB,cAAc,oBAAoB;IAClC,YAAY,kBAAkB;IAC9B,QAAQ,aAAa;IACrB,KAAK,UAAU;CAClB;AAED,MAAM,MAAM,UAAU,GAAG;IACrB,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAA"}

package/dist/entities/kyc.js

@@ -0,0 +1,19 @@
+import { KycProviderType } from "../global/enums.js";
+import { KycEvent } from "./kycEvent.js";
+export class Kyc {
+    status;
+    session;
+    current;
+    date;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+}
+export var KycStatus;
+(function (KycStatus) {
+    KycStatus["Approved"] = "approved";
+    KycStatus["AwaitingReview"] = "awaiting_review";
+    KycStatus["NotCompleted"] = "not_completed";
+    KycStatus["Rejected"] = "rejected";
+    KycStatus["Retry"] = "retry";
+})(KycStatus || (KycStatus = {}));

package/dist/entities/kycEvent.d.ts

@@ -0,0 +1,37 @@
+import { type ICreatable } from "../global/interfaces.js";
+import { KycDeclineSelfieCode, KycDeclineGovIdCode, KycDeclineSupDocCode, type KycDeclineType } from "../global/kyc.js";
+export declare class KycEvent implements ICreatable {
+    id: string;
+    create_date: Date;
+    event: KycEventType;
+    message: string;
+    data: KycEventDataPersona;
+    constructor(args?: Partial<KycEvent>);
+}
+export declare enum KycEventType {
+    Created = "created",
+    Started = "started",
+    Completed = "completed",
+    Expired = "expired",
+    Declined = "declined",
+    Approved = "approved",
+    Failed = "failed",
+    ReviewRejected = "review_rejected",
+    ReviewApproved = "review_approved",
+    InReview = "in_review",
+    Retry = "retry"
+}
+export type KycEventDataPersona = {
+    tags: string[];
+    known: {
+        declines: KycKnownDecline[];
+    };
+    unknown?: {
+        declines?: string[];
+    };
+};
+export type KycKnownDecline = {
+    type: KycDeclineType;
+    codes: (KycDeclineSelfieCode | KycDeclineGovIdCode | KycDeclineSupDocCode)[];
+};
+//# sourceMappingURL=kycEvent.d.ts.map

package/dist/entities/kycEvent.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kycEvent.d.ts","sourceRoot":"","sources":["../../entities/kycEvent.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAC1D,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,KAAK,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAExH,qBAAa,QAAS,YAAW,UAAU;IAEhC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;IAClB,KAAK,EAAE,YAAY,CAAC;IACpB,OAAO,EAAE,MAAM,CAAM;IACrB,IAAI,EAAE,mBAAmB,CAAQ;gBAErB,IAAI,GAAE,OAAO,CAAC,QAAQ,CAAM;CAGlD;AAED,oBAAY,YAAY;IACpB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,cAAc,oBAAoB;IAClC,cAAc,oBAAoB;IAClC,QAAQ,cAAc;IACtB,KAAK,UAAU;CAClB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,IAAI,EAAE,MAAM,EAAE,CAAC;IACf,KAAK,EAAE;QACH,QAAQ,EAAE,eAAe,EAAE,CAAC;KAC/B,CAAC;IACF,OAAO,CAAC,EAAE;QACN,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;KACvB,CAAC;CACL,CAAA;AAED,MAAM,MAAM,eAAe,GAAG;IAC1B,IAAI,EAAE,cAAc,CAAC;IACrB,KAAK,EAAE,CAAC,oBAAoB,GAAG,mBAAmB,GAAG,oBAAoB,CAAC,EAAE,CAAC;CAChF,CAAA"}

package/dist/entities/kycEvent.js

@@ -0,0 +1,26 @@
+import {} from "../global/interfaces.js";
+import { KycDeclineSelfieCode, KycDeclineGovIdCode, KycDeclineSupDocCode } from "../global/kyc.js";
+export class KycEvent {
+    id;
+    create_date;
+    event;
+    message = "";
+    data = null;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+}
+export var KycEventType;
+(function (KycEventType) {
+    KycEventType["Created"] = "created";
+    KycEventType["Started"] = "started";
+    KycEventType["Completed"] = "completed";
+    KycEventType["Expired"] = "expired";
+    KycEventType["Declined"] = "declined";
+    KycEventType["Approved"] = "approved";
+    KycEventType["Failed"] = "failed";
+    KycEventType["ReviewRejected"] = "review_rejected";
+    KycEventType["ReviewApproved"] = "review_approved";
+    KycEventType["InReview"] = "in_review";
+    KycEventType["Retry"] = "retry";
+})(KycEventType || (KycEventType = {}));

package/dist/entities/kycRequest.d.ts

@@ -0,0 +1,35 @@
+import { type IDataEntity, type ICreatable, type IModifiable } from "../global/interfaces.js";
+import { KycProviderType } from "../global/enums.js";
+import { KycEvent } from "./kycEvent.js";
+import { User } from "./user.js";
+export declare class KycRequest implements IDataEntity, ICreatable, IModifiable {
+    id: string;
+    create_date: Date;
+    modified_date: Date | null;
+    session: KycRequestSession;
+    user_id: string;
+    status: KycRequestStatus;
+    events: KycEvent[];
+    kyc_name?: string;
+    constructor(args?: Partial<KycRequest>);
+}
+export declare enum KycRequestStatus {
+    Created = "created",
+    Started = "started",
+    Completed = "completed",
+    Expired = "expired",
+    Rejected = "rejected",
+    Approved = "approved",
+    Failed = "failed",
+    AwaitingReview = "awaiting_review",
+    InReview = "in_review",
+    Retry = "retry"
+}
+export type KycRequestSession = {
+    id: string;
+    provider: KycProviderType;
+};
+export declare class UserKycRequest extends KycRequest {
+    user: User;
+}
+//# sourceMappingURL=kycRequest.d.ts.map

package/dist/entities/kycRequest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kycRequest.d.ts","sourceRoot":"","sources":["../../entities/kycRequest.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC9F,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAC;AACrD,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAEjC,qBAEa,UAAW,YAAW,WAAW,EAAE,UAAU,EAAE,WAAW;IAE5D,EAAE,EAAE,MAAM,CAAQ;IAClB,WAAW,EAAE,IAAI,CAAc;IAC/B,aAAa,EAAE,IAAI,GAAG,IAAI,CAAC;IAE3B,OAAO,EAAE,iBAAiB,CAAQ;IAClC,OAAO,EAAE,MAAM,CAAC;IAGhB,MAAM,EAAE,gBAAgB,CAA4B;IAGpD,MAAM,EAAE,QAAQ,EAAE,CAAM;IAGxB,QAAQ,CAAC,EAAE,MAAM,CAAC;gBAEN,IAAI,GAAE,OAAO,CAAC,UAAU,CAAM;CAGpD;AAED,oBAAY,gBAAgB;IACxB,OAAO,YAAY;IACnB,OAAO,YAAY;IACnB,SAAS,cAAc;IACvB,OAAO,YAAY;IACnB,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,cAAc,oBAAoB;IAClC,QAAQ,cAAc;IACtB,KAAK,UAAU;CAClB;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,QAAQ,EAAE,eAAe,CAAC;CAC7B,CAAA;AAED,qBAAa,cAAe,SAAQ,UAAU;IACnC,IAAI,EAAE,IAAI,CAAC;CACrB"}

package/dist/entities/kycRequest.js

@@ -0,0 +1,61 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import { Collection, Updatable, Topic } from "../global/decorators.js";
+import {} from "../global/interfaces.js";
+import { KycProviderType } from "../global/enums.js";
+import { KycEvent } from "./kycEvent.js";
+import { User } from "./user.js";
+let KycRequest = class KycRequest {
+    id = null;
+    create_date = new Date();
+    modified_date;
+    session = null;
+    user_id;
+    status = KycRequestStatus.Created;
+    events = [];
+    kyc_name;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+};
+__decorate([
+    Updatable(),
+    __metadata("design:type", String)
+], KycRequest.prototype, "status", void 0);
+__decorate([
+    Updatable(),
+    __metadata("design:type", Array)
+], KycRequest.prototype, "events", void 0);
+__decorate([
+    Updatable(),
+    __metadata("design:type", String)
+], KycRequest.prototype, "kyc_name", void 0);
+KycRequest = __decorate([
+    Collection("kyc_requests"),
+    Topic("kyc"),
+    __metadata("design:paramtypes", [Object])
+], KycRequest);
+export { KycRequest };
+export var KycRequestStatus;
+(function (KycRequestStatus) {
+    KycRequestStatus["Created"] = "created";
+    KycRequestStatus["Started"] = "started";
+    KycRequestStatus["Completed"] = "completed";
+    KycRequestStatus["Expired"] = "expired";
+    KycRequestStatus["Rejected"] = "rejected";
+    KycRequestStatus["Approved"] = "approved";
+    KycRequestStatus["Failed"] = "failed";
+    KycRequestStatus["AwaitingReview"] = "awaiting_review";
+    KycRequestStatus["InReview"] = "in_review";
+    KycRequestStatus["Retry"] = "retry";
+})(KycRequestStatus || (KycRequestStatus = {}));
+export class UserKycRequest extends KycRequest {
+    user;
+}

package/dist/entities/ledgerItem.d.ts

@@ -0,0 +1,45 @@
+import { type IDataEntity } from "../global/interfaces.js";
+import { Currency } from "../global/enums.js";
+import { LedgerOperation, LedgerStatus, LedgerTypeInternal } from "../global/balance.js";
+export declare class LedgerItem implements IDataEntity {
+    id: string;
+    create_date: Date;
+    processed_date?: Date;
+    user: string;
+    operation: LedgerOperation;
+    message_id: string;
+    type: LedgerItemType;
+    status: LedgerStatus;
+    currency: Currency;
+    amount: number;
+    pot: LedgerItemPot;
+    entity?: string;
+    metadata: {
+        [key: string]: string;
+    };
+}
+export declare class LedgerItemType {
+    internal: LedgerTypeInternal;
+    regulatory: string;
+    entity: string;
+}
+export declare class LedgerItemPot {
+    _id: string;
+    old_balance?: number;
+    new_balance?: number;
+}
+export declare class LedgerClosingBalance {
+    date: string;
+    balance: number;
+}
+export declare class LedgerAmountResult {
+    amount: number;
+}
+export declare class LedgerAvailableBalance {
+    readonly balance: number;
+    constructor(balance?: number);
+}
+export declare enum CtvPotId {
+    Revenue = "ctv:revenue"
+}
+//# sourceMappingURL=ledgerItem.d.ts.map

package/dist/entities/ledgerItem.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ledgerItem.d.ts","sourceRoot":"","sources":["../../entities/ledgerItem.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAC3D,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,YAAY,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AAGzF,qBACa,UAAW,YAAW,WAAW;IACnC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAC;IAClB,cAAc,CAAC,EAAE,IAAI,CAAC;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,SAAS,EAAE,eAAe,CAAC;IAC3B,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,EAAE,cAAc,CAAC;IACrB,MAAM,EAAE,YAAY,CAAC;IACrB,QAAQ,EAAE,QAAQ,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,GAAG,EAAE,aAAa,CAAC;IACnB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;CAC9C;AAED,qBAAa,cAAc;IAChB,QAAQ,EAAE,kBAAkB,CAAC;IAC7B,UAAU,EAAE,MAAM,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;CACzB;AAED,qBAAa,aAAa;IACf,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;CAC/B;AAED,qBAAa,oBAAoB;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;CAC1B;AAED,qBAAa,kBAAkB;IAC3B,MAAM,EAAE,MAAM,CAAK;CACtB;AAED,qBAAa,sBAAsB;aACI,OAAO,EAAE,MAAM;gBAAf,OAAO,GAAE,MAAU;CACzD;AAED,oBAAY,QAAQ;IAChB,OAAO,gBAAgB;CAC1B"}

package/dist/entities/ledgerItem.js

@@ -0,0 +1,56 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+import {} from "../global/interfaces.js";
+import { Currency } from "../global/enums.js";
+import { LedgerOperation, LedgerStatus, LedgerTypeInternal } from "../global/balance.js";
+import { Collection } from "../global/decorators.js";
+let LedgerItem = class LedgerItem {
+    id;
+    create_date;
+    processed_date;
+    user;
+    operation;
+    message_id;
+    type;
+    status;
+    currency;
+    amount;
+    pot;
+    entity;
+    metadata;
+};
+LedgerItem = __decorate([
+    Collection("ledger")
+], LedgerItem);
+export { LedgerItem };
+export class LedgerItemType {
+    internal;
+    regulatory;
+    entity;
+}
+export class LedgerItemPot {
+    _id;
+    old_balance;
+    new_balance;
+}
+export class LedgerClosingBalance {
+    date; // yyyy-mm-dd
+    balance;
+}
+export class LedgerAmountResult {
+    amount = 0;
+}
+export class LedgerAvailableBalance {
+    balance;
+    constructor(balance = 0) {
+        this.balance = balance;
+    }
+}
+export var CtvPotId;
+(function (CtvPotId) {
+    CtvPotId["Revenue"] = "ctv:revenue";
+})(CtvPotId || (CtvPotId = {}));

package/dist/entities/order.d.ts

@@ -0,0 +1,131 @@
+import { type IDataEntity, type ICreatable, type IModifiable } from "../global/interfaces.js";
+import { Currency } from "../global/enums.js";
+export declare class Order implements IDataEntity, ICreatable, IModifiable {
+    id: string;
+    create_date: Date;
+    modified_date: Date | null;
+    status: OrderStatus;
+    order_no: string;
+    items: OrderItem[];
+    totals: OrderTotals;
+    shipping: OrderShipping;
+    payment: OrderPayment;
+    user_id: string;
+    delivery?: OrderDelivery[];
+    constructor(args?: Partial<Order>);
+}
+export declare class OrderRedemption implements IDataEntity {
+    readonly id: string;
+    readonly create_date: Date;
+    readonly user_id: string;
+    readonly order_no: string;
+    readonly delivery: OrderRedemptionDelivery;
+    readonly access: OrderRedemptionAccess;
+    constructor(args?: Partial<OrderRedemption>);
+}
+export type OrderShippingType = "email" | "user";
+export type OrderPaymentMethod = "pot";
+export declare enum OrderStatus {
+    New = "new",
+    InProgress = "in_progress",
+    Complete = "complete",
+    Cancelled = "cancelled",
+    Failed = "failed",
+    AwaitingDelivery = "awaiting_delivery"
+}
+export declare enum SupplierType {
+    Mbl = "mbl",
+    Tillo = "tillo"
+}
+export declare enum CourierType {
+    Mbl = "mbl",
+    Tillo = "tillo"
+}
+export declare enum OrderItemType {
+    GiftCard = "gift_card"
+}
+export type OrderItem = {
+    product_id: string;
+    item_id: string;
+    quantity: number;
+    sub_total: number;
+    type: OrderItemType;
+};
+export type OrderTotals = {
+    sub_total: number;
+    shipping: number;
+    tax: number;
+    grand_total: number;
+};
+export type OrderShipping = {
+    type: OrderShippingType;
+    email?: string;
+    name?: string;
+    user_id?: string;
+};
+export type OrderPayment = {
+    method: OrderPaymentMethod;
+    pot_id: string;
+};
+export type OrderDeliveryStatus = "pending" | "delivered" | "failed";
+export type OrderDelivery = {
+    supplier: SupplierType;
+    courier: CourierType;
+    status: OrderDeliveryStatus;
+    data: OrderDeliveryData[];
+};
+export type OrderRedemptionDelivery = {
+    supplier: SupplierType;
+    courier: CourierType;
+    status: OrderDeliveryStatus;
+    data: OrderDeliveryData;
+};
+export type OrderRedemptionAccess = {
+    user_id: string | null;
+};
+export type OrderDeliveryData = {
+    product_code: string;
+    product?: MblDelivery | TilloDelivery;
+    product_id: string;
+    product_name: string;
+    product_description: string;
+    product_image: string;
+    product_terms: string;
+    product_categories: string[];
+    item_id: string;
+    item_idx: number;
+    amount: number;
+    currency: Currency;
+    type: OrderItemType;
+    processed_date?: Date;
+};
+export type MblDelivery = {
+    value: number;
+    product: string;
+    processor_reference: string;
+    details: {
+        serial: string;
+        code: string;
+        pin: string;
+        url: string;
+        activation: Date;
+        expiration: Date;
+    };
+};
+export type TilloDelivery = {
+    reference: string;
+    status: string;
+    face_value: {
+        amount: number;
+        currency: string;
+    };
+    cost_value: {
+        amount: number;
+        currency: string;
+    };
+    discount: string;
+    brand: string;
+    url: string;
+    expiration_date: Date;
+};
+//# sourceMappingURL=order.d.ts.map

package/dist/entities/order.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"order.d.ts","sourceRoot":"","sources":["../../entities/order.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,WAAW,EAAE,KAAK,UAAU,EAAE,KAAK,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAE9F,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAE9C,qBAGa,KAAM,YAAW,WAAW,EAAE,UAAU,EAAE,WAAW;IAEvD,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,EAAE,IAAI,CAAc;IAC/B,aAAa,EAAE,IAAI,GAAG,IAAI,CAAC;IAG3B,MAAM,EAAE,WAAW,CAAmB;IAGtC,QAAQ,EAAE,MAAM,CAAC;IAEjB,KAAK,EAAE,SAAS,EAAE,CAAC;IACnB,MAAM,EAAE,WAAW,CAAC;IACpB,QAAQ,EAAE,aAAa,CAAC;IACxB,OAAO,EAAE,YAAY,CAAC;IACtB,OAAO,EAAE,MAAM,CAAC;IAGhB,QAAQ,CAAC,EAAE,aAAa,EAAE,CAAC;gBAEf,IAAI,GAAE,OAAO,CAAC,KAAK,CAAM;CAG/C;AAED,qBACa,eAAgB,YAAW,WAAW;IAC/C,SAAgB,EAAE,EAAE,MAAM,CAAC;IAC3B,SAAgB,WAAW,EAAE,IAAI,CAAC;IAClC,SAAgB,OAAO,EAAE,MAAM,CAAC;IAChC,SAAgB,QAAQ,EAAE,MAAM,CAAC;IACjC,SAAgB,QAAQ,EAAE,uBAAuB,CAAC;IAClD,SAAgB,MAAM,EAAE,qBAAqB,CAAC;gBAE3B,IAAI,GAAE,OAAO,CAAC,eAAe,CAAM;CAGzD;AAED,MAAM,MAAM,iBAAiB,GAAG,OAAO,GAAG,MAAM,CAAC;AACjD,MAAM,MAAM,kBAAkB,GAAG,KAAK,CAAC;AAEvC,oBAAY,WAAW;IACnB,GAAG,QAAQ;IACX,UAAU,gBAAgB;IAC1B,QAAQ,aAAa;IACrB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,gBAAgB,sBAAsB;CACzC;AAED,oBAAY,YAAY;IACpB,GAAG,QAAQ;IACX,KAAK,UAAU;CAClB;AAED,oBAAY,WAAW;IACnB,GAAG,QAAQ;IACX,KAAK,UAAU;CAClB;AAED,oBAAY,aAAa;IACrB,QAAQ,cAAc;CACzB;AAED,MAAM,MAAM,SAAS,GAAG;IACpB,UAAU,EAAE,MAAM,CAAC;IACnB,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE,aAAa,CAAC;CACvB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,MAAM,CAAC;IACZ,WAAW,EAAE,MAAM,CAAC;CACvB,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,IAAI,EAAE,iBAAiB,CAAC;IACxB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,MAAM,CAAC;CAClB,CAAA;AAKD,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;AAErE,MAAM,MAAM,aAAa,GAAG;IACxB,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,IAAI,EAAE,iBAAiB,EAAE,CAAC;CAC7B,CAAA;AAED,MAAM,MAAM,uBAAuB,GAAG;IAClC,QAAQ,EAAE,YAAY,CAAC;IACvB,OAAO,EAAE,WAAW,CAAC;IACrB,MAAM,EAAE,mBAAmB,CAAC;IAC5B,IAAI,EAAE,iBAAiB,CAAC;CAC3B,CAAA;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC,OAAO,EAAE,MAAM,GAAG,IAAI,CAAC;CAC1B,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC5B,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,CAAC,EAAE,WAAW,GAAC,aAAa,CAAC;IACpC,UAAU,EAAE,MAAM,CAAC;IACnB,YAAY,EAAE,MAAM,CAAC;IACrB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,aAAa,EAAE,MAAM,CAAC;IACtB,aAAa,EAAE,MAAM,CAAC;IACtB,kBAAkB,EAAE,MAAM,EAAE,CAAC;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;IACf,QAAQ,EAAE,QAAQ,CAAC;IACnB,IAAI,EAAE,aAAa,CAAC;IACpB,cAAc,CAAC,EAAE,IAAI,CAAC;CACzB,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,mBAAmB,EAAE,MAAM,CAAC;IAC5B,OAAO,EAAE;QACL,MAAM,EAAE,MAAM,CAAC;QACf,IAAI,EAAE,MAAM,CAAC;QACb,GAAG,EAAE,MAAM,CAAC;QACZ,GAAG,EAAE,MAAM,CAAC;QACZ,UAAU,EAAE,IAAI,CAAC;QACjB,UAAU,EAAE,IAAI,CAAC;KACpB,CAAA;CACJ,CAAA;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;KAAE,CAAC;IAClD,UAAU,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAA;KAAE,CAAC;IACjD,QAAQ,EAAE,MAAM,CAAC;IACjB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,EAAE,MAAM,CAAC;IACZ,eAAe,EAAE,IAAI,CAAC;CACzB,CAAA"}

package/dist/entities/order.js

@@ -0,0 +1,86 @@
+var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
+    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
+    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
+    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+    return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+var __metadata = (this && this.__metadata) || function (k, v) {
+    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
+};
+import {} from "../global/interfaces.js";
+import { Collection, Topic, Updatable, TransactionId } from "../global/decorators.js";
+import { Currency } from "../global/enums.js";
+let Order = class Order {
+    id;
+    create_date = new Date();
+    modified_date;
+    status = OrderStatus.New;
+    order_no;
+    items;
+    totals;
+    shipping;
+    payment;
+    user_id;
+    delivery;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+};
+__decorate([
+    Updatable(),
+    __metadata("design:type", String)
+], Order.prototype, "status", void 0);
+__decorate([
+    Updatable(),
+    __metadata("design:type", String)
+], Order.prototype, "order_no", void 0);
+__decorate([
+    Updatable(),
+    __metadata("design:type", Array)
+], Order.prototype, "delivery", void 0);
+Order = __decorate([
+    Collection("orders"),
+    Topic("orders"),
+    TransactionId("order_no"),
+    __metadata("design:paramtypes", [Object])
+], Order);
+export { Order };
+let OrderRedemption = class OrderRedemption {
+    id;
+    create_date;
+    user_id;
+    order_no;
+    delivery;
+    access;
+    constructor(args = {}) {
+        Object.assign(this, args);
+    }
+};
+OrderRedemption = __decorate([
+    Collection("orders"),
+    __metadata("design:paramtypes", [Object])
+], OrderRedemption);
+export { OrderRedemption };
+export var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["New"] = "new";
+    OrderStatus["InProgress"] = "in_progress";
+    OrderStatus["Complete"] = "complete";
+    OrderStatus["Cancelled"] = "cancelled";
+    OrderStatus["Failed"] = "failed";
+    OrderStatus["AwaitingDelivery"] = "awaiting_delivery";
+})(OrderStatus || (OrderStatus = {}));
+export var SupplierType;
+(function (SupplierType) {
+    SupplierType["Mbl"] = "mbl";
+    SupplierType["Tillo"] = "tillo";
+})(SupplierType || (SupplierType = {}));
+export var CourierType;
+(function (CourierType) {
+    CourierType["Mbl"] = "mbl";
+    CourierType["Tillo"] = "tillo";
+})(CourierType || (CourierType = {}));
+export var OrderItemType;
+(function (OrderItemType) {
+    OrderItemType["GiftCard"] = "gift_card";
+})(OrderItemType || (OrderItemType = {}));