@blocklet/meta 1.16.39-beta-20250222-094928-e54632fa → 1.16.39-beta-20250225-115803-28695007

package/lib/channel.d.ts

@@ -1,14 +1,17 @@
 declare const getAppPublicChannelRegex: () => RegExp;
 declare const getComponentChannelRegex: () => RegExp;
 declare const getRelayChannelRegex: () => RegExp;
+declare const getEventBusChannelRegex: () => RegExp;
 declare const getAppPublicChannel: (appDid: string) => string;
 declare const getComponentChannel: (appDid: string, componentDid: string) => string;
 declare const getRelayChannel: (appDid: string, topic: string) => string;
+declare const getEventBusChannel: (appDid: string) => string;
 declare const CHANNEL_TYPE: {
     DID: string;
     APP: string;
     COMPONENT: string;
     RELAY: string;
+    EVENT_BUS: string;
 };
 declare const parseChannel: (channel: string) => {
     type: string;
@@ -16,13 +19,14 @@ declare const parseChannel: (channel: string) => {
     topic?: string;
     componentDid?: string;
 };
-export { CHANNEL_TYPE, getAppPublicChannel, getAppPublicChannelRegex, getComponentChannel, getComponentChannelRegex, getRelayChannel, getRelayChannelRegex, parseChannel, };
+export { CHANNEL_TYPE, getAppPublicChannel, getAppPublicChannelRegex, getComponentChannel, getComponentChannelRegex, getRelayChannel, getRelayChannelRegex, parseChannel, getEventBusChannel, getEventBusChannelRegex, };
 declare const _default: {
     CHANNEL_TYPE: {
         DID: string;
         APP: string;
         COMPONENT: string;
         RELAY: string;
+        EVENT_BUS: string;
     };
     getAppPublicChannel: (appDid: string) => string;
     getAppPublicChannelRegex: () => RegExp;
@@ -36,5 +40,7 @@ declare const _default: {
         topic?: string;
         componentDid?: string;
     };
+    getEventBusChannel: (appDid: string) => string;
+    getEventBusChannelRegex: () => RegExp;
 };
 export default _default;

package/lib/channel.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseChannel = exports.getRelayChannelRegex = exports.getRelayChannel = exports.getComponentChannelRegex = exports.getComponentChannel = exports.getAppPublicChannelRegex = exports.getAppPublicChannel = exports.CHANNEL_TYPE = void 0;
+exports.getEventBusChannelRegex = exports.getEventBusChannel = exports.parseChannel = exports.getRelayChannelRegex = exports.getRelayChannel = exports.getComponentChannelRegex = exports.getComponentChannel = exports.getAppPublicChannelRegex = exports.getAppPublicChannel = exports.CHANNEL_TYPE = void 0;
 /* eslint-disable @typescript-eslint/indent */
 const did_1 = require("@arcblock/did");
 const getAppPublicChannelRegex = () => /app:(\w+):public/;
@@ -9,17 +9,22 @@ const getComponentChannelRegex = () => /component:(\w+):(\w+)/;
 exports.getComponentChannelRegex = getComponentChannelRegex;
 const getRelayChannelRegex = () => /relay:(\w+):(\w+)/;
 exports.getRelayChannelRegex = getRelayChannelRegex;
+const getEventBusChannelRegex = () => /app:(\w+):event/;
+exports.getEventBusChannelRegex = getEventBusChannelRegex;
 const getAppPublicChannel = (appDid) => `app:${appDid}:public`;
 exports.getAppPublicChannel = getAppPublicChannel;
 const getComponentChannel = (appDid, componentDid) => `component:${appDid}:${componentDid}`;
 exports.getComponentChannel = getComponentChannel;
 const getRelayChannel = (appDid, topic) => `relay:${appDid}:${topic}`;
 exports.getRelayChannel = getRelayChannel;
+const getEventBusChannel = (appDid) => `app:${appDid}:eventbus`;
+exports.getEventBusChannel = getEventBusChannel;
 const CHANNEL_TYPE = {
     DID: 'DID',
     APP: 'APP',
     COMPONENT: 'COMPONENT',
     RELAY: 'RELAY',
+    EVENT_BUS: 'EVENT_BUS',
 };
 exports.CHANNEL_TYPE = CHANNEL_TYPE;
 const parseChannel = (channel) => {
@@ -34,6 +39,13 @@ const parseChannel = (channel) => {
             topic: match[2],
         };
     }
+    match = getEventBusChannelRegex().exec(channel);
+    if (match && (0, did_1.isValid)(match[1])) {
+        return {
+            type: CHANNEL_TYPE.EVENT_BUS,
+            appDid: match[1],
+        };
+    }
     match = getAppPublicChannelRegex().exec(channel);
     if (match && (0, did_1.isValid)(match[1])) {
         return {
@@ -72,4 +84,6 @@ exports.default = {
     getRelayChannel,
     getRelayChannelRegex,
     parseChannel,
+    getEventBusChannel,
+    getEventBusChannelRegex,
 };

package/lib/schema.d.ts

@@ -28,6 +28,7 @@ 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 eventsSchema: JOI.ArraySchema<any[]>;
 declare const blockletMetaSchema: JOI.ObjectSchema<any>;
 declare const createBlockletSchema: (baseDir: string, { ensureFiles, ensureDist, ensureComponentStore, ensureName, skipValidateDidName, ...schemaOptions }?: {
     ensureFiles?: boolean;
@@ -36,7 +37,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, resourceBundleSchema, installBlockletTitleSchema, installBlockletDescriptionSchema, 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, installBlockletTitleSchema, installBlockletDescriptionSchema, eventsSchema, Joi, };
 declare const _default: {
     blockletNameSchema: JOI.StringSchema<string>;
     componentSchema: JOI.ObjectSchema<any>;
@@ -66,6 +67,7 @@ declare const _default: {
     resourceBundleSchema: JOI.ObjectSchema<any>;
     installBlockletTitleSchema: JOI.StringSchema<string>;
     installBlockletDescriptionSchema: JOI.StringSchema<string>;
+    eventsSchema: JOI.ArraySchema<any[]>;
     Joi: JOI.Root & {
         [key: string]: Function;
     };

package/lib/schema.js

@@ -36,7 +36,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.Joi = exports.installBlockletDescriptionSchema = exports.installBlockletTitleSchema = 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;
+exports.Joi = exports.eventsSchema = exports.installBlockletDescriptionSchema = exports.installBlockletTitleSchema = 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"));
@@ -497,6 +497,23 @@ const resourceBundleSchema = Joi.object({
     unknownType: 'any',
 });
 exports.resourceBundleSchema = resourceBundleSchema;
+const eventsSchema = Joi.array()
+    .items(Joi.object({
+    type: Joi.string()
+        .trim()
+        .min(1)
+        .max(128)
+        .pattern(/^(?!blocklet\.)[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-]+)+$/)
+        .message('Event type must be in format of "[noun.]verb" like "post.published" or "post.comment.published", and prefix "blocklet." is reserved')
+        .required(),
+    description: Joi.string().trim().min(1).max(256).required(),
+}))
+    .unique('type')
+    .meta({
+    className: 'TEvent',
+    unknownType: 'any',
+});
+exports.eventsSchema = eventsSchema;
 const blockletMetaProps = {
     did: Joi.DID().trim().required(),
     version: Joi.semver().valid().required(),
@@ -705,6 +722,8 @@ const blockletMetaProps = {
     bundleName: Joi.string(),
     bundleDid: Joi.DID().trim(),
     storeId: Joi.string(),
+    // open events (within the app) supported by this blocklet
+    events: eventsSchema.optional(),
 };
 const blockletMetaSchema = Joi.object(blockletMetaProps).options({ stripUnknown: true, noDefaults: false }).meta({
     className: 'TBlockletMeta',
@@ -828,5 +847,6 @@ exports.default = {
     resourceBundleSchema,
     installBlockletTitleSchema,
     installBlockletDescriptionSchema,
+    eventsSchema,
     Joi,
 };

package/lib/types/schema.d.ts

@@ -45,6 +45,7 @@ export interface TBlockletMeta {
     documentation?: string;
     engine?: TEngine | TEngine[];
     environments?: TEnvironment[];
+    events?: TEvent;
     files?: string[];
     gitHash?: string;
     group?: 'dapp' | 'static' | 'gateway' | 'pack';
@@ -179,6 +180,10 @@ export interface TEnvironment {
     validation?: string;
 }
 export type TEnvironmentName = string;
+export type TEvent = {
+    description: string;
+    type: string;
+}[];
 export type TInstallBlockletDescription = string;
 export type TInstallBlockletTitle = string;
 export interface TInterface {

package/lib/util.d.ts

@@ -149,7 +149,8 @@ declare const hasResourceType: (component: ComponentState, { type, did }?: {
 }) => boolean;
 declare const getMountPoints: (blocklet: any) => any[];
 declare const checkPublicAccess: (securityConfig: any) => 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, findDockerInterface, findServiceFromMeta, checkPublicAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, isPackBlocklet, hasStartEngine, hasResourceType, getMountPoints, };
+declare const nanoid: (length?: number) => string;
+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, findDockerInterface, findServiceFromMeta, checkPublicAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, isPackBlocklet, hasStartEngine, hasResourceType, getMountPoints, nanoid, };
 declare const _default: {
     isFreeBlocklet: (meta: TBlockletMeta) => boolean;
     isFreeComponent: (meta: TBlockletMeta) => boolean;
@@ -262,5 +263,6 @@ declare const _default: {
         did: string;
     }) => boolean;
     getMountPoints: (blocklet: any) => any[];
+    nanoid: (length?: number) => string;
 };
 export default _default;

package/lib/util.js

@@ -4,7 +4,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.hasResourceType = exports.hasStartEngine = exports.isPackBlocklet = exports.isGatewayBlocklet = exports.isAccessible = exports.isRunning = exports.isBeforeInstalled = exports.isInProgress = exports.getBlockletServices = exports.getBlockletAppIdList = 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.checkPublicAccess = exports.findServiceFromMeta = exports.findDockerInterface = 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.getMountPoints = void 0;
+exports.nanoid = exports.getMountPoints = void 0;
 exports.getAppUrl = getAppUrl;
 /* eslint-disable no-await-in-loop */
 const get_1 = __importDefault(require("lodash/get"));
@@ -749,6 +749,8 @@ const checkPublicAccess = (securityConfig) => {
     return false;
 };
 exports.checkPublicAccess = checkPublicAccess;
+const nanoid = (length = 16) => [...Array(length)].map(() => Math.random().toString(36)[2]).join('');
+exports.nanoid = nanoid;
 exports.default = {
     isFreeBlocklet,
     isFreeComponent,
@@ -801,4 +803,5 @@ exports.default = {
     hasStartEngine: engine_1.hasStartEngine,
     hasResourceType,
     getMountPoints,
+    nanoid,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.39-beta-20250222-094928-e54632fa",
+  "version": "1.16.39-beta-20250225-115803-28695007",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -25,13 +25,13 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/constant": "1.16.39-beta-20250222-094928-e54632fa",
-    "@abtnode/docker-utils": "1.16.39-beta-20250222-094928-e54632fa",
+    "@abtnode/constant": "1.16.39-beta-20250225-115803-28695007",
+    "@abtnode/docker-utils": "1.16.39-beta-20250225-115803-28695007",
     "@arcblock/did": "1.19.10",
     "@arcblock/did-ext": "1.19.10",
     "@arcblock/did-util": "1.19.10",
     "@arcblock/jwt": "1.19.10",
-    "@blocklet/constant": "1.16.39-beta-20250222-094928-e54632fa",
+    "@blocklet/constant": "1.16.39-beta-20250225-115803-28695007",
     "@ocap/asset": "1.19.10",
     "@ocap/mcrypto": "1.19.10",
     "@ocap/types": "1.19.10",
@@ -80,5 +80,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.6.3"
   },
-  "gitHead": "9eefa43edc541ba7b4db529898fb826a7b2a06b5"
+  "gitHead": "d6c75e9336becf1eabe733058d030bdda0be9848"
 }