@blocklet/meta 1.8.1 → 1.8.4

package/lib/channel.js

@@ -0,0 +1,39 @@
+const { isValid: isValidDid } = require('@arcblock/did');
+
+const getAppPublicChannelRegex = () => /app:(\w+):public/;
+
+const getAppPublicChannel = (appDid) => `app:${appDid}:public`;
+
+const CHANNEL_TYPE = {
+  DID: 'DID',
+  APP: 'APP',
+};
+
+const parseChannel = (channel) => {
+  if (!channel) {
+    throw new Error('Channel should not be empty');
+  }
+
+  const matchAppPublicChannel = getAppPublicChannelRegex().exec(channel);
+  if (matchAppPublicChannel) {
+    return {
+      type: CHANNEL_TYPE.APP,
+      appDid: matchAppPublicChannel[1],
+    };
+  }
+
+  if (isValidDid(channel)) {
+    return {
+      type: CHANNEL_TYPE.DID,
+    };
+  }
+
+  throw new Error(`Invalid channel format: ${channel}`);
+};
+
+module.exports = {
+  CHANNEL_TYPE,
+  getAppPublicChannel,
+  getAppPublicChannelRegex,
+  parseChannel,
+};

package/lib/constants.js

@@ -77,7 +77,9 @@ const BlockletEvents = Object.freeze({
   installed: 'blocklet.installed',
   installFailed: 'blocklet.installFailed',
   upgraded: 'blocklet.upgraded',
+  upgradeFailed: 'blocklet.upgradedFailed',
   downgraded: 'blocklet.downgraded',
+  downgradeFailed: 'blocklet.downgradedFailed',
   deployed: 'blocklet.deployed',
   updated: 'blocklet.updated',
   statusChange: 'blocklet.statusChange',
@@ -170,7 +172,6 @@ module.exports = Object.freeze({
   BLOCKLET_ENTRY_FILE: 'blocklet.js',
   BLOCKLET_META_FILE: 'blocklet.yml',
   BLOCKLET_META_FILE_ALT: 'blocklet.yaml',
-  BLOCKLET_META_FILE_OLD: 'blocklet.json',
 
   BLOCKLET_DEFAULT_VERSION: '1.0.0',
 

package/lib/file.js

@@ -1,9 +1,9 @@
 const path = require('path');
 const yaml = require('js-yaml');
 const fs = require('fs-extra');
-const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT, BLOCKLET_META_FILE_OLD } = require('./constants');
+const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT } = require('./constants');
 
-const list = [BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT, BLOCKLET_META_FILE_OLD];
+const list = [BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT];
 
 const select = (dir, { throwOnError = true } = {}) => {
   const metaFile = path.join(dir, BLOCKLET_META_FILE);

package/lib/nft-templates.js

@@ -0,0 +1,47 @@
+const joinUrl = require('url-join');
+
+const getBlockletPurchaseTemplate = (serviceUrl = 'https://registry.arcblock.io') => ({
+  type: 'vc',
+  value: {
+    '@context': 'https://schema.arcblock.io/v0.1/context.jsonld',
+    id: '{{input.id}}',
+    tag: ['{{data.did}}'],
+    type: ['VerifiableCredential', 'PurchaseCredential', 'NFTCertificate', 'BlockletPurchaseCredential'],
+    issuer: {
+      id: '{{ctx.issuer.id}}',
+      pk: '{{ctx.issuer.pk}}',
+      name: '{{ctx.issuer.name}}',
+    },
+    issuanceDate: '{{input.issuanceDate}}', // does not expire
+    credentialSubject: {
+      id: '{{ctx.owner}}',
+      sn: '{{ctx.id}}',
+      purchased: {
+        blocklet: {
+          id: '{{data.did}}',
+          url: '{{{data.url}}}',
+          name: '{{data.name}}',
+        },
+      },
+      display: {
+        type: 'url',
+        content: joinUrl(serviceUrl, '/api/nft/display'), // accept asset-did in query param
+      },
+    },
+    credentialStatus: {
+      id: joinUrl(serviceUrl, '/api/nft/status'),
+      type: 'NFTStatusList2021',
+      scope: 'public',
+    },
+    proof: {
+      type: '{{input.proofType}}',
+      created: '{{input.issuanceDate}}',
+      proofPurpose: 'assertionMethod',
+      jws: '{{input.signature}}',
+    },
+  },
+});
+
+module.exports = {
+  getBlockletPurchaseTemplate,
+};

package/lib/parse-navigation.js

@@ -7,13 +7,13 @@ const normalizePathPrefix = require('@abtnode/util/lib/normalize-path-prefix');
  * @param {*} prefix prefix of link
  * @param {*} _level 1: primary menu, >2: secondary menu
  */
-const parseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
+const doParseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
   const result = [];
 
   (navigation || []).forEach((nav) => {
     if (!nav.child) {
       if (_level > 1 && nav.items?.length) {
-        const list = parseNavigation(nav.items, blocklet, prefix, _level + 1);
+        const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
         result.push(...list);
         return;
       }
@@ -37,7 +37,7 @@ const parseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
       }
 
       if (nav.items?.length) {
-        const list = parseNavigation(nav.items, blocklet, prefix, _level + 1);
+        const list = doParseNavigation(nav.items, blocklet, prefix, _level + 1);
         if (list.length) {
           item.items = list;
         }
@@ -82,7 +82,7 @@ const parseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
       result.push(item);
     } else {
       // child declares multiple menus
-      const list = parseNavigation(
+      const list = doParseNavigation(
         childNavigation,
         child,
         normalizePathPrefix(`${prefix}${child.mountPoint}`),
@@ -105,4 +105,42 @@ const parseNavigation = (navigation, blocklet, prefix = '/', _level = 1) => {
   return result;
 };
 
+const markDuplicate = (navigation, urls = []) => {
+  navigation.forEach((item) => {
+    if (item.link && urls.includes(item.link)) {
+      item.duplicate = true;
+    }
+    if (item.link) {
+      urls.push(item.link);
+    }
+
+    if (item.items) {
+      markDuplicate(item.items, urls);
+    }
+  });
+
+  return navigation;
+};
+
+const filterDuplicate = (navigation) => {
+  const res = navigation.filter((x) => !x.duplicate);
+  res.forEach((item) => {
+    if (item.items) {
+      item.items = filterDuplicate(item.items);
+    }
+  });
+
+  return res;
+};
+
+const uniq = (navigation) => {
+  return filterDuplicate(markDuplicate(navigation));
+};
+
+const parseNavigation = (...args) => {
+  const res = doParseNavigation(...args);
+
+  return uniq(res);
+};
+
 module.exports = parseNavigation;

package/lib/parse.js

@@ -4,14 +4,14 @@ const yaml = require('js-yaml');
 const camelCase = require('lodash/camelCase');
 const debug = require('debug')('@blocklet/meta:parse');
 
-const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT, BLOCKLET_META_FILE_OLD } = require('./constants');
+const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT } = require('./constants');
 
 const toBlockletDid = require('./did');
 const { createBlockletSchema } = require('./schema');
 const { fixRequired, fixRepository, fixFiles, fixPerson, fixKeywords, fixTags, fixService } = require('./fix');
 
 /**
- * Get blocklet meta from blocklet.yml > blocklet.json > package.json
+ * Get blocklet meta from blocklet.yml
  * @param {string} dir blocklet directory
  * @param {object} options.extraRawAttrs extra attributes, will be used as base attributes
  * @param {boolean} options.ensureMain should we verify that main exists
@@ -21,30 +21,16 @@ const { fixRequired, fixRepository, fixFiles, fixPerson, fixKeywords, fixTags, f
  */
 const parse = (
   dir,
-  { ensureMain = false, ensureFiles = false, ensureDist = false, extraRawAttrs = {}, serviceMetas } = {}
+  {
+    ensureMain = false,
+    ensureFiles = false,
+    ensureDist = false,
+    extraRawAttrs = {},
+    serviceMetas,
+    schemaOptions = {},
+  } = {}
 ) => {
   let result = {};
-  const packageFile = path.join(dir, 'package.json');
-  if (fs.existsSync(packageFile)) {
-    try {
-      const packageJson = JSON.parse(fs.readFileSync(packageFile).toString());
-      delete packageJson.scripts;
-      result = Object.assign(result, packageJson, packageJson.blocklet || {});
-      debug('parse package.json', result);
-    } catch (err) {
-      console.error('parse_blocklet_meta from package.json failed', err);
-    }
-  }
-
-  const blockletMetaFileOld = path.join(dir, BLOCKLET_META_FILE_OLD);
-  if (fs.existsSync(blockletMetaFileOld)) {
-    try {
-      result = Object.assign(result, JSON.parse(fs.readFileSync(blockletMetaFileOld).toString()));
-      debug(`parse ${BLOCKLET_META_FILE_OLD}`, result);
-    } catch (err) {
-      console.error(`parse_blocklet_meta from ${BLOCKLET_META_FILE_OLD} failed`, err);
-    }
-  }
 
   const blockletMetaFile = path.join(dir, BLOCKLET_META_FILE);
   const blockletMetaFileAlt = path.join(dir, BLOCKLET_META_FILE_ALT);
@@ -90,7 +76,7 @@ const parse = (
   }, {});
 
   // Validate and cleanup
-  const schema = createBlockletSchema(dir, { ensureMain, ensureFiles, ensureDist });
+  const schema = createBlockletSchema(dir, { ensureMain, ensureFiles, ensureDist, ...schemaOptions });
   const { value, error } = schema.validate(result);
   if (error) {
     throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);

package/lib/payment.js

@@ -3,7 +3,7 @@ const joinURL = require('url-join');
 const { BN } = require('@ocap/util');
 const { isValidFactory } = require('@ocap/asset');
 const { toFactoryAddress } = require('@arcblock/did-util');
-const { getBlockletPurchaseTemplate } = require('@arcblock/nft/lib/templates');
+const { getBlockletPurchaseTemplate } = require('./nft-templates');
 
 const createShareContract = ({ tokens = [], shares = [] }) => {
   const zeroBN = new BN(0);

package/lib/util.js

@@ -1,6 +1,7 @@
 /* eslint-disable no-await-in-loop */
 const get = require('lodash/get');
 const slugify = require('slugify');
+const joinUrl = require('url-join');
 
 const { NODE_SERVICES, SLOT_FOR_IP_DNS_SITE, WHO_CAN_ACCESS } = require('@abtnode/constant');
 
@@ -24,6 +25,39 @@ const getComponentName = (component, ancestors = []) =>
 
 const getComponentBundleId = (component) => `${component.meta.bundleName}@${component.meta.version}`;
 
+/**
+ * a => ''
+ * @a/b => ''
+ * a/b => a
+ * @a/b/c => @a/b
+ * a/@b/c => a
+ * @a/b/@c/d => @a/b
+ * @a/b/@c/d/e => @a/b/@c/d
+ * @a/b/@c/d/@e/f => @a/b/@c/d
+ */
+const getParentComponentName = (name) => {
+  if (!name) {
+    return '';
+  }
+
+  const arr = name.split('/');
+  arr.pop();
+
+  if (!arr.length) {
+    return '';
+  }
+
+  if (arr[arr.length - 1].startsWith('@')) {
+    arr.pop();
+  }
+
+  if (!arr.length) {
+    return '';
+  }
+
+  return arr.join('/');
+};
+
 const forEachBlocklet = (
   blocklet,
   cb,
@@ -374,6 +408,21 @@ const getWhoCanAccess = (blocklet) => {
   return WHO_CAN_ACCESS.ALL;
 };
 
+const getConnectAppUrl = ({ request, baseUrl }) => {
+  const blockletDid = request.headers['x-blocklet-did'] || '';
+  const blockletRealDid = request.headers['x-blocklet-real-did'] || '';
+  const pathPrefix = request.headers['x-path-prefix'] || '/';
+  const groupPathPrefix = request.headers['x-group-path-prefix'] || '/';
+
+  // Child blocklets should set appInfo.link to exactly the same path as the root blocklet
+  let appUrl = baseUrl;
+  if (blockletDid !== blockletRealDid && pathPrefix !== groupPathPrefix) {
+    appUrl = joinUrl(joinUrl(appUrl, '/').replace(pathPrefix, groupPathPrefix), '');
+  }
+
+  return appUrl;
+};
+
 const replaceSlotToIp = (url, ip) => (url || '').replace(SLOT_FOR_IP_DNS_SITE, (ip || '').replace(/\./g, '-'));
 
 const urlFriendly = (name) => slugify(name.replace(/^[@./-]/, '').replace(/[@./_]/g, '-'));
@@ -402,4 +451,6 @@ module.exports = {
   getComponentName,
   getComponentBundleId,
   findComponentById,
+  getParentComponentName,
+  getConnectAppUrl,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.1",
+  "version": "1.8.4",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "lib/index.js",
   "files": [
@@ -18,17 +18,16 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/constant": "1.8.1",
-    "@abtnode/util": "1.8.1",
-    "@arcblock/did": "1.17.0",
-    "@arcblock/did-ext": "1.17.0",
-    "@arcblock/did-util": "1.17.0",
-    "@arcblock/jwt": "1.17.0",
-    "@arcblock/nft": "1.17.0",
-    "@ocap/asset": "1.17.0",
-    "@ocap/mcrypto": "1.17.0",
-    "@ocap/util": "1.17.0",
-    "@ocap/wallet": "1.17.0",
+    "@abtnode/constant": "1.8.4",
+    "@abtnode/util": "1.8.4",
+    "@arcblock/did": "1.17.5",
+    "@arcblock/did-ext": "1.17.5",
+    "@arcblock/did-util": "1.17.5",
+    "@arcblock/jwt": "1.17.5",
+    "@ocap/asset": "1.17.5",
+    "@ocap/mcrypto": "1.17.5",
+    "@ocap/util": "1.17.5",
+    "@ocap/wallet": "1.17.5",
     "ajv": "^8.11.0",
     "cjk-length": "^1.0.0",
     "debug": "^4.3.3",
@@ -47,5 +46,5 @@
   "devDependencies": {
     "jest": "^27.4.5"
   },
-  "gitHead": "c970b8a386bebd7fe6dbc8b8eedf8bd8328b4bb5"
+  "gitHead": "c42fb1bb84c5eef0f753fd5397d8007c7a6eee19"
 }