@blocklet/meta 1.8.65 → 1.8.66-beta-ff281dd5

package/lib/did.js

@@ -3,6 +3,9 @@ const mcrypto_1 = require("@ocap/mcrypto");
 const util_1 = require("@ocap/util");
 const did_1 = require("@arcblock/did");
 const toBlockletDid = (name) => {
+    if ((0, did_1.isValid)(name)) {
+        return name;
+    }
     const pk = (0, util_1.toHex)(Buffer.from(typeof name === 'string' ? name.trim() : name));
     return (0, did_1.fromPublicKey)(pk, { role: mcrypto_1.types.RoleType.ROLE_ANY });
 };

package/lib/extension.d.ts

@@ -1,5 +1,9 @@
 import { Extension, Root } from 'joi';
 declare const fileExtension: (joi: Root) => Extension;
+/**
+ * joi extend did 判断
+ * 由于需要兼容新旧两种 did 模式判断，所以这里不能做 role 类型判断
+ */
 declare const didExtension: (joi: Root) => Extension;
 export { fileExtension };
 export { didExtension };

package/lib/extension.js

@@ -60,6 +60,10 @@ const fileExtension = (joi) => ({
     },
 });
 exports.fileExtension = fileExtension;
+/**
+ * joi extend did 判断
+ * 由于需要兼容新旧两种 did 模式判断，所以这里不能做 role 类型判断
+ */
 const didExtension = (joi) => ({
     type: 'DID',
     base: joi.string(),

package/lib/file.d.ts

@@ -6,7 +6,9 @@ declare const select: (dir: string, { throwOnError }?: {
 declare const update: (file: string, meta: TBlockletMeta, { fix }?: {
     fix?: boolean;
 }) => void;
+declare const read: (file: string) => unknown;
 export { list };
+export { read };
 export { select };
 export { update };
 declare const _default: {

package/lib/file.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.update = exports.select = exports.list = void 0;
+exports.update = exports.select = exports.read = exports.list = void 0;
 const path_1 = __importDefault(require("path"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -43,6 +43,11 @@ const update = (file, meta, { fix = true } = {}) => {
     fs_extra_1.default.writeFileSync(file, js_yaml_1.default.dump(meta, { sortKeys: false, skipInvalid: true }));
 };
 exports.update = update;
+const read = (file) => {
+    const fileContent = fs_extra_1.default.readFileSync(file, 'utf8').toString();
+    return js_yaml_1.default.load(fileContent);
+};
+exports.read = read;
 exports.default = {
     list,
     select,

package/lib/fix.d.ts

@@ -8,12 +8,14 @@ declare const formatPerson: (person: string | Record<string, any>) => string;
 declare const parsePerson: (person: string) => any;
 declare const fixPerson: (data: any) => any;
 declare const fixInterfaces: (meta: any, removeMerged?: boolean) => any;
+declare const fixName: (meta: any) => any;
 export { fixRequired };
 export { fixRepository };
 export { fixFiles };
 export { fixKeywords };
 export { fixPerson };
 export { fixTags };
+export { fixName };
 export { formatPerson };
 export { parsePerson };
 export { fixInterfaces };
@@ -25,6 +27,7 @@ declare const _default: {
     fixKeywords: (data: any) => void;
     fixPerson: (data: any) => any;
     fixTags: (data: any) => void;
+    fixName: (meta: any) => any;
     formatPerson: (person: string | Record<string, any>) => string;
     parsePerson: (person: string) => any;
     fixInterfaces: (meta: any, removeMerged?: boolean) => any;

package/lib/fix.js

@@ -26,7 +26,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.fixService = exports.fixInterfaces = exports.parsePerson = exports.formatPerson = exports.fixTags = exports.fixPerson = exports.fixKeywords = exports.fixFiles = exports.fixRepository = exports.fixRequired = void 0;
+exports.fixService = exports.fixInterfaces = exports.parsePerson = exports.formatPerson = exports.fixName = exports.fixTags = exports.fixPerson = exports.fixKeywords = exports.fixFiles = exports.fixRepository = exports.fixRequired = void 0;
 const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const get_1 = __importDefault(require("lodash/get"));
@@ -35,6 +35,7 @@ const debug_1 = __importDefault(require("debug"));
 const validate_1 = require("./validate");
 Object.defineProperty(exports, "fixService", { enumerable: true, get: function () { return validate_1.fixAndValidateService; } });
 const constants_1 = __importDefault(require("./constants"));
+const name_1 = require("./name");
 const debug = (0, debug_1.default)('@blocklet/meta:fix');
 const { BLOCKLET_DEFAULT_VERSION, BLOCKLET_DEFAULT_PORT_NAME, BLOCKLET_DYNAMIC_PATH_PREFIX, BLOCKLET_INTERFACE_TYPE_WEB, BLOCKLET_INTERFACE_PUBLIC, } = constants_1.default;
 // Assign sensible defaults: description/main/group/version/public_url
@@ -228,6 +229,18 @@ const fixInterfaces = (meta, removeMerged = true) => {
     return meta;
 };
 exports.fixInterfaces = fixInterfaces;
+const fixName = (meta) => {
+    const { did } = meta;
+    try {
+        (0, name_1.validateNewDid)(did);
+        meta.name = did;
+    }
+    catch (_a) {
+        /* empty */
+    }
+    return meta;
+};
+exports.fixName = fixName;
 exports.default = {
     fixRequired,
     fixRepository,
@@ -235,6 +248,7 @@ exports.default = {
     fixKeywords,
     fixPerson,
     fixTags,
+    fixName,
     formatPerson,
     parsePerson,
     fixInterfaces,

package/lib/index.d.ts

@@ -6,13 +6,14 @@ import getBlockletWallet from './wallet';
 import getBlockletInfo from './info';
 import getBlockletEngine from './engine';
 import { validateMeta, fixAndValidateService } from './validate';
-import { formatPerson, parsePerson, fixPerson, fixInterfaces, fixService } from './fix';
-import { list, select, update } from './file';
+import { formatPerson, parsePerson, fixPerson, fixInterfaces, fixService, fixName } from './fix';
+import { list, select, update, read } from './file';
 import verifyMultiSig from './verify-multi-sig';
 export { constants };
 export { list };
 export { select };
 export { update };
+export { read };
 export { parse };
 export { validateMeta };
 export { fixAndValidateService };
@@ -21,6 +22,7 @@ export { parsePerson };
 export { fixPerson };
 export { fixInterfaces };
 export { fixService };
+export { fixName };
 export { toBlockletDid };
 export { getBlockletWallet };
 export { getBlockletInfo };
@@ -35,6 +37,7 @@ declare const _default: {
     update: (file: string, meta: import("./types").TBlockletMeta, { fix }?: {
         fix?: boolean;
     }) => void;
+    read: (file: string) => unknown;
     parse: (dir: string, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, extraRawAttrs, schemaOptions, defaultStoreUrl, fix, }?: {
         ensureMain?: boolean;
         ensureFiles?: boolean;
@@ -59,6 +62,7 @@ declare const _default: {
     parsePerson: (person: string) => any;
     fixPerson: (data: any) => any;
     fixInterfaces: (meta: any, removeMerged?: boolean) => any;
+    fixName: (meta: any) => any;
     fixService: (meta: import("./types").TBlockletMeta) => import("./types").TBlockletMeta;
     toBlockletDid: {
         (name: string | Buffer): string;

package/lib/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.verifyMultiSig = exports.getBlockletEngine = exports.getBlockletInfo = exports.getBlockletWallet = exports.toBlockletDid = exports.fixService = exports.fixInterfaces = exports.fixPerson = exports.parsePerson = exports.formatPerson = exports.fixAndValidateService = exports.validateMeta = exports.parse = exports.update = exports.select = exports.list = exports.constants = void 0;
+exports.verifyMultiSig = exports.getBlockletEngine = exports.getBlockletInfo = exports.getBlockletWallet = exports.toBlockletDid = exports.fixName = exports.fixService = exports.fixInterfaces = exports.fixPerson = exports.parsePerson = exports.formatPerson = exports.fixAndValidateService = exports.validateMeta = exports.parse = exports.read = exports.update = exports.select = exports.list = exports.constants = void 0;
 const constants_1 = __importDefault(require("./constants"));
 exports.constants = constants_1.default;
 const parse_1 = __importDefault(require("./parse"));
@@ -25,10 +25,12 @@ Object.defineProperty(exports, "parsePerson", { enumerable: true, get: function
 Object.defineProperty(exports, "fixPerson", { enumerable: true, get: function () { return fix_1.fixPerson; } });
 Object.defineProperty(exports, "fixInterfaces", { enumerable: true, get: function () { return fix_1.fixInterfaces; } });
 Object.defineProperty(exports, "fixService", { enumerable: true, get: function () { return fix_1.fixService; } });
+Object.defineProperty(exports, "fixName", { enumerable: true, get: function () { return fix_1.fixName; } });
 const file_1 = require("./file");
 Object.defineProperty(exports, "list", { enumerable: true, get: function () { return file_1.list; } });
 Object.defineProperty(exports, "select", { enumerable: true, get: function () { return file_1.select; } });
 Object.defineProperty(exports, "update", { enumerable: true, get: function () { return file_1.update; } });
+Object.defineProperty(exports, "read", { enumerable: true, get: function () { return file_1.read; } });
 const verify_multi_sig_1 = __importDefault(require("./verify-multi-sig"));
 exports.verifyMultiSig = verify_multi_sig_1.default;
 exports.default = {
@@ -36,6 +38,7 @@ exports.default = {
     list: file_1.list,
     select: file_1.select,
     update: file_1.update,
+    read: file_1.read,
     parse: parse_1.default,
     validateMeta: validate_1.validateMeta,
     fixAndValidateService: validate_1.fixAndValidateService,
@@ -43,6 +46,7 @@ exports.default = {
     parsePerson: fix_1.parsePerson,
     fixPerson: fix_1.fixPerson,
     fixInterfaces: fix_1.fixInterfaces,
+    fixName: fix_1.fixName,
     fixService: fix_1.fixService,
     toBlockletDid: did_1.default,
     getBlockletWallet: wallet_1.default,

package/lib/name.d.ts

@@ -1,5 +1,11 @@
+/**
+ * 检查一个 did 是否为新版 blocklet-did（这里只需要判断是否为 ROLE_BLOCKLET 即可）
+ * @param did 需要检查是否为新版 did 的值
+ */
+export declare const validateNewDid: (did: string) => void;
 export declare const validateName: (name: string) => void;
 declare const _default: {
     validateName: (name: string) => void;
+    validateNewDid: (did: string) => void;
 };
 export default _default;

package/lib/name.js

@@ -3,15 +3,39 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.validateName = void 0;
+exports.validateName = exports.validateNewDid = void 0;
+const did_1 = require("@arcblock/did");
 const validate_npm_package_name_1 = __importDefault(require("validate-npm-package-name"));
+const MAX_NAME_LENGTH = 32;
+/**
+ * 检查一个 did 是否为新版 blocklet-did（这里只需要判断是否为 ROLE_BLOCKLET 即可）
+ * @param did 需要检查是否为新版 did 的值
+ */
+const validateNewDid = (did) => {
+    const typeInfo = (0, did_1.toTypeInfo)(did);
+    if (typeInfo.role !== did_1.types.RoleType.ROLE_BLOCKLET) {
+        throw new Error("Blocklet DID's type must be ROLE_BLOCKLET");
+    }
+};
+exports.validateNewDid = validateNewDid;
 const validateName = (name) => {
-    const { validForNewPackages, errors = [], warnings = [] } = (0, validate_npm_package_name_1.default)(name);
-    if (!validForNewPackages) {
-        throw new Error(errors[0] || warnings[0]);
+    if ((0, did_1.isValid)(name)) {
+        // new did mode
+        (0, exports.validateNewDid)(name);
+    }
+    else {
+        // old did mode
+        const { validForNewPackages, errors = [], warnings = [] } = (0, validate_npm_package_name_1.default)(name);
+        if (!validForNewPackages) {
+            throw new Error(errors[0] || warnings[0]);
+        }
+        if (name.length > MAX_NAME_LENGTH) {
+            throw new Error('Blocklet name is too long');
+        }
     }
 };
 exports.validateName = validateName;
 exports.default = {
     validateName: exports.validateName,
+    validateNewDid: exports.validateNewDid,
 };

package/lib/parse.js

@@ -61,6 +61,7 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
     (0, fix_1.fixFiles)(result);
     (0, fix_1.fixKeywords)(result);
     (0, fix_1.fixTags)(result);
+    (0, fix_1.fixName)(result);
     (0, fix_1.fixPerson)(result);
     (0, fix_1.fixService)(result);
     if (defaultStoreUrl && ((_a = result.components) === null || _a === void 0 ? void 0 : _a.length)) {

package/lib/schema.js

@@ -17,13 +17,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.authConfigSchema = exports.cacheableSchema = exports.statsSchema = exports.titleSchema = exports.themeSchema = exports.signatureSchema = exports.serviceSchema = exports.scriptsSchema = exports.personSchema = exports.navigationSchema = exports.navigationItemSchema = exports.mountPointSchema = exports.logoSchema = exports.interfaceSchema = exports.environmentNameSchema = exports.environmentSchema = exports.engineSchema = exports.endpointSchema = exports.distSchema = exports.descriptionSchema = exports.createBlockletSchema = exports.componentSchema = exports.blockletNameSchema = exports.blockletMetaSchema = void 0;
 const fs_1 = __importDefault(require("fs"));
 const joi_1 = __importDefault(require("joi"));
-// eslint-disable-next-line import/no-named-default
 const cjk_length_1 = __importDefault(require("cjk-length"));
 const is_glob_1 = __importDefault(require("is-glob"));
 const joi_extension_semver_1 = require("joi-extension-semver");
 const is_var_name_1 = __importDefault(require("is-var-name"));
 const constant_1 = require("@abtnode/constant");
-const did_1 = __importDefault(require("./did"));
+const did_1 = require("@arcblock/did");
+const did_2 = __importDefault(require("./did"));
 const extension_1 = require("./extension");
 const name_1 = require("./name");
 const constants_1 = __importDefault(require("./constants"));
@@ -32,7 +32,6 @@ const cjkLength = cjk_length_1.default.default;
 const { BLOCKLET_GROUPS, BLOCKLET_PLATFORMS, BLOCKLET_ARCHITECTURES, BLOCKLET_INTERFACE_TYPES, BLOCKLET_INTERFACE_PROTOCOLS, BLOCKLET_ENTRY_FILE, BLOCKLET_BUNDLE_FILE, BLOCKLET_DEFAULT_PORT_NAME, BLOCKLET_DYNAMIC_PATH_PREFIX, BlockletGroup, BLOCKLET_LATEST_REQUIREMENT_SERVER, BLOCKLET_INTERFACE_TYPE_WEB, BLOCKLET_INTERFACE_TYPE_WELLKNOWN, BLOCKLET_APP_SPACE_ENDPOINTS, BLOCKLET_CONFIGURABLE_KEY, } = constants_1.default;
 const WELLKNOWN_PATH_PREFIX = '/.well-known';
 const MAX_TITLE_LENGTH = 24;
-const MAX_NAME_LENGTH = 32;
 const Joi = joi_1.default.extend(joi_extension_semver_1.semver)
     .extend(joi_extension_semver_1.semverRange)
     .extend(extension_1.fileExtension)
@@ -95,7 +94,6 @@ const blockletNameSchema = Joi.string()
     (0, name_1.validateName)(value);
     return value;
 })
-    .max(MAX_NAME_LENGTH)
     .meta({ className: 'TBlockletName' });
 exports.blockletNameSchema = blockletNameSchema;
 const ENV_NAME_WHITE_LIST = [BLOCKLET_CONFIGURABLE_KEY.BLOCKLET_WALLET_TYPE];
@@ -425,7 +423,7 @@ exports.authConfigSchema = authConfigSchema;
 const blockletMetaProps = {
     did: Joi.DID().trim().required(),
     version: Joi.semver().valid().required(),
-    name: blockletNameSchema.required(),
+    name: blockletNameSchema.optional(),
     description: descriptionSchema.required(),
     group: Joi.string()
         .valid(...BLOCKLET_GROUPS)
@@ -647,10 +645,29 @@ const createBlockletSchema = (baseDir, _a = {}) => {
         .rename('children', 'components')
         .custom((data, helper) => {
         const { did, name } = data;
-        const expectDid = (0, did_1.default)(name);
-        if (expectDid !== did) {
-            // @ts-expect-error
-            return helper.message(`the did of name "${name}" should be "${expectDid}"`);
+        let cacheError;
+        if ((0, did_1.isValid)(did)) {
+            try {
+                (0, name_1.validateNewDid)(did);
+                return data;
+            }
+            catch (e) {
+                cacheError = e;
+            }
+        }
+        /* ------------- 兼容旧的逻辑，旧逻辑使用 name 生成一个 did ------------- */
+        // 此时 name 必须存在
+        if (name) {
+            const expectDid = (0, did_2.default)(name);
+            if (expectDid !== did) {
+                // @ts-ignore
+                return helper.message(`The did of name "${name}" should be "${expectDid}"`);
+            }
+            return data;
+            /* ------------------------------------------------------ */
+        }
+        if (cacheError) {
+            return helper.message(cacheError.message);
         }
         return data;
     });

package/lib/types/schema.d.ts

@@ -66,7 +66,7 @@ export interface TBlockletMeta {
     logoUrl?: string;
     main: string;
     maintainers?: TPerson[];
-    name: TBlockletName;
+    name?: TBlockletName;
     navigation?: TNavigation;
     nftFactory?: string;
     path?: string;

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.65",
+  "version": "1.8.66-beta-ff281dd5",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -24,14 +24,14 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.8.65",
-    "@abtnode/constant": "1.8.65",
-    "@abtnode/util": "1.8.65",
+    "@abtnode/client": "1.8.66-beta-ff281dd5",
+    "@abtnode/constant": "1.8.66-beta-ff281dd5",
+    "@abtnode/util": "1.8.66-beta-ff281dd5",
     "@arcblock/did": "1.18.42",
     "@arcblock/did-ext": "1.18.42",
     "@arcblock/did-util": "1.18.42",
     "@arcblock/jwt": "1.18.42",
-    "@blocklet/constant": "1.8.65",
+    "@blocklet/constant": "1.8.66-beta-ff281dd5",
     "@ocap/asset": "1.18.42",
     "@ocap/mcrypto": "1.18.42",
     "@ocap/types": "1.18.42",
@@ -80,5 +80,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },
-  "gitHead": "69b608353fbbdb7c61f9ccb10965a1d0c55c45f2"
+  "gitHead": "92edfc81679a4749b30a7f8195d487afa148e26b"
 }