@suss/contract-graphql 0.3.1 → 0.4.0

package/dist/index.cjs

@@ -30,6 +30,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
+  SCALAR_SHAPES: () => SCALAR_SHAPES,
   graphqlDocumentFilesToSummaries: () => graphqlDocumentFilesToSummaries,
   graphqlDocumentsPathToSummaries: () => graphqlDocumentsPathToSummaries,
   graphqlDocumentsToSummaries: () => graphqlDocumentsToSummaries,
@@ -227,12 +228,10 @@ function buildOperationSummary(op, name, file, fragments, config) {
     transitions: buildTransitions(name, responseShape),
     gaps: unexpandedSpreadGaps(unexpanded, fragments),
     confidence: { source: "declared", level: "high" },
-    metadata: {
-      graphql: {
-        document: documentText,
-        ...unexpanded.missing.size > 0 ? { unresolvedFragments: [...unexpanded.missing].sort() } : {}
-      }
-    }
+    metadata: (0, import_behavioral_ir.withGraphqlMetadata)(void 0, {
+      document: documentText,
+      ...unexpanded.missing.size > 0 ? { unresolvedFragments: [...unexpanded.missing].sort() } : {}
+    })
   };
 }
 function buildVariableInputs(op) {
@@ -529,18 +528,16 @@ function buildResolverSummary(rootType, field, source, recognition, transport) {
     transitions: buildTransitions2(ownerKey, field),
     gaps: [],
     confidence: { source: "derived", level: "high" },
-    metadata: {
-      graphql: {
-        rootType,
-        fieldName,
-        // Declared contract — checker pairs against any other source
-        // declaring a contract for the same gql:Type.field key.
-        // Provenance is "derived" because both this metadata and the
-        // summary's transitions come from the same SDL field
-        // declaration; self-comparison would be tautological.
-        declaredContract: buildDeclaredContract(field, recognition)
-      }
-    }
+    // Declared contract: checker pairs against any other source
+    // declaring a contract for the same gql:Type.field key. Provenance
+    // is "derived" because both this metadata and the summary's
+    // transitions come from the same SDL field declaration;
+    // self-comparison would be tautological.
+    metadata: (0, import_behavioral_ir2.withGraphqlMetadata)(void 0, {
+      rootType,
+      fieldName,
+      declaredContract: buildDeclaredContract(field, recognition)
+    })
   };
 }
 function buildDeclaredContract(field, recognition) {
@@ -606,6 +603,7 @@ function buildTransitions2(ownerKey, field) {
 }
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  SCALAR_SHAPES,
   graphqlDocumentFilesToSummaries,
   graphqlDocumentsPathToSummaries,
   graphqlDocumentsToSummaries,

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-import { BehavioralSummary } from '@suss/behavioral-ir';
+import { BehavioralSummary, TypeShape } from '@suss/behavioral-ir';
 
 interface GraphqlDocumentsOptions {
     /**
@@ -46,6 +46,13 @@ declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?:
  */
 declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentsOptions): BehavioralSummary[];
 
+/**
+ * The five standard GraphQL scalars, mapped to the shapes they read
+ * as. Exported so packs whose library exposes the same scalars under
+ * its own spelling can build on this table instead of restating it.
+ */
+declare const SCALAR_SHAPES: Record<string, TypeShape>;
+
 interface GraphqlContractOptions {
     /**
      * Logical source path recorded on each summary's `location.file`.
@@ -62,7 +69,7 @@ interface GraphqlContractOptions {
     recognition?: string;
     /**
      * Transport to record on the boundary binding. Defaults to
-     * `"http-graphql"` — most GraphQL servers run over HTTPS.
+     * `"http-graphql"`: most GraphQL servers run over HTTPS.
      */
     transport?: string;
 }
@@ -80,7 +87,7 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
 /**
  * Read an SDL file from disk and return its text, or `null` when the
  * file can't be read. Shared entry point for callers that need the raw
- * SDL rather than the derived summaries — e.g. @suss/contract-appsync
+ * SDL rather than the derived summaries, e.g. @suss/contract-appsync
  * resolving an external schema file referenced by a CloudFormation /
  * SAM template's `DefinitionS3Location` / `SchemaUri`. Reading fails
  * best-effort (missing file, permission error) so the caller can record
@@ -88,4 +95,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentsOptions, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type GraphqlContractOptions, type GraphqlDocumentsOptions, SCALAR_SHAPES, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { BehavioralSummary } from '@suss/behavioral-ir';
+import { BehavioralSummary, TypeShape } from '@suss/behavioral-ir';
 
 interface GraphqlDocumentsOptions {
     /**
@@ -46,6 +46,13 @@ declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?:
  */
 declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentsOptions): BehavioralSummary[];
 
+/**
+ * The five standard GraphQL scalars, mapped to the shapes they read
+ * as. Exported so packs whose library exposes the same scalars under
+ * its own spelling can build on this table instead of restating it.
+ */
+declare const SCALAR_SHAPES: Record<string, TypeShape>;
+
 interface GraphqlContractOptions {
     /**
      * Logical source path recorded on each summary's `location.file`.
@@ -62,7 +69,7 @@ interface GraphqlContractOptions {
     recognition?: string;
     /**
      * Transport to record on the boundary binding. Defaults to
-     * `"http-graphql"` — most GraphQL servers run over HTTPS.
+     * `"http-graphql"`: most GraphQL servers run over HTTPS.
      */
     transport?: string;
 }
@@ -80,7 +87,7 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
 /**
  * Read an SDL file from disk and return its text, or `null` when the
  * file can't be read. Shared entry point for callers that need the raw
- * SDL rather than the derived summaries — e.g. @suss/contract-appsync
+ * SDL rather than the derived summaries, e.g. @suss/contract-appsync
  * resolving an external schema file referenced by a CloudFormation /
  * SAM template's `DefinitionS3Location` / `SchemaUri`. Reading fails
  * best-effort (missing file, permission error) so the caller can record
@@ -88,4 +95,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentsOptions, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type GraphqlContractOptions, type GraphqlDocumentsOptions, SCALAR_SHAPES, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.js

@@ -4,7 +4,10 @@ import {
   Kind as Kind3,
   parse as parse2
 } from "graphql";
-import { graphqlResolverBinding } from "@suss/behavioral-ir";
+import {
+  graphqlResolverBinding,
+  withGraphqlMetadata as withGraphqlMetadata2
+} from "@suss/behavioral-ir";
 
 // src/typeShape.ts
 import { Kind } from "graphql";
@@ -37,7 +40,10 @@ import {
   parse,
   print
 } from "graphql";
-import { graphqlOperationBinding } from "@suss/behavioral-ir";
+import {
+  graphqlOperationBinding,
+  withGraphqlMetadata
+} from "@suss/behavioral-ir";
 function graphqlDocumentsToSummaries(sources, options = {}) {
   const recognition = options.recognition ?? "graphql-documents";
   const transport = options.transport ?? "http-graphql";
@@ -195,12 +201,10 @@ function buildOperationSummary(op, name, file, fragments, config) {
     transitions: buildTransitions(name, responseShape),
     gaps: unexpandedSpreadGaps(unexpanded, fragments),
     confidence: { source: "declared", level: "high" },
-    metadata: {
-      graphql: {
-        document: documentText,
-        ...unexpanded.missing.size > 0 ? { unresolvedFragments: [...unexpanded.missing].sort() } : {}
-      }
-    }
+    metadata: withGraphqlMetadata(void 0, {
+      document: documentText,
+      ...unexpanded.missing.size > 0 ? { unresolvedFragments: [...unexpanded.missing].sort() } : {}
+    })
   };
 }
 function buildVariableInputs(op) {
@@ -497,18 +501,16 @@ function buildResolverSummary(rootType, field, source, recognition, transport) {
     transitions: buildTransitions2(ownerKey, field),
     gaps: [],
     confidence: { source: "derived", level: "high" },
-    metadata: {
-      graphql: {
-        rootType,
-        fieldName,
-        // Declared contract — checker pairs against any other source
-        // declaring a contract for the same gql:Type.field key.
-        // Provenance is "derived" because both this metadata and the
-        // summary's transitions come from the same SDL field
-        // declaration; self-comparison would be tautological.
-        declaredContract: buildDeclaredContract(field, recognition)
-      }
-    }
+    // Declared contract: checker pairs against any other source
+    // declaring a contract for the same gql:Type.field key. Provenance
+    // is "derived" because both this metadata and the summary's
+    // transitions come from the same SDL field declaration;
+    // self-comparison would be tautological.
+    metadata: withGraphqlMetadata2(void 0, {
+      rootType,
+      fieldName,
+      declaredContract: buildDeclaredContract(field, recognition)
+    })
   };
 }
 function buildDeclaredContract(field, recognition) {
@@ -573,6 +575,7 @@ function buildTransitions2(ownerKey, field) {
   ];
 }
 export {
+  SCALAR_SHAPES,
   graphqlDocumentFilesToSummaries,
   graphqlDocumentsPathToSummaries,
   graphqlDocumentsToSummaries,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-graphql",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "type": "module",
   "description": "Generate behavioral summaries from GraphQL sources: a plain SDL file (root fields become resolver-kind summaries) or committed .graphql operation documents (each operation becomes a client-kind summary).",
   "keywords": [
@@ -45,7 +45,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
-    "@suss/behavioral-ir": "0.3.1",
+    "@suss/behavioral-ir": "0.4.0",
     "graphql": "^16.8.0"
   },
   "devDependencies": {