@instockng/api-client 1.0.6 → 1.0.8

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

@@ -0,0 +1,563 @@
+/**
+ * Type-safe RPC hooks for order operations
+ *
+ * These hooks use Hono RPC client with types directly from the backend,
+ * providing end-to-end type safety without code generation.
+ */
+import { UseQueryOptions, UseMutationOptions } from '@tanstack/react-query';
+import { fetchOrder, confirmOrder } from '../../fetchers/orders';
+/**
+ * Hook to get order by ID and token using RPC
+ *
+ * @param orderId - Order UUID
+ * @param token - User action token
+ * @param options - React Query options
+ *
+ * @example
+ * ```tsx
+ * const { data: order, isLoading } = useGetOrder('order-123', 'token-456');
+ * console.log(order?.order.status); // Fully typed!
+ * ```
+ */
+export declare function useGetOrder(orderId: string, token: string, options?: Omit<UseQueryOptions<Awaited<ReturnType<typeof fetchOrder>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
+    canConfirm: boolean;
+    confirmationMessage: string;
+    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;
+        id: string;
+        name: 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;
+            id: string;
+            name: string;
+            isActive: boolean;
+        };
+        id: string;
+        name: string;
+        brandId: string | null;
+        stateId: string;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        noteTitle: string | null;
+        noteContent: string | null;
+        isActive: boolean;
+    };
+    items: {
+        priceAtPurchase: number;
+        variant: {
+            price: number;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            product: {
+                createdAt: string;
+                updatedAt: string;
+                deletedAt: string;
+                id: string;
+                name: 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;
+                    };
+                };
+            };
+            id: string;
+            name: string | null;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+        warehouse: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            id: string;
+            name: string;
+            isActive: boolean;
+            address: string | null;
+            city: string | null;
+            state: string | null;
+        };
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+    }[];
+    email: string | null;
+    id: string;
+    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>;
+/**
+ * Hook to confirm a prospect order using RPC
+ *
+ * @param options - React Query mutation options
+ *
+ * @example
+ * ```tsx
+ * const confirmOrder = useConfirmOrder();
+ * confirmOrder.mutate({
+ *   orderId: 'order-123',
+ *   token: 'token-456'
+ * });
+ * ```
+ */
+export declare function useConfirmOrder(options?: UseMutationOptions<Awaited<ReturnType<typeof confirmOrder>>, Error, {
+    orderId: string;
+    token: string;
+}>): 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;
+        id: string;
+        name: 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;
+            id: string;
+            name: string;
+            isActive: boolean;
+        };
+        id: string;
+        name: string;
+        brandId: string | null;
+        stateId: string;
+        allowCOD: boolean;
+        allowOnline: boolean;
+        waybillOnly: boolean;
+        estimatedDays: number | null;
+        noteTitle: string | null;
+        noteContent: string | null;
+        isActive: boolean;
+    };
+    items: {
+        priceAtPurchase: number;
+        variant: {
+            price: number;
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            product: {
+                createdAt: string;
+                updatedAt: string;
+                deletedAt: string;
+                id: string;
+                name: 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;
+                    };
+                };
+            };
+            id: string;
+            name: string | null;
+            isActive: boolean;
+            thumbnailUrl: string | null;
+            productId: string;
+            sku: string;
+            trackInventory: boolean;
+            lowStockThreshold: number | null;
+        };
+        warehouse: {
+            createdAt: string;
+            updatedAt: string;
+            deletedAt: string;
+            id: string;
+            name: string;
+            isActive: boolean;
+            address: string | null;
+            city: string | null;
+            state: string | null;
+        };
+        id: string;
+        orderId: string;
+        variantId: string;
+        warehouseId: string | null;
+        quantity: number;
+    }[];
+    email: string | null;
+    id: string;
+    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, {
+    orderId: string;
+    token: string;
+}, unknown>;

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

@@ -0,0 +1,50 @@
+/**
+ * Type-safe RPC hooks for order operations
+ *
+ * These hooks use Hono RPC client with types directly from the backend,
+ * providing end-to-end type safety without code generation.
+ */
+import { useMutation } from '@tanstack/react-query';
+import { useQueryUnwrapped } from '../use-query-unwrapped';
+import { queryKeys } from '../../utils/query-keys';
+import { fetchOrder, confirmOrder } from '../../fetchers/orders';
+/**
+ * Hook to get order by ID and token using RPC
+ *
+ * @param orderId - Order UUID
+ * @param token - User action token
+ * @param options - React Query options
+ *
+ * @example
+ * ```tsx
+ * const { data: order, isLoading } = useGetOrder('order-123', 'token-456');
+ * console.log(order?.order.status); // Fully typed!
+ * ```
+ */
+export function useGetOrder(orderId, token, options) {
+    return useQueryUnwrapped({
+        queryKey: queryKeys.public.orders.detail(orderId, token),
+        queryFn: () => fetchOrder(orderId, token),
+        ...options,
+    });
+}
+/**
+ * Hook to confirm a prospect order using RPC
+ *
+ * @param options - React Query mutation options
+ *
+ * @example
+ * ```tsx
+ * const confirmOrder = useConfirmOrder();
+ * confirmOrder.mutate({
+ *   orderId: 'order-123',
+ *   token: 'token-456'
+ * });
+ * ```
+ */
+export function useConfirmOrder(options) {
+    return useMutation({
+        mutationFn: (data) => confirmOrder(data.orderId, data.token),
+        ...options,
+    });
+}