@etsoo/appscript 1.4.9 → 1.4.11

package/__tests__/app/CoreApp.ts

@@ -151,6 +151,16 @@ test('Test for properties', () => {
     expect(app.settings.currentRegion.label).toBe('中国大陆');
 });
 
+test('Test for formatAction', () => {
+    Object.assign(app.settings.currentCulture.resources, {
+        appName: '司友®云ERP'
+    });
+    expect(app.formatAction('修改', '客户A')).toBe('[司友®云ERP] 修改 - 客户A');
+    expect(app.formatAction('修改', '客户A', '企业')).toBe(
+        '[司友®云ERP] 修改 - 客户A, 企业'
+    );
+});
+
 test('Tests for addRootUrl', () => {
     expect(app.addRootUrl('/home')).toBe('/cms/home');
     expect(app.addRootUrl('./home')).toBe('/cms/./home');

package/lib/cjs/app/CoreApp.d.ts

@@ -294,6 +294,14 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Enhanced passphrase
      */
     protected encryptionEnhance(passphrase: string, timestamp: string): string;
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]): string;
     /**
      * Format date to string
      * @param input Input date

package/lib/cjs/app/CoreApp.js

@@ -757,6 +757,17 @@ class CoreApp {
         passphrase += passphrase.length.toString();
         return passphrase;
     }
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action, target, ...items) {
+        let more = items.join(', ');
+        return `[${this.get('appName')}] ${action} - ${target}${more ? `, ${more}` : more}`;
+    }
     /**
      * Format date to string
      * @param input Input date

package/lib/cjs/app/IApp.d.ts

@@ -233,6 +233,14 @@ export interface IApp {
      * @returns string
      */
     formatDate(input?: Date | string, options?: DateUtils.FormatOptions, timeZone?: string): string | undefined;
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]): string;
     /**
      * Format error
      * @param error Error

package/lib/cjs/erp/OrgApi.d.ts

@@ -8,6 +8,7 @@ import { IdResultPayload } from './dto/ResultPayload';
 import { EntityApi } from './EntityApi';
 import { OrgListRQ } from './rq/OrgListRQ';
 import { OrgQueryRQ } from './rq/OrgQueryRQ';
+import { SendActionMessageRQ } from './rq/SendActionMessageRQ';
 /**
  * Organization API
  */
@@ -41,6 +42,13 @@ export declare class OrgApi extends EntityApi {
      * @returns Result
      */
     read(id: number, payload?: IApiPayload<OrgViewDto>, reload?: boolean): Promise<OrgViewDto | undefined>;
+    /**
+     * Send action message
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    sendActionMessage(rq: SendActionMessageRQ, payload?: IApiPayload<void>): Promise<void | undefined>;
     /**
      * Switch organization
      * @param id Organization id

package/lib/cjs/erp/OrgApi.js

@@ -51,6 +51,17 @@ class OrgApi extends EntityApi_1.EntityApi {
         }
         return data;
     }
+    /**
+     * Send action message
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    sendActionMessage(rq, payload) {
+        const appId = 'serviceId' in this.app.settings ? this.app.settings.serviceId : 0;
+        payload !== null && payload !== void 0 ? payload : (payload = { showLoading: false });
+        return this.api.post('System/SendActionMessage', { ...rq, appId }, payload);
+    }
     /**
      * Switch organization
      * @param id Organization id

package/lib/cjs/erp/rq/SendActionMessageRQ.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Send action message request data
+ * 发送操作信息请求数据
+ */
+export type SendActionMessageRQ = {
+    /**
+     * Kind
+     * 类型
+     */
+    kind: string;
+    /**
+     * Title
+     * 标题
+     */
+    title: string;
+    /**
+     * Related id
+     * 相关编号
+     */
+    relatedId?: number;
+    /**
+     * More data
+     * 更多数据
+     */
+    data?: Record<string, unknown>;
+};

package/lib/cjs/erp/rq/SendActionMessageRQ.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/cjs/index.d.ts

@@ -51,6 +51,7 @@ export * from './erp/rq/QueryRQ';
 export * from './erp/rq/RefreshTokenRQ';
 export * from './erp/rq/RegionsRQ';
 export * from './erp/rq/ResetPasswordRQ';
+export * from './erp/rq/SendActionMessageRQ';
 export * from './erp/rq/TiplistRQ';
 export * from './erp/rq/UpdateStatusRQ';
 export * from './erp/AddressApi';

package/lib/cjs/index.js

@@ -75,6 +75,7 @@ __exportStar(require("./erp/rq/QueryRQ"), exports);
 __exportStar(require("./erp/rq/RefreshTokenRQ"), exports);
 __exportStar(require("./erp/rq/RegionsRQ"), exports);
 __exportStar(require("./erp/rq/ResetPasswordRQ"), exports);
+__exportStar(require("./erp/rq/SendActionMessageRQ"), exports);
 __exportStar(require("./erp/rq/TiplistRQ"), exports);
 __exportStar(require("./erp/rq/UpdateStatusRQ"), exports);
 // erp api

package/lib/mjs/app/CoreApp.d.ts

@@ -294,6 +294,14 @@ export declare abstract class CoreApp<U extends IUser, S extends IAppSettings, N
      * @returns Enhanced passphrase
      */
     protected encryptionEnhance(passphrase: string, timestamp: string): string;
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]): string;
     /**
      * Format date to string
      * @param input Input date

package/lib/mjs/app/CoreApp.js

@@ -731,6 +731,17 @@ export class CoreApp {
         passphrase += passphrase.length.toString();
         return passphrase;
     }
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action, target, ...items) {
+        let more = items.join(', ');
+        return `[${this.get('appName')}] ${action} - ${target}${more ? `, ${more}` : more}`;
+    }
     /**
      * Format date to string
      * @param input Input date

package/lib/mjs/app/IApp.d.ts

@@ -233,6 +233,14 @@ export interface IApp {
      * @returns string
      */
     formatDate(input?: Date | string, options?: DateUtils.FormatOptions, timeZone?: string): string | undefined;
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]): string;
     /**
      * Format error
      * @param error Error

package/lib/mjs/erp/OrgApi.d.ts

@@ -8,6 +8,7 @@ import { IdResultPayload } from './dto/ResultPayload';
 import { EntityApi } from './EntityApi';
 import { OrgListRQ } from './rq/OrgListRQ';
 import { OrgQueryRQ } from './rq/OrgQueryRQ';
+import { SendActionMessageRQ } from './rq/SendActionMessageRQ';
 /**
  * Organization API
  */
@@ -41,6 +42,13 @@ export declare class OrgApi extends EntityApi {
      * @returns Result
      */
     read(id: number, payload?: IApiPayload<OrgViewDto>, reload?: boolean): Promise<OrgViewDto | undefined>;
+    /**
+     * Send action message
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    sendActionMessage(rq: SendActionMessageRQ, payload?: IApiPayload<void>): Promise<void | undefined>;
     /**
      * Switch organization
      * @param id Organization id

package/lib/mjs/erp/OrgApi.js

@@ -48,6 +48,17 @@ export class OrgApi extends EntityApi {
         }
         return data;
     }
+    /**
+     * Send action message
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    sendActionMessage(rq, payload) {
+        const appId = 'serviceId' in this.app.settings ? this.app.settings.serviceId : 0;
+        payload !== null && payload !== void 0 ? payload : (payload = { showLoading: false });
+        return this.api.post('System/SendActionMessage', { ...rq, appId }, payload);
+    }
     /**
      * Switch organization
      * @param id Organization id

package/lib/mjs/erp/rq/SendActionMessageRQ.d.ts

@@ -0,0 +1,26 @@
+/**
+ * Send action message request data
+ * 发送操作信息请求数据
+ */
+export type SendActionMessageRQ = {
+    /**
+     * Kind
+     * 类型
+     */
+    kind: string;
+    /**
+     * Title
+     * 标题
+     */
+    title: string;
+    /**
+     * Related id
+     * 相关编号
+     */
+    relatedId?: number;
+    /**
+     * More data
+     * 更多数据
+     */
+    data?: Record<string, unknown>;
+};

package/lib/mjs/erp/rq/SendActionMessageRQ.js

@@ -0,0 +1 @@
+export {};

package/lib/mjs/index.d.ts

@@ -51,6 +51,7 @@ export * from './erp/rq/QueryRQ';
 export * from './erp/rq/RefreshTokenRQ';
 export * from './erp/rq/RegionsRQ';
 export * from './erp/rq/ResetPasswordRQ';
+export * from './erp/rq/SendActionMessageRQ';
 export * from './erp/rq/TiplistRQ';
 export * from './erp/rq/UpdateStatusRQ';
 export * from './erp/AddressApi';

package/lib/mjs/index.js

@@ -58,6 +58,7 @@ export * from './erp/rq/QueryRQ';
 export * from './erp/rq/RefreshTokenRQ';
 export * from './erp/rq/RegionsRQ';
 export * from './erp/rq/ResetPasswordRQ';
+export * from './erp/rq/SendActionMessageRQ';
 export * from './erp/rq/TiplistRQ';
 export * from './erp/rq/UpdateStatusRQ';
 // erp api

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@etsoo/appscript",
-    "version": "1.4.9",
+    "version": "1.4.11",
     "description": "Applications shared TypeScript framework",
     "main": "lib/cjs/index.js",
     "module": "lib/mjs/index.js",

package/src/app/CoreApp.ts

@@ -1025,6 +1025,20 @@ export abstract class CoreApp<
         return passphrase;
     }
 
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]) {
+        let more = items.join(', ');
+        return `[${this.get('appName')}] ${action} - ${target}${
+            more ? `, ${more}` : more
+        }`;
+    }
+
     /**
      * Format date to string
      * @param input Input date

package/src/app/IApp.ts

@@ -315,6 +315,15 @@ export interface IApp {
         timeZone?: string
     ): string | undefined;
 
+    /**
+     * Format action
+     * @param action Action
+     * @param target Target name or title
+     * @param items More items
+     * @returns Result
+     */
+    formatAction(action: string, target: string, ...items: string[]): string;
+
     /**
      * Format error
      * @param error Error

package/src/erp/OrgApi.ts

@@ -8,6 +8,7 @@ import { IdResultPayload } from './dto/ResultPayload';
 import { EntityApi } from './EntityApi';
 import { OrgListRQ } from './rq/OrgListRQ';
 import { OrgQueryRQ } from './rq/OrgQueryRQ';
+import { SendActionMessageRQ } from './rq/SendActionMessageRQ';
 
 const cachedOrgs: { [P: number]: OrgViewDto | undefined | null } = {};
 
@@ -81,6 +82,23 @@ export class OrgApi extends EntityApi {
         return data;
     }
 
+    /**
+     * Send action message
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    sendActionMessage(rq: SendActionMessageRQ, payload?: IApiPayload<void>) {
+        const appId =
+            'serviceId' in this.app.settings ? this.app.settings.serviceId : 0;
+        payload ??= { showLoading: false };
+        return this.api.post(
+            'System/SendActionMessage',
+            { ...rq, appId },
+            payload
+        );
+    }
+
     /**
      * Switch organization
      * @param id Organization id

package/src/erp/rq/SendActionMessageRQ.ts

@@ -0,0 +1,29 @@
+/**
+ * Send action message request data
+ * 发送操作信息请求数据
+ */
+export type SendActionMessageRQ = {
+    /**
+     * Kind
+     * 类型
+     */
+    kind: string;
+
+    /**
+     * Title
+     * 标题
+     */
+    title: string;
+
+    /**
+     * Related id
+     * 相关编号
+     */
+    relatedId?: number;
+
+    /**
+     * More data
+     * 更多数据
+     */
+    data?: Record<string, unknown>;
+};

package/src/index.ts

@@ -64,6 +64,7 @@ export * from './erp/rq/QueryRQ';
 export * from './erp/rq/RefreshTokenRQ';
 export * from './erp/rq/RegionsRQ';
 export * from './erp/rq/ResetPasswordRQ';
+export * from './erp/rq/SendActionMessageRQ';
 export * from './erp/rq/TiplistRQ';
 export * from './erp/rq/UpdateStatusRQ';