Regenerate checkout docs JSON for 2026-01#4459
Open
timtrevor-shopify wants to merge 313 commits into
Open
Conversation
…omponent-category [2026-04] Update checkout component category
Creates placeholder example files for two targets that were missing example directories: - customer-account.order.page.render - customer-account.page.render Full example content will be added in a follow-up PR. Made-with: Cursor
add discount index targets
[2026-04] Generate changeset for checkout metafield removal
…-account-remove-metafield [2026-04] Remove metafield API from customer account
…e-dirs-2026-04-rc Add missing example directories for Customer Account targets
…#4075) * Generate shared component docs for customer account UI extensions Previously, customer account UI extensions only generated docs for 7 surface-specific components (Avatar, ButtonGroup, CustomerAccountAction, ImageGroup, Menu, Page, Section) and linked to checkout for the rest. This adds .doc.ts files for all ~55 shared checkout components so they are generated directly in the customer account reference. Updates the build script to resolve checkout component types, copies examples from checkout, updates the category page, and aligns subcategories across shared content to match the new sidebar IA. Made-with: Cursor Linting sentence case names Name updates and generated docs script optimizations Remove unnecessary file Render visual for clipboard item component Remove category doc Sidebar configuration for 2026-04-rc Fix syntax Generate docs * Regenerate docs
- Add "API" suffix to all API names for consistency - Change category from "APIs" to "Target APIs" - Add subcategories: - Account APIs: authentication, buyer identity, customer privacy, etc. - Order APIs: addresses, cart lines, cost, discounts, order, etc. - Platform APIs: analytics, extension, intents, localization, etc. This aligns with the new navigation experience pattern established for checkout UI extensions. Made-with: Cursor
Revise API names to align with new nav experience (2026-04-rc)
Customer account UI extension: Update API names and categories v2026-04-rc
Fix hardcoded 2025-10-rc component URLs in version upgrade guide (2026-04-rc)
This adds a new `ui-extensions-tester` library, built during [Hack Days](https://vault.shopify.io/hackdays/153/projects/22955-App-Extensions-Test-tool-for-UI-extensions) (internal Shopify link). ## All stacks * 🥞 `ui-extensions-tester` package setup <-- you are here * 🥞 [A complete mock checkout API](https://app.graphite.com/github/pr/Shopify/ui-extensions/3902/Create-mocks-for-the-entire-checkout-extension-API) * 🥞 [A complete mock point-of-sale API](https://app.graphite.com/github/pr/Shopify/ui-extensions/3904/Create-mocks-for-the-entire-point-of-sale-extension-API) * 🥞 [A complete mock customer-account API](https://app.graphite.com/github/pr/Shopify/ui-extensions/3905/Create-mocks-for-the-entire-Customer-Account-extension-API) * 🥞 [A complete mock Admin API](https://app.graphite.com/github/pr/Shopify/ui-extensions/3914/Create-mocks-for-the-entire-Admin-extension-API) ## 👁️ How to review this PR * 📖 Read the [developer-facing documentation](https://github.com/Shopify/ui-extensions/blob/02-11-create_a_testing_library_for_ui-extensions_proof_of_concept_/packages/ui-extensions-tester/README.md) * See one of the stacks above to view surface-specific mocks ## Example Here's what it looks like so far in something like `your-app/extensions/your-ui-extension/tests/Extension.test.ts`: ```tsx import {expect, test, beforeEach, afterEach} from 'vitest'; import {setUpExtension} from '@shopify/ui-extensions-tester'; // This reads from ../shopify.extension.toml const extension = getExtension('purchase.checkout.block.render'); beforeEach(() => { extension.setUp(); }); afterEach(() => { extension.tearDown(); }); test('renders an Enter button', async () => { await extension.render(); const button = extension.querySelector('s-button'); expect(button!.textContent).toEqual('Enter'); }); ``` More complete example: [`checkout-basic-testing-example/tests/Checkout.test.ts`](https://github.com/Shopify/ui-extensions/blob/02-11-create_a_testing_library_for_ui-extensions_proof_of_concept_/examples/testing/checkout-basic-testing-example/extensions/checkout-basic-testing-example/tests/Checkout.test.ts) <hr /> Run it like this after checking out the branch for this PR: ``` yarn build pushd examples/testing/checkout-basic-testing-example npm install npm test ``` # 🎩 To try it in a standalone app, you have to install a pre-built package: [shopify-ui-extensions-tester-v2026.4.0-rc.1.tgz](https://github.com/user-attachments/files/25871729/shopify-ui-extensions-tester-v2026.4.0-rc.1.tgz). This is because `/snapit` doesn't work before there's at least one public release. Add it to a `package.json` file like: ``` "@shopify/ui-extensions-tester": "file:../shopify-ui-extensions-tester-v2026.4.0-rc.1.tgz" ```
Follow up to #3899 that adds a complete, type-safe mock of the checkout extension API ## 👁️ How to review this PR - 📖 Read the main [developer-facing documentation](https://github.com/Shopify/ui-extensions/blob/02-11-create_a_testing_library_for_ui-extensions_proof_of_concept_/packages/ui-extensions-tester/README.md) - 📖 Read the [Checkout specific documentation](https://github.com/Shopify/ui-extensions/blob/02-12-create_mocks_for_the_entire_checkout_extension_api/packages/ui-extensions-tester/src/checkout/README.md) - Try running tests in the [example app](https://github.com/Shopify/ui-extensions/blob/02-12-create_mocks_for_the_entire_checkout_extension_api/examples/testing/checkout-basic-testing-example/README.md) on this branch
Follow up to #3899 that adds a complete, type-safe mock of the point-of-sale extension API ## 👁️ How to review this PR - 📖 Read the main [developer-facing documentation](https://github.com/Shopify/ui-extensions/blob/02-11-create_a_testing_library_for_ui-extensions_proof_of_concept_/packages/ui-extensions-tester/README.md) - 📖 Read the [POS specific documentation](https://github.com/Shopify/ui-extensions/blob/02-12-create_mocks_for_the_entire_point-of-sale_extension_api/packages/ui-extensions-tester/src/point-of-sale/README.md) - Try running tests in the [example app](https://github.com/Shopify/ui-extensions/blob/02-12-create_mocks_for_the_entire_point-of-sale_extension_api/examples/testing/point-of-sale-testing-example/README.md) on this branch
…-name-2026-04 Fix collect_buyer_consent and extension type description
port over rc flow
Remove inaccurate `applyGiftCardChange` JSDoc claim (2026-04)
…upport_label_slot Update checkbox docs to support label slot
…26-04b Remove doc validation skills
Simplify to state what to use instead of when it was deprecated. Co-authored-by: Cursor <[email protected]>
…uts-2026-04 Remove version dates from CA extensionPoint deprecated tags
…-patch Fix checkbox changeset from minor to patch
make rc job run on base change
Add JSDoc for component properties (2026-04)
also comment on base branch change
As of version 2025-10, each screen runs in its own isolated sandbox. This adds a Limitations bullet so developers know module-level state, closures, and singletons aren't shared across screens, and points to the state option / persistent storage as the supported way to pass data between screens.
docs(pos): note per-screen sandbox in Navigation API limitations
remove old target data and update script
…026-04) (#4450) ## Summary Removes the self-referential "Refer to Storefront API access examples for more information" link from the `query` property description in `StandardApi`. The link points to the same page the reader is already on, which is confusing and unhelpful. Fixes shop/issues-learn#2084 ## Test plan - [ ] Verify the generated docs no longer include the self-referential link on the Storefront API page Made with [Cursor](https://cursor.com)
Stable 2026-04 release has shipped, so new fields ship as a patch. Co-Authored-By: Claude Opus 4.7 (1M context) <[email protected]>
Adding in types for purchaseType and recurringCycleLimit fields
Run yarn docs:checkout 2026-04 to refresh generated_docs_data.json and generated_docs_data_v2.json. Co-authored-by: Cursor <[email protected]>
Run yarn docs:checkout 2026-01 to refresh generated_docs_data.json and generated_docs_data_v2.json. Co-authored-by: Cursor <[email protected]>
Contributor
🚨🚨🚨 Docs migration in progress 🚨🚨🚨We are actively migrating UI extension reference docs to MDX in the
During this migration, please be aware of the following:
Doc comments in Examples that previously lived in this repo are being moved to the What should I do?
Thanks for your patience while we complete the migration! 🙏 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
20 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Regenerates checkout UI extensions documentation data by running
yarn docs:checkout 2026-01.Files
packages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data.jsonpackages/ui-extensions/docs/surfaces/checkout/generated/generated_docs_data_v2.jsonMade with Cursor