shopoflex-types 1.0.46 → 1.0.48

package/dist/common.d.ts

@@ -0,0 +1,611 @@
+import mongoose from 'mongoose';
+export interface Discount {
+    _id?: mongoose.Types.ObjectId;
+    code?: string;
+    vendorId: mongoose.Types.ObjectId;
+    type: "fixed" | "percentage";
+    value: number;
+    maxDiscountAmount?: number;
+    isAutomatic: boolean;
+    status: "active" | "paused" | "expired" | "exhausted";
+    usageLimit?: number;
+    usageCount: number;
+    perUserLimit: number;
+    discountCategory: "cart_total" | "free_delivery" | "category_discount" | "product_discount";
+    minCartValue: number;
+    applicableProducts: mongoose.Types.ObjectId[];
+    excludedProducts: mongoose.Types.ObjectId[];
+    applicableCategories: mongoose.Types.ObjectId[];
+    excludedCategories: mongoose.Types.ObjectId[];
+    usedBy: mongoose.Types.ObjectId[];
+    combinable: boolean;
+    firstTimeUsersOnly: boolean;
+    startDate: Date;
+    endDate?: Date;
+    description?: string;
+    createdBy?: mongoose.Types.ObjectId;
+    customerMessage?: 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 declare enum OrderStatus {
+    Pending = "pending",
+    Cancelled = "cancelled",
+    Rejected = "rejected",
+    Refunded = "refunded",
+    Preparing = "preparing",
+    Delivering = "delivering",
+    Completed = "completed"
+}
+export interface FileType {
+    previewUrl?: string;
+    type?: string;
+    selected?: boolean;
+    name?: string;
+    size?: number;
+    id?: string;
+    url?: string;
+    vendorId?: string;
+}
+export interface ILatLng {
+    lat: number;
+    lng: number;
+}
+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 PriceModel {
+    price: number;
+    discountedPrice?: number;
+    finalPrice?: number;
+    cost?: number;
+    allowDecimal?: boolean;
+    minQuantity?: number;
+    unit?: string;
+}
+export interface Dimensions {
+    active: boolean;
+    values?: {
+        length: number | null;
+        width: number | null;
+        height: number | null;
+        weight: number | null;
+    };
+}
+export interface StockHandle {
+    active: boolean;
+    stockByBranch: Record<string, {
+        stockQuantity: number;
+        ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
+    }>;
+}
+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;
+    hasVariants?: boolean;
+    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;
+    categoriesIds: string[];
+    price: number;
+    quantity: number;
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    selectedModifiers?: {
+        lists?: sModifier[];
+        overallTotal?: number;
+    };
+    finalPrice?: number;
+    files?: FileType[];
+}
+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 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 OrderType {
+    _id?: string | any;
+    customer?: Customer;
+    vendorId?: string;
+    cart?: Cart;
+    paymentMethod?: string;
+    address?: Address;
+    status?: OrderStatus;
+    paid?: boolean;
+    shipping: Shipping;
+    createdAt?: Date;
+    updatedAt?: Date;
+    scheduleTime: {
+        asap: boolean;
+        date?: Date;
+        time?: Date;
+    };
+    branch: {
+        _id: mongoose.Types.ObjectId | string;
+        name?: {
+            en?: string;
+            ar?: string;
+        };
+    };
+    orderNumber?: any;
+    promo?: {
+        _id?: string;
+        code?: string;
+        type?: string;
+        value?: number;
+        category?: string;
+        discountedAmount?: number;
+    };
+}
+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[];
+};
+export interface IBranchName {
+    en: string;
+    ar?: string;
+}
+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;
+            };
+        };
+    };
+}
+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 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 PaginationQuery {
+    page?: string;
+    limit?: string;
+    sortBy?: string;
+    sortOrder?: 'asc' | 'desc';
+    search?: string;
+    [key: string]: any;
+}
+export interface PaginationOptions {
+    page: number;
+    limit: number;
+    skip: number;
+    sortBy: string;
+    sortOrder: 'asc' | 'desc';
+    filters: Record<string, any>;
+    search?: string;
+}
+export interface PaginatedResponse<T> {
+    data: T[];
+    pagination: {
+        currentPage: number;
+        totalPages: number;
+        totalItems: number;
+        hasNextPage: boolean;
+        hasPrevPage: boolean;
+        limit: number;
+    };
+    filters?: Record<string, any>;
+    sort?: {
+        sortBy: string;
+        sortOrder: 'asc' | 'desc';
+    };
+}
+export interface FilterConfig {
+    [key: string]: {
+        type: 'string' | 'number' | 'boolean' | 'date' | 'array' | 'objectId';
+        operator?: 'eq' | 'ne' | 'gt' | 'gte' | 'lt' | 'lte' | 'in' | 'nin' | 'regex' | 'exists';
+        transform?: (value: any) => any;
+    };
+}
+export interface SortConfig {
+    allowedFields: string[];
+    defaultField: string;
+    defaultOrder: 'asc' | 'desc';
+}
+export interface SearchConfig {
+    fields: string[];
+    caseSensitive?: boolean;
+}
+export interface successResponse {
+    data: any[];
+    totalPages: number;
+    currentPage: number;
+    count: number;
+    hasNextPage: boolean;
+    hasPrevPage: boolean;
+}

package/dist/common.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/index.d.ts

@@ -1,9 +1 @@
-export * from './types/enums';
-export * from './types/prods';
-export * from './types/discount';
-export * from './types/order';
-export * from './types/user';
-export * from './types/vendor';
-export * from './types/notification';
-export * from './types/state';
-export * from './types/api';
+export * from './common';

package/dist/index.js

@@ -1,6 +1,4 @@
 "use strict";
-// types/index.ts
-// Main export file for all types
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -16,16 +14,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-// Common types
-__exportStar(require("./types/enums"), exports);
-// Domain-specific types
-__exportStar(require("./types/prods"), exports);
-__exportStar(require("./types/discount"), exports);
-__exportStar(require("./types/order"), exports);
-__exportStar(require("./types/user"), exports);
-__exportStar(require("./types/vendor"), exports);
-__exportStar(require("./types/notification"), exports);
-// Application state types
-__exportStar(require("./types/state"), exports);
-// API and utility types
-__exportStar(require("./types/api"), exports);
+__exportStar(require("./common"), exports);

package/package.json

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