@shopify/ui-extensions 2025.10.0-rc.9 → 2025.10.1

package/src/surfaces/point-of-sale/types/country-code.ts

@@ -0,0 +1,249 @@
+/* eslint @shopify/typescript/prefer-pascal-case-enums: off */
+
+export enum CountryCode {
+  AF = 'AF',
+  AX = 'AX',
+  AL = 'AL',
+  DZ = 'DZ',
+  AD = 'AD',
+  AO = 'AO',
+  AI = 'AI',
+  AG = 'AG',
+  AR = 'AR',
+  AM = 'AM',
+  AW = 'AW',
+  AC = 'AC',
+  AU = 'AU',
+  AT = 'AT',
+  AZ = 'AZ',
+  BS = 'BS',
+  BH = 'BH',
+  BD = 'BD',
+  BB = 'BB',
+  BY = 'BY',
+  BE = 'BE',
+  BZ = 'BZ',
+  BJ = 'BJ',
+  BM = 'BM',
+  BT = 'BT',
+  BO = 'BO',
+  BA = 'BA',
+  BW = 'BW',
+  BV = 'BV',
+  BR = 'BR',
+  IO = 'IO',
+  BN = 'BN',
+  BG = 'BG',
+  BF = 'BF',
+  BI = 'BI',
+  KH = 'KH',
+  CA = 'CA',
+  CV = 'CV',
+  BQ = 'BQ',
+  KY = 'KY',
+  CF = 'CF',
+  TD = 'TD',
+  CL = 'CL',
+  CN = 'CN',
+  CX = 'CX',
+  CC = 'CC',
+  CO = 'CO',
+  KM = 'KM',
+  CG = 'CG',
+  CD = 'CD',
+  CK = 'CK',
+  CR = 'CR',
+  HR = 'HR',
+  CU = 'CU',
+  CW = 'CW',
+  CY = 'CY',
+  CZ = 'CZ',
+  CI = 'CI',
+  DK = 'DK',
+  DJ = 'DJ',
+  DM = 'DM',
+  DO = 'DO',
+  EC = 'EC',
+  EG = 'EG',
+  SV = 'SV',
+  GQ = 'GQ',
+  ER = 'ER',
+  EE = 'EE',
+  SZ = 'SZ',
+  ET = 'ET',
+  FK = 'FK',
+  FO = 'FO',
+  FJ = 'FJ',
+  FI = 'FI',
+  FR = 'FR',
+  GF = 'GF',
+  PF = 'PF',
+  TF = 'TF',
+  GA = 'GA',
+  GM = 'GM',
+  GE = 'GE',
+  DE = 'DE',
+  GH = 'GH',
+  GI = 'GI',
+  GR = 'GR',
+  GL = 'GL',
+  GD = 'GD',
+  GP = 'GP',
+  GT = 'GT',
+  GG = 'GG',
+  GN = 'GN',
+  GW = 'GW',
+  GY = 'GY',
+  HT = 'HT',
+  HM = 'HM',
+  VA = 'VA',
+  HN = 'HN',
+  HK = 'HK',
+  HU = 'HU',
+  IS = 'IS',
+  IN = 'IN',
+  ID = 'ID',
+  IR = 'IR',
+  IQ = 'IQ',
+  IE = 'IE',
+  IM = 'IM',
+  IL = 'IL',
+  IT = 'IT',
+  JM = 'JM',
+  JP = 'JP',
+  JE = 'JE',
+  JO = 'JO',
+  KZ = 'KZ',
+  KE = 'KE',
+  KI = 'KI',
+  KP = 'KP',
+  XK = 'XK',
+  KW = 'KW',
+  KG = 'KG',
+  LA = 'LA',
+  LV = 'LV',
+  LB = 'LB',
+  LS = 'LS',
+  LR = 'LR',
+  LY = 'LY',
+  LI = 'LI',
+  LT = 'LT',
+  LU = 'LU',
+  MO = 'MO',
+  MG = 'MG',
+  MW = 'MW',
+  MY = 'MY',
+  MV = 'MV',
+  ML = 'ML',
+  MT = 'MT',
+  MQ = 'MQ',
+  MR = 'MR',
+  MU = 'MU',
+  YT = 'YT',
+  MX = 'MX',
+  MD = 'MD',
+  MC = 'MC',
+  MN = 'MN',
+  ME = 'ME',
+  MS = 'MS',
+  MA = 'MA',
+  MZ = 'MZ',
+  MM = 'MM',
+  NA = 'NA',
+  NR = 'NR',
+  NP = 'NP',
+  NL = 'NL',
+  AN = 'AN',
+  NC = 'NC',
+  NZ = 'NZ',
+  NI = 'NI',
+  NE = 'NE',
+  NG = 'NG',
+  NU = 'NU',
+  NF = 'NF',
+  MK = 'MK',
+  NO = 'NO',
+  OM = 'OM',
+  PK = 'PK',
+  PS = 'PS',
+  PA = 'PA',
+  PG = 'PG',
+  PY = 'PY',
+  PE = 'PE',
+  PH = 'PH',
+  PN = 'PN',
+  PL = 'PL',
+  PT = 'PT',
+  QA = 'QA',
+  CM = 'CM',
+  RE = 'RE',
+  RO = 'RO',
+  RU = 'RU',
+  RW = 'RW',
+  BL = 'BL',
+  SH = 'SH',
+  KN = 'KN',
+  LC = 'LC',
+  MF = 'MF',
+  PM = 'PM',
+  WS = 'WS',
+  SM = 'SM',
+  ST = 'ST',
+  SA = 'SA',
+  SN = 'SN',
+  RS = 'RS',
+  SC = 'SC',
+  SL = 'SL',
+  SG = 'SG',
+  SX = 'SX',
+  SK = 'SK',
+  SI = 'SI',
+  SB = 'SB',
+  SO = 'SO',
+  ZA = 'ZA',
+  GS = 'GS',
+  KR = 'KR',
+  SS = 'SS',
+  ES = 'ES',
+  LK = 'LK',
+  VC = 'VC',
+  SD = 'SD',
+  SR = 'SR',
+  SJ = 'SJ',
+  SE = 'SE',
+  CH = 'CH',
+  SY = 'SY',
+  TW = 'TW',
+  TJ = 'TJ',
+  TZ = 'TZ',
+  TH = 'TH',
+  TL = 'TL',
+  TG = 'TG',
+  TK = 'TK',
+  TO = 'TO',
+  TT = 'TT',
+  TA = 'TA',
+  TN = 'TN',
+  TR = 'TR',
+  TM = 'TM',
+  TC = 'TC',
+  TV = 'TV',
+  UG = 'UG',
+  UA = 'UA',
+  AE = 'AE',
+  GB = 'GB',
+  US = 'US',
+  UM = 'UM',
+  UY = 'UY',
+  UZ = 'UZ',
+  VU = 'VU',
+  VE = 'VE',
+  VN = 'VN',
+  VG = 'VG',
+  WF = 'WF',
+  EH = 'EH',
+  YE = 'YE',
+  ZM = 'ZM',
+  ZW = 'ZW',
+  ZZ = 'ZZ',
+}

package/src/surfaces/point-of-sale/types/device.ts

@@ -0,0 +1,14 @@
+export interface Device {
+  /**
+   * The name of the device
+   */
+  name: string;
+  /**
+   * The ID of the device
+   */
+  deviceId: number;
+  /**
+   * Whether the device is a tablet
+   */
+  isTablet: boolean;
+}

package/src/surfaces/point-of-sale/types/direct-api-request-body.ts

@@ -0,0 +1,13 @@
+/**
+ * Interface representing the structure of a direct API request body for GraphQL operations.
+ */
+export interface DirectApiRequestBody {
+  /**
+   * The GraphQL query or mutation string to be executed.
+   */
+  query: string;
+  /**
+   * Optional variables to be passed along with the GraphQL query.
+   */
+  variables?: Record<string, any>;
+}

package/src/surfaces/point-of-sale/types/discount-allocation.ts

@@ -0,0 +1,5 @@
+import type {MoneyV2} from './money';
+
+export interface DiscountAllocation {
+  allocatedAmount: MoneyV2;
+}

package/src/surfaces/point-of-sale/types/money.ts

@@ -0,0 +1,9 @@
+export interface Money {
+  amount: number;
+  currency: string;
+}
+
+export interface MoneyV2 {
+  amount: string;
+  currencyCode: string;
+}

package/src/surfaces/point-of-sale/types/multiple-resource-result.ts

@@ -0,0 +1,14 @@
+/**
+ * The result of a fetch function where the input is multiple IDs.
+ * This object contains the resources that were found, as well as an array of IDs specifying which IDs, if any, did not correspond to a resource.
+ */
+export interface MultipleResourceResult<T> {
+  /**
+   * The resources that were fetched using the IDs provided.
+   */
+  fetchedResources: T[];
+  /**
+   * The IDs for which a resource was not found.
+   */
+  idsForResourcesNotFound: number[];
+}

package/src/surfaces/point-of-sale/types/order.ts

@@ -0,0 +1,12 @@
+import {LineItem} from './cart';
+
+export interface LineItemRefund {
+  createdAt: string;
+  quantity: number;
+}
+
+export interface OrderLineItem extends LineItem {
+  // Number of remaining goods
+  currentQuantity: number;
+  refunds?: LineItemRefund[];
+}

package/src/surfaces/point-of-sale/types/paginated-result.ts

@@ -0,0 +1,20 @@
+/**
+ * Contains a page of fetched results.
+ */
+export interface PaginatedResult<T> {
+  /**
+   * The items returned from the fetch.
+   */
+  items: T[];
+
+  /**
+   * The cursor of the last item. This can be used to fetch more results.
+   * The format of this cursor may look different depending on if POS is fetching results from the remote API, or its local database. However, that should not affect its usage with the search functions.
+   */
+  lastCursor?: string;
+
+  /**
+   * Whether or not there is another page of results that can be fetched.
+   */
+  hasNextPage: boolean;
+}

package/src/surfaces/point-of-sale/types/payment.ts

@@ -0,0 +1,16 @@
+export type PaymentMethod =
+  | 'Cash'
+  | 'Custom'
+  | 'CreditCard'
+  | 'CardPresentRefund'
+  | 'StripeCardPresentRefund'
+  | 'GiftCard'
+  | 'StripeCreditCard'
+  | 'ShopPay'
+  | 'StoreCredit'
+  | 'Unknown';
+export interface Payment {
+  amount: number;
+  currency: string;
+  type: PaymentMethod;
+}

package/src/surfaces/point-of-sale/types/pin-pad.ts

@@ -0,0 +1,64 @@
+export interface PinPadResult {
+  /**
+   * Whether the PIN entry was completed (not cancelled)
+   */
+  completed: boolean;
+  /**
+   * The entered PIN (only present if completed is true)
+   */
+  pin?: number[];
+}
+
+/**
+ * Represents the result of the pin pad onSubmit function.
+ * @typedef {{result: 'accept'} | {result: 'reject'; errorMessage?: string}} PinValidationResult
+ */
+export type PinValidationResult =
+  | {result: 'accept'}
+  | {result: 'reject'; errorMessage?: string};
+
+export type PinLength = 4 | 5 | 6 | 7 | 8 | 9 | 10;
+
+export interface PinPadActionType {
+  label: string;
+  onClick: () => Promise<number[]> | number[];
+}
+
+export interface PinPadOptions {
+  /**
+   * The function to be called when a pin is entered
+   */
+  onPinEntry?: (pin: number[]) => void;
+  /**
+   * The function to be called when the pin pad modal is dismissed
+   */
+  onDismissed?: (result: PinPadResult) => void;
+  /**
+   * The content for the prompt on the pin pad
+   */
+  label?: string;
+  /**
+   * Whether the entered PIN should be masked
+   */
+  masked?: boolean;
+  /**
+   * The minimum length of the PIN
+   */
+  minPinLength?: PinLength;
+  /**
+   * The maximum length of the PIN
+   */
+  maxPinLength?: PinLength;
+  /**
+   * The call to action between the entry view and the keypad
+   */
+  pinPadAction?: PinPadActionType;
+  /**
+   * Title shown in the modal header
+   */
+  title?: string;
+  /**
+   * Whether the pin should be automatically submitted when the user has entered the maximum PIN length
+   */
+  autoSubmit?: boolean;
+}

package/src/surfaces/point-of-sale/types/product.ts

@@ -0,0 +1,64 @@
+export interface Product {
+  id: number;
+  createdAt: string;
+  updatedAt: string;
+  title: string;
+  description: string;
+  descriptionHtml: string;
+  featuredImage?: string;
+  isGiftCard: boolean;
+  tracksInventory: boolean;
+  vendor: string;
+  minVariantPrice: string;
+  maxVariantPrice: string;
+  productType: string;
+  productCategory: string;
+  tags: string[];
+  numVariants: number;
+  totalAvailableInventory?: number;
+  totalInventory: number;
+  variants: ProductVariant[];
+  options: ProductOption[];
+  hasOnlyDefaultVariant: boolean;
+  hasInStockVariants?: boolean;
+  onlineStoreUrl?: string;
+  requiresSellingPlan?: boolean;
+  hasSellingPlanGroups?: boolean;
+}
+
+export interface ProductVariant {
+  id: number;
+  createdAt: string;
+  updatedAt: string;
+  title: string;
+  price: string;
+  compareAtPrice?: string;
+  taxable: boolean;
+  sku?: string;
+  barcode?: string;
+  displayName: string;
+  image?: string;
+  inventoryIsTracked: boolean;
+  inventoryAtLocation?: number;
+  inventoryAtAllLocations?: number;
+  inventoryPolicy: ProductVariantInventoryPolicy;
+  hasInStockVariants?: boolean;
+  options?: ProductVariantOption[];
+  product?: Product;
+  productId: number;
+  position: number;
+}
+
+export interface ProductVariantOption {
+  name: string;
+  value: string;
+}
+
+export type ProductVariantInventoryPolicy = 'DENY' | 'CONTINUE';
+
+export interface ProductOption {
+  id: number;
+  name: string;
+  optionValues: string[];
+  productId: number;
+}

package/src/surfaces/point-of-sale/types/session.ts

@@ -0,0 +1,39 @@
+import type {CurrencyCode} from '../../../shared';
+
+export interface Session {
+  /**
+   * The shop ID associated with the shop currently logged into POS.
+   */
+  shopId: number;
+
+  /**
+   * The user ID associated with the Shopify account currently authenticated on POS.
+   */
+  userId: number;
+
+  /**
+   * The shop domain associated with the shop currently logged into POS.
+   */
+  shopDomain: string;
+
+  /**
+   * The location ID associated with the POS' current location.
+   */
+  locationId: number;
+
+  /**
+   * The staff ID who is currently pinned into the POS.
+   * Note that this staff member ID may be different to the User ID, as the staff member who enters their PIN may be different to the User who logged onto POS.
+   */
+  staffMemberId?: number;
+
+  /**
+   * The currency code associated with the location currently in on POS.
+   */
+  currency: CurrencyCode;
+
+  /**
+   * The POS version.
+   */
+  posVersion: string;
+}

package/src/surfaces/point-of-sale/types/shipping-line.ts

@@ -0,0 +1,18 @@
+import type {Money} from './money';
+import type {TaxLine} from './tax-line';
+
+export interface ShippingLine {
+  handle?: string;
+  price: Money;
+  title?: string;
+  taxLines?: TaxLine[];
+}
+
+export interface CalculatedShippingLine extends ShippingLine {
+  type: 'Calculated';
+  methodType: 'SHIPPING' | 'RETAIL';
+}
+
+export interface CustomShippingLine extends ShippingLine {
+  type: 'Custom';
+}

package/src/surfaces/point-of-sale/types/storage.ts

@@ -0,0 +1,73 @@
+export class StorageError extends Error {
+  public name = 'StorageError';
+  constructor(
+    public code: 'RecordsCount' | 'RecordSize' | 'KeyType' | 'KeySize',
+    message: string,
+  ) {
+    super(message);
+  }
+}
+export interface Storage<
+  BaseStorageTypes extends Record<string, any> = Record<string, unknown>,
+> {
+  /**
+   * Sets the value of a key in the storage.
+   *
+   * @param key - The key to set the value for.
+   * @param value - The value to set for the key.
+   * Can be any primitive type supported by `JSON.stringify`.
+   * @throws StorageError when:
+   *    the extension exceeds its allotted storage limit.
+   *    the value exceeds its allotted storage limit.
+   *    the key is not a string or exceeds its allotted size.
+   */
+  set<
+    StorageTypes extends BaseStorageTypes = BaseStorageTypes,
+    Keys extends keyof StorageTypes = keyof StorageTypes,
+  >(
+    key: Keys,
+    value: StorageTypes[Keys],
+  ): Promise<void>;
+
+  /**
+   * Gets the value of a key in the storage.
+   *
+   * @param key - The key to get the value for.
+   * @returns The value of the key.
+   * If no value for the key exists, the resolved value is undefined.
+   * @throws StorageError when the key is not a string or exceeds its allotted size.
+   */
+  get<
+    StorageTypes extends BaseStorageTypes = BaseStorageTypes,
+    Keys extends keyof StorageTypes = keyof StorageTypes,
+  >(
+    key: Keys,
+  ): Promise<StorageTypes[Keys] | undefined>;
+
+  /**
+   * Clears the storage.
+   */
+  clear: () => Promise<void>;
+
+  /**
+   * Deletes a key from the storage.
+   *
+   * @param key - The key to delete.
+   */
+  delete<
+    StorageTypes extends BaseStorageTypes = BaseStorageTypes,
+    Keys extends keyof StorageTypes = keyof StorageTypes,
+  >(
+    key: Keys,
+  ): Promise<boolean>;
+
+  /**
+   * Gets all the keys and values in the storage.
+   *
+   * @returns An array containing all the keys and values in the storage.
+   */
+  entries<
+    StorageTypes extends BaseStorageTypes = BaseStorageTypes,
+    Keys extends keyof StorageTypes = keyof StorageTypes,
+  >(): Promise<[Keys, StorageTypes[Keys]][]>;
+}

package/src/surfaces/point-of-sale/types/tax-line.ts

@@ -0,0 +1,10 @@
+import type {Money} from './money';
+
+export interface TaxLine {
+  title: string;
+  price: Money;
+  rate: number;
+  uuid?: string;
+  rateRange?: {min: number; max: number};
+  enabled?: boolean;
+}

package/src/surfaces/point-of-sale/types/transaction-type.ts

@@ -0,0 +1 @@
+export type TransactionType = 'Sale' | 'Return' | 'Exchange' | 'Reprint';

package/src/surfaces/point-of-sale.ts

@@ -0,0 +1,4 @@
+export * from './point-of-sale/api';
+export * from './point-of-sale/extension-targets';
+export * from './point-of-sale/event/data';
+export * from './point-of-sale/event/output';