@giteeteam/apps-manifest 0.1.0-alpha.0 → 0.1.1

package/lib/constants.d.ts

@@ -0,0 +1,6 @@
+export declare enum Triggers {
+    appInstall = "proxima:app:install",
+    appUninstall = "proxima:app:uninstall",
+    appUpdate = "proxima:app:update",
+    itemChange = "proxima:item:change"
+}

package/lib/constants.js

@@ -0,0 +1,10 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Triggers = void 0;
+var Triggers;
+(function (Triggers) {
+    Triggers["appInstall"] = "proxima:app:install";
+    Triggers["appUninstall"] = "proxima:app:uninstall";
+    Triggers["appUpdate"] = "proxima:app:update";
+    Triggers["itemChange"] = "proxima:item:change";
+})(Triggers = exports.Triggers || (exports.Triggers = {}));

package/lib/index.d.ts

@@ -1 +1,3 @@
 export { Manifest } from './manifest';
+export * from './types';
+export * from './constants';

package/lib/index.js

@@ -1,5 +1,21 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Manifest = void 0;
 var manifest_1 = require("./manifest");
 Object.defineProperty(exports, "Manifest", { enumerable: true, get: function () { return manifest_1.Manifest; } });
+__exportStar(require("./types"), exports);
+__exportStar(require("./constants"), exports);

package/lib/manifest.d.ts

@@ -1,14 +1,43 @@
+import type { IManifest } from './types';
 export declare class Manifest {
-    private manifest;
-    constructor(manifestStr: string);
+    private readonly manifest;
+    private readonly manifestString;
+    constructor(manifestString: string);
     get resources(): import("./types").IManifestResource[] | undefined;
     get app(): import("./types").IManifestApp;
+    get tables(): any;
+    getManifest(): IManifest;
+    getManifestString(): string;
     /**
-     * 根据key获取执行的function名称
+     * 获取所有自定义事项类型
+     */
+    getCustomItemType(): any[];
+    /**
+     * 获取所有自定义字段类型
+     */
+    getCustomFieldType(): import("./types").IManifestCustomFieldType[];
+    /**
+     * 获取所有自定义字段
+     */
+    getCustomField(): import("./types").IManifestCustomField[];
+    /**
+     * 根据key获取执行的function
      * @param key
      * @returns
      */
     getFunctionByKey(key: string): import("./types").IManifestFunction | undefined;
+    /**
+     * 根据functionKey获取执行的function
+     * @param functionKey
+     * @returns
+     */
+    getFunctionByFunctionKey(functionKey: string): import("./types").IManifestFunction | undefined;
+    /**
+     * 根据key获取执行的functionKey
+     * @param key
+     * @returns
+     */
+    getFunctionKeyByKey(key: string): string | undefined;
     /**
      * 获取function下的文件列表
      * @returns

package/lib/manifest.js

@@ -3,8 +3,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.Manifest = void 0;
 const yaml_1 = require("yaml");
 class Manifest {
-    constructor(manifestStr) {
-        this.manifest = (0, yaml_1.parse)(manifestStr);
+    constructor(manifestString) {
+        this.manifest = (0, yaml_1.parse)(manifestString);
+        this.manifestString = manifestString;
     }
     get resources() {
         return this.manifest.resources;
@@ -12,13 +13,63 @@ class Manifest {
     get app() {
         return this.manifest.app;
     }
+    get tables() {
+        return this.manifest.tables;
+    }
+    getManifest() {
+        return this.manifest;
+    }
+    getManifestString() {
+        return this.manifestString;
+    }
+    /**
+     * 获取所有自定义事项类型
+     */
+    getCustomItemType() {
+        const { modules } = this.manifest;
+        return modules.customItemType || [];
+    }
+    /**
+     * 获取所有自定义字段类型
+     */
+    getCustomFieldType() {
+        const { modules } = this.manifest;
+        return modules.customFieldType || [];
+    }
+    /**
+     * 获取所有自定义字段
+     */
+    getCustomField() {
+        const { modules } = this.manifest;
+        return modules.customField || [];
+    }
     /**
-     * 根据key获取执行的function名称
+     * 根据key获取执行的function
      * @param key
      * @returns
      */
     getFunctionByKey(key) {
-        var _a, _b, _c, _d, _e;
+        const functionKey = this.getFunctionKeyByKey(key);
+        if (functionKey) {
+            return this.getFunctionByFunctionKey(functionKey);
+        }
+    }
+    /**
+     * 根据functionKey获取执行的function
+     * @param functionKey
+     * @returns
+     */
+    getFunctionByFunctionKey(functionKey) {
+        var _a, _b;
+        return (_b = (_a = this.manifest.modules) === null || _a === void 0 ? void 0 : _a.function) === null || _b === void 0 ? void 0 : _b.find(f => f.key === functionKey);
+    }
+    /**
+     * 根据key获取执行的functionKey
+     * @param key
+     * @returns
+     */
+    getFunctionKeyByKey(key) {
+        var _a, _b, _c;
         const { modules } = this.manifest;
         for (const k in modules) {
             if (k === 'function') {
@@ -27,13 +78,13 @@ class Manifest {
             else if (k === 'importer') {
                 // importer扩展点需要判断function和validate
                 if (key === ((_a = modules[k]) === null || _a === void 0 ? void 0 : _a.function) || key === ((_b = modules[k]) === null || _b === void 0 ? void 0 : _b.validate)) {
-                    return (_c = modules === null || modules === void 0 ? void 0 : modules.function) === null || _c === void 0 ? void 0 : _c.find(v => v.key === key);
+                    return key;
                 }
             }
             else if (Array.isArray(modules[k])) {
-                const targetModule = (_d = modules[k]) === null || _d === void 0 ? void 0 : _d.find(v => v.key === key);
+                const targetModule = (_c = modules[k]) === null || _c === void 0 ? void 0 : _c.find(v => v.key === key);
                 if (targetModule) {
-                    return (_e = modules === null || modules === void 0 ? void 0 : modules.function) === null || _e === void 0 ? void 0 : _e.find(v => v.key === targetModule.function);
+                    return targetModule.function;
                 }
             }
         }

package/lib/types.d.ts

@@ -1,11 +1,13 @@
+import type { Triggers } from './constants';
 export interface IManifestResource {
     key: string;
     path: string;
 }
 export interface IManifestApp {
-    id: string;
+    id?: string;
     name?: string;
-    key: string;
+    key?: string;
+    version?: string;
 }
 export declare type LoadType = 'micro' | 'iframe' | 'remoteJs' | 'redirect' | 'uikit';
 export interface IManifestModule {
@@ -31,14 +33,42 @@ export interface IManifestImporter {
     validate: string;
     itemFields: IManifestImporterItemField[];
 }
+export interface IManifestTrigger {
+    key: string;
+    function: string;
+    events: Triggers[];
+}
+export interface IManifestCustomField {
+    key: string;
+    name: string;
+    type: string;
+    description?: string;
+}
+export interface IManifestCustomFieldType {
+    key: string;
+    name: string;
+    dataType: string;
+    resource: string;
+    description?: string;
+}
 export declare type TManifestModules = {
     [k in string]?: IManifestModule[];
 } & {
     function?: IManifestFunction[];
+    trigger?: IManifestTrigger[];
     importer?: IManifestImporter;
+    customField?: IManifestCustomField[];
+    customFieldType?: IManifestCustomFieldType[];
+    customItemType?: any[];
 };
+export declare type TManifestLanguage = 'en-US' | 'zh-CN';
+export declare type TManifestLocalesItem = Record<string, string>;
+export declare type TManifestLocalesItems = Record<string, TManifestLocalesItem>;
+export declare type TManifestLocales = Record<TManifestLanguage, TManifestLocalesItems>;
 export interface IManifest {
     app: IManifestApp;
     modules: TManifestModules;
+    tables?: any;
     resources?: IManifestResource[];
+    locales?: TManifestLocales;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@giteeteam/apps-manifest",
-  "version": "0.1.0-alpha.0",
+  "version": "0.1.1",
   "description": "Giteeteam Apps Manifest",
   "keywords": [
     "typescript",