@shipworthy/openapi-transformer 0.0.1 → 0.0.2
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.
- package/README.md +2 -2
- package/package.json +2 -5
package/README.md
CHANGED
|
@@ -14,7 +14,7 @@ bun add @shipworthy/openapi-transformer @shipworthy/openapi-parser effect @effec
|
|
|
14
14
|
|
|
15
15
|
Requirements:
|
|
16
16
|
|
|
17
|
-
- **`effect` `^4.0.0`.** It is a
|
|
17
|
+
- **`effect` `^4.0.0`.** It is a dependency. `decode` returns an `Effect` and the model types are Effect `Schema`s, so add a compatible version to your app so both resolve to one copy of `effect` to run and compose them.
|
|
18
18
|
- **`@shipworthy/openapi-parser`.** It is a dependency. You install it yourself to produce the input document, and its `bundleDocument` / `ParsedOpenApiFromString` are the usual entry points.
|
|
19
19
|
- **`@effect/platform-node` `^4.0.0`** (or `@effect/platform-bun`), only because the quick start imports `NodeServices` to provide services to the parser. This package does not depend on it.
|
|
20
20
|
- **ESM only** (`"type": "module"`). There is no CommonJS build. The package ships compiled JavaScript with `.d.ts` declarations, so no TypeScript loader or bundler is needed.
|
|
@@ -394,7 +394,7 @@ function requiresAuth(operation: ParsedOperation) {
|
|
|
394
394
|
|
|
395
395
|
## Key facts (for AI agents)
|
|
396
396
|
|
|
397
|
-
- Import from `@shipworthy/openapi-transformer`. It has one entry point, is ESM-only, ships compiled JavaScript,
|
|
397
|
+
- Import from `@shipworthy/openapi-transformer`. It has one entry point, is ESM-only, ships compiled JavaScript, depends on `effect` `^4.0.0`, and runs on Node.js `>=22.19.0` or Bun.
|
|
398
398
|
- Pipeline: `bundleDocument(source)` (from `@shipworthy/openapi-parser`, needs FileSystem/Path/HttpClient layers) → `decode(document)` → `ParsedService`.
|
|
399
399
|
- `decode` is `Schema.decodeEffect(ParsedServiceFromParsedOpenApi)`. It returns `Effect<ParsedService, Schema.SchemaError>` and needs no services. Run it with `Effect.runSync` or `Effect.runPromise`.
|
|
400
400
|
- Generators and plugins must type their input as `ParsedService` and walk it through the exported `Parsed*` types. Schema nodes are `ParsedSchema` (`JsonSchema | boolean`). Do not use a local `{ [key: string]: any }` stand-in.
|
package/package.json
CHANGED
|
@@ -1,13 +1,11 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@shipworthy/openapi-transformer",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.2",
|
|
4
4
|
"files": [
|
|
5
5
|
"dist"
|
|
6
6
|
],
|
|
7
7
|
"dependencies": {
|
|
8
|
-
"@shipworthy/openapi-parser": "0.0.
|
|
9
|
-
},
|
|
10
|
-
"peerDependencies": {
|
|
8
|
+
"@shipworthy/openapi-parser": "0.0.2",
|
|
11
9
|
"effect": "^4.0.0"
|
|
12
10
|
},
|
|
13
11
|
"description": "Decode a bundled OpenAPI object into the ParsedService HTTP meta model.",
|
|
@@ -33,7 +31,6 @@
|
|
|
33
31
|
"@effect/vitest": "4.0.0",
|
|
34
32
|
"@shipworthy/typescript-config": "0.0.1",
|
|
35
33
|
"@types/node": "^24.10.3",
|
|
36
|
-
"effect": "^4.0.0",
|
|
37
34
|
"typescript": "^7.0.2",
|
|
38
35
|
"vitest": "5.0.3"
|
|
39
36
|
},
|