@shopify/shopify-api 5.1.0 → 6.0.0-rc2

package/CHANGELOG.md

@@ -7,6 +7,10 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
+## [6.0.0-rc2] - 2022-10-04
+
+- ⚠️ [Breaking] Final release candidate for `6.0.0` release, which is a complete breaking change across all surfaces of the library
+
 ## [5.1.0] - 2022-09-19
 
 - Increased tolerance for expired JWT session tokens from 5s to 10s [#462](https://github.com/Shopify/shopify-api-node/pull/462)

package/README.md

@@ -5,52 +5,142 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE.md)
 [![npm version](https://badge.fury.io/js/%40shopify%2Fshopify-api.svg)](https://badge.fury.io/js/%40shopify%2Fshopify-api)
 
-This library provides support for TypeScript/JavaScript [Shopify](https://www.shopify.com) apps to access the [Shopify Admin API](https://shopify.dev/docs/admin-api), by making it easier to perform the following actions:
+This library provides support for the backends of TypeScript/JavaScript [Shopify](https://www.shopify.com) apps to access the [Shopify Admin API](https://shopify.dev/docs/admin-api), by making it easier to perform the following actions:
 
-- Creating [online](https://shopify.dev/concepts/about-apis/authentication#online-access) or [offline](https://shopify.dev/concepts/about-apis/authentication#offline-access) access tokens for the Admin API via OAuth
+- Creating [online](https://shopify.dev/apps/auth#online-access) or [offline](https://shopify.dev/apps/auth#offline-access) access tokens for the Admin API via OAuth
 - Making requests to the [REST API](https://shopify.dev/docs/admin-api/rest/reference)
 - Making requests to the [GraphQL API](https://shopify.dev/docs/admin-api/graphql/reference)
 - Register/process webhooks
 
 Once your app has access to the Admin API, you can also access the [Shopify Storefront API](https://shopify.dev/docs/storefront-api) to run GraphQL queries using the `unauthenticated_*` access scopes.
 
-This library can be used in any application that has a Node.js backend, since it doesn't rely on any specific framework—you can include it alongside your preferred stack and only use the features that you need to build your app.
+This library can be used in any application that runs on one of the supported runtimes. It doesn't rely on any specific framework, so you can include it alongside your preferred stack and only use the features that you need to build your app.
 
-# Requirements
+**Note**: this package will enable your app's backend to work with Shopify APIs, but you'll need to use [Shopify App Bridge](https://shopify.dev/apps/tools/app-bridge) in your frontend if you're planning on embedding your app into the Shopify Admin.
+
+## Requirements
 
 To follow these usage guides, you will need to:
 
-- have a basic understanding of [Node.js](https://nodejs.org)
+- have a basic understanding of [TypeScript](https://www.typescriptlang.org/)
 - have a Shopify Partner account and development store
 - _OR_ have a test store where you can create a private app
 - have a private or custom app already set up in your test store or partner account
 - use [ngrok](https://ngrok.com), in order to create a secure tunnel to your app running on your localhost
 - add the `ngrok` URL and the appropriate redirect for your OAuth callback route to your app settings
-- have [yarn](https://yarnpkg.com) installed
+- have a JavaScript package manager such as [yarn](https://yarnpkg.com) installed
+
+## Getting started
+
+To install this package, you can run this on your terminal:
+
+```bash
+# You can use your preferred Node package manager
+yarn add @shopify/shopify-api
+```
+
+**Note**: throughout these docs, we'll provide some examples of how this library may be used in an app using the [Express.js](https://expressjs.com/) framework for simplicity, but you can use it with any framework you prefer, as mentioned before.
+
+The first thing you need to import is the adapter for your app's runtime. This will internally set up the library to use the right defaults and behaviours for the runtime.
+
+<div>Node.js
+
+```ts
+import '@shopify/shopify-api/adapters/node';
+```
+
+</div><div>CloudFlare Worker
+
+```ts
+import '@shopify/shopify-api/adapters/cf-worker';
+```
+
+</div>
+
+Next, configure the library - you'll need some values in advance:
+
+- Your app's API key from [Partners dashboard](https://www.shopify.com/partners)
+- Your app's API secret from Partners dashboard
+- The [scopes](https://shopify.dev/api/usage/access-scopes) you need for your app
 
-<!-- Make sure this section is in sync with docs/README.md -->
+Call `shopifyApi` to create your library object before setting up your app itself:
 
-# Getting started
+```ts
+import '@shopify/shopify-api/adapters/node';
+import {shopifyApi, LATEST_API_VERSION} from '@shopify/shopify-api';
+import express from 'express';
 
-You can follow our [getting started guide](docs/), which will provide instructions on how to create an app using plain Node.js code, or the [Express](https://expressjs.com/) framework. Both examples are written in Typescript.
+const shopify = shopifyApi({
+  // The next 4 values are typically read from environment variables for added security
+  apiKey: 'APIKeyFromPartnersDashboard',
+  apiSecretKey: 'APISecretFromPartnersDashboard',
+  scopes: ['read_products'],
+  hostName: 'ngrok-tunnel-address',
+  ...
+});
 
-- [Getting started](docs/getting_started.md)
-  - [Install dependencies](docs/getting_started.md#install-dependencies)
-  - [Set up base files](docs/getting_started.md#set-up-base-files)
-  - [Set up environment](docs/getting_started.md#set-up-environment)
-  - [Set up Context](docs/getting_started.md#set-up-context)
-  - [Running your app](docs/getting_started.md#running-your-app)
-- [Performing OAuth](docs/usage/oauth.md)
-  - [Add a route to start OAuth](docs/usage/oauth.md#add-a-route-to-start-oauth)
-  - [Add your OAuth callback route](docs/usage/oauth.md#add-your-oauth-callback-route)
-  - [Fetching sessions](docs/usage/oauth.md#fetching-sessions)
+const app = express();
+```
+
+### Next steps
+
+Once you configure your app, you can use this package to access the Shopify APIs.
+See the specific documentation in the [Features section](#features) for instructions on how to get API access tokens and use them to query the APIs.
+
+As a general rule, apps will want to interact with the Admin API to fetch / submit data to Shopify.
+To do that, apps will need to:
+
+1. Create an Admin API access token by going through [the OAuth flow](docs/usage/oauth.md).
+1. Set up its own endpoints to:
+   1. [Fetch the current session](docs/usage/oauth.md#using-sessions) created in the OAuth process.
+   1. Create a [REST](docs/usage/rest.md) or [GraphQL](docs/usage/graphql.md) API client.
+   1. Use the client to query the appropriate [Admin API](https://shopify.dev/api/admin).
+
+### Configurations
+
+These are all the configuration values `shopifyApi` supports.
+
+| Value                           | Type                     | Required |       Default        | Description                                                                                                                                                                  |
+| ------------------------------- | ------------------------ | :------: | :------------------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| apiKey                          | `string`                 |   Yes    |          -           | API key from Partners Dashboard                                                                                                                                              |
+| apiSecretKey                    | `string`                 |   Yes    |          -           | API secret from Partners Dashboard                                                                                                                                           |
+| scopes                          | `string[] \| AuthScopes` |   Yes    |          -           | [App scopes](https://shopify.dev/api/usage/access-scopes)                                                                                                                    |
+| hostName                        | `string`                 |   Yes    |          -           | App host name in the format `my-host-name.com`. Do **not** include the scheme or leading or trailing slashes                                                                 |
+| hostScheme                      | `"https" \| "http"`      |    No    |      `"https"`       | The scheme for your app's public URL                                                                                                                                         |
+| apiVersion                      | `ApiVersion`             |    No    | `LATEST_API_VERSION` | API version your app will be querying. E.g. `ApiVersion.January20`                                                                                                           |
+| isEmbeddedApp                   | `boolean`                |    No    |        `true`        | Whether your app will run within the Shopify Admin                                                                                                                           |
+| sessionStorage                  | `SessionStorage`         |   Yes    | _Depends on runtime_ | The storage strategy for your user sessions. Learn more about the [available strategies](docs/usage/customsessions.md)                                                       |
+| isPrivateApp                    | `boolean`                |    No    |       `false`        | Whether you are building a private app for a store                                                                                                                           |
+| logFile                         | `string`                 |    No    |     `undefined`      | File path where the library may log some events                                                                                                                              |
+| userAgentPrefix                 | `string`                 |    No    |     `undefined`      | Any prefix you wish to include in the `User-Agent` for requests made by the library                                                                                          |
+| privateAppStorefrontAccessToken | `string`                 |    No    |     `undefined`      | Fixed Storefront API access token for private apps                                                                                                                           |
+| customShopDomains               | `(RegExp \| string)[]`   |    No    |     `undefined`      | Use this if you need to allow values other than `myshopify.com`                                                                                                              |
+| billing                         | `BillingConfig`          |    No    |     `undefined`      | Billing configurations. [See documentation](docs/usage/billing.md) for full description                                                                                      |
+| restResources                   | `ShopifyRestResources`   |    No    |          -           | Mounts the given REST resources onto the object. Must use the same version as `apiVersion`. Learn more about [using REST resources](docs/usage/rest.md#using-rest-resources) |
+
+## Features
+
+- [OAuth](docs/usage/oauth.md)
+  - [Start endpoint](docs/usage/oauth.md#start-endpoint)
+  - [Callback endpoint](docs/usage/oauth.md#callback-endpoint)
+  - [Using sessions](docs/usage/oauth.md#using-sessions)
   - [Detecting scope changes](docs/usage/oauth.md#detecting-scope-changes)
-- [Make a REST API call](docs/usage/rest.md)
-- [Make a GraphQL API call](docs/usage/graphql.md)
-- [Make a Storefront API call](docs/usage/storefront.md)
+- [REST Admin API client](docs/usage/rest.md)
+  - [Using REST resources](docs/usage/rest.md#using-rest-resources)
+- [GraphQL Admin API client](docs/usage/graphql.md)
+- [GraphqL Storefront API client](docs/usage/storefront.md)
 - [Webhooks](docs/usage/webhooks.md)
   - [Register a Webhook](docs/usage/webhooks.md#register-a-webhook)
   - [Process a Webhook](docs/usage/webhooks.md#process-a-webhook)
 - [Billing](docs/usage/billing.md)
+- [Adding custom runtimes](docs/usage/runtimes.md)
 - [Known issues and caveats](docs/issues.md)
   - [Notes on session handling](docs/issues.md#notes-on-session-handling)
+
+## Migrating to v6
+
+Before v6, this library only worked on Node.js runtimes. It now supports multiple runtimes through the use of adapters, more of which can be added over time.
+If an adapter for the runtime you wish to use doesn't exist, you can create your own adapter by implementing some key functions, or contribute a PR to this repository.
+
+In addition to updating the library to work on different runtimes, we've also improved its public interface to make it easier for apps to load only the features they need from the library.
+If you're upgrading an existing app on v5 or earlier, please see [the migration guide for v6](docs/migrating-to-v6.md).

package/dist/adapters/__e2etests__/test_apps/test-cf-worker-app.d.ts

@@ -0,0 +1,6 @@
+import '../../cf-worker';
+declare const _default: {
+    fetch(req: any, _env: any, _ctx: any): Promise<Response>;
+};
+export default _default;
+//# sourceMappingURL=test-cf-worker-app.d.ts.map

package/dist/adapters/__e2etests__/test_apps/test-cf-worker-app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-cf-worker-app.d.ts","sourceRoot":"","sources":["../../../../src/adapters/__e2etests__/test_apps/test-cf-worker-app.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,CAAC;;eAsCN,GAAG,QAAQ,GAAG,QAAQ,GAAG;;AAD5C,wBA2KE"}

package/dist/adapters/__e2etests__/test_apps/test-cf-worker-app.js

@@ -0,0 +1,178 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+require("../../cf-worker");
+var http_client_1 = require("../../../clients/http_client/http_client");
+var utils_1 = require("../utils");
+/* Codes for different Colours */
+var RED = '\x1b[31m';
+var GREEN = '\x1b[32m';
+var RESET = '\x1b[39m';
+var HttpClient = (0, http_client_1.createHttpClientClass)(utils_1.config, 'http');
+var defaultRetryTimer = HttpClient.RETRY_WAIT_TIME;
+var testCount = 0;
+function params(testRequest) {
+    return {
+        path: testRequest.url,
+        type: testRequest.bodyType,
+        data: JSON.stringify(testRequest.body),
+    };
+}
+function setRestClientRetryTime(time) {
+    // We de-type HttpClient here so we can alter its readonly time property
+    HttpClient.RETRY_WAIT_TIME = time;
+}
+/* eslint-disable-next-line import/no-anonymous-default-export */
+exports.default = {
+    fetch: function (req, _env, _ctx) {
+        return tslib_1.__awaiter(this, void 0, void 0, function () {
+            var apiServerPort, client, testConfig, testRequest, expectedResponse, tries, testPassed, timedOut_1, retryTimeout, testFailedDebug_1, response, _a, error_1;
+            return tslib_1.__generator(this, function (_b) {
+                switch (_b.label) {
+                    case 0:
+                        apiServerPort = parseInt(globalThis.HTTP_SERVER_PORT || '3000', 10);
+                        client = new HttpClient({
+                            domain: "localhost:".concat(apiServerPort),
+                        });
+                        if (!(req.method === 'POST')) return [3 /*break*/, 14];
+                        return [4 /*yield*/, req.json()];
+                    case 1:
+                        testConfig = _b.sent();
+                        testRequest = testConfig.testRequest;
+                        expectedResponse = testConfig.expectedResponse;
+                        tries = testRequest.tries || 1;
+                        testPassed = false;
+                        timedOut_1 = false;
+                        retryTimeout = void 0;
+                        testFailedDebug_1 = '';
+                        response = void 0;
+                        setRestClientRetryTime(defaultRetryTimer);
+                        testCount++;
+                        console.log("[cfWorker] testRequest #".concat(testCount, " = ").concat(JSON.stringify(testRequest, undefined, 2), "\n"));
+                        if (typeof testRequest.retryTimeoutTimer !== 'undefined') {
+                            setRestClientRetryTime(testRequest.retryTimeoutTimer);
+                            console.log("[cfWorker] RETRY_TIME_WAIT (BEFORE) = ".concat(HttpClient.RETRY_WAIT_TIME, "\n"));
+                            if (testRequest.retryTimeoutTimer !== 0) {
+                                console.log("[cfWorker] setting setTimeout @ ".concat(HttpClient.RETRY_WAIT_TIME, " ms\n"));
+                                retryTimeout = setTimeout(function () {
+                                    try {
+                                        throw new Error('Request was not retried within the interval defined by Retry-After, test failed');
+                                    }
+                                    catch (error) {
+                                        console.log("[cfWorker] ".concat(RED, "setTimeout fired!").concat(RESET, " @ ").concat(HttpClient.RETRY_WAIT_TIME, "\n"));
+                                        testFailedDebug_1 = JSON.stringify({
+                                            errorMessageReceived: error.message,
+                                        });
+                                        timedOut_1 = true;
+                                    }
+                                }, testRequest.retryTimeoutTimer);
+                            }
+                        }
+                        _a = testRequest.method.toLowerCase();
+                        switch (_a) {
+                            case 'get': return [3 /*break*/, 2];
+                            case 'post': return [3 /*break*/, 6];
+                            case 'put': return [3 /*break*/, 8];
+                            case 'delete': return [3 /*break*/, 10];
+                        }
+                        return [3 /*break*/, 12];
+                    case 2:
+                        _b.trys.push([2, 4, , 5]);
+                        return [4 /*yield*/, client.get({
+                                path: testRequest.url,
+                                tries: tries,
+                                extraHeaders: testRequest.headers,
+                            })];
+                    case 3:
+                        response = _b.sent();
+                        if (timedOut_1) {
+                            console.log("[cfWorker] timedOut=".concat(timedOut_1, ", testPassed=").concat(testPassed, ", testFailedDebug=").concat(testFailedDebug_1, "\n"));
+                        }
+                        else {
+                            testPassed =
+                                (0, utils_1.matchHeaders)(response.headers, expectedResponse.headers) && JSON.stringify(response.body) === expectedResponse.body;
+                            testFailedDebug_1 = JSON.stringify({
+                                bodyExpected: expectedResponse.body,
+                                bodyReceived: response.body,
+                                headersExpected: expectedResponse.headers,
+                                headersReceived: response.headers,
+                            });
+                        }
+                        return [3 /*break*/, 5];
+                    case 4:
+                        error_1 = _b.sent();
+                        testPassed = error_1.constructor.name.startsWith(expectedResponse.errorType);
+                        if (expectedResponse.errorType === 'HttpResponseError') {
+                            testPassed =
+                                testPassed &&
+                                    'response' in error_1 &&
+                                    'code' in error_1.response &&
+                                    error_1.response.code === expectedResponse.statusCode &&
+                                    'statusText' in error_1.response &&
+                                    error_1.response.statusText === expectedResponse.statusText;
+                        }
+                        if ('expectRequestId' in expectedResponse) {
+                            testPassed =
+                                testPassed &&
+                                    error_1.message.includes(expectedResponse.expectRequestId);
+                        }
+                        if ('errorMessage' in expectedResponse) {
+                            testPassed =
+                                testPassed && error_1.message === expectedResponse.errorMessage;
+                        }
+                        testFailedDebug_1 = JSON.stringify({
+                            statusCodeExpected: expectedResponse.statusCode,
+                            statusCodeReceived: error_1.code,
+                            statusTextExpected: expectedResponse.statusText,
+                            statusTextReceived: error_1.statusText,
+                            errorTypeExpected: expectedResponse.errorType,
+                            errorTypeReceived: error_1.constructor.name,
+                            errorMessageExpected: expectedResponse.errorMessage,
+                            errorMessageReceived: error_1.message,
+                        });
+                        return [3 /*break*/, 5];
+                    case 5: return [3 /*break*/, 13];
+                    case 6: return [4 /*yield*/, client.post(params(testRequest))];
+                    case 7:
+                        response = _b.sent();
+                        testPassed = JSON.stringify(response.body) === expectedResponse.body;
+                        return [3 /*break*/, 13];
+                    case 8: return [4 /*yield*/, client.put(params(testRequest))];
+                    case 9:
+                        response = _b.sent();
+                        testPassed = JSON.stringify(response.body) === expectedResponse.body;
+                        return [3 /*break*/, 13];
+                    case 10: return [4 /*yield*/, client.delete({ path: testRequest.url })];
+                    case 11:
+                        response = _b.sent();
+                        testPassed = JSON.stringify(response.body) === expectedResponse.body;
+                        return [3 /*break*/, 13];
+                    case 12:
+                        testPassed = false;
+                        _b.label = 13;
+                    case 13:
+                        if (typeof testRequest.retryTimeoutTimer !== 'undefined' &&
+                            testRequest.retryTimeoutTimer !== 0 &&
+                            typeof retryTimeout !== 'undefined') {
+                            clearTimeout(retryTimeout);
+                        }
+                        console.log("[cfWorker] test #".concat(testCount, " passed=").concat(testPassed ? GREEN : RED).concat(testPassed).concat(RESET, ", debug=").concat(JSON.stringify(testFailedDebug_1, undefined, 2), "\n"));
+                        if (testPassed) {
+                            return [2 /*return*/, new Response('Test passed!', { status: 200 })];
+                        }
+                        else {
+                            return [2 /*return*/, new Response(testFailedDebug_1, {
+                                    status: 500,
+                                    headers: {
+                                        'Content-Type': 'application/json',
+                                    },
+                                })];
+                        }
+                        return [3 /*break*/, 15];
+                    case 14: return [2 /*return*/, new Response('Ready!', { status: 200 })];
+                    case 15: return [2 /*return*/];
+                }
+            });
+        });
+    },
+};

package/dist/adapters/__e2etests__/test_apps/test-dummy-shopify-server.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=test-dummy-shopify-server.d.ts.map

package/dist/adapters/__e2etests__/test_apps/test-dummy-shopify-server.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-dummy-shopify-server.d.ts","sourceRoot":"","sources":["../../../../src/adapters/__e2etests__/test_apps/test-dummy-shopify-server.ts"],"names":[],"mappings":""}

package/dist/adapters/__e2etests__/test_apps/test-dummy-shopify-server.js

@@ -0,0 +1,201 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+/* global process */
+var http_1 = require("http");
+var test_config_types_1 = require("../test_config_types");
+var utils_1 = require("../utils");
+// eslint-disable-next-line no-process-env
+var port = parseInt(process.env.HTTP_SERVER_PORT || '3000', 10);
+var errorStatusText = 'Did not work';
+var requestId = 'Request id header';
+var tests = {
+    200: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)(),
+    },
+    custom: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)({
+            headers: { 'X-Not-A-Real-Header': 'some_value' },
+        }),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            headers: { 'X-Not-A-Real-Header': 'some_value' },
+        }),
+    },
+    lowercaseua: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)({
+            headers: { 'user-agent': 'My lowercase agent' },
+        }),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            headers: { 'user-agent': 'My lowercase agent' },
+        }),
+    },
+    uppercaseua: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)({
+            headers: { 'User-Agent': 'My agent' },
+        }),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            headers: { 'User-Agent': 'My agent' },
+        }),
+    },
+    deprecatedget: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            headers: {
+                'X-Shopify-API-Deprecated-Reason': 'This API endpoint has been deprecated',
+            },
+            body: JSON.stringify({ message: 'Some deprecated request' }),
+        }),
+    },
+    deprecatedpost: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            headers: {
+                'X-Shopify-API-Deprecated-Reason': 'This API endpoint has been deprecated',
+            },
+            body: JSON.stringify({
+                message: 'Some deprecated post request',
+                body: {
+                    query: 'some query',
+                },
+            }),
+        }),
+    },
+    403: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 403,
+            statusText: errorStatusText,
+            headers: { 'x-request-id': requestId },
+            body: JSON.stringify({ errors: 'Something went wrong!' }),
+        }),
+    },
+    404: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 404,
+            statusText: errorStatusText,
+            body: JSON.stringify({}),
+        }),
+    },
+    417: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 417,
+            statusText: 'Expectation Failed',
+        }),
+    },
+    429: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 429,
+            statusText: errorStatusText,
+            headers: { 'x-request-id': requestId },
+            body: JSON.stringify({ errors: 'Something went wrong!' }),
+        }),
+    },
+    wait: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 429,
+            statusText: errorStatusText,
+            headers: { 'Retry-After': (0.1).toString() },
+            body: JSON.stringify({ errors: 'Something went wrong!' }),
+        }),
+    },
+    500: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 500,
+            statusText: errorStatusText,
+            headers: { 'x-request-id': requestId },
+            body: JSON.stringify({}),
+        }),
+    },
+    error: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 500,
+            statusText: errorStatusText,
+            body: JSON.stringify({ errors: 'Something went wrong' }),
+        }),
+    },
+    detailederror: {
+        expectedRequest: (0, test_config_types_1.initTestRequest)(),
+        testResponse: (0, test_config_types_1.initTestResponse)({
+            statusCode: 500,
+            statusText: errorStatusText,
+            body: JSON.stringify({
+                errors: { title: 'Invalid title', description: 'Invalid description' },
+            }),
+        }),
+    },
+};
+var retryCount = 0;
+var server = (0, http_1.createServer)(function (req, res) {
+    var _a;
+    var lookup = (_a = req.url) === null || _a === void 0 ? void 0 : _a.match(/^\/url\/path\/([a-z0-9]*)$/);
+    var receivedHeaders = req.headers;
+    var code = lookup ? lookup[1] : '200';
+    var test = tests[code] || tests['200'];
+    var expectedRequest = test.expectedRequest;
+    var testResponse = test.testResponse;
+    if ((0, utils_1.matchHeaders)(receivedHeaders, expectedRequest.headers)) {
+        if (code === 'retries' && retryCount < 2) {
+            testResponse = tests['429'].testResponse;
+            retryCount += 1;
+        }
+        if (code === 'retrythenfail') {
+            if (retryCount === 0) {
+                testResponse = tests['500'].testResponse;
+                retryCount = 1;
+            }
+            else {
+                testResponse = tests['403'].testResponse;
+                // this is the end of the test, reset the counter
+                retryCount = 0;
+            }
+        }
+        if (code === 'retrythensuccess') {
+            if (retryCount === 0) {
+                testResponse = tests.wait.testResponse;
+                retryCount = 1;
+            }
+            else {
+                // this is the end of the test, reset the counter; response already defaults to success
+                retryCount = 0;
+            }
+        }
+        if (code === 'maxretries') {
+            testResponse = tests['500'].testResponse;
+        }
+    }
+    else {
+        // return an "expectation failed" message
+        testResponse = tests['417'].testResponse;
+        testResponse.body = JSON.stringify({
+            errors: {
+                message: 'There was a header mismatch between expected request and received request',
+                receivedHeaders: receivedHeaders,
+                expectedHeaders: expectedRequest.headers,
+            },
+        });
+    }
+    // console.log(response);
+    res.writeHead(testResponse.statusCode, testResponse.statusText, testResponse.headers);
+    res.end(testResponse.body);
+    // reset counters
+    if (code !== 'retries' && retryCount === 2) {
+        retryCount = 0;
+    }
+    if (code === 'endtest') {
+        handle(0);
+    }
+});
+function handle(_signal) {
+    process.exit(0);
+}
+process.on('SIGINT', handle);
+process.on('SIGTERM', handle);
+server.listen(port, function () {
+    console.log("Listening on :".concat(port));
+});

package/dist/adapters/__e2etests__/test_apps/test-node-app.d.ts

@@ -0,0 +1,2 @@
+import '../../node';
+//# sourceMappingURL=test-node-app.d.ts.map

package/dist/adapters/__e2etests__/test_apps/test-node-app.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"test-node-app.d.ts","sourceRoot":"","sources":["../../../../src/adapters/__e2etests__/test_apps/test-node-app.ts"],"names":[],"mappings":"AAEA,OAAO,YAAY,CAAC"}