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

package/tests/api/SuryToJsonSchemaTest.res.mjs

@@ -80,10 +80,11 @@ let emptySpec = {
   scanSort: emptySpec_scanSort,
   semantic: emptySpec_semantic,
   metric: emptySpec_metric,
-  status: undefined,
+  lifecycle: undefined,
   groupBy: undefined,
   visibility: undefined,
-  live: undefined
+  live: undefined,
+  retired: undefined
 };
 
 globalThis.describe("SuryToJsonSchema:", () => {
@@ -151,10 +152,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let entityIdSchema = getPropertyOf(json, "entityId");
@@ -184,10 +186,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let envSchema = getPropertyOf(json, "environment");
@@ -220,10 +223,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let versionSchema = getPropertyOf(json, "version");
@@ -252,10 +256,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let ownerIdSchema = getPropertyOf(json, "ownerId");
@@ -284,10 +289,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let categorySchema = getPropertyOf(json, "category");
@@ -313,10 +319,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let nameSchema = getPropertyOf(json, "name");
@@ -342,10 +349,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let deploymentIdSchema = getPropertyOf(json, "deploymentId");
@@ -378,10 +386,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let pluginNameSchema = getPropertyOf(json, "pluginName");
@@ -417,10 +426,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let componentsSchema = getPropertyOf(json, "components");
@@ -459,10 +469,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let componentsSchema = getPropertyOf(json, "components");
@@ -491,10 +502,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let componentsSchema = getPropertyOf(json, "components");
@@ -520,10 +532,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let statusSchema = getPropertyOf(json, "status");
@@ -556,10 +569,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: ["name"],
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let nameSchema = getPropertyOf(json, "name");
@@ -595,10 +609,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
             "currency"
           ]],
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let totalSchema = getPropertyOf(json, "total");
@@ -637,10 +652,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
               label: "Revenue"
             }
           ]],
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let metricObj = Stdlib_Option.flatMap(getPropertyOf(json, "total"), s => getProperty(s, "x-reventless-metric"));
@@ -677,10 +693,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
               label: ""
             }
           ]],
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let metricObj = Stdlib_Option.flatMap(getPropertyOf(json, "total"), s => getProperty(s, "x-reventless-metric"));
@@ -692,6 +709,194 @@ globalThis.describe("SuryToJsonSchema:", () => {
         undefined
       ]);
     });
+    globalThis.test("emits x-reventless-retired {label,showWhenFalse} on the retired field", () => {
+      let schema = S.schema(s => ({
+        id: s.m(S.string),
+        archived: s.m(S.bool)
+      }));
+      let schema$p = withSpec(schema, {
+        ids: emptySpec_ids,
+        compositeIds: emptySpec_compositeIds,
+        subIds: emptySpec_subIds,
+        compositeSubIds: emptySpec_compositeSubIds,
+        indexes: emptySpec_indexes,
+        hidden: emptySpec_hidden,
+        summary: emptySpec_summary,
+        drillTargets: emptySpec_drillTargets,
+        drillTargetKeys: emptySpec_drillTargetKeys,
+        collapsed: emptySpec_collapsed,
+        scan: emptySpec_scan,
+        scanSort: emptySpec_scanSort,
+        semantic: emptySpec_semantic,
+        metric: emptySpec_metric,
+        lifecycle: undefined,
+        groupBy: undefined,
+        visibility: undefined,
+        live: undefined,
+        retired: {
+          field: "archived",
+          label: "Archived",
+          showWhenFalse: true,
+          values: undefined
+        }
+      });
+      let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
+      let retiredObj = Stdlib_Option.flatMap(getPropertyOf(json, "archived"), s => getProperty(s, "x-reventless-retired"));
+      globalThis.expect([
+        Stdlib_Option.flatMap(Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "label")), Stdlib_JSON.Decode.string),
+        Stdlib_Option.flatMap(Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "showWhenFalse")), Stdlib_JSON.Decode.bool),
+        Stdlib_Option.flatMap(getPropertyOf(json, "id"), s => getProperty(s, "x-reventless-retired"))
+      ]).toEqual([
+        "Archived",
+        true,
+        undefined
+      ]);
+    });
+    let stateFormJson = values => {
+      let schema = S.schema(s => ({
+        customerId: s.m(S.string),
+        accountStatus: s.m(S.union([
+          S.literal("Active"),
+          S.literal("Deactivated")
+        ]))
+      }));
+      return SuryToJsonSchema$ReventlessCore.deriveObjectSchema(withSpec(schema, {
+        ids: emptySpec_ids,
+        compositeIds: emptySpec_compositeIds,
+        subIds: emptySpec_subIds,
+        compositeSubIds: emptySpec_compositeSubIds,
+        indexes: emptySpec_indexes,
+        hidden: emptySpec_hidden,
+        summary: emptySpec_summary,
+        drillTargets: emptySpec_drillTargets,
+        drillTargetKeys: emptySpec_drillTargetKeys,
+        collapsed: emptySpec_collapsed,
+        scan: emptySpec_scan,
+        scanSort: emptySpec_scanSort,
+        semantic: emptySpec_semantic,
+        metric: emptySpec_metric,
+        lifecycle: "accountStatus",
+        groupBy: undefined,
+        visibility: undefined,
+        live: undefined,
+        retired: {
+          field: "accountStatus",
+          label: "",
+          showWhenFalse: false,
+          values: values
+        }
+      }));
+    };
+    let retiredOn = (json, field) => Stdlib_Option.flatMap(getPropertyOf(json, field), s => getProperty(s, "x-reventless-retired"));
+    let stringsAt = (retiredObj, key) => Stdlib_Option.map(Stdlib_Option.flatMap(Stdlib_Option.flatMap(retiredObj, r => getProperty(r, key)), Stdlib_JSON.Decode.array), a => Stdlib_Array.filterMap(a, Stdlib_JSON.Decode.string));
+    globalThis.test("carries one retirement state as a one-element set", () => {
+      globalThis.expect(stringsAt(retiredOn(stateFormJson(["Deactivated"]), "accountStatus"), "values")).toEqual(["Deactivated"]);
+    });
+    globalThis.test("carries every retirement state a lifecycle declares", () => {
+      globalThis.expect(stringsAt(retiredOn(stateFormJson([
+        "Archived",
+        "Discontinued"
+      ]), "accountStatus"), "values")).toEqual([
+        "Archived",
+        "Discontinued"
+      ]);
+    });
+    globalThis.test("emits the singular value beside a one-element set", () => {
+      globalThis.expect(Stdlib_Option.flatMap(Stdlib_Option.flatMap(retiredOn(stateFormJson(["Deactivated"]), "accountStatus"), r => getProperty(r, "value")), Stdlib_JSON.Decode.string)).toEqual("Deactivated");
+    });
+    globalThis.test("omits the singular value for a set of two", () => {
+      globalThis.expect(Stdlib_Option.flatMap(retiredOn(stateFormJson([
+        "Archived",
+        "Discontinued"
+      ]), "accountStatus"), r => getProperty(r, "value"))).toEqual(undefined);
+    });
+    globalThis.test("omits both value and values entirely on the boolean form", () => {
+      let schema = S.schema(s => ({
+        archived: s.m(S.bool)
+      }));
+      let schema$p = withSpec(schema, {
+        ids: emptySpec_ids,
+        compositeIds: emptySpec_compositeIds,
+        subIds: emptySpec_subIds,
+        compositeSubIds: emptySpec_compositeSubIds,
+        indexes: emptySpec_indexes,
+        hidden: emptySpec_hidden,
+        summary: emptySpec_summary,
+        drillTargets: emptySpec_drillTargets,
+        drillTargetKeys: emptySpec_drillTargetKeys,
+        collapsed: emptySpec_collapsed,
+        scan: emptySpec_scan,
+        scanSort: emptySpec_scanSort,
+        semantic: emptySpec_semantic,
+        metric: emptySpec_metric,
+        lifecycle: undefined,
+        groupBy: undefined,
+        visibility: undefined,
+        live: undefined,
+        retired: {
+          field: "archived",
+          label: "",
+          showWhenFalse: false,
+          values: undefined
+        }
+      });
+      let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
+      let retiredObj = retiredOn(json, "archived");
+      globalThis.expect([
+        Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "value")),
+        Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "values"))
+      ]).toEqual([
+        undefined,
+        undefined
+      ]);
+    });
+    globalThis.test("omits the retired label when empty but always states showWhenFalse", () => {
+      let schema = S.schema(s => ({
+        deactivated: s.m(S.bool)
+      }));
+      let schema$p = withSpec(schema, {
+        ids: emptySpec_ids,
+        compositeIds: emptySpec_compositeIds,
+        subIds: emptySpec_subIds,
+        compositeSubIds: emptySpec_compositeSubIds,
+        indexes: emptySpec_indexes,
+        hidden: emptySpec_hidden,
+        summary: emptySpec_summary,
+        drillTargets: emptySpec_drillTargets,
+        drillTargetKeys: emptySpec_drillTargetKeys,
+        collapsed: emptySpec_collapsed,
+        scan: emptySpec_scan,
+        scanSort: emptySpec_scanSort,
+        semantic: emptySpec_semantic,
+        metric: emptySpec_metric,
+        lifecycle: undefined,
+        groupBy: undefined,
+        visibility: undefined,
+        live: undefined,
+        retired: {
+          field: "deactivated",
+          label: "",
+          showWhenFalse: false,
+          values: undefined
+        }
+      });
+      let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
+      let retiredObj = Stdlib_Option.flatMap(getPropertyOf(json, "deactivated"), s => getProperty(s, "x-reventless-retired"));
+      globalThis.expect([
+        Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "label")),
+        Stdlib_Option.flatMap(Stdlib_Option.flatMap(retiredObj, r => getProperty(r, "showWhenFalse")), Stdlib_JSON.Decode.bool)
+      ]).toEqual([
+        undefined,
+        false
+      ]);
+    });
+    globalThis.test("emits nothing for a schema with no retired annotation", () => {
+      let schema = S.schema(s => ({
+        archived: s.m(S.bool)
+      }));
+      let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(withSpec(schema, emptySpec));
+      globalThis.expect(Stdlib_Option.flatMap(getPropertyOf(json, "archived"), s => getProperty(s, "x-reventless-retired"))).toBe(undefined);
+    });
     globalThis.test("emits x-reventless-group-by on the field named by groupBy", () => {
       let schema = S.schema(s => ({
         id: s.m(S.string),
@@ -712,10 +917,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: "kind",
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let kindSchema = getPropertyOf(json, "kind");
@@ -748,10 +954,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       let primarySchema = getPropertyOf(json, "primaryResource");
@@ -783,10 +990,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: "Internal",
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       globalThis.expect(Stdlib_Option.flatMap(getProperty(json, "x-reventless-visibility"), Stdlib_JSON.Decode.string)).toBe("Internal");
@@ -810,10 +1018,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       globalThis.expect(getProperty(json, "x-reventless-visibility")).toBe(undefined);
@@ -837,10 +1046,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: false
+        live: false,
+        retired: undefined
       }));
       let onJson = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(withSpec(schema, {
         ids: emptySpec_ids,
@@ -857,10 +1067,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: true
+        live: true,
+        retired: undefined
       }));
       globalThis.expect([
         Stdlib_Option.flatMap(getProperty(offJson, "x-reventless-live"), Stdlib_JSON.Decode.bool),
@@ -889,10 +1100,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       globalThis.expect(getProperty(json, "x-reventless-live")).toBe(undefined);
@@ -916,10 +1128,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: "Internal",
-        live: false
+        live: false,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema$p);
       globalThis.expect([
@@ -989,10 +1202,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
         scanSort: emptySpec_scanSort,
         semantic: emptySpec_semantic,
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let native = S.toJSONSchema(schema$p);
       let entityIdSchema = getPropertyOf(native, "entityId");
@@ -1100,10 +1314,11 @@ globalThis.describe("SuryToJsonSchema:", () => {
             "image"
           ]],
         metric: emptySpec_metric,
-        status: undefined,
+        lifecycle: undefined,
         groupBy: undefined,
         visibility: undefined,
-        live: undefined
+        live: undefined,
+        retired: undefined
       });
       let json = SuryToJsonSchema$ReventlessCore.deriveObjectSchema(schema);
       globalThis.expect(semanticOf(json, "imageUrl")).toEqual("storageRef");