@fas-core/shared-types 1.0.18 → 1.0.20

package/dist/index.d.mts

@@ -98,7 +98,59 @@ interface SoftDeleteFilter {
     isDeleted?: boolean;
     deletedAt?: Date | null;
 }
+
 type Metadata = Record<string, unknown>;
+interface ISEOMetaData {
+    title: string;
+    description: string;
+    keywords: string[];
+    headerTag: string;
+    canonicalUrl: string;
+}
+interface IPrice {
+    price: number;
+    originalPrice: number;
+    discount: number;
+}
+interface ITechSpec {
+    key: string;
+    label: string;
+    value: string | number;
+}
+interface IShipping {
+    weightLb: number;
+    weightKg: number;
+    lengthIn: number;
+    lengthMm: number;
+    widthIn: number;
+    widthMm: number;
+    heightIn: number;
+    heightMm: number;
+}
+interface ICompliance {
+    eccn: string;
+    hts: number;
+    unspsc: number;
+    taa: string;
+    stratCode: string;
+}
+interface IDocumentation {
+    warranty: string[];
+    infographics: string[];
+    environment: string[];
+}
+interface IContent {
+    overview: string;
+    expertNote: string;
+    keyFeatures: string[];
+    applications: string;
+}
+interface IRelationships {
+    similarProducts: string[];
+    parts: string[];
+    accessories: string[];
+    toolKits: string[];
+}
 
 interface ICurrency extends BaseEntity {
     name: string;
@@ -112,8 +164,10 @@ interface ICurrency extends BaseEntity {
 interface IStoreSettings {
     logo: string;
     theme: 'light' | 'dark';
+    favicon: string;
     timezone: string;
     requireCustomerLogin: boolean;
+    seoMetaData: ISEOMetaData;
 }
 interface IStore extends BaseEntity {
     name: string;
@@ -168,12 +222,48 @@ interface ICoupon extends BaseEntity {
 interface IVariant extends BaseEntity {
     name: string;
     sku: string;
-    attributes: Record<string, string>;
-    price: number;
-    stock: number;
+    slug: string;
     product: IProduct;
     status: boolean;
     metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
+interface ICategory extends BaseEntity {
+    name: string;
+    slug: string;
+    description: string;
+    parent: ICategory;
+    store: IStore;
+    image: string;
+    status: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+    subCategories?: ICategory[];
+}
+
+interface IBrand extends BaseEntity {
+    name: string;
+    slug: string;
+    description: string;
+    logo: string;
+    store: IStore;
+    status: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
+type StockStatus = "IN_STOCK" | "LOW_STOCK" | "OUT_OF_STOCK";
+interface IStock extends BaseEntity {
+    sku: string;
+    product: IProduct;
+    variant: IVariant | null;
+    store: IStore;
+    quantity: number;
+    reserved: number;
+    available: number;
+    status: StockStatus;
+    lowStockThreshold: number;
 }
 
 interface IProduct extends BaseEntity {
@@ -181,10 +271,28 @@ interface IProduct extends BaseEntity {
     slug: string;
     sku: string;
     description: string;
-    price: number;
-    variants: IVariant[];
+    price: IPrice;
+    quantity: number;
+    brand: IBrand;
     store: IStore;
+    stock: IStock;
+    variants: IVariant[];
+    category: ICategory;
+    categories: ICategory[];
+    images: string[];
+    videos: string[];
+    documentation: IDocumentation;
+    techSpecs: ITechSpec[];
+    physical: ITechSpec[];
+    shipping: IShipping;
+    compliance: ICompliance;
+    features: string[];
+    content: IContent;
+    origin: string;
+    returnable: boolean;
+    relationships: IRelationships;
     metaData: Metadata;
+    seoMetaData: ISEOMetaData;
     status: boolean;
 }
 
@@ -252,4 +360,4 @@ interface ICart extends BaseEntity {
     totalAmount: number;
 }
 
-export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type ICart, type ICartItem, 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 };
+export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IBrand, type ICart, type ICartItem, type ICategory, type ICompliance, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IOrder, type IOrderItem, type IPrice, type IProduct, type IRelationships, type ISEOMetaData, type IShipping, type IState, type IStock, type IStore, type IStoreSettings, type ITechSpec, type IVariant, type Metadata, OrderStatusEnum, type Paginated, type SoftDeleteFilter, type StockStatus };

package/dist/index.d.ts

@@ -98,7 +98,59 @@ interface SoftDeleteFilter {
     isDeleted?: boolean;
     deletedAt?: Date | null;
 }
+
 type Metadata = Record<string, unknown>;
+interface ISEOMetaData {
+    title: string;
+    description: string;
+    keywords: string[];
+    headerTag: string;
+    canonicalUrl: string;
+}
+interface IPrice {
+    price: number;
+    originalPrice: number;
+    discount: number;
+}
+interface ITechSpec {
+    key: string;
+    label: string;
+    value: string | number;
+}
+interface IShipping {
+    weightLb: number;
+    weightKg: number;
+    lengthIn: number;
+    lengthMm: number;
+    widthIn: number;
+    widthMm: number;
+    heightIn: number;
+    heightMm: number;
+}
+interface ICompliance {
+    eccn: string;
+    hts: number;
+    unspsc: number;
+    taa: string;
+    stratCode: string;
+}
+interface IDocumentation {
+    warranty: string[];
+    infographics: string[];
+    environment: string[];
+}
+interface IContent {
+    overview: string;
+    expertNote: string;
+    keyFeatures: string[];
+    applications: string;
+}
+interface IRelationships {
+    similarProducts: string[];
+    parts: string[];
+    accessories: string[];
+    toolKits: string[];
+}
 
 interface ICurrency extends BaseEntity {
     name: string;
@@ -112,8 +164,10 @@ interface ICurrency extends BaseEntity {
 interface IStoreSettings {
     logo: string;
     theme: 'light' | 'dark';
+    favicon: string;
     timezone: string;
     requireCustomerLogin: boolean;
+    seoMetaData: ISEOMetaData;
 }
 interface IStore extends BaseEntity {
     name: string;
@@ -168,12 +222,48 @@ interface ICoupon extends BaseEntity {
 interface IVariant extends BaseEntity {
     name: string;
     sku: string;
-    attributes: Record<string, string>;
-    price: number;
-    stock: number;
+    slug: string;
     product: IProduct;
     status: boolean;
     metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
+interface ICategory extends BaseEntity {
+    name: string;
+    slug: string;
+    description: string;
+    parent: ICategory;
+    store: IStore;
+    image: string;
+    status: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+    subCategories?: ICategory[];
+}
+
+interface IBrand extends BaseEntity {
+    name: string;
+    slug: string;
+    description: string;
+    logo: string;
+    store: IStore;
+    status: boolean;
+    metaData: Metadata;
+    seoMetaData: ISEOMetaData;
+}
+
+type StockStatus = "IN_STOCK" | "LOW_STOCK" | "OUT_OF_STOCK";
+interface IStock extends BaseEntity {
+    sku: string;
+    product: IProduct;
+    variant: IVariant | null;
+    store: IStore;
+    quantity: number;
+    reserved: number;
+    available: number;
+    status: StockStatus;
+    lowStockThreshold: number;
 }
 
 interface IProduct extends BaseEntity {
@@ -181,10 +271,28 @@ interface IProduct extends BaseEntity {
     slug: string;
     sku: string;
     description: string;
-    price: number;
-    variants: IVariant[];
+    price: IPrice;
+    quantity: number;
+    brand: IBrand;
     store: IStore;
+    stock: IStock;
+    variants: IVariant[];
+    category: ICategory;
+    categories: ICategory[];
+    images: string[];
+    videos: string[];
+    documentation: IDocumentation;
+    techSpecs: ITechSpec[];
+    physical: ITechSpec[];
+    shipping: IShipping;
+    compliance: ICompliance;
+    features: string[];
+    content: IContent;
+    origin: string;
+    returnable: boolean;
+    relationships: IRelationships;
     metaData: Metadata;
+    seoMetaData: ISEOMetaData;
     status: boolean;
 }
 
@@ -252,4 +360,4 @@ interface ICart extends BaseEntity {
     totalAmount: number;
 }
 
-export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type ICart, type ICartItem, 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 };
+export { ADMIN_ROLES, type ApiResponse, type BaseEntity, DiscountTypeEnum, type IAddress, type IAdmin, type IAdminCreate, type IAdminRoleType, type IAdminSafe, type IAdminUpdate, type IBrand, type ICart, type ICartItem, type ICategory, type ICompliance, type IContact, type IContent, type ICountry, type ICoupon, type ICurrency, type ICustomer, type IDiscountType, type IDocumentation, type IOrder, type IOrderItem, type IPrice, type IProduct, type IRelationships, type ISEOMetaData, type IShipping, type IState, type IStock, type IStore, type IStoreSettings, type ITechSpec, type IVariant, type Metadata, OrderStatusEnum, type Paginated, type SoftDeleteFilter, type StockStatus };

package/dist/index.js.map

@@ -1 +1 @@
-{"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';\nexport * from './cart';\nexport * from './cartItem';","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":[]}
+{"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';\nexport * from './cart';\nexport * from './cartItem';\nexport * from './category';\nexport * from './brand';\nexport * from './stock';","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/package.json

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