@etsoo/smarterp-crm 1.0.0

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

@@ -0,0 +1,74 @@
+{
+    "assets": "資產",
+    "contacts": "聯絡人",
+    "cultures": "語言/文化",
+    "currencies": "貨幣",
+    "customers": "客戶",
+    "degreeBachelor": "學士",
+    "degreeDoctor": "博士",
+    "degreeMaster": "碩士",
+    "degreePreBachelor": "副學士",
+    "educationHighSchool": "高中",
+    "educationHighSchool1": "高中1年級",
+    "educationHighSchool2": "高中2年級",
+    "educationHighSchool3": "高中3年級",
+    "educationMiddleSchool": "初中",
+    "educationMiddleSchool1": "初中1年級",
+    "educationMiddleSchool2": "初中2年級",
+    "educationMiddleSchool3": "初中3年級",
+    "educationPrimarySchool": "小學",
+    "educationPrimarySchool2": "小學2年級",
+    "educationPrimarySchool3": "小學3年級",
+    "educationPrimarySchool4": "小學4年級",
+    "educationPrimarySchool5": "小學5年級",
+    "educationPrimarySchool6": "小學6年級",
+    "educationUniversity10": "大學本科畢業且獲得學士學位",
+    "educationUniversity12": "研究生畢業（無學位證書）",
+    "educationUniversity14": "碩士學位畢業",
+    "educationUniversity2": "大專畢業",
+    "educationUniversity4": "五大學歷畢業（自考、電大、夜大、黨校、函授）",
+    "educationUniversity6": "大學在讀",
+    "educationUniversity8": "大學本科畢業（無學士學位）",
+    "employees": "員工",
+    "idUser": "用戶",
+    "isLegalPerson": "是否企業",
+    "isOrg": "是否本機構",
+    "jobTitle": "職位",
+    "latinName": "拼音名",
+    "maritalDivorced": "離異",
+    "maritalMarried": "已婚",
+    "maritalPartnership": "同居伴侶",
+    "maritalSeparated": "分居",
+    "maritalSingle": "未婚",
+    "maritalWidowed": "喪偶",
+    "offerings": "產品和服務",
+    "orders": "訂單",
+    "personBirthday": "生日",
+    "personDegree": "學位",
+    "personEducation": "學歷",
+    "personEthnicity": "民族",
+    "personFemale": "女",
+    "personGender": "性別",
+    "personMale": "男",
+    "personMaritalStatus": "婚姻狀況",
+    "personName": "名稱 / 姓名",
+    "personTitle": "稱謂",
+    "personTitleDR": "博士",
+    "personTitleMR": "先生",
+    "personTitleMRS": "夫人",
+    "personTitleMS": "女士",
+    "personTitleMiss": "小姐",
+    "personTitleProf": "教授",
+    "personHeight": "身高 (厘米)",
+    "personWeight": "體重 (公斤)",
+    "politicalStatus": "政治面貌",
+    "profiles": "檔案",
+    "products": "產品",
+    "purchases": "採購",
+    "regions": "國家或地區",
+    "reports": "報表",
+    "stockIn": "入庫",
+    "stockOut": "出庫",
+    "system": "系統",
+    "suppliers": "供應商"
+}

package/lib/mjs/index.d.ts

@@ -0,0 +1,20 @@
+export * from "./dto/person/AddressItem";
+export * from "./dto/person/CategoryItem";
+export * from "./dto/person/ContactItem";
+export * from "./dto/person/PersonListDto";
+export * from "./dto/person/PersonQueryData";
+export * from "./dto/person/PersonReadDto";
+export * from "./rq/person/PersonListRQ";
+export * from "./rq/person/PersonQueryRQ";
+export * from "./dto/personProfile/PersonProfileKind";
+export * from "./dto/personProfile/PersonProfileListData";
+export * from "./dto/personProfile/PersonProfileQueryData";
+export * from "./dto/personProfile/PersonProfileUpdateReadData";
+export * from "./dto/personProfile/PersonProfileViewData";
+export * from "./rq/personProfile/PersonProfileCreateRQ";
+export * from "./rq/personProfile/PersonProfileListRQ";
+export * from "./rq/personProfile/PersonProfileQueryRQ";
+export * from "./i18n/CrmCulture";
+export * from "./PersonApi";
+export * from "./PersonProfileApi";
+export * from "./CrmApp";

package/lib/mjs/index.js

@@ -0,0 +1,24 @@
+// Person
+export * from "./dto/person/AddressItem";
+export * from "./dto/person/CategoryItem";
+export * from "./dto/person/ContactItem";
+export * from "./dto/person/PersonListDto";
+export * from "./dto/person/PersonQueryData";
+export * from "./dto/person/PersonReadDto";
+export * from "./rq/person/PersonListRQ";
+export * from "./rq/person/PersonQueryRQ";
+// PersonProfile
+export * from "./dto/personProfile/PersonProfileKind";
+export * from "./dto/personProfile/PersonProfileListData";
+export * from "./dto/personProfile/PersonProfileQueryData";
+export * from "./dto/personProfile/PersonProfileUpdateReadData";
+export * from "./dto/personProfile/PersonProfileViewData";
+export * from "./rq/personProfile/PersonProfileCreateRQ";
+export * from "./rq/personProfile/PersonProfileListRQ";
+export * from "./rq/personProfile/PersonProfileQueryRQ";
+// i18n
+export * from "./i18n/CrmCulture";
+// APIs
+export * from "./PersonApi";
+export * from "./PersonProfileApi";
+export * from "./CrmApp";

package/lib/mjs/rq/person/PersonListRQ.d.ts

@@ -0,0 +1,6 @@
+import { QueryRQ } from "@etsoo/appscript";
+/**
+ * Person list request data
+ * 成员列表请求数据
+ */
+export type PersonListRQ = QueryRQ & {};

package/lib/mjs/rq/person/PersonListRQ.js

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

package/lib/mjs/rq/person/PersonQueryRQ.d.ts

@@ -0,0 +1,6 @@
+import { PersonListRQ } from "./PersonListRQ";
+/**
+ * Person query request data
+ * 成员查询请求数据
+ */
+export type PersonQueryRQ = PersonListRQ & {};

package/lib/mjs/rq/person/PersonQueryRQ.js

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

package/lib/mjs/rq/personProfile/PersonProfileCreateRQ.d.ts

@@ -0,0 +1,73 @@
+import { EntityStatus, UserRole } from "@etsoo/appscript";
+import { PersonProfileKind } from "../../dto/personProfile/PersonProfileKind";
+/**
+ * Person profile create request data
+ * 人员档案创建请求数据
+ */
+export type PersonProfileCreateRQ = {
+    /**
+     * Person id
+     * 人员编号
+     */
+    personId: number;
+    /**
+     * Other participants
+     * 其他参与者
+     */
+    persons?: number[];
+    /**
+     * Order / purchase id
+     * 订单 / 采购编号
+     */
+    orderId?: number;
+    /**
+     * Kind
+     * 类型
+     */
+    kind: PersonProfileKind;
+    /**
+     * Title
+     * 标题
+     */
+    title: string;
+    /**
+     * Comment
+     * 评论
+     */
+    comment: string;
+    /**
+     * Location
+     * 位置
+     */
+    location?: string;
+    /**
+     * Location id
+     * 位置编号
+     */
+    locationId?: number;
+    /**
+     * Happen date
+     * 发生日期
+     */
+    happenDate?: string;
+    /**
+     * Happen date end
+     * 发生日期结束
+     */
+    happenDateEnd?: string;
+    /**
+     * User role for privacy
+     * 控制隐私的用户角色
+     */
+    userRole?: UserRole;
+    /**
+     * JSON data
+     * JSON 数据
+     */
+    data?: string;
+    /**
+     * Status
+     * 状况
+     */
+    status: EntityStatus;
+};

package/lib/mjs/rq/personProfile/PersonProfileCreateRQ.js

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

package/lib/mjs/rq/personProfile/PersonProfileListRQ.d.ts

@@ -0,0 +1,48 @@
+import { QueryRQ } from "@etsoo/appscript";
+import { PersonProfileKind } from "../../dto/personProfile/PersonProfileKind";
+/**
+ * Person profile list request data
+ * 人员档案列表请求数据
+ */
+export type PersonProfileListRQ = QueryRQ & {
+    /**
+     * Core user id who created the profile
+     * 创建档案的核心用户id
+     */
+    coreUserId?: number;
+    /**
+     * Person id
+     * 人员编号
+     */
+    personId?: number;
+    /**
+     * Kind
+     * 类型
+     */
+    kind?: PersonProfileKind;
+    /**
+     * Order / PO id
+     * 订单 / 采购编号
+     */
+    orderId?: number;
+    /**
+     * Happen date start
+     * 发生日期开始
+     */
+    happenDateStart?: string | Date;
+    /**
+     * Happen date end
+     * 发生日期结束
+     */
+    happenDateEnd?: string | Date;
+    /**
+     * Creation start
+     * 登记日期开始
+     */
+    creationStart?: string | Date;
+    /**
+     * Creation end
+     * 登记日期结束
+     */
+    creationEnd?: string | Date;
+};

package/lib/mjs/rq/personProfile/PersonProfileListRQ.js

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

package/lib/mjs/rq/personProfile/PersonProfileQueryRQ.d.ts

@@ -0,0 +1,12 @@
+import { PersonProfileListRQ } from "./PersonProfileListRQ";
+/**
+ * Person profile query request data
+ * 人员档案查询请求数据
+ */
+export type PersonProfileQueryRQ = PersonProfileListRQ & {
+    /**
+     * Location
+     * 地点
+     */
+    location?: string;
+};

package/lib/mjs/rq/personProfile/PersonProfileQueryRQ.js

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

package/package.json

@@ -0,0 +1,64 @@
+{
+  "name": "@etsoo/smarterp-crm",
+  "version": "1.0.0",
+  "description": "TypeScript APIs for SmartERP Customer Relationship Management (CRM)",
+  "main": "lib/cjs/index.js",
+  "module": "lib/mjs/index.js",
+  "exports": {
+    ".": {
+      "types": "./lib/mjs/index.d.ts",
+      "import": "./lib/mjs/index.js",
+      "require": "./lib/cjs/index.js"
+    },
+    "./components": {
+      "types": "./lib/mjs/components/index.d.ts",
+      "import": "./lib/mjs/components/index.js",
+      "require": "./lib/cjs/components/index.js"
+    }
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json",
+    "test": "vitest",
+    "localtest": "set NODE_ENV=local&&vitest"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ETSOO/etsoo-smarterp-crm.git"
+  },
+  "keywords": [
+    "TypeScript",
+    "ETSOO",
+    "SmartERP",
+    "SmartERP Core APIs",
+    "青岛亿速思维",
+    "上海亿商",
+    "司友云平台",
+    "司友云平台核心接口"
+  ],
+  "author": "ETSOO",
+  "license": "MIT",
+  "homepage": "https://github.com/ETSOO/etsoo-smarterp-crm#readme",
+  "devDependencies": {
+    "@babel/cli": "^7.26.4",
+    "@babel/core": "^7.26.10",
+    "@babel/plugin-transform-runtime": "^7.26.10",
+    "@babel/preset-env": "^7.26.9",
+    "@babel/runtime-corejs3": "^7.26.10",
+    "@types/react": "^18.3.19",
+    "@types/react-dom": "^18.3.1",
+    "@vitejs/plugin-react": "^4.3.4",
+    "jsdom": "^26.0.0",
+    "typescript": "^5.8.2",
+    "vitest": "^3.0.9"
+  },
+  "dependencies": {
+    "@etsoo/appscript": "^1.6.19",
+    "@etsoo/materialui": "^1.5.2",
+    "@etsoo/react": "^1.8.33",
+    "@etsoo/shared": "^1.2.63",
+    "@mui/material": "^6.4.8",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
+  }
+}

package/src/CrmApp.ts

@@ -0,0 +1,270 @@
+import { IApi, IApp, IdentityType } from "@etsoo/appscript";
+import { PersonApi } from "./PersonApi";
+import { useRequiredContext } from "@etsoo/react";
+import { IServiceApp, ReactAppContext } from "@etsoo/materialui";
+import { IdentityTypeData } from "./dto/person/ContactItem";
+import { PersonTitle } from "./dto/person/PersonTitle";
+import { ListType } from "@etsoo/shared";
+import { MaritalStatus } from "./dto/person/MaritalStatus";
+import { PersonDegree } from "./dto/person/PersonDegree";
+import { PersonEducation } from "./dto/person/PersonEducation";
+import { PersonProfileApi } from "./PersonProfileApi";
+
+/**
+ * Get CRM app context hook
+ * @returns CRM app
+ */
+export function useRequiredCrmContext(): ICrmApp {
+  // Get the app context
+  const app = useRequiredContext(ReactAppContext) as ICrmServiceApp;
+
+  // Check the app type
+  if ("crm" in app) {
+    return app.crm;
+  } else {
+    return app;
+  }
+}
+
+/**
+ * CRM service app interface
+ * CRM 服务应用程序接口
+ */
+export type ICrmServiceApp = IServiceApp & (ICrmApp | { crm: ICrmApp });
+
+/**
+ * CRM application interface
+ * CRM应用程序接口
+ */
+export interface ICrmApp {
+  /**
+   * Application
+   * 应用程序
+   */
+  get app(): IApp;
+
+  /**
+   * Person API
+   * 人员接口
+   */
+  readonly personApi: PersonApi;
+
+  /**
+   * Person profile API
+   * 人员档案接口
+   */
+  readonly personProfileApi: PersonProfileApi;
+
+  /**
+   * Get marital status
+   * 获取婚姻状况
+   * @param status
+   */
+  getMaritalStatus(status?: MaritalStatus): string | undefined;
+
+  /**
+   * Get marital statuses
+   * 获取婚姻状况列表
+   * @param status
+   */
+  getMaritalStatuses(): ListType[];
+
+  /**
+   * Get person degree
+   * 获取人员学历
+   * @param degree
+   */
+  getPersonDegree(degree?: PersonDegree): string | undefined;
+
+  /**
+   * Get person degree list
+   * 获取人员学历列表
+   */
+  getPersonDegrees(): ListType[];
+
+  /**
+   * Get person education
+   * 获取人员学历
+   * @param education
+   */
+  getPersonEducation(education?: PersonEducation): string | undefined;
+
+  /**
+   * Get person education list
+   * 获取人员学历列表
+   */
+  getPersonEducations(): ListType[];
+
+  /**
+   * Get person gender
+   * 获取人员性别
+   * @param gender Gender value
+   * @returns Label
+   */
+  getPersonGender(gender?: string): string | undefined;
+
+  /**
+   * Get identity type
+   * 获取身份类型
+   * @param data Identity type data
+   */
+  getIdentityType(data?: IdentityTypeData): string;
+
+  /**
+   * Get person title
+   * 获取人员头衔
+   * @param title
+   */
+  getPersonTitle(title?: PersonTitle): string | undefined;
+
+  /**
+   * Get person titles
+   * 获取人员头衔
+   */
+  getPersonTitles(): ListType[];
+}
+
+/**
+ * CRM application
+ * CRM应用程序
+ */
+export class CrmApp implements ICrmApp {
+  private _personApi?: PersonApi;
+  /**
+   * Person API
+   * 人员接口
+   */
+  get personApi() {
+    return (this._personApi ??= new PersonApi(this.app, this.api));
+  }
+
+  private _personProfileApi?: PersonProfileApi;
+  /**
+   * Person profile API
+   * 人员档案接口
+   */
+  get personProfileApi() {
+    return (this._personProfileApi ??= new PersonProfileApi(
+      this.app,
+      this.api
+    ));
+  }
+
+  /**
+   * Constructor
+   * 构造函数
+   * @param app Base application
+   * @param api API
+   */
+  constructor(public readonly app: IApp, public readonly api: IApi) {}
+
+  /**
+   * Get person gender
+   * 获取人员性别
+   * @param gender Gender value
+   * @returns Label
+   */
+  getPersonGender(gender?: string) {
+    if (gender === "M") return this.app.get("personMale") ?? "Male";
+    else if (gender === "F") return this.app.get("personFemale") ?? "Female";
+    else return undefined;
+  }
+
+  /**
+   * Get identity type
+   * 获取身份类型
+   * @param data Identity type data
+   */
+  getIdentityType(data?: IdentityTypeData) {
+    if (data == null) return "";
+
+    if (data.isOrg) {
+      return this.app.get("org")!;
+    }
+
+    const type = data.identityType;
+    return this.app
+      .getEnumList(IdentityType, "id", (id, _key) => {
+        if ((id & type) > 0) return id;
+      })
+      .map((d) => d.label)
+      .join(", ");
+  }
+
+  /**
+   * Get marital status
+   * 获取婚姻状况
+   * @param status
+   */
+  getMaritalStatus(status?: MaritalStatus) {
+    if (status == null) return undefined;
+    const key = MaritalStatus[status];
+    return this.app.get("marital" + key) ?? key;
+  }
+
+  /**
+   * Get marital statuses
+   * 获取婚姻状况列表
+   * @param status
+   */
+  getMaritalStatuses() {
+    return this.app.getEnumList(MaritalStatus, "marital");
+  }
+
+  /**
+   * Get person degree
+   * 获取人员学历
+   * @param degree
+   */
+  getPersonDegree(degree?: PersonDegree) {
+    if (degree == null) return undefined;
+    const key = PersonDegree[degree];
+    return this.app.get("degree" + key) ?? key;
+  }
+
+  /**
+   * Get person degree list
+   * 获取人员学历列表
+   */
+  getPersonDegrees() {
+    return this.app.getEnumList(PersonDegree, "degree");
+  }
+
+  /**
+   * Get person education
+   * 获取人员学历
+   * @param education
+   */
+  getPersonEducation(education?: PersonEducation) {
+    if (education == null) return undefined;
+    const key = PersonEducation[education];
+    return this.app.get("education" + key) ?? key;
+  }
+
+  /**
+   * Get person education list
+   * 获取人员学历列表
+   */
+  getPersonEducations() {
+    return this.app.getEnumList(PersonEducation, "education");
+  }
+
+  /**
+   * Get person title
+   * 获取人员头衔
+   * @param title
+   */
+  getPersonTitle(title?: PersonTitle) {
+    if (title == null) return undefined;
+    const key = PersonTitle[title];
+    return this.app.get("personTitle" + key) ?? key;
+  }
+
+  /**
+   * Get person titles
+   * 获取人员头衔
+   */
+  getPersonTitles() {
+    return this.app.getEnumList(PersonTitle, "personTitle");
+  }
+}

package/src/PersonApi.ts

@@ -0,0 +1,50 @@
+import { EntityApi, IApi, IApiPayload, IApp } from "@etsoo/appscript";
+import { PersonListRQ } from "./rq/person/PersonListRQ";
+import { PersonQueryRQ } from "./rq/person/PersonQueryRQ";
+import { PersonListDto } from "./dto/person/PersonListDto";
+import { PersonQueryData } from "./dto/person/PersonQueryData";
+import { PersonViewData } from "./dto/person/PersonReadDto";
+
+/**
+ * Person API
+ */
+export class PersonApi extends EntityApi {
+  /**
+   * Constructor
+   * @param app Application
+   * @param api API
+   */
+  constructor(app: IApp, api: IApi = app.api) {
+    super("Person", app, api);
+  }
+
+  /**
+   * List
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  list(rq: PersonListRQ, payload: IApiPayload<PersonListDto[]>) {
+    return this.listBase(rq, payload);
+  }
+
+  /**
+   * Query
+   * @param rq Request data
+   * @param payload Payload
+   * @returns Result
+   */
+  query(rq: PersonQueryRQ, payload?: IApiPayload<PersonQueryData[]>) {
+    return this.queryBase(rq, payload);
+  }
+
+  /**
+   * Read
+   * @param id Id
+   * @param payload Payload
+   * @returns Result
+   */
+  read(id: number, payload?: IApiPayload<PersonViewData>) {
+    return this.readBase(id, payload);
+  }
+}