@use-stall/core 0.0.5 → 0.0.7

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-import { ConnectorModuleKey, UnifiedProductType, UnifiedVariantsType, UnifiedCollectionType, UnifiedCategoryType, UnifiedInventoryLevelType, UnifiedPromotion, UnifiedOrderType, UnifiedOrderNote, UnifiedOrderRefundType, UnifiedPaymentProviderType, UnifiedPaymentCollectionType, UnifiedTaxRegionType, UnifiedTaxRateType, UnifiedCustomerType, UnifiedLocationType, UnifiedFulfillmentType } from '@use-stall/types';
+import { ConnectorModuleKey, UnifiedProductType, UnifiedVariantsType, UnifiedCollectionType, UnifiedCategoryType, UnifiedTagProductTag, UnifiedInventoryLevelType, UnifiedPromotion, UnifiedOrderType, UnifiedOrderNote, UnifiedOrderRefundType, UnifiedPaymentProviderType, UnifiedPaymentCollectionType, UnifiedTaxRegionType, UnifiedTaxRateType, UnifiedCustomerType, UnifiedLocationType, UnifiedFulfillmentMethodType, UnifiedFulfillmentProviderConfigType, UnifiedFulfillmentType } from '@use-stall/types';
+import Dexie, { EntityTable } from 'dexie';
 
 interface StallCoreConfigOptions {
   connector_url: string;
@@ -17,7 +18,7 @@ type ModuleTypeMap = {
   variants: UnifiedVariantsType;
   collections: UnifiedCollectionType;
   categories: UnifiedCategoryType;
-  tags: string;
+  tags: UnifiedTagProductTag;
   inventory_levels: UnifiedInventoryLevelType;
   inventory_history: UnifiedInventoryLevelType;
   promotions: UnifiedPromotion;
@@ -30,8 +31,8 @@ type ModuleTypeMap = {
   tax_rates: UnifiedTaxRateType;
   customers: UnifiedCustomerType;
   locations: UnifiedLocationType;
-  fulfillment_types: string;
-  fulfillment_providers: string;
+  fulfillment_types: UnifiedFulfillmentMethodType;
+  fulfillment_providers: UnifiedFulfillmentProviderConfigType;
   fulfillments: UnifiedFulfillmentType;
 };
 
@@ -82,7 +83,7 @@ declare const initializeStallCore: (options: StallCoreConfigOptions) => CoreConf
 declare const products: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedProductType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -160,7 +161,7 @@ declare const orders: {
 declare const customers: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedCustomerType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -199,7 +200,7 @@ declare const customers: {
 declare const collections: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedCollectionType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -238,7 +239,7 @@ declare const collections: {
 declare const categories: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedCategoryType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -277,7 +278,7 @@ declare const categories: {
 declare const variants: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedVariantsType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -316,7 +317,7 @@ declare const variants: {
 declare const inventory_levels: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedInventoryLevelType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -355,7 +356,7 @@ declare const inventory_levels: {
 declare const promotions: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedPromotion[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -394,7 +395,7 @@ declare const promotions: {
 declare const order_notes: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedOrderNote[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -433,7 +434,7 @@ declare const order_notes: {
 declare const refunds: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedOrderRefundType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -472,7 +473,7 @@ declare const refunds: {
 declare const payment_providers: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedPaymentProviderType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -511,7 +512,7 @@ declare const payment_providers: {
 declare const payments: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedPaymentCollectionType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -550,7 +551,7 @@ declare const payments: {
 declare const tax_regions: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedTaxRegionType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -589,7 +590,7 @@ declare const tax_regions: {
 declare const tax_rates: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedTaxRateType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -628,7 +629,7 @@ declare const tax_rates: {
 declare const locations: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedLocationType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -667,7 +668,7 @@ declare const locations: {
 declare const fulfillments: {
     list: (props: {
         sdk: CoreConfig;
-        query: string;
+        query?: string;
     }) => Promise<UnifiedFulfillmentType[]>;
     retrieve: (props: {
         sdk: CoreConfig;
@@ -703,4 +704,198 @@ declare const fulfillments: {
     }) => Promise<void>;
 };
 
-export { categories, collections, customers, fulfillments, initializeStallCore, inventory_levels, locations, order_notes, orders, payment_providers, payments, products, promotions, refunds, tax_rates, tax_regions, variants };
+interface ConnectorCacheType {
+    id: string;
+    code: string;
+    timestamp: number;
+}
+interface SyncQueueType {
+    id: string;
+    action: "create" | "update" | "delete";
+    table: ConnectorModuleKey;
+    document_id: string;
+    stall_offline_id: string;
+    data: Record<string, any>;
+    timestamp: number;
+    status: "pending" | "syncing" | "completed" | "failed";
+    error?: string;
+    retry_count: number;
+    last_retry_at?: number;
+}
+interface SyncLogType {
+    id: string;
+    sync_batch_id: string;
+    table: ConnectorModuleKey;
+    action: "create" | "update" | "delete";
+    document_id: string;
+    stall_offline_id: string;
+    connector_id?: string;
+    status: "success" | "failed" | "pending";
+    error?: string;
+    timestamp: number;
+    duration_ms: number;
+}
+type ConnectorCacheTable = EntityTable<ConnectorCacheType, "id">;
+type SyncQueueTable = EntityTable<SyncQueueType, "id">;
+type SyncLogTable = EntityTable<SyncLogType, "id">;
+type ProductsTable = EntityTable<UnifiedProductType, "id">;
+type VariantsTable = EntityTable<UnifiedVariantsType, "id">;
+type CollectionsTable = EntityTable<UnifiedCollectionType, "id">;
+type CategoriesTable = EntityTable<UnifiedCategoryType, "id">;
+type InventoryLevelsTable = EntityTable<UnifiedInventoryLevelType, "id">;
+type InventoryHistoryTable = EntityTable<UnifiedInventoryLevelType, "id">;
+type PromotionsTable = EntityTable<UnifiedPromotion, "id">;
+type OrdersTable = EntityTable<UnifiedOrderType, "id">;
+type OrderNotesTable = EntityTable<UnifiedOrderNote, "id">;
+type RefundsTable = EntityTable<UnifiedOrderRefundType, "id">;
+type PaymentProvidersTable = EntityTable<UnifiedPaymentProviderType, "id">;
+type PaymentsTable = EntityTable<UnifiedPaymentCollectionType, "id">;
+type TaxRegionsTable = EntityTable<UnifiedTaxRegionType, "id">;
+type TaxRatesTable = EntityTable<UnifiedTaxRateType, "id">;
+type CustomersTable = EntityTable<UnifiedCustomerType, "id">;
+type LocationsTable = EntityTable<UnifiedLocationType, "id">;
+type FulfillmentsTable = EntityTable<UnifiedFulfillmentType, "id">;
+
+declare const sync_service: {
+    process_sync_queue: (props: {
+        sdk: CoreConfig;
+    }) => Promise<{
+        sync_batch_id: string;
+        total: number;
+        synced: number;
+        failed: number;
+        summary: {
+            table: ConnectorModuleKey;
+            synced: number;
+            failed: number;
+        }[];
+    }>;
+    sync_queue_item: (props: {
+        sdk: CoreConfig;
+        item: SyncQueueType;
+        sync_batch_id: string;
+    }) => Promise<{
+        success: boolean;
+        connector_id?: string;
+        error?: string;
+    }>;
+    start_sync_service: (props: {
+        sdk: CoreConfig;
+        interval?: number;
+    }) => Promise<void>;
+    stop_sync_service: () => void;
+    get_sync_stats: () => Promise<{
+        pending: number;
+        syncing: number;
+        failed: number;
+        total: number;
+    }>;
+    trigger_sync: (props: {
+        sdk: CoreConfig;
+    }) => Promise<{
+        sync_batch_id: string;
+        total: number;
+        synced: number;
+        failed: number;
+        summary: {
+            table: ConnectorModuleKey;
+            synced: number;
+            failed: number;
+        }[];
+    }>;
+};
+
+/**
+ * Generate a temporary offline ID
+ * Format: stall_{table}_{uuid}_{timestamp}
+ */
+declare const generate_offline_id: (table: string) => string;
+/**
+ * Save bulk data to local database, clearing existing data
+ */
+declare const save_bulk_data: (props: {
+    table: string;
+    data: any[];
+}) => Promise<void>;
+/**
+ * Add a single item to the sync queue for later synchronization
+ */
+declare const add_to_sync_queue: (props: {
+    action: "create" | "update" | "delete";
+    table: ConnectorModuleKey;
+    document_id: string;
+    stall_offline_id: string;
+    data: Record<string, any>;
+}) => Promise<SyncQueueType>;
+/**
+ * Get pending sync queue items grouped by table for dependency-aware syncing
+ */
+declare const get_pending_sync_queue: () => Promise<Map<ConnectorModuleKey, SyncQueueType[]>>;
+/**
+ * Update sync queue item status
+ */
+declare const update_sync_queue_status: (props: {
+    id: string;
+    status: "pending" | "syncing" | "completed" | "failed";
+    error?: string;
+    retry_count?: number;
+}) => Promise<void>;
+/**
+ * Remove item from sync queue after successful sync
+ */
+declare const remove_from_sync_queue: (id: string) => Promise<void>;
+/**
+ * Add a sync log entry for tracking synchronization activities
+ */
+declare const add_sync_log: (props: {
+    sync_batch_id: string;
+    table: ConnectorModuleKey;
+    action: "create" | "update" | "delete";
+    document_id: string;
+    stall_offline_id: string;
+    connector_id?: string;
+    status: "success" | "failed" | "pending";
+    error?: string;
+    duration_ms: number;
+}) => Promise<SyncLogType>;
+/**
+ * Get sync logs for a specific batch
+ */
+declare const get_sync_logs_by_batch: (sync_batch_id: string) => Promise<SyncLogType[]>;
+/**
+ * Get recent sync logs with optional filtering
+ */
+declare const get_recent_sync_logs: (props?: {
+    limit?: number;
+    table?: ConnectorModuleKey;
+    status?: "success" | "failed" | "pending";
+}) => Promise<SyncLogType[]>;
+/**
+ * Clear old sync logs (keep last N days)
+ */
+declare const cleanup_old_sync_logs: (days?: number) => Promise<void>;
+
+declare const local_db: Dexie & {
+    connector_cache: ConnectorCacheTable;
+    sync_queue: SyncQueueTable;
+    sync_logs: SyncLogTable;
+    products: ProductsTable;
+    variants: VariantsTable;
+    collections: CollectionsTable;
+    categories: CategoriesTable;
+    inventory_levels: InventoryLevelsTable;
+    inventory_history: InventoryHistoryTable;
+    promotions: PromotionsTable;
+    orders: OrdersTable;
+    order_notes: OrderNotesTable;
+    refunds: RefundsTable;
+    payment_providers: PaymentProvidersTable;
+    payments: PaymentsTable;
+    tax_regions: TaxRegionsTable;
+    tax_rates: TaxRatesTable;
+    customers: CustomersTable;
+    locations: LocationsTable;
+    fulfillments: FulfillmentsTable;
+};
+
+export { add_sync_log, add_to_sync_queue, categories, cleanup_old_sync_logs, collections, customers, fulfillments, generate_offline_id, get_pending_sync_queue, get_recent_sync_logs, get_sync_logs_by_batch, initializeStallCore, inventory_levels, local_db, locations, order_notes, orders, payment_providers, payments, products, promotions, refunds, remove_from_sync_queue, save_bulk_data, sync_service, tax_rates, tax_regions, update_sync_queue_status, variants };