@lmnto/h-mall-shared 1.0.1

package/shared/types/order.ts

@@ -0,0 +1,332 @@
+import { CashBack } from "./shoppingCart";
+
+export enum OrderItemStatusEnum {
+  PENDING = "pending",
+  PURCHASED = "purchased",
+  CANCELLED = "cancelled",
+  REFUNDED = "refunded",
+  FAILED = "failed",
+}
+
+export interface IOrderItems {
+  name: string;
+  featureImage: string;
+  quantity: number;
+  price: number;
+  discount: number;
+  categoryCode: string;
+  shipmentStatus: string;
+  categoryId: number;
+  categoryName: string;
+  totalCostOfShipment: string;
+  oneCareIncluded?: boolean;
+  sku?: string;
+  utilityToken?: string;
+  smartPayPercentage?: string;
+  smartPayOriginalPrice?: string;
+  isReturned?: boolean;
+  shipmentItem?: {
+    name: string;
+
+    featureImage: string;
+    quantity: number;
+    price: number;
+    categoryCode: string;
+    categoryId: number;
+    categoryName: string;
+    shipmentStatus?: string;
+
+    orderItem?: {
+      name: string;
+      featureImage: string;
+      quantity: number;
+      price: number;
+      categoryCode: string;
+      categoryId: number;
+      categoryName: string;
+    };
+  };
+  shipmentItems?: {
+    name: string;
+    shipmentItemIdentifier?: string;
+
+    featureImage: string;
+    quantity: number;
+    price: number;
+    categoryCode: string;
+    categoryId: number;
+    categoryName: string;
+    shipmentStatus?: string;
+
+    orderItem?: {
+      name: string;
+      featureImage: string;
+      quantity: number;
+      price: number;
+      categoryCode: string;
+      categoryId: number;
+      categoryName: string;
+    };
+  }[];
+  enforcedShippingItems?: {
+    name: string;
+    featureImage: string;
+    quantity: number;
+    price: number;
+    categoryCode: string;
+    categoryId: number;
+    categoryName: string;
+    shipmentStatus?: string;
+
+    orderItem?: {
+      name: string;
+      featureImage: string;
+      quantity: number;
+      price: number;
+      categoryCode: string;
+      categoryId: number;
+      categoryName: string;
+    };
+  }[];
+  kitData?: kitItem[];
+  isUpgradable?: boolean;
+  status: OrderItemStatusEnum;
+  unitPrice?: number;
+  unitDiscount?: number;
+  nlkAllocationsPerUnit?: number;
+  unitOriginalPrice?: number;
+}
+
+export type kitItem = {
+  name: string;
+  shipmentItemIdentifier: string;
+  shipmentStatus: string;
+  categoryName?: string;
+};
+
+export type IOrderPaymentMethod = {
+  id: number;
+  code: string;
+  name: string;
+};
+
+export type IOrderBillingAddress = {
+  id: number;
+  city: string;
+  email: string;
+  phone: string;
+  state: string;
+  address: string;
+  buildingInfo: string;
+  type: string;
+  country: {
+    name: string;
+    code: string;
+    flag: string;
+  };
+  lastName: string;
+  latitude: string;
+  firstName: string;
+  longitude: string;
+  postalCode: string;
+  countryCode: string;
+};
+
+export type IAssetOption = {
+  id: number;
+  cartId: number;
+  createdAt: Date;
+  updatedAt: Date;
+  assetOption: {
+    id: number;
+    name: string;
+    symbol: string;
+    isActive: boolean;
+    optionId: number;
+    provider: string;
+    createdAt: Date;
+    deletedAt: null;
+    isDeleted: boolean;
+    updatedAt: Date;
+    isVariable: boolean;
+    optionName: string;
+    displayOrder: number;
+    optionSymbol: string;
+    isAssetActive: true;
+    minPercentage: number;
+    optionIsActive: boolean;
+    paymentMethodId: number;
+    isCommissionEnabled: boolean;
+    commissionMultiplier: {
+      base: {
+        cv: number;
+        vp: number;
+      };
+      option: {
+        cv: number;
+        vp: number;
+      };
+    };
+  };
+  baseAssetName: string;
+  baseAssetAmount: string;
+  baseAssetSymbol: string;
+  optionAssetName: string;
+  optionAssetAmount: number;
+  optionAssetSymbol: string;
+  baseAssetPercentage: number;
+  calculatedCommision: {
+    base: {
+      cv: number;
+      vp: number;
+    };
+    option: {
+      cv: number;
+      vp: number;
+    };
+    totalCV: number;
+    totalVP: number;
+  };
+  optionAssetPercentage: number;
+};
+
+export interface IOrder {
+  id: number;
+  orderId: string;
+  shipmentOrderId?: string;
+  orderItems?: IOrderItems[];
+  orderUpgrades?: OrderUpgrade[];
+  shipmentOrderItems?: IOrderItems[];
+  paymentMethod: IOrderPaymentMethod;
+  billingAddress: IOrderBillingAddress;
+  shippingAddress?: IOrderBillingAddress;
+  shippingMethod?: ShippingMethod;
+  store?: Store;
+  paymentBillingAddress: IOrderBillingAddress;
+  subTotal: number;
+  vatTotal: number;
+  grandTotal: number;
+  feesTotal: number;
+  taxTotal: number;
+  discountTotal: number;
+  shippingTotal: number;
+  status: string;
+  paymentStatus: string;
+  createdAt: Date;
+  updatedAt: Date;
+  assetOption: IAssetOption;
+  fees: Fee[];
+  taxes: Tax[];
+  isSmartPay?: boolean;
+  isUpgradable?: boolean;
+  cashBacks?: CashBack[];
+  orderInvoice?: ShipmentOrderInvoice;
+  shipmentOrderInvoice?: ShipmentOrderInvoice;
+  enforcedShipping: boolean;
+  productBoost?: string;
+  isUpgrade: boolean;
+  isSoftwareOnly?: boolean;
+  creditNotes?: CreditNote[];
+}
+
+type CreditNote = {
+  id: number;
+  identifier: string;
+  createdFor: "order" | "shipment"; // Using union type for specific values
+  type: "refund" | string; // Add other possible types if needed
+  createdAt: string;
+  updatedAt: string;
+  creditNoteInvoiceFileName: string;
+  orderId: number;
+  shipmentOrderId: number | null;
+  creditNoteInvoiceUrl: string;
+};
+
+type ShipmentOrderInvoice = {
+  createdAt: string;
+  id: number;
+  invoiceFileName: string | null;
+  invoiceSequenceNumber: number;
+  invoiceUrl: string | null;
+  shipmentOrderId: number;
+  updatedAt: string;
+};
+
+type Fee = {
+  amount: string;
+  cartId: number;
+  feeCategory: string;
+  feeName: string;
+  id: number;
+  type: string;
+  value: string;
+};
+
+export type OrderUpgrade = {
+  id: string;
+  userBID: string;
+  legacyOrderIdentifier: string;
+  legacyOrderId: number;
+  legacyOrderItemId: number;
+  sku: string;
+  orderId: string | null;
+  isUpgraded: boolean;
+  createdAt: string;
+  updatedAt: string;
+  status: string;
+};
+
+type Tax = {
+  amount: string;
+  cartId: number;
+  id: number;
+  taxCategory: string;
+  taxName: string;
+  type: string;
+  value: string;
+};
+
+export type ShippingMethod = {
+  code: string;
+  description: string;
+  displayName: string;
+
+  createdAt?: string | null;
+  deletedAt?: string | null;
+  id?: number;
+  isActive?: boolean;
+  isDeleted?: boolean;
+  isDisplay?: boolean;
+  updatedAt?: string | null;
+};
+
+export type Store = {
+  address: string;
+  buildingInfo: string;
+  city: String;
+  countryId: number;
+  createdAt: string | null;
+  deletedAt: null;
+  id: 1;
+  isActive: true;
+  isDeleted: false;
+  name: string;
+  pickupFee: string;
+  state: string;
+  updatedAt: string | null;
+  zipCode: string | null;
+  country: ICountryCity;
+};
+export class ICountryCity {
+  id?: number;
+  name: string;
+  countryId: number;
+  country: string;
+  state: string;
+  stateId: number;
+  isActive?: boolean;
+  isDeleted?: boolean;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date;
+}

package/shared/types/pagination.ts

@@ -0,0 +1,5 @@
+export type PaginationQueryParam = {
+  page: number;
+  limit: number;
+  sort?: string;
+};

package/shared/types/payments.ts

@@ -0,0 +1,68 @@
+import { PAYMENTS_TYPE } from "@hms/packages/shared/constants/app";
+
+export type PaymentsMethod = {
+  code: string;
+  createdAt: string;
+  deletedAt: string;
+  displayOrder: number;
+  id: number;
+  isActive: boolean;
+  isDeleted: boolean;
+  isVariable: boolean;
+  name: string;
+  provider: string;
+  updatedAt: string;
+  paymentFees: Fee[];
+};
+
+type Fee = {
+  amount: string;
+  feeCategory: string;
+  name: string;
+  id: number;
+  type: string;
+  value: string;
+};
+
+export type Asset = {
+  code: string;
+  symbol: string;
+  displayOrder: number;
+  balance: number;
+  paymentMethodId: number;
+  id: number;
+  isVariable: boolean;
+  name: string;
+  options: Option[];
+};
+
+export type Option = {
+  id: number;
+  name: string;
+  symbol: string;
+  isActive: boolean;
+  minPercentage: number;
+  commissions: Commission;
+  balance: number;
+  restricted: {
+    status: boolean;
+    msg: string;
+  };
+} & {
+  currentPercentage?: number;
+};
+
+export type Commission = {
+  base: {
+    cv: number;
+    vp: number;
+  };
+  option: {
+    cv: number;
+    vp: number;
+  };
+  totalCV: number;
+  totalVP: number;
+};
+
+export type PaymentType = (typeof PAYMENTS_TYPE)[keyof typeof PAYMENTS_TYPE];

package/shared/types/product.ts

@@ -0,0 +1,54 @@
+export interface IProduct {
+  productId: number;
+  productName: string;
+  productSku: string;
+  categoryCode: string;
+  categoryId: number;
+  specification: string;
+  details: string;
+  features: string;
+  overview: string;
+  isDisplay: boolean;
+  price: number;
+  smartPayAmount?: number;
+  estimatedDeliveryCost?: number;
+  utilityToken?: number;
+  featureImage: string;
+  isActive: boolean;
+  isProductPurchasable: boolean;
+  categoryName: string;
+  mainProductCategory: number;
+  subProducts?: SubProduct[];
+  tags: string[];
+  images: string[];
+  maxCartQuantity: number | null;
+  smartPayPercentage?: number;
+  quantityStepper?: number | null;
+}
+
+export interface SubProduct {
+  productId: number;
+  productName: string;
+  productCategory: number;
+  categoryCode: string;
+  productMetadata: ProductMetadata[];
+}
+
+export interface ProductMetadata {
+  key?: string;
+  value?: string;
+  displayName?: string;
+}
+
+export interface IProductPurchaseLimit {
+  userPurchaseLimit: number;
+  canUserPurchaseTheProduct: boolean;
+  totalOrderExistsForProduct: number;
+  maximumUserCanPurchase: number;
+}
+
+export type BoostPowerProps = {
+  boost: number;
+  validFrom: string;
+  validTo: string;
+};

package/shared/types/shoppingCart.ts

@@ -0,0 +1,219 @@
+import { Store } from "./order";
+import { Commission } from "./payments";
+
+export interface IShoppingCart {
+  userBID: string;
+  reference: string;
+  shippingCartProducts: any[];
+  billingAddressId: number | null;
+  shippingAddressId: number | null;
+  storeId: number | null;
+  paymentMethodId: number | null;
+  id: number;
+  cartState: string;
+  subTotal: string;
+  feesTotal: string;
+  taxTotal: string;
+  grandTotal: string;
+  isActive: boolean;
+  createdAt: string;
+  updatedAt: string;
+  fees: Fee[];
+  taxes: Tax[];
+  cartAsset: CartAsset;
+  store?: Store;
+  cashBacks?: null | CashBack[];
+  isSmartPay?: boolean;
+
+  commissionSubTotal: string;
+  oneCareTotal: string;
+  orderId: string;
+  pickupCostTotal: string;
+  shippingCartAssetId: string;
+  shippingMethodId: number;
+  shippingMethod: ShippingMethod;
+  shippingCostTotal: string;
+  upgradeCostTotal: string;
+  userSubscriptionType: string;
+  shippingAddress: UserAddress;
+  billingAddress: UserAddress;
+  paymentMethod: {
+    code: string;
+    id: number;
+    name: string;
+  };
+
+  shippingCartAsset: CartAsset;
+}
+
+type ShippingMethod = {
+  code: string;
+  description: string;
+  displayName: string;
+};
+type CartAsset = {
+  id: number;
+  cartId: number;
+  assetOption: {
+    id: number;
+    name: string;
+    symbol: string;
+    isActive: boolean;
+    optionId: number;
+    provider: string;
+    createdAt: string;
+    deletedAt: string;
+    isDeleted: boolean;
+    updatedAt: string;
+    isVariable: boolean;
+    optionName: string;
+    displayOrder: number;
+    optionSymbol: string;
+    isAssetActive: boolean;
+    minPercentage: number;
+    optionIsActive: boolean;
+    paymentMethodId: number;
+    isCommissionEnabled: boolean;
+    commissionMultiplier: {
+      base: {
+        cv: number;
+        vp: number;
+      };
+      option: {
+        cv: number;
+        vp: number;
+      };
+    };
+  };
+  calculatedCommision: Commission;
+  baseAssetName: string;
+  baseAssetSymbol: string;
+  baseAssetAmount: number;
+  baseAssetPercentage: number;
+  optionAssetName: string;
+  optionAssetSymbol: string;
+  optionAssetAmount: number;
+  optionAssetPercentage: string;
+  createdAt: string;
+  updatedAt: string;
+};
+type Fee = {
+  amount: string;
+  cartId: number;
+  feeCategory: string;
+  feeName: string;
+  id: number;
+  type: string;
+  value: string;
+};
+type Tax = {
+  amount: string;
+  cartId: number;
+  id: number;
+  taxCategory: string;
+  taxName: string;
+  type: string;
+  value: string;
+};
+
+export type CashBack = {
+  id: number;
+  shippingCartId: number;
+  assetName: string;
+  assetSymbol: string;
+  cashbackAssetId: number;
+  totalAmount: string;
+};
+
+export type cartProduct = {
+  id: number;
+  sku: string;
+  name: string;
+  featureImage: string;
+  category: cartProductCategory;
+  price: number;
+  canProductBeRemoved: boolean;
+  canUserPurchaseTheProduct: boolean;
+  feedBackMessage: string;
+  maximumUserCanPurchase: number | null;
+  totalOrderExistsForProduct: number | null;
+  userPurchaseLimit: number | null;
+  notAllowedShippingMethods?: string[];
+};
+
+export type cartProductCategory = {
+  id: number;
+  code: string;
+  name: string;
+};
+
+export type CartTableItemComponentProps = {
+  id: number;
+  product: cartProduct;
+  quantity: number;
+  cartProducts: number;
+  userPurchaseLimit: number | null;
+  maximumUserCanPurchase: number | null;
+  totalOrderExistsForProduct: number | null;
+  feedBackMessage: string;
+  canUserPurchaseTheProduct: boolean;
+  canProductBeRemoved: boolean;
+};
+
+export type BillingAddress = {
+  address: string;
+  buildingInfo: string;
+  city: string;
+  country: string;
+  countryId: number;
+  createdAt: string;
+  deletedAt: string;
+  id: number;
+  isActive: boolean;
+  isDefault: boolean;
+  isDeleted: boolean;
+  latitude: string;
+  longitude: string;
+  state: string;
+  type: string;
+  updatedAt: string;
+  userId: number;
+};
+export type UserAddress = {
+  id: number;
+  userBID: string;
+  firstName: string;
+  lastName: string;
+  phone: string;
+  email: string;
+  countryId: 3;
+  countryCode: string;
+  city: string;
+  state: string;
+  postalCode: string;
+  address: string;
+  buildingInfo: string;
+  latitude: string;
+  longitude: string;
+  type: string;
+  isDefault: boolean;
+  isActive: boolean;
+  isDeleted: boolean;
+  createdAt: string;
+  updatedAt: string;
+  deletedAt: string;
+  country: {
+    id: 3;
+    name: string;
+    code: string;
+    alphaCode: string;
+    callingCode: string;
+    zipCodeExists: boolean;
+    zipCodeRegex: string;
+    isActive: boolean;
+    isDeleted: boolean;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string;
+  };
+};