@mediusinc/mng-commons 0.6.0 → 0.6.1

package/lib/api/services/crud-api.abstract.service.d.ts

@@ -3,12 +3,18 @@ import { Observable } from 'rxjs';
 import { ClassType, IdType } from '../../types';
 import { MediusQueryResult } from '../models';
 import { AMngGetAllApiService } from './get-all-api.abstract.service';
-export declare abstract class AMngCrudApiService<T, QRT extends MediusQueryResult<any>> extends AMngGetAllApiService<T, QRT> {
+export interface IMngCrudApiService<T> {
+    createPost?(item: T, params?: HttpParams): Observable<T>;
+    getByIdGet?(id: IdType, params?: HttpParams): Observable<T>;
+    updatePut?(id: IdType, item: T, params?: HttpParams): Observable<T>;
+    removeDelete?(id: IdType, item?: T, params?: HttpParams): Observable<T | null>;
+}
+export declare abstract class AMngCrudApiService<T, QRT extends MediusQueryResult<any>> extends AMngGetAllApiService<T, QRT> implements IMngCrudApiService<T> {
     protected constructor(type: ClassType<T>, queryResultType: ClassType<QRT>, http: HttpClient);
     createPost(item: T, params?: HttpParams): Observable<T>;
     getByIdGet(id: IdType, params?: HttpParams): Observable<T>;
     updatePut(id: IdType, item: T, params?: HttpParams): Observable<T>;
-    removeDelete(id: IdType, item?: T, params?: HttpParams): Observable<any>;
+    removeDelete(id: IdType, item?: T, params?: HttpParams): Observable<T | null>;
     protected getCreatePostPath(item: T): string;
     protected getUpdatePutPath(id: IdType, item: T): string;
     protected getGetByIdGetPath(id: IdType): string;

package/lib/components/action/models/action-execution.model.d.ts

@@ -2,9 +2,11 @@ import { Message } from 'primeng/api';
 import { DynamicDialogRef } from 'primeng/dynamicdialog';
 import { Observable } from 'rxjs';
 import { IDataProvider } from '../../../data-providers';
+import { ActionDescriptor } from '../../../descriptors';
 import { IViewContainer } from '../../../models';
 import { IdType } from '../../../types';
 export declare class ActionExecContext<T, S, DP extends IDataProvider<T, S>> {
+    readonly action: ActionDescriptor<T>;
     readonly dataProvider?: DP | undefined;
     readonly serviceInstance?: S | undefined;
     readonly data?: {
@@ -14,7 +16,7 @@ export declare class ActionExecContext<T, S, DP extends IDataProvider<T, S>> {
     } | undefined;
     readonly sourceComponent: any;
     readonly viewContainer: IViewContainer<T, S> | null;
-    constructor(dataProvider?: DP | undefined, serviceInstance?: S | undefined, data?: {
+    constructor(action: ActionDescriptor<T>, dataProvider?: DP | undefined, serviceInstance?: S | undefined, data?: {
         item?: T | undefined;
         itemId?: IdType | undefined;
         actionData?: ActionData | undefined;
@@ -28,10 +30,10 @@ export declare class ActionError {
 }
 export declare class ActionRunResult<T, S, DP extends IDataProvider<T, S>> {
     readonly context?: ActionExecContext<T, S, DP> | undefined;
-    readonly result?: T | undefined;
+    readonly result?: T | null | undefined;
     readonly error?: ActionError | undefined;
     notification?: Message;
-    constructor(context?: ActionExecContext<T, S, DP> | undefined, result?: T | undefined, error?: ActionError | undefined);
+    constructor(context?: ActionExecContext<T, S, DP> | undefined, result?: T | null | undefined, error?: ActionError | undefined);
 }
 export declare class ActionActivationResult<T, S, DP extends IDataProvider<T, S>> {
     readonly runResult?: ActionRunResult<T, S, DP> | undefined;

package/lib/data-providers/editor.data-provider.d.ts

@@ -6,20 +6,20 @@ export interface IEditorDataProvider<T, S> extends IDataProvider<T, S> {
     fetch: (id: IdType, service?: S) => Observable<T>;
     create?: (item?: T, service?: S) => Observable<T>;
     update?: (id: IdType, item?: T, service?: S) => Observable<T>;
-    delete?: (id: IdType, item?: T, service?: S) => Observable<T>;
+    delete?: (id: IdType, item?: T, service?: S) => Observable<T | null>;
 }
 export declare class EditorDataProvider<T, S> extends DataProvider<T, S> implements IEditorDataProvider<T, S> {
     protected _fetch: (id: IdType, service?: S) => Observable<T>;
     protected _create?: (item?: T, service?: S) => Observable<T>;
     protected _update?: (id: IdType, item?: T, service?: S) => Observable<T>;
-    protected _delete?: (id: IdType, item?: T, service?: S) => Observable<T>;
+    protected _delete?: (id: IdType, item?: T, service?: S) => Observable<T | null>;
     constructor(modelType: ClassType<T>, serviceType?: Type<S>);
     get fetch(): (id: IdType, service?: S | undefined) => Observable<T>;
     get create(): ((item?: T | undefined, service?: S | undefined) => Observable<T>) | undefined;
     get update(): ((id: IdType, item?: T | undefined, service?: S | undefined) => Observable<T>) | undefined;
-    get delete(): ((id: IdType, item?: T | undefined, service?: S | undefined) => Observable<T>) | undefined;
+    get delete(): ((id: IdType, item?: T | undefined, service?: S | undefined) => Observable<T | null>) | undefined;
     withFetch(fetch: (id: IdType, service?: S) => Observable<T>): this;
     withCreate(create: (item?: T, service?: S) => Observable<T>): this;
     withUpdate(update: (id: IdType, item?: T, service?: S) => Observable<T>): this;
-    withDelete(deleteFn: (id: IdType, item?: T, service?: S) => Observable<T>): this;
+    withDelete(deleteFn: (id: IdType, item?: T, service?: S) => Observable<T | null>): this;
 }

package/lib/descriptors/action.descriptor.d.ts

@@ -27,7 +27,7 @@ export declare class ActionDescriptor<T> {
     protected _isStyleOutlined: boolean;
     protected _isStyleRaised: boolean;
     protected _dataProvider?: IDataProvider<T, any>;
-    protected _runFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T | undefined>;
+    protected _runFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T | undefined | null>;
     protected _isVisibleFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
     protected _isEnabledFunction?: (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<boolean>;
     private _hasRunConfirmation;
@@ -58,7 +58,7 @@ export declare class ActionDescriptor<T> {
     get tooltip(): string | null | undefined;
     get dataProvider(): IDataProvider<T, any> | undefined;
     get hasRunFunction(): boolean;
-    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T | undefined>;
+    get runFunction(): (ctx: ActionExecContext<T, any, IDataProvider<T, any>>) => Observable<T | undefined | null>;
     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;
@@ -86,7 +86,7 @@ export declare class ActionDescriptor<T> {
     get runNotificationErrorMessage(): string | undefined;
     withDataProvider(dataProvider: IDataProvider<T, any>): this;
     withServiceType<S>(serviceType: Type<S>): this;
-    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T | undefined>): this;
+    withRunFunction<S>(fn: (ctx: ActionExecContext<T, S, IDataProvider<T, S>>) => Observable<T | undefined | null>): 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;

package/lib/utils/action-data-provider.util.d.ts

@@ -0,0 +1,17 @@
+import { Observable } from 'rxjs';
+import { ActionExecContext } from '../components/action/models';
+import { IDataProvider } from '../data-providers';
+export declare class ActionDataProviderUtil {
+    static runFetchOrFail<T, S, DP extends IDataProvider<T, S>>(ctx: ActionExecContext<T, S, DP>): Observable<T>;
+    static runCreateOrFail<T, S, DP extends IDataProvider<T, S>>(ctx: ActionExecContext<T, S, DP>): Observable<T>;
+    static runUpdateOrFail<T, S, DP extends IDataProvider<T, S>>(ctx: ActionExecContext<T, S, DP>): Observable<T>;
+    static runDeleteOrFail<T, S, DP extends IDataProvider<T, S>>(ctx: ActionExecContext<T, S, DP>): Observable<T | null>;
+    static runGetByIdService<T, DP extends IDataProvider<T, unknown>>(ctx: ActionExecContext<T, unknown, DP>): Observable<T> | null;
+    static runCreateService<T, DP extends IDataProvider<T, unknown>>(ctx: ActionExecContext<T, unknown, DP>): Observable<T> | null;
+    static runUpdateService<T, DP extends IDataProvider<T, unknown>>(ctx: ActionExecContext<T, unknown, DP>): Observable<T> | null;
+    static runDeleteService<T, DP extends IDataProvider<T, unknown>>(ctx: ActionExecContext<T, unknown, DP>): Observable<T | null> | null;
+    static runFetchDataProvider<T, S>(ctx: ActionExecContext<T, S, IDataProvider<T, S>>): Observable<T> | null;
+    static runCreateDataProvider<T, S>(ctx: ActionExecContext<T, S, IDataProvider<T, S>>): Observable<T> | null;
+    static runUpdateDataProvider<T, S>(ctx: ActionExecContext<T, S, IDataProvider<T, S>>): Observable<T> | null;
+    static runDeleteDataProvider<T, S>(ctx: ActionExecContext<T, S, IDataProvider<T, S>>): Observable<T | null> | null;
+}

package/lib/utils/index.d.ts

@@ -1,3 +1,4 @@
+export * from './action-data-provider.util';
 export * from './editor-formly.util';
 export * from './enum.util';
 export * from './i18n.util';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mediusinc/mng-commons",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "peerDependencies": {
     "@angular/common": "^13.2.0",
     "@angular/core": "^13.2.0",