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

package/index.js

@@ -0,0 +1 @@
+export * from './src';

package/package.json

@@ -0,0 +1,21 @@
+{
+    "name": "@manycore/budget-plugin-api",
+    "version": "0.0.1-alpha.1",
+    "title": "@manycore/budget-plugin-api",
+    "description": "清单插件平台二开应用的API",
+    "license": "MIT",
+    "main": "./index.js",
+    "module": "./index.js",
+    "typings": "types/index.d.ts",
+    "peerDependencies": {
+        "servkit": "1.0.15"
+    },
+    "engines": {
+        "node": ">=10.0.0"
+    },
+    "scripts": {
+        "prepare": "kjl link-cloud-packages",
+        "dev": "kjl baozheng:dev",
+        "build": "kjl baozheng:build"
+    }
+}

package/src/decl/index.js

@@ -0,0 +1,4 @@
+export * from './sapp.service';
+export * from './sapp.ui.toast.service';
+export * from './sapp.dev.service';
+export * from './listing.service';

package/src/decl/listing.service.js

@@ -0,0 +1,81 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _typeof from "@babel/runtime/helpers/typeof";
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var __decorate = this && this.__decorate || function (decorators, target, key, desc) {
+  var c = arguments.length,
+    r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc,
+    d;
+  if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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';
+/**
+ * 清单插件平台API，给插件提供读写清单数据的api
+ */
+var ListingService = /*#__PURE__*/function (_ServService) {
+  function ListingService() {
+    _classCallCheck(this, ListingService);
+    return _callSuper(this, ListingService, arguments);
+  }
+  _inherits(ListingService, _ServService);
+  return _createClass(ListingService, [{
+    key: "getDetail",
+    value:
+    /**
+     * 读清单数据
+     */
+    function getDetail(params) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 批量更新单元格值
+     */
+  }, {
+    key: "updateCells",
+    value: function updateCells(params) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 锁定清单
+     */
+  }, {
+    key: "lock",
+    value: function lock(params) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 解除锁定
+     */
+  }, {
+    key: "unlock",
+    value: function unlock() {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 获取当前清单id
+     */
+  }, {
+    key: "getCurrentListingId",
+    value: function getCurrentListingId() {
+      return API_UNSUPPORT();
+    }
+  }]);
+}(ServService);
+__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);
+ListingService = __decorate([anno.decl({
+  id: 'sapp.listing.service',
+  version: '1.0.0'
+})], ListingService);
+export { ListingService };

package/src/decl/sapp.dev.service.js

@@ -0,0 +1,51 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _typeof from "@babel/runtime/helpers/typeof";
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var __decorate = this && this.__decorate || function (decorators, target, key, desc) {
+  var c = arguments.length,
+    r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc,
+    d;
+  if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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';
+var SappDevService = /*#__PURE__*/function (_ServService) {
+  function SappDevService() {
+    _classCallCheck(this, SappDevService);
+    return _callSuper(this, SappDevService, arguments);
+  }
+  _inherits(SappDevService, _ServService);
+  return _createClass(SappDevService, [{
+    key: "start",
+    value:
+    /**
+     * 启动某个小程序
+     */
+    function start(sapp) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * stop 停止某个小程序
+     */
+  }, {
+    key: "stop",
+    value: function stop(sapp) {
+      return API_UNSUPPORT();
+    }
+  }]);
+}(ServService);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappDevService.prototype, "start", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappDevService.prototype, "stop", null);
+SappDevService = __decorate([anno.decl({
+  id: 'mini.dev.budget.',
+  version: '1.0.0'
+})], SappDevService);
+export { SappDevService };

package/src/decl/sapp.service.js

@@ -0,0 +1,44 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _typeof from "@babel/runtime/helpers/typeof";
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var __decorate = this && this.__decorate || function (decorators, target, key, desc) {
+  var c = arguments.length,
+    r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc,
+    d;
+  if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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';
+var SappService = /*#__PURE__*/function (_ServService) {
+  function SappService() {
+    _classCallCheck(this, SappService);
+    return _callSuper(this, SappService, arguments);
+  }
+  _inherits(SappService, _ServService);
+  return _createClass(SappService, [{
+    key: "show",
+    value: function show() {
+      return API_UNSUPPORT();
+    }
+  }, {
+    key: "hide",
+    value: function hide() {
+      return API_UNSUPPORT();
+    }
+  }]);
+}(ServService);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", []), __metadata("design:returntype", Object)], SappService.prototype, "show", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", []), __metadata("design:returntype", Object)], SappService.prototype, "hide", null);
+SappService = __decorate([anno.decl({
+  id: 'mini.app.budget.',
+  version: '1.0.0'
+})], SappService);
+export { SappService };

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

@@ -0,0 +1,83 @@
+import _classCallCheck from "@babel/runtime/helpers/classCallCheck";
+import _createClass from "@babel/runtime/helpers/createClass";
+import _possibleConstructorReturn from "@babel/runtime/helpers/possibleConstructorReturn";
+import _getPrototypeOf from "@babel/runtime/helpers/getPrototypeOf";
+import _inherits from "@babel/runtime/helpers/inherits";
+import _typeof from "@babel/runtime/helpers/typeof";
+function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
+function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+var __decorate = this && this.__decorate || function (decorators, target, key, desc) {
+  var c = arguments.length,
+    r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc,
+    d;
+  if ((typeof Reflect === "undefined" ? "undefined" : _typeof(Reflect)) === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
+  return c > 3 && r && Object.defineProperty(target, key, r), r;
+};
+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';
+var SappUiToastService = /*#__PURE__*/function (_ServService) {
+  function SappUiToastService() {
+    _classCallCheck(this, SappUiToastService);
+    return _callSuper(this, SappUiToastService, arguments);
+  }
+  _inherits(SappUiToastService, _ServService);
+  return _createClass(SappUiToastService, [{
+    key: "success",
+    value:
+    /**
+     * 成功的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    function success(msg) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 出错的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+  }, {
+    key: "error",
+    value: function error(msg) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 一般的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+  }, {
+    key: "info",
+    value: function info(msg) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 警告的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+  }, {
+    key: "warning",
+    value: function warning(msg) {
+      return API_UNSUPPORT();
+    }
+    /**
+     * 加载中的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+  }, {
+    key: "loading",
+    value: function loading(msg) {
+      return API_UNSUPPORT();
+    }
+  }]);
+}(ServService);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "success", null);
+__decorate([anno.decl.api(), __metadata("design:type", Function), __metadata("design:paramtypes", [Object]), __metadata("design:returntype", Object)], SappUiToastService.prototype, "error", null);
+__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);
+SappUiToastService = __decorate([anno.decl({
+  id: 's.app.ui.',
+  version: '1.0.0'
+})], SappUiToastService);
+export { SappUiToastService };

package/src/index.js

@@ -0,0 +1 @@
+export * from './decl';

package/types/decl/index.d.ts

@@ -0,0 +1,4 @@
+export * from './sapp.service';
+export * from './sapp.ui.toast.service';
+export * from './sapp.dev.service';
+export * from './listing.service';

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

@@ -0,0 +1,218 @@
+import { ServService } from 'servkit';
+import type { ServAPIRetn } from 'servkit';
+/**
+ * 表格元信息
+ */
+interface ISheet {
+    /**
+     * 表名称
+     */
+    name: string;
+}
+/**
+ * 表格列信息
+ */
+interface IColumn {
+    /**
+     * 列ID，表内唯一
+     */
+    columnId: number;
+    /**
+     * 列名称，表内唯一
+     */
+    name: string;
+    /**
+     * 列的显隐，0-显示，1-隐藏
+     */
+    visible: 0 | 1;
+    /**
+     * 列引用名，表内唯一
+     */
+    referencedName: string;
+}
+/**
+ * 单元格错误信息
+ */
+interface ICellError {
+    /**
+     * 单元格错误信息
+     */
+    message: string;
+}
+/**
+ * 单元格基础信息
+ */
+interface ICellBase {
+    /**
+     * 表ID
+     */
+    tableId: number;
+    /**
+     * 列ID
+     */
+    columnId: number;
+    /**
+     * 行ID
+     */
+    rowId: number;
+    /**
+     * 单元格的值，属性类型的值是json str
+     */
+    value: string;
+}
+/**
+ * 单元格信息
+ */
+interface ICell extends ICellBase {
+    /**
+     * 子表也是一个独立的表格，表Id在清单范围内唯一
+     */
+    subTableId?: number;
+    /**
+     * 单元格错误信息, 比如往数字类型的单元格写了字符串，就会有错误信息
+     */
+    error?: ICellError;
+}
+/**
+ * 表格单行信息
+ */
+interface IROW {
+    /**
+     * 行ID，表内唯一
+     */
+    rowId: number;
+    /**
+     * 是否可见，通过列筛选等可隐藏
+     */
+    visible: boolean;
+    /**
+     * 行内单元格信息，key为columnId，columnId由后端生成，并非1-n连续的数字
+     * 示例：
+     * {
+     *     1: {
+     *        tableId: 1,
+     *        columnId: 1,
+     *        rowId: 2,
+     *        value: 'abc'
+     *
+     *       },
+     *       12: {
+     *            tableId: 1,
+     *            columnId: 12,
+     *            rowId: 2,
+     *            value: "7",
+     *          subTableId: 1
+     *      }
+     * }
+     */
+    cells: Record<string, ICell>;
+}
+/**
+ * 单个表数据
+ */
+interface ITable {
+    /**
+     * 表ID，清单内唯一
+     */
+    tableId: number;
+    /**
+     * 表元信息
+     */
+    sheet: ISheet;
+    /**
+     * 表列信息
+     */
+    columns: Array<IColumn>;
+    /**
+     * 表行信息，内部包含单元格信息
+     */
+    rows: Array<IROW>;
+}
+/**
+ * 清单元信息
+ */
+interface IListingMeta {
+    /**
+     * 清单的唯一标识
+     */
+    id: string;
+    /**
+     * 清单名称
+     */
+    name: string;
+    /**
+     * 用户ID
+     */
+    userId: string;
+}
+/**
+ * 清单详情
+ */
+export interface IListingDetail {
+    /**
+     * 清单元信息
+     */
+    metaData: IListingMeta;
+    /**
+     * 清单表格数据
+     */
+    tableData: Array<ITable>;
+}
+export interface IListingQueryParams {
+    /**
+     * 清单ID
+     */
+    listingId: string;
+}
+export interface ICellsUpdateParams {
+    /**
+     * 清单ID
+     */
+    listingId: string;
+    /**
+     * 单元格信息
+     */
+    updateCells: Array<ICellBase>;
+}
+export interface ICellsUpdateRes {
+    /**
+     * 清单ID
+     */
+    listingId: string;
+    /**
+     * 清单更新结果
+     */
+    updateCells: Array<ICell>;
+}
+export interface IListingLockParams {
+    /**
+     * 清单锁定时，模态框上显示的提示信息
+     */
+    message: string;
+}
+/**
+ * 清单插件平台API，给插件提供读写清单数据的api
+ */
+export declare class ListingService extends ServService {
+    /**
+     * 读清单数据
+     */
+    getDetail(params: IListingQueryParams): ServAPIRetn<IListingDetail>;
+    /**
+     * 批量更新单元格值
+     */
+    updateCells(params: ICellsUpdateParams): ServAPIRetn<ICellsUpdateRes>;
+    /**
+     * 锁定清单
+     */
+    lock(params: IListingLockParams): ServAPIRetn<void>;
+    /**
+     * 解除锁定
+     */
+    unlock(): ServAPIRetn<void>;
+    /**
+     * 获取当前清单id
+     */
+    getCurrentListingId(): ServAPIRetn<string>;
+}
+export {};

package/types/decl/sapp.dev.service.d.ts

@@ -0,0 +1,26 @@
+import { ServService } from 'servkit';
+import type { ServAPIRetn } from 'servkit';
+export interface ISappInfo {
+    /**
+     * 应用使用的链接
+     */
+    url: string;
+    /**
+     * 应用的ID
+     */
+    id: string;
+    /**
+     * 应用的标题
+     */
+    title: string;
+}
+export declare class SappDevService extends ServService {
+    /**
+     * 启动某个小程序
+     */
+    start(sapp: ISappInfo): ServAPIRetn<void>;
+    /**
+     * stop 停止某个小程序
+     */
+    stop(sapp: ISappInfo): ServAPIRetn<void>;
+}

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

@@ -0,0 +1,6 @@
+import { ServService } from 'servkit';
+import type { ServAPIRetn } from 'servkit';
+export declare class SappService extends ServService {
+    show(): ServAPIRetn<void>;
+    hide(): ServAPIRetn<void>;
+}

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

@@ -0,0 +1,33 @@
+import { ServService } from 'servkit';
+import type { ServAPIRetn } from 'servkit';
+export interface IToastConfig {
+    title: string;
+    content: string;
+}
+export declare class SappUiToastService extends ServService {
+    /**
+     * 成功的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    success(msg: string | IToastConfig): ServAPIRetn<void>;
+    /**
+     * 出错的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    error(msg: string | IToastConfig): ServAPIRetn<void>;
+    /**
+     * 一般的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    info(msg: string | IToastConfig): ServAPIRetn<void>;
+    /**
+     * 警告的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    warning(msg: string | IToastConfig): ServAPIRetn<void>;
+    /**
+     * 加载中的提示
+     * @param msg 可以传字符串，也可以传 T
+     */
+    loading(msg: string | IToastConfig): ServAPIRetn<void>;
+}

package/types/index.d.ts

@@ -0,0 +1 @@
+export * from './decl';