@shopify/hydrogen-react 0.0.0-next-ea3959b → 0.0.0-next-dada720

package/dist/types/analytics-types.d.ts

@@ -0,0 +1,108 @@
+import type { CurrencyCode, LanguageCode, Product, ProductVariant } from './storefront-api-types.js';
+import { AnalyticsEventName, ShopifySalesChannel } from './analytics-constants.js';
+import { SHOPIFY_Y, SHOPIFY_S } from './cart-constants.js';
+export type ClientBrowserParameters = {
+    /** Shopify unique user token: Value of `_shopify_y` cookie. Use `getClientBrowserParameters()` to collect this value. */
+    uniqueToken: string;
+    /** Shopify session token: Value of `_shopify_s` cookie. Use `getClientBrowserParameters()` to collect this value. */
+    visitToken: string;
+    /** `window.location.href`. Use `getClientBrowserParameters()` to collect this value. */
+    url: string;
+    /** `window.location.pathname`. Use `getClientBrowserParameters()` to collect this value. */
+    path: string;
+    /** `window.location.search`. Use `getClientBrowserParameters()` to collect this value. */
+    search: string;
+    /** `window.location.referrer`. Use `getClientBrowserParameters()` to collect this value. */
+    referrer: string;
+    /** `document.title`. Use `getClientBrowserParameters()` to collect this value. */
+    title: string;
+    /** `navigator.userAgent`. Use `getClientBrowserParameters()` to collect this value. */
+    userAgent: string;
+    /** Navigation type: 'navigate' | 'reload' | 'back_forward' | 'prerender' | 'unknown <number>'. Use `getClientBrowserParameters()` to collect this value. */
+    navigationType: string;
+    /** Navigation api: 'PerformanceNavigationTiming' | 'performance.navigation'. Use `getClientBrowserParameters()` to collect this value. */
+    navigationApi: string;
+};
+export type ShopifyAnalyticsProduct = {
+    productGid: Product['id'];
+    variantGid?: ProductVariant['id'];
+    name: Product['title'];
+    variantName?: ProductVariant['title'];
+    brand: Product['vendor'];
+    category?: Product['productType'];
+    price: ProductVariant['price']['amount'];
+    sku?: ProductVariant['sku'];
+    quantity?: number;
+};
+type ShopifyAnalyticsBase = {
+    /** If we have consent from buyer for data collection */
+    hasUserConsent: boolean;
+    /** Shopify shop id in the form of `gid://shopify/Shop/<id>`. */
+    shopId: string;
+    /** Currency code. */
+    currency: CurrencyCode;
+    /** Shopify storefront id generated by Hydrogen sales channel. */
+    storefrontId?: string;
+    /** Language displayed to buyer. */
+    acceptedLanguage?: LanguageCode;
+    /** Shopify sales channel. */
+    shopifySalesChannel?: ShopifySalesChannels;
+    /** Shopify customer id in the form of `gid://shopify/Customer/<id>`. */
+    customerId?: string;
+    /** Total value of products. */
+    totalValue?: number;
+    /** Shopify products. */
+    products?: ShopifyAnalyticsProduct[];
+};
+export type ShopifySalesChannels = keyof typeof ShopifySalesChannel;
+export type AnalyticsEventNames = keyof typeof AnalyticsEventName;
+export interface ShopifyPageViewPayload extends ShopifyAnalyticsBase, ClientBrowserParameters {
+    /** Canonical url. */
+    canonicalUrl?: string;
+    /** Shopify page type. */
+    pageType?: string;
+    /** Shopify resource id in the form of `gid://shopify/<type>/<id>`. */
+    resourceId?: string;
+    /** Shopify collection handle. */
+    collectionHandle?: string;
+    /** Search term used on a search results page. */
+    searchString?: string;
+}
+export type ShopifyPageView = {
+    /** Use `AnalyticsEventName.PAGE_VIEW` constant. */
+    eventName: string;
+    payload: ShopifyPageViewPayload;
+};
+export interface ShopifyAddToCartPayload extends ShopifyAnalyticsBase, ClientBrowserParameters {
+    /** Shopify cart id in the form of `gid://shopify/Cart/<id>`. */
+    cartId: string;
+}
+export type ShopifyAddToCart = {
+    /** Use `AnalyticsEventName.ADD_TO_CART` constant. */
+    eventName: string;
+    payload: ShopifyAddToCartPayload;
+};
+export type ShopifyMonorailPayload = {
+    products?: string[];
+    [key: string]: unknown;
+};
+export type ShopifyMonorailEvent = {
+    schema_id: string;
+    payload: ShopifyMonorailPayload;
+    metadata: {
+        event_created_at_ms: number;
+    };
+};
+export type ShopifyAnalyticsPayload = ShopifyPageViewPayload | ShopifyAddToCartPayload;
+export type ShopifyAnalytics = ShopifyPageView | ShopifyAddToCart;
+export type ShopifyCookies = {
+    /** Shopify unique user token: Value of `_shopify_y` cookie. */
+    [SHOPIFY_Y]: string;
+    /** Shopify session token: Value of `_shopify_s` cookie. */
+    [SHOPIFY_S]: string;
+};
+export type ShopifyGId = {
+    id: string;
+    resource: string | null;
+};
+export {};

package/dist/types/analytics-utils.d.ts

@@ -0,0 +1,36 @@
+import type { ShopifyMonorailPayload, ShopifyMonorailEvent, ShopifyGId } from './analytics-types.js';
+/**
+ * Builds a Shopify Monorail event from a Shopify Monorail payload and a schema ID.
+ * @param payload - The Monorail payload
+ * @param schemaId - The schema ID to use
+ * @returns The formatted payload
+ **/
+export declare function schemaWrapper(schemaId: string, payload: ShopifyMonorailPayload): ShopifyMonorailEvent;
+/**
+ * Parses global id (gid) and returns the resource type and id.
+ * @see https://shopify.dev/api/usage/gids
+ * @param gid - A shopify GID (string)
+ *
+ * @example
+ * ```ts
+ * const {id, resource} = parseGid('gid://shopify/Order/123')
+ * // => id = "123", resource = 'Order'
+ *
+ *  * const {id, resource} = parseGid('gid://shopify/Cart/abc123')
+ * // => id = "abc123", resource = 'Cart'
+ * ```
+ **/
+export declare function parseGid(gid: string | undefined): ShopifyGId;
+/**
+ * Filters properties from an object and returns a new object with only the properties that have a truthy value.
+ * @param keyValuePairs - An object of key-value pairs
+ * @param formattedData - An object which will hold the truthy values
+ * @returns The formatted object
+ **/
+export declare function addDataIf(keyValuePairs: ShopifyMonorailPayload, formattedData: ShopifyMonorailPayload): ShopifyMonorailPayload;
+/**
+ * Utility that errors if a function is called on the server.
+ * @param fnName - The name of the function
+ * @returns A boolean
+ **/
+export declare function errorIfServer(fnName: string): boolean;

package/dist/types/analytics.d.ts

@@ -0,0 +1,9 @@
+import type { ClientBrowserParameters, ShopifyAnalytics } from './analytics-types.js';
+/**
+ * Set user and session cookies and refresh the expiry time
+ * @param event - The analytics event.
+ * @param shopDomain - The Online Store domain to sent Shopify analytics under the same
+ *   top level domain.
+ */
+export declare function sendShopifyAnalytics(event: ShopifyAnalytics, shopDomain?: string): Promise<void>;
+export declare function getClientBrowserParameters(): ClientBrowserParameters;

package/dist/types/cookies-utils.d.ts

@@ -0,0 +1,4 @@
+import { ShopifyCookies } from './analytics-types.js';
+export declare function buildUUID(): string;
+export declare function hexTime(): string;
+export declare function getShopifyCookies(cookies: string): ShopifyCookies;

package/dist/types/index.d.cts

@@ -1,21 +1,29 @@
 export { AddToCartButton } from './AddToCartButton.js';
+export { getClientBrowserParameters, sendShopifyAnalytics } from './analytics.js';
+export { AnalyticsEventName, AnalyticsPageType, ShopifySalesChannel, } from './analytics-constants.js';
+export type { ClientBrowserParameters, ShopifyAddToCart, ShopifyAddToCartPayload, ShopifyAnalytics, ShopifyAnalyticsPayload, ShopifyAnalyticsProduct, ShopifyCookies, ShopifyPageView, ShopifyPageViewPayload, } from './analytics-types.js';
 export { BuyNowButton } from './BuyNowButton.js';
-export type { CartState, CartStatus, Cart, CartWithActions, CartAction, } from './cart-types.js';
+export type { Cart, CartAction, CartState, CartStatus, CartWithActions, } from './cart-types.js';
 export { CartCheckoutButton } from './CartCheckoutButton.js';
+export { CartCost } from './CartCost.js';
+export { CartLinePrice } from './CartLinePrice.js';
+export { CartLineProvider, useCartLine } from './CartLineProvider.js';
 export { CartProvider, useCart } from './CartProvider.js';
 export { storefrontApiCustomScalars } from './codegen.helpers.js';
+export { getShopifyCookies } from './cookies-utils.js';
 export { ExternalVideo } from './ExternalVideo.js';
 export { flattenConnection } from './flatten-connection.js';
 export { Image } from './Image.js';
 export { MediaFile } from './MediaFile.js';
-export { parseMetafield, type ParsedMetafields } from './parse-metafield.js';
 export { ModelViewer } from './ModelViewer.js';
 export { Money } from './Money.js';
+export { type ParsedMetafields, parseMetafield } from './parse-metafield.js';
 export { ProductPrice } from './ProductPrice.js';
 export { ProductProvider, useProduct } from './ProductProvider.js';
 export { ShopifyProvider, useShop } from './ShopifyProvider.js';
 export { ShopPayButton } from './ShopPayButton.js';
-export type { StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponseError, StorefrontApiResponse, StorefrontApiResponsePartial, } from './storefront-api-response.types.js';
+export type { StorefrontApiResponse, StorefrontApiResponseError, StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponsePartial, } from './storefront-api-response.types.js';
 export { createStorefrontClient } from './storefront-client.js';
 export { useMoney } from './useMoney.js';
+export { useShopifyCookies } from './useShopifyCookies.js';
 export { Video } from './Video.js';

package/dist/types/index.d.ts

@@ -1,21 +1,29 @@
 export { AddToCartButton } from './AddToCartButton.js';
+export { getClientBrowserParameters, sendShopifyAnalytics } from './analytics.js';
+export { AnalyticsEventName, AnalyticsPageType, ShopifySalesChannel, } from './analytics-constants.js';
+export type { ClientBrowserParameters, ShopifyAddToCart, ShopifyAddToCartPayload, ShopifyAnalytics, ShopifyAnalyticsPayload, ShopifyAnalyticsProduct, ShopifyCookies, ShopifyPageView, ShopifyPageViewPayload, } from './analytics-types.js';
 export { BuyNowButton } from './BuyNowButton.js';
-export type { CartState, CartStatus, Cart, CartWithActions, CartAction, } from './cart-types.js';
+export type { Cart, CartAction, CartState, CartStatus, CartWithActions, } from './cart-types.js';
 export { CartCheckoutButton } from './CartCheckoutButton.js';
+export { CartCost } from './CartCost.js';
+export { CartLinePrice } from './CartLinePrice.js';
+export { CartLineProvider, useCartLine } from './CartLineProvider.js';
 export { CartProvider, useCart } from './CartProvider.js';
 export { storefrontApiCustomScalars } from './codegen.helpers.js';
+export { getShopifyCookies } from './cookies-utils.js';
 export { ExternalVideo } from './ExternalVideo.js';
 export { flattenConnection } from './flatten-connection.js';
 export { Image } from './Image.js';
 export { MediaFile } from './MediaFile.js';
-export { parseMetafield, type ParsedMetafields } from './parse-metafield.js';
 export { ModelViewer } from './ModelViewer.js';
 export { Money } from './Money.js';
+export { type ParsedMetafields, parseMetafield } from './parse-metafield.js';
 export { ProductPrice } from './ProductPrice.js';
 export { ProductProvider, useProduct } from './ProductProvider.js';
 export { ShopifyProvider, useShop } from './ShopifyProvider.js';
 export { ShopPayButton } from './ShopPayButton.js';
-export type { StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponseError, StorefrontApiResponse, StorefrontApiResponsePartial, } from './storefront-api-response.types.js';
+export type { StorefrontApiResponse, StorefrontApiResponseError, StorefrontApiResponseOk, StorefrontApiResponseOkPartial, StorefrontApiResponsePartial, } from './storefront-api-response.types.js';
 export { createStorefrontClient } from './storefront-client.js';
 export { useMoney } from './useMoney.js';
+export { useShopifyCookies } from './useShopifyCookies.js';
 export { Video } from './Video.js';

package/dist/types/parse-metafield.d.ts

@@ -1,9 +1,7 @@
 import type { Collection, GenericFile, Metafield as MetafieldBaseType, MoneyV2, Page, Product, ProductVariant } from './storefront-api-types.js';
 import type { PartialDeep, Simplify } from 'type-fest';
 /**
- * A temporary function that will be renamed to `parseMetafield()` in a future release.
- *
- * A function that uses `metafield.type` to parse the Metafield's `value` or `reference` or `references` (depending on the `type`) and put it in `metafield.parsedValue`
+ * A function that uses `metafield.type` to parse the Metafield's `value` or `reference` or `references` (depending on the `metafield.type`) and places the result in `metafield.parsedValue`
  *
  * TypeScript developers can use the type `ParsedMetafields` from this package to get the returned object's type correct. For example:
  *

package/dist/types/storefront-client.d.ts

@@ -1,16 +1,3 @@
-/**
- * The `createStorefrontClient()` function creates helpers that enable you to quickly query the Shopify Storefront API.
- *
- * When used on the server, it is recommended to use the `privateStorefrontToken` prop. When used on the client, it is recommended to use the `publicStorefrontToken` prop.
- */
-export declare function createStorefrontClient({ storeDomain, privateStorefrontToken, publicStorefrontToken, storefrontApiVersion, contentType, }: StorefrontClientProps): StorefrontClientReturn;
-export declare function getPublicTokenHeadersRaw(contentType: 'graphql' | 'json', storefrontApiVersion: string, accessToken: string): {
-    'content-type': string;
-    'X-SDK-Variant': string;
-    'X-SDK-Variant-Source': string;
-    'X-SDK-Version': string;
-    'X-Shopify-Storefront-Access-Token': string;
-};
 type StorefrontClientProps = {
     /** The host name of the domain (eg: `{shop}.myshopify.com`). */
     storeDomain: string;
@@ -18,7 +5,7 @@ type StorefrontClientProps = {
     privateStorefrontToken?: string;
     /** The Storefront API access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) documentation for more details. */
     publicStorefrontToken?: string;
-    /** The Storefront API version. This should almost always be the same as the version Hydrogen-UI was built for. Learn more about Shopify [API versioning](https://shopify.dev/api/usage/versioning) for more details.  */
+    /** The Storefront API version. This should almost always be the same as the version Hydrogen React was built for. Learn more about Shopify [API versioning](https://shopify.dev/api/usage/versioning) for more details.  */
     storefrontApiVersion: string;
     /**
      * Customizes which `"content-type"` header is added when using `getPrivateTokenHeaders()` and `getPublicTokenHeaders()`. When fetching with a `JSON.stringify()`-ed `body`, use `"json"`. When fetching with a `body` that is a plain string, use `"graphql"`. Defaults to `"json"`
@@ -27,6 +14,19 @@ type StorefrontClientProps = {
      */
     contentType?: 'json' | 'graphql';
 };
+/**
+ * The `createStorefrontClient()` function creates helpers that enable you to quickly query the Shopify Storefront API.
+ *
+ * When used on the server, it is recommended to use the `privateStorefrontToken` prop. When used on the client, it is recommended to use the `publicStorefrontToken` prop.
+ */
+export declare function createStorefrontClient({ storeDomain, privateStorefrontToken, publicStorefrontToken, storefrontApiVersion, contentType, }: StorefrontClientProps): StorefrontClientReturn;
+export declare function getPublicTokenHeadersRaw(contentType: 'graphql' | 'json', storefrontApiVersion: string, accessToken: string): {
+    'content-type': string;
+    'X-SDK-Variant': string;
+    'X-SDK-Variant-Source': string;
+    'X-SDK-Version': string;
+    'X-Shopify-Storefront-Access-Token': string;
+};
 type OverrideTokenHeaderProps = Partial<Pick<StorefrontClientProps, 'contentType'>>;
 type StorefrontClientReturn = {
     /**

package/dist/types/useShopifyCookies.d.ts

@@ -0,0 +1,14 @@
+type UseShopifyCookiesOptions = {
+    /**
+     * If set to `false`, Shopify cookies will be removed.
+     * If set to `true`, Shopify unique user token cookie will have cookie expiry of 1 year.
+     * Defaults to false.
+     **/
+    hasUserConsent?: boolean;
+    /**
+     * The domain scope of the cookie. Defaults to empty string.
+     **/
+    domain?: string;
+};
+export declare function useShopifyCookies(options?: UseShopifyCookiesOptions): void;
+export {};