implement cash drawer api

Author: merkoyep

packages/ui-extensions/docs/surfaces/point-of-sale/reference/apis/cash-drawer-api.doc.ts

@@ -0,0 +1,33 @@
+import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
+import {generateCodeBlock} from '../helpers/generateCodeBlock';
+
+const data: ReferenceEntityTemplateSchema = {
+  name: 'Cash Drawer API',
+  description: `
+The Cash Drawer API is an API exposed to extensions for cash drawer functionality, specifically allowing UI extensions to control cash drawer operations.`,
+  isVisualComponent: false,
+  type: 'APIs',
+  definitions: [
+    {
+      title: 'CashDrawerApi',
+      description: 'Interface for handling cash drawer operations.',
+      type: 'CashDrawerApi',
+    },
+  ],
+  category: 'APIs',
+  related: [],
+  examples: {
+    description: 'Examples of using the Cash Drawer API',
+    examples: [
+      {
+        codeblock: generateCodeBlock(
+          'Cash Drawer API',
+          'cash-drawer-api',
+          'default.example',
+        ),
+      },
+    ],
+  },
+};
+
+export default data;

packages/ui-extensions/docs/surfaces/point-of-sale/reference/examples/cash-drawer-api/default.example.ts

@@ -0,0 +1,20 @@
+import {
+  Tile,
+  extension,
+} from '@shopify/ui-extensions/point-of-sale';
+
+export default extension(
+  'pos.home.tile.render',
+  (root, api) => {
+    const tile = root.createComponent(Tile, {
+      title: 'My app',
+      subtitle: 'Hello world!',
+      enabled: true,
+      onPress: () => {
+        api.cashDrawer.open();
+      },
+    });
+
+    root.append(tile);
+  },
+);

packages/ui-extensions/src/surfaces/point-of-sale/api.ts

@@ -7,6 +7,8 @@ export type {
 
 export type {CartLineItemApi} from './api/cart-line-item-api/cart-line-item-api';
 
+export type {CashDrawerApi} from './api/cash-drawer-api/cash-drawer-api';
+
 export type {ActionApi, ActionApiContent} from './api/action-api/action-api';
 
 export type {StandardApi} from './api/standard/standard-api';

packages/ui-extensions/src/surfaces/point-of-sale/api/cash-drawer-api/cash-drawer-api.ts

@@ -0,0 +1,12 @@
+/**
+ * The Cash Drawer API in POS UI extensions includes select cash drawer functionality.
+ */
+export interface CashDrawerApi {
+  /**
+   * Opens the connected cash drawer.
+   *
+   * @returns Void
+   *
+   */
+  open(): Promise<void>;
+}