@mediusinc/mng-commons 5.0.0-rc.0-c31d5206 → 5.0.0-rc.1

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

@@ -1,85 +0,0 @@
-import { TranslateService } from '@ngx-translate/core';
-import { Observable } from 'rxjs';
-import { ActionDescriptorInst, ActionEditorDescriptorInst } from '../descriptors/action';
-import { ModelDescriptor } from '../descriptors/model';
-import { IMngError } from '../models';
-import { ClassType, I18nType, KeyOfType } from '../types';
-export declare namespace I18nUtils {
-    class Common {
-        static getAsync(translate: TranslateService, params?: any, ...keys: Array<string>): Observable<string | null>;
-        static get(translate: TranslateService, params?: any, ...keys: Array<string>): string | null;
-        static populateParams(item?: any, params?: any): any;
-        static selectI18n(keys: string[], i18n: any): string | null;
-    }
-    class Type {
-        static getClassNameAsync(translate: TranslateService, classType: ClassType<any>, singular?: boolean): Observable<string | null>;
-        static getClassName(translate: TranslateService, classType: ClassType<any>, singular?: boolean): string | null;
-        static getNameAsync(translate: TranslateService, typeName: string, singular?: boolean): Observable<string | null>;
-        static getName(translate: TranslateService, typeName: string, singular?: boolean): string | null;
-        static getClassTabKey(classType: ClassType<any>, tab: string): string;
-        static getTabKey(typeName: string, tab: string): string;
-        static getClassGroupKey(classType: ClassType<any>, group: string): string;
-        static getGroupKey(typeName: string, group: string): string;
-        static getClassPropertyKey(classType: ClassType<any>, property: string): string;
-        static getPropertyKey(typeName: string, property: string): string;
-        static getClassPath(classType: ClassType<any>, ...path: Array<string>): string;
-        static getPath(typeName: string, ...path: Array<string>): string;
-        static getClassParams(translate: TranslateService, classType: ClassType<any>, item: any, params?: any): any;
-        static getParams(translate: TranslateService, typeName?: string, item?: any, params?: any): any;
-        static getClassParamsAsync(translate: TranslateService, classType: ClassType<any>, item?: any, params?: any): Observable<any>;
-        static getParamsAsync(translate: TranslateService, typeName?: string, item?: any, params?: any): Observable<any>;
-        static populateParams(i18nTypeName?: string, item?: any, params?: any): any;
-        private static getNameKeys;
-    }
-    class Model {
-        static get(translate: TranslateService, model: ModelDescriptor<any>, keyPath: string, customKey?: string, item?: any, fallbackKey?: string, params?: any): string | null;
-        static getName(translate: TranslateService, model: ModelDescriptor<any>, singular?: boolean): string | null;
-        static getNameAsync(translate: TranslateService, model: ModelDescriptor<any>, singular?: boolean): Observable<string | null>;
-        static getParams(translate: TranslateService, model?: ModelDescriptor<any>, item?: any, params?: any): any;
-        static getParamsAsync(translate: TranslateService, model?: ModelDescriptor<any>, item?: any, params?: any): Observable<any>;
-        static populateParams(idProperty?: KeyOfType, titleProperty?: KeyOfType, item?: any, params?: any): any;
-        private static getKeysByPriority;
-    }
-    class Action {
-        /**
-         * Returns translation for action with given keys and params
-         * @param translate TranslateService
-         * @param action action descriptor
-         * @param actionPathKeys action path keys
-         * @param customKey custom key
-         * @param item
-         * @param fallbackKey fallback key
-         * @param params additional params for translation
-         * @param missingTranslationStrategy strategy when no translation is found
-         */
-        static get(translate: TranslateService, action: ActionDescriptorInst<any>, actionPathKeys: string | Array<string>, customKey?: string, item?: any, fallbackKey?: string, params?: any, missingTranslationStrategy?: I18nType): string | null;
-        /**
-         * Returns async translation for given keys with given params.
-         * @param translate TranslateService
-         * @param action action descriptor
-         * @param actionPathKeys action path keys
-         * @param customKey custom key
-         * @param item item
-         * @param fallbackKey fallback key, used as fallback key
-         * @param params additional params for translation
-         * @param missingTranslationStrategy strategy when no translation is found
-         */
-        static getAsync(translate: TranslateService, action: ActionDescriptorInst<any>, actionPathKeys: string | Array<string>, customKey?: string, item?: any, fallbackKey?: string, params?: any, missingTranslationStrategy?: I18nType): Observable<string | null>;
-        /**
-         * Returns translation depending on missingTranslationStrategy
-         * @param missingTranslationStrategy strategy when no translation is found
-         * @param values object with values, i18nValue is translation, firstKey is first key in array of keys, fallbackKey is fallback key
-         */
-        private static getTranslationDependingOnStrategy;
-        static getTitleAsync(translate: TranslateService, action: ActionDescriptorInst<any>, item?: any): Observable<string | null>;
-        static getEditorTitleAsync(translate: TranslateService, action: ActionEditorDescriptorInst<any>, item?: any): Observable<string | null>;
-        static getParams(translate: TranslateService, action: ActionDescriptorInst<any>, item?: any, params?: any): any;
-        static getParamsAsync(translate: TranslateService, action: ActionDescriptorInst<any>, item?: any, params?: any): Observable<any>;
-        static populateParams(params?: any): any;
-        private static getKeysByPriority;
-    }
-    class Error {
-        static get(translate: TranslateService, error: IMngError, params?: any): string | null;
-        static getParams(error: IMngError, params?: any): any;
-    }
-}

package/lib/utils/index.d.ts

@@ -1,13 +0,0 @@
-export * from './data-list-params.util';
-export * from './date.util';
-export * from './editor-formly.util';
-export * from './enum.util';
-export * from './i18n.util';
-export * from './model.util';
-export * from './notification.util';
-export * from './object.util';
-export * from './string.util';
-export * from './decorator-metadata.util';
-export * from './export.util';
-export * from './file.util';
-export * from './error.util';

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

@@ -1,10 +0,0 @@
-import { ILookupDescriptor } from '../descriptors/interfaces';
-import { ClassAttributeDef } from '../models';
-import { ClassType } from '../types';
-export declare class ModelUtil {
-    static findIdAttribute<T>(classType?: ClassType<T>): string | null;
-    static findTitleAttribute<T>(classType?: ClassType<T>): string | null;
-    static getAttributeDef<T>(classType?: ClassType<T>): ClassAttributeDef[] | null;
-    private static findAttributeByTypeAndName;
-    static trySetLookupItemsProperties<T>(lookup: ILookupDescriptor<T>, idAsTrack?: boolean): void;
-}

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

@@ -1,13 +0,0 @@
-import { TranslateService } from '@ngx-translate/core';
-import { Message, MessageService } from 'primeng/api';
-import { ActionDescriptor } from '../descriptors/action';
-import { TableDescriptorInst } from '../descriptors/table';
-import { IMngError } from '../models';
-export declare class NotificationUtil {
-    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/lib/utils/object.util.d.ts

@@ -1,30 +0,0 @@
-import { ClassType } from '../types';
-interface DeepCopyPropsOptions {
-    mapGettersToProperties?: boolean;
-}
-export interface DeepCopyOptions<P = object> extends DeepCopyPropsOptions {
-    objectPrototype?: ClassType<P>;
-}
-export declare class ObjectUtil {
-    static deepCopy<T = object, P = object>(obj: T, options: DeepCopyOptions<P> & {
-        mapGettersToProperties: true;
-    }): T | Record<string, any>;
-    static deepCopy<T = object, P = object>(obj: T, options: DeepCopyOptions<P> & {
-        objectPrototype: ClassType<P>;
-    } & {
-        mapGettersToProperties?: false;
-    }): P;
-    static deepCopy<T = object, P = object>(obj: T, options: DeepCopyOptions<P> & {
-        objectPrototype: ClassType<P>;
-    } & {
-        mapGettersToProperties: true;
-    }): P | Record<string, any>;
-    static deepCopy<T = object, P = object>(obj: T, options?: DeepCopyOptions<P>): T;
-    static deepMerge(target: Record<string, any>, source: Record<string, any>): Record<string, any>;
-    private static isObject;
-    private static handleProp;
-    static getProperties(obj: object): string[];
-    static getGetters(obj: any): string[];
-    static getPropertyByPath(value: any, path: string): any | undefined;
-}
-export {};

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

@@ -1,37 +0,0 @@
-import { MenuItem } from 'primeng/api';
-import { MngMenuItem } from '../models';
-export declare class RouteUtil {
-    static removeEmptyPathSegments(path: Array<string>): string[];
-    static appendPathToBasePath(basePath: Array<string>, path: Array<string>): string[];
-    static doesUrlMatchRouterLink(link: Array<string> | string, url: Array<string> | string): boolean;
-    static adjustMenuLazyChildrenRouterLinks(rootMenuItem: MenuItem, lazyChildren: Array<MngMenuItem>): {
-        index?: number | undefined;
-        key?: string | undefined;
-        id?: string | undefined;
-        positionIndex?: number | undefined;
-        label?: string | undefined;
-        icon?: string | undefined;
-        items?: MngMenuItem[] | undefined;
-        guards?: any[] | undefined;
-        permissions?: import("@mediusinc/mng-commons").APermissions | undefined;
-        separator?: boolean | undefined;
-        className?: string | undefined;
-        badge?: string | undefined;
-        badgeClassName?: string | undefined;
-        visible?: boolean | undefined;
-        disabled?: boolean | undefined;
-        routerLink?: string | string[] | null | undefined;
-        href?: string | undefined;
-        target?: string | undefined;
-        queryParams?: {
-            [k: string]: any;
-        } | undefined;
-        fragment?: string | undefined;
-        queryParamsHandling?: import("@angular/router").QueryParamsHandling | undefined;
-        preserveFragment?: boolean | undefined;
-        skipLocationChange?: boolean | undefined;
-        replaceUrl?: boolean | undefined;
-        updated?: boolean | undefined;
-        lazyChildren?: boolean | undefined;
-    }[];
-}

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

@@ -1,9 +0,0 @@
-export declare class StringUtil {
-    static escapeHtml(value: string): any;
-    static escapeHtmlAny(value?: any): any;
-    /**
-     * Stringifies a value - primitives with toString, dates with dateUtil, objects with JSON.stringify.
-     * @param value Any value.
-     */
-    static stringify(value: any): string;
-}

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

@@ -1,53 +0,0 @@
-import { ColumnDescriptor } from '../descriptors/table';
-import { ColumnDisplayTypeEnum, ColumnTypeEnum, FieldInputTypeEnum } from '../descriptors/types';
-import { ClassAttributeDef } from '../models';
-import { TableviewAttributeDef } from '../models/tableview-attr.model';
-import { ClassType } from '../types';
-export declare class TableviewUtil {
-    private static _dateRegex;
-    private static _dateTimeRegex;
-    /**
-     * returns attributes from class type and extends to typed def with column and field enum type
-     * @param type class type
-     */
-    static getAttributeDefMap<T>(type: ClassType<T>): TableviewAttributeDef[];
-    /**
-     * expands AttributeDef to TableviewAttributeDef with defined input and column enum type
-     * @param attributes open api specification model
-     */
-    static expandAttributeDefWithTableviewTypes(attributes?: Array<ClassAttributeDef> | null): TableviewAttributeDef[];
-    /**
-     * converts column to number or date on value based
-     * @param column column to be transformed
-     * @param value value to check if applicable
-     */
-    static stringColumnConverter(column: ColumnDescriptor<any, any>, value: any): ColumnDescriptor<any, any>;
-    /**
-     * converts string type to column type enum, default is string
-     * @param propertyType
-     */
-    static toColumnType(propertyType: string): ColumnTypeEnum;
-    static toColumnDisplayType(columnType: ColumnTypeEnum, propertyType: string): ColumnDisplayTypeEnum;
-    /**
-     * converts string type to type enum, default is text
-     * @param property
-     */
-    static toFieldInputType(property: string): FieldInputTypeEnum;
-    /**
-     * convert column type to equivalent field input type
-     * @param type column type
-     * @param displayType column display type
-     */
-    static toFieldInputTypeFromColumnType(type: ColumnTypeEnum, displayType?: ColumnDisplayTypeEnum): FieldInputTypeEnum;
-    /**
-     * generates table layout preferences key used when saving preferences to localstorage
-     * @param typeName string, required
-     * @param url string, required
-     * @param trackProperty string, not required
-     */
-    static generateTableLayoutPrefsKey(typeName: string, url: string, trackProperty?: string): string;
-    /**
-     * Flatten an object of unknown type, used for generating fields and columns in dynamic tableviews
-     */
-    static flattenObject(objectModel: any): string[];
-}

package/lib/validators/field.validator.d.ts

@@ -1,3 +0,0 @@
-import { MngFieldValidator } from '../types';
-export declare const minDateValidator: (min: Date) => MngFieldValidator;
-export declare const maxDateValidator: (max: Date) => MngFieldValidator;

package/lib/validators/index.d.ts

@@ -1 +0,0 @@
-export * from './field.validator';

package/openapi/angular/README.mustache

@@ -1,226 +0,0 @@
-## {{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

@@ -1,39 +0,0 @@
-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');
-        }
-    }
-}