Wire up cache-control-types and gateway-interface packages to

trevor-scheer · trevor-scheer · commit 37407c452b09 · 2022-10-17T16:32:36.000-07:00
repo, start building c-c-t for cjs+esm
diff --git a/.changeset/beige-feet-destroy.md b/.changeset/beige-feet-destroy.md
@@ -0,0 +1,2 @@
+---
+---
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -40,7 +40,6 @@
     "npm": "^8.5.0"
   },
   "devDependencies": {
-    "@apollo/cache-control-types": "1.0.2",
     "@apollo/client": "3.7.0",
     "@apollo/server-plugin-landing-page-graphql-playground": "4.0.0",
     "@apollo/utils.createhash": "1.1.0",
diff --git a/packages/cache-control-types/package.json b/packages/cache-control-types/package.json
@@ -2,11 +2,20 @@
   "name": "@apollo/cache-control-types",
   "version": "1.0.2",
   "description": "TypeScript types for Apollo Server info.cacheControl",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "type": "module",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/esm/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js"
+    }
+  },
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/apollographql/apollo-utils.git",
+    "url": "git+https://github.com/apollographql/apollo-server.git",
     "directory": "packages/cache-control-types/"
   },
   "keywords": [
@@ -17,6 +26,10 @@
   ],
   "author": "Apollo <packages@apollographql.com>",
   "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/apollographql/apollo-server/issues"
+  },
+  "homepage": "https://github.com/apollographql/apollo-server#readme",
   "peerDependencies": {
     "graphql": "14.x || 15.x || 16.x"
   }
diff --git a/packages/cache-control-types/src/index.ts b/packages/cache-control-types/src/index.ts
@@ -3,13 +3,13 @@
 // enable us to make non-alpha releases that can be used on the apollo-server
 // version-4 branch.
 
-import type { GraphQLCompositeType, GraphQLResolveInfo } from "graphql";
+import type { GraphQLCompositeType, GraphQLResolveInfo } from 'graphql';
 
 /**
  * CacheScope represents whether cacheable data should be shared across sessions
  * (PUBLIC) or considered session-specific (PRIVATE).
  */
-export type CacheScope = "PUBLIC" | "PRIVATE";
+export type CacheScope = 'PUBLIC' | 'PRIVATE';
 
 /**
  * CacheHint represents a contribution to an overall cache policy. It can
@@ -63,7 +63,7 @@ export interface ResolveInfoCacheControl {
  * use this type with the customResolveInfo option to the graphql-code-generator
  * typescript-resolvers plugin, for example.) */
 export interface GraphQLResolveInfoWithCacheControl
-  extends Omit<GraphQLResolveInfo, "cacheControl"> {
+  extends Omit<GraphQLResolveInfo, 'cacheControl'> {
   // Why the Omit above? If you happen to have AS2 `apollo-cache-control` or AS3
   // `apollo-server-core` in your TypeScript build, then there's an ambient
   // `declare module` floating around that monkey-patches GraphQLResolveInfo to
@@ -96,18 +96,18 @@ export function maybeCacheControlFromInfo(
 export function cacheControlFromInfo(
   info: GraphQLResolveInfo,
 ): ResolveInfoCacheControl {
-  if (!("cacheControl" in info)) {
+  if (!('cacheControl' in info)) {
     throw new Error(
-      "The `info` argument does not appear to have a cacheControl field. " +
+      'The `info` argument does not appear to have a cacheControl field. ' +
         "Check that you are using Apollo Server 3 or newer and that you aren't using " +
-        "ApolloServerPluginCacheControlDisabled.",
+        'ApolloServerPluginCacheControlDisabled.',
     );
   }
   if (!(info as any).cacheControl?.cacheHint?.restrict) {
     throw new Error(
-      "The `info` argument has a cacheControl field but it does not appear to be from Apollo" +
+      'The `info` argument has a cacheControl field but it does not appear to be from Apollo' +
         "Server 3 or newer. Check that you are using Apollo Server 3 or newer and that you aren't using " +
-        "ApolloServerPluginCacheControlDisabled.",
+        'ApolloServerPluginCacheControlDisabled.',
     );
   }
   return (info as any).cacheControl;
diff --git a/packages/cache-control-types/tsconfig.cjs.json b/packages/cache-control-types/tsconfig.cjs.json
@@ -0,0 +1,11 @@
+{
+  "extends": ".",
+  "compilerOptions": {
+    "module": "commonjs",
+    "outDir": "./dist/cjs",
+    // We delete the CJS .d.ts files in postcompile so we don't need to
+    // ever make their maps. (We can't disable creating the files because
+    // this is a composite project.)
+    "declarationMap": false,
+  },
+}
diff --git a/packages/cache-control-types/tsconfig.json b/packages/cache-control-types/tsconfig.json
@@ -2,7 +2,7 @@
   "extends": "../../tsconfig.base",
   "compilerOptions": {
     "rootDir": "src",
-    "outDir": "dist"
+    "outDir": "dist/esm"
   },
   "include": ["src/**/*"],
   "exclude": ["**/__tests__"]
diff --git a/packages/gateway-interface/.npmignore b/packages/gateway-interface/.npmignore
diff --git a/packages/gateway-interface/CHANGELOG.md b/packages/gateway-interface/CHANGELOG.md
diff --git a/packages/gateway-interface/README.md b/packages/gateway-interface/README.md
diff --git a/packages/gateway-interface/package.json b/packages/gateway-interface/package.json
@@ -3,19 +3,20 @@
   "version": "1.0.4",
   "description": "Interface used to connect Apollo Gateway to Apollo Server",
   "type": "module",
+  "main": "",
   "types": "dist/index.d.ts",
   "repository": {
     "type": "git",
-    "url": "https://github.com/apollographql/apollo-utils",
-    "directory": "packages/server-gateway-interface"
+    "url": "https://github.com/apollographql/apollo-server",
+    "directory": "packages/gateway-interface"
   },
   "keywords": [],
   "author": "Apollo <packages@apollographql.com>",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/apollographql/apollo-utils/issues"
+    "url": "https://github.com/apollographql/apollo-server/issues"
   },
-  "homepage": "https://github.com/apollographql/apollo-utils#readme",
+  "homepage": "https://github.com/apollographql/apollo-server#readme",
   "engines": {
     "node": ">=12.0"
   },
diff --git a/packages/gateway-interface/src/index.ts b/packages/gateway-interface/src/index.ts
@@ -3,18 +3,18 @@
 // enable us to make non-alpha releases that can be used on the apollo-server
 // version-4 branch.
 
-import type { KeyValueCache } from "@apollo/utils.keyvaluecache";
+import type { KeyValueCache } from '@apollo/utils.keyvaluecache';
 import type {
   DocumentNode,
   ExecutionResult,
   GraphQLError,
   GraphQLFormattedError,
   GraphQLSchema,
   OperationDefinitionNode,
-} from "graphql";
-import type { Logger } from "@apollo/utils.logger";
-import type { Trace } from "@apollo/usage-reporting-protobuf";
-import type { FetcherHeaders } from "@apollo/utils.fetcher";
+} from 'graphql';
+import type { Logger } from '@apollo/utils.logger';
+import type { Trace } from '@apollo/usage-reporting-protobuf';
+import type { FetcherHeaders } from '@apollo/utils.fetcher';
 
 export interface GatewayInterface {
   onSchemaLoadOrUpdate(
@@ -104,7 +104,7 @@ export interface GatewayHTTPResponse {
   status?: number;
 }
 
-export type GatewaySchemaHash = string & { __fauxpaque: "SchemaHash" };
+export type GatewaySchemaHash = string & { __fauxpaque: 'SchemaHash' };
 
 export interface GatewayGraphQLRequestMetrics {
   captureTraces?: boolean;
diff --git a/packages/gateway-interface/tsconfig.json b/packages/gateway-interface/tsconfig.json
diff --git a/packages/integration-testsuite/tsconfig.json b/packages/integration-testsuite/tsconfig.json
@@ -9,6 +9,7 @@
   },
   "include": ["src/**/*"],
   "references": [
+    { "path": "../cache-control-types"},
     { "path": "../server" },
   ],
 }
diff --git a/packages/server/tsconfig.json b/packages/server/tsconfig.json
@@ -6,4 +6,8 @@
   },
   "include": ["src/**/*"],
   "exclude": ["**/__tests__"],
+  "references": [
+    { "path": "../cache-control-types"},
+    { "path": "../gateway-interface" },
+  ],
 }
diff --git a/scripts/postcompile.mjs b/scripts/postcompile.mjs
@@ -12,7 +12,7 @@ import { writeFileSync } from 'fs';
 import rimraf from 'rimraf';
 
 // Tell Node what kinds of files the ".js" files in these subdirectories are.
-for (const dir of ['plugin-response-cache', 'server']) {
+for (const dir of ['cache-control-types', 'plugin-response-cache', 'server']) {
   writeFileSync(
     path.join('packages', dir, 'dist', 'esm', 'package.json'),
     JSON.stringify({ type: 'module' }),
diff --git a/tsconfig.build.cjs.json b/tsconfig.build.cjs.json
@@ -5,6 +5,7 @@
   "files": [],
   "include": [],
   "references": [
+    { "path": "./packages/cache-control-types/tsconfig.cjs.json" },
     { "path": "./packages/plugin-response-cache/tsconfig.cjs.json" },
     { "path": "./packages/server/tsconfig.cjs.json" },
   ]
diff --git a/tsconfig.build.esm.json b/tsconfig.build.esm.json
@@ -5,6 +5,8 @@
   "files": [],
   "include": [],
   "references": [
+    { "path": "./packages/cache-control-types" },
+    { "path": "./packages/gateway-interface" },
     { "path": "./packages/integration-testsuite/" },
     { "path": "./packages/plugin-response-cache" },
     { "path": "./packages/server" },
