@shopify/hydrogen 1.6.4 → 2.0.0-alpha.1

package/dist/esnext/foundation/Analytics/connectors/Shopify/const.js

@@ -1,54 +0,0 @@
-// Shopify analytics constants
-const article = 'article';
-const blog = 'blog';
-const captcha = 'captcha';
-const cart = 'cart';
-const collection = 'collection';
-const customersAccount = 'customers/account';
-const customersActivateAccount = 'customers/activate_account';
-const customersAddresses = 'customers/addresses';
-const customersLogin = 'customers/login';
-const customersOrder = 'customers/order';
-const customersRegister = 'customers/register';
-const customersResetPassword = 'customers/reset_password';
-const giftCard = 'gift_card';
-const home = 'index';
-const listCollections = 'list-collections';
-const forbidden = '403';
-const notFound = '404';
-const page = 'page';
-const password = 'password';
-const product = 'product';
-const policy = 'policy';
-const search = 'search';
-export const PAGE_RENDERED_EVENT_NAME = 'page_rendered';
-export const COLLECTION_PAGE_RENDERED_EVENT_NAME = 'collection_page_rendered';
-export const PRODUCT_PAGE_RENDERED_EVENT_NAME = 'product_page_rendered';
-export const PRODUCT_ADDED_TO_CART_EVENT_NAME = 'product_added_to_cart';
-export const SEARCH_SUBMITTED_EVENT_NAME = 'search_submitted';
-export const ShopifyAnalyticsConstants = {
-    pageType: {
-        article,
-        blog,
-        captcha,
-        cart,
-        collection,
-        customersAccount,
-        customersActivateAccount,
-        customersAddresses,
-        customersLogin,
-        customersOrder,
-        customersRegister,
-        customersResetPassword,
-        giftCard,
-        home,
-        listCollections,
-        forbidden,
-        notFound,
-        page,
-        password,
-        product,
-        policy,
-        search,
-    },
-};

package/dist/esnext/foundation/Analytics/connectors/Shopify/customer-events.client.d.ts

@@ -1,2 +0,0 @@
-export declare function trackCustomerPageView(payload: any, sendToServer: (payload: any) => void): void;
-export declare function trackCustomerAddToCart(payload: any, sendToServer: (payload: any) => void): void;

package/dist/esnext/foundation/Analytics/connectors/Shopify/customer-events.client.js

@@ -1,182 +0,0 @@
-import { buildUUID, addDataIf, getNavigationType, stripGId, stripId, } from './utils.js';
-import { ShopifyAnalyticsConstants, PAGE_RENDERED_EVENT_NAME, COLLECTION_PAGE_RENDERED_EVENT_NAME, PRODUCT_PAGE_RENDERED_EVENT_NAME, PRODUCT_ADDED_TO_CART_EVENT_NAME, SEARCH_SUBMITTED_EVENT_NAME, } from './const.js';
-import { flattenConnection } from '../../../../utilities/flattenConnection/index.js';
-const DOC_URL = 'https://shopify.dev/api/hydrogen/components/framework/shopifyanalytics';
-const requiredProductFields = [
-    {
-        column: 'product_gid',
-        gqlField: 'product.id',
-    },
-    {
-        column: 'variant_gid',
-        gqlField: 'variant.id',
-    },
-    {
-        column: 'name',
-        gqlField: 'product.title',
-    },
-    {
-        column: 'variant',
-        gqlField: 'variant.title',
-    },
-    {
-        column: 'brand',
-        gqlField: 'product.vendor',
-    },
-    {
-        column: 'price',
-        gqlField: 'variant.priceV2.amount',
-    },
-];
-let customerId = '';
-export function trackCustomerPageView(payload, sendToServer) {
-    const shopify = payload.shopify;
-    const canonicalUrl = shopify.canonicalPath
-        ? `${location.origin}${shopify.canonicalPath}`
-        : location.href;
-    // Only the /account/index route sets the `customerId`, so we persist this value when it's available
-    // and append it to analytics events only when a customer is in the logged in state (provided by `CartProvider`).
-    if (payload.shopify.customerId) {
-        customerId = payload.shopify.customerId;
-    }
-    sendToServer(customerEventSchema(payload, PAGE_RENDERED_EVENT_NAME, {
-        canonical_url: canonicalUrl,
-    }));
-    if (shopify.pageType === ShopifyAnalyticsConstants.pageType.product) {
-        sendToServer(customerEventSchema(payload, PRODUCT_PAGE_RENDERED_EVENT_NAME, {
-            products: formatProductsJSON(shopify.products),
-            canonical_url: canonicalUrl,
-            total_value: parseFloat(shopify.products[0].price),
-        }));
-    }
-    if (shopify.pageType === ShopifyAnalyticsConstants.pageType.collection) {
-        sendToServer(customerEventSchema(payload, COLLECTION_PAGE_RENDERED_EVENT_NAME, {
-            collection_name: shopify.collectionHandle,
-            canonical_url: canonicalUrl,
-        }));
-    }
-    if (shopify.pageType === ShopifyAnalyticsConstants.pageType.search) {
-        sendToServer(customerEventSchema(payload, SEARCH_SUBMITTED_EVENT_NAME, {
-            search_string: shopify.searchTerm,
-        }));
-    }
-}
-export function trackCustomerAddToCart(payload, sendToServer) {
-    const { totalValue, addedProducts } = getAddedProducts(payload);
-    sendToServer(customerEventSchema(payload, PRODUCT_ADDED_TO_CART_EVENT_NAME, {
-        total_value: totalValue,
-        products: formatProductsJSON(addedProducts),
-        cart_token: stripId(payload.cart.id),
-    }));
-}
-function customerEventSchema(payload, eventName, extraData) {
-    return {
-        schema_id: 'custom_storefront_customer_tracking/1.0',
-        payload: {
-            ...buildCustomerPayload(payload, extraData),
-            event_name: eventName,
-        },
-        metadata: {
-            event_created_at_ms: Date.now(),
-        },
-    };
-}
-function buildCustomerPayload(payload, extraData = {}) {
-    const location = document.location;
-    const shopify = payload.shopify;
-    const [navigation_type, navigation_api] = getNavigationType();
-    let formattedData = {
-        source: 'hydrogen',
-        shop_id: stripGId(shopify.shopId),
-        hydrogenSubchannelId: shopify.storefrontId || '0',
-        event_time: Date.now(),
-        event_id: buildUUID(),
-        unique_token: shopify.userId,
-        referrer: document.referrer,
-        event_source_url: location.href,
-        user_agent: navigator.userAgent,
-        navigation_type,
-        navigation_api,
-        currency: shopify.currency,
-        /**
-         * For now, all cookie consent management is manage by developers
-         *
-         * TO-DO: When we have access to consent api, implement is_persistent_cookie
-         *        according to the definition below
-         *
-         * It references the state of consent for GDPR protected visitors.
-         * If persistent === FALSE, it means that the merchant has set
-         * “Partially collected before consent”,  and the visitor has not consented.
-         * Until a user consents, we downgrade _shopify_y to a session cookie instead of 1yr expiry.
-         * It denotes a partially stable identifier (stable only for the length of the session,
-         * which should be until they close the browser).
-         */
-        is_persistent_cookie: true,
-        ccpa_enforced: false,
-        gdpr_enforced: false,
-    };
-    formattedData = addDataIf({
-        customer_id: shopify.isLoggedIn && stripGId(customerId),
-    }, formattedData);
-    formattedData = addDataIf(extraData, formattedData);
-    return formattedData;
-}
-function formatProductsJSON(products) {
-    if (!products || products.length === 0) {
-        throw Error(`Make sure useServerAnalytics returns "products"\n More details at ${DOC_URL}#product\n`);
-    }
-    const formattedProducts = products.map((p) => {
-        validateProductData(p, 'useServerAnalytics', 'column', 'product-page');
-        return JSON.stringify({
-            ...p,
-            product_id: stripGId(p.product_gid),
-            variant_id: stripGId(p.variant_gid),
-            quantity: Number(p.quantity || 0),
-        });
-    });
-    return formattedProducts;
-}
-function getAddedProducts(payload) {
-    const addedLines = payload.addedCartLines;
-    const cartLines = formatCartLinesByProductVariant(payload.cart.lines);
-    let totalValue = 0;
-    const addedProducts = addedLines.map((line) => {
-        const item = cartLines[line.merchandiseId];
-        totalValue += parseFloat(item.price) * (line.quantity || 0);
-        return {
-            ...item,
-            quantity: line.quantity,
-        };
-    });
-    return {
-        totalValue,
-        addedProducts,
-    };
-}
-function formatCartLinesByProductVariant(lines) {
-    const cartLines = flattenConnection(lines);
-    const cartItems = {};
-    cartLines.forEach((line) => {
-        const product = line.merchandise.product;
-        const variant = line.merchandise;
-        cartItems[line.merchandise.id] = {
-            product_gid: product.id,
-            variant_gid: variant.id,
-            name: product.title,
-            variant: variant.title,
-            brand: product.vendor,
-            category: product.productType,
-            price: variant.priceV2.amount,
-            sku: variant.sku,
-        };
-        validateProductData(cartItems[line.merchandise.id], 'cart fragment', 'gqlField', 'cart-fragment');
-    });
-    return cartItems;
-}
-function validateProductData(product, source, requireKey, docAnchor) {
-    requiredProductFields.forEach((field) => {
-        if (!product[field.column] || product[field.column] === '') {
-            throw Error(`Make sure ${source} returns "${field[requireKey]}"\n More details at ${DOC_URL}#${docAnchor}\n`);
-        }
-    });
-}

package/dist/esnext/foundation/Analytics/connectors/Shopify/utils.d.ts

@@ -1,6 +0,0 @@
-export declare function buildUUID(): string;
-export declare function hexTime(): string;
-export declare function stripGId(text?: string): number;
-export declare function stripId(text?: string): string;
-export declare function addDataIf(keyValuePairs: Record<string, string | number | Boolean>, formattedData: any): any;
-export declare function getNavigationType(): any[];

package/dist/esnext/foundation/Analytics/connectors/Shopify/utils.js

@@ -1,125 +0,0 @@
-const zeros = '00000000';
-const tokenHash = 'xxxx-4xxx-xxxx-xxxxxxxxxxxx';
-export function buildUUID() {
-    let hash = '';
-    try {
-        const crypto = window.crypto;
-        const randomValuesArray = new Uint16Array(31);
-        crypto.getRandomValues(randomValuesArray);
-        // Generate a strong UUID
-        let i = 0;
-        hash = tokenHash
-            .replace(/[x]/g, (c, ...args) => {
-            const r = randomValuesArray[i] % 16;
-            const v = c === 'x' ? r : (r & 0x3) | 0x8;
-            i++;
-            return v.toString(16);
-        })
-            .toUpperCase();
-    }
-    catch (err) {
-        // crypto not available, generate weak UUID
-        hash = tokenHash
-            .replace(/[x]/g, (c, ...args) => {
-            const r = (Math.random() * 16) | 0;
-            const v = c === 'x' ? r : (r & 0x3) | 0x8;
-            return v.toString(16);
-        })
-            .toUpperCase();
-    }
-    return `${hexTime()}-${hash}`;
-}
-export function hexTime() {
-    // 32 bit representations of new Date().getTime() and performance.now()
-    let dateNumber = 0;
-    let perfNumber = 0;
-    // Result of zero-fill right shift is always positive
-    dateNumber = new Date().getTime() >>> 0;
-    try {
-        perfNumber = performance.now() >>> 0;
-    }
-    catch (err) {
-        perfNumber = 0;
-    }
-    const output = Math.abs(dateNumber + perfNumber)
-        .toString(16)
-        .toLowerCase();
-    return zeros.substr(0, 8 - output.length) + output;
-}
-export function stripGId(text = '') {
-    return parseInt(stripId(text));
-}
-export function stripId(text = '') {
-    return text.substring(text.lastIndexOf('/') + 1);
-}
-export function addDataIf(keyValuePairs, formattedData) {
-    Object.entries(keyValuePairs).forEach(([key, value]) => {
-        if (value) {
-            formattedData[key] = value;
-        }
-    });
-    return formattedData;
-}
-function getNavigationTypeExperimental() {
-    try {
-        const navigationEntries = performance?.getEntriesByType &&
-            performance?.getEntriesByType('navigation');
-        if (navigationEntries && navigationEntries[0]) {
-            //  https://developer.mozilla.org/en-US/docs/Web/API/PerformanceNavigationTiming
-            const rawType = window.performance.getEntriesByType('navigation')[0]['type'];
-            const navType = rawType && rawType.toString();
-            return navType;
-        }
-    }
-    catch (err) {
-        // Do nothing
-    }
-    return undefined;
-}
-function getNavigationTypeLegacy() {
-    try {
-        if (PerformanceNavigation &&
-            performance?.navigation?.type !== null &&
-            performance?.navigation?.type !== undefined) {
-            //  https://developer.mozilla.org/en-US/docs/Web/API/Performance/navigation
-            const rawType = performance.navigation.type;
-            switch (rawType) {
-                case PerformanceNavigation.TYPE_NAVIGATE:
-                    return 'navigate';
-                    break;
-                case PerformanceNavigation.TYPE_RELOAD:
-                    return 'reload';
-                    break;
-                case PerformanceNavigation.TYPE_BACK_FORWARD:
-                    return 'back_forward';
-                    break;
-                default:
-                    return `unknown: ${rawType}`;
-            }
-        }
-    }
-    catch (err) {
-        // do nothing
-    }
-    return undefined;
-}
-export function getNavigationType() {
-    try {
-        let navApi = 'PerformanceNavigationTiming';
-        let navType = getNavigationTypeExperimental();
-        if (!navType) {
-            navType = getNavigationTypeLegacy();
-            navApi = 'performance.navigation';
-        }
-        if (navType) {
-            return [navType, navApi];
-        }
-        else {
-            return ['unknown', 'unknown'];
-        }
-    }
-    catch (err) {
-        // do nothing
-    }
-    return ['error', 'error'];
-}

package/dist/esnext/foundation/Analytics/const.d.ts

@@ -1,9 +0,0 @@
-export declare const eventNames: {
-    PAGE_VIEW: string;
-    VIEWED_PRODUCT: string;
-    ADD_TO_CART: string;
-    REMOVE_FROM_CART: string;
-    UPDATE_CART: string;
-    DISCOUNT_CODE_UPDATED: string;
-    PERFORMANCE: string;
-};

package/dist/esnext/foundation/Analytics/const.js

@@ -1,9 +0,0 @@
-export const eventNames = {
-    PAGE_VIEW: 'page-view',
-    VIEWED_PRODUCT: 'viewed-product',
-    ADD_TO_CART: 'add-to-cart',
-    REMOVE_FROM_CART: 'remove-from-cart',
-    UPDATE_CART: 'update-cart',
-    DISCOUNT_CODE_UPDATED: 'discount-code-updated',
-    PERFORMANCE: 'performance',
-};

package/dist/esnext/foundation/Analytics/hook.d.ts

@@ -1 +0,0 @@
-export declare function useServerAnalytics(data?: any): any;

package/dist/esnext/foundation/Analytics/hook.js

@@ -1,9 +0,0 @@
-import { useServerRequest } from '../ServerRequestProvider/index.js';
-import { mergeDeep } from './utils.js';
-export function useServerAnalytics(data) {
-    const request = useServerRequest();
-    if (data) {
-        request.ctx.analyticsData = mergeDeep(request.ctx.analyticsData, data);
-    }
-    return request.ctx.analyticsData;
-}

package/dist/esnext/foundation/Analytics/index.d.ts

@@ -1 +0,0 @@
-export { ClientAnalytics } from './ClientAnalytics.js';

package/dist/esnext/foundation/Analytics/index.js

@@ -1 +0,0 @@
-export { ClientAnalytics } from './ClientAnalytics.js';

package/dist/esnext/foundation/Analytics/types.d.ts

@@ -1,5 +0,0 @@
-export declare type Subscriber = {
-    unsubscribe: () => void;
-};
-export declare type SubscriberFunction = (payload: any) => void;
-export declare type Subscribers = Record<string, Record<string, SubscriberFunction>>;

package/dist/esnext/foundation/Analytics/types.js

@@ -1 +0,0 @@
-export {};

package/dist/esnext/foundation/Analytics/utils.d.ts

@@ -1,3 +0,0 @@
-export declare function getNamedspacedEventname(eventname: string): string;
-export declare function isObject(item: any): any;
-export declare function mergeDeep(target: any, ...sources: any[]): any;

package/dist/esnext/foundation/Analytics/utils.js

@@ -1,29 +0,0 @@
-import { eventNames } from './const.js';
-const RESERVED_EVENT_NAMES = Object.values(eventNames);
-export function getNamedspacedEventname(eventname) {
-    // Any event name that is not in the reserved space will be prefix with `c-`
-    return RESERVED_EVENT_NAMES.indexOf(eventname) === -1
-        ? `c-${eventname}`
-        : eventname;
-}
-export function isObject(item) {
-    return item && typeof item === 'object' && !Array.isArray(item);
-}
-export function mergeDeep(target, ...sources) {
-    if (!sources.length)
-        return target;
-    const source = sources.shift();
-    if (isObject(target) && isObject(source)) {
-        for (const key in source) {
-            if (isObject(source[key])) {
-                if (!target[key])
-                    Object.assign(target, { [key]: {} });
-                mergeDeep(target[key], source[key]);
-            }
-            else {
-                Object.assign(target, { [key]: source[key] });
-            }
-        }
-    }
-    return mergeDeep(target, ...sources);
-}

package/dist/esnext/foundation/AnalyticsErrorBoundary.client.d.ts

@@ -1,4 +0,0 @@
-import type { ReactNode } from 'react';
-export default function AnalyticsErrorBoundary({ children, }: {
-    children: ReactNode;
-}): JSX.Element;

package/dist/esnext/foundation/AnalyticsErrorBoundary.client.js

@@ -1,8 +0,0 @@
-import React from 'react';
-import { ErrorBoundary } from 'react-error-boundary';
-export default function AnalyticsErrorBoundary({ children, }) {
-    // Analytics fail to load, most likely due to an ad blocker
-    return (React.createElement(ErrorBoundary, { fallbackRender: () => {
-            return null;
-        } }, children));
-}

package/dist/esnext/foundation/BuiltInRoutes/BuiltInRoutes.d.ts

@@ -1,2 +0,0 @@
-import { ResourceGetter } from '../../utilities/apiRoutes.js';
-export declare function getBuiltInRoute(url: URL): ResourceGetter | null;

package/dist/esnext/foundation/BuiltInRoutes/BuiltInRoutes.js

@@ -1,23 +0,0 @@
-import { EVENT_PATHNAME, EVENT_PATHNAME_REGEX } from '../../constants.js';
-import { ServerAnalyticsRoute } from '../Analytics/ServerAnalyticsRoute.js';
-import { HealthCheck } from './healthCheck.js';
-const builtInRoutes = [
-    {
-        pathname: EVENT_PATHNAME,
-        regex: EVENT_PATHNAME_REGEX,
-        resource: ServerAnalyticsRoute,
-    },
-    {
-        pathname: '/__health',
-        resource: HealthCheck,
-    },
-];
-export function getBuiltInRoute(url) {
-    for (const route of builtInRoutes) {
-        if (url.pathname === route.pathname ||
-            (route.regex && route.regex.test(url.pathname))) {
-            return route.resource;
-        }
-    }
-    return null;
-}

package/dist/esnext/foundation/BuiltInRoutes/healthCheck.d.ts

@@ -1 +0,0 @@
-export declare function HealthCheck(): Promise<Response>;

package/dist/esnext/foundation/BuiltInRoutes/healthCheck.js

@@ -1,3 +0,0 @@
-export async function HealthCheck() {
-    return new Response(null, { status: 200 });
-}

package/dist/esnext/foundation/Cache/cache-sub-request.d.ts

@@ -1,17 +0,0 @@
-import type { QueryKey, CachingStrategy } from '../../types.js';
-export declare function generateSubRequestCacheControlHeader(userCacheOptions?: CachingStrategy): string;
-/**
- * Get an item from the cache. If a match is found, returns a tuple
- * containing the `JSON.parse` version of the response as well
- * as the response itself so it can be checked for staleness.
- */
-export declare function getItemFromCache(key: QueryKey): Promise<undefined | [any, Response]>;
-/**
- * Put an item into the cache.
- */
-export declare function setItemInCache(key: QueryKey, value: any, userCacheOptions?: CachingStrategy): Promise<void>;
-export declare function deleteItemFromCache(key: QueryKey): Promise<void>;
-/**
- * Manually check the response to see if it's stale.
- */
-export declare function isStale(key: QueryKey, response: Response): boolean;

package/dist/esnext/foundation/Cache/cache-sub-request.js

@@ -1,64 +0,0 @@
-import { getCache } from '../runtime.js';
-import { hashKey } from '../../utilities/hash.js';
-import * as CacheApi from './cache.js';
-import { CacheShort } from './strategies/index.js';
-/**
- * Wrapper Cache functions for sub queries
- */
-/**
- * Cache API is weird. We just need a full URL, so we make one up.
- */
-function getKeyUrl(key) {
-    return `https://shopify.dev/?${key}`;
-}
-function getCacheOption(userCacheOptions) {
-    return userCacheOptions || CacheShort();
-}
-export function generateSubRequestCacheControlHeader(userCacheOptions) {
-    return CacheApi.generateDefaultCacheControlHeader(getCacheOption(userCacheOptions));
-}
-/**
- * Get an item from the cache. If a match is found, returns a tuple
- * containing the `JSON.parse` version of the response as well
- * as the response itself so it can be checked for staleness.
- */
-export async function getItemFromCache(key) {
-    const cache = getCache();
-    if (!cache) {
-        return;
-    }
-    const url = getKeyUrl(hashKey(key));
-    const request = new Request(url);
-    const response = await CacheApi.getItemFromCache(request);
-    if (!response) {
-        return;
-    }
-    return [await response.json(), response];
-}
-/**
- * Put an item into the cache.
- */
-export async function setItemInCache(key, value, userCacheOptions) {
-    const cache = getCache();
-    if (!cache) {
-        return;
-    }
-    const url = getKeyUrl(hashKey(key));
-    const request = new Request(url);
-    const response = new Response(JSON.stringify(value));
-    await CacheApi.setItemInCache(request, response, getCacheOption(userCacheOptions));
-}
-export async function deleteItemFromCache(key) {
-    const cache = getCache();
-    if (!cache)
-        return;
-    const url = getKeyUrl(hashKey(key));
-    const request = new Request(url);
-    await CacheApi.deleteItemFromCache(request);
-}
-/**
- * Manually check the response to see if it's stale.
- */
-export function isStale(key, response) {
-    return CacheApi.isStale(new Request(getKeyUrl(hashKey(key))), response);
-}

package/dist/esnext/foundation/Cache/cache.d.ts

@@ -1,17 +0,0 @@
-import type { CachingStrategy } from '../../types.js';
-export declare function generateDefaultCacheControlHeader(userCacheOptions?: CachingStrategy): string;
-/**
- * Get an item from the cache. If a match is found, returns a tuple
- * containing the `JSON.parse` version of the response as well
- * as the response itself so it can be checked for staleness.
- */
-export declare function getItemFromCache(request: Request): Promise<Response | undefined>;
-/**
- * Put an item into the cache.
- */
-export declare function setItemInCache(request: Request, response: Response, userCacheOptions: CachingStrategy): Promise<void>;
-export declare function deleteItemFromCache(request: Request): Promise<void>;
-/**
- * Manually check the response to see if it's stale.
- */
-export declare function isStale(request: Request, response: Response): boolean;