@cosmicdrift/kumiko-types 0.354.1 → 0.355.0

package/dist/define-handler.d.ts

@@ -9,6 +9,8 @@ export type WriteHandlerDefinition<TName extends string = string, TSchema extend
     readonly access: AccessRule;
     readonly description?: string;
     readonly agent?: AgentHandlerHints;
+    /** Set by the entity convention create/update handlers; see WriteHandlerDef.excludedFields. */
+    readonly excludedFields?: readonly string[];
     readonly unsafeSkipTransitionGuard?: boolean;
     readonly rateLimit?: RateLimitDeclaration;
     readonly additionalRateLimits?: readonly PayloadRateLimitOption[];

package/dist/event-store-executor-types.d.ts

@@ -2,13 +2,16 @@ import type { CursorResult } from "./cursor-types.js";
 import type { EntityDefinition } from "./fields.js";
 import type { SessionUser, WriteResult } from "./handlers.js";
 import type { DeleteContext, SaveContext } from "./hooks.js";
-import type { EntityId } from "./identifiers.js";
+import type { EntityId, TenantId } from "./identifiers.js";
 import type { SearchAdapter } from "./search-adapter.js";
 import type { TenantDb } from "./tenant-db-types.js";
 export type ParentVisibilityOption = {
     readonly entities: ReadonlyMap<string, EntityDefinition>;
 };
 export type PreSaveRunner = (changes: Record<string, unknown>, previous: Readonly<Record<string, unknown>>, isNew: boolean) => Promise<Record<string, unknown>>;
+export type StreamTenantOption = {
+    readonly streamTenantId?: TenantId | undefined;
+};
 export type EventStoreExecutor = {
     create: (payload: Record<string, unknown>, user: SessionUser, db: TenantDb, options?: {
         preSave?: PreSaveRunner;
@@ -17,7 +20,7 @@ export type EventStoreExecutor = {
         id: EntityId;
         version?: number | undefined;
         changes: Record<string, unknown>;
-    }, user: SessionUser, db: TenantDb, options?: {
+    }, user: SessionUser, db: TenantDb, options?: StreamTenantOption & {
         skipOptimisticLock?: boolean;
         skipUnchanged?: boolean;
         preSave?: PreSaveRunner;
@@ -25,13 +28,13 @@ export type EventStoreExecutor = {
     }) => Promise<WriteResult<SaveContext>>;
     delete: (payload: {
         id: EntityId;
-    }, user: SessionUser, db: TenantDb) => Promise<WriteResult<DeleteContext>>;
+    }, user: SessionUser, db: TenantDb, options?: StreamTenantOption) => Promise<WriteResult<DeleteContext>>;
     forget: (payload: {
         id: EntityId;
-    }, user: SessionUser, db: TenantDb) => Promise<WriteResult<DeleteContext>>;
+    }, user: SessionUser, db: TenantDb, options?: StreamTenantOption) => Promise<WriteResult<DeleteContext>>;
     restore: (payload: {
         id: EntityId;
-    }, user: SessionUser, db: TenantDb) => Promise<WriteResult<SaveContext>>;
+    }, user: SessionUser, db: TenantDb, options?: StreamTenantOption) => Promise<WriteResult<SaveContext>>;
     list: (payload: {
         cursor?: string | undefined;
         limit?: number | undefined;

package/dist/fields.d.ts

@@ -1,5 +1,6 @@
 /// <reference types="temporal-polyfill/global" preserve="true" />
 import type { VariantSpec } from "./derivatives-types.js";
+import type { EventUpcastCtx } from "./handlers.js";
 import type { OwnershipMap } from "./ownership.js";
 import type { EntityTenancy } from "./tenancy-brand.js";
 export type FieldAccess = {
@@ -713,6 +714,11 @@ export type ParentRefDef = {
      *  registered entity is a candidate, which also widens the read-gate's SQL. */
     readonly allowedTypes?: readonly string[];
 };
+export type EntityEventMigration = {
+    readonly fromVersion: number;
+    readonly toVersion: number;
+    readonly transform: (fields: Readonly<Record<string, unknown>>, ctx: EventUpcastCtx) => Record<string, unknown> | Promise<Record<string, unknown>>;
+};
 export type EntityDefinition<F extends FieldsMap = FieldsMap, T extends EntityTenancy = EntityTenancy> = {
     readonly table?: string;
     readonly fields: F;
@@ -725,6 +731,10 @@ export type EntityDefinition<F extends FieldsMap = FieldsMap, T extends EntityTe
      *  only for genuinely tenant-independent aggregates like `user`. The first
      *  event (create) is what's routed; updates resolve the stream tenant upstream. */
     readonly systemStream?: boolean;
+    /** Schema version stamped on every lifecycle event (default 1, integer 1..999). Bump it together with a step in `eventMigrations`. */
+    readonly eventVersion?: number;
+    /** One step per version, fromVersion → fromVersion+1. Transforms run on row-shaped field records; the record may be partial, touch only keys that are present. */
+    readonly eventMigrations?: readonly EntityEventMigration[];
     readonly searchWeight?: number;
     readonly defaultCurrency?: string;
     /** Allowed state transitions per field. Boot validates against select options. */

package/dist/handlers.d.ts

@@ -178,6 +178,7 @@ export type EscapeHatchUseEvent = {
     readonly reason: string;
     readonly tenantId: TenantId;
     readonly actor: string;
+    readonly caller?: string;
     readonly target?: EscapeHatchTarget;
 };
 export type EscapeHatchAuditSink = (event: EscapeHatchUseEvent) => Promise<void>;
@@ -534,6 +535,9 @@ export type WriteHandlerDef = {
     readonly access: AccessRule;
     readonly description?: string;
     readonly agent?: AgentHandlerHints;
+    /** Fields a generic create/update handler never writes (`excludeFields`).
+     *  Set only when non-empty; the renderer and the agent manifest read it from here. */
+    readonly excludedFields?: readonly string[];
     readonly unsafeSkipTransitionGuard?: boolean;
     readonly rateLimit?: RateLimitDeclaration;
     /** Per-payload-field limits, e.g. per recipient address. Complements

package/dist/screen.d.ts

@@ -1205,6 +1205,10 @@ export type EditLayout = {
         };
     };
 };
+export type EntityWriteExcludedFields = {
+    readonly create?: readonly string[];
+    readonly update?: readonly string[];
+};
 export type EntityEditScreenDefinition = {
     readonly id: string;
     readonly type: "entityEdit";
@@ -1228,6 +1232,10 @@ export type EntityEditScreenDefinition = {
      *  screen — the only URL query keys the create form prefills. An authored
      *  value is overwritten. */
     readonly urlPrefillFields?: readonly string[];
+    /** Derived by buildAppSchema from the entity's create/update write handlers
+     *  (`excludeFields`): create hides these fields, update shows them read-only.
+     *  An authored value is overwritten. */
+    readonly writeExcludedFields?: EntityWriteExcludedFields;
     readonly entity: string;
     /** Entity field whose value names the loaded record in the header breadcrumb (edit mode only). */
     readonly recordTitleField?: string;

package/dist/snapshot-types.d.ts

@@ -10,4 +10,5 @@ export type LoadAggregateWithSnapshotOptions = {
     readonly upcastEvent?: (event: StoredEvent) => Promise<StoredEvent>;
     readonly snapshotEvery?: number;
     readonly snapshotVersion?: number;
+    readonly entityEventVersionOf?: (aggregateType: string) => number | undefined;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cosmicdrift/kumiko-types",
-  "version": "0.354.1",
+  "version": "0.355.0",
   "description": "Framework-Type-Definitions für Kumiko — FeatureDefinition, BootCheck-Types und die reinen Engine-Types. Erlaubt Downstream-Konsumenten, gegen die Type-Contracts zu bauen, ohne das ganze Framework-Package zu importieren. Enthaelt keine identitaets-sensitiven Runtime-Werte mehr (Error-Klassen leben seit #1629 in kumiko-framework, Brand-Symbole nutzen Symbol.for) und ist deshalb eine plain dependency, keine peerDependency.",
   "license": "BUSL-1.1",
   "author": "Marc Frost <marc@cosmicdriftgamestudio.com>",