@blocklet/meta 1.8.37 → 1.8.38

package/lib/did.d.ts

@@ -1,10 +1,12 @@
 /// <reference types="node" />
-import { TBlockletMeta } from './types';
 declare const toBlockletDid: {
     (name: string | Buffer): string;
     toExternalBlocklet(name: string, userDid: string, { didOnly, nameOnly }?: {
         didOnly?: boolean;
         nameOnly?: boolean;
-    }): Pick<TBlockletMeta, 'did' | 'name'> | string;
+    }): string | {
+        did: string;
+        name: string;
+    };
 };
 export = toBlockletDid;

package/lib/fix.js

@@ -37,11 +37,8 @@ Object.defineProperty(exports, "fixService", { enumerable: true, get: function (
 const constants_1 = __importDefault(require("./constants"));
 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: name/description/main/group/version/public_url
+// Assign sensible defaults: description/main/group/version/public_url
 const fixRequired = (data, dir) => {
-    if (!data.name) {
-        data.name = path_1.default.basename(dir);
-    }
     if (!data.description) {
         data.description = `Blocklet from ${dir}`;
     }

package/lib/index.d.ts

@@ -63,7 +63,10 @@ declare const _default: {
         toExternalBlocklet(name: string, userDid: string, { didOnly, nameOnly }?: {
             didOnly?: boolean;
             nameOnly?: boolean;
-        }): string | Pick<import("./types").TBlockletMeta, "name" | "did">;
+        }): string | {
+            did: string;
+            name: string;
+        };
     };
     getBlockletWallet: (blockletDid: string, nodeSk?: string, type?: import("@arcblock/did").DIDType, index?: number) => import("@ocap/wallet").WalletObject<string>;
     getBlockletInfo: (state: import("@abtnode/client").BlockletState, nodeSk?: string, { returnWallet }?: {
@@ -71,6 +74,7 @@ declare const _default: {
     }) => {
         did: string;
         name: string;
+        version: string;
         description: string;
         passportColor?: string;
         appUrl: string;

package/lib/info.d.ts

@@ -5,6 +5,7 @@ declare const getBlockletInfo: (state: BlockletState, nodeSk?: string, { returnW
 }) => {
     did: string;
     name: string;
+    version: string;
     description: string;
     passportColor?: string;
     appUrl: string;

package/lib/info.js

@@ -14,7 +14,7 @@ const getBlockletInfo = (state, nodeSk, { returnWallet = true } = {}) => {
     const customDescription = envs.find((x) => x.key === 'BLOCKLET_APP_DESCRIPTION');
     const customPassportColor = envs.find((x) => x.key === 'BLOCKLET_PASSPORT_COLOR');
     const customAppUrl = envs.find((x) => x.key === 'BLOCKLET_APP_URL');
-    const { did } = state.meta;
+    const { did, version } = state.meta;
     const name = (0, util_1.getDisplayName)(state);
     const description = (0, get_1.default)(customDescription, 'value', state.meta.description);
     const passportColor = (0, get_1.default)(customPassportColor, 'value', 'auto');
@@ -22,6 +22,7 @@ const getBlockletInfo = (state, nodeSk, { returnWallet = true } = {}) => {
     if (!returnWallet) {
         return {
             did,
+            version,
             name,
             description,
             appUrl,
@@ -51,6 +52,7 @@ const getBlockletInfo = (state, nodeSk, { returnWallet = true } = {}) => {
     }
     return {
         did,
+        version,
         name,
         description,
         passportColor,

package/lib/parse.js

@@ -8,7 +8,6 @@ const js_yaml_1 = __importDefault(require("js-yaml"));
 const camelCase_1 = __importDefault(require("lodash/camelCase"));
 const debug_1 = __importDefault(require("debug"));
 const constants_1 = __importDefault(require("./constants"));
-const did_1 = __importDefault(require("./did"));
 const schema_1 = require("./schema");
 const fix_1 = require("./fix");
 const debug = (0, debug_1.default)('@blocklet/meta:parse');
@@ -67,7 +66,6 @@ const parse = (dir, { ensureMain = false, ensureFiles = false, ensureDist = fals
     debug('fix', result);
     // We will overwrite did anyway
     result.path = `/${result.group}/${result.name}`;
-    result.did = (0, did_1.default)(Buffer.from(result.name, 'utf8'));
     // Ensure camelCase
     result = Object.keys(result).reduce((acc, k) => {
         acc[(0, camelCase_1.default)(k)] = result[k];

package/lib/schema.d.ts

@@ -4,6 +4,7 @@ declare const descriptionSchema: JOI.StringSchema<string>;
 declare const logoSchema: JOI.StringSchema<string>;
 declare const mountPointSchema: JOI.StringSchema<string>;
 declare const blockletNameSchema: JOI.StringSchema<string>;
+declare const environmentNameSchema: JOI.StringSchema<string>;
 declare const environmentSchema: JOI.ObjectSchema<any>;
 declare const scriptsSchema: JOI.ObjectSchema<any>;
 declare const serviceSchema: JOI.ObjectSchema<any>;
@@ -18,13 +19,14 @@ declare const signatureSchema: JOI.ObjectSchema<any>;
 declare const navigationItemSchema: JOI.ObjectSchema<any>;
 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 }?: {
     ensureMain?: boolean;
     ensureFiles?: boolean;
     ensureDist?: boolean;
 }) => JOI.ObjectSchema;
-export { blockletMetaSchema, blockletNameSchema, componentSchema, createBlockletSchema, descriptionSchema, distSchema, endpointSchema, engineSchema, environmentSchema, interfaceSchema, logoSchema, mountPointSchema, navigationItemSchema, navigationSchema, personSchema, scriptsSchema, serviceSchema, signatureSchema, themeSchema, titleSchema, statsSchema, };
+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: {
     blockletNameSchema: JOI.StringSchema<string>;
     componentSchema: JOI.ObjectSchema<any>;
@@ -37,6 +39,7 @@ declare const _default: {
     }) => JOI.ObjectSchema<any>;
     interfaceSchema: JOI.ObjectSchema<any>;
     environmentSchema: JOI.ObjectSchema<any>;
+    environmentNameSchema: JOI.StringSchema<string>;
     scriptsSchema: JOI.ObjectSchema<any>;
     personSchema: JOI.ObjectSchema<any>;
     distSchema: JOI.ObjectSchema<any>;
@@ -46,5 +49,6 @@ declare const _default: {
     navigationSchema: JOI.ArraySchema<any[]>;
     themeSchema: JOI.ObjectSchema<any>;
     mountPointSchema: JOI.StringSchema<string>;
+    authConfigSchema: JOI.ObjectSchema<any>;
 };
 export default _default;

package/lib/schema.js

@@ -14,19 +14,19 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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.environmentSchema = exports.engineSchema = exports.endpointSchema = exports.distSchema = exports.descriptionSchema = exports.createBlockletSchema = exports.componentSchema = exports.blockletNameSchema = exports.blockletMetaSchema = void 0;
+exports.authConfigSchema = 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"));
-const constant_1 = require("@abtnode/constant");
 // 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 did_1 = __importDefault(require("./did"));
 const extension_1 = require("./extension");
 const name_1 = require("./name");
 const constants_1 = __importDefault(require("./constants"));
 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_STORAGE_ENDPOINTS, } = constants_1.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;
@@ -62,8 +62,40 @@ const blockletNameSchema = Joi.string()
     .max(MAX_NAME_LENGTH)
     .meta({ className: 'TBlockletName' });
 exports.blockletNameSchema = blockletNameSchema;
+const ENV_NAME_WHITE_LIST = [BLOCKLET_CONFIGURABLE_KEY.BLOCKLET_WALLET_TYPE];
+const environmentNameSchema = Joi.string()
+    .trim()
+    .min(1)
+    .max(50)
+    .required()
+    .custom((name, helper) => {
+    if (name.startsWith('BLOCKLET')) {
+        if (!ENV_NAME_WHITE_LIST.includes(name)) {
+            // @ts-expect-error
+            return helper.message('Env name can not start with BLOCKLET_');
+        }
+    }
+    if (name.startsWith('COMPONENT')) {
+        // @ts-expect-error
+        return helper.message('Env name can not start with COMPONENT_');
+    }
+    if (name.startsWith('ABTNODE')) {
+        // @ts-expect-error
+        return helper.message('Env name can not start with ABTNODE_');
+    }
+    if (/[^\w]/.test(name)) {
+        // @ts-expect-error
+        return helper.message('Env name can include only numbers or letters or "_"');
+    }
+    return name;
+})
+    .meta({
+    className: 'TEnvironmentName',
+    unknownType: 'any',
+});
+exports.environmentNameSchema = environmentNameSchema;
 const environmentSchema = Joi.object({
-    name: Joi.string().trim().required(),
+    name: environmentNameSchema.required(),
     description: Joi.string().trim().required(),
     default: Joi.string().optional().allow('').default(''),
     required: Joi.boolean().default(false),
@@ -72,10 +104,6 @@ const environmentSchema = Joi.object({
     shared: Joi.boolean().default((parent) => !parent.secure),
 })
     .custom((x, helper) => {
-    if (x.name.startsWith(constant_1.BLOCKLET_PREFERENCE_PREFIX)) {
-        // @ts-expect-error
-        return helper.message(`Env name can not start with ${constant_1.BLOCKLET_PREFERENCE_PREFIX}`);
-    }
     if (x.secure && x.default) {
         // @ts-expect-error
         return helper.message(`Cannot declare default value for secure env ${x.name}`);
@@ -308,6 +336,20 @@ const themeSchema = Joi.object({
     unknownType: 'any',
 });
 exports.themeSchema = themeSchema;
+const authConfigSchema = Joi.object({
+    whoCanAccess: Joi.string().valid('owner', 'invited', 'all'),
+    profileFields: Joi.array().items(Joi.string().valid('fullName', 'email', 'avatar', 'phone')).unique(),
+    ignoreUrls: Joi.array().items(Joi.string().min(1)),
+    allowSwitchProfile: Joi.boolean(),
+    blockUnauthenticated: Joi.boolean(),
+    blockUnauthorized: Joi.boolean(),
+})
+    .options({ stripUnknown: true })
+    .meta({
+    className: 'TAuthConfig',
+    unknownType: 'any',
+});
+exports.authConfigSchema = authConfigSchema;
 const blockletMetaProps = {
     did: Joi.DID().trim().required(),
     version: Joi.semver().valid().required(),
@@ -450,7 +492,20 @@ const blockletMetaProps = {
     })
         .default([]),
     // environments
-    environments: Joi.array().items(environmentSchema).default([]).optional(),
+    environments: Joi.array()
+        .items(environmentSchema)
+        .default([])
+        .optional()
+        .custom((data, helper) => {
+        if (data && data.length) {
+            const duplicates = data.filter((x, index) => data.findIndex((y) => y.name === x.name) !== index);
+            if (duplicates.length) {
+                // @ts-expect-error
+                return helper.message(`find duplicate environment names ${duplicates.map((x) => x.name).join(', ')}`);
+            }
+        }
+        return data;
+    }),
     // scripts & hooks
     scripts: scriptsSchema,
     // capabilities
@@ -458,8 +513,8 @@ const blockletMetaProps = {
         clusterMode: Joi.boolean().default(false),
         // added in 1.2.2
         component: Joi.boolean().default(true),
-        didStorage: Joi.string()
-            .valid(...Object.values(BLOCKLET_APP_STORAGE_ENDPOINTS))
+        didSpace: Joi.string()
+            .valid(...Object.values(BLOCKLET_APP_SPACE_ENDPOINTS))
             .optional(),
     }).default({
         clusterMode: false,
@@ -516,7 +571,15 @@ const createBlockletSchema = (baseDir, _a = {}) => {
             : Joi.string().trim())
             .optional(), dist: ensureDist ? distSchema.required() : distSchema.optional() }))
         .options(Object.assign({ stripUnknown: true, noDefaults: false }, schemaOptions))
-        .rename('children', 'components');
+        .rename('children', 'components')
+        .custom((data, helper) => {
+        const { did, name } = data;
+        if ((0, did_1.default)(name) !== did) {
+            // @ts-expect-error
+            return helper.message(`name "${name}" does not match with did "${did}"`);
+        }
+        return data;
+    });
 };
 exports.createBlockletSchema = createBlockletSchema;
 exports.default = {
@@ -527,6 +590,7 @@ exports.default = {
     createBlockletSchema,
     interfaceSchema,
     environmentSchema,
+    environmentNameSchema,
     scriptsSchema,
     personSchema,
     distSchema,
@@ -536,4 +600,5 @@ exports.default = {
     navigationSchema,
     themeSchema,
     mountPointSchema,
+    authConfigSchema,
 };

package/lib/service.d.ts

@@ -1,26 +1,27 @@
-declare const setService: (meta: any) => void;
-declare const getServiceMetas: ({ stringifySchema }?: {
-    stringifySchema?: boolean;
-}) => any[];
+declare const setService: (meta: {
+    name: string;
+    schema: any;
+    default: any;
+}) => void;
 declare const getServiceConfig: (serviceName: string, customConfig: any, { validate }?: {
     validate?: any;
 }) => any;
 declare const getDefaultServiceConfig: (serviceName: string) => any;
 declare const findService: (services: any[], name: string) => any;
-export { getServiceMetas };
 export { getServiceConfig };
 export { getDefaultServiceConfig };
 export { findService };
 export { setService };
 declare const _default: {
-    getServiceMetas: ({ stringifySchema }?: {
-        stringifySchema?: boolean;
-    }) => any[];
     getServiceConfig: (serviceName: string, customConfig: any, { validate }?: {
         validate?: any;
     }) => any;
     getDefaultServiceConfig: (serviceName: string) => any;
     findService: (services: any[], name: string) => any;
-    setService: (meta: any) => void;
+    setService: (meta: {
+        name: string;
+        schema: any;
+        default: any;
+    }) => void;
 };
 export default _default;

package/lib/service.js

@@ -3,43 +3,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.setService = exports.findService = exports.getDefaultServiceConfig = exports.getServiceConfig = exports.getServiceMetas = void 0;
+exports.setService = exports.findService = exports.getDefaultServiceConfig = exports.getServiceConfig = void 0;
 const cloneDeep_1 = __importDefault(require("lodash/cloneDeep"));
-const ajv_1 = __importDefault(require("ajv"));
 const constant_1 = __importDefault(require("@abtnode/constant"));
-const auth_json_1 = __importDefault(require("./service-configs/auth.json"));
+const schema_1 = require("./schema");
 const { NODE_SERVICES } = constant_1.default;
-const ajv = new ajv_1.default({
-    useDefaults: true,
-    removeAdditional: 'all',
-});
 const SERVICES = {};
 const setService = (meta) => {
-    const validate = ajv.compile(meta.schema.JSONSchema);
-    // parse empty custom config to get default config
-    const defaultConfig = {};
-    validate(defaultConfig);
     SERVICES[meta.name] = {
-        meta,
-        validate,
-        defaultConfig,
+        validate: meta.schema.validate.bind(meta.schema),
+        defaultConfig: meta.default,
     };
 };
 exports.setService = setService;
-setService(auth_json_1.default);
+setService({
+    name: 'auth',
+    schema: schema_1.authConfigSchema,
+    default: {},
+});
 // backward compatible
 SERVICES[NODE_SERVICES.AUTH_SERVICE] = Object.assign(Object.assign({}, SERVICES[NODE_SERVICES.AUTH]), { meta: Object.assign(Object.assign({}, SERVICES[NODE_SERVICES.AUTH].meta), { name: NODE_SERVICES.AUTH_SERVICE }) });
-const getServiceMetas = ({ stringifySchema = false } = {}) => {
-    const list = Object.values(SERVICES).map(({ meta }) => {
-        const data = (0, cloneDeep_1.default)(meta);
-        if (stringifySchema) {
-            data.schema = JSON.stringify(meta.schema);
-        }
-        return data;
-    });
-    return list;
-};
-exports.getServiceMetas = getServiceMetas;
 const getService = (serviceName) => {
     if (!serviceName) {
         throw new Error('service name should not be empty');
@@ -53,13 +36,11 @@ const getService = (serviceName) => {
 const getServiceConfig = (serviceName, customConfig, { validate } = {}) => {
     const service = getService(serviceName);
     const data = (0, cloneDeep_1.default)(customConfig || {});
-    // this method may have side effect thar will fill default value to customConfig
-    const valid = service.validate(data || {});
-    if (validate && !valid) {
-        const message = service.validate.errors.map((x) => `${x.instancePath} ${x.message}`).join(', ');
-        throw new Error(`Invalid blocklet service config: ${message}`);
+    const { value, error } = service.validate(data);
+    if (validate && error) {
+        throw new Error(`Invalid blocklet service config: ${error.details.map((x) => x.message).join(', ')}`);
     }
-    return data;
+    return value;
 };
 exports.getServiceConfig = getServiceConfig;
 const getDefaultServiceConfig = (serviceName) => {
@@ -77,7 +58,6 @@ const findService = (services, name) => {
 };
 exports.findService = findService;
 exports.default = {
-    getServiceMetas,
     getServiceConfig,
     getDefaultServiceConfig,
     findService,

package/lib/types/schema.d.ts

@@ -1,3 +1,11 @@
+export interface TAuthConfig {
+    allowSwitchProfile?: boolean;
+    blockUnauthenticated?: boolean;
+    blockUnauthorized?: boolean;
+    ignoreUrls?: string[];
+    profileFields?: ('fullName' | 'email' | 'avatar' | 'phone')[];
+    whoCanAccess?: 'owner' | 'invited' | 'all';
+}
 export interface TBlockletMeta {
     author?: TPerson;
     bundleDid?: string;
@@ -5,7 +13,7 @@ export interface TBlockletMeta {
     capabilities?: {
         clusterMode?: boolean;
         component?: boolean;
-        didStorage?: 'required' | 'optional';
+        didSpace?: 'required' | 'optional';
     };
     community?: string;
     components?: TComponent[];
@@ -139,12 +147,13 @@ export interface TEngine {
 export interface TEnvironment {
     default?: string;
     description: string;
-    name: string;
+    name: TEnvironmentName;
     required?: boolean;
     secure?: boolean;
     shared?: boolean;
     validation?: string;
 }
+export declare type TEnvironmentName = string;
 export interface TInterface {
     endpoints?: TEndpoint[];
     name: string;

package/lib/util.d.ts

@@ -1,6 +1,9 @@
 import { BlockletState, ComponentState } from '@abtnode/client';
 import { Request } from 'express';
 import { TBlockletMeta, TEnvironment } from './types';
+declare type TConfig = TEnvironment & {
+    key: string;
+};
 declare const getComponentId: (component?: {
     meta?: {
         did?: string;
@@ -49,14 +52,13 @@ declare const forEachBlocklet: (blocklet: BlockletState | ComponentState, cb: Fu
 declare const forEachBlockletSync: (blocklet: any, cb: Function) => Promise<unknown>;
 declare const forEachChild: (blocklet: any, cb: Function, params?: any) => Promise<any>;
 declare const forEachChildSync: (blocklet: BlockletState, cb: Function) => Promise<any>;
-declare const findComponentById: (blocklet: BlockletState | ComponentState, componentId: string, { _ancestors, returnAncestors, }?: {
+declare const findComponentById: (blocklet: BlockletState | ComponentState, componentId: string | Array<string>, { _ancestors, returnAncestors, }?: {
     _ancestors?: any[];
     returnAncestors?: boolean;
 }) => any;
-declare const isEnvShareable: (env?: TEnvironment & {
-    key: string;
-}) => boolean;
+declare const isEnvShareable: (env?: TConfig) => boolean;
 declare const getSharedConfigObj: (component: BlockletState, ancestors?: any[]) => any;
+declare const isPreferenceKey: (x: TConfig) => Boolean;
 declare const getAppMissingConfigs: (blocklet?: any) => any[];
 declare const getComponentMissingConfigs: (component?: any, ancestors?: any[]) => any[];
 declare const isFreeBlocklet: (meta: TBlockletMeta) => boolean;
@@ -84,6 +86,9 @@ declare const replaceSlotToIp: (url?: string, ip?: string) => string;
 declare const urlFriendly: (name: string) => string;
 declare const getChainInfo: (env: Record<string, string>) => Record<string, string>;
 declare const isExternalBlocklet: (blocklet?: BlockletState) => boolean;
+declare const getRolesFromAuthConfig: (config: {
+    whoCanAccess: string;
+}) => Array<string>;
 export { isFreeBlocklet };
 export { isFreeComponent };
 export { isComponentBlocklet };
@@ -113,6 +118,8 @@ export { getParentComponentName };
 export { getConnectAppUrl };
 export { getChainInfo };
 export { isExternalBlocklet };
+export { isPreferenceKey };
+export { getRolesFromAuthConfig };
 declare const _default: {
     isFreeBlocklet: (meta: TBlockletMeta) => boolean;
     isFreeComponent: (meta: TBlockletMeta) => boolean;
@@ -134,9 +141,7 @@ declare const _default: {
     getSharedConfigObj: (component: BlockletState, ancestors?: any[]) => any;
     getAppMissingConfigs: (blocklet?: any) => any[];
     getComponentMissingConfigs: (component?: any, ancestors?: any[]) => any[];
-    isEnvShareable: (env?: TEnvironment & {
-        key: string;
-    }) => boolean;
+    isEnvShareable: (env?: TConfig) => boolean;
     wipeSensitiveData: (blocklet?: BlockletState) => BlockletState;
     hasRunnableComponent: (blocklet: BlockletState) => boolean;
     getDisplayName: (blocklet: BlockletState, onlyUseMeta?: boolean) => string;
@@ -170,7 +175,7 @@ declare const _default: {
             version: string;
         };
     }) => string;
-    findComponentById: (blocklet: BlockletState | ComponentState, componentId: string, { _ancestors, returnAncestors, }?: {
+    findComponentById: (blocklet: BlockletState | ComponentState, componentId: string | string[], { _ancestors, returnAncestors, }?: {
         _ancestors?: any[];
         returnAncestors?: boolean;
     }) => any;
@@ -181,5 +186,9 @@ declare const _default: {
     }) => string;
     getChainInfo: (env: Record<string, string>) => Record<string, string>;
     isExternalBlocklet: (blocklet?: BlockletState) => boolean;
+    isPreferenceKey: (x: TConfig) => Boolean;
+    getRolesFromAuthConfig: (config: {
+        whoCanAccess: string;
+    }) => string[];
 };
 export default _default;

package/lib/util.js

@@ -12,16 +12,15 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExternalBlocklet = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.findComponentById = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.urlFriendly = exports.replaceSlotToIp = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterface = exports.fixBlockletStatus = exports.getDisplayName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isComponentBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
+exports.getRolesFromAuthConfig = exports.isPreferenceKey = exports.isExternalBlocklet = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.findComponentById = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.urlFriendly = exports.replaceSlotToIp = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterface = exports.fixBlockletStatus = exports.getDisplayName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isComponentBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
 /* eslint-disable no-await-in-loop */
 const get_1 = __importDefault(require("lodash/get"));
 const slugify_1 = __importDefault(require("slugify"));
 const url_join_1 = __importDefault(require("url-join"));
 const constant_1 = __importDefault(require("@abtnode/constant"));
-const constant_2 = require("@blocklet/constant");
 const constants_1 = __importDefault(require("./constants"));
-const { NODE_SERVICES, SLOT_FOR_IP_DNS_SITE, WHO_CAN_ACCESS } = constant_1.default;
-const { BlockletGroup, fromBlockletStatus, fromBlockletSource, BLOCKLET_INTERFACE_TYPE_WEB, BLOCKLET_CONFIGURABLE_KEY, CHAIN_INFO_CONFIG, } = constants_1.default;
+const { NODE_SERVICES, SLOT_FOR_IP_DNS_SITE, WHO_CAN_ACCESS, WHO_CAN_ACCESS_PREFIX_ROLES } = constant_1.default;
+const { BlockletGroup, fromBlockletStatus, fromBlockletSource, BLOCKLET_INTERFACE_TYPE_WEB, BLOCKLET_CONFIGURABLE_KEY, CHAIN_INFO_CONFIG, BLOCKLET_PREFERENCE_PREFIX, } = constants_1.default;
 const getComponentId = (component, ancestors = []) => `${ancestors.map((x) => (x && x.meta ? x.meta.did : '')).join('/')}${ancestors.length ? '/' : ''}${component && component.meta ? component.meta.did : ''}`;
 exports.getComponentId = getComponentId;
 const getComponentName = (component, ancestors = []) => `${ancestors.map((x) => (x && x.meta ? x.meta.name : '')).join('/')}${ancestors.length ? '/' : ''}${component && component.meta ? component.meta.name : ''}`;
@@ -152,6 +151,10 @@ exports.forEachChild = forEachChild;
 const forEachChildSync = (blocklet, cb) => forEachChild(blocklet, cb, { sync: true });
 exports.forEachChildSync = forEachChildSync;
 const findComponentById = (blocklet, componentId, { _ancestors = [], returnAncestors = false, } = {}) => {
+    if (Array.isArray(componentId)) {
+        // eslint-disable-next-line no-param-reassign
+        componentId = componentId.join('/');
+    }
     const id = getComponentId(blocklet, _ancestors);
     if (componentId === id) {
         if (returnAncestors) {
@@ -206,6 +209,8 @@ const getSharedConfigObj = (component, ancestors) => {
     return res;
 };
 exports.getSharedConfigObj = getSharedConfigObj;
+const isPreferenceKey = (x) => x.key.startsWith(BLOCKLET_PREFERENCE_PREFIX) === true;
+exports.isPreferenceKey = isPreferenceKey;
 const getAppMissingConfigs = (blocklet = {}) => {
     const missingConfigs = [];
     forEachBlockletSync(blocklet, (b, { ancestors }) => {
@@ -217,7 +222,7 @@ const getAppMissingConfigs = (blocklet = {}) => {
             }
         });
     });
-    return missingConfigs.filter((x) => x.key.startsWith(constant_2.BLOCKLET_PREFERENCE_PREFIX) === false);
+    return missingConfigs.filter((x) => !isPreferenceKey(x));
 };
 exports.getAppMissingConfigs = getAppMissingConfigs;
 const getComponentMissingConfigs = (component = {}, ancestors = []) => {
@@ -260,7 +265,7 @@ const wipeSensitiveData = (blocklet) => {
     }
     forEachBlocklet(blocklet, (d) => {
         if (d.configs) {
-            d.configs = d.configs.filter((x) => x.key.startsWith(constant_2.BLOCKLET_PREFERENCE_PREFIX) === false);
+            d.configs = d.configs.filter((x) => !isPreferenceKey(x));
             d.configs.forEach((x) => {
                 if (x.secure) {
                     x.value = x.value ? '__encrypted__' : '';
@@ -412,6 +417,13 @@ const getChainInfo = (env) => Object.entries(CHAIN_INFO_CONFIG).reduce((info, x)
 exports.getChainInfo = getChainInfo;
 const isExternalBlocklet = (blocklet) => !!(blocklet === null || blocklet === void 0 ? void 0 : blocklet.controller);
 exports.isExternalBlocklet = isExternalBlocklet;
+const getRolesFromAuthConfig = (config) => {
+    if (!config.whoCanAccess.startsWith(WHO_CAN_ACCESS_PREFIX_ROLES)) {
+        return [];
+    }
+    return config.whoCanAccess.substring(WHO_CAN_ACCESS_PREFIX_ROLES.length).split(',');
+};
+exports.getRolesFromAuthConfig = getRolesFromAuthConfig;
 exports.default = {
     isFreeBlocklet,
     isFreeComponent,
@@ -442,4 +454,6 @@ exports.default = {
     getConnectAppUrl,
     getChainInfo,
     isExternalBlocklet,
+    isPreferenceKey,
+    getRolesFromAuthConfig,
 };

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.8.37",
+  "version": "1.8.38",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -24,19 +24,19 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "MIT",
   "dependencies": {
-    "@abtnode/client": "1.8.37",
-    "@abtnode/constant": "1.8.37",
-    "@abtnode/util": "1.8.37",
-    "@arcblock/did": "1.18.15",
-    "@arcblock/did-ext": "1.18.15",
-    "@arcblock/did-util": "1.18.15",
-    "@arcblock/jwt": "1.18.15",
-    "@blocklet/constant": "1.8.37",
-    "@ocap/asset": "1.18.15",
-    "@ocap/mcrypto": "1.18.15",
-    "@ocap/types": "1.18.15",
-    "@ocap/util": "1.18.15",
-    "@ocap/wallet": "1.18.15",
+    "@abtnode/client": "1.8.38",
+    "@abtnode/constant": "1.8.38",
+    "@abtnode/util": "1.8.38",
+    "@arcblock/did": "1.18.18",
+    "@arcblock/did-ext": "1.18.18",
+    "@arcblock/did-util": "1.18.18",
+    "@arcblock/jwt": "1.18.18",
+    "@blocklet/constant": "1.8.38",
+    "@ocap/asset": "1.18.18",
+    "@ocap/mcrypto": "1.18.18",
+    "@ocap/types": "1.18.18",
+    "@ocap/util": "1.18.18",
+    "@ocap/wallet": "1.18.18",
     "ajv": "^8.11.0",
     "axios": "^0.27.2",
     "cjk-length": "^1.0.0",
@@ -56,7 +56,7 @@
     "validate-npm-package-name": "^3.0.0"
   },
   "devDependencies": {
-    "@abtnode/client": "^1.8.36",
+    "@abtnode/client": "^1.8.37",
     "@arcblock/eslint-config-ts": "^0.2.3",
     "@types/express": "^4.17.14",
     "@types/jest": "^29.2.2",
@@ -77,5 +77,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^4.8.4"
   },
-  "gitHead": "f26f451c6e2b1168b36f78269eafdf3f671236bf"
+  "gitHead": "cbb88f107eb6b403c8cd47a765920575860c7bc7"
 }

package/lib/service-configs/auth.json

@@ -1,66 +0,0 @@
-{
-    "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"
-            }
-        }
-    }
-}