@graphql-codegen/typescript-apollo-angular 3.5.3-alpha-0814e49cc.0 → 3.5.3

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@graphql-codegen/typescript-apollo-angular",
-  "version": "3.5.3-alpha-0814e49cc.0",
+  "version": "3.5.3",
   "description": "GraphQL Code Generator plugin for generating ready-to-use Angular Components 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"
   },
   "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"
@@ -28,7 +28,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,140 @@
+import { RawClientSideBasePluginConfig } from '@graphql-codegen/visitor-plugin-common';
+/**
+ * @description This plugin generates Apollo services (`Query`, `Mutation` and `Subscription`) with TypeScript typings.
+ *
+ * It will generate a strongly typed Angular service for every defined query, mutation or subscription. The generated Angular services are ready to inject and use within your Angular component.
+ *
+ * It extends the basic TypeScript plugins: `@graphql-codegen/typescript`, `@graphql-codegen/typescript-operations` - and thus shares a similar configuration.
+ *
+ * To shed some more light regards this template, it's recommended to go through this article: https://apollo-angular.com/docs/get-started, and to read the Code Generation with Apollo Angular: https://the-guild.dev/blog/apollo-angular-12
+ */
+export interface ApolloAngularRawPluginConfig extends RawClientSideBasePluginConfig {
+    /**
+     * @description Version of `apollo-angular` package
+     * @default 2
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   apolloAngularVersion: 1
+     * ```
+     */
+    apolloAngularVersion?: number;
+    /**
+     * @description Allows to define `ngModule` as part of the plugin's config so it's globally available.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   ngModule: ./path/to/module#MyModule
+     * ```
+     */
+    ngModule?: string;
+    /**
+     * @description Defined the global value of `namedClient`.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   namedClient: 'customName'
+     * ```
+     */
+    namedClient?: string;
+    /**
+     * @description Defined the global value of `serviceName`.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   serviceName: 'MySDK'
+     * ```
+     */
+    serviceName?: string;
+    /**
+     * @description Defined the global value of `serviceProvidedInRoot`.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   serviceProvidedInRoot: false
+     * ```
+     */
+    serviceProvidedInRoot?: boolean;
+    /**
+     * @description Define the Injector of the SDK class.
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   serviceProvidedIn: ./path/to/module#MyModule
+     * ```
+     */
+    serviceProvidedIn?: string;
+    /**
+     * @description Set to `true` in order to generate a SDK service class that uses all generated services.
+     * @default false
+     */
+    sdkClass?: boolean;
+    /**
+     * @description Allows to define a custom suffix for query operations.
+     * @default GQL
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   querySuffix: 'QueryService'
+     * ```
+     */
+    querySuffix?: string;
+    /**
+     * @description Allows to define a custom suffix for mutation operations.
+     * @default GQL
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   mutationSuffix: 'MutationService'
+     * ```
+     */
+    mutationSuffix?: string;
+    /**
+     * @description Allows to define a custom suffix for Subscription operations.
+     * @default GQL
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   subscriptionSuffix: 'SubscriptionService'
+     * ```
+     */
+    subscriptionSuffix?: 'GQL' | string;
+    /**
+     * @description Allows to define a custom Apollo-Angular package to import types from.
+     * @default 'apollo-angular'
+     */
+    apolloAngularPackage?: 'apollo-angular' | string;
+    /**
+     * @description Add additional dependency injections for generated services
+     * @default []
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   additionalDI
+     *      - 'testService: TestService'
+     *      - 'testService1': TestService1'
+     * ```
+     */
+    additionalDI?: string[];
+    /**
+     * @description Add `override` modifier to make the generated code compatible with the `noImplicitOverride` option of Typescript v4.3+.
+     * @default false
+     *
+     * @exampleMarkdown
+     * ```yaml
+     * config:
+     *   addExplicitOverride: true
+     * ```
+     */
+    addExplicitOverride?: boolean;
+}

package/typings/index.d.cts

@@ -0,0 +1,7 @@
+import { PluginValidateFn, PluginFunction } from '@graphql-codegen/plugin-helpers';
+import { ApolloAngularVisitor } from './visitor.cjs';
+import { ApolloAngularRawPluginConfig } from './config.cjs';
+export declare const plugin: PluginFunction<ApolloAngularRawPluginConfig>;
+export declare const addToSchema: import("graphql").DocumentNode;
+export declare const validate: PluginValidateFn<any>;
+export { ApolloAngularVisitor };

package/typings/visitor.d.cts

@@ -0,0 +1,42 @@
+import { ClientSideBaseVisitor, ClientSideBasePluginConfig, LoadedFragment } from '@graphql-codegen/visitor-plugin-common';
+import { OperationDefinitionNode, GraphQLSchema } from 'graphql';
+import { ApolloAngularRawPluginConfig } from './config.cjs';
+import { Types } from '@graphql-codegen/plugin-helpers';
+export interface ApolloAngularPluginConfig extends ClientSideBasePluginConfig {
+    apolloAngularVersion: number;
+    ngModule?: string;
+    namedClient?: string;
+    serviceName?: string;
+    serviceProvidedInRoot?: boolean;
+    serviceProvidedIn?: string;
+    sdkClass?: boolean;
+    querySuffix?: string;
+    mutationSuffix?: string;
+    subscriptionSuffix?: string;
+    apolloAngularPackage: string;
+    additionalDI?: string[];
+    addExplicitOverride: boolean;
+}
+export declare class ApolloAngularVisitor extends ClientSideBaseVisitor<ApolloAngularRawPluginConfig, ApolloAngularPluginConfig> {
+    private _allOperations;
+    private _externalImportPrefix;
+    private _operationsToInclude;
+    private dependencyInjections;
+    private dependencyInjectionArgs;
+    constructor(schema: GraphQLSchema, fragments: LoadedFragment[], _allOperations: OperationDefinitionNode[], rawConfig: ApolloAngularRawPluginConfig, documents?: Types.DocumentFile[]);
+    getImports(): string[];
+    private _extractNgModule;
+    private _parseNgModule;
+    private _operationHasDirective;
+    private _removeDirective;
+    private _removeDirectives;
+    private _extractDirective;
+    protected _prepareDocument(documentStr: string): string;
+    private _namedClient;
+    private _extractNamedClient;
+    private _providedIn;
+    private _getDocumentNodeVariable;
+    private _operationSuffix;
+    protected buildOperation(node: OperationDefinitionNode, documentVariableName: string, operationType: string, operationResultType: string, operationVariablesTypes: string): string;
+    get sdkClass(): string;
+}