@blocklet/meta 1.7.11 → 1.7.14

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

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.7.11",
+  "version": "1.7.14",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,17 +18,17 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@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",
+    "@abtnode/constant": "1.7.14",
+    "@abtnode/util": "1.7.14",
+    "@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",
@@ -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": "84e741e6b37e47d52bf834ce3ace8ed601d0896c"
+  "gitHead": "1f3855e6dc8b6d6c91526264e2f63215df6b962c"
 }