specmatic 2.0.0 → 2.0.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -4
- package/dist/common/runner.d.ts +0 -1
- package/dist/core/index.d.ts +0 -2
- package/dist/core/shutdownUtils.d.ts +0 -1
- package/dist/graphql/index.d.ts +0 -1
- package/dist/kafka/index.d.ts +0 -1
- package/package.json +11 -11
- package/specmatic.jar +0 -0
package/README.md
CHANGED
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
[](https://www.npmjs.com/package/specmatic)
|
|
5
5
|
[](https://github.com/znsio/specmatic-node/releases/latest)
|
|
6
6
|
|
|
7
|
-
This node module is a thin wrapper over the [specmatic executable jar](https://specmatic.
|
|
7
|
+
This node module is a thin wrapper over the [specmatic executable jar](https://specmatic.io/getting_started.html#setup). All core capabilities are in the main [Specmatic project](https://github.com/znsio/specmatic). The purpose of this wrapper module is to act as a helper with below aspects.
|
|
8
8
|
|
|
9
9
|
- Easy installation and upgrade of the jar file in node projects through npm
|
|
10
10
|
- Global install using npm and easy run specmatic jar executable without having to download the jar file and having to run `java -jar`
|
|
@@ -32,15 +32,15 @@ This node module is a thin wrapper over the [specmatic executable jar](https://s
|
|
|
32
32
|
|
|
33
33
|
`npm install specmatic` will install the specmatic locally to the node project.
|
|
34
34
|
|
|
35
|
-
Sample npm scripts to run specmatic, (Check [Documentation](https://specmatic.
|
|
35
|
+
Sample npm scripts to run specmatic, (Check [Documentation](https://specmatic.io/documentation.html) for more information on cli commands and arguments.)
|
|
36
36
|
|
|
37
37
|
## Contract as Stub / Smart Mock (For API clients / consumers)
|
|
38
38
|
|
|
39
|
-
In stub mode, Specmatic emulates the Provider / API / Service based on the API Specification so that the consumer / client application can make independent progress. [Learn more](https://specmatic.
|
|
39
|
+
In stub mode, Specmatic emulates the Provider / API / Service based on the API Specification so that the consumer / client application can make independent progress. [Learn more](https://specmatic.io/#contract-as-stub).
|
|
40
40
|
|
|
41
41
|
## Contract as Test (For API Providers / Service)
|
|
42
42
|
|
|
43
|
-
Tests for Free – Specmatic parses your API Specification files and based on this generates requests which are fired at your application. It then verifies if your application’s response is as per your API Specification. All this with a “No Code” approach.. [Learn More](https://specmatic.
|
|
43
|
+
Tests for Free – Specmatic parses your API Specification files and based on this generates requests which are fired at your application. It then verifies if your application’s response is as per your API Specification. All this with a “No Code” approach.. [Learn More](https://specmatic.io/#contract-as-test)
|
|
44
44
|
|
|
45
45
|
## Sample Repo
|
|
46
46
|
|
package/dist/common/runner.d.ts
CHANGED
|
@@ -1,4 +1,3 @@
|
|
|
1
|
-
/// <reference types="node" />
|
|
2
1
|
import { ChildProcess } from 'child_process';
|
|
3
2
|
declare const callCore: (args: string, done: (error: any) => void, onOutput: (message: string, error: boolean) => void) => ChildProcess;
|
|
4
3
|
declare const callKafka: (args: string, done: (error: any) => void, onOutput: (message: string, error: boolean) => void) => ChildProcess;
|
package/dist/core/index.d.ts
CHANGED
package/dist/graphql/index.d.ts
CHANGED
package/dist/kafka/index.d.ts
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specmatic",
|
|
3
|
-
"version": "2.0.
|
|
4
|
-
"specmaticVersion": "2.0.
|
|
3
|
+
"version": "2.0.3",
|
|
4
|
+
"specmaticVersion": "2.0.3",
|
|
5
5
|
"description": "Node wrapper for Specmatic",
|
|
6
6
|
"main": "dist/index.js",
|
|
7
7
|
"scripts": {
|
|
@@ -48,30 +48,30 @@
|
|
|
48
48
|
"dependencies": {
|
|
49
49
|
"axios": "^1.7.2",
|
|
50
50
|
"express-list-endpoints": "^7.1.0",
|
|
51
|
-
"fast-xml-parser": "^4.4.
|
|
52
|
-
"terminate": "^2.
|
|
51
|
+
"fast-xml-parser": "^4.4.1",
|
|
52
|
+
"terminate": "^2.8.0",
|
|
53
53
|
"tree-kill": "^1.2.2",
|
|
54
|
-
"winston": "^3.13.
|
|
54
|
+
"winston": "^3.13.1"
|
|
55
55
|
},
|
|
56
56
|
"devDependencies": {
|
|
57
|
-
"@babel/cli": "^7.24.
|
|
58
|
-
"@babel/core": "^7.
|
|
57
|
+
"@babel/cli": "^7.24.8",
|
|
58
|
+
"@babel/core": "^7.25.2",
|
|
59
59
|
"@babel/plugin-proposal-class-properties": "^7.18.6",
|
|
60
|
-
"@babel/preset-env": "^7.
|
|
60
|
+
"@babel/preset-env": "^7.25.2",
|
|
61
61
|
"@babel/preset-typescript": "^7.24.7",
|
|
62
62
|
"@types/express": "^4.17.21",
|
|
63
63
|
"@types/express-list-endpoints": "^6.0.3",
|
|
64
64
|
"@types/jest": "^29.5.12",
|
|
65
65
|
"@types/jest-when": "^3.5.5",
|
|
66
|
-
"@types/node": "^20.14.
|
|
66
|
+
"@types/node": "^20.14.13",
|
|
67
67
|
"@types/supertest": "^6.0.2",
|
|
68
68
|
"express": "^4.19.2",
|
|
69
69
|
"jest": "^29.7.0",
|
|
70
70
|
"jest-extended": "^4.0.2",
|
|
71
71
|
"jest-mock-extended": "^3.0.7",
|
|
72
72
|
"jest-when": "^3.6.0",
|
|
73
|
-
"rimraf": "^5.0.
|
|
73
|
+
"rimraf": "^5.0.9",
|
|
74
74
|
"supertest": "^7.0.0",
|
|
75
|
-
"typescript": "^5.4
|
|
75
|
+
"typescript": "^5.5.4"
|
|
76
76
|
}
|
|
77
77
|
}
|
package/specmatic.jar
CHANGED
|
Binary file
|