@chopkola/common 1.0.124 → 1.0.125

package/build/index.d.ts

@@ -11,3 +11,5 @@ export * from './types/apis';
 export * from './types/file.types';
 export * from './types/category';
 export * from './types/vendor';
+export * from './types/menus';
+export * from './types/products';

package/build/index.js

@@ -27,3 +27,5 @@ __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/products"), exports);

package/build/types/global.d.ts

@@ -5,6 +5,12 @@ export declare const ACCESS_TOKEN_EXPIRATION_DURATION = "1h";
 export declare const REFRESH_TOKEN_EXPIRATION_DURATION = "1d";
 export declare const CART_SESSION_TOKEN_EXPIRATION_DURATION = "30d";
 export type SystemLogType = "info" | "success" | "warning" | "error";
+export type UUID = string;
+export interface Timestamps {
+    created_at: Date;
+    updated_at: Date;
+}
+export type DecimalString = string;
 export interface JwtPayload {
     first_name: string;
     last_name: string;

package/build/types/menus.d.ts

@@ -0,0 +1,83 @@
+import { CategoryI } from "./category";
+import { Timestamps, UUID } from "./global";
+export type DietaryFlag = "vegan" | "vegetarian" | "gluten-free" | "spicy" | "halal" | "kosher" | string;
+export interface AvailabilityScheduleEntry {
+    day: "Monday" | "Tuesday" | "Wednesday" | "Thursday" | "Friday" | "Saturday" | "Sunday";
+    from: string;
+    to: string;
+}
+export interface MenuItemI extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    category_id: UUID | null;
+    name: string;
+    description: string | null;
+    image_urls: string[] | null;
+    base_price: string;
+    is_available: boolean;
+    is_featured: boolean;
+    preparation_time_minutes: number | null;
+    dietary_flags: DietaryFlag[] | null;
+    nutritional_info?: Record<string, unknown>;
+}
+export interface ModifierGroupI extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    name: string;
+    min_selection: number;
+    max_selection: number;
+}
+export interface ModifierOptionI extends Timestamps {
+    id: UUID;
+    modifier_group_id: UUID;
+    name: string;
+    price_adjustment: string;
+    is_available: boolean;
+}
+export interface MenuI extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    name: string;
+    description: string | null;
+    is_active: boolean;
+    availability_schedule: AvailabilityScheduleEntry[] | null;
+}
+export interface MenuItemModifierGroup {
+    menu_item_id: UUID;
+    modifier_group_id: UUID;
+    sort_order: number;
+}
+export interface MenuMenuItem {
+    menu_id: UUID;
+    menu_item_id: UUID;
+    sort_order: number;
+}
+export type CreateMenuItemInput = Omit<MenuItemI, "id" | "created_at" | "updated_at">;
+export type CreateModifierGroupInput = Omit<ModifierGroupI, "id" | "created_at" | "updated_at">;
+export type CreateModifierOptionInput = Omit<ModifierOptionI, "id" | "created_at" | "updated_at">;
+export type CreateMenuInput = Omit<MenuI, "id" | "created_at" | "updated_at">;
+export interface ModifierGroupWithOptionsI extends ModifierGroupI {
+    options: ModifierOptionI[];
+    sort_order: number;
+}
+export interface MenuItemWithModifiersI extends MenuItemI {
+    modifier_groups: ModifierGroupWithOptionsI[];
+}
+export interface MenuWithItemsI extends MenuI {
+    items: (MenuItemWithModifiersI & {
+        sort_order: number;
+    })[];
+}
+export interface SelectedModifierOptionI {
+    modifier_group_id: UUID;
+    modifier_option_id: UUID;
+}
+export interface CartItem {
+    menu_item_id: UUID;
+    quantity: number;
+    selected_options: SelectedModifierOptionI[];
+}
+export interface VendorMenusManagementData {
+    categories: CategoryI[];
+    menus: MenuWithItemsI[];
+}

package/build/types/menus.js

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

package/build/types/products.d.ts

@@ -0,0 +1,92 @@
+import { DecimalString, Timestamps, UUID } from "./global";
+export declare enum StockStatus {
+    IN_STOCK = "in_stock",
+    LOW_STOCK = "low_stock",
+    OUT_OF_STOCK = "out_of_stock",
+    DISCONTINUED = "discontinued"
+}
+export declare enum StockMovementReason {
+    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"
+}
+export interface ProductAttributesI {
+    [key: string]: string | number | boolean | string[] | number[] | null;
+}
+export interface VariantOptionsI {
+    [optionName: string]: string;
+}
+export interface ProductI extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    name: string;
+    slug: string;
+    description: string | null;
+    brand: string | null;
+    images: string[] | null;
+    category_id: UUID | null;
+    tags: string[] | null;
+    attributes: ProductAttributesI | null;
+    is_approved: boolean;
+}
+export interface ProductVariantI extends Timestamps {
+    id: UUID;
+    product_id: UUID;
+    name_suffix: string | null;
+    options: VariantOptionsI;
+    images: string[] | null;
+    is_default: boolean;
+}
+export interface InventoryItemI extends Timestamps {
+    id: UUID;
+    vendor_id: UUID;
+    /**
+     * One of these must be present (enforced at DB level)
+     */
+    product_id: UUID | null;
+    product_variant_id: UUID | null;
+    sku: string;
+    price: DecimalString;
+    cost_price: DecimalString | null;
+    sale_price: DecimalString | null;
+    quantity: DecimalString;
+    low_stock_threshold: DecimalString | null;
+    stock_status: StockStatus;
+    is_trackable: boolean;
+    is_visible: boolean;
+    supplier: string | null;
+    storage_location: string | null;
+}
+export interface StockMovementI extends Timestamps {
+    id: UUID;
+    inventory_item_id: UUID;
+    quantity_change: DecimalString;
+    quantity_before: DecimalString;
+    quantity_after: DecimalString;
+    reason: StockMovementReason;
+    notes: string | null;
+    source_reference_id: UUID | null;
+    user_id: UUID | null;
+}
+export type CreateProductVariantInputI = Omit<ProductVariantI, "id" | "created_at" | "updated_at">;
+export type CreateProductInputI = Omit<ProductI, "id" | "created_at" | "updated_at">;
+export type CreateInventoryItemInputI = Omit<InventoryItemI, "id" | "created_at" | "updated_at">;
+export type CreateStockMovementInputI = Omit<StockMovementI, "id" | "created_at" | "updated_at">;
+export interface ProductWithVariantsI extends ProductI {
+    variants: ProductVariantI[];
+}
+export interface InventoryItemWithProductI extends InventoryItemI {
+    product?: ProductI | null;
+    variant?: ProductVariantI | null;
+}
+export interface InventoryLedgerI {
+    item: InventoryItemI;
+    movements: StockMovementI[];
+}

package/build/types/products.js

@@ -0,0 +1,29 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StockMovementReason = exports.StockStatus = void 0;
+var StockStatus;
+(function (StockStatus) {
+    StockStatus["IN_STOCK"] = "in_stock";
+    StockStatus["LOW_STOCK"] = "low_stock";
+    StockStatus["OUT_OF_STOCK"] = "out_of_stock";
+    StockStatus["DISCONTINUED"] = "discontinued";
+})(StockStatus || (exports.StockStatus = StockStatus = {}));
+var StockMovementReason;
+(function (StockMovementReason) {
+    StockMovementReason["SALE"] = "sale";
+    StockMovementReason["RETURN"] = "return";
+    StockMovementReason["SUPPLIER_INTAKE"] = "supplier_intake";
+    StockMovementReason["RECOUNT_ADJUSTMENT"] = "recount_adjustment";
+    StockMovementReason["DAMAGE"] = "damage";
+    StockMovementReason["THEFT"] = "theft";
+    StockMovementReason["PROMOTION"] = "promotion";
+    StockMovementReason["TRANSFER_OUT"] = "transfer_out";
+    StockMovementReason["TRANSFER_IN"] = "transfer_in";
+    StockMovementReason["INITIAL_STOCK"] = "initial_stock";
+})(StockMovementReason || (exports.StockMovementReason = StockMovementReason = {}));
+// Either product_id OR product_variant_id
+// But never both.
+// Never neither.
+// if (!input.product_id && !input.product_variant_id) {
+//   throw new Error("Inventory item must reference product or variant");
+// }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chopkola/common",
-  "version": "1.0.124",
+  "version": "1.0.125",
   "description": "",
   "license": "ISC",
   "author": "akrosoft technology ltd",