@fas-core/shared-types 1.0.15 → 1.0.17

package/dist/index.d.mts

@@ -98,6 +98,7 @@ interface SoftDeleteFilter {
     isDeleted?: boolean;
     deletedAt?: Date | null;
 }
+type Metadata = Record<string, unknown>;
 
 interface ICurrency extends BaseEntity {
     name: string;
@@ -139,8 +140,91 @@ interface IContact extends BaseEntity {
     source: 'website' | 'email' | 'phone' | 'chat' | 'other';
     caseId: string;
     notes: string;
-    Store: IStore;
+    store: IStore;
     resolvedAt?: Date;
 }
 
-export { ADMIN_ROLES, type ApiResponse, type BaseEntity, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IContact, type ICountry, type ICurrency, type ICustomer, type IState, type IStore, type IStoreSettings, type Paginated, type SoftDeleteFilter };
+declare const DiscountTypeEnum: {
+    readonly PERCENTAGE: "PERCENTAGE";
+    readonly FIXED: "FIXED";
+};
+type DiscountTypeEnum = (typeof DiscountTypeEnum)[keyof typeof DiscountTypeEnum];
+interface IDiscountType {
+    type: DiscountTypeEnum;
+    value: number;
+}
+interface ICoupon extends BaseEntity {
+    title: string;
+    couponCode: string;
+    startTime: Date;
+    endTime: Date;
+    discountType: IDiscountType;
+    minimumAmount: number;
+    isPromotional: boolean;
+    status: boolean;
+    store: IStore | string;
+}
+
+interface IVariant extends BaseEntity {
+    name: string;
+    sku: string;
+    attributes: Record<string, string>;
+    price: number;
+    stock: number;
+    product: IProduct;
+    status: boolean;
+    metaData: Metadata;
+}
+
+interface IProduct extends BaseEntity {
+    name: string;
+    slug: string;
+    sku: string;
+    description: string;
+    price: number;
+    variants: IVariant[];
+    store: IStore;
+    metaData: Metadata;
+    status: boolean;
+}
+
+interface IOrderItem extends BaseEntity {
+    order: IOrder;
+    product: IProduct;
+    variant?: IVariant;
+    pricing: {
+        unitPrice: number;
+        totalAmount: number;
+    };
+    quantity: number;
+    unitPrice: number;
+    totalAmount: number;
+    metaData: Metadata;
+}
+
+declare const OrderStatusEnum: {
+    readonly PENDING: "PENDING";
+    readonly CONFIRMED: "CONFIRMED";
+    readonly PROCESSING: "PROCESSING";
+    readonly SHIPPED: "SHIPPED";
+    readonly DELIVERED: "DELIVERED";
+    readonly CANCELED: "CANCELED";
+    readonly FAILED: "FAILED";
+    readonly REFUNDED: "REFUNDED";
+    readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
+};
+type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];
+interface IOrder extends BaseEntity {
+    orderId: string;
+    orderItems: IOrderItem[];
+    user?: ICustomer;
+    coupon?: ICoupon;
+    store: IStore;
+    status: OrderStatusEnum;
+    subTotalAmount: number;
+    discountAmount: number;
+    totalAmount: number;
+    metaData: Metadata;
+}
+
+export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IContact, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IOrder, type IOrderItem, type IProduct, type IState, type IStore, type IStoreSettings, type IVariant, type Metadata, OrderStatusEnum, type Paginated, type SoftDeleteFilter };

package/dist/index.d.ts

@@ -98,6 +98,7 @@ interface SoftDeleteFilter {
     isDeleted?: boolean;
     deletedAt?: Date | null;
 }
+type Metadata = Record<string, unknown>;
 
 interface ICurrency extends BaseEntity {
     name: string;
@@ -139,8 +140,91 @@ interface IContact extends BaseEntity {
     source: 'website' | 'email' | 'phone' | 'chat' | 'other';
     caseId: string;
     notes: string;
-    Store: IStore;
+    store: IStore;
     resolvedAt?: Date;
 }
 
-export { ADMIN_ROLES, type ApiResponse, type BaseEntity, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IContact, type ICountry, type ICurrency, type ICustomer, type IState, type IStore, type IStoreSettings, type Paginated, type SoftDeleteFilter };
+declare const DiscountTypeEnum: {
+    readonly PERCENTAGE: "PERCENTAGE";
+    readonly FIXED: "FIXED";
+};
+type DiscountTypeEnum = (typeof DiscountTypeEnum)[keyof typeof DiscountTypeEnum];
+interface IDiscountType {
+    type: DiscountTypeEnum;
+    value: number;
+}
+interface ICoupon extends BaseEntity {
+    title: string;
+    couponCode: string;
+    startTime: Date;
+    endTime: Date;
+    discountType: IDiscountType;
+    minimumAmount: number;
+    isPromotional: boolean;
+    status: boolean;
+    store: IStore | string;
+}
+
+interface IVariant extends BaseEntity {
+    name: string;
+    sku: string;
+    attributes: Record<string, string>;
+    price: number;
+    stock: number;
+    product: IProduct;
+    status: boolean;
+    metaData: Metadata;
+}
+
+interface IProduct extends BaseEntity {
+    name: string;
+    slug: string;
+    sku: string;
+    description: string;
+    price: number;
+    variants: IVariant[];
+    store: IStore;
+    metaData: Metadata;
+    status: boolean;
+}
+
+interface IOrderItem extends BaseEntity {
+    order: IOrder;
+    product: IProduct;
+    variant?: IVariant;
+    pricing: {
+        unitPrice: number;
+        totalAmount: number;
+    };
+    quantity: number;
+    unitPrice: number;
+    totalAmount: number;
+    metaData: Metadata;
+}
+
+declare const OrderStatusEnum: {
+    readonly PENDING: "PENDING";
+    readonly CONFIRMED: "CONFIRMED";
+    readonly PROCESSING: "PROCESSING";
+    readonly SHIPPED: "SHIPPED";
+    readonly DELIVERED: "DELIVERED";
+    readonly CANCELED: "CANCELED";
+    readonly FAILED: "FAILED";
+    readonly REFUNDED: "REFUNDED";
+    readonly PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED";
+};
+type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];
+interface IOrder extends BaseEntity {
+    orderId: string;
+    orderItems: IOrderItem[];
+    user?: ICustomer;
+    coupon?: ICoupon;
+    store: IStore;
+    status: OrderStatusEnum;
+    subTotalAmount: number;
+    discountAmount: number;
+    totalAmount: number;
+    metaData: Metadata;
+}
+
+export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IContact, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IOrder, type IOrderItem, type IProduct, type IState, type IStore, type IStoreSettings, type IVariant, type Metadata, OrderStatusEnum, type Paginated, type SoftDeleteFilter };

package/dist/index.js

@@ -20,7 +20,9 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  ADMIN_ROLES: () => ADMIN_ROLES
+  ADMIN_ROLES: () => ADMIN_ROLES,
+  DiscountTypeEnum: () => DiscountTypeEnum,
+  OrderStatusEnum: () => OrderStatusEnum
 });
 module.exports = __toCommonJS(index_exports);
 
@@ -35,4 +37,23 @@ var ADMIN_ROLES = [
   "Security Guard",
   "Accountant"
 ];
+
+// src/coupon/interface.ts
+var DiscountTypeEnum = {
+  PERCENTAGE: "PERCENTAGE",
+  FIXED: "FIXED"
+};
+
+// src/order/interface.ts
+var OrderStatusEnum = {
+  PENDING: "PENDING",
+  CONFIRMED: "CONFIRMED",
+  PROCESSING: "PROCESSING",
+  SHIPPED: "SHIPPED",
+  DELIVERED: "DELIVERED",
+  CANCELED: "CANCELED",
+  FAILED: "FAILED",
+  REFUNDED: "REFUNDED",
+  PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED"
+};
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/index.ts","../src/admin/interface.ts"],"sourcesContent":["export * from './address';\nexport * from './admin';\nexport * from './base';\nexport * from './common';\nexport * from './country';\nexport * from './customer';\nexport * from './state';\nexport * from './store';\nexport * from './currency';\nexport * from './contact';","import type { BaseEntity } from '../base/interface';\n\nexport type IAdminRoleType =\n    | 'Admin'\n    | 'Super Admin'\n    | 'Cashier'\n    | 'Manager'\n    | 'CEO'\n    | 'Driver'\n    | 'Security Guard'\n    | 'Accountant';\n\nexport const ADMIN_ROLES: IAdminRoleType[] = [\n    'Admin',\n    'Super Admin',\n    'Cashier',\n    'Manager',\n    'CEO',\n    'Driver',\n    'Security Guard',\n    'Accountant',\n];\n\nexport interface IAdmin extends BaseEntity {\n    firstName: string;\n    lastName: string;\n    email: string;\n    phoneNumber: string;\n    status: boolean;\n    password: string;\n    role: IAdminRoleType;\n    access_list: string[];\n    joiningDate: Date;\n    profileImage: string;\n    lastLogin: Date;\n}\n\nexport type IAdminCreate = Omit<IAdmin, keyof BaseEntity>;\nexport type IAdminUpdate = Partial<IAdminCreate>;\nexport type IAdminSafe = Omit<IAdmin, 'password'>;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACYO,IAAM,cAAgC;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;","names":[]}
+{"version":3,"sources":["../src/index.ts","../src/admin/interface.ts","../src/coupon/interface.ts","../src/order/interface.ts"],"sourcesContent":["export * from './address';\nexport * from './admin';\nexport * from './base';\nexport * from './common';\nexport * from './country';\nexport * from './customer';\nexport * from './state';\nexport * from './store';\nexport * from './currency';\nexport * from './contact';\nexport * from './coupon';\nexport * from './product';\nexport * from './variant';\nexport * from './order';\nexport * from './orderItem';","import type { BaseEntity } from '../base/interface';\n\nexport type IAdminRoleType =\n    | 'Admin'\n    | 'Super Admin'\n    | 'Cashier'\n    | 'Manager'\n    | 'CEO'\n    | 'Driver'\n    | 'Security Guard'\n    | 'Accountant';\n\nexport const ADMIN_ROLES: IAdminRoleType[] = [\n    'Admin',\n    'Super Admin',\n    'Cashier',\n    'Manager',\n    'CEO',\n    'Driver',\n    'Security Guard',\n    'Accountant',\n];\n\nexport interface IAdmin extends BaseEntity {\n    firstName: string;\n    lastName: string;\n    email: string;\n    phoneNumber: string;\n    status: boolean;\n    password: string;\n    role: IAdminRoleType;\n    access_list: string[];\n    joiningDate: Date;\n    profileImage: string;\n    lastLogin: Date;\n}\n\nexport type IAdminCreate = Omit<IAdmin, keyof BaseEntity>;\nexport type IAdminUpdate = Partial<IAdminCreate>;\nexport type IAdminSafe = Omit<IAdmin, 'password'>;\n","import type { BaseEntity } from \"../base\";\nimport type { IStore } from \"../store\";\n\nexport const DiscountTypeEnum = {\n    PERCENTAGE: \"PERCENTAGE\",\n    FIXED: \"FIXED\",\n} as const;\n\nexport type DiscountTypeEnum = (typeof DiscountTypeEnum)[keyof typeof DiscountTypeEnum];\n\nexport interface IDiscountType {\n    type: DiscountTypeEnum;\n    value: number;\n}\n\nexport interface ICoupon extends BaseEntity {\n    title: string;\n    couponCode: string;\n    startTime: Date;\n    endTime: Date;\n    discountType: IDiscountType;\n    minimumAmount: number;\n    isPromotional: boolean;\n    status: boolean;\n    store: IStore | string;\n}","import type { BaseEntity } from \"../base\";\nimport type { Metadata } from \"../common\";\nimport type { ICoupon } from \"../coupon\";\nimport type { ICustomer } from \"../customer\";\nimport type { IOrderItem } from \"../orderItem\";\nimport type { IStore } from \"../store\";\n\nexport const OrderStatusEnum = {\n    PENDING: \"PENDING\",\n    CONFIRMED: \"CONFIRMED\",\n    PROCESSING: \"PROCESSING\",\n    SHIPPED: \"SHIPPED\",\n    DELIVERED: \"DELIVERED\",\n    CANCELED: \"CANCELED\",\n    FAILED: \"FAILED\",\n    REFUNDED: \"REFUNDED\",\n    PARTIALLY_REFUNDED: \"PARTIALLY_REFUNDED\",\n} as const;\n\nexport type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];\n\nexport interface IOrder extends BaseEntity {\n    orderId: string;\n    orderItems: IOrderItem[];\n    user?: ICustomer;\n    coupon?: ICoupon;\n    store: IStore;\n    status: OrderStatusEnum;\n    subTotalAmount: number;\n    discountAmount: number;\n    totalAmount: number;\n    metaData: Metadata;\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACYO,IAAM,cAAgC;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;;;AClBO,IAAM,mBAAmB;AAAA,EAC5B,YAAY;AAAA,EACZ,OAAO;AACX;;;ACCO,IAAM,kBAAkB;AAAA,EAC3B,SAAS;AAAA,EACT,WAAW;AAAA,EACX,YAAY;AAAA,EACZ,SAAS;AAAA,EACT,WAAW;AAAA,EACX,UAAU;AAAA,EACV,QAAQ;AAAA,EACR,UAAU;AAAA,EACV,oBAAoB;AACxB;","names":[]}

package/dist/index.mjs

@@ -9,7 +9,28 @@ var ADMIN_ROLES = [
   "Security Guard",
   "Accountant"
 ];
+
+// src/coupon/interface.ts
+var DiscountTypeEnum = {
+  PERCENTAGE: "PERCENTAGE",
+  FIXED: "FIXED"
+};
+
+// src/order/interface.ts
+var OrderStatusEnum = {
+  PENDING: "PENDING",
+  CONFIRMED: "CONFIRMED",
+  PROCESSING: "PROCESSING",
+  SHIPPED: "SHIPPED",
+  DELIVERED: "DELIVERED",
+  CANCELED: "CANCELED",
+  FAILED: "FAILED",
+  REFUNDED: "REFUNDED",
+  PARTIALLY_REFUNDED: "PARTIALLY_REFUNDED"
+};
 export {
-  ADMIN_ROLES
+  ADMIN_ROLES,
+  DiscountTypeEnum,
+  OrderStatusEnum
 };
 //# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/admin/interface.ts"],"sourcesContent":["import type { BaseEntity } from '../base/interface';\n\nexport type IAdminRoleType =\n    | 'Admin'\n    | 'Super Admin'\n    | 'Cashier'\n    | 'Manager'\n    | 'CEO'\n    | 'Driver'\n    | 'Security Guard'\n    | 'Accountant';\n\nexport const ADMIN_ROLES: IAdminRoleType[] = [\n    'Admin',\n    'Super Admin',\n    'Cashier',\n    'Manager',\n    'CEO',\n    'Driver',\n    'Security Guard',\n    'Accountant',\n];\n\nexport interface IAdmin extends BaseEntity {\n    firstName: string;\n    lastName: string;\n    email: string;\n    phoneNumber: string;\n    status: boolean;\n    password: string;\n    role: IAdminRoleType;\n    access_list: string[];\n    joiningDate: Date;\n    profileImage: string;\n    lastLogin: Date;\n}\n\nexport type IAdminCreate = Omit<IAdmin, keyof BaseEntity>;\nexport type IAdminUpdate = Partial<IAdminCreate>;\nexport type IAdminSafe = Omit<IAdmin, 'password'>;\n"],"mappings":";AAYO,IAAM,cAAgC;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;","names":[]}
+{"version":3,"sources":["../src/admin/interface.ts","../src/coupon/interface.ts","../src/order/interface.ts"],"sourcesContent":["import type { BaseEntity } from '../base/interface';\n\nexport type IAdminRoleType =\n    | 'Admin'\n    | 'Super Admin'\n    | 'Cashier'\n    | 'Manager'\n    | 'CEO'\n    | 'Driver'\n    | 'Security Guard'\n    | 'Accountant';\n\nexport const ADMIN_ROLES: IAdminRoleType[] = [\n    'Admin',\n    'Super Admin',\n    'Cashier',\n    'Manager',\n    'CEO',\n    'Driver',\n    'Security Guard',\n    'Accountant',\n];\n\nexport interface IAdmin extends BaseEntity {\n    firstName: string;\n    lastName: string;\n    email: string;\n    phoneNumber: string;\n    status: boolean;\n    password: string;\n    role: IAdminRoleType;\n    access_list: string[];\n    joiningDate: Date;\n    profileImage: string;\n    lastLogin: Date;\n}\n\nexport type IAdminCreate = Omit<IAdmin, keyof BaseEntity>;\nexport type IAdminUpdate = Partial<IAdminCreate>;\nexport type IAdminSafe = Omit<IAdmin, 'password'>;\n","import type { BaseEntity } from \"../base\";\nimport type { IStore } from \"../store\";\n\nexport const DiscountTypeEnum = {\n    PERCENTAGE: \"PERCENTAGE\",\n    FIXED: \"FIXED\",\n} as const;\n\nexport type DiscountTypeEnum = (typeof DiscountTypeEnum)[keyof typeof DiscountTypeEnum];\n\nexport interface IDiscountType {\n    type: DiscountTypeEnum;\n    value: number;\n}\n\nexport interface ICoupon extends BaseEntity {\n    title: string;\n    couponCode: string;\n    startTime: Date;\n    endTime: Date;\n    discountType: IDiscountType;\n    minimumAmount: number;\n    isPromotional: boolean;\n    status: boolean;\n    store: IStore | string;\n}","import type { BaseEntity } from \"../base\";\nimport type { Metadata } from \"../common\";\nimport type { ICoupon } from \"../coupon\";\nimport type { ICustomer } from \"../customer\";\nimport type { IOrderItem } from \"../orderItem\";\nimport type { IStore } from \"../store\";\n\nexport const OrderStatusEnum = {\n    PENDING: \"PENDING\",\n    CONFIRMED: \"CONFIRMED\",\n    PROCESSING: \"PROCESSING\",\n    SHIPPED: \"SHIPPED\",\n    DELIVERED: \"DELIVERED\",\n    CANCELED: \"CANCELED\",\n    FAILED: \"FAILED\",\n    REFUNDED: \"REFUNDED\",\n    PARTIALLY_REFUNDED: \"PARTIALLY_REFUNDED\",\n} as const;\n\nexport type OrderStatusEnum = (typeof OrderStatusEnum)[keyof typeof OrderStatusEnum];\n\nexport interface IOrder extends BaseEntity {\n    orderId: string;\n    orderItems: IOrderItem[];\n    user?: ICustomer;\n    coupon?: ICoupon;\n    store: IStore;\n    status: OrderStatusEnum;\n    subTotalAmount: number;\n    discountAmount: number;\n    totalAmount: number;\n    metaData: Metadata;\n}\n"],"mappings":";AAYO,IAAM,cAAgC;AAAA,EACzC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACJ;;;AClBO,IAAM,mBAAmB;AAAA,EAC5B,YAAY;AAAA,EACZ,OAAO;AACX;;;ACCO,IAAM,kBAAkB;AAAA,EAC3B,SAAS;AAAA,EACT,WAAW;AAAA,EACX,YAAY;AAAA,EACZ,SAAS;AAAA,EACT,WAAW;AAAA,EACX,UAAU;AAAA,EACV,QAAQ;AAAA,EACR,UAAU;AAAA,EACV,oBAAoB;AACxB;","names":[]}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@fas-core/shared-types",
-    "version": "1.0.15",
+    "version": "1.0.17",
     "description": "FAS Core Shared Types - A collection of shared TypeScript types for the FAS Core SDK.",
     "author": "ibreakloops",
     "license": "UNLICENSED",