@suss/contract-graphql 0.24.3 → 0.25.0

package/dist/index.cjs

@@ -65,6 +65,22 @@ function scalarOrRef(node) {
   const name = node.name.value;
   return SCALAR_SHAPES[name] ?? { type: "ref", name };
 }
+function typeDefinitionsIn(doc) {
+  const definitions = {};
+  for (const node of doc.definitions) {
+    if (node.kind !== import_graphql.Kind.OBJECT_TYPE_DEFINITION && node.kind !== import_graphql.Kind.OBJECT_TYPE_EXTENSION && node.kind !== import_graphql.Kind.INTERFACE_TYPE_DEFINITION && node.kind !== import_graphql.Kind.INPUT_OBJECT_TYPE_DEFINITION) {
+      continue;
+    }
+    const properties = {
+      ...definitions[node.name.value]?.type === "record" ? definitions[node.name.value].properties : {}
+    };
+    for (const field of node.fields ?? []) {
+      properties[field.name.value] = typeNodeToShape(field.type);
+    }
+    definitions[node.name.value] = { type: "record", properties };
+  }
+  return definitions;
+}
 
 // src/documents.ts
 var import_node_fs = __toESM(require("fs"), 1);
@@ -456,9 +472,10 @@ function graphqlSdlToSummaries(sdl, options = {}) {
   if (rootFields.length === 0) {
     return [];
   }
+  const definitions = typeDefinitionsIn(doc);
   const out = [buildSchemaDocumentSummary(settings)];
   for (const { rootType, field } of rootFields) {
-    out.push(buildResolverSummary(rootType, field, settings));
+    out.push(buildResolverSummary(rootType, field, settings, definitions));
   }
   return out;
 }
@@ -508,7 +525,7 @@ function collectRootFields(doc) {
 function isRootType(name) {
   return ROOT_TYPES.includes(name);
 }
-function buildResolverSummary(rootType, field, settings) {
+function buildResolverSummary(rootType, field, settings, definitions) {
   const { source, recognition, transport } = settings;
   const fieldName = field.name.value;
   const ownerKey = `${rootType}.${fieldName}`;
@@ -531,6 +548,10 @@ function buildResolverSummary(rootType, field, settings) {
     },
     inputs: buildInputs(field),
     transitions: buildTransitions2(ownerKey, field),
+    // What each named type this field mentions stands for, so a reader
+    // comparing the field against an implementation has structure on
+    // both sides rather than a name on one.
+    ...Object.keys(definitions).length > 0 ? { definitions } : {},
     gaps: [],
     confidence: { source: "derived", level: "high" },
     // Declared contract: checker pairs against any other source

package/dist/index.js

@@ -11,7 +11,9 @@ import {
 } from "@suss/behavioral-ir";
 
 // src/typeShape.ts
-import { Kind } from "graphql";
+import {
+  Kind
+} from "graphql";
 var SCALAR_SHAPES = {
   String: { type: "text" },
   ID: { type: "text" },
@@ -32,6 +34,22 @@ function scalarOrRef(node) {
   const name = node.name.value;
   return SCALAR_SHAPES[name] ?? { type: "ref", name };
 }
+function typeDefinitionsIn(doc) {
+  const definitions = {};
+  for (const node of doc.definitions) {
+    if (node.kind !== Kind.OBJECT_TYPE_DEFINITION && node.kind !== Kind.OBJECT_TYPE_EXTENSION && node.kind !== Kind.INTERFACE_TYPE_DEFINITION && node.kind !== Kind.INPUT_OBJECT_TYPE_DEFINITION) {
+      continue;
+    }
+    const properties = {
+      ...definitions[node.name.value]?.type === "record" ? definitions[node.name.value].properties : {}
+    };
+    for (const field of node.fields ?? []) {
+      properties[field.name.value] = typeNodeToShape(field.type);
+    }
+    definitions[node.name.value] = { type: "record", properties };
+  }
+  return definitions;
+}
 
 // src/documents.ts
 import fs from "fs";
@@ -430,9 +448,10 @@ function graphqlSdlToSummaries(sdl, options = {}) {
   if (rootFields.length === 0) {
     return [];
   }
+  const definitions = typeDefinitionsIn(doc);
   const out = [buildSchemaDocumentSummary(settings)];
   for (const { rootType, field } of rootFields) {
-    out.push(buildResolverSummary(rootType, field, settings));
+    out.push(buildResolverSummary(rootType, field, settings, definitions));
   }
   return out;
 }
@@ -482,7 +501,7 @@ function collectRootFields(doc) {
 function isRootType(name) {
   return ROOT_TYPES.includes(name);
 }
-function buildResolverSummary(rootType, field, settings) {
+function buildResolverSummary(rootType, field, settings, definitions) {
   const { source, recognition, transport } = settings;
   const fieldName = field.name.value;
   const ownerKey = `${rootType}.${fieldName}`;
@@ -505,6 +524,10 @@ function buildResolverSummary(rootType, field, settings) {
     },
     inputs: buildInputs(field),
     transitions: buildTransitions2(ownerKey, field),
+    // What each named type this field mentions stands for, so a reader
+    // comparing the field against an implementation has structure on
+    // both sides rather than a name on one.
+    ...Object.keys(definitions).length > 0 ? { definitions } : {},
     gaps: [],
     confidence: { source: "derived", level: "high" },
     // Declared contract: checker pairs against any other source

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-graphql",
-  "version": "0.24.3",
+  "version": "0.25.0",
   "type": "module",
   "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.",
   "keywords": [
@@ -47,7 +47,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@suss/behavioral-ir": "0.24.3",
+    "@suss/behavioral-ir": "0.25.0",
     "graphql": "^16.8.0"
   },
   "devDependencies": {