[POS UI extensions]: Improved target, API, and component descriptions for 2024-10 #3566
Conversation
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
mcvinci
added
the
#gsd:47443
linting linting linting More description improvements type errors Remove event data files not needed in 2025-01 version and revert BaseInput/BaseIntent to original names Remove new files that don't belong in 2025-01 version More descriptions Add descriptions to BaseInput and BaseIntent, fix TaxLine import error FormattedTextField desc Fix import path and remove deprecated warnings for 2024-10 - Fix CurrencyCode import path in session.ts (should be 4 levels up) - Remove deprecation warnings from Spacing.ts (sizes.ts doesn't exist in 2024-10) Remove new API features from cherry-pick - keep only description improvements Removed NEW items that shouldn't be in 2024-10: - bulkCartUpdate() method and CartUpdateInput type - Cart.editable field - LineItem.discountAllocations field - LineItem.taxLines field - Session.currency and Session.posVersion fields - Removed CurrencyCode import from session.ts - Removed @returns documentation for methods that return Promise<void> Only keeping the improved descriptions for existing APIs, types, and methods. Remove additional new fields from cart.ts for 2024-10 Removed NEW fields/types that shouldn't be in 2024-10: - LineItem.attributedUserId field - LineItem.components field - LineItemComponent interface (entirely new) - Discount.currency field Only keeping description improvements for EXISTING fields in 2024-10. Restore original Icon.ts - remove new deprecated types for 2024-10 The cherry-pick added NEW types that shouldn't be in 2024-10: - DeprecatedIconName type (with deprecation notices for 2025-10 removal) - DeprecatedIconSize type (with deprecation notices for 2025-10 removal) In 2024-10, these icons are NOT deprecated yet. Restored the original simple Icon.ts with just IconName and IconSize types. Restore original Spacing.ts - remove new Spacing type for 2024-10 The cherry-pick added a NEW 'Spacing' type (numeric values 0.5, 1, 2, etc.) that wasn't in 2024-10. This type doesn't exist in 2024-10. Restored the original with only VerticalSpacing and HorizontalSpacing types. Add proper descriptions for all Customer interface fields Fixed incorrect description on Customer.id (was talking about selling plans) and added descriptions for all fields: - id: Customer identifier with common use cases - email: Email address for communication - firstName: Customer's first name - lastName: Customer's last name - note: Internal merchant notes about the customer Improve Icon.ts field descriptions Enhanced descriptions for IconProps fields: - name: Added examples of icon types (cart, payment, search, etc.) - size: Added clear explanation of each size option (minor, major, spot, caption, badge) Add descriptions for IconName and IconSize types Added comprehensive descriptions for: - IconName: Describes the icon identifier with categorized examples (commerce operations, payment methods, navigation, actions, status indicators, system symbols) - IconSize: Explains each size option (minor, major, spot, caption, badge) with specific use cases
mcvinci
force-pushed
the
pos-ui-extensions-2024-10-api-prop-descriptions
branch
from
55e36ae to
c3a0f6d
Compare
Contributor
|
We detected some changes in |
mcvinci
requested review from
NathanJolly,
johndcollett and
timtrevor-shopify
mcvinci
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
This PR:
Tophatting
ui-extensionsrepo, runyarn docs:point-of-sale 2024-10.shopify-dev, run a server (dev server) and review the 2024-10 docs (descriptions for targets, APIs, and components) at https://shopify-dev.shop.dev/docs/api/pos-ui-extensions/2024-10Known issues
Focus for reviewers
I'm mainly looking for a gut-check on the following: