@chopkola/common 1.0.213

package/build/types/products.d.ts

@@ -0,0 +1,208 @@
+import { LucideIcon } from "lucide-react";
+import { Category } from "./category";
+import { Currency, JsonObject, MoneyString, Nullable, QuantityString, Timestamps, UUID } from "./global";
+import { ProductTypeEnum, StockMovementReasonEnum, StockStatusEnum, VendorProductsStatisticsIconEnum } from "./enum/collection";
+export interface BackendVendorProductStatistic {
+    key: "total_products" | "low_stock" | "out_of_stock" | "top_category";
+    title: string;
+    value: string | number;
+    icon: VendorProductsStatisticsIconEnum;
+    color?: string;
+}
+export interface VendorProductStatistic {
+    key: "total_products" | "low_stock" | "out_of_stock" | "top_category";
+    title: string;
+    value: string | number;
+    icon: LucideIcon;
+    color?: string;
+}
+export type VendorProductsStats = Record<BackendVendorProductStatistic["key"], BackendVendorProductStatistic>;
+/**
+ * Persisted Product Entity
+ */
+export interface Product extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    name: string;
+    slug: string;
+    sku: string;
+    description: Nullable<string>;
+    brand: Nullable<string>;
+    images: Nullable<string[]>;
+    category_id: Nullable<UUID>;
+    tags: Nullable<string[]>;
+    attributes: Nullable<JsonObject>;
+    is_approved: boolean;
+}
+/**
+ * Expanded Product (with category)
+ */
+export interface ProductWithCategory extends Product {
+    category?: Category;
+}
+export interface ProductVariant extends Timestamps {
+    id: UUID;
+    product_id: UUID;
+    name_suffix: Nullable<string>;
+    sku: string;
+    options: JsonObject;
+    images: Nullable<string[]>;
+    is_default: boolean;
+}
+export type InventoryLink = {
+    product_id: UUID;
+    product_variant_id: null;
+} | {
+    product_id: null;
+    product_variant_id: UUID;
+};
+/**
+ * 🛠️ FIX 1: Extracted standard fields into a Base Interface.
+ */
+export interface BaseInventoryItem extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    sku: string;
+    price: MoneyString;
+    cost_price: Nullable<MoneyString>;
+    sale_price: Nullable<MoneyString>;
+    quantity: QuantityString;
+    low_stock_threshold: Nullable<QuantityString>;
+    stock_status: StockStatusEnum;
+    is_trackable: boolean;
+    is_visible: boolean;
+    supplier: Nullable<string>;
+    storage_location: Nullable<string>;
+}
+/**
+ * 🛠️ FIX 2: Used Type Intersection (&) to merge the Base and the Union safely.
+ * DB constraint: Either product OR variant — never both.
+ */
+export type InventoryItem = BaseInventoryItem & InventoryLink;
+export interface StockMovement extends Timestamps {
+    id: UUID;
+    inventory_item_id: UUID;
+    quantity_change: QuantityString;
+    quantity_before: QuantityString;
+    quantity_after: QuantityString;
+    reason: StockMovementReasonEnum;
+    notes: Nullable<string>;
+    source_reference_id: Nullable<UUID>;
+    user_id: Nullable<UUID>;
+}
+/**
+ * 🛠️ FIX 3: Changed from `interface` to `type`.
+ * An interface cannot extend a Union Type (InventoryItem).
+ */
+export type InventoryWithMovements = InventoryItem & {
+    movements: StockMovement[];
+};
+export interface ProductVariantAggregate extends ProductVariant {
+    inventory: Nullable<InventoryWithMovements>;
+}
+/**
+ * SIMPLE PRODUCT AGGREGATE
+ */
+export interface ProductSimpleAggregate extends ProductWithCategory {
+    type: ProductTypeEnum.SIMPLE;
+    inventory: Nullable<InventoryWithMovements>;
+    variants: [];
+}
+/**
+ * VARIANT PRODUCT AGGREGATE
+ */
+export interface ProductWithVariantsAggregate extends ProductWithCategory {
+    type: ProductTypeEnum.VARIANT;
+    inventory: null;
+    variants: ProductVariantAggregate[];
+}
+/**
+ * FINAL DISCRIMINATED UNION
+ */
+export type ProductAggregate = ProductSimpleAggregate | ProductWithVariantsAggregate;
+export type CreateProductInput = Omit<Product, "id" | "created_at" | "updated_at">;
+export type UpdateProductInput = Partial<CreateProductInput>;
+export type CreateProductVariantInput = Omit<ProductVariant, "id" | "created_at" | "updated_at">;
+export type UpdateProductVariantInput = Partial<CreateProductVariantInput>;
+/**
+ * 🛠️ FIX 4: Safe Union Omit.
+ * Omitting directly from `InventoryItem` breaks the discriminated union.
+ * Omitting from `BaseInventoryItem` and re-attaching `InventoryLink` keeps the XOR rule intact!
+ */
+export type CreateInventoryItemInput = Omit<BaseInventoryItem, "id" | "created_at" | "updated_at" | "stock_status"> & InventoryLink;
+export type UpdateInventoryItemInput = Partial<CreateInventoryItemInput>;
+export type CreateStockMovementInput = Omit<StockMovement, "id" | "created_at" | "updated_at">;
+export interface CategoryLite {
+    id: UUID;
+    name: string;
+    slug: string;
+}
+export interface ProductAggregateLite {
+    id: UUID;
+    vendor_id: UUID;
+    name: string;
+    slug: string;
+    sku: string | null;
+    description: string | null;
+    brand: string | null;
+    images: string[] | null;
+    tags: string[] | null;
+    attributes: Record<string, unknown> | null;
+    is_approved: boolean;
+    created_at: Date;
+    category: CategoryLite | null;
+}
+export interface ProductVariantAggregateLite {
+    id: UUID;
+    product_id: UUID;
+    name_suffix: string | null;
+    sku: string | null;
+    options: Record<string, unknown> | null;
+    images: string[] | null;
+    is_default: boolean;
+}
+export interface VendorLite {
+    id: UUID;
+    business_name: string;
+    slug: string;
+    logo_url: string | null;
+}
+export interface InventoryItemAggregate {
+    id?: UUID;
+    vendor_id: UUID;
+    product_id: UUID | null;
+    product_variant_id: UUID | null;
+    sku: string;
+    price: number;
+    cost_price: number;
+    sale_price: number;
+    quantity: number;
+    low_stock_threshold: number;
+    stock_status: StockStatusEnum;
+    is_trackable: boolean;
+    is_visible: boolean;
+    supplier: string | null;
+    storage_location: string | null;
+    created_at: Date;
+    updated_a: Date;
+    product: ProductAggregateLite | null;
+    product_variant: ProductVariantAggregateLite | null;
+    vendor: VendorLite;
+}
+export interface VendorProductsManagementData {
+    products: ProductAggregate[];
+    stats: VendorProductsStats;
+    currency: Currency;
+}
+export interface VendorCreateOrEditProductPageData {
+    categories: Category[];
+    product?: ProductAggregate;
+    currency: Currency;
+}
+export interface ProductDetailsData {
+    product: ProductAggregate;
+    currency: Currency;
+}
+export type WebApplicationProductsResourceData = {
+    products: InventoryItemAggregate[];
+};

package/build/types/products.js

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

package/build/types/reservation.d.ts

@@ -0,0 +1,27 @@
+import { ReservationStatusEnum } from "./enum/collection";
+export type Reservation = {
+    id: string;
+    vendor_id: string;
+    user_id: string;
+    start_time: Date;
+    end_time: Date;
+    party_size: number;
+    status: ReservationStatusEnum;
+    special_requests: string | null;
+    metadata: Record<string, any> | null;
+    created_at: Date;
+    updated_at: Date;
+};
+export type ReservationExtension = {
+    id: string;
+    reservation_id: string;
+    vendor_id: string;
+    start_time: Date;
+    end_time: Date;
+    created_at: Date;
+    updated_at: Date;
+};
+export type CreateReservationInput = Omit<Reservation, "id" | "created_at" | "updated_at">;
+export type UpdateReservationInput = Partial<Reservation>;
+export type CreateReservationExtensionInput = Omit<ReservationExtension, "id" | "created_at" | "updated_at">;
+export type UpdateReservationExtensionInput = Partial<ReservationExtension>;

package/build/types/reservation.js

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

package/build/types/role_n_permission.d.ts

@@ -0,0 +1,56 @@
+import { RoleIconEnum, RoleRiskLevelEnum } from "./enum/collection";
+import { UUID } from "./global";
+export type ResourceType = "users" | "roles" | "vendors" | "orders" | "products" | "*";
+export type VendorResourceType = "$";
+export type ActionType = "create" | "read" | "update" | "delete";
+export type AdministratorActionType = ActionType | "*";
+export type VendorActionType = ActionType | "$";
+export type PermissionKey = `${ResourceType}:${ActionType}`;
+export interface Permission {
+    id: UUID;
+    resource: ResourceType | VendorResourceType;
+    action: AdministratorActionType | VendorActionType;
+    /**
+     * Canonical rule representation
+     * Example:
+     *   users:create
+     *   vendors:manage
+     *   *:*
+     */
+    rule: PermissionKey;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface Role {
+    id: UUID;
+    name: string;
+    slug: string;
+    description: string | null;
+    icon: RoleIconEnum | null;
+    risk: RoleRiskLevelEnum;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface RolePermission {
+    role_id: UUID;
+    permission_id: UUID;
+}
+export interface RoleWithPermissions extends Role {
+    permissions: Permission[];
+}
+export type CreatePermissionInput = Omit<Permission, "id" | "created_at" | "updated_at">;
+export type UpdatePermissionInput = Partial<Omit<Permission, "id" | "created_at" | "updated_at">>;
+export type CreateRoleInput = Omit<Role, "id" | "created_at" | "updated_at"> & {
+    permission_ids?: UUID[];
+};
+export type UpdateRoleInput = Partial<Omit<Role, "id" | "created_at" | "updated_at">> & {
+    permission_ids?: UUID[];
+};
+export interface AuthorizationContext {
+    user_id: UUID;
+    role: RoleWithPermissions;
+}
+export interface PermissionCheck {
+    resource: ResourceType;
+    action: ActionType;
+}

package/build/types/role_n_permission.js

@@ -0,0 +1,5 @@
+"use strict";
+// =======================================================
+// RBAC DOMAIN MODEL (PRODUCTION READY)
+// =======================================================
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/user.d.ts

@@ -0,0 +1,74 @@
+import { AddressI } from "./address";
+import { UserAccountStatusEnum, UserAccountTypeEnum, UserGenderEnum, VerificationPurposeEnum } from "./enum/collection";
+import { UUID } from "./global";
+import { RoleWithPermissions } from "./role_n_permission";
+import { Vendor } from "./vendor";
+export interface User {
+    id: UUID;
+    first_name: string;
+    last_name: string;
+    email: string;
+    phone_number: string;
+    photo_url: string | null;
+    gender: UserGenderEnum;
+    account_status: UserAccountStatusEnum;
+    account_type: UserAccountTypeEnum;
+    locale: string;
+    timezone: string;
+    is_email_verified: boolean;
+    email_verified_at: Date | null;
+    token_version: number;
+    last_login_at: Date | null;
+    last_login_ip: string | null;
+    password_changed_at: Date | null;
+    last_consented_at: Date | null;
+    deleted_at: Date | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface UserSecurity {
+    password?: string;
+    refresh_token_hash: string | null;
+    mfa_enabled: boolean;
+    mfa_secret: string | null;
+    mfa_backup_codes: string[] | null;
+    verification_token_hash: string | null;
+    verification_token_for: VerificationPurposeEnum | null;
+    verification_token_expires_at: Date | null;
+}
+export type PersistedUser = User & UserSecurity;
+export interface UserWithRole extends User {
+    role_id: string;
+    role: RoleWithPermissions;
+    permissions?: string[];
+}
+export interface AdministratorUser extends UserWithRole {
+    account_type: UserAccountTypeEnum.ADMINISTRATOR;
+}
+export interface VendorUser extends UserWithRole {
+    account_type: UserAccountTypeEnum.VENDOR;
+    businesses: Vendor[];
+}
+export interface CustomerUser extends User {
+    account_type: UserAccountTypeEnum.CUSTOMER;
+    dietary_preferences?: string[];
+    addresses?: AddressI[];
+    orders?: string[];
+}
+export type UserAggregate = AdministratorUser | VendorUser | CustomerUser;
+export type PublicUser = Omit<UserAggregate, "token_version" | "deleted_at">;
+export type CreateUserInput = Omit<User, "id" | "token_version" | "last_login_at" | "last_login_ip" | "password_changed_at" | "last_consented_at" | "deleted_at" | "created_at" | "updated_at"> & {
+    password: string;
+    role_id?: string;
+};
+export type UpdateUserInput = Partial<Omit<User, "id" | "account_type" | "account_status" | "token_version" | "created_at" | "updated_at">>;
+export interface SuccessfulUserRegistrationResponse {
+    data: {
+        user: PublicUser;
+        vendor?: Vendor;
+    };
+    payload?: unknown;
+    subject: string;
+    context?: string;
+    message?: string;
+}

package/build/types/user.js

@@ -0,0 +1,5 @@
+"use strict";
+// =========================================
+// USER DOMAIN MODEL (PRODUCTION READY)
+// =========================================
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/types/vendor.d.ts

@@ -0,0 +1,126 @@
+import { AddressI } from "./address";
+import { PromotionTypeEnum, ScopeEnum, VendorStatusEnum } from "./enum/collection";
+import { AddressPayloadType, UUID } from "./global";
+import { MenuWithMeals } from "./menu_n_meal";
+import { VendorUser } from "./user";
+export type CuisineType = "African" | "Asian" | "Continental" | "Mediterranean" | "American";
+export type AmbienceType = "Casual" | "Fine Dining" | "Family Friendly" | "Romantic" | "Outdoor" | "Rooftop";
+export type StoreType = "Supermarket" | "Organic Store" | "Wholesale" | "Convenience Store" | "Mini Mart";
+export type GroceryCategory = "Fresh Produce" | "Frozen Foods" | "Household Items" | "Beverages" | "Snacks" | "Meat & Poultry" | "Dairy";
+type OperatingHours = {
+    day: "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday";
+    open: string;
+    close: string;
+    is_closed: boolean;
+};
+export interface Vendor {
+    id: UUID;
+    owner_id: UUID;
+    business_name: string;
+    slug: string;
+    sku_prefix: string;
+    description: string | null;
+    scope: ScopeEnum;
+    business_status: VendorStatusEnum;
+    contact_email: string;
+    contact_phone: string;
+    business_address?: AddressI;
+    location?: string;
+    logo_url: string | null;
+    banner_url: string | null;
+    operating_hours: OperatingHours[];
+    is_accepting_orders: boolean;
+    avg_preparation_time_minutes: number | null;
+    rating: number;
+    review_count: number;
+    payout_provider_account_id: string | null;
+    verification_documents: unknown;
+    approved_by: string | null;
+    approved_on: Date | null;
+    is_featured?: boolean;
+    created_at: Date;
+    updated_at: Date;
+    owner?: VendorUser;
+}
+export interface RestaurantInfo {
+    id: UUID;
+    vendor_id: UUID;
+    seating_capacity: number | null;
+    cuisines: CuisineType[];
+    ambience: AmbienceType[] | null;
+    tags: string[] | null;
+    offers_dine_in: boolean;
+    offers_takeaway: boolean;
+    offers_delivery: boolean;
+    has_reservation: boolean;
+    serves_alcohol: boolean;
+    has_live_music: boolean;
+    avg_cost_for_two: number | null;
+    promotion_description: string | null;
+    promotion_type: PromotionTypeEnum | null;
+    promotion_start_date: Date | null;
+    promotion_end_date: Date | null;
+    instagram_url: string | null;
+    facebook_url: string | null;
+    website_url: string | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface GroceryInfo {
+    id: UUID;
+    vendor_id: UUID;
+    store_type: StoreType[];
+    product_categories: GroceryCategory[];
+    tags: string[] | null;
+    offers_delivery: boolean;
+    offers_pickup: boolean;
+    offers_in_store_shopping: boolean;
+    is_24_hours: boolean;
+    avg_delivery_time_minutes: number | null;
+    has_bulk_pricing: boolean;
+    promotion_description: string | null;
+    promotion_type: PromotionTypeEnum | null;
+    promotion_start_date: Date | null;
+    promotion_end_date: Date | null;
+    has_pharmacy_section: boolean;
+    has_bakery_section: boolean;
+    has_butcher_section: boolean;
+    instagram_url: string | null;
+    facebook_url: string | null;
+    website_url: string | null;
+    created_at: Date;
+    updated_at: Date;
+}
+export interface RestaurantVendorAggregate extends Vendor {
+    scope: ScopeEnum.RESTAURANT;
+    restaurant_info: RestaurantInfo;
+}
+export interface GroceryVendorAggregate extends Vendor {
+    scope: ScopeEnum.GROCERY;
+    grocery_info: GroceryInfo;
+}
+export type VendorAggregate = RestaurantVendorAggregate | GroceryVendorAggregate;
+export type VendorAggregateForWeb = VendorAggregate & {
+    distance?: string | number;
+    duration?: string | number;
+    deliveryFee?: number;
+    reviews?: number;
+    rating?: number;
+    menus?: MenuWithMeals[];
+};
+export type CreateVendorInput = Omit<Vendor, "id" | "rating" | "review_count" | "business_status" | "approved_by" | "approved_on" | "created_at" | "updated_at"> & {
+    address_payload: AddressPayloadType;
+    registration_cert: File;
+    id_proof: File;
+};
+export type UpdateVendorInput = Partial<Omit<Vendor, "id" | "owner_id" | "scope" | "rating" | "review_count" | "created_at" | "updated_at">>;
+export type CreateRestaurantInfoInput = Omit<RestaurantInfo, "id" | "created_at" | "updated_at">;
+export type UpdateRestaurantInfoInput = Partial<Omit<RestaurantInfo, "id" | "vendor_id" | "created_at" | "updated_at">>;
+export type CreateGroceryInfoInput = Omit<GroceryInfo, "id" | "created_at" | "updated_at">;
+export type UpdateGroceryInfoInput = Partial<Omit<GroceryInfo, "id" | "vendor_id" | "created_at" | "updated_at">>;
+export type WebApplicationRestaurantsResourceData = {
+    restaurants: VendorAggregateForWeb[];
+    cuisines: CuisineType[];
+    ambience: AmbienceType[];
+};
+export {};

package/build/types/vendor.js

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

package/build/validators/index.d.ts

@@ -0,0 +1,2 @@
+export * from './regex';
+export * from './validate';

package/build/validators/index.js

@@ -0,0 +1,18 @@
+"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("./regex"), exports);
+__exportStar(require("./validate"), exports);

package/build/validators/regex.d.ts

@@ -0,0 +1,3 @@
+export declare const emailRegex: RegExp;
+export declare const phoneNumberRegex: RegExp;
+export declare const stringDurationToMsRegex: RegExp;

package/build/validators/regex.js

@@ -0,0 +1,6 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.stringDurationToMsRegex = exports.phoneNumberRegex = exports.emailRegex = void 0;
+exports.emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
+exports.phoneNumberRegex = /^(?:\+234|234|0)(7[0-9]|8[01]|9[01])\d{8}$/;
+exports.stringDurationToMsRegex = /^(\d+)\s*(ms|s|m|h|d|w|y)$/i;

package/build/validators/validate.d.ts

@@ -0,0 +1,3 @@
+export declare const checkIsEmailValid: (email: string) => boolean;
+export declare const checkIsPhoneNumberValid: (phoneNumber: string) => boolean;
+export declare const checkIsEmailOrPhoneValid: (account_ref: string) => "phone_number" | "email" | false;

package/build/validators/validate.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.checkIsEmailOrPhoneValid = exports.checkIsPhoneNumberValid = exports.checkIsEmailValid = void 0;
+const regex_1 = require("./regex");
+const checkIsEmailValid = (email) => {
+    return regex_1.emailRegex.test(email);
+};
+exports.checkIsEmailValid = checkIsEmailValid;
+const checkIsPhoneNumberValid = (phoneNumber) => {
+    return regex_1.phoneNumberRegex.test(phoneNumber);
+};
+exports.checkIsPhoneNumberValid = checkIsPhoneNumberValid;
+const checkIsEmailOrPhoneValid = (account_ref) => {
+    const validEmail = (0, exports.checkIsEmailValid)(account_ref);
+    const validPhoneNumber = (0, exports.checkIsPhoneNumberValid)(account_ref);
+    if (validEmail) {
+        return 'email';
+    }
+    if (validPhoneNumber) {
+        return 'phone_number';
+    }
+    return false;
+};
+exports.checkIsEmailOrPhoneValid = checkIsEmailOrPhoneValid;

package/package.json

@@ -0,0 +1,29 @@
+{
+  "name": "@chopkola/common",
+  "version": "1.0.213",
+  "description": "",
+  "license": "ISC",
+  "author": "akrosoft technology ltd",
+  "main": "./build/index.js",
+  "types": "./build/index.d.ts",
+  "files": [
+    "build/**/*"
+  ],
+  "scripts": {
+    "clean": "del ./build/*",
+    "build": "npm run clean && tsc",
+    "pub": "git add . && git commit -m \"Update\" &&  npm version patch && npm run build && npm publish"
+  },
+  "keywords": [],
+  "dependencies": {
+    "jsonwebtoken": "^9.0.3"
+  },
+  "devDependencies": {
+    "@types/jsonwebtoken": "^9.0.10",
+    "del-cli": "^7.0.0",
+    "typescript": "^5.9.3"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}