Changelog

11.6.0

Minor Changes

50634c0: Adds API to update the capped amount for a usage billing plan.

A new billing helper function has been added to update the capped amount for a usage billing plan.

const response = await shopify.billing.updateUsageCappedAmount({
  session,
  subscriptionLineItemId: 'gid://shopify/AppSubscriptionLineItem/1234567890',
  cappedAmount: {
    amount: 100,
    currencyCode: 'USD',
  },
});
console.log(response);

Learn more about App Billing.

5c01460: Adding toggle parameter flag to return implied scopes from Remix API Query by returning original scopes from AuthScopes instantiation

Example: const scopes = new AuthScopes(['read_customers', 'write_customers', 'read_products', 'write_channels']); scopes.toArray() returns ['write_customers', 'read_products', 'write_channels'] scopes.toArray(true) returns ['read_customers', 'write_customers', 'read_products', 'write_channels']

Patch Changes

59896e3: Updated isbot dependencies
2e396f3: Updated express dependencies
5efb3a2: Updated express dependencies
cd0b3e1: Updated jose dependencies
bad62cc: Updated tslib dependencies
10f4fd0: Updated jose dependencies
Updated dependencies [f38dfc0]
- @shopify/graphql-client@1.2.1
- @shopify/admin-api-client@1.0.4
- @shopify/storefront-api-client@1.0.3

11.5.0

Minor Changes

7a2e78a: Add October 2024 REST resources

Patch Changes

18ee7e2: Updated jose dependencies
6bda2fc: Fix type declaration for payment_transaction
Updated dependencies [97c31fb]
- @shopify/admin-api-client@1.0.3

11.4.1

Patch Changes

323bef3: Update documentation to make it clear when to use app-specific vs shop-specific webhooks and which methods/config uses which approach
fb48795: Fix type error for the Application Charge rest resource

11.4.0

Minor Changes

4e143ec: Adds ts-docs to header utils

4a1ffad: Adds API to create usage records for billing

A new billing helper function has been added to create usage records for a usage billing plan.

const chargeBilling = await billing.createUsageRecord({
  description: 'Usage record for product creation',
  price: {
    amount: 1,
    currencyCode: 'USD',
  },
  isTest: true,
});
console.log(chargeBilling);

Learn more about App Billing.

Patch Changes

a426889: Exposing override types for lineItems in the billing request method.
8e61a39: setUpValidRequest in shopify-api now preserves headers. Documentation for test helpers now more accurately describes use cases.
Updated dependencies [ada2cc3]
- @shopify/graphql-client@1.2.0
- @shopify/admin-api-client@1.0.2
- @shopify/storefront-api-client@1.0.2

11.3.0

Minor Changes

e9b4f22: fixes/webhook-typesafety

8f92455: Test helpers and changes to enable automated unit and e2e testing for @shopify/shopify-app-remix

See documentation for examples on how to use these helper methods.

import prisma from '~/db.server';
import { PrismaSessionStorage } from '@shopify/shopify-app-session-storage-prisma';
import {
  RequestType,
  setUpValidRequest,
  setUpValidSession,
} from '@shopify/shopify-api/test-helpers';

// set up test Session
const sessionStorage = new PrismaSessionStorage(prisma);
const session = await setUpValidSession({
  shop: getShopValue('test-shop');
});
await sessionStorage.storeSession(session);

let request: Request = ... // the request intercepted by end-to-end testing framework

const authorizedRequest = setUpValidRequest(
  {
    type: RequestType.Extension,
    store: `test-shop-${process.env.TEST_PARALLEL_INDEX}`,
    apiKey: ..., // the same value as `apiKey` passed to shopifyApi()
    apiSecretKey: ..., // the same value as `apiSecretKey` passed to shopifyApi()
  },
  request
);

// use authorizedRequest to complete the request, or use the url or headers of authorizedRequest to modify the original request.

... // complete testing here

// tear down test Session
await sessionStorage.deleteSession(session.id);

Patch Changes

e944c72: Updated isbot dependencies

11.2.0

Minor Changes

05fb23d: Added a new future flag unstable_managedPricingSupport to support apps using Shopify managed pricing, which will:
- Change billing.check to always return an object.
- Change billing.check and billing.subscription to work without a billing config.
- Allow calling charges with billing.check without a plans filter. The hasActivePayment value will be true if any purchases are found with the given filters.

1aa226b: Return headers in responses from GraphQL client.

Headers are now returned in the response object from the GraphQL client.

In apps using the @shopify/shopify-app-remix package the headers can be access as follows:

  const response = await admin.graphql(
    ...

  const responseJson = await response.json();
  const responseHeaders = responseJson.headers
  const xRequestID = responseHeaders? responseHeaders["X-Request-Id"] : '';
  console.log(responseHeaders);
  console.log(xRequestID, 'x-request-id');

Patch Changes

192cc6b: Expose AuthScopes type
06793fb: Session is active if the scopes list includes the scopes received. Token wont be regenerated if the current includes additional scopes.
3a0a3d4: Improved code readability and execution time of cookie/header helper functions
3cf3c56: Updated dependency on the jose package.
- @shopify/admin-api-client@1.0.1
- @shopify/storefront-api-client@1.0.1

11.1.0

Minor Changes

ea7c05d: Added support for API version 2024-07

Patch Changes

1de1f15: bump jose from 5.4.0 to 5.4.1

11.0.1

Patch Changes

58fb360: Updated dependency on uuid
8eafd2b: Fixed creation of nested REST resource objects in the Remix package.

11.0.0

Major Changes

6970109: Drop support for Node 16. This package is compatible with Node version >=18.2.0.

Minor Changes

b5a4735: chore:robust-typesafe-error-handling
36e3c62: Add support for Node 22.

Patch Changes

d9f2601: Bump jose from 5.2.4 to 5.3.0

92b6772: Added an is_default field to CustomerAddress so it doesn't overlap with the existing default() method we provide in the class.

Before:

const address = await shopify.rest.CustomerAddress.find({session, id: 1234});
// Boolean
console.log(address.default);
// Error - not a function
await address.default();

After:

const address = await shopify.rest.CustomerAddress.find({session, id: 1234});
// Boolean
console.log(address.is_default);
// Function
await address.default();

To prevent breaking existing apps, this only happens when the customerAddressDefaultFix flag is enabled.

a42efff: Bump isbot from 5.1.4 to 5.1.6
9749f45: Handle empty responses to REST requests for DELETE endpoints gracefully, instead of throwing an error when parsing the JSON.
Updated dependencies [36e3c62]
Updated dependencies [6970109]
- @shopify/admin-api-client@1.0.0
- @shopify/storefront-api-client@1.0.0

10.0.0

Major Changes

Note

For more details on migrating to v10, please follow see the migration guide.

379206c: Webhook validation will now return a different reason value when the HMAC value is missing from the request. Instead of returning WebhookValidationErrorReason.MissingHeaders as it does for the other headers it validates, it will now return a new WebhookValidationErrorReason.MissingHmac error so this check matches other HMAC validations.

If your app doesn't explicitly check for the error after calling webhook.validate(), you don't need to make any changes.
637c6c3: This scopes field on the API config object is now optional. If your app is using the new managed install flow, it is now recommended you omit the scopes property from the config object.

61576be: Changed the package's build process to produce both ESM and CJS outputs.

While this should have no effect on most apps, if you're directly importing a file from the package, its path will have changed. Regular imports for package files remain unchanged.

Before:

import 'node_modules/@shopify/shopify-api/lib/clients/admin/graphql/client';
import '@shopify/shopify-api/adapters/node';

After:

// Add `dist/esm|cjs/` before the file
import 'node_modules/@shopify/shopify-api/dist/esm/lib/clients/admin/graphql/client';
// Unchanged
import '@shopify/shopify-api/adapters/node';

Patch Changes

65325b8: Change v10_lineItemBilling flag to lineItemBilling
6f1a98e: Fixing REST resource find() methods to fail when missing all ids, instead of defaulting to the same behaviour as all().
379206c: Postponed deprecating the GraphQL clients' query method because they haven't been deprecated for long enough. They'll be removed when v11 is released instead.
Updated dependencies [715a120]
- @shopify/storefront-api-client@0.3.4
- @shopify/admin-api-client@0.2.9

9.7.2

Patch Changes

16f52ee: Include error message into HttpRequestError
8c97e8a: Updated dependency on isbot

9.7.1

Patch Changes

a60c214: Fix type error in graphql error handler
513f9e6: Fixed an issue with the RecurringApplicationCharge REST resource currency type

9.7.0

Minor Changes

3415a8c: Added support for the 2024-04 API version.
c9dff9f: Add Shop.current() method to the REST resources

9.6.2

Patch Changes

b60c6c9: Fixes bug, that is returning the onlineAccessInfo field on the session, when the session if offline

9.6.1

Patch Changes

96a0aab: Fix bug that was causing duplicate keys in Session when using FromPropertyArray with returnUserData = true

9.6.0

Minor Changes

b912ecd: Updates the Session class to handle the associated user information on the session object.

Updates the Session fromPropertyArray to handle all user info fields. New optional argument returnUserData, (defaulted to false), will return the user data if it is apart of the property array. This will be defaulted to true in an upcoming version.

const sessionProperties = session.toPropertyArray(true);
/*
  if sessionProperties has the following data...
  [
    ['id', 'online_session_id'],
    ['shop', 'online-session-shop'],
    ['state', 'online-session-state'],
    ['isOnline', true],
    ['scope', 'online-session-scope'],
    ['accessToken', 'online-session-token'],
    ['expires', 1641013200000],  // example = January 1, 2022, as number of milliseconds since Jan 1, 1970
    ['userId', 1],
    ['first_name', 'online-session-first-name'],
    ['last_name', 'online-session-last-name'],
    ['email', 'online-session-email'],
    ['locale', 'online-session-locale'],
    ['email_verified', false]
    ['account_owner', true,]
    ['collaborator', false],
    ],
 */

const session = Session.fromPropertyArray(sessionProperties, true);
/*
  ... then session will have the following data...
  {
    id: 'online_session_id',
    shop: 'online-session-shop',
    state: 'online-session-state',
    isOnline: true,
    scope: 'online-session-scope',
    accessToken: 'online-session-token',
    expires: 2022-01-01T05:00:00.000Z,  // Date object
    onlineAccessInfo: {
      associated_user: {
        id: 1,
        first_name: 'online-session-first-name'
        last_name: 'online-session-last-name',
        email: 'online-session-email',
        locale: 'online-session-locale',
        email_verified: false,
        account_owner: true,
        collaborator: false,
      },
    }
  }
 */

Updates the Session toPropertyArray to handle all user info fields. New optional argument returnUserData, (defaulted to false), will return the user data as part of property array object. This will be defaulted to true in an upcoming version.

const {session, headers} = shopify.auth.callback({
  rawRequest: req,
  rawResponse: res,
});

/*
  If session has the following data content...
  {
    id: 'online_session_id',
    shop: 'online-session-shop',
    state: 'online-session-state',
    isOnline: true,
    scope: 'online-session-scope',
    accessToken: 'online-session-token',
    expires: 2022-01-01T05:00:00.000Z,  // Date object
    onlineAccessInfo: {
      expires_in: 1,
      associated_user_scope: 'online-session-user-scope',
      associated_user: {
        id: 1,
        first_name: 'online-session-first-name',
        last_name: 'online-session-last-name',
        email: 'online-session-email',
        locale: 'online-session-locale',
        email_verified: true,
        account_owner: true,
        collaborator: false,
      },
    }
  }
 */

const sessionProperties = session.toPropertyArray();
/*
  ... then sessionProperties will have the following data...
   [
    ['id', 'online_session_id'],
    ['shop', 'online-session-shop'],
    ['state', 'online-session-state'],
    ['isOnline', true],
    ['scope', 'online-session-scope'],
    ['accessToken', 'online-session-token'],
    ['expires', 1641013200000],  // example = January 1, 2022, as number of milliseconds since Jan 1, 1970
    ['userId', 1], // New returns the user id under the userId key instead of onlineAccessInfo
    ['first_name', 'online-session-first-name'],
    ['last_name', 'online-session-last-name'],
    ['email', 'online-session-email'],
    ['locale', 'online-session-locale'],
    ['email_verified', false]
    ['account_owner', true,]
    ['collaborator', false],
    ],
 */

87208ea: Add a context argument to webhooks process function to make it easier for Cloudflare apps (and others that might use a context object) to pass information to the handler.

9.5.1

Patch Changes

1344258: Bumps jose from 5.2.2 to 5.2.3.

9.5.0

Minor Changes

01371f7: Add function to authenticate fulfillment service requests

Patch Changes

4e7c479: Show an INFO log for disabled future flags to encourage apps to migrate ahead of time, making major version bumps simpler.
13a230d: Enabled returning the full response object in Customer.search() and GiftCard.search(), so that apps can paginate through the results.
f57712c: Refactor HMAC validation to use a common function.
01a803d: Reintroduced logging of HTTP requests for OAuth processes, which was incorrectly removed when the new clients were introduced.
- @shopify/admin-api-client@0.2.8
- @shopify/storefront-api-client@0.3.3

9.4.1

Patch Changes

@shopify/admin-api-client@0.2.7
@shopify/storefront-api-client@0.3.2

9.4.0

Minor Changes

d6657e8: Return additional app subscription plan information, including the line item IDs

Patch Changes

6eb8091: Updated dependency on jose
- @shopify/admin-api-client@0.2.6
- @shopify/storefront-api-client@0.3.1

9.3.2

Patch Changes

Updated dependencies [9df4bacf]
- @shopify/storefront-api-client@0.3.0
- @shopify/admin-api-client@0.2.5

9.3.1

Patch Changes

661d52dd: Fix bug with creation of webhooks with subtopics

9.3.0

Minor Changes

35e06823: Add webhook subtopic as an additional option field when creating webhook subscriptions

Patch Changes

fbae4bcc: Bumps compare-versions from 5.0.3 to 6.1.0.
cc52aaca: Fix linked reference for session in token exchange docs
- @shopify/admin-api-client@0.2.4
- @shopify/storefront-api-client@0.2.4

9.2.0

Minor Changes

e2d4fee2: Update lineItemBilling future flag to v10. Current users of unstable_lineItemBilling will need to update to v10_lineItemBilling to continue using this feature.
```
const shopify = shopifyApi({
  // ...
future: {
  v10_lineItemBilling: true,
});
```

Patch Changes

db7d9cff: Remove gating of the token exchange API behind the unstable_tokenExchange flag.

9.1.0

Minor Changes

9c41d910: Added support for validating Flow extension requests, using shopify.authenticate.flow.

Please see the flow object documentation for more information.
348b138a: Export GraphqlClient class from types

Patch Changes

224fbf57: Fixed the types of the balance and currency fields in the GiftCard object.
0f0ffb8a: Updated global fetch types to more closely match reality
Updated dependencies [0f0ffb8a]
- @shopify/storefront-api-client@0.2.3
- @shopify/admin-api-client@0.2.3

9.0.2

Patch Changes

4d7f9a01: Update documentation with required shopifyApi params
1b4caf91: Return "body" field from GraphqlQueryError type
Updated dependencies [b2414c2f]
- @shopify/storefront-api-client@0.2.2
- @shopify/admin-api-client@0.2.2

9.0.1

Patch Changes

fdd25e13: Fixed an issue in the RestClient class' request method, which was incorrectly made private instead of protected.
- @shopify/admin-api-client@0.2.1
- @shopify/storefront-api-client@0.2.1

9.0.0

Major Changes

64f61414:

[!NOTE] This change only affects apps that are using custom runtime adapters. If you're using a default adapter from this package, you don't need to make this change.

Changed setAbstractFetchFunc to accept a fetch API instead of one based on NormalizedRequest and NormalizedResponse.

With this change, we can return a Response object for requests with the upcoming clients, which can help make the interface for requests more familiar to users.

For more information and examples, see the migration guide to v9.
7bd4be08: Rephrased gdprTopics to privacyTopics to account for other privacy regulations with data subject requests.

This changes the name of the exported object. You can fix this by changing your import statements:

Before:
```
import {gdprTopics} from '@shopify/shopify-api';
```
After:
```
import {privacyTopics} from '@shopify/shopify-api';
```

Minor Changes

83b15905: Allow access tokens to be marked as expired before actual expiry.
218f4521: Use the new GraphQL API clients in shopify-api to use all of the latest features, including automatic types for query / mutation return object and variables.

For more information and examples, see the migration guide to v9.
18781092: Updated shopify-api GraphQL clients' APIs to be closer to the underlying clients
4dd7612d: Underpinned the new REST client from admin-api-client into shopify-api, so apps can access it as a standalone client as well.
5e85e15b: Added support for the 2024-01 API version.
64cda80a: Add helpers to convert between shop admin URLs and legacy URLs. sanitizeShop utility method can now support shop admin URLs.

Patch Changes

Updated dependencies [88858305]
Updated dependencies [218f4521]
Updated dependencies [0286e7fe]
Updated dependencies [18781092]
Updated dependencies [2b9e06f6]
Updated dependencies [194ddcf2]
Updated dependencies [c9622cd7]
- @shopify/admin-api-client@0.2.0
- @shopify/storefront-api-client@0.2.0

8.1.1

Patch Changes

880c9ddf: Add isExpired() and isScopeChanged() functions to Session class

8.1.0

Minor Changes

bf0664bb: Line Item Billing

Now with the future flag unstable_lineItemBilling you can specify multiple line items in a single billing request. This will allow you to create a single billing request for a subscription with both recurring and usage based app billing.

You will define the new billingConfig as follows.

const shopify = shopifyApp({
  billing: {
    MultipleLineItems: {
      replacementBehavior: BillingReplacementBehavior.ApplyImmediately,
      trialDays: 7,
      lineItems: [
        {
          interval: BillingInterval.Usage,
          amount: 30,
          currencyCode: 'USD',
          terms: 'per 1000 emails',
        },
        {
          interval: BillingInterval.Every30Days,
          amount: 30,
          currencyCode: 'USD',
          discount: {
            durationLimitInIntervals: 3,
            value: {
              amount: 10,
            },
          },
        },
      ],
    },
  },
  futures: {
    unstable_lineItemBilling: true,
  },
});

eae5a4a8: Introduce token exchange API for fetching access tokens. This feature is currently unstable and is hidden behind the unstable_tokenExchange future flag.

❗ To learn more about Token Exchange, see Performing OAuth

8.0.2

Patch Changes

58a20daf: Changed LATEST_API_VERSION export to point to October23. Thanks @SeanMythen!

8.0.1

Patch Changes

c8eebf30: Fixing publishing process to prevent empty packages

8.0.0

Major Changes

737838dd: Removed support for Node 14, and removed existing code deprecations.

For details on what's changed in this version, please see the V8 migration guide.

Minor Changes

df5fb586: Added support for the future configuration option. This will allow apps to opt in to upcoming features without needing to install RC packages.
cf60b3d1: Added support for the 2023-10 API version.

7.7.0

Minor Changes

5da6add9 / 3382a958: Allow overriding billing configurations when requesting payment, so that apps can use different values for different requests.
be262ba1: Allow using Session objects to create Storefront API clients that make requests using private access tokens.

Patch Changes

8187031f: Fix CustomerAddress.all not returning anything

7.6.0

Minor Changes

d2df0b1b: validateHmac now accepts an optional second param. Use this to support HMAC validation for app proxy requests

7.5.2

Patch Changes

c2962537: Fix storefront client incorrectly setting private token as access token

7.5.1

Patch Changes

6f075397: Allow not checking a session token payload's aud field to support tokens generated outside of the Shopify Admin.
ce638203: Fixing host validation to work with unified admin shops

7.5.0

Minor Changes

7a953a92: Adding support for 2023-07 API version

7.4.0

Minor Changes

9735d0c3: Stop sending the privateMetafieldNamespaces field in webhook queries to avoid the API duplication warning, and added a new shopify.utils.versionPriorTo method to help with cases like this one where apps will need to stop doing something that was deprecated.
1d84c135: Add Web API runtime adapter

7.3.1

Patch Changes

a9ef2e20: Fix crypto module set up for node, so it doesn't break webpack apps
85e7478f: [Internal] Improved tracking of webhook registration GraphQL calls

7.3.0

Minor Changes

52047d68: Add optional parameter to billing.check and billing.request to modify return value to be a more detailed object.
9b8ef033: Added Subscription cancel capabilities for App Billing. Fixes #771

Usage:
```
const canceledSubscription = await shopify.billing.cancel({
  session,
  subscriptionId,
});
```
See Billing Guide for more details.

Patch Changes

c700888a: Deprecated privateMetafieldNamespaces field in HTTP webhook configurations
b6e9f83c: Add shop search param to default billing return URL for non-embedded apps
18671105: Return the performed operation for each handler when registering webhooks

7.2.0

Minor Changes

57f31117: Add webhooks.validate method to support webhooks without callbacks
65eb416f: Export BillingCheckParams, BillingRequestParams and session.getJwtSessionId

7.1.0

Minor Changes

1a64d96c: Added returnUrl as optional parameter to billing request function, improved returnUrl logic. See documentation of returnUrl parameter for more details.
89cca000: Discount functionality for App Billing. Fixes #731

Patch Changes

8de3c783: Removed setCrypto function to simplify runtimes
2628a7fc: Add scopes validation for AuthScopes object and convert it to array. Fixes #1208, 1221
d028ec0f: Replace semver with compare-versions lib to reduce dependency on nodejs builtin-libs
7dcecb65: [Custom store apps only] Add new adminApiAccessToken parameter to config for when isCustomStoreApp is true. If set, it will be used for API access. apiSecretKey should now be set to the custom store app's API secret key, which is used to validate the HMAC of webhook events received from Shopify for a custom store app. Fixes #772, #800

For apps that don't receive HTTP webhook events from Shopify, no change is required yet - apiSecretKey will be used for client authentication as the fallback option.

Starting with the next major release
- adminApiAccessToken will be mandatory for custom store apps and must be set to the Admin API access token
- apiSecretKey will not be used for client authentication but must be set for HMAC validation of HTTP webhook events
See setting up a custom store app for more details.
450c9e7f: Add deprecation notice for removal of Node 14 support from next major release
9c095d12: Bumps jose from 4.13.1 to 4.14.1. See jose's changelog for more details.
f04f0f64: apiKey configuration parameter is no longer mandatory when isCustomStoreApp is true. Fixes #782
464fd4f2: Extend support for Event topic names
e8966d50: Restoring REST resources for 2022-04, updates to certain resources for other API versions
8de6024f: [Fix] Forward original graphql error message to client
f09417c4: Adds check for Google's Crawler in the authorization functions to prevent CookieNotFound error loops. Fixes #686
cbffa2f6: Add trial days and replacement behavior to usage billing mutation. Fixes #770

7.0.0

Major Changes

5a68e4a5: ⚠️ [Breaking] Return pagination info as part of .all() requests in REST resources, and remove the [PREV|NEXT]_PAGE_INFO static, thread unsafe attributes. Instead of returning a plain array of objects, it will now return an object containing that array, as well as the response headers and pagination info.

This enables apps to use locally-scoped pagination info, which makes it possible to use pagination in a thread-safe way.

You'll need to make 2 changes to use this version:
1. Where you accessed resources from the response, you'll now access the data property.
2. Where you accessed pagination data from the static variables, you'll now retrieve it from the response.
```
const response = await shopify.rest.Product.all({
  /* ... */
});

// BEFORE
const products: Product[] = response;
const nextPageInfo = shopify.rest.Product.NEXT_PAGE_INFO;

// AFTER
const products: Product[] = response.data;
const nextPageInfo = response.pageInfo?.nextPage;
const responseHeaders = response.headers;
```
fc2692f0: ⚠️ [Breaking] Removing deprecated code:
- The isPrivateApp param from shopifyApi() was removed in favour of isCustomStoreApp.
- The isOnline param from shopify.auth.callback() was removed, because it's now handled automatically.
8acc71da: Adding support for 2023-04 API version.

⚠️ [Breaking] Removing support for 2022-04 and 2022-07 API versions.
2096f9e4: The logger is now synchronous. This removes unnecessary await's from functions that use the logger but functionally don't need to await anything else. webhooks.addHandlers is the main impacted public method (it was async only because of the logging mechanism).

Apps that use the default logging methods (which send to console) will not be impacted by this change. Apps that implement their own loggers may be impacted; async logging functions can still be used but they need to be handled as promises.
```
// BEFORE
const myLogFunction = async (severity, message) => {
  try {
    await MyService.log(severity, message);
    // After external call
  } catch {
    // Handle error
  }
};

// AFTER
const myLogFunction = (severity, message) => {
  MyService.log(severity, message)
    .then(() => {
      // After external call
    })
    .catch(() => {
      // Handle error
    });
};
```

Patch Changes

f06912d3: Bump jose from 4.11.2 to 4.13.1. See jose changelog for details.
89847cac: Bump @shopify/network from 1.5.1 to 3.2.1. See network changelog for details.
896ef0d8: Add response headers to GraphqlQueryError. Fixes #553
97449f9e: validateHmac will now check for a hmac or a signature query argument. Fixes #776

[6.2.0] - 2023-02-15

[Minor] Validate HMAC timestamp during OAuth #671
[Patch] Improve logger call on different API versions #664
[Patch] Prevent leakage of session object with REST resources #690
[Patch] Improve typing of PREV_PAGE_INFO and NEXT_PAGE_INFO for REST resources #701
[Minor] Change isPrivateApp configuration item to isCustomStoreApp, keep isPrivateApp but with a deprecation notice, add shopify.session.customAppSession method to create a session suitable for use with clients, REST resources in a store-specific custom app #710

[6.1.0] - 2023-01-05

[Minor] Allow api version overrides #660
[Minor] Add support for 2023-01 API version #659
[Patch] Force / path on session cookie #658
[Patch] Don't ignore previous headers when beginning OAuth #652
[Patch] Export missing client types from package #648
[Patch] Add an info-level log of API library version and runtime environment string during initialization, to aid in troubleshooting 650
[Patch] Add new tracking SDK headers to Storefront API client #649

[6.0.2] - 2022-12-08

[Patch] Raise an InvalidSession if Session.fromPropertyArray receive an object that is not an array
[Patch] Validate content of host parameter using sanitizeShop regex #634
[Patch] Use the GraphQL format of webhook topics in the error message #626
[Patch] Export deprecation notices for v5 main interface #639
[Patch] Fixed an issue when parsing the response body in the AssignedFulfillmentOrder REST resource #644

[6.0.1] - 2022-12-08

[Patch] Auto-detect session type in auth callback, deprecate isOnline argument #628
[Patch] Removed callback URL path check from webhook processing #629
[Patch] Pass api version to webhook handlers #630

[6.0.0] - 2022-12-06

⚠️ [Breaking] Major overhaul of Shopify/shopify-api-node, which is a complete breaking change across all surfaces of the library. See the migration guide for instructions on how to update your app.

[5.3.0] - 2022-12-05

[Minor] Pass webhook id to handlers #606

[5.2.0] - 2022-10-04

Added support for the 2022-10 API version #535

[5.1.0] - 2022-09-19

Increased tolerance for expired JWT session tokens from 5s to 10s #462
Add support for billing to the library #449
Allow dynamically typing the body of REST and GraphQL request responses, so callers don't need to cast it #447
Rather than create a temporary session in order to store a session id in a cookie for the OAuth transaction, we can store the state in the cookie instead, that can then be compared against the state provided by Shopify in the callback. #438

[5.0.1] - 2022-08-03

Make sanitizeHost validation more flexible #446

[5.0.0] - 2022-07-28

⚠️ [Breaking] If a response from a GraphQL query contains an errors attribute, GraphqlClient will now throw a GraphqlQueryError. The caller can check the error.response attribute to see what was returned from the GraphQL API. #431
⚠️ [Breaking] Add utils functions to sanitize shops and hosts, and remove the validateShop utils function #434
Allow passing in options for the Redis client used by the session storage strategy #430
Fix User-Agent header sent in PUT / POST requests #435

[4.2.0] - 2022-07-20

Return a 401 instead of 403 when webhooks fail validation #425
Add optional new methods deleteSession and findSessionsByShop to SessionStorage, with the corresponding implementations for the various session storage adapters #418
Include subset of query body in API deprecation logs #426

[4.1.0] - 2022-07-14

Add new method to construct the host app URL #419

[4.0.0] - 2022-07-04

⚠️ [Breaking] Add REST resources for July 2022 API version, add LATEST_API_VERSION constant, remove support and REST resources for July 2021 (2021-07) API version #415
Add support for July 2022 API version #409

Fixes

Fix a bug where the PostgreSQL session storage always attempted to create the sessions table #413

[3.1.3] - 2022-06-08

Fixes

Return instances of Session from session storages, not POJOs.

[3.1.2] - 2022-06-07

Added

Store user id and expiration date of online tokens

Fixes

Properly parse a non-json HTTP response #257
Don’t create a SQLite DB file if the SQLite storage is not used.

[3.1.0] - 2022-05-16

Added

Support for specifying the URI scheme of the host #385
Add optional saving parameter to serialize of Base class - default is false and will include read-only attributes in returned object; true used for save when committing via API to Shopify.

Fixed

Fixes #363
- Webhooks register now checks for any attempt to register a GDPR topic (not done via API but by Partner Dashboard), provides an error message in response
- For topics that don't exist, register checks the response from the initial API call for an errors field and returns accordingly

[3.0.1] - 2022-04-11

Added

Allow REST resources to configure a deny list of attributes to be excluded when saving #355

[3.0.0] - 2022-04-04

Added

⚠️ [Breaking] Removing API version 2021-04 #343
⚠️ [Breaking] The HttpResponseError error and its flavours (all returned from HTTP requests) have been slightly altered:
- They now take in a hash of values, and will always include the response code, body (as a string if the response is not JSON), and headers
- All response fields are now contained within a response object, to make it easier to access them
⚠️ [Breaking] Update supported Admin API versions #310
Allow full paths in REST requests #301

Fixed

⚠️ [Breaking] Stop responding to the request in the GraphQL Proxy function, returning Shopify's response instead #312

The examples below are in express; you will now need to handle the response yourself.

Before:

app.post('/graphql', async (req, res) => {
  await Shopify.Utils.graphqlProxy(req, res);
});

After:

app.post('/graphql', async (req, res) => {
  const response = await Shopify.Utils.graphqlProxy(req, res);
  res.status(200).send(response.body);
});

[2.1.0] - 2022-02-03

Added

Add support for January 2022 API version #285

[2.0.0] - 2021-10-28

Added

Add a 5 second clockTolerance to fix jwt not active error #227
⚠️ [Breaking] Change default for OAuth.beginAuth to online sessions #203
- see oauth.md for updated docs
⚠️ [Breaking] Return and delete session in validateAuthCallback #217
- see oauth.md for updated usage
⚠️ [Breaking] Extract addHandler and getHandler methods for webhooks out of register #205
⚠️ [Breaking] Sessions no longer default to false for isOnline #169
Required Session arguments must be passed to the constructor #169
Allow undefined in AuthScopes #169

[1.4.3] - 2021-10-22

Fixed

Fixed the HTTP client error messages to expand objects #252

[1.4.2] - 2021-10-20

Added October21 to ApiVersion #247

[1.4.1] - 2021-06-11

Don't include extra params when calculating local hmac #196

[1.4.0] - 2021-05-21

Added

Add support for registering Google Pub/Sub webhooks #181
Added July21 to ApiVersion #181

[1.3.0] - 2021-05-12

Added

Added Storefront API client under Shopify.Clients.Storefront
Add isActive() method to Session class to check if session is active, replace Session with SessionInterface when used as a type #153

[1.2.1] - 2021-03-26

Added

Added April21 to ApiVersion #149

[1.2.0] - 2021-03-16

Added

Allow plain objects to be returned from the loadCallback on CustomSessionStorage #126
Documentation and example code for CustomSessionStorage #129

Fixed

Throw a different error for a missing cookie upon OAuth return #131
Improved documentation for GraphQL and Rest Clients. #123
Made Docs directory more browseable in GitHub. #136
Make sure CustomSessionStorage converts the expires field from a string to Date. #132
Made limit optional for get-requests with query #135

[1.1.0] - 2021-03-02

Minor text/doc changes
Added 2021-01 API version to enum. #117
Allow retrieving offline sessions using loadCurrentSession. #119

[1.0.0]

Initial public release

[0.5.0]

Added

Added AuthScopes value object to allow apps to easily check whether scopes have been updated. #110

Fixed

GraphQL Proxy attempts to parse the request body as JSON before passing it to the client. #106

[0.4.0] - 2021-02-10

Added

Webhooks types are now exported outside the library #91
Added support for private apps #99
USER_AGENT_PREFIX added to Context, to add agent to all requests #101
Add link to tutorial on how to rotate credentials if neccesary #107

Fixed

Export withSession utility method #96
GraphQL Client appropriately handles queries with variables #97
Use cryptographically random bytes to generate nonce #98
Stop using SameSite=none cookies for OAuth, using lax instead #100

[0.3.1] - 2021-02-03

Fixed

Fixed an issue when deleting the current session for embedded apps #88

[0.3.0] - 2021-01-27

Added

Add withSession utility method #83

Fixed

Refactor library public interface #87
Check if a webhook is registered before calling Shopify #82

[0.2.2] - 2021-01-14

Fixed

Ensure that the OAuth session expiration matches the cookie expiration #72 / #73

[0.2.0] - 2021-01-13

Preserve the OAuth cookie session for a few seconds so SPA can perform their initial load using it #70
Session fetches now return undefined when a session is not available #64
Add deleteCurrentSession utils method #60

[0.1.0] - 2020-12-17

Beta release

[0.0.1] - 2020-12-17

Test releasing scripts
Start of Changelog

Files

CHANGELOG.md

Latest commit

History

CHANGELOG.md

File metadata and controls

Changelog

11.6.0

Minor Changes

Patch Changes

11.5.0

Minor Changes

Patch Changes

11.4.1

Patch Changes

11.4.0

Minor Changes

Patch Changes

11.3.0

Minor Changes

Patch Changes

11.2.0

Minor Changes

Patch Changes

11.1.0

Minor Changes

Patch Changes

11.0.1

Patch Changes

11.0.0

Major Changes

Minor Changes

Patch Changes

10.0.0

Major Changes

Patch Changes

9.7.2

Patch Changes

9.7.1

Patch Changes

9.7.0

Minor Changes

9.6.2

Patch Changes

9.6.1

Patch Changes

9.6.0

Minor Changes

9.5.1

Patch Changes

9.5.0

Minor Changes

Patch Changes

9.4.1

Patch Changes

9.4.0

Minor Changes

Patch Changes

9.3.2

Patch Changes

9.3.1

Patch Changes

9.3.0

Minor Changes

Patch Changes

9.2.0

Minor Changes

Patch Changes

9.1.0

Minor Changes

Patch Changes

9.0.2

Patch Changes

9.0.1

Patch Changes

9.0.0

Major Changes

Minor Changes

Patch Changes

8.1.1