shopoflex-types 1.0.39 → 1.0.41

package/dist/types/order.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/order.ts
+// Order and payment types
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/prods.d.ts

@@ -0,0 +1,294 @@
+import { FileType, PriceModel, Dimensions, StockHandle } from './common';
+import { Discount } from './discount';
+import { Customer } from './user';
+export interface Label {
+    featured: boolean;
+    mostSelling: {
+        criteria: string;
+        active: boolean;
+    };
+    newRelease: {
+        criteria: string;
+        period: number;
+        active: boolean;
+    };
+}
+export interface Specification {
+    active: boolean;
+    values: any[];
+}
+export type CustomerDataFieldType = 'text' | 'textarea' | 'number' | 'date' | 'checkbox' | 'radio' | 'select' | 'file_upload' | 'email' | 'phone';
+export interface CustomerDataField {
+    fieldId: string;
+    label: {
+        en: string;
+        ar: string;
+    };
+    type: CustomerDataFieldType;
+    required: boolean;
+    placeholder?: {
+        en?: string;
+        ar?: string;
+    };
+    helpText?: {
+        en?: string;
+        ar?: string;
+    };
+    options?: {
+        value: string;
+        label: {
+            en: string;
+            ar: string;
+        };
+    }[];
+    validation?: {
+        minLength?: number;
+        maxLength?: number;
+        min?: number;
+        max?: number;
+        pattern?: string;
+        fileTypes?: string[];
+        maxFileSize?: number;
+        maxFiles?: number;
+    };
+    pricing?: {
+        type: 'fixed' | 'per_character' | 'per_word' | 'conditional';
+        basePrice?: number;
+        conditionalPricing?: {
+            condition: string;
+            price: number;
+        }[];
+    };
+    sortOrder: number;
+    isActive: boolean;
+}
+export interface CustomerDataValue {
+    fieldId: string;
+    value: any;
+    files?: FileType[];
+    additionalPrice?: number;
+}
+export type AttributeType = 'color' | 'size' | 'material' | 'storage' | 'weight' | 'dimension' | 'style' | 'brand' | 'model';
+export interface ProductAttribute {
+    type: AttributeType;
+    value: string | number;
+    displayValue?: {
+        en: string;
+        ar: string;
+    };
+}
+export interface ProductVariant {
+    variantId: string;
+    sku: string;
+    attributes: Record<string, ProductAttribute>;
+    priceModifier: number;
+    stockHandle: StockHandle;
+    images?: FileType[];
+    isActive: boolean;
+    sort?: number;
+    barcode?: string;
+}
+export interface AddonType {
+    _id: any;
+    name: {
+        en: string;
+        ar: string;
+    };
+    price: number;
+    stockHandle?: StockHandle;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface Modifier {
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    type?: "checkbox" | "radio" | "select";
+    required?: boolean;
+    maxSelect?: number;
+    minSelect?: number;
+    active?: boolean;
+    addons?: {
+        addonId: string;
+        enableQuantity?: boolean;
+        priceOverride?: number;
+    }[];
+}
+export interface Category {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description: {
+        en: string;
+        ar: string;
+    };
+    parentCategoryId?: string | null;
+    createdAt: Date;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+}
+export interface ProductType {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description?: {
+        en: string;
+        ar: string;
+    };
+    sku?: string;
+    categoriesIds: any[];
+    dimensions?: Dimensions;
+    priceModel: PriceModel;
+    variants: ProductVariant[];
+    hasVariants: boolean;
+    variantsGroupOrder?: string[];
+    reviewSummary?: ReviewSummary;
+    allowReviews?: boolean;
+    customerDataFields?: CustomerDataField[];
+    hasCustomerData?: boolean;
+    tags?: string[];
+    branchesIds?: string[];
+    modifiers?: Modifier[];
+    hasModifiers?: boolean;
+    label?: Label;
+    sort?: number;
+    specifications?: Specification;
+    linkedProduct?: any;
+    createdAt?: Date;
+    updatedAt?: Date;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+}
+export interface GroupedCategory {
+    categoryName: any;
+    products: ProductType[];
+}
+export interface sModifier {
+    listName: string;
+    options: {
+        addonId: string;
+        optionName: string;
+        price: number;
+        quantity: number;
+    }[];
+    total: number;
+}
+export interface CartItem {
+    _id?: string;
+    productId: string;
+    categoriesIds: string[];
+    selectedVariant: {
+        variantId: string;
+        sku: string;
+        attributes: Record<string, any>;
+        price: number;
+    };
+    quantity: number;
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    selectedModifiers?: {
+        lists?: sModifier[];
+        overallTotal?: number;
+    };
+    customerData?: CustomerDataValue[];
+    customerDataTotal?: number;
+    finalPrice?: number;
+    files?: FileType[];
+    customData?: Record<string, any>;
+}
+export interface Cart {
+    _id?: string;
+    items: CartItem[];
+    subtotal: number;
+    totalQuantity: number;
+    discount: number;
+    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;
+    _id?: string;
+    items: CartItem[];
+    subtotal: number;
+    totalQuantity: number;
+    discount: number;
+    delivery: number;
+    total: number;
+}
+export interface ProductReview {
+    _id: string;
+    productId: string;
+    variantId?: string;
+    customerId: string;
+    customerName: {
+        en: string;
+        ar: string;
+    };
+    rating: number;
+    title?: {
+        en?: string;
+        ar?: string;
+    };
+    content: {
+        en: string;
+        ar: string;
+    };
+    isVerifiedPurchase: boolean;
+    helpfulCount: number;
+    images?: FileType[];
+    status: 'pending' | 'approved' | 'rejected' | 'flagged';
+    moderationNotes?: string;
+    createdAt: Date;
+    updatedAt: Date;
+    vendorId: string | any;
+}
+export interface ReviewSummary {
+    totalReviews: number;
+    averageRating: number;
+    ratingDistribution: {
+        1: number;
+        2: number;
+        3: number;
+        4: number;
+        5: number;
+    };
+    verifiedPurchaseCount: number;
+    lastUpdated: Date;
+}
+export interface CustomerDataFieldTemplate {
+    id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description: {
+        en: string;
+        ar: string;
+    };
+    field: Omit<CustomerDataField, 'fieldId' | 'sortOrder' | 'isActive'>;
+}

package/dist/types/prods.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/product.ts
+// Product, Category, and related types with uniform variant approach + Customer Data Fields + Variant Selection Support
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/product.d.ts

@@ -0,0 +1,100 @@
+import { FileType, PriceModel, Dimensions, StockHandle } from './common';
+export interface Label {
+    featured: boolean;
+    mostSelling: {
+        criteria: string;
+        active: boolean;
+    };
+    newRelease: {
+        criteria: string;
+        period: number;
+        active: boolean;
+    };
+}
+export interface Specification {
+    active: boolean;
+    values: any[];
+}
+export interface AddonType {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    price: number;
+    enableQuantity?: boolean;
+    stockHandle: StockHandle;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+    createdAt?: Date;
+    updatedAt?: Date;
+}
+export interface Modifier {
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    type?: "checkbox" | "radio" | "select";
+    required?: boolean;
+    maxSelect?: number;
+    minSelect?: number;
+    active?: boolean;
+    addons?: {
+        addonId: AddonType | any;
+        enableQuantity?: boolean;
+        priceOverride?: number;
+    }[];
+}
+export interface Category {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description: {
+        en: string;
+        ar: string;
+    };
+    parentCategoryId?: string | null;
+    createdAt: Date;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+}
+export interface ProductType {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description?: {
+        en: string;
+        ar: string;
+    };
+    sku?: string;
+    categoriesIds: any[];
+    dimensions?: Dimensions;
+    priceModel: PriceModel;
+    stockHandle?: StockHandle;
+    tags?: string[];
+    branchesIds?: string[];
+    modifiers?: Modifier[];
+    hasModifiers?: boolean;
+    label?: Label;
+    sort?: number;
+    specifications?: Specification;
+    linkedProduct?: any;
+    createdAt?: Date;
+    updatedAt?: Date;
+    files?: FileType[];
+    sortOrder?: number;
+    isActive: boolean;
+    vendorId: string | any;
+}
+export interface GroupedCategory {
+    categoryName: any;
+    products: ProductType[];
+}

package/dist/types/product.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/product.ts
+// Product, Category, and related types
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/state.d.ts

@@ -0,0 +1,23 @@
+import { IBranch } from './vendor';
+import { GroupedCategory, ProductType, Category } from './prods';
+import { Address } from './common';
+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;
+}

package/dist/types/state.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/state.ts
+// Application state and UI types
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/user.d.ts

@@ -0,0 +1,61 @@
+import { Address, FileType } from './common';
+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;
+    files?: FileType[];
+}
+export interface VendorAssociation {
+    vendorId: string;
+    role?: string;
+    permissions?: string[];
+}
+export interface IUser {
+    _id?: any;
+    uid?: string;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    photoURL?: string;
+    isAdmin?: boolean;
+    vendors?: VendorAssociation[];
+    createdAt?: Date;
+    updatedAt?: Date;
+    fcmTokens?: string[];
+    files?: FileType[];
+}
+export interface CurrentUserType extends IUser {
+    vendors?: {
+        vendorId: string;
+        name: {
+            en: string;
+            ar: string;
+        };
+        logo?: FileType[];
+        description: {
+            en: string;
+            ar: string;
+        };
+    }[];
+    hasAccesstoVendor?: boolean;
+}
+export type IRole = {
+    _id?: string;
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    permissions?: string[];
+};

package/dist/types/user.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/user.ts
+// User and customer types
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/vendor.d.ts

@@ -0,0 +1,159 @@
+import { FileType } from './common';
+import { TemplateId } from './enums';
+export interface IBranchName {
+    en: string;
+    ar?: string;
+}
+export interface ITimeSlot {
+    from: string;
+    to: string;
+}
+export interface IDayHours {
+    isOpen: boolean;
+    is24Hours: boolean;
+    timeSlots: ITimeSlot[];
+}
+export interface IOpeningHours {
+    Monday: IDayHours;
+    Tuesday: IDayHours;
+    Wednesday: IDayHours;
+    Thursday: IDayHours;
+    Friday: IDayHours;
+    Saturday: IDayHours;
+    Sunday: IDayHours;
+}
+export interface IZone {
+    i?: number;
+    deliveryType?: string;
+    deliveryRange?: string;
+    deliveryFee?: string;
+    pricePerKm?: string;
+    radius?: number;
+    center?: {
+        lat: number;
+        lng: number;
+    };
+    markerPosition?: {
+        lat: number;
+        lng: number;
+    };
+    country?: string;
+}
+export interface IDeliverySettings {
+    enabled?: boolean;
+    charge?: string;
+    zones?: IZone[];
+    openingHours?: IOpeningHours;
+}
+export interface IPickupSettings {
+    enabled?: boolean;
+    instruction?: string;
+    openingHours?: IOpeningHours;
+}
+export interface IDineInSettings {
+    enabled?: boolean;
+    tableCount?: string;
+    openingHours?: IOpeningHours;
+}
+export interface IBranch {
+    _id?: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    phone: string;
+    vendorId: string | any;
+    deliverySettings?: IDeliverySettings;
+    pickupSettings?: IPickupSettings;
+    dineInSettings?: IDineInSettings;
+    createdAt?: Date;
+    updatedAt?: Date;
+    files?: FileType[];
+}
+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;
+    };
+    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;
+            };
+        };
+    };
+}

package/dist/types/vendor.js

@@ -0,0 +1,4 @@
+"use strict";
+// types/vendor.ts
+// Vendor and branch types
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

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