@giteeteam/apps-manifest 0.1.0-alpha.0

package/README.md

@@ -0,0 +1 @@
+# Apps Manifest

package/lib/index.d.ts

@@ -0,0 +1 @@
+export { Manifest } from './manifest';

package/lib/index.js

@@ -0,0 +1,5 @@
+"use strict";
+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; } });

package/lib/manifest.d.ts

@@ -0,0 +1,17 @@
+export declare class Manifest {
+    private manifest;
+    constructor(manifestStr: string);
+    get resources(): import("./types").IManifestResource[] | undefined;
+    get app(): import("./types").IManifestApp;
+    /**
+     * 根据key获取执行的function名称
+     * @param key
+     * @returns
+     */
+    getFunctionByKey(key: string): import("./types").IManifestFunction | undefined;
+    /**
+     * 获取function下的文件列表
+     * @returns
+     */
+    getFunctionFiles(): string[];
+}

package/lib/manifest.js

@@ -0,0 +1,55 @@
+"use strict";
+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);
+    }
+    get resources() {
+        return this.manifest.resources;
+    }
+    get app() {
+        return this.manifest.app;
+    }
+    /**
+     * 根据key获取执行的function名称
+     * @param key
+     * @returns
+     */
+    getFunctionByKey(key) {
+        var _a, _b, _c, _d, _e;
+        const { modules } = this.manifest;
+        for (const k in modules) {
+            if (k === 'function') {
+                continue;
+            }
+            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);
+                }
+            }
+            else if (Array.isArray(modules[k])) {
+                const targetModule = (_d = modules[k]) === null || _d === void 0 ? void 0 : _d.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);
+                }
+            }
+        }
+    }
+    /**
+     * 获取function下的文件列表
+     * @returns
+     */
+    getFunctionFiles() {
+        var _a, _b;
+        const fileNames = new Set();
+        (_b = (_a = this.manifest.modules) === null || _a === void 0 ? void 0 : _a.function) === null || _b === void 0 ? void 0 : _b.forEach(({ handler }) => {
+            const filename = handler.split('.')[0];
+            fileNames.add(filename);
+        });
+        return [...fileNames];
+    }
+}
+exports.Manifest = Manifest;

package/lib/types.d.ts

@@ -0,0 +1,44 @@
+export interface IManifestResource {
+    key: string;
+    path: string;
+}
+export interface IManifestApp {
+    id: string;
+    name?: string;
+    key: string;
+}
+export declare type LoadType = 'micro' | 'iframe' | 'remoteJs' | 'redirect' | 'uikit';
+export interface IManifestModule {
+    key: string;
+    loadType?: LoadType;
+    title?: string;
+    viewType?: string;
+    function?: string;
+    resource?: string;
+    route?: string;
+}
+export interface IManifestFunction {
+    key: string;
+    handler: string;
+    timeout?: number;
+}
+export interface IManifestImporterItemField {
+    key: string;
+    title: string;
+}
+export interface IManifestImporter {
+    function: string;
+    validate: string;
+    itemFields: IManifestImporterItemField[];
+}
+export declare type TManifestModules = {
+    [k in string]?: IManifestModule[];
+} & {
+    function?: IManifestFunction[];
+    importer?: IManifestImporter;
+};
+export interface IManifest {
+    app: IManifestApp;
+    modules: TManifestModules;
+    resources?: IManifestResource[];
+}

package/lib/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,37 @@
+{
+  "name": "@giteeteam/apps-manifest",
+  "version": "0.1.0-alpha.0",
+  "description": "Giteeteam Apps Manifest",
+  "keywords": [
+    "typescript",
+    "giteeteam",
+    "manifest"
+  ],
+  "license": "ISC",
+  "main": "./lib/index.js",
+  "files": [
+    "lib"
+  ],
+  "bugs": {
+    "url": "https://github.com/moriahq/giteeteam-apps/issues"
+  },
+  "homepage": "https://github.com/moriahq/giteeteam-apps/tree/master/packages/manifest",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/moriahq/giteeteam-apps.git"
+  },
+  "scripts": {
+    "dev": "tsc -w",
+    "build": "rimraf lib && tsc",
+    "prepare": "npm run build"
+  },
+  "publishConfig": {
+    "allowBranch": "master",
+    "conventionalCommits": true,
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "dependencies": {
+    "yaml": "^2.1.1"
+  }
+}