web-extend-plugin-vue2 0.3.3 → 0.3.5

package/index.d.ts

@@ -36,7 +36,56 @@ export type AdaptRouteDeclarationsFn = (ctx: {
   declarations: ReadonlyArray<RouteDeclaration>
 }) => VueRouteConfig[]
 
-export type HostContext = Readonly<Record<string, unknown>>
+export type HostExposeMeta = {
+  title?: string
+  description?: string
+}
+
+export type HostComponentMeta = HostExposeMeta
+
+export type HostComponentEntry = HostComponentMeta & {
+  component: unknown
+}
+
+export type HostComponentRegistry =
+  | Record<string, unknown | HostComponentEntry>
+  | Array<(HostComponentEntry & { name: string })>
+
+export type HostModuleMeta = HostExposeMeta
+
+export type HostModuleEntry = HostModuleMeta & {
+  module: unknown
+}
+
+export type HostModuleRegistry =
+  | Record<string, unknown | HostModuleEntry>
+  | Array<(HostModuleEntry & { name: string })>
+
+export type RegisterVueGlobalComponentsOptions = {
+  source?: Record<string, unknown>
+  include?: (name: string, component: unknown) => boolean
+  mapName?: (name: string, component: unknown) => string | null | undefined
+  meta?: HostComponentMeta | ((name: string, component: unknown) => HostComponentMeta | undefined)
+}
+
+export type HostUiCapability = {
+  framework?: string
+  componentLibrary?: string
+}
+
+export type HostCapabilities = Readonly<
+  Record<string, unknown> & {
+    ui?: HostUiCapability
+    modules?: Readonly<Record<string, HostModuleMeta>>
+    components?: Readonly<Record<string, HostComponentMeta>>
+  }
+>
+
+export type HostContext = Readonly<
+  Record<string, unknown> & {
+    capabilities?: HostCapabilities
+  }
+>
 
 export type OnBeforePluginActivateFn = (ctx: {
   pluginId: string
@@ -75,6 +124,24 @@ export type HostKitOptions = {
   hostContext?: HostContext
 }
 
+export type PluginManifestHostCapabilities = Readonly<
+  Record<string, unknown> & {
+    modules?: string[]
+    components?: string[]
+    ui?: Record<string, unknown>
+  }
+>
+
+export type WebExtendPluginManifestRecord = Readonly<
+  Record<string, unknown> & {
+    id: string
+    priority?: unknown
+    entryUrl?: string
+    engines?: { host?: string }
+    hostCapabilities?: PluginManifestHostCapabilities
+  }
+>
+
 export type WebExtendPluginRuntimeOptions = HostKitOptions &
   Record<string, unknown> & {
     manifestBase?: string
@@ -101,6 +168,7 @@ export type WebExtendPluginRuntimeOptions = HostKitOptions &
     bootstrapSummary?: boolean
     fetchManifest?: ManifestFetchFn
     hostContext?: Record<string, unknown>
+    hostCapabilities?: HostCapabilities
     onBeforePluginActivate?: OnBeforePluginActivateFn
     onAfterPluginActivate?: OnAfterPluginActivateFn
     onPluginActivateError?: OnPluginActivateErrorFn
@@ -118,6 +186,10 @@ export interface HostApi {
   registerScriptUrls(urls?: string[]): void
   registerSanitizedHtmlSnippet(): void
   getContributedRoutes(): PluginRouteSnapshot[]
+  getHostModule(name: string): unknown
+  getHostModuleMeta(name: string): HostModuleMeta | undefined
+  getHostComponent(name: string): unknown
+  getHostComponentMeta(name: string): HostComponentMeta | undefined
   getBridge(): {
     request(path: string, init?: RequestInit): Promise<Response>
   }
@@ -175,6 +247,18 @@ export function createHostApi(pluginId: string, router: unknown, hostKit?: HostK
 
 export function disposeWebPlugin(pluginId: string): void
 export const registries: unknown
+export function registerHostModules(input: HostModuleRegistry): Readonly<Record<string, HostModuleMeta>>
+export function registerHostComponents(input: HostComponentRegistry): Readonly<Record<string, HostComponentMeta>>
+export function registerVueGlobalComponents(
+  VueRuntime: unknown,
+  options?: RegisterVueGlobalComponentsOptions
+): Readonly<Record<string, HostComponentMeta>>
+export function getHostModule(name: string): unknown
+export function getHostModuleMeta(name: string): HostModuleMeta | undefined
+export function getAllHostModuleMeta(): Readonly<Record<string, HostModuleMeta>>
+export function getHostComponent(name: string): unknown
+export function getHostComponentMeta(name: string): HostComponentMeta | undefined
+export function getAllHostComponentMeta(): Readonly<Record<string, HostComponentMeta>>
 
 export function createRequestBridge(config?: {
   allowedPathPrefixes?: string[]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-extend-plugin-vue2",
-  "version": "0.3.3",
+  "version": "0.3.5",
   "publishConfig": {
     "access": "public"
   },
@@ -43,14 +43,18 @@
     "prepublishOnly": "npm run build"
   },
   "license": "Apache-2.0",
-  "repository": {
-    "type": "git",
-    "url": "",
-    "directory": "web-extend-plugin-vue2"
-  },
-  "keywords": [
-    "vue2",
-    "plugin",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/xtemplus/extend-plugin-framework.git",
+    "directory": "web-extend-plugin-vue2"
+  },
+  "bugs": {
+    "url": "https://github.com/xtemplus/extend-plugin-framework/issues"
+  },
+  "homepage": "https://github.com/xtemplus/extend-plugin-framework/tree/master/web-extend-plugin-vue2#readme",
+  "keywords": [
+    "vue2",
+    "plugin",
     "extension"
   ]
 }