@cosmicdrift/kumiko-types 0.159.1 → 0.161.0

package/src/where-clause-types.ts

@@ -0,0 +1,25 @@
+// WhereValue: primitive for eq, array for IN, null for IS NULL, or an
+// operator-object for range/comparisons.
+export type WhereOperator = {
+  readonly gt?: unknown;
+  readonly gte?: unknown;
+  readonly lt?: unknown;
+  readonly lte?: unknown;
+  readonly ne?: unknown;
+  readonly in?: readonly unknown[];
+  readonly like?: string;
+};
+export type WhereValue = unknown | WhereOperator;
+export type WhereObject = Record<string, WhereValue>;
+
+export type OrderByClause = {
+  readonly col: string;
+  readonly direction?: "asc" | "desc";
+};
+
+export type SelectOptions = {
+  readonly limit?: number;
+  // Single column or array for multi-column tie-breaks (e.g.
+  // [{col: "createdAt"}, {col: "id"}] for chronological-with-stable-id).
+  readonly orderBy?: OrderByClause | readonly OrderByClause[];
+};

package/src/workspace.ts

@@ -0,0 +1,42 @@
+import type { AccessRule } from "./handlers";
+
+// Workspace declaration. A workspace is a persona-/role-scoped UI surface:
+// pure UI composition with no backend, DB or auth impact. The engine stores
+// these verbatim and the active web shell (shellWorkspaces) renders the
+// switcher and filters the nav tree by membership + access.
+//
+// Membership is computed from two sources, merged at boot:
+//   1. r.workspace({ nav: [...] }) — explicit list of nav QNs
+//   2. r.nav({ workspaces: [...] }) — nav entry self-assigns to workspaces
+// A nav entry that appears in neither source belongs to no workspace and
+// only shows up when no workspace is active (legacy / non-workspace apps).
+//
+// Cross-feature references are allowed: `nav` may point at any registered
+// nav QN. The boot validator checks references exist and that workspace
+// IDs referenced from r.nav are real.
+export type WorkspaceDefinition = {
+  // Feature author writes the short id ("disposition"); the registry
+  // overwrites `id` with the qualified name ("bmc:workspace:disposition")
+  // in its stored copy. Same pattern as NavDefinition / ScreenDefinition.
+  readonly id: string;
+  // i18n translation key. Resolved at render time by the renderer's
+  // useTranslation hook; engine keeps it opaque.
+  readonly label: string;
+  // Icon key — whatever the icon registry of the active renderer understands.
+  // Engine doesn't validate; unknown icons surface as a missing icon on
+  // screen, not a boot failure (mirrors NavDefinition.icon).
+  readonly icon?: string;
+  // Sort weight in the workspace switcher (lower = earlier). Ties broken
+  // by registration order — features registered later appear lower.
+  readonly order?: number;
+  // Role / openToAll gate. Only users matching this rule see the workspace
+  // in their switcher. Mirrors NavDefinition.access — same semantics across
+  // the UI surface, so a default-deny app can do `{ roles: [] }`.
+  readonly access?: AccessRule;
+  // Explicit nav QNs that belong to this workspace. Merged with any nav
+  // entries that self-assign via r.nav({ workspaces: [...] }).
+  readonly nav?: readonly string[];
+  // Default workspace at login when the user has access to multiple. Boot
+  // validator rejects more than one default per app.
+  readonly default?: boolean;
+};

package/src/write-error-info-types.ts

@@ -0,0 +1,22 @@
+// Plain, JSON-serializable snapshot of a KumikoError for use on the write-path
+// (WriteResult.error, BatchResult.error). The dispatcher stores results under
+// an idempotency key — a KumikoError instance wouldn't round-trip through
+// JSON, so we keep structural data only and rebuild the instance on demand
+// via reraiseAsKumikoError when we need to throw upstream again.
+export type WriteErrorInfo = {
+  readonly code: string;
+  readonly httpStatus: number;
+  readonly i18nKey: string;
+  readonly i18nParams?: Readonly<Record<string, unknown>>;
+  readonly message: string;
+  readonly details?: unknown;
+};
+
+// The failure half of WriteResult — `{ isSuccess: false } + error`. Named
+// so the write-failure factories in write-error-info.ts and WriteResult
+// share one shape instead of restating it. Not generic: the error carries
+// zero data, so there's nothing for the caller to narrow.
+export type WriteFailure = {
+  readonly isSuccess: false;
+  readonly error: WriteErrorInfo;
+};