@nosto/nosto-react 2.2.1 → 2.3.0

package/LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2018, Mirumee Labs
+Copyright (c) 2024, Nosto Solutions Ltd
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

package/dist/index.d.ts

@@ -1,61 +1,19 @@
+import { Cart } from '@nosto/nosto-js/client';
 import { Context } from 'react';
+import { PushedCustomer as Customer } from '@nosto/nosto-js/client';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { WebsiteOrder as Order } from '@nosto/nosto-js/client';
+import { Product } from '@nosto/nosto-js/client';
+import { PushedProduct } from '@nosto/nosto-js/client';
 import { ReactElement } from 'react';
 import { ReactNode } from 'react';
+import { RenderMode } from '@nosto/nosto-js/client';
 
 declare type AnyFunction = (...args: unknown[]) => unknown;
 
-/**
- * @group Types
- */
-export declare interface Cart {
-    hcid?: string;
-    items: CartItem[];
-}
-
-declare type Cart_2 = Cart | ToCamelCase<Cart>;
-
-/**
- * @group Types
- */
-declare interface CartItem {
-    name: string;
-    price_currency_code: string;
-    product_id: string;
-    quantity: number;
-    sku_id?: string;
-    unit_price: number;
-}
+export { Cart }
 
-/**
- * @group Types
- */
-declare interface ConversionItem {
-    name: string;
-    price_currency_code: string;
-    product_id: string;
-    quantity?: number;
-    sku_id?: string;
-    unit_price?: number;
-}
-
-/**
- * @group Types
- */
-export declare interface Customer {
-    customer_reference?: string;
-    email: string;
-    first_name: string;
-    hcid?: string;
-    last_name: string;
-    newsletter?: boolean;
-    order_number?: string;
-    source?: string;
-    source_id?: string;
-    type?: string;
-}
-
-declare type Customer_2 = Customer | ToCamelCase<Customer>;
+export { Customer }
 
 /**
  * You can personalise your cart and checkout pages by using the `Nosto404` component.
@@ -80,7 +38,7 @@ declare type Customer_2 = Customer | ToCamelCase<Customer>;
 export declare function Nosto404(props: Nosto404Props): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type Nosto404Props = {
     placements?: string[];
@@ -111,7 +69,7 @@ export declare type Nosto404Props = {
 export declare function NostoCategory(props: NostoCategoryProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoCategoryProps = {
     category: string;
@@ -140,7 +98,7 @@ export declare type NostoCategoryProps = {
 export declare function NostoCheckout(props: NostoCheckoutProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoCheckoutProps = {
     placements?: string[];
@@ -189,7 +147,7 @@ export declare interface NostoContextType {
 export declare function NostoHome(props: NostoHomeProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoHomeProps = {
     placements?: string[];
@@ -217,10 +175,10 @@ export declare type NostoHomeProps = {
 export declare function NostoOrder(props: NostoOrderProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoOrderProps = {
-    order: Order;
+    order: Order | ToCamelCase<Order>;
     placements?: string[];
 };
 
@@ -246,7 +204,7 @@ export declare type NostoOrderProps = {
 export declare function NostoOther(props: NostoOtherProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoOtherProps = {
     placements?: string[];
@@ -302,10 +260,11 @@ export declare type NostoPlacementProps = {
 export declare function NostoProduct(props: NostoProductProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoProductProps = {
     product: string;
+    reference?: string;
     tagging?: Product;
     placements?: string[];
 };
@@ -424,112 +383,16 @@ export declare type NostoSearchProps = {
 export declare function NostoSession(props?: NostoSessionProps): null;
 
 /**
- * @group Components
+ * @group Hooks
  */
 export declare type NostoSessionProps = {
-    cart?: Cart_2;
-    customer?: Customer_2;
-};
-
-declare interface NostoSku extends Sku {
-    inventory_level?: number;
-}
-
-declare interface NostoVariant {
-    availability: string;
-    available: boolean;
-    discounted: boolean;
-    list_price?: number;
-    price: number;
-    price_currency_code: string;
-    price_text?: string;
-}
-
-/**
- * @group Types
- */
-export declare interface Order {
-    created_at?: Date;
-    external_order_ref: string;
-    info?: OrderCustomer;
-    items: ConversionItem[];
-    order_status?: string;
-    order_status_label?: string;
-    payment_provider: string;
-}
-
-/**
- * @group Types
- */
-declare interface OrderCustomer {
-    country: string;
-    email?: string;
-    first_name?: string;
-    last_name?: string;
-    newsletter: string;
-    order_number: string;
-    phone: string;
-    post_code: string;
-    type: string;
-}
-
-/**
- * @group Types
- */
-export declare type Product = {
-    product_id: string;
-    selected_sku_id?: string;
+    cart?: Cart | ToCamelCase<Cart>;
+    customer?: Customer | ToCamelCase<Customer>;
 };
 
-declare interface PushedProduct {
-    age_group?: string;
-    alternate_image_urls: string[];
-    availability: string;
-    brand?: string;
-    category: string[];
-    category_id: string[];
-    condition?: string;
-    custom_fields: {
-        [index: string]: string;
-    };
-    date_published?: Date;
-    description?: string;
-    gender?: string;
-    google_category?: string;
-    gtin?: string;
-    image_url?: string;
-    inventory_level?: number;
-    list_price?: number;
-    name: string;
-    parent_category_id: string[];
-    price: number;
-    price_currency_code: string;
-    product_id: string;
-    rating_value?: number;
-    review_count?: number;
-    skus: PushedProductSKU[];
-    source_updated?: Date;
-    supplier_cost?: number;
-    tags1: string[];
-    tags2: string[];
-    tags3: string[];
-    thumb_url?: string;
-    unit_pricing_base_measure?: number;
-    unit_pricing_measure?: number;
-    unit_pricing_unit?: string;
-    update_received?: Date;
-    url: string;
-    variation_id?: string;
-    variations: {
-        [index: string]: PushedVariation;
-    };
-}
-
-declare interface PushedProductSKU extends NostoSku {
-}
+export { Order }
 
-declare interface PushedVariation extends NostoVariant {
-}
+export { Product }
 
 /**
  * @group Types
@@ -548,11 +411,6 @@ declare type RecommendationComponent = ReactElement<{
     nostoRecommendation: Recommendation;
 }>;
 
-/**
- * @group Types
- */
-declare type RenderMode = "HTML" | "SIMPLE" | "JSON_170x170" | "JSON_100_X_100" | "JSON_90x70" | "JSON_50x50" | "JSON_30x30" | "JSON_100x140" | "JSON_200x200" | "JSON_400x400" | "JSON_750x750" | "JSON_10_MAX_SQUARE" | "JSON_200x200_SQUARE" | "JSON_400x400_SQUARE" | "JSON_750x750_SQUARE" | "JSON_ORIGINAL" | "VERSION_SOURCE";
-
 /**
  * @group Types
  */
@@ -567,20 +425,6 @@ export declare type ScriptLoadOptions = {
     attributes?: Record<string, string>;
 };
 
-declare interface Sku {
-    availability: string;
-    custom_fields: {
-        [index: string]: string;
-    };
-    gtin?: string;
-    id: string;
-    image_url?: string;
-    list_price?: number;
-    name: string;
-    price: number;
-    url?: string;
-}
-
 declare type SnakeToCamelCase<S extends string> = S extends `${infer T}_${infer U}` ? `${T}${Capitalize<SnakeToCamelCase<U>>}` : S;
 
 declare type ToCamelCase<T> = T extends (infer U)[] ? ToCamelCase<U>[] : T extends Date ? T : T extends object ? {
@@ -641,7 +485,7 @@ export declare function useNostoOther(props?: NostoOtherProps): void;
  *
  * @group Hooks
  */
-export declare function useNostoProduct({ product, tagging, placements }: NostoProductProps): void;
+export declare function useNostoProduct({ product, tagging, placements, reference }: NostoProductProps): void;
 
 /**
  * You can personalise your search pages by using the useNostoSearch hook.
@@ -658,16 +502,3 @@ export declare function useNostoSearch({ query, placements }: NostoSearchProps):
 export declare function useNostoSession({ cart, customer }?: NostoSessionProps): void;
 
 export { }
-
-declare global {
-    interface Window {
-        nosto?: {
-            reload(settings: unknown): void;
-        };
-        nostojs: {
-            (callback: (api: NostoClient) => void): void;
-            q?: unknown[];
-        };
-    }
-}
-