web-extend-plugin-vue2 0.3.3 → 0.3.5

package/README.md

@@ -5,7 +5,7 @@ Vue 2 host runtime for web plugin bootstrap, route registration, host API inject
 ## Install
 
 ```bash
-npm i web-extend-plugin-vue2
+npm i web-extend-plugin-vue2@0.3.5
 ```
 
 Peer dependencies:
@@ -13,6 +13,10 @@ Peer dependencies:
 - `vue >= 2.6.0 < 3`
 - `vue-router >= 3.5.0 < 4`
 
+Published package:
+
+- `web-extend-plugin-vue2@0.3.5`
+
 ## Public API
 
 The package now exposes named exports only.
@@ -33,6 +37,9 @@ Utilities:
 
 - `createRequestBridge`
 - `createVueCliAxiosInstallOptions`
+- `registerHostComponents`
+- `registerVueGlobalComponents`
+- `registerHostModules`
 - `composeManifestFetch`
 - `manifestFetchCacheMiddleware`
 - `wrapManifestFetchWithCache`
@@ -90,6 +97,37 @@ installWebExtendPluginVue2(
 ).catch(console.warn)
 ```
 
+## Host exposes
+
+Preferred host integration uses concrete component/module exposes instead of relying on `hostCapabilities`.
+
+```js
+import {
+  installWebExtendPluginVue2,
+  createVueCliAxiosInstallOptions,
+  registerHostComponents,
+  registerVueGlobalComponents,
+  registerHostModules
+} from 'web-extend-plugin-vue2'
+
+registerVueGlobalComponents(Vue, {
+  include: (name) => /^El[A-Z]/.test(name),
+  mapName: (name) => name.replace(/([a-z0-9])([A-Z])/g, '$1-$2').toLowerCase()
+})
+
+registerHostComponents({
+  'app.pagination': Pagination,
+  'app.dict-tag': DictTag
+})
+
+registerHostModules({
+  request,
+  download
+})
+```
+
+Plugins should depend on stable expose names such as `el-button`, `app.pagination`, or `request`.
+
 ## Important runtime options
 
 - `manifestBase`: API prefix, default `/fp-api`
@@ -105,6 +143,7 @@ installWebExtendPluginVue2(
 - `pluginRoutesParentName`: explicit parent route name for child plugin routes
 - `ensurePluginHostRoute`: when `true`, auto-registers the shell route
 - `hostContext`: readonly host dependencies injected into `hostApi.hostContext`
+- `hostCapabilities`: optional legacy metadata; prefer `registerHostComponents` and `registerHostModules`
 
 ## Notes
 

package/dist/index.cjs

@@ -81,7 +81,7 @@ function getEnvObject() {
             return raw.__WEP_ENV__;
         }
     }
-    catch {
+    catch (_a) {
         /* ignore */
     }
     return null;
@@ -117,7 +117,7 @@ function readProcessEnv(key) {
             }
         }
     }
-    catch {
+    catch (_a) {
         /* ignore */
     }
     return undefined;
@@ -143,7 +143,7 @@ function resolveBundledIsDev() {
             return true;
         }
     }
-    catch {
+    catch (_a) {
         /* ignore */
     }
     try {
@@ -151,7 +151,7 @@ function resolveBundledIsDev() {
             return true;
         }
     }
-    catch {
+    catch (_b) {
         /* ignore */
     }
     return false;
@@ -226,7 +226,7 @@ function isScriptHostAllowed(url, hostSet) {
         const h = normalizeHost(u.hostname);
         return hostSet.has(h);
     }
-    catch {
+    catch (_a) {
         return false;
     }
 }
@@ -401,6 +401,12 @@ function resolveRuntimeOptions$1(user = {}) {
             !Array.isArray(user.hostContext)
             ? { hostContext: user.hostContext }
             : {}),
+        ...(user.hostCapabilities !== undefined &&
+            user.hostCapabilities !== null &&
+            typeof user.hostCapabilities === 'object' &&
+            !Array.isArray(user.hostCapabilities)
+            ? { hostCapabilities: user.hostCapabilities }
+            : {}),
         ...(typeof user.onBeforePluginActivate === 'function'
             ? { onBeforePluginActivate: user.onBeforePluginActivate }
             : {}),
@@ -3432,7 +3438,7 @@ function parseWebPluginDevMapExplicit(opts) {
         const map = JSON.parse(String(raw));
         return map && typeof map === 'object' ? map : null;
     }
-    catch {
+    catch (_a) {
         console.warn('[wep] invalid webPluginDevMapJson / VITE_WEB_PLUGIN_DEV_MAP');
         return null;
     }
@@ -3484,7 +3490,7 @@ async function buildImplicitWebPluginDevMap(opts, hostSet) {
             return {};
         }
     }
-    catch {
+    catch (_a) {
         return {};
     }
     const pathPart = opts.webPluginDevEntryPath;
@@ -3508,7 +3514,7 @@ function closeAllPluginDevEventSources() {
         try {
             es.close();
         }
-        catch {
+        catch (_a) {
             /* ignore */
         }
     }
@@ -3526,7 +3532,7 @@ function isDevOriginAllowedForSse(origin, hostSet) {
         const u = new URL(origin);
         return hostSet.has(normalizeHost(u.hostname));
     }
-    catch {
+    catch (_a) {
         return false;
     }
 }
@@ -3570,7 +3576,7 @@ function startPluginDevSseForMap(devMap, isDev, hostSet, ssePath) {
         try {
             origins.add(new URL(t, window.location.href).origin);
         }
-        catch {
+        catch (_a) {
             /* skip */
         }
     }
@@ -3692,15 +3698,254 @@ function ensurePluginHostRoute$1(router, opts) {
     });
 }
 
-/**
- * 宿主通过 `resolveRuntimeOptions({ hostContext })` 注入的只读上下文，
- * 经浅拷贝 + 浅冻结后挂到 `hostApi.hostContext`，供插件访问 store/i18n 等而不污染 HostApi 顶层命名。
- */
-function freezeShallowHostContext(input) {
-    if (input == null || typeof input !== 'object' || Array.isArray(input)) {
-        return Object.freeze({});
+const hostComponentsRegistry = Object.create(null);
+const hostModulesRegistry = Object.create(null);
+function normalizeExposeMeta(raw) {
+    const meta = {};
+    if (typeof raw.title === 'string' && raw.title.trim()) {
+        meta.title = raw.title.trim();
+    }
+    if (typeof raw.description === 'string' && raw.description.trim()) {
+        meta.description = raw.description.trim();
+    }
+    return meta;
+}
+function normalizeHostComponentEntry(entry) {
+    if (!entry) {
+        return null;
+    }
+    if (typeof entry === 'object' && !Array.isArray(entry)) {
+        const record = entry;
+        if ('component' in record) {
+            return {
+                component: record.component,
+                ...normalizeExposeMeta(record)
+            };
+        }
+    }
+    return { component: entry };
+}
+function normalizeHostModuleEntry(entry) {
+    if (!entry) {
+        return null;
+    }
+    if (typeof entry === 'object' && !Array.isArray(entry)) {
+        const record = entry;
+        if ('module' in record) {
+            return {
+                module: record.module,
+                ...normalizeExposeMeta(record)
+            };
+        }
+    }
+    return { module: entry };
+}
+function normalizeNamedEntries(input, normalizeEntry) {
+    if (Array.isArray(input)) {
+        return input
+            .map((item) => {
+            const name = typeof item.name === 'string' ? item.name.trim() : '';
+            const entry = normalizeEntry(item);
+            if (!name || !entry) {
+                return null;
+            }
+            return { name, entry };
+        })
+            .filter(Boolean);
+    }
+    return Object.entries(input || {})
+        .map(([rawName, rawEntry]) => {
+        const name = String(rawName).trim();
+        const entry = normalizeEntry(rawEntry);
+        if (!name || !entry) {
+            return null;
+        }
+        return { name, entry };
+    })
+        .filter(Boolean);
+}
+function cloneMetaMap(registry) {
+    const out = {};
+    for (const [name, entry] of Object.entries(registry)) {
+        out[name] = { ...entry.meta };
+    }
+    return out;
+}
+function resolveVueGlobalComponentSource(VueRuntime) {
+    if (!VueRuntime || typeof VueRuntime !== 'object' || Array.isArray(VueRuntime)) {
+        return undefined;
+    }
+    const maybeOptions = VueRuntime.options;
+    if (!maybeOptions || typeof maybeOptions !== 'object' || Array.isArray(maybeOptions)) {
+        return undefined;
+    }
+    const maybeComponents = maybeOptions.components;
+    return maybeComponents && typeof maybeComponents === 'object' && !Array.isArray(maybeComponents)
+        ? maybeComponents
+        : undefined;
+}
+function resolveHostComponentMeta(metaInput, name, component) {
+    const raw = typeof metaInput === 'function' ? metaInput(name, component) : metaInput;
+    return raw && typeof raw === 'object' && !Array.isArray(raw)
+        ? normalizeExposeMeta(raw)
+        : {};
+}
+function registerHostComponents(input) {
+    const entries = normalizeNamedEntries(input, normalizeHostComponentEntry);
+    for (const { name, entry } of entries) {
+        hostComponentsRegistry[name] = {
+            value: entry.component,
+            meta: normalizeExposeMeta(entry)
+        };
+    }
+    return getAllHostComponentMeta();
+}
+function registerHostModules(input) {
+    const entries = normalizeNamedEntries(input, normalizeHostModuleEntry);
+    for (const { name, entry } of entries) {
+        hostModulesRegistry[name] = {
+            value: entry.module,
+            meta: normalizeExposeMeta(entry)
+        };
+    }
+    return getAllHostModuleMeta();
+}
+function registerVueGlobalComponents(VueRuntime, options = {}) {
+    const source = options.source && typeof options.source === 'object' && !Array.isArray(options.source)
+        ? options.source
+        : resolveVueGlobalComponentSource(VueRuntime);
+    if (!source) {
+        return getAllHostComponentMeta();
+    }
+    const registry = {};
+    for (const [rawName, component] of Object.entries(source)) {
+        const sourceName = String(rawName).trim();
+        if (!sourceName || component == null) {
+            continue;
+        }
+        if (typeof options.include === 'function' && !options.include(sourceName, component)) {
+            continue;
+        }
+        const mappedName = typeof options.mapName === 'function' ? options.mapName(sourceName, component) : sourceName;
+        const exposeName = typeof mappedName === 'string' ? mappedName.trim() : '';
+        if (!exposeName) {
+            continue;
+        }
+        registry[exposeName] = {
+            component,
+            ...resolveHostComponentMeta(options.meta, sourceName, component)
+        };
+    }
+    return registerHostComponents(registry);
+}
+function getHostComponent(name) {
+    const key = typeof name === 'string' ? name.trim() : '';
+    if (!key) {
+        return undefined;
+    }
+    const record = hostComponentsRegistry[key];
+    return record ? record.value : undefined;
+}
+function getHostModule(name) {
+    const key = typeof name === 'string' ? name.trim() : '';
+    if (!key) {
+        return undefined;
+    }
+    const record = hostModulesRegistry[key];
+    return record ? record.value : undefined;
+}
+function getHostComponentMeta(name) {
+    const key = typeof name === 'string' ? name.trim() : '';
+    const record = key ? hostComponentsRegistry[key] : undefined;
+    const meta = record ? record.meta : undefined;
+    return meta ? { ...meta } : undefined;
+}
+function getHostModuleMeta(name) {
+    const key = typeof name === 'string' ? name.trim() : '';
+    const record = key ? hostModulesRegistry[key] : undefined;
+    const meta = record ? record.meta : undefined;
+    return meta ? { ...meta } : undefined;
+}
+function getAllHostComponentMeta() {
+    return cloneMetaMap(hostComponentsRegistry);
+}
+function getAllHostModuleMeta() {
+    return cloneMetaMap(hostModulesRegistry);
+}
+function normalizeHostCapabilities(input) {
+    const moduleMeta = getAllHostModuleMeta();
+    const componentMeta = getAllHostComponentMeta();
+    if (!input || typeof input !== 'object' || Array.isArray(input)) {
+        const fallback = {};
+        if (Object.keys(moduleMeta).length > 0) {
+            fallback.modules = moduleMeta;
+        }
+        if (Object.keys(componentMeta).length > 0) {
+            fallback.components = componentMeta;
+        }
+        return Object.keys(fallback).length > 0 ? Object.freeze(fallback) : undefined;
+    }
+    const raw = input;
+    const normalized = { ...raw };
+    if (raw.ui && typeof raw.ui === 'object' && !Array.isArray(raw.ui)) {
+        const uiRaw = raw.ui;
+        const ui = {};
+        if (typeof uiRaw.framework === 'string' && uiRaw.framework.trim()) {
+            ui.framework = uiRaw.framework.trim();
+        }
+        if (typeof uiRaw.componentLibrary === 'string' && uiRaw.componentLibrary.trim()) {
+            ui.componentLibrary = uiRaw.componentLibrary.trim();
+        }
+        normalized.ui = ui;
+    }
+    const mergedModules = { ...moduleMeta };
+    if (raw.modules && typeof raw.modules === 'object' && !Array.isArray(raw.modules)) {
+        for (const [name, meta] of Object.entries(raw.modules)) {
+            if (!name.trim()) {
+                continue;
+            }
+            mergedModules[name.trim()] =
+                meta && typeof meta === 'object' && !Array.isArray(meta)
+                    ? {
+                        ...(mergedModules[name.trim()] || {}),
+                        ...normalizeExposeMeta(meta)
+                    }
+                    : { ...(mergedModules[name.trim()] || {}) };
+        }
+    }
+    const mergedComponents = { ...componentMeta };
+    if (raw.components && typeof raw.components === 'object' && !Array.isArray(raw.components)) {
+        for (const [name, meta] of Object.entries(raw.components)) {
+            if (!name.trim()) {
+                continue;
+            }
+            mergedComponents[name.trim()] =
+                meta && typeof meta === 'object' && !Array.isArray(meta)
+                    ? {
+                        ...(mergedComponents[name.trim()] || {}),
+                        ...normalizeExposeMeta(meta)
+                    }
+                    : { ...(mergedComponents[name.trim()] || {}) };
+        }
+    }
+    if (Object.keys(mergedModules).length > 0) {
+        normalized.modules = mergedModules;
+    }
+    if (Object.keys(mergedComponents).length > 0) {
+        normalized.components = mergedComponents;
+    }
+    return Object.freeze(normalized);
+}
+
+function freezeShallowHostContext(input, explicitCapabilities) {
+    const base = input != null && typeof input === 'object' && !Array.isArray(input)
+        ? { ...input }
+        : {};
+    const mergedCapabilities = normalizeHostCapabilities(explicitCapabilities !== undefined ? explicitCapabilities : base.capabilities);
+    if (mergedCapabilities) {
+        base.capabilities = mergedCapabilities;
     }
-    return Object.freeze({ ...input });
+    return Object.freeze(base);
 }
 
 /**
@@ -3722,7 +3967,7 @@ function resolveStaticManifestUrlForFetch(url, origin) {
         const pathPart = u.startsWith('/') ? u : `/${u}`;
         return new URL(pathPart, o).href;
     }
-    catch {
+    catch (_a) {
         return u;
     }
 }
@@ -3908,7 +4153,7 @@ createHostApiFactory, runtimeOptions) {
     }
     const devMap = mergeDevMaps(implicit, explicit);
     startPluginDevSseForMap(devMap, opts.isDev, hostSet, opts.devReloadSsePath);
-    const frozenHostContext = freezeShallowHostContext(opts.hostContext !== undefined ? opts.hostContext : undefined);
+    const frozenHostContext = freezeShallowHostContext(opts.hostContext !== undefined ? opts.hostContext : undefined, opts.hostCapabilities && typeof opts.hostCapabilities === 'object' ? opts.hostCapabilities : undefined);
     const hostKit = {
         hostContext: frozenHostContext,
         bridgeAllowedPathPrefixes: opts.bridgeAllowedPathPrefixes,
@@ -4108,13 +4353,13 @@ function manifestFetchCacheMiddleware$1(options = {}) {
                 return structuredClone(r);
             }
         }
-        catch {
+        catch (_a) {
             /* ignore */
         }
         try {
             return JSON.parse(JSON.stringify(r));
         }
-        catch {
+        catch (_b) {
             return { ...r, data: r.data };
         }
     }
@@ -4152,7 +4397,7 @@ function manifestFetchCacheMiddleware$1(options = {}) {
             }
             return res;
         }
-        catch {
+        catch (_a) {
             return null;
         }
     }
@@ -4160,7 +4405,7 @@ function manifestFetchCacheMiddleware$1(options = {}) {
         try {
             store.setItem(key, JSON.stringify({ expiresAt, result }));
         }
-        catch {
+        catch (_a) {
             /* Quota / 不可序列化 */
         }
     }
@@ -4253,7 +4498,7 @@ function normalizeBridgePath(input) {
         try {
             return decodeURIComponent(normalized);
         }
-        catch {
+        catch (_a) {
             return normalized;
         }
     })();
@@ -4580,6 +4825,10 @@ function createHostApi(pluginId, router, hostKitOptions = {}) {
             throw new Error('registerSanitizedHtmlSnippet is not enabled');
         },
         getContributedRoutes: () => getContributedRoutesForPlugin(pluginId),
+        getHostModule,
+        getHostModuleMeta,
+        getHostComponent,
+        getHostComponentMeta,
         getBridge: () => bridge,
         onTeardown(_pluginId, fn) {
             if (typeof fn === 'function') {
@@ -4750,11 +4999,20 @@ exports.defaultWebExtendPluginRuntime = defaultWebExtendPluginRuntime;
 exports.disposeWebPlugin = disposeWebPlugin;
 exports.ensurePluginHostRoute = ensurePluginHostRoute;
 exports.getActivatedPluginIds = getActivatedPluginIds;
+exports.getAllHostComponentMeta = getAllHostComponentMeta;
+exports.getAllHostModuleMeta = getAllHostModuleMeta;
 exports.getContributedRoutesForPlugin = getContributedRoutesForPlugin;
+exports.getHostComponent = getHostComponent;
+exports.getHostComponentMeta = getHostComponentMeta;
+exports.getHostModule = getHostModule;
+exports.getHostModuleMeta = getHostModuleMeta;
 exports.getRegisteredTopRouteNamesForPlugin = getRegisteredTopRouteNamesForPlugin;
 exports.installWebExtendPluginVue2 = installWebExtendPluginVue2;
 exports.manifestFetchCacheMiddleware = manifestFetchCacheMiddleware;
 exports.peerMinimumVersions = peerMinimumVersions;
+exports.registerHostComponents = registerHostComponents;
+exports.registerHostModules = registerHostModules;
+exports.registerVueGlobalComponents = registerVueGlobalComponents;
 exports.registries = registries;
 exports.resolveRuntimeOptions = resolveRuntimeOptions;
 exports.routeSynthNamePrefix = routeSynthNamePrefix;