@graphql-codegen/typescript-document-nodes 2.3.3-alpha-0814e49cc.0 → 2.3.3

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@graphql-codegen/typescript-document-nodes",
-  "version": "2.3.3-alpha-0814e49cc.0",
+  "version": "2.3.3",
   "description": "GraphQL Code Generator plugin for generating TypeScript modules with embedded GraphQL document nodes",
   "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.1-alpha-0814e49cc.0",
-    "@graphql-codegen/visitor-plugin-common": "2.12.1-alpha-0814e49cc.0",
+    "@graphql-codegen/plugin-helpers": "^2.6.2",
+    "@graphql-codegen/visitor-plugin-common": "2.12.1",
     "auto-bind": "~4.0.0",
     "tslib": "~2.4.0"
   },
@@ -27,7 +27,7 @@
   "exports": {
     ".": {
       "require": {
-        "types": "./typings/index.d.ts",
+        "types": "./typings/index.d.cts",
         "default": "./cjs/index.js"
       },
       "import": {

package/typings/index.d.cts

@@ -0,0 +1,94 @@
+import { PluginFunction, PluginValidateFn } from '@graphql-codegen/plugin-helpers';
+import { NamingConvention, RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+/**
+ * @description This plugin generates TypeScript source `.ts` file from GraphQL files `.graphql`.
+ */
+export interface TypeScriptDocumentNodesRawPluginConfig extends RawClientSideBasePluginConfig {
+    /**
+     * @default change-case-all#pascalCase
+     * @description Allow you to override the naming convention of the output.
+     * You can either override all namings, or specify an object with specific custom naming convention per output.
+     * The format of the converter must be a valid `module#method`.
+     * Allowed values for specific output are: `typeNames`, `enumValues`.
+     * You can also use "keep" to keep all GraphQL names as-is.
+     * Additionally, you can set `transformUnderscore` to `true` if you want to override the default behavior,
+     * which is to preserve underscores.
+     *
+     * Available case functions in `change-case-all` are `camelCase`, `capitalCase`, `constantCase`, `dotCase`, `headerCase`, `noCase`, `paramCase`, `pascalCase`, `pathCase`, `sentenceCase`, `snakeCase`, `lowerCase`, `localeLowerCase`, `lowerCaseFirst`, `spongeCase`, `titleCase`, `upperCase`, `localeUpperCase` and `upperCaseFirst`
+     * [See more](https://github.com/btxtiger/change-case-all)
+     *
+     * @exampleMarkdown
+     * ## Override All Names
+     * ```yaml
+     * config:
+     *   namingConvention: change-case-all#lowerCase
+     * ```
+     *
+     * ## Upper-case enum values
+     * ```yaml
+     * config:
+     *   namingConvention:
+     *     typeNames: change-case-all#pascalCase
+     *     enumValues: change-case-all#upperCase
+     * ```
+     *
+     * ## Keep name as-is
+     * ```yaml
+     * config:
+     *   namingConvention: keep
+     * ```
+     *
+     * ## Remove Underscores
+     * ```yaml
+     * config:
+     *   namingConvention:
+     *     typeNames: change-case-all#pascalCase
+     *     transformUnderscore: true
+     * ```
+     */
+    namingConvention?: NamingConvention;
+    /**
+     * @default ""
+     * @description Adds prefix to the name
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * documents: src/api/user-service/queries.graphql
+     * generates:
+     *   src/api/user-service/queries.ts:
+     *   plugins:
+     *     - typescript-document-nodes
+     *   config:
+     *     namePrefix: 'gql'
+     * ```
+     */
+    namePrefix?: string;
+    /**
+     * @default ""
+     * @description Adds suffix to the name
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * documents: src/api/user-service/queries.graphql
+     * generates:
+     *   src/api/user-service/queries.ts:
+     *   plugins:
+     *     - typescript-document-nodes
+     *   config:
+     *     nameSuffix: 'Query'
+     * ```
+     */
+    nameSuffix?: string;
+    /**
+     * @default ""
+     * @description Adds prefix to the fragment variable
+     */
+    fragmentPrefix?: string;
+    /**
+     * @default ""
+     * @description Adds suffix to the fragment variable
+     */
+    fragmentSuffix?: string;
+}
+export declare const plugin: PluginFunction<TypeScriptDocumentNodesRawPluginConfig>;
+export declare const validate: PluginValidateFn<any>;

package/typings/visitor.d.cts

@@ -0,0 +1,11 @@
+import { TypeScriptDocumentNodesRawPluginConfig } from './index.cjs';
+import { Types } from '@graphql-codegen/plugin-helpers';
+import { LoadedFragment, ClientSideBaseVisitor, NamingConvention, ClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+import { GraphQLSchema } from 'graphql';
+export interface TypeScriptDocumentNodesPluginConfig extends ClientSideBasePluginConfig {
+    namingConvention: NamingConvention;
+    transformUnderscore: boolean;
+}
+export declare class TypeScriptDocumentNodesVisitor extends ClientSideBaseVisitor<TypeScriptDocumentNodesRawPluginConfig, TypeScriptDocumentNodesPluginConfig> {
+    constructor(schema: GraphQLSchema, fragments: LoadedFragment[], rawConfig: TypeScriptDocumentNodesRawPluginConfig, documents: Types.DocumentFile[]);
+}