@etsoo/smarterp-core 1.0.0

package/src/dto/org/OrgQueryDto.ts

@@ -0,0 +1,47 @@
+import { EntityStatus } from "@etsoo/appscript";
+
+/**
+ * Organization query data
+ * 机构查询数据
+ */
+export type OrgQueryDto = {
+  /**
+   * Id
+   */
+  id: number;
+
+  /**
+   * Name
+   */
+  name: string;
+
+  /**
+   * Current user is the owner of the organization
+   */
+  isOwner: boolean;
+
+  /**
+   * Brand
+   */
+  brand?: string;
+
+  /**
+   * Identifier (Tax number)
+   */
+  pin?: string;
+
+  /**
+   * Parent Id
+   */
+  parentId?: number;
+
+  /**
+   * Status
+   */
+  status: EntityStatus;
+
+  /**
+   * Creation
+   */
+  creation: Date | string;
+};

package/src/dto/org/OrgReadDto.ts

@@ -0,0 +1,57 @@
+import { EntityStatus } from "@etsoo/appscript";
+
+/**
+ * Organization read for view data
+ * 机构查看数据
+ */
+export type OrgReadDto = {
+  /**
+   * Id
+   */
+  id: number;
+
+  /**
+   * Owner name
+   */
+  ownerName: string;
+
+  /**
+   * Name
+   */
+  name: string;
+
+  /**
+   * Brand
+   */
+  brand?: string;
+
+  /**
+   * Logo
+   */
+  logo?: string;
+
+  /**
+   * PIN
+   */
+  pin?: string;
+
+  /**
+   * Parent name
+   */
+  parentName?: string;
+
+  /**
+   * Creation
+   */
+  creation: string | Date;
+
+  /**
+   * Status
+   */
+  status: EntityStatus;
+
+  /**
+   * Query Keyword
+   */
+  queryKeyword?: string;
+};

package/src/dto/org/OrgUpdateReadDto.ts

@@ -0,0 +1,47 @@
+import { EntityStatus } from "@etsoo/appscript";
+
+/**
+ * Organization read for update data
+ * 机构更新数据
+ */
+export type OrgUpdateReadDto = {
+  /**
+   * Id
+   */
+  id: number;
+
+  /**
+   * Name
+   */
+  name: string;
+
+  /**
+   * Brand
+   */
+  brand?: string;
+
+  /**
+   * Logo
+   */
+  logo?: string;
+
+  /**
+   * PIN
+   */
+  pin?: string;
+
+  /**
+   * Parent Id
+   */
+  parentId?: number;
+
+  /**
+   * Status
+   */
+  status: EntityStatus;
+
+  /**
+   * Query Keyword
+   */
+  queryKeyword?: string;
+};

package/src/dto/public/CurrencyItem.ts

@@ -0,0 +1,35 @@
+/**
+ * Currency item
+ * 货币项目
+ */
+export type CurrencyItem = {
+  /**
+   * Id, like CNY
+   * 编号，如CNY
+   */
+  id: string;
+
+  /**
+   * Name, like Chinese Yuan
+   * 名称，如人民币
+   */
+  name: string;
+
+  /**
+   * Native name, like 人民币
+   * 原生名
+   */
+  nativeName: string;
+
+  /**
+   * English name, like Chinese Yuan
+   * 英文名
+   */
+  englishName: string;
+
+  /**
+   * Symbol, like ¥
+   * 货币符号
+   */
+  symbol: string;
+};

package/src/dto/public/PlaceCommon.ts

@@ -0,0 +1,52 @@
+import { PlaceLocation } from "./PlaceLocation";
+
+/**
+ * Common place
+ * 通用地点
+ */
+export type PlaceCommon = {
+  /**
+   * Place id, 地点编号
+   */
+  placeId: string;
+
+  /**
+   * Place name, 地名
+   */
+  name: string;
+
+  /**
+   * Formatted address, 格式化地址
+   */
+  formattedAddress: string;
+
+  /**
+   * Location, 位置
+   */
+  location?: PlaceLocation;
+
+  /**
+   * Region, 地区
+   */
+  region?: string;
+
+  /**
+   * State, 州省
+   */
+  state?: string;
+
+  /**
+   * City, 城市
+   */
+  city?: string;
+
+  /**
+   * District, 区县
+   */
+  district?: string;
+
+  /**
+   * Postcode, 邮政编码
+   */
+  postcode?: string;
+};

package/src/dto/public/PlaceLocation.ts

@@ -0,0 +1,15 @@
+/**
+ * Place location
+ * 地点位置
+ */
+export type PlaceLocation = {
+  /**
+   * Latitude, 纬度
+   */
+  Lat: number;
+
+  /**
+   * Longitude, 经度
+   */
+  Lng: number;
+};

package/src/dto/public/RegionData.ts

@@ -0,0 +1,41 @@
+/**
+ * Region data
+ * 区域数据
+ */
+export type RegionData = {
+  /**
+   * Id, like CN
+   * 编号，如CN
+   */
+  id: string;
+
+  /**
+   * Id with 3 characters, like CHN
+   * 3字符编号
+   */
+  id3: string;
+
+  /**
+   * Name, like China
+   * 名称，如中国
+   */
+  name: string;
+
+  /**
+   * English name, like China
+   * 英文名
+   */
+  englishName: string;
+
+  /**
+   * Currency id
+   * 货币编号
+   */
+  currency: string;
+
+  /**
+   * Cultures supported
+   * 支持的文化
+   */
+  cultures: string[];
+};

package/src/dto/user/AuditHistoryDto.ts

@@ -0,0 +1,30 @@
+/**
+ * User audit history
+ * 用户操作历史数据
+ */
+export type AuditHistoryDto = {
+  /**
+   * Id
+   */
+  id: number;
+
+  /**
+   * Title
+   */
+  title: string;
+
+  /**
+   * Device name
+   */
+  deviceName: string;
+
+  /**
+   * JSON data
+   */
+  data?: string;
+
+  /**
+   * Creation
+   */
+  creation: Date | string;
+};

package/src/dto/user/DeviceListDto.ts

@@ -0,0 +1,8 @@
+/**
+ * Device list data
+ * 设备列表数据
+ */
+export type DeviceListDto = {
+  id: number;
+  name: string;
+};

package/src/i18n/CoreCulture.ts

@@ -0,0 +1,84 @@
+import { Culture, IApp } from "@etsoo/appscript";
+
+/**
+ * Core culture
+ */
+export namespace CoreCulture {
+  /**
+   * Get en neutral culture
+   * @param localResources Local resources
+   * @returns Full culture
+   */
+  export const en = (...resources: (object | (() => Promise<object>))[]) =>
+    Culture.en(import("./en.json"), ...resources);
+
+  /**
+   * Get zh-Hans neutral cultrue
+   * @param localResources Local resources
+   * @returns Full culture
+   */
+  export const zhHans = (...resources: (object | (() => Promise<object>))[]) =>
+    Culture.zhHans(import("./zh-Hans.json"), ...resources);
+
+  /**
+   * Get zh-Hant neutral cultrue
+   * @param localResources Local resources
+   * @returns Full culture
+   */
+  export const zhHant = (...resources: (object | (() => Promise<object>))[]) =>
+    Culture.zhHant(import("./zh-Hant.json"), ...resources);
+
+  /**
+   * Get the toolpad locale
+   * @param app Current app
+   * @returns Result
+   */
+  export const getToolpadLocale = (app: IApp) => {
+    // Labels
+    const {
+      accountIconButtonAriaLabel,
+      collapseMenu: collapseMenuTitle,
+      collapseNavMenuAriaLabel,
+      darkMode: darkModeTitle,
+      expandMenu: expandMenuTitle,
+      expandNavMenuAriaLabel,
+      lightMode: lightModeTitle,
+      signin: signInLabel,
+      signout: signOutLabel,
+      switchMode: switchModeTitle,
+      switchThemeModeAriaLabel,
+      switchToDarkModeAriaLabel,
+      switchToLightModeAriaLabel
+    } = app.getLabels(
+      "accountIconButtonAriaLabel",
+      "collapseMenu",
+      "collapseNavMenuAriaLabel",
+      "darkMode",
+      "expandMenu",
+      "expandNavMenuAriaLabel",
+      "lightMode",
+      "signin",
+      "signout",
+      "switchMode",
+      "switchThemeModeAriaLabel",
+      "switchToDarkModeAriaLabel",
+      "switchToLightModeAriaLabel"
+    );
+
+    return {
+      accountIconButtonAriaLabel,
+      collapseMenuTitle,
+      collapseNavMenuAriaLabel,
+      darkModeTitle,
+      expandMenuTitle,
+      expandNavMenuAriaLabel,
+      lightModeTitle,
+      signInLabel,
+      signOutLabel,
+      switchModeTitle,
+      switchThemeModeAriaLabel,
+      switchToDarkModeAriaLabel,
+      switchToLightModeAriaLabel
+    };
+  };
+}

package/src/i18n/en.json

@@ -0,0 +1,40 @@
+{
+  "accountIconButtonAriaLabel": "Current user",
+  "app1": "Admin Center",
+  "app2": "O&M System",
+  "app3": "Business Mgt.",
+  "app4": "Finance System",
+  "app5": "Progress Mgt.",
+  "brand": "Brand",
+  "collapseMenu": "Collapse menu",
+  "collapseNavMenuAriaLabel": "Collapse navigation menu",
+  "companyNo": "Company No.",
+  "currentOrg": "Current organization",
+  "darkMode": "Dark mode",
+  "expandMenu": "Expand menu",
+  "expandNavMenuAriaLabel": "Expand navigation menu",
+  "lightMode": "Light mode",
+  "orgName": "Org name",
+  "parentOrg": "Parent org",
+  "role": "Role",
+  "roleAdmin": "Admin",
+  "roleCashier": "Cashier",
+  "roleFinance": "Finance",
+  "roleFounder": "Founder",
+  "roleGuest": "Guest",
+  "roleHRManager": "HR Manager",
+  "roleManager": "Manager",
+  "roleOperator": "Operator",
+  "roleOutsourcing": "Outsourcing",
+  "rolePartner": "Channel Partner",
+  "roleUser": "User",
+  "smarterp": "SmartERP Cloud",
+  "signin": "Sign in",
+  "signout": "Sign out",
+  "signoutSuccess": "Logout successful, please close the current window",
+  "switchMode": "Switch mode",
+  "switchThemeModeAriaLabel": "Switch theme mode",
+  "switchToDarkModeAriaLabel": "Switch to dark mode",
+  "switchToLightModeAriaLabel": "Switch to light mode",
+  "switchOrg": "Switch organization"
+}

package/src/i18n/zh-Hans.json

@@ -0,0 +1,40 @@
+{
+  "accountIconButtonAriaLabel": "当前用户",
+  "app1": "管理中心",
+  "app2": "运维中心",
+  "app3": "业务管理",
+  "app4": "财务系统",
+  "app5": "进度管理",
+  "brand": "品牌",
+  "collapseMenu": "折叠菜单",
+  "collapseNavMenuAriaLabel": "折叠导航菜单",
+  "companyNo": "机构编号",
+  "currentOrg": "当前机构",
+  "darkMode": "深色模式",
+  "expandMenu": "展开菜单",
+  "expandNavMenuAriaLabel": "展开导航菜单",
+  "lightMode": "浅色模式",
+  "orgName": "机构名称",
+  "parentOrg": "上级机构",
+  "role": "角色",
+  "roleAdmin": "管理员",
+  "roleCashier": "出纳员",
+  "roleFinance": "财务经理",
+  "roleFounder": "创始人",
+  "roleGuest": "访客",
+  "roleHRManager": "人事经理",
+  "roleManager": "经理",
+  "roleOperator": "操作员",
+  "roleOutsourcing": "外包",
+  "rolePartner": "渠道伙伴",
+  "roleUser": "用户",
+  "smarterp": "司友®云ERP",
+  "signin": "登录",
+  "signout": "退出",
+  "signoutSuccess": "退出成功，请关闭当前窗口",
+  "switchMode": "切换模式",
+  "switchThemeModeAriaLabel": "切换主题模式",
+  "switchToDarkModeAriaLabel": "切换到深色模式",
+  "switchToLightModeAriaLabel": "切换到浅色模式",
+  "switchOrg": "切换机构"
+}

package/src/i18n/zh-Hant.json

@@ -0,0 +1,40 @@
+{
+  "accountIconButtonAriaLabel": "當前用戶",
+  "app1": "管理中心",
+  "app2": "運維中心",
+  "app3": "業務管理",
+  "app4": "財務系統",
+  "app5": "進度管理",
+  "brand": "品牌",
+  "collapseMenu": "折疊菜單",
+  "collapseNavMenuAriaLabel": "折疊導航菜單",
+  "companyNo": "機構編號",
+  "currentOrg": "當前機構",
+  "darkMode": "深色模式",
+  "expandMenu": "展開菜單",
+  "expandNavMenuAriaLabel": "展開導航菜單",
+  "lightMode": "淺色模式",
+  "orgName": "機構名稱",
+  "parentOrg": "上級機構",
+  "role": "角色",
+  "roleAdmin": "管理員",
+  "roleCashier": "出納員",
+  "roleFinance": "財務經理",
+  "roleFounder": "創始人",
+  "roleGuest": "訪客",
+  "roleHRManager": "人事經理",
+  "roleManager": "經理",
+  "roleOperator": "操作員",
+  "roleOutsourcing": "外包",
+  "rolePartner": "渠道夥伴",
+  "roleUser": "用戶",
+  "signin": "登入",
+  "signout": "登出",
+  "smarterp": "司友®雲ERP",
+  "signoutSuccess": "登出成功，請關閉目前視窗",
+  "switchMode": "切換模式",
+  "switchThemeModeAriaLabel": "切換主題模式",
+  "switchToDarkModeAriaLabel": "切換到深色模式",
+  "switchToLightModeAriaLabel": "切換到淺色模式",
+  "switchOrg": "切換機構"
+}

package/src/index.ts

@@ -0,0 +1,54 @@
+// DTO
+export * from "./dto/app/AppData";
+export * from "./dto/app/AppListDto";
+export * from "./dto/app/AppPurchasedQueryData";
+export * from "./dto/app/AppQueryData";
+
+export * from "./dto/member/MemberListDto";
+export * from "./dto/member/MemberQueryDto";
+
+export * from "./dto/org/OrgGetMyData";
+export * from "./dto/org/OrgListDto";
+export * from "./dto/org/OrgQueryDto";
+export * from "./dto/org/OrgReadDto";
+export * from "./dto/org/OrgUpdateReadDto";
+
+export * from "./dto/public/CurrencyItem";
+export * from "./dto/public/PlaceCommon";
+export * from "./dto/public/PlaceLocation";
+export * from "./dto/public/RegionData";
+
+export * from "./dto/user/AuditHistoryDto";
+export * from "./dto/user/DeviceListDto";
+
+// i18n
+export * from "./i18n/CoreCulture";
+
+// RQ
+export * from "./rq/app/AppGetMyRQ";
+export * from "./rq/app/AppListRQ";
+export * from "./rq/app/AppPurchasedQueryRQ";
+export * from "./rq/app/AppQueryRQ";
+
+export * from "./rq/member/MemberListRQ";
+export * from "./rq/member/MemberQueryRQ";
+
+export * from "./rq/org/OrgCreateRQ";
+export * from "./rq/org/OrgGetMyRQ";
+export * from "./rq/org/OrgListRQ";
+export * from "./rq/org/OrgQueryRQ";
+export * from "./rq/org/OrgUpdateRQ";
+
+export * from "./rq/public/CreateBarcodeRQ";
+export * from "./rq/public/PinyinRQ";
+export * from "./rq/public/PlaceQueryRQ";
+
+export * from "./rq/user/AuditHistoryRQ";
+
+// APIs
+export * from "./AppApi";
+export * from "./CoreApp";
+export * from "./MemberApi";
+export * from "./OrgApi";
+export * from "./PublicApi";
+export * from "./UserApi";

package/src/rq/app/AppGetMyRQ.ts

@@ -0,0 +1,21 @@
+import { IdentityType } from "../../dto/IdentityType";
+
+/**
+ * Get user's latest accessed applications request data
+ * 获取用户最近访问的应用请求数据
+ */
+export type AppGetMyRQ = {
+  /**
+   * Maximum items
+   * 最大项数
+   * @default 10
+   */
+  maxItems?: number;
+
+  /**
+   * Identity type
+   * 身份类型
+   * @default IdentityType.User
+   */
+  identityType?: IdentityType;
+};

package/src/rq/app/AppListRQ.ts

@@ -0,0 +1,20 @@
+import { QueryRQ } from "@etsoo/appscript";
+import { IdentityType } from "../../dto/IdentityType";
+
+/**
+ * Application list request data
+ * 应用列表请求数据
+ */
+export type AppListRQ = QueryRQ & {
+  /**
+   * Identity type
+   * 身份类型
+   */
+  identityType?: IdentityType;
+
+  /**
+   * Require local URL or not
+   * 是否需要本地地址
+   */
+  requireLocalUrl?: boolean;
+};

package/src/rq/app/AppPurchasedQueryRQ.ts

@@ -0,0 +1,19 @@
+import { AppListRQ } from "./AppListRQ";
+
+/**
+ * Application purchased query request data
+ * 应用已购买查询请求数据
+ */
+export type AppPurchasedQueryRQ = AppListRQ & {
+  /**
+   * Expiry date
+   * 过期日期
+   */
+  expiry?: Date | string;
+
+  /**
+   * Expiry days
+   * 过期天数
+   */
+  expiryDays?: number;
+};

package/src/rq/app/AppQueryRQ.ts

@@ -0,0 +1,7 @@
+import { AppListRQ } from "./AppListRQ";
+
+/**
+ * Application query request data
+ * 应用查询请求数据
+ */
+export type AppQueryRQ = AppListRQ & {};

package/src/rq/member/MemberListRQ.ts

@@ -0,0 +1,21 @@
+import { StatusQueryRQ, UserRole } from "@etsoo/appscript";
+
+/**
+ * Member list request data
+ */
+export type MemberListRQ = StatusQueryRQ & {
+  /**
+   * Exclude self user or not
+   */
+  excludeSelf?: boolean;
+
+  /**
+   * User role
+   */
+  userRole?: UserRole;
+
+  /**
+   * User role start
+   */
+  userRoleStart?: UserRole;
+};