@blocklet/meta 1.6.16 → 1.6.17

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,7 +172,6 @@ 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_REQUIREMENT_SERVER: '>=1.6.2',

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/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) => {
@@ -132,11 +142,24 @@ 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;
+};
+
 module.exports = {
   isFreeBlocklet,
+  forEachBlockletSync,
   isDeletableBlocklet,
   forEachBlocklet,
   isAuthServiceEnabled,
   getRequiredMissingConfigs,
   wipeSensitiveData,
+  hasRunnableComponent,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.6.16",
+  "version": "1.6.17",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,14 +18,14 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@arcblock/did": "^1.14.3",
-    "@arcblock/did-ext": "^1.14.3",
-    "@arcblock/did-util": "^1.14.3",
-    "@arcblock/nft": "^1.14.3",
-    "@ocap/asset": "^1.14.3",
-    "@ocap/mcrypto": "^1.14.3",
-    "@ocap/util": "^1.14.3",
-    "@ocap/wallet": "^1.14.3",
+    "@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",
     "ajv": "^7.0.3",
     "debug": "^4.3.3",
     "fs-extra": "^10.0.0",
@@ -42,5 +42,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "69b08db16aeb75ce23b0e6bb5b9fa396adba2d4b"
+  "gitHead": "d567a622a779eba43c95eaeb4633cb2b276bb7b9"
 }