@reventlessdev/online-shop-dcb-catalog 1.0.0-alpha.248 → 1.0.0-alpha.249

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.
 
+# 1.0.0-alpha.249 (2026-09-21)
+
+* feat(spec)!: typed projection keys ([fc6a018](https://github.com/ReventlessDev/reventless-core/commit/fc6a01811ba788f3289e84a435a09f77fa627e1a))
+### Features
+
+* **examples:** the DCB example types its ids ([2efb86f](https://github.com/ReventlessDev/reventless-core/commit/2efb86f0cf53c804c55fd930ecc897eea60c91e3))
+
+### 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`.
+
+
+
 # 1.0.0-alpha.248 (2026-09-21)
 
 **Note:** Version bump only for package @reventlessdev/online-shop-dcb-catalog

package/lib/bs/.compiler.log

@@ -1,2 +1,2 @@
-#Start(1789989171074)
-#Done(1789989173445)
+#Start(1789994029939)
+#Done(1789994032906)

package/lib/bs/CatalogPlugin.mlmap

@@ -14,6 +14,7 @@ Categories_Projection
 CategoryActivity
 CategoryActivity_GWT
 CategoryActivity_Projections
+CategoryId
 ChangeProductDescription
 ChangeProductDescription_Behavior
 ChangeProductDescription_GWT

package/lib/bs/compiler-info.json

@@ -4,5 +4,5 @@
   "bsc_hash": "75e3a59c95cc953608fd3dd6ea6ed68141bba4414a20a52f114261b8a48385fa",
   "rescript_config_hash": "ca6bf04caf4f6b27dbf31b935f934d99c6fe59248cc8b122f9cc48ff2675eb4a",
   "runtime_path": "/home/runner/work/reventless-core/reventless-core/node_modules/@rescript/runtime",
-  "generated_at": "1789989173456"
+  "generated_at": "1789994032915"
 }

package/lib/bs/src/Category/CategoryId.res

@@ -0,0 +1,4 @@
+// A category's id: the partition its slices decide about, and the key of its rows.
+include Reventless.Id.Make({
+  let key = "categoryId"
+})

package/lib/bs/src/Category/CategoryId.res.mjs

@@ -0,0 +1,29 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as Id$Reventless from "@reventlessdev/reventless-spec/src/types/Id.res.mjs";
+
+let include = Id$Reventless.Make({
+  key: "categoryId"
+});
+
+let schema = include.schema;
+
+let make = include.make;
+
+let makeFromString = include.makeFromString;
+
+let toString = include.toString;
+
+let cmp = include.cmp;
+
+let key = include.key;
+
+export {
+  schema,
+  make,
+  makeFromString,
+  toString,
+  cmp,
+  key,
+}
+/* include Not a pure module */

package/lib/bs/src/Category/StateChange/AddCategory.res

@@ -8,10 +8,10 @@ type consumedEvent =
   | CategoryArchived
 
 @schema
-type command = AddCategory({categoryId: string, name: string})
+type command = AddCategory({categoryId: CategoryId.t, name: string})
 
 @schema
 type error = CategoryAlreadyExists
 
 @schema
-type event = CategoryAdded({categoryId: string, name: string})
+type event = CategoryAdded({categoryId: CategoryId.t, name: string})

package/lib/bs/src/Category/StateChange/AddCategory.res.mjs

@@ -2,6 +2,7 @@
 
 import * as Sury from "sury";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
+import * as CategoryId$CatalogPlugin from "../CategoryId.res.mjs";
 
 let consumedEventSchema = Sury.union([
   Sury.literal("CategoryAdded"),
@@ -10,7 +11,7 @@ let consumedEventSchema = Sury.union([
 
 let commandSchema = Sury.$schema(s => ({
   TAG: "AddCategory",
-  categoryId: s.m(DcbTag$Reventless.string),
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
   name: s.m(Sury.string)
 }));
 
@@ -18,7 +19,7 @@ let errorSchema = Sury.literal("CategoryAlreadyExists");
 
 let eventSchema = Sury.$schema(s => ({
   TAG: "CategoryAdded",
-  categoryId: s.m(DcbTag$Reventless.string),
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
   name: s.m(Sury.string)
 }));
 

package/lib/bs/src/Category/StateChange/ArchiveCategory.res

@@ -8,10 +8,10 @@ type consumedEvent =
   | CategoryArchived
 
 @schema
-type command = | @authorize(AllowGroups(["Admin"])) ArchiveCategory({categoryId: string})
+type command = | @authorize(AllowGroups(["Admin"])) ArchiveCategory({categoryId: CategoryId.t})
 
 @schema
 type error = CategoryNotFound
 
 @schema
-type event = CategoryArchived({categoryId: string})
+type event = CategoryArchived({categoryId: CategoryId.t})

package/lib/bs/src/Category/StateChange/ArchiveCategory.res.mjs

@@ -2,6 +2,7 @@
 
 import * as Sury from "sury";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
+import * as CategoryId$CatalogPlugin from "../CategoryId.res.mjs";
 
 let consumedEventSchema = Sury.union([
   Sury.literal("CategoryAdded"),
@@ -10,14 +11,14 @@ let consumedEventSchema = Sury.union([
 
 let commandSchema = Sury.$schema(s => ({
   TAG: "ArchiveCategory",
-  categoryId: s.m(DcbTag$Reventless.string)
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema))
 }));
 
 let errorSchema = Sury.literal("CategoryNotFound");
 
 let eventSchema = Sury.$schema(s => ({
   TAG: "CategoryArchived",
-  categoryId: s.m(DcbTag$Reventless.string)
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema))
 }));
 
 function commandAuthorization(command) {

package/lib/bs/src/Category/StateChange/RenameCategory.res

@@ -12,7 +12,7 @@ type consumedEvent =
   | CategoryArchived
 
 @schema
-type command = RenameCategory({categoryId: string, name: string})
+type command = RenameCategory({categoryId: CategoryId.t, name: string})
 
 @schema
 type error =
@@ -20,4 +20,4 @@ type error =
   | CategoryAlreadyArchived
 
 @schema
-type event = CategoryRenamed({categoryId: string, name: string})
+type event = CategoryRenamed({categoryId: CategoryId.t, name: string})

package/lib/bs/src/Category/StateChange/RenameCategory.res.mjs

@@ -2,6 +2,7 @@
 
 import * as Sury from "sury";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
+import * as CategoryId$CatalogPlugin from "../CategoryId.res.mjs";
 
 let consumedEventSchema = Sury.union([
   Sury.$schema(s => ({
@@ -17,7 +18,7 @@ let consumedEventSchema = Sury.union([
 
 let commandSchema = Sury.$schema(s => ({
   TAG: "RenameCategory",
-  categoryId: s.m(DcbTag$Reventless.string),
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
   name: s.m(Sury.string)
 }));
 
@@ -28,7 +29,7 @@ let errorSchema = Sury.union([
 
 let eventSchema = Sury.$schema(s => ({
   TAG: "CategoryRenamed",
-  categoryId: s.m(DcbTag$Reventless.string),
+  categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
   name: s.m(Sury.string)
 }));
 

package/lib/bs/src/Category/StateView/Categories.res

@@ -2,11 +2,14 @@
 // Projects category events from the shared catalog event log into a Categories read model.
 @@reventless.spec
 
+// Rows are keyed by this identity.
+module Key = CategoryId
+
 @schema
-type state = {categoryId: string, name: string, archived: bool}
+type state = {categoryId: CategoryId.t, name: string, archived: bool}
 
 @schema
 type consumedEvent =
-  | CategoryAdded({categoryId: string, name: string})
-  | CategoryRenamed({categoryId: string, name: string})
-  | CategoryArchived({categoryId: string})
+  | CategoryAdded({categoryId: CategoryId.t, name: string})
+  | CategoryRenamed({categoryId: CategoryId.t, name: string})
+  | CategoryArchived({categoryId: CategoryId.t})

package/lib/bs/src/Category/StateView/Categories.res.mjs

@@ -3,9 +3,10 @@
 import * as Sury from "sury";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
 import * as ReadModel$Reventless from "@reventlessdev/reventless-spec/src/components/ReadModel.res.mjs";
+import * as CategoryId$CatalogPlugin from "../CategoryId.res.mjs";
 
 let stateSchema = Sury.$schema(s => ({
-  categoryId: s.m(Sury.string),
+  categoryId: s.m(CategoryId$CatalogPlugin.schema),
   name: s.m(Sury.string),
   archived: s.m(Sury.bool)
 }));
@@ -13,17 +14,17 @@ let stateSchema = Sury.$schema(s => ({
 let consumedEventSchema = Sury.union([
   Sury.$schema(s => ({
     TAG: "CategoryAdded",
-    categoryId: s.m(DcbTag$Reventless.string),
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
     name: s.m(Sury.string)
   })),
   Sury.$schema(s => ({
     TAG: "CategoryRenamed",
-    categoryId: s.m(DcbTag$Reventless.string),
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
     name: s.m(Sury.string)
   })),
   Sury.$schema(s => ({
     TAG: "CategoryArchived",
-    categoryId: s.m(DcbTag$Reventless.string)
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema))
   }))
 ]);
 
@@ -33,6 +34,8 @@ let name = "Categories";
 
 let Id;
 
+let Key;
+
 let subIdConfig;
 
 let moduleUrl = "@reventlessdev/online-shop-dcb-catalog/src/Category/StateView/Categories.res.mjs";
@@ -44,6 +47,7 @@ let visibility = "Public";
 export {
   name,
   Id,
+  Key,
   stateSchema,
   consumedEventSchema,
   config,

package/lib/bs/src/CategoryActivity/ReadModel/CategoryActivity_Projections.res

@@ -20,9 +20,9 @@ module CategoryEvents = {
 
   @schema
   type event =
-    | CategoryAdded({categoryId: string, name: string})
-    | CategoryRenamed({categoryId: string, name: string})
-    | CategoryArchived({categoryId: string})
+    | CategoryAdded({categoryId: CategoryId.t, name: string})
+    | CategoryRenamed({categoryId: CategoryId.t, name: string})
+    | CategoryArchived({categoryId: CategoryId.t})
 }
 
 // ─────────────────────────────────────────────────────────────
@@ -34,8 +34,13 @@ module ProductEvents = {
 
   @schema
   type event =
-    | ProductAdded({productId: string, name: string, description: string, price: float})
-    | ProductNameChanged({productId: string, name: string})
+    | ProductAdded({
+        productId: CatalogSpec.ProductId.t,
+        name: string,
+        description: string,
+        price: float,
+      })
+    | ProductNameChanged({productId: CatalogSpec.ProductId.t, name: string})
 }
 
 // ─────────────────────────────────────────────────────────────
@@ -51,7 +56,7 @@ module CategoryActivityMapping = Mapping.Make(
       switch event {
       | CategoryAdded({categoryId, name}) =>
         Set(
-          categoryId,
+          CategoryActivity.Id.makeFromString(categoryId->CategoryId.toString),
           {
             CategoryActivity.name,
             kind: Category,
@@ -60,7 +65,7 @@ module CategoryActivityMapping = Mapping.Make(
         )
       | CategoryRenamed({categoryId, name}) =>
         Update(
-          categoryId,
+          CategoryActivity.Id.makeFromString(categoryId->CategoryId.toString),
           state => {
             ...state,
             name,
@@ -68,7 +73,10 @@ module CategoryActivityMapping = Mapping.Make(
           },
         )
       | CategoryArchived({categoryId}) =>
-        Update(categoryId, state => {...state, lastChange: (Archived: CategoryActivity.change)})
+        Update(
+          CategoryActivity.Id.makeFromString(categoryId->CategoryId.toString),
+          state => {...state, lastChange: (Archived: CategoryActivity.change)},
+        )
       }
   },
 )
@@ -85,9 +93,15 @@ module ProductActivityMapping = Mapping.Make(
     let project = ({event, _}) =>
       switch event {
       | ProductAdded({productId, name}) =>
-        Set(productId, {CategoryActivity.name, kind: Product, lastChange: Added})
+        Set(
+          CategoryActivity.Id.makeFromString(productId->CatalogSpec.ProductId.toString),
+          {CategoryActivity.name, kind: Product, lastChange: Added},
+        )
       | ProductNameChanged({productId, name}) =>
-        Update(productId, state => {...state, name, lastChange: Renamed})
+        Update(
+          CategoryActivity.Id.makeFromString(productId->CatalogSpec.ProductId.toString),
+          state => {...state, name, lastChange: Renamed},
+        )
       }
   },
 )

package/lib/bs/src/CategoryActivity/ReadModel/CategoryActivity_Projections.res.mjs

@@ -3,7 +3,9 @@
 import * as Sury from "sury";
 import * as Id$Reventless from "@reventlessdev/reventless-spec/src/types/Id.res.mjs";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
+import * as ProductId$CatalogSpec from "@reventlessdev/online-shop-dcb-catalog-spec/src/ProductId.res.mjs";
 import * as Projection$Reventless from "@reventlessdev/reventless-spec/src/types/Projection.res.mjs";
+import * as CategoryId$CatalogPlugin from "../../Category/CategoryId.res.mjs";
 import * as CategoryActivity$CatalogPlugin from "./CategoryActivity.res.mjs";
 
 let M = Projection$Reventless.Mappings.Make({
@@ -18,17 +20,17 @@ let name = "CatalogDcbEventLog";
 let eventSchema = Sury.union([
   Sury.$schema(s => ({
     TAG: "CategoryAdded",
-    categoryId: s.m(DcbTag$Reventless.string),
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
     name: s.m(Sury.string)
   })),
   Sury.$schema(s => ({
     TAG: "CategoryRenamed",
-    categoryId: s.m(DcbTag$Reventless.string),
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema)),
     name: s.m(Sury.string)
   })),
   Sury.$schema(s => ({
     TAG: "CategoryArchived",
-    categoryId: s.m(DcbTag$Reventless.string)
+    categoryId: s.m(DcbTag$Reventless.mark(CategoryId$CatalogPlugin.schema))
   }))
 ]);
 
@@ -43,14 +45,14 @@ let name$1 = "CatalogDcbEventLog";
 let eventSchema$1 = Sury.union([
   Sury.$schema(s => ({
     TAG: "ProductAdded",
-    productId: s.m(DcbTag$Reventless.string),
+    productId: s.m(DcbTag$Reventless.mark(ProductId$CatalogSpec.schema)),
     name: s.m(Sury.string),
     description: s.m(Sury.string),
     price: s.m(Sury.float)
   })),
   Sury.$schema(s => ({
     TAG: "ProductNameChanged",
-    productId: s.m(DcbTag$Reventless.string),
+    productId: s.m(DcbTag$Reventless.mark(ProductId$CatalogSpec.schema)),
     name: s.m(Sury.string)
   }))
 ]);
@@ -67,7 +69,7 @@ function project(param) {
     case "CategoryAdded" :
       return {
         TAG: "Set",
-        _0: event.categoryId,
+        _0: Id$Reventless.$$String.makeFromString(CategoryId$CatalogPlugin.toString(event.categoryId)),
         _1: {
           name: event.name,
           kind: "Category",
@@ -78,7 +80,7 @@ function project(param) {
       let name = event.name;
       return {
         TAG: "Update",
-        _0: event.categoryId,
+        _0: Id$Reventless.$$String.makeFromString(CategoryId$CatalogPlugin.toString(event.categoryId)),
         _1: state => ({
           name: name,
           kind: state.kind,
@@ -88,7 +90,7 @@ function project(param) {
     case "CategoryArchived" :
       return {
         TAG: "Update",
-        _0: event.categoryId,
+        _0: Id$Reventless.$$String.makeFromString(CategoryId$CatalogPlugin.toString(event.categoryId)),
         _1: state => ({
           name: state.name,
           kind: state.kind,
@@ -116,7 +118,7 @@ function project$1(param) {
   if (event.TAG === "ProductAdded") {
     return {
       TAG: "Set",
-      _0: event.productId,
+      _0: Id$Reventless.$$String.makeFromString(ProductId$CatalogSpec.toString(event.productId)),
       _1: {
         name: event.name,
         kind: "Product",
@@ -127,7 +129,7 @@ function project$1(param) {
   let name = event.name;
   return {
     TAG: "Update",
-    _0: event.productId,
+    _0: Id$Reventless.$$String.makeFromString(ProductId$CatalogSpec.toString(event.productId)),
     _1: state => ({
       name: name,
       kind: state.kind,

package/lib/bs/src/Extension/Orders_Extension.res

@@ -12,11 +12,17 @@ module Mapping = {
 
   let mapIncomingEvent = (_id, event, _meta, _pluginDef, _queryEngine) =>
     switch event {
+    // Ordering's contract carries a plain string; the catalog decides by its own
+    // ProductId.
     | ItemOrdered({productId, orderId}) => [
-        PublishStateChangeSliceCommand(RecordDemand({productId, orderId})),
+        PublishStateChangeSliceCommand(
+          RecordDemand({productId: CatalogSpec.ProductId.makeFromString(productId), orderId}),
+        ),
       ]
     | ItemOrderCancelled({productId, orderId}) => [
-        PublishStateChangeSliceCommand(RevokeDemand({productId, orderId})),
+        PublishStateChangeSliceCommand(
+          RevokeDemand({productId: CatalogSpec.ProductId.makeFromString(productId), orderId}),
+        ),
       ]
     }
 

package/lib/bs/src/Extension/Orders_Extension.res.mjs

@@ -1,5 +1,6 @@
 // Generated by ReScript, PLEASE EDIT WITH CARE
 
+import * as ProductId$CatalogSpec from "@reventlessdev/online-shop-dcb-catalog-spec/src/ProductId.res.mjs";
 import * as RecordProductDemand$CatalogPlugin from "../ProductDemand/StateChange/RecordProductDemand.res.mjs";
 
 function mapIncomingEvent(_id, event, _meta, _pluginDef, _queryEngine) {
@@ -8,7 +9,7 @@ function mapIncomingEvent(_id, event, _meta, _pluginDef, _queryEngine) {
         TAG: "PublishStateChangeSliceCommand",
         _0: {
           TAG: "RecordDemand",
-          productId: event.productId,
+          productId: ProductId$CatalogSpec.makeFromString(event.productId),
           orderId: event.orderId
         }
       }];
@@ -17,7 +18,7 @@ function mapIncomingEvent(_id, event, _meta, _pluginDef, _queryEngine) {
         TAG: "PublishStateChangeSliceCommand",
         _0: {
           TAG: "RevokeDemand",
-          productId: event.productId,
+          productId: ProductId$CatalogSpec.makeFromString(event.productId),
           orderId: event.orderId
         }
       }];
@@ -54,4 +55,4 @@ export {
   Mapping,
   moduleUrl,
 }
-/* RecordProductDemand-CatalogPlugin Not a pure module */
+/* ProductId-CatalogSpec Not a pure module */

package/lib/bs/src/ExtensionPoint/Products_ExtensionPointMapping.res

@@ -9,8 +9,13 @@ module Delegate = {
   let name = "CatalogDcbEventLog"
   @schema
   type event =
-    | ProductAdded({productId: string, name: string, description: string, price: float})
-    | ProductPriceChanged({productId: string, price: float})
+    | ProductAdded({
+        productId: CatalogSpec.ProductId.t,
+        name: string,
+        description: string,
+        price: float,
+      })
+    | ProductPriceChanged({productId: CatalogSpec.ProductId.t, price: float})
 }
 
 let mapIncomingCommand = (_id, _command, _meta) => []
@@ -18,15 +23,16 @@ let mapIncomingCommand = (_id, _command, _meta) => []
 let mapOutgoingEvent = Some(
   (_id, event, _meta, _queryEngine) =>
     switch event {
+    // Publishing routes by string; the contract carries the typed id.
     | Delegate.ProductAdded({productId, name, price}) => [
         PublishEvent(
-          productId,
+          productId->CatalogSpec.ProductId.toString,
           CatalogSpec.Products_ExtensionPoint.ProductBecameAvailable({productId, name, price}),
         ),
       ]
     | Delegate.ProductPriceChanged({productId, price}) => [
         PublishEvent(
-          productId,
+          productId->CatalogSpec.ProductId.toString,
           CatalogSpec.Products_ExtensionPoint.ProductPriceChanged({productId, price}),
         ),
       ]