@lvce-editor/api 8.35.0 → 8.36.0

package/dist/parts/View/View.d.ts

@@ -35,6 +35,7 @@ export interface VirtualDomViewInstance {
     readonly getMenuEntries?: (menuId: string) => readonly MenuEntry[] | Promise<readonly MenuEntry[]>;
     readonly handleEvent?: (event: ViewEvent) => unknown;
     readonly render: () => readonly VirtualDomNode[] | Promise<readonly VirtualDomNode[]>;
+    readonly renderFocus?: (oldContext: Readonly<Record<string, boolean>>, newContext: Readonly<Record<string, boolean>>) => string | Promise<string>;
     readonly saveState?: () => unknown;
 }
 export interface View {
@@ -61,9 +62,11 @@ export interface ViewRegistrySnapshot {
 }
 export interface ViewRenderResultDom {
     readonly dom: readonly VirtualDomNode[];
+    readonly focusSelector?: string;
     readonly type: 'setDom';
 }
 export interface ViewRenderResultPatches {
+    readonly focusSelector?: string;
     readonly patches: readonly unknown[];
     readonly type: 'setPatches';
 }

package/dist/parts/ViewRegistry/ViewRegistry.js

@@ -182,14 +182,23 @@ const isSameContext = (oldContext, newContext) => {
     }
     return true;
 };
+const unchangedContext = {
+    changed: false,
+    newContext: {},
+    oldContext: {},
+};
 const maybeNotifyContextChanged = async (uid, viewId, instance) => {
     if (typeof instance.getContext !== 'function') {
-        return;
+        return unchangedContext;
     }
     const oldContext = contexts[uid] || {};
     const newContext = normalizeContext(instance.getContext());
     if (isSameContext(oldContext, newContext)) {
-        return;
+        return {
+            changed: false,
+            newContext,
+            oldContext,
+        };
     }
     if (Object.keys(newContext).length === 0) {
         delete contexts[uid];
@@ -198,6 +207,31 @@ const maybeNotifyContextChanged = async (uid, viewId, instance) => {
         contexts[uid] = newContext;
     }
     await ExtensionManagementWorker.invoke('Extensions.handleViewContextChange', uid, viewId, newContext);
+    return {
+        changed: true,
+        newContext,
+        oldContext,
+    };
+};
+const renderFocus = async (instance, contextChange) => {
+    if (!contextChange.changed || typeof instance.renderFocus !== 'function') {
+        return '';
+    }
+    const focusSelector = await instance.renderFocus(contextChange.oldContext, contextChange.newContext);
+    if (typeof focusSelector !== 'string') {
+        throw new ExtensionApiError('view renderFocus result must be a string');
+    }
+    return focusSelector;
+};
+const withFocusSelector = async (result, instance, contextChange) => {
+    const focusSelector = await renderFocus(instance, contextChange);
+    if (!focusSelector) {
+        return result;
+    }
+    return {
+        ...result,
+        focusSelector,
+    };
 };
 const maybeClearContext = async (uid, viewId) => {
     if (!contexts[uid]) {
@@ -233,11 +267,12 @@ export const createViewInstance = async (viewId, uid, context) => {
     contextViewIds[uid] = viewId;
     const dom = await renderDom(instance);
     renderedDoms[uid] = dom;
-    await maybeNotifyContextChanged(uid, viewId, instance);
-    return {
+    const result = {
         dom,
         type: 'setDom',
     };
+    const contextChange = await maybeNotifyContextChanged(uid, viewId, instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const dispatchViewEvent = async (uid, event) => {
     const instance = getVirtualDomInstance(uid);
@@ -245,14 +280,14 @@ export const dispatchViewEvent = async (uid, event) => {
         await instance.handleEvent(event);
     }
     const result = await renderPatches(uid, instance);
-    await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return result;
+    const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const renderViewInstance = async (uid) => {
     const instance = getVirtualDomInstance(uid);
     const result = await renderPatches(uid, instance);
-    await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
-    return result;
+    const contextChange = await maybeNotifyContextChanged(uid, contextViewIds[uid], instance);
+    return withFocusSelector(result, instance, contextChange);
 };
 export const disposeViewInstance = async (uid) => {
     const instance = instances[uid];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/api",
-  "version": "8.35.0",
+  "version": "8.36.0",
   "description": "Tree-shakeable extension API for Lvce Editor extensions.",
   "keywords": [
     "lvce-editor",