@blocklet/sdk 1.8.12 → 1.8.13

package/README.md

@@ -2,364 +2,4 @@
 
 Blocklet SDK for blocklet developer
 
-## Install
-
-```shell
-yarn add @blocklet/sdk
-```
-
-or
-
-```shell
-npm install @blocklet/sdk
-```
-
-## Auth SDK
-
-### Usage
-
-```javascript
-const Auth = require('@blocklet/sdk/service/auth');
-
-const client = new Auth();
-
-const userDid = 'xxxxxxxx';
-
-const { user } = await client.getUser(userDid);
-```
-
-### API
-
-#### client.getUser(did)
-
-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 app
-
-- _@param_ **paging** `Object`
-  - **paging.pageSize** ``
-  - **paging.page** ``
-- _@param_ **query** `Object`
-  - **query.role** `String` Match users by role name
-    - `$none`: Match users which does not have a role
-  - **query.approved** `Boolean` Match users by approved
-  - **query.search** `String` Match users by did or fullName
-- _@param_ **sort** `Object`
-  - **sort.createdAt** `Number`
-  - **sort.updatedAt** `Number`
-  - **sort.lastLoginAt** `Number`
-  - > `-1`: The latest time is at first. `1`: The latest time is at last.
-- _@return_ `{ code, users, paging }`
-
-```
-Paging {
-  total: number of users
-  pageSize: number of users per page
-  pageCount: number of page
-  page: current page number
-}
-```
-
-#### client.getPermissionsByRole(role)
-
-Get all permissions of a role
-
-- _@param_ **role** `string`
-- _@return_ `{ code, permissions }`
-
-#### client.getRoles()
-
-Get all roles of the app
-
-- _@return_ `{ code, roles }`
-
-#### client.createRole({ name, title, description })
-
-- _@param_ **name** `string` the key of the role, should be unique
-- _@param_ **title** `string`
-- _@param_ **description** `string`
-- _@return_ `{ code, role }`
-
-#### client.updateRole(name, { title, description })
-
-- _@param_ **name** `string` the key of the role
-- _@param_ **title** `string`
-- _@param_ **description** `string`
-- _@return_ `{ code, role }`
-
-#### client.deleteRole(name, { title, description })
-
-- _@param_ **name** `string` the key of the role
-- _@return_ `{ code }`
-
-#### client.grantPermissionForRole(role, permission)
-
-- _@param_ **role** `string` the name of the role
-- _@param_ **permission** `string` the name of the permission
-- _@return_ `{ code }`
-
-#### client.revokePermissionFromRole(role, permission)
-
-- _@param_ **role** `string` the name of the role
-- _@param_ **permission** `string` the name of the permission
-- _@return_ `{ code }`
-
-#### client.updatePermissionsForRole(role, permissions)
-
-Full update permissions of a role
-
-- _@param_ **role** `string` the name of the role
-- _@param_ **permissions** `array<string>` name of the permissions
-- _@return_ `{ code, role }`
-
-#### client.hasPermission(role, permission)
-
-- _@param_ **role** `string` the name of the role
-- _@param_ **permission** `string` the name of the permission
-- _@return_ `{ code, result }`
-  - **result** `boolean`
-
-#### client.getPermissions()
-
-Get all permissions of the app
-
-- _@return_ `{ code, permissions }`
-
-#### client.createPermission({ name, title, description })
-
-- _@param_ **name** `Permission` the key of the permission, should be unique
-  - format: `<action>_<resource>`. e.g. `query_article`, `mutate_user`
-- _@param_ **description** `string`
-- _@return_ `{ code, role }`
-
-#### client.updatePermission(name, { title, description })
-
-- _@param_ **name** `string` the key of the role
-- _@param_ **title** `string`
-- _@param_ **description** `string`
-- _@return_ `{ code }`
-
-#### client.deletePermission(name, { title, description })
-
-- _@param_ **name** `string` the key of the permission
-- _@return_ `{ code }`
-
-## Notification SDK
-
-### Usage
-
-```javascript
-const Notification = require('@blocklet/sdk/service/notification');
-
-const userDid = 'xxxxxxxx';
-
-const notification = {
-  title: 'xxx',
-  body: 'xxx',
-  attachments: [
-    {
-      type: 'asset',
-      data: {
-        did: 'xxx',
-        chainHost: 'https://chainhost',
-      },
-    },
-  ],
-  actions: [
-    {
-      name: 'xxx',
-      title: 'Go To Website',
-      link: 'https://arcblock.io',
-    },
-  ],
-};
-
-const content = { message: 'this is a message' };
-const actions = [];
-
-await Notification.sendToUser(userDid, notification);
-
-await Notification.sendToUser(userDid, [notification, anotherNotification]);
-await Notification.sendToUser([userDid, anotherUserDid], notification);
-await Notification.sendToUser([userDid, anotherUserDid], [notification, anotherNotification]);
-```
-
-### API
-
-#### notification.sendToUser(receiver, notification)
-
-Send notification to an account
-
-- **receiver** `string | array<string>` required
-- **notification** `object | array<object>` required
-  - **notification.title** `string`
-  - **notification.body** `string`
-  - **notification.attachments** `array<object>`
-    - **attachment.type** `enum` 'asset', 'vc', 'token' required
-    - **attachment.data** `object`
-      - _type: text_
-        - **type** `string`
-        - **message** `string`
-      - _type: asset_
-        - **did** `string`
-        - **chainHost** `string` uri
-      - _type: vc_
-        - **credential** `object`
-        - **tag** `string`
-      - _type: token_
-        - **address** `string` did
-        - **amount** `string`
-        - **symbol** `string`
-        - **senderDid** `string`
-        - **chainHost** `string`
-        - **decimal** `integer`
-  - **notification.actions** `array<object>`
-    - **name** `string` required
-    - **title** `string`
-    - **color** `string`
-    - **bgColor** `string`
-    - **link** `string` uri
-
-## WalletAuthenticator SDK
-
-### Usage
-
-```javascript
-const { WalletAuthenticator } = require('@blocklet/sdk');
-
-const authenticator = new WalletAuthenticator();
-```
-
-## WalletHandler SDK
-
-### Usage
-
-```javascript
-const AuthStorage = require('@arcblock/did-auth-storage-nedb');
-const { WalletAuthenticator, WalletHandlers } = require('@blocklet/sdk');
-
-const authenticator = new WalletAuthenticator();
-
-const handlers = new WalletHandlers({
-  authenticator,
-  tokenStorage: new AuthStorage({
-    dbPath: path.join(process.env.BLOCKLET_DATA_DIR, 'auth.db'),
-    onload: (err) => {
-      if (err) {
-        // eslint-disable-next-line no-console
-        console.error(`Failed to load database from ${path.join(process.env.BLOCKLET_DATA_DIR, 'auth.db')}`, err);
-      }
-    },
-  }),
-});
-```
-
-## Database SDK
-
-A database library for develop blocklet, it's a wrapper of [nedb](https://www.github.com/Arcblock/nedb).
-Supply a simpler way to use nedb. Just use `new Database([dbName])`, or you can pass a object option as second parameter to create a database as origin nedb way `new Database([dbName], [options])`
-
-Supply full-promise support.
-
-### Usage
-
-```javascript
-const { Database } = require('@blocklet/sdk');
-
-(async () => {
-  const db1 = new Database('db1');
-  const data1 = await db1.find().skip(1).limit(10);
-
-  class MyDatabase extends Database {
-    constructor(name) {
-      super(name);
-    }
-
-    async extraFn() {
-      return 'extra';
-    }
-  }
-  const db2 = new MyDatabase('db2');
-  const data2 = await db2.find().paginate(1, 10);
-  const data2Extra = await db2.extraFn();
-})();
-```
-
-## Log SDK
-
-For Blocklet to write business logs, provides a consistent write format.
-
-### Usage
-
-## getWallet
-
-### Usage
-
-```javascript
-const { getWallet } = require('@blocklet/sdk');
-
-// wallet is an instance of @ocap/wallet const { wallet } = env;
-const wallet = getWallet();
-const { address, secretKey, publicKey } = wallet;
-```
-
-## env
-
-### Usage
-
-```javascript
-const { env } = require('@blocklet/sdk');
-
-const { appId, appName, appDescription, appUrl, isComponent, dataDir, cacheDir } = env;
-```
-
-## middlewares
-
-### Usage
-
-```javascript
-const express = require('express');
-const { middlewares } = require('@blocklet/sdk');
-
-const app = express();
-
-app.get('/', middlewares.user(), (req, res) => {
-  const { did, fullName, role } = req.user;
-});
-
-app.get('/auth1', middlewares.auth(), (req, res) => {
-  // will return 401 if user is not connected
-});
-
-app.get('/auth2', middlewares.auth({ roles: ['admin', 'owner'] }), (req, res) => {
-  // will return 401 if user is not connected
-  // will return 403 if user role is neither owner nor admin
-});
-
-app.get('/auth2', middlewares.auth({ permissions: ['mutate_data', 'query_data'] }), (req, res) => {
-  // will return 401 if user is not connected
-  // will return 403 if neither 'mutate_data' nor 'query data' in user permissions
-});
-
-app.get(
-  '/auth3',
-  middlewares.auth({ roles: ['admin', 'owner'], permissions: ['mutate_data', 'query_data'] }),
-  (req, res) => {
-    // will return 401 if user is not connected
-    // will return 403 if user role is neither owner nor admin
-    // will return 403 if neither 'mutate_data' nor 'query data' in user permissions
-  }
-);
-```
+See [https://developer.blocklet.io/docs/](https://developer.blocklet.io/docs/)

package/lib/env.js

@@ -38,6 +38,7 @@ module.exports = Object.freeze({
   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,
   getWebEndpoint,
   getChildWebEndpoint,
   getParentWebEndpoint,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.12",
+  "version": "1.8.13",
   "description": "graphql client to read/write data on abt node",
   "main": "lib/index.js",
   "files": [
@@ -19,17 +19,17 @@
   "author": "linchen1987 <linchen.1987@foxmail.com> (http://github.com/linchen1987)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.8.12",
-    "@abtnode/constant": "1.8.12",
-    "@arcblock/did-auth": "1.17.12",
-    "@arcblock/jwt": "1.17.12",
-    "@arcblock/ws": "1.17.12",
-    "@blocklet/meta": "1.8.12",
+    "@abtnode/client": "1.8.13",
+    "@abtnode/constant": "1.8.13",
+    "@arcblock/did-auth": "1.17.15",
+    "@arcblock/jwt": "1.17.15",
+    "@arcblock/ws": "1.17.15",
+    "@blocklet/meta": "1.8.13",
     "@did-connect/authenticator": "^2.1.11",
     "@did-connect/handler": "^2.1.11",
     "@nedb/core": "^1.3.4",
-    "@ocap/mcrypto": "1.17.12",
-    "@ocap/wallet": "1.17.12",
+    "@ocap/mcrypto": "1.17.15",
+    "@ocap/wallet": "1.17.15",
     "axios": "^0.27.2",
     "fs-extra": "^10.1.0",
     "joi": "^17.6.0",
@@ -41,5 +41,5 @@
     "detect-port": "^1.3.0",
     "jest": "^27.5.1"
   },
-  "gitHead": "f4cb25a77f7ee48333b3243918a0a9c81b94ab8c"
+  "gitHead": "028f33d8a3a4f999456bfe8e7bd2e1a53b664b47"
 }