@suss/contract-graphql 0.34.1 → 0.35.0

package/dist/index.cjs

@@ -44,6 +44,7 @@ module.exports = __toCommonJS(index_exports);
 var import_node_fs2 = __toESM(require("fs"), 1);
 var import_graphql3 = require("graphql");
 var import_behavioral_ir2 = require("@suss/behavioral-ir");
+var import_files2 = require("@suss/behavioral-ir/files");
 
 // src/typeShape.ts
 var import_graphql = require("graphql");
@@ -118,6 +119,7 @@ var import_node_fs = __toESM(require("fs"), 1);
 var import_node_path = __toESM(require("path"), 1);
 var import_graphql2 = require("graphql");
 var import_behavioral_ir = require("@suss/behavioral-ir");
+var import_files = require("@suss/behavioral-ir/files");
 function graphqlDocumentsToSummaries(sources, options = {}) {
   const recognition = options.recognition ?? "graphql-documents";
   const transport = options.transport ?? "http-graphql";
@@ -179,6 +181,8 @@ function distinctName(candidate, taken) {
   return name;
 }
 function graphqlDocumentFilesToSummaries(filepaths, options = {}) {
+  const { projectRoot, rootDir, ...documentOptions } = options;
+  const root = projectRoot ?? (0, import_files.defaultProjectRoot)(rootDir ?? filepaths[0] ?? ".");
   const sources = [];
   for (const filepath of filepaths) {
     let text;
@@ -187,9 +191,13 @@ function graphqlDocumentFilesToSummaries(filepaths, options = {}) {
     } catch {
       continue;
     }
-    sources.push({ path: filepath, text });
+    sources.push({ path: (0, import_files.pathInProject)(filepath, root), text });
   }
-  return graphqlDocumentsToSummaries(sources, options);
+  return graphqlDocumentsToSummaries(sources, {
+    ...documentOptions,
+    // An anonymous operation is named from rootDir, so both are spelled from one root.
+    ...rootDir === void 0 ? {} : { rootDir: (0, import_files.pathInProject)(rootDir, root) }
+  });
 }
 function graphqlDocumentsPathToSummaries(specPath, options = {}) {
   const absolute = import_node_path.default.resolve(specPath);
@@ -511,9 +519,13 @@ function graphqlSdlToSummaries(sdl, options = {}) {
 }
 function graphqlSdlFileToSummaries(filepath, options = {}) {
   const sdl = import_node_fs2.default.readFileSync(filepath, "utf8");
+  const { projectRoot, ...contractOptions } = options;
   return graphqlSdlToSummaries(sdl, {
-    source: filepath,
-    ...options
+    source: (0, import_files2.pathInProject)(
+      filepath,
+      projectRoot ?? (0, import_files2.defaultProjectRoot)(filepath)
+    ),
+    ...contractOptions
   });
 }
 function loadSdlFile(filepath) {

package/dist/index.d.cts

@@ -23,8 +23,9 @@ interface GraphqlDocumentsOptions {
      */
     transport?: string;
     /**
-     * The directory an anonymous operation's name is relative to, so the
-     * name is the same on every machine. Without it the path is used as is.
+     * The directory an anonymous operation's name is relative to, spelled
+     * the way the sources' paths are, so the name is the same on every
+     * machine. Without it the path is used as is.
      */
     rootDir?: string;
 }
@@ -40,17 +41,21 @@ interface DocumentSource {
  * contributes definitions but does not produce a summary.
  */
 declare function graphqlDocumentsToSummaries(sources: DocumentSource[], options?: GraphqlDocumentsOptions): BehavioralSummary[];
+interface GraphqlDocumentFilesOptions extends GraphqlDocumentsOptions {
+    /** Absolute. The directory each file's path is measured from. */
+    projectRoot?: string;
+}
 /**
  * Reads `.graphql` and `.gql` files and converts them. A file that cannot
  * be read is skipped, so one bad path does not lose the rest.
  */
-declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?: GraphqlDocumentsOptions): BehavioralSummary[];
+declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?: GraphqlDocumentFilesOptions): BehavioralSummary[];
 /**
  * Reads one document file, or every `.graphql` and `.gql` file under a
  * directory, skipping `node_modules`. Throws when nothing exists at the
  * path. `suss contract --from graphql-documents <path>` calls this.
  */
-declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentsOptions): BehavioralSummary[];
+declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentFilesOptions): BehavioralSummary[];
 
 /**
  * The TypeShape for each of the five standard GraphQL scalars. A pack
@@ -94,11 +99,15 @@ interface GraphqlContractOptions {
  * does not parse or has no root fields.
  */
 declare function graphqlSdlToSummaries(sdl: string, options?: GraphqlContractOptions): BehavioralSummary[];
+interface GraphqlSdlFileOptions extends GraphqlContractOptions {
+    /** Absolute. The directory the file's path is measured from. */
+    projectRoot?: string;
+}
 /**
- * Reads an SDL file and converts it, recording the file path as the
- * source. `suss contract --from graphql <file>` calls this.
+ * Reads an SDL file and converts it, recording the file's path in its
+ * project as the source. `suss contract --from graphql <file>` calls this.
  */
-declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlContractOptions): BehavioralSummary[];
+declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlSdlFileOptions): BehavioralSummary[];
 /**
  * Reads an SDL file and returns its text, or `null` when the file cannot
  * be read. @suss/contract-appsync uses it for the schema file a template
@@ -107,4 +116,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentsOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.d.ts

@@ -23,8 +23,9 @@ interface GraphqlDocumentsOptions {
      */
     transport?: string;
     /**
-     * The directory an anonymous operation's name is relative to, so the
-     * name is the same on every machine. Without it the path is used as is.
+     * The directory an anonymous operation's name is relative to, spelled
+     * the way the sources' paths are, so the name is the same on every
+     * machine. Without it the path is used as is.
      */
     rootDir?: string;
 }
@@ -40,17 +41,21 @@ interface DocumentSource {
  * contributes definitions but does not produce a summary.
  */
 declare function graphqlDocumentsToSummaries(sources: DocumentSource[], options?: GraphqlDocumentsOptions): BehavioralSummary[];
+interface GraphqlDocumentFilesOptions extends GraphqlDocumentsOptions {
+    /** Absolute. The directory each file's path is measured from. */
+    projectRoot?: string;
+}
 /**
  * Reads `.graphql` and `.gql` files and converts them. A file that cannot
  * be read is skipped, so one bad path does not lose the rest.
  */
-declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?: GraphqlDocumentsOptions): BehavioralSummary[];
+declare function graphqlDocumentFilesToSummaries(filepaths: string[], options?: GraphqlDocumentFilesOptions): BehavioralSummary[];
 /**
  * Reads one document file, or every `.graphql` and `.gql` file under a
  * directory, skipping `node_modules`. Throws when nothing exists at the
  * path. `suss contract --from graphql-documents <path>` calls this.
  */
-declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentsOptions): BehavioralSummary[];
+declare function graphqlDocumentsPathToSummaries(specPath: string, options?: GraphqlDocumentFilesOptions): BehavioralSummary[];
 
 /**
  * The TypeShape for each of the five standard GraphQL scalars. A pack
@@ -94,11 +99,15 @@ interface GraphqlContractOptions {
  * does not parse or has no root fields.
  */
 declare function graphqlSdlToSummaries(sdl: string, options?: GraphqlContractOptions): BehavioralSummary[];
+interface GraphqlSdlFileOptions extends GraphqlContractOptions {
+    /** Absolute. The directory the file's path is measured from. */
+    projectRoot?: string;
+}
 /**
- * Reads an SDL file and converts it, recording the file path as the
- * source. `suss contract --from graphql <file>` calls this.
+ * Reads an SDL file and converts it, recording the file's path in its
+ * project as the source. `suss contract --from graphql <file>` calls this.
  */
-declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlContractOptions): BehavioralSummary[];
+declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlSdlFileOptions): BehavioralSummary[];
 /**
  * Reads an SDL file and returns its text, or `null` when the file cannot
  * be read. @suss/contract-appsync uses it for the schema file a template
@@ -107,4 +116,4 @@ declare function graphqlSdlFileToSummaries(filepath: string, options?: GraphqlCo
  */
 declare function loadSdlFile(filepath: string): string | null;
 
-export { type GraphqlContractOptions, type GraphqlDocumentsOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };
+export { type GraphqlContractOptions, type GraphqlDocumentFilesOptions, type GraphqlDocumentsOptions, type GraphqlSdlFileOptions, SCALAR_SHAPES, describesOperations, describesTypes, graphqlDocumentFilesToSummaries, graphqlDocumentsPathToSummaries, graphqlDocumentsToSummaries, graphqlSdlFileToSummaries, graphqlSdlToSummaries, loadSdlFile };

package/dist/index.js

@@ -9,6 +9,7 @@ import {
   withGraphqlMetadata as withGraphqlMetadata2,
   withSourceDocumentMetadata
 } from "@suss/behavioral-ir";
+import { defaultProjectRoot as defaultProjectRoot2, pathInProject as pathInProject2 } from "@suss/behavioral-ir/files";
 
 // src/typeShape.ts
 import {
@@ -93,6 +94,7 @@ import {
   graphqlOperationBinding,
   withGraphqlMetadata
 } from "@suss/behavioral-ir";
+import { defaultProjectRoot, pathInProject } from "@suss/behavioral-ir/files";
 function graphqlDocumentsToSummaries(sources, options = {}) {
   const recognition = options.recognition ?? "graphql-documents";
   const transport = options.transport ?? "http-graphql";
@@ -154,6 +156,8 @@ function distinctName(candidate, taken) {
   return name;
 }
 function graphqlDocumentFilesToSummaries(filepaths, options = {}) {
+  const { projectRoot, rootDir, ...documentOptions } = options;
+  const root = projectRoot ?? defaultProjectRoot(rootDir ?? filepaths[0] ?? ".");
   const sources = [];
   for (const filepath of filepaths) {
     let text;
@@ -162,9 +166,13 @@ function graphqlDocumentFilesToSummaries(filepaths, options = {}) {
     } catch {
       continue;
     }
-    sources.push({ path: filepath, text });
+    sources.push({ path: pathInProject(filepath, root), text });
   }
-  return graphqlDocumentsToSummaries(sources, options);
+  return graphqlDocumentsToSummaries(sources, {
+    ...documentOptions,
+    // An anonymous operation is named from rootDir, so both are spelled from one root.
+    ...rootDir === void 0 ? {} : { rootDir: pathInProject(rootDir, root) }
+  });
 }
 function graphqlDocumentsPathToSummaries(specPath, options = {}) {
   const absolute = path.resolve(specPath);
@@ -486,9 +494,13 @@ function graphqlSdlToSummaries(sdl, options = {}) {
 }
 function graphqlSdlFileToSummaries(filepath, options = {}) {
   const sdl = fs2.readFileSync(filepath, "utf8");
+  const { projectRoot, ...contractOptions } = options;
   return graphqlSdlToSummaries(sdl, {
-    source: filepath,
-    ...options
+    source: pathInProject2(
+      filepath,
+      projectRoot ?? defaultProjectRoot2(filepath)
+    ),
+    ...contractOptions
   });
 }
 function loadSdlFile(filepath) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@suss/contract-graphql",
-  "version": "0.34.1",
+  "version": "0.35.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.34.1",
+    "@suss/behavioral-ir": "0.35.0",
     "graphql": "^16.8.0"
   },
   "devDependencies": {