@shopify/ui-extensions 2025.10.0-rc.3 → 2025.10.0-rc.30

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "@shopify/ui-extensions",
-  "version": "2025.10.0-rc.3",
+  "version": "2025.10.0-rc.30",
   "scripts": {
     "docs:admin": "node ./docs/surfaces/admin/build-docs.mjs",
     "docs:checkout": "bash ./docs/surfaces/checkout/build-docs.sh",
-    "docs:point-of-sale": "bash ./docs/surfaces/point-of-sale/build-docs.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"
   },
   "main": "index.js",
@@ -39,6 +39,12 @@
       ],
       "customer-account/preact": [
         "./build/ts/surfaces/customer-account/preact/index.d.ts"
+      ],
+      "point-of-sale": [
+        "./build/ts/surfaces/point-of-sale.d.ts"
+      ],
+      "pos.*": [
+        "./build/ts/surfaces/point-of-sale/targets/pos.*.d.ts"
       ]
     }
   },
@@ -91,6 +97,21 @@
       "import": "./build/esm/surfaces/customer-account/preact/index.mjs",
       "require": "./build/cjs/surfaces/customer-account/preact/index.js"
     },
+    "./point-of-sale": {
+      "types": "./build/ts/surfaces/point-of-sale.d.ts",
+      "esnext": "./build/esnext/surfaces/point-of-sale.esnext",
+      "import": "./build/esm/surfaces/point-of-sale.mjs",
+      "require": "./build/cjs/surfaces/point-of-sale.js"
+    },
+    "./pos.*": {
+      "default": "./build/ts/surfaces/point-of-sale/targets/pos.*.d.ts"
+    },
+    "./point-of-sale/preact": {
+      "types": "./build/ts/surfaces/point-of-sale/preact.d.ts",
+      "esnext": "./build/esnext/surfaces/point-of-sale/preact.esnext",
+      "import": "./build/esm/surfaces/point-of-sale/preact.mjs",
+      "require": "./build/cjs/surfaces/point-of-sale/preact.js"
+    },
     "./preact": {
       "types": "./build/ts/preact.d.ts",
       "esnext": "./build/esnext/preact.esnext",

package/src/docs/shared/components/Avatar.ts

@@ -0,0 +1,12 @@
+import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Avatar',
+  description:
+    'Show a user’s profile image or initials in a compact, visual element.',
+  category: 'Polaris web components',
+  subCategory: 'Media',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Badge.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Badge',

package/src/docs/shared/components/Banner.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Banner',

package/src/docs/shared/components/ButtonGroup.ts

@@ -0,0 +1,11 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'ButtonGroup',
+  description: 'Displays multiple buttons in a layout.',
+  category: 'Polaris web components',
+  subCategory: 'Actions',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Checkbox.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Checkbox',

package/src/docs/shared/components/Chip.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Chip',
+  description:
+    'Represents a set of user-supplied keywords that help label, organize, and categorize objects. Used to categorize or highlight content attributes. They are often displayed near the content they classify, enhancing discoverability by allowing users to identify items with similar properties.',
+  category: 'Polaris web components',
+  subCategory: 'Titles and text',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Choice.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Choice',

package/src/docs/shared/components/ChoiceList.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'ChoiceList',

package/src/docs/shared/components/Clickable.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Clickable',

package/src/docs/shared/components/ClickableChip.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'ClickableChip',
+  description:
+    'Interactive button used to categorize or highlight content attributes. They are often displayed near the content they classify, enhancing discoverability by allowing users to identify items with similar properties.',
+  category: 'Polaris web components',
+  subCategory: 'Actions',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/ColorField.ts

@@ -0,0 +1,11 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'ColorField',
+  description: 'Allow users to select a color from a color palette.',
+  category: 'Polaris web components',
+  subCategory: 'Forms',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/ColorPicker.ts

@@ -0,0 +1,11 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'ColorPicker',
+  description: 'Allow users to select a color from a color palette.',
+  category: 'Polaris web components',
+  subCategory: 'Forms',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/DatePicker.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'DatePicker',

package/src/docs/shared/components/Divider.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Divider',

package/src/docs/shared/components/EmailField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'EmailField',

package/src/docs/shared/components/Grid.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Grid',

package/src/docs/shared/components/GridItem.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'GridItem',

package/src/docs/shared/components/Map.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Map',
+  description:
+    'Use Map to display a map on a page. This component is useful for displaying a map of a location, such as a store or a customer’s address.',
+  category: 'Polaris web components',
+  subCategory: 'Interactive',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/MapMarker.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'MapMarker',
+  description:
+    'Use MapMarker to display a marker on a map. Use only as a child of `s-map` component.',
+  category: 'Polaris web components',
+  subCategory: 'Interactive',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Menu.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Menu',
+  description:
+    'Use Menu to display a list of actions that can be performed on a resource.',
+  category: 'Polaris web components',
+  subCategory: 'Actions',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Modal.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Modal',
+  description:
+    'Use modal to display content in a overlay. This component is useful for creating a distraction-free experience, such as a confirmation dialog or a settings panel.',
+  category: 'Polaris web components',
+  subCategory: 'Overlay',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/MoneyField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'MoneyField',

package/src/docs/shared/components/NumberField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'NumberField',

package/src/docs/shared/components/Option.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Option',
+  description:
+    'Represents a single option within a select component. Use only as a child of `s-select` components.',
+  category: 'Polaris web components',
+  subCategory: 'Forms',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/OptionGroup.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'OptionGroup',
+  description:
+    'Represents a group of options within a select component. Use only as a child of `s-select` components.',
+  category: 'Polaris web components',
+  subCategory: 'Forms',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Paragraph.ts

@@ -3,7 +3,7 @@ import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Paragraph',
   description:
-    'Displays a block of text, and can contain inline elements such as buttons, links, or emphasized text. Use to present standalone blocks of content, as opposed to inline text.',
+    'Displays a block of text and can contain inline elements such as buttons, links, or emphasized text. Use to present standalone blocks of content as opposed to inline text.',
   category: 'Polaris web components',
   subCategory: 'Titles and text',
   related: [],

package/src/docs/shared/components/PasswordField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'PasswordField',

package/src/docs/shared/components/PhoneField.ts

@@ -0,0 +1,11 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'PhoneField',
+  description: 'Use PhoneField to allow users to enter phone numbers.',
+  category: 'Polaris web components',
+  subCategory: 'Forms',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Popover.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Popover',
+  description:
+    'Popover is used to display content in an overlay that can be triggered by a button.',
+  category: 'Polaris web components',
+  subCategory: 'Overlays',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/ProductThumbnail.ts

@@ -0,0 +1,11 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'ProductThumbnail',
+  description: 'Use ProductThumbnail to display a product thumbnail',
+  category: 'Polaris web components',
+  subCategory: 'Media',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/QueryContainer.ts

@@ -0,0 +1,12 @@
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'QueryContainer',
+  description:
+    'Establishes a query container for responsive design. Use `s-query-container` to define an element as a containment context, enabling child components or styles to adapt based on the container’s size.',
+  category: 'Polaris web components',
+  subCategory: 'Structure',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/SearchField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'SearchField',

package/src/docs/shared/components/Section.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Section',

package/src/docs/shared/components/Select.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Select',

package/src/docs/shared/components/Switch.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Switch',

package/src/docs/shared/components/Table.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'Table',

package/src/docs/shared/components/TableBody.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TableBody',

package/src/docs/shared/components/TableCell.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TableCell',

package/src/docs/shared/components/TableHeader.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TableHeader',

package/src/docs/shared/components/TableHeaderRow.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TableHeaderRow',

package/src/docs/shared/components/TableRow.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TableRow',

package/src/docs/shared/components/TextArea.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'TextArea',

package/src/docs/shared/components/Thumbnail.ts

@@ -0,0 +1,12 @@
+import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Thumbnail',
+  description:
+    'Display a small preview image representing content, products, or media.',
+  category: 'Polaris web components',
+  subCategory: 'Media',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/Tooltip.ts

@@ -0,0 +1,12 @@
+import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+
+const data: SharedReferenceEntityTemplateSchema = {
+  name: 'Tooltip',
+  description:
+    'Floating labels that briefly explain the function of a user interface element. They can be triggered when merchants hover or focus.',
+  category: 'Polaris web components',
+  subCategory: 'Overlays',
+  related: [],
+};
+
+export default data;

package/src/docs/shared/components/URLField.ts

@@ -1,4 +1,4 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
+import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
 
 const data: SharedReferenceEntityTemplateSchema = {
   name: 'URLField',

package/src/docs/shared/docs-type.ts

@@ -1,6 +1,7 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
+import type {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 
-export type SharedReferenceEntityTemplateSchema = Pick<
-  ReferenceEntityTemplateSchema,
-  'name' | 'description' | 'category' | 'subCategory' | 'related'
->;
+export interface SharedReferenceEntityTemplateSchema
+  extends Pick<
+    ReferenceEntityTemplateSchema,
+    'name' | 'description' | 'category' | 'subCategory' | 'related'
+  > {}

package/src/shared.ts

@@ -937,3 +937,28 @@ export interface GraphQLError {
     code: string;
   };
 }
+
+/**
+ * Represents a read-only value managed on the main thread that an extension can subscribe to.
+ *
+ * Example: Checkout uses this to manage the state of an object and
+ * communicate state changes to extensions running in a sandboxed web worker.
+ *
+ * This interface is compatible with Preact's ReadonlySignal:
+ * https://github.com/preactjs/signals/blob/a023a132a81bd4ba4a0bebb8cbbeffbd8c8bbafc/packages/core/src/index.ts#L700-L709
+ */
+export interface ReadonlySignalLike<T> {
+  readonly value: T;
+  subscribe(fn: (value: T) => void): () => void;
+}
+
+/**
+ * A remote-subscribable object exposed to a sandboxed web worker.
+ *
+ * Example: extensions use this to get updates about an object
+ * managed by Checkout on the main thread.
+ */
+export interface StatefulRemoteSubscribable<T> extends ReadonlySignalLike<T> {
+  readonly current: T;
+  destroy(): Promise<void>;
+}

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

@@ -1,5 +1,6 @@
 import type {I18n} from '../../../../api';
 import {ApiVersion} from '../../../../shared';
+import type {Storage} from './storage';
 import type {ExtensionTarget as AnyExtensionTarget} from '../../extension-targets';
 
 export interface Intents {
@@ -50,10 +51,15 @@ export interface StandardApi<ExtensionTarget extends AnyExtensionTarget> {
   i18n: I18n;
 
   /**
-   * Provides information to the receiver the of an intent.
+   * Provides information to the receiver of an intent.
    */
   intents: Intents;
 
+  /**
+   * Provides methods for setting, getting, and clearing browser data from the extension
+   */
+  storage: Storage;
+
   /**
    * Used to query the Admin GraphQL API
    */