@mediusinc/mng-commons 4.0.0-rc.1 → 4.0.0-rc.3

package/lib/models/layout-config.model.d.ts

@@ -0,0 +1,33 @@
+import { Type } from '@angular/core';
+import { MenuItem } from 'primeng/api';
+export type MngMenuMode = 'static' | 'overlay' | 'reveal' | 'drawer' | 'slim' | 'slim-plus';
+/**
+ * @deprecated use MngMenuConfigV2 instead
+ */
+export interface MngLayoutConfig {
+    menuMode: 'static' | 'sidebar' | 'slim' | 'overlay';
+    menuItems?: MenuItem[];
+    pinEnabled?: boolean;
+    sidebarSlim?: boolean;
+    disableNotificationWrapper?: boolean;
+    components?: {
+        topbar?: Type<any>;
+        menu?: Type<any>;
+        footer?: Type<any>;
+        breadcrumb?: Type<any>;
+        topbarUser?: Type<any>;
+    };
+}
+export interface MngLayoutConfigV2 {
+    menuMode: MngMenuMode;
+    menuItems?: MenuItem[];
+    ripple?: boolean;
+    disableNotificationWrapper?: boolean;
+    components?: {
+        topbar?: Type<any> | false;
+        menu?: Type<any> | false;
+        footer?: Type<any> | false;
+        breadcrumb?: Type<any> | false;
+        topbarUser?: Type<any> | false;
+    };
+}

package/lib/models/view-container.model.d.ts

@@ -1,29 +1,4 @@
-import { MessageService } from 'primeng/api';
-import { Observable } from 'rxjs';
 import { MediusQueryParam } from '../api/models';
-import { ActionInstance } from '../components/action/models';
-import { IDataProvider } from '../data-providers';
-import { ActionDescriptorInst } from '../descriptors/action';
-export interface IViewContainer<T = any, S = any> {
-    getMessageService(): MessageService | undefined;
-    getDataProvider(): IDataProvider<T, S> | undefined;
-    getActions(): Array<ActionDescriptorInst<T, S>>;
-}
-export interface IViewContainerTable<T = any, S = any> extends IViewContainer<T, S> {
-    getTableReload$(): Observable<ViewContainerTableReloadEvent>;
-    reloadTable(event: ViewContainerTableReloadEvent): void;
-}
-export interface IViewContainerEditor<T = any, S = any> extends IViewContainer<T, S> {
-    getEditorReset$(): Observable<ViewContainerEditorResetEvent<T>>;
-    resetEditor(event?: ViewContainerEditorResetEvent<T>): void;
-    getEditorClose$(): Observable<ViewContainerEditorCloseEvent<T>>;
-    closeEditor(event?: ViewContainerEditorCloseEvent<T>): void;
-}
-export interface IViewActionRouteTriggeredContainer<T = any, S = any> {
-    getActionRouteTriggeredInstance(): ActionInstance<T, S> | undefined;
-    setActionRouteTriggeredInstance(instance: ActionInstance<T, S>): void;
-    unsetActionRouteTriggeredInstance(): void;
-}
 export interface ViewContainerTableReloadEvent {
     emitEvent?: boolean;
     resetParams?: boolean;

package/lib/router/route-builder.d.ts

@@ -9,7 +9,7 @@ import { BreadcrumbType, MngRouterData } from './models';
 import { RoutesBuilder } from './routes-builder';
 import { TableviewRouteBuilderInternal } from './tableview-route-builder';
 export declare class RouteBuilder {
-    private readonly route;
+    protected readonly route: Route;
     private routePath;
     protected routeData: MngRouterData;
     private root?;

package/lib/services/{action-executor.service.d.ts → action/action-executor.service.d.ts}

@@ -1,31 +1,34 @@
-import { Injector, Type } from '@angular/core';
+import { Injector } from '@angular/core';
 import { Router } from '@angular/router';
 import { TranslateService } from '@ngx-translate/core';
+import { ConfirmationService, MessageService } from 'primeng/api';
 import { DialogService } from 'primeng/dynamicdialog';
-import { ActionContext, ActionContextValidation, ActionInstance, ActionParameters } from '../components/action/models';
-import { IDataProvider, IEditorDataProvider } from '../data-providers';
-import { ActionDescriptorInst, ActionEditorDescriptorInst } from '../descriptors/action';
-import { IActionEditorComponent, IMngError } from '../models';
-import { MngParametrizePipe } from '../pipes';
-import { MngActionErrorMapperService } from './action-error-mapper.service';
-import { MngCommonsService } from './commons.service';
-import { MngNavigationService } from './navigation.service';
-import * as i0 from "@angular/core";
-export declare class MngActionExecutorService {
-    private injector;
-    private router;
-    private dialogService;
-    private translate;
-    private mngCommons;
-    private navigationService;
-    private errorMapper;
-    private parametrize;
-    private defaultEditorDialogComponent;
-    private readonly instancesBufferMax;
-    private readonly _instances;
-    private logger;
-    constructor(injector: Injector, router: Router, dialogService: DialogService, translate: TranslateService, mngCommons: MngCommonsService, navigationService: MngNavigationService, errorMapper: MngActionErrorMapperService, parametrize: MngParametrizePipe, defaultEditorDialogComponent: Type<any>);
-    get instances(): ActionInstance<any, any>[];
+import { ActionContext, ActionContextValidation, ActionInstance, ActionInstanceStateEnum, ActionParameters } from '../../components/action/models';
+import { IDataProvider } from '../../data-providers';
+import { ActionDescriptorInst, ActionEditorDescriptorInst } from '../../descriptors/action';
+import { IActionEditorComponent, IMngError } from '../../models';
+import { MngParametrizePipe } from '../../pipes';
+import { MngActionErrorMapperService } from '../action-error-mapper.service';
+import { MngCommonsService } from '../commons.service';
+import { MngLoggerService } from '../logger.service';
+import { MngNavigationService } from '../navigation.service';
+import { ViewContainer } from '../view';
+export declare abstract class MngActionExecutorService {
+    protected readonly injector: Injector;
+    protected readonly router: Router;
+    protected readonly dialogService: DialogService;
+    protected readonly translate: TranslateService;
+    protected readonly mngCommons: MngCommonsService;
+    protected readonly navigationService: MngNavigationService;
+    protected readonly errorMapper: MngActionErrorMapperService;
+    protected readonly parametrize: MngParametrizePipe;
+    protected readonly defaultEditorDialogComponent: import("@angular/core").Type<any>;
+    protected readonly messageService: MessageService;
+    protected readonly confirmationService: ConfirmationService;
+    protected readonly viewContainer: ViewContainer<any, any> | null;
+    protected readonly instancesBufferMax = 100;
+    protected logger: MngLoggerService;
+    abstract get instances(): ActionInstance<any, any>[];
     /**
      * Prepares action context for usage in validation.
      * @param action Action descriptor.
@@ -60,7 +63,7 @@ export declare class MngActionExecutorService {
      *
      * @return Action context for fetch function.
      */
-    prepareContextForEditorFetch<T, S>(action: ActionEditorDescriptorInst<T>, parameters: ActionParameters<T>, dataProvider?: IEditorDataProvider<T, S>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<unknown, unknown>): ActionContext<T, S>;
+    prepareContextForEditorFetch<T, S>(action: ActionEditorDescriptorInst<T>, parameters: ActionParameters<T>, dataProvider?: IDataProvider<T, S>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<unknown, unknown>): ActionContext<T, S>;
     /**
      * Runs editor action's submit (=main run) function by creating new action context for action instance.
      *
@@ -72,7 +75,7 @@ export declare class MngActionExecutorService {
      *
      * @return Action context for submit (=run) function.
      */
-    prepareContextForEditorSubmit<T, S>(action: ActionEditorDescriptorInst<T>, parameters: ActionParameters<T>, dataProvider?: IEditorDataProvider<T, S>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<unknown, unknown>): ActionContext<T, S>;
+    prepareContextForEditorSubmit<T, S>(action: ActionEditorDescriptorInst<T>, parameters: ActionParameters<T>, dataProvider?: IDataProvider<T, S>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<unknown, unknown>): ActionContext<T, S>;
     /**
      * Prepares action exec context for action of type editor.
      *
@@ -106,7 +109,7 @@ export declare class MngActionExecutorService {
      *
      * @return Action instance - if non provided in parameters, the newly created will be returned.
      */
-    activateAction<T, S>(action: ActionDescriptorInst<T>, parameters: ActionParameters<T>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<unknown, unknown>, runContext?: boolean): ActionInstance<T, S>;
+    activateAction<T, S>(action: ActionDescriptorInst<T>, parameters: ActionParameters<T>, instance?: ActionInstance<T, S>, previousActionInstance?: ActionInstance<any, any>, runContext?: boolean): ActionInstance<T, S>;
     /**
      * To be called when action editor is initialized to correctly activate action.
      * @param action Action descriptor.
@@ -168,7 +171,5 @@ export declare class MngActionExecutorService {
      * @param skipInitializationFromViewContainer If initialization of instance from view container should be skipped.
      * @private
      */
-    private getOrCreateInstance;
-    static ɵfac: i0.ɵɵFactoryDeclaration<MngActionExecutorService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<MngActionExecutorService>;
+    protected getOrCreateInstance<T, S>(instance: ActionInstance<T, S> | undefined, action?: ActionDescriptorInst<T>, parameters?: ActionParameters<T>, instanceInitialStatus?: ActionInstanceStateEnum, skipInitializationFromViewContainer?: boolean): ActionInstance<T, S>;
 }

package/lib/services/action/component-action-executor.service.d.ts

@@ -0,0 +1,9 @@
+import { ActionInstance } from '../../components/action/models';
+import { MngActionExecutorService } from './action-executor.service';
+import * as i0 from "@angular/core";
+export declare class MngComponentActionExecutorService extends MngActionExecutorService {
+    private readonly rootActionExecutorService;
+    get instances(): ActionInstance<any, any>[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<MngComponentActionExecutorService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MngComponentActionExecutorService>;
+}

package/lib/services/action/index.d.ts

@@ -0,0 +1,4 @@
+export * from './component-action-executor.service';
+export * from './root-action-executor.service';
+export * from './provide-action-executor';
+export * from './action-executor.service';

package/lib/services/action/provide-action-executor.d.ts

@@ -0,0 +1,2 @@
+import { Provider } from '@angular/core';
+export declare function provideActionExecutor(): Provider;

package/lib/services/action/root-action-executor.service.d.ts

@@ -0,0 +1,9 @@
+import { ActionInstance } from '../../components/action/models';
+import { MngActionExecutorService } from './action-executor.service';
+import * as i0 from "@angular/core";
+export declare class MngRootActionExecutorService extends MngActionExecutorService {
+    private readonly _instances;
+    get instances(): ActionInstance<any, any>[];
+    static ɵfac: i0.ɵɵFactoryDeclaration<MngRootActionExecutorService, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<MngRootActionExecutorService>;
+}

package/lib/services/index.d.ts

@@ -1,11 +1,9 @@
-export * from './action-executor.service';
 export * from './action-error-mapper.service';
 export * from './configuration.service';
 export * from './commons.service';
 export * from './navigation.service';
 export * from './router.service';
 export * from './version.service';
-export * from './view-container.component.service';
 export * from './mng-localstorage-config.service';
 export * from './log-publisher-console.service';
 export * from './logger.service';

package/lib/services/view/index.d.ts

@@ -0,0 +1,2 @@
+export * from './view-container.service';
+export * from './provide-view-container';

package/lib/services/view/provide-view-container.d.ts

@@ -0,0 +1,2 @@
+import { Provider } from '@angular/core';
+export declare function provideViewContainer(provideParentIfPresent?: boolean): Provider;

package/lib/services/view/view-container.service.d.ts

@@ -0,0 +1,32 @@
+import { Observable } from 'rxjs';
+import { ActionInstance } from '../../components/action/models';
+import { IDataProvider } from '../../data-providers';
+import { ActionDescriptorInst } from '../../descriptors/action';
+import { ViewContainerEditorCloseEvent, ViewContainerEditorResetEvent, ViewContainerTableReloadEvent } from '../../models';
+import * as i0 from "@angular/core";
+/**
+ * Should be used with providers defined within component.
+ */
+export declare class ViewContainer<T, S> {
+    private _dataProvider?;
+    private _routeTriggeredActionInstance?;
+    private actions;
+    private _tableReloadSubject;
+    private _editorResetSubject;
+    private _editorCloseSubject;
+    set dataProvider(dataProvider: IDataProvider<T, S>);
+    getDataProvider(): IDataProvider<T, S> | undefined;
+    getActions(): Array<ActionDescriptorInst<T>>;
+    setActions(actions: Array<ActionDescriptorInst<T>>): void;
+    getTableReload$(): Observable<ViewContainerTableReloadEvent>;
+    reloadTable(event?: ViewContainerTableReloadEvent): void;
+    getEditorReset$(): Observable<ViewContainerEditorResetEvent<T>>;
+    resetEditor(event?: ViewContainerEditorResetEvent<T> | undefined): void;
+    getEditorClose$(): Observable<ViewContainerEditorCloseEvent<T>>;
+    closeEditor(event?: ViewContainerEditorCloseEvent<T>): void;
+    getRouteTriggeredActionInstance(): ActionInstance<T, S> | undefined;
+    setRouteTriggeredActionInstance(instance: ActionInstance<T, S>): void;
+    unsetRouteTriggeredActionInstance(): void;
+    static ɵfac: i0.ɵɵFactoryDeclaration<ViewContainer<any, any>, never>;
+    static ɵprov: i0.ɵɵInjectableDeclaration<ViewContainer<any, any>>;
+}

package/lib/utils/date.util.d.ts

@@ -1,8 +1,18 @@
+export type toIsoStringTypeOptType = 'date' | 'date-time' | 'dateTime';
+export type toIsoStringDateTimeOptsType = {
+    utc?: boolean;
+    noTimezone?: boolean;
+    noMillis?: boolean;
+};
 export declare class DateUtil {
     private static readonly NG_PRIME_FORMAT_SUPPORTED;
     private static readonly NG_PRIME_FORMAT_OTHER;
     private static readonly NG_PRIME_FORMAT_MAP;
-    private static pad;
-    static toIsoString(date: unknown, inUtc?: boolean, withTimezone?: boolean, withMillis?: boolean, dateOnly?: boolean): string | null;
+    private static padNumber;
+    static toIsoString(value: string | number | Date, type?: 'date'): string;
+    static toIsoString(value: string | number | Date, type: 'date-time' | 'dateTime', dateTimeOpts?: toIsoStringDateTimeOptsType): string;
+    static toIsoString(value: undefined | null | unknown, type?: 'date'): null;
+    static toIsoString(value: undefined | null | unknown, type: 'date-time' | 'dateTime', dateTimeOpts?: toIsoStringDateTimeOptsType): null;
+    static toIsoString(value: unknown, type?: toIsoStringTypeOptType, dateTimeOpts?: toIsoStringDateTimeOptsType): string | null;
     static fromPrimeToAngularDateFormat(ngDateFormat: string): string;
 }

package/lib/utils/notification.util.d.ts

@@ -1,13 +1,13 @@
 import { TranslateService } from '@ngx-translate/core';
-import { Message } from 'primeng/api';
+import { Message, MessageService } from 'primeng/api';
 import { ActionDescriptor } from '../descriptors/action';
 import { TableDescriptorInst } from '../descriptors/table';
-import { IMngError, IViewContainer } from '../models';
+import { IMngError } from '../models';
 export declare class NotificationUtil {
-    static notification(viewContainer?: IViewContainer<any, any>, title?: string, message?: string, severity?: 'success' | 'warn' | 'error', icon?: string): Message;
-    static tableNotificationError(translate: TranslateService, table: TableDescriptorInst<any>, error: any, viewContainer?: IViewContainer<any, any>): Message;
-    static actionNotificationSuccess(translate: TranslateService, action: ActionDescriptor, functionName: string, customTitleKey?: string, customMessageKey?: string, viewContainer?: IViewContainer<any, any>, item?: any): Message;
-    static actionNotificationError(translate: TranslateService, action: ActionDescriptor, error: IMngError, functionName: string, viewContainer?: IViewContainer<any, any>, item?: any, severity?: 'warn' | 'error'): Message;
+    static notification(messageService: MessageService, title?: string, message?: string, severity?: 'success' | 'warn' | 'error', icon?: string): Message;
+    static tableNotificationError(translate: TranslateService, table: TableDescriptorInst<any>, error: any, messageService: MessageService): Message;
+    static actionNotificationSuccess(translate: TranslateService, action: ActionDescriptor, functionName: string, messageService: MessageService, customTitleKey?: string, customMessageKey?: string, item?: any): Message;
+    static actionNotificationError(translate: TranslateService, action: ActionDescriptor, error: IMngError, functionName: string, messageService: MessageService, item?: any, severity?: 'warn' | 'error'): Message;
     static getFormEditorInfoMessage(translate: TranslateService, title: string, message: string, params?: any): Message;
     static getFormEditorWarningMessage(translate: TranslateService, title: string, message: string): Message;
 }

package/openapi/angular/README.mustache

@@ -0,0 +1,226 @@
+## {{npmName}}@{{npmVersion}}
+
+### Building
+
+To install the required dependencies and to build the typescript sources run:
+```
+npm install
+npm run build
+```
+
+### publishing
+
+First build the package then run ```npm publish dist``` (don't forget to specify the `dist` folder!)
+
+### consuming
+
+Navigate to the folder of your consuming project and run one of next commands.
+
+_published:_
+
+```
+npm install {{npmName}}@{{npmVersion}} --save
+```
+
+_without publishing (not recommended):_
+
+```
+npm install PATH_TO_GENERATED_PACKAGE/dist.tgz --save
+```
+
+_It's important to take the tgz file, otherwise you'll get trouble with links on windows_
+
+_using `npm link`:_
+
+In PATH_TO_GENERATED_PACKAGE/dist:
+```
+npm link
+```
+
+In your project:
+```
+npm link {{npmName}}
+```
+
+__Note for Windows users:__ The Angular CLI has troubles to use linked npm packages.
+Please refer to this issue https://github.com/angular/angular-cli/issues/8284 for a solution / workaround.
+Published packages are not effected by this issue.
+
+
+#### General usage
+
+In your Angular project:
+
+
+```
+// without configuring providers
+import { {{apiModuleClassName}} } from '{{npmName}}';
+import { HttpClientModule } from '@angular/common/http';
+
+@NgModule({
+    imports: [
+        {{apiModuleClassName}},
+        // make sure to import the HttpClientModule in the AppModule only,
+        // see https://github.com/angular/angular/issues/20575
+        HttpClientModule
+    ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+// configuring providers
+import { {{apiModuleClassName}}, {{configurationClassName}}, {{configurationParametersInterfaceName}} } from '{{npmName}}';
+
+export function apiConfigFactory (): {{configurationClassName}} {
+  const params: {{configurationParametersInterfaceName}} = {
+    // set configuration parameters here.
+  }
+  return new {{configurationClassName}}(params);
+}
+
+@NgModule({
+    imports: [ {{apiModuleClassName}}.forRoot(apiConfigFactory) ],
+    declarations: [ AppComponent ],
+    providers: [],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+// configuring providers with an authentication service that manages your access tokens
+import { {{apiModuleClassName}}, {{configurationClassName}} } from '{{npmName}}';
+
+@NgModule({
+    imports: [ {{apiModuleClassName}} ],
+    declarations: [ AppComponent ],
+    providers: [
+      {
+        provide: {{configurationClassName}},
+        useFactory: (authService: AuthService) => new {{configurationClassName}}(
+          {
+            basePath: environment.apiUrl,
+            accessToken: authService.getAccessToken.bind(authService)
+          }
+        ),
+        deps: [AuthService],
+        multi: false
+      }
+    ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+```
+import { DefaultApi } from '{{npmName}}';
+
+export class AppComponent {
+    constructor(private apiGateway: DefaultApi) { }
+}
+```
+
+Note: The {{apiModuleClassName}} is restricted to being instantiated once app wide.
+This is to ensure that all services are treated as singletons.
+
+#### Using multiple OpenAPI files / APIs / {{apiModuleClassName}}s
+In order to use multiple `{{apiModuleClassName}}s` generated from different OpenAPI files,
+you can create an alias name when importing the modules
+in order to avoid naming conflicts:
+```
+import { {{apiModuleClassName}} } from 'my-api-path';
+import { {{apiModuleClassName}} as OtherApiModule } from 'my-other-api-path';
+import { HttpClientModule } from '@angular/common/http';
+
+@NgModule({
+  imports: [
+    {{apiModuleClassName}},
+    OtherApiModule,
+    // make sure to import the HttpClientModule in the AppModule only,
+    // see https://github.com/angular/angular/issues/20575
+    HttpClientModule
+  ]
+})
+export class AppModule {
+
+}
+```
+
+
+### Set service base path
+If different than the generated base path, during app bootstrap, you can provide the base path to your service.
+
+```
+import { BASE_PATH } from '{{npmName}}';
+
+bootstrap(AppComponent, [
+    { provide: BASE_PATH, useValue: 'https://your-web-service.com' },
+]);
+```
+or
+
+```
+import { BASE_PATH } from '{{npmName}}';
+
+@NgModule({
+    imports: [],
+    declarations: [ AppComponent ],
+    providers: [ provide: BASE_PATH, useValue: 'https://your-web-service.com' ],
+    bootstrap: [ AppComponent ]
+})
+export class AppModule {}
+```
+
+
+#### Using @angular/cli
+First extend your `src/environments/*.ts` files by adding the corresponding base path:
+
+```
+export const environment = {
+  production: false,
+  API_BASE_PATH: 'http://127.0.0.1:8080'
+};
+```
+
+In the src/app/app.module.ts:
+```
+import { BASE_PATH } from '{{npmName}}';
+import { environment } from '../environments/environment';
+
+@NgModule({
+  declarations: [
+    AppComponent
+  ],
+  imports: [ ],
+  providers: [{ provide: BASE_PATH, useValue: environment.API_BASE_PATH }],
+  bootstrap: [ AppComponent ]
+})
+export class AppModule { }
+```
+
+### Customizing path parameter encoding
+
+Without further customization, only [path-parameters][parameter-locations-url] of [style][style-values-url] 'simple'
+and Dates for format 'date-time' are encoded correctly.
+
+Other styles (e.g. "matrix") are not that easy to encode
+and thus are best delegated to other libraries (e.g.: [@honoluluhenk/http-param-expander]).
+
+To implement your own parameter encoding (or call another library),
+pass an arrow-function or method-reference to the `encodeParam` property of the Configuration-object
+(see [General Usage](#general-usage) above).
+
+Example value for use in your Configuration-Provider:
+```typescript
+new Configuration({
+    encodeParam: (param: Param) => myFancyParamEncoder(param),
+})
+```
+
+[parameter-locations-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#parameter-locations
+[style-values-url]: https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md#style-values
+[@honoluluhenk/http-param-expander]: https://www.npmjs.com/package/@honoluluhenk/http-param-expander

package/openapi/angular/api.module.mustache

@@ -0,0 +1,39 @@
+import { NgModule, ModuleWithProviders, SkipSelf, Optional } from '@angular/core';
+import { {{configurationClassName}} } from './configuration';
+import { HttpClient } from '@angular/common/http';
+
+{{#isProvidedInNone}}
+{{#apiInfo}}
+{{#apis}}
+import { {{classname}} } from './{{importPath}}';
+{{/apis}}
+{{/apiInfo}}
+{{/isProvidedInNone}}
+
+@NgModule({
+  imports:      [],
+  declarations: [],
+  exports:      [],
+  providers: [{{#isProvidedInNone}}
+    {{#apiInfo}}{{#apis}}{{classname}}{{^-last}},
+    {{/-last}}{{/apis}}{{/apiInfo}} {{/isProvidedInNone}}]
+})
+export class {{apiModuleClassName}} {
+    public static forRoot(configurationFactory: () => {{configurationClassName}}): ModuleWithProviders{{#enforceGenericModuleWithProviders}}<{{apiModuleClassName}}>{{/enforceGenericModuleWithProviders}} {
+        return {
+            ngModule: {{apiModuleClassName}},
+            providers: [ { provide: {{configurationClassName}}, useFactory: configurationFactory } ]
+        };
+    }
+
+    constructor( @Optional() @SkipSelf() parentModule: {{apiModuleClassName}},
+                 @Optional() http: HttpClient) {
+        if (parentModule) {
+            throw new Error('{{apiModuleClassName}} is already loaded. Import in your base AppModule only.');
+        }
+        if (!http) {
+            throw new Error('You need to import the HttpClientModule in your AppModule! \n' +
+            'See also https://github.com/angular/angular/issues/20575');
+        }
+    }
+}