@planet-matrix/mobius-model 0.5.0 → 0.9.0

package/tests/unit/form/inputor-controller/base.spec.ts

@@ -0,0 +1,458 @@
+import { expect, test, vi } from "vitest"
+
+import type {
+  BaseInputorContext,
+  BaseInputorControllerOptions,
+  BaseInputorSchema,
+} from "#Source/form/index.ts"
+import { BaseInputorController } from "#Source/form/index.ts"
+
+const TEST_INPUTOR_TYPE_NAME = "test" as const
+
+type TestExternalValue = string | undefined
+type TestInternalValue = string | undefined
+
+interface TestInputorSchema extends BaseInputorSchema<TestExternalValue> {
+  inputorTypeName: typeof TEST_INPUTOR_TYPE_NAME
+}
+
+interface TestInputorContext extends BaseInputorContext<TestExternalValue, TestInternalValue> {
+}
+
+interface TestInputorControllerOptions extends BaseInputorControllerOptions<TestExternalValue, TestInputorSchema> {
+}
+
+class TestInputorController extends BaseInputorController<
+  TestExternalValue,
+  TestInternalValue,
+  TestInputorSchema,
+  TestInputorContext
+> {
+  declare schemaType: TestInputorSchema
+  declare optionsType: TestInputorControllerOptions
+  declare constructorType: typeof TestInputorController
+
+  static inputorTypeName = TEST_INPUTOR_TYPE_NAME
+
+  inputorTypeName = TEST_INPUTOR_TYPE_NAME
+  protected voidExternalValue = undefined
+  protected voidInternalValue = undefined
+
+  protected override async constrainExternalValue(value: TestExternalValue): Promise<TestExternalValue> {
+    if (value === undefined) {
+      return await Promise.resolve(undefined)
+    }
+    return await Promise.resolve(value.trim())
+  }
+
+  protected override async constrainInternalValue(value: TestInternalValue): Promise<TestInternalValue> {
+    if (value === undefined) {
+      return await Promise.resolve(undefined)
+    }
+    return await Promise.resolve(value.trim())
+  }
+}
+
+const createTestInputor = (
+  overrides: Partial<TestInputorControllerOptions> = {},
+): TestInputorController => {
+  return new TestInputorController({
+    id: "test-id",
+    name: "test-name",
+    placeholder: "test-placeholder",
+    value: " initial ",
+    ...overrides,
+  })
+}
+
+test("BaseInputorController.isReady and waitForReady initialize defaults and emit initial hooks", async () => {
+  const valueChanges: Array<{ newValue: TestExternalValue; oldValue: TestExternalValue }> = []
+  const schemaChanges: Array<{ newSchema: TestInputorSchema; oldSchema: TestInputorSchema }> = []
+  const controller = createTestInputor({
+    onValueChange: (context) => {
+      valueChanges.push(context)
+    },
+    onSchemaChange: (context) => {
+      schemaChanges.push(context)
+    },
+  })
+
+  expect(controller.isReady()).toBe(false)
+
+  await controller.waitForReady()
+
+  expect(controller.isReady()).toBe(true)
+  expect(await controller.getSchema()).toEqual({
+    inputorTypeName: TEST_INPUTOR_TYPE_NAME,
+    id: "test-id",
+    name: "test-name",
+    placeholder: "test-placeholder",
+    value: "initial",
+    isVoid: false,
+    isFocused: false,
+    isTouched: false,
+    isDirty: false,
+    isDisabled: false,
+    isDebugMode: false,
+  })
+  expect(valueChanges).toEqual([
+    {
+      newValue: "initial",
+      oldValue: "initial",
+    },
+  ])
+  expect(schemaChanges).toHaveLength(1)
+  expect(schemaChanges[0]!.newSchema).toEqual(schemaChanges[0]!.oldSchema)
+  expect(schemaChanges[0]!.newSchema.value).toBe("initial")
+})
+
+test("BaseInputorController.getInternalValue, getContext, and isEqualSchema expose current state", async () => {
+  const controller = createTestInputor({
+    value: " alpha ",
+  })
+
+  await controller.waitForReady()
+
+  expect(controller.getInternalValue()).toBe("alpha")
+  expect(await controller.getContext()).toEqual({
+    inputorTypeName: TEST_INPUTOR_TYPE_NAME,
+    id: "test-id",
+    name: "test-name",
+    placeholder: "test-placeholder",
+    value: "alpha",
+    isVoid: false,
+    isFocused: false,
+    isTouched: false,
+    isDirty: false,
+    isDisabled: false,
+    isDebugMode: false,
+    internalValue: "alpha",
+    isReady: true,
+  })
+  expect(await controller.isEqualSchema({ value: "alpha", placeholder: "test-placeholder" })).toBe(true)
+  expect(await controller.isEqualSchema({ value: "beta" })).toBe(false)
+  expect(await controller.isEqualSchema(null)).toBe(false)
+})
+
+test("BaseInputorController.subscribeInputChange and updateInputValue emit input updates after debounce", async () => {
+  vi.useFakeTimers()
+
+  try {
+    const controller = createTestInputor({
+      value: "start",
+      inputDebounce: 20,
+    })
+    const inputChanges: Array<{ newInput: TestExternalValue; oldInput: TestExternalValue; oldValue: TestExternalValue }> = []
+
+    await controller.waitForReady()
+    controller.subscribeInputChange((context) => {
+      inputChanges.push(context)
+    })
+
+    await controller.updateInputValue(" next ")
+
+    expect(inputChanges).toEqual([])
+
+    await vi.advanceTimersByTimeAsync(20)
+
+    expect(inputChanges).toEqual([
+      {
+        newInput: " next ",
+        oldInput: "start",
+        oldValue: "start",
+      },
+    ])
+  }
+  finally {
+    vi.useRealTimers()
+  }
+})
+
+test("BaseInputorController.unsubscribeInputChange removes one input subscriber", async () => {
+  vi.useFakeTimers()
+
+  try {
+    const controller = createTestInputor({ value: "start" })
+    let calls = 0
+    const subscriber = (): void => {
+      calls = calls + 1
+    }
+
+    await controller.waitForReady()
+    controller.subscribeInputChange(subscriber)
+    controller.unsubscribeInputChange(subscriber)
+
+    await controller.updateInputValue("next")
+    await vi.advanceTimersByTimeAsync(0)
+
+    expect(calls).toBe(0)
+  }
+  finally {
+    vi.useRealTimers()
+  }
+})
+
+test("BaseInputorController.clearInputChangeSubscribers removes all input subscribers", async () => {
+  vi.useFakeTimers()
+
+  try {
+    const controller = createTestInputor({ value: "start" })
+    let calls = 0
+
+    await controller.waitForReady()
+    controller.subscribeInputChange(() => {
+      calls = calls + 1
+    })
+    controller.subscribeInputChange(() => {
+      calls = calls + 1
+    })
+    controller.clearInputChangeSubscribers()
+
+    await controller.updateInputValue("next")
+    await vi.advanceTimersByTimeAsync(0)
+
+    expect(calls).toBe(0)
+  }
+  finally {
+    vi.useRealTimers()
+  }
+})
+
+test("BaseInputorController.subscribeValueChange, applyInputValue, and updateValue emit value changes", async () => {
+  const controller = createTestInputor({ value: "start" })
+  const valueChanges: Array<{ newValue: TestExternalValue; oldValue: TestExternalValue }> = []
+
+  await controller.waitForReady()
+  controller.subscribeValueChange((context) => {
+    valueChanges.push(context)
+  })
+
+  await controller.updateInputValue(" next ")
+  await controller.applyInputValue()
+  await controller.updateValue(" final ")
+
+  expect(valueChanges).toEqual([
+    {
+      newValue: "next",
+      oldValue: "start",
+    },
+    {
+      newValue: "final",
+      oldValue: "next",
+    },
+  ])
+})
+
+test("BaseInputorController.unsubscribeValueChange removes one value subscriber", async () => {
+  const controller = createTestInputor({ value: "start" })
+  let calls = 0
+  const subscriber = (): void => {
+    calls = calls + 1
+  }
+
+  await controller.waitForReady()
+  controller.subscribeValueChange(subscriber)
+  controller.unsubscribeValueChange(subscriber)
+  await controller.updateValue("next")
+
+  expect(calls).toBe(0)
+})
+
+test("BaseInputorController.clearValueChangeSubscribers removes all value subscribers", async () => {
+  const controller = createTestInputor({ value: "start" })
+  let calls = 0
+
+  await controller.waitForReady()
+  controller.subscribeValueChange(() => {
+    calls = calls + 1
+  })
+  controller.subscribeValueChange(() => {
+    calls = calls + 1
+  })
+  controller.clearValueChangeSubscribers()
+  await controller.updateValue("next")
+
+  expect(calls).toBe(0)
+})
+
+test("BaseInputorController.subscribeSchemaChange and updatePlaceholder emit schema changes", async () => {
+  const controller = createTestInputor({ value: "start" })
+  const schemaChanges: Array<{ newSchema: TestInputorSchema; oldSchema: TestInputorSchema }> = []
+
+  await controller.waitForReady()
+  await Promise.resolve()
+  controller.subscribeSchemaChange((context) => {
+    schemaChanges.push(context)
+  })
+  await controller.updatePlaceholder("next-placeholder")
+
+  expect(schemaChanges.length).toBeGreaterThanOrEqual(1)
+  expect(schemaChanges.at(-1)!.oldSchema.placeholder).toBe("test-placeholder")
+  expect(schemaChanges.at(-1)!.newSchema.placeholder).toBe("next-placeholder")
+})
+
+test("BaseInputorController.unsubscribeSchemaChange removes one schema subscriber", async () => {
+  const controller = createTestInputor({ value: "start" })
+  let calls = 0
+  const subscriber = (): void => {
+    calls = calls + 1
+  }
+
+  await controller.waitForReady()
+  controller.subscribeSchemaChange(subscriber)
+  controller.unsubscribeSchemaChange(subscriber)
+  await controller.updatePlaceholder("next-placeholder")
+
+  expect(calls).toBe(0)
+})
+
+test("BaseInputorController.clearSchemaChangeSubscribers removes all schema subscribers", async () => {
+  const controller = createTestInputor({ value: "start" })
+  let calls = 0
+
+  await controller.waitForReady()
+  controller.subscribeSchemaChange(() => {
+    calls = calls + 1
+  })
+  controller.subscribeSchemaChange(() => {
+    calls = calls + 1
+  })
+  controller.clearSchemaChangeSubscribers()
+  await controller.updatePlaceholder("next-placeholder")
+
+  expect(calls).toBe(0)
+})
+
+test("BaseInputorController.updateIsVoid resets the value to its void value", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsVoid(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    value: undefined,
+    isVoid: true,
+    isDirty: true,
+  })
+})
+
+test("BaseInputorController.updateIsFocused also marks the controller as touched", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsFocused(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    isFocused: true,
+    isTouched: true,
+  })
+})
+
+test("BaseInputorController.updateIsTouched updates touched state directly", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsTouched(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    isTouched: true,
+  })
+})
+
+test("BaseInputorController.updateIsDirty updates dirty state directly", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsDirty(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    isDirty: true,
+  })
+})
+
+test("BaseInputorController.updateIsDisabled updates disabled state directly", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsDisabled(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    isDisabled: true,
+  })
+})
+
+test("BaseInputorController.updateIsDebugMode updates debug mode directly", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateIsDebugMode(true)
+
+  expect(await controller.getSchema()).toMatchObject({
+    isDebugMode: true,
+  })
+})
+
+test("BaseInputorController.updateSchema applies multiple schema fields in one pass", async () => {
+  const controller = createTestInputor({ value: "start" })
+
+  await controller.waitForReady()
+  await controller.updateSchema({
+    ...(await controller.getSchema()),
+    placeholder: "schema-placeholder",
+    value: " schema-value ",
+    isFocused: true,
+    isTouched: true,
+    isDirty: true,
+    isDisabled: true,
+    isDebugMode: true,
+  })
+
+  expect(await controller.getSchema()).toEqual({
+    inputorTypeName: TEST_INPUTOR_TYPE_NAME,
+    id: "test-id",
+    name: "test-name",
+    placeholder: "schema-placeholder",
+    value: "schema-value",
+    isVoid: false,
+    isFocused: true,
+    isTouched: true,
+    isDirty: true,
+    isDisabled: true,
+    isDebugMode: true,
+  })
+})
+
+test("BaseInputorController.destroy clears every subscriber collection", async () => {
+  vi.useFakeTimers()
+
+  try {
+    const controller = createTestInputor({ value: "start" })
+    let inputCalls = 0
+    let valueCalls = 0
+    let schemaCalls = 0
+
+    await controller.waitForReady()
+    controller.subscribeInputChange(() => {
+      inputCalls = inputCalls + 1
+    })
+    controller.subscribeValueChange(() => {
+      valueCalls = valueCalls + 1
+    })
+    controller.subscribeSchemaChange(() => {
+      schemaCalls = schemaCalls + 1
+    })
+    controller.destroy()
+
+    await controller.updateInputValue("next")
+    await vi.advanceTimersByTimeAsync(0)
+    await controller.updateValue("final")
+    await controller.updatePlaceholder("after-destroy")
+
+    expect(inputCalls).toBe(0)
+    expect(valueCalls).toBe(0)
+    expect(schemaCalls).toBe(0)
+  }
+  finally {
+    vi.useRealTimers()
+  }
+})

package/tests/unit/form/inputor-controller/boolean.spec.ts

@@ -0,0 +1,30 @@
+import { expect, test } from "vitest"
+
+import {
+  BOOLEAN_INPUTOR_TYPE_NAME,
+  BooleanInputorController,
+} from "#Source/form/index.ts"
+
+test("BooleanInputorController.getSchema exposes boolean schema state and updateValue toggles it", async () => {
+  const controller = new BooleanInputorController({
+    id: "boolean-id",
+    value: false,
+  })
+
+  await controller.waitForReady()
+  await controller.updateValue(true)
+
+  expect(await controller.getSchema()).toEqual({
+    inputorTypeName: BOOLEAN_INPUTOR_TYPE_NAME,
+    id: "boolean-id",
+    name: `boolean-boolean-id`,
+    placeholder: "",
+    value: true,
+    isVoid: false,
+    isFocused: false,
+    isTouched: false,
+    isDirty: true,
+    isDisabled: false,
+    isDebugMode: false,
+  })
+})

package/tests/unit/form/inputor-controller/file.spec.ts

@@ -0,0 +1,27 @@
+import { expect, test } from "vitest"
+
+import {
+  FILE_INPUTOR_TYPE_NAME,
+  FileInputorController,
+} from "#Source/form/index.ts"
+
+test("FileInputorController.getSchema stores file values and reports file metadata", async () => {
+  const file = new File(["alpha"], "alpha.txt", {
+    type: "text/plain",
+  })
+  const controller = new FileInputorController({
+    id: "file-id",
+    value: file,
+  })
+
+  await controller.waitForReady()
+
+  const schema = await controller.getSchema()
+
+  expect(schema.inputorTypeName).toBe(FILE_INPUTOR_TYPE_NAME)
+  expect(schema.id).toBe("file-id")
+  expect(schema.name).toBe("file-file-id")
+  expect(schema.value?.name).toBe("alpha.txt")
+  expect(schema.value?.type).toBe("text/plain")
+  expect(schema.isDirty).toBe(false)
+})

package/tests/unit/form/inputor-controller/form.spec.ts

@@ -0,0 +1,120 @@
+import { expect, test } from "vitest"
+
+import {
+  FormInputorController,
+  NumberInputorController,
+  TextInputorController,
+} from "#Source/form/index.ts"
+
+const createItems = (): {
+  name: TextInputorController
+  age: NumberInputorController
+} => {
+  return {
+    name: new TextInputorController({
+      id: "form-name-id",
+      value: "alpha",
+    }),
+    age: new NumberInputorController({
+      id: "form-age-id",
+      value: 1,
+      min: 0,
+      max: 99,
+    }),
+  }
+}
+
+test("FormInputorController.updateValue decodes external values into child items", async () => {
+  const items = createItems()
+  const controller = new FormInputorController<
+    { name: string | undefined; age: number | undefined },
+    typeof items
+  >({
+    id: "form-id",
+    value: {
+      name: "alpha",
+      age: 1,
+    },
+    items,
+    encodeValue: (schemaDict) => {
+      return {
+        name: schemaDict.name.value,
+        age: schemaDict.age.value,
+      }
+    },
+    decodeValue: (value) => {
+      return {
+        name: value.name,
+        age: value.age,
+      }
+    },
+  })
+
+  await Promise.all([
+    items.name.waitForReady(),
+    items.age.waitForReady(),
+    controller.waitForReady(),
+  ])
+  await controller.updateValue({
+    name: "beta",
+    age: 8,
+  })
+
+  expect((await items.name.getSchema()).value).toBe("beta")
+  expect((await items.age.getSchema()).value).toBe(8)
+  expect((await controller.getSchema()).value).toEqual({
+    name: "beta",
+    age: 8,
+  })
+})
+
+test("FormInputorController reacts to child schema changes through encodeValue", async () => {
+  const items = createItems()
+  const controller = new FormInputorController<
+    { name: string | undefined; age: number | undefined },
+    typeof items
+  >({
+    id: "form-id",
+    value: {
+      name: "alpha",
+      age: 1,
+    },
+    items,
+    encodeValue: (schemaDict) => {
+      return {
+        name: schemaDict.name.value,
+        age: schemaDict.age.value,
+      }
+    },
+    decodeValue: (value) => {
+      return {
+        name: value.name,
+        age: value.age,
+      }
+    },
+  })
+
+  await Promise.all([
+    items.name.waitForReady(),
+    items.age.waitForReady(),
+    controller.waitForReady(),
+  ])
+  await Promise.resolve()
+
+  const nextFormValue = new Promise<{ name: string | undefined; age: number | undefined }>((resolve) => {
+    controller.subscribeValueChange((context) => {
+      resolve(context.newValue)
+    })
+  })
+
+  await items.name.updateValue("gamma")
+
+  expect(await nextFormValue).toEqual({
+    name: "gamma",
+    age: 1,
+  })
+  expect((await controller.getSchema()).value).toEqual({
+    name: "gamma",
+    age: 1,
+  })
+})

package/tests/unit/form/inputor-controller/helper.spec.ts

@@ -0,0 +1,67 @@
+import { expect, test } from "vitest"
+
+import {
+  BooleanInputorController,
+  FileInputorController,
+  FormInputorController,
+  MultiSelectInputorController,
+  NumberInputorController,
+  SelectInputorController,
+  TextInputorController,
+  boolean as createBooleanInputor,
+  file as createFileInputor,
+  form as createFormInputor,
+  multiSelect as createMultiSelectInputor,
+  number as createNumberInputor,
+  select as createSelectInputor,
+  text as createTextInputor,
+} from "#Source/form/index.ts"
+
+test("boolean creates a BooleanInputorController", () => {
+  expect(createBooleanInputor({ value: false })).toBeInstanceOf(BooleanInputorController)
+})
+
+test("number creates a NumberInputorController", () => {
+  expect(createNumberInputor({ value: 1 })).toBeInstanceOf(NumberInputorController)
+})
+
+test("text creates a TextInputorController", () => {
+  expect(createTextInputor({ value: "alpha" })).toBeInstanceOf(TextInputorController)
+})
+
+test("file creates a FileInputorController", () => {
+  expect(createFileInputor({ value: undefined })).toBeInstanceOf(FileInputorController)
+})
+
+test("select creates a SelectInputorController", () => {
+  expect(createSelectInputor({ value: [] })).toBeInstanceOf(SelectInputorController)
+})
+
+test("multiSelect creates a MultiSelectInputorController", () => {
+  expect(createMultiSelectInputor({ value: [] })).toBeInstanceOf(MultiSelectInputorController)
+})
+
+test("form creates a FormInputorController", () => {
+  const nameController = createTextInputor({ value: "alpha" })
+  const ageController = createNumberInputor({ value: 1 })
+
+  expect(createFormInputor({
+    value: {
+      name: "alpha",
+      age: 1,
+    },
+    items: {
+      name: nameController,
+      age: ageController,
+    },
+    encodeValue: (schemaDict) => {
+      return {
+        name: schemaDict.name.value,
+        age: schemaDict.age.value,
+      }
+    },
+    decodeValue: (value) => {
+      return value
+    },
+  })).toBeInstanceOf(FormInputorController)
+})