@graphql-codegen/typescript-react-apollo 3.3.3-alpha-0814e49cc.0 → 3.3.3

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@graphql-codegen/typescript-react-apollo",
-  "version": "3.3.3-alpha-0814e49cc.0",
+  "version": "3.3.3",
   "description": "GraphQL Code Generator plugin for generating a ready-to-use React Components/HOC/Hooks based on GraphQL operations",
   "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-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",
     "change-case-all": "1.0.14",
     "tslib": "~2.4.0"
@@ -29,7 +29,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,193 @@
+import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+/**
+ * @description This plugin generates React Apollo components and HOC with TypeScript typings.
+ *
+ * It extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.
+ */
+export interface ReactApolloRawPluginConfig extends RawClientSideBasePluginConfig {
+    /**
+     * @description Customize the output by enabling/disabling the generated Component (deprecated since Apollo-Client v3). For more details: https://apollographql.com/docs/react/api/react/components
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withComponent: true
+     * ```
+     */
+    withComponent?: boolean;
+    /**
+     * @description Customize the output by enabling/disabling the HOC (deprecated since Apollo-Client v3). For more details: https://apollographql.com/docs/react/api/react/hoc
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withHOC: true
+     * ```
+     */
+    withHOC?: boolean;
+    /**
+     * @description Customized the output by enabling/disabling the generated React Hooks. For more details: https://apollographql.com/docs/react/api/react/hooks
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withHooks: true
+     * ```
+     */
+    withHooks?: boolean;
+    /**
+     * @description Customized the output by enabling/disabling the generated mutation function signature.
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withMutationFn: true
+     * ```
+     */
+    withMutationFn?: boolean;
+    /**
+     * @description Enable generating a function to be used with refetchQueries
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withRefetchFn: false
+     * ```
+     */
+    withRefetchFn?: boolean;
+    /**
+     * @description Customize the package where apollo-react common lib is loaded from.
+     * @default "@apollo/react-common"
+     */
+    apolloReactCommonImportFrom?: string;
+    /**
+     * @description Customize the package where apollo-react component lib is loaded from.
+     * @default "@apollo/react-components"
+     */
+    apolloReactComponentsImportFrom?: string;
+    /**
+     * @description Customize the package where apollo-react HOC lib is loaded from.
+     * @default "@apollo/react-hoc"
+     */
+    apolloReactHocImportFrom?: string;
+    /**
+     * @description Customize the package where apollo-react hooks lib is loaded from.
+     * @default "@apollo/react-hooks"
+     */
+    apolloReactHooksImportFrom?: string;
+    /**
+     * @description You can specify a suffix that gets attached to the name of the generated component.
+     * @default Component
+     */
+    componentSuffix?: string;
+    /**
+     * @description Sets the version of react-apollo.
+     * If you are using the old (deprecated) package of `react-apollo`, please set this configuration to `2`.
+     * If you are using Apollo-Client v3, please set this to `3`.
+     * @default 3
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       reactApolloVersion: 2
+     * ```
+     */
+    reactApolloVersion?: 2 | 3;
+    /**
+     * @description Customized the output by enabling/disabling the generated result type.
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withResultType: true
+     * ```
+     */
+    withResultType?: boolean;
+    /**
+     * @description Customized the output by enabling/disabling the generated mutation option type.
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       withMutationOptionsType: true
+     * ```
+     */
+    withMutationOptionsType?: boolean;
+    /**
+     * @description Allows you to enable/disable the generation of docblocks in generated code.
+     * Some IDE's (like VSCode) add extra inline information with docblocks, you can disable this feature if your preferred IDE does not.
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-react-apollo
+     *     config:
+     *       addDocBlocks: true
+     * ```
+     */
+    addDocBlocks?: boolean;
+    defaultBaseOptions?: {
+        [key: string]: string;
+    };
+    hooksSuffix?: string;
+}

package/typings/index.d.cts

@@ -0,0 +1,6 @@
+import { Types, PluginValidateFn, PluginFunction } from '@graphql-codegen/plugin-helpers';
+import { ReactApolloVisitor } from './visitor.cjs';
+import { ReactApolloRawPluginConfig } from './config.cjs';
+export declare const plugin: PluginFunction<ReactApolloRawPluginConfig, Types.ComplexPluginOutput>;
+export declare const validate: PluginValidateFn<any>;
+export { ReactApolloVisitor };

package/typings/visitor.d.cts

@@ -0,0 +1,54 @@
+import { ClientSideBaseVisitor, ClientSideBasePluginConfig, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import { ReactApolloRawPluginConfig } from './config.cjs';
+import { OperationDefinitionNode, GraphQLSchema } from 'graphql';
+import { Types } from '@graphql-codegen/plugin-helpers';
+export interface ReactApolloPluginConfig extends ClientSideBasePluginConfig {
+    withComponent: boolean;
+    withHOC: boolean;
+    withHooks: boolean;
+    withMutationFn: boolean;
+    withRefetchFn: boolean;
+    apolloReactCommonImportFrom: string;
+    apolloReactComponentsImportFrom: string;
+    apolloReactHocImportFrom: string;
+    apolloReactHooksImportFrom: string;
+    componentSuffix: string;
+    reactApolloVersion: 2 | 3;
+    withResultType: boolean;
+    withMutationOptionsType: boolean;
+    addDocBlocks: boolean;
+    defaultBaseOptions: {
+        [key: string]: string;
+    };
+    hooksSuffix: string;
+}
+export declare class ReactApolloVisitor extends ClientSideBaseVisitor<ReactApolloRawPluginConfig, ReactApolloPluginConfig> {
+    protected rawConfig: ReactApolloRawPluginConfig;
+    private _externalImportPrefix;
+    private imports;
+    constructor(schema: GraphQLSchema, fragments: LoadedFragment[], rawConfig: ReactApolloRawPluginConfig, documents: Types.DocumentFile[]);
+    private getImportStatement;
+    private getReactImport;
+    private getApolloReactCommonIdentifier;
+    private getApolloReactHooksIdentifier;
+    private usesExternalHooksOnly;
+    private getApolloReactCommonImport;
+    private getApolloReactComponentsImport;
+    private getApolloReactHocImport;
+    private getApolloReactHooksImport;
+    private getOmitDeclaration;
+    private getDefaultOptions;
+    private getDocumentNodeVariable;
+    getImports(): string[];
+    private _buildHocProps;
+    private _buildMutationFn;
+    private _buildOperationHoc;
+    private _buildComponent;
+    private _buildHooksJSDoc;
+    private _buildHooks;
+    private _getHookSuffix;
+    private _buildResultType;
+    private _buildWithMutationOptionsType;
+    private _buildRefetchFn;
+    protected buildOperation(node: OperationDefinitionNode, documentVariableName: string, operationType: string, operationResultType: string, operationVariablesTypes: string, hasRequiredVariables: boolean): string;
+}