@shipworthy/openapi-cli 0.0.1 → 0.0.2

package/README.md

@@ -13,7 +13,7 @@
 Install the CLI and the generator packages you need as dev dependencies. The CLI brings its own dependencies (`effect` `^4.0.0`, `@effect/platform-node` `^4.0.0`, `@shipworthy/openapi-generator`, `@shipworthy/openapi-parser`, `@shipworthy/overlay`, and `@shipworthy/openapi-validator`):
 
 ```sh
-bun add -d @shipworthy/openapi-cli @shipworthy/openapi-typescript effect@^4
+bun add -d @shipworthy/openapi-cli @shipworthy/openapi-typescript
 ```
 
 ### Optional peer dependencies (generators)
@@ -22,7 +22,7 @@ Install the generator package for each `generate` subcommand you use, at the sam
 
 | Command                            | Requires                                                                  | Notes                                                       |
 | ---------------------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------- |
-| `openapi generate typescript`      | `@shipworthy/openapi-typescript`                                          | That package peers on `effect@^4.0.0`.                      |
+| `openapi generate typescript`      | `@shipworthy/openapi-typescript`                                          |                                                             |
 | `openapi generate zod`             | `@shipworthy/openapi-zod` and `@shipworthy/openapi-typescript`            | Also writes `types.ts`.                                     |
 | `openapi generate tanstack-query`  | `@shipworthy/openapi-tanstack-query` and `@shipworthy/openapi-typescript` | Also writes `types.ts`.                                     |
 | `openapi generate standard-schema` | `@shipworthy/openapi-standard-schema`                                     |                                                             |
@@ -42,7 +42,7 @@ The generated files import packages at runtime, so your application needs those
 Run the `openapi` commands below in a package script, or use `bunx --bun @shipworthy/openapi-cli` in place of `openapi`.
 
 ```sh
-bun add -d @shipworthy/openapi-cli @shipworthy/openapi-typescript effect@^4
+bun add -d @shipworthy/openapi-cli @shipworthy/openapi-typescript
 bunx --bun @shipworthy/openapi-cli lint ./openapi.yaml
 bunx --bun @shipworthy/openapi-cli generate typescript ./openapi.yaml -o ./src/generated/types.ts
 ```
@@ -181,7 +181,9 @@ openapi overlay openapi.yaml --overlay selected.overlay.yaml --remove-unused-com
 
 Actions run sequentially against the bundled document. Supports RFC 9535 JSONPath, recursive
 object updates, array concatenation/appending, primitive replacement, copying from a single
-source node, and removal. A target matching no nodes has no effect. `extends` is metadata;
+source node, and removal. Invalid JSONPath target expressions and targets matching no nodes
+are skipped; the CLI logs each as a warning to stderr with its action number and target, then
+writes the result of the remaining actions. `extends` is metadata;
 `<input>` determines the document. The overlaid result is written directly without another
 bundling or validation pass.
 
@@ -395,7 +397,7 @@ openapi.pipe(
 );
 ```
 
-This requires `effect` `^4.0.0` and `@effect/platform-node` `^4.0.0`, which the CLI also depends on. Add them to your own `package.json` if your code imports them directly. No other functions or types are exported. For direct access to the generation pipeline, use `@shipworthy/openapi-generator`, `@shipworthy/openapi-parser`, and `@shipworthy/openapi-transformer`.
+This uses `effect` `^4.0.0` and `@effect/platform-node` `^4.0.0`. The CLI depends on both, but add them to your own `package.json` when your code imports them, using versions compatible with the CLI so they resolve to one copy. No other functions or types are exported. For direct access to the generation pipeline, use `@shipworthy/openapi-generator`, `@shipworthy/openapi-parser`, and `@shipworthy/openapi-transformer`.
 
 ## Errors and exit codes
 

package/dist/commands/overlay/command.js

@@ -1,4 +1,4 @@
-import { applyOverlay } from "@shipworthy/overlay";
+import { applyOverlayWithWarnings } from "@shipworthy/overlay";
 import { bundleDocument } from "@shipworthy/openapi-parser";
 import { Console, Effect, FileSystem, Path, Schema } from "effect";
 import { Argument, Command, Flag } from "effect/cli";
@@ -11,11 +11,12 @@ const run = Effect.fn("overlay")(function* ({ input, overlay, output, removeUnus
     const text = overlay.protocol === "file:"
         ? yield* fs.readFileString(fileURLToPath(overlay))
         : yield* HttpClient.get(overlay.href).pipe(Effect.flatMap(HttpClientResponse.filterStatusOk), Effect.flatMap((response) => response.text));
-    const result = yield* applyOverlay(document, text, { removeUnusedComponents });
+    const result = yield* applyOverlayWithWarnings(document, text, { removeUnusedComponents });
+    yield* Effect.forEach(result.warnings, (warning) => Console.warn(`WARNING Overlay action ${warning.action} (${warning.target}): ${warning.message}`), { discard: true });
     const path = yield* Path.Path;
     const outputPath = path.resolve(output);
     yield* fs.makeDirectory(path.dirname(outputPath), { recursive: true });
-    const serialized = yield* Schema.encodeEffect(Schema.fromJsonString(Schema.Unknown, { space: 2 }))(result);
+    const serialized = yield* Schema.encodeEffect(Schema.fromJsonString(Schema.Unknown, { space: 2 }))(result.document);
     yield* fs.writeFileString(outputPath, `${serialized}\n`);
     yield* Console.log(`${input.href} + ${overlay.href} → ${output}`);
 }, Effect.mapError(asCliError));

package/package.json

@@ -1,22 +1,22 @@
 {
   "name": "@shipworthy/openapi-cli",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "files": [
     "dist"
   ],
   "dependencies": {
     "@effect/platform-node": "^4.0.0",
-    "@shipworthy/openapi-generator": "0.0.1",
-    "@shipworthy/openapi-parser": "0.0.1",
-    "@shipworthy/openapi-validator": "0.0.1",
-    "@shipworthy/overlay": "0.0.1",
+    "@shipworthy/openapi-generator": "0.0.2",
+    "@shipworthy/openapi-parser": "0.0.2",
+    "@shipworthy/openapi-validator": "0.0.2",
+    "@shipworthy/overlay": "0.0.2",
     "effect": "^4.0.0"
   },
   "peerDependencies": {
-    "@shipworthy/openapi-standard-schema": "0.0.1",
-    "@shipworthy/openapi-tanstack-query": "0.0.1",
-    "@shipworthy/openapi-typescript": "0.0.1",
-    "@shipworthy/openapi-zod": "0.0.1"
+    "@shipworthy/openapi-standard-schema": "0.0.2",
+    "@shipworthy/openapi-tanstack-query": "0.0.2",
+    "@shipworthy/openapi-typescript": "0.0.2",
+    "@shipworthy/openapi-zod": "0.0.2"
   },
   "bin": {
     "openapi": "./dist/bin.js"
@@ -40,10 +40,10 @@
     "build": "rm -rf dist && tsc -p tsconfig.build.json && sed -i.bak '1s|^#!.*|#!/usr/bin/env node|' dist/bin.js && rm dist/bin.js.bak"
   },
   "devDependencies": {
-    "@shipworthy/openapi-standard-schema": "0.0.1",
-    "@shipworthy/openapi-tanstack-query": "0.0.1",
-    "@shipworthy/openapi-typescript": "0.0.1",
-    "@shipworthy/openapi-zod": "0.0.1",
+    "@shipworthy/openapi-standard-schema": "0.0.2",
+    "@shipworthy/openapi-tanstack-query": "0.0.2",
+    "@shipworthy/openapi-typescript": "0.0.2",
+    "@shipworthy/openapi-zod": "0.0.2",
     "@shipworthy/typescript-config": "0.0.1",
     "@types/node": "^24.10.3",
     "typescript": "^7.0.2",