@blocklet/sdk 1.7.7 → 1.7.10

package/README.md

@@ -28,7 +28,7 @@ const userDid = 'xxxxxxxx';
 const { user } = await client.getUser(userDid);
 ```
 
-### Api
+### API
 
 #### client.getUser(did)
 
@@ -37,9 +37,16 @@ Get user by user did
 - _@param_ **did** `string`
 - _@return_ `{ code, user }`
 
+#### client.getOwner()
+
+Get owner of the app
+
+- _@param_ **did** `string`
+- _@return_ `{ code, user }`
+
 #### client.getUsers()
 
-Get all users of the team
+Get all users of the app
 
 - _@return_ `{ code, users }`
 
@@ -52,7 +59,7 @@ Get all permissions of a role
 
 #### client.getRoles()
 
-Get all roles of the team
+Get all roles of the app
 
 - _@return_ `{ code, roles }`
 
@@ -104,7 +111,7 @@ Full update permissions of a role
 
 #### client.getPermissions()
 
-Get all permissions of the team
+Get all permissions of the app
 
 - _@return_ `{ code, permissions }`
 
@@ -167,7 +174,7 @@ await Notification.sendToUser([userDid, anotherUserDid], notification);
 await Notification.sendToUser([userDid, anotherUserDid], [notification, anotherNotification]);
 ```
 
-### Api
+### API
 
 #### notification.sendToUser(receiver, notification)
 
@@ -268,6 +275,26 @@ const { Database } = require('@blocklet/sdk');
 })();
 ```
 
+## Log SDK
+
+For Blocklet to write business logs, provides a consistent write format.
+
+### Usage
+
+```javascript
+const { logger } = require('@blocklet/sdk');
+
+// log
+log = logger('demo');
+log.info('this is demo', { id: 'test-id' });
+log.warn('this is demo', { id: 'test-id' });
+log.error('this is demo', { id: 'test-id' });
+log.debug('this is demo', { id: 'test-id' });
+
+// access log
+app.use(morgan('combined', { stream: logger.getAccessLogStream() }));
+```
+
 ## getWallet
 
 ### Usage

package/lib/index.js

@@ -6,6 +6,7 @@ const Database = require('./database');
 const env = require('./env');
 const middlewares = require('./middlewares');
 const getWallet = require('./wallet');
+const logger = require('./logger');
 
 module.exports = {
   AuthService,
@@ -16,4 +17,5 @@ module.exports = {
   getWallet,
   env,
   middlewares,
+  logger,
 };

package/lib/logger.js

@@ -0,0 +1,8 @@
+const logger = require('@abtnode/logger');
+
+if (!process.env.BLOCKLET_LOG_DIR) {
+  throw new Error('valid BLOCKLET_LOG_DIR env is required by logger');
+}
+
+module.exports = (label) => logger(label, { logDir: process.env.BLOCKLET_LOG_DIR, filename: 'info' });
+module.exports.getAccessLogStream = () => logger.getAccessLogStream(process.env.BLOCKLET_LOG_DIR);

package/lib/service/auth.js

@@ -37,6 +37,7 @@ class AuthService extends Client {
       // user
       'getUsers',
       'getUser',
+      'getOwner',
       // 'removeUser',
       'updateUserRole', // deprecated
       // 'updateUserApproval',

package/lib/util/send-notification.js

@@ -1,5 +1,6 @@
 /* eslint-disable global-require */
 const axios = require('axios').create({ proxy: false });
+const pick = require('lodash/pick');
 
 const JWT = require('@arcblock/jwt');
 const { NODE_MODES } = require('@abtnode/constant');
@@ -29,7 +30,8 @@ module.exports = async (
   options = {}
 ) => {
   await validateReceiver(receiver);
-  await validateOption(options);
+  const opt = pick(options, ['keepForOfflineUser']);
+  await validateOption(opt);
 
   if (SERVER_MODE !== NODE_MODES.DEBUG) {
     await validateNotification(notification);
@@ -44,7 +46,7 @@ module.exports = async (
         sender: { did, token, appDid: appId },
         receiver,
         notification,
-        options,
+        options: opt,
       },
     });
 

package/lib/wallet-handler.js

@@ -75,7 +75,8 @@ class WalletHandlers extends Handler {
           message.checkUrl = checkUrl.href;
         }
 
-        this.sendNotificationFn(connectedDid, message).catch((err) => {
+        // sendNotificationFn maybe custom function so we need params
+        this.sendNotificationFn(connectedDid, message, params).catch((err) => {
           console.error(err);
           if (typeof opts.onError === 'function') {
             opts.onError(err);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.7",
+  "version": "1.7.10",
   "description": "graphql client to read/write data on abt node",
   "main": "lib/index.js",
   "files": [
@@ -19,16 +19,17 @@
   "author": "linchen1987 <linchen.1987@foxmail.com> (http://github.com/linchen1987)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.7.7",
-    "@abtnode/constant": "1.7.7",
-    "@arcblock/did-auth": "^1.16.0",
-    "@arcblock/jwt": "^1.16.0",
-    "@arcblock/ws": "^1.16.0",
-    "@blocklet/meta": "1.7.7",
+    "@abtnode/client": "1.7.10",
+    "@abtnode/constant": "1.7.10",
+    "@abtnode/logger": "1.7.10",
+    "@arcblock/did-auth": "^1.16.5",
+    "@arcblock/jwt": "^1.16.5",
+    "@arcblock/ws": "^1.16.5",
+    "@blocklet/meta": "1.7.10",
     "@nedb/core": "^1.2.2",
-    "@ocap/mcrypto": "^1.16.0",
-    "@ocap/wallet": "^1.16.0",
-    "axios": "^0.25.0",
+    "@ocap/mcrypto": "^1.16.5",
+    "@ocap/wallet": "^1.16.5",
+    "axios": "^0.26.1",
     "fs-extra": "^10.0.1",
     "joi": "^17.6.0",
     "lodash": "^4.17.21",
@@ -39,5 +40,5 @@
     "detect-port": "^1.3.0",
     "jest": "^27.4.5"
   },
-  "gitHead": "619db37ea7a91c64a9bf30836a55c70d55325e73"
+  "gitHead": "8eab10fd39b6183a2fa4d2706f52e8b2ecaa059a"
 }