Skip to content

Fix collect_buyer_consent and extension type description#4400

Merged
sordaz00 merged 6 commits into
2025-10from
fix/customer-privacy-capability-name-2025-10
Apr 30, 2026
Merged

Fix collect_buyer_consent and extension type description#4400
sordaz00 merged 6 commits into
2025-10from
fix/customer-privacy-capability-name-2025-10

Conversation

@sordaz00
Copy link
Copy Markdown
Contributor

@sordaz00 sordaz00 commented Apr 30, 2026 •
edited
Loading

Summary

Cascade of #4397 to 2025-10.
Also fixes missing properties tag so properties show.

Test plan

  • Verify rendered docs show collect_buyer_consent with correct link

Made with Cursor

@sordaz00
Fix customer_privacy capability name to collect_buyer_consent
a8e8e07 
The applyTrackingConsentChange note incorrectly referenced the
customer_privacy capability. The correct name is collect_buyer_consent.
Updated link to point to the capabilities documentation.

Made-with: Cursor
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

🚨🚨🚨 Docs migration in progress 🚨🚨🚨

We are actively migrating UI extension reference docs to MDX in the areas/platforms/shopify-dev zone of the monorepo. This impacts docs for the following surfaces:

During this migration, please be aware of the following:

.doc.ts files are being deprecated. Changes to .doc.ts files in this repo will not be reflected in the new MDX-based docs. If you need to update docs for a reference that has already been migrated, make your changes directly in the areas/platforms/shopify-dev zone of the monorepo instead.

Doc comments in .ts source files (the comment blocks above types and functions) are also affected. Generating docs from these comments currently requires a newer version of the @shopify/generate-docs library that isn't yet available. Updates to doc comments may not produce the expected output until the migration is complete.

Examples that previously lived in this repo are being moved to the areas/platforms/shopify-dev zone of the monorepo and should be authored there going forward.

What should I do?

  • If your PR includes changes to .doc.ts files, doc comments, or examples, please reach out to us in #devtools-proj-templated-refs so we can help ensure your updates are captured correctly.
  • If your PR is limited to source code changes (non-docs), you can ignore this notice.

Thanks for your patience while we complete the migration! 🙏

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

We detected some changes in packages/*/package.json or packages/*/src, and there are no updates in the .changeset directory. If the changes are user-facing and should cause a version bump, run yarn changeset to track your changes and include them in the next release CHANGELOG. If you are making simple updates to repo configuration, examples, or documentation, you do not need to add a changeset.

sordaz00 added 2 commits April 30, 2026 09:47
@sordaz00
Remove capabilities bullet list from CA Extension JSDoc
9b70e73 
The bullet list enumerated capabilities that don't all apply to
customer account. The description already links to the configuration
docs where valid capabilities are documented per surface.

Made-with: Cursor
@sordaz00
Add missing @publicdocs tag and description to Navigation interface
da414d5 
Without this tag, the doc generator doesn't extract the Navigation
interface members, resulting in an empty Properties section.

Made-with: Cursor
@sordaz00 sordaz00 changed the title Fix customer_privacy capability name to collect_buyer_consent Fix collect_buyer_consent and extension type description Apr 30, 2026
@sordaz00
Remove capabilities bullet list from checkout Extension JSDoc
2549d80 
The bullet list is redundant with the type's resolved values and
causes incorrect capabilities to appear on non-checkout surfaces.
The description already links to the configuration docs.

Made-with: Cursor
mcvinci
mcvinci approved these changes Apr 30, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@mcvinci mcvinci left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

Comment thread packages/ui-extensions/src/surfaces/checkout/api/standard/standard.ts Outdated
*
* * [`iframe.sources`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration#iframe): the extension can embed an external URL in an iframe.
* The allowed capabilities of the extension, defined in your
* [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.
Copy link
Copy Markdown
Contributor

@mcvinci mcvinci Apr 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* [`shopify.extension.toml`](https://shopify.dev/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.
* [`shopify.extension.toml`](/docs/api/checkout-ui-extensions/{API_VERSION}/configuration) file.

sordaz00 added 2 commits April 30, 2026 11:03
@sordaz00
Add missing @publicdocs and enrich Extension interface description
a92c9a5 
Without @publicdocs the generator falls back to a default description.
Also aligned the description to match newer versions.

Made-with: Cursor
@sordaz00
Use relative link for shopify.extension.toml in capabilities description
00d9975 
Made-with: Cursor
@sordaz00 sordaz00 merged commit 89567ef into 2025-10 Apr 30, 2026
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcvinci mcvinci mcvinci approved these changes

Assignees

No one assigned

Labels

Customer account UI extensions

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@sordaz00 @mcvinci