@blocklet/sdk 1.16.20-beta-cf6dfce1 → 1.16.20-beta-148929e2

package/lib/component/index.d.ts

@@ -3,8 +3,6 @@ import { AxiosResponse, Method } from 'axios';
 import { IncomingMessage } from 'http';
 import * as Util from './util';
 import type { Resource } from './util';
-declare const getChildWebEndpoint: (name: string) => string;
-declare const getParentWebEndpoint: () => string;
 declare const getComponentWebEndpoint: (keyword: string) => string;
 type CallComponentOptions<D = any, P = any> = {
     name?: string;
@@ -33,19 +31,20 @@ declare const getResources: ({ types, skipRunningCheck, }?: {
     types?: string[];
     skipRunningCheck?: boolean;
 }) => Resource[];
+declare const waitForComponentRunning: (name: string, timeout?: number, interval?: number) => Promise<boolean>;
 export { call };
 export { getUrl };
 export { getComponentMountPoint };
 export { getComponentWebEndpoint };
+export { waitForComponentRunning };
 export { getResourceExportDir };
 export { getResources };
-export { getChildWebEndpoint };
-export { getParentWebEndpoint };
 declare const _default: {
     call: CallComponent;
     getUrl: (...parts: string[]) => string;
     getComponentMountPoint: (keyword: string) => string;
     getComponentWebEndpoint: (keyword: string) => string;
+    waitForComponentRunning: (name: string, timeout?: number, interval?: number) => Promise<boolean>;
     getResourceExportDir: ({ projectId, releaseId }?: {
         projectId: string;
         releaseId?: string;
@@ -54,7 +53,5 @@ declare const _default: {
         types?: string[];
         skipRunningCheck?: boolean;
     }) => Util.Resource[];
-    getChildWebEndpoint: (name: string) => string;
-    getParentWebEndpoint: () => string;
 };
 export default _default;

package/lib/component/index.js

@@ -26,12 +26,12 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getParentWebEndpoint = exports.getChildWebEndpoint = exports.getResources = exports.getResourceExportDir = exports.getComponentWebEndpoint = exports.getComponentMountPoint = exports.getUrl = exports.call = void 0;
+exports.getResources = exports.getResourceExportDir = exports.waitForComponentRunning = exports.getComponentWebEndpoint = exports.getComponentMountPoint = exports.getUrl = exports.call = void 0;
 const path_1 = require("path");
-const util_1 = require("@blocklet/meta/lib/util");
 const axios_1 = __importDefault(require("axios"));
 const get_1 = __importDefault(require("lodash/get"));
 const url_join_1 = __importDefault(require("url-join"));
+const wait_port_1 = __importDefault(require("wait-port"));
 const constant_1 = require("@blocklet/constant");
 const config_1 = require("../config");
 const verify_sign_1 = require("../util/verify-sign");
@@ -61,24 +61,6 @@ const doCall = async ({ url, headers = {}, ...options }) => {
         throw error;
     }
 };
-const parsePorts = () => JSON.parse(process.env.BLOCKLET_WEB_PORTS);
-const getWebEndpoint = (name) => {
-    const ports = parsePorts();
-    if (ports[name]) {
-        return `http://127.0.0.1:${ports[name]}`;
-    }
-    return '';
-};
-const getChildWebEndpoint = (name) => {
-    const fullName = `${process.env.BLOCKLET_REAL_NAME}/${name}`;
-    return getWebEndpoint(fullName);
-};
-exports.getChildWebEndpoint = getChildWebEndpoint;
-const getParentWebEndpoint = () => {
-    const parentName = (0, util_1.getParentComponentName)(process.env.BLOCKLET_REAL_NAME);
-    return getWebEndpoint(parentName);
-};
-exports.getParentWebEndpoint = getParentWebEndpoint;
 const getComponent = (name) => {
     const item = config_1.components.find((x) => [x.title, x.name, x.did].includes(name));
     return item;
@@ -141,13 +123,28 @@ const getResources = ({ types, skipRunningCheck, } = {}) => {
     return Util.getResources({ components: config_1.components, types, skipRunningCheck });
 };
 exports.getResources = getResources;
+const waitForComponentRunning = async (name, timeout = 30000, interval = 250) => {
+    const component = getComponent(name);
+    if (!component) {
+        throw new Error(`can not find component ${name}`);
+    }
+    const { port } = component;
+    if (!port) {
+        throw new Error(`can not find port for component ${name}`);
+    }
+    const result = await (0, wait_port_1.default)({ host: '127.0.0.1', port, timeout, interval });
+    if (result.open) {
+        return true;
+    }
+    throw new Error(`component ${name} is not running not unreachable`);
+};
+exports.waitForComponentRunning = waitForComponentRunning;
 exports.default = {
     call,
     getUrl,
     getComponentMountPoint,
     getComponentWebEndpoint,
+    waitForComponentRunning,
     getResourceExportDir,
     getResources,
-    getChildWebEndpoint,
-    getParentWebEndpoint, // deprecated
 };

package/lib/service/notification.d.ts

@@ -1,6 +1,6 @@
 /// <reference types="node" />
 import EventEmitter from 'events';
-import { TNotificationInput, TSendOptions } from '../types/notification';
+import { TNotification, TNotificationInput, TSendOptions } from '../types/notification';
 type $TSFixMe = any;
 /**
  *
@@ -12,6 +12,7 @@ type $TSFixMe = any;
  */
 declare const doSendToUser: (receiver: string | string[], notification: TNotificationInput, options?: TSendOptions) => Promise<any>;
 declare const doSendToRelay: (topic: string, event: string, data: any) => Promise<any>;
+declare const doSendMail: (receiver: string | string[], notification: TNotification, options?: TSendOptions) => Promise<any>;
 /**
  *
  * @param {Notification} notification
@@ -31,11 +32,13 @@ export declare const _message: {
     off: any;
 };
 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>;
+    sendToMail: (receiver: string | string[], notification: TNotification, options?: TSendOptions) => Promise<any>;
     broadcast: (notification: TNotificationInput, options?: TSendOptions) => Promise<any>;
     on: (event: string, cb?: any) => EventEmitter;
     off: any;

package/lib/service/notification.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.broadcast = exports.sendToRelay = exports.sendToUser = exports._message = exports.off = exports.on = void 0;
+exports.broadcast = exports.sendToRelay = exports.sendToMail = exports.sendToUser = exports._message = exports.off = exports.on = void 0;
 /* eslint-disable @typescript-eslint/naming-convention */
 const Jwt = __importStar(require("@arcblock/jwt"));
 const events_1 = __importDefault(require("events"));
@@ -56,7 +56,7 @@ 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);
+    return (0, send_notification_1.sendToUser)(receiver, notification, getSender(), process.env.ABT_NODE_SERVICE_PORT, options, 'send-to-user');
 };
 exports.sendToUser = doSendToUser;
 // eslint-disable-next-line require-await
@@ -65,6 +65,12 @@ const doSendToRelay = async (topic, event, data) => {
     return (0, send_notification_1.sendToRelay)(topic, event, data, getSender(), process.env.ABT_NODE_SERVICE_PORT);
 };
 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');
+};
+exports.sendToMail = doSendMail;
 /**
  *
  * @param {Notification} notification
@@ -219,6 +225,7 @@ exports._message = {
 exports.default = {
     sendToUser: doSendToUser,
     sendToRelay: doSendToRelay,
+    sendToMail: doSendMail,
     broadcast,
     on: exports.on,
     off: exports.off,

package/lib/types/notification.d.ts

@@ -111,4 +111,5 @@ export interface TSendOptions {
      */
     [x: string]: any;
     keepForOfflineUser?: boolean;
+    locale?: string;
 }

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

@@ -1,4 +1,4 @@
-import { TNotificationInput, TSendOptions } from '../types/notification';
+import { TNotification, TNotificationInput, TSendOptions } from '../types/notification';
 export type TNotificationSender = {
     appDid: string;
     appSk: string;
@@ -14,12 +14,12 @@ export type TNotificationSender = {
  * @param {Object} options
  * @returns
  */
-declare const sendToUser: (receiver: string | string[], notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: {}) => Promise<any>;
+declare const sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: {}, pathname?: string) => Promise<any>;
 declare const sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: TSendOptions) => Promise<any>;
 declare const sendToRelay: (topic: string, event: string, data: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
 export { sendToUser, sendToAppChannel, sendToRelay };
 declare const _default: {
-    sendToUser: (receiver: string | string[], notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: {}) => Promise<any>;
+    sendToUser: (receiver: string | string[], notification: TNotification | TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: {}, pathname?: string) => Promise<any>;
     sendToAppChannel: (channel: string, event: string, notification: TNotificationInput, { appDid, appSk }: TNotificationSender, port?: string, options?: TSendOptions) => Promise<any>;
     sendToRelay: (topic: string, event: string, data: any, { appDid, appSk }: TNotificationSender, port?: string) => Promise<any>;
 };

package/lib/util/send-notification.js

@@ -51,15 +51,20 @@ const getRequestHeaders = () => ({ 'User-Agent': `BlockletSDK/${VERSION}` });
  * @param {Object} options
  * @returns
  */
-const sendToUser = async (receiver, notification, { appDid, appSk }, port = process.env.ABT_NODE_SERVICE_PORT, options = {}) => {
-    await (0, index_1.validateReceiver)(receiver);
-    const opt = (0, pick_1.default)(options, ['keepForOfflineUser']);
+const sendToUser = async (receiver, notification, { appDid, appSk }, port = process.env.ABT_NODE_SERVICE_PORT, options = {}, pathname = 'send-to-user') => {
+    if (pathname === 'send-to-user') {
+        await (0, index_1.validateReceiver)(receiver);
+    }
+    if (pathname === 'send-to-mail') {
+        await (0, index_1.validateEmail)(receiver);
+    }
+    const opt = (0, pick_1.default)(options, ['keepForOfflineUser', 'locale']);
     await (0, index_1.validateOption)(opt);
     if (SERVER_MODE !== NODE_MODES.DEBUG) {
         await (0, index_1.validateNotification)(notification);
     }
     try {
-        const { data: res } = await axios.post(`http://127.0.0.1:${port}${constants_1.SERVICE_PREFIX}/api/send-to-user`, {
+        const { data: res } = await axios.post(`http://127.0.0.1:${port}${constants_1.SERVICE_PREFIX}/api/${pathname}`, {
             apiVersion: VERSION,
             data: {
                 sender: { appDid, token: JWT.sign(appDid, appSk) },

package/lib/validators/index.d.ts

@@ -1,12 +1,14 @@
-import { validateNotification, validateReceiver, validateOption, validateChannelEvent } from './notification';
+import { validateNotification, validateReceiver, validateOption, validateChannelEvent, validateEmail } from './notification';
 export { validateNotification };
 export { validateReceiver };
 export { validateOption };
 export { validateChannelEvent };
+export { validateEmail };
 declare const _default: {
     validateNotification: any;
     validateReceiver: any;
     validateOption: any;
     validateChannelEvent: any;
+    validateEmail: any;
 };
 export default _default;

package/lib/validators/index.js

@@ -1,14 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateChannelEvent = exports.validateOption = exports.validateReceiver = exports.validateNotification = void 0;
+exports.validateEmail = exports.validateChannelEvent = exports.validateOption = exports.validateReceiver = exports.validateNotification = void 0;
 const notification_1 = require("./notification");
 Object.defineProperty(exports, "validateNotification", { enumerable: true, get: function () { return notification_1.validateNotification; } });
 Object.defineProperty(exports, "validateReceiver", { enumerable: true, get: function () { return notification_1.validateReceiver; } });
 Object.defineProperty(exports, "validateOption", { enumerable: true, get: function () { return notification_1.validateOption; } });
 Object.defineProperty(exports, "validateChannelEvent", { enumerable: true, get: function () { return notification_1.validateChannelEvent; } });
+Object.defineProperty(exports, "validateEmail", { enumerable: true, get: function () { return notification_1.validateEmail; } });
 exports.default = {
     validateNotification: notification_1.validateNotification,
     validateReceiver: notification_1.validateReceiver,
     validateOption: notification_1.validateOption,
     validateChannelEvent: notification_1.validateChannelEvent,
+    validateEmail: notification_1.validateEmail,
 };

package/lib/validators/notification.d.ts

@@ -28,6 +28,7 @@ export declare const validateNotification: any;
 export declare const validateMessage: any;
 export declare const validateChannelEvent: any;
 export declare const validateOption: any;
+export declare const validateEmail: any;
 export { tokenSchema };
 export { actionSchema };
 export { assetSchema };

package/lib/validators/notification.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.feedTypeSchema = exports.connectTypeSchema = exports.notificationTypeSchema = exports.inputNotificationSchema = exports.NOTIFICATION_TYPES = exports.channelEventSchema = exports.optionSchema = exports.messageSchema = exports.notificationSchema = exports.attachmentSchema = exports.dappSchema = exports.imageSchema = exports.linkSchema = exports.textSchema = exports.transactionSchema = exports.vcSchema = exports.assetSchema = exports.actionSchema = exports.tokenSchema = exports.validateOption = exports.validateChannelEvent = exports.validateMessage = exports.validateNotification = exports.validateReceiver = void 0;
+exports.feedTypeSchema = exports.connectTypeSchema = exports.notificationTypeSchema = exports.inputNotificationSchema = exports.NOTIFICATION_TYPES = exports.channelEventSchema = exports.optionSchema = exports.messageSchema = exports.notificationSchema = exports.attachmentSchema = exports.dappSchema = exports.imageSchema = exports.linkSchema = exports.textSchema = exports.transactionSchema = exports.vcSchema = exports.assetSchema = exports.actionSchema = exports.tokenSchema = exports.validateEmail = exports.validateOption = exports.validateChannelEvent = exports.validateMessage = exports.validateNotification = exports.validateReceiver = void 0;
 const joi_1 = __importDefault(require("joi"));
 const extension_1 = require("@blocklet/meta/lib/extension");
 const Joi = joi_1.default.extend(extension_1.didExtension);
@@ -203,17 +203,20 @@ exports.inputNotificationSchema = inputNotificationSchema;
 const inputReceiverSchema = Joi.array().items(receiverSchema).single().required().meta({ className: 'TReceiverInput' });
 const optionSchema = Joi.object({
     keepForOfflineUser: Joi.boolean(),
+    locale: Joi.string(),
 })
     .unknown()
     .meta({ className: 'TSendOptions', unknownType: 'any' });
 exports.optionSchema = optionSchema;
 const channelEventSchema = Joi.string().required().meta({ className: 'TChannelEvent' });
 exports.channelEventSchema = channelEventSchema;
+const schemaEmail = Joi.string().email().required();
 exports.validateReceiver = inputReceiverSchema.validateAsync.bind(inputReceiverSchema);
 exports.validateNotification = inputNotificationSchema.validateAsync.bind(inputNotificationSchema);
 exports.validateMessage = messageSchema.validateAsync.bind(messageSchema);
 exports.validateChannelEvent = channelEventSchema.validateAsync.bind(channelEventSchema);
 exports.validateOption = optionSchema.validateAsync.bind(optionSchema);
+exports.validateEmail = schemaEmail.validateAsync.bind(schemaEmail);
 exports.default = {
     validateReceiver: exports.validateReceiver,
     validateNotification: exports.validateNotification,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.20-beta-cf6dfce1",
+  "version": "1.16.20-beta-148929e2",
   "description": "graphql client to read/write data on abt node",
   "main": "lib/index.js",
   "typings": "lib/index.d.ts",
@@ -26,15 +26,15 @@
   "author": "linchen1987 <linchen.1987@foxmail.com> (http://github.com/linchen1987)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/client": "1.16.20-beta-cf6dfce1",
-    "@abtnode/constant": "1.16.20-beta-cf6dfce1",
+    "@abtnode/client": "1.16.20-beta-148929e2",
+    "@abtnode/constant": "1.16.20-beta-148929e2",
     "@arcblock/did": "1.18.103",
     "@arcblock/did-auth": "1.18.103",
     "@arcblock/jwt": "1.18.103",
     "@arcblock/ws": "1.18.103",
-    "@blocklet/constant": "1.16.20-beta-cf6dfce1",
-    "@blocklet/env": "1.16.20-beta-cf6dfce1",
-    "@blocklet/meta": "1.16.20-beta-cf6dfce1",
+    "@blocklet/constant": "1.16.20-beta-148929e2",
+    "@blocklet/env": "1.16.20-beta-148929e2",
+    "@blocklet/meta": "1.16.20-beta-148929e2",
     "@did-connect/authenticator": "^2.2.1",
     "@did-connect/handler": "^2.2.1",
     "@nedb/core": "^2.1.5",
@@ -50,7 +50,8 @@
     "semver": "^7.3.8",
     "sitemap": "^7.1.1",
     "ufo": "^1.1.1",
-    "url-join": "^4.0.1"
+    "url-join": "^4.0.1",
+    "wait-port": "^1.1.0"
   },
   "resolutions": {
     "@nedb/core": "^2.1.2"
@@ -74,5 +75,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "bc2f0c9c5a39b124c7a7b64ec907527b3e8ccdf1"
+  "gitHead": "99e23380f73b63a8e63ce1fe8f75908194df5d80"
 }