@graphql-codegen/typescript-apollo-angular 3.5.4 → 3.5.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 +165 -35
  3. package/typings/config.d.ts +165 -35
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@graphql-codegen/typescript-apollo-angular",
3
- "version": "3.5.4",
3
+ "version": "3.5.5-alpha-20221018123033-99bc320fe",
4
4
  "description": "GraphQL Code Generator plugin for generating ready-to-use Angular Components 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"
7
7
  },
8
8
  "dependencies": {
9
9
  "@graphql-codegen/plugin-helpers": "^2.6.2",
10
- "@graphql-codegen/visitor-plugin-common": "2.12.2",
10
+ "@graphql-codegen/visitor-plugin-common": "2.13.0-alpha-20221018123033-99bc320fe",
11
11
  "auto-bind": "~4.0.0",
12
12
  "change-case-all": "1.0.14",
13
13
  "tslib": "~2.4.0"
package/typings/config.d.cts CHANGED
@@ -14,9 +14,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
14
14
  * @default 2
15
15
  *
16
16
  * @exampleMarkdown
17
- * ```yaml
18
- * config:
19
- * apolloAngularVersion: 1
17
+ * ```ts filename="codegen.ts"
18
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
19
+ *
20
+ * const config: CodegenConfig = {
21
+ * // ...
22
+ * generates: {
23
+ * 'path/to/file': {
24
+ * plugins: ['apollo-angular'],
25
+ * config: {
26
+ * apolloAngularVersion: 1
27
+ * },
28
+ * },
29
+ * },
30
+ * };
31
+ * export default config;
20
32
  * ```
21
33
  */
22
34
  apolloAngularVersion?: number;
@@ -24,9 +36,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
24
36
  * @description Allows to define `ngModule` as part of the plugin's config so it's globally available.
25
37
  *
26
38
  * @exampleMarkdown
27
- * ```yaml
28
- * config:
29
- * ngModule: ./path/to/module#MyModule
39
+ * ```ts filename="codegen.ts"
40
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
41
+ *
42
+ * const config: CodegenConfig = {
43
+ * // ...
44
+ * generates: {
45
+ * 'path/to/file': {
46
+ * plugins: ['apollo-angular'],
47
+ * config: {
48
+ * ngModule: './path/to/module#MyModule'
49
+ * },
50
+ * },
51
+ * },
52
+ * };
53
+ * export default config;
30
54
  * ```
31
55
  */
32
56
  ngModule?: string;
@@ -34,9 +58,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
34
58
  * @description Defined the global value of `namedClient`.
35
59
  *
36
60
  * @exampleMarkdown
37
- * ```yaml
38
- * config:
39
- * namedClient: 'customName'
61
+ * ```ts filename="codegen.ts"
62
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
63
+ *
64
+ * const config: CodegenConfig = {
65
+ * // ...
66
+ * generates: {
67
+ * 'path/to/file': {
68
+ * plugins: ['apollo-angular'],
69
+ * config: {
70
+ * namedClient: 'customName'
71
+ * },
72
+ * },
73
+ * },
74
+ * };
75
+ * export default config;
40
76
  * ```
41
77
  */
42
78
  namedClient?: string;
@@ -44,9 +80,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
44
80
  * @description Defined the global value of `serviceName`.
45
81
  *
46
82
  * @exampleMarkdown
47
- * ```yaml
48
- * config:
49
- * serviceName: 'MySDK'
83
+ * ```ts filename="codegen.ts"
84
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
85
+ *
86
+ * const config: CodegenConfig = {
87
+ * // ...
88
+ * generates: {
89
+ * 'path/to/file': {
90
+ * plugins: ['apollo-angular'],
91
+ * config: {
92
+ * serviceName: 'MySDK'
93
+ * },
94
+ * },
95
+ * },
96
+ * };
97
+ * export default config;
50
98
  * ```
51
99
  */
52
100
  serviceName?: string;
@@ -54,9 +102,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
54
102
  * @description Defined the global value of `serviceProvidedInRoot`.
55
103
  *
56
104
  * @exampleMarkdown
57
- * ```yaml
58
- * config:
59
- * serviceProvidedInRoot: false
105
+ * ```ts filename="codegen.ts"
106
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
107
+ *
108
+ * const config: CodegenConfig = {
109
+ * // ...
110
+ * generates: {
111
+ * 'path/to/file': {
112
+ * plugins: ['apollo-angular'],
113
+ * config: {
114
+ * serviceProvidedInRoot: false
115
+ * },
116
+ * },
117
+ * },
118
+ * };
119
+ * export default config;
60
120
  * ```
61
121
  */
62
122
  serviceProvidedInRoot?: boolean;
@@ -64,9 +124,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
64
124
  * @description Define the Injector of the SDK class.
65
125
  *
66
126
  * @exampleMarkdown
67
- * ```yaml
68
- * config:
69
- * serviceProvidedIn: ./path/to/module#MyModule
127
+ * ```ts filename="codegen.ts"
128
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
129
+ *
130
+ * const config: CodegenConfig = {
131
+ * // ...
132
+ * generates: {
133
+ * 'path/to/file': {
134
+ * plugins: ['apollo-angular'],
135
+ * config: {
136
+ * serviceProvidedIn: './path/to/module#MyModule'
137
+ * },
138
+ * },
139
+ * },
140
+ * };
141
+ * export default config;
70
142
  * ```
71
143
  */
72
144
  serviceProvidedIn?: string;
@@ -80,9 +152,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
80
152
  * @default GQL
81
153
  *
82
154
  * @exampleMarkdown
83
- * ```yaml
84
- * config:
85
- * querySuffix: 'QueryService'
155
+ * ```ts filename="codegen.ts"
156
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
157
+ *
158
+ * const config: CodegenConfig = {
159
+ * // ...
160
+ * generates: {
161
+ * 'path/to/file': {
162
+ * plugins: ['apollo-angular'],
163
+ * config: {
164
+ * querySuffix: 'QueryService'
165
+ * },
166
+ * },
167
+ * },
168
+ * };
169
+ * export default config;
86
170
  * ```
87
171
  */
88
172
  querySuffix?: string;
@@ -91,9 +175,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
91
175
  * @default GQL
92
176
  *
93
177
  * @exampleMarkdown
94
- * ```yaml
95
- * config:
96
- * mutationSuffix: 'MutationService'
178
+ * ```ts filename="codegen.ts"
179
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
180
+ *
181
+ * const config: CodegenConfig = {
182
+ * // ...
183
+ * generates: {
184
+ * 'path/to/file': {
185
+ * plugins: ['apollo-angular'],
186
+ * config: {
187
+ * mutationSuffix: 'MutationService'
188
+ * },
189
+ * },
190
+ * },
191
+ * };
192
+ * export default config;
97
193
  * ```
98
194
  */
99
195
  mutationSuffix?: string;
@@ -102,9 +198,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
102
198
  * @default GQL
103
199
  *
104
200
  * @exampleMarkdown
105
- * ```yaml
106
- * config:
107
- * subscriptionSuffix: 'SubscriptionService'
201
+ * ```ts filename="codegen.ts"
202
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
203
+ *
204
+ * const config: CodegenConfig = {
205
+ * // ...
206
+ * generates: {
207
+ * 'path/to/file': {
208
+ * plugins: ['apollo-angular'],
209
+ * config: {
210
+ * subscriptionSuffix: 'SubscriptionService'
211
+ * },
212
+ * },
213
+ * },
214
+ * };
215
+ * export default config;
108
216
  * ```
109
217
  */
110
218
  subscriptionSuffix?: 'GQL' | string;
@@ -118,11 +226,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
118
226
  * @default []
119
227
  *
120
228
  * @exampleMarkdown
121
- * ```yaml
122
- * config:
123
- * additionalDI
124
- * - 'testService: TestService'
125
- * - 'testService1': TestService1'
229
+ * ```ts filename="codegen.ts"
230
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
231
+ *
232
+ * const config: CodegenConfig = {
233
+ * // ...
234
+ * generates: {
235
+ * 'path/to/file': {
236
+ * plugins: ['apollo-angular'],
237
+ * config: {
238
+ * additionalDI: ['testService: TestService', 'testService1': TestService1']
239
+ * },
240
+ * },
241
+ * },
242
+ * };
243
+ * export default config;
126
244
  * ```
127
245
  */
128
246
  additionalDI?: string[];
@@ -131,9 +249,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
131
249
  * @default false
132
250
  *
133
251
  * @exampleMarkdown
134
- * ```yaml
135
- * config:
136
- * addExplicitOverride: true
252
+ * ```ts filename="codegen.ts"
253
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
254
+ *
255
+ * const config: CodegenConfig = {
256
+ * // ...
257
+ * generates: {
258
+ * 'path/to/file': {
259
+ * plugins: ['apollo-angular'],
260
+ * config: {
261
+ * addExplicitOverride: true
262
+ * },
263
+ * },
264
+ * },
265
+ * };
266
+ * export default config;
137
267
  * ```
138
268
  */
139
269
  addExplicitOverride?: boolean;
package/typings/config.d.ts CHANGED
@@ -14,9 +14,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
14
14
  * @default 2
15
15
  *
16
16
  * @exampleMarkdown
17
- * ```yaml
18
- * config:
19
- * apolloAngularVersion: 1
17
+ * ```ts filename="codegen.ts"
18
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
19
+ *
20
+ * const config: CodegenConfig = {
21
+ * // ...
22
+ * generates: {
23
+ * 'path/to/file': {
24
+ * plugins: ['apollo-angular'],
25
+ * config: {
26
+ * apolloAngularVersion: 1
27
+ * },
28
+ * },
29
+ * },
30
+ * };
31
+ * export default config;
20
32
  * ```
21
33
  */
22
34
  apolloAngularVersion?: number;
@@ -24,9 +36,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
24
36
  * @description Allows to define `ngModule` as part of the plugin's config so it's globally available.
25
37
  *
26
38
  * @exampleMarkdown
27
- * ```yaml
28
- * config:
29
- * ngModule: ./path/to/module#MyModule
39
+ * ```ts filename="codegen.ts"
40
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
41
+ *
42
+ * const config: CodegenConfig = {
43
+ * // ...
44
+ * generates: {
45
+ * 'path/to/file': {
46
+ * plugins: ['apollo-angular'],
47
+ * config: {
48
+ * ngModule: './path/to/module#MyModule'
49
+ * },
50
+ * },
51
+ * },
52
+ * };
53
+ * export default config;
30
54
  * ```
31
55
  */
32
56
  ngModule?: string;
@@ -34,9 +58,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
34
58
  * @description Defined the global value of `namedClient`.
35
59
  *
36
60
  * @exampleMarkdown
37
- * ```yaml
38
- * config:
39
- * namedClient: 'customName'
61
+ * ```ts filename="codegen.ts"
62
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
63
+ *
64
+ * const config: CodegenConfig = {
65
+ * // ...
66
+ * generates: {
67
+ * 'path/to/file': {
68
+ * plugins: ['apollo-angular'],
69
+ * config: {
70
+ * namedClient: 'customName'
71
+ * },
72
+ * },
73
+ * },
74
+ * };
75
+ * export default config;
40
76
  * ```
41
77
  */
42
78
  namedClient?: string;
@@ -44,9 +80,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
44
80
  * @description Defined the global value of `serviceName`.
45
81
  *
46
82
  * @exampleMarkdown
47
- * ```yaml
48
- * config:
49
- * serviceName: 'MySDK'
83
+ * ```ts filename="codegen.ts"
84
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
85
+ *
86
+ * const config: CodegenConfig = {
87
+ * // ...
88
+ * generates: {
89
+ * 'path/to/file': {
90
+ * plugins: ['apollo-angular'],
91
+ * config: {
92
+ * serviceName: 'MySDK'
93
+ * },
94
+ * },
95
+ * },
96
+ * };
97
+ * export default config;
50
98
  * ```
51
99
  */
52
100
  serviceName?: string;
@@ -54,9 +102,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
54
102
  * @description Defined the global value of `serviceProvidedInRoot`.
55
103
  *
56
104
  * @exampleMarkdown
57
- * ```yaml
58
- * config:
59
- * serviceProvidedInRoot: false
105
+ * ```ts filename="codegen.ts"
106
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
107
+ *
108
+ * const config: CodegenConfig = {
109
+ * // ...
110
+ * generates: {
111
+ * 'path/to/file': {
112
+ * plugins: ['apollo-angular'],
113
+ * config: {
114
+ * serviceProvidedInRoot: false
115
+ * },
116
+ * },
117
+ * },
118
+ * };
119
+ * export default config;
60
120
  * ```
61
121
  */
62
122
  serviceProvidedInRoot?: boolean;
@@ -64,9 +124,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
64
124
  * @description Define the Injector of the SDK class.
65
125
  *
66
126
  * @exampleMarkdown
67
- * ```yaml
68
- * config:
69
- * serviceProvidedIn: ./path/to/module#MyModule
127
+ * ```ts filename="codegen.ts"
128
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
129
+ *
130
+ * const config: CodegenConfig = {
131
+ * // ...
132
+ * generates: {
133
+ * 'path/to/file': {
134
+ * plugins: ['apollo-angular'],
135
+ * config: {
136
+ * serviceProvidedIn: './path/to/module#MyModule'
137
+ * },
138
+ * },
139
+ * },
140
+ * };
141
+ * export default config;
70
142
  * ```
71
143
  */
72
144
  serviceProvidedIn?: string;
@@ -80,9 +152,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
80
152
  * @default GQL
81
153
  *
82
154
  * @exampleMarkdown
83
- * ```yaml
84
- * config:
85
- * querySuffix: 'QueryService'
155
+ * ```ts filename="codegen.ts"
156
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
157
+ *
158
+ * const config: CodegenConfig = {
159
+ * // ...
160
+ * generates: {
161
+ * 'path/to/file': {
162
+ * plugins: ['apollo-angular'],
163
+ * config: {
164
+ * querySuffix: 'QueryService'
165
+ * },
166
+ * },
167
+ * },
168
+ * };
169
+ * export default config;
86
170
  * ```
87
171
  */
88
172
  querySuffix?: string;
@@ -91,9 +175,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
91
175
  * @default GQL
92
176
  *
93
177
  * @exampleMarkdown
94
- * ```yaml
95
- * config:
96
- * mutationSuffix: 'MutationService'
178
+ * ```ts filename="codegen.ts"
179
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
180
+ *
181
+ * const config: CodegenConfig = {
182
+ * // ...
183
+ * generates: {
184
+ * 'path/to/file': {
185
+ * plugins: ['apollo-angular'],
186
+ * config: {
187
+ * mutationSuffix: 'MutationService'
188
+ * },
189
+ * },
190
+ * },
191
+ * };
192
+ * export default config;
97
193
  * ```
98
194
  */
99
195
  mutationSuffix?: string;
@@ -102,9 +198,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
102
198
  * @default GQL
103
199
  *
104
200
  * @exampleMarkdown
105
- * ```yaml
106
- * config:
107
- * subscriptionSuffix: 'SubscriptionService'
201
+ * ```ts filename="codegen.ts"
202
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
203
+ *
204
+ * const config: CodegenConfig = {
205
+ * // ...
206
+ * generates: {
207
+ * 'path/to/file': {
208
+ * plugins: ['apollo-angular'],
209
+ * config: {
210
+ * subscriptionSuffix: 'SubscriptionService'
211
+ * },
212
+ * },
213
+ * },
214
+ * };
215
+ * export default config;
108
216
  * ```
109
217
  */
110
218
  subscriptionSuffix?: 'GQL' | string;
@@ -118,11 +226,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
118
226
  * @default []
119
227
  *
120
228
  * @exampleMarkdown
121
- * ```yaml
122
- * config:
123
- * additionalDI
124
- * - 'testService: TestService'
125
- * - 'testService1': TestService1'
229
+ * ```ts filename="codegen.ts"
230
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
231
+ *
232
+ * const config: CodegenConfig = {
233
+ * // ...
234
+ * generates: {
235
+ * 'path/to/file': {
236
+ * plugins: ['apollo-angular'],
237
+ * config: {
238
+ * additionalDI: ['testService: TestService', 'testService1': TestService1']
239
+ * },
240
+ * },
241
+ * },
242
+ * };
243
+ * export default config;
126
244
  * ```
127
245
  */
128
246
  additionalDI?: string[];
@@ -131,9 +249,21 @@ export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginCon
131
249
  * @default false
132
250
  *
133
251
  * @exampleMarkdown
134
- * ```yaml
135
- * config:
136
- * addExplicitOverride: true
252
+ * ```ts filename="codegen.ts"
253
+ * import type { CodegenConfig } from '@graphql-codegen/cli';
254
+ *
255
+ * const config: CodegenConfig = {
256
+ * // ...
257
+ * generates: {
258
+ * 'path/to/file': {
259
+ * plugins: ['apollo-angular'],
260
+ * config: {
261
+ * addExplicitOverride: true
262
+ * },
263
+ * },
264
+ * },
265
+ * };
266
+ * export default config;
137
267
  * ```
138
268
  */
139
269
  addExplicitOverride?: boolean;