@suss/contract-graphql 0.35.1 → 0.37.0

package/dist/index.cjs

@@ -31,6 +31,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var index_exports = {};
 __export(index_exports, {
   SCALAR_SHAPES: () => SCALAR_SHAPES,
+  declaredValueTypes: () => declaredValueTypes,
   describesOperations: () => describesOperations,
   describesTypes: () => describesTypes,
   graphqlDocumentFilesToSummaries: () => graphqlDocumentFilesToSummaries,
@@ -113,6 +114,47 @@ function definitionKinds(text) {
     return [];
   }
 }
+var VALUE_TYPE_READERS = {
+  [import_graphql.Kind.ENUM_TYPE_DEFINITION]: enumOf,
+  [import_graphql.Kind.ENUM_TYPE_EXTENSION]: enumOf,
+  [import_graphql.Kind.UNION_TYPE_DEFINITION]: unionOf,
+  [import_graphql.Kind.UNION_TYPE_EXTENSION]: unionOf,
+  [import_graphql.Kind.SCALAR_TYPE_DEFINITION]: () => ({ kind: "scalar", members: [] }),
+  [import_graphql.Kind.SCALAR_TYPE_EXTENSION]: () => ({ kind: "scalar", members: [] })
+};
+function enumOf(node) {
+  const values = node.values ?? [];
+  return { kind: "enum", members: values.map((value) => value.name.value) };
+}
+function unionOf(node) {
+  const types = node.types ?? [];
+  return { kind: "union", members: types.map((type) => type.name.value) };
+}
+function declaredValueTypes(sdl) {
+  let doc;
+  try {
+    doc = (0, import_graphql.parse)(sdl);
+  } catch {
+    return [];
+  }
+  const found = /* @__PURE__ */ new Map();
+  for (const node of doc.definitions) {
+    const read = VALUE_TYPE_READERS[node.kind];
+    if (read === void 0) {
+      continue;
+    }
+    const valueNode = node;
+    const { kind, members } = read(valueNode);
+    const name = valueNode.name.value;
+    const known = found.get(name);
+    found.set(name, {
+      name,
+      kind,
+      members: [...known?.members ?? [], ...members]
+    });
+  }
+  return [...found.values()];
+}
 
 // src/documents.ts
 var import_node_fs = __toESM(require("fs"), 1);
@@ -575,7 +617,10 @@ function buildResolverSummary(rootType, field, settings, definitions) {
     kind: "resolver",
     location: {
       file: `${source}:${ownerKey}`,
-      range: { start: 0, end: 0 },
+      range: {
+        start: field.loc?.startToken.line ?? 0,
+        end: field.loc?.endToken.line ?? 0
+      },
       exportName: null
     },
     identity: {
@@ -687,6 +732,7 @@ function buildTransitions2(ownerKey, field) {
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   SCALAR_SHAPES,
+  declaredValueTypes,
   describesOperations,
   describesTypes,
   graphqlDocumentFilesToSummaries,

package/dist/index.d.cts

@@ -67,6 +67,20 @@ declare const SCALAR_SHAPES: Record<string, TypeShape>;
 declare function describesTypes(text: string): boolean;
 /** True when the document has at least one operation. A file of fragments has none. */
 declare function describesOperations(text: string): boolean;
+/** A type a schema declares that has no fields: an enum, a union or a custom scalar. */
+interface DeclaredValueType {
+    name: string;
+    kind: "enum" | "union" | "scalar";
+    /** An enum's values or a union's member types, in the order written, extensions included. */
+    members: string[];
+}
+/**
+ * The enums, unions and custom scalars a schema declares. They have no
+ * fields, so they are not in `typeDefinitionsIn`, but a page that links
+ * each type name a field returns needs them. Empty when the SDL does not
+ * parse.
+ */
+declare function declaredValueTypes(sdl: string): DeclaredValueType[];
 
 /**
  * Reads a plain GraphQL SDL file and writes one resolver summary for each
@@ -116,4 +130,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlSd
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type DeclaredValueType, type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, declaredValueTypes, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.d.ts

@@ -67,6 +67,20 @@ declare const SCALAR_SHAPES: Record<string, TypeShape>;
 declare function describesTypes(text: string): boolean;
 /** True when the document has at least one operation. A file of fragments has none. */
 declare function describesOperations(text: string): boolean;
+/** A type a schema declares that has no fields: an enum, a union or a custom scalar. */
+interface DeclaredValueType {
+    name: string;
+    kind: "enum" | "union" | "scalar";
+    /** An enum's values or a union's member types, in the order written, extensions included. */
+    members: string[];
+}
+/**
+ * The enums, unions and custom scalars a schema declares. They have no
+ * fields, so they are not in `typeDefinitionsIn`, but a page that links
+ * each type name a field returns needs them. Empty when the SDL does not
+ * parse.
+ */
+declare function declaredValueTypes(sdl: string): DeclaredValueType[];
 
 /**
  * Reads a plain GraphQL SDL file and writes one resolver summary for each
@@ -116,4 +130,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlSd
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type DeclaredValueType, type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, declaredValueTypes, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.js

@@ -81,6 +81,47 @@ function definitionKinds(text) {
     return [];
   }
 }
+var VALUE_TYPE_READERS = {
+  [Kind.ENUM_TYPE_DEFINITION]: enumOf,
+  [Kind.ENUM_TYPE_EXTENSION]: enumOf,
+  [Kind.UNION_TYPE_DEFINITION]: unionOf,
+  [Kind.UNION_TYPE_EXTENSION]: unionOf,
+  [Kind.SCALAR_TYPE_DEFINITION]: () => ({ kind: "scalar", members: [] }),
+  [Kind.SCALAR_TYPE_EXTENSION]: () => ({ kind: "scalar", members: [] })
+};
+function enumOf(node) {
+  const values = node.values ?? [];
+  return { kind: "enum", members: values.map((value) => value.name.value) };
+}
+function unionOf(node) {
+  const types = node.types ?? [];
+  return { kind: "union", members: types.map((type) => type.name.value) };
+}
+function declaredValueTypes(sdl) {
+  let doc;
+  try {
+    doc = graphqlParse(sdl);
+  } catch {
+    return [];
+  }
+  const found = /* @__PURE__ */ new Map();
+  for (const node of doc.definitions) {
+    const read = VALUE_TYPE_READERS[node.kind];
+    if (read === void 0) {
+      continue;
+    }
+    const valueNode = node;
+    const { kind, members } = read(valueNode);
+    const name = valueNode.name.value;
+    const known = found.get(name);
+    found.set(name, {
+      name,
+      kind,
+      members: [...known?.members ?? [], ...members]
+    });
+  }
+  return [...found.values()];
+}
 
 // src/documents.ts
 import fs from "fs";
@@ -550,7 +591,10 @@ function buildResolverSummary(rootType, field, settings, definitions) {
     kind: "resolver",
     location: {
       file: `${source}:${ownerKey}`,
-      range: { start: 0, end: 0 },
+      range: {
+        start: field.loc?.startToken.line ?? 0,
+        end: field.loc?.endToken.line ?? 0
+      },
       exportName: null
     },
     identity: {
@@ -661,6 +705,7 @@ function buildTransitions2(ownerKey, field) {
 }
 export {
   SCALAR_SHAPES,
+  declaredValueTypes,
   describesOperations,
   describesTypes,
   graphqlDocumentFilesToSummaries,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-graphql",
-  "version": "0.35.1",
+  "version": "0.37.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.35.1",
+    "@suss/behavioral-ir": "0.37.0",
     "graphql": "^16.8.0"
   },
   "devDependencies": {