@blocklet/meta 1.16.11-next-a232f5fb → 1.16.11-next-3d2b39f7

package/lib/util.d.ts

@@ -4,8 +4,9 @@ import type { TBlockletMeta, TEnvironment } from './types';
 type TConfig = TEnvironment & {
     key: string;
 };
-type Component = BlockletState | ComponentState;
-type ComponentPro = Component & {
+type TApp = BlockletState;
+type TComponent = BlockletState | ComponentState;
+type TComponentPro = TComponent & {
     configObj?: Record<string, string>;
     environmentObj?: Record<string, string>;
 };
@@ -44,7 +45,7 @@ declare const getComponentBundleId: (component: {
  * @a/b/@c/d/@e/f => @a/b/@c/d
  */
 declare const getParentComponentName: (name?: string) => string;
-declare const forEachBlocklet: (blocklet: ComponentPro, cb: Function, { parallel, concurrencyLimit, sync, params: inputParams, _parent, _root, _level, _tasks: inputTasks, _ancestors, _limit, }?: {
+declare const forEachBlocklet: (blocklet: TComponentPro, cb: Function, { parallel, concurrencyLimit, sync, params: inputParams, _parent, _root, _level, _tasks: inputTasks, _ancestors, _limit, }?: {
     parallel?: boolean;
     concurrencyLimit?: number;
     sync?: boolean;
@@ -57,23 +58,31 @@ declare const forEachBlocklet: (blocklet: ComponentPro, cb: Function, { parallel
     _limit?: (fn: () => void) => void;
 }) => Promise<unknown>;
 declare const forEachBlockletSync: (blocklet: any, cb: Function) => Promise<unknown>;
+declare const forEachComponentV2: (blocklet: TApp, cb: Function, { parallel, concurrencyLimit, sync, }?: {
+    parallel?: boolean;
+    concurrencyLimit?: number;
+    sync?: boolean;
+}) => Promise<unknown>;
+declare const forEachComponentV2Sync: (blocklet: any, cb: Function) => Promise<unknown>;
 declare const forEachChild: (blocklet: any, cb: Function, params?: any) => Promise<any>;
 declare const forEachChildSync: (blocklet: BlockletState, cb: Function) => Promise<any>;
-declare const findComponent: (blocklet: Component, isEqualFn: (component: Component, context: {
-    ancestors: Array<Component>;
+declare const findComponent: (blocklet: TComponent, isEqualFn: (component: TComponent, context: {
+    ancestors: Array<TComponent>;
 }) => boolean, { _ancestors, returnAncestors, }?: {
-    _ancestors?: Array<Component>;
+    _ancestors?: Array<TComponent>;
     returnAncestors?: boolean;
-}) => Component | {
-    component: Component;
-    ancestors: Array<Component>;
+}) => TComponent | {
+    component: TComponent;
+    ancestors: Array<TComponent>;
 };
 declare const findComponentById: (blocklet: BlockletState | ComponentState, componentId: string | Array<string>, { returnAncestors, }?: {
     returnAncestors?: boolean;
-}) => Component | {
-    component: Component;
-    ancestors: Array<Component>;
+}) => TComponent | {
+    component: TComponent;
+    ancestors: Array<TComponent>;
 };
+declare const findComponentV2: (app: TApp, isEqualFn: (component: TComponent, app: TApp) => boolean) => ComponentState;
+declare const findComponentByIdV2: (app: TApp, componentId: string | Array<string>) => ComponentState;
 declare const isEnvShareable: (env?: TConfig) => boolean;
 declare const getSharedConfigObj: (component: BlockletState, ancestors?: any[]) => any;
 declare const isPreferenceKey: (x: TConfig) => Boolean;
@@ -115,7 +124,7 @@ type ChainInfo = {
     host: string;
 };
 declare const getChainInfo: (env: Record<string, string>) => ChainInfo;
-declare const getBlockletChainInfo: (blocklet?: ComponentPro) => ChainInfo;
+declare const getBlockletChainInfo: (blocklet?: TComponentPro) => ChainInfo;
 declare const isExternalBlocklet: (blocklet?: BlockletState) => boolean;
 declare const getRolesFromAuthConfig: (config: {
     whoCanAccess: string;
@@ -130,12 +139,21 @@ declare const getBlockletServices: (blocklet: Partial<BlockletState>) => Array<{
 declare const isInProgress: (status: string | number) => boolean;
 declare const isBeforeInstalled: (status: string | number) => boolean;
 declare const isRunning: (status: string | number) => boolean;
-export { isFreeBlocklet, isFreeComponent, isComponentBlocklet, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findServiceFromMeta, getWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, };
+type TComponentInternalInfo = {
+    title: string;
+    did: string;
+    name: string;
+    mountPoint: string;
+    status: number;
+    port: number;
+};
+declare const getComponentsInternalInfo: (app: TApp) => Array<TComponentInternalInfo>;
+export { isFreeBlocklet, isFreeComponent, isComponentBlocklet, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, forEachComponentV2, forEachComponentV2Sync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findServiceFromMeta, getWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, getComponentsInternalInfo, TComponentInternalInfo, };
 declare const _default: {
     isFreeBlocklet: (meta: TBlockletMeta) => boolean;
     isFreeComponent: (meta: TBlockletMeta) => boolean;
     isComponentBlocklet: (meta?: TBlockletMeta) => boolean;
-    forEachBlocklet: (blocklet: ComponentPro, cb: Function, { parallel, concurrencyLimit, sync, params: inputParams, _parent, _root, _level, _tasks: inputTasks, _ancestors, _limit, }?: {
+    forEachBlocklet: (blocklet: TComponentPro, cb: Function, { parallel, concurrencyLimit, sync, params: inputParams, _parent, _root, _level, _tasks: inputTasks, _ancestors, _limit, }?: {
         parallel?: boolean;
         concurrencyLimit?: number;
         sync?: boolean;
@@ -150,6 +168,12 @@ declare const _default: {
     forEachBlockletSync: (blocklet: any, cb: Function) => Promise<unknown>;
     forEachChild: (blocklet: any, cb: Function, params?: any) => Promise<any>;
     forEachChildSync: (blocklet: BlockletState, cb: Function) => Promise<any>;
+    forEachComponentV2: (blocklet: BlockletState, cb: Function, { parallel, concurrencyLimit, sync, }?: {
+        parallel?: boolean;
+        concurrencyLimit?: number;
+        sync?: boolean;
+    }) => Promise<unknown>;
+    forEachComponentV2Sync: (blocklet: any, cb: Function) => Promise<unknown>;
     isDeletableBlocklet: (blocklet?: BlockletState) => boolean;
     getSharedConfigObj: (component: BlockletState, ancestors?: any[]) => any;
     getAppMissingConfigs: (blocklet?: any) => any[];
@@ -190,28 +214,30 @@ declare const _default: {
             version: string;
         };
     }) => string;
-    findComponent: (blocklet: Component, isEqualFn: (component: Component, context: {
-        ancestors: Component[];
+    findComponent: (blocklet: TComponent, isEqualFn: (component: TComponent, context: {
+        ancestors: TComponent[];
     }) => boolean, { _ancestors, returnAncestors, }?: {
-        _ancestors?: Component[];
+        _ancestors?: TComponent[];
         returnAncestors?: boolean;
-    }) => Component | {
-        component: Component;
-        ancestors: Component[];
+    }) => TComponent | {
+        component: TComponent;
+        ancestors: TComponent[];
     };
     findComponentById: (blocklet: BlockletState | ComponentState, componentId: string | string[], { returnAncestors, }?: {
         returnAncestors?: boolean;
-    }) => Component | {
-        component: Component;
-        ancestors: Component[];
+    }) => TComponent | {
+        component: TComponent;
+        ancestors: TComponent[];
     };
+    findComponentV2: (app: BlockletState, isEqualFn: (component: TComponent, app: BlockletState) => boolean) => ComponentState;
+    findComponentByIdV2: (app: BlockletState, componentId: string | string[]) => ComponentState;
     getParentComponentName: (name?: string) => string;
     getConnectAppUrl: ({ request, baseUrl }: {
         request: Partial<Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>>;
         baseUrl: string;
     }) => string;
     getChainInfo: (env: Record<string, string>) => ChainInfo;
-    getBlockletChainInfo: (blocklet?: ComponentPro) => ChainInfo;
+    getBlockletChainInfo: (blocklet?: TComponentPro) => ChainInfo;
     isExternalBlocklet: (blocklet?: BlockletState) => boolean;
     isPreferenceKey: (x: TConfig) => Boolean;
     getRolesFromAuthConfig: (config: {
@@ -226,5 +252,6 @@ declare const _default: {
     isInProgress: (status: string | number) => boolean;
     isBeforeInstalled: (status: string | number) => boolean;
     isRunning: (status: string | number) => boolean;
+    getComponentsInternalInfo: (app: BlockletState) => TComponentInternalInfo[];
 };
 export default _default;

package/lib/util.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isRunning = exports.isBeforeInstalled = exports.isInProgress = exports.getBlockletServices = exports.getBlockletAppIdList = exports.getRolesFromAuthConfig = exports.isPreferenceKey = exports.isExternalBlocklet = exports.getBlockletChainInfo = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isComponentBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
+exports.getComponentsInternalInfo = exports.isRunning = exports.isBeforeInstalled = exports.isInProgress = exports.getBlockletServices = exports.getBlockletAppIdList = exports.getRolesFromAuthConfig = exports.isPreferenceKey = exports.isExternalBlocklet = exports.getBlockletChainInfo = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.findComponentByIdV2 = exports.findComponentV2 = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachComponentV2Sync = exports.forEachComponentV2 = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isComponentBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
 /* eslint-disable no-await-in-loop */
 const get_1 = __importDefault(require("lodash/get"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
@@ -131,6 +131,46 @@ const forEachBlocklet = (blocklet, cb, { parallel = false, concurrencyLimit = 5,
 exports.forEachBlocklet = forEachBlocklet;
 const forEachBlockletSync = (blocklet, cb) => forEachBlocklet(blocklet, cb, { sync: true });
 exports.forEachBlockletSync = forEachBlockletSync;
+const forEachComponentV2 = (blocklet, cb, { parallel = false, concurrencyLimit = 5, sync, } = {}) => {
+    // sync
+    if (sync) {
+        if (blocklet.children) {
+            for (const child of blocklet.children) {
+                cb(child);
+            }
+        }
+        return null;
+    }
+    // serial
+    if (!parallel) {
+        // eslint-disable-next-line no-async-promise-executor
+        return new Promise(async (resolve, reject) => {
+            try {
+                if (blocklet.children) {
+                    for (const child of blocklet.children) {
+                        await cb(child);
+                    }
+                }
+                resolve(null);
+            }
+            catch (err) {
+                reject(err);
+            }
+        });
+    }
+    // parallel
+    const limit = (0, p_limit_1.default)(concurrencyLimit);
+    const tasks = [];
+    if (blocklet.children) {
+        for (const child of blocklet.children) {
+            tasks.push(limit(() => cb(child)));
+        }
+    }
+    return Promise.all(tasks);
+};
+exports.forEachComponentV2 = forEachComponentV2;
+const forEachComponentV2Sync = (blocklet, cb) => forEachComponentV2(blocklet, cb, { sync: true });
+exports.forEachComponentV2Sync = forEachComponentV2Sync;
 const forEachChild = (blocklet, cb, params) => {
     return forEachBlocklet(blocklet, (b, opt) => {
         if (opt.level === 0) {
@@ -177,6 +217,35 @@ const findComponentById = (blocklet, componentId, { returnAncestors = false, } =
     }, { returnAncestors });
 };
 exports.findComponentById = findComponentById;
+const findComponentV2 = (app, isEqualFn) => {
+    if (!isEqualFn) {
+        return null;
+    }
+    for (const child of app.children || []) {
+        if (isEqualFn(child, app)) {
+            return child;
+        }
+    }
+    return null;
+};
+exports.findComponentV2 = findComponentV2;
+const findComponentByIdV2 = (app, componentId) => {
+    if (!componentId) {
+        return null;
+    }
+    if (Array.isArray(componentId)) {
+        // eslint-disable-next-line no-param-reassign
+        componentId = componentId.join('/');
+    }
+    return findComponentV2(app, (component, _app) => {
+        if (componentId.includes('/')) {
+            const id = getComponentId(component, [_app]);
+            return componentId === id;
+        }
+        return componentId === component.meta.did;
+    });
+};
+exports.findComponentByIdV2 = findComponentByIdV2;
 const isEnvShareable = (env) => {
     return (!!env &&
         !!(env.key || env.name) &&
@@ -572,6 +641,29 @@ const isBeforeInstalled = (status) => [
 exports.isBeforeInstalled = isBeforeInstalled;
 const isRunning = (status) => [constant_2.BlockletStatus.running, 'running'].includes(status);
 exports.isRunning = isRunning;
+const getComponentsInternalInfo = (app) => {
+    const components = [];
+    if (!app) {
+        return components;
+    }
+    forEachComponentV2Sync(app, (x) => {
+        const component = {
+            title: x.meta.title,
+            did: x.meta.did,
+            name: x.meta.name,
+            mountPoint: x.mountPoint || '',
+            status: x.status,
+            port: 0,
+        };
+        const webInterface = findWebInterface(x);
+        if (webInterface && (x.environments || []).find((y) => y.key === webInterface.port)) {
+            component.port = x.environments.find((y) => y.key === webInterface.port).value;
+        }
+        components.push(component);
+    });
+    return components;
+};
+exports.getComponentsInternalInfo = getComponentsInternalInfo;
 exports.default = {
     isFreeBlocklet,
     isFreeComponent,
@@ -580,6 +672,8 @@ exports.default = {
     forEachBlockletSync,
     forEachChild,
     forEachChildSync,
+    forEachComponentV2,
+    forEachComponentV2Sync,
     isDeletableBlocklet,
     getSharedConfigObj,
     getAppMissingConfigs,
@@ -601,6 +695,8 @@ exports.default = {
     getComponentBundleId,
     findComponent,
     findComponentById,
+    findComponentV2,
+    findComponentByIdV2,
     getParentComponentName,
     getConnectAppUrl,
     getChainInfo,
@@ -612,4 +708,5 @@ exports.default = {
     isInProgress,
     isBeforeInstalled,
     isRunning,
+    getComponentsInternalInfo,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.11-next-a232f5fb",
+  "version": "1.16.11-next-3d2b39f7",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -24,13 +24,13 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/constant": "1.16.11-next-a232f5fb",
-    "@abtnode/util": "1.16.11-next-a232f5fb",
+    "@abtnode/constant": "1.16.11-next-3d2b39f7",
+    "@abtnode/util": "1.16.11-next-3d2b39f7",
     "@arcblock/did": "1.18.80",
     "@arcblock/did-ext": "1.18.80",
     "@arcblock/did-util": "1.18.80",
     "@arcblock/jwt": "1.18.80",
-    "@blocklet/constant": "1.16.11-next-a232f5fb",
+    "@blocklet/constant": "1.16.11-next-3d2b39f7",
     "@ocap/asset": "1.18.80",
     "@ocap/mcrypto": "1.18.80",
     "@ocap/types": "1.18.80",
@@ -79,5 +79,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "1af264e9b6648aa191fbf23c67717262ac717697"
+  "gitHead": "d0142bd2d1e49b94dcb5542d78e294a7b2258faa"
 }