@reventlessdev/reventless-core 3.0.0-alpha.189 → 3.0.0-alpha.191

package/src/plugin/component/Plugin_Structure.res.mjs

@@ -8,8 +8,10 @@ import * as Belt_SetString from "@rescript/runtime/lib/es6/Belt_SetString.js";
 import * as DcbTag$Reventless from "@reventlessdev/reventless-spec/src/components/DcbTag.res.mjs";
 import * as Reference$Reventless from "@reventlessdev/reventless-spec/src/components/Reference.res.mjs";
 import * as Logger$ReventlessCore from "../../util/Logger.res.mjs";
+import * as StorageRef$Reventless from "@reventlessdev/reventless-spec/src/semantic/StorageRef.res.mjs";
 import * as DisplayName$Reventless from "@reventlessdev/reventless-spec/src/components/DisplayName.res.mjs";
 import * as Api_Naming$ReventlessCore from "../../components/Api/Api_Naming.res.mjs";
+import * as SchemaType$ReventlessCore from "../../components/Api/SchemaType.res.mjs";
 import * as StateAnnotations$Reventless from "@reventlessdev/reventless-spec/src/components/StateAnnotations.res.mjs";
 import * as ApiNoApiHelpers$ReventlessCore from "../../components/Api/ApiNoApiHelpers.res.mjs";
 import * as SuryToJsonSchema$ReventlessCore from "../../components/Api/SuryToJsonSchema.res.mjs";
@@ -18,54 +20,122 @@ import * as ApiAllowedStatesHelpers$ReventlessCore from "../../components/Api/Ap
 
 let log = Logger$ReventlessCore.fromEnv();
 
-function isIdLikeFieldName(name) {
-  if (name === "id" || name.endsWith("Id")) {
-    return true;
-  } else {
-    return name.endsWith("Ids");
-  }
+function isLabelShape(_t) {
+  while (true) {
+    let t = _t;
+    if (typeof t !== "object") {
+      return t === "ScalarString";
+    }
+    if (t.TAG !== "Nullable") {
+      return false;
+    }
+    _t = t._0;
+    continue;
+  };
 }
 
-function statusFieldFromStateSchema(stateSchema) {
+function isStatusShape(_t) {
+  while (true) {
+    let t = _t;
+    if (typeof t !== "object") {
+      return false;
+    }
+    switch (t.TAG) {
+      case "Nullable" :
+        _t = t._0;
+        continue;
+      case "Enum" :
+        return true;
+      default:
+        return false;
+    }
+  };
+}
+
+let conventionalLabelNames = [
+  "name",
+  "title",
+  "label",
+  "displayname"
+];
+
+function shapeOfItem(entityName, item) {
+  return SchemaType$ReventlessCore.fromSury(entityName, item.location, item.schema);
+}
+
+function statusFieldFromStateSchema(entityName, stateSchema) {
   let spec = StateAnnotations$Reventless.getSpec(stateSchema);
   let annotated = spec !== undefined ? spec.status : undefined;
   if (annotated !== undefined) {
     return annotated;
   } else if (stateSchema.type === "object") {
-    return Stdlib_Option.map(stateSchema.items.find(item => item.location === "status"), item => item.location);
+    return Stdlib_Option.map(stateSchema.items.find(item => {
+      if (item.location === "status") {
+        return isStatusShape(shapeOfItem(entityName, item));
+      } else {
+        return false;
+      }
+    }), item => item.location);
   } else {
     return;
   }
 }
 
+function labelFieldSourceToString(s) {
+  switch (s) {
+    case "Annotation" :
+      return "annotation";
+    case "Convention" :
+      return "convention";
+    case "Position" :
+      return "position";
+    case "Fallback" :
+      return "fallback";
+  }
+}
+
 function labelFieldsFromStateSchema(entityName, stateSchema) {
   let spec = DisplayName$Reventless.getSpec(stateSchema);
   if (spec !== undefined) {
-    return [
-      "displayName",
-      spec.fields
-    ];
+    return {
+      field: "displayName",
+      searchableFields: spec.fields,
+      source: "Annotation"
+    };
   }
-  let firstStringItem;
-  firstStringItem = stateSchema.type === "object" ? stateSchema.items.find(item => {
-      if (item.location === "TAG" || isIdLikeFieldName(item.location)) {
+  let candidates;
+  candidates = stateSchema.type === "object" ? stateSchema.items.filter(item => {
+      if (item.location !== "TAG" && item.location !== "id") {
+        return isLabelShape(shapeOfItem(entityName, item));
+      } else {
         return false;
       }
-      let match = item.schema;
-      return match.type === "string";
-    }) : undefined;
-  if (firstStringItem !== undefined) {
-    return [
-      firstStringItem.location,
-      [firstStringItem.location]
-    ];
-  } else {
-    log.warn("Plugin_Structure", undefined, entityName + `: no @displayName annotation and no suitable string field — labelField falls back to "id"`);
-    return [
-      "id",
-      []
-    ];
+    }) : [];
+  let conventional = candidates.find(item => {
+    let lower = item.location.toLowerCase();
+    return conventionalLabelNames.some(n => n === lower);
+  });
+  let picked = conventional !== undefined ? [
+      conventional,
+      "Convention"
+    ] : Stdlib_Option.map(candidates[0], item => [
+      item,
+      "Position"
+    ]);
+  if (picked !== undefined) {
+    let item = picked[0];
+    return {
+      field: item.location,
+      searchableFields: [item.location],
+      source: picked[1]
+    };
   }
+  log.warn("Plugin_Structure", undefined, entityName + `: no @displayName annotation and no suitable string field — labelField falls back to "id"`);
+  return {
+    field: "id",
+    searchableFields: [],
+    source: "Fallback"
+  };
 }
 
 function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChangeSlicesOpt, automationSlicesOpt, outboundTranslationSlicesOpt, inboundTranslationSlicesOpt, extensionsOpt, extensionPointsOpt, componentChaptersOpt) {
@@ -316,6 +386,29 @@ function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChang
     let match$3 = scored[0];
     return match$3[0];
   };
+  let storesFromSchema = schema => {
+    let fromVariant = v => {
+      if (v.type === "object") {
+        let properties = v.properties;
+        return Stdlib_Array.filterMap(Object.entries(properties), param => Stdlib_Option.map(StorageRef$Reventless.getStore(param[1]), target => Stdlib_Option.getOr(target.plugin, name) + "." + target.store));
+      } else {
+        return [];
+      }
+    };
+    if (schema.type === "union") {
+      return schema.anyOf.flatMap(fromVariant);
+    } else {
+      return fromVariant(schema);
+    }
+  };
+  let requiredStores = Belt_SetString.toArray(Belt_SetString.fromArray([
+    aggregates.flatMap(A => storesFromSchema(A.Spec.commandSchema).concat(storesFromSchema(A.Spec.eventSchema))),
+    stateChangeSlices.flatMap(SCS => storesFromSchema(SCS.Spec.commandSchema).concat(storesFromSchema(SCS.Spec.eventSchema))),
+    stateViewSlices.flatMap(SVS => storesFromSchema(SVS.Spec.stateSchema)),
+    readModels.flatMap(R => storesFromSchema(R.Spec.stateSchema)),
+    automationSlices.flatMap(AS => storesFromSchema(AS.Spec.commandSchema)),
+    inboundTranslationSlices.flatMap(ITS => storesFromSchema(ITS.Spec.commandSchema))
+  ].flat()));
   let visibilityTag = v => {
     if (v === "Public") {
       return;
@@ -326,7 +419,7 @@ function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChang
   let readModelDefs = readModels.map(R => {
     let qf = Api_Naming$ReventlessCore.queryFieldNamesForReadModel(name, R.Spec.name, undefined);
     let stateSchema = R.Spec.stateSchema;
-    let match = labelFieldsFromStateSchema(R.Spec.name, stateSchema);
+    let label = labelFieldsFromStateSchema(R.Spec.name, stateSchema);
     let consumed = qualify(name, R.consumedEventNames);
     return {
       name: R.Spec.name,
@@ -334,9 +427,10 @@ function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChang
       schema: JSON.stringify(SuryToJsonSchema$ReventlessCore.deriveObjectSchema(stateSchema)),
       consumedEventTypes: consumed,
       linkedWriteSide: linkedWriteSideFor(consumed),
-      labelField: match[0],
-      searchableFields: match[1],
-      statusField: statusFieldFromStateSchema(stateSchema),
+      labelField: label.field,
+      searchableFields: label.searchableFields,
+      labelFieldSource: labelFieldSourceToString(label.source),
+      statusField: statusFieldFromStateSchema(R.Spec.name, stateSchema),
       visibility: visibilityTag(R.Spec.visibility),
       chapter: componentChapters[R.Spec.name]
     };
@@ -346,16 +440,17 @@ function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChang
     let match = svsConsumed[i];
     let consumed = match[1];
     let stateSchema = SVS.Spec.stateSchema;
-    let match$1 = labelFieldsFromStateSchema(SVS.Spec.name, stateSchema);
+    let label = labelFieldsFromStateSchema(SVS.Spec.name, stateSchema);
     return {
       name: SVS.Spec.name,
       queryField: qf.listFieldName,
       schema: JSON.stringify(SuryToJsonSchema$ReventlessCore.deriveObjectSchema(stateSchema)),
       consumedEventTypes: consumed,
       linkedWriteSide: linkedWriteSideFor(consumed),
-      labelField: match$1[0],
-      searchableFields: match$1[1],
-      statusField: statusFieldFromStateSchema(stateSchema),
+      labelField: label.field,
+      searchableFields: label.searchableFields,
+      labelFieldSource: labelFieldSourceToString(label.source),
+      statusField: statusFieldFromStateSchema(SVS.Spec.name, stateSchema),
       visibility: visibilityTag(SVS.Spec.visibility),
       chapter: componentChapters[SVS.Spec.name]
     };
@@ -458,14 +553,19 @@ function make(name, aggregatesOpt, readModelsOpt, stateViewSlicesOpt, stateChang
     outboundTranslationSlices: outboundTranslationSliceDefs,
     inboundTranslationSlices: inboundTranslationSliceDefs,
     extensions: extensionDefs,
-    extensionPoints: extensionPointDefs
+    extensionPoints: extensionPointDefs,
+    requiredStores: requiredStores
   };
 }
 
 export {
   log,
-  isIdLikeFieldName,
+  isLabelShape,
+  isStatusShape,
+  conventionalLabelNames,
+  shapeOfItem,
   statusFieldFromStateSchema,
+  labelFieldSourceToString,
   labelFieldsFromStateSchema,
   make,
 }

package/tests/admin/Platform_ComponentDefinitionsApiTest.res

@@ -27,6 +27,7 @@ let qbl: queryableDef = {
   linkedWriteSide: ["Product"],
   labelField: "displayName",
   searchableFields: ["displayName"],
+  labelFieldSource: Some("annotation"),
   statusField: None,
   visibility: None,
   chapter: None,
@@ -85,6 +86,7 @@ let structure: pluginStructure = {
     },
   ],
   extensionPoints: None,
+  requiredStores: None,
 }
 
 let encoded = Platform_ComponentDefinitionsApi.encodePluginStructureEntry(
@@ -227,6 +229,7 @@ describe("visibility filtering (deployed AutoUI hides Internal)", () => {
     linkedWriteSide: [],
     labelField: "name",
     searchableFields: ["name"],
+    labelFieldSource: Some("convention"),
     statusField: None,
     visibility: Some("Internal"),
     chapter: None,
@@ -269,6 +272,7 @@ describe("allowedStates + statusField populated", () => {
     linkedWriteSide: ["Plugin"],
     labelField: "name",
     searchableFields: ["name"],
+    labelFieldSource: Some("convention"),
     statusField: Some("status"),
     visibility: None,
     chapter: None,
@@ -295,6 +299,7 @@ describe("allowedStates + statusField populated", () => {
     inboundTranslationSlices: [],
     extensions: [],
     extensionPoints: None,
+    requiredStores: None,
   }
 
   let json =

package/tests/admin/Platform_ComponentDefinitionsApiTest.res.mjs

@@ -31,6 +31,8 @@ let qbl_linkedWriteSide = ["Product"];
 
 let qbl_searchableFields = ["displayName"];
 
+let qbl_labelFieldSource = "annotation";
+
 let qbl = {
   name: "Products",
   queryField: "Catalog_Products",
@@ -39,6 +41,7 @@ let qbl = {
   linkedWriteSide: qbl_linkedWriteSide,
   labelField: "displayName",
   searchableFields: qbl_searchableFields,
+  labelFieldSource: qbl_labelFieldSource,
   statusField: undefined,
   visibility: undefined,
   chapter: undefined
@@ -118,7 +121,8 @@ let structure = {
   outboundTranslationSlices: structure_outboundTranslationSlices,
   inboundTranslationSlices: structure_inboundTranslationSlices,
   extensions: structure_extensions,
-  extensionPoints: undefined
+  extensionPoints: undefined,
+  requiredStores: undefined
 };
 
 let encoded = Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Catalog", structure);
@@ -216,7 +220,8 @@ globalThis.describe("translation-slice externalSystem round-trip", () => {
     outboundTranslationSlices: externalStructure_outboundTranslationSlices,
     inboundTranslationSlices: externalStructure_inboundTranslationSlices,
     extensions: externalStructure_extensions,
-    extensionPoints: undefined
+    extensionPoints: undefined,
+    requiredStores: undefined
   };
   let externalJson = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Catalog", externalStructure));
   globalThis.test("surfaces Some outbound externalSystem as its inner string", () => {
@@ -231,6 +236,7 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
   let internalQbl_consumedEventTypes = ["CatalogProductSynced"];
   let internalQbl_linkedWriteSide = [];
   let internalQbl_searchableFields = ["name"];
+  let internalQbl_labelFieldSource = "convention";
   let internalQbl_visibility = "Internal";
   let internalQbl = {
     name: "AvailableProducts",
@@ -240,6 +246,7 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
     linkedWriteSide: internalQbl_linkedWriteSide,
     labelField: "name",
     searchableFields: internalQbl_searchableFields,
+    labelFieldSource: internalQbl_labelFieldSource,
     statusField: undefined,
     visibility: internalQbl_visibility,
     chapter: undefined
@@ -264,7 +271,8 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
     outboundTranslationSlices: mixed_outboundTranslationSlices,
     inboundTranslationSlices: mixed_inboundTranslationSlices,
     extensions: mixed_extensions,
-    extensionPoints: undefined
+    extensionPoints: undefined,
+    requiredStores: undefined
   };
   let mixedJson = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Ordering", mixed));
   globalThis.test("excludes an Internal queryableDef from the encoded read-side", () => {
@@ -295,6 +303,7 @@ globalThis.describe("allowedStates + statusField populated", () => {
   let qblWithStatus_consumedEventTypes = [];
   let qblWithStatus_linkedWriteSide = ["Plugin"];
   let qblWithStatus_searchableFields = ["name"];
+  let qblWithStatus_labelFieldSource = "convention";
   let qblWithStatus_statusField = "status";
   let qblWithStatus = {
     name: "Plugin",
@@ -304,6 +313,7 @@ globalThis.describe("allowedStates + statusField populated", () => {
     linkedWriteSide: qblWithStatus_linkedWriteSide,
     labelField: "name",
     searchableFields: qblWithStatus_searchableFields,
+    labelFieldSource: qblWithStatus_labelFieldSource,
     statusField: qblWithStatus_statusField,
     visibility: undefined,
     chapter: undefined
@@ -340,7 +350,8 @@ globalThis.describe("allowedStates + statusField populated", () => {
     outboundTranslationSlices: structureWithStates_outboundTranslationSlices,
     inboundTranslationSlices: structureWithStates_inboundTranslationSlices,
     extensions: structureWithStates_extensions,
-    extensionPoints: undefined
+    extensionPoints: undefined,
+    requiredStores: undefined
   };
   let json = JSON.stringify(Platform_ComponentDefinitionsApi$ReventlessCore.encodePluginStructureEntry("Platform", structureWithStates));
   globalThis.test("encodes populated allowedStates as a JSON array", () => {

package/tests/message/MessageTest.res

@@ -130,6 +130,7 @@ describe("Message should", () => {
         inboundTranslationSlices: [],
         extensions: [],
         extensionPoints: None,
+        requiredStores: None,
       }),
       dcbEventLog: None,
       kind: Domain,

package/tests/message/MessageTest.res.mjs

@@ -117,7 +117,8 @@ globalThis.describe("Message should", () => {
         outboundTranslationSlices: [],
         inboundTranslationSlices: [],
         extensions: [],
-        extensionPoints: undefined
+        extensionPoints: undefined,
+        requiredStores: undefined
       },
       dcbEventLog: undefined,
       kind: "Domain"