@graphql-codegen/typescript-mongodb 2.4.3-alpha-7e47fba48.0 → 2.4.3-alpha-20220805095358-8b7e687d1

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@graphql-codegen/typescript-mongodb",
-  "version": "2.4.3-alpha-7e47fba48.0",
+  "version": "2.4.3-alpha-20220805095358-8b7e687d1",
   "description": "GraphQL Code Generator plugin for generting a ready-to-use ORM types for MongoDB",
   "peerDependencies": {
     "graphql": "^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
     "graphql-tag": "^2.0.0"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.6.1-alpha-7e47fba48.0",
-    "@graphql-codegen/typescript": "^2.7.3-alpha-7e47fba48.0",
-    "@graphql-codegen/visitor-plugin-common": "2.12.1-alpha-7e47fba48.0",
+    "@graphql-codegen/plugin-helpers": "2.6.2-alpha-20220805095358-8b7e687d1",
+    "@graphql-codegen/typescript": "2.7.3-alpha-20220805095358-8b7e687d1",
+    "@graphql-codegen/visitor-plugin-common": "2.12.1-alpha-20220805095358-8b7e687d1",
     "@graphql-tools/utils": "^8.8.0",
     "auto-bind": "~4.0.0",
     "lodash": "~4.17.0",
@@ -31,7 +31,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {

package/typings/config.d.cts

@@ -0,0 +1,86 @@
+import { RawConfig } from '@graphql-codegen/visitor-plugin-common';
+export interface TypeScriptMongoPluginConfig extends RawConfig {
+    /**
+     * @default DbObject
+     * @description Customize the suffix for the generated GraphQL `type`s.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   dbTypeSuffix: MyType
+     * ```
+     */
+    dbTypeSuffix?: string;
+    /**
+     * @default DbObject
+     * @description Customize the suffix for the generated GraphQL `interface`s.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   dbInterfaceSuffix: MyInterface
+     * ```
+     */
+    dbInterfaceSuffix?: string;
+    /**
+     * @default mongodb#ObjectId
+     * @description Customize the type of `_id` fields. You can either specify a type name, or specify `module#type`.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   objectIdType: ./my-models.ts#MyIdType
+     * ```
+     */
+    objectIdType?: string;
+    /**
+     * @default _id
+     * @description Customize the name of the id field generated after using `@id` directive over a GraphQL field.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   idFieldName: id
+     * ```
+     */
+    idFieldName?: string;
+    /**
+     * @default true
+     * @description Replaces generated `enum` values with `string`.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   enumsAsString: false
+     * ```
+     */
+    enumsAsString?: boolean;
+    /**
+     * @description This will cause the generator to avoid using TypeScript optionals (`?`),
+     * so the following definition: `type A { myField: String }` will output `myField: Maybe<string>`
+     * instead of `myField?: Maybe<string>`.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-mongodb
+     *     config:
+     *       avoidOptionals: true
+     * ```
+     */
+    avoidOptionals?: boolean;
+}
+export declare enum Directives {
+    ID = "id",
+    ENTITY = "entity",
+    ABSTRACT_ENTITY = "abstractEntity",
+    UNION = "union",
+    LINK = "link",
+    COLUMN = "column",
+    EMBEDDED = "embedded",
+    MAP = "map"
+}

package/typings/fields-tree.d.cts

@@ -0,0 +1,6 @@
+export declare class FieldsTree {
+    private _fields;
+    addField(path: string, type: string): void;
+    private _getInnerField;
+    get string(): string;
+}

package/typings/index.d.cts

@@ -0,0 +1,6 @@
+import { PluginFunction, PluginValidateFn } from '@graphql-codegen/plugin-helpers';
+import { TypeScriptMongoPluginConfig } from './config.cjs';
+export declare const plugin: PluginFunction<TypeScriptMongoPluginConfig>;
+export declare const DIRECTIVES: import("graphql").DocumentNode;
+export declare const addToSchema: import("graphql").DocumentNode;
+export declare const validate: PluginValidateFn<any>;

package/typings/visitor.d.cts

@@ -0,0 +1,30 @@
+import { ParsedConfig, BaseVisitor } from '@graphql-codegen/visitor-plugin-common';
+import { TypeScriptMongoPluginConfig } from './config.cjs';
+import { GraphQLSchema, ObjectTypeDefinitionNode, InterfaceTypeDefinitionNode, UnionTypeDefinitionNode } from 'graphql';
+export interface TypeScriptMongoPluginParsedConfig extends ParsedConfig {
+    dbTypeSuffix: string;
+    dbInterfaceSuffix: string;
+    objectIdType: string;
+    objectIdImport: string;
+    idFieldName: string;
+    enumsAsString: boolean;
+    avoidOptionals: boolean;
+}
+export declare class TsMongoVisitor extends BaseVisitor<TypeScriptMongoPluginConfig, TypeScriptMongoPluginParsedConfig> {
+    private _schema;
+    constructor(_schema: GraphQLSchema, pluginConfig: TypeScriptMongoPluginConfig);
+    get objectIdImport(): string;
+    private _resolveDirectiveValue;
+    private _getDirectiveArgValue;
+    private _getDirectiveFromAstNode;
+    private _buildInterfaces;
+    private _handleIdField;
+    private _handleLinkField;
+    private _handleColumnField;
+    private _handleEmbeddedField;
+    private _buildFieldsTree;
+    private _addAdditionalFields;
+    InterfaceTypeDefinition(node: InterfaceTypeDefinitionNode): string;
+    UnionTypeDefinition(node: UnionTypeDefinitionNode): string;
+    ObjectTypeDefinition(node: ObjectTypeDefinitionNode): string;
+}