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

package/lib/service/eventbus.d.ts

@@ -0,0 +1,9 @@
+import { TEvent } from '../types/event';
+declare const subscribe: (cb: (event: TEvent) => any | Promise<any>) => void;
+declare const unsubscribe: (cb: (event: TEvent) => any | Promise<any>) => void;
+declare const publish: (name: string, event: {
+    id?: string;
+    time?: string;
+    data: any;
+}) => Promise<any>;
+export { subscribe, unsubscribe, publish };

package/lib/service/eventbus.js

@@ -0,0 +1,43 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.publish = exports.unsubscribe = exports.subscribe = void 0;
+const util_1 = require("@blocklet/meta/lib/util");
+const notification_1 = require("./notification");
+const check_blocklet_env_1 = __importDefault(require("../util/check-blocklet-env"));
+const send_notification_1 = require("../util/send-notification");
+const event_1 = require("../validators/event");
+const subscribe = (cb) => {
+    (0, notification_1.ensureClient)();
+    notification_1._eventBus.on('event', cb);
+};
+exports.subscribe = subscribe;
+const unsubscribe = (cb) => {
+    notification_1._eventBus.off('event', cb);
+};
+exports.unsubscribe = unsubscribe;
+const publish = async (name, event) => {
+    (0, check_blocklet_env_1.default)();
+    (0, notification_1.ensureClient)();
+    const payload = {
+        id: event.id || (0, util_1.nanoid)(),
+        time: event.time || new Date().toISOString(),
+        object_type: event.data.object_type || '',
+        object_id: event.data.object_id || '',
+        type: name,
+        data: {
+            type: 'application/json',
+            ...event.data,
+        },
+        source: process.env.BLOCKLET_COMPONENT_DID,
+        spec_version: '1.0.0',
+    };
+    const { error } = await (0, event_1.validateEvent)(payload);
+    if (error) {
+        throw new Error(`Invalid event: ${error}`);
+    }
+    return (0, send_notification_1.sendToEventBus)(payload, (0, notification_1.getSender)());
+};
+exports.publish = publish;

package/lib/service/notification.d.ts

@@ -1,6 +1,10 @@
 import { EventEmitter } from 'node:events';
 import { TNotification, TNotificationInput, TSendOptions } from '../types/notification';
 type $TSFixMe = any;
+export declare const getSender: () => {
+    appDid: string;
+    appSk: string;
+};
 /**
  *
  * @param {Notification} notification
@@ -23,7 +27,9 @@ declare const doSendMail: (receiver: string | string[], notification: TNotificat
  * }} options
  * @returns
  */
-declare const broadcast: (notification: TNotificationInput, options?: TSendOptions) => Promise<any>;
+export declare const broadcast: (notification: TNotificationInput, options?: TSendOptions) => Promise<any>;
+export declare const _eventBus: EventEmitter<[never]>;
+export declare const ensureClient: () => void;
 export declare const on: (event: string, cb?: $TSFixMe) => EventEmitter<[never]>;
 export declare const off: any;
 export declare const _message: {
@@ -33,7 +39,6 @@ export declare const _message: {
 export { doSendToUser as sendToUser };
 export { doSendMail as sendToMail };
 export { doSendToRelay as sendToRelay };
-export { broadcast };
 declare const _default: {
     sendToUser: (receiver: string | string[], notification: TNotificationInput, options?: TSendOptions) => Promise<any>;
     sendToRelay: (topic: string, event: string, data: any) => Promise<any>;

package/lib/service/notification.js

@@ -36,12 +36,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.broadcast = exports.sendToRelay = exports.sendToMail = exports.sendToUser = exports._message = exports.off = exports.on = void 0;
+exports.sendToRelay = exports.sendToMail = exports.sendToUser = exports._message = exports.off = exports.on = exports.ensureClient = exports._eventBus = exports.broadcast = exports.getSender = void 0;
 /* eslint-disable @typescript-eslint/naming-convention */
 const Jwt = __importStar(require("@arcblock/jwt"));
 const debug_1 = __importDefault(require("debug"));
 const node_events_1 = require("node:events");
 const ws_1 = require("@arcblock/ws");
+const util_1 = require("@blocklet/meta/lib/util");
 const channel_1 = require("@blocklet/meta/lib/channel");
 const constant_1 = require("@blocklet/constant");
 const check_blocklet_env_1 = __importDefault(require("../util/check-blocklet-env"));
@@ -58,6 +59,7 @@ const getSender = () => {
         appSk: wallet.secretKey,
     };
 };
+exports.getSender = getSender;
 /**
  *
  * @param {Notification} notification
@@ -69,19 +71,19 @@ const getSender = () => {
 // eslint-disable-next-line require-await
 const doSendToUser = async (receiver, notification, options) => {
     (0, check_blocklet_env_1.default)();
-    return (0, send_notification_1.sendToUser)(receiver, notification, getSender(), process.env.ABT_NODE_SERVICE_PORT, options, 'send-to-user');
+    return (0, send_notification_1.sendToUser)(receiver, notification, (0, exports.getSender)(), options, 'send-to-user');
 };
 exports.sendToUser = doSendToUser;
 // eslint-disable-next-line require-await
 const doSendToRelay = async (topic, event, data) => {
     (0, check_blocklet_env_1.default)();
-    return (0, send_notification_1.sendToRelay)(topic, event, data, getSender(), process.env.ABT_NODE_SERVICE_PORT);
+    return (0, send_notification_1.sendToRelay)(topic, event, data, (0, exports.getSender)());
 };
 exports.sendToRelay = doSendToRelay;
 // eslint-disable-next-line require-await
 const doSendMail = async (receiver, notification, options) => {
     (0, check_blocklet_env_1.default)();
-    return (0, send_notification_1.sendToUser)(receiver, notification, getSender(), process.env.ABT_NODE_SERVICE_PORT, options, 'send-to-mail');
+    return (0, send_notification_1.sendToUser)(receiver, notification, (0, exports.getSender)(), options, 'send-to-mail');
 };
 exports.sendToMail = doSendMail;
 /**
@@ -98,15 +100,16 @@ exports.sendToMail = doSendMail;
 // eslint-disable-next-line require-await
 const broadcast = async (notification, options = {}) => {
     (0, check_blocklet_env_1.default)();
-    const sender = getSender();
+    const sender = (0, exports.getSender)();
     const { channel = (0, channel_1.getAppPublicChannel)(sender.appDid) } = options;
     const { event = 'message' } = options;
-    return (0, send_notification_1.sendToAppChannel)(channel, event, notification, sender, process.env.ABT_NODE_SERVICE_PORT, options);
+    return (0, send_notification_1.sendToAppChannel)(channel, event, notification, sender, options);
 };
 exports.broadcast = broadcast;
 const noop = () => { };
 const emitter = new node_events_1.EventEmitter();
 const messageEmitter = new node_events_1.EventEmitter();
+exports._eventBus = new node_events_1.EventEmitter(); // for event bus
 const emitError = (error) => {
     messageEmitter.emit('error', error);
     emitter.emit('error', error);
@@ -114,11 +117,12 @@ const emitError = (error) => {
 const ensureErrorListener = () => {
     emitter.on('error', noop);
     messageEmitter.on('error', noop);
+    exports._eventBus.on('error', noop);
 };
 const joinChannelErrorHandler = (name, type, emitters) => (err) => {
     const msg = `join ${name || 'channel'} ${type || 'error'}${err?.message ? ': ' : ''}${err?.message || ''}`;
     console.error(msg);
-    (emitters || [emitter]).forEach((_emitter) => _emitter.emit('error', { message: msg }));
+    (emitters || [emitter]).forEach((x) => x.emit('error', { message: msg }));
 };
 let client = null;
 const initClient = () => {
@@ -144,18 +148,23 @@ const initClient = () => {
             pk,
             apiKey: process.env.BLOCKLET_COMPONENT_API_KEY,
         }));
+        const eventBusChannel = client.channel((0, channel_1.getEventBusChannel)(did), () => ({ token: token(), pk }));
         messageChannel
             .join()
             .receive('error', joinChannelErrorHandler('message channel', 'error', [messageEmitter, emitter]))
             .receive('timeout', joinChannelErrorHandler('message channel', 'timeout', [messageEmitter, emitter]));
         appPublicChannel
             .join()
-            .receive('error', joinChannelErrorHandler('app publish channel', 'error'))
-            .receive('timeout', joinChannelErrorHandler('app publish channel', 'timeout'));
+            .receive('error', joinChannelErrorHandler('app public channel', 'error'))
+            .receive('timeout', joinChannelErrorHandler('app public channel', 'timeout'));
         componentChannel
             .join()
             .receive('error', joinChannelErrorHandler('app component channel', 'error'))
             .receive('timeout', joinChannelErrorHandler('app component channel', 'timeout'));
+        eventBusChannel
+            .join()
+            .receive('error', joinChannelErrorHandler('eventbus channel', 'error'))
+            .receive('timeout', joinChannelErrorHandler('eventbus channel', 'timeout'));
         messageChannel.on('message', ({ status, response } = {}) => {
             debug('messageChannel.on', { status, response });
             if (status === 'ok') {
@@ -166,10 +175,20 @@ const initClient = () => {
             }
             else {
                 emitError(response);
-                console.error({
-                    status,
-                    response,
-                });
+                console.error('Message channel error', { status, response });
+            }
+        });
+        eventBusChannel.on('event', ({ status, response } = {}) => {
+            debug('eventBusChannel.on', { status, response });
+            if (status === 'ok') {
+                // ignore events from self
+                if (response.source !== process.env.BLOCKLET_COMPONENT_DID) {
+                    exports._eventBus.emit('event', response);
+                }
+            }
+            else {
+                exports._eventBus.emit('error', response);
+                console.error('Event channel error', { status, response });
             }
         });
         [...Object.keys(constant_1.BlockletInternalEvents), ...Object.keys(constant_1.TeamEvents)].forEach((key) => {
@@ -190,10 +209,19 @@ const initClient = () => {
                         return;
                     }
                     emitter.emit(event, data);
+                    // Emit team events to event bus
+                    if (constant_1.TeamEvents[key]) {
+                        exports._eventBus.emit('event', {
+                            id: (0, util_1.nanoid)(),
+                            time: new Date().toISOString(),
+                            type: `blocklet.${event}`,
+                            data: { object: data.user },
+                        });
+                    }
                 }
                 else {
                     emitError(response);
-                    console.error({ status, response });
+                    console.error('Component channel error', { status, response });
                 }
             });
         });
@@ -204,7 +232,7 @@ const initClient = () => {
             }
             else {
                 emitter.emit('error', response);
-                console.error({ status, response });
+                console.error('App public channel error', { status, response });
             }
         });
     }
@@ -217,15 +245,16 @@ const ensureClient = () => {
         initClient();
     }
 };
+exports.ensureClient = ensureClient;
 const on = (event, cb) => {
-    ensureClient();
+    (0, exports.ensureClient)();
     return emitter.on(event, cb);
 };
 exports.on = on;
 exports.off = emitter.off.bind(emitter);
 exports._message = {
     on: (event, cb) => {
-        ensureClient();
+        (0, exports.ensureClient)();
         return messageEmitter.on(event, cb);
     },
     off: messageEmitter.off.bind(messageEmitter),
@@ -234,7 +263,7 @@ exports.default = {
     sendToUser: doSendToUser,
     sendToRelay: doSendToRelay,
     sendToMail: doSendMail,
-    broadcast,
+    broadcast: exports.broadcast,
     on: exports.on,
     off: exports.off,
     _message: exports._message,

package/lib/types/event.d.ts

@@ -0,0 +1,14 @@
+export interface TEvent {
+    data: {
+        object?: any;
+        previous_attributes?: any;
+        type?: string;
+    };
+    id: string;
+    object_id?: string;
+    object_type?: string;
+    source: unknown;
+    spec_version: string;
+    time: Date;
+    type: string;
+}

package/lib/types/event.js

@@ -0,0 +1,3 @@
+"use strict";
+/* eslint-disable @typescript-eslint/indent */
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/util/send-notification.d.ts

@@ -15,21 +15,23 @@ export type TNotificationSender = {
  * @param {Object} options
  * @returns
  */
-declare const sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk, type }: TNotificationSender, port?: string, options?: {
+declare const sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk, type }: TNotificationSender, options?: {
     keepForOfflineUser?: boolean;
     locale?: string;
     channels?: ("app" | "email" | "push" | "webhook")[];
-}, pathname?: string) => Promise<any>;
-declare const sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: TSendOptions) => Promise<any>;
+}, pathname?: string, port?: string) => Promise<any>;
+declare const sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, options?: TSendOptions, port?: string) => Promise<any>;
 declare const sendToRelay: (topic: string, event: string, data: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
-export { sendToUser, sendToAppChannel, sendToRelay };
+declare const sendToEventBus: (event: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
+export { sendToUser, sendToAppChannel, sendToRelay, sendToEventBus };
 declare const _default: {
-    sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk, type }: TNotificationSender, port?: string, options?: {
+    sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk, type }: TNotificationSender, options?: {
         keepForOfflineUser?: boolean;
         locale?: string;
         channels?: ("app" | "email" | "push" | "webhook")[];
-    }, pathname?: string) => Promise<any>;
-    sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: TSendOptions) => Promise<any>;
+    }, pathname?: string, port?: string) => Promise<any>;
+    sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, options?: TSendOptions, port?: string) => Promise<any>;
     sendToRelay: (topic: string, event: string, data: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
+    sendToEventBus: (event: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
 };
 export default _default;

package/lib/util/send-notification.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.sendToRelay = exports.sendToAppChannel = exports.sendToUser = void 0;
+exports.sendToEventBus = exports.sendToRelay = exports.sendToAppChannel = exports.sendToUser = void 0;
 const axios_1 = __importDefault(require("axios"));
 const pick_1 = __importDefault(require("lodash/pick"));
 const JWT = __importStar(require("@arcblock/jwt"));
@@ -64,7 +64,7 @@ const getRequestHeaders = () => ({ 'User-Agent': `BlockletSDK/${VERSION}` });
  * @param {Object} options
  * @returns
  */
-const sendToUser = async (receiver, notification, { appDid, appSk, type }, port = process.env.ABT_NODE_SERVICE_PORT, options = {}, pathname = 'send-to-user') => {
+const sendToUser = async (receiver, notification, { appDid, appSk, type }, options = {}, pathname = 'send-to-user', port = process.env.ABT_NODE_SERVICE_PORT) => {
     if (['send-to-user', 'send-to-push-kit', 'send-to-wallet'].includes(pathname)) {
         await (0, index_1.validateReceiver)(receiver);
     }
@@ -102,7 +102,7 @@ const sendToUser = async (receiver, notification, { appDid, appSk, type }, port
     }
 };
 exports.sendToUser = sendToUser;
-const sendToAppChannel = async (channel, event, notification, { appDid, appSk }, port = process.env.ABT_NODE_SERVICE_PORT, options = {}) => {
+const sendToAppChannel = async (channel, event, notification, { appDid, appSk }, options = {}, port = process.env.ABT_NODE_SERVICE_PORT) => {
     if (!channel) {
         throw new Error('channel is required');
     }
@@ -172,8 +172,33 @@ const sendToRelay = async (topic, event, data, { appDid, appSk }, port = process
     }
 };
 exports.sendToRelay = sendToRelay;
+const sendToEventBus = async (event, { appDid, appSk }, port = process.env.ABT_NODE_SERVICE_PORT) => {
+    if (!event) {
+        throw new Error('event is required');
+    }
+    try {
+        const { data: res } = await axios.post(`http://${(0, parse_docker_endpoint_1.getServerHost)()}:${port}${constants_1.SERVICE_PREFIX}/api/send-to-event-bus`, {
+            apiVersion: VERSION,
+            data: {
+                sender: { appDid, token: JWT.sign(appDid, appSk) },
+                channel: (0, channel_1.getEventBusChannel)(appDid),
+                event,
+            },
+        }, {
+            timeout: 60 * 1000,
+            headers: getRequestHeaders(),
+        });
+        return res;
+    }
+    catch (err) {
+        console.error(err.response ? err.response.data : err);
+        throw new Error(err.response ? err.response.data : err.message);
+    }
+};
+exports.sendToEventBus = sendToEventBus;
 exports.default = {
     sendToUser,
     sendToAppChannel,
     sendToRelay,
+    sendToEventBus,
 };

package/lib/validators/event.d.ts

@@ -0,0 +1,9 @@
+import JOI from 'joi';
+declare const eventSchema: JOI.ObjectSchema<any>;
+declare const validateEvent: any;
+export { eventSchema, validateEvent };
+declare const _default: {
+    eventSchema: JOI.ObjectSchema<any>;
+    validateEvent: any;
+};
+export default _default;

package/lib/validators/event.js

@@ -0,0 +1,49 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.validateEvent = exports.eventSchema = void 0;
+/* eslint-disable import/prefer-default-export */
+const joi_1 = __importDefault(require("joi"));
+const extension_1 = require("@blocklet/meta/lib/extension");
+const Joi = joi_1.default.extend(extension_1.didExtension);
+// {
+//   "id": "evt_T2UiJ2VHUxVo3J6BuULkrp15",
+//   "source": "componentDid",
+//   "type": "customer.subscription.renewed",
+//   "time": "2025-02-19T03:46:42.662Z",
+//   "spec_version": "1.0",
+//   "object_type": "Subscription",
+//   "object_id": "sub_hmL7FQTmMbYVELkH6uVo6m9P",
+//   "data": {
+//     "type": "application/json",
+//     "object": {
+//       "id": "sub_hmL7FQTmMbYVELkH6uVo6m9P"
+//     },
+//     "previous_attributes": {}
+//   }
+// }
+const eventSchema = Joi.object({
+    id: Joi.string().required(),
+    source: Joi.DID().required(),
+    type: Joi.string().required(),
+    time: Joi.date().iso().required(),
+    spec_version: Joi.string().required(),
+    object_type: Joi.string().optional().empty(''),
+    object_id: Joi.string().optional().empty(''),
+    data: Joi.object({
+        type: Joi.string().optional().default('application/json'),
+        object: Joi.any().optional(),
+        previous_attributes: Joi.any().optional().empty(null),
+    }).required(),
+})
+    .options({ stripUnknown: true, allowUnknown: true })
+    .meta({ className: 'TEvent' });
+exports.eventSchema = eventSchema;
+const validateEvent = eventSchema.validateAsync.bind(eventSchema);
+exports.validateEvent = validateEvent;
+exports.default = {
+    eventSchema,
+    validateEvent,
+};

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": "graphql client to read/write data on abt node",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -27,16 +27,16 @@
   "author": "linchen1987 <linchen.1987@foxmail.com> (http://github.com/linchen1987)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/client": "1.16.39-beta-20250222-094928-e54632fa",
-    "@abtnode/constant": "1.16.39-beta-20250222-094928-e54632fa",
-    "@abtnode/util": "1.16.39-beta-20250222-094928-e54632fa",
+    "@abtnode/client": "1.16.39-beta-20250225-115803-28695007",
+    "@abtnode/constant": "1.16.39-beta-20250225-115803-28695007",
+    "@abtnode/util": "1.16.39-beta-20250225-115803-28695007",
     "@arcblock/did": "1.19.10",
     "@arcblock/did-auth": "1.19.10",
     "@arcblock/jwt": "1.19.10",
     "@arcblock/ws": "1.19.10",
-    "@blocklet/constant": "1.16.39-beta-20250222-094928-e54632fa",
-    "@blocklet/env": "1.16.39-beta-20250222-094928-e54632fa",
-    "@blocklet/meta": "1.16.39-beta-20250222-094928-e54632fa",
+    "@blocklet/constant": "1.16.39-beta-20250225-115803-28695007",
+    "@blocklet/env": "1.16.39-beta-20250225-115803-28695007",
+    "@blocklet/meta": "1.16.39-beta-20250225-115803-28695007",
     "@did-connect/authenticator": "^2.2.7",
     "@did-connect/handler": "^2.2.7",
     "@nedb/core": "^2.1.5",
@@ -82,5 +82,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.6.3"
   },
-  "gitHead": "9eefa43edc541ba7b4db529898fb826a7b2a06b5"
+  "gitHead": "d6c75e9336becf1eabe733058d030bdda0be9848"
 }

package/service/eventbus.js

@@ -0,0 +1 @@
+module.exports = require('../lib/service/eventbus');