@gqlbase/plugins 0.0.1 → 0.0.2

package/dist/base/NodeInterfacePlugin.d.ts

@@ -0,0 +1,19 @@
+import { type ITransformerPlugin } from "@gqlbase/core/plugins";
+import type { ITransformerContext } from "@gqlbase/core/context";
+import { DefinitionNode, ObjectNode } from "@gqlbase/core/definition";
+/**
+ * Adds a `Node` interface with an `id: ID!` field to the schema and ensures that all types that implement the `Node` interface also have the `id: ID!` field.
+ *
+ */
+export declare class NodeInterfacePlugin implements ITransformerPlugin {
+    readonly name = "NodeInterfacePlugin";
+    readonly context: ITransformerContext;
+    constructor(context: ITransformerContext);
+    init(): void;
+    match(definition: DefinitionNode): boolean;
+    before(): void;
+    execute(definition: ObjectNode): void;
+    after(): void;
+}
+export declare const nodeInterfacePlugin: (options?: unknown) => import("@gqlbase/core/plugins").IPluginFactory;
+//# sourceMappingURL=NodeInterfacePlugin.d.ts.map

package/dist/base/NodeInterfacePlugin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NodeInterfacePlugin.d.ts","sourceRoot":"","sources":["../../src/base/NodeInterfacePlugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAuB,KAAK,kBAAkB,EAAE,MAAM,uBAAuB,CAAC;AACrF,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAC;AACjE,OAAO,EACL,cAAc,EAOd,UAAU,EACX,MAAM,0BAA0B,CAAC;AAGlC;;;GAGG;AAEH,qBAAa,mBAAoB,YAAW,kBAAkB;IAC5D,SAAgB,IAAI,yBAAyB;IAC7C,QAAQ,CAAC,OAAO,EAAE,mBAAmB,CAAC;gBAE1B,OAAO,EAAE,mBAAmB;IAIjC,IAAI,IAAI,IAAI;IAQnB,KAAK,CAAC,UAAU,EAAE,cAAc,GAAG,OAAO;IAU1C,MAAM,IAAI,IAAI;IAed,OAAO,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI;IAmC9B,KAAK,IAAI,IAAI;CAiBrB;AAED,eAAO,MAAM,mBAAmB,uEAA2C,CAAC"}

package/dist/base/NodeInterfacePlugin.js

@@ -0,0 +1,70 @@
+import { createPluginFactory } from "@gqlbase/core/plugins";
+import { DirectiveNode, FieldNode, InputValueNode, InterfaceNode, NamedTypeNode, NonNullTypeNode, ObjectNode, } from "@gqlbase/core/definition";
+import { TransformerPluginExecutionError } from "@gqlbase/shared/errors";
+/**
+ * Adds a `Node` interface with an `id: ID!` field to the schema and ensures that all types that implement the `Node` interface also have the `id: ID!` field.
+ *
+ */
+export class NodeInterfacePlugin {
+    name = "NodeInterfacePlugin";
+    context;
+    constructor(context) {
+        this.context = context;
+    }
+    init() {
+        this.context.base.addNode(InterfaceNode.create("Node", [
+            FieldNode.create("id", NonNullTypeNode.create(NamedTypeNode.create("ID"))),
+        ]));
+    }
+    match(definition) {
+        if (definition instanceof ObjectNode) {
+            if (definition.hasInterface("Node") || definition.hasDirective("model")) {
+                return true;
+            }
+        }
+        return false;
+    }
+    before() {
+        const queryNode = this.context.document.getQueryNode();
+        if (!queryNode.hasField("node")) {
+            queryNode.addField(FieldNode.create("node", NamedTypeNode.create("Node"), [InputValueNode.create("id", NonNullTypeNode.create(NamedTypeNode.create("ID")))], [DirectiveNode.create("hasOne")]));
+        }
+    }
+    execute(definition) {
+        const nodeInterface = this.context.document.getNode("Node");
+        if (!nodeInterface) {
+            throw new TransformerPluginExecutionError(this.name, "Node Interface not found. Make sure you run `plugin.init()` before executing.");
+        }
+        // In definition has directive `@model` it should also implement `Node` interface
+        if (definition.hasDirective("model")) {
+            definition.addInterface(nodeInterface.name);
+        }
+        // Make sure that all fields declared by `Node` interface are declared by definition as well
+        const nodeFields = nodeInterface.fields ?? [];
+        for (const field of nodeFields) {
+            if (!definition.hasField(field.name)) {
+                definition.addField(FieldNode.fromDefinition(field.serialize()));
+            }
+            else {
+                const nodeFieldTypeName = field.type.getTypeName();
+                const fieldTypename = definition.getField(field.name)?.type.getTypeName();
+                if (nodeFieldTypeName !== fieldTypename) {
+                    throw new TransformerPluginExecutionError(this.name, `Field ${field.name} in ${definition.name} has different type than the one declared in Node interface. Expected ${nodeFieldTypeName}, got ${fieldTypename}`);
+                }
+            }
+        }
+    }
+    after() {
+        const iface = this.context.document.getNode("Node");
+        if (!iface || !(iface instanceof InterfaceNode)) {
+            throw new TransformerPluginExecutionError(this.name, "Node Interface not found. Make sure you run `plugin.init()` before executing.");
+        }
+        // Node interface should have only 1 field, the `id`
+        for (const field of iface.fields ?? []) {
+            if (field.name !== "id") {
+                iface.removeField(field.name);
+            }
+        }
+    }
+}
+export const nodeInterfacePlugin = createPluginFactory(NodeInterfacePlugin);

package/dist/base/index.d.ts

@@ -1,2 +1,3 @@
 export { modelPlugin, isModel, ModelPlugin, type ModelPluginOptions, ModelOperation, ModelDirective, } from "./ModelPlugin.js";
+export { NodeInterfacePlugin, nodeInterfacePlugin } from "./NodeInterfacePlugin.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/base/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,OAAO,EACP,WAAW,EACX,KAAK,kBAAkB,EACvB,cAAc,EACd,cAAc,GACf,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/base/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,OAAO,EACP,WAAW,EACX,KAAK,kBAAkB,EACvB,cAAc,EACd,cAAc,GACf,MAAM,kBAAkB,CAAC;AAC1B,OAAO,EAAE,mBAAmB,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAC"}

package/dist/base/index.js

@@ -1 +1,2 @@
 export { modelPlugin, isModel, ModelPlugin, ModelOperation, ModelDirective, } from "./ModelPlugin.js";
+export { NodeInterfacePlugin, nodeInterfacePlugin } from "./NodeInterfacePlugin.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gqlbase/plugins",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "Collection of plugins and presets for gqlbase, providing common transformations and utilities that can be used in GraphQL schema transformation processes.",
   "sideEffects": false,
   "type": "module",