@blocklet/meta 1.16.21-beta-bd0e2503 → 1.16.21-beta-445a8baa

package/lib/blocklet.d.ts

@@ -1,4 +1,4 @@
-import type { BlockletState, ComponentState } from '@abtnode/client';
+import type { BlockletState } from '@abtnode/client';
 type TComponentInternalInfo = {
     title: string;
     did: string;
@@ -8,12 +8,15 @@ type TComponentInternalInfo = {
     status?: number;
     port?: number;
     resources?: string[];
+    resourcesV2?: {
+        path: string;
+        public?: boolean;
+    }[];
+    group?: string;
 };
-declare const getComponentResourcesPath: (component: ComponentState) => string[];
 declare const getComponentsInternalInfo: (app: BlockletState) => Array<TComponentInternalInfo>;
-export { getComponentsInternalInfo, getComponentResourcesPath, TComponentInternalInfo };
+export { getComponentsInternalInfo, TComponentInternalInfo };
 declare const _default: {
     getComponentsInternalInfo: (app: BlockletState) => TComponentInternalInfo[];
-    getComponentResourcesPath: (component: ComponentState) => string[];
 };
 export default _default;

package/lib/blocklet.js

@@ -3,26 +3,32 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getComponentResourcesPath = exports.getComponentsInternalInfo = void 0;
+exports.getComponentsInternalInfo = void 0;
 const path_1 = __importDefault(require("path"));
+const constant_1 = require("@blocklet/constant");
 const util_1 = require("./util");
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 const getComponentResourcesPath = (component) => {
+    return [];
+};
+const getComponentResourcesPathV2 = (component) => {
     const appDir = (component.environments || []).find((y) => y.key === 'BLOCKLET_APP_DIR')?.value;
     if (!appDir) {
         return [];
     }
-    return (component.meta?.resources || [])
+    const resourceDir = path_1.default.join(appDir, constant_1.BLOCKLET_RESOURCE_DIR);
+    return (component.meta?.resource?.bundles || [])
         .map((y) => {
-        const res = path_1.default.join(appDir, y);
-        if (!res.startsWith(appDir)) {
+        const { did, type, public: isPublic } = y;
+        const res = path_1.default.join(resourceDir, did, type);
+        if (!res.startsWith(resourceDir)) {
             // Invalid resource path
-            return '';
+            return null;
         }
-        return res;
+        return { path: res, public: isPublic };
     })
         .filter(Boolean);
 };
-exports.getComponentResourcesPath = getComponentResourcesPath;
 const getComponentsInternalInfo = (app) => {
     const components = [];
     if (!app) {
@@ -38,6 +44,8 @@ const getComponentsInternalInfo = (app) => {
             status: x.status,
             port: 0,
             resources: getComponentResourcesPath(x),
+            resourcesV2: getComponentResourcesPathV2(x),
+            group: x.meta.group,
         };
         const webInterface = (0, util_1.findWebInterface)(x);
         if (webInterface && (x.environments || []).find((y) => y.key === webInterface.port)) {
@@ -50,5 +58,4 @@ const getComponentsInternalInfo = (app) => {
 exports.getComponentsInternalInfo = getComponentsInternalInfo;
 exports.default = {
     getComponentsInternalInfo,
-    getComponentResourcesPath,
 };

package/lib/schema.d.ts

@@ -25,6 +25,7 @@ declare const navigationItemSchema: JOI.ObjectSchema<any>;
 declare const navigationSchema: JOI.ArraySchema<any[]>;
 declare const themeSchema: JOI.ObjectSchema<any>;
 declare const authConfigSchema: JOI.ObjectSchema<any>;
+declare const resourceBundleSchema: JOI.ObjectSchema<any>;
 declare const blockletMetaSchema: JOI.ObjectSchema<any>;
 declare const createBlockletSchema: (baseDir: string, { ensureFiles, ensureDist, ensureComponentStore, ensureName, skipValidateDidName, ...schemaOptions }?: {
     ensureFiles?: boolean;
@@ -33,7 +34,7 @@ declare const createBlockletSchema: (baseDir: string, { ensureFiles, ensureDist,
     ensureName?: boolean;
     skipValidateDidName?: boolean;
 }) => JOI.ObjectSchema;
-export { blockletMetaSchema, blockletNameSchema, componentSchema, createBlockletSchema, descriptionSchema, distSchema, endpointSchema, engineSchema, environmentSchema, environmentNameSchema, interfaceSchema, logoSchema, mountPointSchema, updateMountPointSchema, navigationItemSchema, navigationSchema, personSchema, scriptsSchema, serviceSchema, signatureSchema, themeSchema, titleSchema, statsSchema, cacheableSchema, authConfigSchema, Joi, };
+export { blockletMetaSchema, blockletNameSchema, componentSchema, createBlockletSchema, descriptionSchema, distSchema, endpointSchema, engineSchema, environmentSchema, environmentNameSchema, interfaceSchema, logoSchema, mountPointSchema, updateMountPointSchema, navigationItemSchema, navigationSchema, personSchema, scriptsSchema, serviceSchema, signatureSchema, themeSchema, titleSchema, statsSchema, cacheableSchema, authConfigSchema, resourceBundleSchema, Joi, };
 declare const _default: {
     blockletNameSchema: JOI.StringSchema<string>;
     componentSchema: JOI.ObjectSchema<any>;
@@ -60,6 +61,7 @@ declare const _default: {
     mountPointSchema: JOI.StringSchema<string>;
     updateMountPointSchema: JOI.StringSchema<string>;
     authConfigSchema: JOI.ObjectSchema<any>;
+    resourceBundleSchema: JOI.ObjectSchema<any>;
     Joi: JOI.Root & {
         [key: string]: Function;
     };

package/lib/schema.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Joi = exports.authConfigSchema = exports.cacheableSchema = exports.statsSchema = exports.titleSchema = exports.themeSchema = exports.signatureSchema = exports.serviceSchema = exports.scriptsSchema = exports.personSchema = exports.navigationSchema = exports.navigationItemSchema = exports.updateMountPointSchema = exports.mountPointSchema = exports.logoSchema = exports.interfaceSchema = exports.environmentNameSchema = exports.environmentSchema = exports.engineSchema = exports.endpointSchema = exports.distSchema = exports.descriptionSchema = exports.createBlockletSchema = exports.componentSchema = exports.blockletNameSchema = exports.blockletMetaSchema = void 0;
+exports.Joi = exports.resourceBundleSchema = exports.authConfigSchema = exports.cacheableSchema = exports.statsSchema = exports.titleSchema = exports.themeSchema = exports.signatureSchema = exports.serviceSchema = exports.scriptsSchema = exports.personSchema = exports.navigationSchema = exports.navigationItemSchema = exports.updateMountPointSchema = exports.mountPointSchema = exports.logoSchema = exports.interfaceSchema = exports.environmentNameSchema = exports.environmentSchema = exports.engineSchema = exports.endpointSchema = exports.distSchema = exports.descriptionSchema = exports.createBlockletSchema = exports.componentSchema = exports.blockletNameSchema = exports.blockletMetaSchema = void 0;
 const fs_1 = __importDefault(require("fs"));
 const joi_1 = __importDefault(require("joi"));
 const cjk_length_1 = __importDefault(require("cjk-length"));
@@ -467,6 +467,19 @@ const authConfigSchema = Joi.object({
     unknownType: 'any',
 });
 exports.authConfigSchema = authConfigSchema;
+const resourceTypeSchema = Joi.object({
+    type: Joi.string().trim().min(1).required(),
+    description: Joi.string().trim().min(1),
+});
+const resourceBundleSchema = Joi.object({
+    did: Joi.DID().trim().required(),
+    type: Joi.string().trim().min(1).required(),
+    public: Joi.boolean(),
+}).meta({
+    className: 'TResourceBundle',
+    unknownType: 'any',
+});
+exports.resourceBundleSchema = resourceBundleSchema;
 const blockletMetaProps = {
     did: Joi.DID().trim().required(),
     version: Joi.semver().valid().required(),
@@ -636,6 +649,11 @@ const blockletMetaProps = {
     // Other contents to be included in the bundle
     files: Joi.array().items(Joi.string().trim()).optional(),
     resources: Joi.array().items(Joi.string().trim().required()),
+    resource: Joi.object({
+        exportApi: Joi.string().trim(),
+        bundles: Joi.array().items(resourceBundleSchema),
+        types: Joi.array().items(resourceTypeSchema).max(10),
+    }),
     // TODO: this field should be refactored in future version
     engine: Joi.alternatives().try(engineSchema, Joi.array().items(engineSchema)).optional(),
     // NOTE: following fields are appended by registry or bundling process
@@ -741,5 +759,6 @@ exports.default = {
     mountPointSchema,
     updateMountPointSchema,
     authConfigSchema,
+    resourceBundleSchema,
     Joi,
 };

package/lib/types/schema.d.ts

@@ -47,7 +47,7 @@ export interface TBlockletMeta {
     environments?: TEnvironment[];
     files?: string[];
     gitHash?: string;
-    group?: 'dapp' | 'static' | 'gateway';
+    group?: 'dapp' | 'static' | 'gateway' | 'pack';
     homepage?: string;
     htmlAst?: any;
     interfaces?: TInterface[];
@@ -96,6 +96,14 @@ export interface TBlockletMeta {
         os?: '*' | 'aix' | 'darwin' | 'freebsd' | 'linux' | 'openbsd' | 'sunos' | 'win32' | ('aix' | 'darwin' | 'freebsd' | 'linux' | 'openbsd' | 'sunos' | 'win32')[];
         server?: string;
     };
+    resource?: {
+        bundles?: TResourceBundle[];
+        exportApi?: string;
+        types?: {
+            description?: string;
+            type: string;
+        }[];
+    };
     resources?: string[];
     screenshots?: string[];
     scripts?: TScripts;
@@ -240,6 +248,11 @@ export interface TPerson {
     name: string;
     url?: string;
 }
+export interface TResourceBundle {
+    did: string;
+    public?: boolean;
+    type: string;
+}
 export interface TScripts {
     dev?: string;
     e2eDev?: string;

package/lib/util.d.ts

@@ -99,6 +99,7 @@ declare const isFreeComponent: (meta: TBlockletMeta) => boolean;
 declare const wipeSensitiveData: (blocklet?: BlockletState) => BlockletState;
 declare const isDeletableBlocklet: (blocklet?: BlockletState) => boolean;
 declare const isGatewayBlocklet: (meta: TBlockletMeta) => boolean;
+declare const isPackBlocklet: (meta: TBlockletMeta) => boolean;
 declare const hasRunnableComponent: (blocklet: BlockletState) => boolean;
 /**
  * 获取 blocklet 的 name
@@ -147,8 +148,11 @@ declare const isInProgress: (status: string | number) => boolean;
 declare const isBeforeInstalled: (status: string | number) => boolean;
 declare const isRunning: (status: string | number) => boolean;
 declare const isAccessible: (status: string | number) => boolean;
-declare const hasResourceType: (component: ComponentState, resourceType?: string) => boolean;
-export { isFreeBlocklet, isFreeComponent, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, forEachComponentV2, forEachComponentV2Sync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareableToClient, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findServiceFromMeta, getWhoCanAccess, getComponentWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, hasStartEngine, hasResourceType, };
+declare const hasResourceType: (component: ComponentState, { type, did }?: {
+    type: string;
+    did: string;
+}) => boolean;
+export { isFreeBlocklet, isFreeComponent, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, forEachComponentV2, forEachComponentV2Sync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareableToClient, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findServiceFromMeta, getWhoCanAccess, getComponentWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, isPackBlocklet, hasStartEngine, hasResourceType, };
 declare const _default: {
     isFreeBlocklet: (meta: TBlockletMeta) => boolean;
     isFreeComponent: (meta: TBlockletMeta) => boolean;
@@ -256,7 +260,11 @@ declare const _default: {
     isRunning: (status: string | number) => boolean;
     isAccessible: (status: string | number) => boolean;
     isGatewayBlocklet: (meta: TBlockletMeta) => boolean;
+    isPackBlocklet: (meta: TBlockletMeta) => boolean;
     hasStartEngine: (meta: TBlockletMeta | import("@abtnode/client").BlockletMeta) => boolean;
-    hasResourceType: (component: ComponentState, resourceType?: string) => boolean;
+    hasResourceType: (component: ComponentState, { type, did }?: {
+        type: string;
+        did: string;
+    }) => boolean;
 };
 export default _default;

package/lib/util.js

@@ -3,7 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasResourceType = exports.hasStartEngine = exports.isGatewayBlocklet = exports.isAccessible = 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.filterComponentsV2 = exports.findComponentByIdV2 = exports.findComponentV2 = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getComponentWhoCanAccess = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.isEnvShareableToClient = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachComponentV2Sync = exports.forEachComponentV2 = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
+exports.hasStartEngine = exports.isPackBlocklet = exports.isGatewayBlocklet = exports.isAccessible = 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.filterComponentsV2 = exports.findComponentByIdV2 = exports.findComponentV2 = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getComponentWhoCanAccess = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.isEnvShareableToClient = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachComponentV2Sync = exports.forEachComponentV2 = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
+exports.hasResourceType = void 0;
 /* eslint-disable no-await-in-loop */
 const get_1 = __importDefault(require("lodash/get"));
 const uniq_1 = __importDefault(require("lodash/uniq"));
@@ -417,10 +418,10 @@ const isDeletableBlocklet = (blocklet) => {
     return config.value === 'yes';
 };
 exports.isDeletableBlocklet = isDeletableBlocklet;
-const isGatewayBlocklet = (meta) => 
-// @ts-ignore
-meta?.group === constant_2.BlockletGroup.gateway || meta?.group === 'gateway';
+const isGatewayBlocklet = (meta) => meta?.group === constant_2.BlockletGroup.gateway;
 exports.isGatewayBlocklet = isGatewayBlocklet;
+const isPackBlocklet = (meta) => meta?.group === constant_2.BlockletGroup.pack;
+exports.isPackBlocklet = isPackBlocklet;
 const hasRunnableComponent = (blocklet) => {
     let has = false;
     forEachBlockletSync(blocklet, (x) => {
@@ -662,6 +663,7 @@ const isInProgress = (status) => [
     'waiting',
     'starting',
     'installing',
+    'extracting',
     'stopping',
     'upgrading',
     'restarting',
@@ -690,13 +692,13 @@ const isAccessible = (status) => [
     'downloading',
 ].includes(status);
 exports.isAccessible = isAccessible;
-const hasResourceType = (component, resourceType) => {
+const hasResourceType = (component, { type, did } = { type: '', did: '' }) => {
     if (!component) {
         return false;
     }
     return (!(0, has_start_engine_1.default)(component.meta) &&
-        component.meta?.resources?.length > 0 &&
-        (!resourceType || (component.meta.resources || []).some((y) => y.endsWith(resourceType))));
+        component.meta?.resource?.bundles?.length > 0 &&
+        (component.meta.resource.bundles || []).some((y) => y.type === type && y.did === did));
 };
 exports.hasResourceType = hasResourceType;
 exports.default = {
@@ -747,6 +749,7 @@ exports.default = {
     isRunning,
     isAccessible,
     isGatewayBlocklet,
+    isPackBlocklet,
     hasStartEngine: has_start_engine_1.default,
     hasResourceType,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.21-beta-bd0e2503",
+  "version": "1.16.21-beta-445a8baa",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -24,12 +24,12 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/constant": "1.16.21-beta-bd0e2503",
+    "@abtnode/constant": "1.16.21-beta-445a8baa",
     "@arcblock/did": "1.18.107",
     "@arcblock/did-ext": "1.18.107",
     "@arcblock/did-util": "1.18.107",
     "@arcblock/jwt": "1.18.107",
-    "@blocklet/constant": "1.16.21-beta-bd0e2503",
+    "@blocklet/constant": "1.16.21-beta-445a8baa",
     "@ocap/asset": "1.18.107",
     "@ocap/mcrypto": "1.18.107",
     "@ocap/types": "1.18.107",
@@ -78,5 +78,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "f4550e061b661cb67d7f1413ada51f3f6491f0b8"
+  "gitHead": "7a7ff8be7f424775c3bde0eead773d8e6177fa1a"
 }