@shopify/hydrogen-react 2022.7.0

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

@@ -0,0 +1,63 @@
+/**
+ * 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;
+declare type StorefrontClientProps = {
+    /** The host name of the domain (eg: `{shop}.myshopify.com`). */
+    storeDomain: string;
+    /** The Storefront API delegate access token. Refer to the [authentication](https://shopify.dev/api/storefront#authentication) and [delegate access token](https://shopify.dev/apps/auth/oauth/delegate-access-tokens) documentation for more details. */
+    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.  */
+    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"`
+     *
+     * Can also be customized on a call-by-call basis by passing in `'contentType'` to both `getPrivateTokenHeaders({...})` and `getPublicTokenHeaders({...})`, for example: `getPublicTokenHeaders({contentType: 'graphql'})`
+     */
+    contentType?: 'json' | 'graphql';
+};
+declare type OverrideTokenHeaderProps = Partial<Pick<StorefrontClientProps, 'contentType'>>;
+declare type StorefrontClientReturn = {
+    /**
+     * Creates the fully-qualified URL to your store's GraphQL endpoint.
+     *
+     * By default, it will use the config you passed in when calling `createStorefrontClient()`. However, you can override the following settings on each invocation of `getStorefrontApiUrl({...})`:
+     *
+     * - `storeDomain`
+     * - `storefrontApiVersion`
+     */
+    getStorefrontApiUrl: (props?: Partial<Pick<StorefrontClientProps, 'storeDomain' | 'storefrontApiVersion'>>) => string;
+    /**
+     * Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. This method uses the private Server-to-Server token which reduces the chance of throttling but must not be exposed to clients. Server-side calls should prefer using this over `getPublicTokenHeaders()`.
+     *
+     * By default, it will use the config you passed in when calling `createStorefrontClient()`. However, you can override the following settings on each invocation of `getPrivateTokenHeaders({...})`:
+     *
+     * - `contentType`
+     * - `privateStorefrontToken`
+     * - `buyerIp`
+     *
+     * Note that `contentType` defaults to what you configured in `createStorefrontClient({...})` and defaults to `'json'`, but a specific call may require using `graphql`. When using `JSON.stringify()` on the `body`, use `'json'`; otherwise, use `'graphql'`.
+     */
+    getPrivateTokenHeaders: (props?: OverrideTokenHeaderProps & Pick<StorefrontClientProps, 'privateStorefrontToken'> & {
+        /**
+         * The client's IP address. Passing this to the Storefront API when using a server-to-server token will help improve your store's analytics data.
+         */
+        buyerIp?: string;
+    }) => Record<string, string>;
+    /**
+     * Returns an object that contains headers that are needed for each query to Storefront API GraphQL endpoint. This method uses the private Server-to-Server token which reduces the chance of throttling but must not be exposed to clients. Server-side calls should prefer using this over `getPublicTokenHeaders()`.
+     *
+     * By default, it will use the config you passed in when calling `createStorefrontClient()`. However, you can override the following settings on each invocation of `getPrivateTokenHeaders({...})`:
+     *
+     * - `contentType`
+     * - `publicStorefrontToken`
+     *
+     * Note that `contentType` defaults to what you configured in `createStorefrontClient({...})` and defaults to `'json'`, but a specific call may require using `graphql`. When using `JSON.stringify()` on the `body`, use `'json'`; otherwise, use `'graphql'`.
+     */
+    getPublicTokenHeaders: (props?: OverrideTokenHeaderProps & Pick<StorefrontClientProps, 'publicStorefrontToken'>) => Record<string, string>;
+};
+export {};

package/dist/types/useMoney.d.ts

@@ -0,0 +1,55 @@
+import { CurrencyCode, MoneyV2 } from './storefront-api-types.js';
+export declare type UseMoneyValue = {
+    /**
+     * The currency code from the `MoneyV2` object.
+     */
+    currencyCode: CurrencyCode;
+    /**
+     * The name for the currency code, returned by `Intl.NumberFormat`.
+     */
+    currencyName?: string;
+    /**
+     * The currency symbol returned by `Intl.NumberFormat`.
+     */
+    currencySymbol?: string;
+    /**
+     * The currency narrow symbol returned by `Intl.NumberFormat`.
+     */
+    currencyNarrowSymbol?: string;
+    /**
+     * The localized amount, without any currency symbols or non-number types from the `Intl.NumberFormat.formatToParts` parts.
+     */
+    amount: string;
+    /**
+     * All parts returned by `Intl.NumberFormat.formatToParts`.
+     */
+    parts: Intl.NumberFormatPart[];
+    /**
+     * A string returned by `new Intl.NumberFormat` for the amount and currency code,
+     * using the `locale` value in the [`LocalizationProvider` component](https://shopify.dev/api/hydrogen/components/localization/localizationprovider).
+     */
+    localizedString: string;
+    /**
+     * The `MoneyV2` object provided as an argument to the hook.
+     */
+    original: MoneyV2;
+    /**
+     * A string with trailing zeros removed from the fractional part, if any exist. If there are no trailing zeros, then the fractional part remains.
+     * For example, `$640.00` turns into `$640`.
+     * `$640.42` remains `$640.42`.
+     */
+    withoutTrailingZeros: string;
+    /**
+     * A string without currency and without trailing zeros removed from the fractional part, if any exist. If there are no trailing zeros, then the fractional part remains.
+     * For example, `$640.00` turns into `640`.
+     * `$640.42` turns into `640.42`.
+     */
+    withoutTrailingZerosAndCurrency: string;
+};
+/**
+ * The `useMoney` hook takes a [MoneyV2 object](https://shopify.dev/api/storefront/reference/common-objects/moneyv2) and returns a
+ * default-formatted string of the amount with the correct currency indicator, along with some of the parts provided by
+ * [Intl.NumberFormat](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat).
+ * Uses `locale` from `ShopifyProvider`
+ */
+export declare function useMoney(money: MoneyV2): UseMoneyValue;