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

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@graphql-codegen/typescript-vue-apollo",
-  "version": "3.3.3-alpha-0814e49cc.0",
+  "version": "3.3.3",
   "description": "GraphQL Code Generator plugin for generating ready-to-use Vue-Apollo composition functions 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,78 @@
+import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+/**
+ * @description This plugin generates @vue/apollo-composable composition functions with TypeScript typings.
+ *
+ * It extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.
+ *
+ */
+export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig {
+    /**
+     * @description Customized the output by enabling/disabling the generated Vue composition functions.
+     * @default true
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-vue-apollo
+     *     config:
+     *       withCompositionFunctions: true
+     * ```
+     */
+    withCompositionFunctions?: boolean;
+    /**
+     * @name vueApolloComposableImportFrom
+     * @default @vue/apollo-composable
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-vue-apollo
+     *     config:
+     *       vueApolloComposableImportFrom: vue
+     * ```
+     */
+    vueApolloComposableImportFrom?: 'vue' | '@vue/apollo-composable' | string;
+    /**
+     * @name vueCompositionApiImportFrom
+     * @default @vue/composition-api
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * generates:
+     *   path/to/file.ts:
+     *     plugins:
+     *       - typescript
+     *       - typescript-operations
+     *       - typescript-vue-apollo
+     *     config:
+     *       vueCompositionApiImportFrom: vue
+     * ```
+     */
+    vueCompositionApiImportFrom?: 'vue' | '@vue/composition-api' | string;
+    /**
+     * @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-vue-apollo
+     *     config:
+     *       addDocBlocks: true
+     * ```
+     */
+    addDocBlocks?: boolean;
+}

package/typings/index.d.cts

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

package/typings/visitor.d.cts

@@ -0,0 +1,25 @@
+import { ClientSideBaseVisitor, ClientSideBasePluginConfig, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import { VueApolloRawPluginConfig } from './config.cjs';
+import { OperationDefinitionNode, GraphQLSchema } from 'graphql';
+import { Types } from '@graphql-codegen/plugin-helpers';
+export interface VueApolloPluginConfig extends ClientSideBasePluginConfig {
+    withCompositionFunctions: boolean;
+    vueApolloComposableImportFrom: 'vue' | '@vue/apollo-composable' | string;
+    vueCompositionApiImportFrom: 'vue' | '@vue/apollo-composable' | string;
+    addDocBlocks: boolean;
+}
+export declare class VueApolloVisitor extends ClientSideBaseVisitor<VueApolloRawPluginConfig, VueApolloPluginConfig> {
+    private externalImportPrefix;
+    private imports;
+    constructor(schema: GraphQLSchema, fragments: LoadedFragment[], rawConfig: VueApolloRawPluginConfig, documents: Types.DocumentFile[]);
+    private get vueApolloComposableImport();
+    private get vueCompositionApiImport();
+    private get reactiveFunctionType();
+    private getDocumentNodeVariable;
+    getImports(): string[];
+    private buildCompositionFunctionsJSDoc;
+    private getCompositionFunctionSuffix;
+    protected buildOperation(node: OperationDefinitionNode, documentVariableName: string, operationType: 'Query' | 'Mutation' | 'Subscription', operationResultType: string, operationVariablesTypes: string): string;
+    private buildCompositionFunction;
+    private buildCompositionFunctionReturnType;
+}