@wildwinter/app-shell 0.33.1 → 0.34.0

package/dist/index.d.cts

@@ -1,4 +1,4 @@
-export { EDIT_MENU, MenuLabel, PANE_MENU } from './menu.cjs';
+export { EDIT_MENU, GO_MENU, MenuLabel, PANE_MENU } from './menu.cjs';
 export { JOB_PROGRESS, JobProgress } from './job.cjs';
 
 type Child = Node | string | null | undefined;
@@ -831,4 +831,40 @@ interface StepperBarOptions {
 /** Draw (or hide) the bar in `host`. Idempotent: call it again with new state. */
 declare function renderStepperBar(host: HTMLElement, opts: StepperBarOptions): void;
 
-export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+interface NavHistoryOptions<Place> {
+    /** Same DOCUMENT: a visit whose place is `same` as the newest entry
+     *  REPLACES it (keeping the freshest tab) instead of stacking. */
+    same(a: Place, b: Place): boolean;
+    /** Still restorable? Checked as an entry is stepped onto; a stale one is
+     *  dropped and the step continues past it. Default: everything is. */
+    usable?(p: Place): boolean;
+    /** Entries beyond this age off the far end (default 100). */
+    cap?: number;
+}
+interface NavHistory<Place> {
+    /** Record the place being left, before an ordinary navigation. */
+    visit(place: Place): void;
+    /** Step back: hands over the current place (it becomes the forward entry)
+     *  and returns the place to restore, or undefined at the far end. */
+    back(current: Place): Place | undefined;
+    forward(current: Place): Place | undefined;
+    /** Whether the arrows light. Optimistic: a side holding only stale entries
+     *  still reports true, and the press quietly discards them (the alternative
+     *  is validating the whole stack on every paint). */
+    canBack(): boolean;
+    canForward(): boolean;
+}
+declare function createNavHistory<Place>(opts: NavHistoryOptions<Place>): NavHistory<Place>;
+/**
+ * The quiet arrow pair, VS Code's shape: two plain chevrons sitting to the
+ * left of the app's normal navigation, each greyed when there is nowhere to
+ * go. One component so the pair looks and sits the same in every app of the
+ * family; the caller re-`set`s it whenever a navigation may have changed what
+ * the arrows can do.
+ */
+declare function historyNav(onBack: () => void, onForward: () => void): {
+    el: HTMLElement;
+    set(canBack: boolean, canForward: boolean): void;
+};
+
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-export { EDIT_MENU, MenuLabel, PANE_MENU } from './menu.js';
+export { EDIT_MENU, GO_MENU, MenuLabel, PANE_MENU } from './menu.js';
 export { JOB_PROGRESS, JobProgress } from './job.js';
 
 type Child = Node | string | null | undefined;
@@ -831,4 +831,40 @@ interface StepperBarOptions {
 /** Draw (or hide) the bar in `host`. Idempotent: call it again with new state. */
 declare function renderStepperBar(host: HTMLElement, opts: StepperBarOptions): void;
 
-export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+interface NavHistoryOptions<Place> {
+    /** Same DOCUMENT: a visit whose place is `same` as the newest entry
+     *  REPLACES it (keeping the freshest tab) instead of stacking. */
+    same(a: Place, b: Place): boolean;
+    /** Still restorable? Checked as an entry is stepped onto; a stale one is
+     *  dropped and the step continues past it. Default: everything is. */
+    usable?(p: Place): boolean;
+    /** Entries beyond this age off the far end (default 100). */
+    cap?: number;
+}
+interface NavHistory<Place> {
+    /** Record the place being left, before an ordinary navigation. */
+    visit(place: Place): void;
+    /** Step back: hands over the current place (it becomes the forward entry)
+     *  and returns the place to restore, or undefined at the far end. */
+    back(current: Place): Place | undefined;
+    forward(current: Place): Place | undefined;
+    /** Whether the arrows light. Optimistic: a side holding only stale entries
+     *  still reports true, and the press quietly discards them (the alternative
+     *  is validating the whole stack on every paint). */
+    canBack(): boolean;
+    canForward(): boolean;
+}
+declare function createNavHistory<Place>(opts: NavHistoryOptions<Place>): NavHistory<Place>;
+/**
+ * The quiet arrow pair, VS Code's shape: two plain chevrons sitting to the
+ * left of the app's normal navigation, each greyed when there is nowhere to
+ * go. One component so the pair looks and sits the same in every app of the
+ * family; the caller re-`set`s it whenever a navigation may have changed what
+ * the arrows can do.
+ */
+declare function historyNav(onBack: () => void, onForward: () => void): {
+    el: HTMLElement;
+    set(canBack: boolean, canForward: boolean): void;
+};
+
+export { type AboutOptions, type AnchoredPanel, type AnchoredPanelOptions, type Child, type Comment, type CommentMessage, type CommentsOptions, type ConfirmOptions, type DocLine, type DupGuard, type ElProps, type GameIdEditorOptions, type IconName, type IconSvgName, type Identity, type IdentityOptions, type JobProgressOptions, type JobProgressView, type NavHistory, type NavHistoryOptions, type Notes, type NotesEditorOptions, PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, type PaneShell, type PaneShellOptions, type PaneShellState, type PaneSide, type PaneSideConfig, type PinButton, type PinButtonOptions, type PropertyRefOptions, RESERVED_PROPERTY_NAMES, type SaveController, type SaveControllerOptions, type SaveIndicator, type SaveStatus, type SettingsDialog, type SettingsDialogOptions, type SettingsSection, type SettingsSectionHandle, type ShardVc, type StaleBarOptions, type StepperBarOptions, type StepperItem, type StepperTone, type TipRect, type TooltipOptions, type VcMap, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };

package/dist/index.js

@@ -1,5 +1,5 @@
 export { JOB_PROGRESS } from './chunk-MDGOIT3O.js';
-export { EDIT_MENU, PANE_MENU } from './chunk-YLINCOQD.js';
+export { EDIT_MENU, GO_MENU, PANE_MENU } from './chunk-QDPFU4WX.js';
 
 // src/tooltip.ts
 var B_OPEN = "";
@@ -1683,6 +1683,69 @@ function renderStepperBar(host, opts) {
   );
 }
 
-export { PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, RESERVED_PROPERTY_NAMES, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
+// src/nav-history.ts
+function createNavHistory(opts) {
+  const cap = opts.cap ?? 100;
+  const usable = opts.usable ?? (() => true);
+  let past = [];
+  let ahead = [];
+  const step = (from, to, current2) => {
+    for (; ; ) {
+      const p = from.pop();
+      if (p === void 0) return void 0;
+      if (!usable(p)) continue;
+      if (opts.same(p, current2)) continue;
+      to.push(current2);
+      return p;
+    }
+  };
+  return {
+    visit(place2) {
+      ahead = [];
+      const top = past[past.length - 1];
+      if (top !== void 0 && opts.same(top, place2)) past[past.length - 1] = place2;
+      else past.push(place2);
+      if (past.length > cap) past = past.slice(past.length - cap);
+    },
+    back(current2) {
+      return step(past, ahead, current2);
+    },
+    forward(current2) {
+      return step(ahead, past, current2);
+    },
+    canBack() {
+      return past.length > 0;
+    },
+    canForward() {
+      return ahead.length > 0;
+    }
+  };
+}
+function historyNav(onBack, onForward) {
+  const btn = (glyph, tip2, onClick) => {
+    const b = document.createElement("button");
+    b.type = "button";
+    b.className = "shell-histnav-btn";
+    b.textContent = glyph;
+    b.dataset["tip"] = tip2;
+    b.setAttribute("aria-label", tip2);
+    b.addEventListener("click", onClick);
+    return b;
+  };
+  const back = btn("\u2039", "Back", onBack);
+  const forward = btn("\u203A", "Forward", onForward);
+  const el2 = document.createElement("span");
+  el2.className = "shell-histnav";
+  el2.append(back, forward);
+  return {
+    el: el2,
+    set(canBack, canForward) {
+      back.disabled = !canBack;
+      forward.disabled = !canForward;
+    }
+  };
+}
+
+export { PALETTE, PALETTE_SIZE, PROPERTY_NAME_HINT, RESERVED_PROPERTY_NAMES, askIdentity, bindPropertyName, bindPropertyRef, closeAnchoredPanel, closeWithExit, colourFor, colourIndex, confirmDialog, createNavHistory, createSaveController, dupGuard, el, expandableRow, firstIllegalPropertyName, focusNewRow, foldVc, gameIdify, hideTip, historyNav, icon, iconBtn, iconSvg, initTooltips, isCaseOnlyPropertyName, isValidGameId, isValidPropertyName, labelled, lockControls, lockNotice, mountJobProgress, mountPaneShell, mountSettingsDialog, moveItem, openAnchoredPanel, openComments, openGameIdEditor, openNotesEditor, paintVcBadges, pinButton, placeAnchored, propertyNameProblem, propertyNameify, propertyRefProblem, renderStepperBar, revalidatePropertyRefs, saveIndicator, showAbout, staleBar, tagChips, tipAt, tipBold, vcBadgeFor };
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map