@blocklet/sdk 1.8.15 → 1.8.18

package/lib/component/index.js

@@ -0,0 +1,79 @@
+const axios = require('axios').default;
+const get = require('lodash/get');
+const joinURL = require('url-join');
+const stableStringify = require('json-stable-stringify');
+const { getParentComponentName } = require('@blocklet/meta/lib/util');
+
+const getWallet = require('../wallet');
+const config = require('../config');
+
+const parseMountPoints = () => JSON.parse(process.env.BLOCKLET_MOUNT_POINTS);
+const parsePorts = () => JSON.parse(process.env.BLOCKLET_WEB_PORTS);
+
+const call = async ({ name, path: _path, data }) => {
+  const baseURL = name ? getChildWebEndpoint(name) : getParentWebEndpoint();
+  const url = joinURL(baseURL, _path);
+
+  return doCall({ url, data });
+};
+
+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);
+};
+
+const getParentWebEndpoint = () => {
+  const parentName = getParentComponentName(process.env.BLOCKLET_REAL_NAME);
+  return getWebEndpoint(parentName);
+};
+
+const getComponentMountPoint = (s) => {
+  const mountPoints = parseMountPoints();
+  const item = mountPoints.find((x) => [x.title, x.name, x.did].includes(s));
+  return item ? item.mountPoint : '';
+};
+
+const getComponentMountPoints = () => {
+  return parseMountPoints();
+};
+
+const sign = (data) => {
+  const wallet = getWallet();
+  const signData = typeof data === 'undefined' ? {} : data;
+
+  return { 'x-component-sig': wallet.sign(stableStringify(signData)) };
+};
+
+const doCall = async ({ url, data }) => {
+  try {
+    const resp = await axios.post(url, data, { headers: sign(data), timeout: 60000 });
+    config.logger.info(`call ${url} api success`);
+    return resp;
+  } catch (error) {
+    config.logger.error(`call ${url} api failed`, {
+      url,
+      responseStatus: get(error, 'response.status'),
+      responseData: get(error, 'response.data'),
+      error,
+    });
+
+    throw new Error(`call ${url} api failed`);
+  }
+};
+
+module.exports = {
+  call,
+  getComponentMountPoint,
+  getComponentMountPoints,
+  getWebEndpoint,
+  getChildWebEndpoint,
+  getParentWebEndpoint,
+};

package/lib/config.js

@@ -0,0 +1,14 @@
+/* eslint-disable no-console */
+
+module.exports = {
+  logger: {
+    info: console.log,
+    debug: (...args) => {
+      if (process.env.NODE_ENV === 'development') {
+        console.debug(...args);
+      }
+    },
+    warn: console.warn,
+    error: console.error,
+  },
+};

package/lib/database/index.js

@@ -0,0 +1,41 @@
+const fs = require('fs-extra');
+const path = require('path');
+const { DataStore: BaseStore } = require('@nedb/core');
+
+if (!process.env.BLOCKLET_DATA_DIR) {
+  throw new Error('Blocklet SDK must be used in blocklet runtime');
+}
+
+const DB_DIR = path.join(process.env.BLOCKLET_DATA_DIR, 'db');
+fs.ensureDirSync(DB_DIR);
+
+module.exports = class DataStore extends BaseStore {
+  constructor(name, options = {}) {
+    const filename = options.filename || path.join(DB_DIR, `${name}.db`);
+    super({
+      filename,
+      autoload: true,
+      timestampData: true,
+      onload: (err) => {
+        if (err) {
+          console.error(`failed to load disk database ${filename}`, err);
+        }
+      },
+      ...options,
+    });
+  }
+
+  async exists(...args) {
+    const doc = await this.findOne(...args);
+    return !!doc;
+  }
+
+  async paginate({ condition = {}, sort = {}, page = 1, size = 100, projection = {} }) {
+    return this.cursor(condition)
+      .sort(sort)
+      .skip(Math.max(page * size - size, 0))
+      .limit(Math.max(size, 1))
+      .projection(projection)
+      .exec();
+  }
+};

package/lib/env.js

@@ -1,35 +1,3 @@
-const { getParentComponentName } = require('@blocklet/meta/lib/util');
-
-const parsePorts = () => JSON.parse(process.env.BLOCKLET_WEB_PORTS);
-const parseMountPoints = () => JSON.parse(process.env.BLOCKLET_MOUNT_POINTS);
-
-const getComponentMountPoint = (s) => {
-  const mountPoints = parseMountPoints();
-  const item = mountPoints.find((x) => [x.title, x.name, x.did].includes(s));
-  return item ? item.mountPoint : '';
-};
-
-const getComponentMountPoints = () => {
-  return parseMountPoints();
-};
-
-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);
-};
-const getParentWebEndpoint = () => {
-  const parentName = getParentComponentName(process.env.BLOCKLET_REAL_NAME);
-  return getWebEndpoint(parentName);
-};
-
 module.exports = Object.freeze({
   appId: process.env.BLOCKLET_APP_ID,
   appName: process.env.BLOCKLET_APP_NAME,
@@ -39,9 +7,4 @@ module.exports = Object.freeze({
   dataDir: process.env.BLOCKLET_DATA_DIR,
   cacheDir: process.env.BLOCKLET_CACHE_DIR,
   mode: process.env.BLOCKLET_MODE,
-  getWebEndpoint,
-  getChildWebEndpoint,
-  getParentWebEndpoint,
-  getComponentMountPoints,
-  getComponentMountPoint,
 });

package/lib/index.js

@@ -8,6 +8,8 @@ const Database = require('./database');
 const env = require('./env');
 const middlewares = require('./middlewares');
 const getWallet = require('./wallet');
+const component = require('./component');
+const config = require('./config');
 
 module.exports = {
   AuthService,
@@ -20,4 +22,6 @@ module.exports = {
   getWallet,
   env,
   middlewares,
+  component,
+  config,
 };

package/lib/middlewares/component.js

@@ -0,0 +1,28 @@
+const stableStringify = require('json-stable-stringify');
+
+const getWallet = require('../wallet');
+const config = 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' });
+    }
+
+    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.logger.error(error);
+    return res.status(401).json({ error: 'verify sig failed' });
+  }
+
+  return next();
+};
+
+module.exports = { verifySig };

package/lib/middlewares/index.js

@@ -1,7 +1,9 @@
 const user = require('./user');
 const auth = require('./auth');
+const component = require('./component');
 
 module.exports = {
   user,
   auth,
+  component,
 };

package/lib/service/auth.js

@@ -59,11 +59,12 @@ class AuthService extends Client {
       'hasPermission',
 
       // user passport
+      'issuePassportToUser',
+      'revokeUserPassport',
+      'enableUserPassport',
       // 'getPassportIssuances',
       // 'createPassportIssuance',
       // 'deletePassportIssuance',
-      // 'revokeUserPassport',
-      // 'enableUserPassport',
 
       // permission
       'getPermissions',

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.15",
+  "version": "1.8.18",
   "description": "graphql client to read/write data on abt node",
   "main": "lib/index.js",
   "files": [
@@ -19,20 +19,21 @@
   "author": "linchen1987 <linchen.1987@foxmail.com> (http://github.com/linchen1987)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.8.15",
-    "@abtnode/constant": "1.8.15",
-    "@arcblock/did-auth": "1.17.17",
-    "@arcblock/jwt": "1.17.17",
-    "@arcblock/ws": "1.17.17",
-    "@blocklet/meta": "1.8.15",
-    "@did-connect/authenticator": "^2.1.11",
-    "@did-connect/handler": "^2.1.11",
-    "@nedb/core": "^1.3.4",
-    "@ocap/mcrypto": "1.17.17",
-    "@ocap/wallet": "1.17.17",
+    "@abtnode/client": "1.8.18",
+    "@abtnode/constant": "1.8.18",
+    "@arcblock/did-auth": "1.17.19",
+    "@arcblock/jwt": "1.17.19",
+    "@arcblock/ws": "1.17.19",
+    "@blocklet/meta": "1.8.18",
+    "@did-connect/authenticator": "^2.1.13",
+    "@did-connect/handler": "^2.1.13",
+    "@nedb/core": "^2.0.3",
+    "@ocap/mcrypto": "1.17.19",
+    "@ocap/wallet": "1.17.19",
     "axios": "^0.27.2",
     "fs-extra": "^10.1.0",
     "joi": "^17.6.0",
+    "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
     "lru-cache": "^6.0.0",
     "url-join": "^4.0.1"
@@ -41,5 +42,5 @@
     "detect-port": "^1.3.0",
     "jest": "^27.5.1"
   },
-  "gitHead": "57106db1b559b906734df5b8eac7ce87cae72980"
+  "gitHead": "7d82c570913bedf740afca15c27ef10d05aa85fc"
 }

package/lib/database.js

@@ -1,98 +0,0 @@
-const path = require('path');
-const fs = require('fs-extra');
-const { PromisedDatastore } = require('@nedb/core');
-
-if (!process.env.BLOCKLET_DATA_DIR) {
-  throw new Error('valid BLOCKLET_DATA_DIR env is required');
-}
-
-const DB_DIR = path.join(process.env.BLOCKLET_DATA_DIR, 'db');
-fs.ensureDirSync(DB_DIR);
-
-/**
- * 判断查询的数据是否存在
- * 因为函数的定义是判断指定条件是否存在，所以需要直接返回结果，而不是返回一个 nedb 对象或 nedb cursor 对象
- * @returns Boolean
- */
-async function exists(...args) {
-  const tmp = await this.findOne(...args);
-  return !!tmp;
-}
-
-/**
- * 分页查询
- * 这里需要返回一个 nedb cursor 对象，因为后续可能还会链式操作别的方法，所以不能使用 await
- * @param {number} page 页码
- * @param {number} size 分页大小
- * @returns nedb cursor
- */
-function paginate(page, size) {
-  const tmp = this.skip(page * size - size).limit(size);
-  return tmp;
-}
-
-/**
- * 代理 nedb cursor，如果需要对查询条件做扩展，需要把方法添加到这里
- * @param {Nedb Cursor} cursor
- * @returns nedb cursor
- */
-function proxyCursor(cursor) {
-  return new Proxy(cursor, {
-    get(target, prop) {
-      if (prop === 'paginate') return paginate;
-
-      return target[prop];
-    },
-  });
-}
-
-/**
- * 代理 nedb 对象，如果需要在 nedb 上增加方法，需要把方法添加到这里
- * @param {Nedb} db nedb
- * @returns promise
- */
-function proxyNedb(db) {
-  return new Proxy(db, {
-    get(target, prop) {
-      const propFn = target[prop];
-      if (prop === 'exists') return exists;
-
-      if (PromisedDatastore.CURSOR_FN_LIST.includes(prop)) {
-        return function wrap(...args) {
-          const rawFn = propFn.bind(this)(...args);
-          return proxyCursor(rawFn);
-        };
-      }
-      return propFn;
-    },
-  });
-}
-
-module.exports = function Datastore(name, options = {}) {
-  if (!new.target) {
-    throw new Error("This function must called by 'new' command!");
-  }
-  const filename = options.filename || path.join(DB_DIR, `${name}.db`);
-  const db = new PromisedDatastore({
-    filename,
-    autoload: true,
-    timestampData: true,
-    onload: (err) => {
-      if (err) {
-        console.error(`failed to load disk database ${filename}`, err);
-      }
-    },
-    ...options,
-  });
-
-  const proxyDb = proxyNedb(db);
-
-  // 如果直接返回 proxyDb，则无法使用 class 的 extends 进行类的方法扩展
-  // 这个 proxy 首先会判断自身是否有这个方法，如果有，则直接返回；如果没有，则会去 proxyDb 中查找
-  return new Proxy(this, {
-    get(target, prop) {
-      if (target[prop]) return target[prop];
-      return proxyDb[prop];
-    },
-  });
-};