@shopify/shopify-api 6.0.0-rc5 → 6.0.0-rc7

package/.eslintrc.js

@@ -0,0 +1,16 @@
+module.exports = {
+  env: {
+    browser: false,
+    es2021: true,
+  },
+  extends: ['plugin:@shopify/typescript', 'plugin:@shopify/prettier'],
+  ignorePatterns: ['dist/'],
+  rules: {
+    'import/no-named-as-default': 0,
+    'no-mixed-operators': 0,
+    'no-console': 0,
+    'lines-around-comment': 0,
+    'import/no-cycle': 0,
+    '@typescript-eslint/naming-convention': 0,
+  },
+};

package/.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @shopify/learn-libs-superteam

package/.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -0,0 +1,35 @@
+---
+name: '🐛 Bug Report'
+about: Something isn't working
+labels: 'Type: Bug 🐛'
+---
+
+# Issue summary
+
+Write a short description of the issue here ↓
+
+## Expected behavior
+
+What do you think should happen?
+
+## Actual behavior
+
+What actually happens?
+
+Tip: include an error message (in a `<details></details>` tag) if your issue is related to an error
+
+## Steps to reproduce the problem
+
+1.
+1.
+1.
+
+## Reduced test case
+
+The best way to get your bug fixed is to provide a [reduced test case](https://webkit.org/test-case-reduction/).
+
+---
+
+## Checklist
+
+- [ ] I have described this issue in a way that is actionable (if possible)

package/.github/ISSUE_TEMPLATE/ENHANCEMENT.md

@@ -0,0 +1,25 @@
+---
+name: '📈 Enhancement'
+about: Enhancement to our codebase that isn't a adding or changing a feature
+labels: 'Type: Enhancement 📈'
+---
+
+## Overview/summary
+
+...
+
+## Motivation
+
+> What inspired this enhancement?
+
+...
+
+### Area
+
+- [ ] Add any relevant `Area: <area>` labels to this issue
+
+---
+
+## Checklist
+
+- [ ] I have described this enhancement in a way that is actionable (if possible)

package/.github/ISSUE_TEMPLATE/FEATURE_REQUEST.md

@@ -0,0 +1,30 @@
+---
+name: '🙌 Feature Request'
+about: Suggest a new feature, or changes to an existing one
+labels: 'Type: Feature Request :raised_hands:'
+---
+
+## Overview
+
+...
+
+## Type
+
+- [ ] New feature
+- [ ] Changes to existing features
+
+## Motivation
+
+> What inspired this feature request? What problems were you facing?
+
+...
+
+### Area
+
+- [ ] Add any relevant `Area: <area>` labels to this issue
+
+---
+
+## Checklist
+
+- [ ] I have described this feature request in a way that is actionable (if possible)

package/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,34 @@
+<!--
+  ☝️How to write a good PR title:
+  - Prefix it with [Feature] (if applicable)
+  - Start with a verb, for example: Add, Delete, Improve, Fix…
+  - Give as much context as necessary and as little as possible
+  - Prefix it with [WIP] while it’s a work in progress
+-->
+
+### WHY are these changes introduced?
+
+Fixes #0000 <!-- link to issue if one exists -->
+
+<!--
+  Context about the problem that’s being addressed.
+-->
+
+### WHAT is this pull request doing?
+
+<!--
+  Summary of the changes committed.
+  Before / after screenshots appreciated for UI changes, if applicable.
+-->
+
+## Type of change
+
+- [ ] Patch: Bug (non-breaking change which fixes an issue)
+- [ ] Minor: New feature (non-breaking change which adds functionality)
+- [ ] Major: Breaking change (fix or feature that would cause existing functionality to not work as expected)
+
+## Checklist
+
+- [ ] I have added a changelog entry, prefixed by the type of change noted above
+- [ ] I have added/updated tests for this change
+- [ ] I have documented new APIs/updated the documentation for modified APIs (for public APIs)

package/.github/stale.yml

@@ -0,0 +1,42 @@
+# Configuration for probot-stale - https://github.com/probot/stale
+
+# Issues or Pull Requests with these labels will never be considered stale.
+# Set to `[]` to disable
+exemptLabels:
+  - Security
+
+# Label to use when marking as stale
+staleLabel: Stale
+
+pulls:
+  # Number of days of inactivity before an Issue or Pull Request becomes stale
+  daysUntilStale: 90
+
+  # Number of days of inactivity before a Pull Request with the stale label is closed.
+  # Set to false to disable. If disabled, issues still need to be closed manually,
+  # but will remain marked as stale.
+  daysUntilClose: 14
+
+  # Comment to post when marking as stale. Set to `false` to disable
+  markComment: >
+    This pull request has been automatically marked as stale because it has not had
+    activity in 90 days. It will be closed if no further activity occurs.
+
+issues:
+  # Number of days of inactivity before an Issue or Pull Request becomes stale
+  # TO-DO: the real value will be 90, this version is for testing
+  daysUntilStale: 1
+
+  # Issues labeled `Confirmed` are ignored
+  exemptLabels:
+    - Confirmed
+
+  # Number of days of inactivity before an Issue with the stale label is closed.
+  # Set to false to disable. If disabled, issues still need to be closed manually,
+  # but will remain marked as stale.
+  daysUntilClose: 14
+
+  # Comment to post when marking as stale. Set to `false` to disable
+  markComment: >
+    This issue has been automatically marked as stale because it has not had
+    activity in 90 days. It will be closed if no further activity occurs.

package/.github/workflows/ci.yml

@@ -0,0 +1,27 @@
+on: [push, pull_request]
+name: CI
+jobs:
+  CI:
+    name: CI (${{ matrix.version }})
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        version: [14, 16, 18]
+    steps:
+      - uses: actions/checkout@master
+      - uses: actions/setup-node@v1
+        with:
+          node-version: ${{ matrix.version }}
+      # TODO Remove the --ignore-engines flag when we drop support for Node 14
+      - name: Install
+        run: yarn install --ignore-engines
+      - name: Lint
+        run: yarn lint
+      - name: Test
+        run: yarn test
+      - name: Test REST resources
+        run: yarn test:rest_resources
+      - name: Test SessionStorage implementations
+        run: yarn test:session_storage
+      - name: Run isomorphic adapter tests
+        run: yarn test:adapters

package/.github/workflows/cla.yml

@@ -0,0 +1,22 @@
+name: Contributor License Agreement (CLA)
+
+on:
+  pull_request_target:
+    types: [opened, synchronize]
+  issue_comment:
+    types: [created]
+
+jobs:
+  cla:
+    runs-on: ubuntu-latest
+    if: |
+      (github.event.issue.pull_request 
+        && !github.event.issue.pull_request.merged_at
+        && contains(github.event.comment.body, 'signed')
+      ) 
+      || (github.event.pull_request && !github.event.pull_request.merged)
+    steps:
+      - uses: Shopify/shopify-cla-action@v1
+        with:
+          github-token: ${{ secrets.GITHUB_TOKEN }}
+          cla-token: ${{ secrets.CLA_TOKEN }}

package/.github/workflows/markdown_link_check.yml

@@ -0,0 +1,12 @@
+name: Check Markdown links
+
+on: push
+
+jobs:
+  markdown-link-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@master
+      - uses: gaurav-nelson/github-action-markdown-link-check@v1
+        with:
+          config-file: '.github/workflows/markdown_link_checker_config.json'

package/.github/workflows/markdown_link_checker_config.json

@@ -0,0 +1,4 @@
+{
+  "retryOn429": true,
+  "fallbackRetryDelay": "1s"
+}

package/CHANGELOG.md

@@ -7,9 +7,9 @@ and adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 ## Unreleased
 
-## [6.0.0-rc2] - 2022-10-04
+## [6.0.0-rc7] - 2022-10-25
 
-- ⚠️ [Breaking] Final release candidate for `6.0.0` release, which is a complete breaking change across all surfaces of the library
+- ⚠️ [Breaking] Latest 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
 

package/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all
+people who contribute through reporting issues, posting feature
+requests, updating documentation, submitting pull requests or patches,
+and other activities.
+
+We are committed to making participation in this project a
+harassment-free experience for everyone, regardless of level of
+experience, gender, gender identity and expression, sexual orientation,
+disability, personal appearance, body size, race, ethnicity, age,
+religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery
+- Personal attacks
+- Trolling or insulting/derogatory comments
+- Public or private harassment
+- Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+- Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit,
+or reject comments, commits, code, wiki edits, issues, and other
+contributions that are not aligned to this Code of Conduct, or to ban
+temporarily or permanently any contributor for other behaviors that they
+deem inappropriate, threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves
+to fairly and consistently applying these principles to every aspect of
+managing this project. Project maintainers who do not follow or enforce
+the Code of Conduct may be permanently removed from the project team.
+
+This Code of Conduct applies both within project spaces and in public
+spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may
+be reported by contacting a project maintainer at <opensource@shopify.com>.
+All complaints will be reviewed and investigated and will result in a response
+that is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an incident.
+
+This Code of Conduct is adapted from the Contributor Covenant, version
+1.3.0, available from http://contributor-covenant.org/version/1/3/0/

package/CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributing
+
+We welcome your contributions to the project. There are a few steps to take when looking to make a contribution.
+
+- Open an issue to discuss the feature/bug
+- If feature/bug is deemed valid then fork repo.
+- Implement patch to resolve issue.
+- Include tests to prevent regressions and validate the patch.
+- Update the docs for any API changes.
+- Submit a pull request.
+
+# Bug Reporting
+
+Shopify API Library for Node uses GitHub issue tracking to manage bugs, please open an issue there.
+
+# Feature Request
+
+You can open a new issue on the GitHub issues and describe the feature you would like to see.
+
+# Developing the library
+
+Requirements:
+
+- [Node](https://nodejs.org/en/) v14 or above
+- [Yarn](https://yarnpkg.com/) v1.22 or above
+
+You can set up your development environment by running the following:
+
+```
+git clone git@github.com:Shopify/shopify-api-node.git # get the code
+cd shopify-node-api                                   # change into the source directory
+yarn install                                          # install dependencies
+yarn build                                            # build library
+```
+
+Helpful commands
+
+- `yarn lint` will run linting to make sure your code is of high standard
+- `yarn test` will run testing to ensure your code is covered by test cases

package/RELEASING.md

@@ -0,0 +1,77 @@
+# Releasing shopify-node-api
+
+1. Check the Semantic Versioning page for info on how to version the new release: [http://semver.org](http://semver.org)
+
+1. Ensure your local repo is up-to-date
+
+   ```shell
+   git checkout main && git pull
+   ```
+
+1. Add an entry for the new release to `CHANGELOG.md`, and/or move the contents from the _Unreleased_ to the new release
+
+1. Increment the version in `lib/version.ts`.
+
+1. Stage the `CHANGELOG.md` and `lib/version.ts` files
+
+   ```shell
+   git add CHANGELOG.md lib/version.ts
+   ```
+
+1. The following command updates the version (in `package.json`), creates the appropriate tag, commits all staged changes and pushes to the remote repository
+
+   ```shell
+   yarn version [ --patch | --minor | --major ]
+   ```
+
+   Select the applicable option to the `yarn version` command to increment the corresponding part of the version number, i.e., for a version of `x.y.z`,
+
+   - `--patch` to increment the `z`
+   - `--minor` to increment the `y`
+   - `--major` to increment the `x`
+
+   The `preversion` and `postversion` scripts in `package.json` take care of the pre (testing) and post (pushing) actions.
+
+1. Login to `shipit` and press _Deploy_ on the appropriate commit (the commit description will be the version number).
+
+## Release Candidates
+
+For significant API changes that could result in significant refactoring on the part of developers, consider releasing a few _Release Candidate_ versions in advance of the final version. `shipit` is configured to do this from the `shopify_api_next` branch.
+
+1. Ensure your local repo is up-to-date
+
+   ```shell
+   git checkout shopify_api_next && git pull
+   ```
+
+1. (optional) Add an entry for the release candidate to `CHANGELOG.md`
+
+1. Increment the version in `lib/version.ts`, ensuring that it ends with `-rcN`, where `N` starts at `1` and increments with each Release Candidate.
+
+1. Update the version in `package.json` to match that in `lib/version.ts`
+
+1. Stage the `CHANGELOG.md`, `lib/version.ts`, and `package.json` files
+
+   ```shell
+   git add CHANGELOG.md lib/version.ts package.json
+   ```
+
+1. Commit the files to the repo
+
+   ```shell
+   git commit -m "Packaging for release vX.Y.Z-rcN"
+   ```
+
+1. Tag the commit with an _annotated_ tag (required for the `--follow-tags` of the `push` command). Note that it's very important that the tag includes `-rc` as part of the tag name - this is how `shipit` will recognize that it's a release candidate, not a general release.
+
+   ```shell
+   git tag -a vX.Y.Z-rcN -m "Release candidate N of version X.Y.Z"
+   ```
+
+1. Push the files to the remote repository, along with the annotated tag.
+
+   ```shell
+   git push origin shopify_api_next --follow-tags
+   ```
+
+1. Login to `shipit`, search for the _next_ environment for `shopify-api-node`, and press _Deploy_ on the appropriate commit (the commit description will be the version number).

package/adapters/__e2etests__/.env.test

@@ -0,0 +1 @@
+HTTP_SERVER_PORT=9999

package/adapters/__e2etests__/rollup.test-cf-worker-app.config.d.ts

@@ -0,0 +1,10 @@
+declare const _default: {
+    input: string;
+    output: {
+        dir: string;
+        format: string;
+    };
+    plugins: import("rollup").Plugin[];
+};
+export default _default;
+//# sourceMappingURL=rollup.test-cf-worker-app.config.d.ts.map

package/adapters/__e2etests__/rollup.test-cf-worker-app.config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rollup.test-cf-worker-app.config.d.ts","sourceRoot":"","sources":["rollup.test-cf-worker-app.config.ts"],"names":[],"mappings":";;;;;;;;AAKA,wBAqBE"}

package/adapters/__e2etests__/rollup.test-cf-worker-app.config.js

@@ -0,0 +1,30 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+var tslib_1 = require("tslib");
+var rollup_plugin_swc_1 = tslib_1.__importDefault(require("rollup-plugin-swc"));
+var plugin_node_resolve_1 = tslib_1.__importDefault(require("@rollup/plugin-node-resolve"));
+var plugin_commonjs_1 = tslib_1.__importDefault(require("@rollup/plugin-commonjs"));
+/* eslint-disable-next-line import/no-anonymous-default-export */
+exports.default = {
+    input: 'adapters/__e2etests__/test_apps/test-cf-worker-app.js',
+    output: {
+        dir: 'bundle',
+        format: 'esm',
+    },
+    plugins: [
+        (0, plugin_node_resolve_1.default)({
+            extensions: ['.ts', '.js'],
+            browser: true,
+        }),
+        (0, plugin_commonjs_1.default)(),
+        (0, rollup_plugin_swc_1.default)({
+            jsc: {
+                parser: {
+                    syntax: 'typescript',
+                },
+                target: 'es2022',
+            },
+        }),
+    ],
+};
+//# sourceMappingURL=rollup.test-cf-worker-app.config.js.map

package/adapters/__e2etests__/rollup.test-cf-worker-app.config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rollup.test-cf-worker-app.config.js","sourceRoot":"","sources":["rollup.test-cf-worker-app.config.ts"],"names":[],"mappings":";;;AAAA,gFAAoC;AACpC,4FAAsD;AACtD,oFAA0C;AAE1C,iEAAiE;AACjE,kBAAe;IACb,KAAK,EAAE,uDAAuD;IAC9D,MAAM,EAAE;QACN,GAAG,EAAE,QAAQ;QACb,MAAM,EAAE,KAAK;KACd;IACD,OAAO,EAAE;QACP,IAAA,6BAAW,EAAC;YACV,UAAU,EAAE,CAAC,KAAK,EAAE,KAAK,CAAC;YAC1B,OAAO,EAAE,IAAI;SACd,CAAC;QACF,IAAA,yBAAG,GAAE;QACL,IAAA,2BAAG,EAAC;YACF,GAAG,EAAE;gBACH,MAAM,EAAE;oBACN,MAAM,EAAE,YAAY;iBACrB;gBACD,MAAM,EAAE,QAAQ;aACjB;SACF,CAAC;KACH;CACF,CAAC"}

package/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":["test-cf-worker-app.ts"],"names":[],"mappings":"AAAA,OAAO,iBAAiB,CAAC;;eAsCN,GAAG,QAAQ,GAAG,QAAQ,GAAG;;AAD5C,wBA2KE"}