@shopify/ui-extensions 2025.10.14 → 2025.10.16

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Switch',
-  description:
-    'The switch component provides a clear way for users to toggle options or settings on and off. Use switch for binary controls that take effect immediately, like enabling features, activating settings, or controlling visibility.' +
-    "\n\nSwitches provide instant visual feedback and are ideal for settings that don't require a save action to apply changes. For selections that require explicit submission, use [checkbox](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/checkbox) instead.",
-  category: 'Web components',
-  subCategory: 'Forms',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table',
-  description:
-    'The table component displays data clearly in rows and columns, helping users view, analyze, and compare structured information. Use table to present datasets, product lists, order details, or any tabular content that benefits from organized rows and columns.' +
-    '\n\nTables automatically adapt to screen size, rendering as lists on small screens and tables on larger ones for optimal readability across devices.',
-  category: 'Web components',
-  subCategory: 'Layout and structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table body',
-  description:
-    'The table body component represents the main content area of a table, containing the data rows. Use table body as a child of table to structure your table data, with each table row within the body representing a single record or entry.' +
-    '\n\nTable body must contain table row components, which in turn contain table cell components for the actual data values.',
-  category: 'Web components',
-  subCategory: 'Structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table cell',
-  description:
-    'The table cell component represents a single data cell within a table row. Use table cell as a child of table row to display individual data values, with each cell corresponding to a column in the table.' +
-    '\n\nTable cell automatically inherits styling and alignment from its parent table structure and supports text content or other inline components.',
-  category: 'Web components',
-  subCategory: 'Structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table header',
-  description:
-    'The table header component represents a single column header within a table header row. Use table header as a child of table header row to define column headings and optionally enable column sorting.' +
-    '\n\nTable header provides semantic meaning for screen readers and can include sorting controls when configured. Each header corresponds to a column in the table body.',
-  category: 'Web components',
-  subCategory: 'Structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table header row',
-  description:
-    'The table header row component represents the header row of a table, containing column headings. Use table header row as the first child of table (before table body) to define the table structure and provide column labels.' +
-    '\n\nTable header row must contain table header components for each column. These headers provide context for the data columns and can support sorting functionality.',
-  category: 'Web components',
-  subCategory: 'Structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Table row',
-  description:
-    'The table row component represents a single row of data within a table body. Use table row as a child of table body to structure individual records or entries in the table.' +
-    '\n\nTable row must contain table cell components, with each cell representing a data value for the corresponding column. The number of cells should match the number of headers in the table.',
-  category: 'Web components',
-  subCategory: 'Structure',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Text',
-  description:
-    'The text component displays inline text with specific visual styles or tones. Use text to emphasize or differentiate words or phrases within paragraphs or other block-level components, applying weight, color, or semantic styling.' +
-    '\n\nText supports multiple visual variants, alignment options, and line clamping for flexible inline typography control. For block-level text content, use [paragraph](/docs/api/{API_NAME}/{API_VERSION}/web-components/typography-and-content/paragraph).',
-  category: 'Web components',
-  subCategory: 'Typography and content',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Text area',
-  description:
-    'The text area component captures multi-line text input. Use it to collect descriptions, notes, comments, or other extended text content.' +
-    '\n\nThe component supports configurable height, character limits, and validation. For single-line text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/text-field).',
-  category: 'Web components',
-  subCategory: 'Forms',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Text field',
-  description:
-    'The text field component captures single-line text input. Use it to collect short, free-form information like names, titles, or identifiers.' +
-    '\n\nThe component supports various input configurations including placeholders, character limits, and validation. For multi-line text entry, use [text area](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/text-area). For specialized input types, use [email field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/email-field), [URL field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/url-field), [password field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/password-field), or [search field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/search-field).',
-  category: 'Web components',
-  subCategory: 'Forms',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Thumbnail',
-  description:
-    'The thumbnail component displays small preview images representing content, products, or media items. Use thumbnail to provide visual identification in lists, tables, or cards where space is constrained and quick recognition is important.' +
-    '\n\nThumbnails support multiple sizes, alt text for accessibility, and fallback states for missing images. For full-size images, use [image](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/image). For user profile images, use [avatar](/docs/api/{API_NAME}/{API_VERSION}/web-components/media-and-visuals/avatar).',
-  category: 'Web components',
-  subCategory: 'Media and visuals',
-  related: [],
-};
-
-export default data;

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

@@ -1,12 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Time',
-  description:
-    'Represents a specific point or duration in time. Use to display dates, times, or durations clearly and consistently. May include a machine-readable `datetime` attribute for improved accessibility and functionality.',
-  category: 'Web components',
-  subCategory: 'Typography and content',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Tooltip',
-  description:
-    'The tooltip component displays helpful information in a small overlay when users hover over or focus on an element. Use tooltip to provide additional context, explain functionality, or clarify terms without cluttering the interface with permanent text.' +
-    '\n\nTooltips support keyboard accessibility, positioning options, and activation on both hover and focus for inclusive interaction patterns.',
-  category: 'Web components',
-  subCategory: 'Overlays',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'URL field',
-  description:
-    'The URL field component collects URLs from users with built-in formatting and validation. Use URL field for website addresses, link destinations, or any URL input to provide URL-specific keyboard layouts and automatic validation.' +
-    '\n\nURL fields support protocol prefixing, validation, and help text to guide users toward entering properly formatted web addresses. For general text input, use [text field](/docs/api/{API_NAME}/{API_VERSION}/web-components/forms/text-field).',
-  category: 'Web components',
-  subCategory: 'Forms',
-  related: [],
-};
-
-export default data;

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

@@ -1,13 +0,0 @@
-import type {SharedReferenceEntityTemplateSchema} from '../docs-type';
-
-const data: SharedReferenceEntityTemplateSchema = {
-  name: 'Unordered list',
-  description:
-    "The unordered list component displays a bulleted list of related items where sequence isn't critical. Use unordered list to present collections of features, options, requirements, or any group of items where order doesn't affect meaning." +
-    '\n\nUnordered lists automatically add bullet points and support nested lists for hierarchical content organization. For sequential items where order is important, use [ordered list](/docs/api/{API_NAME}/{API_VERSION}/web-components/layout-and-structure/ordered-list).',
-  category: 'Web components',
-  subCategory: 'Typography and content',
-  related: [],
-};
-
-export default data;

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

@@ -1,52 +0,0 @@
-export {default as Abbreviation} from './Abbreviation';
-export {default as Badge} from './Badge';
-export {default as Banner} from './Banner';
-export {default as Box} from './Box';
-export {default as Button} from './Button';
-export {default as Checkbox} from './Checkbox';
-export {default as Chip} from './Chip';
-export {default as ChoiceList} from './ChoiceList';
-export {default as Clickable} from './Clickable';
-export {default as ClickableChip} from './ClickableChip';
-export {default as ClipboardItem} from './ClipboardItem';
-export {default as ConsentCheckbox} from './ConsentCheckbox';
-export {default as ConsentPhoneField} from './ConsentPhoneField';
-export {default as DateField} from './DateField';
-export {default as DatePicker} from './DatePicker';
-export {default as Details} from './Details';
-export {default as Divider} from './Divider';
-export {default as DropZone} from './DropZone';
-export {default as EmailField} from './EmailField';
-export {default as Form} from './Form';
-export {default as Grid} from './Grid';
-export {default as Heading} from './Heading';
-export {default as Icon} from './Icon';
-export {default as Image} from './Image';
-export {default as Link} from './Link';
-export {default as ListItem} from './ListItem';
-export {default as MoneyField} from './MoneyField';
-export {default as NumberField} from './NumberField';
-export {default as OrderedList} from './OrderedList';
-export {default as Paragraph} from './Paragraph';
-export {default as PasswordField} from './PasswordField';
-export {default as PaymentIcon} from './PaymentIcon';
-export {default as Popover} from './Popover';
-export {default as PressButton} from './PressButton';
-export {default as Progress} from './Progress';
-export {default as QRCode} from './QRCode';
-export {default as ScrollBox} from './ScrollBox';
-export {default as SearchField} from './SearchField';
-export {default as Section} from './Section';
-export {default as Select} from './Select';
-export {default as SkeletonParagraph} from './SkeletonParagraph';
-export {default as Spinner} from './Spinner';
-export {default as Stack} from './Stack';
-export {default as Summary} from './Summary';
-export {default as Switch} from './Switch';
-export {default as Table} from './Table';
-export {default as Text} from './Text';
-export {default as TextArea} from './TextArea';
-export {default as Time} from './Time';
-export {default as Tooltip} from './Tooltip';
-export {default as UnorderedList} from './UnorderedList';
-export {default as URLField} from './URLField';

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

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

package/src/surfaces/admin/components/Icon/icon-data.json

@@ -1,9 +0,0 @@
-{
-  "iconPreviewData": {
-    "jsxFile": "./templates/icon-renderer/icon-preview.jsx",
-    "icons": "__AUTO_GENERATED_ICONS__",
-    "bodyContent": "<div id=\"app\"></div>",
-    "customStyles": "padding: 0px; margin: 0px; margin-top: 8px; max-width: 584px; overflow: hidden; background: #FFF, border: 1px solid #ccc; border-radius: 8px;",
-    "hashes": "__AUTO_GENERATED_HASHES__"
-  }
-}

package/src/surfaces/admin/components/patterns/index.ab.doc.ts

@@ -1,80 +0,0 @@
-import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
-
-const data: ReferenceEntityTemplateSchema = {
-  name: 'Index',
-  overviewPreviewDescription:
-    'Manage objects efficiently with dynamic table actions.',
-  description: `The index layout lets merchants view and manage all their objects at once in a table format. They can filter, sort and do quick actions on their objects. To prevent tables from becoming visually cluttered, reveal actions only when the row is hovered over or selected
-
-  | Used to | Examples |
-  | --- | --- |
-  | View all objects at once | Products, orders, customers, discounts |
-  | Perform bulk actions | Delete products, pause/activate campaigns |
-
-  ![Preview of the index pattern](/assets/templated-apis-screenshots/admin/patterns/index-example.png)
-
-  This pattern uses \`Badge\`, \`Box\`, \`Button\`, \`Clickable\`, \`Grid\`, \`Heading\`, \`Image\`, \`Link\`, \`Paragraph\`, \`Section\`, \`Stack\`, and \`Table\` components.
-
-  ---
-
-  ## Design guidelines
-  Design your index page so users can organize and take action on resource objects.
-
-  ### Navigation
-
-  * Users must be able to return to the previous page without using the browser button. To achieve this, your app can provide breadcrumbs or a Back button on the page.
-  * Offer users clear and predictable action labels.
-
-  ---
-
-  ### Layout
-
-  * Design your app to be responsive and adapt to different screen sizes and devices. This ensures a seamless user experience across various platforms.
-  * For resource index pages, use a full-width page. This is helpful when users are dealing with lists of data that have many columns.
-
-  ---
-
-  <style>
-          div[class*="CodeBlock-module-CodeBlock_"] {
-        max-height: calc(100vh - 400px) !important;
-    }
-    div[class*="Tabs-module-TabsContent_"] {
-      overflow: auto !important;
-    }
-    div[class*="Screenshot-module-Screenshot_"] {
-      display: none !important;
-    }
-  </style>`,
-  isVisualComponent: true,
-  category: 'Patterns',
-  subCategory: 'Templates',
-  thumbnail: '/assets/templated-apis-screenshots/admin/patterns/index.png',
-  defaultExample: {
-    codeblock: {
-      title: 'Index',
-      tabs: [
-        {
-          title: 'html',
-          code: './examples/index.html',
-          language: 'html',
-        },
-        {
-          title: 'jsx',
-          code: './examples/index.jsx',
-          language: 'preview-jsx',
-        },
-      ],
-    },
-  },
-
-  related: [
-    {
-      name: 'Built for Shopify',
-      subtitle: 'Requirements',
-      url: '/docs/apps/launch/built-for-shopify/requirements',
-      type: 'component',
-    },
-  ],
-};
-
-export default data;

package/src/surfaces/admin/docs-types.ts

@@ -1,45 +0,0 @@
-import type {CSSProperties} from 'react';
-import {
-  ReferenceEntityTemplateSchema,
-  CodeTabType,
-  ExampleType,
-  ExampleSectionSchema,
-  ExampleGroupType,
-} from '@shopify/generate-docs';
-
-// Don't allow all CSS properties to be used in the customStyles property
-type AllowedCSSProperties = Pick<CSSProperties, 'minHeight' | 'minBlockSize'>;
-
-type AdminCodeTabType = CodeTabType & {
-  layout?: string;
-  customStyles?: AllowedCSSProperties;
-};
-
-interface CodeLinkType {
-  name: string;
-  url: string;
-  icon: string;
-}
-
-interface AdminCodeblockType {
-  title: string;
-  tabs: AdminCodeTabType[];
-  links?: CodeLinkType[];
-}
-
-type AdminExampleType = Omit<ExampleType, 'codeblock'> & {
-  codeblock: AdminCodeblockType | AdminCodeblockType[];
-};
-
-type AdminExampleGroupType = Omit<ExampleGroupType, 'examples'> & {
-  examples: AdminExampleType[];
-};
-
-export interface AdminReferenceEntityTemplateSchema
-  extends Omit<ReferenceEntityTemplateSchema, 'defaultExample' | 'examples'> {
-  defaultExample?: AdminExampleType;
-  examples?: Omit<ExampleSectionSchema, 'exampleGroups' | 'examples'> & {
-    exampleGroups?: AdminExampleGroupType[] | null;
-    examples?: AdminExampleType[] | null;
-  };
-}

package/src/surfaces/checkout/helper.docs.ts

@@ -1,166 +0,0 @@
-import type {CodeTabType, ExampleType} from '@shopify/generate-docs';
-
-const examplePath = '../../../../../docs/surfaces/checkout/reference/examples';
-
-type NonEmptyArray<T> = [T, ...T[]];
-type ExtensionExampleLanguage = 'js' | 'jsx';
-type ExtensionCodeTabConfig = Record<
-  ExtensionExampleLanguage,
-  {
-    title: string;
-    fileExtension: 'ts' | 'tsx';
-  }
->;
-const codeExampleTabConfig: ExtensionCodeTabConfig = {
-  js: {
-    title: 'JavaScript',
-    fileExtension: 'ts',
-  },
-  jsx: {
-    title: 'React',
-    fileExtension: 'tsx',
-  },
-};
-
-/**
- * Returns all examples available, specified with a key for reference.
- */
-export function getExamples(
-  languages: NonEmptyArray<ExtensionExampleLanguage>,
-): Record<string, ExampleType> {
-  if (!languages || languages.length === 0) {
-    throw new HelperDocsError(
-      'You must define at least one extension code language context you wish to retrieve the example(s) for.',
-    );
-  }
-  /**
-   * Provides the code tab for the requested languages in "JavaScript" and "React".
-   */
-  function getExtensionCodeTabs(name: string): CodeTabType[] {
-    return languages.map((language) => {
-      return {
-        code: `${examplePath}/${name}.example.${codeExampleTabConfig[language].fileExtension}`,
-        language,
-        title: codeExampleTabConfig[language].title,
-      };
-    });
-  }
-
-  // Add new examples here that can be shared across multiples pages.
-  return {
-    'ui-components/clipboarditem-qrcode': {
-      description:
-        'When displaying a QR code, include an alternative way for the user to get the content',
-      image: 'clipboard-qrcode.png',
-      codeblock: {
-        title: "Copying content of a QR code to the user's clipboard",
-        tabs: getExtensionCodeTabs('ui-components/clipboarditem-qrcode'),
-      },
-    },
-    'ui-components/choicelist-survey': {
-      description: `The base variant’s flexibility allows for the creation of Likert scales using the ChoiceList component. By utilizing layout components, you can easily structure rows and columns for this purpose.`,
-      image: 'choicelist-survey.png',
-      codeblock: {
-        title: 'Custom survey using the base variant',
-        tabs: getExtensionCodeTabs('ui-components/choicelist-survey'),
-      },
-    },
-    'ui-components/choicelist-details': {
-      description: `The ChoiceList’s group variant, combined with the details property, allows for the conditional display of information when needed.`,
-      image: 'choicelist-details.png',
-      codeblock: {
-        title: 'Collecting additional information',
-        tabs: getExtensionCodeTabs('ui-components/choicelist-details'),
-      },
-    },
-    'ui-components/choicelist-time-picking': {
-      description: `The ChoiceList component is great for presenting a concise list of options, particularly when showcasing time ranges due to its ample horizontal space. However, if there’s more than 5 choices, use the [Select](/docs/api/checkout-ui-extensions/components/forms/select) component instead.`,
-      image: 'choicelist-time-picking.png',
-      codeblock: {
-        title: 'Displaying a short list of time choices',
-        tabs: getExtensionCodeTabs('ui-components/choicelist-time-picking'),
-      },
-    },
-    'ui-components/sheet-consent': {
-      description:
-        'The Sheet component can be used to display privacy consent preferences in the Checkout interface. Sheet can be defaulted to open for this use case.\n\n This component requires access to [Customer Privacy API](/docs/api/checkout-ui-extensions/latest/apis/customer-privacy) to be rendered.',
-      codeblock: {
-        title: 'Using Sheet to display consent preferences',
-        tabs: getExtensionCodeTabs('ui-components/sheet-consent'),
-      },
-    },
-    'ui-components/sheet-description-preferences': {
-      description:
-        'In order to save space in the action slot, secondary actions can be placed in the content area.',
-      image: 'sheet-description-preferences.png',
-      codeblock: {
-        title: 'Preferences button is in the description as a link',
-        tabs: getExtensionCodeTabs(
-          'ui-components/sheet-description-preferences',
-        ),
-      },
-    },
-    'ui-components/sheet-layout-content': {
-      description:
-        'The description can take in layout components to allow for different types of content to be structured in specific ways.',
-      image: 'sheet-layout-content.png',
-      codeblock: {
-        title: 'Using layout component in the description ',
-        tabs: getExtensionCodeTabs('ui-components/sheet-layout-content'),
-      },
-    },
-    'ui-components/sheet-icon-button-preferences': {
-      description:
-        'An icon button can be used in the secondary actions area to allow for more space for the primary actions.',
-      image: 'sheet-icon-button-preferences.png',
-      codeblock: {
-        title: 'Icon button used for preferences',
-        tabs: getExtensionCodeTabs(
-          'ui-components/sheet-icon-button-preferences',
-        ),
-      },
-    },
-    'ui-components/qrcode-image': {
-      description:
-        'The QRCode component can display an image in the center. Adding a logo can increase brand trust and set expectations for the action when scanning.',
-      image: 'qrcode-image.png',
-      codeblock: {
-        title: 'With logo',
-        tabs: getExtensionCodeTabs('ui-components/qrcode-image'),
-      },
-    },
-    'ui-components/qrcode-fill-size': {
-      description:
-        'In most cases the default size should work well. If you need a different size, use `fill` to make it grow to the size of its parent container.',
-      image: 'qrcode-fill-size.png',
-      codeblock: {
-        title: 'Fill size',
-        tabs: getExtensionCodeTabs('ui-components/qrcode-fill-size'),
-      },
-    },
-  };
-}
-
-/**
- * Returns a specific `Example` by name, as specified in `getExamples()`.
- * Specify whether you want to include both `js` and `jsx`examples or just one.
- */
-export function getExample(
-  name: string,
-  languages: NonEmptyArray<ExtensionExampleLanguage> = ['js'],
-): ExampleType {
-  const example = getExamples(languages)[name];
-  if (!example) {
-    throw new HelperDocsError(
-      `Could not find a matching example with the name "${name}". Does it exist within the file "docs/reference/helper.docs.ts" in getExamples()?`,
-    );
-  }
-  return example;
-}
-
-class HelperDocsError extends Error {
-  name = 'HelperDocsError';
-}
-
-export const REQUIRES_PROTECTED_CUSTOMER_DATA =
-  'access to [protected customer data](/docs/apps/store/data-protection/protected-customer-data) for some properties.';

package/src/surfaces/point-of-sale/event/data/CartUpdateEventData.ts

@@ -1,13 +0,0 @@
-import {BaseData} from './BaseData';
-import {Cart} from '../../api';
-import {BaseApi} from './BaseApi';
-
-/**
- * The data object provided to cart update extension targets. Contains the current cart state along with device, session, and connectivity information. This data is passed to extensions whenever the cart changes, enabling real-time cart monitoring and cart-based business logic.
- */
-export interface CartUpdateEventData extends BaseData, BaseApi {
-  /**
-   * The complete current `Cart` object containing all cart data including line items with products and quantities, pricing totals (subtotal, tax, grand total), associated customer information, applied discounts, custom properties, and editability state. This represents the cart's state at the moment the extension is triggered, reflecting all recent changes. The cart object is read-only in this context—modifications should be made through the Cart API methods.
-   */
-  cart: Cart;
-}

package/src/surfaces/point-of-sale/event/data/CashTrackingSessionData.ts

@@ -1,44 +0,0 @@
-import {BaseData} from './BaseData';
-import {BaseApi} from './BaseApi';
-
-/**
- * The data object provided to cash tracking session start extension targets. Contains information about a newly opened cash tracking session along with device and session context.
- */
-export interface CashTrackingSessionStartData extends BaseData, BaseApi {
-  /**
-   * The cash tracking session start data containing the session identifier and the time when the session began. Cash tracking sessions represent the period during which a cash drawer is open and being used for transactions, typically corresponding to a staff member's shift.
-   */
-  cashTrackingSessionStart: {
-    /**
-     * The unique numeric identifier for this cash tracking session. This ID distinguishes this session from other cash tracking sessions and can be used for session-specific operations, reporting, or linking transactions to sessions. The ID is assigned when the session opens and remains constant until the session closes.
-     */
-    id: number;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and cash drawer operations began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the staff member's shift or cash handling period. Commonly used for calculating session duration, shift reporting, or determining which transactions belong to which session.
-     */
-    openingTime: string;
-  };
-}
-
-/**
- * The data object provided to cash tracking session complete extension targets. Contains information about a completed cash tracking session including when it opened and closed, along with device and session context.
- */
-export interface CashTrackingSessionCompleteData extends BaseData, BaseApi {
-  /**
-   * The cash tracking session complete data containing the session identifier, opening time, and closing time. This represents the full lifecycle of a cash drawer session from opening to closing.
-   */
-  cashTrackingSessionComplete: {
-    /**
-     * The unique numeric identifier for this cash tracking session. This ID matches the ID from when the session was opened and can be used to correlate session start and end events, retrieve session-specific data, or link all transactions that occurred during this session.
-     */
-    id: number;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was opened and began (for example, `"2024-05-15T09:00:00Z"`). This marks the start of the session and can be compared with `closingTime` to calculate the total session duration or shift length.
-     */
-    openingTime: string;
-    /**
-     * The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp when the cash tracking session was closed and ended (for example, `"2024-05-15T17:30:00Z"`). This marks when the staff member completed their shift, closed out the cash drawer, and finalized the session. The time between `openingTime` and `closingTime` represents the active session duration. Commonly used for shift reporting, calculating hours worked, or determining the timeframe for session-specific transactions.
-     */
-    closingTime: string;
-  };
-}