chore(deps): update dependency @shopify/shopify-api to v13#84
Open
renovate[bot] wants to merge 1 commit into
Open
chore(deps): update dependency @shopify/shopify-api to v13#84renovate[bot] wants to merge 1 commit into
renovate[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
5d93d98 to
2a125aa
Compare
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
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 contains the following updates:
^12.0.0→^13.0.0Release Notes
Shopify/shopify-app-js (@shopify/shopify-api)
v13.0.0Major Changes
78c8968: BREAKING CHANGE: RemovedcustomShopDomainsconfiguration parameter. UsedomainTransformationsinstead, which provides both validation and transformation capabilities.The
SHOP_CUSTOM_DOMAINenvironment variable is no longer supported.Migration Guide:
If you were using
customShopDomainsfor validation only:0bb7837: Removed support for older API versions: 2022-10, 2023-01, 2023-04, 2023-07, 2023-10, 2024-01, 2024-04, 2024-07.The corresponding
ApiVersionenum values and REST resource directories have been removed.Apps using these versions must update to
2024-10or later.1eb863d: Add support for verifying webhooks delivered with the newshopify-*headers (replacing the previousx-shopify-*headers), and refactor webhook validation types to a discriminated union onwebhookType.Breaking change in
@shopify/shopify-api:WebhookFieldsis now a discriminated union (WebhooksWebhookFields | EventsWebhookFields) keyed on the requiredwebhookTypefield.webhookIdonly exists onWebhooksWebhookFields;eventIdis required onEventsWebhookFields. Consumers must narrow onwebhookTypeto access type-specific fields. BothWebhooksWebhookFieldsandEventsWebhookFieldsare exported for use in type narrowing.Before:
After:
@shopify/shopify-app-react-routerand@shopify/shopify-app-remix: The webhook context now includes new fields based on the new webhook headers, such aswebhookType,handle,action,resourceId,triggeredAt, andeventId. For events webhooks,webhookIdis set to the value of theeventIdheader for backwards compatibility — prefer usingeventIddirectly for events webhooks, aswebhookIdwill be removed from events webhooks in the next major version.Patch Changes
0d4a3f7: Updatedexpressfrom v4 to v5 and@types/expressfrom v4 to v5.Breaking changes for consumers of
@shopify/shopify-app-express:expresshas been moved fromdependenciestopeerDependencies. You must installexpress@^5.0.0directly in your project.app.use()already matches all subpaths, so the/*suffix is unnecessary:app.use('/api/*', ...)→app.use('/api', ...)app.use('/*', ...)→app.use('/', ...)app.get/app.postroutes, wildcards must be named:app.get('/api/*path', ...)req.bodynow defaults toundefined(was{}in v4) when no body-parser middleware is applied. Ensure you useexpress.json(),express.text(), or similar middleware before accessingreq.body.req.queryis now read-only and uses thequerystringparser by default instead ofqs. Nested object query parameters are no longer parsed by default.Added a null guard in
graphqlProxyto handlereq.bodybeingundefined.4c1789b: Updated@graphql-codegen/typescript,@​parcel/watcher,isbotdependenciesd5ae946: Publish TypeScript source files to npm so "Go to Definition" in IDEs navigates to real source code instead of compiled.d.tsdeclaration files. Source maps already pointed to the correct paths — the source files just weren't included in the published packages.Updated dependencies [
df81075]Updated dependencies [
d5ae946]v12.3.0Minor Changes
0fa5ef7: Add REST version 2026-01Patch Changes
60dc5ce: Updatedisbotdependenciesv12.2.0Minor Changes
f1af47e: This change introduces full support for OAuth refresh tokens in the@shopify/shopify-apipackage, enabling apps to use expiring access tokens and rotate them securely.Sessionclass now includes properties to store refresh token information:refreshToken: The refresh token string.refreshTokenExpires: The date when the refresh token expires.shopify.auth.refreshToken: A new method to exchange a refresh token for a new access token.shopify.auth.migrateToExpiringToken: A helper method to migrate existing non-expiring offline tokens to expiring tokens.tokenExchangemethod now accepts anexpiringparameter to request expiring access tokens.Patch Changes
a6a13bf: Updatedlossless-jsondependenciesv12.1.2Patch Changes
98f1be9: Add Web API and CF Worker adapter intialized constants for aggressive tree-shakersFor example with the web-api adapter:
v12.1.1Patch Changes
b3716f8: Add back in correctly removed REST resourcesv12.1.0Minor Changes
a6c4fed: Add 2025-10 REST resourcesv12.0.0Major Changes
dc41d09: Swappedjsonwebtokendependency forjoseIf you use the
getJwtfunction, it is now async.Before
After:
This change gives you smaller packages and more standards compliance.
c3005a6: REST API IDs change from number to stringstringinstead ofnumberto prevent precision loss for IDs approaching JavaScript's MAX_SAFE_INTEGER (2^53-1). This affects both REST resources and the REST client.What Changed
Affected APIs
Why This Change
Migration Examples
Migration Guide
Backward Compatibility
dc41d09: Require Node >= v20.10.0. Remove crypto dependency in favor of globalThis.cryptoIf you are using Node, make sure you are using Node version 20 or above
If you are using
setCryptofrom'@​shopify/shopify-api'you can remove this code.a5be0d0: Removed thev10_lineItemBillingandlineItemBillingfuture flags.If you've adopted either flag
If you have not adopted either flag
48d3631: TheLATEST_API_VERSIONandRELEASE_CANDIDATE_API_VERSIONconstants have been removed from the package. TheapiVersionparameter is now required in theshopifyAppconfiguration.We are making this change to ensure the API versions do not change without the developer explicitly opting into the new version. This removes the potential for apps to break unexpectedly and should reduce overall maintenance.
Migration Steps
Patch Changes
6606d39: Fix adapter initialization issues with modern bundlers (Vite, Webpack) in SSR frameworksAdds
sideEffectsconfiguration to package.json to prevent bundlers from incorrectly tree-shaking adapter initialization code. This resolves the "Missing adapter implementation for 'abstractRuntimeString'" error that occurred when using the library with Nuxt 3, TanStack Start, and other frameworks.The adapters use side effects to initialize runtime functions, and modern bundlers were optimizing these away, causing runtime errors. The fix ensures these critical initialization side effects are preserved during the bundling process.
Some bundlers may still tree-shake pure side-effect imports. If you encounter issues after this update, you can use the newly
exported
nodeAdapterInitializedconstant to ensure the adapter is loaded:7d8aa81: # Remove deprecated packageRemoves the deprecated
@shopify/networkpackage. No change in functionality.089f4fd: Update loggings for session utilsdc41d09: Remove node-fetch from the node adapter since Node >=20 supports globalThis.fetchConfiguration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.