@reventlessdev/reventless-core 3.0.0-alpha.284 → 3.0.0-alpha.286

package/tests/admin/Platform_Admin_StructureTest.res

@@ -27,7 +27,7 @@ let commandNamed = (name: string): commandDef =>
 let activate = () => commandNamed("Activate")
 
 describe("the Plugins read model declares its lifecycle", () => {
-  let rm: queryableDef = Platform_Admin_Structure.pluginReadModel
+  let rm: queryableDef = Platform_Admin_Structure.pluginReadModel()
 
   testSync("names the field commands branch on", () =>
     expect(rm.lifecycleField)->toEqual(Some("status"))
@@ -206,25 +206,28 @@ describe("the internal commands declare the edges they move rows along", () => {
 // was open to everyone and the server refused anyone outside `Admin`. The
 // mismatch is invisible until a non-admin clicks the page.
 describe("the Plugins view publishes the rule the server enforces", () => {
-  // 🚨 **This is also the only check `Reventless.AdminGroup.name` can carry.** A
-  // PPX annotation takes a literal, so `@@reventless.authorize(AllowGroups(
-  // ["Admin"]))` above cannot reference the constant — the constant's job is to
-  // make everything *else* agree with the annotation, and nothing in the compiler
-  // spans that gap. The actual side here comes from the expanded annotation and
-  // the expected side from the constant, so the two are compared rather than
-  // restated. Writing the literal on both sides would pass while they diverged.
-  testSync("the spec declares the group, and it is the one the constant names", () =>
+  // The annotation names the role, so a renamed administrator group follows it
+  // without anyone editing the spec.
+  testSync("the spec declares the administrator role", () =>
     expect(PluginsReadModelSpec.authorization)->toEqual(
-      Reventless.Authorization.AllowGroups([Reventless.AdminGroup.name]),
+      Reventless.Authorization.AllowRoles([Reventless.Role.admin]),
     )
   )
 
-  testSync("and the published access keys are derived from it", () =>
-    expect(Platform_Admin_Structure.pluginReadModel.requiredAccess)->toEqual(
-      Some([Reventless.AdminGroup.name]),
+  testSync("and the published access keys are the group it maps to", () =>
+    expect(Platform_Admin_Structure.pluginReadModel().requiredAccess)->toEqual(
+      Some([Reventless.Role.adminGroup()]),
     )
   )
 
+  testSync("a renamed administrator group reaches the access keys", () => {
+    Reventless.Role.clearGroups()
+    Reventless.Role.setGroups([(Reventless.Role.admin, "ops")])
+    let keys = Platform_Admin_Structure.pluginReadModel().requiredAccess
+    Reventless.Role.clearGroups()
+    expect(keys)->toEqual(Some(["ops"]))
+  })
+
   // The API entry reads the same binding rather than restating it, so the two
   // cannot be edited apart.
   testSync("the query entry carries the spec's rule and no hand-written pair", () => {
@@ -243,7 +246,7 @@ describe("the Plugins view publishes the rule the server enforces", () => {
 // looked special. Asserted rather than assumed — the whole case for deriving
 // rests on the generic helpers reaching the same answers.
 describe("the Plugins queryableDef is what the generic helpers produce", () => {
-  let rm: queryableDef = Platform_Admin_Structure.pluginReadModel
+  let rm: queryableDef = Platform_Admin_Structure.pluginReadModel()
 
   testSync("the field names are the generic ones", () =>
     expect((rm.queryField, rm.singleQueryField))->toEqual((

package/tests/admin/Platform_Admin_StructureTest.res.mjs

@@ -2,8 +2,8 @@
 
 import * as Stdlib_JSON from "@rescript/runtime/lib/es6/Stdlib_JSON.js";
 import * as Stdlib_Option from "@rescript/runtime/lib/es6/Stdlib_Option.js";
+import * as Role$Reventless from "@reventlessdev/reventless-spec/src/types/Role.res.mjs";
 import * as Primitive_object from "@rescript/runtime/lib/es6/Primitive_object.js";
-import * as AdminGroup$Reventless from "@reventlessdev/reventless-spec/src/types/AdminGroup.res.mjs";
 import * as Plugin_Structure$ReventlessCore from "../../src/plugin/component/Plugin_Structure.res.mjs";
 import * as PluginBaseFragment$ReventlessCore from "../../src/plugin/api/PluginBaseFragment.res.mjs";
 import * as PluginsReadModelSpec$ReventlessCore from "../../src/plugin/lifecycle/PluginsReadModelSpec.res.mjs";
@@ -19,19 +19,20 @@ function activate() {
 }
 
 globalThis.describe("the Plugins read model declares its lifecycle", () => {
+  let rm = Platform_Admin_Structure$ReventlessCore.pluginReadModel();
   globalThis.test("names the field commands branch on", () => {
-    globalThis.expect(Platform_Admin_Structure$ReventlessCore.pluginReadModel.lifecycleField).toEqual("status");
+    globalThis.expect(rm.lifecycleField).toEqual("status");
   });
   globalThis.test("and the published wire name is unchanged by the rename", () => {
-    let sdlDeclaresStatus = Stdlib_Option.mapOr(Platform_Admin_Structure$ReventlessCore.pluginReadModel.lifecycleField, false, f => f === "status") && Platform_Admin_Structure$ReventlessCore.pluginReadModel.queryField.startsWith("Platform_");
+    let sdlDeclaresStatus = Stdlib_Option.mapOr(rm.lifecycleField, false, f => f === "status") && rm.queryField.startsWith("Platform_");
     globalThis.expect(sdlDeclaresStatus).toEqual(true);
   });
   globalThis.test("is served on the encoded def under the new key", () => {
-    let json = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodeQueryableDef(Platform_Admin_Structure$ReventlessCore.pluginReadModel));
+    let json = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodeQueryableDef(rm));
     globalThis.expect(json.includes(`"lifecycleField":"status"`)).toEqual(true);
   });
   globalThis.test("and never under the old one", () => {
-    globalThis.expect(JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodeQueryableDef(Platform_Admin_Structure$ReventlessCore.pluginReadModel)).includes(`"statusField"`)).toEqual(false);
+    globalThis.expect(JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodeQueryableDef(rm)).includes(`"statusField"`)).toEqual(false);
   });
 });
 
@@ -155,14 +156,24 @@ globalThis.describe("the internal commands declare the edges they move rows alon
 });
 
 globalThis.describe("the Plugins view publishes the rule the server enforces", () => {
-  globalThis.test("the spec declares the group, and it is the one the constant names", () => {
+  globalThis.test("the spec declares the administrator role", () => {
     globalThis.expect(PluginsReadModelSpec$ReventlessCore.authorization).toEqual({
-      TAG: "AllowGroups",
-      _0: [AdminGroup$Reventless.name]
+      TAG: "AllowRoles",
+      _0: [Role$Reventless.admin]
     });
   });
-  globalThis.test("and the published access keys are derived from it", () => {
-    globalThis.expect(Platform_Admin_Structure$ReventlessCore.pluginReadModel.requiredAccess).toEqual([AdminGroup$Reventless.name]);
+  globalThis.test("and the published access keys are the group it maps to", () => {
+    globalThis.expect(Platform_Admin_Structure$ReventlessCore.pluginReadModel().requiredAccess).toEqual([Role$Reventless.adminGroup()]);
+  });
+  globalThis.test("a renamed administrator group reaches the access keys", () => {
+    Role$Reventless.clearGroups();
+    Role$Reventless.setGroups([[
+        Role$Reventless.admin,
+        "ops"
+      ]]);
+    let keys = Platform_Admin_Structure$ReventlessCore.pluginReadModel().requiredAccess;
+    Role$Reventless.clearGroups();
+    globalThis.expect(keys).toEqual(["ops"]);
   });
   globalThis.test("the query entry carries the spec's rule and no hand-written pair", () => {
     let entry = PluginBaseFragment$ReventlessCore.queryEntries[0];
@@ -177,10 +188,11 @@ globalThis.describe("the Plugins view publishes the rule the server enforces", (
 });
 
 globalThis.describe("the Plugins queryableDef is what the generic helpers produce", () => {
+  let rm = Platform_Admin_Structure$ReventlessCore.pluginReadModel();
   globalThis.test("the field names are the generic ones", () => {
     globalThis.expect([
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.queryField,
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.singleQueryField
+      rm.queryField,
+      rm.singleQueryField
     ]).toEqual([
       "Platform_Plugins",
       "Platform_Plugin"
@@ -188,9 +200,9 @@ globalThis.describe("the Plugins queryableDef is what the generic helpers produc
   });
   globalThis.test("the label ladder reaches the same field, by convention", () => {
     globalThis.expect([
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.labelField,
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.labelFieldSource,
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.searchableFields
+      rm.labelField,
+      rm.labelFieldSource,
+      rm.searchableFields
     ]).toEqual([
       "name",
       "convention",
@@ -199,15 +211,15 @@ globalThis.describe("the Plugins queryableDef is what the generic helpers produc
   });
   globalThis.test("the key ladder finds no id field, as the hand-written def claimed", () => {
     globalThis.expect([
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.idField,
-      Platform_Admin_Structure$ReventlessCore.pluginReadModel.idFieldSource
+      rm.idField,
+      rm.idFieldSource
     ]).toEqual([
       undefined,
       undefined
     ]);
   });
   globalThis.test("the blob fields are published, and marked hidden", () => {
-    let props = Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(JSON.parse(Platform_Admin_Structure$ReventlessCore.pluginReadModel.schema)), o => o["properties"]), Stdlib_JSON.Decode.object), {});
+    let props = Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(JSON.parse(rm.schema)), o => o["properties"]), Stdlib_JSON.Decode.object), {});
     let isHidden = key => Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_Option.flatMap(props[key], Stdlib_JSON.Decode.object), o => o["x-reventless-hidden"]), Stdlib_JSON.Decode.bool);
     globalThis.expect([
       isHidden("apiSchemaFragment"),
@@ -218,7 +230,7 @@ globalThis.describe("the Plugins queryableDef is what the generic helpers produc
     ]);
   });
   globalThis.test("while the internal fields are not published at all", () => {
-    let props = Stdlib_Option.mapOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(JSON.parse(Platform_Admin_Structure$ReventlessCore.pluginReadModel.schema)), o => o["properties"]), Stdlib_JSON.Decode.object), [], prim => Object.keys(prim));
+    let props = Stdlib_Option.mapOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(JSON.parse(rm.schema)), o => o["properties"]), Stdlib_JSON.Decode.object), [], prim => Object.keys(prim));
     globalThis.expect([
       props.includes("eventCollector"),
       props.includes("extensionNames"),

package/tests/admin/Platform_ComponentDefinitionsApiTest.res.mjs

@@ -311,40 +311,14 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
     idFieldSource: internalQbl_idFieldSource,
     requiredAccess: undefined
   };
-  let internalSlice_consumedEventTypes = internalQbl_consumedEventTypes;
-  let internalSlice_linkedWriteSide = internalQbl_linkedWriteSide;
-  let internalSlice_searchableFields = internalQbl_searchableFields;
-  let internalSlice_labelFieldSource = "convention";
-  let internalSlice_visibility = "Internal";
-  let internalSlice_singleQueryField = "Ordering_AvailableProduct";
-  let internalSlice_idField = "productId";
-  let internalSlice_idFieldSource = "sole";
-  let internalSlice = {
-    name: "PendingShipments",
-    queryField: "Ordering_PendingShipments",
-    schema: "{}",
-    consumedEventTypes: internalSlice_consumedEventTypes,
-    linkedWriteSide: internalSlice_linkedWriteSide,
-    labelField: "name",
-    searchableFields: internalSlice_searchableFields,
-    labelFieldSource: internalSlice_labelFieldSource,
-    lifecycleField: undefined,
-    ownerField: undefined,
-    retiredField: undefined,
-    retiredValues: undefined,
-    namedWhenRetired: undefined,
-    visibility: internalSlice_visibility,
-    chapter: undefined,
-    singleQueryField: internalSlice_singleQueryField,
-    idField: internalSlice_idField,
-    idFieldSource: internalSlice_idFieldSource,
-    requiredAccess: undefined
-  };
+  let newrecord = {...internalQbl};
+  newrecord.queryField = "Ordering_PendingShipments";
+  newrecord.name = "PendingShipments";
   let mixed_readModels = [
     qbl,
     internalQbl
   ];
-  let mixed_stateViewSlices = [internalSlice];
+  let mixed_stateViewSlices = [newrecord];
   let mixed_stateChangeSlices = structure_stateChangeSlices;
   let mixed_aggregates = structure_aggregates;
   let mixed_automationSlices = structure_automationSlices;
@@ -515,28 +489,9 @@ globalThis.describe("singleQueryField reaches the caller", () => {
     globalThis.expect(json.includes("\"singleQueryField\":\"Catalog_Product\"")).toEqual(true);
   });
   globalThis.test("encodes an unstated singular as null", () => {
+    let newrecord = {...qbl};
     let unstated = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Catalog", undefined, {
-      readModels: [{
-          name: "Products",
-          queryField: "Catalog_Products",
-          schema: "{}",
-          consumedEventTypes: qbl_consumedEventTypes,
-          linkedWriteSide: qbl_linkedWriteSide,
-          labelField: "displayName",
-          searchableFields: qbl_searchableFields,
-          labelFieldSource: "annotation",
-          lifecycleField: undefined,
-          ownerField: undefined,
-          retiredField: undefined,
-          retiredValues: undefined,
-          namedWhenRetired: undefined,
-          visibility: undefined,
-          chapter: undefined,
-          singleQueryField: undefined,
-          idField: "productId",
-          idFieldSource: "convention",
-          requiredAccess: undefined
-        }],
+      readModels: [(newrecord.singleQueryField = undefined, newrecord)],
       stateViewSlices: structure_stateViewSlices,
       stateChangeSlices: structure_stateChangeSlices,
       aggregates: structure_aggregates,
@@ -565,28 +520,9 @@ globalThis.describe("idField / idFieldSource reach the caller", () => {
     globalThis.expect(json.includes("\"idFieldSource\":\"convention\"")).toEqual(true);
   });
   globalThis.test("encodes an unresolved key as null on both fields", () => {
+    let newrecord = {...qbl};
     let unresolved = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Catalog", undefined, {
-      readModels: [{
-          name: "Products",
-          queryField: "Catalog_Products",
-          schema: "{}",
-          consumedEventTypes: qbl_consumedEventTypes,
-          linkedWriteSide: qbl_linkedWriteSide,
-          labelField: "displayName",
-          searchableFields: qbl_searchableFields,
-          labelFieldSource: "annotation",
-          lifecycleField: undefined,
-          ownerField: undefined,
-          retiredField: undefined,
-          retiredValues: undefined,
-          namedWhenRetired: undefined,
-          visibility: undefined,
-          chapter: undefined,
-          singleQueryField: "Catalog_Product",
-          idField: undefined,
-          idFieldSource: undefined,
-          requiredAccess: undefined
-        }],
+      readModels: [(newrecord.idFieldSource = undefined, newrecord.idField = undefined, newrecord)],
       stateViewSlices: structure_stateViewSlices,
       stateChangeSlices: structure_stateChangeSlices,
       aggregates: structure_aggregates,

package/tests/admin/Platform_PluginStructuresApiTest.res.mjs

@@ -47,52 +47,20 @@ let publicRm = {
   requiredAccess: undefined
 };
 
-let internalRm_consumedEventTypes = publicRm_consumedEventTypes;
+let newrecord = {...publicRm};
 
-let internalRm_linkedWriteSide = publicRm_linkedWriteSide;
+newrecord.visibility = "Internal";
 
-let internalRm_searchableFields = publicRm_searchableFields;
+newrecord.queryField = "Catalog_ProductAudit";
 
-let internalRm_labelFieldSource = "annotation";
-
-let internalRm_visibility = "Internal";
-
-let internalRm_chapter = "Inventory";
-
-let internalRm_singleQueryField = "Catalog_Product";
-
-let internalRm_idField = "productId";
-
-let internalRm_idFieldSource = "convention";
-
-let internalRm = {
-  name: "ProductAudit",
-  queryField: "Catalog_ProductAudit",
-  schema: "{}",
-  consumedEventTypes: internalRm_consumedEventTypes,
-  linkedWriteSide: internalRm_linkedWriteSide,
-  labelField: "displayName",
-  searchableFields: internalRm_searchableFields,
-  labelFieldSource: internalRm_labelFieldSource,
-  lifecycleField: undefined,
-  ownerField: undefined,
-  retiredField: undefined,
-  retiredValues: undefined,
-  namedWhenRetired: undefined,
-  visibility: internalRm_visibility,
-  chapter: internalRm_chapter,
-  singleQueryField: internalRm_singleQueryField,
-  idField: internalRm_idField,
-  idFieldSource: internalRm_idFieldSource,
-  requiredAccess: undefined
-};
+newrecord.name = "ProductAudit";
 
 let structure_readModels = [
   publicRm,
-  internalRm
+  newrecord
 ];
 
-let structure_stateViewSlices = [internalRm];
+let structure_stateViewSlices = [newrecord];
 
 let structure_stateChangeSlices = [];
 
@@ -248,6 +216,8 @@ globalThis.describe("absent optional collections", () => {
   });
 });
 
+let internalRm = newrecord;
+
 export {
   publicRm,
   internalRm,
@@ -256,4 +226,4 @@ export {
   json,
   namesOf,
 }
-/* encoded Not a pure module */
+/*  Not a pure module */

package/tests/api/GraphQL_FragmentGeneratorTest.res

@@ -853,7 +853,7 @@ describe("@resolves / @resolvesMany reach the SDL", () => {
         () =>
           orderType(
             ~resolvedFields=Some(ResolvedFields.bothFields),
-            ~targetPermission=AllowGroups(["Admin"]),
+            ~targetPermission=AllowRoles([Reventless.Role.make("Admin")]),
           ),
       ),
     )->toBe(true)

package/tests/api/GraphQL_FragmentGeneratorTest.res.mjs

@@ -710,7 +710,7 @@ globalThis.describe("@resolves / @resolvesMany reach the SDL", () => {
   });
   globalThis.test("a target guarded differently from the parent is refused", () => {
     globalThis.expect(refused(() => orderType(bothFields, {
-      TAG: "AllowGroups",
+      TAG: "AllowRoles",
       _0: ["Admin"]
     }))).toBe(true);
   });