@shopify/ui-extensions 2025.10.14 → 2025.10.15

package/package.json

@@ -1,11 +1,9 @@
 {
   "name": "@shopify/ui-extensions",
-  "version": "2025.10.14",
+  "version": "2025.10.15",
   "scripts": {
     "docs:admin": "node ./docs/surfaces/admin/build-docs.mjs",
     "docs:checkout": "bash ./docs/surfaces/checkout/build-docs.sh",
-    "docs:checkout:fast": "bash ./docs/surfaces/checkout/build-docs-fast.sh",
-    "docs:checkout:dev": "bash ./docs/surfaces/checkout/build-docs-watch.sh",
     "docs:point-of-sale": "node ./docs/surfaces/point-of-sale/build-docs.mjs",
     "docs:customer-account": "node ./docs/surfaces/customer-account/build-docs.mjs"
   },
@@ -129,7 +127,7 @@
   ],
   "devDependencies": {
     "@remote-ui/async-subscription": "^2.1.16",
-    "@shopify/generate-docs": "https://registry.npmjs.org/@shopify/generate-docs/-/generate-docs-0.19.8.tgz",
+    "@shopify/generate-docs": "1.2.2",
     "@quilted/react-testing": "^0.6.11",
     "typescript": "^4.9.0",
     "@faker-js/faker": "^8.4.1",
@@ -160,7 +158,6 @@
   "files": [
     "build",
     "src",
-    "!*.doc.ts",
     "index.*",
     "README.md"
   ],

package/src/shared.ts

@@ -14,22 +14,23 @@ export type ApiVersion =
   | 'unstable'
   | '2025-07'
   | '2025-10'
-  | '2026-01';
+  | '2026-01'
+  | '2026-04';
 
 /**
  * The capabilities an extension has access to.
  *
- * * [`api_access`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#api-access): the extension can access the Storefront API.
+ * * `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.
+ * * `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 buyer's progress and the merchant has allowed this blocking behavior.
+ * * `block_progress`: The extension can block a buyer'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 buyer consent for SMS marketing.
+ * * `collect_buyer_consent.sms_marketing`: The extension can collect buyer 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 buyer consent decisions that will be honored on Shopify-managed services.
+ * * `collect_buyer_consent.customer_privacy`: The extension can register buyer consent decisions that will be honored on Shopify-managed services.
  *
- * * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/configuration#iframe): the extension can embed an external URL in an iframe.
+ * * `iframe.sources`: The extension can embed an external URL in an iframe.
  */
 
 export type Capability =
@@ -849,9 +850,12 @@ export type CountryCode =
   | 'ZW'
   | 'ZZ';
 
+/**
+ * A buyer's country, identified by its ISO country code.
+ */
 export interface Country {
   /**
-   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. This is the internationally recognized standard for representing countries and territories.
+   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    *
    * @example 'CA' for Canada, 'US' for United States.
    */
@@ -902,7 +906,7 @@ export type LocalizedFieldKey =
   | 'TAX_EMAIL_IT';
 
 /**
- * Union of supported storefront API versions
+ * The supported Storefront API versions. Pass one of these values to `query()` to target a specific API version when querying the Storefront GraphQL API.
  */
 export type StorefrontApiVersion =
   | '2022-04'
@@ -921,9 +925,12 @@ export type StorefrontApiVersion =
   | '2025-07'
   | '2025-10';
 
+/**
+ * A buyer's country, identified by its ISO country code.
+ */
 export interface Country {
   /**
-   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. This is the internationally recognized standard for representing countries and territories.
+   * The two-letter country code in [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format.
    *
    * @example 'CA' for Canada, 'US' for United States.
    */
@@ -931,12 +938,24 @@ export interface Country {
 }
 
 /**
- * GraphQL error returned by the Shopify Storefront APIs.
+ * An error returned by the Storefront GraphQL API. Contains a human-readable `message` and an `extensions` object with the request ID and error code for debugging.
  */
 export interface GraphQLError {
+  /**
+   * A human-readable description of the error.
+   */
   message: string;
+  /**
+   * Additional error metadata including the request ID and error code.
+   */
   extensions: {
+    /**
+     * The unique identifier for the API request, useful for debugging with Shopify support.
+     */
     requestId: string;
+    /**
+     * A machine-readable error code identifying the type of error.
+     */
     code: string;
   };
 }
@@ -946,11 +965,46 @@ export interface GraphQLError {
  */
 export interface ReadonlySignalLike<T> {
   /**
-   * The current value of the locale string in IETF format. For example, `"en-US"`, `"fr-CA"`, or `"de-DE"`. This property provides immediate access to the current locale without requiring subscription setup. Use for one-time locale checks or initial internationalization setup.
+   * The current value of the signal. This property provides immediate access to the current value without requiring subscription setup. Use for one-time value checks or initial setup.
    */
   readonly value: T;
   /**
-   * Subscribes to locale changes and calls the provided function whenever the locale updates. Returns an unsubscribe function to clean up the subscription. Use to automatically update your extension content when merchants change their language settings during POS sessions.
+   * Subscribes to value changes and calls the provided function whenever the value updates. Returns an unsubscribe function to clean up the subscription. Use to automatically react to changes in the signal's value.
    */
   subscribe(fn: (value: T) => void): () => void;
 }
+
+/**
+ * A result type that indicates the success or failure of an operation.
+ */
+type Result<T> =
+  | {success: true; value: T}
+  | {success: false; errors: ValidationError[]};
+
+/**
+ * A validation error object that is returned when an operation fails.
+ */
+interface ValidationError {
+  type: 'error';
+  /**
+   * A message describing the error.
+   */
+  message: string;
+  /**
+   * A code identifier for the error.
+   */
+  code: string;
+  /**
+   * Field-level validation issues
+   */
+  issues?: {
+    message: string;
+    path: string[];
+  }[];
+}
+
+/**
+ * A function that updates a signal and returns a result indicating success or failure.
+ * The function is typically used along with a `ReadonlySignalLike` object.
+ */
+export type UpdateSignalFunction<T> = (value: T) => Result<T>;

package/src/surfaces/admin/api/action/action.ts

@@ -6,6 +6,7 @@ import type {PickerApi} from '../picker/picker';
 
 /**
  * The `ActionExtensionApi` object provides methods for action extensions that render in modal overlays. Access the following properties on the `ActionExtensionApi` object to interact with the current context, control the modal, and display picker dialogs.
+ * @publicDocs
  */
 export interface ActionExtensionApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardApi<ExtensionTarget> {

package/src/surfaces/admin/api/block/block.ts

@@ -19,6 +19,7 @@ export interface Navigation {
 
 /**
  * The `BlockExtensionApi` object provides methods for block extensions that render inline content on admin pages. Access the following properties on the `BlockExtensionApi` object to interact with the current context, navigate to other extensions, and display picker dialogs.
+ * @publicDocs
  */
 export interface BlockExtensionApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardApi<ExtensionTarget> {

package/src/surfaces/admin/api/customer-segment-template/customer-segment-template.ts

@@ -4,6 +4,7 @@ import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-target
 
 /**
  * The `CustomerSegmentTemplateApi` object provides methods for creating customer segment templates. Access the following properties on the `CustomerSegmentTemplateApi` object to build templates with translated content.
+ * @publicDocs
  */
 export interface CustomerSegmentTemplateApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/intents/intents.ts

@@ -1,5 +1,6 @@
 /**
  * The response returned when a merchant closes or cancels the workflow without completing it. Check for this response to handle cancellation gracefully in your extension.
+ * @publicDocs
  */
 export interface ClosedIntentResponse {
   /** Indicates the workflow was closed without completion. When `'closed'`, the merchant exited the workflow before finishing. */
@@ -8,6 +9,7 @@ export interface ClosedIntentResponse {
 
 /**
  * The response returned when a merchant successfully completes the workflow. Use this to access the created or updated resource data.
+ * @publicDocs
  */
 export interface SuccessIntentResponse {
   /** Indicates successful completion. When `'ok'`, the merchant completed the workflow and the resource was created or updated. */
@@ -18,6 +20,7 @@ export interface SuccessIntentResponse {
 
 /**
  * The response returned when the workflow fails due to validation errors or other issues. Use this to display error messages and help merchants fix problems.
+ * @publicDocs
  */
 export interface ErrorIntentResponse {
   /** Indicates the workflow failed. When `'error'`, the workflow encountered validation errors or other issues that prevented completion. */
@@ -37,6 +40,7 @@ export interface ErrorIntentResponse {
 
 /**
  * The result of an intent workflow. Check the `code` property to determine the outcome: `'ok'` for success, `'error'` for failure, or `'closed'` if the merchant cancelled.
+ * @publicDocs
  */
 export type IntentResponse =
   | SuccessIntentResponse
@@ -45,6 +49,7 @@ export type IntentResponse =
 
 /**
  * A handle for tracking an in-progress intent workflow.
+ * @publicDocs
  */
 export interface IntentActivity {
   /**
@@ -127,6 +132,7 @@ export interface IntentQuery extends IntentQueryOptions {
  * });
  * const response = await activity.complete;
  * ```
+ * @publicDocs
  */
 export interface IntentInvokeApi {
   (query: IntentQuery): Promise<IntentActivity>;

package/src/surfaces/admin/api/order-routing-rule/order-routing-rule.ts

@@ -6,6 +6,7 @@ import {Data} from './data';
 
 /**
  * The `OrderRoutingRuleApi` object provides methods for configuring order routing rules. Access the following properties on the `OrderRoutingRuleApi` object to manage rule settings and metafields.
+ * @publicDocs
  */
 export interface OrderRoutingRuleApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardApi<ExtensionTarget> {

package/src/surfaces/admin/api/picker/picker.ts

@@ -108,5 +108,6 @@ interface Item {
 
 /**
  * The `picker` function opens a custom selection dialog with your app-specific data. It accepts configuration options to define the picker's heading, items, headers, and selection behavior. It returns a Promise that resolves to a `Picker` object with a `selected` property for accessing the merchant's selection.
+ * @publicDocs
  */
 export type PickerApi = (options: PickerOptions) => Promise<Picker>;

package/src/surfaces/admin/api/print-action/print-action.ts

@@ -6,6 +6,7 @@ import type {PickerApi} from '../picker/picker';
 
 /**
  * The `PrintActionExtensionApi` object provides methods for print action extensions that generate custom printable documents. Access the following properties on the `PrintActionExtensionApi` object to access selected resources and display picker dialogs for print configuration.
+ * @publicDocs
  */
 export interface PrintActionExtensionApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-details-configuration.ts

@@ -65,6 +65,7 @@ export interface ProductComponent {
 
 /**
  * The `ProductDetailsConfigurationApi` object provides methods for configuring product bundles and relationships. Access the following properties on the `ProductDetailsConfigurationApi` object to build product configuration interfaces.
+ * @publicDocs
  */
 export interface ProductDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/product-configuration/product-variant-details-configuration.ts

@@ -66,6 +66,7 @@ export interface ProductVariantComponent {
 
 /**
  * The `ProductVariantDetailsConfigurationApi` object provides methods for configuring product variant bundles and relationships. Access the following properties on the `ProductVariantDetailsConfigurationApi` object to build variant configuration interfaces.
+ * @publicDocs
  */
 export interface ProductVariantDetailsConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/purchase-options-card-action.ts

@@ -3,6 +3,7 @@ import type {ExtensionTarget as AnyExtensionTarget} from '../extension-targets';
 
 /**
  * The `PurchaseOptionsCardConfigurationApi` object provides methods for action extensions that interact with purchase options and selling plans. Access the following properties on the `PurchaseOptionsCardConfigurationApi` object to work with selected products and their associated subscription configurations.
+ * @publicDocs
  */
 export interface PurchaseOptionsCardConfigurationApi<
   ExtensionTarget extends AnyExtensionTarget,

package/src/surfaces/admin/api/resource-picker/resource-picker.ts

@@ -360,6 +360,7 @@ interface Filters {
 
 /**
  * The `ResourcePickerOptions` object defines how the resource picker behaves, including which resource type to display, selection limits, filters, and preselected items. Access the following properties on the `ResourcePickerOptions` object to configure the resource picker's appearance and functionality.
+ * @publicDocs
  */
 export interface ResourcePickerOptions {
   /**
@@ -394,6 +395,7 @@ export interface ResourcePickerOptions {
 
 /**
  * Opens the resource picker modal for selecting products, variants, or collections. Returns the selected resources when the user confirms their selection, or undefined if they cancel.
+ * @publicDocs
  */
 export type ResourcePickerApi = (
   options: ResourcePickerOptions,

package/src/surfaces/admin/api/should-render/should-render.ts

@@ -12,6 +12,7 @@ export interface ShouldRenderOutput {
 
 /**
  * The `ShouldRenderApi` object provides methods for controlling action extension visibility. Access the following properties on the `ShouldRenderApi` object to determine whether an associated action should appear based on the current context.
+ * @publicDocs
  */
 export interface ShouldRenderApi<ExtensionTarget extends AnyExtensionTarget>
   extends StandardApi<ExtensionTarget> {

package/src/surfaces/admin/api/standard/standard.ts

@@ -37,6 +37,7 @@ interface Auth {
 
 /**
  * The `StandardApi` object provides core methods available to all extension targets. Access the following properties on the `StandardApi` object to authenticate users, query the [GraphQL Admin API](/docs/api/admin-graphql), translate content, handle intents, and persist data.
+ * @publicDocs
  */
 export interface StandardApi<ExtensionTarget extends AnyExtensionTarget> {
   /**

package/src/surfaces/admin/components/AdminAction.d.ts

@@ -9,6 +9,8 @@ import type {ComponentChildren, AdminActionProps$1} from './shared.d.ts';
 
 /**
  * The properties for the admin action component. These properties configure the heading and loading state of the admin action extension interface.
+ *
+ * @publicDocs
  */
 export interface AdminActionProps
   extends Pick<AdminActionProps$1, 'heading' | 'loading'> {}

package/src/surfaces/admin/components/AdminBlock.d.ts

@@ -9,6 +9,8 @@ import type {AdminBlockProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the admin block component. These properties configure the heading and collapsed summary of collapsible content blocks in the admin interface.
+ *
+ * @publicDocs
  */
 export interface AdminBlockProps
   extends Pick<AdminBlockProps$1, 'heading' | 'collapsedSummary'> {}

package/src/surfaces/admin/components/AdminPrintAction.d.ts

@@ -9,6 +9,8 @@ import type {AdminPrintActionProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the admin print action component. These properties configure the source URL for printing content within admin extensions.
+ *
+ * @publicDocs
  */
 export interface AdminPrintActionProps
   extends Pick<AdminPrintActionProps$1, 'src'> {}

package/src/surfaces/admin/components/Badge.d.ts

@@ -61,6 +61,8 @@ export interface IconProps
 
 /**
  * The properties for the badge component. Badges display status information through compact visual indicators with customizable tones, sizes, and optional icons.
+ *
+ * @publicDocs
  */
 export interface BadgeProps
   extends Pick<BadgeProps$1, 'color' | 'icon' | 'size' | 'tone'> {

package/src/surfaces/admin/components/Banner.d.ts

@@ -59,6 +59,8 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 export type RequiredBannerProps = Required<BannerProps$1>;
 /**
  * The properties for the banner component. These properties define an important message or notification with visual styling that conveys its semantic meaning.
+ *
+ * @publicDocs
  */
 export interface BannerProps
   extends Pick<

package/src/surfaces/admin/components/Box.d.ts

@@ -79,6 +79,8 @@ export type ResponsiveBoxProps = MakeResponsivePick<
 >;
 /**
  * The properties for the box component. A box provides control over layout, spacing, sizing, borders, and background styling for its content.
+ *
+ * @publicDocs
  */
 export interface BoxProps
   extends Pick<

package/src/surfaces/admin/components/Button.d.ts

@@ -138,6 +138,8 @@ export type ButtonBaseProps = Required<
 >;
 /**
  * The properties for the button component. Buttons trigger actions or navigation when clicked, with customizable visual styles, states, and optional icons.
+ *
+ * @publicDocs
  */
 export interface ButtonProps extends ButtonBaseProps {
   /**

package/src/surfaces/admin/components/Checkbox.d.ts

@@ -255,6 +255,8 @@ declare class PreactCheckboxElement
 
 /**
  * Properties for rendering a checkbox that supports checked, unchecked, and indeterminate states for complex selection scenarios.
+ *
+ * @publicDocs
  */
 export interface CheckboxProps extends PreactCheckboxProps {
   /**

package/src/surfaces/admin/components/ChoiceList.d.ts

@@ -48,6 +48,8 @@ export interface PreactBaseElementPropsWithChildren<TClass extends HTMLElement>
 
 /**
  * Properties for rendering a list of choices that lets users select one or more options using radio buttons or checkboxes.
+ *
+ * @publicDocs
  */
 export interface ChoiceListProps
   extends Required<

package/src/surfaces/admin/components/ColorPicker.d.ts

@@ -48,6 +48,8 @@ export interface PreactBaseElementProps<TClass extends HTMLElement> {
 
 /**
  * Properties for rendering a color picker that provides a visual interface for selecting colors with optional transparency control.
+ *
+ * @publicDocs
  */
 export interface ColorPickerProps
   extends Required<

package/src/surfaces/admin/components/DateField.d.ts

@@ -309,6 +309,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the date field component. These properties configure an input field that allows merchants to select dates using an integrated calendar picker with optional text input, date constraints, and day-of-week restrictions.
+ *
+ * @publicDocs
  */
 export interface DateFieldProps
   extends Omit<

package/src/surfaces/admin/components/DatePicker.d.ts

@@ -10,6 +10,8 @@ import type {DatePickerProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the date picker component. These properties configure a standalone calendar interface for selecting single dates or date ranges, with support for date constraints, day-of-week restrictions, and month/year navigation.
+ *
+ * @publicDocs
  */
 export interface DatePickerProps
   extends Required<

package/src/surfaces/admin/components/Divider.d.ts

@@ -10,6 +10,8 @@ import type {DividerProps$1, ComponentChildren} from './shared.d.ts';
 
 /**
  * The properties for the divider component. A divider creates a visual separator to distinguish different sections of content.
+ *
+ * @publicDocs
  */
 export interface DividerProps
   extends Pick<DividerProps$1, 'direction' | 'color'> {

package/src/surfaces/admin/components/EmailField.d.ts

@@ -325,6 +325,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the email field component. These properties configure a specialized text input field for entering email addresses with built-in validation and appropriate keyboard support.
+ *
+ * @publicDocs
  */
 export type EmailFieldProps = PreactFieldProps<
   Required<EmailFieldProps$1>['autocomplete']

package/src/surfaces/admin/components/Form.d.ts

@@ -51,6 +51,8 @@ export type CallbackExtendableEventListener<
 
 /**
  * The properties for the form component. These properties configure the form's identifier for targeting and referencing within the admin extension.
+ *
+ * @publicDocs
  */
 export interface FormProps extends Pick<FormProps$1, 'id'> {}
 

package/src/surfaces/admin/components/FunctionSettings.d.ts

@@ -70,6 +70,8 @@ export type CallbackExtendableEventListener<
 
 /**
  * The properties for the function settings component. These properties configure the form's identifier for configuring Shopify Function settings in the admin interface.
+ *
+ * @publicDocs
  */
 export interface FunctionSettingsProps
   extends Pick<FunctionSettingsProps$1, 'id'> {}

package/src/surfaces/admin/components/Heading.d.ts

@@ -10,6 +10,8 @@ import type {ComponentChildren, HeadingProps$1} from './shared.d.ts';
 
 /**
  * The properties for the heading component. These properties define hierarchical section titles and headings with appropriate semantic meaning and visual hierarchy.
+ *
+ * @publicDocs
  */
 export interface HeadingProps
   extends Required<

package/src/surfaces/admin/components/Icon.d.ts

@@ -8,9 +8,6 @@
 /// <reference lib="DOM" />
 import type {IconProps$1, IconType, ComponentChildren} from './shared.d.ts';
 
-/**
- * The properties for the icon component. An icon displays a graphical symbol with configurable appearance, color, and semantic meaning.
- */
 export interface IconProps
   extends Pick<
     IconProps$1,

package/src/surfaces/admin/components/Image.d.ts

@@ -328,6 +328,8 @@ export interface BoxProps
 
 /**
  * The properties for the image component. An image displays pictures with configurable sizing, loading behavior, and borders. Properties include `src` for the image URL, `alt` for accessibility text, `aspectRatio` for sizing, `loading` for lazy loading, and border styling options.
+ *
+ * @publicDocs
  */
 export interface ImageProps
   extends Required<

package/src/surfaces/admin/components/Link.d.ts

@@ -62,6 +62,8 @@ export type LinkBaseProps = Required<
 >;
 /**
  * The properties for the link component. These properties define a clickable link that navigates users to different pages or sections with customizable visual styles and semantic meaning.
+ *
+ * @publicDocs
  */
 export interface LinkProps extends LinkBaseProps {
   /**

package/src/surfaces/admin/components/MoneyField.d.ts

@@ -329,6 +329,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 export type RequiredMoneyFieldProps = Required<MoneyFieldProps$1>;
 /**
  * The properties for the money field component. These properties configure a specialized input field for entering monetary amounts with automatic currency formatting, decimal handling, and range validation.
+ *
+ * @publicDocs
  */
 export interface MoneyFieldProps
   extends Omit<PreactFieldProps, 'value'>,

package/src/surfaces/admin/components/NumberField.d.ts

@@ -325,6 +325,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the number field component. These properties configure a specialized input field for entering numeric values with support for validation, formatting, range constraints, and optimized mobile input modes.
+ *
+ * @publicDocs
  */
 export interface NumberFieldProps
   extends Omit<

package/src/surfaces/admin/components/Paragraph.d.ts

@@ -10,6 +10,8 @@ import type {ComponentChildren, ParagraphProps$1} from './shared.d.ts';
 
 /**
  * The properties for the paragraph component. These properties define blocks of text content with consistent spacing and styling for readable body copy.
+ *
+ * @publicDocs
  */
 export interface ParagraphProps
   extends Required<

package/src/surfaces/admin/components/PasswordField.d.ts

@@ -330,6 +330,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the password field component. These properties configure a secure input field that collects sensitive password input from merchants with masked characters.
+ *
+ * @publicDocs
  */
 export type PasswordFieldProps = PreactFieldProps<
   Required<PasswordFieldProps$1>['autocomplete']

package/src/surfaces/admin/components/Section.d.ts

@@ -13,6 +13,8 @@ import type {ComponentChildren, SectionProps$1} from './shared.d.ts';
 export type RequiredSectionProps = Required<SectionProps$1>;
 /**
  * The properties for the section component. A section groups related content together with an optional heading, providing semantic structure and visual separation.
+ *
+ * @publicDocs
  */
 export interface SectionProps
   extends Pick<

package/src/surfaces/admin/components/Select.d.ts

@@ -221,6 +221,8 @@ export interface IconProps
 
 /**
  * Properties for rendering a select dropdown that lets users choose one option from a list with optional icon and label customization.
+ *
+ * @publicDocs
  */
 export interface SelectProps
   extends Omit<PreactInputProps, 'value'>,

package/src/surfaces/admin/components/Text.d.ts

@@ -10,6 +10,8 @@ import type {ComponentChildren, TextProps$1} from './shared.d.ts';
 
 /**
  * The properties for the text component. These properties define inline or small blocks of text content with various visual styles and semantic meanings.
+ *
+ * @publicDocs
  */
 export interface TextProps
   extends Required<

package/src/surfaces/admin/components/TextArea.d.ts

@@ -325,6 +325,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the text area component. These properties configure a multi-line text input field that allows merchants to enter and edit longer text content.
+ *
+ * @publicDocs
  */
 export type TextAreaProps = PreactFieldProps<
   Required<TextAreaProps$1>['autocomplete']

package/src/surfaces/admin/components/TextField.d.ts

@@ -321,6 +321,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the text field component. Extends `PreactFieldProps` with text-specific features like icons, length constraints, and prefix/suffix content.
+ *
+ * @publicDocs
  */
 export type TextFieldProps = PreactFieldProps<
   /** @default 'on' */

package/src/surfaces/admin/components/URLField.d.ts

@@ -330,6 +330,8 @@ declare class PreactFieldElement<Autocomplete extends string = string>
 
 /**
  * The properties for the URL field component. These properties configure an input field that allows merchants to enter and validate web addresses (URLs) with built-in validation.
+ *
+ * @publicDocs
  */
 export type URLFieldProps = PreactFieldProps<
   Required<URLFieldProps$1>['autocomplete']