@phis/ui 0.4.2 → 0.4.4

package/plugins/runtime-modules/builder/developer-workspace-store.d.ts

@@ -1,7 +1,6 @@
 import type { PhiCmsTreeControllerSettings } from "../../../types/cms";
 import { type PhiSignalRouteReceiverTarget } from "../../../helpers/signal-route-lifecycle";
-import { type PhiWorkspaceCatalogState } from "../../../components/workspace/catalog-store";
-import type { PhiBuilderModuleDeactivationRequest, PhiBuilderPublicRouteCollisionRequest, PhiDeveloperBuilderArea, PhiDeveloperBuilderEffectsRequest, PhiDeveloperBuilderNodeKind, PhiDeveloperBuilderPageMetaDraft, PhiDeveloperBuilderRegionDraft, PhiDeveloperBuilderState, PhiDeveloperBuilderWorkspaceState } from "./developer-workspace-types";
+import type { PhiBuilderModuleDeactivationRequest, PhiBuilderPublicRouteCollisionRequest, PhiDeveloperBuilderArea, PhiDeveloperBuilderDraftAllocation, PhiDeveloperBuilderEffectsRequest, PhiDeveloperBuilderMode, PhiDeveloperBuilderCommandWorkspace, PhiDeveloperBuilderNodeKind, PhiDeveloperBuilderPageMetaDraft, PhiDeveloperBuilderRegionDraft, PhiDeveloperBuilderState, PhiDeveloperBuilderWorkspaceState } from "./developer-workspace-types";
 import type { PhiRenderableBlockEffects } from "../../../types/renderable-block";
 import type { PhiCmsInstanceId } from "../../../types/cms-instance-id";
 import type { PhiAnchorWidgetPlacement } from "../../../components/controls/phi-anchor-control-contract";
@@ -9,7 +8,7 @@ import { type PhiBuilderHistoryRecording } from "./history";
 import type { PhiAreaRootRoute, PhiAreaMeta } from "../../../helpers/cms-area-config";
 export declare function normalizePhiDeveloperBuilderArea(scopeKey: string): PhiDeveloperBuilderArea;
 export declare const builderWorkspaceStore: import("../../../state").PhiPluginStateStore<PhiDeveloperBuilderState>;
-export declare function openPhiDeveloperBuilderEffectsEditor(scopeKey: PhiDeveloperBuilderArea, effects: PhiRenderableBlockEffects, target: PhiDeveloperBuilderEffectsRequest["target"], onCommit: (effects: PhiRenderableBlockEffects) => void): void;
+export declare function openPhiDeveloperBuilderEffectsEditor(effects: PhiRenderableBlockEffects, target: PhiDeveloperBuilderEffectsRequest["target"], onCommit: (effects: PhiRenderableBlockEffects) => void): void;
 /**
  * What the open editor shows now, for the canvas to draw while it is being chosen.
  *
@@ -18,7 +17,7 @@ export declare function openPhiDeveloperBuilderEffectsEditor(scopeKey: PhiDevelo
  * checked because the editor that sent this may already be closed -- a late message from a gesture that
  * ended must not put a picture back on a node whose editor is gone.
  */
-export declare function previewPhiDeveloperBuilderEffects(scopeKey: PhiDeveloperBuilderArea, correlationId: string, preview: PhiRenderableBlockEffects): void;
+export declare function previewPhiDeveloperBuilderEffects(correlationId: string, preview: PhiRenderableBlockEffects): void;
 /**
  * The effects a node is drawn with while its editor stands open, or nothing where none is.
  *
@@ -26,7 +25,7 @@ export declare function previewPhiDeveloperBuilderEffects(scopeKey: PhiDeveloper
  * node whose toolbar opened it and the selection may have moved on.
  */
 export declare function readPhiDeveloperBuilderEffectsPreview(state: PhiDeveloperBuilderState, kind: PhiDeveloperBuilderNodeKind, blockId: PhiCmsInstanceId | null): PhiRenderableBlockEffects | null;
-export declare function completePhiDeveloperBuilderEffectsEditor(scopeKey: PhiDeveloperBuilderArea, request: PhiDeveloperBuilderEffectsRequest, effects?: PhiRenderableBlockEffects): void;
+export declare function completePhiDeveloperBuilderEffectsEditor(request: PhiDeveloperBuilderEffectsRequest, effects?: PhiRenderableBlockEffects): void;
 /**
  * The question a Module's switch could not answer on its own.
  *
@@ -34,21 +33,19 @@ export declare function completePhiDeveloperBuilderEffectsEditor(scopeKey: PhiDe
  * which Areas, and which addresses are contested -- and the answer is what enables the Module. A second
  * question replaces the first, because there is only one dialog and only one gesture behind it.
  */
-export declare function openPhiBuilderPublicRouteCollisionRequest(scopeKey: PhiDeveloperBuilderArea, request: Omit<PhiBuilderPublicRouteCollisionRequest, "correlationId">): string;
+export declare function openPhiBuilderPublicRouteCollisionRequest(request: Omit<PhiBuilderPublicRouteCollisionRequest, "correlationId">): string;
 /** The address being typed for one contested route. */
-export declare function answerPhiBuilderPublicRouteCollision(scopeKey: PhiDeveloperBuilderArea, presetKey: string, path: string): void;
+export declare function answerPhiBuilderPublicRouteCollision(presetKey: string, path: string): void;
 /**
  * What switching a Module off takes off the Site, put to the person doing it.
  *
  * Opened only when there is something to say: a Module nothing draws from is switched off without a
  * word, because a dialog that always says "nothing happens" is a dialog nobody reads.
  */
-export declare function openPhiBuilderModuleDeactivationRequest(scopeKey: PhiDeveloperBuilderArea, request: Omit<PhiBuilderModuleDeactivationRequest, "correlationId">): string;
-export declare function closePhiBuilderModuleDeactivationRequest(scopeKey: PhiDeveloperBuilderArea): void;
-export declare function closePhiBuilderPublicRouteCollisionRequest(scopeKey: PhiDeveloperBuilderArea): void;
+export declare function openPhiBuilderModuleDeactivationRequest(request: Omit<PhiBuilderModuleDeactivationRequest, "correlationId">): string;
+export declare function closePhiBuilderModuleDeactivationRequest(): void;
+export declare function closePhiBuilderPublicRouteCollisionRequest(): void;
 export type PhiDeveloperBuilderNodeSelection = {
-    area?: PhiDeveloperBuilderArea;
-    pageKey?: string;
     nodeKey: string;
     nodeId?: PhiCmsInstanceId | null;
     nodeKind: PhiDeveloperBuilderNodeKind;
@@ -57,21 +54,8 @@ export type PhiDeveloperBuilderNodeSelection = {
     selectedLayoutAnchor?: PhiAnchorWidgetPlacement | null;
     openWiring?: boolean;
 };
-/**
- * The selection a Page opens with: the Page itself, nothing inside it chosen, the Inspector closed and
- * the Pages sidebar showing. One answer for every way a Page is opened -- a click in the tree, a route
- * change, a new Page -- which used to be four copies that had drifted apart. `chrome` resets the
- * chrome controls as well, `closePages` folds the Pages panel.
- */
-export declare function resetPhiBuilderSelectionToPage(current: PhiDeveloperBuilderState, pageKey: string, options?: {
-    closePages?: boolean;
-}): PhiDeveloperBuilderState;
-export declare function selectPhiDeveloperBuilderNode(scopeKey: PhiDeveloperBuilderArea, selection: PhiDeveloperBuilderNodeSelection): void;
-export declare function patchPhiDeveloperBuilderState(scopeKey: PhiDeveloperBuilderArea, next: Partial<Pick<PhiDeveloperBuilderState, "pickerWidgetCategoryFilters">>): void;
-export declare function splitWorkspacePatch(next: Partial<PhiDeveloperBuilderWorkspaceState>): {
-    catalog: Partial<PhiWorkspaceCatalogState>;
-    tool: Partial<PhiDeveloperBuilderState>;
-};
+export declare function selectPhiDeveloperBuilderNode(selection: PhiDeveloperBuilderNodeSelection): void;
+export declare function patchPhiDeveloperBuilderState(next: Partial<Pick<PhiDeveloperBuilderState, "pickerWidgetCategoryFilters">>): void;
 type PhiBuilderRegionDraftMutationOptions = {
     history?: PhiBuilderHistoryRecording | null;
 };
@@ -174,8 +158,58 @@ export declare function usePhiDeveloperRegionDraft(draftKey: string): PhiDevelop
  */
 export declare function usePhiDeveloperRegionDraftsValue<TSelected>(selector: (drafts: Record<string, PhiDeveloperBuilderRegionDraft>) => TSelected): TSelected;
 /** The whole merged view, for the few places that work with the state as one object. */
-export declare function usePhiDeveloperBuilderWorkspaceState(area: PhiDeveloperBuilderArea): PhiDeveloperBuilderWorkspaceState;
-export declare function usePhiDeveloperBuilderStateValue<TSelected>(area: PhiDeveloperBuilderArea, selector: (state: PhiDeveloperBuilderWorkspaceState) => TSelected): TSelected;
+export declare function usePhiDeveloperBuilderWorkspaceState(): PhiDeveloperBuilderWorkspaceState;
+export declare function usePhiDeveloperBuilderStateValue<TSelected>(selector: (state: PhiDeveloperBuilderWorkspaceState) => TSelected): TSelected;
 export declare function getPhiDeveloperRegionDraftsSnapshot(): Record<string, PhiDeveloperBuilderRegionDraft>;
-export declare function getPhiDeveloperBuilderStateSnapshot(area?: PhiDeveloperBuilderArea): PhiDeveloperBuilderWorkspaceState;
+export declare function getPhiDeveloperBuilderStateSnapshot(): PhiDeveloperBuilderWorkspaceState;
+/** Opens a Page of an Area: the catalog says what is open, the selection starts at the Page itself. */
+export declare function openPhiBuilderPage(area: PhiDeveloperBuilderArea, pageKey: string, options?: {
+    closePages?: boolean;
+}): void;
+/** Opens a Page of the Area that is open. */
+export declare function openPhiBuilderPageInOpenArea(pageKey: string, options?: {
+    closePages?: boolean;
+}): void;
+/** Points the selection at a Page the catalog opened by itself, leaving the rest of the tool as it is. */
+export declare function selectPhiBuilderPageNode(pageKey: string): void;
+export declare function setPhiBuilderCommandWorkspace(commandWorkspace: PhiDeveloperBuilderCommandWorkspace): void;
+export declare function setPhiBuilderMode(builderMode: PhiDeveloperBuilderMode): void;
+export declare function setPhiBuilderDebugScaffold(debugScaffold: boolean): void;
+export declare function openPhiBuilderPagesPanel(): void;
+export declare function setPhiBuilderInspectorOpen(inspectorOpen: boolean): void;
+export declare function setPhiBuilderSelectedLayoutAnchor(anchor: PhiAnchorWidgetPlacement): void;
+/** A Page's meta as edited, laid over what its draft held. */
+export declare function setPhiBuilderPageMetaDraft(draftKey: string, meta: PhiDeveloperBuilderPageMetaDraft): void;
+/** A Page created in the Builder: its meta, and that it is not deleted. */
+export declare function startPhiBuilderNewPageDrafts(input: {
+    metaDraftKey: string;
+    meta: PhiDeveloperBuilderPageMetaDraft;
+    deleteDraftKey: string;
+}): void;
+/** A Page marked for deletion with the next save. */
+export declare function markPhiBuilderPageDeleted(deleteDraftKey: string): void;
+/**
+ * The Areas whose Module selection has unsaved edits, kept as Builder tool state so the Modules
+ * workspace commands know which Areas a site-wide save or publish has to reach. Undo does not clear
+ * an Area from here -- a save of an unchanged selection is a no-op draft, while a missed Area would
+ * silently publish stale state.
+ */
+export declare function markPhiBuilderModuleAreasDirty(areas: readonly PhiDeveloperBuilderArea[]): void;
+export declare function clearPhiBuilderModuleAreasDirty(): void;
+/** What the wiring dialog has chosen so far; a value that moved drops everything chosen below it. */
+export declare function patchPhiBuilderSignalWiringSession(values: Record<string, unknown>): void;
+export declare function resetPhiBuilderSignalWiringSession(): void;
+/**
+ * What a save or read answered about the Draft a region stands on. A later answer for the same revision
+ * never moves the version or the node sequence back.
+ */
+export declare function storePhiBuilderDraftAllocation(allocationKey: string, saved: PhiDeveloperBuilderDraftAllocation): void;
+export declare function clearPhiBuilderDraftAllocation(allocationKey: string): void;
+/** Takes the next node sequence of a Draft, answering the allocation it was taken from. */
+export declare function takePhiBuilderDraftNodeSequence(allocationKey: string): PhiDeveloperBuilderDraftAllocation;
+/**
+ * Puts a workspace snapshot back, each field into the store it lives in: the catalog's into the
+ * catalog, the Builder's here. An undo used to patch both stores from the command controller.
+ */
+export declare function restorePhiBuilderWorkspaceState(state: Partial<PhiDeveloperBuilderWorkspaceState>): void;
 export {};