@blocklet/meta 1.7.10 → 1.7.13

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/service-configs/auth.json

@@ -0,0 +1,66 @@
+{
+  "name": "auth",
+  "description": "Neat and easy to use user authentication and authorization service for blocklets",
+  "version": "1.0.0",
+  "schema": {
+    "JSONSchema": {
+      "title": "Config Auth Service",
+      "description": "Customize how Auth Service works",
+      "type": "object",
+      "required": ["profileFields", "webWalletUrl"],
+      "properties": {
+        "whoCanAccess": {
+          "type": "string",
+          "title": "Who can access the blocklet?",
+          "enum": ["owner", "invited", "all"],
+          "default": "all"
+        },
+        "profileFields": {
+          "type": "array",
+          "title": "What info do you want user to provide when login?",
+          "items": {
+            "type": "string",
+            "enum": ["fullName", "email", "avatar", "phone"]
+          },
+          "default": ["fullName", "email", "avatar"],
+          "uniqueItems": true
+        },
+        "allowSwitchProfile": {
+          "type": "boolean",
+          "title": "Does you app allow user to switch profile?",
+          "default": true
+        },
+        "webWalletUrl": {
+          "type": "string",
+          "title": "The URL of your preferred web wallet instance",
+          "pattern": "^https?://",
+          "default": "https://web.abtwallet.io"
+        },
+        "ignoreUrls": {
+          "type": "array",
+          "title": "Which URLs do not need to be protected. e.g: /public/**",
+          "items": {
+            "type": "string",
+            "minLength": 1
+          },
+          "default": []
+        },
+        "blockUnauthenticated": {
+          "type": "boolean",
+          "title": "Do you want Auth Service block unauthenticated requests for you?",
+          "default": false
+        },
+        "blockUnauthorized": {
+          "type": "boolean",
+          "title": "Do you want Auth Service block unauthorized requests for you?",
+          "default": false
+        }
+      }
+    },
+    "UISchema": {
+      "profileFields": {
+        "ui:widget": "checkboxes"
+      }
+    }
+  }
+}

package/lib/service.js

@@ -1,4 +1,3 @@
-const fs = require('fs-extra');
 const cloneDeep = require('lodash/cloneDeep');
 const Ajv = require('ajv').default;
 
@@ -25,7 +24,7 @@ const setService = (meta) => {
   };
 };
 
-setService(fs.readJSONSync(require.resolve('@abtnode/blocklet-services/configs/auth.json')));
+setService(require('./service-configs/auth.json'));
 
 // backward compatible
 SERVICES[NODE_SERVICES.AUTH_SERVICE] = {

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.10",
+  "version": "1.7.13",
   "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.10",
-    "@abtnode/util": "1.7.10",
-    "@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.13",
+    "@abtnode/util": "1.7.13",
+    "@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": "8eab10fd39b6183a2fa4d2706f52e8b2ecaa059a"
+  "gitHead": "c35c485417df0e023c06c09557644b46a6c8c655"
 }