@suss/contract-graphql 0.23.0 → 0.24.0

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.
Files changed (2) hide show
  1. package/README.md +8 -0
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,5 +1,7 @@
1
1
  # @suss/contract-graphql
2
2
 
3
+ Part of [suss](https://github.com/nimbuscloud-ai/suss), which reads both sides of every call in a repository and says where the two disagree.
4
+
3
5
  Generate suss `BehavioralSummary[]` from GraphQL files a repository already commits. Two readers ship in this package, one for each side of a GraphQL boundary:
4
6
 
5
7
  | Reader | Input | Summaries |
@@ -79,6 +81,12 @@ const consumer = graphqlDocumentsPathToSummaries("src/queries");
79
81
 
80
82
  Depends only on `@suss/behavioral-ir` (for the IR types it produces) and `graphql` (for parsing and printing). It does not extract from source code and is independent of the language adapters. `@suss/contract-appsync` reuses this package's SDL loader and type conversion for AppSync schemas declared in CloudFormation.
81
83
 
84
+ ## More
85
+
86
+ - [Documentation](https://nimbuscloud-ai.github.io/suss/)
87
+ - [Every package and pack suss ships](https://nimbuscloud-ai.github.io/suss/reference/packages)
88
+ - [Source and issues](https://github.com/nimbuscloud-ai/suss)
89
+
82
90
  ## Coverage
83
91
 
84
92
  ![coverage](../../../.github/badges/coverage-contract-graphql.svg)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@suss/contract-graphql",
3
- "version": "0.23.0",
3
+ "version": "0.24.0",
4
4
  "type": "module",
5
5
  "description": "Turn a GraphQL schema or a committed operation document into a suss contract and check it against the resolvers and clients on either side.",
6
6
  "keywords": [
@@ -47,7 +47,7 @@
47
47
  "typecheck": "tsc --noEmit"
48
48
  },
49
49
  "dependencies": {
50
- "@suss/behavioral-ir": "0.23.0",
50
+ "@suss/behavioral-ir": "0.24.0",
51
51
  "graphql": "^16.8.0"
52
52
  },
53
53
  "devDependencies": {