shopoflex-types 1.0.162 → 1.0.166

package/dist/common.d.ts

@@ -280,6 +280,42 @@ export interface PixelsOptions {
         active?: boolean;
     };
 }
+type LimitValue = number | 'unlimited';
+interface PlanLimits {
+    dailyOrders: LimitValue;
+    users: LimitValue;
+    branches: LimitValue;
+}
+interface PlanFeatures {
+    terminalSynchronization: boolean;
+    customDomain: boolean;
+    tableManagement: boolean;
+    accounting: boolean;
+    advancedReports: boolean;
+    whatsappNotifications: boolean;
+    emailNotifications: boolean;
+}
+export interface IPlanPackage {
+    _id?: any;
+    name: string;
+    price: number | 'custom';
+    limits: PlanLimits;
+    features: PlanFeatures;
+    isActive: boolean;
+    createdAt: Date;
+    updatedAt: Date;
+}
+interface TaxSettings {
+    active: boolean;
+    show: boolean;
+    payer: 'vendor' | 'customer';
+    percentage: number;
+}
+export type VendorUserInvitation = {
+    email: string;
+    role: string;
+    status: "pending";
+};
 export interface Vendor {
     _id?: string;
     industry?: string;
@@ -327,17 +363,9 @@ export interface Vendor {
     createdAt: Date;
     orderType: PickType[];
     socialLinks: string[];
-    users: Array<unknown>;
+    users: VendorUserPopulated[] | VendorUser[] | VendorUserUnpopulated[] | VendorUserInvitation[];
     areas: Record<string, unknown>;
     payments: VendorPayments;
-    wallet: {
-        balance: number;
-        currency: string;
-        commissionRates: {
-            ecommerce: number;
-            pos: number;
-        };
-    };
     usage: {
         productsCount: number;
         branchesCount: number;
@@ -346,10 +374,76 @@ export interface Vendor {
     allowCustomPricing?: boolean;
     pixelsOptions?: PixelsOptions;
     taxManagement?: TaxManagement;
-    addToWallet(amount: number): Promise<this>;
-    deductCommission(orderValue: number, source?: 'pos' | 'online'): Promise<this>;
-    canProcessOrder(orderValue: number, source?: 'pos' | 'online'): boolean;
+    currentPlan?: IPlanPackage;
+    getTaxConfig(country?: string): TaxSettings;
+    calculateTax(subtotal: number, country?: string): {
+        taxAmount: number;
+        taxConfig: TaxSettings;
+        taxIncludedInTotal: boolean;
+    };
+    setTaxConfig(config: {
+        type: 'fixed' | 'perCountry';
+        settings: any;
+    }): Promise<any>;
+    setCountryTax(country: string, settings: TaxSettings): Promise<any>;
+    validateLockPin(userId: string, lockPin: string): boolean;
+    setUserLockPin(userId: string, lockPin: string): Promise<any>;
+    updatePlan(planId: string, startDate?: Date, endDate?: Date): Promise<any>;
+    getCurrentPlan(): Promise<any>;
+    getCurrentUsage(): Promise<{
+        dailyOrders: number;
+        branches: number;
+        users: number;
+    }>;
+    calculateRemainingLimits(planLimits: any): Promise<any>;
+    getSubscriptionDetails(): any;
+    checkLimit(limitType: string): Promise<boolean>;
+    canCreateOrder(): Promise<boolean>;
+    canCreateUser(): Promise<boolean>;
+    canCreateBranch(): Promise<boolean>;
+}
+export interface VendorUser<TUser = string, TRole = string> {
+    user: TUser;
+    role: TRole;
+    status: "pending" | "active" | "disabled";
+    email: string;
+    lockPin: string;
+    notifications: {
+        tokens: string[];
+        email: boolean;
+        push: boolean;
+        inApp: boolean;
+        types: {
+            new_order: boolean;
+            order_update: boolean;
+            stock_alert: boolean;
+            product_update: boolean;
+            system_update: boolean;
+        };
+    };
+}
+export interface VendorUser<TUser = string, TRole = string> {
+    user: TUser;
+    role: TRole;
+    status: "pending" | "active" | "disabled";
+    email: string;
+    lockPin: string;
+    notifications: {
+        tokens: string[];
+        email: boolean;
+        push: boolean;
+        inApp: boolean;
+        types: {
+            new_order: boolean;
+            order_update: boolean;
+            stock_alert: boolean;
+            product_update: boolean;
+            system_update: boolean;
+        };
+    };
 }
+export type VendorUserPopulated = VendorUser<IUser, IRole>;
+export type VendorUserUnpopulated = VendorUser<string, string>;
 export interface NotificationType {
     _id?: any;
     recipientId?: string;

package/package.json

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