@instockng/api-client 1.0.28 → 1.0.30

package/dist/hooks/public/products.d.ts

@@ -5,20 +5,20 @@
  * providing end-to-end type safety without code generation.
  */
 import { UseQueryOptions } from '@tanstack/react-query';
-import { fetchProductsByBrand, fetchProductBySlug, fetchProductAddons } from '../../fetchers/products';
+import { fetchProductsByBrand, fetchProductBySlug, fetchProductAddons, fetchProductRecommendations } from '../../fetchers/products';
 /**
- * Hook to get products by brand using RPC
+ * Hook to get products by brand slug using RPC
  *
- * @param brandId - Brand UUID
+ * @param brandSlug - Brand slug (e.g., 'toyland')
  * @param options - React Query options
  *
  * @example
  * ```tsx
- * const { data: products, isLoading } = useGetProducts('brand-123');
+ * const { data: products, isLoading } = useGetProducts('toyland');
  * console.log(products?.data[0].name); // Fully typed!
  * ```
  */
-export declare function useGetProducts(brandId: string, options?: Omit<UseQueryOptions<Awaited<ReturnType<typeof fetchProductsByBrand>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
+export declare function useGetProducts(brandSlug: string, options?: Omit<UseQueryOptions<Awaited<ReturnType<typeof fetchProductsByBrand>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
     id: string;
     name: string;
     slug: string;
@@ -991,3 +991,486 @@ export declare function useGetProduct(slug: string, options?: Omit<UseQueryOptio
  * @param limit - Max number of add-ons
  */
 export declare function useGetProductAddOns(slug: string, limit?: number, options?: Omit<UseQueryOptions<Awaited<ReturnType<typeof fetchProductAddons>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<any, Error>;
+/**
+ * Hook to get product recommendations (other products from same brand)
+ *
+ * @param slug - Product slug
+ * @param limit - Max number of recommendations (default 4)
+ */
+export declare function useGetProductRecommendations(slug: string, limit?: number, options?: Omit<UseQueryOptions<Awaited<ReturnType<typeof fetchProductRecommendations>>, Error>, 'queryKey' | 'queryFn'>): import("@tanstack/react-query").UseQueryResult<{
+    id: string;
+    name: string;
+    slug: string;
+    description: string;
+    thumbnailUrl: string;
+    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;
+        };
+    };
+    brand: {
+        id: string;
+        name: string;
+        slug: string;
+        logoUrl: string;
+        siteUrl: string;
+        domain: string;
+        metaPixelId: string;
+        tiktokPixelId: string;
+        paystackPublicKey: string;
+        createdAt: string;
+        updatedAt: string;
+        deletedAt: string;
+    };
+    variants: {
+        createdAt: string;
+        updatedAt: string;
+        price: number;
+        compareAtPrice: number;
+        deletedAt: string;
+        id: string;
+        name: string | null;
+        isActive: boolean;
+        thumbnailUrl: string | null;
+        productId: string;
+        sku: string;
+        trackInventory: boolean;
+        lowStockThreshold: number | null;
+    }[];
+    media: string | number | true | {
+        [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;
+        };
+    };
+    features: string;
+    faqs: string | number | true | {
+        [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;
+        };
+    };
+    createdAt: string;
+    updatedAt: string;
+    deletedAt: string;
+    brandId: string;
+    isActive: boolean;
+}[], Error>;

package/dist/hooks/public/products.js

@@ -6,23 +6,23 @@
  */
 import { useQueryUnwrapped } from '../use-query-unwrapped';
 import { queryKeys } from '../../utils/query-keys';
-import { fetchProductsByBrand, fetchProductBySlug, fetchProductAddons } from '../../fetchers/products';
+import { fetchProductsByBrand, fetchProductBySlug, fetchProductAddons, fetchProductRecommendations } from '../../fetchers/products';
 /**
- * Hook to get products by brand using RPC
+ * Hook to get products by brand slug using RPC
  *
- * @param brandId - Brand UUID
+ * @param brandSlug - Brand slug (e.g., 'toyland')
  * @param options - React Query options
  *
  * @example
  * ```tsx
- * const { data: products, isLoading } = useGetProducts('brand-123');
+ * const { data: products, isLoading } = useGetProducts('toyland');
  * console.log(products?.data[0].name); // Fully typed!
  * ```
  */
-export function useGetProducts(brandId, options) {
+export function useGetProducts(brandSlug, options) {
     return useQueryUnwrapped({
-        queryKey: queryKeys.public.products.list(brandId),
-        queryFn: () => fetchProductsByBrand(brandId),
+        queryKey: queryKeys.public.products.list(brandSlug),
+        queryFn: () => fetchProductsByBrand(brandSlug),
         ...options,
     });
 }
@@ -58,3 +58,16 @@ export function useGetProductAddOns(slug, limit, options) {
         ...options,
     });
 }
+/**
+ * Hook to get product recommendations (other products from same brand)
+ *
+ * @param slug - Product slug
+ * @param limit - Max number of recommendations (default 4)
+ */
+export function useGetProductRecommendations(slug, limit, options) {
+    return useQueryUnwrapped({
+        queryKey: queryKeys.public.products.recommendations(slug, limit),
+        queryFn: () => fetchProductRecommendations(slug, limit),
+        ...options,
+    });
+}