Auto-complete of plugin names in preset (#2155)

graphile · Aug 16, 2024 · 54c9027 · 54c9027
2 parents 1b7fcbf + 792988e
commit 54c9027
Show file tree

Hide file tree

Showing 76 changed files with 534 additions and 15 deletions.
diff --git a/.changeset/two-balloons-learn.md b/.changeset/two-balloons-learn.md
@@ -0,0 +1,10 @@
+---
+"graphile-build-pg": patch
+"graphile-build": patch
+"postgraphile": patch
+"graphile-config": patch
+---
+
+`disablePlugins` now supports TypeScript auto-completion of known plugin names.
+Other names are still accepted without error, so this is just a minor DX
+improvement rather than type safety.
diff --git a/grafast/dataplan-pg/src/plugins/PgContextPlugin.ts b/grafast/dataplan-pg/src/plugins/PgContextPlugin.ts
@@ -8,6 +8,14 @@ export const EMPTY_OBJECT: Record<string, never> = Object.freeze(
   Object.create(null),
 );
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgContextPlugin: true;
+    }
+  }
+}
+
 export const PgContextPlugin: GraphileConfig.Plugin = {
   name: "PgContextPlugin",
   description:

diff --git a/grafast/grafserv-persisted/src/index.ts b/grafast/grafserv-persisted/src/index.ts
@@ -14,6 +14,14 @@ import LRU from "@graphile/lru";
 import type { PersistedOperationGetter } from "./interfaces.js";
 import { version } from "./version.js";
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PersistedPlugin: true;
+    }
+  }
+}
+
 const PersistedPlugin: GraphileConfig.Plugin = {
   name: "PersistedPlugin",
   description: "Enables persisted operations in Grafserv",

diff --git a/grafast/grafserv/src/envelop/index.ts b/grafast/grafserv/src/envelop/index.ts
@@ -18,6 +18,14 @@ declare global {
   }
 }
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      GrafservEnvelopPlugin: true;
+    }
+  }
+}
+
 export const GrafservEnvelopPlugin: GraphileConfig.Plugin = {
   name: "GrafservEnvelopPlugin",
   version,

diff --git a/graphile-build/graphile-build-pg/src/examples/NO_DATA_GATHERING.ts b/graphile-build/graphile-build-pg/src/examples/NO_DATA_GATHERING.ts
@@ -43,6 +43,14 @@ const pool = new Pool({
 });
 const withPgClient: WithPgClient = makePgAdaptorWithPgClient(pool);
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      UseRelationNamesPlugin: true;
+    }
+  }
+}
+
 async function main() {
   // Create our GraphQL schema by applying all the plugins
   const executor = EXPORTABLE(

diff --git a/graphile-build/graphile-build-pg/src/examples/config.ts b/graphile-build/graphile-build-pg/src/examples/config.ts
@@ -37,6 +37,14 @@ export function getPool() {
   return pool;
 }
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      EnumManglingPlugin: true;
+    }
+  }
+}
+
 const EnumManglingPlugin: GraphileConfig.Plugin = {
   name: "EnumManglingPlugin",
   description:

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgAllRowsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgAllRowsPlugin.ts
@@ -10,6 +10,12 @@ import { tagToString } from "../utils.js";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgAllRowsPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       /**

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgAttributeDeprecationPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgAttributeDeprecationPlugin.ts
@@ -2,6 +2,14 @@ import "graphile-config";
 
 import { version } from "../version.js";
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgAttributeDeprecationPlugin: true;
+    }
+  }
+}
+
 export const PgAttributeDeprecationPlugin: GraphileConfig.Plugin = {
   name: "PgAttributeDeprecationPlugin",
   description: "Marks a attribute as deprecated if it has the deprecated tag",

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgAttributesPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgAttributesPlugin.ts
@@ -21,6 +21,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgAttributesPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Build {
       pgResolveOutputType(

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgBasicsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgBasicsPlugin.ts
@@ -21,6 +21,12 @@ import { getCodecMetaLookupFromInput, makePgCodecMeta } from "../inputUtils.js";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgBasicsPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface BuildVersions {
       "graphile-build-pg": string;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgCodecsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgCodecsPlugin.ts
@@ -79,6 +79,14 @@ declare global {
   }
 
   namespace GraphileConfig {
+    interface Plugins {
+      PgCodecsPlugin: true;
+    }
+
+    interface Provides {
+      PgCodecs: true;
+    }
+
     interface GatherHelpers {
       pgCodecs: {
         getCodecFromClass(

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgConditionArgumentPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgConditionArgumentPlugin.ts
@@ -13,6 +13,12 @@ import type { GraphQLInputObjectType } from "grafast/graphql";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgConditionArgumentPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       conditionType(this: Inflection, typeName: string): string;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgConditionCustomFieldsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgConditionCustomFieldsPlugin.ts
@@ -11,6 +11,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgConditionCustomFieldsPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface ScopeInputObjectFieldsField {
       isPgConnectionConditionInputField?: boolean;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgConnectionArgOrderByDefaultValuePlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgConnectionArgOrderByDefaultValuePlugin.ts
@@ -5,6 +5,14 @@ import type { GraphQLEnumType } from "grafast/graphql";
 
 import { version } from "../version.js";
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgConnectionArgOrderByDefaultValuePlugin: true;
+    }
+  }
+}
+
 export const PgConnectionArgOrderByDefaultValuePlugin: GraphileConfig.Plugin = {
   name: "PgConnectionArgOrderByDefaultValuePlugin",
   description: "Sets the default 'orderBy' for a table",

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgConnectionArgOrderByPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgConnectionArgOrderByPlugin.ts
@@ -20,6 +20,12 @@ import { inspect } from "util";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgConnectionArgOrderByPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       orderByType(this: Inflection, typeName: string): string;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgConnectionTotalCountPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgConnectionTotalCountPlugin.ts
@@ -15,6 +15,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgConnectionTotalCountPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface ScopeObjectFieldsField {
       /**

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgCustomTypeFieldPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgCustomTypeFieldPlugin.ts
@@ -54,6 +54,12 @@ const $$rootMutation = Symbol("PgCustomTypeFieldPluginRootMutationSources");
 const $$computed = Symbol("PgCustomTypeFieldPluginComputedSources");
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgCustomTypeFieldPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Build {
       pgGetArgDetailsFromParameters(

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgEnumTablesPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgEnumTablesPlugin.ts
@@ -14,6 +14,10 @@ import { version } from "../version.js";
 
 declare global {
   namespace GraphileConfig {
+    interface Plugins {
+      PgEnumTablesPlugin: true;
+    }
+
     interface GatherHelpers {
       pgEnumTables: {
         isEnumConstraint(pgConstraint: PgConstraint): boolean;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgFakeConstraintsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgFakeConstraintsPlugin.ts
@@ -14,6 +14,10 @@ import { version } from "../version.js";
 
 declare global {
   namespace GraphileConfig {
+    interface Plugins {
+      PgFakeConstraintsPlugin: true;
+    }
+
     interface GatherHelpers {
       pgFakeConstraints: Record<string, never>;
     }

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgFirstLastBeforeAfterArgsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgFirstLastBeforeAfterArgsPlugin.ts
@@ -12,6 +12,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgFirstLastBeforeAfterArgsPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       conditionType(this: Inflection, typeName: string): string;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgIndexBehaviorsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgIndexBehaviorsPlugin.ts
@@ -1,5 +1,13 @@
 import { addBehaviorToTags } from "../utils.js";
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgIndexBehaviorsPlugin: true;
+    }
+  }
+}
+
 export const PgIndexBehaviorsPlugin: GraphileConfig.Plugin = {
   name: "PgIndexBehaviorsPlugin",
   version: "0.0.0",

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgInterfaceModeUnionAllRowsPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgInterfaceModeUnionAllRowsPlugin.ts
@@ -14,6 +14,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgInterfaceModeUnionAllRowsPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       /**

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgIntrospectionPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgIntrospectionPlugin.ts
@@ -61,6 +61,10 @@ declare global {
   }
 
   namespace GraphileConfig {
+    interface Plugins {
+      PgIntrospectionPlugin: true;
+    }
+
     interface GatherHelpers {
       pgIntrospection: {
         getIntrospection(): PromiseOrDirect<IntrospectionResults>;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgJWTPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgJWTPlugin.ts
@@ -42,6 +42,10 @@ declare global {
 
 declare global {
   namespace GraphileConfig {
+    interface Plugins {
+      PgJWTPlugin: true;
+    }
+
     interface GatherHelpers {
       pgJWT: Record<string, never>;
     }

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgLtreePlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgLtreePlugin.ts
@@ -10,6 +10,14 @@ interface State {
   ltreeArrayCodec: PgCodec;
 }
 
+declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgLtreePlugin: true;
+    }
+  }
+}
+
 export const PgLtreePlugin: GraphileConfig.Plugin = {
   name: "PgLtreePlugin",
   version,

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgMutationCreatePlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgMutationCreatePlugin.ts
@@ -11,6 +11,12 @@ import { tagToString } from "../utils.js";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgMutationCreatePlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface ScopeObject {
       isPgCreatePayloadType?: boolean;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgMutationPayloadEdgePlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgMutationPayloadEdgePlugin.ts
@@ -16,6 +16,12 @@ import { version } from "../version.js";
 import { applyOrderToPlan } from "./PgConnectionArgOrderByPlugin.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgMutationPayloadEdgePlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       tableEdgeField(this: Inflection, codec: PgCodecWithAttributes): string;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgMutationUpdateDeletePlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgMutationUpdateDeletePlugin.ts
@@ -27,6 +27,12 @@ import { tagToString } from "../utils.js";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgMutationUpdateDeletePlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface ScopeObject {
       isPgUpdatePayloadType?: boolean;

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgNodeIdAttributesPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgNodeIdAttributesPlugin.ts
@@ -15,6 +15,12 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgNodeIdAttributesPlugin: true;
+    }
+  }
+
   namespace GraphileBuild {
     interface Inflection {
       /**

diff --git a/graphile-build/graphile-build-pg/src/plugins/PgOrderAllAttributesPlugin.ts b/graphile-build/graphile-build-pg/src/plugins/PgOrderAllAttributesPlugin.ts
@@ -10,6 +10,11 @@ import { EXPORTABLE } from "graphile-build";
 import { version } from "../version.js";
 
 declare global {
+  namespace GraphileConfig {
+    interface Plugins {
+      PgOrderAllAttributesPlugin: true;
+    }
+  }
   namespace GraphileBuild {
     interface Inflection {
       orderByAttributeEnum(