@abgov/jsonforms-components 2.83.0 → 2.84.0

package/index.esm.js

@@ -8909,6 +8909,51 @@ const stepperReducer = (state, action) => {
   }
 };
 
+const getStepInfo = ({
+  categories,
+  activeId
+}) => {
+  const count = categories.length;
+  if (activeId >= count) {
+    return {
+      isFirstStep: false,
+      isLastStep: false,
+      currentStep: 0,
+      isOnReview: activeId === count,
+      isOnTaskList: activeId > count
+    };
+  }
+  const isVisible = visible => visible !== false;
+  const hiddenBefore = categories.filter(c => !isVisible(c.visible) && c.id < activeId).length;
+  const totalSteps = categories.filter(c => isVisible(c.visible)).length;
+  const currentStep = activeId + 1 - hiddenBefore;
+  return {
+    isFirstStep: currentStep === 1,
+    isLastStep: currentStep === totalSteps,
+    currentStep,
+    isOnReview: false,
+    isOnTaskList: false
+  };
+};
+const isSameStepInfo = (a, b) => !!a && a.isFirstStep === b.isFirstStep && a.isLastStep === b.isLastStep && a.currentStep === b.currentStep && a.isOnReview === b.isOnReview && a.isOnTaskList === b.isOnTaskList;
+
+// Derives the step info and reports it on mount and whenever its value changes, so typing on a
+// step, a schema recompute or a new callback identity never reports twice.
+const useStepInfo = (state, onStepChange) => {
+  const stepInfo = useMemo(() => getStepInfo(state), [state]);
+  const onStepChangeRef = useRef(onStepChange);
+  onStepChangeRef.current = onStepChange;
+  const lastReported = useRef(undefined);
+  useEffect(() => {
+    if (isSameStepInfo(lastReported.current, stepInfo)) {
+      return;
+    }
+    lastReported.current = stepInfo;
+    onStepChangeRef.current == null || onStepChangeRef.current(stepInfo);
+  }, [stepInfo]);
+  return stepInfo;
+};
+
 var isArray = isArray$6;
 var lengthOfArrayLike$4 = lengthOfArrayLike$d;
 var doesNotExceedSafeInteger$1 = doesNotExceedSafeInteger$3;
@@ -9301,7 +9346,7 @@ const autoPopulatePropertiesMonaco = [];
 // new context value for nothing.
 const NO_AUTO_POPULATED_DATA = [];
 // The props a host can change after mount. See the note where they are applied.
-const HOST_CONTROLLED_KEYS = ['formUrl', 'isFormSubmitted', 'showChangeButtons', 'autoPopulatedData', 'formId', 'navigationTarget', 'onNavigationChange'];
+const HOST_CONTROLLED_KEYS = ['formUrl', 'isFormSubmitted', 'showChangeButtons', 'autoPopulatedData', 'formId', 'navigationTarget', 'onNavigationChange', 'onStepChange'];
 class ContextProviderClass {
   async addDataByUrl(key, url, processDataFunction, token) {
     let header = {};
@@ -9386,7 +9431,8 @@ class ContextProviderClass {
         autoPopulatedData: (_props$autoPopulatedD = props.autoPopulatedData) != null ? _props$autoPopulatedD : NO_AUTO_POPULATED_DATA,
         formId: props.formId,
         navigationTarget: props.navigationTarget,
-        onNavigationChange: props.onNavigationChange
+        onNavigationChange: props.onNavigationChange,
+        onStepChange: props.onStepChange
       });
       const hostControlledChanged = HOST_CONTROLLED_KEYS.some(key => next[key] !== this.baseEnumerator[key]);
       const fileManagementChanged = props.fileManagement !== previousFileManagement;
@@ -10371,6 +10417,7 @@ const JsonFormsStepperContextProvider = ({
   const formId = formCtx == null ? void 0 : formCtx.formId;
   const navigationTarget = formCtx == null ? void 0 : formCtx.navigationTarget;
   const onNavigationChange = formCtx == null ? void 0 : formCtx.onNavigationChange;
+  const onStepChange = formCtx == null ? void 0 : formCtx.onStepChange;
   // Steps opened in an earlier session. Seeding these on first mount is what keeps a step the user
   // has been through from dropping back to NotStarted on resume — including the case where they
   // edited an auto-populated field and then restored the original value, which leaves nothing in
@@ -10443,6 +10490,7 @@ const JsonFormsStepperContextProvider = ({
     snapshotRef.current = computed;
     return computed;
   }, [stepperState, data, schema, ajv]);
+  const stepInfo = useStepInfo(snapshot, onStepChange);
   const context = useMemo(() => {
     return {
       isProvided: true,
@@ -10466,6 +10514,7 @@ const JsonFormsStepperContextProvider = ({
         return snapshot.path;
       },
       selectStepperOptions: () => getStepperPageOptions(uischema),
+      selectStepInfo: () => stepInfo,
       selectCategory: id => {
         return snapshot.categories[id];
       },
@@ -10504,7 +10553,7 @@ const JsonFormsStepperContextProvider = ({
         });
       }
     };
-  }, [stepperDispatch, snapshot, doValidatePage, uischema]);
+  }, [stepperDispatch, snapshot, stepInfo, doValidatePage, uischema]);
   /* istanbul ignore next */
   useEffect(() => {
     var _ctx$core$errors, _ctx$core4;
@@ -19013,6 +19062,22 @@ const CategorizationPagesRendererTester = rankWith(2, and(uiTypeIs('Categorizati
   return ((_uischema$options3 = uischema.options) == null ? void 0 : _uischema$options3.variant) === 'pages';
 }));
 
+// Host-side companion to ContextProvider's onStepChange: holds the reported step as state.
+const useStepChange = listener => {
+  const [stepInfo, setStepInfo] = useState();
+  const listenerRef = useRef(listener);
+  listenerRef.current = listener;
+  // Stable identity, so a host passing it to ContextProvider does not refresh the form context.
+  const onStepChange = useCallback(next => {
+    setStepInfo(next);
+    listenerRef.current == null || listenerRef.current(next);
+  }, []);
+  return {
+    stepInfo,
+    onStepChange
+  };
+};
+
 const isSingleFileUrn = and(schemaTypeIs('string'), formatIs('file-urn'));
 const isFileUrnArray = and(schemaTypeIs('array'), schemaMatches(schema => {
   if (!(schema != null && schema.items) || Array.isArray(schema.items)) {
@@ -22290,4 +22355,4 @@ const goaRenderers = [...GoABaseRenderers, {
 const GoARenderers = memoizeRendererTesters(goaRenderers);
 const GoACells = [...InputCells];
 
-export { ADD_DATALIST_ACTION, ADD_NO_ANONYMOUS_ACTION, ADD_REGISTER_DATA_ACTION, ADD_REGISTER_DATA_ERROR, ADD_USER_ACTION, AUTO_POPULATE_SOURCES, AddressLookUpControl, AddressLookUpControlReview, AddressLookUpTester, AddressLoopUpControlTableReview, ArrayControl, ArrayControlBase, ArrayControlReview, BooleanComponent, BooleanControl, BooleanRadioComponent, BooleanRadioControl, CategorizationPagesRendererTester, CategorizationStepperRendererTester, CheckboxGroup, ContactInformationTester, ContextProviderC, ContextProviderClass, ContextProviderFactory, ContractInfoControl, ContractInfoControlReview, EnumCheckboxControl, EnumRadioControl, EnumSelect, FileUploader, FileUploaderReview, FileUploaderTester, FormPageStepper, FormPagesView, FormStepper, FormStepperControl, FormStepperPagesControl, FormStepperReviewControl, FormStepperReviewer, FormStepperView, FullNameControl, FullNameControlReview, FullNameDobControl, FullNameDobReviewControl, FullNameDobTester, FullNameReviewControl, FullNameTester, GoAArrayControlRenderer, GoAArrayControlReviewRenderer, GoAArrayControlTester, GoABaseInputReviewComponent, GoABaseRenderers, GoABaseReviewRenderers, GoABaseTableReviewRenderers, GoABooleanControl, GoABooleanControlTester, GoABooleanRadioControl, GoABooleanRadioControlTester, GoACalculationControl, GoACalculationControlTester, GoACells, GoACheckoutGroupControlTester, GoAContractInfoControlReview, GoADateControl, GoADateControlTester, GoADateInput, GoADateTimeControl, GoADateTimeControlTester, GoADateTimeInput, GoAEmailControl, GoAEmailControlTester, GoAEmailInput, GoAEnumCheckboxGroupControl, GoAEnumControl, GoAEnumControlTester, GoAEnumRadioGroupControl, GoAInputBaseControl, GoAInputBaseFullNameControlReview, GoAInputBaseFullNameDobControlReview, GoAInputBaseReviewControl, GoAInputBaseTableReview, GoAInputBaseTableReviewControl, GoAInputDateControl, GoAInputDateTimeControl, GoAInputEmailControl, GoAInputIntegerControl, GoAInputNumberControl, GoAInputText, GoAInputTextControl, GoAInputTimeControl, GoAIntegerControl, GoAIntegerControlTester, GoAListWithDetailsControlRenderer, GoAListWithDetailsTester, GoANumberControl, GoANumberControlTester, GoANumberInput, GoAPhoneNumberControl, GoAPhoneNumberWithTypeControl, GoAPrimitiveArrayRenderer, GoAPrimitiveArrayTester, GoARadioGroupControlTester, GoARenderers, GoAReviewRenderers, GoATextControl, GoATextControlTester, GoATimeControl, GoATimeControlTester, GoATimeInput, GoInputBaseReview, GoabInputBasePhoneNumberReviewControl, GoabInputBasePhoneNumberWithTypeReviewControl, GoabInputInteger, InnerGoAInputText, JsonFormContext, JsonFormRegisterProvider, JsonFormsRegisterContext, ListWithDetailsControl, MultiLineText, MultiLineTextControl, MultiLineTextControlInput, MultiLineTextControlTester, NAVIGATION_PARAMS, OPTION_DEFINITIONS, PHONE_REGEX, PhoneGrid, PhoneNumberControl, PhoneNumberReviewControl, PhoneNumberTester, PhoneNumberWithTypeControl, PhoneNumberWithTypeReviewControl, PhoneNumberWithTypeTester, PrimitiveArrayControl, REVIEW_CHANGE_ACTION, RadioGroup, ReviewRenderContext, ReviewRenderProvider, USER_FIELD_DEFINITIONS, autoPopulatePropertiesMonaco, autoPopulateValue, categoriesAreValid, createAutoPopulateMiddleware, createDefaultAjv, enumControl, errMalformedDate, fetchRegisterConfigFromOptions$1 as fetchRegisterConfigFromOptions, getAutoPopulateControls, getAutoPopulatedData, getByJsonPointer, getCategoryScopes, getExternalFormPath, getNavigationTargetFromParams, getNavigationTargets, hasDataInScopes, hasDataValue, isAddressLookup, isContactInformation, isFullName, isFullNameDoB, isPhoneNumberWithType, memoizeRendererTesters, memoizeTester, mergeAutoPopulatedData, predictiveOptionsMonaco, registerReducer, resolveRefs, toDateTimeLocalInputValue, tryResolveRefs, useRegisterUser, useReviewContext, useShowChangeButtons };
+export { ADD_DATALIST_ACTION, ADD_NO_ANONYMOUS_ACTION, ADD_REGISTER_DATA_ACTION, ADD_REGISTER_DATA_ERROR, ADD_USER_ACTION, AUTO_POPULATE_SOURCES, AddressLookUpControl, AddressLookUpControlReview, AddressLookUpTester, AddressLoopUpControlTableReview, ArrayControl, ArrayControlBase, ArrayControlReview, BooleanComponent, BooleanControl, BooleanRadioComponent, BooleanRadioControl, CategorizationPagesRendererTester, CategorizationStepperRendererTester, CheckboxGroup, ContactInformationTester, ContextProviderC, ContextProviderClass, ContextProviderFactory, ContractInfoControl, ContractInfoControlReview, EnumCheckboxControl, EnumRadioControl, EnumSelect, FileUploader, FileUploaderReview, FileUploaderTester, FormPageStepper, FormPagesView, FormStepper, FormStepperControl, FormStepperPagesControl, FormStepperReviewControl, FormStepperReviewer, FormStepperView, FullNameControl, FullNameControlReview, FullNameDobControl, FullNameDobReviewControl, FullNameDobTester, FullNameReviewControl, FullNameTester, GoAArrayControlRenderer, GoAArrayControlReviewRenderer, GoAArrayControlTester, GoABaseInputReviewComponent, GoABaseRenderers, GoABaseReviewRenderers, GoABaseTableReviewRenderers, GoABooleanControl, GoABooleanControlTester, GoABooleanRadioControl, GoABooleanRadioControlTester, GoACalculationControl, GoACalculationControlTester, GoACells, GoACheckoutGroupControlTester, GoAContractInfoControlReview, GoADateControl, GoADateControlTester, GoADateInput, GoADateTimeControl, GoADateTimeControlTester, GoADateTimeInput, GoAEmailControl, GoAEmailControlTester, GoAEmailInput, GoAEnumCheckboxGroupControl, GoAEnumControl, GoAEnumControlTester, GoAEnumRadioGroupControl, GoAInputBaseControl, GoAInputBaseFullNameControlReview, GoAInputBaseFullNameDobControlReview, GoAInputBaseReviewControl, GoAInputBaseTableReview, GoAInputBaseTableReviewControl, GoAInputDateControl, GoAInputDateTimeControl, GoAInputEmailControl, GoAInputIntegerControl, GoAInputNumberControl, GoAInputText, GoAInputTextControl, GoAInputTimeControl, GoAIntegerControl, GoAIntegerControlTester, GoAListWithDetailsControlRenderer, GoAListWithDetailsTester, GoANumberControl, GoANumberControlTester, GoANumberInput, GoAPhoneNumberControl, GoAPhoneNumberWithTypeControl, GoAPrimitiveArrayRenderer, GoAPrimitiveArrayTester, GoARadioGroupControlTester, GoARenderers, GoAReviewRenderers, GoATextControl, GoATextControlTester, GoATimeControl, GoATimeControlTester, GoATimeInput, GoInputBaseReview, GoabInputBasePhoneNumberReviewControl, GoabInputBasePhoneNumberWithTypeReviewControl, GoabInputInteger, InnerGoAInputText, JsonFormContext, JsonFormRegisterProvider, JsonFormsRegisterContext, ListWithDetailsControl, MultiLineText, MultiLineTextControl, MultiLineTextControlInput, MultiLineTextControlTester, NAVIGATION_PARAMS, OPTION_DEFINITIONS, PHONE_REGEX, PhoneGrid, PhoneNumberControl, PhoneNumberReviewControl, PhoneNumberTester, PhoneNumberWithTypeControl, PhoneNumberWithTypeReviewControl, PhoneNumberWithTypeTester, PrimitiveArrayControl, REVIEW_CHANGE_ACTION, RadioGroup, ReviewRenderContext, ReviewRenderProvider, USER_FIELD_DEFINITIONS, autoPopulatePropertiesMonaco, autoPopulateValue, categoriesAreValid, createAutoPopulateMiddleware, createDefaultAjv, enumControl, errMalformedDate, fetchRegisterConfigFromOptions$1 as fetchRegisterConfigFromOptions, getAutoPopulateControls, getAutoPopulatedData, getByJsonPointer, getCategoryScopes, getExternalFormPath, getNavigationTargetFromParams, getNavigationTargets, hasDataInScopes, hasDataValue, isAddressLookup, isContactInformation, isFullName, isFullNameDoB, isPhoneNumberWithType, memoizeRendererTesters, memoizeTester, mergeAutoPopulatedData, predictiveOptionsMonaco, registerReducer, resolveRefs, toDateTimeLocalInputValue, tryResolveRefs, useRegisterUser, useReviewContext, useShowChangeButtons, useStepChange };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/jsonforms-components",
-  "version": "2.83.0",
+  "version": "2.84.0",
   "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-11-09T17:34:00.090Z",
-  "sourceCommit": "aa7e267b7b5409519d32f5159a697f615219d1f7",
+  "generatedAt": "2026-11-10T15:41:13.455Z",
+  "sourceCommit": "5747ec8fe0d1256aee1914168f50e825e502fba3",
   "sourcePath": "libs/jsonforms-components/src/index.ts",
   "rendererCount": 23,
   "renderers": [

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

@@ -1,6 +1,7 @@
 import React from 'react';
 import { AxiosStatic } from 'axios';
 import type { NavigationOutcome, NavigationTarget } from '../Controls/FormStepper/util/navigationTarget';
+import type { StepInfo } from '../Controls/FormStepper/context/types';
 interface AllData {
     [x: string]: any;
 }
@@ -33,6 +34,7 @@ export interface AutoPopulatedValue {
 export interface ExternalNavigationProps {
     navigationTarget?: NavigationTarget;
     onNavigationChange?: (outcome: NavigationOutcome) => void;
+    onStepChange?: (stepInfo: StepInfo) => void;
 }
 type Props = ExternalNavigationProps & {
     children?: React.ReactNode;
@@ -66,6 +68,7 @@ export declare class ContextProviderClass {
         formId?: string;
         navigationTarget?: NavigationTarget;
         onNavigationChange?: (outcome: NavigationOutcome) => void;
+        onStepChange?: (stepInfo: StepInfo) => 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/context/StepperContext.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode, Dispatch } from 'react';
 import { CategorizationStepperLayoutRendererProps } from '../types';
-import { StepperContextDataType, CategoryState } from './types';
+import { StepperContextDataType, CategoryState, StepInfo } from './types';
 import { JsonFormStepperDispatch } from './reducer';
 import { JsonSchema } from '@jsonforms/core';
 import { ErrorObject } from 'ajv';
@@ -29,6 +29,7 @@ export interface JsonFormsStepperContextProps {
     validatePage: (id: number) => void;
     selectNumberOfCompletedCategories: () => number;
     selectStepperOptions: () => StepperPageOptions;
+    selectStepInfo: () => StepInfo;
     isProvided?: boolean;
 }
 export declare const JsonFormsStepperContext: import("react").Context<JsonFormsStepperContextProps | undefined>;

package/src/lib/Controls/FormStepper/context/stepInfo.d.ts

@@ -0,0 +1,3 @@
+import { StepInfo, StepperContextDataType } from './types';
+export declare const getStepInfo: ({ categories, activeId, }: Pick<StepperContextDataType, "categories" | "activeId">) => StepInfo;
+export declare const isSameStepInfo: (a: StepInfo | undefined, b: StepInfo) => boolean;

package/src/lib/Controls/FormStepper/context/types.d.ts

@@ -41,3 +41,10 @@ export interface StepperContextDataType {
     validationTrigger?: number;
 }
 export type CategorizationElement = Category | Categorization;
+export interface StepInfo {
+    isFirstStep: boolean;
+    isLastStep: boolean;
+    currentStep: number;
+    isOnReview: boolean;
+    isOnTaskList: boolean;
+}

package/src/lib/Controls/FormStepper/context/useStepChange.d.ts

@@ -0,0 +1,6 @@
+import { StepInfo } from './types';
+export interface StepChange {
+    stepInfo?: StepInfo;
+    onStepChange: (stepInfo: StepInfo) => void;
+}
+export declare const useStepChange: (listener?: (stepInfo: StepInfo) => void) => StepChange;

package/src/lib/Controls/FormStepper/context/useStepInfo.d.ts

@@ -0,0 +1,2 @@
+import { StepInfo, StepperContextDataType } from './types';
+export declare const useStepInfo: (state: Pick<StepperContextDataType, "categories" | "activeId">, onStepChange?: (stepInfo: StepInfo) => void) => StepInfo;

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

@@ -3,3 +3,5 @@ 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';
+export type { StepInfo } from './context/types';
+export { useStepChange, type StepChange } from './context/useStepChange';