@manycore/budget-plugin-api 0.0.1-alpha.5 → 0.0.1-alpha.9

package/package.json

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

package/src/decl/listing.service.js

@@ -35,6 +35,11 @@ var ListingService = /*#__PURE__*/function (_ServService) {
   return _createClass(ListingService, [{
     key: "getDetail",
     value:
+    /**
+     * 行选中事件 - 当用户选中或取消选中行时触发
+     * 替代原 IRowSelection.onSelect 回调函数
+     */
+
     /**
      * 读清单数据
      */
@@ -81,15 +86,34 @@ var ListingService = /*#__PURE__*/function (_ServService) {
     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, "rowSelectEvent", 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/types/decl/listing.service.d.ts

@@ -4,16 +4,49 @@ export declare enum ESystematic {
     SYSTEMATIC = 0,
     CUSTOM = 1
 }
-export interface IProject {
+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;
 }
 /**
@@ -166,7 +199,7 @@ export interface IListingMeta {
     /**
      * 清单项目信息列表
      */
-    projectInfos: Array<IProject>;
+    projectInfos: Array<IProjectInfo>;
 }
 /**
  * 清单详情
@@ -224,13 +257,92 @@ export interface IProjectInfoUpdateParams {
     /**
      * 清单项目信息列表
      */
-    projectInfos: IProject[];
+    projectInfos: IProjectInfo[];
+}
+/**
+ * 表ID
+ */
+export declare type SheetId = string | number;
+/**
+ * 行ID
+ */
+export declare type RowKey = string | number;
+/**
+ * 表格行选中项，key为表id，value为选中行id数组
+ */
+export declare type SelectedRowKeys = Record<SheetId, RowKey[]>;
+/**
+ * 行选中事件数据
+ */
+export interface IRowSelectionEventData<D = any> {
+    /**
+     * 表ID
+     */
+    sheetId: SheetId;
+    /**
+     * 选中的行keys
+     */
+    selectedKeys: RowKey[];
+}
+/**
+ * 行选中变化事件数据
+ */
+export interface IRowSelectionChangeEventData {
+    /**
+     * 所有表的选中状态
+     */
+    selectedRowKeys: SelectedRowKeys;
+}
+export interface IRowSelection<D = any> {
+    /**
+     * 默认选中的行keys
+     */
+    selectedRowKeys: SelectedRowKeys;
+    /**
+     * 禁用checkbox的行keys
+     */
+    disabledRowKeys?: SelectedRowKeys;
+}
+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;
 }
 /**
  * 清单插件平台API，给插件提供读写清单数据的api
  */
 export declare class ListingService extends ServService {
     syncDesignEvent: ServEventer<void>;
+    /**
+     * 行选中事件 - 当用户选中或取消选中行时触发
+     * 替代原 IRowSelection.onSelect 回调函数
+     */
+    rowSelectEvent: ServEventer<IRowSelectionEventData>;
     /**
      * 读清单数据
      */
@@ -255,4 +367,12 @@ export declare class ListingService extends ServService {
      * 更新项目信息
      */
     updateProjectInfo(params: IProjectInfoUpdateParams): ServAPIRetn<void>;
+    /**
+     * 行选中配置
+     */
+    setRowSelection(rowSelection?: IRowSelection): ServAPIRetn<void>;
+    /**
+     * 显示订单详情
+     */
+    showOrderDetail(order: IOrder, onClose?: () => void): ServAPIRetn<void>;
 }