feat(widget-plugin-test-utils): rename functions

Author: iobuhov

Diff for: packages/shared/widget-plugin-test-utils/__tests__/functions.test.ts

@@ -1,4 +1,15 @@
-import { listAttr, obj, ref, refSet, list, listAction, listRef, listRefSet, objArray, cases } from "../src/main";
+import {
+    listAttribute,
+    obj,
+    reference,
+    referenceSet,
+    list,
+    listAction,
+    listReference,
+    listReferenceSet,
+    objArray,
+    cases
+} from "../src/main";
 
 describe("prop mocking functions", () => {
     describe("list", () => {
@@ -26,15 +37,15 @@ describe("prop mocking functions", () => {
         });
     });
 
-    describe("listAttr", () => {
+    describe("listAttribute", () => {
         it("returns ListAttributeValue mock", () => {
             const t: Date = new Date("2024-09-01T00:00:00.000Z");
-            const attr = listAttr(() => new Date(t));
+            const attr = listAttribute(() => new Date(t));
             expect(attr.get(obj()).value!).toEqual(t);
         });
     });
 
-    describe("listExp", () => {
+    describe("listExpression", () => {
         it.todo("returns ListExpressionValue mock");
     });
 
@@ -44,7 +55,7 @@ describe("prop mocking functions", () => {
 
     describe("ref", () => {
         it("returns ReferenceValue mock with undefined value", () => {
-            const ref1 = ref();
+            const ref1 = reference();
             expect(ref1).toMatchObject({
                 readOnly: false,
                 status: "available",
@@ -57,7 +68,7 @@ describe("prop mocking functions", () => {
         });
 
         it("take factory as first argument", () => {
-            const ref1 = ref(builder => builder.withValue(obj("0")).isLoading().build());
+            const ref1 = reference(builder => builder.withValue(obj("0")).isLoading().build());
             expect(ref1).toMatchObject({
                 readOnly: true,
                 status: "loading",
@@ -70,7 +81,7 @@ describe("prop mocking functions", () => {
 
     describe("refSet", () => {
         it("returns ReferenceSetValue mock with undefined value", () => {
-            const ref1 = refSet();
+            const ref1 = referenceSet();
             expect(ref1).toMatchObject({
                 readOnly: false,
                 status: "available",
@@ -83,7 +94,7 @@ describe("prop mocking functions", () => {
         });
 
         it("take factory as first argument", () => {
-            const ref1 = refSet(builder =>
+            const ref1 = referenceSet(builder =>
                 builder
                     .withValue([obj("0")])
                     .isLoading()
@@ -99,17 +110,17 @@ describe("prop mocking functions", () => {
         });
 
         it("returns mock with working setValue", () => {
-            const ref1 = refSet();
+            const ref1 = referenceSet();
             ref1.setValue([obj("007")]);
             expect(ref1.value).toEqual([obj("007")]);
             ref1.setValue([obj("939")]);
             expect(ref1.value).toEqual([obj("939")]);
         });
     });
 
-    describe("listRef", () => {
+    describe("listReference", () => {
         it("returns ListReferenceValue mock", () => {
-            const prop = listRef();
+            const prop = listReference();
             expect(prop).toMatchObject({
                 type: "Reference",
                 filterable: true,
@@ -126,9 +137,9 @@ describe("prop mocking functions", () => {
         });
     });
 
-    describe("listRefSet", () => {
+    describe("listReferenceSet", () => {
         it("returns ListReferenceSetValue mock", () => {
-            const prop = listRefSet();
+            const prop = listReferenceSet();
             expect(prop).toMatchObject({
                 type: "ReferenceSet",
                 filterable: true,
@@ -171,7 +182,7 @@ describe("prop mocking functions", () => {
             const mapFn = cases([a, "Alice"], [b, "Bob"], [c, "Chuck"], [undefined, "None"]);
             const props = {
                 datasource: list(items),
-                name: listAttr(mapFn)
+                name: listAttribute(mapFn)
             };
 
             expect(props.datasource.items?.map(item => props.name.get(item).value)).toEqual([

Diff for: packages/shared/widget-plugin-test-utils/src/functions/list.ts

@@ -1,6 +1,11 @@
 import { ListValue, ObjectItem } from "mendix";
 import { ListValueBuilder } from "../builders/ListValueBuilder";
 
+/**
+ * Returns `ListValue` mock.
+ * @param arg - ether `number` or array of `ObjectItem`.
+ * If number is given, fill `.items` with mock obj array. Array size depends on the number.
+ */
 export function list(arg: number | ObjectItem[]): ListValue {
     let builder = new ListValueBuilder();
     if (Array.isArray(arg)) {
@@ -10,3 +15,8 @@ export function list(arg: number | ObjectItem[]): ListValue {
     }
     return builder.build();
 }
+
+/**
+ * Returns `ListValue` with loading status.
+ */
+list.loading = () => new ListValueBuilder().isLoading().build();

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listAttr.ts renamed to packages/shared/widget-plugin-test-utils/src/functions/listAttribute.ts

@@ -2,8 +2,17 @@ import { ListAttributeValue, ObjectItem } from "mendix";
 import { ListAttributeValueBuilder } from "../builders/ListAttributeValueBuilder";
 import { editable } from "../primitives/editable";
 
-export function listAttr<T extends string | boolean | Date | Big>(get: (item: ObjectItem) => T): ListAttributeValue<T> {
+/**
+ * Returns `ListAttributeValue` mock.
+ * @param get - function to use as `.get`. Should map item to value.
+ */
+export function listAttribute<T extends string | boolean | Date | Big>(
+    get: (item: ObjectItem) => T
+): ListAttributeValue<T> {
     const attr = new ListAttributeValueBuilder<T>().build();
     attr.get = jest.fn((item: ObjectItem) => editable<T>(b => b.withValue(get(item)).isReadOnly().build()));
     return attr;
 }
+
+/** @deprecated Renamed to `listAttribute`. */
+export const listAttr = listAttribute;

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listExp.ts

@@ -0,0 +1,15 @@
+import { ListExpressionValue, ObjectItem } from "mendix";
+import { dynamic } from "../primitives/dynamic";
+
+/**
+ * Returns `ListExpressionValue` mock.
+ * @param get - function to use as `.get`. Should map item to value.
+ */
+export function listExpression<T extends string | boolean | Date | Big>(
+    get: (item: ObjectItem) => T
+): ListExpressionValue<T> {
+    return { get: (item: ObjectItem) => dynamic<T>(get(item)) };
+}
+
+/** @deprecated Renamed to `listExpression` */
+export const listExp = listExpression;

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listExpression.ts

@@ -2,11 +2,13 @@ import { ListReferenceValue } from "mendix";
 import { ListReferenceValueBuilder } from "../builders/ListReferenceValueBuilder";
 
 /**
- * Short function to mock ListReferenceValue.
+ * Short function to mock `ListReferenceValue`.
  * @param factory - optional factory function which takes
- * ListReferenceValueBuilder as first argument and returns new ReferenceValue.
+ * ListReferenceValueBuilder as first argument and returns new `ListReferenceValue`.
  */
-export function listRef(factory?: (builder: ListReferenceValueBuilder) => ListReferenceValue): ListReferenceValue {
+export function listReference(
+    factory?: (builder: ListReferenceValueBuilder) => ListReferenceValue
+): ListReferenceValue {
     factory ??= builder => builder.build();
     return factory(new ListReferenceValueBuilder());
 }

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listRef.ts

@@ -2,11 +2,11 @@ import { ListReferenceSetValue } from "mendix";
 import { ListReferenceSetValueBuilder } from "../builders/ListReferenceSetValueBuilder";
 
 /**
- * Short function to mock ListReferenceSetValue.
+ * Short function to mock `ListReferenceSetValue`.
  * @param factory - optional factory function which takes
- * ListReferenceSetValueBuilder as first argument and returns new ReferenceValue.
+ * ListReferenceSetValueBuilder as first argument and returns new `ListReferenceSetValue`.
  */
-export function listRefSet(
+export function listReferenceSet(
     factory?: (builder: ListReferenceSetValueBuilder) => ListReferenceSetValue
 ): ListReferenceSetValue {
     factory ??= builder => builder.build();

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listRefSet.ts renamed to packages/shared/widget-plugin-test-utils/src/functions/listReferenceSet.ts

@@ -1,5 +1,9 @@
 import { ListWidgetValue, ObjectItem } from "mendix";
 
+/**
+ * Returns `ListWidgetValue` mock.
+ * @param get - function to use as `.get`. Should map item to React node.
+ */
 export function listWidget(get: (item: ObjectItem) => React.ReactNode): ListWidgetValue {
-    return { get } as unknown as ListWidgetValue;
+    return { get } as ListWidgetValue;
 }

Diff for: packages/shared/widget-plugin-test-utils/src/functions/listWidget.ts

@@ -2,11 +2,11 @@ import { ReferenceValue } from "mendix";
 import { ReferenceValueBuilder } from "../builders/ReferenceValueBuilder";
 
 /**
- * Short function to mock ReferenceValue.
+ * Short function to mock `ReferenceValue`.
  * @param factory - optional factory function which takes
- * ReferenceValueBuilder as first argument and returns new ReferenceValue.
+ * ReferenceValueBuilder as first argument and returns new `ReferenceValue`.
  */
-export function ref(factory?: (builder: ReferenceValueBuilder) => ReferenceValue): ReferenceValue {
+export function reference(factory?: (builder: ReferenceValueBuilder) => ReferenceValue): ReferenceValue {
     factory ??= builder => builder.build();
     return factory(new ReferenceValueBuilder());
 }

Diff for: packages/shared/widget-plugin-test-utils/src/functions/ref.ts renamed to packages/shared/widget-plugin-test-utils/src/functions/reference.ts

@@ -2,11 +2,11 @@ import { ReferenceSetValue } from "mendix";
 import { ReferenceSetValueBuilder } from "../builders/ReferenceSetValueBuilder";
 
 /**
- * Short function to mock ReferenceSetValue.
+ * Short function to mock `ReferenceSetValue`.
  * @param factory - optional factory function which takes
- * ReferenceSetValueBuilder as first argument and returns new ReferenceValue.
+ * ReferenceSetValueBuilder as first argument and returns new `ReferenceSetValue`.
  */
-export function refSet(factory?: (builder: ReferenceSetValueBuilder) => ReferenceSetValue): ReferenceSetValue {
+export function referenceSet(factory?: (builder: ReferenceSetValueBuilder) => ReferenceSetValue): ReferenceSetValue {
     factory ??= builder => builder.build();
     return factory(new ReferenceSetValueBuilder());
 }

Diff for: packages/shared/widget-plugin-test-utils/src/functions/refSet.ts renamed to packages/shared/widget-plugin-test-utils/src/functions/referenceSet.ts

@@ -8,13 +8,13 @@ export * from "./builders/SelectionMultiValueBuilder.js";
 export * from "./functions/cases.js";
 export * from "./functions/list.js";
 export * from "./functions/listAction.js";
-export * from "./functions/listAttr.js";
-export * from "./functions/listExp.js";
+export * from "./functions/listAttribute.js";
+export * from "./functions/listExpression.js";
 export * from "./functions/listRef.js";
-export * from "./functions/listRefSet.js";
+export * from "./functions/listReferenceSet.js";
 export * from "./functions/listWidget.js";
-export * from "./functions/ref.js";
-export * from "./functions/refSet.js";
+export * from "./functions/reference.js";
+export * from "./functions/referenceSet.js";
 export * from "./primitives/action.js";
 export * from "./primitives/attrId.js";
 export * from "./primitives/dynamic.js";