fix js doc comments

Author: laurelthorburn

packages/hydrogen-react/src/ExternalVideo.tsx

@@ -21,11 +21,7 @@ export type ExternalVideoProps = Omit<
 > &
   ExternalVideoBaseProps;
 
-/**
- * The `ExternalVideo` component renders an embedded video for the Storefront
- * API's [ExternalVideo object](https://shopify.dev/api/storefront/reference/products/externalvideo).
- * @publicDocs
- */
+/** @publicDocs */
 export const ExternalVideo = forwardRef<HTMLIFrameElement, ExternalVideoProps>(
   (props, ref): JSX.Element => {
     const {

packages/hydrogen-react/src/MediaFile.tsx

@@ -9,10 +9,7 @@ import type {ModelViewerElement} from '@google/model-viewer/lib/model-viewer.js'
 type BaseProps = React.HTMLAttributes<
   HTMLImageElement | HTMLVideoElement | HTMLIFrameElement | ModelViewerElement
 >;
-/**
- * MediaFile renders an `Image`, `Video`, `ExternalVideo`, or `ModelViewer` component. Use the `mediaOptions` prop to customize the props sent to each of these components.
- * @publicDocs
- */
+/** @publicDocs */
 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}>;
@@ -34,13 +31,7 @@ type MediaOptions = {
   modelViewer?: Omit<typeof ModelViewer, 'data'>;
 };
 
-/**
- * The `MediaFile` component renders the media for the Storefront API's
- * [Media object](https://shopify.dev/api/storefront/reference/products/media). It renders an `Image`, a
- * `Video`, an `ExternalVideo`, or a `ModelViewer` depending on the `__typename` of the `data` prop.
- * Use the `mediaOptions` prop to customize the props sent to each of these components.
- * @publicDocs
- */
+/** @publicDocs */
 export function MediaFile({
   data,
   mediaOptions,

packages/hydrogen-react/src/ModelViewer.tsx

@@ -54,15 +54,7 @@ export type ModelViewerBaseProps = {
   onSceneGraphReady?: (event: Event) => void;
 };
 
-/**
- * The `ModelViewer` component renders a 3D model (with the `model-viewer` custom element) for
- * the Storefront API's [Model3d object](https://shopify.dev/api/storefront/reference/products/model3d).
- *
- * The `model-viewer` custom element is lazily downloaded through a dynamically-injected `<script type="module">` tag when the `<ModelViewer />` component is rendered
- *
- * ModelViewer is using version `1.21.1` of the `@google/model-viewer` library.
- * @publicDocs
- */
+/** @publicDocs */
 export function ModelViewer(props: ModelViewerProps): JSX.Element | null {
   const [modelViewer, setModelViewer] = useState<undefined | HTMLElement>(
     undefined,

packages/hydrogen-react/src/ShopPayButton.tsx

@@ -65,12 +65,7 @@ function isChannel(
   return channel === 'headless' || channel === 'hydrogen';
 }
 
-/**
- * The `ShopPayButton` component renders a button that redirects to the Shop Pay checkout.
- * It renders a [`<shop-pay-button>`](https://shopify.dev/custom-storefronts/tools/web-components) custom element, for which it will lazy-load the source code automatically.
- * It relies on the `<ShopProvider>` context provider.
- * @publicDocs
- */
+/** @publicDocs */
 export function ShopPayButton({
   channel,
   variantIds,

packages/hydrogen-react/src/analytics.ts

@@ -19,7 +19,14 @@ import {
 } from './analytics-schema-custom-storefront-customer-tracking.js';
 import {getTrackingValues} from './tracking-utils.js';
 
-/** @publicDocs */
+/**
+ * Set user and session cookies and refresh the expiry time
+ * @param event - The analytics event.
+ * @param shopDomain - The Online Store domain to sent Shopify analytics under the same
+ *   top level domain.
+ * @publicDocs
+ */
+
 export function sendShopifyAnalytics(
   event: ShopifyAnalytics,
   shopDomain?: string,

packages/hydrogen-react/src/cookies-utils.tsx

@@ -59,6 +59,7 @@ export function hexTime(): string {
 }
 
 /**
+ * Gets the values of _shopify_y and _shopify_s cookies from the provided cookie string.
  * @deprecated Use getTrackingValues instead.
  * @publicDocs
  */

packages/hydrogen-react/src/flatten-connection.ts

@@ -1,12 +1,6 @@
 import type {PartialDeep} from 'type-fest';
 
-/**
- * The `flattenConnection` utility transforms a connection object from the Storefront API (for example, [Product-related connections](https://shopify.dev/api/storefront/reference/products/product)) into a flat array of nodes.
- * The utility works with either `nodes` or `edges.node`.
- *
- * If `connection` is null or undefined, will return an empty array instead in production. In development, an error will be thrown.
- * @publicDocs
- */
+/** @publicDocs */
 export function flattenConnection<
   ConnectionGeneric extends
     | PartialDeep<ConnectionEdges, {recurseIntoArrays: true}>
@@ -91,8 +85,5 @@ type ConnectionNodes = {
 export interface ConnectionGenericForDoc {
   connection?: ConnectionEdges | ConnectionNodes;
 }
-/**
- * The return type of the `flattenConnection` utility: a flat array of nodes extracted from a Storefront API connection object.
- * @publicDocs
- */
+/** @publicDocs */
 export type FlattenConnectionReturnForDoc = unknown[];

packages/hydrogen-react/src/optionValueDecoder.ts

@@ -20,23 +20,13 @@ const V1_CONTROL_CHARS = {
   RANGE: '-',
 };
 
-/**
- * A function type that determines whether a given option value combination is present in an encoded variant field from the Storefront API.
- * @publicDocs
- */
+/** @publicDocs */
 export type IsOptionValueCombinationInEncodedVariant = (
   targetOptionValueCombination: number[],
   encodedVariantField: string,
 ) => boolean;
 
-/**
- * Determine whether an option value combination is present in an encoded option value string. Function is memoized by encodedVariantField.
- *
- * @param targetOptionValueCombination - Indices of option values to look up in the encoded option value string. A partial set of indices may be passed to determine whether a node or any children is present. For example, if a product has 3 options, passing [0] will return true if any option value combination for the first option's option value is present in the encoded string.
- * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantavailability)
- * @returns - True if a full or partial targetOptionValueIndices is present in the encoded option value string, false otherwise.
- * @publicDocs
- */
+/** @publicDocs */
 export const isOptionValueCombinationInEncodedVariant: IsOptionValueCombinationInEncodedVariant =
   ((): IsOptionValueCombinationInEncodedVariant => {
     const decodedOptionValues = new Map<string, Set<string>>();
@@ -81,12 +71,7 @@ type EncodedVariantField =
   | Product['encodedVariantExistence'];
 type DecodedOptionValues = number[][];
 
-/**
- * For an encoded option value string, decode into option value combinations. Entries represent a valid combination formatted as an array of option value positions.
- * @param encodedVariantField - Encoded option value string from the Storefront API, e.g. [product.encodedVariantExistence](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantexistence) or [product.encodedVariantAvailability](/docs/api/storefront/2026-01/objects/Product#field-encodedvariantavailability)
- * @returns Decoded option value combinations
- * @publicDocs
- */
+/** @publicDocs */
 export function decodeEncodedVariant(
   encodedVariantField: EncodedVariantField,
 ): DecodedOptionValues {