Fix docs generation to support PWC

packages/ui-extensions/docs/surfaces/point-of-sale/build-docs.sh

@@ -1,6 +1,9 @@
+#!/bin/bash
+
 API_VERSION=$1
 DOCS_PATH=docs/surfaces/point-of-sale
 SRC_PATH=src/surfaces/point-of-sale
+COMPONENTS_DIR=src/surfaces/point-of-sale/components
 SHOPIFY_DEV_PATH="../../../shopify-dev"
 
 fail_and_exit() {
@@ -29,7 +32,23 @@ else
   echo "If you need to update the 'unstable' version, run this command again without the '$API_VERSION' parameter."
 fi
 
-COMPILE_DOCS="yarn tsc --project $DOCS_PATH/tsconfig.docs.json --types react --moduleResolution node  --target esNext  --module CommonJS && yarn generate-docs --overridePath ./$DOCS_PATH/typeOverride.json --input ./$DOCS_PATH/reference ./$SRC_PATH --typesInput ./$SRC_PATH ../ui-extensions-react/$SRC_PATH --output ./$DOCS_PATH/generated"
+# Copy all .d.ts files in components directory to .ts files so they can be picked up by the generate-docs tool
+echo "Copying .d.ts files to temporary .ts files..."
+TEMP_FILES=()
+for dts_file in $COMPONENTS_DIR/*.d.ts; do
+  if [[ -f "$dts_file" ]]; then
+    # Skip shared.d.ts
+    if [[ "$dts_file" == *"shared.d.ts" ]]; then
+      continue
+    fi
+    # Convert .d.ts to .ts (e.g., Badge.d.ts -> Badge.ts)
+    temp_file="${dts_file%.d.ts}.ts"
+    cp "$dts_file" "$temp_file"
+    TEMP_FILES+=("$temp_file")
+  fi
+done
+
+COMPILE_DOCS="yarn tsc --project $DOCS_PATH/tsconfig.docs.json --types react --moduleResolution node  --target esNext  --module CommonJS && yarn generate-docs --overridePath ./$DOCS_PATH/typeOverride.json --input ./$DOCS_PATH/reference ./$SRC_PATH --typesInput ./$SRC_PATH --output ./$DOCS_PATH/generated"
 COMPILE_STATIC_PAGES="yarn tsc $DOCS_PATH/staticPages/pages/*.doc.ts --types react --moduleResolution node  --target esNext  --module CommonJS && yarn generate-docs --isLandingPage --input ./$DOCS_PATH/staticPages --output ./$DOCS_PATH/generated"
 
 eval $COMPILE_DOCS && eval $COMPILE_STATIC_PAGES
@@ -40,6 +59,14 @@ find ./ -name '*.doc*.js' -exec rm -r {} \;
 find ./ -wholename '*/point-of-sale/reference/helpers/*.js' -exec rm -r {} \;
 find ./ -wholename '*/point-of-sale/reference/types/*.js' -exec rm -r {} \;
 
+# Remove all temporary .ts files that were created from .d.ts files
+echo "Removing temporary .ts files..."
+for temp_file in "${TEMP_FILES[@]}"; do
+  if [ -f "$temp_file" ]; then
+    rm -f "$temp_file"
+  fi
+done
+
 if [ $build_exit -ne 0 ]; then
   fail_and_exit $build_exit
 fi

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

@@ -1,6 +1,6 @@
 import {ReferenceEntityTemplateSchema} from '@shopify/generate-docs';
 import {generateCodeBlock} from '../helpers/generateCodeBlock';
-import {ExtensionTargetType, TargetLink} from '../types/ExtensionTargetType';
+import {TargetLink} from '../types/ExtensionTargetType';
 
 const generateCodeBlockForActionApi = (title: string, fileName: string) =>
   generateCodeBlock(title, 'action-api', fileName);
@@ -36,12 +36,6 @@ The Action API allows an action extension to modally present its corresponding m
   examples: {
     description: 'Examples of using the Action API.',
     examples: [
-      {
-        codeblock: generateCodeBlockForActionApi(
-          'Present a modal from post purchase.',
-          'present-modal',
-        ),
-      },
       {
         codeblock: generateCodeBlockForActionApi(
           'Present a modal from smart grid.',

packages/ui-extensions/docs/surfaces/point-of-sale/reference/components/TextField.doc.ts

@@ -12,7 +12,7 @@ const data: ReferenceEntityTemplateSchema = {
       title: 'TextField',
       description:
         'Use a text field to allow merchants to input or modify multiline text.',
-      type: 'NewTextFieldProps',
+      type: 'TextFieldProps',
     },
   ],
   category: 'Components',

packages/ui-extensions/docs/surfaces/point-of-sale/reference/types/ExtensionTargetType.ts

@@ -4,6 +4,12 @@ export enum ExtensionTargetType {
   PosPurchasePostActionMenuItemRender = 'pos.purchase.post.action.menu-item.render',
   PosPurchasePostActionRender = 'pos.purchase.post.action.render',
   PosPurchasePostBlockRender = 'pos.purchase.post.block.render',
+  PosReturnPostActionMenuItemRender = 'pos.return.post.action.menu-item.render',
+  PosReturnPostActionRender = 'pos.return.post.action.render',
+  PosReturnPostBlockRender = 'pos.return.post.block.render',
+  PosExchangePostActionMenuItemRender = 'pos.exchange.post.action.menu-item.render',
+  PosExchangePostActionRender = 'pos.exchange.post.action.render',
+  PosExchangePostBlockRender = 'pos.exchange.post.block.render',
   PosProductDetailsActionMenuItemRender = 'pos.product-details.action.menu-item.render',
   PosProductDetailsActionRender = 'pos.product-details.action.render',
   PosProductDetailsBlockRender = 'pos.product-details.block.render',
@@ -16,6 +22,13 @@ export enum ExtensionTargetType {
   PosDraftOrderDetailsActionMenuItemRender = 'pos.draft-order-details.action.menu-item.render',
   PosDraftOrderDetailsActionRender = 'pos.draft-order-details.action.render',
   PosDraftOrderDetailsBlockRender = 'pos.draft-order-details.block.render',
+  PosTransactionCompleteObserve = 'pos.transaction-complete.event.observe',
+  PosCashTrackingSessionStartObserve = 'pos.cash-tracking-session-start.event.observe',
+  PosCashTrackingSessionCompleteObserve = 'pos.cash-tracking-session-complete.event.observe',
+  PosCartUpdateObserve = 'pos.cart-update.event.observe',
+  PosReceiptFooterBlockRender = 'pos.receipt-footer.block.render',
+  PosCartLineItemDetailsActionMenuItemRender = 'pos.cart.line-item-details.action.menu-item.render',
+  PosCartLineItemDetailsActionRender = 'pos.cart.line-item-details.action.render',
 }
 
 export enum TargetLink {
@@ -24,6 +37,12 @@ export enum TargetLink {
   PosPurchasePostActionMenuItemRender = '[pos.purchase.post.action.menu-item.render](/docs/api/pos-ui-extensions/targets/post-purchase/pos-purchase-post-action-menu-item-render)',
   PosPurchasePostActionRender = '[pos.purchase.post.action.render](/docs/api/pos-ui-extensions/targets/post-purchase/pos-purchase-post-action-render)',
   PosPurchasePostBlockRender = '[pos.purchase.post.block.render](/docs/api/pos-ui-extensions/targets/post-purchase/pos-purchase-post-block-render)',
+  PosReturnPostActionMenuItemRender = '[pos.return.post.action.menu-item.render](/docs/api/pos-ui-extensions/targets/post-return/pos-return-post-action-menu-item-render)',
+  PosReturnPostActionRender = '[pos.return.post.action.render](/docs/api/pos-ui-extensions/targets/post-return/pos-return-post-action-render)',
+  PosReturnPostBlockRender = '[pos.return.post.block.render](/docs/api/pos-ui-extensions/targets/post-return/pos-return-post-block-render)',
+  PosExchangePostActionMenuItemRender = '[pos.exchange.post.action.menu-item.render](/docs/api/pos-ui-extensions/targets/post-exchange/pos-exchange-post-action-menu-item-render)',
+  PosExchangePostActionRender = '[pos.exchange.post.action.render](/docs/api/pos-ui-extensions/targets/post-exchange/pos-exchange-post-action-render)',
+  PosExchangePostBlockRender = '[pos.exchange.post.block.render](/docs/api/pos-ui-extensions/targets/post-exchange/pos-exchange-post-block-render)',
   PosProductDetailsActionMenuItemRender = '[pos.product-details.action.menu-item.render](/docs/api/pos-ui-extensions/targets/product-details/pos-product-details-action-menu-item-render)',
   PosProductDetailsActionRender = '[pos.product-details.action.render](/docs/api/pos-ui-extensions/targets/product-details/pos-product-details-action-render)',
   PosProductDetailsBlockRender = '[pos.product-details.block.render](/docs/api/pos-ui-extensions/targets/product-details/pos-product-details-block-render)',
@@ -35,5 +54,12 @@ export enum TargetLink {
   PosCustomerDetailsBlockRender = '[pos.customer-details.block.render](/docs/api/pos-ui-extensions/targets/customer-details/pos-customer-details-block-render)',
   PosDraftOrderDetailsActionMenuItemRender = '[pos.draft-order-details.action.menu-item.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-menu-item-render)',
   PosDraftOrderDetailsActionRender = '[pos.draft-order-details.action.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-action-render)',
-  PosDraftOrderDetailsBlockRender = '[pos.draft-order-details.action.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render)',
+  PosDraftOrderDetailsBlockRender = '[pos.draft-order-details.block.render](/docs/api/pos-ui-extensions/targets/draft-order-details/pos-draft-order-details-block-render)',
+  PosTransactionCompleteObserve = '[pos.transaction-complete.event.observe](/docs/api/pos-ui-extensions/targets/post-transaction/pos-transaction-complete-event-observe)',
+  PosCashTrackingSessionStartObserve = '[pos.cash-tracking-session-start.event.observe](/docs/api/pos-ui-extensions/targets/cash-tracking/pos-cash-tracking-session-start-event-observe)',
+  PosCashTrackingSessionCompleteObserve = '[pos.cash-tracking-session-complete.event.observe](/docs/api/pos-ui-extensions/targets/cash-tracking/pos-cash-tracking-session-complete-event-observe)',
+  PosCartUpdateObserve = '[pos.cart-update.event.observe](/docs/api/pos-ui-extensions/targets/cart-details/pos-cart-update-event-observe)',
+  PosReceiptFooterBlockRender = '[pos.receipt-footer.block.render](/docs/api/pos-ui-extensions/targets/receipts/pos-receipt-footer-block-render)',
+  PosCartLineItemDetailsActionMenuItemRender = '[pos.cart.line-item-details.action.menu-item.render](/docs/api/pos-ui-extensions/targets/cart-details/pos-cart-line-item-details-action-menu-item-render)',
+  PosCartLineItemDetailsActionRender = '[pos.cart.line-item-details.action.render](/docs/api/pos-ui-extensions/targets/cart-details/pos-cart-line-item-details-action-render)',
 }