@graphql-codegen/typescript-vue-apollo 3.3.4 → 3.3.5-alpha-20221018123033-99bc320fe

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/package.json +2 -2
  2. package/typings/config.d.cts +60 -36
  3. package/typings/config.d.ts +60 -36
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@graphql-codegen/typescript-vue-apollo",
3
- "version": "3.3.4",
3
+ "version": "3.3.5-alpha-20221018123033-99bc320fe",
4
4
  "description": "GraphQL Code Generator plugin for generating ready-to-use Vue-Apollo composition functions based on GraphQL operations",
5
5
  "peerDependencies": {
6
6
  "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",
@@ -8,7 +8,7 @@
8
8
  },
9
9
  "dependencies": {
10
10
  "@graphql-codegen/plugin-helpers": "^2.6.2",
11
- "@graphql-codegen/visitor-plugin-common": "2.12.2",
11
+ "@graphql-codegen/visitor-plugin-common": "2.13.0-alpha-20221018123033-99bc320fe",
12
12
  "auto-bind": "~4.0.0",
13
13
  "change-case-all": "1.0.14",
14
14
  "tslib": "~2.4.0"
package/typings/config.d.cts CHANGED
@@ -11,15 +11,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
11
11
  * @default true
12
12
  *
13
13
  * @exampleMarkdown
14
- * ```yaml
15
- * generates:
16
- * path/to/file.ts:
17
- * plugins:
18
- * - typescript
19
- * - typescript-operations
20
- * - typescript-vue-apollo
21
- * config:
22
- * withCompositionFunctions: true
14
+ * ```ts filename="codegen.ts"
15
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
16
+ *
17
+ * const config: CodegenConfig = {
18
+ * // ...
19
+ * generates: {
20
+ * 'path/to/file.ts': {
21
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
22
+ * config: {
23
+ * withCompositionFunctions: true
24
+ * },
25
+ * },
26
+ * },
27
+ * };
28
+ * export default config;
23
29
  * ```
24
30
  */
25
31
  withCompositionFunctions?: boolean;
@@ -28,15 +34,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
28
34
  * @default @vue/apollo-composable
29
35
  *
30
36
  * @exampleMarkdown
31
- * ```yaml
32
- * generates:
33
- * path/to/file.ts:
34
- * plugins:
35
- * - typescript
36
- * - typescript-operations
37
- * - typescript-vue-apollo
38
- * config:
39
- * vueApolloComposableImportFrom: vue
37
+ * ```ts filename="codegen.ts"
38
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
39
+ *
40
+ * const config: CodegenConfig = {
41
+ * // ...
42
+ * generates: {
43
+ * 'path/to/file.ts': {
44
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
45
+ * config: {
46
+ * vueApolloComposableImportFrom: 'vue'
47
+ * },
48
+ * },
49
+ * },
50
+ * };
51
+ * export default config;
40
52
  * ```
41
53
  */
42
54
  vueApolloComposableImportFrom?: 'vue' | '@vue/apollo-composable' | string;
@@ -45,15 +57,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
45
57
  * @default @vue/composition-api
46
58
  *
47
59
  * @exampleMarkdown
48
- * ```yaml
49
- * generates:
50
- * path/to/file.ts:
51
- * plugins:
52
- * - typescript
53
- * - typescript-operations
54
- * - typescript-vue-apollo
55
- * config:
56
- * vueCompositionApiImportFrom: vue
60
+ * ```ts filename="codegen.ts"
61
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
62
+ *
63
+ * const config: CodegenConfig = {
64
+ * // ...
65
+ * generates: {
66
+ * 'path/to/file.ts': {
67
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
68
+ * config: {
69
+ * vueCompositionApiImportFrom: 'vue'
70
+ * },
71
+ * },
72
+ * },
73
+ * };
74
+ * export default config;
57
75
  * ```
58
76
  */
59
77
  vueCompositionApiImportFrom?: 'vue' | '@vue/composition-api' | string;
@@ -63,15 +81,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
63
81
  * @default true
64
82
  *
65
83
  * @exampleMarkdown
66
- * ```yaml
67
- * generates:
68
- * path/to/file.ts:
69
- * plugins:
70
- * - typescript
71
- * - typescript-operations
72
- * - typescript-vue-apollo
73
- * config:
74
- * addDocBlocks: true
84
+ * ```ts filename="codegen.ts"
85
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
86
+ *
87
+ * const config: CodegenConfig = {
88
+ * // ...
89
+ * generates: {
90
+ * 'path/to/file.ts': {
91
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
92
+ * config: {
93
+ * addDocBlocks: true
94
+ * },
95
+ * },
96
+ * },
97
+ * };
98
+ * export default config;
75
99
  * ```
76
100
  */
77
101
  addDocBlocks?: boolean;
package/typings/config.d.ts CHANGED
@@ -11,15 +11,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
11
11
  * @default true
12
12
  *
13
13
  * @exampleMarkdown
14
- * ```yaml
15
- * generates:
16
- * path/to/file.ts:
17
- * plugins:
18
- * - typescript
19
- * - typescript-operations
20
- * - typescript-vue-apollo
21
- * config:
22
- * withCompositionFunctions: true
14
+ * ```ts filename="codegen.ts"
15
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
16
+ *
17
+ * const config: CodegenConfig = {
18
+ * // ...
19
+ * generates: {
20
+ * 'path/to/file.ts': {
21
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
22
+ * config: {
23
+ * withCompositionFunctions: true
24
+ * },
25
+ * },
26
+ * },
27
+ * };
28
+ * export default config;
23
29
  * ```
24
30
  */
25
31
  withCompositionFunctions?: boolean;
@@ -28,15 +34,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
28
34
  * @default @vue/apollo-composable
29
35
  *
30
36
  * @exampleMarkdown
31
- * ```yaml
32
- * generates:
33
- * path/to/file.ts:
34
- * plugins:
35
- * - typescript
36
- * - typescript-operations
37
- * - typescript-vue-apollo
38
- * config:
39
- * vueApolloComposableImportFrom: vue
37
+ * ```ts filename="codegen.ts"
38
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
39
+ *
40
+ * const config: CodegenConfig = {
41
+ * // ...
42
+ * generates: {
43
+ * 'path/to/file.ts': {
44
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
45
+ * config: {
46
+ * vueApolloComposableImportFrom: 'vue'
47
+ * },
48
+ * },
49
+ * },
50
+ * };
51
+ * export default config;
40
52
  * ```
41
53
  */
42
54
  vueApolloComposableImportFrom?: 'vue' | '@vue/apollo-composable' | string;
@@ -45,15 +57,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
45
57
  * @default @vue/composition-api
46
58
  *
47
59
  * @exampleMarkdown
48
- * ```yaml
49
- * generates:
50
- * path/to/file.ts:
51
- * plugins:
52
- * - typescript
53
- * - typescript-operations
54
- * - typescript-vue-apollo
55
- * config:
56
- * vueCompositionApiImportFrom: vue
60
+ * ```ts filename="codegen.ts"
61
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
62
+ *
63
+ * const config: CodegenConfig = {
64
+ * // ...
65
+ * generates: {
66
+ * 'path/to/file.ts': {
67
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
68
+ * config: {
69
+ * vueCompositionApiImportFrom: 'vue'
70
+ * },
71
+ * },
72
+ * },
73
+ * };
74
+ * export default config;
57
75
  * ```
58
76
  */
59
77
  vueCompositionApiImportFrom?: 'vue' | '@vue/composition-api' | string;
@@ -63,15 +81,21 @@ export interface VueApolloRawPluginConfig extends RawClientSideBasePluginConfig
63
81
  * @default true
64
82
  *
65
83
  * @exampleMarkdown
66
- * ```yaml
67
- * generates:
68
- * path/to/file.ts:
69
- * plugins:
70
- * - typescript
71
- * - typescript-operations
72
- * - typescript-vue-apollo
73
- * config:
74
- * addDocBlocks: true
84
+ * ```ts filename="codegen.ts"
85
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
86
+ *
87
+ * const config: CodegenConfig = {
88
+ * // ...
89
+ * generates: {
90
+ * 'path/to/file.ts': {
91
+ * plugins: ['typescript', 'typescript-operations', 'typescript-vue-apollo'],
92
+ * config: {
93
+ * addDocBlocks: true
94
+ * },
95
+ * },
96
+ * },
97
+ * };
98
+ * export default config;
75
99
  * ```
76
100
  */
77
101
  addDocBlocks?: boolean;