@contract-case/case-connector 0.7.4 → 0.8.0

package/CHANGELOG.md

@@ -1,5 +1,82 @@
 # Changelog
 
+## [0.8.0](https://github.com/case-contract-testing/contract-case/compare/@contract-case/case-connector-v0.7.5...@contract-case/case-connector-v0.8.0) (2024-10-01)
+
+
+### ⚠ BREAKING CHANGES
+
+* BoundarySuccessWithAny is now always a json encoded string. Existing mappers will need to be updated.
+* Convert package to pure ESM
+* Split HTTP mock and matchers to their own packages
+
+### Features
+
+* Add BoundaryPluginLoader to facilitate loading of plugins ([2242e96](https://github.com/case-contract-testing/contract-case/commit/2242e960c93278d9fafdacce79d568b87200345c))
+* Add grpc messages for function invokers and responses ([1a45353](https://github.com/case-contract-testing/contract-case/commit/1a453539bc12bda8ccd1ec69f0d485c197eb43e6))
+* Add loadPlugin message to both contract definition and verification grpc streams ([5845808](https://github.com/case-contract-testing/contract-case/commit/584580849cc48eaf990a2b559ab85f29f0b571b6))
+* Add mockConfig to configuration object, allowing arbitrary configuration of mocks ([a9aa4f7](https://github.com/case-contract-testing/contract-case/commit/a9aa4f717095dde70e98742dd16dd3e20cc63b1d))
+* Expose invokeable functions through the javascript boundary ([39a1920](https://github.com/case-contract-testing/contract-case/commit/39a19206157962dc60e2f216fb13500c1f37b94d))
+
+
+### Bug Fixes
+
+* Fix issue where failures in verfication could cause the server to die ([6415824](https://github.com/case-contract-testing/contract-case/commit/64158247dccefbe40d41cdcbdc643014e0ef6c75))
+* Fix issue where failures were incorrectly mapped across core binary ([5ea3a1f](https://github.com/case-contract-testing/contract-case/commit/5ea3a1f028b2d6cc4b7ddb7edcfb92b228f23590))
+* Hardcode error names so that they're robust to minification ([3106196](https://github.com/case-contract-testing/contract-case/commit/3106196f909ef703ecb15e0f076933a987e69fc3))
+* Now loading plugins over grpc doesn't throw an error ([0137381](https://github.com/case-contract-testing/contract-case/commit/013738163d79d3fac8a27e88c77a6ee6b0e3fc1f))
+
+
+### Miscellaneous Chores
+
+* Split HTTP mock and matchers to their own packages ([bfc2e4f](https://github.com/case-contract-testing/contract-case/commit/bfc2e4ff2d464899fd8ce63978048e9f1991ff80))
+
+
+### Code Refactoring
+
+* BoundarySuccessWithAny is now always a json encoded string. Existing mappers will need to be updated. ([5fc4a7a](https://github.com/case-contract-testing/contract-case/commit/5fc4a7afc4b88ecc70e5d1d86f2e6f42a2486ae4))
+* Convert package to pure ESM ([64f5788](https://github.com/case-contract-testing/contract-case/commit/64f5788236d25f70092b6d1e5c4d2f4e0e412bc9))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @contract-case/case-core bumped from 0.15.7 to 0.16.0
+    * @contract-case/case-connector-proto bumped from 0.7.5 to 0.7.6
+    * @contract-case/case-entities-internal bumped from 0.15.7 to 0.16.0
+  * devDependencies
+    * @contract-case/case-maintainer-config bumped from 0.0.4 to 0.1.0
+    * @contract-case/eslint-config-case-maintainer bumped from 0.1.0 to 0.1.1
+
+## [0.7.5](https://github.com/case-contract-testing/contract-case/compare/@contract-case/case-connector-v0.7.4...@contract-case/case-connector-v0.7.5) (2024-05-16)
+
+
+### Features
+
+* Add case-boundary into the connector package ([072222f](https://github.com/case-contract-testing/contract-case/commit/072222f4b4f1eeddef461b0007bc5f431217fb7b))
+* Add internal config parameters to control whether verification is async or not ([6882739](https://github.com/case-contract-testing/contract-case/commit/68827393b0b766e753aeb77dcab123a2a01672fe))
+* Implement and expose contract verifier ([ea460cd](https://github.com/case-contract-testing/contract-case/commit/ea460cd5a915975673b2f22d98e05fab3b2b1cba))
+
+
+### Bug Fixes
+
+* Correct typing issue with trigger handles ([c7c4b47](https://github.com/case-contract-testing/contract-case/commit/c7c4b47b1d43d98235ac188c6444e27913b1b121))
+* Ensure that response ID is present in the maintainer logs ([bcda125](https://github.com/case-contract-testing/contract-case/commit/bcda1258520a87a358fb9369fe1a4b9e77356a9c))
+* Fix issue where the verification endpoint wasn't exposed ([df36ba3](https://github.com/case-contract-testing/contract-case/commit/df36ba38fcd91fb3b263f88a17d6314fc93a6095))
+* Remove call to deprecated function, avoiding warning ([6b7ea08](https://github.com/case-contract-testing/contract-case/commit/6b7ea08dc06776fb3377f1ef9a0dc24dd594a935))
+* Start the ContractCase server on a random port ([4c5d431](https://github.com/case-contract-testing/contract-case/commit/4c5d431848cb026701510cf7248f0c48ff5f8b75))
+* Use case-connector instead of case-boundary ([ecc1c9a](https://github.com/case-contract-testing/contract-case/commit/ecc1c9a02f1afc7caadaf1844d9b49eb1843a014))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @contract-case/case-core bumped from 0.15.6 to 0.15.7
+    * @contract-case/case-entities-internal bumped from 0.15.6 to 0.15.7
+  * devDependencies
+    * @contract-case/eslint-config-case-maintainer bumped from 0.0.3 to 0.1.0
+
 ## [0.7.4](https://github.com/case-contract-testing/contract-case/compare/@contract-case/case-connector-v0.7.3...@contract-case/case-connector-v0.7.4) (2024-02-11)
 
 

package/dist/bin/case-connector.d.ts

@@ -1,3 +1,8 @@
 #!/usr/bin/env node
+/*!
+ * ContractCase Connector
+ * Copyright(c) 2022-2024 Timothy Jones (TLJ)
+ * BSD-3-Clause license
+ */
 export {};
 //# sourceMappingURL=case-connector.d.ts.map

package/dist/bin/case-connector.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"case-connector.d.ts","sourceRoot":"","sources":["../../bin/case-connector.ts"],"names":[],"mappings":""}
+{"version":3,"file":"case-connector.d.ts","sourceRoot":"","sources":["../../bin/case-connector.ts"],"names":[],"mappings":";AAEA;;;;GAIG"}

package/dist/bin/case-connector.js

@@ -1,6 +1,9 @@
 #!/usr/bin/env node
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const contract_case_stream_temp_1 = require("../src/connectors/grpc/contract-case-stream-temp");
-(0, contract_case_stream_temp_1.main)();
+/*!
+ * ContractCase Connector
+ * Copyright(c) 2022-2024 Timothy Jones (TLJ)
+ * BSD-3-Clause license
+ */
+import { main } from '../src/connectors/grpc/contract-case-stream.js';
+main();
 //# sourceMappingURL=case-connector.js.map

package/dist/bin/case-connector.js.map

@@ -1 +1 @@
-{"version":3,"file":"case-connector.js","sourceRoot":"","sources":["../../bin/case-connector.ts"],"names":[],"mappings":";;;AAEA,gGAAwE;AAExE,IAAA,gCAAI,GAAE,CAAC"}
+{"version":3,"file":"case-connector.js","sourceRoot":"","sources":["../../bin/case-connector.ts"],"names":[],"mappings":";AAEA;;;;GAIG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,gDAAgD,CAAC;AAEtE,IAAI,EAAE,CAAC"}

package/dist/package.json

@@ -0,0 +1,101 @@
+{
+    "name": "@contract-case/case-connector",
+    "version": "0.8.0",
+    "type": "module",
+    "description": "Connector to allow ContractCase to run as a server. Use only if you're creating a custom wrapper for a new language",
+    "author": "Timothy Jones <timothy.l.jones@gmail.com> (https://github.com/TimothyJones)",
+    "homepage": "https://case.contract-testing.io/docs",
+    "license": "BSD-3-Clause",
+    "main": "build/index.js",
+    "publishConfig": {
+        "access": "public"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+ssh://git@github.com/case-contract-testing/case.git"
+    },
+    "bin": {
+        "case-connector": "./dist/bin/case-connector.js"
+    },
+    "scripts": {
+        "build:proto": "npm run build:proto:js && npm run build:proto:ts && npm run format:fix",
+        "build:proto:js": "grpc_tools_node_protoc --js_out=import_style=commonjs,binary:src/connectors/grpc --grpc_out=grpc_js:src/connectors/grpc ./proto/contract_case_stream.proto",
+        "build:proto:ts": "grpc_tools_node_protoc --js_out=import_style=commonjs,binary:src/connectors/grpc --grpc_out=grpc_js:src/connectors/grpc --plugin=protoc-gen-grpc=../../node_modules/grpc_tools_node_protoc_ts/bin/protoc-gen-ts ./proto/contract_case_stream.proto",
+        "build": "rimraf {dist,package} && tsc --project tsconfig.build.json && webpack-cli",
+        "lint": "eslint src --ext .ts --config .eslintrc.json",
+        "lint:fix": "eslint src --fix --ext .ts --config .eslintrc.json",
+        "lint:fix:proto": "protolint --fix ./proto",
+        "format:base": "prettier --parser typescript \"src/**/*.ts\"",
+        "format:check": "npm run format:base -- --list-different",
+        "format:fix": "npm run format:base -- --write "
+    },
+    "bugs": {
+        "url": "https://github.com/case-contract-testing/case/issues"
+    },
+    "devDependencies": {
+        "@contract-case/case-maintainer-config": "0.1.0",
+        "@contract-case/eslint-config-case-maintainer": "0.1.1",
+        "@types/google-protobuf": "^3.15.12",
+        "@types/jest": "^29.5.12",
+        "@types/uuid": "^10.0.0",
+        "grpc_tools_node_protoc_ts": "^5.3.3",
+        "grpc-tools": "^1.12.4",
+        "prettier": "3.3.3",
+        "rimraf": "^6.0.1",
+        "source-map-loader": "^5.0.0",
+        "terser-webpack-plugin": "^5.3.10",
+        "ts-jest": "^29.1.5",
+        "ts-node": "^10.9.2",
+        "webpack": "^5.94.0",
+        "webpack-cli": "^5.1.4"
+    },
+    "dependencies": {
+        "@contract-case/case-core": "0.16.0",
+        "@contract-case/case-connector-proto": "0.7.6",
+        "@contract-case/case-entities-internal": "0.16.0",
+        "@grpc/grpc-js": "^1.11.1",
+        "@grpc/proto-loader": "^0.7.10",
+        "get-port": "^7.1.0",
+        "google-protobuf": "^3.21.4",
+        "pretty-format": "^29.7.0",
+        "uuid": "^10.0.0"
+    },
+    "stability": "stable",
+    "types": "build/index.d.ts",
+    "nx": {
+        "tasksRunnerOptions": {
+            "default": {
+                "runner": "nx/tasks-runners/default",
+                "options": {
+                    "cacheableOperations": [
+                        "build",
+                        "package",
+                        "lint",
+                        "format:check",
+                        "test"
+                    ]
+                }
+            }
+        },
+        "targetDefaults": {
+            "prebuild": {
+                "dependsOn": [
+                    "^prebuild"
+                ]
+            },
+            "build": {
+                "dependsOn": [
+                    "^build"
+                ],
+                "outputs": [
+                    "{projectRoot}/build"
+                ]
+            },
+            "package": {
+                "outputs": [
+                    "{projectRoot}/dist"
+                ]
+            }
+        }
+    }
+}

package/dist/src/connectors/case-boundary/definer.d.ts

@@ -1,10 +1,10 @@
-import { ContractCaseBoundaryConfig, ILogPrinter, IResultPrinter, BoundaryContractDefiner, BoundaryFailure } from '@contract-case/case-boundary';
-import { DefinitionId } from '../../domain/types';
+import { ContractCaseBoundaryConfig, ILogPrinter, IResultPrinter, BoundaryContractDefiner, BoundaryFailure } from './internals/index.js';
+import { DefinitionId } from '../../domain/types.js';
 export type DefinitionHandle = {
     id: string;
     definer: BoundaryContractDefiner;
 };
-export declare const createDefiner: (config: Omit<ContractCaseBoundaryConfig, 'testRunId'>, callbackPrinter: ILogPrinter, resultPrinter: IResultPrinter, callerVersions: string[]) => DefinitionId;
+export declare const createDefiner: (config: Omit<ContractCaseBoundaryConfig, "testRunId">, callbackPrinter: ILogPrinter, resultPrinter: IResultPrinter, callerVersions: string[]) => DefinitionId;
 export declare const getDefiner: (defineId: DefinitionId, methodName: string) => DefinitionHandle | BoundaryFailure;
 export declare const closeDefiner: (defineId: DefinitionId) => void;
 //# sourceMappingURL=definer.d.ts.map

package/dist/src/connectors/case-boundary/definer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"definer.d.ts","sourceRoot":"","sources":["../../../../src/connectors/case-boundary/definer.ts"],"names":[],"mappings":"AACA,OAAO,EACL,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,eAAe,EAChB,MAAM,8BAA8B,CAAC;AAKtC,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAKlD,MAAM,MAAM,gBAAgB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,uBAAuB,CAAA;CAAE,CAAC;AAMhF,eAAO,MAAM,aAAa,WAChB,KAAK,0BAA0B,EAAE,WAAW,CAAC,mBACpC,WAAW,iBACb,cAAc,kBACb,MAAM,EAAE,KACvB,YAeF,CAAC;AAEF,eAAO,MAAM,UAAU,aACX,YAAY,cACV,MAAM,KACjB,gBAAgB,GAAG,eAerB,CAAC;AAEF,eAAO,MAAM,YAAY,aAAc,YAAY,KAAG,IAErD,CAAC"}
+{"version":3,"file":"definer.d.ts","sourceRoot":"","sources":["../../../../src/connectors/case-boundary/definer.ts"],"names":[],"mappings":"AACA,OAAO,EACL,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,uBAAuB,EACvB,eAAe,EAChB,MAAM,sBAAsB,CAAC;AAK9B,OAAO,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAC;AAKrD,MAAM,MAAM,gBAAgB,GAAG;IAAE,EAAE,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,uBAAuB,CAAA;CAAE,CAAC;AAMhF,eAAO,MAAM,aAAa,WAChB,IAAI,CAAC,0BAA0B,EAAE,WAAW,CAAC,mBACpC,WAAW,iBACb,cAAc,kBACb,MAAM,EAAE,KACvB,YAeF,CAAC;AAEF,eAAO,MAAM,UAAU,aACX,YAAY,cACV,MAAM,KACjB,gBAAgB,GAAG,eAerB,CAAC;AAEF,eAAO,MAAM,YAAY,aAAc,YAAY,KAAG,IAErD,CAAC"}

package/dist/src/connectors/case-boundary/definer.js

@@ -1,36 +1,30 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.closeDefiner = exports.getDefiner = exports.createDefiner = void 0;
-const uuid_1 = require("uuid");
-const case_boundary_1 = require("@contract-case/case-boundary");
-const errors_1 = require("../../domain/errors/errors");
-const maintainerLog_1 = require("../../domain/maintainerLog");
+import { v4 as uuid4 } from 'uuid';
+import { BoundaryContractDefiner, } from './internals/index.js';
+import { makeCoreError, makeConfigurationError, } from '../../domain/errors/errors.js';
+import { maintainerLog } from '../../domain/maintainerLog.js';
 const ENDED_DEFINER = 'CLOSED';
 const DEFINING_CONTRACTS = {};
-const createDefiner = (config, callbackPrinter, resultPrinter, callerVersions) => {
-    const id = (0, uuid_1.v4)();
+export const createDefiner = (config, callbackPrinter, resultPrinter, callerVersions) => {
+    const id = uuid4();
     const definer = {
         id,
-        definer: new case_boundary_1.BoundaryContractDefiner({ ...config, testRunId: id }, callbackPrinter, resultPrinter, callerVersions),
+        definer: new BoundaryContractDefiner({ ...config, testRunId: id }, callbackPrinter, resultPrinter, callerVersions),
     };
     DEFINING_CONTRACTS[id] = definer;
-    (0, maintainerLog_1.maintainerLog)('  ---  storage', `Storing a definer (${id})`);
+    maintainerLog('  ---  storage', `Storing a definer (${id})`);
     return id;
 };
-exports.createDefiner = createDefiner;
-const getDefiner = (defineId, methodName) => {
+export const getDefiner = (defineId, methodName) => {
     const definerHandle = DEFINING_CONTRACTS[defineId];
     if (definerHandle === undefined) {
-        return (0, errors_1.makeCoreError)(`The defineId '${defineId}' doesn't have an associated handle.\n\nThis might happen if the case-connector methods are called out of order, or the wrong connector is contacted`, `case-connector::${methodName}`);
+        return makeCoreError(`The defineId '${defineId}' doesn't have an associated handle.\n\nThis might happen if the case-connector methods are called out of order, or the wrong connector is contacted`, `case-connector::${methodName}`);
     }
     if (definerHandle === ENDED_DEFINER) {
-        return (0, errors_1.makeConfigurationError)(`${methodName} was called after the definer was closed, presumably by endRecord`, `case-connector::${methodName}`);
+        return makeConfigurationError(`${methodName} was called after the definer was closed, presumably by endRecord`, `case-connector::${methodName}`);
     }
     return definerHandle;
 };
-exports.getDefiner = getDefiner;
-const closeDefiner = (defineId) => {
+export const closeDefiner = (defineId) => {
     DEFINING_CONTRACTS[defineId] = ENDED_DEFINER;
 };
-exports.closeDefiner = closeDefiner;
 //# sourceMappingURL=definer.js.map

package/dist/src/connectors/case-boundary/definer.js.map

@@ -1 +1 @@
-{"version":3,"file":"definer.js","sourceRoot":"","sources":["../../../../src/connectors/case-boundary/definer.ts"],"names":[],"mappings":";;;AAAA,+BAAmC;AACnC,gEAMsC;AACtC,uDAGoC;AAEpC,8DAA2D;AAE3D,MAAM,aAAa,GAAG,QAAiB,CAAC;AAMxC,MAAM,kBAAkB,GAAwC,EAAE,CAAC;AAE5D,MAAM,aAAa,GAAG,CAC3B,MAAqD,EACrD,eAA4B,EAC5B,aAA6B,EAC7B,cAAwB,EACV,EAAE;IAChB,MAAM,EAAE,GAAG,IAAA,SAAK,GAAE,CAAC;IACnB,MAAM,OAAO,GAAG;QACd,EAAE;QACF,OAAO,EAAE,IAAI,uCAAuB,CAClC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,EAC5B,eAAe,EACf,aAAa,EACb,cAAc,CACf;KACF,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAEjC,IAAA,6BAAa,EAAC,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,CAAC,CAAC;IAC7D,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AApBW,QAAA,aAAa,iBAoBxB;AAEK,MAAM,UAAU,GAAG,CACxB,QAAsB,EACtB,UAAkB,EACkB,EAAE;IACtC,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACnD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,IAAA,sBAAa,EAClB,iBAAiB,QAAQ,sJAAsJ,EAC/K,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;QACpC,OAAO,IAAA,+BAAsB,EAC3B,GAAG,UAAU,mEAAmE,EAChF,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAlBW,QAAA,UAAU,cAkBrB;AAEK,MAAM,YAAY,GAAG,CAAC,QAAsB,EAAQ,EAAE;IAC3D,kBAAkB,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;AAC/C,CAAC,CAAC;AAFW,QAAA,YAAY,gBAEvB"}
+{"version":3,"file":"definer.js","sourceRoot":"","sources":["../../../../src/connectors/case-boundary/definer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,EAAE,IAAI,KAAK,EAAE,MAAM,MAAM,CAAC;AACnC,OAAO,EAIL,uBAAuB,GAExB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,EACL,aAAa,EACb,sBAAsB,GACvB,MAAM,+BAA+B,CAAC;AAEvC,OAAO,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC;AAE9D,MAAM,aAAa,GAAG,QAAiB,CAAC;AAMxC,MAAM,kBAAkB,GAAwC,EAAE,CAAC;AAEnE,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,MAAqD,EACrD,eAA4B,EAC5B,aAA6B,EAC7B,cAAwB,EACV,EAAE;IAChB,MAAM,EAAE,GAAG,KAAK,EAAE,CAAC;IACnB,MAAM,OAAO,GAAG;QACd,EAAE;QACF,OAAO,EAAE,IAAI,uBAAuB,CAClC,EAAE,GAAG,MAAM,EAAE,SAAS,EAAE,EAAE,EAAE,EAC5B,eAAe,EACf,aAAa,EACb,cAAc,CACf;KACF,CAAC;IACF,kBAAkB,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC;IAEjC,aAAa,CAAC,gBAAgB,EAAE,sBAAsB,EAAE,GAAG,CAAC,CAAC;IAC7D,OAAO,EAAE,CAAC;AACZ,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,UAAU,GAAG,CACxB,QAAsB,EACtB,UAAkB,EACkB,EAAE;IACtC,MAAM,aAAa,GAAG,kBAAkB,CAAC,QAAQ,CAAC,CAAC;IACnD,IAAI,aAAa,KAAK,SAAS,EAAE,CAAC;QAChC,OAAO,aAAa,CAClB,iBAAiB,QAAQ,sJAAsJ,EAC/K,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IACD,IAAI,aAAa,KAAK,aAAa,EAAE,CAAC;QACpC,OAAO,sBAAsB,CAC3B,GAAG,UAAU,mEAAmE,EAChF,mBAAmB,UAAU,EAAE,CAChC,CAAC;IACJ,CAAC;IACD,OAAO,aAAa,CAAC;AACvB,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,QAAsB,EAAQ,EAAE;IAC3D,kBAAkB,CAAC,QAAQ,CAAC,GAAG,aAAa,CAAC;AAC/C,CAAC,CAAC"}

package/dist/src/connectors/case-boundary/internals/BoundaryContractDefiner.d.ts

@@ -0,0 +1,34 @@
+import { BoundaryAnyMatcher, BoundaryMockDefinition } from './types.jsii-boundary.js';
+import { ContractCaseBoundaryConfig, ILogPrinter, IResultPrinter, BoundaryResult } from './boundary/index.js';
+import { BoundaryInvokableFunction } from './types.js';
+/**
+ * A BoundaryContractDefiner allows defining contracts
+ *
+ * @public
+ */
+export declare class BoundaryContractDefiner {
+    private definer;
+    private readonly constructorConfig;
+    private readonly logPrinter;
+    private readonly resultPrinter;
+    private readonly parentVersions;
+    /**
+     * @public
+     * Construct a BoundaryContractDefiner to allow defining contracts.
+     *
+     * @param config - A ContractCaseBoundaryConfig object for the configuration
+     * @param logPrinter - An ILogPrinter to enable printing logs
+     * @param resultPrinter - An IResultPrinter to enable printing results
+     * @param parentVersions - The names version(s) of the package(s) calling
+     * this, where each entry in the array contains a name and version, with the
+     * first entry in the array being the furthest package up the call stack.
+     */
+    constructor(config: ContractCaseBoundaryConfig, logPrinter: ILogPrinter, resultPrinter: IResultPrinter, parentVersions: string[]);
+    private initialiseDefiner;
+    runExample(definition: BoundaryMockDefinition, runConfig: ContractCaseBoundaryConfig): Promise<BoundaryResult>;
+    runRejectingExample(definition: BoundaryMockDefinition, runConfig: ContractCaseBoundaryConfig): Promise<BoundaryResult>;
+    registerFunction(handle: string, invokeableFn: BoundaryInvokableFunction): BoundaryResult;
+    stripMatchers(matcherOrData: BoundaryAnyMatcher): BoundaryResult;
+    endRecord(): Promise<BoundaryResult>;
+}
+//# sourceMappingURL=BoundaryContractDefiner.d.ts.map

package/dist/src/connectors/case-boundary/internals/BoundaryContractDefiner.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryContractDefiner.d.ts","sourceRoot":"","sources":["../../../../../src/connectors/case-boundary/internals/BoundaryContractDefiner.ts"],"names":[],"mappings":"AAiBA,OAAO,EACL,kBAAkB,EAClB,sBAAsB,EACvB,MAAM,0BAA0B,CAAC;AAClC,OAAO,EACL,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,cAAc,EAGf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAkCvD;;;;GAIG;AACH,qBAAa,uBAAuB;IAClC,OAAO,CAAC,OAAO,CAA8D;IAE7E,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6B;IAE/D,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;IAE/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAW;IAE1C;;;;;;;;;;OAUG;gBAED,MAAM,EAAE,0BAA0B,EAClC,UAAU,EAAE,WAAW,EACvB,aAAa,EAAE,cAAc,EAC7B,cAAc,EAAE,MAAM,EAAE;IAc1B,OAAO,CAAC,iBAAiB;IA6BnB,UAAU,CACd,UAAU,EAAE,sBAAsB,EAClC,SAAS,EAAE,0BAA0B,GACpC,OAAO,CAAC,cAAc,CAAC;IAoBpB,mBAAmB,CACvB,UAAU,EAAE,sBAAsB,EAClC,SAAS,EAAE,0BAA0B,GACpC,OAAO,CAAC,cAAc,CAAC;IAmB1B,gBAAgB,CACd,MAAM,EAAE,MAAM,EACd,YAAY,EAAE,yBAAyB,GACtC,cAAc;IAejB,aAAa,CAAC,aAAa,EAAE,kBAAkB,GAAG,cAAc;IAmBhE,SAAS,IAAI,OAAO,CAAC,cAAc,CAAC;CAcrC"}

package/dist/src/connectors/case-boundary/internals/BoundaryContractDefiner.js

@@ -0,0 +1,137 @@
+import { CaseConfigurationError, CaseCoreError, ContractDefinerConnector, } from '@contract-case/case-core';
+import { convertConfig, jsErrorToFailure, mapInvokableFunction, wrapLogPrinter, } from './mappers/index.js';
+import { BoundarySuccess, BoundarySuccessWithAny, } from './boundary/index.js';
+import { versionString } from '../../../versionString.js';
+const mapDefinitionPart = (matcherOrData) => JSON.parse(JSON.stringify(matcherOrData));
+const mapDefinition = (definition, { stateHandlers, triggerAndTests, triggerAndTest, }, config) => ({
+    ...mapDefinitionPart(definition),
+    ...(stateHandlers
+        ? {
+            stateHandlers,
+        }
+        : {}),
+    ...(triggerAndTests
+        ? {
+            triggerAndTests,
+        }
+        : {}),
+    ...(triggerAndTest ? { triggerAndTest } : {}),
+    config,
+});
+/**
+ * A BoundaryContractDefiner allows defining contracts
+ *
+ * @public
+ */
+export class BoundaryContractDefiner {
+    definer;
+    constructorConfig;
+    logPrinter;
+    resultPrinter;
+    parentVersions;
+    /**
+     * @public
+     * Construct a BoundaryContractDefiner to allow defining contracts.
+     *
+     * @param config - A ContractCaseBoundaryConfig object for the configuration
+     * @param logPrinter - An ILogPrinter to enable printing logs
+     * @param resultPrinter - An IResultPrinter to enable printing results
+     * @param parentVersions - The names version(s) of the package(s) calling
+     * this, where each entry in the array contains a name and version, with the
+     * first entry in the array being the furthest package up the call stack.
+     */
+    constructor(config, logPrinter, resultPrinter, parentVersions) {
+        this.constructorConfig = config;
+        this.definer = undefined;
+        this.logPrinter = logPrinter;
+        this.resultPrinter = resultPrinter;
+        // If invoked directly, we need to include our version
+        if (!parentVersions.includes(versionString)) {
+            this.parentVersions = [...parentVersions, versionString];
+        }
+        else {
+            this.parentVersions = parentVersions;
+        }
+    }
+    initialiseDefiner() {
+        if (this.definer === undefined) {
+            const { config, partialInvoker } = convertConfig(this.constructorConfig);
+            if (config.consumerName === undefined || config.consumerName === '') {
+                throw new CaseConfigurationError('Must provide a non-empty consumerName');
+            }
+            if (config.providerName === undefined || config.providerName === '') {
+                throw new CaseConfigurationError('Must provide a non-empty providerName');
+            }
+            this.definer = new ContractDefinerConnector({
+                consumerName: config.consumerName,
+                providerName: config.providerName,
+            }, config, partialInvoker, wrapLogPrinter(this.logPrinter, this.resultPrinter), [...this.parentVersions]);
+        }
+    }
+    async runExample(definition, runConfig) {
+        try {
+            this.initialiseDefiner();
+            if (this.definer === undefined) {
+                throw new CaseCoreError('Definer was undefined after it was initialised (runExample)');
+            }
+            const { config, partialInvoker } = convertConfig(runConfig);
+            await this.definer.runExample(mapDefinition(definition, partialInvoker, config), config);
+            return new BoundarySuccess();
+        }
+        catch (e) {
+            return jsErrorToFailure(e);
+        }
+    }
+    async runRejectingExample(definition, runConfig) {
+        try {
+            this.initialiseDefiner();
+            if (this.definer === undefined) {
+                throw new CaseCoreError('Definer was undefined after it was initialised (runRejectingExample)');
+            }
+            const { config, partialInvoker } = convertConfig(runConfig);
+            await this.definer.runRejectingExample({ ...mapDefinition(definition, partialInvoker, config) }, config);
+            return new BoundarySuccess();
+        }
+        catch (e) {
+            return jsErrorToFailure(e);
+        }
+    }
+    registerFunction(handle, invokeableFn) {
+        try {
+            this.initialiseDefiner();
+            if (this.definer === undefined) {
+                throw new CaseCoreError('Definer was undefined after it was initialised (stripMatchers)');
+            }
+            this.definer.registerFunction(handle, mapInvokableFunction(invokeableFn));
+            return new BoundarySuccess();
+        }
+        catch (e) {
+            return jsErrorToFailure(e);
+        }
+    }
+    stripMatchers(matcherOrData) {
+        try {
+            this.initialiseDefiner();
+            if (this.definer === undefined) {
+                throw new CaseCoreError('Definer was undefined after it was initialised (stripMatchers)');
+            }
+            return new BoundarySuccessWithAny(JSON.stringify(this.definer.stripMatchers(JSON.parse(JSON.stringify(matcherOrData)))));
+        }
+        catch (e) {
+            return jsErrorToFailure(e);
+        }
+    }
+    endRecord() {
+        return Promise.resolve()
+            .then(() => {
+            this.initialiseDefiner();
+            if (this.definer === undefined) {
+                throw new CaseCoreError('Definer was undefined after it was initialised (endRecord)');
+            }
+            return this.definer.endRecord();
+        })
+            .then(() => new BoundarySuccess())
+            .catch((e) => jsErrorToFailure(e));
+    }
+}
+//# sourceMappingURL=BoundaryContractDefiner.js.map

package/dist/src/connectors/case-boundary/internals/BoundaryContractDefiner.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryContractDefiner.js","sourceRoot":"","sources":["../../../../../src/connectors/case-boundary/internals/BoundaryContractDefiner.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,sBAAsB,EACtB,aAAa,EAGb,wBAAwB,GACzB,MAAM,0BAA0B,CAAC;AAElC,OAAO,EACL,aAAa,EACb,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,GACf,MAAM,oBAAoB,CAAC;AAK5B,OAAO,EAKL,eAAe,EACf,sBAAsB,GACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAQ1D,MAAM,iBAAiB,GAAG,CAAC,aAAsB,EAAc,EAAE,CAC/D,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC;AAE5C,MAAM,aAAa,GAAG,CACpB,UAAkC,EAClC,EACE,aAAa,EACb,eAAe,EACf,cAAc,GAC8B,EAC9C,MAAkB,EAClB,EAAE,CAAC,CAAC;IACJ,GAAG,iBAAiB,CAAC,UAAU,CAAC;IAChC,GAAG,CAAC,aAAa;QACf,CAAC,CAAC;YACE,aAAa;SACd;QACH,CAAC,CAAC,EAAE,CAAC;IACP,GAAG,CAAC,eAAe;QACjB,CAAC,CAAC;YACE,eAAe;SAChB;QACH,CAAC,CAAC,EAAE,CAAC;IACP,GAAG,CAAC,cAAc,CAAC,CAAC,CAAC,EAAE,cAAc,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IAC7C,MAAM;CACP,CAAC,CAAC;AAEH;;;;GAIG;AACH,MAAM,OAAO,uBAAuB;IAC1B,OAAO,CAA8D;IAE5D,iBAAiB,CAA6B;IAE9C,UAAU,CAAc;IAExB,aAAa,CAAiB;IAE9B,cAAc,CAAW;IAE1C;;;;;;;;;;OAUG;IACH,YACE,MAAkC,EAClC,UAAuB,EACvB,aAA6B,EAC7B,cAAwB;QAExB,IAAI,CAAC,iBAAiB,GAAG,MAAM,CAAC;QAChC,IAAI,CAAC,OAAO,GAAG,SAAS,CAAC;QACzB,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,sDAAsD;QACtD,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;YAC5C,IAAI,CAAC,cAAc,GAAG,CAAC,GAAG,cAAc,EAAE,aAAa,CAAC,CAAC;QAC3D,CAAC;aAAM,CAAC;YACN,IAAI,CAAC,cAAc,GAAG,cAAc,CAAC;QACvC,CAAC;IACH,CAAC;IAEO,iBAAiB;QACvB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;YAC/B,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,IAAI,CAAC,iBAAiB,CAAC,CAAC;YAEzE,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE,CAAC;gBACpE,MAAM,IAAI,sBAAsB,CAC9B,uCAAuC,CACxC,CAAC;YACJ,CAAC;YAED,IAAI,MAAM,CAAC,YAAY,KAAK,SAAS,IAAI,MAAM,CAAC,YAAY,KAAK,EAAE,EAAE,CAAC;gBACpE,MAAM,IAAI,sBAAsB,CAC9B,uCAAuC,CACxC,CAAC;YACJ,CAAC;YAED,IAAI,CAAC,OAAO,GAAG,IAAI,wBAAwB,CACzC;gBACE,YAAY,EAAE,MAAM,CAAC,YAAY;gBACjC,YAAY,EAAE,MAAM,CAAC,YAAY;aAClC,EACD,MAAM,EACN,cAAc,EACd,cAAc,CAAC,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC,aAAa,CAAC,EACnD,CAAC,GAAG,IAAI,CAAC,cAAc,CAAC,CACzB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,UAAU,CACd,UAAkC,EAClC,SAAqC;QAErC,IAAI,CAAC;YACH,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CACrB,6DAA6D,CAC9D,CAAC;YACJ,CAAC;YAED,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,UAAU,CAC3B,aAAa,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,CAAC,EACjD,MAAM,CACP,CAAC;YACF,OAAO,IAAI,eAAe,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,KAAK,CAAC,mBAAmB,CACvB,UAAkC,EAClC,SAAqC;QAErC,IAAI,CAAC;YACH,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CACrB,sEAAsE,CACvE,CAAC;YACJ,CAAC;YACD,MAAM,EAAE,MAAM,EAAE,cAAc,EAAE,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;YAC5D,MAAM,IAAI,CAAC,OAAO,CAAC,mBAAmB,CACpC,EAAE,GAAG,aAAa,CAAC,UAAU,EAAE,cAAc,EAAE,MAAM,CAAC,EAAE,EACxD,MAAM,CACP,CAAC;YACF,OAAO,IAAI,eAAe,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,gBAAgB,CACd,MAAc,EACd,YAAuC;QAEvC,IAAI,CAAC;YACH,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CACrB,gEAAgE,CACjE,CAAC;YACJ,CAAC;YACD,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,MAAM,EAAE,oBAAoB,CAAC,YAAY,CAAC,CAAC,CAAC;YAC1E,OAAO,IAAI,eAAe,EAAE,CAAC;QAC/B,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,aAAa,CAAC,aAAiC;QAC7C,IAAI,CAAC;YACH,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CACrB,gEAAgE,CACjE,CAAC;YACJ,CAAC;YAED,OAAO,IAAI,sBAAsB,CAC/B,IAAI,CAAC,SAAS,CACZ,IAAI,CAAC,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CACtE,CACF,CAAC;QACJ,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,gBAAgB,CAAC,CAAC,CAAC,CAAC;QAC7B,CAAC;IACH,CAAC;IAED,SAAS;QACP,OAAO,OAAO,CAAC,OAAO,EAAE;aACrB,IAAI,CAAC,GAAG,EAAE;YACT,IAAI,CAAC,iBAAiB,EAAE,CAAC;YACzB,IAAI,IAAI,CAAC,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC/B,MAAM,IAAI,aAAa,CACrB,4DAA4D,CAC7D,CAAC;YACJ,CAAC;YACD,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,CAAC;QAClC,CAAC,CAAC;aACD,IAAI,CAAC,GAAG,EAAE,CAAC,IAAI,eAAe,EAAE,CAAC;aACjC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;IACvC,CAAC;CACF"}

package/dist/src/connectors/case-boundary/internals/BoundaryContractVerifier.d.ts

@@ -0,0 +1,51 @@
+import { IRunTestCallback } from './boundary/IRunTestCallback.js';
+import { ILogPrinter, IResultPrinter, ContractCaseBoundaryConfig, BoundaryResult } from './boundary/index.js';
+import { BoundaryInvokableFunction } from './types.js';
+/**
+ * A BoundaryContractDefiner allows verifying contracts
+ *
+ * @public
+ */
+export declare class BoundaryContractVerifier {
+    private verifier;
+    private readonly constructorConfig;
+    private readonly callback;
+    private readonly logPrinter;
+    private readonly resultPrinter;
+    private readonly parentVersions;
+    /**
+     * Construct a BoundaryContractVerifier to allow verifying pre-written contracts.
+     *
+     * @param config - A ContractCaseBoundaryConfig object for the configuration
+     * @param IRunTestCallback - The callback to tell the test runner that it is running a test
+     * @param logPrinter - An ILogPrinter to enable printing logs
+     * @param resultPrinter - An IResultPrinter to enable printing results
+     * @param parentVersions - The names version(s) of the package(s) calling
+     * this, where each entry in the array contains a name and version, with the
+     * first entry in the array being the furthest package up the call stack.
+     */
+    constructor(config: ContractCaseBoundaryConfig, callback: IRunTestCallback, logPrinter: ILogPrinter, resultPrinter: IResultPrinter, parentVersions: string[]);
+    private initialiseVerifier;
+    /**
+     * Returns a description of all of the contracts that can be found by the configuration.
+     *
+     * @returns either a `BoundaryFailure`, or a `BoundarySuccessWithAny` which contains an array of:
+     * ```
+     * CaseContractDescription {
+     *     consumerName: string;
+     *     providerName: string;
+     * }
+     * ```
+     */
+    availableContractDescriptions(): BoundaryResult;
+    /**
+     * Run the verification of the contract(s) that can be found using the configuration provided.
+     * If you want to filter the contract(s), use the configOverrides to specify a Consumer or Provider name.
+     *
+     * @param configOverrides - A `ContractCaseBoundaryConfig` that defines any config options to override (after the ones provided in the constructor are applied)
+     *
+     * @returns `BoundarySuccess` if verification was successful, otherwise a `BoundaryFailure`
+     */
+    runVerification(configOverrides: ContractCaseBoundaryConfig, invokeableFns: Record<string, BoundaryInvokableFunction>): Promise<BoundaryResult> | BoundaryResult;
+}
+//# sourceMappingURL=BoundaryContractVerifier.d.ts.map

package/dist/src/connectors/case-boundary/internals/BoundaryContractVerifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"BoundaryContractVerifier.d.ts","sourceRoot":"","sources":["../../../../../src/connectors/case-boundary/internals/BoundaryContractVerifier.ts"],"names":[],"mappings":"AAcA,OAAO,EAEL,gBAAgB,EACjB,MAAM,gCAAgC,CAAC;AACxC,OAAO,EACL,WAAW,EACX,cAAc,EACd,0BAA0B,EAC1B,cAAc,EAGf,MAAM,qBAAqB,CAAC;AAE7B,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAsCvD;;;;GAIG;AACH,qBAAa,wBAAwB;IACnC,OAAO,CAAC,QAAQ,CAAwC;IAExD,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAA6B;IAE/D,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAmB;IAE5C,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAc;IAEzC,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAiB;IAE/C,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAW;IAE1C;;;;;;;;;;OAUG;gBAED,MAAM,EAAE,0BAA0B,EAClC,QAAQ,EAAE,gBAAgB,EAC1B,UAAU,EAAE,WAAW,EACvB,aAAa,EAAE,cAAc,EAC7B,cAAc,EAAE,MAAM,EAAE;IAe1B,OAAO,CAAC,kBAAkB;IAe1B;;;;;;;;;;OAUG;IACH,6BAA6B,IAAI,cAAc;IAiB/C;;;;;;;OAOG;IACH,eAAe,CACb,eAAe,EAAE,0BAA0B,EAC3C,aAAa,EAAE,MAAM,CAAC,MAAM,EAAE,yBAAyB,CAAC,GACvD,OAAO,CAAC,cAAc,CAAC,GAAG,cAAc;CAgC5C"}