@shopify/hydrogen-react 2022.10.1 → 2022.10.2

package/dist/prod/metafield-parser.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"metafield-parser.mjs","sources":["../../src/metafield-parser.ts"],"sourcesContent":["import type {\n  Collection,\n  GenericFile,\n  Metafield as MetafieldBaseType,\n  MoneyV2,\n  Page,\n  Product,\n  ProductVariant,\n} from './storefront-api-types.js';\nimport type {PartialDeep, Simplify} from 'type-fest';\nimport {parseJSON} from './Metafield.js';\nimport {flattenConnection} from './flatten-connection.js';\n\n/**\n * A temporary function that will be renamed to `parseMetafield()` in a future release.\n *\n * 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`\n *\n * TypeScript developers can use the type `ParsedMetafields` from this package to get the returned object's type correct. For example:\n *\n * ```\n * metafieldParser<ParsedMetafields['boolean']>({type: 'boolean', value: 'false'}\n * ```\n */\nexport function metafieldParser<ReturnGeneric>(\n  metafield: PartialDeep<MetafieldBaseType, {recurseIntoArrays: true}>\n): ReturnGeneric {\n  if (!metafield.type) {\n    const noTypeError = `metafieldParser(): The 'type' field is required in order to parse the Metafield.`;\n    if (__HYDROGEN_DEV__) {\n      throw new Error(noTypeError);\n    } else {\n      console.error(`${noTypeError} Returning 'parsedValue' of 'null'`);\n      return {\n        ...metafield,\n        parsedValue: null,\n      } as ReturnGeneric;\n    }\n  }\n\n  switch (metafield.type) {\n    case 'boolean':\n      return {\n        ...metafield,\n        parsedValue: metafield.value === 'true',\n      } as ReturnGeneric;\n\n    case 'collection_reference':\n    case 'file_reference':\n    case 'page_reference':\n    case 'product_reference':\n    case 'variant_reference':\n      return {\n        ...metafield,\n        parsedValue: metafield.reference,\n      } as ReturnGeneric;\n\n    case 'color':\n    case 'multi_line_text_field':\n    case 'single_line_text_field':\n    case 'url':\n      return {\n        ...metafield,\n        parsedValue: metafield.value,\n      } as ReturnGeneric;\n\n    // TODO: 'money' should probably be parsed even further to like `useMoney()`, but that logic needs to be extracted first so it's not a hook\n    case 'dimension':\n    case 'money':\n    case 'json':\n    case 'rating':\n    case 'volume':\n    case 'weight':\n    case 'list.color':\n    case 'list.dimension':\n    case 'list.number_integer':\n    case 'list.number_decimal':\n    case 'list.rating':\n    case 'list.single_line_text_field':\n    case 'list.url':\n    case 'list.volume':\n    case 'list.weight': {\n      let parsedValue = null;\n      try {\n        parsedValue = parseJSON(metafield.value ?? '');\n      } catch (err) {\n        const parseError = `metafieldParser(): attempted to JSON.parse the 'metafield.value' property, but failed.`;\n        if (__HYDROGEN_DEV__) {\n          throw new Error(parseError);\n        } else {\n          console.error(`${parseError} Returning 'null' for 'parsedValue'`);\n        }\n        parsedValue = null;\n      }\n      return {\n        ...metafield,\n        parsedValue,\n      } as ReturnGeneric;\n    }\n\n    case 'date':\n    case 'date_time':\n      return {\n        ...metafield,\n        parsedValue: new Date(metafield.value ?? ''),\n      } as ReturnGeneric;\n\n    case 'list.date':\n    case 'list.date_time': {\n      const jsonParseValue = parseJSON(metafield?.value ?? '') as string[];\n      return {\n        ...metafield,\n        parsedValue: jsonParseValue.map((dateString) => new Date(dateString)),\n      } as ReturnGeneric;\n    }\n\n    case 'number_decimal':\n    case 'number_integer':\n      return {\n        ...metafield,\n        parsedValue: Number(metafield.value),\n      } as ReturnGeneric;\n\n    case 'list.collection_reference':\n    case 'list.file_reference':\n    case 'list.page_reference':\n    case 'list.product_reference':\n    case 'list.variant_reference':\n      return {\n        ...metafield,\n        parsedValue: flattenConnection(metafield.references ?? undefined),\n      } as ReturnGeneric;\n\n    default: {\n      const typeNotFoundError = `metafieldParser(): the 'metafield.type' you passed in is not supported. Your type: \"${metafield.type}\". If you believe this is an error, please open an issue on GitHub.`;\n      if (__HYDROGEN_DEV__) {\n        throw new Error(typeNotFoundError);\n      } else {\n        console.error(\n          `${typeNotFoundError}  Returning 'parsedValue' of 'null'`\n        );\n        return {\n          ...metafield,\n          parsedValue: null,\n        } as ReturnGeneric;\n      }\n    }\n  }\n}\n\n// taken from https://shopify.dev/apps/metafields/types\nexport const allMetafieldTypesArray = [\n  'boolean',\n  'collection_reference',\n  'color',\n  'date',\n  'date_time',\n  'dimension',\n  'file_reference',\n  'json',\n  'money',\n  'multi_line_text_field',\n  'number_decimal',\n  'number_integer',\n  'page_reference',\n  'product_reference',\n  'rating',\n  'single_line_text_field',\n  'url',\n  'variant_reference',\n  'volume',\n  'weight',\n  // list metafields\n  'list.collection_reference',\n  'list.color',\n  'list.date',\n  'list.date_time',\n  'list.dimension',\n  'list.file_reference',\n  'list.number_integer',\n  'list.number_decimal',\n  'list.page_reference',\n  'list.product_reference',\n  'list.rating',\n  'list.single_line_text_field',\n  'list.url',\n  'list.variant_reference',\n  'list.volume',\n  'list.weight',\n] as const;\n\n/** A union of all the supported `metafield.type`s */\nexport type MetafieldTypeTypes = typeof allMetafieldTypesArray[number];\n\n/**\n * A mapping of a Metafield's `type` to the TypeScript type that is returned from `metafieldParser()`\n * For example, when using `metafieldParser()`, the type will be correctly returned when used like the following:\n *\n * ```\n * const parsedMetafield = metafieldParser<ParsedMetafields['boolean']>(metafield);`\n * ```\n * `parsedMetafield.parsedValue`'s type is now `boolean`\n */\nexport type ParsedMetafields<ExtraTypeGeneric = void> = {\n  /** A Metafield that's been parsed, with a `parsedValue` of `boolean` */\n  boolean: Simplify<BooleanParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of a `Collection` object (as defined by the Storefront API) */\n  collection_reference: Simplify<CollectionParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `string` */\n  color: Simplify<ColorParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Date` */\n  date: Simplify<DatesParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Date` */\n  date_time: Simplify<DatesParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */\n  dimension: Simplify<MeasurementParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of a `GenericFile` object (as defined by the Storefront API) */\n  file_reference: Simplify<FileRefParsedMetafield>;\n  /**\n   * A Metafield that's been parsed, with a `parsedValue` of type `unknown`, unless you pass in the type as a generic. For example:\n   *\n   * ```\n   * ParsedMetafields<MyJsonType>['json']\n   * ```\n   */\n  json: Simplify<JsonParsedMetafield<ExtraTypeGeneric>>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Money` */\n  money: Simplify<MoneyParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `string` */\n  multi_line_text_field: Simplify<TextParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `number` */\n  number_decimal: Simplify<NumberParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `number` */\n  number_integer: Simplify<NumberParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of a `Page` object (as defined by the Storefront API) */\n  page_reference: Simplify<PageParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of a `Product` object (as defined by the Storefront API) */\n  product_reference: Simplify<ProductParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Rating` */\n  rating: Simplify<RatingParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `string` */\n  single_line_text_field: Simplify<TextParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `string` */\n  url: Simplify<TextParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of a `ProductVariant` object (as defined by the Storefront API) */\n  variant_reference: Simplify<VariantParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */\n  volume: Simplify<MeasurementParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */\n  weight: Simplify<MeasurementParsedMetafield>;\n  // list metafields\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Collection` objects (as defined by the Storefront API) */\n  'list.collection_reference': Simplify<CollectionListParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */\n  'list.color': Simplify<ColorListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of Date objects */\n  'list.date': Simplify<DatesListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of Date objects */\n  'list.date_time': Simplify<DatesListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement` objects */\n  'list.dimension': Simplify<MeasurementListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `GenericFile` objects (as defined by the Storefront API) */\n  'list.file_reference': Simplify<FileListParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of numbers */\n  'list.number_integer': Simplify<NumberListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of numbers */\n  'list.number_decimal': Simplify<NumberListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Page` objects (as defined by the Storefront API) */\n  'list.page_reference': Simplify<PageListParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Product` objects (as defined by the Storefront API) */\n  'list.product_reference': Simplify<ProductListParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Rating`s */\n  'list.rating': Simplify<RatingListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */\n  'list.single_line_text_field': Simplify<TextListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */\n  'list.url': Simplify<TextListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `ProductVariant` objects (as defined by the Storefront API) */\n  'list.variant_reference': Simplify<VariantListParsedRefMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement`s */\n  'list.volume': Simplify<MeasurementListParsedMetafield>;\n  /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement`s */\n  'list.weight': Simplify<MeasurementListParsedMetafield>;\n};\n\ninterface ParsedBase extends MetafieldBaseType {\n  type: MetafieldTypeTypes;\n  parsedValue: unknown;\n}\n\ninterface BooleanParsedMetafield extends ParsedBase {\n  type: 'boolean';\n  parsedValue: boolean | null;\n}\ntype CollectionParsedRefMetafield = MetafieldBaseType & {\n  type: 'collection_reference';\n  parsedValue: Collection | null;\n};\ntype ColorParsedMetafield = MetafieldBaseType & {\n  type: 'color';\n  parsedValue: string | null;\n};\ntype DatesParsedMetafield = MetafieldBaseType & {\n  type: 'date' | 'date_time';\n  parsedValue: Date | null;\n};\n\ntype MeasurementParsedMetafield = MetafieldBaseType & {\n  type: 'dimension' | 'weight' | 'volume';\n  parsedValue: Measurement | null;\n};\n\ntype FileRefParsedMetafield = MetafieldBaseType & {\n  type: 'file_reference';\n  parsedValue: GenericFile | null;\n};\n\ntype JsonParsedMetafield<JsonTypeGeneric = void> = MetafieldBaseType & {\n  type: 'json';\n  parsedValue: JsonTypeGeneric extends void ? unknown : JsonTypeGeneric | null;\n};\n\ntype MoneyParsedMetafield = MetafieldBaseType & {\n  type: 'money';\n  parsedValue: MoneyV2 | null;\n};\n\ntype TextParsedMetafield = MetafieldBaseType & {\n  type: 'single_line_text_field' | 'multi_line_text_field' | 'url';\n  parsedValue: string | null;\n};\n\ntype NumberParsedMetafield = MetafieldBaseType & {\n  type: 'number_decimal' | 'number_integer';\n  parsedValue: number | null;\n};\n\ntype PageParsedRefMetafield = MetafieldBaseType & {\n  type: 'page_reference';\n  parsedValue: Page | null;\n};\n\ntype ProductParsedRefMetafield = MetafieldBaseType & {\n  type: 'product_reference';\n  parsedValue: Product | null;\n};\n\ntype RatingParsedMetafield = MetafieldBaseType & {\n  type: 'rating';\n  parsedValue: Rating | null;\n};\n\ntype VariantParsedRefMetafield = MetafieldBaseType & {\n  type: 'variant_reference';\n  parsedValue: ProductVariant | null;\n};\n\ntype CollectionListParsedRefMetafield = MetafieldBaseType & {\n  type: 'list.collection_reference';\n  parsedValue: Array<Collection> | null;\n};\n\ntype ColorListParsedMetafield = MetafieldBaseType & {\n  type: 'list.color';\n  parsedValue: Array<string> | null;\n};\n\ntype DatesListParsedMetafield = MetafieldBaseType & {\n  type: 'list.date' | 'list.date_time';\n  parsedValue: Array<Date> | null;\n};\n\ntype MeasurementListParsedMetafield = MetafieldBaseType & {\n  type: 'list.dimension' | 'list.weight' | 'list.volume';\n  parsedValue: Array<Measurement> | null;\n};\n\ntype FileListParsedRefMetafield = MetafieldBaseType & {\n  type: 'list.file_reference';\n  parsedValue: Array<GenericFile> | null;\n};\n\ntype TextListParsedMetafield = MetafieldBaseType & {\n  type: 'list.single_line_text_field' | 'list.url';\n  parsedValue: Array<string> | null;\n};\n\ntype NumberListParsedMetafield = MetafieldBaseType & {\n  type: 'list.number_decimal' | 'list.number_integer';\n  parsedValue: Array<number> | null;\n};\n\ntype PageListParsedRefMetafield = MetafieldBaseType & {\n  type: 'list.page_reference';\n  parsedValue: Array<Page> | null;\n};\n\ntype ProductListParsedRefMetafield = MetafieldBaseType & {\n  type: 'list.product_reference';\n  parsedValue: Array<Product> | null;\n};\n\ntype RatingListParsedMetafield = MetafieldBaseType & {\n  type: 'list.rating';\n  parsedValue: Array<Rating> | null;\n};\n\ntype VariantListParsedRefMetafield = MetafieldBaseType & {\n  type: 'list.variant_reference';\n  parsedValue: Array<ProductVariant> | null;\n};\n\nexport type Measurement = {\n  unit: string;\n  value: number;\n};\n\nexport interface Rating {\n  value: number;\n  scale_min: number;\n  scale_max: number;\n}\n"],"names":[],"mappings":";;AAwBO,SAAS,gBACd,WACe;;AACX,MAAA,CAAC,UAAU,MAAM;AACnB,UAAM,cAAc;AAGb;AACG,cAAA,MAAM,GAAG,+CAA+C;AACzD,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa;AAAA,MAAA;AAAA,IAEjB;AAAA,EACF;AAEA,UAAQ,UAAU,MAAM;AAAA,IACtB,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,UAAU,UAAU;AAAA,MAAA;AAAA,IAGrC,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,UAAU;AAAA,MAAA;AAAA,IAG3B,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,UAAU;AAAA,MAAA;AAAA,IAI3B,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK,eAAe;AAClB,UAAI,cAAc;AACd,UAAA;AACY,sBAAA,WAAU,eAAU,UAAV,YAAmB,EAAE;AAAA,eACtC;AACP,cAAM,aAAa;AAGZ;AACG,kBAAA,MAAM,GAAG,+CAA+C;AAAA,QAClE;AACc,sBAAA;AAAA,MAChB;AACO,aAAA;AAAA,QACL,GAAG;AAAA,QACH;AAAA,MAAA;AAAA,IAEJ;AAAA,IAEA,KAAK;AAAA,IACL,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,IAAI,MAAK,eAAU,UAAV,YAAmB,EAAE;AAAA,MAAA;AAAA,IAG/C,KAAK;AAAA,IACL,KAAK,kBAAkB;AACrB,YAAM,iBAAiB,WAAU,4CAAW,UAAX,YAAoB,EAAE;AAChD,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,eAAe,IAAI,CAAC,eAAe,IAAI,KAAK,UAAU,CAAC;AAAA,MAAA;AAAA,IAExE;AAAA,IAEA,KAAK;AAAA,IACL,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,OAAO,UAAU,KAAK;AAAA,MAAA;AAAA,IAGvC,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AAAA,IACL,KAAK;AACI,aAAA;AAAA,QACL,GAAG;AAAA,QACH,aAAa,mBAAkB,eAAU,eAAV,YAAwB,MAAS;AAAA,MAAA;AAAA,IAGpE,SAAS;AACD,YAAA,oBAAoB,uFAAuF,UAAU;AAGpH;AACG,gBAAA;AAAA,UACN,GAAG;AAAA,QAAA;AAEE,eAAA;AAAA,UACL,GAAG;AAAA,UACH,aAAa;AAAA,QAAA;AAAA,MAEjB;AAAA,IACF;AAAA,EACF;AACF;"}

package/dist/types/AddToCartButton.d.ts

@@ -0,0 +1,22 @@
+import { BaseButtonProps } from './BaseButton.js';
+interface AddToCartButtonProps {
+    /** An array of cart line attributes that belong to the item being added to the cart. */
+    attributes?: {
+        key: string;
+        value: string;
+    }[];
+    /** The ID of the variant. */
+    variantId?: string | null;
+    /** The item quantity. */
+    quantity?: number;
+    /** The text that is announced by the screen reader when the item is being added to the cart. Used for accessibility purposes only and not displayed on the page. */
+    accessibleAddingToCartLabel?: string;
+    /** The selling plan ID of the subscription variant */
+    sellingPlanId?: string;
+}
+/**
+ * The `AddToCartButton` component renders a button that adds an item to the cart when pressed.
+ * It must be a descendent of the `CartProvider` component.
+ */
+export declare function AddToCartButton<AsType extends React.ElementType = 'button'>(props: AddToCartButtonProps & BaseButtonProps<AsType>): JSX.Element;
+export {};

package/dist/types/BaseButton.d.ts

@@ -0,0 +1,15 @@
+import { ReactNode, Ref } from 'react';
+export interface CustomBaseButtonProps<AsType> {
+    /** Provide a React element or component to render as the underlying button. Note: for accessibility compliance, almost always you should use a `button` element, or a component that renders an underlying button. */
+    as?: AsType;
+    /** Any ReactNode elements. */
+    children: ReactNode;
+    /** Click event handler. Default behaviour triggers unless prevented */
+    onClick?: (event?: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | boolean;
+    /** A default onClick behavior */
+    defaultOnClick?: (event?: React.MouseEvent<HTMLButtonElement, MouseEvent>) => void | boolean;
+    /** A ref to the underlying button */
+    buttonRef?: Ref<HTMLButtonElement>;
+}
+export declare type BaseButtonProps<AsType extends React.ElementType> = CustomBaseButtonProps<AsType> & Omit<React.ComponentPropsWithoutRef<AsType>, keyof CustomBaseButtonProps<AsType>>;
+export declare function BaseButton<AsType extends React.ElementType = 'button'>(props: BaseButtonProps<AsType>): JSX.Element;

package/dist/types/BuyNowButton.d.ts

@@ -0,0 +1,15 @@
+import { BaseButtonProps } from './BaseButton.js';
+interface BuyNowButtonProps {
+    /** The item quantity. Defaults to 1. */
+    quantity?: number;
+    /** The ID of the variant. */
+    variantId: string;
+    /** An array of cart line attributes that belong to the item being added to the cart. */
+    attributes?: {
+        key: string;
+        value: string;
+    }[];
+}
+/** The `BuyNowButton` component renders a button that adds an item to the cart and redirects the customer to checkout. */
+export declare function BuyNowButton<AsType extends React.ElementType = 'button'>(props: BuyNowButtonProps & BaseButtonProps<AsType>): JSX.Element;
+export {};

package/dist/types/CartCheckoutButton.d.ts

@@ -0,0 +1,12 @@
+import { ReactNode } from 'react';
+import { BaseButtonProps } from './BaseButton.js';
+declare type PropsWeControl = 'onClick';
+/**
+ * The `CartCheckoutButton` component renders a button that redirects to the checkout URL for the cart.
+ * It must be a descendent of a `CartProvider` component.
+ */
+export declare function CartCheckoutButton(props: Omit<BaseButtonProps<'button'>, PropsWeControl> & {
+    /** A `ReactNode` element. */
+    children: ReactNode;
+}): JSX.Element;
+export {};

package/dist/types/CartCost.d.ts

@@ -0,0 +1,13 @@
+import { Money } from './Money.js';
+export interface CartCostProps {
+    /** A string type that defines the type of cost needed. Valid values: `total`, `subtotal`, `tax`, or `duty`. */
+    amountType?: 'total' | 'subtotal' | 'tax' | 'duty';
+    /** Any `ReactNode` elements. */
+    children?: React.ReactNode;
+}
+/**
+ * The `CartCost` component renders a `Money` component with the
+ * cost associated with the `amountType` prop. If no `amountType` prop is specified, then it defaults to `totalAmount`.
+Depends on `useCart()` and must be a child of `<CartProvider/>`
+ */
+export declare function CartCost(props: Omit<React.ComponentProps<typeof Money>, 'data'> & CartCostProps): JSX.Element | null;

package/dist/types/MediaFile.d.ts

@@ -4,7 +4,9 @@ import { ExternalVideo } from './ExternalVideo.js';
 import { ModelViewer } from './ModelViewer.js';
 import type { MediaEdge as MediaEdgeType } from './storefront-api-types.js';
 import type { PartialDeep } from 'type-fest';
-interface MediaFileProps {
+import type { ModelViewerElement } from '@google/model-viewer/lib/model-viewer.js';
+declare type BaseProps = React.HTMLAttributes<HTMLImageElement | HTMLVideoElement | HTMLIFrameElement | ModelViewerElement>;
+export interface MediaFileProps extends BaseProps {
     /** An object with fields that correspond to the Storefront API's [Media object](https://shopify.dev/api/storefront/reference/products/media). */
     data: PartialDeep<MediaEdgeType['node'], {
         recurseIntoArrays: true;

package/dist/types/Metafield.d.ts

@@ -22,6 +22,8 @@ export declare function Metafield<ComponentGeneric extends ElementType>(props: M
  * The `parseMetafield` utility transforms a [Metafield](https://shopify.dev/api/storefront/reference/common-objects/Metafield)
  * into a new object whose `values` have been parsed according to the metafield `type`.
  * If the metafield is `null`, then it returns `null` back.
+ *
+ * Note that `parseMetafield()` will have a breaking change in a future version; it will change to behave like `metafieldParser()`.
  */
 export declare function parseMetafield(
 /** A [Metafield](https://shopify.dev/api/storefront/reference/common-objects/Metafield) or null */
@@ -32,6 +34,7 @@ metafield: PartialDeep<MetafieldType, {
 }> | null;
 /**
  * The `parseMetafieldValue` function parses a [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `value` from a string into a sensible type corresponding to the [Metafield](https://shopify.dev/api/storefront/reference/common-objects/metafield)'s `type`.
+ * @deprecated `parseMetafieldValue()` is unsupported and will be removed in a future version.
  */
 export declare function parseMetafieldValue(metafield: PartialDeep<MetafieldType, {
     recurseIntoArrays: true;

package/dist/types/ProductPrice.d.ts

@@ -1,7 +1,7 @@
 import type { Product } from './storefront-api-types.js';
 import { type MoneyProps } from './Money.js';
 import type { PartialDeep } from 'type-fest';
-interface ProductPriceProps {
+export interface ProductPriceProps {
     /** A [Product object](https://shopify.dev/api/storefront/reference/products/product). */
     data: PartialDeep<Product, {
         recurseIntoArrays: true;
@@ -18,4 +18,3 @@ interface ProductPriceProps {
  * [`priceRange`](https://shopify.dev/api/storefront/reference/products/productpricerange)'s `maxVariantPrice` or `minVariantPrice`, for either the regular price or compare at price range.
  */
 export declare function ProductPrice<ComponentGeneric extends React.ElementType>(props: ProductPriceProps & Omit<MoneyProps<ComponentGeneric>, 'data' | 'measurement'>): JSX.Element | null;
-export {};

package/dist/types/index.d.cts

@@ -1,9 +1,13 @@
+export { AddToCartButton } from './AddToCartButton.js';
+export { BuyNowButton } from './BuyNowButton.js';
 export type { CartState, CartStatus, Cart, CartWithActions, CartAction, } from './cart-types.js';
+export { CartCheckoutButton } from './CartCheckoutButton.js';
 export { CartProvider, useCart } from './CartProvider.js';
 export { ExternalVideo } from './ExternalVideo.js';
 export { flattenConnection } from './flatten-connection.js';
 export { Image } from './Image.js';
 export { MediaFile } from './MediaFile.js';
+export { metafieldParser, type ParsedMetafields } from './metafield-parser.js';
 export { Metafield, parseMetafield, parseMetafieldValue } from './Metafield.js';
 export { ModelViewer } from './ModelViewer.js';
 export { Money } from './Money.js';

package/dist/types/index.d.ts

@@ -1,9 +1,13 @@
+export { AddToCartButton } from './AddToCartButton.js';
+export { BuyNowButton } from './BuyNowButton.js';
 export type { CartState, CartStatus, Cart, CartWithActions, CartAction, } from './cart-types.js';
+export { CartCheckoutButton } from './CartCheckoutButton.js';
 export { CartProvider, useCart } from './CartProvider.js';
 export { ExternalVideo } from './ExternalVideo.js';
 export { flattenConnection } from './flatten-connection.js';
 export { Image } from './Image.js';
 export { MediaFile } from './MediaFile.js';
+export { metafieldParser, type ParsedMetafields } from './metafield-parser.js';
 export { Metafield, parseMetafield, parseMetafieldValue } from './Metafield.js';
 export { ModelViewer } from './ModelViewer.js';
 export { Money } from './Money.js';

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

@@ -0,0 +1,222 @@
+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`
+ *
+ * TypeScript developers can use the type `ParsedMetafields` from this package to get the returned object's type correct. For example:
+ *
+ * ```
+ * metafieldParser<ParsedMetafields['boolean']>({type: 'boolean', value: 'false'}
+ * ```
+ */
+export declare function metafieldParser<ReturnGeneric>(metafield: PartialDeep<MetafieldBaseType, {
+    recurseIntoArrays: true;
+}>): ReturnGeneric;
+export declare const allMetafieldTypesArray: readonly ["boolean", "collection_reference", "color", "date", "date_time", "dimension", "file_reference", "json", "money", "multi_line_text_field", "number_decimal", "number_integer", "page_reference", "product_reference", "rating", "single_line_text_field", "url", "variant_reference", "volume", "weight", "list.collection_reference", "list.color", "list.date", "list.date_time", "list.dimension", "list.file_reference", "list.number_integer", "list.number_decimal", "list.page_reference", "list.product_reference", "list.rating", "list.single_line_text_field", "list.url", "list.variant_reference", "list.volume", "list.weight"];
+/** A union of all the supported `metafield.type`s */
+export declare type MetafieldTypeTypes = typeof allMetafieldTypesArray[number];
+/**
+ * A mapping of a Metafield's `type` to the TypeScript type that is returned from `metafieldParser()`
+ * For example, when using `metafieldParser()`, the type will be correctly returned when used like the following:
+ *
+ * ```
+ * const parsedMetafield = metafieldParser<ParsedMetafields['boolean']>(metafield);`
+ * ```
+ * `parsedMetafield.parsedValue`'s type is now `boolean`
+ */
+export declare type ParsedMetafields<ExtraTypeGeneric = void> = {
+    /** A Metafield that's been parsed, with a `parsedValue` of `boolean` */
+    boolean: Simplify<BooleanParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of a `Collection` object (as defined by the Storefront API) */
+    collection_reference: Simplify<CollectionParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `string` */
+    color: Simplify<ColorParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Date` */
+    date: Simplify<DatesParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Date` */
+    date_time: Simplify<DatesParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */
+    dimension: Simplify<MeasurementParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of a `GenericFile` object (as defined by the Storefront API) */
+    file_reference: Simplify<FileRefParsedMetafield>;
+    /**
+     * A Metafield that's been parsed, with a `parsedValue` of type `unknown`, unless you pass in the type as a generic. For example:
+     *
+     * ```
+     * ParsedMetafields<MyJsonType>['json']
+     * ```
+     */
+    json: Simplify<JsonParsedMetafield<ExtraTypeGeneric>>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Money` */
+    money: Simplify<MoneyParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `string` */
+    multi_line_text_field: Simplify<TextParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `number` */
+    number_decimal: Simplify<NumberParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `number` */
+    number_integer: Simplify<NumberParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of a `Page` object (as defined by the Storefront API) */
+    page_reference: Simplify<PageParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of a `Product` object (as defined by the Storefront API) */
+    product_reference: Simplify<ProductParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Rating` */
+    rating: Simplify<RatingParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `string` */
+    single_line_text_field: Simplify<TextParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `string` */
+    url: Simplify<TextParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of a `ProductVariant` object (as defined by the Storefront API) */
+    variant_reference: Simplify<VariantParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */
+    volume: Simplify<MeasurementParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of type `Measurement` */
+    weight: Simplify<MeasurementParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Collection` objects (as defined by the Storefront API) */
+    'list.collection_reference': Simplify<CollectionListParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */
+    'list.color': Simplify<ColorListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of Date objects */
+    'list.date': Simplify<DatesListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of Date objects */
+    'list.date_time': Simplify<DatesListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement` objects */
+    'list.dimension': Simplify<MeasurementListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `GenericFile` objects (as defined by the Storefront API) */
+    'list.file_reference': Simplify<FileListParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of numbers */
+    'list.number_integer': Simplify<NumberListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of numbers */
+    'list.number_decimal': Simplify<NumberListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Page` objects (as defined by the Storefront API) */
+    'list.page_reference': Simplify<PageListParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Product` objects (as defined by the Storefront API) */
+    'list.product_reference': Simplify<ProductListParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Rating`s */
+    'list.rating': Simplify<RatingListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */
+    'list.single_line_text_field': Simplify<TextListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of strings */
+    'list.url': Simplify<TextListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `ProductVariant` objects (as defined by the Storefront API) */
+    'list.variant_reference': Simplify<VariantListParsedRefMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement`s */
+    'list.volume': Simplify<MeasurementListParsedMetafield>;
+    /** A Metafield that's been parsed, with a `parsedValue` of an array of `Measurement`s */
+    'list.weight': Simplify<MeasurementListParsedMetafield>;
+};
+interface ParsedBase extends MetafieldBaseType {
+    type: MetafieldTypeTypes;
+    parsedValue: unknown;
+}
+interface BooleanParsedMetafield extends ParsedBase {
+    type: 'boolean';
+    parsedValue: boolean | null;
+}
+declare type CollectionParsedRefMetafield = MetafieldBaseType & {
+    type: 'collection_reference';
+    parsedValue: Collection | null;
+};
+declare type ColorParsedMetafield = MetafieldBaseType & {
+    type: 'color';
+    parsedValue: string | null;
+};
+declare type DatesParsedMetafield = MetafieldBaseType & {
+    type: 'date' | 'date_time';
+    parsedValue: Date | null;
+};
+declare type MeasurementParsedMetafield = MetafieldBaseType & {
+    type: 'dimension' | 'weight' | 'volume';
+    parsedValue: Measurement | null;
+};
+declare type FileRefParsedMetafield = MetafieldBaseType & {
+    type: 'file_reference';
+    parsedValue: GenericFile | null;
+};
+declare type JsonParsedMetafield<JsonTypeGeneric = void> = MetafieldBaseType & {
+    type: 'json';
+    parsedValue: JsonTypeGeneric extends void ? unknown : JsonTypeGeneric | null;
+};
+declare type MoneyParsedMetafield = MetafieldBaseType & {
+    type: 'money';
+    parsedValue: MoneyV2 | null;
+};
+declare type TextParsedMetafield = MetafieldBaseType & {
+    type: 'single_line_text_field' | 'multi_line_text_field' | 'url';
+    parsedValue: string | null;
+};
+declare type NumberParsedMetafield = MetafieldBaseType & {
+    type: 'number_decimal' | 'number_integer';
+    parsedValue: number | null;
+};
+declare type PageParsedRefMetafield = MetafieldBaseType & {
+    type: 'page_reference';
+    parsedValue: Page | null;
+};
+declare type ProductParsedRefMetafield = MetafieldBaseType & {
+    type: 'product_reference';
+    parsedValue: Product | null;
+};
+declare type RatingParsedMetafield = MetafieldBaseType & {
+    type: 'rating';
+    parsedValue: Rating | null;
+};
+declare type VariantParsedRefMetafield = MetafieldBaseType & {
+    type: 'variant_reference';
+    parsedValue: ProductVariant | null;
+};
+declare type CollectionListParsedRefMetafield = MetafieldBaseType & {
+    type: 'list.collection_reference';
+    parsedValue: Array<Collection> | null;
+};
+declare type ColorListParsedMetafield = MetafieldBaseType & {
+    type: 'list.color';
+    parsedValue: Array<string> | null;
+};
+declare type DatesListParsedMetafield = MetafieldBaseType & {
+    type: 'list.date' | 'list.date_time';
+    parsedValue: Array<Date> | null;
+};
+declare type MeasurementListParsedMetafield = MetafieldBaseType & {
+    type: 'list.dimension' | 'list.weight' | 'list.volume';
+    parsedValue: Array<Measurement> | null;
+};
+declare type FileListParsedRefMetafield = MetafieldBaseType & {
+    type: 'list.file_reference';
+    parsedValue: Array<GenericFile> | null;
+};
+declare type TextListParsedMetafield = MetafieldBaseType & {
+    type: 'list.single_line_text_field' | 'list.url';
+    parsedValue: Array<string> | null;
+};
+declare type NumberListParsedMetafield = MetafieldBaseType & {
+    type: 'list.number_decimal' | 'list.number_integer';
+    parsedValue: Array<number> | null;
+};
+declare type PageListParsedRefMetafield = MetafieldBaseType & {
+    type: 'list.page_reference';
+    parsedValue: Array<Page> | null;
+};
+declare type ProductListParsedRefMetafield = MetafieldBaseType & {
+    type: 'list.product_reference';
+    parsedValue: Array<Product> | null;
+};
+declare type RatingListParsedMetafield = MetafieldBaseType & {
+    type: 'list.rating';
+    parsedValue: Array<Rating> | null;
+};
+declare type VariantListParsedRefMetafield = MetafieldBaseType & {
+    type: 'list.variant_reference';
+    parsedValue: Array<ProductVariant> | null;
+};
+export declare type Measurement = {
+    unit: string;
+    value: number;
+};
+export interface Rating {
+    value: number;
+    scale_min: number;
+    scale_max: number;
+}
+export {};