shopoflex-types 1.0.0

package/dist/index.d.ts

@@ -0,0 +1 @@
+export * from './types/common';

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+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 });
+__exportStar(require("./types/common"), exports);

package/dist/types/common.d.ts

@@ -0,0 +1,517 @@
+export interface FileType {
+    previewUrl?: string;
+    type?: string;
+    selected?: boolean;
+    name?: string;
+    size?: number;
+    id?: string;
+    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 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;
+    currency: string;
+    integrations: {
+        loyaltyProgram: {
+            active: boolean;
+            started: boolean;
+        };
+    };
+    expiryDate: string;
+    defaultLanguage: string;
+    acceptedLanguages: string[];
+    numberOfDecimals: number;
+    supportEmail: 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>;
+    country: string;
+    phone: string;
+    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;
+            };
+        };
+    };
+}
+interface PriceModel {
+    price: number;
+    discountedPrice?: number;
+    finalPrice?: number;
+    cost?: number;
+    allowDecimal?: boolean;
+    minQuantity?: number;
+    unit?: string;
+}
+interface Dimensions {
+    active: boolean;
+    values?: {
+        length: number | null;
+        width: number | null;
+        height: number | null;
+        weight: number | null;
+    };
+}
+interface StockHandle {
+    active: boolean;
+    stockQuantity: number;
+    ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
+}
+interface StockHandle {
+    active: boolean;
+    stockQuantity: number;
+    ifOutOfStock: 'showOutOfStock' | 'allowOrdering' | 'hideFromStore';
+}
+interface Label {
+    featured: boolean;
+    mostSelling: {
+        criteria: string;
+        active: boolean;
+    };
+    newRelease: {
+        criteria: string;
+        period: number;
+        active: boolean;
+    };
+}
+interface Specification {
+    active: boolean;
+    values: any[];
+}
+export interface Category {
+    _id: string;
+    name: {
+        en: string;
+        ar: string;
+    };
+    description: {
+        en: string;
+        ar: string;
+    };
+    parentCategoryId?: string | null;
+    image?: string;
+    sortOrder?: number;
+    isActive: boolean;
+    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: {
+        en: string;
+        ar: string;
+    };
+    description?: {
+        en: string;
+        ar: string;
+    };
+    sku?: string;
+    categoriesIds: any[];
+    dimensions?: Dimensions;
+    priceModel: PriceModel;
+    stockHandle?: StockHandle;
+    tags?: string[];
+    branchesIds?: string[];
+    files: FileType[];
+    modifiers?: Modifier[];
+    hasModifiers?: boolean;
+    label?: Label;
+    sort?: number;
+    active: boolean;
+    specifications?: Specification;
+    linkedProduct?: any;
+    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[];
+}
+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 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;
+    fileUrl: string;
+}
+export interface Cart {
+    _id?: string;
+    items: CartItem[];
+    subtotal: number;
+    totalQuantity: number;
+    discount: number;
+    delivery: number;
+    total: number;
+}
+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;
+    vendorId?: string;
+    cart?: Cart;
+    paymentMethod?: string;
+    address?: Address;
+    status?: OrderStatus;
+    paid?: boolean;
+    shipping: Shipping;
+    createdAt?: Date;
+    updatedAt?: Date;
+    orderNumber?: any;
+}
+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;
+    firstName?: string;
+    lastName?: string;
+    email?: string;
+    phone?: string;
+    photoURL?: string;
+    isAdmin?: boolean;
+    vendors?: VendorAssociation[];
+    createdAt?: Date;
+    updatedAt?: Date;
+    fcmTokens?: string[];
+}
+export type IRole = {
+    _id?: string;
+    name?: {
+        en?: string;
+        ar?: string;
+    };
+    permissions?: string[];
+};
+interface ILatLng {
+    lat: number;
+    lng: number;
+}
+interface IZone {
+    country: string;
+    deliveryType: "distance" | "constant";
+    deliveryRange: "radius" | "country";
+    deliveryFee?: string;
+    pricePerKm: string;
+    radius: number;
+    center: ILatLng;
+    markerPosition: ILatLng;
+}
+interface IDeliverySettings {
+    zones: IZone[];
+}
+interface IPickupSettings {
+    enabled: boolean;
+    instruction?: string;
+}
+interface IDineInSettings {
+    enabled: boolean;
+}
+interface IBranchName {
+    en: string;
+    ar?: string;
+}
+export interface IBranch {
+    name: IBranchName;
+    phone: string;
+    vendorId: string;
+    deliverySettings: IDeliverySettings;
+    pickupSettings: IPickupSettings;
+    dineInSettings: IDineInSettings;
+    createdAt?: Date;
+}
+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 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;
+    };
+    allProducts?: ProductType[];
+    allCategories?: Category[];
+    loading?: boolean;
+}
+export interface Discount {
+    _id: string;
+    code: string;
+    vendorId: string;
+    type: "fixed" | "percentage";
+    value: number;
+    isAutomatic: boolean;
+    usageLimit: number | null;
+    perUserLimit: number;
+    discountCategory: "cart_total" | "free_delivery";
+    minCartValue: number;
+    applicableProducts: string[];
+    applicableCategories: string[];
+    eligibleUsers: string[];
+    combinable: boolean;
+    firstTimeUsersOnly: boolean;
+    startDate: Date;
+    endDate?: Date;
+    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 {};

package/dist/types/common.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrderStatus = exports.TemplateId = void 0;
+var TemplateId;
+(function (TemplateId) {
+    TemplateId["TEMPLATE_1"] = "template_1";
+    TemplateId["TEMPLATE_2"] = "template_2";
+    TemplateId["TEMPLATE_3"] = "template_3";
+    TemplateId["TEMPLATE_4"] = "template_4";
+    TemplateId["TEMPLATE_5"] = "template_5";
+})(TemplateId || (exports.TemplateId = TemplateId = {}));
+var OrderStatus;
+(function (OrderStatus) {
+    OrderStatus["Pending"] = "pending";
+    OrderStatus["Cancelled"] = "cancelled";
+    OrderStatus["Rejected"] = "rejected";
+    OrderStatus["Refunded"] = "refunded";
+    OrderStatus["Preparing"] = "preparing";
+    OrderStatus["Delivering"] = "delivering";
+    OrderStatus["Completed"] = "completed";
+})(OrderStatus || (exports.OrderStatus = OrderStatus = {}));

package/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "shopoflex-types",
+  "version": "1.0.0",
+  "description": "Shared TypeScript types for Shopoflex applications",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": ["typescript", "types", "shopoflex"],
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}