@nosto/nosto-react 0.5.0 → 2.0.0

package/README.md

@@ -251,21 +251,16 @@ You can personalise your order-confirmation/thank-you page by using the `NostoOr
 
 By default, your account, when created, has one other-page placement named `thankyou-nosto-1`. You may omit this and use any identifier you need. The identifier used here is simply provided to illustrate the example.
 
-The `order` prop requires a value that adheres to the type `Purchase`.
-
 ```jsx
 import {
-  Buyer,
-  Item,
   NostoOrder,
   NostoPlacement,
-  Purchase,
 } from "@nosto/nosto-react";
 
 <div className="thankyou-page">
   ... ... ...
   <NostoPlacement id="thankyou-nosto-1" />
-  <NostoOrder order={{ purchase: toOrder(order) }} />
+  <NostoOrder order={ order } />
 </div>;
 ```
 

package/dist/index.d.ts

@@ -2,55 +2,54 @@ import { Context } from 'react';
 import { default as default_2 } from 'react';
 import { JSX as JSX_2 } from 'react/jsx-runtime';
 
+declare type AnyFunction = (...args: unknown[]) => unknown;
+
 /**
  * @group Types
  */
-declare interface Affinity {
-    name: string;
-    score: number;
+export declare interface Cart {
+    hcid?: string;
+    items: CartItem[];
 }
 
-declare type AnyFunction = (...args: unknown[]) => unknown;
-
 /**
  * @group Types
  */
-export declare interface Buyer {
-    first_name: string;
-    last_name: string;
-    email: string;
-    type: string;
-    newsletter: boolean;
+declare interface CartItem {
+    name: string;
+    price_currency_code: string;
+    product_id: string;
+    quantity: number;
+    sku_id?: string;
+    unit_price: number;
 }
 
 /**
  * @group Types
  */
-export declare interface Cart {
-    items: Item[];
+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;
+    customer_reference?: string;
     email: string;
     first_name: string;
+    hcid?: string;
     last_name: string;
-    newsletter: boolean;
-}
-
-/**
- * @group Types
- */
-export declare interface Item {
-    name: string;
-    price_currency_code: string;
-    product_id: string;
-    quantity: number;
-    sku_id: string;
-    unit_price: number;
+    newsletter?: boolean;
+    order_number?: string;
+    source?: string;
+    source_id?: string;
+    type?: string;
 }
 
 /**
@@ -75,7 +74,7 @@ export declare interface Item {
  */
 export declare function Nosto404(props: {
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * You can personalise your category and collection pages by using the NostoCategory component.
@@ -102,7 +101,7 @@ export declare function Nosto404(props: {
 export declare function NostoCategory(props: {
     category: string;
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * You can personalise your cart and checkout pages by using the NostoCheckout component.
@@ -125,39 +124,7 @@ export declare function NostoCategory(props: {
  */
 export declare function NostoCheckout(props: {
     placements?: string[];
-}): JSX_2.Element;
-
-/**
- * @group Types
- */
-declare interface NostoClient {
-    setAutoLoad(autoload: boolean): NostoClient;
-    defaultSession(): NostoClientSession;
-    placements: {
-        getPlacements(): string[];
-        injectCampaigns(recommendations: Record<string, Recommendation>): void;
-    };
-}
-
-/**
- * @group Types
- */
-declare interface NostoClientSession {
-    setCart(cart?: Cart): NostoClientSession;
-    setCustomer(customer?: Customer): NostoClientSession;
-    setResponseMode(mode: string): NostoClientSession;
-    setVariation(variation?: string): NostoClientSession;
-    addOrder(order: {
-        purchase: Purchase;
-    }): SessionAction;
-    viewCategory(category: string): SessionAction;
-    viewProduct(product: string): SessionAction;
-    viewFrontPage(): SessionAction;
-    viewNotFound(): SessionAction;
-    viewOther(): SessionAction;
-    viewSearch(query: string): SessionAction;
-    viewCart(): SessionAction;
-}
+}): null;
 
 /**
  * @group Essential Functions
@@ -172,15 +139,8 @@ export declare interface NostoContextType {
     clientScriptLoaded: boolean;
     currentVariation?: string;
     renderFunction?: AnyFunction;
-    responseMode: string;
-    recommendationComponent?: React.ReactElement<{
-        nostoRecommendation: Recommendation;
-    }>;
-    useRenderCampaigns(type: string): {
-        renderCampaigns(data: unknown, api: NostoClient): void;
-        pageTypeUpdated: boolean;
-    };
-    pageType: string;
+    responseMode: RenderMode;
+    recommendationComponent?: RecommendationComponent;
 }
 
 /**
@@ -208,7 +168,7 @@ export declare interface NostoContextType {
  */
 export declare function NostoHome(props: {
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * You can personalise your order-confirmation/thank-you page by using the `NostoOrder` component.
@@ -230,11 +190,9 @@ export declare function NostoHome(props: {
  * @group Components
  */
 export declare function NostoOrder(props: {
-    order: {
-        purchase: Purchase;
-    };
+    order: Order;
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * You can personalise your miscellaneous pages by using the NostoOther component.
@@ -257,7 +215,7 @@ export declare function NostoOrder(props: {
  */
 export declare function NostoOther(props: {
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * Nosto React has a special component called NostoPlacement.
@@ -305,7 +263,7 @@ export declare function NostoProduct(props: {
     product: string;
     tagging?: Product;
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * This widget is what we call the Nosto root widget, which is responsible for adding the actual Nosto script and the JS API stub.
@@ -346,7 +304,10 @@ declare interface NostoProviderProps {
      * Indicates an url of a server
      */
     host?: string;
-    children: default_2.ReactElement;
+    /**
+     * children
+     */
+    children: default_2.ReactElement | default_2.ReactElement[];
     /**
      * Indicates if merchant uses multiple currencies
      */
@@ -354,9 +315,7 @@ declare interface NostoProviderProps {
     /**
      * Recommendation component which holds nostoRecommendation object
      */
-    recommendationComponent?: default_2.ReactElement<{
-        nostoRecommendation: Recommendation;
-    }>;
+    recommendationComponent?: RecommendationComponent;
     /**
      * Enables Shopify markets with language and market id
      */
@@ -392,7 +351,7 @@ declare interface NostoProviderProps {
 export declare function NostoSearch(props: {
     query: string;
     placements?: string[];
-}): JSX_2.Element;
+}): null;
 
 /**
  * Nosto React requires that you pass it the details of current cart contents and the details of the currently logged-in customer, if any, on every route change.
@@ -404,53 +363,109 @@ export declare function NostoSearch(props: {
  *
  * @group Essential Functions
  */
-export declare function NostoSession(props: {
-    cart: Cart;
-    customer: Customer;
+export declare function NostoSession(props?: {
+    cart?: Cart;
+    customer?: Customer;
 }): JSX_2.Element;
 
+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 interface Product {
-    alternateImageUrls?: URL[];
-    availability: "InStock" | "OutOfStock";
+export declare type Product = {
+    product_id: string;
+    selected_sku_id?: string;
+};
+
+declare interface PushedProduct {
+    age_group?: string;
+    alternate_image_urls: string[];
+    availability: string;
     brand?: string;
     category: string[];
-    categoryIds?: string[];
-    description: string;
-    googleCategory?: string;
+    category_id: string[];
     condition?: string;
+    custom_fields: {
+        [index: string]: string;
+    };
+    date_published?: Date;
+    description?: string;
     gender?: string;
-    ageGroup?: string;
+    google_category?: string;
     gtin?: string;
-    imageUrl: URL;
-    listPrice?: number;
+    image_url?: string;
+    inventory_level?: number;
+    list_price?: number;
     name: string;
+    parent_category_id: string[];
     price: number;
-    ratingValue?: number;
-    reviewCount?: number;
-    priceCurrencyCode: string;
-    productId: string;
-    tags1?: string[];
-    tags2?: string[];
-    tags3?: string[];
-    thumbUrl?: URL;
-    url: URL;
-    customFields?: {
-        [key: string]: string;
+    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;
     };
-    variationId?: string;
-    skus?: SKU[];
 }
 
-/**
- * @group Types
- */
-export declare interface Purchase {
-    number: string;
-    info: Buyer;
-    items: Item[];
+declare interface PushedProductSKU extends NostoSku {
+}
+
+declare interface PushedVariation extends NostoVariant {
 }
 
 /**
@@ -458,7 +473,7 @@ export declare interface Purchase {
  */
 export declare interface Recommendation {
     result_id: string;
-    products: Product[];
+    products: PushedProduct[];
     result_type: string;
     title: string;
     div_id: string;
@@ -466,34 +481,27 @@ export declare interface Recommendation {
     params: unknown;
 }
 
-/**
- * @group Types
- */
-declare interface SessionAction {
-    setPlacements(placements: string[]): SessionAction;
-    load(): Promise<{
-        affinities: Record<string, Affinity[]>;
-        geo_location?: string[];
-        page_views: number;
-        recommendations: Recommendation[];
-    }>;
-}
+declare type RecommendationComponent = React.ReactElement<{
+    nostoRecommendation: Recommendation;
+}>;
 
 /**
  * @group Types
  */
-export declare interface SKU {
+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";
+
+declare interface Sku {
+    availability: string;
+    custom_fields: {
+        [index: string]: string;
+    };
+    gtin?: string;
     id: string;
+    image_url?: string;
+    list_price?: number;
     name: string;
     price: number;
-    listPrice?: number;
-    url: URL;
-    imageUrl: URL;
-    gtin?: string;
-    availability: "InStock" | "OutOfStock";
-    customFields?: {
-        [key: string]: string;
-    };
+    url?: string;
 }
 
 /**