@basedone/core 0.1.8 → 0.2.0

package/lib/ecommerce/types/enums.ts

@@ -0,0 +1,270 @@
+/**
+ * Ecommerce Type Enums
+ * 
+ * This module contains all enum types used in the ecommerce API.
+ */
+
+/**
+ * Order status enum representing the lifecycle of an order
+ */
+export enum OrderStatus {
+  /** Order created but payment not initiated */
+  CREATED = "CREATED",
+  /** Awaiting escrow deposit from customer */
+  AWAITING_DEPOSIT = "AWAITING_DEPOSIT",
+  /** Payment reserved in escrow */
+  PAYMENT_RESERVED = "PAYMENT_RESERVED",
+  /** Merchant has accepted the order */
+  MERCHANT_ACCEPTED = "MERCHANT_ACCEPTED",
+  /** Order has been shipped */
+  SHIPPED = "SHIPPED",
+  /** Order has been delivered */
+  DELIVERED = "DELIVERED",
+  /** Order has been cancelled */
+  CANCELLED = "CANCELLED",
+  /** Order is confirmed (legacy status) */
+  CONFIRMED = "CONFIRMED",
+  /** Order is completed (legacy status) */
+  COMPLETED = "COMPLETED",
+}
+
+/**
+ * Payment method enum
+ */
+export enum PaymentMethod {
+  /** USDC payment via Hyperliquid escrow */
+  USDC_ESCROW = "USDC_ESCROW",
+  /** Points-based payment */
+  POINTS = "POINTS",
+}
+
+/**
+ * Payment status enum
+ */
+export enum PaymentStatus {
+  /** Payment is pending */
+  PENDING = "PENDING",
+  /** Payment is reserved in escrow */
+  RESERVED = "RESERVED",
+  /** Payment is completed */
+  COMPLETED = "COMPLETED",
+  /** Payment failed */
+  FAILED = "FAILED",
+  /** Payment was refunded */
+  REFUNDED = "REFUNDED",
+}
+
+/**
+ * Merchant status enum
+ */
+export enum MerchantStatus {
+  /** Merchant is active */
+  ACTIVE = "ACTIVE",
+  /** Merchant is suspended */
+  SUSPENDED = "SUSPENDED",
+  /** Merchant is pending approval */
+  PENDING = "PENDING",
+}
+
+/**
+ * Shipment status enum
+ */
+export enum ShipmentStatus {
+  /** Shipment is pending */
+  PENDING = "PENDING",
+  /** Shipment is in transit */
+  SHIPPED = "SHIPPED",
+  /** Shipment is delivered */
+  DELIVERED = "DELIVERED",
+  /** Shipment failed */
+  FAILED = "FAILED",
+}
+
+/**
+ * Return status enum
+ */
+export enum ReturnStatus {
+  /** Return requested by customer */
+  REQUESTED = "REQUESTED",
+  /** Return approved by merchant */
+  APPROVED = "APPROVED",
+  /** Return rejected by merchant */
+  REJECTED = "REJECTED",
+  /** Return item shipped back */
+  SHIPPED_BACK = "SHIPPED_BACK",
+  /** Return item received by merchant */
+  RECEIVED = "RECEIVED",
+  /** Refund processed */
+  REFUNDED = "REFUNDED",
+}
+
+/**
+ * Review status enum
+ */
+export enum ReviewStatus {
+  /** Review is pending */
+  PENDING = "PENDING",
+  /** Review has been responded to */
+  RESPONDED = "RESPONDED",
+  /** Review has been flagged */
+  FLAGGED = "FLAGGED",
+}
+
+/**
+ * Discount type enum
+ */
+export enum DiscountType {
+  /** Percentage discount */
+  PERCENTAGE = "PERCENTAGE",
+  /** Fixed amount discount */
+  FIXED_AMOUNT = "FIXED_AMOUNT",
+  /** Buy X get Y discount */
+  BUY_X_GET_Y = "BUY_X_GET_Y",
+  /** Free shipping */
+  FREE_SHIPPING = "FREE_SHIPPING",
+}
+
+/**
+ * Discount method enum
+ */
+export enum DiscountMethod {
+  /** Code-based discount (coupon) */
+  CODE = "CODE",
+  /** Automatic discount */
+  AUTOMATIC = "AUTOMATIC",
+}
+
+/**
+ * Discount scope enum
+ */
+export enum DiscountScope {
+  /** Applies to entire order */
+  ORDER = "ORDER",
+  /** Applies to specific products */
+  PRODUCT = "PRODUCT",
+  /** Applies to specific categories */
+  CATEGORY = "CATEGORY",
+  /** Applies to shipping */
+  SHIPPING = "SHIPPING",
+}
+
+/**
+ * Banner type enum
+ */
+export enum BannerType {
+  /** Hero banner */
+  HERO = "HERO",
+  /** Promotional banner */
+  PROMO = "PROMO",
+  /** Featured banner */
+  FEATURED = "FEATURED",
+}
+
+/**
+ * Tax type enum
+ */
+export enum TaxType {
+  /** Sales tax */
+  SALES_TAX = "SALES_TAX",
+  /** Value-added tax */
+  VAT = "VAT",
+  /** Goods and services tax */
+  GST = "GST",
+  /** Provincial sales tax */
+  PST = "PST",
+  /** Harmonized sales tax */
+  HST = "HST",
+}
+
+/**
+ * Tax behavior enum
+ */
+export enum TaxBehavior {
+  /** Charge tax on top of price */
+  CHARGE = "CHARGE",
+  /** Tax is included in price */
+  INCLUSIVE = "INCLUSIVE",
+  /** No tax */
+  EXEMPT = "EXEMPT",
+}
+
+/**
+ * Tax report period type enum
+ */
+export enum TaxReportPeriodType {
+  /** Monthly report */
+  MONTHLY = "MONTHLY",
+  /** Quarterly report */
+  QUARTERLY = "QUARTERLY",
+  /** Yearly report */
+  YEARLY = "YEARLY",
+}
+
+/**
+ * Tax report status enum
+ */
+export enum TaxReportStatus {
+  /** Report is in draft */
+  DRAFT = "DRAFT",
+  /** Report is finalized */
+  FINALIZED = "FINALIZED",
+  /** Report has been filed */
+  FILED = "FILED",
+}
+
+/**
+ * Inventory audit action enum
+ */
+export enum InventoryAuditAction {
+  /** Inventory created */
+  CREATED = "CREATED",
+  /** Inventory updated */
+  UPDATED = "UPDATED",
+  /** Inventory reserved */
+  RESERVED = "RESERVED",
+  /** Inventory deducted */
+  DEDUCTED = "DEDUCTED",
+  /** Inventory restored */
+  RESTORED = "RESTORED",
+}
+
+/**
+ * Sort order enum
+ */
+export enum SortOrder {
+  /** Ascending order */
+  ASC = "asc",
+  /** Descending order */
+  DESC = "desc",
+}
+
+/**
+ * Product sort by enum
+ */
+export enum ProductSortBy {
+  /** Sort by date (newest first) */
+  DATE_DESC = "date_desc",
+  /** Sort by date (oldest first) */
+  DATE_ASC = "date_asc",
+  /** Sort by price (low to high) */
+  PRICE_ASC = "price_asc",
+  /** Sort by price (high to low) */
+  PRICE_DESC = "price_desc",
+  /** Sort by popularity */
+  POPULAR = "popular",
+  /** Sort by featured status */
+  FEATURED = "featured",
+}
+
+/**
+ * Review sort by enum
+ */
+export enum ReviewSortBy {
+  /** Sort by newest */
+  NEWEST = "newest",
+  /** Sort by highest rating */
+  HIGHEST = "highest",
+  /** Sort by lowest rating */
+  LOWEST = "lowest",
+}
+

package/lib/ecommerce/types/index.ts

@@ -0,0 +1,18 @@
+/**
+ * Ecommerce Types Module
+ * 
+ * This module exports all TypeScript types and interfaces for the ecommerce API.
+ */
+
+// Export all enums
+export * from "./enums";
+
+// Export all entities
+export * from "./entities";
+
+// Export all request types
+export * from "./requests";
+
+// Export all response types
+export * from "./responses";
+