perseid 0.7.1 → 0.8.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (6) hide show
  1. package/NOTICE +24 -6
  2. package/README.md +7 -6
  3. package/checksums.json +4 -4
  4. package/package.json +2 -2
  5. package/LICENSE-Meteroid +0 -21
  6. package/LICENSE-Svix +0 -21
package/NOTICE CHANGED
@@ -1,11 +1,29 @@
1
1
  Perseid
2
2
  https://github.com/meteroid-oss/perseid
3
3
 
4
- Perseid is licensed under the Apache License 2.0 (LICENSE) and includes code
5
- from the following projects, under the MIT license:
4
+ Perseid is licensed under the Apache License 2.0 (see LICENSE).
6
5
 
7
- - Svix openapi-codegen and client libraries (https://github.com/svix/openapi-codegen)
8
- Copyright (c) 2021-2025 Svix. See LICENSE-Svix.
6
+ Perseid started as a fork of Svix openapi-codegen
7
+ (https://github.com/svix/openapi-codegen), distributed under the MIT license:
9
8
 
10
- - Meteroid clients (https://github.com/meteroid-oss/meteroid-clients)
11
- Copyright (c) 2025 Meteroid. See LICENSE-Meteroid.
9
+ The MIT License
10
+
11
+ Copyright (c) 2025 Svix (https://www.svix.com)
12
+
13
+ Permission is hereby granted, free of charge, to any person obtaining a copy
14
+ of this software and associated documentation files (the "Software"), to deal
15
+ in the Software without restriction, including without limitation the rights
16
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17
+ copies of the Software, and to permit persons to whom the Software is
18
+ furnished to do so, subject to the following conditions:
19
+
20
+ The above copyright notice and this permission notice shall be included in
21
+ all copies or substantial portions of the Software.
22
+
23
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
29
+ THE SOFTWARE.
package/README.md CHANGED
@@ -24,13 +24,13 @@ In the repository that holds your OpenAPI spec:
24
24
 
25
25
  ```sh
26
26
  npx perseid init # pick the languages and where the SDKs live
27
- gh secret set PERSEID_TOKEN # paste a fine-grained token, see below
27
+ gh secret set SDK_GITHUB_TOKEN # paste a fine-grained token, see below
28
28
  git add -A && git commit -m "ci: generate SDKs with perseid" && git push
29
29
  ```
30
30
 
31
31
  The push runs the `SDKs` workflow, which opens a pull request with every SDK.
32
32
 
33
- `PERSEID_TOKEN` is a [fine-grained token](https://github.com/settings/personal-access-tokens/new)
33
+ `SDK_GITHUB_TOKEN` is a [fine-grained token](https://github.com/settings/personal-access-tokens/new)
34
34
  with **Contents**, **Pull requests** and **Workflows** set to read and write, on this repository
35
35
  and the SDK repositories. Fine-grained tokens expire, and perseid warns 30 days before.
36
36
  `npx perseid app` sets up a GitHub App instead, which doesn't expire.
@@ -71,6 +71,7 @@ var pets = await petstore.Pets.ListAsync(new() { Limit = 10, Status = PetStatus.
71
71
  | Data | Cursor, page and offset pagination, server-sent events, file uploads |
72
72
  | Models | Enums and unions that keep values the SDK does not know, unknown properties sent back |
73
73
  | Webhooks | An opt-in [Standard Webhooks](https://www.standardwebhooks.com) verifier in every language |
74
+ | Tests | A test per operation in every SDK, run in process against the response the spec declares |
74
75
  | Docs | An `api.md` per SDK, regenerated with the code, and a README calling your API's own operations |
75
76
  | Specs | OpenAPI 3.0, 3.1 and 3.2, external `$ref`s, parameter styles, nullable and recursive schemas, webhook-only specs |
76
77
  | Customizing | Middleware, resource snippets, ejectable templates |
@@ -113,10 +114,10 @@ The Actions are pinned to the release line of the perseid that wrote them, such
113
114
  | One SDKs repository | `repo = "acme/api-sdks"` | `acme/api-sdks`, a folder per language |
114
115
 
115
116
  - perseid never creates repositories: `gh repo create acme/api-typescript`.
116
- - Add `PERSEID_TOKEN` to each SDK repository too: its release workflow uses it.
117
+ - Add `SDK_GITHUB_TOKEN` to each SDK repository too: its release workflow uses it.
117
118
  - Spec in another repository? Run `perseid init` in the SDKs repository, then
118
119
  `npx perseid connect acme/api-sdks` in the API repository. It writes a workflow pushing the
119
- spec, with a deploy key that reaches the SDKs repository only.
120
+ spec, as the App of `perseid app` or with a token.
120
121
  - A spec served at a URL needs no `connect`: `sdks.yml` fetches it daily.
121
122
 
122
123
  See [repository layouts](docs/ci.md#repository-layouts).
@@ -128,7 +129,7 @@ See [repository layouts](docs/ci.md#repository-layouts).
128
129
  | `init` | Write `perseid.toml` and the workflows. Local only: nothing is sent to GitHub. |
129
130
  | `generate` | Write the SDKs. `--out <dir>` previews, `--check` fails on drift, `--pr` opens pull requests. |
130
131
  | `connect <owner/repo>` | In the API repository: push the spec to the SDKs repository. |
131
- | `app` | Set up a GitHub App to open the pull requests instead of `PERSEID_TOKEN`. |
132
+ | `app` | Set up a GitHub App to open the pull requests instead of `SDK_GITHUB_TOKEN`. |
132
133
  | `status` | Check the setup: secrets, workflows, last spec pushed, open pull requests, last runs. |
133
134
  | `inspect` | Print the model the templates receive, as JSON. |
134
135
  | `eject <lang>` | Copy the built-in templates and runtime of a language to `.perseid/` to edit them. |
@@ -164,4 +165,4 @@ perseid started as a fork of [Svix's openapi-codegen](https://github.com/svix/op
164
165
 
165
166
  ## License
166
167
 
167
- Apache-2.0. Includes MIT-licensed code from Svix and Meteroid, see [NOTICE](NOTICE).
168
+ Apache-2.0, see [LICENSE](LICENSE). Third-party attributions are in [NOTICE](NOTICE).
package/checksums.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
- "perseid-aarch64-apple-darwin.tar.gz": "2eb0ac906bb4cecc3a0d1601534dcaa74b59662854b2da1591fd592ea184a34c",
3
- "perseid-aarch64-unknown-linux-musl.tar.gz": "854cc1802674c1696f58077331e00e681f4599b7c4f822c6e46e0a5e1a35d955",
4
- "perseid-x86_64-apple-darwin.tar.gz": "1e2eed57cc766b89759b12468b64cc4c2cb44fdbf9cd17d5b77fecd9f82a5901",
5
- "perseid-x86_64-unknown-linux-musl.tar.gz": "262bb046cd75aa312bdb53b52197923770c54b35f545bf5ba13e4cc59a7a482b"
2
+ "perseid-aarch64-apple-darwin.tar.gz": "fe9aafd26554d3d13acc2bce0c5c6888d704886da615aa0f4481195849b229aa",
3
+ "perseid-aarch64-unknown-linux-musl.tar.gz": "52d8da3778f3724575538d4097615176be8ae29d696c99aa8a1d6ae453939b81",
4
+ "perseid-x86_64-apple-darwin.tar.gz": "1f912dda16fd7a6a7f20bb1143c166e34f425bdcd50144f25a697d7b0ac9bb61",
5
+ "perseid-x86_64-unknown-linux-musl.tar.gz": "965235913d83116251993a424cb1791d09bdac84b6a2ba0b29f6568b0a330c01"
6
6
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "perseid",
3
- "version": "0.7.1",
3
+ "version": "0.8.0",
4
4
  "description": "OpenAPI in, idiomatic SDKs out: Rust, TypeScript, Python, Go, Java and C# from one static binary",
5
5
  "keywords": [
6
6
  "openapi",
@@ -10,7 +10,7 @@
10
10
  "generator"
11
11
  ],
12
12
  "homepage": "https://github.com/meteroid-oss/perseid",
13
- "license": "Apache-2.0 AND MIT",
13
+ "license": "Apache-2.0",
14
14
  "repository": {
15
15
  "type": "git",
16
16
  "url": "git+https://github.com/meteroid-oss/perseid.git"
package/LICENSE-Meteroid DELETED
@@ -1,21 +0,0 @@
1
- The MIT License
2
-
3
- Copyright (c) 2025 Meteroid (https://meteroid.com)
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.
package/LICENSE-Svix DELETED
@@ -1,21 +0,0 @@
1
- The MIT License
2
-
3
- Copyright (c) 2025 Svix (https://www.svix.com)
4
-
5
- Permission is hereby granted, free of charge, to any person obtaining a copy
6
- of this software and associated documentation files (the "Software"), to deal
7
- in the Software without restriction, including without limitation the rights
8
- to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
- copies of the Software, and to permit persons to whom the Software is
10
- furnished to do so, subject to the following conditions:
11
-
12
- The above copyright notice and this permission notice shall be included in
13
- all copies or substantial portions of the Software.
14
-
15
- THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
- IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
- FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
- AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
- LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
- OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
- THE SOFTWARE.