@manycore/budget-plugin-api 0.0.1-alpha.1 → 0.0.1-alpha.10

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@manycore/budget-plugin-api",
-    "version": "0.0.1-alpha.1",
+    "version": "0.0.1-alpha.10",
     "title": "@manycore/budget-plugin-api",
     "description": "清单插件平台二开应用的API",
     "license": "MIT",

package/src/decl/listing.service.js

@@ -17,6 +17,12 @@ var __metadata = this && this.__metadata || function (k, v) {
   if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { anno, API_UNSUPPORT, ServService } from 'servkit';
+// 是否系统字段
+export var ESystematic;
+(function (ESystematic) {
+  ESystematic[ESystematic["SYSTEMATIC"] = 0] = "SYSTEMATIC";
+  ESystematic[ESystematic["CUSTOM"] = 1] = "CUSTOM";
+})(ESystematic || (ESystematic = {}));
 /**
  * 清单插件平台API，给插件提供读写清单数据的api
  */
@@ -29,6 +35,10 @@ var ListingService = /*#__PURE__*/function (_ServService) {
   return _createClass(ListingService, [{
     key: "getDetail",
     value:
+    /**
+     * 行选中变化事件 - 当用户选中或取消选中行时触发
+     */
+
     /**
      * 读清单数据
      */
@@ -67,13 +77,42 @@ var ListingService = /*#__PURE__*/function (_ServService) {
     value: function getCurrentListingId() {
       return API_UNSUPPORT();
     }
+    /**
+     * 更新项目信息
+     */
+  }, {
+    key: "updateProjectInfo",
+    value: function updateProjectInfo(params) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 行选中配置
+     */
+  }, {
+    key: "setRowSelection",
+    value: function setRowSelection(rowSelection) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 显示订单详情
+     */
+  }, {
+    key: "showOrderDetail",
+    value: function showOrderDetail(order, onClose) {
+      return API_UNSUPPORT();
+    }
   }]);
 }(ServService);
+__decorate([anno.decl.event(), __metadata("design:type", Object)], ListingService.prototype, "syncDesignEvent", void 0);
+__decorate([anno.decl.event(), __metadata("design:type", Object)], ListingService.prototype, "rowSelectChangeEvent", void 0);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], ListingService.prototype, "getDetail", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], ListingService.prototype, "updateCells", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], ListingService.prototype, "lock", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", []), __metadata("design:returntype", Object)], ListingService.prototype, "unlock", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", []), __metadata("design:returntype", Object)], ListingService.prototype, "getCurrentListingId", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], ListingService.prototype, "updateProjectInfo", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], ListingService.prototype, "setRowSelection", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object, Function]), __metadata("design:returntype", Object)], ListingService.prototype, "showOrderDetail", null);
 ListingService = __decorate([anno.decl({
   id: 'sapp.listing.service',
   version: '1.0.0'

package/src/decl/sapp.ui.toast.service.js

@@ -17,6 +17,12 @@ var __metadata = this && this.__metadata || function (k, v) {
   if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
 };
 import { anno, API_UNSUPPORT, ServService } from 'servkit';
+export var SyncDesignStatus;
+(function (SyncDesignStatus) {
+  SyncDesignStatus["success"] = "success";
+  SyncDesignStatus["error"] = "error";
+  SyncDesignStatus["loading"] = "loading";
+})(SyncDesignStatus || (SyncDesignStatus = {}));
 var SappUiToastService = /*#__PURE__*/function (_ServService) {
   function SappUiToastService() {
     _classCallCheck(this, SappUiToastService);
@@ -69,6 +75,11 @@ var SappUiToastService = /*#__PURE__*/function (_ServService) {
     value: function loading(msg) {
       return API_UNSUPPORT();
     }
+  }, {
+    key: "setSyncDesignStatus",
+    value: function setSyncDesignStatus(status) {
+      return API_UNSUPPORT();
+    }
   }]);
 }(ServService);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "success", null);
@@ -76,6 +87,7 @@ __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("de
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "info", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "warning", null);
 __decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "loading", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [String]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "setSyncDesignStatus", null);
 SappUiToastService = __decorate([anno.decl({
   id: 's.app.ui.',
   version: '1.0.0'

package/types/decl/listing.service.d.ts

@@ -1,9 +1,62 @@
 import { ServService } from 'servkit';
-import type { ServAPIRetn } from 'servkit';
+import type { ServAPIRetn, ServEventer } from 'servkit';
+export declare enum ESystematic {
+    SYSTEMATIC = 0,
+    CUSTOM = 1
+}
+export interface IProjectInfo {
+    /**
+     * 项目信息的唯一标识
+     */
+    obsId: string;
+    /**
+     * 清单ID
+     */
+    listingId: string;
+    /**
+     * 字段名
+     */
+    name: string;
+    /**
+     * 字段值
+     */
+    value: string;
+    /**
+     * 列结构, json字符串
+     */
+    struct?: string;
+    /**
+     * 1-文本
+     * 2-日期
+     * 3-单选
+     */
+    type: 1 | 2 | 3;
+    /**
+     * SYSTEMATIC-系统字段
+     * CUSTOM-自定义
+     */
+    systemic: ESystematic;
+    /**
+     * 顺序
+     */
+    order: number;
+    /**
+     * 创建时间
+     */
+    created: number;
+    /**
+     * 最后修改时间
+     */
+    lastmodified: number;
+    /**
+     * 可选，企业项目信息库配置
+     */
+    apiCode?: string;
+}
 /**
  * 表格元信息
  */
-interface ISheet {
+export interface ISheet {
     /**
      * 表名称
      */
@@ -12,7 +65,7 @@ interface ISheet {
 /**
  * 表格列信息
  */
-interface IColumn {
+export interface IColumn {
     /**
      * 列ID，表内唯一
      */
@@ -33,7 +86,7 @@ interface IColumn {
 /**
  * 单元格错误信息
  */
-interface ICellError {
+export interface ICellError {
     /**
      * 单元格错误信息
      */
@@ -42,7 +95,7 @@ interface ICellError {
 /**
  * 单元格基础信息
  */
-interface ICellBase {
+export interface ICellBase {
     /**
      * 表ID
      */
@@ -63,7 +116,7 @@ interface ICellBase {
 /**
  * 单元格信息
  */
-interface ICell extends ICellBase {
+export interface ICell extends ICellBase {
     /**
      * 子表也是一个独立的表格，表Id在清单范围内唯一
      */
@@ -76,7 +129,7 @@ interface ICell extends ICellBase {
 /**
  * 表格单行信息
  */
-interface IROW {
+export interface IROW {
     /**
      * 行ID，表内唯一
      */
@@ -94,7 +147,6 @@ interface IROW {
      *        columnId: 1,
      *        rowId: 2,
      *        value: 'abc'
-     *
      *       },
      *       12: {
      *            tableId: 1,
@@ -110,7 +162,7 @@ interface IROW {
 /**
  * 单个表数据
  */
-interface ITable {
+export interface ITable {
     /**
      * 表ID，清单内唯一
      */
@@ -131,7 +183,7 @@ interface ITable {
 /**
  * 清单元信息
  */
-interface IListingMeta {
+export interface IListingMeta {
     /**
      * 清单的唯一标识
      */
@@ -144,6 +196,14 @@ interface IListingMeta {
      * 用户ID
      */
     userId: string;
+    /**
+     * 用户邮箱
+     */
+    email?: string;
+    /**
+     * 清单项目信息列表
+     */
+    projectInfos: Array<IProjectInfo>;
 }
 /**
  * 清单详情
@@ -190,10 +250,108 @@ export interface IListingLockParams {
      */
     message: string;
 }
+/**
+ * 更新项目信息参数
+ */
+export interface IProjectInfoUpdateParams {
+    /**
+     * 清单ID
+     */
+    listingId: string;
+    /**
+     * 清单项目信息列表
+     */
+    projectInfos: IProjectInfo[];
+}
+/**
+ * 表ID
+ */
+export declare type SheetId = string | number;
+/**
+ * 行ID
+ */
+export declare type RowKey = string | number;
+/**
+ * 指定的行，key为表id，value为选中行id数组
+ */
+export interface SheetRowKeys {
+    [sheetId: SheetId]: RowKey[];
+}
+/**
+ * 行选中事件数据
+ */
+export interface IRowSelectionEventData<D = any> {
+    /**
+     * 表ID
+     */
+    sheetId: SheetId;
+    /**
+     * 选中的行keys
+     */
+    selectedKeys: RowKey[];
+}
+/**
+ * 行选中变化事件数据
+ */
+export interface IRowSelectionChangeEventData {
+    /**
+     * 所有表的选中状态
+     */
+    selectedRowKeys: SheetRowKeys;
+}
+export interface IRowSelection<D = any> {
+    /**
+     * 默认选中的行keys
+     */
+    selectedRowKeys: SheetRowKeys;
+    /**
+     * 禁用checkbox的行keys
+     */
+    disabledRowKeys?: SheetRowKeys;
+}
+export interface IOrder {
+    /**
+     * 订单obsId
+     */
+    obsId: string;
+    /**
+     * 订单所属清单ID
+     */
+    obsListingId: string;
+    /**
+     * 订单编号
+     */
+    customOrderId: string;
+    /**
+     * 订单备注
+     */
+    description: string;
+    /**
+     * 订单创建时间
+     */
+    created: number;
+    /**
+     * 订单详情ID
+     */
+    obsOrderDetailId: string;
+    /**
+     * 0-无效 1-有效 2-撤销
+     */
+    status: 0 | 1 | 2;
+    /**
+     * 最后更新时间
+     */
+    lastmodified?: number;
+}
 /**
  * 清单插件平台API，给插件提供读写清单数据的api
  */
 export declare class ListingService extends ServService {
+    syncDesignEvent: ServEventer<void>;
+    /**
+     * 行选中变化事件 - 当用户选中或取消选中行时触发
+     */
+    rowSelectChangeEvent: ServEventer<SheetRowKeys>;
     /**
      * 读清单数据
      */
@@ -214,5 +372,16 @@ export declare class ListingService extends ServService {
      * 获取当前清单id
      */
     getCurrentListingId(): ServAPIRetn<string>;
+    /**
+     * 更新项目信息
+     */
+    updateProjectInfo(params: IProjectInfoUpdateParams): ServAPIRetn<void>;
+    /**
+     * 行选中配置
+     */
+    setRowSelection(rowSelection?: IRowSelection): ServAPIRetn<void>;
+    /**
+     * 显示订单详情
+     */
+    showOrderDetail(order: IOrder, onClose?: () => void): ServAPIRetn<void>;
 }
-export {};

package/types/decl/sapp.ui.toast.service.d.ts

@@ -1,5 +1,10 @@
 import { ServService } from 'servkit';
 import type { ServAPIRetn } from 'servkit';
+export declare enum SyncDesignStatus {
+    success = "success",
+    error = "error",
+    loading = "loading"
+}
 export interface IToastConfig {
     title: string;
     content: string;
@@ -30,4 +35,5 @@ export declare class SappUiToastService extends ServService {
      * @param msg 可以传字符串，也可以传 T
      */
     loading(msg: string | IToastConfig): ServAPIRetn<void>;
+    setSyncDesignStatus(status: SyncDesignStatus): ServAPIRetn<void>;
 }