japa-openapi-assertions 0.1.0

package/build/types.d.ts

@@ -0,0 +1,126 @@
+import type { ValidateFunction } from 'ajv';
+/**
+ * Plugin configuration options
+ */
+export interface PluginConfig {
+    /**
+     * Paths to OpenAPI specification files (JSON or YAML)
+     */
+    schemas: (string | URL)[];
+    /**
+     * Print coverage report to console on process exit
+     */
+    reportCoverage?: boolean;
+    /**
+     * Export coverage data to coverage.json on process exit
+     */
+    exportCoverage?: boolean;
+}
+/**
+ * Compiled validators for a single response
+ */
+export interface ResponseValidators {
+    body?: ValidateFunction;
+    headers?: ValidateFunction;
+}
+/**
+ * Compiled validators organized by path, method, and status code
+ */
+export interface CompiledValidators {
+    [path: string]: {
+        [method: string]: {
+            responses: {
+                [statusCode: string]: ResponseValidators;
+            };
+        };
+    };
+}
+/**
+ * Parsed response data from various HTTP client formats
+ */
+export interface ParsedResponse {
+    method: string;
+    path: string;
+    status: number;
+    headers: Record<string, string>;
+    body: unknown;
+}
+/**
+ * Validation error details
+ */
+export interface ValidationError {
+    path: string;
+    message: string;
+    keyword?: string;
+    expected?: unknown;
+    actual?: unknown;
+}
+/**
+ * Result of validating a response
+ */
+export interface ValidationResult {
+    valid: boolean;
+    errors?: ValidationError[];
+}
+/**
+ * Path matching result
+ */
+export interface PathMatchResult {
+    matched: string;
+    params: Record<string, string>;
+}
+/**
+ * Coverage entry for a single endpoint
+ */
+export interface CoverageEntry {
+    route: string;
+    method: string;
+    statuses: string[];
+}
+/**
+ * OpenAPI document types (simplified)
+ */
+export interface OpenAPIDocument {
+    openapi: string;
+    info: {
+        title: string;
+        version: string;
+    };
+    paths?: {
+        [path: string]: OpenAPIPathItem;
+    };
+    components?: {
+        schemas?: Record<string, unknown>;
+    };
+}
+export interface OpenAPIPathItem {
+    get?: OpenAPIOperation;
+    post?: OpenAPIOperation;
+    put?: OpenAPIOperation;
+    patch?: OpenAPIOperation;
+    delete?: OpenAPIOperation;
+    options?: OpenAPIOperation;
+    head?: OpenAPIOperation;
+    trace?: OpenAPIOperation;
+    parameters?: unknown[];
+}
+export interface OpenAPIOperation {
+    operationId?: string;
+    summary?: string;
+    description?: string;
+    responses?: {
+        [statusCode: string]: OpenAPIResponse;
+    };
+    requestBody?: unknown;
+    parameters?: unknown[];
+}
+export interface OpenAPIResponse {
+    description?: string;
+    content?: {
+        [mediaType: string]: {
+            schema?: unknown;
+        };
+    };
+    headers?: Record<string, unknown>;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,KAAK,CAAA;AAE3C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B;;OAEG;IACH,OAAO,EAAE,CAAC,MAAM,GAAG,GAAG,CAAC,EAAE,CAAA;IAEzB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,OAAO,CAAC,EAAE,gBAAgB,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC,CAAC,IAAI,EAAE,MAAM,GAAG;QACd,CAAC,MAAM,EAAE,MAAM,GAAG;YAChB,SAAS,EAAE;gBACT,CAAC,UAAU,EAAE,MAAM,GAAG,kBAAkB,CAAA;aACzC,CAAA;SACF,CAAA;KACF,CAAA;CACF;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,EAAE,MAAM,CAAA;IACd,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC/B,IAAI,EAAE,OAAO,CAAA;CACd;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,OAAO,CAAA;IAClB,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B,KAAK,EAAE,OAAO,CAAA;IACd,MAAM,CAAC,EAAE,eAAe,EAAE,CAAA;CAC3B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAC/B;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,KAAK,EAAE,MAAM,CAAA;IACb,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE;QACJ,KAAK,EAAE,MAAM,CAAA;QACb,OAAO,EAAE,MAAM,CAAA;KAChB,CAAA;IACD,KAAK,CAAC,EAAE;QACN,CAAC,IAAI,EAAE,MAAM,GAAG,eAAe,CAAA;KAChC,CAAA;IACD,UAAU,CAAC,EAAE;QACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KAClC,CAAA;CACF;AAED,MAAM,WAAW,eAAe;IAC9B,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,GAAG,CAAC,EAAE,gBAAgB,CAAA;IACtB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,MAAM,CAAC,EAAE,gBAAgB,CAAA;IACzB,OAAO,CAAC,EAAE,gBAAgB,CAAA;IAC1B,IAAI,CAAC,EAAE,gBAAgB,CAAA;IACvB,KAAK,CAAC,EAAE,gBAAgB,CAAA;IACxB,UAAU,CAAC,EAAE,OAAO,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,gBAAgB;IAC/B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,SAAS,CAAC,EAAE;QACV,CAAC,UAAU,EAAE,MAAM,GAAG,eAAe,CAAA;KACtC,CAAA;IACD,WAAW,CAAC,EAAE,OAAO,CAAA;IACrB,UAAU,CAAC,EAAE,OAAO,EAAE,CAAA;CACvB;AAED,MAAM,WAAW,eAAe;IAC9B,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,OAAO,CAAC,EAAE;QACR,CAAC,SAAS,EAAE,MAAM,GAAG;YACnB,MAAM,CAAC,EAAE,OAAO,CAAA;SACjB,CAAA;KACF,CAAA;IACD,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAClC"}

package/build/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":""}

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "japa-openapi-assertions",
+  "version": "0.1.0",
+  "description": "OpenAPI 3.1 Assertions plugin for Japa (fork of @japa/openapi-assertions)",
+  "type": "module",
+  "main": "build/index.js",
+  "types": "build/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./build/index.js",
+      "types": "./build/index.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=20.6.0"
+  },
+  "files": [
+    "build",
+    "!build/tests"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "typecheck": "tsc --noEmit",
+    "lint": "eslint src",
+    "test": "node --import tsx --test tests/**/*.spec.ts"
+  },
+  "dependencies": {
+    "ajv": "^8.17.1",
+    "ajv-formats": "^3.0.1",
+    "@seriousme/openapi-schema-validator": "^2.7.0",
+    "chalk": "^5.4.1"
+  },
+  "peerDependencies": {
+    "@japa/assert": "^4.0.0",
+    "@japa/runner": "^3.0.0 || ^4.0.0 || ^5.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.18",
+    "tsx": "^4.19.0",
+    "typescript": "~5.8"
+  },
+  "keywords": [
+    "openapi",
+    "openapi-3.1",
+    "japa",
+    "assert",
+    "api-testing",
+    "json-schema"
+  ],
+  "author": "Drew Daniels",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/drew-daniels/japa-openapi-assertions"
+  },
+  "homepage": "https://github.com/drew-daniels/japa-openapi-assertions#readme",
+  "bugs": {
+    "url": "https://github.com/drew-daniels/japa-openapi-assertions/issues"
+  }
+}