@abgov/jsonforms-components 2.72.0 → 2.73.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/jsonforms-components",
-  "version": "2.72.0",
+  "version": "2.73.1",
   "license": "Apache-2.0",
   "description": "Government of Alberta - React renderers for JSON Forms based on the design system.",
   "repository": "https://github.com/GovAlta/adsp-monorepo",

package/renderer-catalog.json

@@ -1,7 +1,7 @@
 {
   "schemaVersion": "1.0.0",
-  "generatedAt": "2026-08-21T19:44:51.722Z",
-  "sourceCommit": "1c39a20a72c3d50d067165674de8ae0ded1c7b47",
+  "generatedAt": "2026-08-27T22:10:25.781Z",
+  "sourceCommit": "8963e4fedf4c8f323ddc21c852273f0d75b2f99f",
   "sourcePath": "libs/jsonforms-components/src/index.ts",
   "rendererCount": 33,
   "renderers": [

package/src/lib/Context/ContextProvider.d.ts

@@ -1,5 +1,6 @@
 import React from 'react';
 import { AxiosStatic } from 'axios';
+import type { NavigationOutcome, NavigationTarget } from '../Controls/FormStepper/util/navigationTarget';
 interface AllData {
     [x: string]: any;
 }
@@ -29,7 +30,11 @@ export interface AutoPopulatedValue {
     path: string;
     value: unknown;
 }
-type Props = {
+export interface ExternalNavigationProps {
+    navigationTarget?: NavigationTarget;
+    onNavigationChange?: (outcome: NavigationOutcome) => void;
+}
+type Props = ExternalNavigationProps & {
     children?: React.ReactNode;
     fileManagement?: FileManagement;
     submit?: SubmitManagement;
@@ -59,6 +64,8 @@ export declare class ContextProviderClass {
         formUrl: string | null | undefined;
         autoPopulatedData?: AutoPopulatedValue[];
         formId?: string;
+        navigationTarget?: NavigationTarget;
+        onNavigationChange?: (outcome: NavigationOutcome) => void;
     };
     addFormContextData: (key: string, data: Record<string, unknown> | unknown[]) => void;
     addDataByUrl(key: string, url: string, processDataFunction: (data: object) => string[], token?: string): Promise<void>;

package/src/lib/Controls/FormStepper/index.d.ts

@@ -2,3 +2,4 @@ export * from './FormStepperControl';
 export * from './PageStepperControl';
 export * from './FormStepperTester';
 export * from './FormStepperReviewControl';
+export { getExternalFormPath, getNavigationTargetFromParams, getNavigationTargets, NAVIGATION_PARAMS, type FieldInfo, type FieldTarget, type NavigationOutcome, type NavigationTarget, type NavigationTargetInfo, type PageTarget, } from './util/navigationTarget';

package/src/lib/Controls/FormStepper/util/navigationTarget.d.ts

@@ -0,0 +1,87 @@
+import { UISchemaElement } from '@jsonforms/core';
+import { CategoriesState } from '../context/types';
+export interface PageTarget {
+    pageId: string;
+}
+export interface FieldTarget {
+    pageId?: string;
+    /** JSON pointer to the property, e.g. '#/properties/employer'. */
+    scope?: string;
+    /**
+     * Authored `options.id` on the control. Resolved to that control's scope before navigating, so a
+     * field id and a scope pointer behave identically from there on — including focus, which controls
+     * key off scope.
+     */
+    fieldId?: string;
+    instancePath?: string;
+}
+export type NavigationTarget = PageTarget | FieldTarget;
+export type NavigationOutcome = {
+    status: 'navigated';
+    pageId: string;
+} | {
+    status: 'unavailable';
+    pageId: string;
+    reason: 'hidden' | 'disabled' | 'not-yet-reachable';
+} | {
+    status: 'unknown';
+    requested: NavigationTarget;
+};
+export type NavigationResolution = {
+    outcome: Extract<NavigationOutcome, {
+        status: 'navigated';
+    }>;
+    index: number;
+    scope?: string;
+} | {
+    outcome: Extract<NavigationOutcome, {
+        status: 'unavailable';
+    }>;
+    index: number;
+} | {
+    outcome: Extract<NavigationOutcome, {
+        status: 'unknown';
+    }>;
+};
+export interface FieldInfo {
+    scope: string;
+    /** Present when the control carries an authored `options.id`. */
+    id?: string;
+}
+export interface NavigationTargetInfo {
+    pageId: string;
+    label?: string;
+    authored: boolean;
+    index: number;
+    fields: FieldInfo[];
+}
+export declare const resolveNavigationTarget: (categories: CategoriesState, target: NavigationTarget) => NavigationResolution;
+export declare const getNavigationTargets: (uischema: UISchemaElement) => NavigationTargetInfo[];
+/**
+ * Query parameter names carried by an external navigation link. Exported so a host that has to
+ * parse or strip them by hand is not guessing at string literals.
+ */
+export declare const NAVIGATION_PARAMS: {
+    readonly page: "page";
+    readonly field: "field";
+    readonly fieldId: "fieldId";
+};
+/**
+ * Builds the link that sends a user from somewhere outside a form to a page or field inside it.
+ *
+ * Hosts get this for free rather than re-deriving the parameter names and the id-versus-scope rule
+ * for every summary or task list they build. A scope whose control carries an authored id is
+ * written as that id, which survives the underlying property being renamed.
+ *
+ * @param uischema the form's ui schema, used to resolve the step index and look up authored ids
+ * @param url the form's address in the application that hosts it
+ * @param stepId index of the page, as reported by the review renderers
+ * @param scope JSON pointer of the field being changed
+ * @returns the link, or undefined when neither a page nor a field could be addressed
+ */
+export declare const getExternalFormPath: (uischema: UISchemaElement, url: string, stepId?: number, scope?: string) => string | undefined;
+/**
+ * The other half of getExternalFormPath: turns the parameters back into a target for the form to
+ * consume. The library still never reads the address bar — the host passes in what it found.
+ */
+export declare const getNavigationTargetFromParams: (params: URLSearchParams) => NavigationTarget | undefined;