@mediusinc/mng-commons 0.1.0 → 0.2.5

package/lib/{models/descriptors/action-descriptor.model.d.ts → descriptors/action.descriptor.d.ts}

@@ -1,145 +1,148 @@
-import { Observable } from 'rxjs';
-import { ClassType } from '../types';
-import { EditorDescriptor, ModelDescriptor } from '../descriptors';
-import { IDataProvider, IEditorDataProvider } from '../providers';
-import { ActionExecContext } from '../action';
-export declare class ActionDescriptor<T> {
-    protected readonly _model: ModelDescriptor<T>;
-    protected readonly _actionName: string;
-    protected readonly _parentType?: ClassType<any>;
-    protected readonly _parentTypeName?: string;
-    protected readonly _parentProperty?: string;
-    protected readonly _i18nModelActionBaseKey: string;
-    protected _type: ActionTypeEnum;
-    protected _activationTrigger: ActionActivationTriggerEnum;
-    protected _position: ActionPositionEnum;
-    protected _level: ActionLevelEnum;
-    protected _routeUrl: string | null;
-    protected _title?: string | null;
-    protected _icon?: string;
-    protected _className: string;
-    protected _runFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
-    protected _isVisibleFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
-    protected _isEnabledFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
-    private _hasRunConfirmation;
-    private _runConfirmationIcon?;
-    private _runConfirmationTitle?;
-    private _runConfirmationMessage?;
-    private _runConfirmationAcceptTitle?;
-    private _runConfirmationRejectTitle?;
-    protected _hasRunNotificationSuccess: boolean;
-    private _runNotificationSuccessTitle?;
-    private _runNotificationSuccessMessage?;
-    private _hasRunNotificationError;
-    private _runNotificationErrorTitle?;
-    private _runNotificationErrorMessage?;
-    constructor(model: ModelDescriptor<T>, actionName: string, parentType?: ClassType<any>, parentProperty?: string);
-    get model(): ModelDescriptor<T>;
-    get parentTypeName(): string | undefined;
-    get parentProperty(): string | undefined;
-    get i18nModelActionBaseKey(): string;
-    get type(): ActionTypeEnum;
-    get activationTrigger(): ActionActivationTriggerEnum;
-    get position(): ActionPositionEnum;
-    get level(): ActionLevelEnum;
-    get routeUrl(): string | null;
-    get title(): string | null | undefined;
-    get icon(): string | undefined;
-    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
-    get isVisibleFunction(): ((ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>) | undefined;
-    get isEnabledFunction(): ((ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>) | undefined;
-    get actionName(): string;
-    get className(): string;
-    get hasRunConfirmation(): boolean;
-    get runConfirmationIcon(): string | undefined;
-    get runConfirmationTitle(): string | undefined;
-    get runConfirmationMessage(): string | undefined;
-    get runConfirmationAcceptTitle(): string | undefined;
-    get runConfirmationRejectTitle(): string | undefined;
-    get hasRunNotificationSuccess(): boolean;
-    get runNotificationSuccessTitle(): string | undefined;
-    get runNotificationSuccessMessage(): string | undefined;
-    get hasRunNotificationError(): boolean;
-    get runNotificationErrorTitle(): string | undefined;
-    get runNotificationErrorMessage(): string | undefined;
-    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T>): this;
-    withIsVisibleFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<boolean>): this;
-    withIsEnabledFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<boolean>): this;
-    withRouteTrigger(routeUrl: string): this;
-    withLevel(level: ActionLevelEnum): this;
-    /**
-     * Overrides default title key with model action key (${model.typeName}.actions.${actionName}). Not relevant if parentType name is provided.
-     */
-    withModelTitle(): this;
-    /**
-     * Overrides default title key (${actionName}.title). If null, no title will be shown.
-     * @param title Title i18n key or title.
-     */
-    withTitle(title: string | null): this;
-    withIcon(icon: string): this;
-    withClassName(className: string): this;
-    withPosition(position: ActionPositionEnum): this;
-    withRunConfirmation(icon?: string, title?: string, message?: string, acceptTitle?: string, rejectTitle?: string): this;
-    withRunNotificationSuccess(title?: string, message?: string, hasNotification?: boolean): void;
-    withRunNotificationError(title?: string, message?: string, hasNotification?: boolean): void;
-}
-export declare class ActionEditorDescriptor<T> extends ActionDescriptor<T> {
-    private readonly _editorDescriptor;
-    protected _editorTitle?: string;
-    private _hasFetchNotificationSuccess;
-    private _fetchNotificationSuccessTitle?;
-    private _fetchNotificationSuccessMessage?;
-    protected _fetchFunction?: (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
-    protected _submitFunction?: (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
-    constructor(editorDescriptor: EditorDescriptor<T>, actionName: string, parentType?: ClassType<any>, parentProperty?: string);
-    get editorTitle(): string | undefined;
-    get editorDescriptor(): EditorDescriptor<T>;
-    get hasFetchNotificationSuccess(): boolean;
-    get fetchNotificationSuccessTitle(): string | undefined;
-    get fetchNotificationSuccessMessage(): string | undefined;
-    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
-    get fetchFunction(): (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
-    get submitFunction(): ((ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>) | undefined;
-    withEditorTitle(title: string): this;
-    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T>): this;
-    withFetchFunction<S>(fn: (ctx: ActionExecContext<T, S, IEditorDataProvider<T, S>>) => Observable<T>): this;
-    withSubmitFunction<S>(fn: (ctx: ActionExecContext<T, S, IEditorDataProvider<T, S>>) => Observable<T>): this;
-    withFetchNotificationError(title?: string, message?: string, hasNotification?: boolean): void;
-}
-export declare class ActionEditorDetailsDescriptor<T> extends ActionEditorDescriptor<T> {
-    constructor(editorDescriptor: EditorDescriptor<T>);
-}
-export declare class ActionEditorAddDescriptor<T> extends ActionEditorDescriptor<T> {
-    constructor(editorDescriptor: EditorDescriptor<T>);
-}
-export declare class ActionEditorEditDescriptor<T> extends ActionEditorDescriptor<T> {
-    constructor(editorDescriptor: EditorDescriptor<T>);
-}
-export declare class ActionDeleteDescriptor<T> extends ActionDescriptor<T> {
-    constructor(model: ModelDescriptor<T>);
-}
-export declare enum ActionPositionEnum {
-    ToolbarLeft = 0,
-    ToolbarRight = 1,
-    TableHeader = 2,
-    RowInline = 3,
-    RowClick = 4
-}
-export declare enum ActionActivationTriggerEnum {
-    OnClick = 0,
-    OnRoute = 1
-}
-export declare enum ActionTypeEnum {
-    Direct = 0,
-    Editor = 1
-}
-export declare enum ActionLevelEnum {
-    Default = 0,
-    Primary = 1,
-    Secondary = 2,
-    Info = 3,
-    Help = 4,
-    Success = 5,
-    Warning = 6,
-    Danger = 7
-}
+import { Observable } from 'rxjs';
+import { ClassType } from '../types';
+import { EditorDescriptor, ModelDescriptor } from './';
+import { IDataProvider, IEditorDataProvider } from '../data-providers';
+import { ActionExecContext } from '../components/action/models';
+export declare class ActionDescriptor<T> {
+    protected readonly _model: ModelDescriptor<T>;
+    protected readonly _actionName: string;
+    protected readonly _parentType?: ClassType<any>;
+    protected readonly _parentTypeName?: string;
+    protected readonly _parentProperty?: string;
+    protected readonly _i18nModelActionBaseKey: string;
+    protected _type: ActionTypeEnum;
+    protected _activationTrigger: ActionActivationTriggerEnum;
+    protected _position: ActionPositionEnum;
+    protected _level: ActionLevelEnum;
+    protected _routeUrl: string | null;
+    protected _title?: string | null;
+    protected _icon?: string;
+    protected _className: string;
+    protected _tooltip?: string | null;
+    protected _runFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
+    protected _isVisibleFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
+    protected _isEnabledFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
+    private _hasRunConfirmation;
+    private _runConfirmationIcon?;
+    private _runConfirmationTitle?;
+    private _runConfirmationMessage?;
+    private _runConfirmationAcceptTitle?;
+    private _runConfirmationRejectTitle?;
+    protected _hasRunNotificationSuccess: boolean;
+    private _runNotificationSuccessTitle?;
+    private _runNotificationSuccessMessage?;
+    private _hasRunNotificationError;
+    private _runNotificationErrorTitle?;
+    private _runNotificationErrorMessage?;
+    constructor(model: ModelDescriptor<T>, actionName: string, parentType?: ClassType<any>, parentProperty?: string);
+    get model(): ModelDescriptor<T>;
+    get parentTypeName(): string | undefined;
+    get parentProperty(): string | undefined;
+    get i18nModelActionBaseKey(): string;
+    get type(): ActionTypeEnum;
+    get activationTrigger(): ActionActivationTriggerEnum;
+    get position(): ActionPositionEnum;
+    get level(): ActionLevelEnum;
+    get routeUrl(): string | null;
+    get title(): string | null | undefined;
+    get icon(): string | undefined;
+    get tooltip(): string | null | undefined;
+    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
+    get isVisibleFunction(): ((ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>) | undefined;
+    get isEnabledFunction(): ((ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>) | undefined;
+    get actionName(): string;
+    get className(): string;
+    get hasRunConfirmation(): boolean;
+    get runConfirmationIcon(): string | undefined;
+    get runConfirmationTitle(): string | undefined;
+    get runConfirmationMessage(): string | undefined;
+    get runConfirmationAcceptTitle(): string | undefined;
+    get runConfirmationRejectTitle(): string | undefined;
+    get hasRunNotificationSuccess(): boolean;
+    get runNotificationSuccessTitle(): string | undefined;
+    get runNotificationSuccessMessage(): string | undefined;
+    get hasRunNotificationError(): boolean;
+    get runNotificationErrorTitle(): string | undefined;
+    get runNotificationErrorMessage(): string | undefined;
+    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T>): this;
+    withIsVisibleFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<boolean>): this;
+    withIsEnabledFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<boolean>): this;
+    withRouteTrigger(routeUrl: string): this;
+    withLevel(level: ActionLevelEnum): this;
+    /**
+     * Overrides default title key with model action key (${model.typeName}.actions.${actionName}). Not relevant if parentType name is provided.
+     */
+    withModelTitle(): this;
+    /**
+     * Overrides default title key (${actionName}.title). If null, no title will be shown.
+     * @param title Title i18n key or title.
+     */
+    withTitle(title: string | null): this;
+    withIcon(icon: string): this;
+    withTooltip(tooltip: string | null): this;
+    withClassName(className: string): this;
+    withPosition(position: ActionPositionEnum): this;
+    withRunConfirmation(icon?: string, title?: string, message?: string, acceptTitle?: string, rejectTitle?: string): this;
+    withRunNotificationSuccess(title?: string, message?: string, hasNotification?: boolean): void;
+    withRunNotificationError(title?: string, message?: string, hasNotification?: boolean): void;
+}
+export declare class ActionEditorDescriptor<T> extends ActionDescriptor<T> {
+    private readonly _editorDescriptor;
+    protected _editorTitle?: string;
+    private _hasFetchNotificationSuccess;
+    private _fetchNotificationSuccessTitle?;
+    private _fetchNotificationSuccessMessage?;
+    protected _fetchFunction?: (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
+    protected _submitFunction?: (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
+    constructor(editorDescriptor: EditorDescriptor<T>, actionName: string, parentType?: ClassType<any>, parentProperty?: string);
+    get editorTitle(): string | undefined;
+    get editorDescriptor(): EditorDescriptor<T>;
+    get hasFetchNotificationSuccess(): boolean;
+    get fetchNotificationSuccessTitle(): string | undefined;
+    get fetchNotificationSuccessMessage(): string | undefined;
+    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T>;
+    get fetchFunction(): (ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>;
+    get submitFunction(): ((ctx: ActionExecContext<T, any, IEditorDataProvider<T, any>>) => Observable<T>) | undefined;
+    withEditorTitle(title: string): this;
+    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T>): this;
+    withFetchFunction<S>(fn: (ctx: ActionExecContext<T, S, IEditorDataProvider<T, S>>) => Observable<T>): this;
+    withSubmitFunction<S>(fn: (ctx: ActionExecContext<T, S, IEditorDataProvider<T, S>>) => Observable<T>): this;
+    withFetchNotificationError(title?: string, message?: string, hasNotification?: boolean): void;
+}
+export declare class ActionEditorDetailsDescriptor<T> extends ActionEditorDescriptor<T> {
+    constructor(editorDescriptor: EditorDescriptor<T>);
+}
+export declare class ActionEditorAddDescriptor<T> extends ActionEditorDescriptor<T> {
+    constructor(editorDescriptor: EditorDescriptor<T>);
+}
+export declare class ActionEditorEditDescriptor<T> extends ActionEditorDescriptor<T> {
+    constructor(editorDescriptor: EditorDescriptor<T>);
+}
+export declare class ActionDeleteDescriptor<T> extends ActionDescriptor<T> {
+    constructor(model: ModelDescriptor<T>);
+}
+export declare enum ActionPositionEnum {
+    ToolbarLeft = 0,
+    ToolbarRight = 1,
+    TableHeader = 2,
+    RowInline = 3,
+    RowClick = 4
+}
+export declare enum ActionActivationTriggerEnum {
+    OnClick = 0,
+    OnRoute = 1
+}
+export declare enum ActionTypeEnum {
+    Direct = 0,
+    Editor = 1
+}
+export declare enum ActionLevelEnum {
+    Default = 0,
+    Primary = 1,
+    Secondary = 2,
+    Info = 3,
+    Help = 4,
+    Success = 5,
+    Warning = 6,
+    Danger = 7
+}