@pactflow/openapi-pact-comparator 0.0.1

package/dist/src/compare/index.d.ts

@@ -0,0 +1,8 @@
+import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
+import type { Pact } from "#documents/pact";
+import type { Result } from "#results/index";
+export declare class Comparator {
+    #private;
+    constructor(oas: OpenAPIV2.Document | OpenAPIV3.Document);
+    compare(pact: Pact): AsyncGenerator<Result>;
+}

package/dist/src/compare/requestBody.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareReqBody(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/requestHeader.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareReqHeader(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/requestPath.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareReqPath(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/requestQuery.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Result } from "#results/index";
+import type { Interaction } from "#documents/pact";
+import type { Config } from "#utils/config";
+export declare function compareReqQuery(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/requestSecurity.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareReqSecurity(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/responseBody.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareResBody(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, config: Config): Iterable<Result>;

package/dist/src/compare/responseHeader.d.ts

@@ -0,0 +1,6 @@
+import type Ajv from "ajv/dist/2019";
+import type Router from "find-my-way";
+import type { Interaction } from "#documents/pact";
+import type { Result } from "#results/index";
+import type { Config } from "#utils/config";
+export declare function compareResHeader(ajv: Ajv, route: Router.FindResult<Router.HTTPVersion.V1>, interaction: Interaction, index: number, _config: Config): Iterable<Result>;

package/dist/src/compare/setup.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
+import Ajv, { Options } from "ajv/dist/2019.js";
+import Router from "find-my-way";
+import type { Config } from "#utils/config";
+export declare function setupAjv(options: Options): Ajv;
+export declare function setupRouter(oas: OpenAPIV2.Document | OpenAPIV3.Document, config: Config): Router.Instance<Router.HTTPVersion.V1>;

package/dist/src/compare/utils/content.d.ts

@@ -0,0 +1,7 @@
+import type { SchemaObject } from "ajv";
+export declare function findMatchingType(requestType: string, responseTypes: string[]): string | undefined;
+export declare const getByContentType: (object: {} | undefined, contentType: string) => {
+    schema: SchemaObject;
+};
+export declare const standardHttpRequestHeaders: string[];
+export declare const standardHttpResponseHeaders: string[];

package/dist/src/compare/utils/parameters.d.ts

@@ -0,0 +1 @@
+export declare const cleanPathParameter: (s: string) => string;

package/dist/src/compare/utils/parse.d.ts

@@ -0,0 +1,5 @@
+import qs from "qs";
+type QueryStyle = "form" | "spaceDelimited" | "pipeDelimited" | "deepObject";
+export declare const parseQuery: (style: QueryStyle, explode: boolean) => (query: string) => qs.ParsedQs;
+export declare const parseValue: (query?: string | null) => string | string[] | qs.ParsedQs | null | undefined;
+export {};

package/dist/src/documents/oas.d.ts

@@ -0,0 +1,5 @@
+import type { OpenAPIV2, OpenAPIV3 } from "openapi-types";
+export declare const parse: (oas: OpenAPIV2.Document | OpenAPIV3.Document) => Promise<void>;
+export declare class ParserError extends Error {
+    constructor();
+}

package/dist/src/documents/pact.d.ts

@@ -0,0 +1,54 @@
+import { Static } from "@sinclair/typebox";
+import { ErrorObject } from "ajv";
+export declare const Interaction: import("@sinclair/typebox").TObject<{
+    type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    providerState: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    request: import("@sinclair/typebox").TObject<{
+        body: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnknown>;
+        headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+        method: import("@sinclair/typebox").TString;
+        path: import("@sinclair/typebox").TString;
+        query: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TString, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+    }>;
+    response: import("@sinclair/typebox").TObject<{
+        body: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnknown>;
+        headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+        status: import("@sinclair/typebox").TNumber;
+    }>;
+}>;
+export type Interaction = Static<typeof Interaction>;
+export declare const Pact: import("@sinclair/typebox").TObject<{
+    metadata: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+        pactSpecification: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            version: import("@sinclair/typebox").TString;
+        }>>;
+        pactSpecificationVersion: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        "pact-specification": import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
+            version: import("@sinclair/typebox").TString;
+        }>>;
+    }>>;
+    interactions: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        type: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        description: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        providerState: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        request: import("@sinclair/typebox").TObject<{
+            body: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnknown>;
+            headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+            method: import("@sinclair/typebox").TString;
+            path: import("@sinclair/typebox").TString;
+            query: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TString, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+        }>;
+        response: import("@sinclair/typebox").TObject<{
+            body: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnknown>;
+            headers: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNull, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>]>>;
+            status: import("@sinclair/typebox").TNumber;
+        }>;
+    }>>;
+}>;
+export type Pact = Static<typeof Pact>;
+export declare const parse: (pact: Pact) => Pact;
+export declare class ParserError extends Error {
+    errors: ErrorObject[];
+    constructor(errors: ErrorObject[]);
+}

package/dist/src/index.d.ts

@@ -0,0 +1 @@
+export * from "./compare";

package/dist/src/results/index.d.ts

@@ -0,0 +1,29 @@
+import type { ErrorObject } from "ajv";
+import type { Interaction } from "../documents/pact";
+type ErrorCode = "request.accept.incompatible" | "request.authorization.missing" | "request.body.incompatible" | "request.content-type.incompatible" | "request.header.incompatible" | "request.path-or-method.unknown" | "request.query.incompatible" | "response.body.incompatible" | "response.body.unknown" | "response.content-type.incompatible" | "response.header.incompatible" | "response.header.unknown" | "response.status.unknown";
+type WarningCode = "pact-broker.no-pacts-found" | "request.accept.unknown" | "request.body.unknown" | "request.content-type.missing" | "request.content-type.unknown" | "request.header.unknown" | "request.query.unknown" | "response.content-type.unknown" | "response.header.undefined" | "response.status.default";
+export interface Result {
+    code: ErrorCode | WarningCode;
+    message: string;
+    mockDetails?: {
+        interactionDescription?: string | null;
+        interactionState?: string | null;
+        location: string;
+        value: unknown;
+    };
+    specDetails?: {
+        location: string;
+        pathMethod?: string | null;
+        pathName?: string | null;
+        value: unknown;
+    };
+    type: "error" | "warning";
+}
+export declare const formatMessage: (error: ErrorObject) => string | undefined;
+export declare const formatInstancePath: (error: ErrorObject) => string;
+export declare const formatSchemaPath: (error: ErrorObject) => string;
+export declare const baseMockDetails: (interaction: Interaction) => {
+    interactionDescription: string | undefined;
+    interactionState: string;
+};
+export {};

package/dist/src/transform/index.d.ts

@@ -0,0 +1,3 @@
+export { transformRequestSchema } from "./requestSchema";
+export { transformResponseSchema } from "./responseSchema";
+export { minimumSchema } from "./minimumSchema";

package/dist/src/transform/minimumSchema.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIV3 } from "openapi-types";
+import { SchemaObject } from "ajv";
+export declare const minimumSchema: (originalSchema: SchemaObject, oas: OpenAPIV3.Document) => SchemaObject;

package/dist/src/transform/requestSchema.d.ts

@@ -0,0 +1,2 @@
+import { SchemaObject } from "ajv";
+export declare const transformRequestSchema: (schema: SchemaObject) => SchemaObject;

package/dist/src/transform/responseSchema.d.ts

@@ -0,0 +1,2 @@
+import { SchemaObject } from "ajv";
+export declare const transformResponseSchema: (schema: SchemaObject, noTransformNonNullableResponseSchema: boolean) => SchemaObject;

package/dist/src/utils/config.d.ts

@@ -0,0 +1,3 @@
+export type ConfigKeys = "cast-objects-in-pact" | "disable-multipart-formdata" | "ignore-duplicate-slashes" | "ignore-trailing-slash" | "legacy-parser" | "no-authorization-schema" | "no-percent-encoding" | "no-transform-non-nullable-response-schema" | "no-validate-complex-parameters" | "no-validate-request-body-unless-application-json";
+export type Config = Map<ConfigKeys, boolean>;
+export declare const DEFAULT_CONFIG: Config;

package/dist/src/utils/interaction.d.ts

@@ -0,0 +1,2 @@
+import type { Interaction } from "../documents/pact";
+export declare const isValidRequest: (interaction: Interaction) => boolean;

package/dist/src/utils/queryParams.d.ts

@@ -0,0 +1 @@
+export declare const ARRAY_SEPARATOR = ",";

package/dist/src/utils/quirks.d.ts

@@ -0,0 +1,3 @@
+import type { OpenAPIV3 } from "openapi-types";
+import type { SchemaObject } from "ajv";
+export declare const isSimpleSchema: (s: SchemaObject | undefined, oas: OpenAPIV3.Document) => boolean;

package/dist/src/utils/schema.d.ts

@@ -0,0 +1,6 @@
+import type { OpenAPIV3 } from "openapi-types";
+import type { SchemaObject } from "ajv";
+export declare const splitPath: (path: string) => string | string[];
+export declare const dereferenceOas: (schema: SchemaObject, oas: OpenAPIV3.Document) => any;
+export declare const traverse: (schema: SchemaObject, visitor: (schema: SchemaObject) => void) => void;
+export declare const traverseWithDereferencing: (schema: SchemaObject, visitor: (schema: SchemaObject) => void) => void;

package/dist/src/utils/validation.d.ts

@@ -0,0 +1,2 @@
+import Ajv, { AnySchema, ValidateFunction } from "ajv";
+export declare const getValidateFunction: (ajv: Ajv, schemaId: string, create: () => AnySchema) => ValidateFunction;

package/package.json

@@ -0,0 +1,83 @@
+{
+  "name": "@pactflow/openapi-pact-comparator",
+  "version": "0.0.1",
+  "description": "An OpenAPI Specification and Pact Comparison library",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "files": [
+    "dist"
+  ],
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs",
+      "types": "./dist/src/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "rollup --config",
+    "changeset:add": "changeset add",
+    "changeset:publish": "changeset publish",
+    "changeset:version": "changeset version",
+    "lint": "eslint --max-warnings=0",
+    "postinstall": "patch-package",
+    "prepare": "npm run build",
+    "prettier": "prettier --check .",
+    "prettier:fix": "prettier --cache --list-different --write .",
+    "start": "node dist/cli.mjs",
+    "test": "vitest",
+    "test:coverage": "vitest --coverage",
+    "typecheck": "tsc --project tsconfig.json"
+  },
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/pactflow/openapi-pact-comparator.git"
+  },
+  "author": {
+    "name": "Voon Siong Wong",
+    "email": "voon.wong@smartbear.com"
+  },
+  "license": "Apache-2.0",
+  "type": "module",
+  "devDependencies": {
+    "@apidevtools/swagger-parser": "10.1.1",
+    "@changesets/cli": "2.28.1",
+    "@eslint/js": "9.22.0",
+    "@pactflow/swagger-mock-validator": "14.5.0",
+    "@rollup/plugin-commonjs": "28.0.3",
+    "@rollup/plugin-json": "6.1.0",
+    "@rollup/plugin-node-resolve": "16.0.1",
+    "@rollup/plugin-typescript": "12.1.2",
+    "@sinclair/typebox": "0.34.30",
+    "@types/js-yaml": "4.0.9",
+    "@types/lodash-es": "4.17.12",
+    "@types/node": "22.13.10",
+    "@types/qs": "6.9.18",
+    "@vitest/coverage-v8": "3.0.9",
+    "ajv": "8.17.1",
+    "ajv-formats": "3.0.1",
+    "eslint": "9.22.0",
+    "eslint-config-prettier": "10.1.1",
+    "find-my-way": "9.2.0",
+    "js-yaml": "4.1.0",
+    "lodash-es": "4.17.21",
+    "parse-multipart-data": "1.5.0",
+    "patch-package": "8.0.0",
+    "prettier": "3.5.3",
+    "qs": "6.14.0",
+    "rollup": "4.36.0",
+    "tslib": "2.8.1",
+    "tsx": "4.19.3",
+    "typescript": "5.8.2",
+    "typescript-eslint": "8.26.1",
+    "vitest": "3.0.9"
+  },
+  "imports": {
+    "#compare/*": "./src/compare/*.ts",
+    "#documents/*": "./src/documents/*.ts",
+    "#results/*": "./src/results/*.ts",
+    "#transform/*": "./src/transform/*.ts",
+    "#utils/*": "./src/utils/*.ts"
+  }
+}