@etsoo/smarterp-core 1.1.48 → 1.1.50

package/lib/mjs/rq/document/DocumentUpdateRQ.d.ts

@@ -0,0 +1,7 @@
+import { DataTypes } from "@etsoo/shared";
+import { DocumentCreateRQ } from "./DocumentCreateRQ";
+/**
+ * Document update request data
+ * 文档更新请求数据
+ */
+export type DocumentUpdateRQ = DataTypes.EditType<DocumentCreateRQ>;

package/lib/mjs/rq/document/DocumentUpdateRQ.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/smarterp-core",
-  "version": "1.1.48",
+  "version": "1.1.50",
   "description": "TypeScript APIs for SmartERP Core",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",
@@ -40,10 +40,10 @@
   "license": "MIT",
   "homepage": "https://github.com/ETSOO/smarterp-core#readme",
   "devDependencies": {
-    "@babel/core": "^7.29.0",
-    "@babel/plugin-transform-runtime": "^7.29.0",
-    "@babel/preset-env": "^7.29.5",
-    "@babel/runtime-corejs3": "^7.29.2",
+    "@babel/core": "^7.29.7",
+    "@babel/plugin-transform-runtime": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@babel/runtime-corejs3": "^7.29.7",
     "@types/react": "^19.2.15",
     "@types/react-dom": "^19.2.3",
     "@vitejs/plugin-react": "^6.0.2",

package/src/CoreApp.ts

@@ -12,9 +12,10 @@ import {
   UserIdentifierType
 } from "@etsoo/appscript";
 import { AuthCodeApi } from "./AuthCodeApi";
-import { DataTypes, ListType } from "@etsoo/shared";
+import { DataTypes, ListType, ListType1 } from "@etsoo/shared";
 import { CoreApiService } from "./dto/org/CoreApiService";
 import { DocumentApi } from "./DocumentApi";
+import { DocumentKind } from "./dto/document/DocumentKind";
 
 type AppData = { id: number; appId?: number; name: string; localName?: string };
 
@@ -86,6 +87,21 @@ export interface ICoreApp {
    */
   getAppName(data: AppData): string;
 
+  /**
+   * Get document kind label
+   * 获取文档类型标签
+   * @param kind Kind
+   * @returns Label
+   */
+  getDocumentKind(kind?: DocumentKind): string | undefined;
+
+  /**
+   * Get document kinds
+   * 获取文档类型列表
+   * @returns List
+   */
+  getDocumentKinds(): ListType1[];
+
   /**
    * Get user identifier type label
    * 获取用户标识类型标签
@@ -257,6 +273,28 @@ export class CoreApp implements ICoreApp {
     );
   }
 
+  /**
+   * Get document kind label
+   * 获取文档类型标签
+   * @param kind Kind
+   * @returns Label
+   */
+  getDocumentKind(kind?: DocumentKind) {
+    if (kind == null) return undefined;
+
+    const key = DocumentKind[kind];
+    return this.app.get("template" + key) ?? key;
+  }
+
+  /**
+   * Get document kinds
+   * 获取文档类型列表
+   * @returns List
+   */
+  getDocumentKinds() {
+    return this.app.getEnumStrList(DocumentKind, "template");
+  }
+
   /**
    * Get user identifier type label
    * 获取用户标识类型标签

package/src/DocumentApi.ts

@@ -1,7 +1,17 @@
-import { EntityApi, IApi, IApiPayload, IApp } from "@etsoo/appscript";
-import { SystemDocumentListRQ } from "./rq/document/SystemDocumentListRQ";
-import { SystemDocumentListData } from "./dto/document/SystemDocumentListData";
-import { SystemDocumentViewData } from "./dto/document/SystemDocumentViewData";
+import {
+  EntityApi,
+  IApi,
+  IApiPayload,
+  IApp,
+  IdResultPayload
+} from "@etsoo/appscript";
+import { DocumentListData } from "./dto/document/DocumentListData";
+import { DocumentListRQ } from "./rq/document/DocumentListRQ";
+import { DocumentReadData } from "./dto/document/DocumentReadData";
+import { DocumentCreateRQ } from "./rq/document/DocumentCreateRQ";
+import { DocumentQueryRQ } from "./rq/document/DocumentQueryRQ";
+import { DocumentQueryData } from "./dto/document/DocumentQueryData";
+import { DocumentUpdateRQ } from "./rq/document/DocumentUpdateRQ";
 
 /**
  * Document API
@@ -16,26 +26,63 @@ export class DocumentApi extends EntityApi {
     super("Document", app, api);
   }
 
+  /**
+   * Create
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  create(rq: DocumentCreateRQ, payload?: IdResultPayload) {
+    return this.createBase(rq, payload);
+  }
+
+  /**
+   * Delete
+   * @param id Id
+   * @param payload Payload
+   * @returns Result
+   */
+  delete(id: number, payload?: IdResultPayload) {
+    return this.deleteBase(id, payload);
+  }
+
   /**
    * List
    * @param rq Request data
    * @param payload Payload
    * @returns Result
    */
-  list(
-    rq: SystemDocumentListRQ,
-    payload: IApiPayload<SystemDocumentListData[]>
-  ) {
+  list(rq: DocumentListRQ, payload: IApiPayload<DocumentListData[]>) {
     return this.listBase(rq, payload);
   }
 
+  /**
+   * Query
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  query(rq: DocumentQueryRQ, payload?: IApiPayload<DocumentQueryData[]>) {
+    return this.queryBase(rq, payload);
+  }
+
   /**
    * Read
    * @param id Id
    * @param payload Payload
    * @returns Result
    */
-  read(id: number, payload?: IApiPayload<SystemDocumentViewData>) {
+  read(id: number, payload?: IApiPayload<DocumentReadData>) {
     return this.readBase(id, payload);
   }
+
+  /**
+   * Update
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  update(rq: DocumentUpdateRQ, payload?: IdResultPayload) {
+    return this.updateBase(rq, payload);
+  }
 }

package/src/components/document/DocumentKindList.tsx

@@ -0,0 +1,28 @@
+import { SelectEx, SelectExProps } from "@etsoo/materialui";
+import { useRequiredAppContext } from "../../ICoreServiceApp";
+import { ListType1 } from "@etsoo/shared";
+
+/**
+ * Document kind list component
+ * @param props Props
+ * @returns Component
+ */
+export function DocumentKindList(
+  props: Omit<SelectExProps<ListType1>, "options">
+) {
+  // App
+  const app = useRequiredAppContext();
+
+  // Destruct
+  const { label = app.get("templateKind"), name = "kind", ...rest } = props;
+
+  // Layout
+  return (
+    <SelectEx
+      label={label}
+      name={name}
+      options={app.core.getDocumentKinds()}
+      {...rest}
+    />
+  );
+}

package/src/components/document/{SystemDocumentTiplist.tsx → DocumentTiplist.tsx}

@@ -1,14 +1,14 @@
 import { Tiplist, TiplistProps } from "@etsoo/materialui";
 import { useRequiredAppContext } from "../../ICoreServiceApp";
-import { SystemDocumentListData } from "../../dto/document/SystemDocumentListData";
-import { SystemDocumentListRQ } from "../../rq/document/SystemDocumentListRQ";
+import { DocumentListData } from "../../dto/document/DocumentListData";
+import { DocumentListRQ } from "../../rq/document/DocumentListRQ";
 
 /**
- * System document tiplist properties
- * 系统文档提示列表属性
+ * Document tiplist properties
+ * 文档提示列表属性
  */
-export type SystemDocumentTiplistProps = Omit<
-  TiplistProps<SystemDocumentListData, "id">,
+export type DocumentTiplistProps = Omit<
+  TiplistProps<DocumentListData, "id">,
   "loadData" | "label" | "name"
 > & {
   /**
@@ -21,25 +21,30 @@ export type SystemDocumentTiplistProps = Omit<
    */
   name?: string;
 
+  /**
+   * Kind
+   */
+  kind: string;
+
   /**
    * Default request data
    */
-  rq?: Partial<SystemDocumentListRQ>;
+  rq?: Partial<DocumentListRQ>;
 
   /**
    * Load data handler
    * @param rq Request data
    */
-  onLoadData?: (rq: SystemDocumentListRQ) => SystemDocumentListRQ;
+  onLoadData?: (rq: DocumentListRQ) => DocumentListRQ;
 };
 
 /**
- * System document tiplist
- * 系统文档提示列表
+ * Document tiplist
+ * 文档提示列表
  * @param props Properties
  * @returns Component
  */
-export function SystemDocumentTiplist(props: SystemDocumentTiplistProps) {
+export function DocumentTiplist(props: DocumentTiplistProps) {
   // App
   const app = useRequiredAppContext();
 
@@ -50,14 +55,15 @@ export function SystemDocumentTiplist(props: SystemDocumentTiplistProps) {
     maxItems = 10,
     getOptionLabel = (data) => data.title,
     onLoadData = (rq) => rq,
-    name = "systemDocumentId",
+    name = "DocumentId",
+    kind,
     rq = { enabled: true },
     ...rest
   } = props;
 
   // Layout
   return (
-    <Tiplist<SystemDocumentListData, "id">
+    <Tiplist<DocumentListData, "id">
       label={label}
       getOptionLabel={getOptionLabel}
       name={name}
@@ -69,6 +75,7 @@ export function SystemDocumentTiplist(props: SystemDocumentTiplistProps) {
             ...rq,
             keyword,
             id,
+            kind,
             queryPaging: {
               batchSize: maxItems
             }

package/src/components/index.ts

@@ -11,7 +11,8 @@ export * from "./app/StatusList";
 export * from "./app/UserRoleList";
 
 // document
-export * from "./document/SystemDocumentTiplist";
+export * from "./document/DocumentKindList";
+export * from "./document/DocumentTiplist";
 
 // org
 export * from "./org/ButtonApiServices";

package/src/dto/document/DocumentKind.ts

@@ -0,0 +1,41 @@
+/**
+ * Template document kind, the value should not exceed 20 characters
+ * 模板文档类型，值不能超过20个字符
+ */
+export enum DocumentKind {
+  /**
+   * CMS asset check alert
+   * CMS资产检查警告
+   */
+  CMSASSETCHECKALERT = "CMSASSETCHECKALERT",
+
+  /**
+   * CMS asset expiry alert
+   * CMS资产过期警告
+   */
+  CMSASSETEXPIRYALERT = "CMSASSETEXPIRYALERT",
+
+  /**
+   * CMS customer data
+   * CMS客户数据
+   */
+  CMSCUSTOMERDATA = "CMSCUSTOMERDATA",
+
+  /**
+   * CMS order data
+   * CMS订单数据
+   */
+  CMSORDERDATA = "CMSORDERDATA",
+
+  /**
+   * CMS PO data
+   * CMS采购数据
+   */
+  CMSPODATA = "CMSPODATA",
+
+  /**
+   * CMS stock data
+   * CMS库存数据
+   */
+  CMSSTOCKDATA = "CMSSTOCKDATA"
+}

package/src/dto/document/{SystemDocumentListData.ts → DocumentListData.ts}

@@ -1,13 +1,14 @@
 /**
- * System document list data
- * 系统文档列表数据
+ * Document list data
+ * 文档列表数据
  */
-export type SystemDocumentListData = {
+export type DocumentListData = {
   /**
    * Id
    * 编号
    */
   id: number;
+
   /**
    * Title
    * 标题

package/src/dto/document/DocumentQueryData.ts

@@ -0,0 +1,35 @@
+/**
+ * Document query data
+ * 文档查询数据
+ */
+export type DocumentQueryData = {
+  /**
+   * Id
+   * 编号
+   */
+  id: number;
+
+  /**
+   * Kind
+   * 类型
+   */
+  kind: string;
+
+  /**
+   * Title
+   * 标题
+   */
+  title: string;
+
+  /**
+   * Has parameters or not
+   * 是否有参数
+   */
+  hasParameters: boolean;
+
+  /**
+   * Refresh time
+   * 刷新时间
+   */
+  refreshTime: Date | string;
+};

package/src/dto/document/{SystemDocumentViewData.ts → DocumentReadData.ts}

@@ -1,33 +1,38 @@
 /**
- * System document view data
- * 系统文档浏览数据
+ * Document read data
+ * 文档浏览数据
  */
-export type SystemDocumentViewData = {
+export type DocumentReadData = {
   /**
    * Id
    * 编号
    */
   id: number;
+
   /**
    * Kind
    * 类型
    */
   kind: string;
+
   /**
    * Title
    * 标题
    */
   title: string;
+
   /**
    * Parameters
    * 参数
    */
-  parameters?: unknown;
+  parameters?: Record<string, unknown>;
+
   /**
    * Template
    * 模板
    */
   template: string;
+
   /**
    * Refresh time
    * 刷新时间

package/src/i18n/en.json

@@ -124,6 +124,13 @@
   "target": "Target",
   "targetId": "Target id",
   "template": "Template",
+  "templateCMSASSETCHECKALERT": "CMS asset check alert",
+  "templateCMSASSETEXPIRYALERT": "CMS asset expiry alert",
+  "templateCMSCUSTOMERDATA": "CMS customer data",
+  "templateCMSORDERDATA": "CMS order data",
+  "templateCMSPODATA": "CMS PO data",
+  "templateCMSSTOCKDATA": "CMS stock data",
+  "templateKind": "Template kind",
   "years5": ["1 year", "2 years", "3 years", "4 years", "5 years"],
   "uiTypeEmail": "Email",
   "uiTypeMobile": "Mobile",

package/src/i18n/zh-Hans.json

@@ -124,6 +124,13 @@
   "target": "目标",
   "targetId": "目标编号",
   "template": "模板",
+  "templateCMSASSETCHECKALERT": "CMS资产检查警告",
+  "templateCMSASSETEXPIRYALERT": "CMS资产过期警告",
+  "templateCMSCUSTOMERDATA": "CMS客户数据",
+  "templateCMSORDERDATA": "CMS订单数据",
+  "templateCMSPODATA": "CMS采购数据",
+  "templateCMSSTOCKDATA": "CMS库存数据",
+  "templateKind": "模板类型",
   "years5": ["1年", "2年", "3年", "4年", "5年"],
   "uiTypeEmail": "电子邮箱",
   "uiTypeMobile": "手机号",

package/src/i18n/zh-Hant.json

@@ -124,6 +124,13 @@
   "target": "目標",
   "targetId": "目標編號",
   "template": "模板",
+  "templateCMSASSETCHECKALERT": "CMS資產檢查警告",
+  "templateCMSASSETEXPIRYALERT": "CMS資產過期警告",
+  "templateCMSCUSTOMERDATA": "CMS客戶數據",
+  "templateCMSORDERDATA": "CMS訂單數據",
+  "templateCMSPODATA": "CMS採購數據",
+  "templateCMSSTOCKDATA": "CMS庫存數據",
+  "templateKind": "模板類型",
   "years5": ["1年", "2年", "3年", "4年", "5年"],
   "uiTypeEmail": "電子郵件",
   "uiTypeMobile": "手機號碼",

package/src/index.ts

@@ -9,10 +9,10 @@ export * from "./dto/app/CreateApiKeyData";
 
 export * from "./dto/authCode/AuthCodeAction";
 
-export * from "./rq/document/SystemDocumentListRQ";
-
-export * from "./dto/document/SystemDocumentListData";
-export * from "./dto/document/SystemDocumentViewData";
+export * from "./dto/document/DocumentKind";
+export * from "./dto/document/DocumentListData";
+export * from "./dto/document/DocumentQueryData";
+export * from "./dto/document/DocumentReadData";
 
 export * from "./dto/member/MemberListDto";
 export * from "./dto/member/MemberQueryDto";
@@ -63,6 +63,11 @@ export * from "./rq/authCode/SendEmailRQ";
 export * from "./rq/authCode/SendSMSRQ";
 export * from "./rq/authCode/ValidateRQ";
 
+export * from "./rq/document/DocumentCreateRQ";
+export * from "./rq/document/DocumentListRQ";
+export * from "./rq/document/DocumentQueryRQ";
+export * from "./rq/document/DocumentUpdateRQ";
+
 export * from "./rq/member/MemberInviteRQ";
 export * from "./rq/member/MemberListRQ";
 export * from "./rq/member/MemberQueryRQ";

package/src/rq/document/DocumentCreateRQ.ts

@@ -0,0 +1,35 @@
+/**
+ * Document create request data
+ * 文档创建请求数据
+ */
+export type DocumentCreateRQ = {
+  /**
+   * Kind
+   * 类型
+   */
+  kind: string;
+
+  /**
+   * Title
+   * 标题
+   */
+  title: string;
+
+  /**
+   * Parameters
+   * 参数
+   */
+  parameters?: unknown;
+
+  /**
+   * Template
+   * 模板
+   */
+  template: string;
+
+  /**
+   * Cultures
+   * 语言文化
+   */
+  cultures?: string[];
+};

package/src/rq/document/DocumentListRQ.ts

@@ -0,0 +1,25 @@
+import { QueryRQ } from "@etsoo/appscript";
+
+/**
+ * Document list request data
+ * 文档列表请求数据
+ */
+export type DocumentListRQ = QueryRQ<number> & {
+  /**
+   * Kind
+   * 类型
+   */
+  kind: string;
+
+  /**
+   * Culture
+   * 语言文化
+   */
+  culture?: string;
+
+  /**
+   * System template or not
+   * 系统模板与否
+   */
+  isSystem?: boolean;
+};

package/src/rq/document/DocumentQueryRQ.ts

@@ -0,0 +1,31 @@
+import { QueryRQ } from "@etsoo/appscript";
+
+/**
+ * Document query request data
+ * 文档查询请求数据
+ */
+export type DocumentQueryRQ = QueryRQ & {
+  /**
+   * Kind
+   * 类型
+   */
+  kind?: string;
+
+  /**
+   * Culture
+   * 文化
+   */
+  culture?: string;
+
+  /**
+   * System template or not
+   * 是否为系统模板
+   */
+  isSystem?: boolean;
+
+  /**
+   * Has parameters or not
+   * 是否有参数
+   */
+  hasParameters?: boolean;
+};

package/src/rq/document/DocumentUpdateRQ.ts

@@ -0,0 +1,8 @@
+import { DataTypes } from "@etsoo/shared";
+import { DocumentCreateRQ } from "./DocumentCreateRQ";
+
+/**
+ * Document update request data
+ * 文档更新请求数据
+ */
+export type DocumentUpdateRQ = DataTypes.EditType<DocumentCreateRQ>;

package/lib/cjs/components/document/SystemDocumentTiplist.d.ts

@@ -1,33 +0,0 @@
-import { TiplistProps } from "@etsoo/materialui";
-import { SystemDocumentListData } from "../../dto/document/SystemDocumentListData";
-import { SystemDocumentListRQ } from "../../rq/document/SystemDocumentListRQ";
-/**
- * System document tiplist properties
- * 系统文档提示列表属性
- */
-export type SystemDocumentTiplistProps = Omit<TiplistProps<SystemDocumentListData, "id">, "loadData" | "label" | "name"> & {
-    /**
-     * Label
-     */
-    label?: string;
-    /**
-     * Name
-     */
-    name?: string;
-    /**
-     * Default request data
-     */
-    rq?: Partial<SystemDocumentListRQ>;
-    /**
-     * Load data handler
-     * @param rq Request data
-     */
-    onLoadData?: (rq: SystemDocumentListRQ) => SystemDocumentListRQ;
-};
-/**
- * System document tiplist
- * 系统文档提示列表
- * @param props Properties
- * @returns Component
- */
-export declare function SystemDocumentTiplist(props: SystemDocumentTiplistProps): import("react/jsx-runtime").JSX.Element;

package/lib/cjs/rq/document/SystemDocumentListRQ.d.ts

@@ -1,17 +0,0 @@
-import { QueryRQ } from "@etsoo/appscript";
-/**
- * System Document list request data
- * 系统文档列表请求数据
- */
-export type SystemDocumentListRQ = QueryRQ<number> & {
-    /**
-     * Kind
-     * 类型
-     */
-    kind?: string;
-    /**
-     * Culture
-     * 语言文化
-     */
-    culture?: string;
-};