zone4code-sdk 1.0.9 → 1.0.11

package/dist/index.d.ts

@@ -5,13 +5,13 @@ interface StorageAdapter {
 }
 interface Zone4CodeConfig {
     /**
-     * The base URL of the API Gateway (e.g., 'http://localhost:8080' or 'https://api.yourdomain.com')
+     * The base URL of the API Gateway (defaults to ZONE4BUILD_GATEWAY_URL, VITE_ZONE4BUILD_GATEWAY_URL, or https://api.zone4build.com)
      */
-    gatewayUrl: string;
+    gatewayUrl?: string;
     /**
-     * Default tenant identifier (workspace ID)
+     * Default tenant identifier (defaults to ZONE4BUILD_WORKSPACE_ID, VITE_ZONE4BUILD_WORKSPACE_ID, or 'default')
      */
-    tenantId: string;
+    tenantId?: string;
     /**
      * Optional initial JWT authorization token
      */
@@ -295,6 +295,398 @@ declare class AuthClient {
     logout(): void;
 }
 
+interface ProductItem {
+    id: string | number;
+    name: string;
+    slug: string;
+    description?: string;
+    price: number;
+    sale_price?: number | null;
+    min_price?: number;
+    max_price?: number;
+    sku?: string;
+    quantity?: number;
+    in_stock?: boolean;
+    is_taxable?: boolean;
+    status?: string;
+    product_type?: string;
+    image?: {
+        id: string;
+        original: string;
+        thumbnail?: string;
+    };
+    gallery?: Array<{
+        id: string;
+        original: string;
+        thumbnail?: string;
+    }>;
+    categories?: Array<{
+        id: string | number;
+        name: string;
+        slug: string;
+    }>;
+    shop_id?: string | number;
+    created_at?: string;
+    updated_at?: string;
+    [key: string]: any;
+}
+interface ProductPaginator {
+    data: ProductItem[];
+    count?: number;
+    total?: number;
+    currentPage?: number;
+    lastPage?: number;
+    perPage?: number;
+    first_page_url?: string;
+    last_page_url?: string;
+    next_page_url?: string;
+    prev_page_url?: string;
+}
+interface CategoryItem {
+    id: string | number;
+    name: string;
+    slug: string;
+    icon?: string;
+    image?: {
+        id: string;
+        original: string;
+        thumbnail?: string;
+    };
+    details?: string;
+    parent_id?: string | number | null;
+    children?: CategoryItem[];
+    products_count?: number;
+    [key: string]: any;
+}
+interface OrderItem {
+    id: string | number;
+    tracking_number: string;
+    customer_id?: string;
+    customer_contact?: string;
+    customer_name?: string;
+    amount: number;
+    total: number;
+    paid_total?: number;
+    payment_id?: string;
+    payment_gateway?: string;
+    payment_status?: string;
+    delivery_fee?: number;
+    sales_tax?: number;
+    discount?: number;
+    coupon_id?: string | number | null;
+    status?: {
+        id: string | number;
+        name: string;
+        serial?: number;
+        color?: string;
+    };
+    products?: Array<{
+        id: string | number;
+        name: string;
+        pivot?: {
+            order_quantity: number;
+            unit_price: number;
+            subtotal: number;
+        };
+    }>;
+    shipping_address?: Record<string, any>;
+    billing_address?: Record<string, any>;
+    created_at?: string;
+    updated_at?: string;
+    [key: string]: any;
+}
+interface CreateOrderPayload {
+    products: Array<{
+        product_id: string | number;
+        order_quantity: number;
+        unit_price?: number;
+        subtotal?: number;
+    }>;
+    amount?: number;
+    total?: number;
+    coupon_id?: string | number;
+    discount?: number;
+    sales_tax?: number;
+    delivery_fee?: number;
+    customer_contact?: string;
+    customer_name?: string;
+    payment_gateway?: string;
+    use_wallet_points?: boolean;
+    shipping_address?: Record<string, any>;
+    billing_address?: Record<string, any>;
+    note?: string;
+    [key: string]: any;
+}
+interface VerifyCheckoutPayload {
+    amount: number;
+    products: Array<{
+        product_id: string | number;
+        order_quantity: number;
+        unit_price?: number;
+    }>;
+    billing_address?: Record<string, any>;
+    shipping_address?: Record<string, any>;
+}
+interface VerifyCheckoutResponse {
+    total_tax: number;
+    shipping_charge: number;
+    unavailable_products: Array<string | number>;
+    wallet_amount?: number;
+    wallet_currency?: number;
+}
+interface VerifyCouponPayload {
+    code: string;
+    sub_total: number;
+}
+interface CouponItem {
+    id: string | number;
+    code: string;
+    description?: string;
+    amount: number;
+    type?: 'fixed' | 'percentage' | 'free_shipping';
+    is_valid: boolean;
+}
+declare class CommerceClient {
+    private gatewayUrl;
+    private tenantId;
+    private fetchWithAuth;
+    private fetchFn;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        fetchWithAuth: (url: string, init?: RequestInit) => Promise<Response>;
+        fetchFn: typeof fetch;
+    });
+    /**
+     * List catalog products with search, category filtering, and pagination
+     */
+    getProducts(params?: {
+        search?: string;
+        category?: string;
+        status?: string;
+        limit?: number;
+        page?: number;
+        orderBy?: string;
+        sortedBy?: 'ASC' | 'DESC' | 'asc' | 'desc';
+        language?: string;
+        type?: string;
+    }): Promise<ProductPaginator>;
+    /**
+     * Get a single product by slug or ID
+     */
+    getProductBySlug(slug: string, language?: string): Promise<ProductItem>;
+    /**
+     * Create a new product (requires merchant/admin authentication)
+     */
+    createProduct(product: Partial<ProductItem>): Promise<ProductItem>;
+    /**
+     * List store categories
+     */
+    getCategories(params?: {
+        parent?: string | number;
+        limit?: number;
+        page?: number;
+    }): Promise<CategoryItem[]>;
+    /**
+     * Create a new customer checkout order
+     */
+    createOrder(payload: CreateOrderPayload): Promise<OrderItem>;
+    /**
+     * Verify checkout taxes, shipping fees, and product availability
+     */
+    verifyCheckout(payload: VerifyCheckoutPayload): Promise<VerifyCheckoutResponse>;
+    /**
+     * Track order by tracking number
+     */
+    trackOrder(trackingNumber: string): Promise<OrderItem>;
+    /**
+     * List customer orders (authenticated)
+     */
+    getOrders(params?: {
+        limit?: number;
+        page?: number;
+        tracking_number?: string;
+    }): Promise<{
+        data: OrderItem[];
+    }>;
+    /**
+     * Verify and calculate discount for a promo coupon code
+     */
+    verifyCoupon(payload: VerifyCouponPayload): Promise<{
+        is_valid: boolean;
+        coupon?: CouponItem;
+    }>;
+    /**
+     * Get store and commerce configuration settings
+     */
+    getSettings(): Promise<Record<string, any>>;
+}
+
+interface UploadResult {
+    id: string;
+    original: string;
+    thumbnail?: string;
+    filename: string;
+    size: number;
+    mimetype: string;
+}
+interface DocumentItem {
+    id: string;
+    name: string;
+    url: string;
+    size?: number;
+    mimeType?: string;
+    folderId?: string | null;
+    tenantId?: string;
+    createdAt?: string;
+    updatedAt?: string;
+}
+interface FolderItem {
+    id: string;
+    name: string;
+    parentId?: string | null;
+    tenantId?: string;
+    createdAt?: string;
+}
+declare class DocClient {
+    private gatewayUrl;
+    private tenantId;
+    private fetchWithAuth;
+    private fetchFn;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        fetchWithAuth: (url: string, init?: RequestInit) => Promise<Response>;
+        fetchFn: typeof fetch;
+    });
+    /**
+     * Upload one or more files to object storage (S3/MinIO) with automated thumbnailing
+     */
+    upload(files: FormData | File | File[] | Blob | Blob[]): Promise<UploadResult[]>;
+    /**
+     * List documents with optional folder filtering and pagination
+     */
+    list(params?: {
+        folderId?: string;
+        page?: number;
+        limit?: number;
+    }): Promise<DocumentItem[]>;
+    /**
+     * Get a single document record by ID
+     */
+    get(id: string): Promise<DocumentItem>;
+    /**
+     * Delete a document by ID
+     */
+    delete(id: string): Promise<{
+        success: boolean;
+    }>;
+    /**
+     * List document folders
+     */
+    listFolders(): Promise<FolderItem[]>;
+    /**
+     * Create a new folder for organizing documents
+     */
+    createFolder(name: string, parentId?: string): Promise<FolderItem>;
+}
+
+interface SendSmsPayload {
+    to: string;
+    message: string;
+    from?: string;
+    provider?: string;
+}
+interface SmsResponse {
+    success: boolean;
+    messageId?: string;
+    status?: string;
+    error?: string;
+}
+interface SendEmailPayload {
+    to: string | string[];
+    subject: string;
+    html?: string;
+    text?: string;
+    templateId?: string;
+    templateData?: Record<string, any>;
+    localeCode?: string;
+    shopSlug?: string;
+}
+interface EmailResponse {
+    success: boolean;
+    messageId?: string;
+    status?: string;
+    error?: string;
+}
+interface SendPushPayload {
+    token?: string;
+    tokens?: string[];
+    topic?: string;
+    title: string;
+    body: string;
+    data?: Record<string, string>;
+}
+interface PushResponse {
+    success: boolean;
+    messageId?: string;
+    status?: string;
+    error?: string;
+}
+interface PushRegistrationPayload {
+    token: string;
+    userId?: string;
+    platform?: 'ios' | 'android' | 'web';
+    metadata?: Record<string, any>;
+}
+interface NotificationItem {
+    id: string;
+    userId?: string;
+    title: string;
+    message: string;
+    type?: string;
+    read?: boolean;
+    createdAt?: string;
+}
+declare class NotificationClient {
+    private gatewayUrl;
+    private tenantId;
+    private fetchWithAuth;
+    private fetchFn;
+    constructor(options: {
+        gatewayUrl: string;
+        tenantId: string;
+        fetchWithAuth: (url: string, init?: RequestInit) => Promise<Response>;
+        fetchFn: typeof fetch;
+    });
+    /**
+     * Send an SMS message via configured SMS gateways (Twilio / SMS API)
+     */
+    sendSms(payload: SendSmsPayload): Promise<SmsResponse>;
+    /**
+     * Send an email or template email
+     */
+    sendEmail(payload: SendEmailPayload): Promise<EmailResponse>;
+    /**
+     * Send Firebase Cloud Messaging (FCM) Push Notification
+     */
+    sendPush(payload: SendPushPayload): Promise<PushResponse>;
+    /**
+     * Register a device push token for push notifications
+     */
+    registerPushToken(payload: PushRegistrationPayload): Promise<{
+        success: boolean;
+        id?: string;
+    }>;
+    /**
+     * Get recent in-app notifications
+     */
+    list(params?: {
+        page?: number;
+        limit?: number;
+    }): Promise<NotificationItem[]>;
+}
+
 declare class EntityQueryBuilder<T = Record<string, any>> {
     private gatewayUrl;
     private tenantId;
@@ -468,10 +860,19 @@ declare class Zone4CodeClient {
     readonly tenantId: string;
     readonly auth: AuthClient;
     readonly schema: SchemaClient;
+    readonly doc: DocClient;
+    readonly notification: NotificationClient;
+    readonly commerce: CommerceClient;
     private storage;
     private fetchFn;
     private currentLanguage;
-    constructor(config: Zone4CodeConfig);
+    constructor(config?: Zone4CodeConfig);
+    readonly generic: {
+        from: <T = Record<string, any>>(typeName: string) => EntityQueryBuilder<T>;
+        entities: <T = Record<string, any>>(typeName: string) => EntityQueryBuilder<T>;
+        schema: SchemaClient;
+        getMe: () => Promise<UserProfileWithWallet>;
+    };
     /**
      * Set the active default language for API requests (e.g., 'en', 'fr', 'ar', or '*' for raw)
      */
@@ -517,4 +918,4 @@ declare class MemoryStorage implements StorageAdapter {
 }
 declare function getDefaultStorage(): StorageAdapter;
 
-export { AuthClient, type AuthResponse, type AuthUser, type EntityListResponse, EntityQueryBuilder, type EntityRecord, type EntityRelationPayload, type EntityRelationRecord, type EntityReplaceRelationsPayload, type EntityRevision, type EntitySchemaDefinition, type FilterOperator, type GetEntityOptions, MemoryStorage, SchemaClient, type SchemaProperty, type StorageAdapter, type Translatable, type UserProfileWithWallet, Zone4CodeClient, type Zone4CodeConfig, createClient, createClient as default, getDefaultStorage };
+export { AuthClient, type AuthResponse, type AuthUser, type CategoryItem, CommerceClient, type CouponItem, type CreateOrderPayload, DocClient, type DocumentItem, type EmailResponse, type EntityListResponse, EntityQueryBuilder, type EntityRecord, type EntityRelationPayload, type EntityRelationRecord, type EntityReplaceRelationsPayload, type EntityRevision, type EntitySchemaDefinition, type FilterOperator, type FolderItem, type GetEntityOptions, MemoryStorage, NotificationClient, type NotificationItem, type OrderItem, type ProductItem, type ProductPaginator, type PushRegistrationPayload, type PushResponse, SchemaClient, type SchemaProperty, type SendEmailPayload, type SendPushPayload, type SendSmsPayload, type SmsResponse, type StorageAdapter, type Translatable, type UploadResult, type UserProfileWithWallet, type VerifyCheckoutPayload, type VerifyCheckoutResponse, type VerifyCouponPayload, Zone4CodeClient, type Zone4CodeConfig, createClient, createClient as default, getDefaultStorage };