@blocklet/meta 1.16.32 → 1.16.33-beta-20240929-110332-9d5dfdc4

package/lib/blocklet.js

@@ -47,7 +47,7 @@ const getComponentsInternalInfo = (app) => {
             resourcesV2: getComponentResourcesPathV2(x),
             group: x.meta.group,
         };
-        const webInterface = (0, util_1.findWebInterface)(x);
+        const webInterface = (0, util_1.findWebInterface)(x) || (0, util_1.findDockerInterface)(x);
         if (webInterface && (x.environments || []).find((y) => y.key === webInterface.port)) {
             component.port = x.environments.find((y) => y.key === webInterface.port).value;
         }

package/lib/schema.js

@@ -269,6 +269,11 @@ const interfaceSchema = Joi.object({
     path: Joi.string().trim().default('/'),
     // `*` means the interface can be mounted at any path prefix
     prefix: Joi.string().trim().min(1).default(constant_2.BLOCKLET_DYNAMIC_PATH_PREFIX),
+    containerPort: Joi.number().port().optional(),
+    hostIP: Joi.string()
+        .trim()
+        .ip({ version: ['ipv4', 'ipv6'] })
+        .optional(),
     protocol: Joi.string()
         .lowercase()
         .valid(...constant_2.BLOCKLET_INTERFACE_PROTOCOLS)
@@ -712,11 +717,60 @@ const createBlockletSchema = (baseDir, { ensureFiles = false, ensureDist = false
         dist: ensureDist ? distSchema.required() : distSchema.optional(),
         components: componentsSchema({ checkStore: ensureComponentStore }),
         name: ensureName ? Joi.string().optional() : Joi.string().required(),
+        docker: Joi.object({
+            workdir: Joi.string().trim(),
+            image: Joi.string().trim().optional(),
+            dockerfile: ensureFiles ? Joi.file().trim().exists({ baseDir }).optional() : Joi.string().trim().optional(),
+            shell: Joi.string().trim().optional(),
+            network: Joi.string().valid('host', 'bridge', 'none').default('host').optional(),
+            volumes: Joi.array().items(Joi.string().trim()).optional(),
+            script: Joi.string().trim().optional(),
+            installNodeModules: Joi.boolean().optional(),
+            command: Joi.string().trim().optional(),
+            runBaseScript: Joi.boolean().optional(),
+        }).optional(),
     })
         .options({ stripUnknown: true, noDefaults: false, ...schemaOptions })
         .rename('children', 'components')
         .custom((data, helper) => {
-        const { did, name } = data;
+        const { did, name, docker } = data;
+        if (docker) {
+            const { image, dockerfile, exportPorts, network } = docker;
+            if (!image && !dockerfile) {
+                // @ts-ignore
+                return helper.message('Image or dockerfile must be set');
+            }
+            if (image && dockerfile) {
+                // @ts-ignore
+                return helper.message('Image and dockerfile cannot be set at the same time');
+            }
+            if (exportPorts && network) {
+                // @ts-ignore
+                return helper.message('ExportPorts and network cannot be set at the same time');
+            }
+            if (!exportPorts && !network) {
+                // @ts-ignore
+                return helper.message('ExportPorts or network must be set');
+            }
+            if (dockerfile) {
+                if (!data.files) {
+                    data.files = [];
+                }
+                data.files.push(dockerfile);
+            }
+            if (docker.volumes) {
+                for (const volume of docker.volumes) {
+                    if (!volume.startsWith('$BLOCKLET_APP_DIR/') && !volume.startsWith('$BLOCKLET_DATA_DIR/')) {
+                        // @ts-ignore
+                        return helper.message('Volume must start with $BLOCKLET_APP_DIR or $BLOCKLET_DATA_DIR');
+                    }
+                    if (volume.indexOf('..') > -1) {
+                        // @ts-ignore
+                        return helper.message('Volume cannot contain ".."');
+                    }
+                }
+            }
+        }
         let cacheError;
         if ((0, did_1.isValid)(did)) {
             try {

package/lib/types/schema.d.ts

@@ -182,7 +182,9 @@ export type TInstallBlockletDescription = string;
 export type TInstallBlockletTitle = string;
 export interface TInterface {
     cacheable?: TPathPrefix[];
+    containerPort?: number;
     endpoints?: TEndpoint[];
+    hostIP?: string;
     name: string;
     pageGroups?: string[];
     path?: string;
@@ -193,7 +195,7 @@ export interface TInterface {
     prefix?: string;
     protocol?: 'tcp' | 'udp' | 'http';
     services?: TService[];
-    type: 'web' | 'service' | 'wellknown';
+    type: 'web' | 'service' | 'wellknown' | 'docker';
 }
 export type TLogo = string;
 export type TMountPoint = string;

package/lib/util.d.ts

@@ -116,6 +116,7 @@ declare const getAppDescription: (blocklet: BlockletState, onlyUseMeta?: boolean
 export declare function getAppUrl(blocklet: BlockletState): string;
 declare const fixBlockletStatus: (blocklet?: BlockletState) => void;
 declare const findWebInterface: (blocklet?: BlockletState | TBlockletMeta) => any;
+declare const findDockerInterface: (blocklet?: BlockletState | TBlockletMeta) => any;
 declare const findWebInterfacePort: (blocklet?: BlockletState) => any;
 declare const findServiceFromMeta: (meta?: TBlockletMeta, ServiceName?: string) => any;
 declare const getWhoCanAccess: (blocklet?: BlockletState) => any;
@@ -151,7 +152,7 @@ declare const hasResourceType: (component: ComponentState, { type, did }?: {
     type: string;
     did: string;
 }) => boolean;
-export { isFreeBlocklet, isFreeComponent, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, forEachComponentV2, forEachComponentV2Sync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareableToClient, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findServiceFromMeta, getWhoCanAccess, getComponentWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, isPackBlocklet, hasStartEngine, hasResourceType, };
+export { isFreeBlocklet, isFreeComponent, forEachBlocklet, forEachBlockletSync, forEachChild, forEachChildSync, forEachComponentV2, forEachComponentV2Sync, isDeletableBlocklet, getSharedConfigObj, getAppMissingConfigs, getComponentMissingConfigs, isEnvShareableToClient, isEnvShareable, wipeSensitiveData, hasRunnableComponent, getAppName, getAppName as getDisplayName, getAppDescription, fixBlockletStatus, findWebInterface, findWebInterfacePort, findDockerInterface, findServiceFromMeta, getWhoCanAccess, getComponentWhoCanAccess, replaceSlotToIp, getComponentId, getComponentName, getComponentBundleId, findComponent, findComponentById, findComponentV2, findComponentByIdV2, filterComponentsV2, getParentComponentName, getConnectAppUrl, getChainInfo, getBlockletChainInfo, isExternalBlocklet, isPreferenceKey, getRolesFromAuthConfig, getBlockletAppIdList, getBlockletServices, isInProgress, isBeforeInstalled, isRunning, isAccessible, isGatewayBlocklet, isPackBlocklet, hasStartEngine, hasResourceType, };
 declare const _default: {
     isFreeBlocklet: (meta: TBlockletMeta) => boolean;
     isFreeComponent: (meta: TBlockletMeta) => boolean;
@@ -191,6 +192,7 @@ declare const _default: {
     fixBlockletStatus: (blocklet?: BlockletState) => void;
     findWebInterface: (blocklet?: BlockletState | TBlockletMeta) => any;
     findWebInterfacePort: (blocklet?: BlockletState) => any;
+    findDockerInterface: (blocklet?: BlockletState | TBlockletMeta) => any;
     findServiceFromMeta: (meta?: TBlockletMeta, ServiceName?: string) => any;
     getWhoCanAccess: (blocklet?: BlockletState) => any;
     getComponentWhoCanAccess: (component: TComponent, app?: BlockletState) => string;

package/lib/util.js

@@ -3,8 +3,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.hasStartEngine = exports.isPackBlocklet = exports.isGatewayBlocklet = exports.isAccessible = exports.isRunning = exports.isBeforeInstalled = exports.isInProgress = exports.getBlockletServices = exports.getBlockletAppIdList = exports.getRolesFromAuthConfig = exports.isPreferenceKey = exports.isExternalBlocklet = exports.getBlockletChainInfo = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.filterComponentsV2 = exports.findComponentByIdV2 = exports.findComponentV2 = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getComponentWhoCanAccess = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.isEnvShareableToClient = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachComponentV2Sync = exports.forEachComponentV2 = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
-exports.hasResourceType = void 0;
+exports.isPackBlocklet = exports.isGatewayBlocklet = exports.isAccessible = exports.isRunning = exports.isBeforeInstalled = exports.isInProgress = exports.getBlockletServices = exports.getBlockletAppIdList = exports.getRolesFromAuthConfig = exports.isPreferenceKey = exports.isExternalBlocklet = exports.getBlockletChainInfo = exports.getChainInfo = exports.getConnectAppUrl = exports.getParentComponentName = exports.filterComponentsV2 = exports.findComponentByIdV2 = exports.findComponentV2 = exports.findComponentById = exports.findComponent = exports.getComponentBundleId = exports.getComponentName = exports.getComponentId = exports.replaceSlotToIp = exports.getComponentWhoCanAccess = exports.getWhoCanAccess = exports.findServiceFromMeta = exports.findDockerInterface = exports.findWebInterfacePort = exports.findWebInterface = exports.fixBlockletStatus = exports.getAppDescription = exports.getDisplayName = exports.getAppName = exports.hasRunnableComponent = exports.wipeSensitiveData = exports.isEnvShareable = exports.isEnvShareableToClient = exports.getComponentMissingConfigs = exports.getAppMissingConfigs = exports.getSharedConfigObj = exports.isDeletableBlocklet = exports.forEachComponentV2Sync = exports.forEachComponentV2 = exports.forEachChildSync = exports.forEachChild = exports.forEachBlockletSync = exports.forEachBlocklet = exports.isFreeComponent = exports.isFreeBlocklet = void 0;
+exports.hasResourceType = exports.hasStartEngine = void 0;
 exports.getAppUrl = getAppUrl;
 /* eslint-disable no-await-in-loop */
 const get_1 = __importDefault(require("lodash/get"));
@@ -529,6 +529,19 @@ const findWebInterface = (blocklet) => {
     return interfaces.find((x) => x.type === constant_2.BLOCKLET_INTERFACE_TYPE_WEB);
 };
 exports.findWebInterface = findWebInterface;
+const findDockerInterface = (blocklet) => {
+    if (!blocklet) {
+        return null;
+    }
+    // @ts-ignore
+    const meta = blocklet.meta || blocklet || {};
+    const { interfaces = [] } = meta;
+    if (!Array.isArray(interfaces)) {
+        return null;
+    }
+    return interfaces.find((x) => x.type === constant_2.BLOCKLET_INTERFACE_TYPE_DOCKER);
+};
+exports.findDockerInterface = findDockerInterface;
 const findWebInterfacePort = (blocklet) => {
     if (!blocklet) {
         return null;
@@ -740,6 +753,7 @@ exports.default = {
     fixBlockletStatus,
     findWebInterface,
     findWebInterfacePort,
+    findDockerInterface,
     findServiceFromMeta,
     getWhoCanAccess,
     getComponentWhoCanAccess,

package/package.json

@@ -3,7 +3,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.16.32",
+  "version": "1.16.33-beta-20240929-110332-9d5dfdc4",
   "description": "Library to parse/validate/fix blocklet meta",
   "main": "./lib/index.js",
   "typings": "./lib/index.d.ts",
@@ -25,12 +25,12 @@
   "author": "wangshijun <wangshijun2020@gmail.com> (http://github.com/wangshijun)",
   "license": "Apache-2.0",
   "dependencies": {
-    "@abtnode/constant": "1.16.32",
+    "@abtnode/constant": "1.16.33-beta-20240929-110332-9d5dfdc4",
     "@arcblock/did": "1.18.135",
     "@arcblock/did-ext": "1.18.135",
     "@arcblock/did-util": "1.18.135",
     "@arcblock/jwt": "1.18.135",
-    "@blocklet/constant": "1.16.32",
+    "@blocklet/constant": "1.16.33-beta-20240929-110332-9d5dfdc4",
     "@ocap/asset": "1.18.135",
     "@ocap/mcrypto": "1.18.135",
     "@ocap/types": "1.18.135",
@@ -79,5 +79,5 @@
     "ts-node": "^10.9.1",
     "typescript": "^5.0.4"
   },
-  "gitHead": "6b6c0abc72e892179a61d6daf7b17e884526db0b"
+  "gitHead": "315517d60ab74ae086b6ff07e4871a3723c4dde4"
 }