@reventlessdev/reventless-spec 3.0.0-alpha.139 → 3.0.0-alpha.140

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# 3.0.0-alpha.140 (2026-09-21)
+
+* feat(spec)!: typed projection keys ([fc6a018](https://github.com/ReventlessDev/reventless-core/commit/fc6a01811ba788f3289e84a435a09f77fa627e1a))
+### Features
+
+* **core:** references derived from identities, and identity checks ([7cb1376](https://github.com/ReventlessDev/reventless-core/commit/7cb1376e56cdb4e4d5ab5954cd97fd37fd3ba258))
+
+### BREAKING CHANGES
+
+* a projection that keys a row by a payload `string`, or uses
+the envelope id as a `string`, converts explicitly with
+`Target.Id.makeFromString` / `Source.Id.toString`. `StateChangeSlice.Spec` no
+longer requires `module Id`.
+
+
+
 # 3.0.0-alpha.139 (2026-09-21)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reventlessdev/reventless-spec",
-  "version": "3.0.0-alpha.139",
+  "version": "3.0.0-alpha.140",
   "description": "Specifications for Reventless",
   "license": "Apache-2.0",
   "bin": {

package/src/components/IdentityCheck.res

@@ -0,0 +1,110 @@
+/**
+Where a plugin's ids and their types disagree. Needs the whole plugin, not one
+file: whether `orderId` names an identity depends on whether any field is typed
+`OrderId.t`, which is also what makes adoption opt-in per plugin — a plugin that
+types nothing is never reported.
+
+- **A field named for one identity and typed as another** (`orderId: CustomerId.t`):
+  the mix-up the types exist to catch. A role name that is no identity of its own
+  (`sellerId: CustomerId.t`) is fine.
+- **An untyped `*Id` whose key has an identity** (`productId: string` beside a
+  `ProductId.t`): the half-migrated state, where the compiler guards some uses and
+  not others.
+*/
+type finding = {sliceName: string, message: string}
+
+// The identity key a `*Id` / `*Ids` name gives by convention.
+let nameKey = (name: string): option<string> =>
+  if name->String.endsWith("Ids") {
+    Some(name->String.slice(~start=0, ~end=name->String.length - 1))
+  } else if name->String.length > 2 && name->String.endsWith("Id") {
+    Some(name)
+  } else {
+    None
+  }
+
+let fieldsOf = (schema: S.t<unknown>): array<(string, S.t<unknown>)> => {
+  let ofObject = (v: S.t<unknown>) =>
+    switch v {
+    | Object({properties}) => properties->Dict.toArray->Array.filter(((n, _)) => n != "TAG")
+    | _ => []
+    }
+  switch schema {
+  | AnyOf({anyOf}) => anyOf->Array.flatMap(ofObject)
+  | other => ofObject(other)
+  }
+}
+
+let slicesFields = (slice: DcbTag.sliceSchemas) =>
+  [slice.commandSchema, slice.consumedEventSchema, slice.eventSchema]->Array.flatMap(fieldsOf)
+
+let check = (slices: array<DcbTag.sliceSchemas>): array<finding> => {
+  let declared: Set.t<string> = Set.make()
+  slices->Array.forEach(slice =>
+    slice
+    ->slicesFields
+    ->Array.forEach(((_, schema)) =>
+      Semantic.fieldIdentityKey(schema)->Option.forEach(k => declared->Set.add(k))
+    )
+  )
+  let seen: Set.t<string> = Set.make()
+  let findings = []
+  slices->Array.forEach(slice =>
+    slice
+    ->slicesFields
+    ->Array.forEach(((name, schema)) => {
+      let message = switch (Semantic.fieldIdentityKey(schema), nameKey(name)) {
+      | (Some(key), Some(named)) if named != key && declared->Set.has(named) =>
+        Some(
+          `${name} is typed as a ${key}, but ${named} is an identity of its own in this plugin. Type it as ${named}'s identity, or rename the field.`,
+        )
+      | (None, Some(named)) if declared->Set.has(named) =>
+        Some(
+          `${name} is a plain string, but ${named} has an identity in this plugin. Type the field with it, so the compiler guards every use.`,
+        )
+      | _ => None
+      }
+      message->Option.forEach(
+        message => {
+          let id = slice.name ++ "\n" ++ message
+          if !(seen->Set.has(id)) {
+            seen->Set.add(id)
+            findings->Array.push({sliceName: slice.name, message})
+          }
+        },
+      )
+    })
+  )
+  findings
+}
+
+/**
+A slice partitioned by an identity another chapter declares: `categoryId`
+partitioning a slice under `Product/`. The chapter is the default home of the
+identity its slices decide about, so the two disagreeing usually means the slice
+or the identity is in the wrong folder. `identityChapters` maps a key to the
+chapter whose folder declares it; an identity declared in another package has
+none and is not checked.
+*/
+let checkChapters = (
+  ~identityChapters: dict<string>,
+  ~partitionBySlice: dict<string>,
+  slices: array<DcbTag.sliceSchemas>,
+): array<finding> =>
+  slices->Array.filterMap(slice =>
+    switch (
+      partitionBySlice->Dict.get(slice.name),
+      slice.moduleUrl->Option.flatMap(DcbTag.chapterOfModuleUrl),
+    ) {
+    | (Some(key), Some(chapter)) =>
+      switch identityChapters->Dict.get(key) {
+      | Some(home) if home != chapter =>
+        Some({
+          sliceName: slice.name,
+          message: `is partitioned by ${key}, which ${home}/ declares, but sits in ${chapter}/. Move the slice or the identity so they share a chapter.`,
+        })
+      | _ => None
+      }
+    | _ => None
+    }
+  )

package/src/components/IdentityCheck.res.mjs

@@ -0,0 +1,103 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
+import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as DcbTag$Reventless from "./DcbTag.res.mjs";
+import * as Semantic$Reventless from "../semantic/Semantic.res.mjs";
+
+function nameKey(name) {
+  if (name.endsWith("Ids")) {
+    return name.slice(0, name.length - 1 | 0);
+  } else if (name.length > 2 && name.endsWith("Id")) {
+    return name;
+  } else {
+    return;
+  }
+}
+
+function fieldsOf(schema) {
+  let ofObject = v => {
+    if (v.type === "object") {
+      return Object.entries(v.properties).filter(param => param[0] !== "TAG");
+    } else {
+      return [];
+    }
+  };
+  if (schema.type === "anyOf") {
+    return schema.anyOf.flatMap(ofObject);
+  } else {
+    return ofObject(schema);
+  }
+}
+
+function slicesFields(slice) {
+  return [
+    slice.commandSchema,
+    slice.consumedEventSchema,
+    slice.eventSchema
+  ].flatMap(fieldsOf);
+}
+
+function check(slices) {
+  let declared = new Set();
+  slices.forEach(slice => {
+    slicesFields(slice).forEach(param => Stdlib_Option.forEach(Semantic$Reventless.fieldIdentityKey(param[1]), k => {
+      declared.add(k);
+    }));
+  });
+  let seen = new Set();
+  let findings = [];
+  slices.forEach(slice => {
+    slicesFields(slice).forEach(param => {
+      let name = param[0];
+      let match = Semantic$Reventless.fieldIdentityKey(param[1]);
+      let match$1 = nameKey(name);
+      let message = match !== undefined ? (
+          match$1 !== undefined && match$1 !== match && declared.has(match$1) ? name + ` is typed as a ` + match + `, but ` + match$1 + ` is an identity of its own in this plugin. Type it as ` + match$1 + `'s identity, or rename the field.` : undefined
+        ) : (
+          match$1 !== undefined && declared.has(match$1) ? name + ` is a plain string, but ` + match$1 + ` has an identity in this plugin. Type the field with it, so the compiler guards every use.` : undefined
+        );
+      Stdlib_Option.forEach(message, message => {
+        let id = slice.name + "\n" + message;
+        if (!seen.has(id)) {
+          seen.add(id);
+          findings.push({
+            sliceName: slice.name,
+            message: message
+          });
+          return;
+        }
+      });
+    });
+  });
+  return findings;
+}
+
+function checkChapters(identityChapters, partitionBySlice, slices) {
+  return Stdlib_Array.filterMap(slices, slice => {
+    let match = partitionBySlice[slice.name];
+    let match$1 = Stdlib_Option.flatMap(slice.moduleUrl, DcbTag$Reventless.chapterOfModuleUrl);
+    if (match === undefined) {
+      return;
+    }
+    if (match$1 === undefined) {
+      return;
+    }
+    let home = identityChapters[match];
+    if (home !== undefined && home !== match$1) {
+      return {
+        sliceName: slice.name,
+        message: `is partitioned by ` + match + `, which ` + home + `/ declares, but sits in ` + match$1 + `/. Move the slice or the identity so they share a chapter.`
+      };
+    }
+  });
+}
+
+export {
+  nameKey,
+  fieldsOf,
+  slicesFields,
+  check,
+  checkChapters,
+}
+/* DcbTag-Reventless Not a pure module */

package/src/components/StateChangeSlice.res

@@ -42,17 +42,15 @@ let decide = (state, command) => switch command {
 ```
 */
 /**
-The lean Spec for a StateChangeSlice — types, identity, schemas. State and
-state-evolution functions live in the sibling `Behavior` module type.
+The lean Spec for a StateChangeSlice — types and schemas. State and
+state-evolution functions live in the sibling `Behavior` module type. A slice has
+no identity of its own: it decides about the one its partition field carries.
 */
 module type Spec = {
   /** Logical name of this slice (used as a command topic prefix). */
   let name: string
   let moduleUrl: string
 
-  /** Identity type — always `Id.String` for DCB slices. */
-  module Id: Id.T
-
   /**
   Events this slice reads to build its decision model (in `evolve`).
   Only needs the fields required for the decision — no tag annotations needed.

package/src/components/StateViewSlice.res

@@ -51,6 +51,14 @@ module type Spec = {
   /** Sury schema for the state type — generated automatically by `@schema`. */
   let stateSchema: S.t<state>
 
+  /**
+  What a row is keyed by. `Id.StringPure` (a plain `string`) unless the view
+  declares its identity — `module Key = OrderId` — in which case a projection
+  that keys a row by another entity's id does not compile. Auto-injected by
+  `@@reventless.spec` in a `StateView/` folder.
+  */
+  module Key: Id.T
+
   /**
   Events this view slice projects. Only needs the fields required for the projection —
   no tag annotations needed. May be payload-less where only existence matters.
@@ -114,7 +122,7 @@ module type Projection = {
   Receives the event wrapped in a `consumed` envelope (event + `meta` +
   `recordedAt`); only events declared in `Spec.consumedEvent` — no wildcard needed.
   */
-  let project: consumed<Spec.consumedEvent> => array<Projection.action<string, Spec.state>>
+  let project: consumed<Spec.consumedEvent> => array<Projection.action<Spec.Key.t, Spec.state>>
 
   /** File URL of this Projection module (`import.meta.url`). */
   let moduleUrl: string

package/src/semantic/Semantic.res

@@ -258,6 +258,17 @@ let identityKey = (fieldSchema: S.t<'a>): option<string> =>
   | _ => None
   }
 
+/** The identity a field names, on its own value or on an array's elements. */
+let rec fieldIdentityKey = (fieldSchema: S.t<unknown>): option<string> =>
+  switch identityKey(fieldSchema) {
+  | Some(_) as found => found
+  | None =>
+    switch fieldSchema->unwrapOptional->Option.getOr(fieldSchema) {
+    | Array({additionalItems: Schema(item)}) => fieldIdentityKey(item)
+    | _ => None
+    }
+  }
+
 /** Whether a field's schema carries this specific semantic. */
 let has = (fieldSchema: S.t<'a>, ~id: string): bool =>
   switch get(fieldSchema) {

package/src/semantic/Semantic.res.mjs

@@ -225,6 +225,26 @@ function identityKey(fieldSchema) {
   }
 }
 
+function fieldIdentityKey(_fieldSchema) {
+  while (true) {
+    let fieldSchema = _fieldSchema;
+    let found = identityKey(fieldSchema);
+    if (found !== undefined) {
+      return found;
+    }
+    let match = Stdlib_Option.getOr(unwrapOptional(fieldSchema), fieldSchema);
+    if (match.type !== "array") {
+      return;
+    }
+    let item = match.additionalItems;
+    if (item === "strip" || item === "strict") {
+      return;
+    }
+    _fieldSchema = item;
+    continue;
+  };
+}
+
 function has(fieldSchema, id) {
   let s = getFrom(fieldSchema);
   if (s !== undefined) {
@@ -246,6 +266,7 @@ export {
   getFrom,
   get,
   identityKey,
+  fieldIdentityKey,
   has,
 }
 /* semanticId Not a pure module */

package/src/types/Projection.res

@@ -79,23 +79,60 @@ type action<'id, 'state> =
   /** No-op. Return this when an event should not affect the read model. */
   | Ignore
 
+/**
+The same action keyed by another representation of its ids. `to_` converts the
+ids the action carries; `from` converts back the ids its callbacks receive. The
+storage edge uses it to turn a typed row key into the string a table is keyed by.
+*/
+let mapActionId = (action: action<'a, 's>, ~to_: 'a => 'b, ~from: 'b => 'a): action<'b, 's> =>
+  switch action {
+  | Create(id, state) => Create(to_(id), state)
+  | CreateMany(rows) => CreateMany(rows->Array.map(((id, state)) => (to_(id), state)))
+  | Update(id, f) => Update(to_(id), f)
+  | UpdateMany(ids, f) => UpdateMany(ids->Array.map(to_), (id, state) => f(from(id), state))
+  | UpdateWithDefault(id, default, f) => UpdateWithDefault(to_(id), default, f)
+  | UpdateManyWithDefault(ids, default, f) =>
+    UpdateManyWithDefault(
+      ids->Array.map(to_),
+      id => default(from(id)),
+      (id, state) => f(from(id), state),
+    )
+  | Set(id, state) => Set(to_(id), state)
+  | SetMany(ids, f) => SetMany(ids->Array.map(to_), id => f(from(id)))
+  | Delete(id) => Delete(to_(id))
+  | DeleteMany(ids) => DeleteMany(ids->Array.map(to_))
+  | DeleteIf(id, p) => DeleteIf(to_(id), p)
+  | DeleteManyIf(ids, p) => DeleteManyIf(ids->Array.map(to_), (id, state) => p(from(id), state))
+  | CreateMultiState(id, states) => CreateMultiState(to_(id), states)
+  | UpdateMultiState(id, f) => UpdateMultiState(to_(id), f)
+  | UpdateManyMultiStates(ids, f) =>
+    UpdateManyMultiStates(ids->Array.map(to_), (id, states) => f(from(id), states))
+  | Ignore => Ignore
+  }
+
 /**
 A compiled single-source-to-single-target mapping.
 
 Created by `Projection.Mapping.Make(Source, Target, MappingImpl)`.
 The `project` function receives a full `Message.event'` envelope and returns
-one `action` value.
+one `action` value. Both ends are typed: the envelope id is the source's `Id.t`
+and the row key the target's, so a projection that keys a view by another
+entity's id does not compile. A mapping between different ids converts
+explicitly (`Target.Id.makeFromString`), which marks the seam.
 */
 module type Mapping = {
   //module Source: Source
   //module Target: Target // NOTE: to be destructive substituted
   module SourceId: Id.T
+  type targetId
   @schema
   type sourceEvent
   @schema
   type targetState
 
-  let project: Message.event'<string, sourceEvent> => action<string, targetState>
+  let project: Message.event'<SourceId.t, sourceEvent> => action<targetId, targetState>
+  let targetIdToString: targetId => string
+  let targetIdFromString: string => targetId
   let sourceEventSchema: S.t<sourceEvent>
   let sourceName: string
   let subIdConfig: option<ReadModel.subIdConfig<targetState>>
@@ -116,9 +153,11 @@ module type Mappings = {
 }
 
 module type MappingImpl = {
+  type sourceId
+  type targetId
   type sourceEvent
   type targetState
-  let project: Message.event'<string, sourceEvent> => action<string, targetState>
+  let project: Message.event'<sourceId, sourceEvent> => action<targetId, targetState>
 }
 
 /**
@@ -147,7 +186,9 @@ module Mapping = {
     Target: Target,
     MappingImpl: MappingImpl
       with type sourceEvent := Source.event
-      and type targetState := Target.state,
+      and type targetState := Target.state
+      and type sourceId := Source.Id.t
+      and type targetId := Target.Id.t,
   ): (
     Mapping
       with type targetState = Target.state
@@ -155,11 +196,14 @@ module Mapping = {
       and module SourceId = Source.Id
   ) => {
     module SourceId = Source.Id
+    type targetId = Target.Id.t
     @schema
     type sourceEvent = Source.event
     @schema
     type targetState = Target.state
     let project = MappingImpl.project
+    let targetIdToString = Target.Id.toString
+    let targetIdFromString = Target.Id.makeFromString
     let sourceName = Source.name
     let subIdConfig = Target.subIdConfig
   }

package/src/types/Projection.res.mjs

@@ -1,15 +1,127 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
 
+function mapActionId(action, to_, from) {
+  if (typeof action !== "object") {
+    return "Ignore";
+  }
+  switch (action.TAG) {
+    case "Create" :
+      return {
+        TAG: "Create",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "CreateMany" :
+      return {
+        TAG: "CreateMany",
+        _0: action._0.map(param => [
+          to_(param[0]),
+          param[1]
+        ])
+      };
+    case "Update" :
+      return {
+        TAG: "Update",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "UpdateMany" :
+      let f = action._1;
+      return {
+        TAG: "UpdateMany",
+        _0: action._0.map(to_),
+        _1: (id, state) => f(from(id), state)
+      };
+    case "UpdateWithDefault" :
+      return {
+        TAG: "UpdateWithDefault",
+        _0: to_(action._0),
+        _1: action._1,
+        _2: action._2
+      };
+    case "UpdateManyWithDefault" :
+      let f$1 = action._2;
+      let $$default = action._1;
+      return {
+        TAG: "UpdateManyWithDefault",
+        _0: action._0.map(to_),
+        _1: id => $$default(from(id)),
+        _2: (id, state) => f$1(from(id), state)
+      };
+    case "Set" :
+      return {
+        TAG: "Set",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "SetMany" :
+      let f$2 = action._1;
+      return {
+        TAG: "SetMany",
+        _0: action._0.map(to_),
+        _1: id => f$2(from(id))
+      };
+    case "Delete" :
+      return {
+        TAG: "Delete",
+        _0: to_(action._0)
+      };
+    case "DeleteMany" :
+      return {
+        TAG: "DeleteMany",
+        _0: action._0.map(to_)
+      };
+    case "DeleteIf" :
+      return {
+        TAG: "DeleteIf",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "DeleteManyIf" :
+      let p = action._1;
+      return {
+        TAG: "DeleteManyIf",
+        _0: action._0.map(to_),
+        _1: (id, state) => p(from(id), state)
+      };
+    case "CreateMultiState" :
+      return {
+        TAG: "CreateMultiState",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "UpdateMultiState" :
+      return {
+        TAG: "UpdateMultiState",
+        _0: to_(action._0),
+        _1: action._1
+      };
+    case "UpdateManyMultiStates" :
+      let f$3 = action._1;
+      return {
+        TAG: "UpdateManyMultiStates",
+        _0: action._0.map(to_),
+        _1: (id, states) => f$3(from(id), states)
+      };
+  }
+}
+
 function Make(Source) {
-  return Target => (MappingImpl => ({
-    SourceId: Source.Id,
-    project: MappingImpl.project,
-    sourceEventSchema: Source.eventSchema,
-    sourceName: Source.name,
-    subIdConfig: Target.subIdConfig,
-    targetStateSchema: Target.stateSchema
-  }));
+  return Target => (MappingImpl => {
+    let targetIdToString = Target.Id.toString;
+    let targetIdFromString = Target.Id.makeFromString;
+    return {
+      SourceId: Source.Id,
+      project: MappingImpl.project,
+      targetIdToString: targetIdToString,
+      targetIdFromString: targetIdFromString,
+      sourceEventSchema: Source.eventSchema,
+      sourceName: Source.name,
+      subIdConfig: Target.subIdConfig,
+      targetStateSchema: Target.stateSchema
+    };
+  });
 }
 
 let Mapping = {
@@ -37,6 +149,7 @@ let DcbSource = {
 };
 
 export {
+  mapActionId,
   Mapping,
   Mappings,
   DcbSource,