@blocklet/meta 1.7.9 → 1.7.12

package/lib/constants.js

@@ -22,6 +22,7 @@ const BlockletStatus = Object.freeze({
   restarting: 11, // Deprecated
   corrupted: 12,
   waiting: 13,
+  deleted: 14,
 });
 
 const fromBlockletStatus = fromEntry(BlockletStatus);
@@ -173,8 +174,8 @@ module.exports = Object.freeze({
 
   BLOCKLET_DEFAULT_VERSION: '1.0.0',
 
-  BLOCKLET_LATEST_SPEC_VERSION: '1.2.4',
-  BLOCKLET_LATEST_REQUIREMENT_SERVER: '>=1.6.2',
+  BLOCKLET_LATEST_SPEC_VERSION: '1.2.7',
+  BLOCKLET_LATEST_REQUIREMENT_SERVER: '>=1.7.0',
   BLOCKLET_LATEST_REQUIREMENT_ABTNODE: '>=1.5.15', // Deprecated
 
   BLOCKLET_CONFIGURABLE_KEY: {

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/schema.js

@@ -24,11 +24,25 @@ const {
 } = require('./constants');
 
 const WELLKNOWN_PATH_PREFIX = '/.well-known';
-const MAX_TITLE_LENGTH = 48;
+const MAX_TITLE_LENGTH = 22;
 const MAX_NAME_LENGTH = 32;
 
 const Joi = JOI.extend(semver).extend(semverRange).extend(fileExtension).extend(didExtension);
 
+const titleSchema = Joi.string()
+  .trim()
+  .min(3)
+  .custom((value) => {
+    if (cjkLength(value) > MAX_TITLE_LENGTH) {
+      throw new Error(
+        `title length should not exceed ${MAX_TITLE_LENGTH} (see: https://www.npmjs.com/package/cjk-length)`
+      );
+    }
+
+    return value;
+  });
+const descriptionSchema = Joi.string().trim().min(3).max(160);
+
 const environmentSchema = Joi.object({
   name: Joi.string().trim().required(),
   description: Joi.string().trim().required(),
@@ -149,6 +163,8 @@ const statsSchema = Joi.object({
 
 const childrenSchema = Joi.object({
   name: Joi.string().min(1).required(),
+  title: titleSchema,
+  description: descriptionSchema,
   resolved: Joi.alternatives().try(Joi.string().uri(), Joi.string()).required(),
   mountPoints: Joi.array() // deprecated
     .items(
@@ -189,18 +205,6 @@ const signatureSchema = Joi.object({
   delegation: Joi.string(),
 });
 
-const titleSchema = Joi.string()
-  .trim()
-  .min(3)
-  .custom((value) => {
-    if (cjkLength(value) > MAX_TITLE_LENGTH) {
-      throw new Error(`Blocklet title is too long. Max length is ${MAX_TITLE_LENGTH}`);
-    }
-
-    return value;
-  });
-const descriptionSchema = Joi.string().trim().min(3).max(160);
-
 const navigationItemSchema = Joi.object({
   title: Joi.string().required(),
   link: Joi.string(),
@@ -400,12 +404,6 @@ const createBlockletSchema = (
     // TODO: this field should be refactored in future version
     engine: Joi.alternatives().try(engineSchema, Joi.array().items(engineSchema)).optional(),
 
-    // TODO: following fields only exist for backward compatibility
-    publicUrl: Joi.string().optional().allow(''),
-    adminUrl: Joi.string().optional().allow(''),
-    configUrl: Joi.string().optional().allow(''),
-    docUrl: Joi.string().optional().allow(''),
-
     // NOTE: following fields are appended by registry or bundling process
     screenshots: Joi.array().items(Joi.string().min(1)).optional().default([]),
     logoUrl: Joi.string().optional().allow(''),
@@ -422,13 +420,11 @@ const createBlockletSchema = (
     // navigation & theme
     navigation: navigationSchema,
     theme: themeSchema,
-  })
-    .rename('public_url', 'publicUrl', { ignoreUndefined: true, override: true })
-    .rename('admin_url', 'adminUrl', { ignoreUndefined: true, override: true })
-    .rename('config_url', 'configUrl', { ignoreUndefined: true, override: true })
-    .rename('tags', 'keywords', { ignoreUndefined: true, override: true })
-    .rename('requiredEnvironments', 'environments', { ignoreUndefined: true, override: true })
-    .options({ stripUnknown: true, noDefaults: false, ...schemaOptions });
+
+    // NOTE: following fields only exist in blocklet server and cannot be set manually
+    bundleName: Joi.string(),
+    bundleDid: Joi.DID().trim(),
+  }).options({ stripUnknown: true, noDefaults: false, ...schemaOptions });
 };
 
 module.exports = {

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/util.js

@@ -1,5 +1,6 @@
 /* eslint-disable no-await-in-loop */
 const get = require('lodash/get');
+const slugify = require('slugify');
 
 const { NODE_SERVICES, SLOT_FOR_IP_DNS_SITE, WHO_CAN_ACCESS } = require('@abtnode/constant');
 
@@ -170,6 +171,14 @@ const fixBlockletStatus = (blocklet) => {
       child.source = fromBlockletSource(child.source);
     }
   });
+  if (blocklet.settings) {
+    (blocklet.settings.children || []).forEach((child) => {
+      child.status = fromBlockletStatus(child.status);
+      if (child.source !== undefined) {
+        child.source = fromBlockletSource(child.source);
+      }
+    });
+  }
 };
 
 const findWebInterface = (blocklet) => {
@@ -223,6 +232,8 @@ const getWhoCanAccess = (blocklet) => {
 
 const replaceSlotToIp = (url, ip) => (url || '').replace(SLOT_FOR_IP_DNS_SITE, (ip || '').replace(/\./g, '-'));
 
+const urlFriendly = (name) => slugify(name.replace(/^[@./-]/, '').replace(/[@./_]/g, '-'));
+
 module.exports = {
   isFreeBlocklet,
   isComponentBlocklet,
@@ -238,4 +249,5 @@ module.exports = {
   findServiceFromMeta,
   getWhoCanAccess,
   replaceSlotToIp,
+  urlFriendly,
 };

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/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.9",
+  "version": "1.7.12",
   "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.9",
-    "@abtnode/util": "1.7.9",
-    "@arcblock/did": "^1.16.4",
-    "@arcblock/did-ext": "^1.16.4",
-    "@arcblock/did-util": "^1.16.4",
-    "@arcblock/jwt": "^1.16.4",
-    "@arcblock/nft": "^1.16.4",
-    "@ocap/asset": "^1.16.4",
-    "@ocap/mcrypto": "^1.16.4",
-    "@ocap/util": "^1.16.4",
-    "@ocap/wallet": "^1.16.4",
-    "ajv": "^7.0.3",
+    "@abtnode/constant": "1.7.12",
+    "@abtnode/util": "1.7.12",
+    "@arcblock/did": "^1.16.6",
+    "@arcblock/did-ext": "^1.16.6",
+    "@arcblock/did-util": "^1.16.6",
+    "@arcblock/jwt": "^1.16.6",
+    "@arcblock/nft": "^1.16.6",
+    "@ocap/asset": "^1.16.6",
+    "@ocap/mcrypto": "^1.16.6",
+    "@ocap/util": "^1.16.6",
+    "@ocap/wallet": "^1.16.6",
+    "ajv": "^8.11.0",
     "cjk-length": "^1.0.0",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.1",
@@ -40,11 +40,12 @@
     "js-yaml": "^4.1.0",
     "json-stable-stringify": "^1.0.1",
     "lodash": "^4.17.21",
+    "slugify": "^1.4.6",
     "url-join": "^4.0.1",
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "285f4fedd41fcb8e1814ce5d8250ac10616e67e0"
+  "gitHead": "afc78b9cb92448676149262fb02432bc256a5524"
 }