@shopify/hydrogen-react 2023.7.5 → 2023.10.0

package/dist/types/Image.d.ts

@@ -11,7 +11,6 @@ type SrcSetOptions = {
     /** The size used for placeholder fallback images */
     placeholderWidth: number;
 };
-type HtmlImageProps = React.DetailedHTMLProps<React.ImgHTMLAttributes<HTMLImageElement>, HTMLImageElement>;
 export type LoaderParams = {
     /** The base URL of the image */
     src?: ImageType['url'];
@@ -23,18 +22,6 @@ export type LoaderParams = {
     crop?: Crop;
 };
 export type Loader = (params: LoaderParams) => string;
-/** Legacy type for backwards compatibility *
- * @deprecated Use `crop`, `width`, `height`, and `src` props, and/or `data` prop. Or pass a custom `loader` with `LoaderParams` */
-export type ShopifyLoaderOptions = {
-    /** The base URL of the image */
-    src?: ImageType['url'];
-    /** The URL param that controls width */
-    width?: HtmlImageProps['width'] | ImageType['width'];
-    /** The URL param that controls height */
-    height?: HtmlImageProps['height'] | ImageType['height'];
-    /** The URL param that controls the cropping region */
-    crop?: Crop;
-};
 type Crop = 'center' | 'top' | 'bottom' | 'left' | 'right';
 export type HydrogenImageProps = React.ComponentPropsWithRef<'img'> & HydrogenImageBaseProps;
 type HydrogenImageBaseProps = {
@@ -55,7 +42,7 @@ type HydrogenImageBaseProps = {
      * @defaultValue `center`
      */
     crop?: Crop;
-    /** Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2023-07/objects/Image) object. Must be an Image object.
+    /** Data mapping to the [Storefront API `Image`](https://shopify.dev/docs/api/storefront/2023-10/objects/Image) object. Must be an Image object.
      *
      * @example
      * ```
@@ -92,10 +79,6 @@ type HydrogenImageBaseProps = {
     loader?: Loader;
     /** An optional prop you can use to change the default srcSet generation behaviour */
     srcSetOptions?: SrcSetOptions;
-    /** @deprecated Use `crop`, `width`, `height`, and `src` props, and/or `data` prop */
-    loaderOptions?: ShopifyLoaderOptions;
-    /** @deprecated Autocalculated, use only `width` prop, or srcSetOptions */
-    widths?: (HtmlImageProps['width'] | ImageType['width'])[];
 };
 /**
  * A Storefront API GraphQL fragment that can be used to query for an image.

package/dist/types/ModelViewer.d.ts

@@ -14,7 +14,7 @@ type ModelViewerProps = Omit<PartialDeep<JSX.IntrinsicElements['model-viewer'],
     recurseIntoArrays: true;
 }>, 'src'> & ModelViewerBaseProps;
 type ModelViewerBaseProps = {
-    /** An object with fields that correspond to the Storefront API's [Model3D object](https://shopify.dev/api/storefront/2023-07/objects/model3d). */
+    /** An object with fields that correspond to the Storefront API's [Model3D object](https://shopify.dev/api/storefront/2023-10/objects/model3d). */
     data: PartialDeep<Model3d, {
         recurseIntoArrays: true;
     }>;

package/dist/types/Money.d.ts

@@ -12,7 +12,7 @@ export interface MoneyPropsBase<ComponentGeneric extends React.ElementType> {
     withoutCurrency?: boolean;
     /** Whether to remove trailing zeros (fractional money) from the output. */
     withoutTrailingZeros?: boolean;
-    /** A [UnitPriceMeasurement object](https://shopify.dev/api/storefront/2023-07/objects/unitpricemeasurement). */
+    /** A [UnitPriceMeasurement object](https://shopify.dev/api/storefront/2023-10/objects/unitpricemeasurement). */
     measurement?: PartialDeep<UnitPriceMeasurement, {
         recurseIntoArrays: true;
     }>;

package/dist/types/Video.d.ts

@@ -3,7 +3,7 @@ import { shopifyLoader } from './Image.js';
 import type { Video as VideoType } from './storefront-api-types.js';
 import type { PartialDeep } from 'type-fest';
 export interface VideoProps {
-    /** An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2023-07/objects/video). */
+    /** An object with fields that correspond to the Storefront API's [Video object](https://shopify.dev/api/storefront/2023-10/objects/video). */
     data: PartialDeep<VideoType, {
         recurseIntoArrays: true;
     }>;

package/dist/types/codegen.helpers.d.ts

@@ -1,4 +1,8 @@
-/** Meant to be used with GraphQL CodeGen to type the Storefront API's custom scalars correctly */
+/**
+ * Meant to be used with GraphQL CodeGen to type the Storefront API's custom scalars correctly.
+ * Reference for the GraphQL types: https://shopify.dev/docs/api/storefront/current/scalars/HTML
+ * Note: JSON is generated as 'unknown' by default.
+ */
 export declare const storefrontApiCustomScalars: {
     DateTime: string;
     Decimal: string;

package/dist/types/storefront-api-constants.d.ts

@@ -1 +1 @@
-export declare const SFAPI_VERSION = "2023-07";
+export declare const SFAPI_VERSION = "2023-10";