@graphql-codegen/graphql-modules-preset 2.5.0 → 2.5.1-alpha-20220805095358-8b7e687d1

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@graphql-codegen/graphql-modules-preset",
-  "version": "2.5.0",
+  "version": "2.5.1-alpha-20220805095358-8b7e687d1",
   "description": "GraphQL Code Generator preset for modularized schema",
   "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"
   },
   "dependencies": {
-    "@graphql-codegen/plugin-helpers": "^2.6.0",
-    "@graphql-codegen/visitor-plugin-common": "2.12.0",
+    "@graphql-codegen/plugin-helpers": "2.6.2-alpha-20220805095358-8b7e687d1",
+    "@graphql-codegen/visitor-plugin-common": "2.12.1-alpha-20220805095358-8b7e687d1",
     "@graphql-tools/utils": "^8.8.0",
     "parse-filepath": "^1.0.2",
     "change-case-all": "1.0.14",
@@ -29,7 +29,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {

package/typings/builder.d.cts

@@ -0,0 +1,14 @@
+import { DocumentNode, GraphQLSchema } from 'graphql';
+import { ModulesConfig } from './config.cjs';
+import { BaseVisitor } from '@graphql-codegen/visitor-plugin-common';
+export declare function buildModule(name: string, doc: DocumentNode, { importNamespace, importPath, encapsulate, requireRootResolvers, shouldDeclare, rootTypes, schema, baseVisitor, useGraphQLModules, }: {
+    importNamespace: string;
+    importPath: string;
+    encapsulate: ModulesConfig['encapsulateModuleTypes'];
+    requireRootResolvers: ModulesConfig['requireRootResolvers'];
+    shouldDeclare: boolean;
+    rootTypes: string[];
+    baseVisitor: BaseVisitor;
+    schema?: GraphQLSchema;
+    useGraphQLModules: boolean;
+}): string;

package/typings/config.d.cts

@@ -0,0 +1,114 @@
+export declare type ModulesConfig = {
+    /**
+     * @name baseTypesPath
+     * @type string
+     * @description Required, should point to the base schema types file.
+     * The key of the output is used a base path for this file.
+     *
+     * @example
+     * ```yaml
+     * generates:
+     * src/:
+     *  preset: modules
+     *  presetConfig:
+     *    baseTypesPath: types.ts
+     *  plugins:
+     *    - typescript-resolvers
+     * ```
+     */
+    baseTypesPath: string;
+    /**
+     * @name importBaseTypesFrom
+     * @type string
+     * @description Overrides the package import for the base types. Use this if you are within a monorepo, and you wish
+     * to import the base types directly from a different package, and not from a relative path.
+     *
+     */
+    importBaseTypesFrom?: string;
+    /**
+     * @name cwd
+     * @type string
+     * @description Optional, override the `cwd` of the execution. We are using `cwd` to figure out the imports between files. Use this if your execution path is not your project root directory.
+     * @default process.cwd()
+     *
+     * @example
+     * ```yaml
+     * generates:
+     * src/:
+     *  preset: modules
+     *  presetConfig:
+     *    baseTypesPath: types.ts
+     *    cwd: /some/path
+     *  plugins:
+     *    - typescript-resolvers
+     * ```
+     */
+    cwd?: string;
+    /**
+     * @name importTypesNamespace
+     * @type string
+     * @description Optional, override the name of the import namespace used to import from the `baseTypesPath` file.
+     * @default Types
+     *
+     * @example
+     * ```yaml
+     * generates:
+     * src/:
+     *  preset: modules
+     *  presetConfig:
+     *    baseTypesPath: types.ts
+     *    importTypesNamespace: core
+     *  plugins:
+     *    - typescript-resolvers
+     * ```
+     */
+    importTypesNamespace?: string;
+    /**
+     * @name filename
+     * @type string
+     * @description Required, sets the file name for the generated files.
+     *
+     */
+    filename: string;
+    /**
+     * @name encapsulateModuleTypes
+     * @type string
+     * @default namespace
+     * @description Configure how to encapsulate the module types, to avoid confusion.
+     *
+     * `namespace` (default): will wrap all types in a TypeScript namespace, using the module name.
+     * `prefix`: will prefix all types from a specific module with the module name.
+     * `none`: will skip encapsulation, and generate type as-is.
+     *
+     */
+    encapsulateModuleTypes: 'prefix' | 'namespace' | 'none';
+    /**
+     * @name requireRootResolvers
+     * @type boolean
+     * @default false
+     * @description Generate resolvers of root types (Query, Mutation and Subscription) as non-optional.
+     *
+     * @example
+     * ```yml
+     * generates:
+     * src/:
+     *  preset: modules
+     *  presetConfig:
+     *    baseTypesPath: types.ts
+     *    filename: types.ts
+     *    requireRootResolvers: true
+     *  plugins:
+     *    - typescript-resolvers
+     * ```
+     */
+    requireRootResolvers?: boolean;
+    /**
+     * @name useGraphQLModules
+     * @type boolean
+     * @default true
+     * @description By default, the generated types will generate some code specific to `graphql-modules` library.
+     *
+     * If you are not using GraphQL-Modules, you can disable this feature by setting this to `false`.
+     */
+    useGraphQLModules?: boolean;
+};

package/typings/index.d.cts

@@ -0,0 +1,4 @@
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { ModulesConfig } from './config.cjs';
+export declare const preset: Types.OutputPreset<ModulesConfig>;
+export default preset;

package/typings/utils.d.cts

@@ -0,0 +1,25 @@
+import { DocumentNode, NamedTypeNode, TypeNode } from 'graphql';
+import { Source } from '@graphql-tools/utils';
+/**
+ * Searches every node to collect used types
+ */
+export declare function collectUsedTypes(doc: DocumentNode): string[];
+export declare function resolveTypeNode(node: TypeNode): NamedTypeNode;
+export declare function isGraphQLPrimitive(name: string): boolean;
+export declare function unique<T>(val: T, i: number, all: T[]): boolean;
+export declare function withQuotes(val: string): string;
+export declare function indent(size: number): (val: string) => string;
+export declare function buildBlock({ name, lines }: {
+    name: string;
+    lines: string[];
+}): string;
+export declare function groupSourcesByModule(sources: Source[], basePath: string): Record<string, Source[]>;
+export declare function stripFilename(path: string): string;
+export declare function normalize(path: string): string;
+/**
+ * Pushes an item to a list only if the list doesn't include the item
+ */
+export declare function pushUnique<T>(list: T[], item: T): void;
+export declare function concatByKey<T extends Record<string, any[]>, K extends keyof T>(left: T, right: T, key: K): T[K][number][];
+export declare function uniqueByKey<T extends Record<string, any[]>, K extends keyof T>(left: T, right: T, key: K): any[];
+export declare function createObject<K extends string, T>(keys: K[], valueFn: (key: K) => T): Record<K, T>;