@blocklet/meta 1.7.8 → 1.7.11

package/lib/parse-navigation.js

@@ -17,7 +17,7 @@ const parseNavigation = (navigation, blocklet, prefix = '/', level = 1) => {
       };
 
       if (nav.link) {
-        item.link = normalizePathPrefix(`${prefix}${nav.link || '/'}`);
+        item.link = nav.link.startsWith('/') ? normalizePathPrefix(`${prefix}${nav.link || '/'}`) : nav.link;
       }
 
       if (level === 1) {

package/lib/service-configs/auth.json

@@ -0,0 +1,66 @@
+{
+  "name": "auth",
+  "description": "Neat and easy to use user authentication and authorization service for blocklets",
+  "version": "1.0.0",
+  "schema": {
+    "JSONSchema": {
+      "title": "Config Auth Service",
+      "description": "Customize how Auth Service works",
+      "type": "object",
+      "required": ["profileFields", "webWalletUrl"],
+      "properties": {
+        "whoCanAccess": {
+          "type": "string",
+          "title": "Who can access the blocklet?",
+          "enum": ["owner", "invited", "all"],
+          "default": "all"
+        },
+        "profileFields": {
+          "type": "array",
+          "title": "What info do you want user to provide when login?",
+          "items": {
+            "type": "string",
+            "enum": ["fullName", "email", "avatar", "phone"]
+          },
+          "default": ["fullName", "email", "avatar"],
+          "uniqueItems": true
+        },
+        "allowSwitchProfile": {
+          "type": "boolean",
+          "title": "Does you app allow user to switch profile?",
+          "default": true
+        },
+        "webWalletUrl": {
+          "type": "string",
+          "title": "The URL of your preferred web wallet instance",
+          "pattern": "^https?://",
+          "default": "https://web.abtwallet.io"
+        },
+        "ignoreUrls": {
+          "type": "array",
+          "title": "Which URLs do not need to be protected. e.g: /public/**",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "default": []
+        },
+        "blockUnauthenticated": {
+          "type": "boolean",
+          "title": "Do you want Auth Service block unauthenticated requests for you?",
+          "default": false
+        },
+        "blockUnauthorized": {
+          "type": "boolean",
+          "title": "Do you want Auth Service block unauthorized requests for you?",
+          "default": false
+        }
+      }
+    },
+    "UISchema": {
+      "profileFields": {
+        "ui:widget": "checkboxes"
+      }
+    }
+  }
+}

package/lib/service.js

@@ -0,0 +1,101 @@
+const cloneDeep = require('lodash/cloneDeep');
+const Ajv = require('ajv').default;
+
+const { NODE_SERVICES } = require('@abtnode/constant');
+
+const ajv = new Ajv({
+  useDefaults: true,
+  removeAdditional: 'all',
+});
+
+const SERVICES = {};
+
+const setService = (meta) => {
+  const validate = ajv.compile(meta.schema.JSONSchema);
+
+  // parse empty custom config to get default config
+  const defaultConfig = {};
+  validate(defaultConfig);
+
+  SERVICES[meta.name] = {
+    meta,
+    validate,
+    defaultConfig,
+  };
+};
+
+setService(require('./service-configs/auth.json'));
+
+// backward compatible
+SERVICES[NODE_SERVICES.AUTH_SERVICE] = {
+  ...SERVICES[NODE_SERVICES.AUTH],
+  meta: {
+    ...SERVICES[NODE_SERVICES.AUTH].meta,
+    name: NODE_SERVICES.AUTH_SERVICE,
+  },
+};
+
+const getServiceMetas = ({ stringifySchema = false } = {}) => {
+  const list = Object.values(SERVICES).map(({ meta }) => {
+    const data = cloneDeep(meta);
+    if (stringifySchema) {
+      data.schema = JSON.stringify(meta.schema);
+    }
+    return data;
+  });
+
+  return list;
+};
+
+const getService = (serviceName) => {
+  if (!serviceName) {
+    throw new Error('service name should not be empty');
+  }
+
+  const service = SERVICES[serviceName];
+  if (!service) {
+    throw new Error(`service ${serviceName} does not exist`);
+  }
+
+  return service;
+};
+
+const getServiceConfig = (serviceName, customConfig, { validate } = {}) => {
+  const service = getService(serviceName);
+
+  const data = cloneDeep(customConfig || {});
+  // this method may have side effect thar will fill default value to customConfig
+  const valid = service.validate(data || {});
+
+  if (validate && !valid) {
+    const message = service.validate.errors.map((x) => `${x.instancePath} ${x.message}`).join(', ');
+    throw new Error(`Invalid blocklet service config: ${message}`);
+  }
+
+  return data;
+};
+
+const getDefaultServiceConfig = (serviceName) => {
+  const { defaultConfig } = getService(serviceName);
+
+  return defaultConfig;
+};
+
+const findService = (services, name) => {
+  const names = [name];
+
+  // backward compatible
+  if (name === NODE_SERVICES.AUTH) {
+    names.push(NODE_SERVICES.AUTH_SERVICE);
+  }
+
+  return (services || []).find((x) => names.includes(x.name));
+};
+
+module.exports = {
+  getServiceMetas,
+  getServiceConfig,
+  getDefaultServiceConfig,
+  findService,
+  setService,
+};

package/lib/validate.js

@@ -1,14 +1,7 @@
-const Ajv = require('ajv').default;
-const cloneDeep = require('lodash/cloneDeep');
-
 const { createBlockletSchema } = require('./schema');
+const { getServiceConfig } = require('./service');
 
-const fixAndValidateService = (meta, serviceMetas) => {
-  const ajv = new Ajv({
-    useDefaults: true,
-    removeAdditional: 'all',
-  });
-
+const fixAndValidateService = (meta) => {
   if (!meta.interfaces) {
     return meta;
   }
@@ -19,26 +12,7 @@ const fixAndValidateService = (meta, serviceMetas) => {
   meta.interfaces.forEach((d) => {
     if (d.services && d.services.length) {
       d.services.forEach((s) => {
-        const config = cloneDeep(s.config) || {};
-
-        // validate service.config if serviceMetaList is exist
-        if (serviceMetas) {
-          const serviceMeta = serviceMetas.find((x) => x.name === s.name);
-          if (!serviceMeta) {
-            throw new Error(`Invalid blocklet service: ${s.name} does not exist`);
-          }
-
-          const validate = ajv.compile(serviceMeta.schema.JSONSchema);
-          // this method may have side effect thar will fill default value to config
-          const valid = validate(config);
-
-          if (!valid) {
-            const message = validate.errors.map((x) => `${x.dataPath} ${x.message}`).join(', ');
-            throw new Error(`Invalid blocklet service config: ${message}`);
-          }
-        }
-
-        s.config = config;
+        s.config = getServiceConfig(s.name, s.config, { validate: true });
       });
     }
   });

package/lib/verify-multi-sig.js

@@ -1,12 +1,14 @@
-const debug = require('debug')('@blocklet/meta:verifyMultiSig');
-const stableStringify = require('json-stable-stringify');
-const cloneDeep = require('lodash/cloneDeep');
+const get = require('lodash/get');
 const omit = require('lodash/omit');
+const cloneDeep = require('lodash/cloneDeep');
+const stableStringify = require('json-stable-stringify');
 const { toTypeInfo } = require('@arcblock/did');
 const { fromPublicKey } = require('@ocap/wallet');
 const { verify } = require('@arcblock/jwt');
 const { fromBase64 } = require('@ocap/util');
 
+const debug = require('debug')('@blocklet/meta:verifyMultiSig');
+
 function verifyDelegationToken(signature) {
   if (signature.delegation) {
     const payload = JSON.parse(fromBase64(signature.delegation.split('.')[1]));
@@ -21,7 +23,7 @@ function verifyDelegationToken(signature) {
       return false;
     }
 
-    if (!payload?.permissions?.includes('publish_blocklet')) {
+    if (!get(payload, 'permissions', []).includes('publish_blocklet')) {
       debug('verify payload.permissions failed', payload);
       return false;
     }

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.8",
+  "version": "1.7.11",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,18 +18,18 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.7.8",
-    "@abtnode/util": "1.7.8",
-    "@arcblock/did": "^1.16.3",
-    "@arcblock/did-ext": "^1.16.3",
-    "@arcblock/did-util": "^1.16.3",
-    "@arcblock/jwt": "^1.16.3",
-    "@arcblock/nft": "^1.16.3",
-    "@ocap/asset": "^1.16.3",
-    "@ocap/mcrypto": "^1.16.3",
-    "@ocap/util": "^1.16.3",
-    "@ocap/wallet": "^1.16.3",
-    "ajv": "^7.0.3",
+    "@abtnode/constant": "1.7.11",
+    "@abtnode/util": "1.7.11",
+    "@arcblock/did": "^1.16.5",
+    "@arcblock/did-ext": "^1.16.5",
+    "@arcblock/did-util": "^1.16.5",
+    "@arcblock/jwt": "^1.16.5",
+    "@arcblock/nft": "^1.16.5",
+    "@ocap/asset": "^1.16.5",
+    "@ocap/mcrypto": "^1.16.5",
+    "@ocap/util": "^1.16.5",
+    "@ocap/wallet": "^1.16.5",
+    "ajv": "^8.11.0",
     "cjk-length": "^1.0.0",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.1",
@@ -46,5 +46,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "ae75dd20b4750a31dc53c88b75ed1d95c8f15397"
+  "gitHead": "84e741e6b37e47d52bf834ce3ace8ed601d0896c"
 }