@narrative.io/jsonforms-provider-protocols 1.1.0-beta.0 → 1.1.0-beta.10

package/src/vue/primevue/JfEnumArray.vue

@@ -1,12 +1,51 @@
+<script lang="ts">
+export default {
+  name: "JfEnumArray",
+  props: {
+    uischema: {
+      type: Object,
+      required: true,
+    },
+    schema: {
+      type: Object,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+    enabled: {
+      type: Boolean,
+      default: undefined,
+    },
+    renderers: {
+      type: Array,
+      required: false,
+    },
+    cells: {
+      type: Array,
+      required: false,
+    },
+    config: {
+      type: Object,
+      required: false,
+    },
+  },
+};
+</script>
+
 <script setup lang="ts">
-import type { ControlElement, JsonSchema } from "@jsonforms/core";
-import { rendererProps, useJsonFormsControl } from "@jsonforms/vue";
-import { computed } from "vue";
+import type { JsonSchema } from "@jsonforms/core";
+import type { ControlProps } from "@jsonforms/vue";
+import { useJsonFormsControl } from "@jsonforms/vue";
+import { computed, inject, getCurrentInstance } from "vue";
+import { useProvider } from "../composables/useProvider";
+import { useDerive } from "../composables/useDerive";
 import MultiSelect from "primevue/multiselect";
 
-defineOptions({ name: "JfEnumArray" });
-
-const props = defineProps(rendererProps<ControlElement>());
+// Access props from the component instance
+const instance = getCurrentInstance()!;
+const props = instance.props as unknown as ControlProps;
 const { control, handleChange } = useJsonFormsControl(props);
 
 type Opt = { label: string; value: unknown };
@@ -26,14 +65,74 @@ const toOptions = (schema?: JsonSchema): Opt[] => {
   return [];
 };
 
-const options = computed(() =>
-  toOptions((control.value.schema as { items?: JsonSchema })?.items),
-);
-const placeholder = computed<string | undefined>(
+// Provider support
+const binding = computed(() => {
+  const provider = control.value.uischema?.options?.provider;
+  // Ensure load property is set to 'mount' by default
+  if (provider && typeof provider === "object" && !provider.load) {
+    return { ...provider, load: "mount" };
+  }
+  return provider;
+});
+
+const deps = computed(
   () =>
-    (control.value.uischema as { options?: { placeholder?: string } })?.options
-      ?.placeholder ?? control.value.description,
+    ((
+      (control.value.schema as Record<string, unknown>)?.[
+        "x-provider"
+      ] as Record<string, unknown>
+    )?.dependsOn as string[]) ?? [],
 );
+const depValues = computed(() => {
+  return deps.value.map((dep) => {
+    // Resolve dependency value from form data using JSON pointer-like path
+    const path = dep.startsWith("#/") ? dep.slice(2) : dep;
+    const keys = path.replace(/\//g, ".").split(".");
+    let value: unknown = rootData.value;
+    for (const key of keys) {
+      if (value && typeof value === "object" && key in value) {
+        value = (value as Record<string, unknown>)[key];
+      } else {
+        return null;
+      }
+    }
+    return value;
+  });
+});
+
+// Get the root form data from JSONForms context for template URL resolution
+const injectedFormData = inject<{ value: unknown }>("formData", { value: {} });
+const rootData = computed(() => injectedFormData.value || {});
+
+// Use provider if available, otherwise fall back to schema enum/oneOf
+const {
+  items: providerItems,
+  loading,
+  error,
+} = useProvider(binding, {
+  data: rootData,
+  path: control.value.path,
+  dependsOnValues: depValues.value,
+});
+
+const options = computed(() => {
+  // Use provider items if available, otherwise fall back to schema enum/oneOf
+  if (binding.value && providerItems.value.length > 0) {
+    return providerItems.value;
+  }
+  return toOptions((control.value.schema as { items?: JsonSchema })?.items);
+});
+
+// Add derive functionality
+useDerive({ control, handleChange });
+
+const placeholder = computed<string | undefined>(() => {
+  if (loading.value) return "Loading…";
+  return (
+    (control.value.uischema as { options?: { placeholder?: string } })?.options
+      ?.placeholder ?? control.value.description
+  );
+});
 
 // order-insensitive shallow equality for primitive enums
 const sameSet = (a: unknown[], b: unknown[]) => {
@@ -75,11 +174,16 @@ const model = computed<unknown[]>({
       option-value="value"
       data-key="value"
       display="chip"
-      :disabled="!control.enabled"
+      :disabled="!control.enabled || loading"
       :aria-invalid="!!control.errors || undefined"
       :placeholder="placeholder"
     />
 
-    <small v-if="control.errors" class="p-error">{{ control.errors }}</small>
+    <small v-if="error" class="p-error" role="alert"
+      >Failed to load: {{ error }}</small
+    >
+    <small v-else-if="control.errors" class="p-error">{{
+      control.errors
+    }}</small>
   </div>
 </template>

package/src/vue/primevue/JfNumber.vue

@@ -1,22 +1,108 @@
+<script lang="ts">
+export default {
+  name: "JfNumber",
+  props: {
+    uischema: {
+      type: Object,
+      required: true,
+    },
+    schema: {
+      type: Object,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+    enabled: {
+      type: Boolean,
+      default: undefined,
+    },
+    renderers: {
+      type: Array,
+      required: false,
+    },
+    cells: {
+      type: Array,
+      required: false,
+    },
+    config: {
+      type: Object,
+      required: false,
+    },
+  },
+};
+</script>
+
 <script setup lang="ts">
-import type { ControlElement } from "@jsonforms/core";
-import { rendererProps, useJsonFormsControl } from "@jsonforms/vue";
-import { computed } from "vue";
+import type { ControlProps } from "@jsonforms/vue";
+import { useJsonFormsControl } from "@jsonforms/vue";
+import { computed, ref, getCurrentInstance } from "vue";
+import { useDerive } from "../composables/useDerive";
 import InputNumber from "primevue/inputnumber";
 
-defineOptions({ name: "JfNumber" });
-
-const props = defineProps(rendererProps<ControlElement>());
+// Access props from the component instance
+const instance = getCurrentInstance()!;
+const props = instance.props as unknown as ControlProps;
 const { control, handleChange } = useJsonFormsControl(props);
 
-const placeholder = computed<string | undefined>(
+const options = computed(
   () =>
-    (control.value.uischema as { options?: { placeholder?: string } })?.options
-      ?.placeholder ?? control.value.description,
+    (control.value.uischema as { options?: Record<string, unknown> })
+      ?.options ?? {},
 );
 
-const onNumber = (val: number | null) =>
+const placeholder = computed<string | undefined>(
+  () => (options.value.placeholder as string) ?? control.value.description,
+);
+
+// Add derive functionality
+useDerive({ control, handleChange });
+
+// Currency and decimal configuration
+const mode = computed(() => {
+  if (options.value.currency) return "currency";
+  if (options.value.decimal || typeof options.value.precision === "number")
+    return "decimal";
+  return undefined;
+});
+
+const currency = computed(() =>
+  typeof options.value.currency === "string" ? options.value.currency : "USD",
+);
+
+const minFractionDigits = computed(() => {
+  if (mode.value === "currency") return 2;
+  if (typeof options.value.precision === "number")
+    return options.value.precision;
+  return undefined;
+});
+
+const maxFractionDigits = computed(() => {
+  if (mode.value === "currency") return 2;
+  if (typeof options.value.precision === "number")
+    return options.value.precision;
+  return undefined;
+});
+
+const useGrouping = computed(() => {
+  // Enable grouping for currency by default, or if explicitly set
+  if (mode.value === "currency") return true;
+  return options.value.useGrouping === true;
+});
+
+// Track user interaction
+const hasInteracted = ref(false);
+
+const showErrors = computed(() => hasInteracted.value && control.value.errors);
+
+const onNumber = (val: number | null) => {
   handleChange(control.value.path, val ?? undefined);
+};
+
+const onBlur = () => {
+  hasInteracted.value = true;
+};
 </script>
 
 <template>
@@ -30,13 +116,18 @@ const onNumber = (val: number | null) =>
     <InputNumber
       class="w-full"
       input-class="w-full"
-      :use-grouping="false"
+      :use-grouping="useGrouping"
+      :mode="mode"
+      :currency="currency"
+      :min-fraction-digits="minFractionDigits"
+      :max-fraction-digits="maxFractionDigits"
       :model-value="typeof control.data === 'number' ? control.data : null"
       :placeholder="placeholder"
       :disabled="!control.enabled"
-      :aria-invalid="!!control.errors || undefined"
+      :aria-invalid="!!showErrors || undefined"
       @update:model-value="onNumber"
+      @blur="onBlur"
     />
-    <small v-if="control.errors" class="p-error">{{ control.errors }}</small>
+    <small v-if="showErrors" class="p-error">{{ control.errors }}</small>
   </div>
 </template>

package/src/vue/primevue/JfText.vue

@@ -1,26 +1,150 @@
+<script lang="ts">
+export default {
+  name: "JfText",
+  props: {
+    uischema: {
+      type: Object,
+      required: true,
+    },
+    schema: {
+      type: Object,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+    enabled: {
+      type: Boolean,
+      default: undefined,
+    },
+    renderers: {
+      type: Array,
+      required: false,
+    },
+    cells: {
+      type: Array,
+      required: false,
+    },
+    config: {
+      type: Object,
+      required: false,
+    },
+  },
+};
+</script>
+
 <script setup lang="ts">
-import type { ControlElement } from "@jsonforms/core";
-import { rendererProps, useJsonFormsControl } from "@jsonforms/vue";
-import { computed } from "vue";
+import type { ControlProps } from "@jsonforms/vue";
+import { useJsonFormsControl } from "@jsonforms/vue";
+import { computed, ref, inject, watch, getCurrentInstance } from "vue";
+import { useProvider } from "../composables/useProvider";
+import { useDerive } from "../composables/useDerive";
 import InputText from "primevue/inputtext";
+import AutoComplete from "primevue/autocomplete";
 
-defineOptions({ name: "JfText" });
-
-const props = defineProps(rendererProps<ControlElement>());
+// Access props from the component instance
+const instance = getCurrentInstance()!;
+const props = instance.props as unknown as ControlProps;
 const { control, handleChange } = useJsonFormsControl(props);
 
-const placeholder = computed<string | undefined>(
+// Provider support for autocomplete functionality
+const binding = computed(() => {
+  const provider = control.value.uischema?.options?.provider;
+  // Ensure load property is set to 'query' by default for autocomplete
+  if (provider && typeof provider === "object" && !provider.load) {
+    return { ...provider, load: "query" };
+  }
+  return provider;
+});
+
+const deps = computed(
   () =>
-    (control.value.uischema as { options?: { placeholder?: string } })?.options
-      ?.placeholder ?? control.value.description,
+    ((
+      (control.value.schema as Record<string, unknown>)?.[
+        "x-provider"
+      ] as Record<string, unknown>
+    )?.dependsOn as string[]) ?? [],
 );
+const depValues = computed(() => {
+  return deps.value.map((dep) => {
+    // Resolve dependency value from form data using JSON pointer-like path
+    const path = dep.startsWith("#/") ? dep.slice(2) : dep;
+    const keys = path.replace(/\//g, ".").split(".");
+    let value: unknown = rootData.value;
+    for (const key of keys) {
+      if (value && typeof value === "object" && key in value) {
+        value = (value as Record<string, unknown>)[key];
+      } else {
+        return null;
+      }
+    }
+    return value;
+  });
+});
+
+// Get the root form data from JSONForms context for template URL resolution
+const injectedFormData = inject<{ value: unknown }>("formData", { value: {} });
+const rootData = computed(() => injectedFormData.value || {});
+
+const query = ref("");
+const { items, loading, error, reload } = useProvider(binding, {
+  data: rootData,
+  path: control.value.path,
+  uiQuery: query.value,
+  dependsOnValues: depValues.value,
+});
+
+watch(query, () => {
+  if (binding.value?.load === "query") reload();
+});
+
+const placeholder = computed<string | undefined>(() => {
+  if (loading.value) return "Loading…";
+  return (
+    (control.value.uischema as { options?: { placeholder?: string } })?.options
+      ?.placeholder ?? control.value.description
+  );
+});
+
+const isAutocomplete = computed(() => !!binding.value);
+
+// Add derive functionality
+useDerive({ control, handleChange });
+
+// Track user interaction
+const hasInteracted = ref(false);
+const hasFocused = ref(false);
+
+const showErrors = computed(() => hasInteracted.value && control.value.errors);
 
 function onInput(val: string | undefined) {
-  const newValue = val ?? "";
-  if ((control.value.data ?? "") !== newValue) {
+  // Convert empty strings to undefined for proper required field validation
+  const newValue = val && val.trim() !== "" ? val : undefined;
+  if (control.value.data !== newValue) {
     handleChange(control.value.path, newValue);
   }
 }
+
+function onBlur() {
+  if (hasFocused.value) {
+    hasInteracted.value = true;
+  }
+}
+
+function onFocus() {
+  hasFocused.value = true;
+}
+
+// Autocomplete specific handlers
+const onComplete = (event: { query: string }) => {
+  query.value = event.query;
+};
+
+const onSelect = (event: { value?: { value?: unknown } | unknown }) => {
+  const newValue = (event.value as { value?: unknown })?.value ?? event.value;
+  handleChange(control.value.path, newValue);
+};
 </script>
 
 <template>
@@ -31,17 +155,36 @@ function onInput(val: string | undefined) {
     <div v-if="control.description" class="text-color-secondary text-left">
       {{ control.description }}
     </div>
+    <AutoComplete
+      v-if="isAutocomplete"
+      class="w-full"
+      :model-value="control.data ?? ''"
+      :suggestions="items"
+      option-label="label"
+      :placeholder="placeholder"
+      :disabled="!control.enabled"
+      :aria-invalid="!!showErrors || undefined"
+      @complete="onComplete"
+      @item-select="onSelect"
+      @update:model-value="onInput"
+      @blur="onBlur"
+      @focus="onFocus"
+    />
     <InputText
+      v-else
       class="w-full"
       :model-value="control.data ?? ''"
       :disabled="!control.enabled"
-      :aria-invalid="!!control.errors || undefined"
+      :aria-invalid="!!showErrors || undefined"
       :placeholder="placeholder"
       autocapitalize="off"
       autocomplete="off"
       spellcheck="false"
       @update:model-value="onInput"
+      @blur="onBlur"
+      @focus="onFocus"
     />
-    <small v-if="control.errors" class="p-error">{{ control.errors }}</small>
+    <small v-if="error" class="p-error" role="alert">Failed: {{ error }}</small>
+    <small v-else-if="showErrors" class="p-error">{{ control.errors }}</small>
   </div>
 </template>

package/src/vue/primevue/JfTextArea.vue

@@ -1,12 +1,48 @@
+<script lang="ts">
+export default {
+  name: "JfTextArea",
+  props: {
+    uischema: {
+      type: Object,
+      required: true,
+    },
+    schema: {
+      type: Object,
+      required: true,
+    },
+    path: {
+      type: String,
+      required: true,
+    },
+    enabled: {
+      type: Boolean,
+      default: undefined,
+    },
+    renderers: {
+      type: Array,
+      required: false,
+    },
+    cells: {
+      type: Array,
+      required: false,
+    },
+    config: {
+      type: Object,
+      required: false,
+    },
+  },
+};
+</script>
+
 <script setup lang="ts">
-import type { ControlElement } from "@jsonforms/core";
-import { rendererProps, useJsonFormsControl } from "@jsonforms/vue";
-import { computed } from "vue";
+import type { ControlProps } from "@jsonforms/vue";
+import { useJsonFormsControl } from "@jsonforms/vue";
+import { computed, ref, getCurrentInstance } from "vue";
 import Textarea from "primevue/textarea";
 
-defineOptions({ name: "JfTextArea" });
-
-const props = defineProps(rendererProps<ControlElement>());
+// Access props from the component instance
+const instance = getCurrentInstance()!;
+const props = instance.props as unknown as ControlProps;
 const { control, handleChange } = useJsonFormsControl(props);
 
 const placeholder = computed<string | undefined>(
@@ -15,12 +51,22 @@ const placeholder = computed<string | undefined>(
       ?.placeholder ?? control.value.description,
 );
 
+// Track user interaction
+const hasInteracted = ref(false);
+
+const showErrors = computed(() => hasInteracted.value && control.value.errors);
+
 function onInput(val: string | undefined) {
-  const newValue = val ?? "";
-  if ((control.value.data ?? "") !== newValue) {
+  // Convert empty strings to undefined for proper required field validation
+  const newValue = val && val.trim() !== "" ? val : undefined;
+  if (control.value.data !== newValue) {
     handleChange(control.value.path, newValue);
   }
 }
+
+function onBlur() {
+  hasInteracted.value = true;
+}
 </script>
 
 <template>
@@ -35,12 +81,13 @@ function onInput(val: string | undefined) {
       class="w-full"
       :model-value="control.data ?? ''"
       :disabled="!control.enabled"
-      :aria-invalid="!!control.errors || undefined"
+      :aria-invalid="!!showErrors || undefined"
       :placeholder="placeholder"
       :rows="4"
       :auto-resize="true"
       @update:model-value="onInput"
+      @blur="onBlur"
     />
-    <small v-if="control.errors" class="p-error">{{ control.errors }}</small>
+    <small v-if="showErrors" class="p-error">{{ control.errors }}</small>
   </div>
 </template>

package/src/vue/primevue/index.ts

@@ -33,17 +33,8 @@ const injectLayoutStyles = () => {
 // Inject styles when this module is imported
 injectLayoutStyles();
 
-import {
-  rankWith,
-  isStringControl,
-  or,
-  isNumberControl,
-  isIntegerControl,
-  and,
-  isControl,
-  schemaMatches,
-  isBooleanControl,
-} from "@jsonforms/core";
+// Import types only to avoid circular dependencies
+import type { JsonFormsRendererRegistryEntry } from "@jsonforms/core";
 
 // helpers for enum detection
 const isScalarEnum = (s?: object) => {
@@ -66,34 +57,54 @@ const isEnumArray = (s?: object) => {
   );
 };
 
-// helper for multiline detection
-const isMultilineString = (uischema: unknown, schema: unknown) => {
-  return (
-    isStringControl(uischema as never, schema as never, {} as never) &&
-    (uischema as { options?: { multi?: boolean } })?.options?.multi === true
-  );
-};
-
 // Give PrimeVue renderers a high base rank; vanilla commonly uses small ranks (2–5)
 const PRIME = 100;
 
-export const primevueRenderers = [
-  // Multiline text has higher priority than regular text
-  { tester: rankWith(PRIME + 4, isMultilineString), renderer: JfTextArea },
-  { tester: rankWith(PRIME + 3, isStringControl), renderer: JfText },
-  {
-    tester: rankWith(PRIME + 4, or(isNumberControl, isIntegerControl)),
-    renderer: JfNumber,
-  },
-  {
-    tester: rankWith(PRIME + 5, and(isControl, schemaMatches(isScalarEnum))),
-    renderer: JfEnum,
-  },
-  {
-    tester: rankWith(PRIME + 6, and(isControl, schemaMatches(isEnumArray))),
-    renderer: JfEnumArray,
-  },
-  { tester: rankWith(PRIME + 3, isBooleanControl), renderer: JfBoolean },
-];
+// Create empty array first, populate it after module initialization to avoid circular deps
+export const primevueRenderers: JsonFormsRendererRegistryEntry[] = [];
+
+// Populate the renderers array after a microtask delay to avoid circular dependency
+Promise.resolve().then(async () => {
+  const {
+    rankWith,
+    isStringControl,
+    or,
+    isNumberControl,
+    isIntegerControl,
+    and,
+    isControl,
+    schemaMatches,
+    isBooleanControl,
+  } = await import("@jsonforms/core");
+
+  // helper for multiline detection moved inside async block
+  const isMultilineString = (uischema: unknown, schema: unknown) => {
+    const controlUischema = uischema as { options?: { multi?: boolean } };
+    return and(isStringControl, () => controlUischema?.options?.multi === true)(
+      uischema as Parameters<typeof isStringControl>[0],
+      schema as Parameters<typeof isStringControl>[1],
+      {} as Parameters<typeof isStringControl>[2],
+    );
+  };
+
+  primevueRenderers.push(
+    // Multiline text has higher priority than regular text
+    { tester: rankWith(PRIME + 4, isMultilineString), renderer: JfTextArea },
+    { tester: rankWith(PRIME + 3, isStringControl), renderer: JfText },
+    {
+      tester: rankWith(PRIME + 4, or(isNumberControl, isIntegerControl)),
+      renderer: JfNumber,
+    },
+    {
+      tester: rankWith(PRIME + 5, and(isControl, schemaMatches(isScalarEnum))),
+      renderer: JfEnum,
+    },
+    {
+      tester: rankWith(PRIME + 6, and(isControl, schemaMatches(isEnumArray))),
+      renderer: JfEnumArray,
+    },
+    { tester: rankWith(PRIME + 3, isBooleanControl), renderer: JfBoolean },
+  );
+});
 
 export { JfText, JfTextArea, JfNumber, JfEnum, JfEnumArray, JfBoolean };