@cosmicdrift/kumiko-framework 0.229.0 → 0.230.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-framework",
-  "version": "0.229.0",
+  "version": "0.230.0",
   "description": "Framework core — engine, pipeline, API, DB, and every other bit that makes Kumiko go.",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",
@@ -198,7 +198,7 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@cosmicdrift/kumiko-types": "0.229.0",
+    "@cosmicdrift/kumiko-types": "0.230.0",
     "bullmq": "^5.76.7",
     "bun-types": "^1.3.13",
     "hono": "^4.13.1",
@@ -214,7 +214,7 @@
     "zod": "^4.4.3"
   },
   "devDependencies": {
-    "@cosmicdrift/kumiko-dispatcher-live": "0.229.0",
+    "@cosmicdrift/kumiko-dispatcher-live": "0.230.0",
     "bun-types": "^1.3.13",
     "pino-pretty": "^13.1.3"
   },

package/src/engine/__tests__/screen-definition-exports.test.ts

@@ -0,0 +1,102 @@
+import { describe, expect, test } from "bun:test";
+import type {
+  CustomScreenDefinition,
+  DashboardScreenDefinition,
+  DashboardStatPanel,
+  ProjectionDetailScreenDefinition,
+  ProjectionListScreenDefinition,
+  RowFieldExtractor,
+  ScreenNavSugar,
+  UnitKey,
+} from "@cosmicdrift/kumiko-framework/engine";
+import { requiredKeysFromScreen, screenTitleKey } from "../../i18n/required-surface-keys";
+
+// fw#2519: the engine barrel exported ScreenDefinition (the union) but not
+// its individual members — apps splitting screens out of feature.ts into
+// their own module (kumiko-guard-ui's 300-line limit) could only type the
+// union, losing per-kind checking. Every type imported below comes from the
+// public "@cosmicdrift/kumiko-framework/engine" subpath, not an internal
+// ../types path — an internal import would pass before the fix too, since
+// the internal barrel already had these.
+//
+// The import above is `import type`, erased at runtime — this file guards
+// the barrel at compile time only (tsc, via `check-wt.sh`/CI), not via
+// `bun test`. If a type export regresses, `tsc --build` fails; this suite
+// still passes green.
+describe("engine barrel exports the per-screen definition types", () => {
+  test("ProjectionListScreenDefinition is assignable and feeds requiredKeysFromScreen", () => {
+    const screen: ProjectionListScreenDefinition = {
+      id: "recent-jobs",
+      type: "projectionList",
+      query: "jobs:query:recent",
+      columns: [{ field: "status", label: "publicstatus:column.status" }],
+    };
+    const keys = requiredKeysFromScreen("publicstatus", screen);
+    expect(keys).toContain(screenTitleKey("recent-jobs"));
+    expect(keys).toContain("publicstatus:column.status");
+  });
+
+  test("ProjectionDetailScreenDefinition is assignable and feeds requiredKeysFromScreen", () => {
+    const screen: ProjectionDetailScreenDefinition = {
+      id: "job-detail",
+      type: "projectionDetail",
+      query: "jobs:query:detail",
+      layout: {
+        sections: [{ title: "publicstatus:section.job", fields: ["runId"] }],
+      },
+    };
+    const keys = requiredKeysFromScreen("publicstatus", screen);
+    expect(keys).toContain("publicstatus:section.job");
+    expect(keys).toContain("publicstatus:entity:__projection-detail__:field:runId");
+  });
+
+  test("DashboardScreenDefinition + DashboardStatPanel are assignable and feed requiredKeysFromScreen", () => {
+    const panel: DashboardStatPanel = {
+      kind: "stat",
+      id: "open-incidents",
+      label: "publicstatus:panel.openIncidents",
+      query: "publicstatus:query:incidents:openCount",
+      valueField: "count",
+    };
+    const screen: DashboardScreenDefinition = {
+      id: "ops-dashboard",
+      type: "dashboard",
+      panels: [panel],
+    };
+    const keys = requiredKeysFromScreen("publicstatus", screen);
+    expect(keys).toContain("publicstatus:panel.openIncidents");
+  });
+
+  test("CustomScreenDefinition standalone carries nav/detailFor directly", () => {
+    const nav: ScreenNavSugar = { label: "publicstatus:nav.componentDetail", order: 1 };
+    const screen: CustomScreenDefinition = {
+      id: "component-detail",
+      type: "custom",
+      renderer: { react: {} },
+      nav,
+      detailFor: "component",
+    };
+    expect(screen.nav?.label).toBe("publicstatus:nav.componentDetail");
+    expect(screen.detailFor).toBe("component");
+  });
+
+  test("ProjectionListScreenDefinition also carries nav/detailFor directly, not just via ScreenDefinition", () => {
+    const screen: ProjectionListScreenDefinition = {
+      id: "job-list",
+      type: "projectionList",
+      query: "jobs:query:list",
+      columns: ["status"],
+      nav: { label: "publicstatus:nav.jobList" },
+      detailFor: "job",
+    };
+    expect(screen.nav?.label).toBe("publicstatus:nav.jobList");
+    expect(screen.detailFor).toBe("job");
+  });
+
+  test("UnitKey / RowFieldExtractor are exported and usable standalone", () => {
+    const unit: UnitKey = "km";
+    const extractor: RowFieldExtractor = { pick: ["id", "version"] };
+    expect(unit).toBe("km");
+    expect(extractor).toEqual({ pick: ["id", "version"] });
+  });
+});

package/src/engine/index.ts

@@ -320,6 +320,16 @@ export type {
   CreateUserSeedOptions,
   CustomScreenDefinition,
   CustomScreenRoute,
+  DashboardChartPanel,
+  DashboardCustomPanel,
+  DashboardFeedPanel,
+  DashboardFilterDefinition,
+  DashboardListPanel,
+  DashboardPanelDefinition,
+  DashboardProgressListPanel,
+  DashboardScreenDefinition,
+  DashboardStatGroupPanel,
+  DashboardStatPanel,
   DateFieldDef,
   DecimalFieldDef,
   DeleteContext,
@@ -331,6 +341,7 @@ export type {
   EditFieldSpec,
   EditFieldsSection,
   EditLayout,
+  EditRelatedListSection,
   EditSectionSpec,
   EntityDefinition,
   EntityEditScreenDefinition,
@@ -344,10 +355,14 @@ export type {
   FieldAccess,
   FieldCondition,
   FieldDefinition,
+  FieldFormatRegistry,
+  FieldIconKey,
   FieldRenderer,
   FileFieldDef,
   FilesFieldDef,
   Findability,
+  FormatSpec,
+  FormWidth,
   HandlerContext,
   HasManyRelation,
   HookMap,
@@ -364,6 +379,10 @@ export type {
   KumikoHandlerResultMap,
   LifecycleHookType,
   ListColumnSpec,
+  ListFacetSpec,
+  ListPaginationMode,
+  ListSortDir,
+  ListSortSpec,
   LongTextFindability,
   ManyToManyRelation,
   MspErrorMode,
@@ -395,19 +414,29 @@ export type {
   PreQueryHookFn,
   PreSaveHookFn,
   ProjectionDefinition,
+  ProjectionDetailScreenDefinition,
+  ProjectionListScreenDefinition,
   ProjectionTable,
   QualifiedEventName,
   QueryEvent,
   QueryHandlerDef,
   QueryHandlerFn,
+  RecordHeaderSpec,
   ReferenceDataDef,
   Registry,
   RelationDefinition,
   ResolvedPiiFlags,
   RetentionDef,
   RowAction,
+  RowActionNavigate,
+  RowActionNavigateBase,
+  RowActionWriteHandler,
+  RowFieldExtractor,
   SaveContext,
   ScreenDefinition,
+  ScreenFilter,
+  ScreenFilterOp,
+  ScreenNavSugar,
   ScreenSlots,
   SecretKeyHandle,
   SelectFieldDef,
@@ -427,6 +456,7 @@ export type {
   TreeChildrenSubscribe,
   TreeNode,
   TreeNodeState,
+  UnitKey,
   UnsafeAppendEventFn,
   ValidationError,
   ValidationHookFn,

package/src/engine/types/index.ts

@@ -84,6 +84,8 @@ export type {
   UiHintOption,
   UiHints,
 } from "@cosmicdrift/kumiko-types/feature";
+// Closed field-icon vocabulary — used by `EditFieldSpec.icon`.
+export type { FieldIconKey } from "@cosmicdrift/kumiko-types/field-icon";
 export type {
   AnyFileFieldDef,
   BigIntFieldDef,
@@ -267,6 +269,7 @@ export type {
   EditFieldSpec,
   EditFieldsSection,
   EditLayout,
+  EditRelatedListSection,
   EditSectionSpec,
   EntityEditScreenDefinition,
   EntityListScreenDefinition,
@@ -274,19 +277,28 @@ export type {
   FieldFormatRegistry,
   FieldRenderer,
   FormatSpec,
+  FormWidth,
   ListColumnSpec,
   ListFacetSpec,
+  ListPaginationMode,
+  ListSortDir,
+  ListSortSpec,
   PlatformComponent,
   ProjectionDetailScreenDefinition,
   ProjectionListScreenDefinition,
+  RecordHeaderSpec,
   RowAction,
   RowActionNavigate,
+  RowActionNavigateBase,
   RowActionWriteHandler,
+  RowFieldExtractor,
   ScreenDefinition,
   ScreenFilter,
   ScreenFilterOp,
+  ScreenNavSugar,
   ScreenSlots,
   ToolbarAction,
+  UnitKey,
 } from "@cosmicdrift/kumiko-types/screen";
 export type { TargetRef } from "@cosmicdrift/kumiko-types/target-ref";
 export type {