shopoflex-types 1.0.9 → 1.0.11

package/dist/types/common.d.ts

@@ -1,3 +1,19 @@
+export declare enum TemplateId {
+    TEMPLATE_1 = "template_1",
+    TEMPLATE_2 = "template_2",
+    TEMPLATE_3 = "template_3",
+    TEMPLATE_4 = "template_4",
+    TEMPLATE_5 = "template_5"
+}
+export declare enum OrderStatus {
+    Pending = "pending",
+    Cancelled = "cancelled",
+    Rejected = "rejected",
+    Refunded = "refunded",
+    Preparing = "preparing",
+    Delivering = "delivering",
+    Completed = "completed"
+}
 export interface FileType {
     previewUrl?: string;
     type?: string;
@@ -8,111 +24,26 @@ export interface FileType {
     url?: string;
     vendorId?: string;
 }
-export declare enum TemplateId {
-    TEMPLATE_1 = "template_1",
-    TEMPLATE_2 = "template_2",
-    TEMPLATE_3 = "template_3",
-    TEMPLATE_4 = "template_4",
-    TEMPLATE_5 = "template_5"
+export interface ILatLng {
+    lat: number;
+    lng: number;
 }
-export interface Vendor {
-    _id: string;
-    name: {
-        en: string;
-        ar: string;
-    };
-    domains: string[];
-    description: {
-        en: string;
-        ar: string;
-    };
-    logo: FileType;
-    cover: FileType[];
-    favicon: FileType;
-    font: {
-        en: any;
-        ar: any;
-    };
-    colors: {
-        primaryColor: string;
-        textColor: string;
-        bgColor: string;
-    };
-    countries: string[];
-    currencies: string[];
-    defaultCurrency: string;
-    integrations: {
-        loyaltyProgram: {
-            active: boolean;
-            started: boolean;
-        };
-    };
-    expiryDate: string;
-    defaultLanguage: string;
-    acceptedLanguages: string[];
-    numberOfDecimals: number;
-    email: string;
-    phone: string;
-    currency: string;
-    language: string;
-    country: string;
-    template: {
-        id: TemplateId;
-        name: {
-            en: string;
-            ar: string;
-        };
-        description: {
-            en: string;
-            ar: string;
-        };
-        link: string;
-        image: string;
-        isActive: boolean;
-    };
-    updateAt: Date;
-    createdAt: Date;
-    orderType: string[];
-    socialLinks: string[];
-    users: Array<unknown>;
-    areas: Record<string, unknown>;
-    payments: {
-        Cash: {
-            active: boolean;
-            status: string;
-            id: string;
-            key: string | null;
-            extra: string | null;
-            name: {
-                ar: string;
-                en: string;
-            };
-        };
-        posCard: {
-            active: boolean;
-            status: string;
-            id: string;
-            key: string | null;
-            extra: string | null;
-            name: {
-                ar: string;
-                en: string;
-            };
-        };
-        payByLink: {
-            active: boolean;
-            status: string;
-            id: string;
-            key: string | null;
-            extra: string | null;
-            name: {
-                ar: string;
-                en: string;
-            };
-        };
+export interface Address {
+    _id?: string;
+    id?: string;
+    location: {
+        lat: number;
+        lng: number;
     };
+    city?: string;
+    area?: string;
+    street?: string;
+    building?: string;
+    florr?: string;
+    country?: string;
+    details: string;
 }
-interface PriceModel {
+export interface PriceModel {
     price: number;
     discountedPrice?: number;
     finalPrice?: number;
@@ -121,7 +52,7 @@ interface PriceModel {
     minQuantity?: number;
     unit?: string;
 }
-interface Dimensions {
+export interface Dimensions {
     active: boolean;
     values?: {
         length: number | null;
@@ -130,17 +61,12 @@ interface Dimensions {
         weight: number | null;
     };
 }
-interface StockHandle {
+export interface StockHandle {
     active: boolean;
     stockQuantity: number;
     ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
 }
-interface StockHandle {
-    active: boolean;
-    stockQuantity: number;
-    ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
-}
-interface Label {
+export interface Label {
     featured: boolean;
     mostSelling: {
         criteria: string;
@@ -152,10 +78,33 @@ interface Label {
         active: boolean;
     };
 }
-interface Specification {
+export interface Specification {
     active: boolean;
     values: any[];
 }
+export interface AddonType {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    price: number;
+    enableQuantity?: boolean;
+    stockHandle: StockHandle;
+}
+export interface Modifier {
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    type?: "checkbox" | "radio" | "select";
+    required?: boolean;
+    maxSelect?: number;
+    minSelect?: number;
+    active?: boolean;
+    options?: AddonType[] | string[];
+    addons?: AddonType[] | string[];
+}
 export interface Category {
     _id: string;
     name: {
@@ -173,15 +122,6 @@ export interface Category {
     vendorId: string;
     createdAt: Date;
 }
-export interface CartState {
-    items: CartItem[];
-    subtotal: number;
-    totalQuantity: number;
-    discount: number;
-    delivery: number;
-    total: number;
-    promoCode?: Discount;
-}
 export interface ProductType {
     _id: string;
     name: {
@@ -210,74 +150,9 @@ export interface ProductType {
     vendorId?: any;
     createdAt?: string;
 }
-interface StockHandle {
-    active: boolean;
-    stockQuantity: number;
-    ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
-}
-export interface Modifier {
-    name?: {
-        en?: string;
-        ar?: string;
-    };
-    type?: "checkbox" | "radio" | "select";
-    required?: boolean;
-    maxSelect?: number;
-    minSelect?: number;
-    active?: boolean;
-    options?: AddonType[] | string[];
-    addons?: AddonType[] | string[];
-}
-export interface AddonType {
-    _id: string;
-    name: {
-        en: string;
-        ar: string;
-    };
-    price: number;
-    enableQuantity?: boolean;
-    stockHandle: StockHandle;
-}
-export interface PaymentDetails {
-    method: string;
-    status: string;
-    transactionId?: string;
-}
-export interface DeliveryDetails {
-    method: string;
-    status?: string;
-    estimatedDate?: Date;
-    trackingNumber?: string;
-}
-export interface Customer {
-    _id?: string;
-    uid?: string;
-    fullName?: string;
-    email?: string;
-    phone?: {
-        full?: string;
-        dial?: string;
-        number?: string;
-    };
-    updatedAt?: Date | number;
-    createdAt?: Date | number;
-    addresses?: Address[];
-    vendors?: string[];
-    isAnonymos?: boolean;
-}
-export interface Address {
-    _id?: string;
-    location: {
-        lat: number;
-        lng: number;
-    };
-    city?: string;
-    area?: string;
-    street?: string;
-    building?: string;
-    florr?: string;
-    country?: string;
-    details: string;
+export interface GroupedCategory {
+    categoryName: any;
+    products: ProductType[];
 }
 export interface sModifier {
     listName: string;
@@ -314,38 +189,35 @@ export interface Cart {
     delivery: number;
     total: number;
 }
+export interface CartState {
+    items: CartItem[];
+    subtotal: number;
+    totalQuantity: number;
+    discount: number;
+    delivery: number;
+    total: number;
+    promoCode?: Discount;
+}
 export interface CartModelType extends Cart {
     customer: Customer | any;
     vendorId: String | any;
 }
+export interface PaymentDetails {
+    method: string;
+    status: string;
+    transactionId?: string;
+}
+export interface DeliveryDetails {
+    method: string;
+    status?: string;
+    estimatedDate?: Date;
+    trackingNumber?: string;
+}
 export interface Shipping {
     method: string;
     cost?: number;
     trackingNumber?: string;
 }
-export interface Address {
-    id: string;
-    location: {
-        lat: number;
-        lng: number;
-    };
-    city?: string;
-    area?: string;
-    street?: string;
-    building?: string;
-    florr?: string;
-    country?: string;
-    details: string;
-}
-export declare enum OrderStatus {
-    Pending = "pending",
-    Cancelled = "cancelled",
-    Rejected = "rejected",
-    Refunded = "refunded",
-    Preparing = "preparing",
-    Delivering = "delivering",
-    Completed = "completed"
-}
 export interface OrderType {
     _id?: string | any;
     customer?: Customer;
@@ -360,26 +232,27 @@ export interface OrderType {
     updatedAt?: Date;
     orderNumber?: any;
 }
-interface VendorAssociation {
+export interface Customer {
+    _id?: string;
+    uid?: string;
+    fullName?: string;
+    email?: string;
+    phone?: {
+        full?: string;
+        dial?: string;
+        number?: string;
+    };
+    updatedAt?: Date | number;
+    createdAt?: Date | number;
+    addresses?: Address[];
+    vendors?: string[];
+    isAnonymos?: boolean;
+}
+export interface VendorAssociation {
     vendorId: string;
     role?: string;
     permissions?: string[];
 }
-export interface NotificationType {
-    _id?: any;
-    recipientId?: string;
-    recipientType?: 'vendor' | 'customer';
-    vendorId?: string;
-    type?: 'new_order' | 'order_update' | 'stock_alert' | 'product_update' | 'system_update';
-    title: string;
-    message?: string;
-    data?: any;
-    read: boolean;
-    readAt?: Date;
-    priority?: 'low' | 'medium' | 'high';
-    createdAt?: Date;
-    updatedAt?: Date;
-}
 export interface IUser {
     _id?: any;
     uid?: string;
@@ -394,6 +267,23 @@ export interface IUser {
     updatedAt?: Date;
     fcmTokens?: string[];
 }
+export interface CurrentUserType extends IUser {
+    vendors?: {
+        vendorId: string;
+        name: {
+            en: string;
+            ar: string;
+        };
+        logo: {
+            previewUrl: string;
+        };
+        description: {
+            en: string;
+            ar: string;
+        };
+    }[];
+    hasAccesstoVendor?: boolean;
+}
 export type IRole = {
     _id?: string;
     name?: {
@@ -402,11 +292,7 @@ export type IRole = {
     };
     permissions?: string[];
 };
-interface ILatLng {
-    lat: number;
-    lng: number;
-}
-interface IZone {
+export interface IZone {
     country: string;
     deliveryType: "distance" | "constant";
     deliveryRange: "radius" | "country";
@@ -416,17 +302,17 @@ interface IZone {
     center: ILatLng;
     markerPosition: ILatLng;
 }
-interface IDeliverySettings {
+export interface IDeliverySettings {
     zones: IZone[];
 }
-interface IPickupSettings {
+export interface IPickupSettings {
     enabled: boolean;
     instruction?: string;
 }
-interface IDineInSettings {
+export interface IDineInSettings {
     enabled: boolean;
 }
-interface IBranchName {
+export interface IBranchName {
     en: string;
     ar?: string;
 }
@@ -439,48 +325,92 @@ export interface IBranch {
     dineInSettings: IDineInSettings;
     createdAt?: Date;
 }
-export interface Address {
-    id: string;
-    location: {
-        lat: number;
-        lng: number;
+export interface Vendor {
+    _id?: string;
+    name: {
+        en: string;
+        ar: string;
     };
-    city?: string;
-    area?: string;
-    street?: string;
-    building?: string;
-    florr?: string;
-    country?: string;
-    details: string;
-}
-export interface SelectionsState {
-    address?: Address;
-    branch?: IBranch;
-    orderType?: "delivery" | "pickup" | "dinein";
-    paymentMethod?: "cash_on_delivery" | "card_on_delivery" | "wallet" | "credit_card";
-}
-export interface SelectionsState {
-    address?: Address;
-    branch?: IBranch;
-    deliveryType?: "delivery" | "pickup" | "dineIn";
-    paymentMethod?: "cash_on_delivery" | "card_on_delivery" | "wallet" | "credit_card";
-    promoCode?: string;
-    shippingMethod?: string;
-    time?: number;
-    validLocation?: boolean;
-}
-export interface GroupedCategory {
-    categoryName: any;
-    products: ProductType[];
-}
-export interface StoreState {
-    branches?: IBranch[];
-    groupedCategories?: {
-        [key: string]: GroupedCategory;
+    domains: string[];
+    description: {
+        en: string;
+        ar: string;
+    };
+    logo: FileType;
+    cover: FileType[];
+    favicon: FileType;
+    font: {
+        en: any;
+        ar: any;
+    };
+    colors: {
+        primaryColor: string;
+        textColor: string;
+        bgColor: string;
+    };
+    currencies: string[];
+    expiryDate: string;
+    numberOfDecimals: number;
+    email: string;
+    phone: string;
+    currency: string;
+    language: string;
+    country: string;
+    template: {
+        id: TemplateId;
+        name: {
+            en: string;
+            ar: string;
+        };
+        description: {
+            en: string;
+            ar: string;
+        };
+        link: string;
+        image: string;
+        isActive: boolean;
+    };
+    updateAt: Date;
+    createdAt: Date;
+    orderType: string[];
+    socialLinks: string[];
+    users: Array<unknown>;
+    areas: Record<string, unknown>;
+    payments: {
+        Cash: {
+            active: boolean;
+            status: string;
+            id: string;
+            key: string | null;
+            extra: string | null;
+            name: {
+                ar: string;
+                en: string;
+            };
+        };
+        posCard: {
+            active: boolean;
+            status: string;
+            id: string;
+            key: string | null;
+            extra: string | null;
+            name: {
+                ar: string;
+                en: string;
+            };
+        };
+        payByLink: {
+            active: boolean;
+            status: string;
+            id: string;
+            key: string | null;
+            extra: string | null;
+            name: {
+                ar: string;
+                en: string;
+            };
+        };
     };
-    allProducts?: ProductType[];
-    allCategories?: Category[];
-    loading?: boolean;
 }
 export interface Discount {
     _id: string;
@@ -503,21 +433,38 @@ export interface Discount {
     expiryDate?: Date;
     createdAt: Date;
 }
-export interface CurrentUserType extends IUser {
-    vendors?: {
-        vendorId: string;
-        name: {
-            en: string;
-            ar: string;
-        };
-        logo: {
-            previewUrl: string;
-        };
-        description: {
-            en: string;
-            ar: string;
-        };
-    }[];
-    hasAccesstoVendor?: boolean;
+export interface NotificationType {
+    _id?: any;
+    recipientId?: string;
+    recipientType?: 'vendor' | 'customer';
+    vendorId?: string;
+    type?: 'new_order' | 'order_update' | 'stock_alert' | 'product_update' | 'system_update';
+    title: string;
+    message?: string;
+    data?: any;
+    read: boolean;
+    readAt?: Date;
+    priority?: 'low' | 'medium' | 'high';
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface SelectionsState {
+    address?: Address;
+    branch?: IBranch;
+    orderType?: "delivery" | "pickup" | "dinein";
+    deliveryType?: "delivery" | "pickup" | "dineIn";
+    paymentMethod?: "cash_on_delivery" | "card_on_delivery" | "wallet" | "credit_card";
+    promoCode?: string;
+    shippingMethod?: string;
+    time?: number;
+    validLocation?: boolean;
+}
+export interface StoreState {
+    branches?: IBranch[];
+    groupedCategories?: {
+        [key: string]: GroupedCategory;
+    };
+    allProducts?: ProductType[];
+    allCategories?: Category[];
+    loading?: boolean;
 }
-export {};

package/dist/types/common.js

@@ -1,4 +1,7 @@
 "use strict";
+// =============================================================================
+// ENUMS
+// =============================================================================
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.OrderStatus = exports.TemplateId = void 0;
 var TemplateId;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shopoflex-types",
-  "version": "1.0.9",
+  "version": "1.0.11",
   "description": "Shared TypeScript types for Shopoflex applications",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",