release: 0.1.0-alpha.1

.github/workflows/ci.yml

@@ -6,6 +6,7 @@ on:
   pull_request:
     branches:
       - main
+      - next
 
 jobs:
   lint:
@@ -21,13 +22,30 @@ jobs:
         with:
           node-version: '18'
 
-      - name: Install dependencies
-        run: |
-          yarn install
+      - name: Bootstrap
+        run: ./scripts/bootstrap
 
       - name: Check types
-        run: |
-          yarn build
+        run: ./scripts/lint
+
+  build:
+    name: build
+    runs-on: ubuntu-latest
+
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Bootstrap
+        run: ./scripts/bootstrap
+
+      - name: Check build
+        run: ./scripts/build
   test:
     name: test
     runs-on: ubuntu-latest

.github/workflows/release-doctor.yml

@@ -1,6 +1,8 @@
 name: Release Doctor
 on:
   pull_request:
+    branches:
+      - main
   workflow_dispatch:
 
 jobs:
@@ -17,3 +19,4 @@ jobs:
           bash ./bin/check-release-environment
         env:
           NPM_TOKEN: ${{ secrets.BOOKLET_NPM_TOKEN || secrets.NPM_TOKEN }}
+

.gitignore

@@ -1,9 +1,10 @@
+.prism.log
 node_modules
 yarn-error.log
 codegen.log
 Brewfile.lock.json
 dist
-/deno
+dist-deno
 /*.tgz
 .idea/
 

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.0.1-alpha.1"
+  ".": "0.1.0-alpha.1"
 }

CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 0.1.0-alpha.1 (2025-01-18)
+
+Full Changelog: [v0.0.1-alpha.1...v0.1.0-alpha.1](https://github.com/contraptionco/booklet-node/compare/v0.0.1-alpha.1...v0.1.0-alpha.1)
+
+### Features
+
+* **api:** OpenAPI spec update via Stainless API ([#5](https://github.com/contraptionco/booklet-node/issues/5)) ([9f9c4e6](https://github.com/contraptionco/booklet-node/commit/9f9c4e64078f331bf01e944cd565f016df9582b9))
+* **api:** update via SDK Studio ([#7](https://github.com/contraptionco/booklet-node/issues/7)) ([b4832fe](https://github.com/contraptionco/booklet-node/commit/b4832fe2213779d8f59d6f0a7191d46486d4ad93))
+* **internal:** make git install file structure match npm ([#14](https://github.com/contraptionco/booklet-node/issues/14)) ([7be6b86](https://github.com/contraptionco/booklet-node/commit/7be6b86ff0f49a2dcbdc9c19927770e38004ca3c))
+
+
+### Bug Fixes
+
+* **client:** normalize method ([#20](https://github.com/contraptionco/booklet-node/issues/20)) ([d9d12fd](https://github.com/contraptionco/booklet-node/commit/d9d12fdd69451ad2ba1a2173d1ed261540835d1b))
+
+
+### Chores
+
+* **internal:** bump cross-spawn to v7.0.6 ([#16](https://github.com/contraptionco/booklet-node/issues/16)) ([e65eb19](https://github.com/contraptionco/booklet-node/commit/e65eb1996762efc9cbab31ed900dad0ef6a8b71d))
+* **internal:** codegen related update ([#19](https://github.com/contraptionco/booklet-node/issues/19)) ([a9637a6](https://github.com/contraptionco/booklet-node/commit/a9637a67a5691574b1f9256112e2a07460898751))
+* **internal:** codegen related update ([#21](https://github.com/contraptionco/booklet-node/issues/21)) ([f6c9ebd](https://github.com/contraptionco/booklet-node/commit/f6c9ebdb532a7a44740a10c05116a495e1f6d4c2))
+* **internal:** codegen related update ([#22](https://github.com/contraptionco/booklet-node/issues/22)) ([1bffa88](https://github.com/contraptionco/booklet-node/commit/1bffa8808e2c5c8df861da259fe448247c5aa532))
+* **internal:** codegen related update ([#23](https://github.com/contraptionco/booklet-node/issues/23)) ([7fdb428](https://github.com/contraptionco/booklet-node/commit/7fdb428f3ed4e0ac22a7321ee94bfde4386ad029))
+* **internal:** codegen related update ([#24](https://github.com/contraptionco/booklet-node/issues/24)) ([eb451a5](https://github.com/contraptionco/booklet-node/commit/eb451a5a9320d1383221d7772a15d222f7d35c54))
+* **internal:** remove unnecessary getRequestClient function ([#15](https://github.com/contraptionco/booklet-node/issues/15)) ([fb6add5](https://github.com/contraptionco/booklet-node/commit/fb6add5b2815fa11a00fefb1ec3b6e5f19d5bf89))
+* **internal:** update isAbsoluteURL ([#18](https://github.com/contraptionco/booklet-node/issues/18)) ([444c551](https://github.com/contraptionco/booklet-node/commit/444c551093f053027d44cafb2fafb7b2f889adcd))
+* rebuild project due to codegen change ([#10](https://github.com/contraptionco/booklet-node/issues/10)) ([21d7ffd](https://github.com/contraptionco/booklet-node/commit/21d7ffdf216113e48b5d0ece5ad9ca7768e5bb03))
+* rebuild project due to codegen change ([#11](https://github.com/contraptionco/booklet-node/issues/11)) ([b8d1379](https://github.com/contraptionco/booklet-node/commit/b8d13794f060c11e57c83f262a5b305ca215f8ed))
+* rebuild project due to codegen change ([#8](https://github.com/contraptionco/booklet-node/issues/8)) ([42c5432](https://github.com/contraptionco/booklet-node/commit/42c5432581e52d934a3e5bc8828c2e68a8f569ec))
+* rebuild project due to codegen change ([#9](https://github.com/contraptionco/booklet-node/issues/9)) ([9357498](https://github.com/contraptionco/booklet-node/commit/935749842956eda69d60880005b43790945da997))
+* remove redundant word in comment ([#13](https://github.com/contraptionco/booklet-node/issues/13)) ([7569cd5](https://github.com/contraptionco/booklet-node/commit/7569cd546273316f4de5fad7507aee4c84c9496e))
+* **types:** nicer error class types + jsdocs ([#17](https://github.com/contraptionco/booklet-node/issues/17)) ([56b5355](https://github.com/contraptionco/booklet-node/commit/56b53550e582c2b91a99aea3cb8f3460478e6839))
+
+
+### Documentation
+
+* remove suggestion to use `npm` call out ([#12](https://github.com/contraptionco/booklet-node/issues/12)) ([c23a86f](https://github.com/contraptionco/booklet-node/commit/c23a86fd4ba036653925f16d330093a404e46a80))
+
 ## 0.0.1-alpha.1 (2024-05-09)
 
 Full Changelog: [v0.0.1-alpha.0...v0.0.1-alpha.1](https://github.com/contraptionco/booklet-node/compare/v0.0.1-alpha.0...v0.0.1-alpha.1)

CONTRIBUTING.md

@@ -1,38 +1,38 @@
 ## Setting up the environment
 
-This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install/#mac-stable).
+This repository uses [`yarn@v1`](https://classic.yarnpkg.com/lang/en/docs/install).
 Other package managers may work but are not officially supported for development.
 
 To set up the repository, run:
 
-```bash
-yarn
-yarn build
+```sh
+$ 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.
+Most of the SDK is generated code. Modifications to code will be persisted between generations, but may
+result in merge conflicts between manual patches and changes from the generator. The generator will never
+modify the contents of the `src/lib/` and `examples/` directories.
 
 ## 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.
+All files in the `examples/` directory are not modified by the generator and can be freely edited or added to.
 
-```bash
+```ts
 // add an example to examples/<your-example>.ts
 
 #!/usr/bin/env -S npm run tsn -T
 …
 ```
 
-```
-chmod +x examples/<your-example>.ts
+```sh
+$ chmod +x examples/<your-example>.ts
 # run the example against your api
-yarn tsn -T examples/<your-example>.ts
+$ yarn tsn -T examples/<your-example>.ts
 ```
 
 ## Using the repository from source
@@ -41,38 +41,38 @@ If you’d like to use the repository from source, you can either install from g
 
 To install via git:
 
-```bash
-npm install git+ssh://git@github.com:contraptionco/booklet-node.git
+```sh
+$ npm install git+ssh://git@github.com:contraptionco/booklet-node.git
 ```
 
 Alternatively, to link a local copy of the repo:
 
-```bash
+```sh
 # Clone
-git clone https://www.github.com/contraptionco/booklet-node
-cd booklet-node
+$ git clone https://www.github.com/contraptionco/booklet-node
+$ cd booklet-node
 
 # With yarn
-yarn link
-cd ../my-package
-yarn link bklt
+$ yarn link
+$ cd ../my-package
+$ yarn link bklt
 
 # With pnpm
-pnpm link --global
-cd ../my-package
-pnpm link -—global bklt
+$ pnpm link --global
+$ cd ../my-package
+$ pnpm link -—global bklt
 ```
 
 ## 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 mock path/to/your/openapi.yml
+```sh
+$ npx prism mock path/to/your/openapi.yml
 ```
 
-```bash
-yarn run test
+```sh
+$ yarn run test
 ```
 
 ## Linting and formatting
@@ -82,14 +82,14 @@ This repository uses [prettier](https://www.npmjs.com/package/prettier) and
 
 To lint:
 
-```bash
-yarn lint
+```sh
+$ yarn lint
 ```
 
 To format and fix all lint issues automatically:
 
-```bash
-yarn fix
+```sh
+$ yarn fix
 ```
 
 ## Publishing and releases

LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright 2024 Booklet
+   Copyright 2025 Booklet
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.