@narrative.io/jsonforms-provider-protocols 3.0.0-beta.1 → 3.0.0-beta.11

package/src/vue/composables/useDeriveInitialValue.ts

@@ -0,0 +1,195 @@
+import { computed, inject, ref, watch, type Ref, type ComputedRef } from "vue";
+import { type ControlElement } from "@jsonforms/core";
+import { renderTpl, renderObj } from "../../core/templating";
+import { jp } from "../../core/jsonpath";
+import {
+  applyTransformPipeline,
+  type TransformPipeline,
+} from "../../core/transforms";
+import type { AuthConfig } from "../../core/types";
+
+export interface DeriveInitialValueCfg {
+  protocol: string;
+  config: {
+    url: string;
+    method?: "GET" | "POST";
+    headers?: Record<string, string>;
+    query?: Record<string, unknown>;
+    body?: unknown;
+    auth?: AuthConfig;
+    items: string;
+    map: { value: string };
+    transforms?: TransformPipeline;
+    showError?: boolean;
+  };
+}
+
+interface DeriveInitialValueOptions {
+  control: Ref<{
+    uischema: ControlElement;
+    path: string;
+    data: unknown;
+  }>;
+  handleChange: (path: string, value: unknown) => void;
+  data?: Ref<unknown> | ComputedRef<unknown>;
+}
+
+function buildAuthHeaders(
+  auth?: AuthConfig,
+  globalAuth?: Record<string, unknown>,
+): Record<string, string> {
+  const headers: Record<string, string> = {};
+  if (!auth) return headers;
+
+  if (auth.use && globalAuth?.[auth.use]) {
+    const globalValue = globalAuth[auth.use];
+    const value =
+      typeof globalValue === "function" ? globalValue() : globalValue;
+    if (auth.use === "apiKey") headers["X-API-Key"] = String(value);
+    else if (auth.use === "bearer")
+      headers["Authorization"] = `Bearer ${value}`;
+    else if (auth.use === "token") headers["Authorization"] = `Token ${value}`;
+    return headers;
+  }
+
+  if (auth.bearer) {
+    const v = typeof auth.bearer === "function" ? auth.bearer() : auth.bearer;
+    headers["Authorization"] = `Bearer ${v}`;
+  }
+  if (auth.apiKey) {
+    const v = typeof auth.apiKey === "function" ? auth.apiKey() : auth.apiKey;
+    headers["X-API-Key"] = String(v);
+  }
+  if (auth.token) {
+    const v = typeof auth.token === "function" ? auth.token() : auth.token;
+    headers["Authorization"] = `Token ${v}`;
+  }
+
+  return headers;
+}
+
+/**
+ * Returns true when the template URL contains `{{…}}` placeholders but
+ * one or more of those placeholders resolved to an empty string, which
+ * means a required data dependency hasn't been set yet.
+ */
+function hasUnresolvedTemplates(
+  templateUrl: string,
+  renderedUrl: string,
+): boolean {
+  if (!templateUrl.includes("{{")) return false;
+  // After protocol, empty segments indicate unresolved vars
+  const pathPart = renderedUrl.replace(/^https?:\/\/[^/]+/, "");
+  if (pathPart.includes("//")) return true;
+  // Trailing slash when the template didn't have one
+  if (renderedUrl.endsWith("/") && !templateUrl.endsWith("/")) return true;
+  return false;
+}
+
+export function useDeriveInitialValue({
+  control,
+  handleChange,
+}: DeriveInitialValueOptions) {
+  const injectedFormData = inject<{ value: unknown }>("formData", {
+    value: {},
+  });
+  const rootData = computed(() => injectedFormData.value || {});
+  const auth = inject("providerAuth", {}) as Record<string, unknown>;
+
+  const cfg = computed<DeriveInitialValueCfg | undefined>(() => {
+    return control.value.uischema?.options?.deriveInitialValue as
+      | DeriveInitialValueCfg
+      | undefined;
+  });
+
+  // Compute the resolved URL reactively
+  const resolvedUrl = computed<string | null>(() => {
+    const c = cfg.value;
+    if (!c?.config?.url) return null;
+    const rendered = renderTpl(c.config.url, { data: rootData.value });
+    if (hasUnresolvedTemplates(c.config.url, rendered)) return null;
+    return rendered;
+  });
+
+  const lastFetchedUrl = ref<string | null>(null);
+  const loading = ref(false);
+  const error = ref<string | undefined>(undefined);
+
+  watch(
+    resolvedUrl,
+    async (url) => {
+      if (!url || !cfg.value) return;
+      // Only fetch when the URL changes (new context).
+      // Same URL = same context; don't override user selection.
+      if (url === lastFetchedUrl.value) return;
+      lastFetchedUrl.value = url;
+
+      loading.value = true;
+      error.value = undefined;
+
+      try {
+        const c = cfg.value.config;
+        const fullUrl = new URL(url);
+
+        // Query params
+        const q = renderObj(c.query ?? {}, {
+          data: rootData.value,
+        }) as Record<string, unknown>;
+        for (const [k, v] of Object.entries(q)) {
+          if (v !== undefined && v !== "")
+            fullUrl.searchParams.set(k, String(v));
+        }
+
+        // Headers
+        const baseHeaders = renderObj(c.headers ?? {}, {
+          data: rootData.value,
+        }) as Record<string, string>;
+        const authHeaders = buildAuthHeaders(c.auth, auth);
+        const headers = { ...baseHeaders, ...authHeaders };
+
+        const method = c.method ?? "GET";
+        const requestInit: RequestInit = { method, headers };
+        if (method !== "GET" && c.body) {
+          requestInit.body = JSON.stringify(
+            renderObj(c.body, { data: rootData.value }),
+          );
+        }
+
+        const res = await fetch(fullUrl.toString(), requestInit);
+        if (!res.ok) {
+          if (c.showError !== false) {
+            throw new Error(`REST ${res.status}`);
+          }
+          return;
+        }
+
+        const json = await res.json();
+        let items = jp(json, c.items);
+
+        // Apply transforms if provided
+        if (c.transforms && c.transforms.length > 0) {
+          items = applyTransformPipeline(items, c.transforms);
+        }
+
+        if (items.length === 0) return; // No items → leave field empty
+
+        // Extract value from first item
+        const derivedValue = jp(items[0], c.map.value)[0];
+        if (derivedValue !== undefined) {
+          handleChange(control.value.path, derivedValue);
+        }
+      } catch (e) {
+        error.value = (e as Error)?.message ?? String(e);
+        console.warn(
+          `deriveInitialValue fetch failed for ${control.value.path}:`,
+          e,
+        );
+      } finally {
+        loading.value = false;
+      }
+    },
+    { immediate: true },
+  );
+
+  return { loading, error };
+}

package/src/vue/composables/useDirtyValidation.ts

@@ -0,0 +1,20 @@
+import { ref, computed, type Ref, type ComputedRef } from "vue";
+
+export function useDirtyValidation(
+  control: Ref<{ errors: string }>,
+  errorsOverride?: Ref<string> | ComputedRef<string>,
+) {
+  const hasInteracted = ref(false);
+
+  const showErrors = computed(
+    () =>
+      hasInteracted.value &&
+      !!(errorsOverride ? errorsOverride.value : control.value.errors),
+  );
+
+  const markDirty = () => {
+    hasInteracted.value = true;
+  };
+
+  return { hasInteracted, showErrors, markDirty };
+}

package/src/vue/composables/useProjection.ts

@@ -1,4 +1,4 @@
-import { computed, type ComputedRef, type Ref } from "vue";
+import { computed, inject, type ComputedRef, type Ref } from "vue";
 import {
   getProjectedValue,
   setProjectedValue,
@@ -8,11 +8,68 @@ import {
 interface ProjectionControl {
   data: unknown;
   path: string;
+  errors: string;
+  label?: string;
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   schema: Record<string, any>;
   uischema: { options?: { projection?: string; [key: string]: unknown } };
 }
 
+// Minimal AJV ErrorObject shape for filtering
+interface ErrorLike {
+  instancePath?: string;
+  keyword?: string;
+  message?: string;
+  params?: { missingProperty?: string };
+}
+
+/**
+ * Resolve the display label for a control.
+ * Priority: uischema options.label → schemaTitle (projected sub-schema) → control.label.
+ */
+function resolveLabel(ctrl: ProjectionControl, schemaTitle?: string): string {
+  return (
+    (ctrl.uischema?.options?.label as string) ?? schemaTitle ?? ctrl.label ?? ""
+  );
+}
+
+/**
+ * Normalize AJV error message fragments into user-friendly text.
+ * e.g. "is a required property" → "is required"
+ */
+function normalizeErrors(errors: string): string {
+  if (!errors) return errors;
+  return errors
+    .replace(/is a required property/g, "is required")
+    .replace(/must have required property '[^']*'/g, "is required");
+}
+
+/**
+ * Prefix each error message line with the field label so that AJV fragments
+ * like "is required" become "Name is required".
+ */
+function prefixErrors(label: string, errors: string): string {
+  if (!label || !errors) return errors;
+  return errors
+    .split("\n")
+    .map((line) => `${label} ${line}`)
+    .join("\n");
+}
+
+/**
+ * Convert an AJV ErrorObject's instancePath to a dot-separated control path.
+ * Replicates the logic from @jsonforms/core getControlPath.
+ */
+function getErrorPath(error: ErrorLike): string {
+  let p = (error.instancePath || "").replace(/\//g, ".").replace(/^\./, "");
+  if (error.keyword === "required" && error.params?.missingProperty) {
+    p = p
+      ? p + "." + error.params.missingProperty
+      : error.params.missingProperty;
+  }
+  return p;
+}
+
 export interface ProjectionResult {
   /** The value at the projected path (for rendering) */
   projectedData: ComputedRef<unknown>;
@@ -23,6 +80,10 @@ export interface ProjectionResult {
   handleProjectedChange: (path: string, value: unknown) => void;
   /** Whether projection is active */
   hasProjection: boolean;
+  /** Resolved display label (options.label → projected schema title → control.label) */
+  projectedLabel: ComputedRef<string>;
+  /** Error string combining base-path and projected sub-path errors */
+  projectedErrors: ComputedRef<string>;
 }
 
 /**
@@ -44,14 +105,32 @@ export function useProjection(
     | undefined;
 
   if (!projection) {
+    const label = computed(() => resolveLabel(control.value));
     return {
       projectedData: computed(() => control.value.data),
       projectedSchema: computed(() => control.value.schema),
       handleProjectedChange: handleChange,
       hasProjection: false,
+      projectedLabel: label,
+      projectedErrors: computed(() =>
+        prefixErrors(
+          label.value.replace(/\*$/, "").trim(),
+          normalizeErrors(control.value.errors),
+        ),
+      ),
     };
   }
 
+  // Inject JSONForms state to access raw AJV errors for projected sub-paths.
+  // control.errors only contains errors at the exact control path (e.g. "data_rates"),
+  // but projected fields need errors at the full path (e.g. "data_rates.0.video_rate_usd").
+  const jsonforms = inject<{ core?: { errors?: ErrorLike[] } } | null>(
+    "jsonforms",
+    null,
+  );
+
+  const fullProjectedPath = control.value.path + "." + projection;
+
   const projectedData = computed(() =>
     getProjectedValue(control.value.data, projection),
   );
@@ -60,6 +139,32 @@ export function useProjection(
     getProjectedSchema(control.value.schema, projection),
   );
 
+  const label = computed(() =>
+    resolveLabel(control.value, projectedSchema.value?.title),
+  );
+
+  const projectedErrors = computed(() => {
+    const baseErrors = normalizeErrors(control.value.errors || "");
+
+    const rawErrors = jsonforms?.core?.errors ?? [];
+    const matching = rawErrors.filter(
+      (err) => getErrorPath(err) === fullProjectedPath,
+    );
+
+    let errStr: string;
+    if (matching.length === 0) {
+      errStr = baseErrors;
+    } else {
+      const projMsg = matching
+        .map((e) => (e.keyword === "required" ? "is required" : e.message))
+        .filter(Boolean)
+        .join("\n");
+      errStr = [baseErrors, projMsg].filter(Boolean).join("\n");
+    }
+
+    return prefixErrors(label.value.replace(/\*$/, "").trim(), errStr);
+  });
+
   const handleProjectedChange = (path: string, value: unknown) => {
     const fullValue = setProjectedValue(control.value.data, projection, value);
     handleChange(path, fullValue);
@@ -70,5 +175,7 @@ export function useProjection(
     projectedSchema,
     handleProjectedChange,
     hasProjection: true,
+    projectedLabel: label,
+    projectedErrors,
   };
 }

package/src/vue/composables/useProvider.ts

@@ -10,6 +10,7 @@ import {
 } from "vue";
 import { cache as globalCache } from "../../core/cache";
 import { registry as globalRegistry } from "../../core/registry";
+import { renderObj } from "../../core/templating";
 import type {
   AuthConfig,
   ProviderBinding,
@@ -25,8 +26,11 @@ export function useProvider(
   ctxBits: {
     data: unknown | Ref<unknown> | ComputedRef<unknown>;
     path: string;
-    dependsOnValues?: unknown[];
-    uiQuery?: string;
+    dependsOnValues?: unknown[] | Ref<unknown[]> | ComputedRef<unknown[]>;
+    uiQuery?:
+      | string
+      | Ref<string | undefined>
+      | ComputedRef<string | undefined>;
   },
 ) {
   const registry = inject("providerRegistry", globalRegistry);
@@ -41,14 +45,27 @@ export function useProvider(
   const error = ref<string | undefined>(undefined);
   const ac = new AbortController();
 
-  const cacheKey = computed(() =>
-    JSON.stringify({
-      b: unref(binding),
-      d: ctxBits.dependsOnValues ?? [],
-      q: ctxBits.uiQuery ?? "",
-      data: unref(ctxBits.data), // Include data in cache key for reactivity
-    }),
-  );
+  // Cache key keys on the *rendered* binding config (with template variables
+  // substituted) plus dependsOnValues + uiQuery. This means:
+  //   - `{{data.country}}` in the URL → cache key changes when country changes,
+  //     auto-refetching without callers having to declare dependsOn.
+  //   - Unrelated form fields → rendered URL is unchanged → no refetch.
+  // The protocol's resolve() still receives the raw config and current data,
+  // so per-fetch URL rendering works as before.
+  const cacheKey = computed(() => {
+    const b = unref(binding);
+    const renderedBinding = b
+      ? {
+          ...b,
+          config: renderObj(b.config ?? {}, { data: unref(ctxBits.data) }),
+        }
+      : b;
+    return JSON.stringify({
+      b: renderedBinding,
+      d: unref(ctxBits.dependsOnValues) ?? [],
+      q: unref(ctxBits.uiQuery) ?? "",
+    });
+  });
 
   async function load() {
     const bindingValue = unref(binding);
@@ -71,7 +88,7 @@ export function useProvider(
       const out = await driver.resolve(bindingValue.config ?? {}, {
         data: unref(ctxBits.data),
         path: ctxBits.path,
-        ui: { query: ctxBits.uiQuery },
+        ui: { query: unref(ctxBits.uiQuery) },
         signal: ac.signal,
         auth: resolveAuth(bindingValue.auth, auth),
       });

package/src/vue/index.ts

@@ -1,6 +1,7 @@
 import type { UISchemaElement } from "@jsonforms/core";
 import {
   and,
+  isIntegerControl,
   isNumberControl,
   isStringControl,
   or,
@@ -22,25 +23,38 @@ const isIntegerScope = (uischema: unknown, schema: unknown) => {
   const ui = uischema as { type?: string; scope?: string };
   if (ui?.type !== "Control" || !ui?.scope) return false;
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const propertySchema = resolveScopeSchema(ui.scope, schema as Record<string, any>);
+  const propertySchema = resolveScopeSchema(
+    ui.scope,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    schema as Record<string, any>,
+  );
   return propertySchema?.type === "integer";
 };
 
 // Create specific testers for each component type
 const providerSelectTester = rankWith(
-  106, // Higher than PrimeVue base (100) to ensure providers take precedence
+  107, // Higher than PrimeVue JfNumber integer renderer (106) so provider wins
   and(
-    or(isStringControl, isNumberControl, and(isControl, isIntegerScope)),
+    or(
+      isStringControl,
+      isNumberControl,
+      isIntegerControl,
+      and(isControl, isIntegerScope),
+    ),
     hasProvider,
     (uischema) => !uischema?.options?.autocomplete,
   ),
 );
 
 const providerAutocompleteTester = rankWith(
-  107, // Higher than PrimeVue base (100) to ensure providers take precedence
+  108, // Higher than providerSelectTester so autocomplete variant wins when flagged
   and(
-    or(isStringControl, isNumberControl, and(isControl, isIntegerScope)),
+    or(
+      isStringControl,
+      isNumberControl,
+      isIntegerControl,
+      and(isControl, isIntegerScope),
+    ),
     hasProvider,
     (uischema) => uischema?.options?.autocomplete === true,
   ),
@@ -53,13 +67,16 @@ const isArrayControl = (uischema: UISchemaElement, schema: unknown) => {
     return false;
   }
 
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  const propertySchema = resolveScopeSchema(controlSchema.scope, schema as Record<string, any>);
+  const propertySchema = resolveScopeSchema(
+    controlSchema.scope,
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    schema as Record<string, any>,
+  );
   return propertySchema?.type === "array";
 };
 
 const providerMultiSelectTester = rankWith(
-  108, // Highest priority for array controls with providers
+  109, // Highest priority for array controls with providers
   and(isArrayControl, hasProvider),
 );
 
@@ -79,6 +96,9 @@ export { useProjection } from "./composables/useProjection";
 export type { ProjectionResult } from "./composables/useProjection";
 export { createDataLayer, useDataLayer } from "./composables/useDataLayer";
 export type { DataLayer } from "./composables/useDataLayer";
+export { useDeriveInitialValue } from "./composables/useDeriveInitialValue";
+export type { DeriveInitialValueCfg } from "./composables/useDeriveInitialValue";
+export { useDirtyValidation } from "./composables/useDirtyValidation";
 export * from "./testers";
 
 // Export individual PrimeVue components using lazy evaluation to avoid circular deps

package/src/vue/primevue/JfBoolean.vue

@@ -42,27 +42,40 @@ import type { ControlProps } from "@jsonforms/vue";
 import { useJsonFormsControl } from "@jsonforms/vue";
 import { getCurrentInstance } from "vue";
 import { useProjection } from "../composables/useProjection";
+import { useDirtyValidation } from "../composables/useDirtyValidation";
 import Checkbox from "primevue/checkbox";
 
 // Access props from the component instance
 const instance = getCurrentInstance()!;
 const props = instance.props as unknown as ControlProps;
 const { control, handleChange: rawHandleChange } = useJsonFormsControl(props);
-const { projectedData, handleProjectedChange: handleChange } = useProjection(control, rawHandleChange);
+const {
+  projectedData,
+  handleProjectedChange: handleChange,
+  projectedErrors,
+  projectedLabel,
+} = useProjection(control, rawHandleChange);
 
-const onToggle = (val: boolean) => handleChange(control.value.path, val);
+// Track user interaction — errors only show after first toggle
+const { showErrors, markDirty } = useDirtyValidation(control, projectedErrors);
+
+const onToggle = (val: boolean) => {
+  markDirty();
+  handleChange(control.value.path, val);
+};
 </script>
 
 <template>
-  <div class="flex items-center gap-2">
+  <div class="jf-control" style="flex-direction: row; align-items: center">
     <Checkbox
       :binary="true"
       :model-value="!!projectedData"
       :disabled="!control.enabled"
-      :aria-invalid="!!control.errors || undefined"
+      :class="{ 'p-invalid': showErrors }"
+      :aria-invalid="showErrors || undefined"
       @update:model-value="onToggle"
     />
-    <label v-if="control.label">{{ control.label }}</label>
-    <small v-if="control.errors" class="p-error">{{ control.errors }}</small>
+    <label v-if="projectedLabel" class="jf-label">{{ projectedLabel }}</label>
+    <small v-if="showErrors" class="p-error">{{ projectedErrors }}</small>
   </div>
 </template>

package/src/vue/primevue/JfEnum.vue

@@ -42,10 +42,12 @@ export default {
 import type { JsonSchema } from "@jsonforms/core";
 import type { ControlProps } from "@jsonforms/vue";
 import { useJsonFormsControl } from "@jsonforms/vue";
-import { computed, ref, inject, getCurrentInstance, watch } from "vue";
+import { computed, inject, getCurrentInstance, watch } from "vue";
 import { useProvider } from "../composables/useProvider";
 import { useDerive } from "../composables/useDerive";
+import { useDeriveInitialValue } from "../composables/useDeriveInitialValue";
 import { useProjection } from "../composables/useProjection";
+import { useDirtyValidation } from "../composables/useDirtyValidation";
 import { shouldAutoSelect } from "../utils/autoSelect";
 import Dropdown from "primevue/dropdown";
 
@@ -53,7 +55,12 @@ import Dropdown from "primevue/dropdown";
 const instance = getCurrentInstance()!;
 const props = instance.props as unknown as ControlProps;
 const { control, handleChange: rawHandleChange } = useJsonFormsControl(props);
-const { projectedData, handleProjectedChange: handleChange } = useProjection(control, rawHandleChange);
+const {
+  projectedData,
+  handleProjectedChange: handleChange,
+  projectedErrors,
+  projectedLabel,
+} = useProjection(control, rawHandleChange);
 
 type Opt = { label: string; value: unknown };
 const toOptions = (schema?: JsonSchema): Opt[] => {
@@ -119,7 +126,7 @@ const {
 } = useProvider(binding, {
   data: rootData,
   path: control.value.path,
-  dependsOnValues: depValues.value,
+  dependsOnValues: depValues,
 });
 
 const placeholder = computed<string | undefined>(() => {
@@ -141,6 +148,9 @@ const options = computed(() => {
 // Add derive functionality
 useDerive({ control, handleChange, data: projectedData });
 
+// Add deriveInitialValue — async API-based initial value seeding
+useDeriveInitialValue({ control, handleChange });
+
 // Auto-select when provider returns only one item (enabled by default)
 watch(
   [providerItems, loading],
@@ -157,47 +167,39 @@ watch(
       handleChange(control.value.path, valueToSelect);
     }
   },
-  { immediate: true }
+  { immediate: true },
 );
 
-// Track user interaction
-const hasInteracted = ref(false);
-
-const showErrors = computed(() => hasInteracted.value && control.value.errors);
+// Track user interaction — errors only show after blur
+const { showErrors, markDirty } = useDirtyValidation(control, projectedErrors);
 
 const onSelect = (val: unknown) => {
   handleChange(control.value.path, val);
 };
-
-const onBlur = () => {
-  hasInteracted.value = true;
-};
 </script>
 
 <template>
-  <div class="flex flex-column gap-2">
-    <label v-if="control.label" class="text-color text-left">{{
-      control.label
-    }}</label>
-    <div v-if="control.description" class="text-color-secondary text-left">
+  <div class="jf-control">
+    <label v-if="projectedLabel" class="jf-label">{{ projectedLabel }}</label>
+    <div v-if="control.description" class="jf-description">
       {{ control.description }}
     </div>
     <Dropdown
-      class="w-full"
+      :class="['w-full!', { 'p-invalid': showErrors }]"
       :options="options"
       option-label="label"
       option-value="value"
       :model-value="projectedData ?? null"
       :placeholder="placeholder"
       :disabled="!control.enabled || loading"
-      :aria-invalid="!!showErrors || undefined"
+      :aria-invalid="showErrors || undefined"
       :show-clear="true"
       @update:model-value="onSelect"
-      @blur="onBlur"
+      @blur="markDirty"
     />
     <small v-if="error" class="p-error" role="alert"
       >Failed to load: {{ error }}</small
     >
-    <small v-else-if="showErrors" class="p-error">{{ control.errors }}</small>
+    <small v-else-if="showErrors" class="p-error">{{ projectedErrors }}</small>
   </div>
 </template>