@reventlessdev/reventless-core 3.0.0-alpha.235 → 3.0.0-alpha.237

package/tests/admin/Platform_ComponentDefinitionsApiTest.res.mjs

@@ -51,8 +51,10 @@ let qbl = {
   labelField: "displayName",
   searchableFields: qbl_searchableFields,
   labelFieldSource: qbl_labelFieldSource,
-  statusField: undefined,
+  lifecycleField: undefined,
   ownerField: undefined,
+  retiredField: undefined,
+  retiredValues: undefined,
   visibility: undefined,
   chapter: undefined,
   singleQueryField: qbl_singleQueryField,
@@ -198,8 +200,8 @@ globalThis.describe("encodePluginStructureEntry", () => {
   globalThis.test("encodes the command's apiExposed flag (drives the event-graph API badge)", () => {
     globalThis.expect(json.includes("\"apiExposed\":true")).toEqual(true);
   });
-  globalThis.test("encodes None statusField as null", () => {
-    globalThis.expect(json.includes("\"statusField\":null")).toEqual(true);
+  globalThis.test("encodes None lifecycleField as null", () => {
+    globalThis.expect(json.includes("\"lifecycleField\":null")).toEqual(true);
   });
   globalThis.test("encodes writableDef events", () => {
     globalThis.expect(json.includes("\"events\":[{\"name\":\"ProductAdded\"")).toEqual(true);
@@ -282,8 +284,10 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
     labelField: "name",
     searchableFields: internalQbl_searchableFields,
     labelFieldSource: internalQbl_labelFieldSource,
-    statusField: undefined,
+    lifecycleField: undefined,
     ownerField: undefined,
+    retiredField: undefined,
+    retiredValues: undefined,
     visibility: internalQbl_visibility,
     chapter: undefined,
     singleQueryField: internalQbl_singleQueryField,
@@ -308,8 +312,10 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
     labelField: "name",
     searchableFields: internalSlice_searchableFields,
     labelFieldSource: internalSlice_labelFieldSource,
-    statusField: undefined,
+    lifecycleField: undefined,
     ownerField: undefined,
+    retiredField: undefined,
+    retiredValues: undefined,
     visibility: internalSlice_visibility,
     chapter: undefined,
     singleQueryField: internalSlice_singleQueryField,
@@ -378,7 +384,7 @@ globalThis.describe("visibility filtering (deployed AutoUI hides Internal)", ()
   });
 });
 
-globalThis.describe("allowedStates + statusField populated", () => {
+globalThis.describe("allowedStates + lifecycleField populated", () => {
   let cmdWithStates_aggregateIdField = "id";
   let cmdWithStates_references = [];
   let cmdWithStates_allowedStates = ["Inactive"];
@@ -401,7 +407,7 @@ globalThis.describe("allowedStates + statusField populated", () => {
   let qblWithStatus_linkedWriteSide = ["Plugin"];
   let qblWithStatus_searchableFields = ["name"];
   let qblWithStatus_labelFieldSource = "convention";
-  let qblWithStatus_statusField = "status";
+  let qblWithStatus_lifecycleField = "status";
   let qblWithStatus_singleQueryField = "Platform_Plugin";
   let qblWithStatus = {
     name: "Plugin",
@@ -412,8 +418,10 @@ globalThis.describe("allowedStates + statusField populated", () => {
     labelField: "name",
     searchableFields: qblWithStatus_searchableFields,
     labelFieldSource: qblWithStatus_labelFieldSource,
-    statusField: qblWithStatus_statusField,
+    lifecycleField: qblWithStatus_lifecycleField,
     ownerField: undefined,
+    retiredField: undefined,
+    retiredValues: undefined,
     visibility: undefined,
     chapter: undefined,
     singleQueryField: qblWithStatus_singleQueryField,
@@ -466,8 +474,8 @@ globalThis.describe("allowedStates + statusField populated", () => {
   globalThis.test("round-trips a declared targetState as the status string", () => {
     globalThis.expect(json.includes("\"targetState\":\"Active\"")).toEqual(true);
   });
-  globalThis.test("encodes populated statusField as the field name string", () => {
-    globalThis.expect(json.includes("\"statusField\":\"status\"")).toEqual(true);
+  globalThis.test("encodes populated lifecycleField as the field name string", () => {
+    globalThis.expect(json.includes("\"lifecycleField\":\"status\"")).toEqual(true);
   });
   globalThis.test("encodes a component with no declared errors as an empty array, not null", () => {
     globalThis.expect(json.includes("\"errors\":[]")).toEqual(true);
@@ -491,8 +499,10 @@ globalThis.describe("singleQueryField reaches the caller", () => {
           labelField: "displayName",
           searchableFields: qbl_searchableFields,
           labelFieldSource: "annotation",
-          statusField: undefined,
+          lifecycleField: undefined,
           ownerField: undefined,
+          retiredField: undefined,
+          retiredValues: undefined,
           visibility: undefined,
           chapter: undefined,
           singleQueryField: undefined,
@@ -536,8 +546,10 @@ globalThis.describe("idField / idFieldSource reach the caller", () => {
           labelField: "displayName",
           searchableFields: qbl_searchableFields,
           labelFieldSource: "annotation",
-          statusField: undefined,
+          lifecycleField: undefined,
           ownerField: undefined,
+          retiredField: undefined,
+          retiredValues: undefined,
           visibility: undefined,
           chapter: undefined,
           singleQueryField: "Catalog_Product",

package/tests/admin/Platform_PluginStructuresApiTest.res

@@ -16,7 +16,7 @@ let publicRm: queryableDef = {
   labelField: "displayName",
   searchableFields: ["displayName"],
   labelFieldSource: Some("annotation"),
-  statusField: None,
+  lifecycleField: None,
   visibility: None,
   chapter: Some("Inventory"),
   singleQueryField: Some("Catalog_Product"),
@@ -24,6 +24,8 @@ let publicRm: queryableDef = {
   idFieldSource: Some("convention"),
   requiredAccess: None,
   ownerField: None,
+  retiredField: None,
+  retiredValues: None,
 }
 
 // The component `Platform_ComponentDefinitions` drops and this query must keep.

package/tests/admin/Platform_PluginStructuresApiTest.res.mjs

@@ -31,8 +31,10 @@ let publicRm = {
   labelField: "displayName",
   searchableFields: publicRm_searchableFields,
   labelFieldSource: publicRm_labelFieldSource,
-  statusField: undefined,
+  lifecycleField: undefined,
   ownerField: undefined,
+  retiredField: undefined,
+  retiredValues: undefined,
   visibility: undefined,
   chapter: publicRm_chapter,
   singleQueryField: publicRm_singleQueryField,
@@ -68,8 +70,10 @@ let internalRm = {
   labelField: "displayName",
   searchableFields: internalRm_searchableFields,
   labelFieldSource: internalRm_labelFieldSource,
-  statusField: undefined,
+  lifecycleField: undefined,
   ownerField: undefined,
+  retiredField: undefined,
+  retiredValues: undefined,
   visibility: internalRm_visibility,
   chapter: internalRm_chapter,
   singleQueryField: internalRm_singleQueryField,

package/tests/api/Api_IdsTest.res.mjs

@@ -77,7 +77,7 @@ globalThis.describe("filter.ids matches whichever form each side holds", () => {
         "ids",
         filterIds.map(prim => prim)
       ]]);
-    let conn = QueryDbListQuery$ReventlessCore.run([row(rowId)], args, GraphQL_FragmentGenerator$ReventlessCore.emptyCapability, "name", undefined, undefined);
+    let conn = QueryDbListQuery$ReventlessCore.run([row(rowId)], args, GraphQL_FragmentGenerator$ReventlessCore.emptyCapability, "name", undefined, undefined, undefined);
     return Stdlib_Option.getOr(Stdlib_Option.flatMap(Stdlib_Option.flatMap(Stdlib_JSON.Decode.object(conn), d => d["edges"]), Stdlib_JSON.Decode.array), []).length;
   };
   globalThis.test("storage key row, storage key filter", () => {

package/tests/api/SuryToJsonSchemaTest.res

@@ -31,10 +31,11 @@ let emptySpec: Reventless.StateAnnotations.stateAnnotationSpec = {
   scanSort: [],
   semantic: [],
   metric: [],
-  status: None,
+  lifecycle: None,
   groupBy: None,
   visibility: None,
   live: None,
+  retired: None,
 }
 
 describe("SuryToJsonSchema:", () => {
@@ -420,6 +421,145 @@ describe("SuryToJsonSchema:", () => {
       ))->toEqual((Some("sum"), None))
     })
 
+    testSync("emits x-reventless-retired {label,showWhenFalse} on the retired field", () => {
+      let schema = S.schema(s =>
+        {
+          "id": s.matches(S.string),
+          "archived": s.matches(S.bool),
+        }
+      )->S.castToUnknown
+      let schema' =
+        schema->withSpec({
+          ...emptySpec,
+          retired: Some({field: "archived", label: "Archived", showWhenFalse: true, values: None}),
+        })
+      let json = SuryToJsonSchema.deriveObjectSchema(schema')
+      let retiredObj =
+        getPropertyOf(json, "archived")->Option.flatMap(s => getProperty(s, "x-reventless-retired"))
+      expect((
+        retiredObj->Option.flatMap(r => getProperty(r, "label"))->Option.flatMap(JSON.Decode.string),
+        retiredObj
+        ->Option.flatMap(r => getProperty(r, "showWhenFalse"))
+        ->Option.flatMap(JSON.Decode.bool),
+        // Only the named field carries it.
+        getPropertyOf(json, "id")->Option.flatMap(s => getProperty(s, "x-reventless-retired")),
+      ))->toEqual((Some("Archived"), Some(true), None))
+    })
+
+    // The state form. `values` is what tells a consumer which of the two forms a
+    // view declared, so it travels on the same key and only when present.
+    let stateFormJson = (~values: array<string>) => {
+      let schema = S.schema(s =>
+        {
+          "customerId": s.matches(S.string),
+          "accountStatus": s.matches(S.union([S.literal("Active"), S.literal("Deactivated")])),
+        }
+      )->S.castToUnknown
+      schema
+      ->withSpec({
+        ...emptySpec,
+        lifecycle: Some("accountStatus"),
+        retired: Some({
+          field: "accountStatus",
+          label: "",
+          showWhenFalse: false,
+          values: Some(values),
+        }),
+      })
+      ->SuryToJsonSchema.deriveObjectSchema
+    }
+
+    let retiredOn = (json, field) =>
+      getPropertyOf(json, field)->Option.flatMap(s => getProperty(s, "x-reventless-retired"))
+
+    let stringsAt = (retiredObj, key) =>
+      retiredObj
+      ->Option.flatMap(r => getProperty(r, key))
+      ->Option.flatMap(JSON.Decode.array)
+      ->Option.map(a => a->Array.filterMap(JSON.Decode.string))
+
+    testSync("carries one retirement state as a one-element set", () => {
+      expect(
+        stateFormJson(~values=["Deactivated"])->retiredOn("accountStatus")->stringsAt("values"),
+      )->toEqual(Some(["Deactivated"]))
+    })
+
+    testSync("carries every retirement state a lifecycle declares", () => {
+      expect(
+        stateFormJson(~values=["Archived", "Discontinued"])
+        ->retiredOn("accountStatus")
+        ->stringsAt("values"),
+      )->toEqual(Some(["Archived", "Discontinued"]))
+    })
+
+    // The transitional key, for one release. A consumer pinned before the set
+    // degrades to nothing at all rather than to a missing badge — and enforcement
+    // never depended on it, so the whole of the lag is cosmetic either way.
+    testSync("emits the singular value beside a one-element set", () => {
+      expect(
+        stateFormJson(~values=["Deactivated"])
+        ->retiredOn("accountStatus")
+        ->Option.flatMap(r => getProperty(r, "value"))
+        ->Option.flatMap(JSON.Decode.string),
+      )->toEqual(Some("Deactivated"))
+    })
+
+    // There is no singular reading of two states, so the shim simply stops. A
+    // consumer that understands only `value` sees no retirement rather than one
+    // of the two picked arbitrarily.
+    testSync("omits the singular value for a set of two", () => {
+      expect(
+        stateFormJson(~values=["Archived", "Discontinued"])
+        ->retiredOn("accountStatus")
+        ->Option.flatMap(r => getProperty(r, "value")),
+      )->toEqual(None)
+    })
+
+    // Absent rather than null: a consumer reads the key's absence as "the boolean
+    // form", the same way it reads an absent label as "derive one from the name".
+    testSync("omits both value and values entirely on the boolean form", () => {
+      let schema = S.schema(s => {"archived": s.matches(S.bool)})->S.castToUnknown
+      let schema' =
+        schema->withSpec({
+          ...emptySpec,
+          retired: Some({field: "archived", label: "", showWhenFalse: false, values: None}),
+        })
+      let json = SuryToJsonSchema.deriveObjectSchema(schema')
+      let retiredObj = json->retiredOn("archived")
+      expect((
+        retiredObj->Option.flatMap(r => getProperty(r, "value")),
+        retiredObj->Option.flatMap(r => getProperty(r, "values")),
+      ))->toEqual((None, None))
+    })
+
+    testSync("omits the retired label when empty but always states showWhenFalse", () => {
+      let schema = S.schema(s => {"deactivated": s.matches(S.bool)})->S.castToUnknown
+      let schema' =
+        schema->withSpec({
+          ...emptySpec,
+          retired: Some({field: "deactivated", label: "", showWhenFalse: false, values: None}),
+        })
+      let json = SuryToJsonSchema.deriveObjectSchema(schema')
+      let retiredObj =
+        getPropertyOf(json, "deactivated")->Option.flatMap(s =>
+          getProperty(s, "x-reventless-retired")
+        )
+      expect((
+        retiredObj->Option.flatMap(r => getProperty(r, "label")),
+        retiredObj
+        ->Option.flatMap(r => getProperty(r, "showWhenFalse"))
+        ->Option.flatMap(JSON.Decode.bool),
+      ))->toEqual((None, Some(false)))
+    })
+
+    testSync("emits nothing for a schema with no retired annotation", () => {
+      let schema = S.schema(s => {"archived": s.matches(S.bool)})->S.castToUnknown
+      let json = SuryToJsonSchema.deriveObjectSchema(schema->withSpec(emptySpec))
+      expect(
+        getPropertyOf(json, "archived")->Option.flatMap(s => getProperty(s, "x-reventless-retired")),
+      )->toBe(None)
+    })
+
     testSync("emits x-reventless-group-by on the field named by groupBy", () => {
       let schema = S.schema(s =>
         {