@blocklet/meta 1.6.15 → 1.6.19

package/lib/constants.js

@@ -1,10 +1,11 @@
-const BLOCKLET_INTERFACE_TYPE_WEB = 'web';
-const BLOCKLET_INTERFACE_TYPE_SERVICE = 'service';
+const fromEntry = (entries) => (v) => {
+  const match = Object.entries(entries).find((x) => x[1] === Number(v));
+  return match ? match[0] : 'unknown';
+};
 
-// Wellknown interface declares an sub-interface under web interface
-// The path of the wellknown interface must starts with /.well-known, e.g. /.well-known/acme-challenge)
-// The wellknown interface can be mounted to every endpoint of the abtnode and all blocklets on the abtnode
-const BLOCKLET_INTERFACE_TYPE_WELLKNOWN = 'wellknown';
+const toEntry = (entries) => (v) => Object.keys(entries).find((x) => entries[x] === Number(v));
+
+// Blocklet Status
 
 const BlockletStatus = Object.freeze({
   added: 0,
@@ -23,13 +24,52 @@ const BlockletStatus = Object.freeze({
   waiting: 13,
 });
 
+const fromBlockletStatus = fromEntry(BlockletStatus);
+const toBlockletStatus = toEntry(BlockletStatus);
+
+// Blocklet Source
+
 const BlockletSource = Object.freeze({
+  // Installed from Blocklet Store
   registry: 0,
+
+  // Installed from local development source folder
   local: 1,
+
+  // Installed from uploading bundle directly
   upload: 2,
+
+  // Installed from a url (similar to Blocklet Store)
   url: 3,
+
+  // Installed by custom creation
+  custom: 4,
 });
 
+const fromBlockletSource = fromEntry(BlockletSource);
+const toBlockletSource = toEntry(BlockletSource);
+
+// Blocklet Group(Type)
+
+const BlockletGroup = Object.freeze({
+  // Only static website
+  // The website is served by by Blocklet Server at runtime
+  static: 'static',
+
+  // The runtime instance is provided by its own backend server
+  dapp: 'dapp',
+
+  starter: false, // deprecated
+
+  // This type is used to combine other component blocklets
+  // No instance will be spawned at runtime
+  gateway: 'gateway',
+});
+
+const BLOCKLET_GROUPS = ['dapp', 'static', 'gateway'];
+
+// Blocklet Events
+
 const BlockletEvents = Object.freeze({
   added: 'blocklet.added',
   downloadFailed: 'blocklet.downloadFailed',
@@ -48,45 +88,52 @@ const BlockletEvents = Object.freeze({
   purchaseChange: 'blocklet.purchaseChange',
 });
 
-const fromEntry = (entries) => (v) => {
-  const match = Object.entries(entries).find((x) => x[1] === Number(v));
-  return match ? match[0] : 'unknown';
-};
+// Blocklet Interface
 
-const toEntry = (entries) => (v) => Object.keys(entries).find((x) => entries[x] === Number(v));
-
-const fromBlockletStatus = fromEntry(BlockletStatus);
-const toBlockletStatus = toEntry(BlockletStatus);
+const BLOCKLET_INTERFACE_TYPE_WEB = 'web';
+const BLOCKLET_INTERFACE_TYPE_SERVICE = 'service';
 
-const fromBlockletSource = fromEntry(BlockletSource);
-const toBlockletSource = toEntry(BlockletSource);
+// Wellknown interface declares an sub-interface under web interface
+// The path of the wellknown interface must starts with /.well-known, e.g. /.well-known/acme-challenge)
+// The wellknown interface can be mounted to every endpoint of the abtnode and all blocklets on the abtnode
+const BLOCKLET_INTERFACE_TYPE_WELLKNOWN = 'wellknown';
+const BLOCKLET_INTERFACE_TYPES = [
+  BLOCKLET_INTERFACE_TYPE_WEB,
+  BLOCKLET_INTERFACE_TYPE_SERVICE,
+  BLOCKLET_INTERFACE_TYPE_WELLKNOWN,
+];
 
 const BLOCKLET_INTERFACE_PUBLIC = 'publicUrl';
-const BLOCKLET_INTERFACE_ADMIN = 'adminUrl';
-const BLOCKLET_INTERFACE_CONFIG = 'configUrl';
-const BLOCKLET_INTERFACE_DOC = 'docUrl';
 const BLOCKLET_INTERFACE_WELLKNOWN = 'wellknownUrl'; // Deprecated
+const BLOCKLET_UI_INTERFACES = [BLOCKLET_INTERFACE_PUBLIC];
+const BLOCKLET_STANDARD_INTERFACES = [BLOCKLET_INTERFACE_PUBLIC, BLOCKLET_INTERFACE_WELLKNOWN];
+
+const BLOCKLET_INTERFACE_PROTOCOL_HTTP = 'http';
+const BLOCKLET_INTERFACE_PROTOCOL_TCP = 'tcp';
+const BLOCKLET_INTERFACE_PROTOCOL_UDP = 'udp';
+const BLOCKLET_INTERFACE_PROTOCOLS = [
+  BLOCKLET_INTERFACE_PROTOCOL_TCP,
+  BLOCKLET_INTERFACE_PROTOCOL_UDP,
+  BLOCKLET_INTERFACE_PROTOCOL_HTTP,
+];
 
 module.exports = Object.freeze({
   BlockletStatus,
-  BlockletSource,
   fromBlockletStatus,
   toBlockletStatus,
+
+  BlockletSource,
   fromBlockletSource,
   toBlockletSource,
 
-  BlockletGroup: Object.freeze({
-    static: 'static',
-    dapp: 'dapp',
-    starter: false,
-    gateway: 'gateway',
-  }),
-  BLOCKLET_GROUPS: ['dapp', 'static', 'gateway'],
+  BlockletGroup,
+  BLOCKLET_GROUPS,
 
   BlockletEvents,
 
   BLOCKLET_PLATFORMS: ['aix', 'darwin', 'freebsd', 'linux', 'openbsd', 'sunos', 'win32'],
   BLOCKLET_ARCHITECTURES: ['arm', 'arm64', 'ia32', 'mips', 'mipsel', 'ppc', 'ppc64', 's390', 's390x', 'x32', 'x64'],
+
   BLOCKLET_MODES: Object.freeze({
     PRODUCTION: 'production',
     DEVELOPMENT: 'development',
@@ -94,40 +141,27 @@ module.exports = Object.freeze({
 
   BLOCKLET_FACTORY_SHARES: { developer: 0.7, store: 0.3 },
 
-  BLOCKLET_DYNAMIC_PATH_PREFIX: '*',
-
+  // interface
   BLOCKLET_INTERFACE_PUBLIC,
-  BLOCKLET_INTERFACE_ADMIN,
-  BLOCKLET_INTERFACE_CONFIG,
-  BLOCKLET_INTERFACE_DOC,
-  BLOCKLET_INTERFACE_WELLKNOWN,
-
-  BLOCKLET_UI_INTERFACES: [
-    BLOCKLET_INTERFACE_PUBLIC,
-    BLOCKLET_INTERFACE_ADMIN,
-    BLOCKLET_INTERFACE_CONFIG,
-    BLOCKLET_INTERFACE_DOC,
-  ],
-
-  BLOCKLET_STANDARD_INTERFACES: [
-    BLOCKLET_INTERFACE_PUBLIC,
-    BLOCKLET_INTERFACE_ADMIN,
-    BLOCKLET_INTERFACE_CONFIG,
-    BLOCKLET_INTERFACE_DOC,
-    BLOCKLET_INTERFACE_WELLKNOWN,
-  ],
+  BLOCKLET_INTERFACE_WELLKNOWN, // Deprecated
+  BLOCKLET_UI_INTERFACES,
+  BLOCKLET_STANDARD_INTERFACES,
 
   BLOCKLET_INTERFACE_TYPE_WEB,
   BLOCKLET_INTERFACE_TYPE_SERVICE,
   BLOCKLET_INTERFACE_TYPE_WELLKNOWN,
-  BLOCKLET_INTERFACE_TYPES: [
-    BLOCKLET_INTERFACE_TYPE_WEB,
-    BLOCKLET_INTERFACE_TYPE_SERVICE,
-    BLOCKLET_INTERFACE_TYPE_WELLKNOWN,
-  ],
+  BLOCKLET_INTERFACE_TYPES,
 
-  BLOCKLET_INTERFACE_PROTOCOLS: ['tcp', 'udp', 'http'],
+  BLOCKLET_INTERFACE_PROTOCOL_HTTP,
+  BLOCKLET_INTERFACE_PROTOCOL_TCP,
+  BLOCKLET_INTERFACE_PROTOCOL_UDP,
+  BLOCKLET_INTERFACE_PROTOCOLS,
 
+  BLOCKLET_DYNAMIC_PATH_PREFIX: '*',
+  BLOCKLET_DEFAULT_PORT_NAME: 'BLOCKLET_PORT',
+  BLOCKLET_DEFAULT_PATH_REWRITE: '/',
+
+  // bundle
   BLOCKLET_RELEASE_FOLDER: '.blocklet/release',
   BLOCKLET_RELEASE_FILE: 'blocklet.json',
   BLOCKLET_BUNDLE_FOLDER: '.blocklet/bundle',
@@ -138,9 +172,8 @@ module.exports = Object.freeze({
   BLOCKLET_META_FILE_OLD: 'blocklet.json',
 
   BLOCKLET_DEFAULT_VERSION: '1.0.0',
-  BLOCKLET_DEFAULT_PORT_NAME: 'BLOCKLET_PORT',
 
-  BLOCKLET_LATEST_SPEC_VERSION: '1.2.1',
+  BLOCKLET_LATEST_SPEC_VERSION: '1.2.2',
   BLOCKLET_LATEST_REQUIREMENT_SERVER: '>=1.6.2',
   BLOCKLET_LATEST_REQUIREMENT_ABTNODE: '>=1.5.15', // Deprecated
 
@@ -149,6 +182,8 @@ module.exports = Object.freeze({
     BLOCKLET_APP_NAME: 'BLOCKLET_APP_NAME',
     BLOCKLET_APP_DESCRIPTION: 'BLOCKLET_APP_DESCRIPTION',
     BLOCKLET_APP_SK: 'BLOCKLET_APP_SK',
+    BLOCKLET_APP_URL: 'BLOCKLET_APP_URL',
+    BLOCKLET_PASSPORT_COLOR: 'BLOCKLET_PASSPORT_COLOR',
     BLOCKLET_WALLET_TYPE: 'BLOCKLET_WALLET_TYPE',
     BLOCKLET_DELETABLE: 'BLOCKLET_DELETABLE',
   },

package/lib/did.js

@@ -1,9 +1,7 @@
-const Mcrypto = require('@ocap/mcrypto');
+const { types } = require('@ocap/mcrypto');
 const { toHex } = require('@ocap/util');
 const { fromPublicKey } = require('@arcblock/did');
 
-const { types } = Mcrypto;
-
 const toBlockletDid = (name) => {
   const pk = toHex(name);
   return fromPublicKey(pk, { role: types.RoleType.ROLE_ANY });

package/lib/fix.js

@@ -12,9 +12,6 @@ const {
   BLOCKLET_DYNAMIC_PATH_PREFIX,
   BLOCKLET_INTERFACE_TYPE_WEB,
   BLOCKLET_INTERFACE_PUBLIC,
-  BLOCKLET_INTERFACE_ADMIN,
-  BLOCKLET_INTERFACE_CONFIG,
-  BLOCKLET_INTERFACE_DOC,
 } = require('./constants');
 
 // Assign sensible defaults: name/description/main/group/version/public_url
@@ -203,13 +200,11 @@ const fixInterfaces = (meta, removeMerged = true) => {
     meta.interfaces.push({ type, name, path, prefix, port, protocol });
   };
 
-  [BLOCKLET_INTERFACE_PUBLIC, BLOCKLET_INTERFACE_ADMIN, BLOCKLET_INTERFACE_CONFIG, BLOCKLET_INTERFACE_DOC].forEach(
-    (x) => {
-      if (meta[x]) {
-        addInterface({ name: x, path: meta[x] });
-      }
+  [BLOCKLET_INTERFACE_PUBLIC].forEach((x) => {
+    if (meta[x]) {
+      addInterface({ name: x, path: meta[x] });
     }
-  );
+  });
 
   if (Array.isArray(meta.exposeServices)) {
     meta.exposeServices.forEach((x) => {

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,13 @@ 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');
 
   if (!returnWallet) {
     return {
@@ -51,6 +53,7 @@ module.exports = (state, nodeSk, { returnWallet = true } = {}) => {
     did,
     name,
     description,
+    passportColor,
     wallet,
   };
 };

package/lib/parse.js

@@ -2,7 +2,7 @@ const fs = require('fs');
 const path = require('path');
 const yaml = require('js-yaml');
 const camelCase = require('lodash/camelCase');
-const debug = require('debug')('@blocklet/meta:fix');
+const debug = require('debug')('@blocklet/meta:parse');
 
 const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT, BLOCKLET_META_FILE_OLD } = require('./constants');
 

package/lib/payment.js

@@ -5,8 +5,6 @@ const { isValidFactory } = require('@ocap/asset');
 const { toFactoryAddress } = require('@arcblock/did-util');
 const { getBlockletPurchaseTemplate } = require('@arcblock/nft/lib/templates');
 
-const { isFreeBlocklet } = require('./util');
-
 const createShareContract = ({ tokens = [], shares = [] }) => {
   const zeroBN = new BN(0);
   const decimals = 1000000; // we only support 6 decimals on share ratio
@@ -81,7 +79,6 @@ const createNftFactoryItx = ({ meta, tokens, shares, issuers, serviceUrl }) => {
 };
 
 module.exports = {
-  isFreeBlocklet,
   createShareContract,
   createNftFactoryItx,
 };

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,13 +255,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 +332,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

@@ -1,6 +1,8 @@
 /* eslint-disable no-await-in-loop */
 const get = require('lodash/get');
 
+const { BlockletGroup } = require('./constants');
+
 const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
   // sync
   if (sync) {
@@ -15,15 +17,21 @@ const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
 
   // serial
   if (!parallel) {
-    return (async () => {
-      await cb(blocklet);
-      if (blocklet.children) {
-        for (const child of blocklet.children) {
-          await cb(child);
+    // eslint-disable-next-line no-async-promise-executor
+    return new Promise(async (resolve, reject) => {
+      try {
+        await cb(blocklet);
+        if (blocklet.children) {
+          for (const child of blocklet.children) {
+            await cb(child);
+          }
         }
+
+        resolve(null);
+      } catch (err) {
+        reject(err);
       }
-      return null;
-    })();
+    });
   }
 
   // parallel
@@ -37,6 +45,8 @@ const forEachBlocklet = (blocklet, cb, { parallel = false, sync } = {}) => {
   return Promise.all(tasks);
 };
 
+const forEachBlockletSync = (blocklet, cb) => forEachBlocklet(blocklet, cb, { sync: true });
+
 const isAuthServiceEnabled = (blocklet) => {
   const interfaces = get(blocklet, 'meta.interfaces') || [];
   const isRootEnabled = interfaces.some((x) => {
@@ -91,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;
@@ -132,11 +146,45 @@ const isDeletableBlocklet = (blocklet) => {
   return config.value === 'yes';
 };
 
+const hasRunnableComponent = (blocklet) => {
+  let has = false;
+  forEachBlockletSync(blocklet, (x) => {
+    if (x.meta.group !== BlockletGroup.gateway) {
+      has = true;
+    }
+  });
+
+  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,
   isAuthServiceEnabled,
   getRequiredMissingConfigs,
   wipeSensitiveData,
+  hasRunnableComponent,
+  getDisplayName,
 };

package/lib/wallet.js

@@ -1,10 +1,8 @@
-const Mcrypto = require('@ocap/mcrypto');
+const { types } = require('@ocap/mcrypto');
 const { fromSecretKey } = require('@ocap/wallet');
 const { isValid } = require('@arcblock/did');
 const { fromAppDid } = require('@arcblock/did-ext');
 
-const { types } = Mcrypto;
-
 /**
  * Gen DID from blocklet did and nodeSk
  *

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.6.15",
+  "version": "1.6.19",
   "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.13.84",
-    "@arcblock/did-ext": "^1.13.84",
-    "@arcblock/did-util": "^1.13.84",
-    "@arcblock/nft": "^1.13.84",
-    "@ocap/asset": "^1.13.84",
-    "@ocap/mcrypto": "^1.13.84",
-    "@ocap/util": "^1.13.84",
-    "@ocap/wallet": "^1.13.84",
+    "@arcblock/did": "^1.14.11",
+    "@arcblock/did-ext": "^1.14.11",
+    "@arcblock/did-util": "^1.14.11",
+    "@arcblock/nft": "^1.14.11",
+    "@ocap/asset": "^1.14.11",
+    "@ocap/mcrypto": "^1.14.11",
+    "@ocap/util": "^1.14.11",
+    "@ocap/wallet": "^1.14.11",
     "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": "1b7b07da04387b1daa838b251a9388355009142d"
+  "gitHead": "42a1290f14fca261eccafb05561eecf8683ed66a"
 }