@shipworthy/openapi-validator 0.0.1 → 1.0.0

package/README.md

@@ -13,14 +13,14 @@ of calling this package.
 ## Installation
 
 ```sh
-bun add @shipworthy/openapi-validator effect@^4.0.0
+bun add @shipworthy/openapi-validator effect@4.1.4
 ```
 
 ### Requirements
 
-- **Effect 4.** `effect` `^4.0.0` is a peer dependency. The public API is an Effect
-  `Context.Service` and an Effect `Schema` error. Install a compatible version so
-  every package shares one Effect instance.
+- **Effect 4.** The package depends on `effect` `4.1.4`. The public API is an Effect
+  `Context.Service` and an Effect `Schema` error. Add a compatible version to your
+  app so every package resolves to one Effect instance.
 - **ESM only.** The package is `"type": "module"` and has no CommonJS build.
 - **Node.js `>=22.19.0` or Bun.** The package ships compiled JavaScript and `.d.ts`
   declarations in `dist/`. No TypeScript loader or bundler is needed. Its public
@@ -301,7 +301,7 @@ custom rulesets, or per-rule overrides.
 - Output goes through Effect `Console` (`error` for blocking diagnostics, `warn`
   otherwise). Color is used only on a TTY without `NO_COLOR`.
 - Requirements: ESM only, compiled JavaScript and `.d.ts` declarations in `dist/`,
-  Node.js `>=22.19.0` or Bun, and peer dependency `effect@^4.0.0`.
+  Node.js `>=22.19.0` or Bun, and a dependency on `effect@4.1.4`.
 - The CLI equivalent is `openapi lint [--strict] <file-or-url>` from
   `@shipworthy/openapi-cli`.
 

package/dist/errors.d.ts

@@ -12,7 +12,9 @@ declare const LintError_base: Schema.Class<LintError, Schema.TaggedStruct<"LintE
         readonly path: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Finite]>>;
     }>>;
     readonly cause: Schema.optional<Schema.Defect>;
-}>, import("effect/Cause").YieldableError>;
+}>, import("effect/Cause").YieldableError & {
+    readonly brand: unique symbol;
+}>;
 export declare class LintError extends LintError_base {
 }
 export {};

package/dist/lint.js

@@ -3,7 +3,7 @@ import { oas3 } from "@stoplight/spectral-formats";
 // spectral-parsers is CommonJS without statically detectable named exports, so Node needs a default import.
 import spectralParsers from "@stoplight/spectral-parsers";
 import { oas } from "@stoplight/spectral-rulesets";
-import { Array as EffectArray, Config, Console, Context, Effect, Layer, Predicate } from "effect";
+import { Array as EffectArray, Config, Console, Context, Effect, Layer, pipe, Predicate, Record, String as EffectString, } from "effect";
 import { LintError } from "./errors.js";
 /** Same TTY and `NO_COLOR` check as `CliOutput.defaultFormatter`. */
 const colorsEnabled = Effect.gen(function* () {
@@ -26,7 +26,7 @@ function spectralRules(strict) {
     };
     if (strict)
         return rules;
-    for (const [id, rule] of Object.entries(oas.rules ?? {})) {
+    for (const [id, rule] of Record.toEntries(oas.rules ?? {})) {
         if (id === "operation-operationId-unique")
             continue;
         if (Predicate.isObject(rule) && "severity" in rule && rule.severity === 0) {
@@ -37,7 +37,7 @@ function spectralRules(strict) {
 }
 function isExampleRefRead(result) {
     return (result.code === "invalid-ref" &&
-        result.message.startsWith("ReadError:") &&
+        EffectString.startsWith("ReadError:")(result.message) &&
         result.path.includes("examples"));
 }
 function makeSpectral(strict) {
@@ -56,7 +56,7 @@ function makeSpectral(strict) {
 function spectralTarget(source, sourceUrl) {
     if (typeof source !== "string")
         return source;
-    if (source.trimStart().startsWith("{")) {
+    if (pipe(source, EffectString.trimStart, EffectString.startsWith("{"))) {
         return new Document(source, spectralParsers.Json, sourceUrl);
     }
     return new Document(source, spectralParsers.Yaml, sourceUrl);
@@ -65,7 +65,7 @@ function thrownMessage(cause) {
     return cause instanceof Error ? cause.message : String(cause);
 }
 function pathSegments(path) {
-    return path.filter((segment) => Predicate.isString(segment) || Predicate.isNumber(segment));
+    return EffectArray.filter(path, (segment) => Predicate.isString(segment) || Predicate.isNumber(segment));
 }
 export class Linter extends Context.Service()("@shipworthy/openapi-validator/Linter") {
     static layer = Layer.sync(Linter, () => {
@@ -97,7 +97,9 @@ export class Linter extends Context.Service()("@shipworthy/openapi-validator/Lin
             const red = paint("31", useColors);
             const yellow = paint("33", useColors);
             const failures = yield* Effect.forEach(results, Effect.fnUntraced(function* (result) {
-                const location = result.path.length ? ` at #/${result.path.join("/")}` : "";
+                const location = result.path.length
+                    ? ` at #/${pipe(result.path, EffectArray.map((segment) => `${segment}`), EffectArray.join("/"))}`
+                    : "";
                 const message = `${result.message}${location}`;
                 // Spectral's parser rejects merge tags this repo accepts, and example payloads
                 // use `$ref` as data. Those diagnostics are not document errors unless strict.
@@ -115,7 +117,7 @@ export class Linter extends Context.Service()("@shipworthy/openapi-validator/Lin
             })).pipe(Effect.map(EffectArray.filter(Predicate.isNotUndefined)));
             if (failures.length > 0) {
                 return yield* new LintError({
-                    message: failures.map((diagnostic) => diagnostic.message).join("\n"),
+                    message: EffectArray.join(EffectArray.map(failures, (diagnostic) => diagnostic.message), "\n"),
                     diagnostics: failures,
                 });
             }

package/package.json

@@ -1,17 +1,15 @@
 {
   "name": "@shipworthy/openapi-validator",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "files": [
     "dist"
   ],
   "dependencies": {
-    "@stoplight/spectral-core": "1.24.0",
+    "@stoplight/spectral-core": "1.24.1",
     "@stoplight/spectral-formats": "1.9.0",
     "@stoplight/spectral-parsers": "1.0.5",
-    "@stoplight/spectral-rulesets": "1.23.0"
-  },
-  "peerDependencies": {
-    "effect": "^4.0.0"
+    "@stoplight/spectral-rulesets": "1.23.1",
+    "effect": "4.1.4"
   },
   "description": "Lint an OpenAPI document.",
   "license": "MIT",
@@ -33,12 +31,11 @@
     "build": "rm -rf dist && tsc -p tsconfig.build.json"
   },
   "devDependencies": {
-    "@effect/vitest": "4.0.0",
+    "@effect/vitest": "4.1.4",
     "@shipworthy/typescript-config": "0.0.1",
-    "@types/node": "^24.10.3",
-    "effect": "^4.0.0",
+    "@types/node": "^26.6.6",
     "typescript": "^7.0.2",
-    "vitest": "5.0.3"
+    "vitest": "5.1.0"
   },
   "engines": {
     "node": ">=22.19.0"