@blocklet/meta 1.8.55 → 1.8.56

package/lib/index.d.ts

@@ -35,21 +35,23 @@ declare const _default: {
     update: (file: string, meta: import("./types").TBlockletMeta, { fix }?: {
         fix?: boolean;
     }) => void;
-    parse: (dir: string, { ensureMain, ensureFiles, ensureDist, extraRawAttrs, serviceMetas, schemaOptions, fix, }?: {
+    parse: (dir: string, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, extraRawAttrs, schemaOptions, defaultStoreUrl, fix, }?: {
         ensureMain?: boolean;
         ensureFiles?: boolean;
         ensureDist?: boolean;
+        ensureComponentStore?: boolean;
         extraRawAttrs?: any;
-        serviceMetas?: any;
         schemaOptions?: any;
         enableDefaults?: boolean;
         extraAttrSpec?: any;
+        defaultStoreUrl?: string | ((component: import("./types").TComponent) => string);
         fix?: boolean;
     }) => import("./types").TBlockletMeta;
-    validateMeta: (meta: any, { ensureMain, ensureFiles, ensureDist, schemaOptions, }?: {
+    validateMeta: (meta: any, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, schemaOptions, }?: {
         ensureMain?: boolean;
         ensureFiles?: boolean;
         ensureDist?: boolean;
+        ensureComponentStore?: boolean;
         schemaOptions?: any;
     }) => import("./types").TBlockletMeta;
     fixAndValidateService: (meta: import("./types").TBlockletMeta) => import("./types").TBlockletMeta;

package/lib/parse.d.ts

@@ -1,4 +1,4 @@
-import { TBlockletMeta } from './types';
+import { TBlockletMeta, TComponent } from './types';
 /**
  * Get blocklet meta from blocklet.yml
  * @param {string} dir blocklet directory
@@ -6,17 +6,17 @@ import { TBlockletMeta } from './types';
  * @param {boolean} options.ensureMain should we verify that main exists
  * @param {boolean} options.ensureDist should we verify that dist exists
  * @param {boolean} options.ensureFiles should we verify that logo and files exists
- * @param {Array} options.serviceMetas should we verify that each service is validate (using JSON Schema defined serviceMetas)
  */
-declare const parse: (dir: string, { ensureMain, ensureFiles, ensureDist, extraRawAttrs, serviceMetas, schemaOptions, fix, }?: {
+declare const parse: (dir: string, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, extraRawAttrs, schemaOptions, defaultStoreUrl, fix, }?: {
     ensureMain?: boolean;
     ensureFiles?: boolean;
     ensureDist?: boolean;
+    ensureComponentStore?: boolean;
     extraRawAttrs?: any;
-    serviceMetas?: any;
     schemaOptions?: any;
     enableDefaults?: boolean;
     extraAttrSpec?: any;
+    defaultStoreUrl?: string | ((component: TComponent) => string);
     fix?: boolean;
 }) => TBlockletMeta;
 export = parse;

package/lib/parse.js

@@ -6,6 +6,7 @@ const fs_1 = __importDefault(require("fs"));
 const path_1 = __importDefault(require("path"));
 const js_yaml_1 = __importDefault(require("js-yaml"));
 const camelCase_1 = __importDefault(require("lodash/camelCase"));
+const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
 const debug_1 = __importDefault(require("debug"));
 const constants_1 = __importDefault(require("./constants"));
 const schema_1 = require("./schema");
@@ -19,15 +20,15 @@ const { BLOCKLET_META_FILE, BLOCKLET_META_FILE_ALT } = constants_1.default;
  * @param {boolean} options.ensureMain should we verify that main exists
  * @param {boolean} options.ensureDist should we verify that dist exists
  * @param {boolean} options.ensureFiles should we verify that logo and files exists
- * @param {Array} options.serviceMetas should we verify that each service is validate (using JSON Schema defined serviceMetas)
  */
-const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = false, extraRawAttrs = {}, serviceMetas, schemaOptions = {}, fix = true, } = {}) => {
-    let result = {};
+const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = false, ensureComponentStore = true, extraRawAttrs = {}, schemaOptions = {}, defaultStoreUrl, fix = true, } = {}) => {
+    var _a;
+    let result;
     const blockletMetaFile = path_1.default.join(dir, BLOCKLET_META_FILE);
     const blockletMetaFileAlt = path_1.default.join(dir, BLOCKLET_META_FILE_ALT);
     if (fs_1.default.existsSync(blockletMetaFile)) {
         try {
-            result = Object.assign(result, js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFile).toString(), { json: true }));
+            result = js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFile).toString(), { json: true });
             debug(`parse ${blockletMetaFile}`, result);
         }
         catch (err) {
@@ -36,7 +37,7 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
     }
     else if (fs_1.default.existsSync(blockletMetaFileAlt)) {
         try {
-            result = Object.assign(result, js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFileAlt).toString(), { json: true }));
+            result = Object.assign({}, js_yaml_1.default.load(fs_1.default.readFileSync(blockletMetaFileAlt).toString(), { json: true }));
             debug(`parse ${blockletMetaFileAlt}`, result);
         }
         catch (err) {
@@ -61,9 +62,16 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
     (0, fix_1.fixKeywords)(result);
     (0, fix_1.fixTags)(result);
     (0, fix_1.fixPerson)(result);
-    // @ts-expect-error TS(2554) FIXME: Expected 1 arguments, but got 2.
-    (0, fix_1.fixService)(result, serviceMetas);
-    debug('fix', result);
+    (0, fix_1.fixService)(result);
+    if (defaultStoreUrl && ((_a = result.components) === null || _a === void 0 ? void 0 : _a.length)) {
+        result.components.forEach((x) => {
+            if ('name' in x.source) {
+                if (!x.source.store) {
+                    x.source.store = typeof defaultStoreUrl === 'function' ? defaultStoreUrl((0, cloneDeep_1.default)(x)) : defaultStoreUrl;
+                }
+            }
+        });
+    }
     // We will overwrite did anyway
     result.path = `/${result.group}/${result.name}`;
     // Ensure camelCase
@@ -71,8 +79,12 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
         acc[(0, camelCase_1.default)(k)] = result[k];
         return acc;
     }, {});
+    debug('fix', result);
     // Validate and cleanup
-    const schema = (0, schema_1.createBlockletSchema)(dir, Object.assign({ ensureMain, ensureFiles, ensureDist }, schemaOptions));
+    const schema = (0, schema_1.createBlockletSchema)(dir, Object.assign({ ensureMain,
+        ensureFiles,
+        ensureDist,
+        ensureComponentStore }, schemaOptions));
     const { value, error } = schema.validate(result);
     if (error) {
         throw new Error(`Invalid blocklet.yml: ${error.details.map((x) => x.message).join(', ')}`);

package/lib/schema.d.ts

@@ -21,10 +21,11 @@ declare const navigationSchema: JOI.ArraySchema<any[]>;
 declare const themeSchema: JOI.ObjectSchema<any>;
 declare const authConfigSchema: JOI.ObjectSchema<any>;
 declare const blockletMetaSchema: JOI.ObjectSchema<any>;
-declare const createBlockletSchema: (baseDir: string, { ensureMain, ensureFiles, ensureDist, ...schemaOptions }?: {
+declare const createBlockletSchema: (baseDir: string, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, ...schemaOptions }?: {
     ensureMain?: boolean;
     ensureFiles?: boolean;
     ensureDist?: boolean;
+    ensureComponentStore?: boolean;
 }) => JOI.ObjectSchema;
 export { blockletMetaSchema, blockletNameSchema, componentSchema, createBlockletSchema, descriptionSchema, distSchema, endpointSchema, engineSchema, environmentSchema, environmentNameSchema, interfaceSchema, logoSchema, mountPointSchema, navigationItemSchema, navigationSchema, personSchema, scriptsSchema, serviceSchema, signatureSchema, themeSchema, titleSchema, statsSchema, authConfigSchema, };
 declare const _default: {
@@ -32,10 +33,11 @@ declare const _default: {
     componentSchema: JOI.ObjectSchema<any>;
     endpointSchema: JOI.ObjectSchema<any>;
     serviceSchema: JOI.ObjectSchema<any>;
-    createBlockletSchema: (baseDir: string, { ensureMain, ensureFiles, ensureDist, ...schemaOptions }?: {
+    createBlockletSchema: (baseDir: string, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, ...schemaOptions }?: {
         ensureMain?: boolean;
         ensureFiles?: boolean;
         ensureDist?: boolean;
+        ensureComponentStore?: boolean;
     }) => JOI.ObjectSchema<any>;
     interfaceSchema: JOI.ObjectSchema<any>;
     environmentSchema: JOI.ObjectSchema<any>;

package/lib/schema.js

@@ -259,16 +259,17 @@ const statsSchema = Joi.object({
     unknownType: 'any',
 });
 exports.statsSchema = statsSchema;
-const componentSchema = Joi.object({
+const urlListSchema = Joi.alternatives().try(Joi.string().uri(), Joi.array().items(Joi.string().uri()).min(1));
+const componentSchemaProps = {
     name: blockletNameSchema.required(),
     title: titleSchema,
     description: descriptionSchema,
     mountPoint: mountPointSchema,
     services: Joi.array().items(serviceSchema).unique('name'),
     source: Joi.alternatives().try(Joi.object({
-        url: Joi.alternatives().try(Joi.string().uri(), Joi.array().items(Joi.string().uri()).min(1)).required(),
+        url: urlListSchema.required(),
     }), Joi.object({
-        store: Joi.alternatives().try(Joi.string().uri(), Joi.array().items(Joi.string().uri()).min(1)).required(),
+        store: urlListSchema,
         name: blockletNameSchema.required(),
         // TODO 目前只能支持锁死的版本号，接下载需要支持自适应的版本号，比如 4.x
         version: Joi.alternatives().try(Joi.string().valid('latest'), Joi.semver().valid()).default('latest'),
@@ -286,8 +287,8 @@ const componentSchema = Joi.object({
         services: Joi.array().items(serviceSchema).unique('name'),
     }))
         .optional(),
-})
-    .custom((value, helper) => {
+};
+const createComponentSchema = (allowEmptyStore) => Joi.object(componentSchemaProps).custom((value, helper) => {
     if (!value.mountPoint && (!value.mountPoints || !value.mountPoints.length)) {
         // @ts-expect-error
         return helper.message('child mountPoint is required');
@@ -296,13 +297,23 @@ const componentSchema = Joi.object({
         // @ts-expect-error
         return helper.message('child source is required');
     }
+    if (!allowEmptyStore && value.source && value.source.name && !value.source.store) {
+        // @ts-expect-error
+        return helper.message(`missing 'store' in source of component ${value.name}`);
+    }
     return value;
-})
-    .meta({
+});
+const componentSchema = createComponentSchema().meta({
     className: 'TComponent',
     unknownType: 'any',
 });
 exports.componentSchema = componentSchema;
+const componentSchemaWithoutStoreCheck = createComponentSchema(true);
+const componentsSchema = (checkStore) => Joi.array()
+    .items(checkStore ? componentSchema : componentSchemaWithoutStoreCheck)
+    .unique('name')
+    .optional()
+    .default([]);
 const signatureSchema = Joi.object({
     type: Joi.string().required(),
     name: Joi.string().required(),
@@ -568,7 +579,7 @@ const blockletMetaProps = {
     signatures: Joi.array().items(signatureSchema).optional(),
     lastPublishedAt: Joi.string().isoDate().optional(),
     // blocklet component support
-    components: Joi.array().items(componentSchema).unique('name').optional().default([]),
+    components: componentsSchema(),
     // navigation & theme
     navigation: navigationSchema,
     theme: themeSchema,
@@ -587,7 +598,7 @@ const blockletMetaSchema = Joi.object(blockletMetaProps).options({ stripUnknown:
 });
 exports.blockletMetaSchema = blockletMetaSchema;
 const createBlockletSchema = (baseDir, _a = {}) => {
-    var { ensureMain = false, ensureFiles = false, ensureDist = false } = _a, schemaOptions = __rest(_a, ["ensureMain", "ensureFiles", "ensureDist"]);
+    var { ensureMain = false, ensureFiles = false, ensureDist = false, ensureComponentStore = true } = _a, schemaOptions = __rest(_a, ["ensureMain", "ensureFiles", "ensureDist", "ensureComponentStore"]);
     if (!baseDir || !fs_1.default.existsSync(baseDir)) {
         // eslint-disable-next-line no-param-reassign
         ensureFiles = false;
@@ -603,7 +614,7 @@ const createBlockletSchema = (baseDir, _a = {}) => {
             ? // eslint-disable-next-line
                 Joi.file().exists({ baseDir, canSkip: (dir, name) => [BLOCKLET_ENTRY_FILE, BLOCKLET_BUNDLE_FILE].includes(name) || (0, is_glob_1.default)(name) }) // prettier-ignore
             : Joi.string().trim())
-            .optional(), dist: ensureDist ? distSchema.required() : distSchema.optional() }))
+            .optional(), dist: ensureDist ? distSchema.required() : distSchema.optional(), components: componentsSchema(ensureComponentStore) }))
         .options(Object.assign({ stripUnknown: true, noDefaults: false }, schemaOptions))
         .rename('children', 'components')
         .custom((data, helper) => {

package/lib/types/schema.d.ts

@@ -17,7 +17,31 @@ export interface TBlockletMeta {
         navigation?: boolean;
     };
     community?: string;
-    components?: TComponent[];
+    components?: {
+        description?: TDescription;
+        mountPoint?: TMountPoint;
+        mountPoints?: {
+            child: {
+                interfaceName: string;
+            };
+            root: {
+                interfaceName: string;
+                prefix: string;
+            };
+            services?: TService[];
+        }[];
+        name: TBlockletName;
+        resolved?: string | string;
+        services?: TService[];
+        source?: {
+            url: string | string[];
+        } | {
+            name: TBlockletName;
+            store?: string | string[];
+            version?: 'latest' | string;
+        };
+        title?: TTitle;
+    }[];
     contributors?: TPerson[];
     copyright?: {
         owner?: string;
@@ -116,7 +140,7 @@ export interface TComponent {
         url: string | string[];
     } | {
         name: TBlockletName;
-        store: string | string[];
+        store?: string | string[];
         version?: 'latest' | string;
     };
     title?: TTitle;

package/lib/validate.d.ts

@@ -1,9 +1,10 @@
 import { TBlockletMeta } from './types';
 declare const fixAndValidateService: (meta: TBlockletMeta) => TBlockletMeta;
-declare const validateMeta: (meta: any, { ensureMain, ensureFiles, ensureDist, schemaOptions, }?: {
+declare const validateMeta: (meta: any, { ensureMain, ensureFiles, ensureDist, ensureComponentStore, schemaOptions, }?: {
     ensureMain?: boolean;
     ensureFiles?: boolean;
     ensureDist?: boolean;
+    ensureComponentStore?: boolean;
     schemaOptions?: any;
 }) => TBlockletMeta;
 export default validateMeta;

package/lib/validate.js

@@ -20,8 +20,11 @@ const fixAndValidateService = (meta) => {
     return meta;
 };
 exports.fixAndValidateService = fixAndValidateService;
-const validateMeta = (meta, { ensureMain = false, ensureFiles = false, ensureDist = false, schemaOptions = {}, } = {}) => {
-    const schema = (0, schema_1.createBlockletSchema)(null, Object.assign({ ensureMain, ensureFiles, ensureDist }, schemaOptions));
+const validateMeta = (meta, { ensureMain = false, ensureFiles = false, ensureDist = false, ensureComponentStore = true, schemaOptions = {}, } = {}) => {
+    const schema = (0, schema_1.createBlockletSchema)(null, Object.assign({ ensureMain,
+        ensureFiles,
+        ensureDist,
+        ensureComponentStore }, schemaOptions));
     const { value, error } = schema.validate(meta);
     if (error) {
         throw new Error(`Invalid blocklet meta: ${error.details.map((x) => x.message).join(', ')}`);

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.55",
+  "version": "1.8.56",
   "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.55",
-    "@abtnode/constant": "1.8.55",
-    "@abtnode/util": "1.8.55",
+    "@abtnode/client": "1.8.56",
+    "@abtnode/constant": "1.8.56",
+    "@abtnode/util": "1.8.56",
     "@arcblock/did": "1.18.34",
     "@arcblock/did-ext": "1.18.34",
     "@arcblock/did-util": "1.18.34",
     "@arcblock/jwt": "1.18.34",
-    "@blocklet/constant": "1.8.55",
+    "@blocklet/constant": "1.8.56",
     "@ocap/asset": "1.18.34",
     "@ocap/mcrypto": "1.18.34",
     "@ocap/types": "1.18.34",
@@ -80,5 +80,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },
-  "gitHead": "dce39bef7062b76648998b1f1b9a3c0a9b708dff"
+  "gitHead": "8c24c9d747e96e05510b9cbe863666960569fb46"
 }