@blocklet/meta 1.6.17 → 1.6.21

package/lib/constants.js

@@ -173,7 +173,7 @@ module.exports = Object.freeze({
 
   BLOCKLET_DEFAULT_VERSION: '1.0.0',
 
-  BLOCKLET_LATEST_SPEC_VERSION: '1.2.1',
+  BLOCKLET_LATEST_SPEC_VERSION: '1.2.3',
   BLOCKLET_LATEST_REQUIREMENT_SERVER: '>=1.6.2',
   BLOCKLET_LATEST_REQUIREMENT_ABTNODE: '>=1.5.15', // Deprecated
 

package/lib/info.js

@@ -1,5 +1,6 @@
 const get = require('lodash/get');
 const getBlockletWallet = require('./wallet');
+const { getDisplayName } = require('./util');
 
 module.exports = (state, nodeSk, { returnWallet = true } = {}) => {
   if (!state || typeof state !== 'object' || !Array.isArray(state.environments) || !get(state, 'meta.did')) {
@@ -9,12 +10,11 @@ module.exports = (state, nodeSk, { returnWallet = true } = {}) => {
   const { environments, configs = [] } = state;
   const envs = [...configs, ...environments];
 
-  const customName = envs.find((x) => x.key === 'BLOCKLET_APP_NAME');
   const customDescription = envs.find((x) => x.key === 'BLOCKLET_APP_DESCRIPTION');
   const customPassportColor = envs.find((x) => x.key === 'BLOCKLET_PASSPORT_COLOR');
 
   const { did } = state.meta;
-  const name = get(customName, 'value', state.meta.title || state.meta.name);
+  const name = getDisplayName(state);
   const description = get(customDescription, 'value', state.meta.description);
   const passportColor = get(customPassportColor, 'value', 'auto');
 

package/lib/schema.js

@@ -1,8 +1,9 @@
 /* eslint-disable newline-per-chained-call */
 const fs = require('fs');
 const JOI = require('joi');
-const { semver, semverRange } = require('joi-extension-semver');
+const cjkLength = require('cjk-length').default;
 const isGlob = require('is-glob');
+const { semver, semverRange } = require('joi-extension-semver');
 
 const { fileExtension, didExtension } = require('./extension');
 const { validateName } = require('./name');
@@ -23,6 +24,7 @@ const {
 } = require('./constants');
 
 const WELLKNOWN_PATH_PREFIX = '/.well-known';
+const MAX_TITLE_LENGTH = 48;
 
 const Joi = JOI.extend(semver).extend(semverRange).extend(fileExtension).extend(didExtension);
 
@@ -138,7 +140,7 @@ const statsSchema = Joi.object({
 const childrenSchema = Joi.object({
   name: Joi.string().min(1).required(),
   resolved: Joi.alternatives().try(Joi.string().uri(), Joi.string()).required(),
-  mountPoints: Joi.array()
+  mountPoints: Joi.array() // deprecated
     .items(
       Joi.object({
         root: Joi.object({
@@ -153,6 +155,14 @@ const childrenSchema = Joi.object({
     )
     .optional()
     .default([]),
+  mountPoint: Joi.string().trim().min(1), // added in 1.2.3
+  services: Joi.array().items(serviceSchema).unique('name'), // added in 1.2.3
+}).custom((value) => {
+  if (!value.mountPoint && (!value.mountPoints || !value.mountPoints.length)) {
+    throw new Error('mountPoint is required');
+  }
+
+  return value;
 });
 
 const signatureSchema = Joi.object({
@@ -184,14 +194,25 @@ const createBlockletSchema = (
         return value;
       })
       .required(),
-    description: Joi.string().trim().required(),
+    description: Joi.string().trim().min(3).max(512).required(),
     group: Joi.string().valid(...BLOCKLET_GROUPS).required(), // prettier-ignore
     main: Joi.when('group', {
       is: Joi.valid(BlockletGroup.gateway),
       then: Joi.forbidden(),
       otherwise: ensureMain ? Joi.file().exists({ baseDir }).required() : Joi.string().trim().required(),
     }),
-    title: Joi.string().trim().optional().allow(''),
+    title: 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;
+      })
+      .optional()
+      .allow(''),
     logo: ensureFiles ? Joi.file().trim().exists({ baseDir }).optional() : Joi.string().trim().optional(),
     specVersion: Joi.semver().valid().gte('1.0.0').optional(),
 
@@ -216,7 +237,7 @@ const createBlockletSchema = (
         .max(4)
         .items(
           Joi.object({
-            value: Joi.number().required(),
+            value: Joi.number().greater(0).required(),
             address: Joi.DID().required(), // token address
           })
         ),
@@ -232,7 +253,7 @@ const createBlockletSchema = (
           Joi.object({
             name: Joi.string().required(),
             address: Joi.DID().required(),
-            value: Joi.number().min(0).max(1).required(),
+            value: Joi.number().greater(0).max(1).required(),
           })
         )
         .custom((value) => {
@@ -242,13 +263,11 @@ const createBlockletSchema = (
           }
           const total = value.reduce((acc, cur) => acc + cur.value, 0);
           if (total !== 1) {
-            throw new Error(`invalid share: ${JSON.stringify(value)}`);
+            throw new Error(`Invalid blocklet payment share config: total share must be 1, got ${total}`);
           }
           return value;
-        }, 'share invalid'),
-    })
-      .default({ price: [], share: [] })
-      .optional(),
+        }, 'invalid blocklet share'),
+    }).default({ price: [], share: [] }),
 
     keywords: Joi.alternatives()
       .try(Joi.string().trim().min(1), Joi.array().items(Joi.string().min(1)))
@@ -321,7 +340,13 @@ const createBlockletSchema = (
     // capabilities
     capabilities: Joi.object({
       clusterMode: Joi.boolean().default(false), // Can blocklet be started in cluster mode
-    }).default({}),
+
+      // added in 1.2.2
+      component: Joi.boolean().default(true), // Can blocklet become a component and be composed by other blocklets
+    }).default({
+      clusterMode: false,
+      component: true,
+    }),
 
     // Other contents to be included in the bundle
     files: Joi.array()

package/lib/util.js

@@ -101,6 +101,10 @@ const isFreeBlocklet = (meta) => {
   return priceList.every((x) => x === 0);
 };
 
+const isComponentBlocklet = (meta) => {
+  return get(meta, 'capabilities.component') !== false;
+};
+
 const wipeSensitiveData = (blocklet) => {
   if (!blocklet) {
     return blocklet;
@@ -153,8 +157,28 @@ const hasRunnableComponent = (blocklet) => {
   return has;
 };
 
+/**
+ * 获取 blocklet 的 name
+ * @param {Object} blocklet 应用数据
+ * @param {Boolean} onlyUseMeta 优先使用应用元数据的name
+ * @returns blocklet display name
+ */
+const getDisplayName = (blocklet, onlyUseMeta = false) => {
+  const { meta } = blocklet;
+  let displayName;
+
+  if (!onlyUseMeta && blocklet.environments) {
+    const target = blocklet.environments.find((e) => e.key === 'BLOCKLET_APP_NAME');
+    if (target && target.value) {
+      displayName = target.value;
+    }
+  }
+  return displayName || meta.title || meta.name;
+};
+
 module.exports = {
   isFreeBlocklet,
+  isComponentBlocklet,
   forEachBlockletSync,
   isDeletableBlocklet,
   forEachBlocklet,
@@ -162,4 +186,5 @@ module.exports = {
   getRequiredMissingConfigs,
   wipeSensitiveData,
   hasRunnableComponent,
+  getDisplayName,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.6.17",
+  "version": "1.6.21",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,20 +18,21 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "^1.14.8",
-    "@arcblock/did-ext": "^1.14.8",
-    "@arcblock/did-util": "^1.14.8",
-    "@arcblock/nft": "^1.14.8",
-    "@ocap/asset": "^1.14.8",
-    "@ocap/mcrypto": "^1.14.8",
-    "@ocap/util": "^1.14.8",
-    "@ocap/wallet": "^1.14.8",
+    "@arcblock/did": "^1.14.13",
+    "@arcblock/did-ext": "^1.14.13",
+    "@arcblock/did-util": "^1.14.13",
+    "@arcblock/nft": "^1.14.13",
+    "@ocap/asset": "^1.14.13",
+    "@ocap/mcrypto": "^1.14.13",
+    "@ocap/util": "^1.14.13",
+    "@ocap/wallet": "^1.14.13",
     "ajv": "^7.0.3",
+    "cjk-length": "^1.0.0",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.0",
     "hosted-git-info": "3.0.8",
     "is-glob": "^4.0.3",
-    "joi": "^17.5.0",
+    "joi": "^17.6.0",
     "joi-extension-semver": "^5.0.0",
     "js-yaml": "^3.14.0",
     "json-stable-stringify": "^1.0.1",
@@ -42,5 +43,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "d567a622a779eba43c95eaeb4633cb2b276bb7b9"
+  "gitHead": "864ae21711c119948475057a1f634fd7d16ae91a"
 }