@blocklet/sdk 1.8.32 → 1.8.34

package/lib/env.d.ts

@@ -0,0 +1,12 @@
+declare const env: Readonly<{
+    appId: string;
+    appName: string;
+    appDescription: string;
+    appUrl: string;
+    isComponent: boolean;
+    dataDir: string;
+    cacheDir: string;
+    mode: string;
+    appStorageEndpoint: string;
+}>;
+export = env;

package/lib/env.js

@@ -1,10 +1,13 @@
-module.exports = Object.freeze({
-  appId: process.env.BLOCKLET_APP_ID,
-  appName: process.env.BLOCKLET_APP_NAME,
-  appDescription: process.env.BLOCKLET_APP_DESCRIPTION,
-  appUrl: process.env.BLOCKLET_APP_URL,
-  isComponent: process.env.BLOCKLET_DID !== process.env.BLOCKLET_REAL_DID,
-  dataDir: process.env.BLOCKLET_DATA_DIR,
-  cacheDir: process.env.BLOCKLET_CACHE_DIR,
-  mode: process.env.BLOCKLET_MODE,
+"use strict";
+const env = Object.freeze({
+    appId: process.env.BLOCKLET_APP_ID,
+    appName: process.env.BLOCKLET_APP_NAME,
+    appDescription: process.env.BLOCKLET_APP_DESCRIPTION,
+    appUrl: process.env.BLOCKLET_APP_URL,
+    isComponent: process.env.BLOCKLET_DID !== process.env.BLOCKLET_REAL_DID,
+    dataDir: process.env.BLOCKLET_DATA_DIR,
+    cacheDir: process.env.BLOCKLET_CACHE_DIR,
+    mode: process.env.BLOCKLET_MODE,
+    appStorageEndpoint: process.env.BLOCKLET_APP_STORAGE_ENDPOINT,
 });
+module.exports = env;

package/lib/error-handler.js

@@ -1,9 +1,9 @@
 process
-  .on('uncaughtException', (error) => {
-    console.error(error.message);
+    .on('uncaughtException', (err) => {
+    console.error(err.message);
     process.exit(1);
-  })
-  .on('unhandledRejection', (reason) => {
+})
+    .on('unhandledRejection', (reason) => {
     console.error(reason.message);
     process.exit(1);
-  });
+});

package/lib/index.d.ts

@@ -0,0 +1,51 @@
+import Auth from './service/auth';
+import Notification from './service/notification';
+import WalletAuthenticator from './wallet-authenticator';
+import WalletHandlers from './wallet-handler';
+import BlockletAuthenticator from './connect/authenticator';
+import createConnectHandlers from './connect/handler';
+import connectShared from './connect/shared';
+import Database from './database/index';
+import env from './env';
+import middlewares from './middlewares/index';
+import getWallet from './wallet';
+import Component, { MountPoint } from './component/index';
+import Security from './security/index';
+import config from './config';
+export { Auth as AuthService };
+export { Auth };
+export { Notification as NotificationService };
+export { Notification };
+export { WalletHandlers };
+export { WalletAuthenticator };
+export { BlockletAuthenticator };
+export { createConnectHandlers };
+export { connectShared };
+export { Database };
+export { getWallet };
+export { env };
+export { middlewares };
+export { Component as component };
+export { Component };
+export { Security };
+export { config };
+declare global {
+    interface Window {
+        blocklet: {
+            [x: string]: any;
+            appId: string;
+            appName: string;
+            appDescription: string;
+            appLogo: string;
+            appUrl: string;
+            isComponent: boolean;
+            prefix: string;
+            groupPrefix: string;
+            version: string;
+            theme: any;
+            navigation: any[];
+            componentMountPoints: MountPoint[];
+        };
+    }
+}
+export * from './component';

package/lib/index.js

@@ -1,41 +1,52 @@
-const Auth = require('./service/auth');
-const Notification = require('./service/notification');
-const WalletAuthenticator = require('./wallet-authenticator');
-const WalletHandlers = require('./wallet-handler');
-const BlockletAuthenticator = require('./connect/authenticator');
-const createConnectHandlers = require('./connect/handler');
-const Database = require('./database');
-const env = require('./env');
-const middlewares = require('./middlewares');
-const getWallet = require('./wallet');
-const Component = require('./component');
-const Security = require('./security');
-const config = require('./config');
-
-module.exports = {
-  /**
-   * @deprecated ES6: use `Auth` instead
-   */
-  AuthService: Auth,
-  Auth,
-  /**
-   * @deprecated ES6: use `Notification` instead
-   */
-  NotificationService: Notification,
-  Notification,
-  WalletHandlers,
-  WalletAuthenticator,
-  BlockletAuthenticator,
-  createConnectHandlers,
-  Database,
-  getWallet,
-  env,
-  middlewares,
-  /**
-   * @deprecated ES6: use `Component` instead
-   */
-  component: Component,
-  Component,
-  Security,
-  config,
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.config = exports.Security = exports.Component = exports.component = exports.middlewares = exports.env = exports.getWallet = exports.Database = exports.connectShared = exports.createConnectHandlers = exports.BlockletAuthenticator = exports.WalletAuthenticator = exports.WalletHandlers = exports.Notification = exports.NotificationService = exports.Auth = exports.AuthService = void 0;
+const auth_1 = __importDefault(require("./service/auth"));
+exports.AuthService = auth_1.default;
+exports.Auth = auth_1.default;
+const notification_1 = __importDefault(require("./service/notification"));
+exports.NotificationService = notification_1.default;
+exports.Notification = notification_1.default;
+const wallet_authenticator_1 = __importDefault(require("./wallet-authenticator"));
+exports.WalletAuthenticator = wallet_authenticator_1.default;
+const wallet_handler_1 = __importDefault(require("./wallet-handler"));
+exports.WalletHandlers = wallet_handler_1.default;
+const authenticator_1 = __importDefault(require("./connect/authenticator"));
+exports.BlockletAuthenticator = authenticator_1.default;
+const handler_1 = __importDefault(require("./connect/handler"));
+exports.createConnectHandlers = handler_1.default;
+const shared_1 = __importDefault(require("./connect/shared"));
+exports.connectShared = shared_1.default;
+const index_1 = __importDefault(require("./database/index"));
+exports.Database = index_1.default;
+const env_1 = __importDefault(require("./env"));
+exports.env = env_1.default;
+const index_2 = __importDefault(require("./middlewares/index"));
+exports.middlewares = index_2.default;
+const wallet_1 = __importDefault(require("./wallet"));
+exports.getWallet = wallet_1.default;
+const index_3 = __importDefault(require("./component/index"));
+exports.component = index_3.default;
+exports.Component = index_3.default;
+const index_4 = __importDefault(require("./security/index"));
+exports.Security = index_4.default;
+const config_1 = __importDefault(require("./config"));
+exports.config = config_1.default;
+__exportStar(require("./component"), exports);

package/lib/middlewares/auth.d.ts

@@ -0,0 +1,3 @@
+import { NextFunction, Request, Response } from 'express';
+declare const AuthMiddleware: ({ roles, permissions, _AuthClient }?: $TSFixMe) => (req: Request, res: Response, next: NextFunction) => Promise<void>;
+export = AuthMiddleware;

package/lib/middlewares/auth.js

@@ -1,54 +1,57 @@
-const LRU = require('lru-cache');
-const AuthClient = require('../service/auth');
-
-const cachedPermissions = new LRU({
-  max: 10, // cache at most 10 role
-  maxAge: 60 * 1000, // cache for 2min
-});
-
-const getPermissionsByRole = async (client, role) => {
-  const cached = cachedPermissions.get(role);
-  if (cached) {
-    return cached;
-  }
-  const res = await client.getPermissionsByRole(role);
-  cachedPermissions.set(role, res);
-  return res;
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
 };
-
-/**
- * @param {*} _AuthClient Just for test
- */
-module.exports = ({ roles, permissions, _AuthClient = AuthClient } = {}) => {
-  if (roles && !Array.isArray(roles)) {
-    throw new Error('roles must be array');
-  }
-
-  if (permissions && !Array.isArray(permissions)) {
-    throw new Error('permissions must be array');
-  }
-
-  const client = new _AuthClient();
-
-  return async (req, res, next) => {
-    if (!req.headers['x-user-did']) {
-      res.status(401).json({ code: 'forbidden', error: 'not authorized' });
-      return;
+const lru_cache_1 = __importDefault(require("lru-cache"));
+const auth_1 = __importDefault(require("../service/auth"));
+const cachedPermissions = new lru_cache_1.default({
+    max: 10,
+    maxAge: 60 * 1000, // cache for 2min
+});
+const getPermissionsByRole = (client, role) => __awaiter(void 0, void 0, void 0, function* () {
+    const cached = cachedPermissions.get(role);
+    if (cached) {
+        return cached;
     }
-
-    if (roles && !roles.includes(req.headers['x-user-role'])) {
-      res.status(403).json({ code: 'forbidden', error: 'no permission' });
-      return;
+    const res = yield client.getPermissionsByRole(role);
+    cachedPermissions.set(role, res);
+    return res;
+});
+// FIXME: 名字待确认, 全局的名称 Auth 已经被用了
+const AuthMiddleware = ({ roles, permissions, _AuthClient = auth_1.default } = {}) => {
+    if (roles && !Array.isArray(roles)) {
+        throw new Error('roles must be array');
     }
-
-    if (permissions) {
-      const { permissions: list } = await getPermissionsByRole(client, req.headers['x-user-role']);
-      if (!permissions.some((x) => (list || []).some((y) => y.name === x))) {
-        res.status(403).json({ code: 'forbidden', error: 'no permission' });
-        return;
-      }
+    if (permissions && !Array.isArray(permissions)) {
+        throw new Error('permissions must be array');
     }
-
-    next();
-  };
+    const client = new _AuthClient();
+    return (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+        if (!req.headers['x-user-did']) {
+            res.status(401).json({ code: 'forbidden', error: 'not authorized' });
+            return;
+        }
+        if (roles && !roles.includes(req.headers['x-user-role'])) {
+            res.status(403).json({ code: 'forbidden', error: 'no permission' });
+            return;
+        }
+        if (permissions) {
+            const { permissions: list } = yield getPermissionsByRole(client, req.headers['x-user-role']);
+            if (!permissions.some((x) => (list || []).some((y) => y.name === x))) {
+                res.status(403).json({ code: 'forbidden', error: 'no permission' });
+                return;
+            }
+        }
+        next();
+    });
 };
+module.exports = AuthMiddleware;

package/lib/middlewares/component.d.ts

@@ -0,0 +1,7 @@
+import { NextFunction, Request, Response } from 'express';
+declare const verifySig: (req: Request, res: Response, next: NextFunction) => void | Response<any, Record<string, any>>;
+export { verifySig };
+declare const _default: {
+    verifySig: (req: Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: Response<any, Record<string, any>>, next: NextFunction) => void | Response<any, Record<string, any>>;
+};
+export default _default;

package/lib/middlewares/component.js

@@ -1,28 +1,32 @@
-const stableStringify = require('json-stable-stringify');
-
-const getWallet = require('../wallet');
-const config = require('../config');
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.verifySig = void 0;
+const json_stable_stringify_1 = __importDefault(require("json-stable-stringify"));
+const wallet_1 = __importDefault(require("../wallet"));
+const config_1 = require("../config");
 const verifySig = (req, res, next) => {
-  try {
-    const wallet = getWallet();
-    const sig = req.get('x-component-sig');
-    if (!sig) {
-      return res.status(400).json({ error: 'Bad Request' });
+    try {
+        const wallet = (0, wallet_1.default)();
+        const sig = req.get('x-component-sig');
+        if (!sig) {
+            return res.status(400).json({ error: 'Bad Request' });
+        }
+        const data = typeof req.body === 'undefined' ? {} : req.body;
+        const verified = wallet.verify((0, json_stable_stringify_1.default)(data), sig);
+        if (!verified) {
+            return res.status(401).json({ error: 'verify sig failed' });
+        }
     }
-
-    const data = typeof req.body === 'undefined' ? {} : req.body;
-
-    const verified = wallet.verify(stableStringify(data), sig);
-    if (!verified) {
-      return res.status(401).json({ error: 'verify sig failed' });
+    catch (error) {
+        config_1.logger.error(error);
+        return res.status(401).json({ error: 'verify sig failed' });
     }
-  } catch (error) {
-    config.logger.error(error);
-    return res.status(401).json({ error: 'verify sig failed' });
-  }
-
-  return next();
+    return next();
+};
+exports.verifySig = verifySig;
+exports.default = {
+    verifySig,
 };
-
-module.exports = { verifySig };

package/lib/middlewares/index.d.ts

@@ -0,0 +1,20 @@
+import user from './user';
+import auth from './auth';
+import component from './component';
+export { user };
+export { auth };
+export { component };
+declare const _default: {
+    user: () => (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>> & {
+        user?: {
+            did: string;
+            role: string;
+            fullName: string;
+        };
+    }, res: import("express").Response<any, Record<string, any>>, next: import("express").NextFunction) => Promise<void>;
+    auth: ({ roles, permissions, _AuthClient }?: any) => (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: import("express").Response<any, Record<string, any>>, next: import("express").NextFunction) => Promise<void>;
+    component: {
+        verifySig: (req: import("express").Request<import("express-serve-static-core").ParamsDictionary, any, any, import("qs").ParsedQs, Record<string, any>>, res: import("express").Response<any, Record<string, any>>, next: import("express").NextFunction) => void | import("express").Response<any, Record<string, any>>;
+    };
+};
+export default _default;

package/lib/middlewares/index.js

@@ -1,9 +1,17 @@
-const user = require('./user');
-const auth = require('./auth');
-const component = require('./component');
-
-module.exports = {
-  user,
-  auth,
-  component,
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.component = exports.auth = exports.user = void 0;
+const user_1 = __importDefault(require("./user"));
+exports.user = user_1.default;
+const auth_1 = __importDefault(require("./auth"));
+exports.auth = auth_1.default;
+const component_1 = __importDefault(require("./component"));
+exports.component = component_1.default;
+exports.default = {
+    user: user_1.default,
+    auth: auth_1.default,
+    component: component_1.default,
 };

package/lib/middlewares/user.d.ts

@@ -0,0 +1,10 @@
+import { NextFunction, Request, Response } from 'express';
+declare type User = {
+    did: string;
+    role: string | undefined;
+    fullName: string;
+};
+declare const userMiddleware: () => (req: Request & {
+    user?: User;
+}, res: Response, next: NextFunction) => Promise<void>;
+export = userMiddleware;

package/lib/middlewares/user.js

@@ -1,11 +1,21 @@
-module.exports = () => async (req, res, next) => {
-  if (req.headers['x-user-did']) {
-    req.user = {
-      did: req.headers['x-user-did'],
-      role: req.headers['x-user-role'],
-      fullName: decodeURIComponent(req.headers['x-user-fullname']),
-    };
-  }
-
-  next();
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
 };
+const userMiddleware = () => (req, res, next) => __awaiter(void 0, void 0, void 0, function* () {
+    if (req.headers['x-user-did']) {
+        req.user = {
+            did: req.headers['x-user-did'],
+            role: req.headers['x-user-role'],
+            fullName: decodeURIComponent(req.headers['x-user-fullname']),
+        };
+    }
+    next();
+});
+module.exports = userMiddleware;

package/lib/security/index.d.ts

@@ -0,0 +1,9 @@
+declare const encrypt: (message: string) => string;
+declare const decrypt: (message: string) => string;
+export { encrypt };
+export { decrypt };
+declare const _default: {
+    encrypt: (message: string) => string;
+    decrypt: (message: string) => string;
+};
+export default _default;

package/lib/security/index.js

@@ -1,26 +1,27 @@
-const crypto = require('crypto');
-const AES = require('@ocap/mcrypto/lib/crypter/aes').default;
-
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.decrypt = exports.encrypt = void 0;
+const crypto_1 = __importDefault(require("crypto"));
+const aes_1 = __importDefault(require("@ocap/mcrypto/lib/crypter/aes"));
+const AES = { default: aes_1.default }.default;
 const encrypt = (message) => {
-  if (!process.env.BLOCKLET_DID || !process.env.BLOCKLET_APP_EK) {
-    return message;
-  }
-  return AES.encrypt(
-    message,
-    crypto.pbkdf2Sync(process.env.BLOCKLET_APP_EK, process.env.BLOCKLET_DID, 256, 32, 'sha512').toString('hex')
-  );
+    if (!process.env.BLOCKLET_DID || !process.env.BLOCKLET_APP_EK) {
+        return message;
+    }
+    return AES.encrypt(message, crypto_1.default.pbkdf2Sync(process.env.BLOCKLET_APP_EK, process.env.BLOCKLET_DID, 256, 32, 'sha512').toString('hex'));
 };
+exports.encrypt = encrypt;
 const decrypt = (message) => {
-  if (!process.env.BLOCKLET_DID || !process.env.BLOCKLET_APP_EK) {
-    return message;
-  }
-  return AES.decrypt(
-    message,
-    crypto.pbkdf2Sync(process.env.BLOCKLET_APP_EK, process.env.BLOCKLET_DID, 256, 32, 'sha512').toString('hex')
-  );
+    if (!process.env.BLOCKLET_DID || !process.env.BLOCKLET_APP_EK) {
+        return message;
+    }
+    return AES.decrypt(message, crypto_1.default.pbkdf2Sync(process.env.BLOCKLET_APP_EK, process.env.BLOCKLET_DID, 256, 32, 'sha512').toString('hex'));
 };
-
-module.exports = {
-  encrypt,
-  decrypt,
+exports.decrypt = decrypt;
+exports.default = {
+    encrypt,
+    decrypt,
 };

package/lib/service/auth.d.ts

@@ -0,0 +1,9 @@
+import Client from '@abtnode/client';
+declare type $TSFixMe = any;
+declare class AuthService extends Client {
+    _blockletDid: string;
+    setAuthAccessKey: $TSFixMe;
+    constructor(httpEndpoint: string);
+    _getAuthHeaders(): any;
+}
+export = AuthService;