UNPKG

1.83 kBTypeScriptView Raw
1import { PluginFunction, Types } from '@graphql-codegen/plugin-helpers';
2import { RawConfig } from '@graphql-codegen/visitor-plugin-common';
3import { FileType } from './file-type';
4/**
5 * @description This plugin and presets creates generated mappers and parsers for a complete type-safe GraphQL requests, for developers that uses Apollo Android runtime.
6 */
7export interface JavaApolloAndroidPluginConfig extends RawConfig {
8 /**
9 * @description Customize the Java package name for the generated operations. The default package name will be generated according to the output file path.
10 *
11 * @exampleMarkdown
12 * ```yml
13 * generates:
14 * ./app/src/main/java/:
15 * preset: java-apollo-android
16 * config:
17 * package: "com.my.package.generated.graphql"
18 * plugins:
19 * - java-apollo-android
20 * ```
21 */
22 package?: string;
23 /**
24 * @description Customize the Java package name for the types generated based on input types.
25 *
26 * @exampleMarkdown
27 * ```yml
28 * generates:
29 * ./app/src/main/java/:
30 * preset: java-apollo-android
31 * config:
32 * typePackage: "com.my.package.generated.graphql"
33 * plugins:
34 * - java-apollo-android
35 * ```
36 */
37 typePackage?: string;
38 /**
39 * @description Customize the Java package name for the fragments generated classes.
40 *
41 * @exampleMarkdown
42 * ```yml
43 * generates:
44 * ./app/src/main/java/:
45 * preset: java-apollo-android
46 * config:
47 * fragmentPackage: "com.my.package.generated.graphql"
48 * plugins:
49 * - java-apollo-android
50 * ```
51 */
52 fragmentPackage?: string;
53 fileType: FileType;
54}
55export declare const plugin: PluginFunction<JavaApolloAndroidPluginConfig, Types.ComplexPluginOutput>;