@chopkola/common 1.0.153 → 1.0.157

package/build/index.d.ts

@@ -1,6 +1,6 @@
 export * from './types/user';
 export * from './types/enum/error';
-export * from './types/enum/user';
+export * from './types/enum/collection';
 export * from './types/enum/global';
 export * from './types/global';
 export * from './types/errors/index';
@@ -11,5 +11,6 @@ export * from './types/apis';
 export * from './types/file.types';
 export * from './types/category';
 export * from './types/vendor';
-export * from './types/menus';
+export * from './types/menu_n_meal';
 export * from './types/products';
+export * from './types/role_n_permission';

package/build/index.js

@@ -16,7 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./types/user"), exports);
 __exportStar(require("./types/enum/error"), exports);
-__exportStar(require("./types/enum/user"), exports);
+__exportStar(require("./types/enum/collection"), exports);
 __exportStar(require("./types/enum/global"), exports);
 __exportStar(require("./types/global"), exports);
 __exportStar(require("./types/errors/index"), exports);
@@ -27,5 +27,6 @@ __exportStar(require("./types/apis"), exports);
 __exportStar(require("./types/file.types"), exports);
 __exportStar(require("./types/category"), exports);
 __exportStar(require("./types/vendor"), exports);
-__exportStar(require("./types/menus"), exports);
+__exportStar(require("./types/menu_n_meal"), exports);
 __exportStar(require("./types/products"), exports);
+__exportStar(require("./types/role_n_permission"), exports);

package/build/types/address.d.ts

@@ -0,0 +1,12 @@
+export interface AddressI {
+    id?: string;
+    label?: string;
+    street_address?: string;
+    city?: string;
+    country?: string;
+    neighborhood?: string;
+    state?: string;
+    postal_code?: string;
+    latitude?: number;
+    longitude?: number;
+}

package/build/types/apis/administrator/access.control.list.type.d.ts

@@ -1,8 +1,8 @@
-import { PermissionEnum } from "../../enum/user";
-import { PermissionI, RoleI } from "../../user";
+import { PermissionEnum } from "../../enum/collection";
+import { Permission, Role } from "../../role_n_permission";
 export type AccessControlListResourceData = {
     resources: string[];
     permissionActions: PermissionEnum[];
-    permissions: PermissionI[];
-    roles: RoleI[];
+    permissions: Permission[];
+    roles: Role[];
 };

package/build/types/apis/administrator/administrator.category.management.type.d.ts

@@ -1,4 +1,4 @@
-import { CategoryI, CategoryItemI, CategoryTreeNode } from "../../category";
+import { Category, CategoryTreeNode } from "../../category";
 export type CategoryItemStat = {
     title: string;
     value: string | number;
@@ -11,11 +11,11 @@ export type CategoryItemStats = {
 };
 export interface CategoryDetailsData {
     stats: CategoryItemStats;
-    category: CategoryItemI;
+    category: Category;
 }
 export interface CreateOrEditCategoryData {
-    category: CategoryI | null;
-    parentCategory: CategoryI | null;
+    category: Category | null;
+    parentCategory: Category | null;
 }
 export type CategoryManagementData = {
     roots: CategoryTreeNode[];

package/build/types/apis/administrator/administrator.dashboard.type.d.ts

@@ -1,6 +1,6 @@
 import type { LucideIcon } from "lucide-react";
-import { SystemLoggedActivityI, SystemPerformanceI } from "../../global";
-import { VendorI } from "../../vendor";
+import { SystemLoggedActivity, SystemPerformanceMetric } from "../../global";
+import { Vendor } from "../../vendor";
 export declare enum AdministratorDashboardIconEnum {
     BADGE_DOLLAR_SIGN = "badge_dollar_sign",
     WALLET = "wallet",
@@ -29,9 +29,9 @@ export type AdminDashboardStats = {
 };
 export type AdministratorDashboardData = {
     stats: AdminDashboardStats;
-    vendor_applications: VendorI[];
-    system_activities: SystemLoggedActivityI[];
-    performance_data: SystemPerformanceI[];
+    vendor_applications: Vendor[];
+    system_activities: SystemLoggedActivity[];
+    performance_data: SystemPerformanceMetric[];
 };
 export interface GetAdministratorDashboardPageResourceI {
     data: AdministratorDashboardData;

package/build/types/apis/administrator/administrator.vendor.management.type.d.ts

@@ -1,6 +1,6 @@
 import { LucideIcon } from "lucide-react";
 import { BusinessTypeFilterTab } from "../../global";
-import { VendorI } from "../../vendor";
+import { Vendor } from "../../vendor";
 export declare enum AdministratorVendorManagementIconEnum {
     STORE = "store"
 }
@@ -27,11 +27,11 @@ export type AdministratorVendorsStats = {
 export type AdministratorVendorManagementData = {
     stats: AdministratorVendorsStats;
     business_types?: BusinessTypeFilterTab;
-    vendors: VendorI[];
+    vendors: Vendor[];
 };
 export type AdministratorVendorDetailsManagementData = {
     audit_logs: any[];
     compliance_and_finance: any[];
     operations?: any[];
-    vendor: VendorI;
+    vendor: Vendor;
 };

package/build/types/apis/administrator/create.administrator.type.d.ts

@@ -1,4 +1,4 @@
-import { RoleI } from "../../user";
+import { Role } from "../../role_n_permission";
 export type CreateAdministratorData = {
-    roles: RoleI[];
+    roles: Role[];
 };

package/build/types/apis/administrator/system.user.management.type.d.ts

@@ -1,6 +1,6 @@
 import { LucideIcon } from "lucide-react";
 import { FilterTab } from "../../global";
-import { UserI } from "../../user";
+import { User } from "../../user";
 export declare enum SystemUserManagementIconEnum {
     USER_X = "user_x",
     USER_CHECK = "user_check",
@@ -29,10 +29,10 @@ export type SystemUsersStats = {
 export type SystemUserManagementData = {
     stats: SystemUsersStats;
     account_types?: FilterTab;
-    users: UserI[];
+    users: User[];
 };
 export type SystemUserDetailsManagementData = {
     audit_logs: any[];
     security_and_access?: any[];
-    user: UserI;
+    user: User;
 };

package/build/types/apis/vendor/active.business.d.ts

@@ -1,7 +1,7 @@
-import { VendorI } from "../../vendor";
+import { Vendor } from "../../vendor";
 export interface ToggleBusinessOpenedState {
-    business: VendorI;
+    business: Vendor;
 }
 export interface GetBusinessOpenedState {
-    business: VendorI;
+    business: Vendor;
 }

package/build/types/apis/vendor/vendor.user.summary.statistics.resource.data.d.ts

@@ -1,11 +1,6 @@
 import { LucideIcon } from "lucide-react";
-import { VendorI } from "../../vendor";
-export declare enum VendorUserSummaryStatisticsIconEnum {
-    BUILDING_2 = "building_2",
-    STORE = "store",
-    CLOCK = "clock",
-    BAN = "ban"
-}
+import { Vendor } from "../../vendor";
+import { VendorUserSummaryStatisticsIconEnum } from "../../enum/collection";
 export type BackendVendorUserSummaryStat = {
     title: string;
     value: string | number;
@@ -29,7 +24,7 @@ export type VendorUserStats = {
     suspended: BackendVendorUserSummaryStat;
 };
 export type VendorUserSummaryStatisticsResourceData = {
-    businesses: VendorI[];
+    businesses: Vendor[];
     actions: any[];
     stats: VendorUserStats;
 };

package/build/types/apis/vendor/vendor.user.summary.statistics.resource.data.js

@@ -1,10 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.VendorUserSummaryStatisticsIconEnum = void 0;
-var VendorUserSummaryStatisticsIconEnum;
-(function (VendorUserSummaryStatisticsIconEnum) {
-    VendorUserSummaryStatisticsIconEnum["BUILDING_2"] = "building_2";
-    VendorUserSummaryStatisticsIconEnum["STORE"] = "store";
-    VendorUserSummaryStatisticsIconEnum["CLOCK"] = "clock";
-    VendorUserSummaryStatisticsIconEnum["BAN"] = "ban";
-})(VendorUserSummaryStatisticsIconEnum || (exports.VendorUserSummaryStatisticsIconEnum = VendorUserSummaryStatisticsIconEnum = {}));

package/build/types/cart.d.ts

@@ -1,32 +1,98 @@
-export type CartItemType = "restaurant" | "grocery";
-export interface CartItemsI {
-    id: string;
-    cart_id: string;
-    item_id: string;
-    item_type: CartItemTypeEnum;
-    source_id: string;
+import { CartItemTypeEnum, CartStatusEnum, CartTypeEnum } from "./enum/collection";
+import { MoneyString, Timestamps, UUID, Nullable } from "./global";
+import { SelectedModifierOption } from "./menu_n_meal";
+/**
+ * PRODUCTION NOTE:
+ * We assign a `vendor_id` and `cart_type` directly to the Cart.
+ * In food delivery platforms (like UberEats/Instacart), you generally
+ * cannot mix hot restaurant food and grocery items in the same checkout,
+ * nor can you easily mix vendors. This enforces business rules at the DB level.
+ */
+export interface Cart extends Timestamps {
+    id: UUID;
+    user_id: Nullable<UUID>;
+    session_id: string;
+    cart_type: CartTypeEnum;
+    status: CartStatusEnum;
+    expires_at: Date;
+    total_items: number;
+    subtotal: MoneyString;
+}
+/**
+ * Base fields shared by ALL cart items
+ */
+export interface BaseCartItem extends Timestamps {
+    id: UUID;
+    cart_id: UUID;
+    vendor_id: UUID;
     quantity: number;
-    price_at_time: number;
-    metadata: JSON;
-    created_at?: Date;
-    updated_at?: Date;
+    unit_price: MoneyString;
+    total_price: MoneyString;
 }
-export declare enum CartItemTypeEnum {
-    GROCERY = "grocery",
-    RESTAURANT = "restaurant"
+/**
+ * MEAL CART ITEM (Restaurant)
+ * Requires exact knowledge of which modifiers the user selected.
+ */
+export interface MealCartItemMetadata {
+    special_instructions: Nullable<string>;
+    selected_options: SelectedModifierOption[];
 }
-export declare enum CartStatusEnum {
-    ACTIVE = "active",
-    CONVERTED = "converted",
-    ABANDONED = "abandoned",
-    USED = "used"
+export interface MealCartItem extends BaseCartItem {
+    item_type: CartItemTypeEnum.MEAL;
+    meal_id: UUID;
+    product_id: null;
+    product_variant_id: null;
+    inventory_item_id: null;
+    metadata: MealCartItemMetadata;
 }
-export interface CartI {
-    id: string;
-    user_id: string;
-    session_id: string;
-    status: CartStatusEnum;
-    expires_at: Date;
-    created_at: Date;
-    updated_at: Date;
+/**
+ * PRODUCT CART ITEM (Grocery/Retail)
+ * Requires exact knowledge of the Inventory Item to reserve stock.
+ */
+export interface ProductCartItemMetadata {
+    special_instructions: Nullable<string>;
+    accepts_substitutions: boolean;
+}
+export interface ProductCartItem extends BaseCartItem {
+    item_type: CartItemTypeEnum.PRODUCT;
+    meal_id: null;
+    product_id: UUID;
+    product_variant_id: Nullable<UUID>;
+    inventory_item_id: UUID;
+    metadata: ProductCartItemMetadata;
 }
+/**
+ * 🚀 FINAL CART ITEM UNION
+ * DB constraint: Item is either a Meal OR a Product.
+ */
+export type CartItem = MealCartItem | ProductCartItem;
+/**
+ * Used for the frontend Cart Page view.
+ * Contains the Cart and an array of fully populated items.
+ */
+export interface CartAggregate extends Cart {
+    items: CartItem[];
+    tax_estimate?: MoneyString;
+    delivery_fee_estimate?: MoneyString;
+    total_estimate?: MoneyString;
+}
+/** Base fields required from the frontend to add an item */
+type BaseAddToCartInput = {
+    cart_id: UUID;
+    quantity: number;
+};
+export type AddMealToCartInput = BaseAddToCartInput & {
+    item_type: CartItemTypeEnum.MEAL;
+    meal_id: UUID;
+    metadata: MealCartItemMetadata;
+};
+export type AddProductToCartInput = BaseAddToCartInput & {
+    item_type: CartItemTypeEnum.PRODUCT;
+    product_id: UUID;
+    product_variant_id?: UUID;
+    inventory_item_id: UUID;
+    metadata: ProductCartItemMetadata;
+};
+/** Frontend payload type for "Add To Cart" requests */
+export type AddToCartInput = AddMealToCartInput | AddProductToCartInput;
+export {};

package/build/types/cart.js

@@ -1,15 +1,2 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.CartStatusEnum = exports.CartItemTypeEnum = void 0;
-var CartItemTypeEnum;
-(function (CartItemTypeEnum) {
-    CartItemTypeEnum["GROCERY"] = "grocery";
-    CartItemTypeEnum["RESTAURANT"] = "restaurant";
-})(CartItemTypeEnum || (exports.CartItemTypeEnum = CartItemTypeEnum = {}));
-var CartStatusEnum;
-(function (CartStatusEnum) {
-    CartStatusEnum["ACTIVE"] = "active";
-    CartStatusEnum["CONVERTED"] = "converted";
-    CartStatusEnum["ABANDONED"] = "abandoned";
-    CartStatusEnum["USED"] = "used";
-})(CartStatusEnum || (exports.CartStatusEnum = CartStatusEnum = {}));

package/build/types/category.d.ts

@@ -1,36 +1,38 @@
-import { CategoryScopeEnum, CategoryStatusEnum } from "./enum/user";
-export interface CategoryI {
-    id: string;
-    parent_id: string | null;
-    path?: string;
-    level?: number;
+import { UUID, Timestamps } from "./global";
+import { CategoryScopeEnum, CategoryStatusEnum } from "./enum/collection";
+export interface Category extends Timestamps {
+    id: UUID;
+    parent_id: UUID | null;
+    path: string;
+    level: number;
     name: string;
     slug: string;
-    description?: string | null;
-    scope?: CategoryScopeEnum;
-    status?: CategoryStatusEnum;
-    aliases?: string[];
-    tags?: string[];
-    metadata?: Record<string, unknown>;
-    created_at?: Date;
-    updated_at?: Date;
+    description: string | null;
+    scope: CategoryScopeEnum;
+    status: CategoryStatusEnum;
+    aliases: string[];
+    tags: string[];
+    metadata: Record<string, unknown>;
 }
-export interface CategoryItemI extends CategoryI {
-    parents: CategoryI[];
-    children: CategoryI[];
-}
-export type CategoryTreeNode = CategoryI & {
+export interface CategoryTreeNode extends Category {
     children: CategoryTreeNode[];
     child_count: number;
-};
-export type RootCategory = CategoryTreeNode & {
+}
+export type RootCategoryNode = CategoryTreeNode & {
     level: 0;
+    parent_id: null;
 };
-export type ChildrenCategoryMap = Record<string, CategoryTreeNode[]>;
-export interface CategoryTreeResponse {
-    roots: RootCategory[];
-    children?: ChildrenCategoryMap;
-}
-export interface NestedCategoryNode extends CategoryTreeNode {
+export interface NestedCategoryNode extends Category {
     children: NestedCategoryNode[];
 }
+export interface CategoryWithRelations extends Category {
+    parents: Category[];
+    children: Category[];
+}
+export type ChildrenCategoryMap = Record<UUID, CategoryTreeNode[]>;
+export interface CategoryTreeResponse {
+    roots: RootCategoryNode[];
+    children_map?: ChildrenCategoryMap;
+}
+export type CreateCategoryInput = Omit<Category, "id" | "created_at" | "updated_at" | "path" | "level">;
+export type UpdateCategoryInput = Partial<CreateCategoryInput>;

package/build/types/enum/collection.d.ts

@@ -0,0 +1,125 @@
+export declare enum UserAccountTypeEnum {
+    CUSTOMER = "customer",
+    VENDOR = "vendor",
+    ADMINISTRATOR = "administrator"
+}
+export declare enum UserAccountStatusEnum {
+    PENDING_VERIFICATION = "pending_verification",
+    ACTIVE = "active",
+    SUSPENDED = "suspended",
+    DEACTIVATED = "deactivated"
+}
+export declare enum UserGenderEnum {
+    MALE = "male",
+    FEMALE = "female",
+    OTHERS = "other",
+    ANONYMOUS = "anonymous"
+}
+export declare enum VendorBusinessTypeEnum {
+    GROCERY = "grocery",
+    RESTAURANT = "restaurant"
+}
+export declare enum VendorStatusEnum {
+    PENDING_APPROVAL = "pending_approval",
+    NEEDS_REVISION = "needs_revision",
+    ACTIVE = "active",
+    PAUSED_BY_VENDOR = "paused_by_vendor",
+    SUSPENDED_BY_ADMINISTRATOR = "suspended_by_administrator"
+}
+export declare enum DietryPreferencesEnum {
+    VEGAN = "vegan",
+    HALAL = "halal",
+    ALLERGIES = "allergies"
+}
+export declare enum PermissionEnum {
+    CREATE = "create",
+    READ = "read",
+    UPDATE = "update",
+    DELETE = "delete"
+}
+export declare enum RoleRiskLevelEnum {
+    HIGH = "high",
+    MEDIUM = "medium",
+    LOW = "low"
+}
+export declare enum VerificationPurposeEnum {
+    EMAIL_VERIFY = "email_verify",
+    PASSWORD_RESET = "password_reset"
+}
+export declare enum CategoryScopeEnum {
+    RESTAURANT = "restaurant",
+    GROCERY = "grocery"
+}
+export declare enum CategoryStatusEnum {
+    ACTIVE = "active",
+    ARCHIVED = "archived",
+    DRAFT = "draft"
+}
+export declare enum RoleIconEnum {
+    SHIELD = "shield",
+    USERS = "users",
+    DOLLAR_SIGN = "dollar_sign",
+    GLOBE = "globe"
+}
+export declare enum StockStatusEnum {
+    IN_STOCK = "in_stock",
+    LOW_STOCK = "low_stock",
+    OUT_OF_STOCK = "out_of_stock",
+    DISCONTINUED = "discontinued"
+}
+export declare enum StockMovementReasonEnum {
+    SALE = "sale",
+    RETURN = "return",
+    SUPPLIER_INTAKE = "supplier_intake",
+    RECOUNT_ADJUSTMENT = "recount_adjustment",
+    DAMAGE = "damage",
+    THEFT = "theft",
+    PROMOTION = "promotion",
+    TRANSFER_OUT = "transfer_out",
+    TRANSFER_IN = "transfer_in",
+    INITIAL_STOCK = "initial_stock",
+    UPWARD_PRICE_REVIEW = "upward_price_review",
+    DOWNWARD_PRICE_REVIEW = "downward_price_review"
+}
+export declare enum VendorProductsStatisticsIconEnum {
+    PACKAGE = "package",
+    ALERT_TRIANGLE = "alert_triangle",
+    TRASH_2 = "trash_2",
+    FILTER = "filter"
+}
+export declare enum PromotionTypeEnum {
+    BUY_ONE_GET_ONE = "buy_one_get_one",
+    FREE_DELIVERY = "free_delivery",
+    SEASONAL_OFFER = "seasonal_offer",
+    LOYALTY_REWARD = "loyalty_reward",
+    HAPPY_HOUR = "happy_hour",
+    PERCENTAGE = "percentage",
+    FIXED = "fixed",
+    BUY_MORE_SAVE_MORE = "buy_more_save_more",
+    CLEARANCE = "clearance",
+    LIMITED_TIME = "limited_time"
+}
+export declare enum ProductTypeEnum {
+    SIMPLE = "simple",
+    VARIANT = "variant"
+}
+export declare enum CartTypeEnum {
+    RESTAURANT = "restaurant",
+    GROCERY = "grocery"
+}
+export declare enum CartItemTypeEnum {
+    MEAL = "meal",
+    PRODUCT = "product"
+}
+export declare enum CartStatusEnum {
+    ACTIVE = "active",
+    CONVERTED = "converted",// Converted to Order
+    ABANDONED = "abandoned",
+    USED = "used"
+}
+export declare enum VendorUserSummaryStatisticsIconEnum {
+    BUILDING_2 = "building_2",
+    STORE = "store",
+    CLOCK = "clock",
+    BAN = "ban"
+}