CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and adheres to Semantic Versioning.

Unreleased

Added

• ⚠️ [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