@reventlessdev/reventless-core 3.0.0-alpha.223 → 3.0.0-alpha.224

package/tests/plugin/PluginStructureTest.res

@@ -78,6 +78,15 @@ module PsAnnotatedViewSlice: ReventlessInfra.StateViewSlice.T = {
   type component = svsComponent
   let make = (~dcbEventLog as _, ~runtime as _=?, ~opts as _=?): component => Obj.magic(0)
 }
+module PsCategoriesViewSlice: ReventlessInfra.StateViewSlice.T = {
+  module Spec = PsCategoriesView
+  module Projection = {
+    let project = PsCategoriesView.project
+    let moduleUrl = PsCategoriesView.moduleUrl
+  }
+  type component = svsComponent
+  let make = (~dcbEventLog as _, ~runtime as _=?, ~opts as _=?): component => Obj.magic(0)
+}
 
 module PsAttachInvoiceSlice: ReventlessInfra.StateChangeSlice.T = {
   module Spec = PsAttachInvoice
@@ -560,6 +569,87 @@ describe("Plugin_Structure.make — Phase 2 graph fields", () => {
     })
   })
 
+  // The singular is published because it is not derivable from the plural without
+  // re-implementing `Api_Naming.singularize` — and a consumer that guesses gets an
+  // irregular plural wrong for both the detail query and the filter input type.
+  describe("singleQueryField — the singular the schema actually serves", () => {
+    let withIrregularPlural = Plugin_Structure.make(
+      ~name="TestPlugin",
+      ~stateChangeSlices=[],
+      ~stateViewSlices=[module(PsCategoriesViewSlice)],
+    )
+    let categories = withIrregularPlural.stateViewSlices->Array.getUnsafe(0)
+
+    // "strip a trailing `s`" would publish `TestPlugin_Categorie`, a field the
+    // generated SDL does not contain.
+    testSync("an `-ies` plural publishes the `y` singular, not a truncation", () => {
+      expect((categories.queryField, categories.singleQueryField))->toEqual((
+        "TestPlugin_Categories",
+        Some("TestPlugin_Category"),
+      ))
+    })
+
+    testSync("every built def states the name Api_Naming returned", () => {
+      let stated = structure.stateViewSlices->Array.every(q =>
+        q.singleQueryField ==
+          Some(
+            Api_Naming.queryFieldNamesForStateView(
+              ~plugin="TestPlugin",
+              ~viewName=q.name,
+            ).singleFieldName,
+          )
+      )
+      expect(stated)->toEqual(true)
+    })
+  })
+
+  // Which field identifies a row, and whether the author said so or this side
+  // worked it out — the same declaration-vs-guess distinction `labelFieldSource`
+  // publishes, for the field the generated filter and order-by are built from.
+  describe("idField / idFieldSource — the key and its provenance", () => {
+    let keyOf = (q: Reventless.Plugin.queryableDef) => (q.idField, q.idFieldSource)
+    let withCategories = Plugin_Structure.make(
+      ~name="TestPlugin",
+      ~stateChangeSlices=[],
+      ~stateViewSlices=[module(PsCategoriesViewSlice)],
+    )
+
+    // Orders holds `orderId` + `customerName`; the component name matches the
+    // former, so the rung is the one a client could also reach on its own.
+    testSync("a name-matching `*Id` field is a guess the consumer can also make", () =>
+      expect(keyOf(structure.stateViewSlices->Array.getUnsafe(0)))->toEqual((
+        Some("orderId"),
+        Some("convention"),
+      ))
+    )
+
+    // AvailableProducts: the name would ask for `availableProductId`, which is not
+    // a field — `productId` wins because it is the only candidate there is.
+    testSync("a sole `*Id` field is a fact only this side can see", () =>
+      expect(keyOf(structure.stateViewSlices->Array.getUnsafe(1)))->toEqual((
+        Some("productId"),
+        Some("sole"),
+      ))
+    )
+
+    testSync("an `-ies` component name singularises to its key", () =>
+      expect(keyOf(withCategories.stateViewSlices->Array.getUnsafe(0)))->toEqual((
+        Some("categoryId"),
+        Some("convention"),
+      ))
+    )
+
+    // AnnotatedView declares `@id itemId` beside an `@index` field `ownerId`, and
+    // its name matches neither — inference alone would decline here, so reporting
+    // `itemId` proves the declaration produced it.
+    testSync("a declared @id is used where inference would decline", () =>
+      expect(keyOf(structure.stateViewSlices->Array.getUnsafe(3)))->toEqual((
+        Some("itemId"),
+        Some("annotation"),
+      ))
+    )
+  })
+
   describe("statusField — the shape rule", () => {
     let statusOf = schema =>
       Plugin_Structure.statusFieldFromStateSchema(~entityName="Test", schema->S.castToUnknown)

package/tests/plugin/PluginStructureTest.res.mjs

@@ -5,10 +5,12 @@ import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Array from "@rescript/runtime/lib/es6/Stdlib_Array.js";
 import * as Id$Reventless from "@reventlessdev/reventless-spec/src/types/Id.res.mjs";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Primitive_object from "@rescript/runtime/lib/es6/Primitive_object.js";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
 import * as DateTime$Reventless from "@reventlessdev/reventless-spec/src/types/DateTime.res.mjs";
 import * as Reference$Reventless from "@reventlessdev/reventless-spec/src/components/Reference.res.mjs";
 import * as StorageRef$Reventless from "@reventlessdev/reventless-spec/src/semantic/StorageRef.res.mjs";
+import * as Api_Naming$ReventlessCore from "../../src/components/Api/Api_Naming.res.mjs";
 import * as PsShipOrder$ReventlessCore from "./StateChangeSlice/PsShipOrder.res.mjs";
 import * as PsOrdersView$ReventlessCore from "./StateViewSlice/PsOrdersView.res.mjs";
 import * as PsPlaceOrder$ReventlessCore from "./StateChangeSlice/PsPlaceOrder.res.mjs";
@@ -20,6 +22,7 @@ import * as PsAnnotatedView$ReventlessCore from "./StateViewSlice/PsAnnotatedVie
 import * as PsAttachInvoice$ReventlessCore from "./StateChangeSlice/PsAttachInvoice.res.mjs";
 import * as PsCustomersView$ReventlessCore from "./StateViewSlice/PsCustomersView.res.mjs";
 import * as Plugin_Structure$ReventlessCore from "../../src/plugin/component/Plugin_Structure.res.mjs";
+import * as PsCategoriesView$ReventlessCore from "./StateViewSlice/PsCategoriesView.res.mjs";
 import * as Capability_Inference$ReventlessCore from "../../src/plugin/component/Capability_Inference.res.mjs";
 import * as PsAvailableProductsView$ReventlessCore from "./StateViewSlice/PsAvailableProductsView.res.mjs";
 
@@ -187,6 +190,32 @@ let PsAnnotatedViewSlice = {
   make: make$5
 };
 
+let Projection$4 = {
+  project: PsCategoriesView$ReventlessCore.project,
+  moduleUrl: PsCategoriesView$ReventlessCore.moduleUrl
+};
+
+function make$6(param, param$1, param$2) {
+  return 0;
+}
+
+let PsCategoriesViewSlice_Spec = {
+  name: PsCategoriesView$ReventlessCore.name,
+  moduleUrl: PsCategoriesView$ReventlessCore.moduleUrl,
+  stateSchema: PsCategoriesView$ReventlessCore.stateSchema,
+  consumedEventSchema: PsCategoriesView$ReventlessCore.consumedEventSchema,
+  config: PsCategoriesView$ReventlessCore.config,
+  subIdConfig: undefined,
+  authorization: PsCategoriesView$ReventlessCore.authorization,
+  visibility: PsCategoriesView$ReventlessCore.visibility
+};
+
+let PsCategoriesViewSlice = {
+  Spec: PsCategoriesViewSlice_Spec,
+  Projection: Projection$4,
+  make: make$6
+};
+
 let Behavior$2 = {
   initialState: false,
   evolve: PsAttachInvoice$ReventlessCore.evolve,
@@ -194,7 +223,7 @@ let Behavior$2 = {
   moduleUrl: PsAttachInvoice$ReventlessCore.moduleUrl
 };
 
-function make$6(param, param$1, param$2, param$3, param$4, param$5) {
+function make$7(param, param$1, param$2, param$3, param$4, param$5) {
   return 0;
 }
 
@@ -214,7 +243,7 @@ let PsAttachInvoiceSlice = {
   Spec: PsAttachInvoiceSlice_Spec,
   Behavior: Behavior$2,
   isAsync: false,
-  make: make$6
+  make: make$7
 };
 
 let Behavior$3 = {
@@ -224,7 +253,7 @@ let Behavior$3 = {
   moduleUrl: PsUploadAvatar$ReventlessCore.moduleUrl
 };
 
-function make$7(param, param$1, param$2, param$3, param$4, param$5) {
+function make$8(param, param$1, param$2, param$3, param$4, param$5) {
   return 0;
 }
 
@@ -244,7 +273,7 @@ let PsUploadAvatarSlice = {
   Spec: PsUploadAvatarSlice_Spec,
   Behavior: Behavior$3,
   isAsync: false,
-  make: make$7
+  make: make$8
 };
 
 let Behavior$4 = {
@@ -254,7 +283,7 @@ let Behavior$4 = {
   moduleUrl: PsChangePhoto$ReventlessCore.moduleUrl
 };
 
-function make$8(param, param$1, param$2, param$3, param$4, param$5) {
+function make$9(param, param$1, param$2, param$3, param$4, param$5) {
   return 0;
 }
 
@@ -274,7 +303,7 @@ let PsChangePhotoSlice = {
   Spec: PsChangePhotoSlice_Spec,
   Behavior: Behavior$4,
   isAsync: false,
-  make: make$8
+  make: make$9
 };
 
 let Behavior$5 = {
@@ -284,7 +313,7 @@ let Behavior$5 = {
   moduleUrl: PsReserveStock$ReventlessCore.moduleUrl
 };
 
-function make$9(param, param$1, param$2, param$3, param$4, param$5) {
+function make$10(param, param$1, param$2, param$3, param$4, param$5) {
   return 0;
 }
 
@@ -304,7 +333,7 @@ let PsReserveStockSlice = {
   Spec: PsReserveStockSlice_Spec,
   Behavior: Behavior$5,
   isAsync: false,
-  make: make$9
+  make: make$10
 };
 
 let structure = Plugin_Structure$ReventlessCore.make("TestPlugin", undefined, undefined, [
@@ -709,6 +738,54 @@ globalThis.describe("Plugin_Structure.make — Phase 2 graph fields", () => {
       globalThis.expect(stated).toEqual(true);
     });
   });
+  globalThis.describe("singleQueryField — the singular the schema actually serves", () => {
+    let withIrregularPlural = Plugin_Structure$ReventlessCore.make("TestPlugin", undefined, undefined, [PsCategoriesViewSlice], [], undefined, undefined, undefined, undefined, undefined, undefined);
+    let categories = withIrregularPlural.stateViewSlices[0];
+    globalThis.test("an `-ies` plural publishes the `y` singular, not a truncation", () => {
+      globalThis.expect([
+        categories.queryField,
+        categories.singleQueryField
+      ]).toEqual([
+        "TestPlugin_Categories",
+        "TestPlugin_Category"
+      ]);
+    });
+    globalThis.test("every built def states the name Api_Naming returned", () => {
+      let stated = structure.stateViewSlices.every(q => Primitive_object.equal(q.singleQueryField, Api_Naming$ReventlessCore.queryFieldNamesForStateView("TestPlugin", q.name, undefined).singleFieldName));
+      globalThis.expect(stated).toEqual(true);
+    });
+  });
+  globalThis.describe("idField / idFieldSource — the key and its provenance", () => {
+    let keyOf = q => [
+      q.idField,
+      q.idFieldSource
+    ];
+    let withCategories = Plugin_Structure$ReventlessCore.make("TestPlugin", undefined, undefined, [PsCategoriesViewSlice], [], undefined, undefined, undefined, undefined, undefined, undefined);
+    globalThis.test("a name-matching `*Id` field is a guess the consumer can also make", () => {
+      globalThis.expect(keyOf(structure.stateViewSlices[0])).toEqual([
+        "orderId",
+        "convention"
+      ]);
+    });
+    globalThis.test("a sole `*Id` field is a fact only this side can see", () => {
+      globalThis.expect(keyOf(structure.stateViewSlices[1])).toEqual([
+        "productId",
+        "sole"
+      ]);
+    });
+    globalThis.test("an `-ies` component name singularises to its key", () => {
+      globalThis.expect(keyOf(withCategories.stateViewSlices[0])).toEqual([
+        "categoryId",
+        "convention"
+      ]);
+    });
+    globalThis.test("a declared @id is used where inference would decline", () => {
+      globalThis.expect(keyOf(structure.stateViewSlices[3])).toEqual([
+        "itemId",
+        "annotation"
+      ]);
+    });
+  });
   globalThis.describe("statusField — the shape rule", () => {
     globalThis.test("a `status` field holding a closed set of values is the lifecycle field", () => {
       let schema = S.schema(s => ({
@@ -1046,6 +1123,7 @@ export {
   PsAvailableProductsViewSlice,
   PsCustomersViewSlice,
   PsAnnotatedViewSlice,
+  PsCategoriesViewSlice,
   PsAttachInvoiceSlice,
   PsUploadAvatarSlice,
   PsChangePhotoSlice,

package/tests/plugin/StateViewSlice/PsCategoriesView.res

@@ -0,0 +1,17 @@
+// Test fixture for the published singular query field.
+// "Categories" is the name a naive "strip a trailing s" derivation gets wrong
+// (`Categorie`), so it is the one that proves `singleQueryField` comes from
+// `Api_Naming` rather than from a rule re-invented at the consumer.
+
+@@reventless.spec("Categories")
+
+@schema
+type consumedEvent = CategoryAdded({categoryId: string, name: string})
+
+@schema
+type state = {categoryId: string, name: string}
+
+let project = ({event}: Reventless.StateViewSlice.consumed<consumedEvent>) =>
+  switch event {
+  | CategoryAdded({categoryId, name}) => [Set(categoryId, {categoryId, name})]
+  }

package/tests/plugin/StateViewSlice/PsCategoriesView.res.mjs

@@ -0,0 +1,57 @@
+// Generated by ReScript, PLEASE EDIT WITH CARE
+
+import * as S from "sury/src/S.res.mjs";
+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";
+
+let consumedEventSchema = S.schema(s => ({
+  TAG: "CategoryAdded",
+  categoryId: s.m(DcbTag$Reventless.string),
+  name: s.m(S.string)
+}));
+
+let stateSchema = S.schema(s => ({
+  categoryId: s.m(S.string),
+  name: s.m(S.string)
+}));
+
+function project(param) {
+  let event = param.event;
+  let categoryId = event.categoryId;
+  return [{
+      TAG: "Set",
+      _0: categoryId,
+      _1: {
+        categoryId: categoryId,
+        name: event.name
+      }
+    }];
+}
+
+let config = ReadModel$Reventless.config(undefined, undefined, undefined);
+
+let name = "Categories";
+
+let Id;
+
+let subIdConfig;
+
+let moduleUrl = "@reventlessdev/reventless-core/tests/plugin/StateViewSlice/PsCategoriesView.res.mjs";
+
+let authorization = "AllowAuthenticated";
+
+let visibility = "Public";
+
+export {
+  name,
+  Id,
+  consumedEventSchema,
+  stateSchema,
+  project,
+  config,
+  subIdConfig,
+  moduleUrl,
+  authorization,
+  visibility,
+}
+/* consumedEventSchema Not a pure module */