@blocklet/meta 1.6.17 → 1.6.18

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);
 
@@ -184,14 +186,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 +229,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 +245,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,10 +255,10 @@ 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'),
+        }, 'invalid blocklet share'),
     })
       .default({ price: [], share: [] })
       .optional(),

package/lib/util.js

@@ -153,6 +153,25 @@ 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,
   forEachBlockletSync,
@@ -162,4 +181,5 @@ module.exports = {
   getRequiredMissingConfigs,
   wipeSensitiveData,
   hasRunnableComponent,
+  getDisplayName,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.6.17",
+  "version": "1.6.18",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -27,6 +27,7 @@
     "@ocap/util": "^1.14.8",
     "@ocap/wallet": "^1.14.8",
     "ajv": "^7.0.3",
+    "cjk-length": "^1.0.0",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.0",
     "hosted-git-info": "3.0.8",
@@ -42,5 +43,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "d567a622a779eba43c95eaeb4633cb2b276bb7b9"
+  "gitHead": "2f02f166869d8ebedc0466068f6ed90ab3e07b87"
 }