@khanacademy/graphql-flow 3.2.0 → 3.4.0

package/.github/workflows/pr-checks.yml

@@ -34,7 +34,7 @@ jobs:
 
     - name: Run TypeScript
       if: steps.ts-files.outputs.filtered != '[]'
-      run: yarn tsc
+      run: yarn typecheck
 
     - id: eslint-reset
       uses: Khan/actions@filter-files-v1

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @khanacademy/graphql-flow
 
+## 3.4.0
+
+### Minor Changes
+
+-   c699e6a: Export the introspection options we use
+
+## 3.3.0
+
+### Minor Changes
+
+-   b9fc899: Adds support for marking input fields as @deprecated
+
 ## 3.2.0
 
 ### Minor Changes

package/dist/cli/config.js

@@ -12,6 +12,7 @@ var _jsonschema = require("jsonschema");
 var _minimist = _interopRequireDefault(require("minimist"));
 var _child_process = require("child_process");
 var _path = _interopRequireDefault(require("path"));
+var _getIntrospectionQuery = require("./get-introspection-query");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const validateOrThrow = (value, jsonSchema) => {
   const result = (0, _jsonschema.validate)(value, jsonSchema);
@@ -67,9 +68,7 @@ const getSchemas = schemaFilePath => {
     const schemaForValidation = (0, _graphql.buildSchema)(raw);
     const queryResponse = (0, _graphql.graphqlSync)({
       schema: schemaForValidation,
-      source: (0, _graphql.getIntrospectionQuery)({
-        descriptions: true
-      })
+      source: (0, _getIntrospectionQuery.getIntrospectionQuery)()
     });
     const schemaForTypeGeneration = (0, _schemaFromIntrospectionData.schemaFromIntrospectionData)(queryResponse.data);
     return [schemaForValidation, schemaForTypeGeneration];

package/dist/cli/get-introspection-query.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getIntrospectionQuery = void 0;
+var _graphql = require("graphql");
+const INTROSPECTION_OPTIONS = {
+  descriptions: true,
+  inputValueDeprecation: true
+};
+const getIntrospectionQuery = () => {
+  return (0, _graphql.getIntrospectionQuery)(INTROSPECTION_OPTIONS);
+};
+exports.getIntrospectionQuery = getIntrospectionQuery;

package/dist/index.js

@@ -4,10 +4,17 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.documentToFlowTypes = exports.FlowGenerationError = void 0;
+Object.defineProperty(exports, "getIntrospectionQuery", {
+  enumerable: true,
+  get: function () {
+    return _getIntrospectionQuery.getIntrospectionQuery;
+  }
+});
 var _wonderStuffCore = require("@khanacademy/wonder-stuff-core");
 var _generator = _interopRequireDefault(require("@babel/generator"));
 var _generateResponseType = require("./generateResponseType");
 var _generateVariablesType = require("./generateVariablesType");
+var _getIntrospectionQuery = require("./cli/get-introspection-query");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /* eslint-disable no-console */
 /* flow-uncovered-file */
@@ -18,6 +25,10 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * which is produced by running `./tools/graphql-flow/sendIntrospection.js`.
  */
 
+// NOTE(kevinb): This is exported so that tooling in other repos can use
+// the same options for their introspection query.  In particular, we use
+// this in Khan/frontend when downloading the introspection JSON from prod.
+
 const optionsToConfig = (schema, definitions, options, errors = []) => {
   var _options$strictNullab, _options$readOnlyArra, _options$scalars, _options$typeScript, _options$omitFileExte;
   const internalOptions = {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@khanacademy/graphql-flow",
-    "version": "3.2.0",
+    "version": "3.4.0",
     "bin": {
         "graphql-flow": "./dist/cli/run.js"
     },
@@ -11,6 +11,7 @@
     },
     "scripts": {
         "test": "jest",
+        "typecheck": "tsc --noEmit",
         "publish:ci": "yarn run build && changeset publish",
         "build": "babel src --extensions '.ts, .tsx' --out-dir dist --ignore 'src/**/*.spec.ts','src/**/*.test.ts' && chmod 755 dist/cli/run.js"
     },

package/src/__test__/example-schema.graphql

@@ -61,6 +61,7 @@ input CharacterInput {
   appearsIn: [Episode!]
   candies: PositiveNumber!
   friendly: Boolean! = true
+  toBeRemoved: String @deprecated(reason: "Unused")
 }
 
 type Mutation {

package/src/__test__/graphql-flow.test.ts

@@ -579,6 +579,7 @@ describe("graphql-flow generation", () => {
                     "NEW_HOPE" | "EMPIRE" | "JEDI"> | null | undefined;
                     candies: number;
                     friendly?: boolean | null | undefined;
+                    toBeRemoved?: string | null | undefined;
                   };
                 },
                     response: {
@@ -610,6 +611,7 @@ describe("graphql-flow generation", () => {
                     appearsIn?: ReadonlyArray<"NEW_HOPE" | "EMPIRE" | "JEDI"> | null | undefined;
                     candies: number;
                     friendly?: boolean | null | undefined;
+                    toBeRemoved?: string | null | undefined;
                   };
                 },
                     response: {

package/src/cli/config.ts

@@ -8,9 +8,8 @@ import fs from "fs";
 import {
     buildClientSchema,
     buildSchema,
-    getIntrospectionQuery,
     graphqlSync,
-    IntrospectionQuery,
+    type IntrospectionQuery,
 } from "graphql";
 import {validate} from "jsonschema";
 import processArgs from "minimist";
@@ -18,6 +17,8 @@ import type {Config, GenerateConfig} from "../types";
 import {execSync} from "child_process";
 import path from "path";
 
+import {getIntrospectionQuery} from "./get-introspection-query";
+
 export const validateOrThrow = (value: unknown, jsonSchema: unknown) => {
     const result = validate(value, jsonSchema);
     if (!result.valid) {
@@ -91,7 +92,7 @@ export const getSchemas = (schemaFilePath: string): [GraphQLSchema, Schema] => {
         const schemaForValidation = buildSchema(raw);
         const queryResponse = graphqlSync({
             schema: schemaForValidation,
-            source: getIntrospectionQuery({descriptions: true}),
+            source: getIntrospectionQuery(),
         });
         const schemaForTypeGeneration = schemaFromIntrospectionData(
             queryResponse.data as any as IntrospectionQuery,

package/src/cli/get-introspection-query.ts

@@ -0,0 +1,13 @@
+import {
+    getIntrospectionQuery as getIntrospectionQueryWithOptions,
+    type IntrospectionOptions,
+} from "graphql";
+
+const INTROSPECTION_OPTIONS: IntrospectionOptions = {
+    descriptions: true,
+    inputValueDeprecation: true,
+};
+
+export const getIntrospectionQuery = () => {
+    return getIntrospectionQueryWithOptions(INTROSPECTION_OPTIONS);
+};

package/src/index.ts

@@ -19,6 +19,11 @@ import type {Node} from "@babel/types";
 
 import type {Context, Schema, GenerateConfig} from "./types";
 
+// NOTE(kevinb): This is exported so that tooling in other repos can use
+// the same options for their introspection query.  In particular, we use
+// this in Khan/frontend when downloading the introspection JSON from prod.
+export {getIntrospectionQuery} from "./cli/get-introspection-query";
+
 const optionsToConfig = (
     schema: Schema,
     definitions: ReadonlyArray<DefinitionNode>,