@shopify/hydrogen-react 0.0.0-next-022e862 → 0.0.0-next-c23a62a

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 {};

package/dist/umd/hydrogen-react.dev.js

@@ -2548,6 +2548,9 @@ fragment ImageFragment on Image {
     }, (_i = parsedMetafield.value) == null ? void 0 : _i.toString());
   }
   function parseMetafield(metafield) {
+    {
+      console.info(`'parseMetafield()' will have a breaking change in a future version; its behavior will match that of 'metafieldParser()'`);
+    }
     if (!metafield) {
       {
         console.warn(`'parseMetafield' was not passed any value for the 'metafield' argument`);
@@ -2563,6 +2566,9 @@ fragment ImageFragment on Image {
     };
   }
   function parseMetafieldValue(metafield) {
+    {
+      console.info(`'parseMetafieldValue()' will be removed in a future version`);
+    }
     if (!metafield) {
       return null;
     }
@@ -2690,6 +2696,113 @@ fragment ImageFragment on Image {
         throw new Error(`Unit not supported: ${unit}`);
     }
   }
+  var dist = {};
+  Object.defineProperty(dist, "__esModule", { value: true });
+  dist.expectNever = expectType_1 = dist.expectType = void 0;
+  const expectType = (value) => void 0;
+  var expectType_1 = dist.expectType = expectType;
+  const expectNever = (value) => {
+    throw new TypeError("Unexpected value: " + value);
+  };
+  dist.expectNever = expectNever;
+  function metafieldParser(metafield) {
+    var _a, _b, _c, _d;
+    if (!metafield.type) {
+      const noTypeError = `metafieldParser(): The 'type' field is required in order to parse the Metafield.`;
+      {
+        throw new Error(noTypeError);
+      }
+    }
+    switch (metafield.type) {
+      case "boolean":
+        return {
+          ...metafield,
+          parsedValue: metafield.value === "true"
+        };
+      case "collection_reference":
+      case "file_reference":
+      case "page_reference":
+      case "product_reference":
+      case "variant_reference":
+        return {
+          ...metafield,
+          parsedValue: metafield.reference
+        };
+      case "color":
+      case "multi_line_text_field":
+      case "single_line_text_field":
+      case "url":
+        return {
+          ...metafield,
+          parsedValue: metafield.value
+        };
+      case "dimension":
+      case "money":
+      case "json":
+      case "rating":
+      case "volume":
+      case "weight":
+      case "list.color":
+      case "list.dimension":
+      case "list.number_integer":
+      case "list.number_decimal":
+      case "list.rating":
+      case "list.single_line_text_field":
+      case "list.url":
+      case "list.volume":
+      case "list.weight": {
+        let parsedValue = null;
+        try {
+          parsedValue = parseJSON((_a = metafield.value) != null ? _a : "");
+        } catch (err) {
+          const parseError = `metafieldParser(): attempted to JSON.parse the 'metafield.value' property, but failed.`;
+          {
+            throw new Error(parseError);
+          }
+        }
+        return {
+          ...metafield,
+          parsedValue
+        };
+      }
+      case "date":
+      case "date_time":
+        return {
+          ...metafield,
+          parsedValue: new Date((_b = metafield.value) != null ? _b : "")
+        };
+      case "list.date":
+      case "list.date_time": {
+        const jsonParseValue = parseJSON((_c = metafield == null ? void 0 : metafield.value) != null ? _c : "");
+        return {
+          ...metafield,
+          parsedValue: jsonParseValue.map((dateString) => new Date(dateString))
+        };
+      }
+      case "number_decimal":
+      case "number_integer":
+        return {
+          ...metafield,
+          parsedValue: Number(metafield.value)
+        };
+      case "list.collection_reference":
+      case "list.file_reference":
+      case "list.page_reference":
+      case "list.product_reference":
+      case "list.variant_reference":
+        return {
+          ...metafield,
+          parsedValue: flattenConnection((_d = metafield.references) != null ? _d : void 0)
+        };
+      default: {
+        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.`;
+        {
+          throw new Error(typeNotFoundError);
+        }
+      }
+    }
+  }
+  expectType_1(true);
   function useMoney(money) {
     const {
       locale
@@ -3167,6 +3280,7 @@ fragment ImageFragment on Image {
   exports2.Video = Video;
   exports2.createStorefrontClient = createStorefrontClient;
   exports2.flattenConnection = flattenConnection;
+  exports2.metafieldParser = metafieldParser;
   exports2.parseMetafield = parseMetafield;
   exports2.parseMetafieldValue = parseMetafieldValue;
   exports2.useCart = useCart;