diff --git a/.changeset/gorgeous-moose-beg.md b/.changeset/gorgeous-moose-beg.md new file mode 100644 index 0000000000..cb6f1edeac --- /dev/null +++ b/.changeset/gorgeous-moose-beg.md @@ -0,0 +1,11 @@ +--- +'@shopify/shopify-app-remix': minor +'@shopify/shopify-api': minor +--- + +# Add release candidate API version +Adds a constant that points to the [release candidate API version](https://shopify.dev/docs/api/usage/versioning#release-candidates). + +``` +import { RELEASE_CANDIDATE_API_VERSION } from "@shopify/shopify-api"; +``` diff --git a/packages/apps/shopify-api/lib/__tests__/config.test.ts b/packages/apps/shopify-api/lib/__tests__/config.test.ts index 2ff7e4b2d0..41a4ac9af4 100644 --- a/packages/apps/shopify-api/lib/__tests__/config.test.ts +++ b/packages/apps/shopify-api/lib/__tests__/config.test.ts @@ -161,10 +161,10 @@ describe('Config object', () => { expect(config.hostName).toEqual('my-host-name'); }); - it('points LATEST_API_VERSION to the last non-unstable version in the enum', () => { + it('points LATEST_API_VERSION to the last non-unstable, and non release candidate version in the enum', () => { const enumVersions = Object.values(ApiVersion); - expect(LATEST_API_VERSION).toEqual(enumVersions[enumVersions.length - 2]); + expect(LATEST_API_VERSION).toEqual(enumVersions[enumVersions.length - 3]); }); it('can alias billing future flags', () => { diff --git a/packages/apps/shopify-api/lib/types.ts b/packages/apps/shopify-api/lib/types.ts index 74dc34ed8e..eba8af5703 100644 --- a/packages/apps/shopify-api/lib/types.ts +++ b/packages/apps/shopify-api/lib/types.ts @@ -16,11 +16,13 @@ export enum ApiVersion { July24 = '2024-07', October24 = '2024-10', January25 = '2025-01', + April25 = '2025-04', Unstable = 'unstable', } export const LIBRARY_NAME = 'Shopify API Library'; export const LATEST_API_VERSION = ApiVersion.January25; +export const RELEASE_CANDIDATE_API_VERSION = ApiVersion.April25; /* eslint-disable @shopify/typescript/prefer-pascal-case-enums */ export enum ShopifyHeader { diff --git a/packages/apps/shopify-app-remix/src/server/index.ts b/packages/apps/shopify-app-remix/src/server/index.ts index 79ead0d4c1..5abbcde5bc 100644 --- a/packages/apps/shopify-app-remix/src/server/index.ts +++ b/packages/apps/shopify-app-remix/src/server/index.ts @@ -7,6 +7,7 @@ setAbstractRuntimeString(() => { export { LATEST_API_VERSION, + RELEASE_CANDIDATE_API_VERSION, LogSeverity, DeliveryMethod, BillingInterval,