@shopify/hydrogen 0.24.0 → 0.26.0

package/dist/node/hooks/useParsedMetafields/useParsedMetafields.d.ts

@@ -1,21 +0,0 @@
-import type { MetafieldConnection } from '../../storefront-api-types';
-import type { PartialDeep } from 'type-fest';
-/**
- * The `useParsedMetafields` hook transforms a [MetafieldConnection](https://shopify.dev/api/storefront/reference/common-objects/metafieldconnection)
- * in an array of metafields whose `values` have been parsed according to the metafield `type`.
- */
-export declare function useParsedMetafields(
-/** A [MetafieldConnection](https://shopify.dev/api/storefront/reference/common-objects/metafieldconnection). */
-metafields?: PartialDeep<MetafieldConnection>): {
-    value: any;
-    id?: string | undefined;
-    __typename?: "Metafield" | undefined;
-    createdAt?: string | undefined;
-    description?: import("../../storefront-api-types").Maybe<string> | undefined;
-    key?: string | undefined;
-    namespace?: string | undefined;
-    parentResource?: import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Blog> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Article> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Customer> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").ProductVariant> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Order> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Collection> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Page> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Product> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Shop> | undefined;
-    reference?: import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Video> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").MediaImage> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").ProductVariant> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Page> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").Product> | import("type-fest/source/partial-deep").PartialObjectDeep<import("../../storefront-api-types").GenericFile> | null | undefined;
-    type?: string | undefined;
-    updatedAt?: string | undefined;
-}[];

package/dist/node/hooks/useParsedMetafields/useParsedMetafields.js

@@ -1,25 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useParsedMetafields = void 0;
-const react_1 = require("react");
-const utilities_1 = require("../../utilities");
-/**
- * The `useParsedMetafields` hook transforms a [MetafieldConnection](https://shopify.dev/api/storefront/reference/common-objects/metafieldconnection)
- * in an array of metafields whose `values` have been parsed according to the metafield `type`.
- */
-function useParsedMetafields(
-/** A [MetafieldConnection](https://shopify.dev/api/storefront/reference/common-objects/metafieldconnection). */
-metafields) {
-    return (0, react_1.useMemo)(() => {
-        if (!metafields) {
-            throw new Error(`'useParsedMetafields' needs metafields`);
-        }
-        return (0, utilities_1.flattenConnection)(metafields).map((metafield) => {
-            return {
-                ...metafield,
-                value: (0, utilities_1.parseMetafieldValue)(metafield),
-            };
-        });
-    }, [metafields]);
-}
-exports.useParsedMetafields = useParsedMetafields;

package/dist/node/hooks/useProductOptions/helpers.d.ts

@@ -1,6 +0,0 @@
-import { SelectedOptions, OptionWithValues } from './types';
-import type { ProductVariant as ProductVariantType } from '../../storefront-api-types';
-import type { PartialDeep } from 'type-fest';
-export declare function getAllOptionValues(variants: ProductVariantType[], option: string): string[];
-export declare function getSelectedVariant(variants: PartialDeep<ProductVariantType>[], choices: SelectedOptions): PartialDeep<ProductVariantType> | undefined;
-export declare function getOptions(variants: PartialDeep<ProductVariantType>[]): OptionWithValues[];

package/dist/node/hooks/useProductOptions/helpers.js

@@ -1,46 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getOptions = exports.getSelectedVariant = exports.getAllOptionValues = void 0;
-function getAllOptionValues(variants, option) {
-    return Array.from(new Set(variants.map((variant) => variant.selectedOptions.find((selection) => selection.name == option)
-        .value)));
-}
-exports.getAllOptionValues = getAllOptionValues;
-function getSelectedVariant(variants, choices) {
-    var _a, _b;
-    /**
-     * Ensure the user has selected all the required options, not just some.
-     */
-    if (!variants.length ||
-        ((_b = (_a = variants === null || variants === void 0 ? void 0 : variants[0]) === null || _a === void 0 ? void 0 : _a.selectedOptions) === null || _b === void 0 ? void 0 : _b.length) !== Object.keys(choices).length) {
-        return;
-    }
-    return variants === null || variants === void 0 ? void 0 : variants.find((variant) => {
-        return Object.entries(choices).every(([name, value]) => {
-            var _a;
-            return (_a = variant === null || variant === void 0 ? void 0 : variant.selectedOptions) === null || _a === void 0 ? void 0 : _a.some((option) => (option === null || option === void 0 ? void 0 : option.name) === name && (option === null || option === void 0 ? void 0 : option.value) === value);
-        });
-    });
-}
-exports.getSelectedVariant = getSelectedVariant;
-function getOptions(variants) {
-    const map = variants.reduce((memo, variant) => {
-        var _a;
-        if (!variant.selectedOptions) {
-            throw new Error(`getOptions requires 'variant.selectedOptions`);
-        }
-        (_a = variant === null || variant === void 0 ? void 0 : variant.selectedOptions) === null || _a === void 0 ? void 0 : _a.forEach((opt) => {
-            var _a, _b, _c, _d;
-            memo[(_a = opt === null || opt === void 0 ? void 0 : opt.name) !== null && _a !== void 0 ? _a : ''] = memo[(_b = opt === null || opt === void 0 ? void 0 : opt.name) !== null && _b !== void 0 ? _b : ''] || new Set();
-            memo[(_c = opt === null || opt === void 0 ? void 0 : opt.name) !== null && _c !== void 0 ? _c : ''].add((_d = opt === null || opt === void 0 ? void 0 : opt.value) !== null && _d !== void 0 ? _d : '');
-        });
-        return memo;
-    }, {});
-    return Object.keys(map).map((option) => {
-        return {
-            name: option,
-            values: Array.from(map[option]),
-        };
-    });
-}
-exports.getOptions = getOptions;

package/dist/node/hooks/useProductOptions/index.d.ts

@@ -1,2 +0,0 @@
-export { useProductOptions } from './useProductOptions.client';
-export * from './types';

package/dist/node/hooks/useProductOptions/index.js

@@ -1,20 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useProductOptions = void 0;
-var useProductOptions_client_1 = require("./useProductOptions.client");
-Object.defineProperty(exports, "useProductOptions", { enumerable: true, get: function () { return useProductOptions_client_1.useProductOptions; } });
-__exportStar(require("./types"), exports);

package/dist/node/hooks/useProductOptions/types.d.ts

@@ -1,44 +0,0 @@
-import type { SelectedOption as SelectedOptionType, ProductVariant as ProductVariantType, ProductVariantConnection, SellingPlan as SellingPlanType, SellingPlanAllocation as SellingPlanAllocationType, SellingPlanGroup as SellingPlanGroupType, SellingPlanGroupConnection } from '../../storefront-api-types';
-import type { PartialDeep } from 'type-fest';
-export declare type SelectedOptions = {
-    [key: string]: string;
-};
-export declare type SelectVariantCallback = (variant: ProductVariantType | null) => void;
-export declare type SelectOptionCallback = (name: SelectedOptionType['name'], value: SelectedOptionType['value']) => void;
-export declare type SelectOptionsCallback = (options: SelectedOptions) => void;
-export declare type OptionsInStockCallback = (name: SelectedOptionType['name'], value: SelectedOptionType['value']) => boolean;
-export declare type SelectedSellingPlanCallback = (sellingPlan: SellingPlanType) => void;
-export interface OptionWithValues {
-    name: SelectedOptionType['name'];
-    values: SelectedOptionType['value'][];
-}
-export declare type ProductOptionsHookValue = PartialDeep<{
-    /** An array of the variant `nodes` from the `VariantConnection`. */
-    variants: ProductVariantType[];
-    variantsConnection?: ProductVariantConnection;
-    /** An array of the product's options and values. */
-    options: OptionWithValues[];
-    /** The selected variant. */
-    selectedVariant?: ProductVariantType | null;
-    selectedOptions: SelectedOptions;
-    /** The selected selling plan. */
-    selectedSellingPlan?: SellingPlanType;
-    /** The selected selling plan allocation. */
-    selectedSellingPlanAllocation?: SellingPlanAllocationType;
-    /** The selling plan groups. */
-    sellingPlanGroups?: (Omit<SellingPlanGroupType, 'sellingPlans'> & {
-        sellingPlans: SellingPlanType[];
-    })[];
-    sellingPlanGroupsConnection?: SellingPlanGroupConnection;
-}> & {
-    /** A callback to set the selected variant to the variant passed as an argument. */
-    setSelectedVariant: SelectVariantCallback;
-    /** A callback to set the selected option. */
-    setSelectedOption: SelectOptionCallback;
-    /** A callback to set multiple selected options at once. */
-    setSelectedOptions: SelectOptionsCallback;
-    /** A callback to set the selected selling plan to the one passed as an argument. */
-    setSelectedSellingPlan: SelectedSellingPlanCallback;
-    /** A callback that returns a boolean indicating if the option is in stock. */
-    isOptionInStock: OptionsInStockCallback;
-};

package/dist/node/hooks/useProductOptions/types.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/dist/node/hooks/useProductOptions/useProductOptions.client.d.ts

@@ -1 +0,0 @@
-export declare function useProductOptions(): import("./types").ProductOptionsHookValue;

package/dist/node/hooks/useProductOptions/useProductOptions.client.js

@@ -1,13 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useProductOptions = void 0;
-const react_1 = require("react");
-const context_1 = require("../../components/ProductOptionsProvider/context");
-function useProductOptions() {
-    const context = (0, react_1.useContext)(context_1.ProductOptionsContext);
-    if (!context) {
-        throw new Error(`'useProductOptions' must be a child of <ProductOptionsProvider/>`);
-    }
-    return context;
-}
-exports.useProductOptions = useProductOptions;

package/dist/node/hooks/useShopQuery/hooks.d.ts

@@ -1,28 +0,0 @@
-import type { CachingStrategy, PreloadOptions } from '../../types';
-export interface UseShopQueryResponse<T> {
-    /** The data returned by the query. */
-    data: T;
-    errors: any;
-}
-/**
- * The `useShopQuery` hook allows you to make server-only GraphQL queries to the Storefront API. It must be a descendent of a `ShopifyProvider` component.
- */
-export declare function useShopQuery<T>({ query, variables, cache, preload, }: {
-    /** A string of the GraphQL query.
-     * If no query is provided, useShopQuery will make no calls to the Storefront API.
-     */
-    query?: string;
-    /** An object of the variables for the GraphQL query. */
-    variables?: Record<string, any>;
-    /** The [caching strategy](https://shopify.dev/custom-storefronts/hydrogen/framework/cache#caching-strategies) to
-     * help you determine which cache control header to set.
-     */
-    cache?: CachingStrategy;
-    /** A string corresponding to a valid locale identifier like `en-us` used to make the request. */
-    locale?: string;
-    /** Whether to[preload the query](https://shopify.dev/custom-storefronts/hydrogen/framework/preloaded-queries).
-     * Defaults to `false`. Specify `true` to preload the query for the URL or `'*'`
-     * to preload the query for all requests.
-     */
-    preload?: PreloadOptions;
-}): UseShopQueryResponse<T>;

package/dist/node/hooks/useShopQuery/hooks.js

@@ -1,171 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useShopQuery = void 0;
-const useShop_1 = require("../../foundation/useShop");
-const log_1 = require("../../utilities/log");
-const utilities_1 = require("../../utilities");
-const ServerRequestProvider_1 = require("../../foundation/ServerRequestProvider");
-const graphql_tracker_1 = require("../../utilities/graphql-tracker");
-const devtools_1 = require("../../utilities/devtools");
-const fetchSync_1 = require("../../foundation/fetchSync/server/fetchSync");
-const ssr_interop_1 = require("../../foundation/ssr-interop");
-const storefrontApi_1 = require("../../utilities/storefrontApi");
-const parse_1 = require("../../utilities/parse");
-// Check if the response body has GraphQL errors
-// https://spec.graphql.org/June2018/#sec-Response-Format
-const shouldCacheResponse = ([body]) => {
-    var _a;
-    try {
-        return !((_a = (0, parse_1.parseJSON)(body)) === null || _a === void 0 ? void 0 : _a.errors);
-    }
-    catch (_b) {
-        // If we can't parse the response, then assume
-        // an error and don't cache the response
-        return false;
-    }
-};
-/**
- * The `useShopQuery` hook allows you to make server-only GraphQL queries to the Storefront API. It must be a descendent of a `ShopifyProvider` component.
- */
-function useShopQuery({ query, variables = {}, cache, preload = false, }) {
-    var _a;
-    /**
-     * If no query is passed, we no-op here to allow developers to obey the Rules of Hooks.
-     */
-    if (!query) {
-        return { data: undefined, errors: undefined };
-    }
-    if (!ssr_interop_1.META_ENV_SSR) {
-        throw new Error('Shopify Storefront API requests should only be made from the server.');
-    }
-    const serverRequest = (0, ServerRequestProvider_1.useServerRequest)(); // eslint-disable-line react-hooks/rules-of-hooks
-    const log = (0, log_1.getLoggerWithContext)(serverRequest);
-    const body = query ? (0, utilities_1.graphqlRequestBody)(query, variables) : '';
-    const { url, requestInit } = useCreateShopRequest(body); // eslint-disable-line react-hooks/rules-of-hooks
-    let text;
-    let data;
-    let useQueryError;
-    try {
-        text = (0, fetchSync_1.fetchSync)(url, {
-            ...requestInit,
-            cache,
-            preload,
-            shouldCacheResponse,
-        }).text();
-        try {
-            data = JSON.parse(text);
-        }
-        catch (error) {
-            useQueryError = new Error('Unable to parse response:\n' + text);
-        }
-    }
-    catch (error) {
-        // Pass-through thrown promise for Suspense functionality
-        if (error === null || error === void 0 ? void 0 : error.then) {
-            throw error;
-        }
-        useQueryError = error;
-    }
-    /**
-     * The fetch request itself failed, so we handle that differently than a GraphQL error
-     */
-    if (useQueryError) {
-        const errorMessage = createErrorMessage(useQueryError);
-        log.error(errorMessage);
-        log.error(useQueryError);
-        if (__HYDROGEN_DEV__ && !__HYDROGEN_TEST__) {
-            throw new Error(errorMessage);
-        }
-        else {
-            // in non-dev environments, we probably don't want super-detailed error messages for the user
-            throw new Error(`The fetch attempt failed; there was an issue connecting to the data source.`);
-        }
-    }
-    /**
-     * GraphQL errors get printed to the console but ultimately
-     * get returned to the consumer.
-     */
-    if (data === null || data === void 0 ? void 0 : data.errors) {
-        const errors = Array.isArray(data.errors) ? data.errors : [data.errors];
-        for (const error of errors) {
-            if (__HYDROGEN_DEV__ && !__HYDROGEN_TEST__) {
-                throw new Error(error.message);
-            }
-            else {
-                log.error('GraphQL Error', error);
-            }
-        }
-        log.error(`GraphQL errors: ${errors.length}`);
-    }
-    if (__HYDROGEN_DEV__ &&
-        log.options().showUnusedQueryProperties &&
-        query &&
-        (data === null || data === void 0 ? void 0 : data.data)) {
-        const fileLine = (_a = new Error('').stack) === null || _a === void 0 ? void 0 : _a.split('\n').find((line) => line.includes('.server.'));
-        const [, functionName, fileName] = (fileLine === null || fileLine === void 0 ? void 0 : fileLine.match(/^\s*at (\w+) \(([^)]+)\)/)) || [];
-        (0, graphql_tracker_1.injectGraphQLTracker)({
-            query,
-            data,
-            onUnusedData: ({ queryName, properties }) => {
-                const footer = `Examine the list of fields above to confirm that they are being used.\n`;
-                const header = `Potentially overfetching fields in GraphQL query.\n`;
-                let info = `Query \`${queryName}\``;
-                if (fileName) {
-                    info += ` in file \`${fileName}\` (function \`${functionName}\`)`;
-                }
-                const n = 6;
-                const shouldTrim = properties.length > n + 1;
-                const shownProperties = shouldTrim
-                    ? properties.slice(0, n)
-                    : properties;
-                const hiddenInfo = shouldTrim
-                    ? `  ...and ${properties.length - shownProperties.length} more\n`
-                    : '';
-                const warning = header +
-                    info +
-                    `:\n• ${shownProperties.join(`\n• `)}\n` +
-                    hiddenInfo +
-                    footer;
-                log.warn(warning);
-                (0, devtools_1.sendMessageToClient)({ type: 'warn', data: warning });
-            },
-        });
-    }
-    return data;
-}
-exports.useShopQuery = useShopQuery;
-function useCreateShopRequest(body) {
-    const { storeDomain, storefrontToken, storefrontApiVersion } = (0, useShop_1.useShop)();
-    const request = (0, ServerRequestProvider_1.useServerRequest)();
-    const buyerIp = request.getBuyerIp();
-    const extraHeaders = (0, storefrontApi_1.getStorefrontApiRequestHeaders)({
-        buyerIp,
-        storefrontToken,
-    });
-    return {
-        key: [storeDomain, storefrontApiVersion, body],
-        url: `https://${storeDomain}/api/${storefrontApiVersion}/graphql.json`,
-        requestInit: {
-            body,
-            method: 'POST',
-            headers: {
-                'X-SDK-Variant': 'hydrogen',
-                'X-SDK-Version': storefrontApiVersion,
-                'content-type': 'application/json',
-                ...extraHeaders,
-            },
-        },
-    };
-}
-function createErrorMessage(fetchError) {
-    if (fetchError instanceof Response) {
-        return `An error occurred while fetching from the Storefront API. ${
-        // 403s to the SF API (almost?) always mean that your Shopify credentials are bad/wrong
-        fetchError.status === 403
-            ? `You may have a bad value in 'hydrogen.config.js'`
-            : `${fetchError.statusText}`}`;
-    }
-    else {
-        return `Failed to connect to the Storefront API: ${fetchError.message}`;
-    }
-}

package/dist/node/hooks/useShopQuery/index.d.ts

@@ -1 +0,0 @@
-export { useShopQuery } from './hooks';

package/dist/node/hooks/useShopQuery/index.js

@@ -1,5 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.useShopQuery = void 0;
-var hooks_1 = require("./hooks");
-Object.defineProperty(exports, "useShopQuery", { enumerable: true, get: function () { return hooks_1.useShopQuery; } });