@instockng/api-client 1.0.5 → 1.0.7

package/dist/packages/api-client/src/fetchers/orders.d.ts

@@ -280,4 +280,261 @@ export declare function fetchOrder(orderId: string, token: string): Promise<{
  * @param token - User action token
  * @returns Confirmed order
  */
-export declare function confirmOrder(orderId: string, token: string): Promise<unknown>;
+export declare function confirmOrder(orderId: string, token: string): Promise<{
+    subtotal: number;
+    deliveryCharge: number;
+    totalPrice: number;
+    discountAmount: number;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string;
+    prospectSince: string;
+    lastRecoveryAttemptAt: string;
+    brand: {
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+        name: string;
+        id: string;
+        slug: string;
+        logoUrl: string | null;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string | null;
+    };
+    deliveryZone: {
+        deliveryCost: number;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+        state: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            name: string;
+            id: string;
+            isActive: boolean;
+        };
+        name: string;
+        id: string;
+        brandId: string | null;
+        stateId: string;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        isActive: boolean;
+    };
+    items: {
+        priceAtPurchase: number;
+        variant: {
+            price: number;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            product: {
+                createdAt: string;
+                updatedAt: string;
+                deletedAt: string;
+                name: string;
+                id: string;
+                slug: string;
+                brandId: string;
+                isActive: boolean;
+                description: string | null;
+                thumbnailUrl: string | null;
+                quantityDiscounts: string | number | boolean | {
+                    [x: string]: string | number | boolean | /*elided*/ any | {
+                        [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
+                        length: number;
+                        toString: never;
+                        toLocaleString: never;
+                        pop: never;
+                        push: never;
+                        concat: never;
+                        join: never;
+                        reverse: never;
+                        shift: never;
+                        slice: never;
+                        sort: never;
+                        splice: never;
+                        unshift: never;
+                        indexOf: never;
+                        lastIndexOf: never;
+                        every: never;
+                        some: never;
+                        forEach: never;
+                        map: never;
+                        filter: never;
+                        reduce: never;
+                        reduceRight: never;
+                        find: never;
+                        findIndex: never;
+                        fill: never;
+                        copyWithin: never;
+                        entries: never;
+                        keys: never;
+                        values: never;
+                        includes: never;
+                        flatMap: never;
+                        flat: never;
+                        [Symbol.iterator]: never;
+                        readonly [Symbol.unscopables]: {
+                            [x: number]: boolean;
+                            length?: boolean;
+                            toString?: boolean;
+                            toLocaleString?: boolean;
+                            pop?: boolean;
+                            push?: boolean;
+                            concat?: boolean;
+                            join?: boolean;
+                            reverse?: boolean;
+                            shift?: boolean;
+                            slice?: boolean;
+                            sort?: boolean;
+                            splice?: boolean;
+                            unshift?: boolean;
+                            indexOf?: boolean;
+                            lastIndexOf?: boolean;
+                            every?: boolean;
+                            some?: boolean;
+                            forEach?: boolean;
+                            map?: boolean;
+                            filter?: boolean;
+                            reduce?: boolean;
+                            reduceRight?: boolean;
+                            find?: boolean;
+                            findIndex?: boolean;
+                            fill?: boolean;
+                            copyWithin?: boolean;
+                            entries?: boolean;
+                            keys?: boolean;
+                            values?: boolean;
+                            includes?: boolean;
+                            flatMap?: boolean;
+                            flat?: boolean;
+                        };
+                    };
+                } | {
+                    [x: number]: string | number | boolean | {
+                        [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
+                    } | /*elided*/ any;
+                    length: number;
+                    toString: never;
+                    toLocaleString: never;
+                    pop: never;
+                    push: never;
+                    concat: never;
+                    join: never;
+                    reverse: never;
+                    shift: never;
+                    slice: never;
+                    sort: never;
+                    splice: never;
+                    unshift: never;
+                    indexOf: never;
+                    lastIndexOf: never;
+                    every: never;
+                    some: never;
+                    forEach: never;
+                    map: never;
+                    filter: never;
+                    reduce: never;
+                    reduceRight: never;
+                    find: never;
+                    findIndex: never;
+                    fill: never;
+                    copyWithin: never;
+                    entries: never;
+                    keys: never;
+                    values: never;
+                    includes: never;
+                    flatMap: never;
+                    flat: never;
+                    [Symbol.iterator]: never;
+                    readonly [Symbol.unscopables]: {
+                        [x: number]: boolean;
+                        length?: boolean;
+                        toString?: boolean;
+                        toLocaleString?: boolean;
+                        pop?: boolean;
+                        push?: boolean;
+                        concat?: boolean;
+                        join?: boolean;
+                        reverse?: boolean;
+                        shift?: boolean;
+                        slice?: boolean;
+                        sort?: boolean;
+                        splice?: boolean;
+                        unshift?: boolean;
+                        indexOf?: boolean;
+                        lastIndexOf?: boolean;
+                        every?: boolean;
+                        some?: boolean;
+                        forEach?: boolean;
+                        map?: boolean;
+                        filter?: boolean;
+                        reduce?: boolean;
+                        reduceRight?: boolean;
+                        find?: boolean;
+                        findIndex?: boolean;
+                        fill?: boolean;
+                        copyWithin?: boolean;
+                        entries?: boolean;
+                        keys?: boolean;
+                        values?: boolean;
+                        includes?: boolean;
+                        flatMap?: boolean;
+                        flat?: boolean;
+                    };
+                };
+            };
+            name: string | null;
+            id: string;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+        warehouse: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            name: string;
+            id: string;
+            isActive: boolean;
+            address: string | null;
+            city: string | null;
+            state: string | null;
+        };
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+    }[];
+    id: string;
+    email: string | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    discountCodeId: string | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    userActionToken: string;
+}>;

package/dist/packages/api-client/src/hooks/admin/orders.d.ts

@@ -9,14 +9,24 @@ import { createAdminRpcClients } from '../../rpc-client';
 /**
  * Hook to list all orders with pagination using admin RPC
  *
+ * @param filters - Query parameters for filtering orders
  * @param options - React Query options
  *
  * @example
  * ```tsx
- * const { data: orders, isLoading } = useListOrders();
+ * const { data: orders, isLoading } = useListOrders({ search: 'john', page: 1 });
  * ```
  */
-export declare function useListOrders(options?: Omit<UseQueryOptions<Awaited<ReturnType<Awaited<ReturnType<ReturnType<typeof createAdminRpcClients>['orders']['index']['$get']>>['json']>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
+export declare function useListOrders(filters?: {
+    page?: number;
+    limit?: number;
+    brandId?: string;
+    status?: string;
+    paymentMethod?: string;
+    search?: string;
+    startDate?: string;
+    endDate?: string;
+}, options?: Omit<UseQueryOptions<Awaited<ReturnType<Awaited<ReturnType<ReturnType<typeof createAdminRpcClients>['orders']['index']['$get']>>['json']>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
     data: {
         subtotal: number;
         deliveryCharge: number;
@@ -1370,7 +1380,279 @@ export declare function useUpdateOrder(orderId: string, options?: UseMutationOpt
  * @param orderId - Order UUID
  * @param options - React Query mutation options
  */
-export declare function useUpdateOrderStatus(orderId: string, options?: UseMutationOptions<Awaited<ReturnType<Awaited<ReturnType<ReturnType<typeof createAdminRpcClients>['orders'][':id']['status']['$patch']>>['json']>>, Error, any>): import("@tanstack/react-query").UseMutationResult<unknown, Error, any, unknown>;
+export declare function useUpdateOrderStatus(orderId: string, options?: UseMutationOptions<Awaited<ReturnType<Awaited<ReturnType<ReturnType<typeof createAdminRpcClients>['orders'][':id']['status']['$patch']>>['json']>>, Error, any>): import("@tanstack/react-query").UseMutationResult<{
+    subtotal: number;
+    deliveryCharge: number;
+    totalPrice: number;
+    discountAmount: number;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string;
+    prospectSince: string;
+    lastRecoveryAttemptAt: string;
+    brand: {
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+        name: string;
+        id: string;
+        slug: string;
+        logoUrl: string | null;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string | null;
+    };
+    deliveryZone: {
+        deliveryCost: number;
+        freeShippingThreshold: number;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+        state: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            name: string;
+            id: string;
+            isActive: boolean;
+        };
+        name: string;
+        id: string;
+        brandId: string | null;
+        stateId: string;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        isActive: boolean;
+    };
+    items: {
+        priceAtPurchase: number;
+        variant: {
+            price: number;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            product: {
+                createdAt: string;
+                updatedAt: string;
+                deletedAt: string;
+                name: string;
+                id: string;
+                slug: string;
+                brandId: string;
+                isActive: boolean;
+                description: string | null;
+                thumbnailUrl: string | null;
+                quantityDiscounts: string | number | boolean | {
+                    [x: string]: string | number | boolean | /*elided*/ any | {
+                        [x: number]: string | number | boolean | /*elided*/ any | /*elided*/ any;
+                        length: number;
+                        toString: never;
+                        toLocaleString: never;
+                        pop: never;
+                        push: never;
+                        concat: never;
+                        join: never;
+                        reverse: never;
+                        shift: never;
+                        slice: never;
+                        sort: never;
+                        splice: never;
+                        unshift: never;
+                        indexOf: never;
+                        lastIndexOf: never;
+                        every: never;
+                        some: never;
+                        forEach: never;
+                        map: never;
+                        filter: never;
+                        reduce: never;
+                        reduceRight: never;
+                        find: never;
+                        findIndex: never;
+                        fill: never;
+                        copyWithin: never;
+                        entries: never;
+                        keys: never;
+                        values: never;
+                        includes: never;
+                        flatMap: never;
+                        flat: never;
+                        [Symbol.iterator]: never;
+                        readonly [Symbol.unscopables]: {
+                            [x: number]: boolean;
+                            length?: boolean;
+                            toString?: boolean;
+                            toLocaleString?: boolean;
+                            pop?: boolean;
+                            push?: boolean;
+                            concat?: boolean;
+                            join?: boolean;
+                            reverse?: boolean;
+                            shift?: boolean;
+                            slice?: boolean;
+                            sort?: boolean;
+                            splice?: boolean;
+                            unshift?: boolean;
+                            indexOf?: boolean;
+                            lastIndexOf?: boolean;
+                            every?: boolean;
+                            some?: boolean;
+                            forEach?: boolean;
+                            map?: boolean;
+                            filter?: boolean;
+                            reduce?: boolean;
+                            reduceRight?: boolean;
+                            find?: boolean;
+                            findIndex?: boolean;
+                            fill?: boolean;
+                            copyWithin?: boolean;
+                            entries?: boolean;
+                            keys?: boolean;
+                            values?: boolean;
+                            includes?: boolean;
+                            flatMap?: boolean;
+                            flat?: boolean;
+                        };
+                    };
+                } | {
+                    [x: number]: string | number | boolean | {
+                        [x: string]: string | number | boolean | /*elided*/ any | /*elided*/ any;
+                    } | /*elided*/ any;
+                    length: number;
+                    toString: never;
+                    toLocaleString: never;
+                    pop: never;
+                    push: never;
+                    concat: never;
+                    join: never;
+                    reverse: never;
+                    shift: never;
+                    slice: never;
+                    sort: never;
+                    splice: never;
+                    unshift: never;
+                    indexOf: never;
+                    lastIndexOf: never;
+                    every: never;
+                    some: never;
+                    forEach: never;
+                    map: never;
+                    filter: never;
+                    reduce: never;
+                    reduceRight: never;
+                    find: never;
+                    findIndex: never;
+                    fill: never;
+                    copyWithin: never;
+                    entries: never;
+                    keys: never;
+                    values: never;
+                    includes: never;
+                    flatMap: never;
+                    flat: never;
+                    [Symbol.iterator]: never;
+                    readonly [Symbol.unscopables]: {
+                        [x: number]: boolean;
+                        length?: boolean;
+                        toString?: boolean;
+                        toLocaleString?: boolean;
+                        pop?: boolean;
+                        push?: boolean;
+                        concat?: boolean;
+                        join?: boolean;
+                        reverse?: boolean;
+                        shift?: boolean;
+                        slice?: boolean;
+                        sort?: boolean;
+                        splice?: boolean;
+                        unshift?: boolean;
+                        indexOf?: boolean;
+                        lastIndexOf?: boolean;
+                        every?: boolean;
+                        some?: boolean;
+                        forEach?: boolean;
+                        map?: boolean;
+                        filter?: boolean;
+                        reduce?: boolean;
+                        reduceRight?: boolean;
+                        find?: boolean;
+                        findIndex?: boolean;
+                        fill?: boolean;
+                        copyWithin?: boolean;
+                        entries?: boolean;
+                        keys?: boolean;
+                        values?: boolean;
+                        includes?: boolean;
+                        flatMap?: boolean;
+                        flat?: boolean;
+                    };
+                };
+            };
+            name: string | null;
+            id: string;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+        warehouse: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            name: string;
+            id: string;
+            isActive: boolean;
+            address: string | null;
+            city: string | null;
+            state: string | null;
+        };
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+    }[];
+    id: string;
+    email: string | null;
+    brandId: string;
+    deliveryZoneId: string;
+    recoveryAttempts: number;
+    recoveryDiscountCodeId: string | null;
+    wasRecovered: boolean;
+    estimatedDays: number | null;
+    orderNumber: number;
+    firstName: string;
+    lastName: string;
+    phone: string;
+    address: string;
+    city: string;
+    discountCodeId: string | null;
+    paymentMethod: import("@prisma/client").$Enums.PaymentMethod;
+    paystackReference: string | null;
+    status: import("@prisma/client").$Enums.OrderStatus;
+    cancellationReason: string | null;
+    prospectReason: import("@prisma/client").$Enums.ProspectReason | null;
+    userActionToken: string;
+} | {
+    error: {
+        code: string;
+        message: string;
+    };
+} | {
+    error: {
+        code: string;
+        message: string;
+    };
+} | {
+    error: {
+        code: string;
+        message: string;
+    };
+}, Error, any, unknown>;
 /**
  * Hook to delete an order using admin RPC
  *

package/dist/packages/api-client/src/hooks/admin/orders.js

@@ -12,21 +12,24 @@ import { useApiConfig } from '../useApiConfig';
 /**
  * Hook to list all orders with pagination using admin RPC
  *
+ * @param filters - Query parameters for filtering orders
  * @param options - React Query options
  *
  * @example
  * ```tsx
- * const { data: orders, isLoading } = useListOrders();
+ * const { data: orders, isLoading } = useListOrders({ search: 'john', page: 1 });
  * ```
  */
-export function useListOrders(options) {
+export function useListOrders(filters, options) {
     const { baseURL, getAuthToken } = useApiConfig();
     return useQueryUnwrapped({
-        queryKey: queryKeys.admin.orders.list(),
+        queryKey: queryKeys.admin.orders.list(filters),
         queryFn: async () => {
             const token = await getAuthToken();
             const clients = createAdminRpcClients(baseURL);
-            const res = await clients.orders.index.$get({}, authHeaders(token));
+            // Clean undefined values from filters
+            const cleanFilters = filters ? Object.fromEntries(Object.entries(filters).filter(([_, v]) => v !== undefined)) : undefined;
+            const res = await clients.orders.index.$get({ query: cleanFilters }, authHeaders(token));
             if (!res.ok) {
                 throw new Error(`Failed to fetch orders: ${res.statusText}`);
             }