@blocklet/meta 1.8.25 → 1.8.27

package/lib/constants.js

@@ -1,191 +1,3 @@
-const fromEntry = (entries) => (v) => {
-  const match = Object.entries(entries).find((x) => x[1] === Number(v));
-  return match ? match[0] : 'unknown';
-};
+const constant = require('@blocklet/constant');
 
-const toEntry = (entries) => (v) => Object.keys(entries).find((x) => entries[x] === Number(v));
-
-// Blocklet Status
-
-const BlockletStatus = Object.freeze({
-  added: 0,
-  downloading: 1,
-  downloaded: 2, // Deprecated
-  installing: 3,
-  installed: 4,
-  starting: 5,
-  running: 6,
-  stopping: 7,
-  stopped: 8,
-  error: 9,
-  upgrading: 10,
-  restarting: 11, // Deprecated
-  corrupted: 12,
-  waiting: 13,
-  deleted: 14,
-});
-
-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',
-  installed: 'blocklet.installed',
-  installFailed: 'blocklet.installFailed',
-  upgraded: 'blocklet.upgraded',
-  upgradeFailed: 'blocklet.upgradedFailed',
-  downgraded: 'blocklet.downgraded',
-  downgradeFailed: 'blocklet.downgradedFailed',
-  updated: 'blocklet.updated',
-  statusChange: 'blocklet.statusChange',
-  removed: 'blocklet.removed',
-  started: 'blocklet.started',
-  startFailed: 'blocklet.startFailed',
-  stopped: 'blocklet.stopped',
-  reloaded: 'blocklet.reloaded', // Deprecated
-  purchaseChange: 'blocklet.purchaseChange',
-});
-
-// Blocklet Interface
-
-const BLOCKLET_INTERFACE_TYPE_WEB = 'web';
-const BLOCKLET_INTERFACE_TYPE_SERVICE = 'service';
-
-// 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_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,
-  fromBlockletStatus,
-  toBlockletStatus,
-
-  BlockletSource,
-  fromBlockletSource,
-  toBlockletSource,
-
-  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',
-  }),
-
-  BLOCKLET_FACTORY_SHARES: { developer: 0.7, store: 0.3 },
-
-  // interface
-  BLOCKLET_INTERFACE_PUBLIC,
-  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_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',
-  BLOCKLET_BUNDLE_FILE: 'blocklet.zip',
-  BLOCKLET_ENTRY_FILE: 'blocklet.js',
-  BLOCKLET_META_FILE: 'blocklet.yml',
-  BLOCKLET_META_FILE_ALT: 'blocklet.yaml',
-
-  BLOCKLET_DEFAULT_VERSION: '1.0.0',
-
-  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: {
-    BLOCKLET_CLUSTER_SIZE: 'BLOCKLET_CLUSTER_SIZE',
-    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',
-  },
-});
+module.exports = constant;

package/lib/file.js

@@ -21,7 +21,12 @@ const select = (dir, { throwOnError = true } = {}) => {
   return metaToUpdate;
 };
 
-const update = (file, meta) => {
+const update = (file, meta, { fix = true } = {}) => {
+  if (!fix) {
+    fs.writeFileSync(file, yaml.dump(meta, { sortKeys: false, skipInvalid: true }));
+    return;
+  }
+
   delete meta.path;
   delete meta.folder;
   delete meta.htmlAst;

package/lib/parse-navigation.js

@@ -40,6 +40,8 @@ const getGroups = (navigation) => {
   return Object.values(groups);
 };
 
+const getChildName = (nav) => nav.component || nav.child;
+
 /**
  * @param {*} navigation src
  * @param {*} blocklet
@@ -50,7 +52,7 @@ const doParseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
   const result = [];
 
   (navigation || []).forEach((nav) => {
-    if (!nav.child) {
+    if (!getChildName(nav)) {
       if (_level > 1 && nav.items?.length) {
         const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
         result.push(...list);
@@ -95,7 +97,7 @@ const doParseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
     }
 
     // parse child
-    const child = (blocklet.children || []).find((x) => [x.meta.name, x.meta.did].includes(nav.child));
+    const child = (blocklet.children || []).find((x) => [x.meta.name, x.meta.did].includes(getChildName(nav)));
     if (!child) {
       return;
     }

package/lib/parse.js

@@ -28,6 +28,7 @@ const parse = (
     extraRawAttrs = {},
     serviceMetas,
     schemaOptions = {},
+    fix = true,
   } = {}
 ) => {
   let result = {};
@@ -57,6 +58,10 @@ const parse = (
     result = Object.assign(result, extraRawAttrs);
   }
 
+  if (!fix) {
+    return result;
+  }
+
   // Fix
   fixRequired(result, dir);
   fixRepository(result);

package/lib/payment/v2.js

@@ -24,6 +24,8 @@ const ZeroBN = new BN(0);
 const defaultDecimals = 1e6; // we only support 6 decimals on share ratio
 const defaultDecimalsBN = new BN(defaultDecimals);
 
+const getComponentConfig = (meta) => meta.components || meta.children;
+
 const safeMul = (a, b) =>
   Number(
     fromUnitToToken(
@@ -68,7 +70,7 @@ const _getComponents = async (inputMeta, context = {}) => {
     throw new Error('The depth of component should not exceed 40');
   }
 
-  const configs = inputMeta.children || [];
+  const configs = getComponentConfig(inputMeta);
 
   if (!configs || !configs.length) {
     return [];

package/lib/schema.js

@@ -42,6 +42,9 @@ const titleSchema = Joi.string()
     return value;
   });
 const descriptionSchema = Joi.string().trim().min(3).max(160);
+const logoSchema = Joi.string()
+  .uri({ scheme: ['http', 'https'], allowRelative: true })
+  .allow('');
 const mountPointSchema = Joi.string().trim().min(1);
 
 const blockletNameSchema = Joi.string()
@@ -245,11 +248,11 @@ const navigationItemSchema = Joi.object({
       en: Joi.string(),
     }).min(1)
   ),
-  child: Joi.string().min(1), // child name or child did
+  component: Joi.string().min(1), // child name or child did
   section: Joi.array().items(Joi.string().min(1)).single(),
   role: Joi.array().items(Joi.string().min(1)).single(),
   icon: Joi.string().min(1),
-});
+}).rename('child', 'component');
 
 const navigationSchema = Joi.array().items(
   navigationItemSchema.append({
@@ -487,7 +490,7 @@ const createBlockletSchema = (
     lastPublishedAt: Joi.string().isoDate().optional(),
 
     // blocklet component support
-    children: Joi.array().items(childrenSchema).unique('name').optional().default([]),
+    components: Joi.array().items(childrenSchema).unique('name').optional().default([]),
 
     // navigation & theme
     navigation: navigationSchema,
@@ -501,7 +504,9 @@ const createBlockletSchema = (
     bundleName: Joi.string(),
     bundleDid: Joi.DID().trim(),
     storeId: Joi.string(),
-  }).options({ stripUnknown: true, noDefaults: false, ...schemaOptions });
+  })
+    .options({ stripUnknown: true, noDefaults: false, ...schemaOptions })
+    .rename('children', 'components');
 };
 
 module.exports = {
@@ -513,6 +518,7 @@ module.exports = {
   distSchema,
   titleSchema,
   descriptionSchema,
+  logoSchema,
   navigationSchema,
   themeSchema,
   mountPointSchema,

package/lib/util.js

@@ -334,6 +334,10 @@ const hasRunnableComponent = (blocklet) => {
  * @returns blocklet display name
  */
 const getDisplayName = (blocklet, onlyUseMeta = false) => {
+  if (!blocklet) {
+    return '';
+  }
+
   const { meta } = blocklet;
   let displayName;
 

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.25",
+  "version": "1.8.27",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,16 +18,17 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.8.25",
-    "@abtnode/util": "1.8.25",
-    "@arcblock/did": "1.17.19",
-    "@arcblock/did-ext": "1.17.19",
-    "@arcblock/did-util": "1.17.19",
-    "@arcblock/jwt": "1.17.19",
-    "@ocap/asset": "1.17.19",
-    "@ocap/mcrypto": "1.17.19",
-    "@ocap/util": "1.17.19",
-    "@ocap/wallet": "1.17.19",
+    "@abtnode/constant": "1.8.27",
+    "@abtnode/util": "1.8.27",
+    "@arcblock/did": "1.17.20",
+    "@arcblock/did-ext": "1.17.20",
+    "@arcblock/did-util": "1.17.20",
+    "@arcblock/jwt": "1.17.20",
+    "@blocklet/constant": "1.8.27",
+    "@ocap/asset": "1.17.20",
+    "@ocap/mcrypto": "1.17.20",
+    "@ocap/util": "1.17.20",
+    "@ocap/wallet": "1.17.20",
     "ajv": "^8.11.0",
     "axios": "^0.27.2",
     "cjk-length": "^1.0.0",
@@ -53,5 +54,5 @@
     "express": "^4.18.1",
     "jest": "^27.5.1"
   },
-  "gitHead": "ea34dcd0037c63cb63b31744efcf169edf8aa776"
+  "gitHead": "84b2cb3ee703479f17e88c91650ecf3015cbf6af"
 }