@shopify/hydrogen 2026.10.0-preview.4 → 2026.10.0

package/dist/graphql/generated/storefront-api-types.d.mts

@@ -1,4 +1,114 @@
 //#region src/graphql/generated/storefront-api-types.d.ts
+/** All built-in and custom scalars, mapped to their actual values */
+type Scalars = {
+  ID: {
+    input: string;
+    output: string;
+  };
+  String: {
+    input: string;
+    output: string;
+  };
+  Boolean: {
+    input: boolean;
+    output: boolean;
+  };
+  Int: {
+    input: number;
+    output: number;
+  };
+  Float: {
+    input: number;
+    output: number;
+  };
+  /**
+   * A string containing a hexadecimal representation of a color.
+   *
+   * For example, "#6A8D48".
+   *
+   */
+  Color: {
+    input: string;
+    output: string;
+  };
+  /**
+   * Represents an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)-encoded date and time string.
+   * For example, 3:50 pm on September 7, 2019 in the time zone of UTC (Coordinated Universal Time) is
+   * represented as `"2019-09-07T15:50:00Z`".
+   *
+   */
+  DateTime: {
+    input: string;
+    output: string;
+  };
+  /**
+   * A signed decimal number, which supports arbitrary precision and is serialized as a string.
+   *
+   * Example values: `"29.99"`, `"29.999"`.
+   *
+   */
+  Decimal: {
+    input: string;
+    output: string;
+  };
+  /**
+   * A string containing HTML code. Refer to the [HTML spec](https://html.spec.whatwg.org/#elements-3) for a
+   * complete list of HTML elements.
+   *
+   * Example value: `"<p>Grey cotton knit sweater.</p>"`
+   *
+   */
+  HTML: {
+    input: string;
+    output: string;
+  }; /** An ISO 8601-encoded datetime */
+  ISO8601DateTime: {
+    input: string;
+    output: string;
+  };
+  /**
+   * A [JSON](https://www.json.org/json-en.html) object.
+   *
+   * Example value:
+   * `{
+   *   "product": {
+   *     "id": "gid://shopify/Product/1346443542550",
+   *     "title": "White T-shirt",
+   *     "options": [{
+   *       "name": "Size",
+   *       "values": ["M", "L"]
+   *     }]
+   *   }
+   * }`
+   *
+   */
+  JSON: {
+    input: string;
+    output: string;
+  };
+  /**
+   * Represents an [RFC 3986](https://datatracker.ietf.org/doc/html/rfc3986) and
+   * [RFC 3987](https://datatracker.ietf.org/doc/html/rfc3987)-compliant URI string.
+   *
+   * For example, `"https://example.myshopify.com"` is a valid URL. It includes a scheme (`https`) and a host
+   * (`example.myshopify.com`).
+   *
+   */
+  URL: {
+    input: string;
+    output: string;
+  };
+  /**
+   * An unsigned 64-bit integer. Represents whole numeric values between 0 and 2^64 - 1 encoded as a string of base-10 digits.
+   *
+   * Example value: `"50"`.
+   *
+   */
+  UnsignedInt64: {
+    input: string;
+    output: string;
+  };
+};
 /**
  * Error codes returned by [`CartUserError`](https://shopify.dev/docs/api/storefront/current/objects/CartUserError) during cart mutations. Covers validation failures for addresses, quantities, delivery options, merchandise lines, discount codes, and metafields.
  *
@@ -14,6 +124,13 @@ type CartWarningCode = /** The discount code cannot be honored. */"DISCOUNT_CODE
  *
  */
 type CountryCode = /** Ascension Island. */"AC" /** Andorra. */ | "AD" /** United Arab Emirates. */ | "AE" /** Afghanistan. */ | "AF" /** Antigua & Barbuda. */ | "AG" /** Anguilla. */ | "AI" /** Albania. */ | "AL" /** Armenia. */ | "AM" /** Netherlands Antilles. */ | "AN" /** Angola. */ | "AO" /** Argentina. */ | "AR" /** Austria. */ | "AT" /** Australia. */ | "AU" /** Aruba. */ | "AW" /** Åland Islands. */ | "AX" /** Azerbaijan. */ | "AZ" /** Bosnia & Herzegovina. */ | "BA" /** Barbados. */ | "BB" /** Bangladesh. */ | "BD" /** Belgium. */ | "BE" /** Burkina Faso. */ | "BF" /** Bulgaria. */ | "BG" /** Bahrain. */ | "BH" /** Burundi. */ | "BI" /** Benin. */ | "BJ" /** St. Barthélemy. */ | "BL" /** Bermuda. */ | "BM" /** Brunei. */ | "BN" /** Bolivia. */ | "BO" /** Caribbean Netherlands. */ | "BQ" /** Brazil. */ | "BR" /** Bahamas. */ | "BS" /** Bhutan. */ | "BT" /** Bouvet Island. */ | "BV" /** Botswana. */ | "BW" /** Belarus. */ | "BY" /** Belize. */ | "BZ" /** Canada. */ | "CA" /** Cocos (Keeling) Islands. */ | "CC" /** Congo - Kinshasa. */ | "CD" /** Central African Republic. */ | "CF" /** Congo - Brazzaville. */ | "CG" /** Switzerland. */ | "CH" /** Côte d’Ivoire. */ | "CI" /** Cook Islands. */ | "CK" /** Chile. */ | "CL" /** Cameroon. */ | "CM" /** China. */ | "CN" /** Colombia. */ | "CO" /** Costa Rica. */ | "CR" /** Cuba. */ | "CU" /** Cape Verde. */ | "CV" /** Curaçao. */ | "CW" /** Christmas Island. */ | "CX" /** Cyprus. */ | "CY" /** Czechia. */ | "CZ" /** Germany. */ | "DE" /** Djibouti. */ | "DJ" /** Denmark. */ | "DK" /** Dominica. */ | "DM" /** Dominican Republic. */ | "DO" /** Algeria. */ | "DZ" /** Ecuador. */ | "EC" /** Estonia. */ | "EE" /** Egypt. */ | "EG" /** Western Sahara. */ | "EH" /** Eritrea. */ | "ER" /** Spain. */ | "ES" /** Ethiopia. */ | "ET" /** Finland. */ | "FI" /** Fiji. */ | "FJ" /** Falkland Islands. */ | "FK" /** Faroe Islands. */ | "FO" /** France. */ | "FR" /** Gabon. */ | "GA" /** United Kingdom. */ | "GB" /** Grenada. */ | "GD" /** Georgia. */ | "GE" /** French Guiana. */ | "GF" /** Guernsey. */ | "GG" /** Ghana. */ | "GH" /** Gibraltar. */ | "GI" /** Greenland. */ | "GL" /** Gambia. */ | "GM" /** Guinea. */ | "GN" /** Guadeloupe. */ | "GP" /** Equatorial Guinea. */ | "GQ" /** Greece. */ | "GR" /** South Georgia & South Sandwich Islands. */ | "GS" /** Guatemala. */ | "GT" /** Guinea-Bissau. */ | "GW" /** Guyana. */ | "GY" /** Hong Kong SAR. */ | "HK" /** Heard & McDonald Islands. */ | "HM" /** Honduras. */ | "HN" /** Croatia. */ | "HR" /** Haiti. */ | "HT" /** Hungary. */ | "HU" /** Indonesia. */ | "ID" /** Ireland. */ | "IE" /** Israel. */ | "IL" /** Isle of Man. */ | "IM" /** India. */ | "IN" /** British Indian Ocean Territory. */ | "IO" /** Iraq. */ | "IQ" /** Iran. */ | "IR" /** Iceland. */ | "IS" /** Italy. */ | "IT" /** Jersey. */ | "JE" /** Jamaica. */ | "JM" /** Jordan. */ | "JO" /** Japan. */ | "JP" /** Kenya. */ | "KE" /** Kyrgyzstan. */ | "KG" /** Cambodia. */ | "KH" /** Kiribati. */ | "KI" /** Comoros. */ | "KM" /** St. Kitts & Nevis. */ | "KN" /** North Korea. */ | "KP" /** South Korea. */ | "KR" /** Kuwait. */ | "KW" /** Cayman Islands. */ | "KY" /** Kazakhstan. */ | "KZ" /** Laos. */ | "LA" /** Lebanon. */ | "LB" /** St. Lucia. */ | "LC" /** Liechtenstein. */ | "LI" /** Sri Lanka. */ | "LK" /** Liberia. */ | "LR" /** Lesotho. */ | "LS" /** Lithuania. */ | "LT" /** Luxembourg. */ | "LU" /** Latvia. */ | "LV" /** Libya. */ | "LY" /** Morocco. */ | "MA" /** Monaco. */ | "MC" /** Moldova. */ | "MD" /** Montenegro. */ | "ME" /** St. Martin. */ | "MF" /** Madagascar. */ | "MG" /** North Macedonia. */ | "MK" /** Mali. */ | "ML" /** Myanmar (Burma). */ | "MM" /** Mongolia. */ | "MN" /** Macao SAR. */ | "MO" /** Martinique. */ | "MQ" /** Mauritania. */ | "MR" /** Montserrat. */ | "MS" /** Malta. */ | "MT" /** Mauritius. */ | "MU" /** Maldives. */ | "MV" /** Malawi. */ | "MW" /** Mexico. */ | "MX" /** Malaysia. */ | "MY" /** Mozambique. */ | "MZ" /** Namibia. */ | "NA" /** New Caledonia. */ | "NC" /** Niger. */ | "NE" /** Norfolk Island. */ | "NF" /** Nigeria. */ | "NG" /** Nicaragua. */ | "NI" /** Netherlands. */ | "NL" /** Norway. */ | "NO" /** Nepal. */ | "NP" /** Nauru. */ | "NR" /** Niue. */ | "NU" /** New Zealand. */ | "NZ" /** Oman. */ | "OM" /** Panama. */ | "PA" /** Peru. */ | "PE" /** French Polynesia. */ | "PF" /** Papua New Guinea. */ | "PG" /** Philippines. */ | "PH" /** Pakistan. */ | "PK" /** Poland. */ | "PL" /** St. Pierre & Miquelon. */ | "PM" /** Pitcairn Islands. */ | "PN" /** Palestinian Territories. */ | "PS" /** Portugal. */ | "PT" /** Paraguay. */ | "PY" /** Qatar. */ | "QA" /** Réunion. */ | "RE" /** Romania. */ | "RO" /** Serbia. */ | "RS" /** Russia. */ | "RU" /** Rwanda. */ | "RW" /** Saudi Arabia. */ | "SA" /** Solomon Islands. */ | "SB" /** Seychelles. */ | "SC" /** Sudan. */ | "SD" /** Sweden. */ | "SE" /** Singapore. */ | "SG" /** St. Helena. */ | "SH" /** Slovenia. */ | "SI" /** Svalbard & Jan Mayen. */ | "SJ" /** Slovakia. */ | "SK" /** Sierra Leone. */ | "SL" /** San Marino. */ | "SM" /** Senegal. */ | "SN" /** Somalia. */ | "SO" /** Suriname. */ | "SR" /** South Sudan. */ | "SS" /** São Tomé & Príncipe. */ | "ST" /** El Salvador. */ | "SV" /** Sint Maarten. */ | "SX" /** Syria. */ | "SY" /** Eswatini. */ | "SZ" /** Tristan da Cunha. */ | "TA" /** Turks & Caicos Islands. */ | "TC" /** Chad. */ | "TD" /** French Southern Territories. */ | "TF" /** Togo. */ | "TG" /** Thailand. */ | "TH" /** Tajikistan. */ | "TJ" /** Tokelau. */ | "TK" /** Timor-Leste. */ | "TL" /** Turkmenistan. */ | "TM" /** Tunisia. */ | "TN" /** Tonga. */ | "TO" /** Türkiye. */ | "TR" /** Trinidad & Tobago. */ | "TT" /** Tuvalu. */ | "TV" /** Taiwan. */ | "TW" /** Tanzania. */ | "TZ" /** Ukraine. */ | "UA" /** Uganda. */ | "UG" /** U.S. Outlying Islands. */ | "UM" /** United States. */ | "US" /** Uruguay. */ | "UY" /** Uzbekistan. */ | "UZ" /** Vatican City. */ | "VA" /** St. Vincent & Grenadines. */ | "VC" /** Venezuela. */ | "VE" /** British Virgin Islands. */ | "VG" /** Vietnam. */ | "VN" /** Vanuatu. */ | "VU" /** Wallis & Futuna. */ | "WF" /** Samoa. */ | "WS" /** Kosovo. */ | "XK" /** Yemen. */ | "YE" /** Mayotte. */ | "YT" /** South Africa. */ | "ZA" /** Zambia. */ | "ZM" /** Zimbabwe. */ | "ZW" /** Unknown Region. */ | "ZZ";
+/**
+ * The three-letter currency codes that represent the world currencies used in
+ * stores. These include standard ISO 4217 codes, legacy codes,
+ * and non-standard codes.
+ *
+ */
+type CurrencyCode = /** United Arab Emirates Dirham (AED). */"AED" /** Afghan Afghani (AFN). */ | "AFN" /** Albanian Lek (ALL). */ | "ALL" /** Armenian Dram (AMD). */ | "AMD" /** Netherlands Antillean Guilder. */ | "ANG" /** Angolan Kwanza (AOA). */ | "AOA" /** Argentine Pesos (ARS). */ | "ARS" /** Australian Dollars (AUD). */ | "AUD" /** Aruban Florin (AWG). */ | "AWG" /** Azerbaijani Manat (AZN). */ | "AZN" /** Bosnia and Herzegovina Convertible Mark (BAM). */ | "BAM" /** Barbadian Dollar (BBD). */ | "BBD" /** Bangladesh Taka (BDT). */ | "BDT" /** Bulgarian Lev (BGN). */ | "BGN" /** Bahraini Dinar (BHD). */ | "BHD" /** Burundian Franc (BIF). */ | "BIF" /** Bermudian Dollar (BMD). */ | "BMD" /** Brunei Dollar (BND). */ | "BND" /** Bolivian Boliviano (BOB). */ | "BOB" /** Brazilian Real (BRL). */ | "BRL" /** Bahamian Dollar (BSD). */ | "BSD" /** Bhutanese Ngultrum (BTN). */ | "BTN" /** Botswana Pula (BWP). */ | "BWP" /** Belarusian Ruble (BYN). */ | "BYN" /** Belarusian Ruble (BYR). */ | "BYR" /** Belize Dollar (BZD). */ | "BZD" /** Canadian Dollars (CAD). */ | "CAD" /** Congolese franc (CDF). */ | "CDF" /** Swiss Francs (CHF). */ | "CHF" /** Chilean Peso (CLP). */ | "CLP" /** Chinese Yuan Renminbi (CNY). */ | "CNY" /** Colombian Peso (COP). */ | "COP" /** Costa Rican Colones (CRC). */ | "CRC" /** Cape Verdean escudo (CVE). */ | "CVE" /** Czech Koruny (CZK). */ | "CZK" /** Djiboutian Franc (DJF). */ | "DJF" /** Danish Kroner (DKK). */ | "DKK" /** Dominican Peso (DOP). */ | "DOP" /** Algerian Dinar (DZD). */ | "DZD" /** Egyptian Pound (EGP). */ | "EGP" /** Eritrean Nakfa (ERN). */ | "ERN" /** Ethiopian Birr (ETB). */ | "ETB" /** Euro (EUR). */ | "EUR" /** Fijian Dollars (FJD). */ | "FJD" /** Falkland Islands Pounds (FKP). */ | "FKP" /** United Kingdom Pounds (GBP). */ | "GBP" /** Georgian Lari (GEL). */ | "GEL" /** Ghanaian Cedi (GHS). */ | "GHS" /** Gibraltar Pounds (GIP). */ | "GIP" /** Gambian Dalasi (GMD). */ | "GMD" /** Guinean Franc (GNF). */ | "GNF" /** Guatemalan Quetzal (GTQ). */ | "GTQ" /** Guyanese Dollar (GYD). */ | "GYD" /** Hong Kong Dollars (HKD). */ | "HKD" /** Honduran Lempira (HNL). */ | "HNL" /** Croatian Kuna (HRK). */ | "HRK" /** Haitian Gourde (HTG). */ | "HTG" /** Hungarian Forint (HUF). */ | "HUF" /** Indonesian Rupiah (IDR). */ | "IDR" /** Israeli New Shekel (NIS). */ | "ILS" /** Indian Rupees (INR). */ | "INR" /** Iraqi Dinar (IQD). */ | "IQD" /** Iranian Rial (IRR). */ | "IRR" /** Icelandic Kronur (ISK). */ | "ISK" /** Jersey Pound. */ | "JEP" /** Jamaican Dollars (JMD). */ | "JMD" /** Jordanian Dinar (JOD). */ | "JOD" /** Japanese Yen (JPY). */ | "JPY" /** Kenyan Shilling (KES). */ | "KES" /** Kyrgyzstani Som (KGS). */ | "KGS" /** Cambodian Riel. */ | "KHR" /** Kiribati Dollar (KID). */ | "KID" /** Comorian Franc (KMF). */ | "KMF" /** South Korean Won (KRW). */ | "KRW" /** Kuwaiti Dinar (KWD). */ | "KWD" /** Cayman Dollars (KYD). */ | "KYD" /** Kazakhstani Tenge (KZT). */ | "KZT" /** Laotian Kip (LAK). */ | "LAK" /** Lebanese Pounds (LBP). */ | "LBP" /** Sri Lankan Rupees (LKR). */ | "LKR" /** Liberian Dollar (LRD). */ | "LRD" /** Lesotho Loti (LSL). */ | "LSL" /** Lithuanian Litai (LTL). */ | "LTL" /** Latvian Lati (LVL). */ | "LVL" /** Libyan Dinar (LYD). */ | "LYD" /** Moroccan Dirham. */ | "MAD" /** Moldovan Leu (MDL). */ | "MDL" /** Malagasy Ariary (MGA). */ | "MGA" /** Macedonia Denar (MKD). */ | "MKD" /** Burmese Kyat (MMK). */ | "MMK" /** Mongolian Tugrik. */ | "MNT" /** Macanese Pataca (MOP). */ | "MOP" /** Mauritanian Ouguiya (MRU). */ | "MRU" /** Mauritian Rupee (MUR). */ | "MUR" /** Maldivian Rufiyaa (MVR). */ | "MVR" /** Malawian Kwacha (MWK). */ | "MWK" /** Mexican Pesos (MXN). */ | "MXN" /** Malaysian Ringgits (MYR). */ | "MYR" /** Mozambican Metical. */ | "MZN" /** Namibian Dollar. */ | "NAD" /** Nigerian Naira (NGN). */ | "NGN" /** Nicaraguan Córdoba (NIO). */ | "NIO" /** Norwegian Kroner (NOK). */ | "NOK" /** Nepalese Rupee (NPR). */ | "NPR" /** New Zealand Dollars (NZD). */ | "NZD" /** Omani Rial (OMR). */ | "OMR" /** Panamian Balboa (PAB). */ | "PAB" /** Peruvian Nuevo Sol (PEN). */ | "PEN" /** Papua New Guinean Kina (PGK). */ | "PGK" /** Philippine Peso (PHP). */ | "PHP" /** Pakistani Rupee (PKR). */ | "PKR" /** Polish Zlotych (PLN). */ | "PLN" /** Paraguayan Guarani (PYG). */ | "PYG" /** Qatari Rial (QAR). */ | "QAR" /** Romanian Lei (RON). */ | "RON" /** Serbian dinar (RSD). */ | "RSD" /** Russian Rubles (RUB). */ | "RUB" /** Rwandan Franc (RWF). */ | "RWF" /** Saudi Riyal (SAR). */ | "SAR" /** Solomon Islands Dollar (SBD). */ | "SBD" /** Seychellois Rupee (SCR). */ | "SCR" /** Sudanese Pound (SDG). */ | "SDG" /** Swedish Kronor (SEK). */ | "SEK" /** Singapore Dollars (SGD). */ | "SGD" /** Saint Helena Pounds (SHP). */ | "SHP" /** Sierra Leonean Leone (SLL). */ | "SLL" /** Somali Shilling (SOS). */ | "SOS" /** Surinamese Dollar (SRD). */ | "SRD" /** South Sudanese Pound (SSP). */ | "SSP" /** Sao Tome And Principe Dobra (STD). */ | "STD" /** Sao Tome And Principe Dobra (STN). */ | "STN" /** Syrian Pound (SYP). */ | "SYP" /** Swazi Lilangeni (SZL). */ | "SZL" /** Thai baht (THB). */ | "THB" /** Tajikistani Somoni (TJS). */ | "TJS" /** Turkmenistani Manat (TMT). */ | "TMT" /** Tunisian Dinar (TND). */ | "TND" /** Tongan Pa'anga (TOP). */ | "TOP" /** Turkish Lira (TRY). */ | "TRY" /** Trinidad and Tobago Dollars (TTD). */ | "TTD" /** Taiwan Dollars (TWD). */ | "TWD" /** Tanzanian Shilling (TZS). */ | "TZS" /** Ukrainian Hryvnia (UAH). */ | "UAH" /** Ugandan Shilling (UGX). */ | "UGX" /** United States Dollars (USD). */ | "USD" /** Uruguayan Pesos (UYU). */ | "UYU" /** Uzbekistan som (UZS). */ | "UZS" /** Venezuelan Bolivares (VED). */ | "VED" /** Venezuelan Bolivares (VEF). */ | "VEF" /** Venezuelan Bolivares Soberanos (VES). */ | "VES" /** Vietnamese đồng (VND). */ | "VND" /** Vanuatu Vatu (VUV). */ | "VUV" /** Samoan Tala (WST). */ | "WST" /** Central African CFA Franc (XAF). */ | "XAF" /** East Caribbean Dollar (XCD). */ | "XCD" /** Caribbean Guilder (XCG). */ | "XCG" /** West African CFA franc (XOF). */ | "XOF" /** CFP Franc (XPF). */ | "XPF" /** Unrecognized currency. */ | "XXX" /** Yemeni Rial (YER). */ | "YER" /** South African Rand (ZAR). */ | "ZAR" /** Zambian Kwacha (ZMW). */ | "ZMW";
 /**
  * Supported languages for retrieving translated storefront content. Pass a language code to the [`@inContext`](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/in-context) directive to return product titles, descriptions, and other translatable fields in that language.
  *
@@ -21,6 +138,15 @@ type CountryCode = /** Ascension Island. */"AC" /** Andorra. */ | "AD" /** Unite
  *
  */
 type LanguageCode = /** Afrikaans. */"AF" /** Akan. */ | "AK" /** Amharic. */ | "AM" /** Arabic. */ | "AR" /** Assamese. */ | "AS" /** Azerbaijani. */ | "AZ" /** Belarusian. */ | "BE" /** Bulgarian. */ | "BG" /** Bambara. */ | "BM" /** Bangla. */ | "BN" /** Tibetan. */ | "BO" /** Breton. */ | "BR" /** Bosnian. */ | "BS" /** Catalan. */ | "CA" /** Chechen. */ | "CE" /** Central Kurdish. */ | "CKB" /** Czech. */ | "CS" /** Church Slavic. */ | "CU" /** Welsh. */ | "CY" /** Danish. */ | "DA" /** German. */ | "DE" /** Dzongkha. */ | "DZ" /** Ewe. */ | "EE" /** Greek. */ | "EL" /** English. */ | "EN" /** Esperanto. */ | "EO" /** Spanish. */ | "ES" /** Estonian. */ | "ET" /** Basque. */ | "EU" /** Persian. */ | "FA" /** Fulah. */ | "FF" /** Finnish. */ | "FI" /** Filipino. */ | "FIL" /** Faroese. */ | "FO" /** French. */ | "FR" /** Western Frisian. */ | "FY" /** Irish. */ | "GA" /** Scottish Gaelic. */ | "GD" /** Galician. */ | "GL" /** Gujarati. */ | "GU" /** Manx. */ | "GV" /** Hausa. */ | "HA" /** Hebrew. */ | "HE" /** Hindi. */ | "HI" /** Croatian. */ | "HR" /** Hungarian. */ | "HU" /** Armenian. */ | "HY" /** Interlingua. */ | "IA" /** Indonesian. */ | "ID" /** Igbo. */ | "IG" /** Sichuan Yi. */ | "II" /** Icelandic. */ | "IS" /** Italian. */ | "IT" /** Japanese. */ | "JA" /** Javanese. */ | "JV" /** Georgian. */ | "KA" /** Kikuyu. */ | "KI" /** Kazakh. */ | "KK" /** Kalaallisut. */ | "KL" /** Khmer. */ | "KM" /** Kannada. */ | "KN" /** Korean. */ | "KO" /** Kashmiri. */ | "KS" /** Kurdish. */ | "KU" /** Cornish. */ | "KW" /** Kyrgyz. */ | "KY" /** Latin. */ | "LA" /** Luxembourgish. */ | "LB" /** Ganda. */ | "LG" /** Lingala. */ | "LN" /** Lao. */ | "LO" /** Lithuanian. */ | "LT" /** Luba-Katanga. */ | "LU" /** Latvian. */ | "LV" /** Malagasy. */ | "MG" /** Māori. */ | "MI" /** Macedonian. */ | "MK" /** Malayalam. */ | "ML" /** Mongolian. */ | "MN" /** Moldavian. */ | "MO" /** Marathi. */ | "MR" /** Malay. */ | "MS" /** Maltese. */ | "MT" /** Burmese. */ | "MY" /** Norwegian (Bokmål). */ | "NB" /** North Ndebele. */ | "ND" /** Nepali. */ | "NE" /** Dutch. */ | "NL" /** Norwegian Nynorsk. */ | "NN" /** Norwegian. */ | "NO" /** Oromo. */ | "OM" /** Odia. */ | "OR" /** Ossetic. */ | "OS" /** Punjabi. */ | "PA" /** Polish. */ | "PL" /** Pashto. */ | "PS" /** Portuguese. */ | "PT" /** Portuguese (Brazil). */ | "PT_BR" /** Portuguese (Portugal). */ | "PT_PT" /** Quechua. */ | "QU" /** Romansh. */ | "RM" /** Rundi. */ | "RN" /** Romanian. */ | "RO" /** Russian. */ | "RU" /** Kinyarwanda. */ | "RW" /** Sanskrit. */ | "SA" /** Sardinian. */ | "SC" /** Sindhi. */ | "SD" /** Northern Sami. */ | "SE" /** Sango. */ | "SG" /** Serbo-Croatian. */ | "SH" /** Sinhala. */ | "SI" /** Slovak. */ | "SK" /** Slovenian. */ | "SL" /** Shona. */ | "SN" /** Somali. */ | "SO" /** Albanian. */ | "SQ" /** Serbian. */ | "SR" /** Sundanese. */ | "SU" /** Swedish. */ | "SV" /** Swahili. */ | "SW" /** Tamil. */ | "TA" /** Telugu. */ | "TE" /** Tajik. */ | "TG" /** Thai. */ | "TH" /** Tigrinya. */ | "TI" /** Turkmen. */ | "TK" /** Tongan. */ | "TO" /** Turkish. */ | "TR" /** Tatar. */ | "TT" /** Uyghur. */ | "UG" /** Ukrainian. */ | "UK" /** Urdu. */ | "UR" /** Uzbek. */ | "UZ" /** Vietnamese. */ | "VI" /** Volapük. */ | "VO" /** Wolof. */ | "WO" /** Xhosa. */ | "XH" /** Yiddish. */ | "YI" /** Yoruba. */ | "YO" /** Chinese. */ | "ZH" /** Chinese (Simplified). */ | "ZH_CN" /** Chinese (Traditional). */ | "ZH_TW" /** Zulu. */ | "ZU";
+/**
+ * A precise monetary value with its associated currency. Combines a decimal amount with a three-letter [`CurrencyCode`](https://shopify.dev/docs/api/storefront/current/enums/CurrencyCode) to express prices, costs, and other financial values. For example, 12.99 USD.
+ *
+ */
+type MoneyV2 = {
+  __typename?: "MoneyV2"; /** Decimal money amount. */
+  amount: Scalars["Decimal"]["output"]; /** Currency of the money. */
+  currencyCode: CurrencyCode;
+};
 /** Decides the distribution of results. */
 type PredictiveSearchLimitScope = /** Return results up to limit across all types. */"ALL" /** Return results up to limit per type. */ | "EACH";
 /** The types of search items to perform predictive search on. */
@@ -43,5 +169,5 @@ type SearchUnavailableProductsType = /** Exclude unavailable products. */"HIDE"
 /** Specifies the list of resource fields to search. */
 type SearchableField = /** Author of the page or article. */"AUTHOR" /** Body of the page or article or product description or collection description. */ | "BODY" /** Product type. */ | "PRODUCT_TYPE" /** Tag associated with the product or article. */ | "TAG" /** Title of the page or article or product title or collection title. */ | "TITLE" /** Variant barcode. */ | "VARIANTS_BARCODE" /** Variant SKU. */ | "VARIANTS_SKU" /** Variant title. */ | "VARIANTS_TITLE" /** Product vendor. */ | "VENDOR";
 //#endregion
-export { CartErrorCode, CartWarningCode, CountryCode, LanguageCode, PredictiveSearchLimitScope, PredictiveSearchType, ProductCollectionSortKeys, SearchUnavailableProductsType, SearchableField };
+export { CartErrorCode, CartWarningCode, CountryCode, LanguageCode, MoneyV2, PredictiveSearchLimitScope, PredictiveSearchType, ProductCollectionSortKeys, SearchUnavailableProductsType, SearchableField };
 //# sourceMappingURL=storefront-api-types.d.mts.map

package/dist/graphql/graphql.d.mts

@@ -8,29 +8,31 @@ type StorefrontTadaGql = initGraphQLTada<{
   introspection: introspection;
   scalars: StorefrontScalars;
 }>;
+/** Type-only properties that mark a string as a `gql` document. */
 type StorefrontQueryMetadata<Source extends string = string> = {
-  readonly __hydrogenQueryBrand: true;
+  /** Marks a string that `gql` returns. The property exists only in types. */readonly __hydrogenQueryBrand: true; /** The document's query text, which TypeScript reads to infer types. The property exists only in types. */
   readonly __hydrogenQuerySource?: Source;
 };
 /**
- * A branded string that carries phantom Result and Variables types.
+ * The type of a `gql` document, a query string that carries its result and variables types.
  *
- * Honest about being a `string` at runtime (unlike `TadaDocumentNode`
- * which claims to be an AST). Implements `DocumentDecoration` so
- * `ResultOf<>` and `VariablesOf<>` work on it.
+ * At runtime, the document is a plain string. Read the types with `StorefrontApi.ResultOf` and
+ * `StorefrontApi.VariablesOf`.
  */
 type StorefrontQueryString<Result = any, Variables = any, Source extends string = string> = string & DocumentDecoration<Result, Variables> & {
   readonly __hydrogenQueryBrand: true;
   readonly __hydrogenQuerySource?: Source;
 };
-/** Any `gql()`-branded string, regardless of inferred Result/Variables. Used in constraints that accept any Storefront document. */
+/**
+ * Any `gql` document, whatever its result and variables types. Use the type to accept any Storefront API document.
+ */
 type AnyStorefrontQueryString = string & StorefrontQueryMetadata;
-/** Extracts the literal source text from a `gql()`-branded document type. Resolves to `never` for unbranded strings. */
+/** The query text of a `gql` document as a string literal type. Resolves to `never` for a plain string. */
 type SourceOf<Doc> = Doc extends {
   readonly __hydrogenQuerySource?: infer Source extends string;
 } ? Source : never;
 type FragmentSources<Fragments extends readonly AnyStorefrontQueryString[]> = Fragments extends readonly [] ? "" : Fragments extends readonly [infer Only extends AnyStorefrontQueryString] ? SourceOf<Only> : Fragments extends readonly [infer First extends AnyStorefrontQueryString, ...infer Rest extends readonly AnyStorefrontQueryString[]] ? `${SourceOf<First>}\n${FragmentSources<Rest>}` : string;
-/** Concatenates a query source with its fragment sources into a single literal type, enabling end-to-end type inference for composed documents. */
+/** The combined query text of a document and its fragments, which keeps the inferred types of composed documents. */
 type ComposedSource<Source extends string, Fragments extends readonly AnyStorefrontQueryString[]> = FragmentSources<Fragments> extends "" ? Source : `${Source}\n${FragmentSources<Fragments>}`;
 type StorefrontGql = {
   <const Document extends AnyStorefrontQueryString, const Fragments extends readonly AnyStorefrontQueryString[], const DocumentSource extends string = ComposedSource<SourceOf<Document>, Fragments>>(document: Document, fragments: Fragments): StorefrontQueryString<InferResult<DocumentSource>, InferVariables<DocumentSource>, DocumentSource>;
@@ -38,14 +40,12 @@ type StorefrontGql = {
   <const Source extends string, const Fragments extends readonly AnyStorefrontQueryString[], const DocumentSource extends string = ComposedSource<Source, Fragments>>(source: Source, fragments: Fragments): StorefrontQueryString<InferResult<DocumentSource>, InferVariables<DocumentSource>, DocumentSource>;
 } & StorefrontTadaGql;
 /**
- * Tags a Storefront API query string for type-safe inference.
- *
- * At runtime, returns the source string (concatenated with any fragments).
- * At the type level, the return type carries phantom `Result` and `Variables`
- * types inferred from the Storefront API schema via gql.tada.
+ * Writes a typed Storefront API query, mutation, or fragment. TypeScript infers the result and
+ * variables types from Hydrogen's bundled Storefront API schema. At runtime, the function returns
+ * the query string with any fragments appended.
  *
- * Pass an array of previously declared `gql()` fragments as the second
- * argument to compose documents while preserving full type inference.
+ * Pass earlier fragment documents as the second argument to compose documents and keep the
+ * inferred types.
  *
  * @example
  * ```ts
@@ -62,10 +62,11 @@ type StorefrontGql = {
  * });
  *
  * if (!result.errors) {
- *   // result.data.product is typed as `{ title: string } | null`
+ *   // result.data.product has the type `{ title: string } | null`
  *   console.log(result.data.product?.title);
  * }
  * ```
+ * @publicDocs
  */
 declare const gql: StorefrontGql;
 //#endregion

package/dist/graphql/graphql.mjs

@@ -1,13 +1,11 @@
 //#region src/graphql/graphql.ts
 /**
-* Tags a Storefront API query string for type-safe inference.
+* Writes a typed Storefront API query, mutation, or fragment. TypeScript infers the result and
+* variables types from Hydrogen's bundled Storefront API schema. At runtime, the function returns
+* the query string with any fragments appended.
 *
-* At runtime, returns the source string (concatenated with any fragments).
-* At the type level, the return type carries phantom `Result` and `Variables`
-* types inferred from the Storefront API schema via gql.tada.
-*
-* Pass an array of previously declared `gql()` fragments as the second
-* argument to compose documents while preserving full type inference.
+* Pass earlier fragment documents as the second argument to compose documents and keep the
+* inferred types.
 *
 * @example
 * ```ts
@@ -24,10 +22,11 @@
 * });
 *
 * if (!result.errors) {
-*   // result.data.product is typed as `{ title: string } | null`
+*   // result.data.product has the type `{ title: string } | null`
 *   console.log(result.data.product?.title);
 * }
 * ```
+* @publicDocs
 */
 const gql = ((source, fragments) => {
 	let query = source;

package/dist/graphql/graphql.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"graphql.mjs","names":[],"sources":["../../src/graphql/graphql.ts"],"sourcesContent":["import type { DocumentDecoration, initGraphQLTada as InitGraphQLTada } from \"gql.tada\";\n\nimport type { introspection } from \"./generated/graphql-env\";\nimport type { StorefrontScalars } from \"./scalars\";\nimport type { InferResult, InferVariables } from \"./type-resolver\";\n\ntype StorefrontTadaGql = InitGraphQLTada<{\n  introspection: introspection;\n  scalars: StorefrontScalars;\n}>;\n\ntype StorefrontQueryMetadata<Source extends string = string> = {\n  readonly __hydrogenQueryBrand: true;\n  readonly __hydrogenQuerySource?: Source;\n};\n\n/**\n * A branded string that carries phantom Result and Variables types.\n *\n * Honest about being a `string` at runtime (unlike `TadaDocumentNode`\n * which claims to be an AST). Implements `DocumentDecoration` so\n * `ResultOf<>` and `VariablesOf<>` work on it.\n */\nexport type StorefrontQueryString<\n  Result = any,\n  Variables = any,\n  Source extends string = string,\n> = string &\n  DocumentDecoration<Result, Variables> & {\n    readonly __hydrogenQueryBrand: true;\n    readonly __hydrogenQuerySource?: Source;\n  };\n\n/** Any `gql()`-branded string, regardless of inferred Result/Variables. Used in constraints that accept any Storefront document. */\nexport type AnyStorefrontQueryString = string & StorefrontQueryMetadata;\n\n/** Extracts the literal source text from a `gql()`-branded document type. Resolves to `never` for unbranded strings. */\nexport type SourceOf<Doc> = Doc extends {\n  readonly __hydrogenQuerySource?: infer Source extends string;\n}\n  ? Source\n  : never;\n\nexport type FragmentSources<Fragments extends readonly AnyStorefrontQueryString[]> =\n  Fragments extends readonly []\n    ? \"\"\n    : Fragments extends readonly [infer Only extends AnyStorefrontQueryString]\n      ? SourceOf<Only>\n      : Fragments extends readonly [\n            infer First extends AnyStorefrontQueryString,\n            ...infer Rest extends readonly AnyStorefrontQueryString[],\n          ]\n        ? `${SourceOf<First>}\\n${FragmentSources<Rest>}`\n        : string;\n\n/** Concatenates a query source with its fragment sources into a single literal type, enabling end-to-end type inference for composed documents. */\nexport type ComposedSource<\n  Source extends string,\n  Fragments extends readonly AnyStorefrontQueryString[],\n> = FragmentSources<Fragments> extends \"\" ? Source : `${Source}\\n${FragmentSources<Fragments>}`;\n\ntype StorefrontGql = {\n  // Composes an already-declared document with additional fragments. Declared\n  // before the raw-source overloads so branded documents recover their literal\n  // source through SourceOf instead of binding Source to the branded type,\n  // which would degrade ComposedSource and kill inference.\n  <\n    const Document extends AnyStorefrontQueryString,\n    const Fragments extends readonly AnyStorefrontQueryString[],\n    const DocumentSource extends string = ComposedSource<SourceOf<Document>, Fragments>,\n  >(\n    document: Document,\n    fragments: Fragments,\n  ): StorefrontQueryString<\n    InferResult<DocumentSource>,\n    InferVariables<DocumentSource>,\n    DocumentSource\n  >;\n  <const Source extends string>(\n    source: Source,\n  ): StorefrontQueryString<InferResult<Source>, InferVariables<Source>, Source>;\n  <\n    const Source extends string,\n    const Fragments extends readonly AnyStorefrontQueryString[],\n    const DocumentSource extends string = ComposedSource<Source, Fragments>,\n  >(\n    source: Source,\n    fragments: Fragments,\n  ): StorefrontQueryString<\n    InferResult<DocumentSource>,\n    InferVariables<DocumentSource>,\n    DocumentSource\n  >;\n} & StorefrontTadaGql;\n\n/**\n * Tags a Storefront API query string for type-safe inference.\n *\n * At runtime, returns the source string (concatenated with any fragments).\n * At the type level, the return type carries phantom `Result` and `Variables`\n * types inferred from the Storefront API schema via gql.tada.\n *\n * Pass an array of previously declared `gql()` fragments as the second\n * argument to compose documents while preserving full type inference.\n *\n * @example\n * ```ts\n * import { gql } from \"@shopify/hydrogen\";\n *\n * const PRODUCT_QUERY = gql(`\n *   query Product($handle: String!) {\n *     product(handle: $handle) { title }\n *   }\n * `);\n *\n * const result = await storefront.graphql(PRODUCT_QUERY, {\n *   variables: { handle: \"snowboard\" },\n * });\n *\n * if (!result.errors) {\n *   // result.data.product is typed as `{ title: string } | null`\n *   console.log(result.data.product?.title);\n * }\n * ```\n */\n// oxlint-disable-next-line typescript-eslint/consistent-type-assertions -- gql.tada adds phantom helper properties to the function type that are not used at runtime.\nexport const gql = ((source: string, fragments?: Array<string>) => {\n  let query = source;\n\n  if (fragments) {\n    const seen = new Set<string>();\n    for (const fragment of fragments) {\n      if (!seen.has(fragment)) {\n        seen.add(fragment);\n        query += \"\\n\" + fragment;\n      }\n    }\n  }\n\n  return query;\n}) as unknown as StorefrontGql;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AA8HA,MAAa,QAAQ,QAAgB,cAA8B;CACjE,IAAI,QAAQ;AAEZ,KAAI,WAAW;EACb,MAAM,uBAAO,IAAI,KAAa;AAC9B,OAAK,MAAM,YAAY,UACrB,KAAI,CAAC,KAAK,IAAI,SAAS,EAAE;AACvB,QAAK,IAAI,SAAS;AAClB,YAAS,OAAO;;;AAKtB,QAAO"}
+{"version":3,"file":"graphql.mjs","names":[],"sources":["../../src/graphql/graphql.ts"],"sourcesContent":["import type { DocumentDecoration, initGraphQLTada as InitGraphQLTada } from \"gql.tada\";\n\nimport type { introspection } from \"./generated/graphql-env\";\nimport type { StorefrontScalars } from \"./scalars\";\nimport type { InferResult, InferVariables } from \"./type-resolver\";\n\ntype StorefrontTadaGql = InitGraphQLTada<{\n  introspection: introspection;\n  scalars: StorefrontScalars;\n}>;\n\n/** Type-only properties that mark a string as a `gql` document. */\ntype StorefrontQueryMetadata<Source extends string = string> = {\n  /** Marks a string that `gql` returns. The property exists only in types. */\n  readonly __hydrogenQueryBrand: true;\n  /** The document's query text, which TypeScript reads to infer types. The property exists only in types. */\n  readonly __hydrogenQuerySource?: Source;\n};\n\n/**\n * The type of a `gql` document, a query string that carries its result and variables types.\n *\n * At runtime, the document is a plain string. Read the types with `StorefrontApi.ResultOf` and\n * `StorefrontApi.VariablesOf`.\n */\nexport type StorefrontQueryString<\n  Result = any,\n  Variables = any,\n  Source extends string = string,\n> = string &\n  DocumentDecoration<Result, Variables> & {\n    readonly __hydrogenQueryBrand: true;\n    readonly __hydrogenQuerySource?: Source;\n  };\n\n/**\n * Any `gql` document, whatever its result and variables types. Use the type to accept any Storefront API document.\n */\nexport type AnyStorefrontQueryString = string & StorefrontQueryMetadata;\n\n/** The query text of a `gql` document as a string literal type. Resolves to `never` for a plain string. */\nexport type SourceOf<Doc> = Doc extends {\n  readonly __hydrogenQuerySource?: infer Source extends string;\n}\n  ? Source\n  : never;\n\nexport type FragmentSources<Fragments extends readonly AnyStorefrontQueryString[]> =\n  Fragments extends readonly []\n    ? \"\"\n    : Fragments extends readonly [infer Only extends AnyStorefrontQueryString]\n      ? SourceOf<Only>\n      : Fragments extends readonly [\n            infer First extends AnyStorefrontQueryString,\n            ...infer Rest extends readonly AnyStorefrontQueryString[],\n          ]\n        ? `${SourceOf<First>}\\n${FragmentSources<Rest>}`\n        : string;\n\n/** The combined query text of a document and its fragments, which keeps the inferred types of composed documents. */\nexport type ComposedSource<\n  Source extends string,\n  Fragments extends readonly AnyStorefrontQueryString[],\n> = FragmentSources<Fragments> extends \"\" ? Source : `${Source}\\n${FragmentSources<Fragments>}`;\n\ntype StorefrontGql = {\n  // Composes an already-declared document with additional fragments. Declared\n  // before the raw-source overloads so branded documents recover their literal\n  // source through SourceOf instead of binding Source to the branded type,\n  // which would degrade ComposedSource and kill inference.\n  <\n    const Document extends AnyStorefrontQueryString,\n    const Fragments extends readonly AnyStorefrontQueryString[],\n    const DocumentSource extends string = ComposedSource<SourceOf<Document>, Fragments>,\n  >(\n    document: Document,\n    fragments: Fragments,\n  ): StorefrontQueryString<\n    InferResult<DocumentSource>,\n    InferVariables<DocumentSource>,\n    DocumentSource\n  >;\n  <const Source extends string>(\n    source: Source,\n  ): StorefrontQueryString<InferResult<Source>, InferVariables<Source>, Source>;\n  <\n    const Source extends string,\n    const Fragments extends readonly AnyStorefrontQueryString[],\n    const DocumentSource extends string = ComposedSource<Source, Fragments>,\n  >(\n    source: Source,\n    fragments: Fragments,\n  ): StorefrontQueryString<\n    InferResult<DocumentSource>,\n    InferVariables<DocumentSource>,\n    DocumentSource\n  >;\n} & StorefrontTadaGql;\n\n/**\n * Writes a typed Storefront API query, mutation, or fragment. TypeScript infers the result and\n * variables types from Hydrogen's bundled Storefront API schema. At runtime, the function returns\n * the query string with any fragments appended.\n *\n * Pass earlier fragment documents as the second argument to compose documents and keep the\n * inferred types.\n *\n * @example\n * ```ts\n * import { gql } from \"@shopify/hydrogen\";\n *\n * const PRODUCT_QUERY = gql(`\n *   query Product($handle: String!) {\n *     product(handle: $handle) { title }\n *   }\n * `);\n *\n * const result = await storefront.graphql(PRODUCT_QUERY, {\n *   variables: { handle: \"snowboard\" },\n * });\n *\n * if (!result.errors) {\n *   // result.data.product has the type `{ title: string } | null`\n *   console.log(result.data.product?.title);\n * }\n * ```\n * @publicDocs\n */\n// oxlint-disable-next-line typescript-eslint/consistent-type-assertions -- gql.tada adds phantom helper properties to the function type that are not used at runtime.\nexport const gql = ((source: string, fragments?: Array<string>) => {\n  let query = source;\n\n  if (fragments) {\n    const seen = new Set<string>();\n    for (const fragment of fragments) {\n      if (!seen.has(fragment)) {\n        seen.add(fragment);\n        query += \"\\n\" + fragment;\n      }\n    }\n  }\n\n  return query;\n}) as unknown as StorefrontGql;\n\n/**\n * Writes a typed Storefront API query, mutation, or fragment. At runtime, the function returns the query text with each fragment appended once.\n *\n * TypeScript infers the result and variables types from Hydrogen's bundled Storefront API schema, even when the client targets another `apiVersion`. Read the types with `StorefrontApi.ResultOf` and `StorefrontApi.VariablesOf`. To type a fragment on its own, compose the fragment into a query and read the type from the query. The `FragmentOf` helper from `gql`.tada doesn't accept `gql` documents.\n *\n * @publicDocs\n */\nexport type StorefrontGqlForDocs =\n  /**\n   * @param source - The Storefront API query, mutation, or fragment source text.\n   * @param fragments - The `gql` fragments that the query text spreads.\n   * @returns A typed document to pass to the client's `graphql()` method.\n   */\n  (source: string, fragments?: readonly AnyStorefrontQueryString[]) => AnyStorefrontQueryString;\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAiIA,MAAa,QAAQ,QAAgB,cAA8B;CACjE,IAAI,QAAQ;AAEZ,KAAI,WAAW;EACb,MAAM,uBAAO,IAAI,KAAa;AAC9B,OAAK,MAAM,YAAY,UACrB,KAAI,CAAC,KAAK,IAAI,SAAS,EAAE;AACvB,QAAK,IAAI,SAAS;AAClB,YAAS,OAAO;;;AAKtB,QAAO"}

package/dist/graphql/type-resolver.d.mts

@@ -134,6 +134,7 @@ type FragmentMap<Defs, Map = {}> = Defs extends readonly [infer Def, ...infer Re
 type FirstOperation<Defs> = Defs extends readonly [infer Def, ...infer Rest] ? Def extends {
   kind: "OperationDefinition";
 } ? Def : FirstOperation<Rest> : never;
+/** The document's only operation, or `never` when the document has no operations or several. */
 type SingleOperation<Defs, Operation = never> = Defs extends readonly [infer Def, ...infer Rest] ? Def extends {
   kind: "OperationDefinition";
 } ? [Operation] extends [never] ? SingleOperation<Rest, Def> : never : SingleOperation<Rest, Operation> : Operation;
@@ -213,6 +214,7 @@ type VariablesType<Doc, Schema extends SchemaLike> = Doc extends {
 } ? FirstOperation<Defs> extends {
   variableDefinitions: any;
 } ? VariablesWalker<FirstOperation<Defs>["variableDefinitions"], Schema> : {} : {};
+/** The operation kind of a parsed document with one operation. Resolves to `"unknown"` for any other document. */
 type OperationKindType<Doc> = Doc extends {
   kind: "Document";
   definitions: infer Defs extends readonly unknown[];
@@ -222,21 +224,26 @@ type OperationKindType<Doc> = Doc extends {
 type InferResultForSchema<T extends string, Schema extends SchemaLike> = parseDocument<T> extends infer Doc ? Doc extends never ? never : DocumentType<Doc, Schema> : never;
 type InferVariablesForSchema<T extends string, Schema extends SchemaLike> = parseDocument<T> extends infer Doc ? Doc extends never ? never : VariablesType<Doc, Schema> : never;
 /**
- * Infers the result type of a Storefront API query string against the bundled schema.
+ * The result type of a Storefront API query string, from Hydrogen's bundled schema.
  *
- * Useful when you need the result shape outside of `storefront.graphql()` — e.g. for
- * a component prop type. Takes a raw query source literal: for `gql()` documents use
- * `StorefrontApi.ResultOf`, since `InferResult<typeof doc>` resolves to `never`.
+ * Use the type for a result shape outside a GraphQL call, such as a component prop type. Pass the
+ * query text as a string literal type. For a `gql` document, use `StorefrontApi.ResultOf`. The
+ * type resolves to `never` for a `gql` document.
+ *
+ * @publicDocs
  */
 type InferResult<T extends string> = InferResultForSchema<T, StorefrontSchema>;
 /**
- * Infers the variables type of a Storefront API query string against the bundled schema.
+ * The variables type of a Storefront API query string, from Hydrogen's bundled schema.
+ *
+ * Use the type for a variables shape outside a GraphQL call, such as a loader parameter type. Pass
+ * the query text as a string literal type. For a `gql` document, use `StorefrontApi.VariablesOf`.
+ * The type resolves to `never` for a `gql` document.
  *
- * Useful when you need the variables shape outside of `storefront.graphql()` — e.g. for
- * a loader param type. Takes a raw query source literal: for `gql()` documents use
- * `StorefrontApi.VariablesOf`, since `InferVariables<typeof doc>` resolves to `never`.
+ * @publicDocs
  */
 type InferVariables<T extends string> = InferVariablesForSchema<T, StorefrontSchema>;
+/** The operation kind of a query string, such as `query`. Resolves to `unknown` unless the query text has exactly one operation. */
 type InferOperationKind<T extends string> = parseDocument<T> extends infer Doc ? [Doc] extends [never] ? "unknown" : OperationKindType<Doc> : "unknown";
 //#endregion
 export { GraphQLSchemaFor, InferOperationKind, InferResult, InferResultForSchema, InferVariables, InferVariablesForSchema };

package/dist/react/cart.d.mts

@@ -4,25 +4,71 @@ import { CartFormRegister } from "../core/cart/form.mjs";
 import { CartDataFromHandlers } from "../core/cart/server-handlers.mjs";
 import { FormHTMLAttributes, ReactNode, SubmitEvent } from "react";
 //#region src/react/cart.d.ts
+/**
+ * Props for the cart provider that `createCartComponents` returns.
+ */
 type TypedCartProviderProps<TData extends CartData> = {
-  initialData?: CartInitialData<TData>;
+  /**
+   * The `data` property of the cart GET handler's result, or a promise of that data. Without initial data, the store loads the cart from `/api/cart` after the provider mounts, and the server-rendered page shows an empty cart. The provider creates its store from the first value and ignores later changes.
+   */
+  initialData?: CartInitialData<TData>; /** Content that can read the cart through the cart hooks. */
   children?: ReactNode;
 };
 type CartInitialData<TData extends CartData = CartData> = CreateCartStoreOptions<TData>["initialData"];
+/** A hook that returns the slice of cart state that your selector picks. */
+type CartStateHook<TData extends CartData> =
+/**
+ * @param selector - Picks the value to return from the cart state.
+ * @param isEqual - Compares the previous and next selected values. Return `true` to skip the re-render. Without the function, the hook compares the values by reference.
+ * @returns The selected value.
+ */
+<S>(selector: (state: CartState<TData>) => S, isEqual?: (a: S, b: S) => boolean) => S;
+/** A hook that returns the slice of cart state that your selector picks, or `undefined` outside the cart provider. */
+type OptionalCartStateHook<TData extends CartData> =
+/**
+ * @param selector - Picks the value to return from the cart state.
+ * @param isEqual - Compares the previous and next selected values. Return `true` to skip the re-render. Without the function, the hook compares the values by reference.
+ * @returns The selected value, or `undefined` outside the cart provider.
+ */
+<S>(selector: (state: CartState<TData>) => S, isEqual?: (a: S, b: S) => boolean) => S | undefined;
+/** Callbacks that run around a cart form submission. */
+interface CartFormPropsOptions {
+  /** Runs before the cart store handles the submission. Call `event.preventDefault()` to skip the cart submission. */
+  beforeSubmit?: (e: SubmitEvent<HTMLFormElement>) => void;
+  /** Runs as soon as the cart change starts, before the server responds. */
+  afterSubmit?: (e: SubmitEvent<HTMLFormElement>) => void;
+}
+/** The form props function and the register function for a cart form. */
+interface CartFormBindings {
+  /** Returns the `method`, `action`, and `onSubmit` props to spread on the form. The form posts to the cart endpoint, and the cart store handles each submission. */
+  formProps: (opts?: CartFormPropsOptions) => FormHTMLAttributes<HTMLFormElement>;
+  /** Returns the attributes for a cart field or action button. Register the quantity field with `interactive: true` to submit the form when the quantity changes. The interactive input takes the quantity as a default value and stays uncontrolled. */
+  register: CartFormRegister;
+}
+/**
+ * The cart provider and hooks that `createCartComponents` returns, typed with the custom cart fields from your cart server handlers.
+ */
 type TypedCartComponents<TData extends CartData> = {
-  CartProvider: (props: TypedCartProviderProps<TData>) => ReactNode;
-  useCart: <S>(selector: (state: CartState<TData>) => S, isEqual?: (a: S, b: S) => boolean) => S;
-  useSuspenseCart: <S>(selector: (state: CartState<TData>) => S, isEqual?: (a: S, b: S) => boolean) => S;
-  useOptionalCart: <S>(selector: (state: CartState<TData>) => S, isEqual?: (a: S, b: S) => boolean) => S | undefined;
-  useCartActions: typeof useCartActions;
+  /** Creates the cart store and shares the store with the cart hooks inside the provider. The provider connects the store on mount and destroys the store on unmount. */CartProvider: (props: TypedCartProviderProps<TData>) => ReactNode;
+  /**
+   * Returns the slice of cart state that the selector picks. The component re-renders when the selected value changes by reference, or when your `isEqual` function reports a change. A selector that returns the full state re-renders on every cart update.
+   */
+  useCart: CartStateHook<TData>; /** Suspends while the full cart loads, then returns the slice of cart state that the selector picks. Wrap the component in a `Suspense` boundary. */
+  useSuspenseCart: CartStateHook<TData>;
+  /**
+   * Returns the slice of cart state that the selector picks, or `undefined` outside the provider. Use the hook in a component that also renders above the provider, such as a cart badge on an error page.
+   */
+  useOptionalCart: OptionalCartStateHook<TData>; /** Returns the `refresh()` action. Call `refresh()` after a server-side cart change that skips cart forms. */
+  useCartActions: typeof useCartActions; /** Returns form props and a register function for cart forms. */
   useCartForm: typeof useCartForm;
 };
 /**
- * Factory that returns typed cart components and hooks matched to your server handler's
- * cart query shape.
+ * Returns a cart provider and cart hooks typed to the cart fragment in your cart server handlers.
+ * Pass `typeof cartServerHandlers` as the `THandlers` type argument. Every hook's cart state then includes your custom cart fields.
+ *
+ * On mount, the provider sends cart requests to `/api/cart` and connects the store. Every hook except `useOptionalCart` throws when you call it outside the provider.
  *
- * The generic `THandlers` parameter is inferred from your `createCartServerHandlers`
- * call, so every hook's {@link CartState} carries your custom cart fields end-to-end.
+ * @returns The cart provider, the cart state hooks, and the cart actions and form hooks.
  *
  * @example
  * ```tsx
@@ -37,14 +83,15 @@ type TypedCartComponents<TData extends CartData> = {
  *   useCartForm,
  * } = createCartComponents<typeof cartServerHandlers>();
  * ```
+ * @publicDocs
  */
 declare function createCartComponents<THandlers>(): TypedCartComponents<CartDataFromHandlers<THandlers>>;
 /**
- * Returns cart actions for reconciling state after out-of-band mutations.
+ * Returns the cart action that reloads the cart after a cart change outside cart forms.
  *
- * Currently exposes {@link CartStore.refresh} — call it after server-side cart
- * mutations that bypass the form system (e.g. a server action that creates the
- * cart before the client knows about it).
+ * Call `refresh()` after a server-side cart change that skips cart forms, such as a server action that creates the cart.
+ *
+ * @returns The `refresh()` action.
  *
  * @example
  * ```tsx
@@ -55,14 +102,17 @@ declare function createCartComponents<THandlers>(): TypedCartComponents<CartData
  *   refresh(); // re-fetch the cart
  * }
  * ```
+ * @publicDocs
  */
 declare function useCartActions(): CartActions;
 /**
- * Subscribes the {@link CartStore} to the analytics event dispatcher.
+ * Publishes cart analytics events when the customer's cart changes.
+ *
+ * Call the hook once near the root of your app, inside `CartProvider`. The hook starts tracking on mount and stops on unmount. The hook publishes `cart_updated`, `product_added_to_cart`, and `product_removed_from_cart` events.
  *
- * Call once near the root of your app — it subscribes on mount and
- * cleans up on unmount. Publishes `CART_UPDATED`, `PRODUCT_ADD_TO_CART`,
- * and `PRODUCT_REMOVED_FROM_CART` analytics events automatically.
+ * The hook throws outside `CartProvider`, and when the Shopify analytics bus isn't available. Render `ShopifyScripts` before the hook runs.
+ *
+ * @returns Nothing. The hook tracks cart analytics for the lifetime of the calling component.
  *
  * @example
  * ```tsx
@@ -71,19 +121,20 @@ declare function useCartActions(): CartActions;
  *   return <Layout />;
  * }
  * ```
+ * @publicDocs
  */
 declare function useCartAnalytics(): void;
 /**
  * Returns form props and a field register function for building cart forms.
  *
- * `formProps()` returns `<form>` attributes that intercept submission, call
- * {@link CartStore.handleFormSubmit}, and prevent the default browser navigation.
- * `register()` returns the correct HTML attributes for each field type — see
- * `CartFormRegister` for the full field/action list.
+ * Spread `formProps()` on the form. The form posts to the cart endpoint. On submit, the form props stop the browser's navigation and send the form through the cart store.
+ * The submit handler ignores a failed cart change. Read failures from the cart state's `errors`.
+ * To skip the cart submission, call `event.preventDefault()` in a `beforeSubmit` callback. The `afterSubmit` callback runs as soon as the cart change starts, before the server responds.
+ * The register function returns the HTML attributes for each cart field and action.
+ *
+ * Register the quantity field with `interactive: true` to submit the form when the quantity changes. The interactive input takes the quantity as a default value and stays uncontrolled.
  *
- * When `register("quantity", { interactive: true })` is called, the returned
- * attributes include a `ref` callback that attaches {@link attachQuantityInput}
- * for auto-submit-on-change behavior.
+ * @returns The form props function and the register function.
  *
  * @example
  * ```tsx
@@ -102,14 +153,9 @@ declare function useCartAnalytics(): void;
  *   );
  * }
  * ```
+ * @publicDocs
  */
-declare function useCartForm(): {
-  formProps: (opts?: {
-    beforeSubmit?: (e: SubmitEvent<HTMLFormElement>) => void;
-    afterSubmit?: (e: SubmitEvent<HTMLFormElement>) => void;
-  }) => FormHTMLAttributes<HTMLFormElement>;
-  register: CartFormRegister;
-};
+declare function useCartForm(): CartFormBindings;
 //#endregion
 export { createCartComponents, useCartAnalytics };
 //# sourceMappingURL=cart.d.mts.map