Merge pull request #105 from orbcorp/release-please--branches--main--changes--next--components--orb-billing

release: 2.0.0

Author: sskhandek

.github/workflows/ci.yml

@@ -14,10 +14,10 @@ jobs:
     if: github.repository == 'orbcorp/orb-node'
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Set up Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '18'
 

.github/workflows/create-releases.yml

@@ -1,9 +1,13 @@
-# workflow for re-running publishing to NPM in case it fails for some reason
-# you can run this workflow by navigating to https://www.github.com/orbcorp/orb-node/actions/workflows/publish-npm.yml
+# This workflow is triggered when a GitHub release is created.
+# It can also be run manually to re-publish to NPM in case it failed for some reason.
+# You can run this workflow by navigating to https://www.github.com/orbcorp/orb-node/actions/workflows/publish-npm.yml
 name: Publish NPM
 on:
   workflow_dispatch:
 
+  release:
+    types: [published]
+
 jobs:
   publish:
     name: publish

.github/workflows/handle-release-pr-title-edit.yml

@@ -16,5 +16,4 @@ jobs:
         run: |
           bash ./bin/check-release-environment
         env:
-          STAINLESS_API_KEY: ${{ secrets.STAINLESS_API_KEY }}
           NPM_TOKEN: ${{ secrets.ORB_NPM_TOKEN || secrets.NPM_TOKEN }}

.github/workflows/publish-npm.yml

@@ -1,3 +1,3 @@
 {
-  ".": "1.41.0"
+  ".": "2.0.0"
 }

.github/workflows/release-doctor.yml

@@ -1,5 +1,48 @@
 # Changelog
 
+## 2.0.0 (2024-03-15)
+
+Full Changelog: [v1.41.0...v2.0.0](https://github.com/orbcorp/orb-node/compare/v1.41.0...v2.0.0)
+
+### ⚠ BREAKING CHANGES
+
+* remove brackets from array param names ([#109](https://github.com/orbcorp/orb-node/issues/109))
+
+### Features
+
+* **api:** add matrix with allocation price ([#125](https://github.com/orbcorp/orb-node/issues/125)) ([6f5326c](https://github.com/orbcorp/orb-node/commit/6f5326cf9880d411ef0195a6b30cdb7b28efb1ba))
+* **api:** create invoice metadata param ([#126](https://github.com/orbcorp/orb-node/issues/126)) ([fbd1fe2](https://github.com/orbcorp/orb-node/commit/fbd1fe2359c84af7e96e75be593d3802f104273e))
+* **api:** updates ([#123](https://github.com/orbcorp/orb-node/issues/123)) ([da21006](https://github.com/orbcorp/orb-node/commit/da21006557813e5840ad5c976cbc5f7cdb490d80))
+* **api:** updates ([#124](https://github.com/orbcorp/orb-node/issues/124)) ([b38e885](https://github.com/orbcorp/orb-node/commit/b38e885c10405d866051b49bec3110c388ebaa38))
+
+
+### Bug Fixes
+
+* remove brackets from array param names ([#109](https://github.com/orbcorp/orb-node/issues/109)) ([eb8d87a](https://github.com/orbcorp/orb-node/commit/eb8d87ab56e1c0f0aa1550488e1be9adfb82b46c))
+
+
+### Chores
+
+* **ci:** update actions/setup-node action to v4 ([#114](https://github.com/orbcorp/orb-node/issues/114)) ([cb18285](https://github.com/orbcorp/orb-node/commit/cb182857aab933915d07299375cec7556e64b22a))
+* **ci:** uses Stainless GitHub App for releases ([#111](https://github.com/orbcorp/orb-node/issues/111)) ([b32a3db](https://github.com/orbcorp/orb-node/commit/b32a3db0956464737a7692d47dee726a58870aa2))
+* **docs:** mention install from git repo ([#118](https://github.com/orbcorp/orb-node/issues/118)) ([80ab072](https://github.com/orbcorp/orb-node/commit/80ab072ce57e6caf6490e57302b67900c7a00702))
+* fix error handler in readme ([#119](https://github.com/orbcorp/orb-node/issues/119)) ([91ab80e](https://github.com/orbcorp/orb-node/commit/91ab80e3e3e07e9af2f6065594f29cae558a48e0))
+* **interal:** make link to api.md relative ([#104](https://github.com/orbcorp/orb-node/issues/104)) ([10b9053](https://github.com/orbcorp/orb-node/commit/10b9053e1cf9afc7a6ce3750650f9cee91ff5890))
+* **internal:** enable building when git installed ([#107](https://github.com/orbcorp/orb-node/issues/107)) ([9d6c4aa](https://github.com/orbcorp/orb-node/commit/9d6c4aa517116a5c5f9e2a242429f52cd86f88b8))
+* **internal:** re-order pagination import ([#106](https://github.com/orbcorp/orb-node/issues/106)) ([3869080](https://github.com/orbcorp/orb-node/commit/38690803e060a343400da766e4b783d4cc8b0d2a))
+* **internal:** refactor release environment script ([#112](https://github.com/orbcorp/orb-node/issues/112)) ([73a6e40](https://github.com/orbcorp/orb-node/commit/73a6e409f780f9961d22a2515f861d32a639e0ba))
+* **internal:** update deps ([#115](https://github.com/orbcorp/orb-node/issues/115)) ([42f5dcd](https://github.com/orbcorp/orb-node/commit/42f5dcd408f813ee4371a50095bb454d1173f30e))
+* respect `application/vnd.api+json` content-type header ([#110](https://github.com/orbcorp/orb-node/issues/110)) ([af334b3](https://github.com/orbcorp/orb-node/commit/af334b32adc1f446cb65b25f0fa670bbc18da170))
+
+
+### Documentation
+
+* add a CONTRIBUTING.md ([#108](https://github.com/orbcorp/orb-node/issues/108)) ([97829ba](https://github.com/orbcorp/orb-node/commit/97829ba3cef5cf3435bfa6bd467b24e83676168f))
+* **contributing:** improve wording ([#116](https://github.com/orbcorp/orb-node/issues/116)) ([154baf1](https://github.com/orbcorp/orb-node/commit/154baf11174879ba98ec0f8b6b298c69496ab537))
+* fix example of fetch overwrite ([d3cf8c0](https://github.com/orbcorp/orb-node/commit/d3cf8c0b94c49cc88ec0c5f70a36e85e121b13a8))
+* **readme:** fix https proxy example ([#120](https://github.com/orbcorp/orb-node/issues/120)) ([e284311](https://github.com/orbcorp/orb-node/commit/e2843116e45bbae8d532ebcc10bd9e0c84ff806c))
+* remove extraneous --save and yarn install instructions ([#121](https://github.com/orbcorp/orb-node/issues/121)) ([38785df](https://github.com/orbcorp/orb-node/commit/38785df64cf6ddaf07a103967856fbce3a56674c))
+
 ## 1.41.0 (2024-02-01)
 
 Full Changelog: [v1.40.0...v1.41.0](https://github.com/orbcorp/orb-node/compare/v1.40.0...v1.41.0)

.release-please-manifest.json

@@ -0,0 +1,107 @@
+## Setting up the environment
+
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+Other package managers may work but are not officially supported for development.
+
+To set up the repository, run:
+
+```bash
+yarn
+yarn build
+```
+
+This will install all the required dependencies and build output files to `dist/`.
+
+## Modifying/Adding code
+
+Most of the SDK is generated code, and any modified code will be overridden on the next generation. The
+`src/lib/` and `examples/` directories are exceptions and will never be overridden.
+
+## Adding and running examples
+
+All files in the `examples/` directory are not modified by the Stainless generator and can be freely edited or
+added to.
+
+```bash
+// add an example to examples/<your-example>.ts
+
+#!/usr/bin/env -S npm run tsn -T
+…
+```
+
+```
+chmod +x examples/<your-example>.ts
+# run the example against your api
+yarn tsn -T examples/<your-example>.ts
+```
+
+## Using the repository from source
+
+If you’d like to use the repository from source, you can either install from git or link to a cloned repository:
+
+To install via git:
+
+```bash
+npm install git+ssh://git@github.com:orbcorp/orb-node.git
+```
+
+Alternatively, to link a local copy of the repo:
+
+```bash
+# Clone
+git clone https://www.github.com/orbcorp/orb-node
+cd orb-node
+
+# With yarn
+yarn link
+cd ../my-package
+yarn link orb-billing
+
+# With pnpm
+pnpm link --global
+cd ../my-package
+pnpm link -—global orb-billing
+```
+
+## Running tests
+
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+
+```bash
+npx prism path/to/your/openapi.yml
+```
+
+```bash
+yarn run test
+```
+
+## Linting and formatting
+
+This repository uses [prettier](https://www.npmjs.com/package/prettier) and
+[eslint](https://www.npmjs.com/package/eslint) to format the code in the repository.
+
+To lint:
+
+```bash
+yarn lint
+```
+
+To format and fix all lint issues automatically:
+
+```bash
+yarn fix
+```
+
+## Publishing and releases
+
+Changes made to this repository via the automated release PR pipeline should publish to npm automatically. If
+the changes aren't made through the automated pipeline, you may want to make releases manually.
+
+### Publish with a GitHub workflow
+
+You can release to package managers by using [the `Publish NPM` GitHub action](https://www.github.com/orbcorp/orb-node/actions/workflows/publish-npm.yml). This requires a setup organization or repository secret to be set up.
+
+### Publish manually
+
+If you need to manually release a package, you can run the `bin/publish-npm` script with an `NPM_TOKEN` set on
+the environment.

CHANGELOG.md

@@ -4,19 +4,17 @@
 
 This library provides convenient access to the Orb REST API from server-side TypeScript or JavaScript.
 
-The REST API documentation can be found [on docs.withorb.com](https://docs.withorb.com/reference/api-reference). The full API of this library can be found in [api.md](https://www.github.com/orbcorp/orb-node/blob/main/api.md).
+The REST API documentation can be found [on docs.withorb.com](https://docs.withorb.com/reference/api-reference). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
 ```sh
-npm install --save orb-billing
-# or
-yarn add orb-billing
+npm install orb-billing
 ```
 
 ## Usage
 
-The full API of this library can be found in [api.md](https://www.github.com/orbcorp/orb-node/blob/main/api.md).
+The full API of this library can be found in [api.md](api.md).
 
 <!-- prettier-ignore -->
 ```js
@@ -68,7 +66,7 @@ a subclass of `APIError` will be thrown:
 async function main() {
   const customer = await orb.customers
     .create({ email: 'example-customer@withorb.com', name: 'My Customer' })
-    .catch((err) => {
+    .catch(async (err) => {
       if (err instanceof Orb.APIError) {
         console.log(err.status); // 400
         console.log(err.name); // BadRequestError
@@ -209,7 +207,7 @@ import Orb from 'orb-billing';
 ```
 
 To do the inverse, add `import "orb-billing/shims/node"` (which does import polyfills).
-This can also be useful if you are getting the wrong TypeScript types for `Response` - more details [here](https://github.com/orbcorp/orb-node/tree/main/src/_shims#readme).
+This can also be useful if you are getting the wrong TypeScript types for `Response` ([more details](https://github.com/orbcorp/orb-node/tree/main/src/_shims#readme)).
 
 You may also provide a custom `fetch` function when instantiating the client,
 which can be used to inspect or alter the `Request` or `Response` before/after each request:
@@ -240,18 +238,20 @@ If you would like to disable or customize this behavior, for example to use the
 <!-- prettier-ignore -->
 ```ts
 import http from 'http';
-import HttpsProxyAgent from 'https-proxy-agent';
+import { HttpsProxyAgent } from 'https-proxy-agent';
 
 // Configure the default for all requests:
 const orb = new Orb({
   httpAgent: new HttpsProxyAgent(process.env.PROXY_URL),
 });
 
 // Override per-request:
-await orb.customers.create({ email: 'example-customer@withorb.com', name: 'My Customer' }, {
-  baseURL: 'http://localhost:8080/test-api',
-  httpAgent: new http.Agent({ keepAlive: false }),
-})
+await orb.customers.create(
+  { email: 'example-customer@withorb.com', name: 'My Customer' },
+  {
+    httpAgent: new http.Agent({ keepAlive: false }),
+  },
+);
 ```
 
 ## Semantic Versioning

CONTRIBUTING.md

@@ -2,17 +2,13 @@
 
 errors=()
 
-if [ -z "${STAINLESS_API_KEY}" ]; then
-  errors+=("The STAINLESS_API_KEY secret has not been set. Please contact Stainless for an API key & set it in your organization secrets on GitHub.")
-fi
-
 if [ -z "${NPM_TOKEN}" ]; then
   errors+=("The ORB_NPM_TOKEN secret has not been set. Please set it in either this repository's secrets or your organization secrets")
 fi
 
-len=${#errors[@]}
+lenErrors=${#errors[@]}
 
-if [[ len -gt 0 ]]; then
+if [[ lenErrors -gt 0 ]]; then
   echo -e "Found the following errors in the release environment:\n"
 
   for error in "${errors[@]}"; do