@etsoo/smarterp-crm 1.0.0

package/.gitattributes

@@ -0,0 +1,2 @@
+# Auto detect text files and perform LF normalization
+* text=auto

package/.github/workflows/main.yml

@@ -0,0 +1,60 @@
+# This workflow will run tests using node and then publish a package to GitHub Packages when a release is created
+# For more information see: https://help.github.com/actions/language-and-framework-guides/publishing-nodejs-packages
+# https://docs.github.com/en/actions/language-and-framework-guides/publishing-nodejs-packages
+
+# Description
+name: Node.js Package
+
+# Event to trigger the action
+on:
+  [push]
+  # release:
+  #  types: [created]
+
+jobs:
+  # Publish to NPM
+  publish-npm:
+    # Condition: previous build is successful
+    # needs: Any previous jobs
+
+    # Operation system
+    runs-on: ubuntu-latest
+
+    steps:
+      # https://github.com/actions/checkout, This action checks-out your repository under $GITHUB_WORKSPACE
+      # so your workflow can access it.
+      - uses: actions/checkout@v4
+
+      # Set up your GitHub Actions workflow with a specific version of node.js
+      # Setup .npmrc file to publish to npm
+      - uses: actions/setup-node@v4
+        with:
+          node-version: "20.x"
+          registry-url: "https://registry.npmjs.org"
+
+      # Named after Continuous Integration, installs dependencies directly from package-lock.json
+      # ci vs install
+      - run: npm install
+
+      # Make sure pass the test without any exception
+      - run: npm test
+
+      # Build the package
+      - run: npm run build
+
+      # Check if the package is already published
+      - name: Check publish status
+        id: check
+        uses: tehpsalmist/npm-publish-status-action@v1
+
+      # Publish to npm
+      # For scoped package, make it public for free service
+      - name: Publish if necessary
+        id: publish
+        if: ${{ steps.check.outputs.exists == '0' }} # package version doesn't yet exist, ship it!
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.ETSOONpmToken }}
+      - name: Report publish status
+        if: ${{ steps.check.outputs.exists == '1' }}
+        run: 'echo "package version already exists on npm registry"'

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2004-2025 ETSOO ® (亿速思维 ®), https://etsoo.com, https://etsoo.nz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,17 @@
+# @etsoo/smarterp-crm
+
+**TypeScript APIs for SmartERP Customer Relationship Management (CRM)**
+
+## Installing
+
+Using npm:
+
+```bash
+$ npm install @etsoo/smarterp-crm
+```
+
+Using yarn:
+
+```bash
+$ yarn add @etsoo/shared/smarterp-crm
+```

package/__tests__/PersonApi.ts

@@ -0,0 +1,15 @@
+import { PersonApi } from "../src";
+import { isLocalTest, TestApp } from "./app/TestApp";
+
+const app = new TestApp();
+
+await app.changeCulture(app.settings.cultures[0]);
+
+const api = new PersonApi(app);
+
+test("Empty tests", () => {
+  expect(api).not.toBeNull();
+});
+
+if (isLocalTest) {
+}

package/__tests__/app/TestApp.ts

@@ -0,0 +1,139 @@
+import {
+  INotificaseBase,
+  INotification,
+  Notification,
+  NotificationCallProps,
+  NotificationContainer,
+  NotificationRenderProps
+} from "@etsoo/notificationbase";
+import {
+  AddressUtils,
+  CoreApp,
+  createClient,
+  Culture,
+  IAppSettings,
+  InitCallResultData,
+  IUser
+} from "@etsoo/appscript";
+import { DataTypes, DomUtils, Utils, WindowStorage } from "@etsoo/shared";
+
+// Detected country or region
+const { detectedCountry } = DomUtils;
+
+// Detected culture
+const { detectedCulture } = DomUtils;
+
+// Supported cultures
+const supportedCultures: DataTypes.CultureDefinition[] = [
+  Culture.zhHans({}),
+  Culture.en({})
+];
+
+// Supported regions
+const supportedRegions = ["CN"];
+
+// Class implementation for tests
+class NotificationTest extends Notification<any, NotificationCallProps> {
+  render(props: NotificationRenderProps, className?: string, options?: any) {
+    throw new Error("Method not implemented.");
+  }
+}
+
+class NotificationContainerTest extends NotificationContainer<
+  any,
+  NotificationCallProps
+> {
+  protected addRaw(
+    data: INotificaseBase<any, NotificationCallProps>
+  ): INotification<any, NotificationCallProps> {
+    return new NotificationTest(data.type, data.content);
+  }
+}
+
+// Container
+var container = new NotificationContainerTest((update) => {});
+
+// Is local test (integration test)
+// Make sure your local environment is ready
+export const isLocalTest = process.env.NODE_ENV === "local";
+
+// Test application class
+export class TestApp extends CoreApp<
+  IUser,
+  IAppSettings,
+  {},
+  NotificationCallProps
+> {
+  /**
+   * Constructor
+   * @param settings Settings
+   * @param name Application name
+   */
+  constructor() {
+    super(
+      {
+        appId: 0,
+
+        /**
+         * Endpoint of the API service
+         */
+        endpoint: "http://{hostname}:9000/api/",
+
+        endpoints: {
+          core: {
+            endpoint: "https://{hostname}:9001/api/",
+            webUrl: ""
+          }
+        },
+
+        /**
+         * App root url
+         */
+        homepage: "/cms",
+
+        /**
+         * Web url of the cloud
+         */
+        webUrl: "https://localhost",
+
+        // Detected culture
+        detectedCulture,
+
+        // Supported cultures
+        cultures: supportedCultures,
+
+        // Supported regions
+        regions: supportedRegions,
+
+        // Browser's time zone
+        timeZone: Utils.getTimeZone(),
+
+        // Current country or region
+        currentRegion: AddressUtils.getRegion(
+          supportedRegions,
+          detectedCountry,
+          detectedCulture
+        ),
+
+        // Current culture
+        currentCulture: DomUtils.getCulture(
+          supportedCultures,
+          detectedCulture
+        )![0]
+      },
+      createClient(),
+      container,
+      new WindowStorage(),
+      "SmartERP"
+    );
+  }
+
+  freshCountdownUI(callback?: () => PromiseLike<unknown>): void {
+    throw new Error("Method not implemented.");
+  }
+
+  initCallUpdateLocal(data: InitCallResultData, timestamp: number) {
+    this.initCallUpdate(data, timestamp);
+    return this.passphrase;
+  }
+}

package/__tests__/tsconfig.json

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig.json to read more about this file */
+    "target": "ES2022",
+    "module": "ES2022",
+    "moduleResolution": "bundler",
+    "allowJs": false,
+    "isolatedModules": true,
+    "outDir": "./lib",
+    "noEmit": false,
+    "declaration": true,
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": false,
+    "jsx": "react-jsx",
+    "forceConsistentCasingInFileNames": true,
+    "types": ["vitest/globals"]
+  },
+  "include": [".."]
+}

package/babel.config.json

@@ -0,0 +1,11 @@
+{
+  "presets": [["@babel/env"]],
+  "plugins": [
+    [
+      "@babel/plugin-transform-runtime",
+      {
+        "corejs": 3
+      }
+    ]
+  ]
+}

package/lib/cjs/CrmApp.d.ts

@@ -0,0 +1,186 @@
+import { IApi, IApp } from "@etsoo/appscript";
+import { PersonApi } from "./PersonApi";
+import { IServiceApp } 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 declare function useRequiredCrmContext(): ICrmApp;
+/**
+ * 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 declare class CrmApp implements ICrmApp {
+    readonly app: IApp;
+    readonly api: IApi;
+    private _personApi?;
+    /**
+     * Person API
+     * 人员接口
+     */
+    get personApi(): PersonApi;
+    private _personProfileApi?;
+    /**
+     * Person profile API
+     * 人员档案接口
+     */
+    get personProfileApi(): PersonProfileApi;
+    /**
+     * Constructor
+     * 构造函数
+     * @param app Base application
+     * @param api API
+     */
+    constructor(app: IApp, api: IApi);
+    /**
+     * 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 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 title
+     * 获取人员头衔
+     * @param title
+     */
+    getPersonTitle(title?: PersonTitle): string | undefined;
+    /**
+     * Get person titles
+     * 获取人员头衔
+     */
+    getPersonTitles(): ListType[];
+}

package/lib/cjs/CrmApp.js

@@ -0,0 +1,170 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CrmApp = void 0;
+exports.useRequiredCrmContext = useRequiredCrmContext;
+const appscript_1 = require("@etsoo/appscript");
+const PersonApi_1 = require("./PersonApi");
+const react_1 = require("@etsoo/react");
+const materialui_1 = require("@etsoo/materialui");
+const PersonTitle_1 = require("./dto/person/PersonTitle");
+const MaritalStatus_1 = require("./dto/person/MaritalStatus");
+const PersonDegree_1 = require("./dto/person/PersonDegree");
+const PersonEducation_1 = require("./dto/person/PersonEducation");
+const PersonProfileApi_1 = require("./PersonProfileApi");
+/**
+ * Get CRM app context hook
+ * @returns CRM app
+ */
+function useRequiredCrmContext() {
+    // Get the app context
+    const app = (0, react_1.useRequiredContext)(materialui_1.ReactAppContext);
+    // Check the app type
+    if ("crm" in app) {
+        return app.crm;
+    }
+    else {
+        return app;
+    }
+}
+/**
+ * CRM application
+ * CRM应用程序
+ */
+class CrmApp {
+    app;
+    api;
+    _personApi;
+    /**
+     * Person API
+     * 人员接口
+     */
+    get personApi() {
+        return (this._personApi ??= new PersonApi_1.PersonApi(this.app, this.api));
+    }
+    _personProfileApi;
+    /**
+     * Person profile API
+     * 人员档案接口
+     */
+    get personProfileApi() {
+        return (this._personProfileApi ??= new PersonProfileApi_1.PersonProfileApi(this.app, this.api));
+    }
+    /**
+     * Constructor
+     * 构造函数
+     * @param app Base application
+     * @param api API
+     */
+    constructor(app, api) {
+        this.app = app;
+        this.api = api;
+    }
+    /**
+     * Get person gender
+     * 获取人员性别
+     * @param gender Gender value
+     * @returns Label
+     */
+    getPersonGender(gender) {
+        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) {
+        if (data == null)
+            return "";
+        if (data.isOrg) {
+            return this.app.get("org");
+        }
+        const type = data.identityType;
+        return this.app
+            .getEnumList(appscript_1.IdentityType, "id", (id, _key) => {
+            if ((id & type) > 0)
+                return id;
+        })
+            .map((d) => d.label)
+            .join(", ");
+    }
+    /**
+     * Get marital status
+     * 获取婚姻状况
+     * @param status
+     */
+    getMaritalStatus(status) {
+        if (status == null)
+            return undefined;
+        const key = MaritalStatus_1.MaritalStatus[status];
+        return this.app.get("marital" + key) ?? key;
+    }
+    /**
+     * Get marital statuses
+     * 获取婚姻状况列表
+     * @param status
+     */
+    getMaritalStatuses() {
+        return this.app.getEnumList(MaritalStatus_1.MaritalStatus, "marital");
+    }
+    /**
+     * Get person degree
+     * 获取人员学历
+     * @param degree
+     */
+    getPersonDegree(degree) {
+        if (degree == null)
+            return undefined;
+        const key = PersonDegree_1.PersonDegree[degree];
+        return this.app.get("degree" + key) ?? key;
+    }
+    /**
+     * Get person degree list
+     * 获取人员学历列表
+     */
+    getPersonDegrees() {
+        return this.app.getEnumList(PersonDegree_1.PersonDegree, "degree");
+    }
+    /**
+     * Get person education
+     * 获取人员学历
+     * @param education
+     */
+    getPersonEducation(education) {
+        if (education == null)
+            return undefined;
+        const key = PersonEducation_1.PersonEducation[education];
+        return this.app.get("education" + key) ?? key;
+    }
+    /**
+     * Get person education list
+     * 获取人员学历列表
+     */
+    getPersonEducations() {
+        return this.app.getEnumList(PersonEducation_1.PersonEducation, "education");
+    }
+    /**
+     * Get person title
+     * 获取人员头衔
+     * @param title
+     */
+    getPersonTitle(title) {
+        if (title == null)
+            return undefined;
+        const key = PersonTitle_1.PersonTitle[title];
+        return this.app.get("personTitle" + key) ?? key;
+    }
+    /**
+     * Get person titles
+     * 获取人员头衔
+     */
+    getPersonTitles() {
+        return this.app.getEnumList(PersonTitle_1.PersonTitle, "personTitle");
+    }
+}
+exports.CrmApp = CrmApp;

package/lib/cjs/PersonApi.d.ts

@@ -0,0 +1,38 @@
+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 declare class PersonApi extends EntityApi {
+    /**
+     * Constructor
+     * @param app Application
+     * @param api API
+     */
+    constructor(app: IApp, api?: IApi);
+    /**
+     * List
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    list(rq: PersonListRQ, payload: IApiPayload<PersonListDto[]>): Promise<PersonListDto[] | undefined>;
+    /**
+     * Query
+     * @param rq Request data
+     * @param payload Payload
+     * @returns Result
+     */
+    query(rq: PersonQueryRQ, payload?: IApiPayload<PersonQueryData[]>): Promise<PersonQueryData[] | undefined>;
+    /**
+     * Read
+     * @param id Id
+     * @param payload Payload
+     * @returns Result
+     */
+    read(id: number, payload?: IApiPayload<PersonViewData>): Promise<PersonViewData | undefined>;
+}