internal: satisfy stricter deno type/package checks (#4623)

as performed by `deno publish --dry-run`

enable tsconfig `isolatedDeclarations`, add a local `check:deno` step, and add a CI step for multiple versions to achieve conformity.

Author: yaacovCR

.c8rc.json

@@ -7,6 +7,7 @@
     "src/jsutils/Maybe.ts",
     "src/jsutils/ObjMap.ts",
     "src/jsutils/PromiseOrValue.ts",
+    "src/language/KindTypeMap.ts",
     "src/utilities/typedQueryDocumentNode.ts",
     "src/**/__tests__/**/*.ts"
   ],

.github/workflows/ci.yml

@@ -26,7 +26,7 @@ jobs:
         run: npm run lint
 
       - name: Check Types
-        run: npm run check
+        run: npm run check:ts
 
       - name: Lint Prettier
         run: npm run prettier:check
@@ -244,7 +244,7 @@ jobs:
           name: denoDist
           path: ./denoDist
 
-  type-check-deno-dist:
+  check-deno-dist:
     name: Type check denoDist on Deno v${{ matrix.deno_version_to_setup }}
     needs: build-deno-dist
     runs-on: ubuntu-latest
@@ -268,5 +268,12 @@ jobs:
         with:
           deno-version: ${{ matrix.deno_version_to_setup }}
 
-      - name: Check denoDist package
-        run: deno check ./denoDist/index.ts
+      - name: Run denoDist package publish dry-run checks
+        # `deno publish --dry-run` performs a number of checks including:
+        # (a) type-checking package modules/public API,
+        # (b) validating exports and module-graph resolution,
+        # (c) validating the publish file set (gitignore + publish.exclude/include),
+        # (d) validating package metadata/config, and
+        # (e) enforcing JSR slow-types checks.
+        working-directory: ./denoDist
+        run: deno publish --dry-run

.github/workflows/release.yml

@@ -134,14 +134,9 @@ jobs:
     runs-on: ubuntu-latest
     environment: release
     permissions:
-      contents: read # for actions/checkout
+      contents: read # for actions/download-artifact
       id-token: write # for JSR trusted publishing via OIDC
     steps:
-      - name: Checkout repo
-        uses: actions/checkout@v4
-        with:
-          persist-credentials: false
-
       - name: Download denoDist package
         uses: actions/download-artifact@v4
         with:

package.json

@@ -36,7 +36,9 @@
     "benchmark": "node --import ./resources/register-ts-node.js  resources/benchmark.ts",
     "test": "npm run lint && npm run check && npm run testonly:cover && npm run prettier:check && npm run check:spelling && npm run check:integrations",
     "lint": "eslint --cache --max-warnings 0 .",
-    "check": "tsc --pretty",
+    "check": "npm run check:ts && npm run check:deno",
+    "check:ts": "tsc --pretty",
+    "check:deno": "npm run build:deno && deno publish --dry-run --allow-dirty --config denoDist/jsr.json",
     "testonly": "mocha --full-trace src/**/__tests__/**/*-test.ts",
     "testonly:cover": "c8 npm run testonly",
     "testonly:watch": "npm run testonly -- --watch",

resources/build-deno.ts

@@ -90,6 +90,9 @@ interface JSRConfig {
   name: string;
   version: string;
   exports: { [entrypoint: string]: string };
+  publish: {
+    exclude: ReadonlyArray<string>;
+  };
 }
 
 async function writeJSRConfig(
@@ -122,6 +125,10 @@ async function writeJSRConfig(
     name: '@graphql/graphql-js',
     version,
     exports: jsrExports,
+    publish: {
+      // The package root is `denoDist/`, so unignore relative to that root.
+      exclude: ['!.'],
+    },
   };
 
   const prettified = await prettify(jsrConfigPath, JSON.stringify(jsrConfig));

resources/change-extension-in-import-paths.ts

@@ -21,14 +21,16 @@ import ts from 'typescript';
  * ```
  *
  */
-export function changeExtensionInImportPaths(config: { extension: string }) {
+export function changeExtensionInImportPaths(config: {
+  extension: string;
+}): ts.TransformerFactory<ts.SourceFile> {
   const { extension } = config;
-  return (context: ts.TransformationContext) => {
+  return (context: ts.TransformationContext): ts.Transformer<ts.SourceFile> => {
     const { factory } = context;
 
     return visitSourceFile;
 
-    function visitSourceFile(sourceFile: ts.SourceFile) {
+    function visitSourceFile(sourceFile: ts.SourceFile): ts.SourceFile {
       return ts.visitNode(sourceFile, visitNode, ts.isSourceFile);
     }
 

resources/gen-version.ts

@@ -20,7 +20,12 @@ export const version = '${version}' as string;
 /**
  * An object containing the components of the GraphQL.js version string
  */
-export const versionInfo = Object.freeze({
+export const versionInfo: Readonly<{
+  major: number;
+  minor: number;
+  patch: number;
+  preReleaseTag: string | null;
+}> = Object.freeze({
   major: ${major} as number,
   minor: ${minor} as number,
   patch: ${patch} as number,

resources/inline-invariant.ts

@@ -11,12 +11,14 @@ import ts from 'typescript';
  *
  *  if (!(<cond>)) invariant(false, ...)
  */
-export function inlineInvariant(context: ts.TransformationContext) {
+export function inlineInvariant(
+  context: ts.TransformationContext,
+): ts.Transformer<ts.SourceFile> {
   const { factory } = context;
 
   return visitSourceFile;
 
-  function visitSourceFile(sourceFile: ts.SourceFile) {
+  function visitSourceFile(sourceFile: ts.SourceFile): ts.SourceFile {
     return ts.visitNode(sourceFile, visitNode, ts.isSourceFile);
   }
 

src/__testUtils__/expectJSON.ts

@@ -23,22 +23,33 @@ function toJSONDeep(value: unknown): unknown {
   return mapValue(value, toJSONDeep);
 }
 
-export function expectJSON(actual: unknown) {
+export function expectJSON(actual: unknown): {
+  toDeepEqual: (expected: unknown) => ReturnType<typeof expect>;
+  toDeepNestedProperty: (
+    path: string,
+    expected: unknown,
+  ) => ReturnType<typeof expect>;
+} {
   const actualJSON = toJSONDeep(actual);
 
   return {
-    toDeepEqual(expected: unknown) {
+    toDeepEqual(expected: unknown): ReturnType<typeof expect> {
       const expectedJSON = toJSONDeep(expected);
-      expect(actualJSON).to.deep.equal(expectedJSON);
+      return expect(actualJSON).to.deep.equal(expectedJSON);
     },
-    toDeepNestedProperty(path: string, expected: unknown) {
+    toDeepNestedProperty(
+      path: string,
+      expected: unknown,
+    ): ReturnType<typeof expect> {
       const expectedJSON = toJSONDeep(expected);
-      expect(actualJSON).to.deep.nested.property(path, expectedJSON);
+      return expect(actualJSON).to.deep.nested.property(path, expectedJSON);
     },
   };
 }
 
-export function expectToThrowJSON(fn: () => unknown) {
+export function expectToThrowJSON(
+  fn: () => unknown,
+): ReturnType<typeof expect> {
   function mapException(): unknown {
     try {
       return fn();

src/__testUtils__/expectPromise.ts

@@ -3,17 +3,22 @@ import { assert, expect } from 'chai';
 import { inspect } from '../jsutils/inspect.js';
 import { isPromise } from '../jsutils/isPromise.js';
 
-export function expectPromise(maybePromise: unknown) {
+interface PromiseExpectation {
+  toResolve: () => Promise<unknown>;
+  toRejectWith: (message: string) => Promise<void>;
+}
+
+export function expectPromise(maybePromise: unknown): PromiseExpectation {
   assert(
     isPromise(maybePromise),
     `Expected a promise, received '${inspect(maybePromise)}'`,
   );
 
   return {
-    toResolve() {
+    toResolve(): Promise<unknown> {
       return maybePromise;
     },
-    async toRejectWith(message: string) {
+    async toRejectWith(message: string): Promise<void> {
       let caughtError: unknown;
       let resolved;
       let rejected = false;