@h-rig/omp-extension-plugin 0.0.6-alpha.186

package/dist/src/cockpit/screen-catalog.d.ts

@@ -0,0 +1,55 @@
+import type { PanelRegistration } from "@rig/contracts";
+/** A keyboard shortcut a screen registers against the OMP extension API. */
+export interface ScreenShortcut {
+    readonly key: string;
+    readonly description: string;
+}
+/** Cockpit navigation row metadata (the `to:<screen>` rows on the cockpit). */
+export interface ScreenNav {
+    readonly order: number;
+    readonly label: string;
+    readonly description: string;
+}
+/** One cockpit screen, described as data. */
+export interface ScreenDescriptor {
+    readonly id: string;
+    readonly title: string;
+    readonly label?: string;
+    readonly shortcut?: ScreenShortcut;
+    readonly nav?: ScreenNav;
+    readonly disabled?: boolean;
+}
+/**
+ * The cockpit host's OWN frame screens — NOT a domain's. The cockpit dashboard
+ * and the generic task/run detail composers are the host's own navigation frame,
+ * so it owns them; everything else is contributed. This is the fallback catalog
+ * when no cockpit panels are contributed (headless-ish / no plugin host).
+ */
+export declare const DEFAULT_SCREEN_CATALOG: readonly ScreenDescriptor[];
+/**
+ * A cockpit screen id. The concrete set is CONTRIBUTED at runtime (host frame
+ * screens + every plugin's contributed `screen` descriptor), so this is a plain
+ * string rather than a hardcoded compile-time union — the host does not enumerate
+ * the domains' screens.
+ */
+export type RigScreen = string;
+/**
+ * Build the cockpit screen catalog from the host's own frame screens PLUS every
+ * contributed cockpit-slot panel that carries a `screen` descriptor. The SET,
+ * nav, shortcuts and routing all come from contributions — the host adds nothing
+ * domain-specific of its own.
+ */
+export declare function resolveScreenCatalog(panels?: readonly PanelRegistration[]): readonly ScreenDescriptor[];
+export declare function isRigScreen(value: unknown, catalog?: readonly ScreenDescriptor[]): value is RigScreen;
+export declare function screenTitle(screen: RigScreen, catalog?: readonly ScreenDescriptor[]): string;
+export declare function screenLabel(screen: RigScreen, catalog?: readonly ScreenDescriptor[]): string;
+/** Screens that register a keyboard shortcut, in catalog order. */
+export declare function screenShortcuts(catalog?: readonly ScreenDescriptor[]): readonly {
+    readonly screen: string;
+    readonly shortcut: ScreenShortcut;
+}[];
+/** Cockpit navigation screens (have a `nav`), sorted by nav order. */
+export declare function cockpitNavScreens(catalog?: readonly ScreenDescriptor[]): readonly {
+    readonly screen: string;
+    readonly nav: ScreenNav;
+}[];

package/dist/src/cockpit/screen-catalog.js

@@ -0,0 +1,65 @@
+// @bun
+// packages/omp-extension-plugin/src/cockpit/screen-catalog.ts
+var DEFAULT_SCREEN_CATALOG = [
+  { id: "cockpit", title: "Project Cockpit", shortcut: { key: "g", description: "Rig cockpit" } },
+  { id: "task-detail", title: "Task Detail" },
+  { id: "run-detail", title: "Run Detail", label: "run detail" }
+];
+function buildScreenFromPanel(panel) {
+  const meta = panel.screen ?? {};
+  const id = panel.id;
+  return {
+    id,
+    title: meta.title || panel.title || id,
+    ...meta.label !== undefined ? { label: meta.label } : {},
+    ...meta.shortcutKey ? { shortcut: { key: meta.shortcutKey, description: meta.shortcutDescription ?? panel.title } } : {},
+    ...meta.navOrder !== undefined ? {
+      nav: {
+        order: meta.navOrder,
+        label: meta.navLabel ?? panel.title.toUpperCase(),
+        description: meta.navDescription ?? panel.description ?? ""
+      }
+    } : {},
+    ...panel.disabled !== undefined ? { disabled: panel.disabled } : {}
+  };
+}
+function resolveScreenCatalog(panels = []) {
+  const contributed = panels.filter((panel) => panel.slot === "cockpit" && panel.screen).map(buildScreenFromPanel);
+  const seen = new Set(DEFAULT_SCREEN_CATALOG.map((screen) => screen.id));
+  const merged = [...DEFAULT_SCREEN_CATALOG];
+  for (const screen of contributed) {
+    if (seen.has(screen.id))
+      continue;
+    seen.add(screen.id);
+    merged.push(screen);
+  }
+  return merged;
+}
+function findScreen(catalog, screen) {
+  return catalog.find((entry) => entry.id === screen);
+}
+function isRigScreen(value, catalog = DEFAULT_SCREEN_CATALOG) {
+  return typeof value === "string" && catalog.some((screen) => screen.id === value);
+}
+function screenTitle(screen, catalog = DEFAULT_SCREEN_CATALOG) {
+  return findScreen(catalog, screen)?.title ?? screen;
+}
+function screenLabel(screen, catalog = DEFAULT_SCREEN_CATALOG) {
+  const descriptor = findScreen(catalog, screen);
+  return descriptor?.label ?? descriptor?.id ?? screen;
+}
+function screenShortcuts(catalog = DEFAULT_SCREEN_CATALOG) {
+  return catalog.flatMap((entry) => entry.shortcut ? [{ screen: entry.id, shortcut: entry.shortcut }] : []);
+}
+function cockpitNavScreens(catalog = DEFAULT_SCREEN_CATALOG) {
+  return catalog.flatMap((entry) => entry.nav && !entry.disabled ? [{ screen: entry.id, nav: entry.nav }] : []).sort((left, right) => left.nav.order - right.nav.order);
+}
+export {
+  screenTitle,
+  screenShortcuts,
+  screenLabel,
+  resolveScreenCatalog,
+  isRigScreen,
+  cockpitNavScreens,
+  DEFAULT_SCREEN_CATALOG
+};

package/dist/src/plugin.d.ts

@@ -0,0 +1,4 @@
+import { type RigPlugin } from "@rig/core/config";
+export declare const OMP_EXTENSION_PLUGIN_NAME = "@rig/omp-extension-plugin";
+export declare function createOmpExtensionPlugin(): RigPlugin;
+export default createOmpExtensionPlugin;