@etsoo/smarterp-core 1.1.44 → 1.1.46

package/lib/mjs/dto/document/SystemDocumentViewData.d.ts

@@ -0,0 +1,41 @@
+/**
+ * System document view data
+ * 系统文档浏览数据
+ */
+export type SystemDocumentViewData = {
+    /**
+     * Id
+     * 编号
+     */
+    id: number;
+    /**
+     * Kind
+     * 类型
+     */
+    kind: string;
+    /**
+     * Title
+     * 标题
+     */
+    title: string;
+    /**
+     * Parameters
+     * 参数
+     */
+    parameters?: unknown;
+    /**
+     * Template
+     * 模板
+     */
+    template: string;
+    /**
+     * Refresh time
+     * 刷新时间
+     */
+    refreshTime: Date | string;
+    /**
+     * Cultures
+     * 文化
+     */
+    cultures?: string[];
+};

package/lib/mjs/dto/document/SystemDocumentViewData.js

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

package/lib/mjs/i18n/en.json

@@ -25,6 +25,7 @@
     "buy": "Buy",
     "collapseMenu": "Collapse menu",
     "collapseNavMenuAriaLabel": "Collapse navigation menu",
+    "cultures": "Cultures",
     "companyNo": "Company No.",
     "completeExecution": "Complete execution",
     "currentOrg": "Current organization",
@@ -33,11 +34,14 @@
     "days": "Days",
     "details": "Details",
     "directReports": "Direct reports",
+    "documentPreview": "Document preview",
+    "documentTemplates": "Document templates",
     "editAvatar": "Edit avatar",
     "editLogo": "Edit logo",
     "editResource": "Edit resource",
     "expandMenu": "Expand menu",
     "expandNavMenuAriaLabel": "Expand navigation menu",
+    "exportDocument": "Export document",
     "externalApis": "External APIs",
     "fileName": "File name",
     "fullName": "Full name",
@@ -75,6 +79,7 @@
     "orgPin": "Org No.",
     "orgs": "Organizations",
     "owner": "Owner",
+    "parameters": "Parameters",
     "parentOrg": "Parent org",
     "pin": "ID",
     "preferredName": "Preferred name",
@@ -114,8 +119,10 @@
     "switchToLightModeAriaLabel": "Switch to light mode",
     "switchOrg": "Switch organization",
     "subscribed": "Subscribed",
+    "systemTemplate": "System template",
     "target": "Target",
     "targetId": "Target id",
+    "template": "Template",
     "years5": ["1 year", "2 years", "3 years", "4 years", "5 years"],
     "uiTypeEmail": "Email",
     "uiTypeMobile": "Mobile",

package/lib/mjs/i18n/zh-Hans.json

@@ -25,6 +25,7 @@
     "buy": "购买",
     "collapseMenu": "折叠菜单",
     "collapseNavMenuAriaLabel": "折叠导航菜单",
+    "cultures": "语言/文化",
     "companyNo": "机构编号",
     "completeExecution": "完成执行",
     "currentOrg": "当前机构",
@@ -33,11 +34,14 @@
     "days": "天数",
     "details": "细节",
     "directReports": "直接下属",
+    "documentPreview": "文档预览",
+    "documentTemplates": "文档模板",
     "editAvatar": "修改头像",
     "editLogo": "修改图标",
     "editResource": "编辑资源",
     "expandMenu": "展开菜单",
     "expandNavMenuAriaLabel": "展开导航菜单",
+    "exportDocument": "导出文档",
     "externalApis": "外部接口",
     "fileName": "文件名",
     "fullName": "全称",
@@ -75,6 +79,7 @@
     "orgPin": "机构编号",
     "orgs": "机构",
     "owner": "所有者",
+    "parameters": "参数",
     "parentOrg": "上级机构",
     "pin": "身份证号码",
     "preferredName": "首选名称",
@@ -114,8 +119,10 @@
     "switchToLightModeAriaLabel": "切换到浅色模式",
     "switchOrg": "切换机构",
     "subscribed": "已订阅",
+    "systemTemplate": "系统模板",
     "target": "目标",
     "targetId": "目标编号",
+    "template": "模板",
     "years5": ["1年", "2年", "3年", "4年", "5年"],
     "uiTypeEmail": "电子邮箱",
     "uiTypeMobile": "手机号",

package/lib/mjs/i18n/zh-Hant.json

@@ -25,6 +25,7 @@
     "buy": "購買",
     "collapseMenu": "折疊菜單",
     "collapseNavMenuAriaLabel": "折疊導航菜單",
+    "cultures": "語言/文化",
     "companyNo": "機構編號",
     "completeExecution": "完成執行",
     "currentOrg": "當前機構",
@@ -33,11 +34,14 @@
     "days": "天數",
     "details": "細節",
     "directReports": "直接下屬",
+    "documentPreview": "文檔預覽",
+    "documentTemplates": "文檔模板",
     "editAvatar": "修改頭像",
     "editLogo": "修改圖標",
     "editResource": "編輯資源",
     "expandMenu": "展開菜單",
     "expandNavMenuAriaLabel": "展開導航菜單",
+    "exportDocument": "導出文檔",
     "externalApis": "外部接口",
     "fileName": "文件名",
     "fullName": "全稱",
@@ -75,6 +79,7 @@
     "orgPin": "機構編號",
     "orgs": "機構",
     "owner": "所有者",
+    "parameters": "參數",
     "parentOrg": "上級機構",
     "pin": "身份證號碼",
     "preferredName": "首選名稱",
@@ -114,8 +119,10 @@
     "switchToLightModeAriaLabel": "切換到淺色模式",
     "switchOrg": "切換機構",
     "subscribed": "已訂閱",
+    "systemTemplate": "系統模板",
     "target": "目標",
     "targetId": "目標編號",
+    "template": "模板",
     "years5": ["1年", "2年", "3年", "4年", "5年"],
     "uiTypeEmail": "電子郵件",
     "uiTypeMobile": "手機號碼",

package/lib/mjs/index.d.ts

@@ -6,6 +6,9 @@ export * from "./dto/app/AppReadDto";
 export * from "./dto/app/AppUpdateReadDto";
 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/member/MemberListDto";
 export * from "./dto/member/MemberQueryDto";
 export * from "./dto/member/MemberReadDto";

package/lib/mjs/index.js

@@ -7,6 +7,9 @@ export * from "./dto/app/AppReadDto";
 export * from "./dto/app/AppUpdateReadDto";
 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/member/MemberListDto";
 export * from "./dto/member/MemberQueryDto";
 export * from "./dto/member/MemberReadDto";

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

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

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

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etsoo/smarterp-core",
-  "version": "1.1.44",
+  "version": "1.1.46",
   "description": "TypeScript APIs for SmartERP Core",
   "main": "lib/cjs/index.js",
   "module": "lib/mjs/index.js",

package/src/CoreApp.ts

@@ -14,6 +14,7 @@ import {
 import { AuthCodeApi } from "./AuthCodeApi";
 import { DataTypes, ListType } from "@etsoo/shared";
 import { CoreApiService } from "./dto/org/CoreApiService";
+import { DocumentApi } from "./DocumentApi";
 
 type AppData = { id: number; appId?: number; name: string; localName?: string };
 
@@ -37,6 +38,11 @@ export interface ICoreApp {
    */
   readonly authCodeApi: AuthCodeApi;
 
+  /**
+   * Document API
+   */
+  readonly documentApi: DocumentApi;
+
   /**
    * Member API
    */
@@ -161,6 +167,15 @@ export class CoreApp implements ICoreApp {
     return (this._authCodeApi ??= new AuthCodeApi(this.app, this.api));
   }
 
+  private _documentApi?: DocumentApi;
+  /**
+   * Document API
+   * 文档接口
+   */
+  get documentApi() {
+    return (this._documentApi ??= new DocumentApi(this.app, this.api));
+  }
+
   private _memberApi?: MemberApi;
   /**
    * Member API

package/src/DocumentApi.ts

@@ -0,0 +1,41 @@
+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";
+
+/**
+ * Document API
+ */
+export class DocumentApi extends EntityApi {
+  /**
+   * Constructor
+   * @param app Application
+   * @param api API
+   */
+  constructor(app: IApp, api: IApi = app.api) {
+    super("Document", app, api);
+  }
+
+  /**
+   * List
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  list(
+    rq: SystemDocumentListRQ,
+    payload: IApiPayload<SystemDocumentListData[]>
+  ) {
+    return this.listBase(rq, payload);
+  }
+
+  /**
+   * Read
+   * @param id Id
+   * @param payload Payload
+   * @returns Result
+   */
+  read(id: number, payload?: IApiPayload<SystemDocumentViewData>) {
+    return this.readBase(id, payload);
+  }
+}

package/src/components/document/SystemDocumentTiplist.tsx

@@ -0,0 +1,82 @@
+import { Tiplist, TiplistProps } from "@etsoo/materialui";
+import { useRequiredAppContext } from "../../ICoreServiceApp";
+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 function SystemDocumentTiplist(props: SystemDocumentTiplistProps) {
+  // App
+  const app = useRequiredAppContext();
+
+  // Destruct
+  const {
+    fullWidth = true,
+    label = app.get("systemTemplate")!,
+    maxItems = 10,
+    getOptionLabel = (data) => data.title,
+    onLoadData = (rq) => rq,
+    name = "systemDocumentId",
+    rq = { enabled: true },
+    ...rest
+  } = props;
+
+  // Layout
+  return (
+    <Tiplist<SystemDocumentListData, "id">
+      label={label}
+      getOptionLabel={getOptionLabel}
+      name={name}
+      fullWidth={fullWidth}
+      maxItems={maxItems}
+      loadData={(keyword, id, maxItems) =>
+        app.core.documentApi.list(
+          onLoadData({
+            ...rq,
+            keyword,
+            id,
+            queryPaging: {
+              batchSize: maxItems
+            }
+          }),
+          { showLoading: false, defaultValue: [] }
+        )
+      }
+      {...rest}
+    />
+  );
+}

package/src/components/index.ts

@@ -10,6 +10,9 @@ export * from "./app/SearchDays";
 export * from "./app/StatusList";
 export * from "./app/UserRoleList";
 
+// document
+export * from "./document/SystemDocumentTiplist";
+
 // org
 export * from "./org/ButtonApiServices";
 export * from "./org/OrgSwitchPopover";

package/src/dto/document/SystemDocumentListData.ts

@@ -0,0 +1,16 @@
+/**
+ * System document list data
+ * 系统文档列表数据
+ */
+export type SystemDocumentListData = {
+  /**
+   * Id
+   * 编号
+   */
+  id: number;
+  /**
+   * Title
+   * 标题
+   */
+  title: string;
+};

package/src/dto/document/SystemDocumentViewData.ts

@@ -0,0 +1,42 @@
+/**
+ * System document view data
+ * 系统文档浏览数据
+ */
+export type SystemDocumentViewData = {
+  /**
+   * Id
+   * 编号
+   */
+  id: number;
+  /**
+   * Kind
+   * 类型
+   */
+  kind: string;
+  /**
+   * Title
+   * 标题
+   */
+  title: string;
+  /**
+   * Parameters
+   * 参数
+   */
+  parameters?: unknown;
+  /**
+   * Template
+   * 模板
+   */
+  template: string;
+  /**
+   * Refresh time
+   * 刷新时间
+   */
+  refreshTime: Date | string;
+
+  /**
+   * Cultures
+   * 文化
+   */
+  cultures?: string[];
+};

package/src/i18n/en.json

@@ -25,6 +25,7 @@
   "buy": "Buy",
   "collapseMenu": "Collapse menu",
   "collapseNavMenuAriaLabel": "Collapse navigation menu",
+  "cultures": "Cultures",
   "companyNo": "Company No.",
   "completeExecution": "Complete execution",
   "currentOrg": "Current organization",
@@ -33,11 +34,14 @@
   "days": "Days",
   "details": "Details",
   "directReports": "Direct reports",
+  "documentPreview": "Document preview",
+  "documentTemplates": "Document templates",
   "editAvatar": "Edit avatar",
   "editLogo": "Edit logo",
   "editResource": "Edit resource",
   "expandMenu": "Expand menu",
   "expandNavMenuAriaLabel": "Expand navigation menu",
+  "exportDocument": "Export document",
   "externalApis": "External APIs",
   "fileName": "File name",
   "fullName": "Full name",
@@ -75,6 +79,7 @@
   "orgPin": "Org No.",
   "orgs": "Organizations",
   "owner": "Owner",
+  "parameters": "Parameters",
   "parentOrg": "Parent org",
   "pin": "ID",
   "preferredName": "Preferred name",
@@ -114,8 +119,10 @@
   "switchToLightModeAriaLabel": "Switch to light mode",
   "switchOrg": "Switch organization",
   "subscribed": "Subscribed",
+  "systemTemplate": "System template",
   "target": "Target",
   "targetId": "Target id",
+  "template": "Template",
   "years5": ["1 year", "2 years", "3 years", "4 years", "5 years"],
   "uiTypeEmail": "Email",
   "uiTypeMobile": "Mobile",

package/src/i18n/zh-Hans.json

@@ -25,6 +25,7 @@
   "buy": "购买",
   "collapseMenu": "折叠菜单",
   "collapseNavMenuAriaLabel": "折叠导航菜单",
+  "cultures": "语言/文化",
   "companyNo": "机构编号",
   "completeExecution": "完成执行",
   "currentOrg": "当前机构",
@@ -33,11 +34,14 @@
   "days": "天数",
   "details": "细节",
   "directReports": "直接下属",
+  "documentPreview": "文档预览",
+  "documentTemplates": "文档模板",
   "editAvatar": "修改头像",
   "editLogo": "修改图标",
   "editResource": "编辑资源",
   "expandMenu": "展开菜单",
   "expandNavMenuAriaLabel": "展开导航菜单",
+  "exportDocument": "导出文档",
   "externalApis": "外部接口",
   "fileName": "文件名",
   "fullName": "全称",
@@ -75,6 +79,7 @@
   "orgPin": "机构编号",
   "orgs": "机构",
   "owner": "所有者",
+  "parameters": "参数",
   "parentOrg": "上级机构",
   "pin": "身份证号码",
   "preferredName": "首选名称",
@@ -114,8 +119,10 @@
   "switchToLightModeAriaLabel": "切换到浅色模式",
   "switchOrg": "切换机构",
   "subscribed": "已订阅",
+  "systemTemplate": "系统模板",
   "target": "目标",
   "targetId": "目标编号",
+  "template": "模板",
   "years5": ["1年", "2年", "3年", "4年", "5年"],
   "uiTypeEmail": "电子邮箱",
   "uiTypeMobile": "手机号",

package/src/i18n/zh-Hant.json

@@ -25,6 +25,7 @@
   "buy": "購買",
   "collapseMenu": "折疊菜單",
   "collapseNavMenuAriaLabel": "折疊導航菜單",
+  "cultures": "語言/文化",
   "companyNo": "機構編號",
   "completeExecution": "完成執行",
   "currentOrg": "當前機構",
@@ -33,11 +34,14 @@
   "days": "天數",
   "details": "細節",
   "directReports": "直接下屬",
+  "documentPreview": "文檔預覽",
+  "documentTemplates": "文檔模板",
   "editAvatar": "修改頭像",
   "editLogo": "修改圖標",
   "editResource": "編輯資源",
   "expandMenu": "展開菜單",
   "expandNavMenuAriaLabel": "展開導航菜單",
+  "exportDocument": "導出文檔",
   "externalApis": "外部接口",
   "fileName": "文件名",
   "fullName": "全稱",
@@ -75,6 +79,7 @@
   "orgPin": "機構編號",
   "orgs": "機構",
   "owner": "所有者",
+  "parameters": "參數",
   "parentOrg": "上級機構",
   "pin": "身份證號碼",
   "preferredName": "首選名稱",
@@ -114,8 +119,10 @@
   "switchToLightModeAriaLabel": "切換到淺色模式",
   "switchOrg": "切換機構",
   "subscribed": "已訂閱",
+  "systemTemplate": "系統模板",
   "target": "目標",
   "targetId": "目標編號",
+  "template": "模板",
   "years5": ["1年", "2年", "3年", "4年", "5年"],
   "uiTypeEmail": "電子郵件",
   "uiTypeMobile": "手機號碼",

package/src/index.ts

@@ -9,6 +9,11 @@ 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/member/MemberListDto";
 export * from "./dto/member/MemberQueryDto";
 export * from "./dto/member/MemberReadDto";

package/src/rq/document/SystemDocumentListRQ.ts

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