@znight/graphql 0.0.0 → 0.2.1

package/dist/compiler.d.mts

@@ -0,0 +1,114 @@
+import { Scope } from "@znight/core";
+import { MetaEntry } from "@znight/http/compiler";
+import { BindingHandle, ClassInfo, ClassRef, CompilerExtension, Location, ValueRef } from "@znight/compiler";
+/** Kind of field a resolver method provides. */
+type FieldOperation = "query" | "mutation" | "subscription" | "field";
+/** A `@Resolver` class. */
+interface ResolverData {
+  readonly kind: "resolver";
+  /** The resolver class; its identity is the provider token. */
+  readonly host: ClassInfo;
+  readonly scope: Scope;
+  /** Location of `@Resolver`. */
+  readonly location: Location;
+  /**
+   * `@Resolver('Event')`: the SDL object type its `@ResolveField` methods belong to (schema-first,
+   * RFC 0007), with the location of the argument.
+   */
+  readonly typeName?: {
+    readonly name: string;
+    readonly location: Location;
+  };
+  /**
+   * Schema-first: a class the analysis rejected (an error was reported); it only tells which fields
+   * its methods name (never bound, never a provider).
+   */
+  readonly invalid?: true;
+  /** Class `@UseGuard` guards. */
+  readonly guards: readonly ClassRef[];
+  /** One entry per field decorator of the class's methods, in source order. */
+  readonly fields: readonly FieldData[];
+}
+/** One `@Query`, `@Mutation`, `@Subscription` or `@ResolveField` decorator. */
+interface FieldData {
+  /** Method name. */
+  readonly method: string;
+  readonly operation: FieldOperation;
+  /** GraphQL field name (decorator argument, or the method name). */
+  readonly name: string;
+  /** Location of the field decorator. */
+  readonly location: Location;
+  /** Location of the method name. */
+  readonly methodLocation: Location;
+  /** Method `@UseGuard` guards (class guards are on {@link ResolverData.guards}). */
+  readonly guards: readonly ClassRef[];
+  /** Effective route metadata: the class entries a method decision does not replace, then the method's. */
+  readonly meta: readonly MetaEntry[];
+  /** One entry per method parameter, by index (`undefined`: the parameter could not be analysed). */
+  readonly params: readonly (ParamData | undefined)[];
+  /** `false` when a parameter or the method could not be analysed (an error was reported). */
+  readonly complete: boolean;
+}
+/** What a method parameter receives (§7.3). */
+type ParamData = {
+  readonly kind: "args";
+  /** `@Args('name')`: one argument; `undefined`: the properties of the type are the arguments. */
+  readonly name: string | undefined;
+  /** `@Args(..., Schema)`: the Standard Schema validating the value. */
+  readonly schema: ValueRef | undefined;
+  readonly location: Location;
+} | {
+  readonly kind: "parent";
+  readonly location: Location;
+} | {
+  readonly kind: "ctx";
+} | {
+  readonly kind: "info";
+} | {
+  readonly kind: "loader";
+  /** Binding of the loader provider (lazy edge from the resolver). */
+  readonly binding: BindingHandle;
+  /** Identity of `L` in `Loader<L>`. */
+  readonly identity: string;
+  readonly location: Location;
+};
+/** Everything the extension stores. */
+type GraphQLData = ResolverData;
+/**
+ * Options of the compiler extension (RFC 0005 §6.7, RFC 0007 §4.1), given with
+ * `graphql.configure({ ... })` in `znight.config.ts`. Import-free.
+ */
+/** Options of `graphql.configure()`. */
+interface GraphQLCompilerOptions {
+  /**
+   * Path of the SDL artifact, relative to the project root (`'schema.graphql'`), written next to the
+   * generated module and checked by `znight generate --check`. Default `false`: no file.
+   */
+  readonly sdl?: string | false;
+  /** GraphQL type of `number`. Default `'Float'`; `'Int'` suits counts and identifiers. Code-first only. */
+  readonly number?: "Float" | "Int";
+  /**
+   * Schema-first mode (RFC 0007): globs of the `.graphql` files that define the schema, relative to
+   * the project root (`'src/**\/*.graphql'`, `!` negations allowed). Resolvers are bound to their
+   * fields by name and checked against the SDL. Default `false`: code-first.
+   */
+  readonly schema?: string | readonly string[] | false;
+}
+/** {@link GraphQLCompilerOptions} with their defaults. */
+interface ResolvedGraphQLCompilerOptions {
+  readonly sdl: string | false;
+  readonly number: "Float" | "Int";
+  /** The schema-first globs; `false`: code-first. */
+  readonly schema: readonly string[] | false;
+}
+/** The `@znight/graphql` compiler extension, with its options and `configure()`. */
+export interface GraphQLCompilerExtension extends CompilerExtension<GraphQLData> {
+  /** The options of this copy (defaults filled in). */
+  readonly options: ResolvedGraphQLCompilerOptions;
+  /** A copy of the extension with `options` merged onto the options of this one. */
+  configure(options: GraphQLCompilerOptions): GraphQLCompilerExtension;
+}
+/** The `@znight/graphql` compiler extension with its default options. */
+export declare const graphqlCompilerExtension: GraphQLCompilerExtension;
+export { type FieldData, type FieldOperation, type GraphQLCompilerOptions, type GraphQLData, type ParamData, type ResolvedGraphQLCompilerOptions, type ResolverData, graphqlCompilerExtension as default };
+//# sourceMappingURL=compiler.d.mts.map