@shopify/ui-extensions 2024.4.0 → 2024.4.2

package/build/cjs/surfaces/checkout/components/Sheet/Sheet.js

@@ -0,0 +1,16 @@
+'use strict';
+
+Object.defineProperty(exports, '__esModule', { value: true });
+
+var core = require('@remote-ui/core');
+
+/**
+ * Sheet is designed to be used on top of other elements in a user interface and is typically bound to the bottom of a page.
+ * Sheet can contain and display various types of content such as forms, or informational messages.
+ * Unlike a Modal, which interrupts user flow, a Sheet offers a less intrusive, fluid experience.
+ *
+ * The library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.
+ */
+const Sheet = core.createRemoteComponent('Sheet');
+
+exports.Sheet = Sheet;

package/build/cjs/surfaces/checkout.js

@@ -44,6 +44,7 @@ var ProductThumbnail = require('./checkout/components/ProductThumbnail/ProductTh
 var Popover = require('./checkout/components/Popover/Popover.js');
 var ScrollView = require('./checkout/components/ScrollView/ScrollView.js');
 var Select = require('./checkout/components/Select/Select.js');
+var Sheet = require('./checkout/components/Sheet/Sheet.js');
 var SkeletonImage = require('./checkout/components/SkeletonImage/SkeletonImage.js');
 var SkeletonText = require('./checkout/components/SkeletonText/SkeletonText.js');
 var SkeletonTextBlock = require('./checkout/components/SkeletonTextBlock/SkeletonTextBlock.js');
@@ -105,6 +106,7 @@ exports.ProductThumbnail = ProductThumbnail.ProductThumbnail;
 exports.Popover = Popover.Popover;
 exports.ScrollView = ScrollView.ScrollView;
 exports.Select = Select.Select;
+exports.Sheet = Sheet.Sheet;
 exports.SkeletonImage = SkeletonImage.SkeletonImage;
 exports.SkeletonText = SkeletonText.SkeletonText;
 exports.SkeletonTextBlock = SkeletonTextBlock.SkeletonTextBlock;

package/build/esm/surfaces/checkout/components/Sheet/Sheet.mjs

@@ -0,0 +1,12 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Sheet is designed to be used on top of other elements in a user interface and is typically bound to the bottom of a page.
+ * Sheet can contain and display various types of content such as forms, or informational messages.
+ * Unlike a Modal, which interrupts user flow, a Sheet offers a less intrusive, fluid experience.
+ *
+ * The library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.
+ */
+const Sheet = createRemoteComponent('Sheet');
+
+export { Sheet };

package/build/esm/surfaces/checkout.mjs

@@ -40,6 +40,7 @@ export { ProductThumbnail } from './checkout/components/ProductThumbnail/Product
 export { Popover } from './checkout/components/Popover/Popover.mjs';
 export { ScrollView } from './checkout/components/ScrollView/ScrollView.mjs';
 export { Select } from './checkout/components/Select/Select.mjs';
+export { Sheet } from './checkout/components/Sheet/Sheet.mjs';
 export { SkeletonImage } from './checkout/components/SkeletonImage/SkeletonImage.mjs';
 export { SkeletonText } from './checkout/components/SkeletonText/SkeletonText.mjs';
 export { SkeletonTextBlock } from './checkout/components/SkeletonTextBlock/SkeletonTextBlock.mjs';

package/build/esnext/surfaces/checkout/components/Sheet/Sheet.esnext

@@ -0,0 +1,12 @@
+import { createRemoteComponent } from '@remote-ui/core';
+
+/**
+ * Sheet is designed to be used on top of other elements in a user interface and is typically bound to the bottom of a page.
+ * Sheet can contain and display various types of content such as forms, or informational messages.
+ * Unlike a Modal, which interrupts user flow, a Sheet offers a less intrusive, fluid experience.
+ *
+ * The library automatically applies the [WAI-ARIA Dialog pattern](https://www.w3.org/WAI/ARIA/apg/patterns/dialog-modal/) to both the activator and the sheet content.
+ */
+const Sheet = createRemoteComponent('Sheet');
+
+export { Sheet };

package/build/esnext/surfaces/checkout.esnext

@@ -40,6 +40,7 @@ export { ProductThumbnail } from './checkout/components/ProductThumbnail/Product
 export { Popover } from './checkout/components/Popover/Popover.esnext';
 export { ScrollView } from './checkout/components/ScrollView/ScrollView.esnext';
 export { Select } from './checkout/components/Select/Select.esnext';
+export { Sheet } from './checkout/components/Sheet/Sheet.esnext';
 export { SkeletonImage } from './checkout/components/SkeletonImage/SkeletonImage.esnext';
 export { SkeletonText } from './checkout/components/SkeletonText/SkeletonText.esnext';
 export { SkeletonTextBlock } from './checkout/components/SkeletonTextBlock/SkeletonTextBlock.esnext';

package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts

@@ -0,0 +1,20 @@
+import type { AddressAutocompleteSuggestion, AutocompleteAddress } from './shared';
+export interface AddressAutocompleteFormatSuggestionApi {
+    /**
+     * The autocomplete suggestion that the buyer selected during checkout.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     */
+    target: Target;
+}
+interface Target {
+    selectedSuggestion: AddressAutocompleteSuggestion;
+}
+export interface AddressAutocompleteFormatSuggestionOutput {
+    /**
+     * The formatted address that will be used to populate the native address fields.
+     */
+    formattedAddress: AutocompleteAddress;
+}
+export {};
+//# sourceMappingURL=format-suggestion.d.ts.map

package/build/ts/surfaces/checkout/api/address-autocomplete/format-suggestion.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"format-suggestion.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/address-autocomplete/format-suggestion.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,6BAA6B,EAC7B,mBAAmB,EACpB,MAAM,UAAU,CAAC;AAElB,MAAM,WAAW,sCAAsC;IACrD;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,MAAM;IACd,kBAAkB,EAAE,6BAA6B,CAAC;CACnD;AAED,MAAM,WAAW,yCAAyC;IACxD;;OAEG;IACH,gBAAgB,EAAE,mBAAmB,CAAC;CACvC"}

package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts

@@ -0,0 +1,51 @@
+import type { MailingAddress } from '../../../checkout';
+/**
+ * A partial mailing address with only fields relevant to address autocomplete.
+ * All fields are optional
+ */
+export interface AutocompleteAddress extends Pick<MailingAddress, 'address1' | 'address2' | 'city' | 'provinceCode' | 'zip' | 'countryCode'> {
+}
+export interface AddressAutocompleteSuggestion {
+    /**
+     * The address suggestion text presented to the buyer in the list of autocomplete suggestions.
+     *
+     * This text is shown to the buyer as-is. No attempts will be made to parse it.
+     *
+     * @example "123 Main St, Toronto, ON, CA"
+     */
+    label: string;
+    /**
+     * A textual identifier that uniquely identifies an autocomplete suggestion
+     * or address. This identifier may be used to search for a formatted address.
+     *
+     * @example "35ef8d55-dceb-4ed8-847b-2f2fc7472f14"
+     */
+    id?: string;
+    /**
+     * A list of substrings that matched the original search query.
+     *
+     * If `matchedSubstrings` are provided, then they will be used to highlight the substrings
+     * of the suggestions that matched the original search query.
+     *
+     * @example [{offset: 0, length: 4}]
+     */
+    matchedSubstrings?: MatchedSubstring[];
+    /**
+     * The formatted address that will auto-fill the remaining address fields.
+     *
+     * If this value is returned for every suggestion, then the
+     * `purchase.address-autocomplete.format-suggestion` extension target is not needed.
+     */
+    formattedAddress?: AutocompleteAddress;
+}
+export interface MatchedSubstring {
+    /**
+     * The start location of the matched substring in the suggestion label text.
+     */
+    offset: number;
+    /**
+     * The length of the matched substring in the suggestion label text.
+     */
+    length: number;
+}
+//# sourceMappingURL=shared.d.ts.map

package/build/ts/surfaces/checkout/api/address-autocomplete/shared.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"shared.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/address-autocomplete/shared.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,mBAAmB,CAAC;AAEtD;;;GAGG;AACH,MAAM,WAAW,mBACf,SAAQ,IAAI,CACV,cAAc,EACd,UAAU,GAAG,UAAU,GAAG,MAAM,GAAG,cAAc,GAAG,KAAK,GAAG,aAAa,CAC1E;CAAG;AAEN,MAAM,WAAW,6BAA6B;IAC5C;;;;;;OAMG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;OAKG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;;;;;;OAOG;IACH,iBAAiB,CAAC,EAAE,gBAAgB,EAAE,CAAC;IAEvC;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAC;CACxC;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;IACf;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB"}

package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts

@@ -0,0 +1,236 @@
+import type { Analytics, AppMetafieldEntry, Capability, CheckoutToken, Country, Currency, Editor, ExtensionSettings, I18n, Language, Market, Metafield, SessionToken, Shop, Storage, Version } from '../standard/standard';
+import type { Attribute, MailingAddress } from '../shared';
+import type { ApiVersion, GraphQLError, StorefrontApiVersion, Timezone } from '../../../../shared';
+export interface AddressAutocompleteStandardApi<Target extends 'purchase.address-autocomplete.suggest' | 'purchase.address-autocomplete.format-suggestion'> {
+    /**
+     * The metafields requested in the
+     * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration)
+     * file. These metafields are updated when there's a change in the merchandise items
+     * being purchased by the customer.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     *
+     * > Tip:
+     * > Cart metafields are only available on carts created via the Storefront API version `2023-04` or later.*
+     */
+    appMetafields: AppMetafieldEntry[];
+    /**
+     * The methods for interacting with [Web Pixels](https://shopify.dev/docs/apps/marketing), such as emitting an event.
+     */
+    analytics: Analytics;
+    /**
+     * The custom attributes left by the customer to the merchant, either in their cart or during checkout.
+     */
+    attributes: Attribute[] | undefined;
+    /**
+     * The proposed customer billing address. The address updates when the field is
+     * committed (on change) rather than every keystroke.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     */
+    billingAddress?: MailingAddress | undefined;
+    /**
+     * A stable ID that represents the current checkout.
+     *
+     * Matches the `token` field in the [WebPixel checkout payload](https://shopify.dev/docs/api/pixels/customer-events#checkout)
+     * and the `checkout_token` field in the [REST Admin API `Order` resource](https://shopify.dev/docs/api/admin-rest/unstable/resources/order#resource-object).
+     */
+    checkoutToken: CheckoutToken | undefined;
+    /**
+     * The meta information about the extension.
+     */
+    extension: Extension<Target>;
+    /**
+     * Utilities for translating content and formatting values according to the current
+     * [`localization`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization)
+     * Type 'RunnableExtensionInstance<keyof RunnableExtensionTargets>' is not assignable to type 'ExtensionInstance<Target>'.
+     *
+     * Refer to [`localization` examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#examples)
+     * for more information.
+     */
+    i18n: I18n;
+    /**
+     * The details about the location, language, and currency of the customer. For utilities to easily
+     * format and translate content based on these details, you can use the
+     * [`i18n`](https://shopify.dev/docs/api/checkout-ui-extensions/apis/localization#standardapi-propertydetail-i18n)
+     * object instead.
+     */
+    localization: Localization;
+    /**
+     * The metafields that apply to the current checkout.
+     *
+     * Metafields are stored locally on the client and are applied to the order object after the checkout completes.
+     * They are shared by all extensions running on checkout, and
+     * persist for as long as the customer is working on this checkout.
+     *
+     * Once the order is created, you can query these metafields using the
+     * [GraphQL Admin API](https://shopify.dev/docs/admin-api/graphql/reference/orders/order#metafield-2021-01)
+     */
+    metafields: Metafield[];
+    /**
+     * The method used to query the Storefront GraphQL API with a prefetched token.
+     *
+     * Refer to [Storefront API access examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/storefront-api) for more information.
+     */
+    query: <Data = unknown, Variables = Record<string, unknown>>(query: string, options?: {
+        variables?: Variables;
+        version?: StorefrontApiVersion;
+    }) => Promise<{
+        data?: Data;
+        errors?: GraphQLError[];
+    }>;
+    /**
+     * The session token providing a set of claims as a signed JSON Web Token (JWT).
+     *
+     * The token has a TTL of 5 minutes.
+     *
+     * If the previous token expires, this value will reflect a new session token with a new signature and expiry.
+     *
+     * Refer to [session token examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/session-token) for more information.
+     */
+    sessionToken: SessionToken;
+    /**
+     * The settings matching the settings definition written in the
+     * [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.
+     *
+     *  Refer to [settings examples](https://shopify.dev/docs/api/checkout-ui-extensions/apis/settings#examples) for more information.
+     *
+     * > Note: The settings are empty when an extension is being installed in the [checkout editor](https://help.shopify.com/en/manual/checkout-settings/checkout-extensibility/checkout-editor).
+  
+     */
+    settings: ExtensionSettings;
+    /**
+     * The proposed customer shipping address. During the information step,
+     * the address updates when the field is committed (on change) rather than every keystroke.
+     *
+     * > Note: An address value is only present if delivery is required. Otherwise, the subscribable value is undefined.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     */
+    shippingAddress?: MailingAddress | undefined;
+    /** The shop where the checkout is taking place. */
+    shop: Shop;
+    /**
+     * The key-value storage for the extension.
+     *
+     * It uses `localStorage` and should persist across the customer's current checkout session.
+     *
+     * > Caution: Data persistence isn't guaranteed and storage is reset when the customer starts a new checkout.
+     *
+     * Data is shared across all activated extension targets of this extension. In versions 2023-07 and earlier,
+     * each activated extension target had its own storage.
+     */
+    storage: Storage;
+    /**
+     * The runner version being used for the extension.
+     *
+     * @example 'unstable'
+     */
+    version: Version;
+}
+interface Extension<Target extends 'purchase.address-autocomplete.suggest' | 'purchase.address-autocomplete.format-suggestion'> {
+    /**
+     * The API version that was set in the extension config file.
+     *
+     * @example '2023-07', '2023-10', '2024-01', '2024-04', 'unstable'
+     */
+    apiVersion: ApiVersion;
+    /**
+     * The allowed capabilities of the extension, defined
+     * in your [shopify.extension.toml](https://shopify.dev/docs/api/checkout-ui-extensions/configuration) file.
+     *
+     * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.
+     *
+     * * [`network_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#network-access): the extension can make external network calls.
+     *
+     * * [`block_progress`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#block-progress): the extension can block a customer's progress and the merchant has allowed this blocking behavior.
+     *
+     * * [`collect_buyer_consent.sms_marketing`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can collect customer consent for SMS marketing.
+     *
+     * * [`collect_buyer_consent.customer_privacy`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#collect-buyer-consent): the extension can register customer consent decisions that will be honored on Shopify-managed services.
+     */
+    capabilities: Capability[];
+    /**
+     * The information about the editor where the extension is being rendered.
+     *
+     * If the value is undefined, then the extension is not running in an editor.
+     */
+    editor?: Editor;
+    /**
+     * A Boolean to show whether your extension is currently rendered to the screen.
+     *
+     * Shopify might render your extension before it's visible in the UI,
+     * typically to pre-render extensions that will appear on a later step of the
+     * checkout.
+     *
+     * Your extension might also continue to run after the customer has navigated away
+     * from where it was rendered. The extension continues running so that
+     * your extension is immediately available to render if the customer navigates back.
+     *
+     * If the extension is not capable of rendering UI components, then the value will always be false.
+     */
+    rendered: boolean;
+    /**
+     * The URL to the script that started the extension target.
+     */
+    scriptUrl: string;
+    /**
+     * The identifier that specifies where in Shopify’s UI your code is being
+     * injected. This will be one of the targets you have included in your
+     * extension’s configuration file.
+     *
+     * @example 'purchase.checkout.block.render'
+     * @see https://shopify.dev/docs/api/checkout-ui-extensions/unstable/extension-targets-overview
+     * @see https://shopify.dev/docs/apps/app-extensions/configuration#targets
+     */
+    target: Target;
+    /**
+     * The published version of the running extension target.
+     *
+     * For unpublished extensions, the value is `undefined`.
+     *
+     * @example 3.0.10
+     */
+    version?: string;
+}
+interface Localization {
+    /**
+     * The currency that the customer sees for money amounts in the checkout.
+     */
+    currency: Currency;
+    /**
+     * The buyer’s time zone.
+     */
+    timezone: Timezone;
+    /**
+     * The language the customer sees in the checkout.
+     */
+    language: Language;
+    /**
+     * This is the customer's language, as supported by the extension.
+     * If the customer's actual language is not supported by the extension,
+     * then this is the language that is used for translations.
+     *
+     * For example, if the customer's language is 'fr-CA' but your extension
+     * only supports translations for 'fr', then the `isoCode` for this
+     * language is 'fr'. If your extension does not provide french
+     * translations at all, then this value is the default locale for your
+     * extension (that is, the one matching your .default.json file).
+     */
+    extensionLanguage: Language;
+    /**
+     * The country context of the checkout. This value carries over from the
+     * context of the cart, where it was used to contextualize the storefront
+     * experience. If the country is unknown, then the value is undefined.
+     */
+    country: Country | undefined;
+    /**
+     * The [market](https://shopify.dev/docs/apps/markets) context of the
+     * checkout. This value carries over from the context of the cart, where it
+     * was used to contextualize the storefront experience. If the market is unknown,
+     * then the value is undefined.
+     */
+    market: Market | undefined;
+}
+export {};
+//# sourceMappingURL=standard.d.ts.map

package/build/ts/surfaces/checkout/api/address-autocomplete/standard.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"standard.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/address-autocomplete/standard.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,SAAS,EACT,iBAAiB,EACjB,UAAU,EACV,aAAa,EACb,OAAO,EACP,QAAQ,EACR,MAAM,EACN,iBAAiB,EACjB,IAAI,EACJ,QAAQ,EACR,MAAM,EACN,SAAS,EACT,YAAY,EACZ,IAAI,EACJ,OAAO,EACP,OAAO,EACR,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EAAC,SAAS,EAAE,cAAc,EAAC,MAAM,WAAW,CAAC;AACzD,OAAO,KAAK,EACV,UAAU,EACV,YAAY,EACZ,oBAAoB,EACpB,QAAQ,EACT,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,8BAA8B,CAC7C,MAAM,SACF,uCAAuC,GACvC,iDAAiD;IAErD;;;;;;;;;;OAUG;IACH,aAAa,EAAE,iBAAiB,EAAE,CAAC;IAEnC;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAAC;IAEpC;;;;;OAKG;IACH,cAAc,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAE5C;;;;;OAKG;IACH,aAAa,EAAE,aAAa,GAAG,SAAS,CAAC;IAEzC;;OAEG;IACH,SAAS,EAAE,SAAS,CAAC,MAAM,CAAC,CAAC;IAE7B;;;;;;;OAOG;IACH,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;OAKG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;;;;;;OASG;IACH,UAAU,EAAE,SAAS,EAAE,CAAC;IAExB;;;;OAIG;IACH,KAAK,EAAE,CAAC,IAAI,GAAG,OAAO,EAAE,SAAS,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACzD,KAAK,EAAE,MAAM,EACb,OAAO,CAAC,EAAE;QAAC,SAAS,CAAC,EAAE,SAAS,CAAC;QAAC,OAAO,CAAC,EAAE,oBAAoB,CAAA;KAAC,KAC9D,OAAO,CAAC;QAAC,IAAI,CAAC,EAAE,IAAI,CAAC;QAAC,MAAM,CAAC,EAAE,YAAY,EAAE,CAAA;KAAC,CAAC,CAAC;IAErD;;;;;;;;OAQG;IACH,YAAY,EAAE,YAAY,CAAC;IAE3B;;;;;;;;OAQG;IACH,QAAQ,EAAE,iBAAiB,CAAC;IAE5B;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,cAAc,GAAG,SAAS,CAAC;IAE7C,mDAAmD;IACnD,IAAI,EAAE,IAAI,CAAC;IAEX;;;;;;;;;OASG;IACH,OAAO,EAAE,OAAO,CAAC;IAEjB;;;;OAIG;IACH,OAAO,EAAE,OAAO,CAAC;CAClB;AAED,UAAU,SAAS,CACjB,MAAM,SACF,uCAAuC,GACvC,iDAAiD;IAErD;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAC;IAEvB;;;;;;;;;;;;;OAaG;IACH,YAAY,EAAE,UAAU,EAAE,CAAC;IAE3B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;;;;;;OAYG;IACH,QAAQ,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAClB;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAC;IAEf;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,UAAU,YAAY;IACpB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;OAEG;IACH,QAAQ,EAAE,QAAQ,CAAC;IAEnB;;;;;;;;;;OAUG;IACH,iBAAiB,EAAE,QAAQ,CAAC;IAE5B;;;;OAIG;IACH,OAAO,EAAE,OAAO,GAAG,SAAS,CAAC;IAE7B;;;;;OAKG;IACH,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;CAC5B"}

package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts

@@ -0,0 +1,56 @@
+import type { CountryCode } from '../../../checkout';
+import type { AddressAutocompleteSuggestion } from './shared';
+export interface AddressAutocompleteSuggestApi {
+    /**
+     * The signal that the extension should listen to for cancellation requests.
+     *
+     * If the signal is aborted, the extension should cancel any ongoing requests.
+     * The signal will be aborted either when the buyer navigates away from the
+     * address field or when the debounced query value changes.
+     *
+     * Pass this signal to any asynchronous operations that need to be cancelled,
+     * like `fetch`.
+     */
+    signal: AbortSignal;
+    /**
+     * The current state of the address form that the buyer is interacting with.
+     *
+     * {% include /apps/checkout/privacy-icon.md %} Requires access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data).
+     */
+    target: Target;
+}
+interface Target {
+    /**
+     * The current value of the `field` the buyer is interacting with.
+     *
+     * @example "123 M"
+     */
+    value: string;
+    /**
+     * The `MailingAddress` field that the buyer is interacting with.
+     *
+     * This field can either be `address1` or `zip` depending on the country
+     * selected by the buyer during checkout.
+     *
+     * @example "address1"
+     */
+    field: 'address1' | 'zip';
+    /**
+     * The `countryCode` selected in the address form that the buyer is interacting with.
+     *
+     * This code is in ISO 3166 Alpha-2 format representing the buyer's country. Refer to https://www.iso.org/iso-3166-country-codes.html.
+     *
+     * @example 'CA' for Canada.
+     */
+    selectedCountryCode?: CountryCode;
+}
+export interface AddressAutocompleteSuggestOutput {
+    /**
+     * An array of address autocomplete suggestions to show to the buyer.
+     *
+     * > Note: Only the first five suggestions will be displayed to the buyer.
+     */
+    suggestions: AddressAutocompleteSuggestion[];
+}
+export {};
+//# sourceMappingURL=suggest.d.ts.map

package/build/ts/surfaces/checkout/api/address-autocomplete/suggest.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"suggest.d.ts","sourceRoot":"","sources":["../../../../../../src/surfaces/checkout/api/address-autocomplete/suggest.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,WAAW,EAAC,MAAM,mBAAmB,CAAC;AAEnD,OAAO,KAAK,EAAC,6BAA6B,EAAC,MAAM,UAAU,CAAC;AAE5D,MAAM,WAAW,6BAA6B;IAC5C;;;;;;;;;OASG;IACH,MAAM,EAAE,WAAW,CAAC;IAEpB;;;;OAIG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,MAAM;IACd;;;;OAIG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;;;;;;OAOG;IACH,KAAK,EAAE,UAAU,GAAG,KAAK,CAAC;IAE1B;;;;;;OAMG;IACH,mBAAmB,CAAC,EAAE,WAAW,CAAC;CACnC;AAED,MAAM,WAAW,gCAAgC;IAC/C;;;;OAIG;IACH,WAAW,EAAE,6BAA6B,EAAE,CAAC;CAC9C"}

package/build/ts/surfaces/checkout/api/checkout/checkout.d.ts

@@ -233,7 +233,7 @@ export interface GiftCardRemoveChange {
      */
     type: 'removeGiftCard';
     /**
-     * Gift card code.
+     * The full gift card code, or the last four digits of the code.
      */
     code: string;
 }