@abgov/jsonforms-components 1.46.0 → 1.48.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abgov/jsonforms-components",
-  "version": "1.46.0",
+  "version": "1.48.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",
@@ -11,7 +11,8 @@
     "react": "^18.0.0",
     "ajv": "^8.6.1",
     "ajv-errors": "^3.0.0",
-    "ajv-formats": "^3.0.1"
+    "ajv-formats": "^3.0.1",
+    "@mdx-js/mdx": "^3.1.0"
   },
   "dependencies": {
     "axios": "^1.6.7",

package/src/lib/Additional/HelpContent.d.ts

@@ -10,6 +10,7 @@ interface OptionProps {
     height?: string;
     width?: string;
     link?: string;
+    markdown?: boolean;
 }
 interface CustomControlElement extends ControlElement {
     options?: OptionProps;
@@ -22,6 +23,10 @@ interface ExtraHelpContentProps {
 interface CustomControlProps extends ControlProps {
     uischema: CustomControlElement;
 }
+interface MdxMarkdown {
+    markdown: string;
+}
+export declare const MarkdownComponent: ({ markdown }: MdxMarkdown) => JSX.Element;
 export declare const HelpContentComponent: ({ isParent, showLabel, ...props }: CustomControlProps & ExtraHelpContentProps) => JSX.Element;
 export declare const HelpContentTester: RankedTester;
 export declare const HelpContent: React.ComponentType<import("@jsonforms/core").OwnPropsOfControl>;

package/src/lib/Additional/styled-components.d.ts

@@ -1,2 +1,3 @@
 /// <reference types="react" />
 export declare const HelpContentDiv: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;
+export declare const InvalidMarkdown: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<import("react").DetailedHTMLProps<import("react").HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;

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

@@ -6,6 +6,7 @@ export interface FormStepperOptionProps {
     previousButtonLabel?: string;
     previousButtonType?: GoAButtonType;
 }
-export declare const FormStepper: (props: CategorizationStepperLayoutRendererProps) => JSX.Element;
+export declare const FormStepper: (props: CategorizationStepperLayoutRendererProps) => import("react/jsx-runtime").JSX.Element;
+export declare const FormStepperView: (props: CategorizationStepperLayoutRendererProps) => JSX.Element;
 export declare const FormStepperControl: (props: CategorizationStepperLayoutRendererProps & import("@jsonforms/core").OwnPropsOfLayout) => import("react/jsx-runtime").JSX.Element;
 export default FormStepper;

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

@@ -1,2 +1,4 @@
 import { CategorizationStepperLayoutReviewRendererProps } from './types';
 export declare const FormStepperReviewer: (props: CategorizationStepperLayoutReviewRendererProps) => JSX.Element;
+export declare const FormStepperReviewControl: (props: CategorizationStepperLayoutReviewRendererProps & import("@jsonforms/core").OwnPropsOfLayout) => import("react/jsx-runtime").JSX.Element;
+export default FormStepperReviewer;

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

@@ -1,15 +1,14 @@
-import { Categorization, Category, JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry, JsonSchema } from '@jsonforms/core';
-export type CategorizationElement = Category | Categorization;
+import { JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry, JsonSchema } from '@jsonforms/core';
+import { CategorizationElement } from './context/types';
 export interface StepProps {
     category: CategorizationElement;
     categoryIndex: number;
-    step: number;
     schema: JsonSchema;
-    enabled: boolean;
     visible: boolean;
+    enabled: boolean;
     path: string;
-    disabledCategoryMap: boolean[];
     renderers: JsonFormsRendererRegistryEntry[] | undefined;
     cells: JsonFormsCellRendererRegistryEntry[] | undefined;
+    data: Record<string, unknown>;
 }
 export declare const RenderStepElements: (props: StepProps) => JSX.Element;

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

@@ -0,0 +1,26 @@
+import { ReactNode, Dispatch } from 'react';
+import { CategorizationStepperLayoutRendererProps } from '../types';
+import { StepperContextDataType, CategoryState } from './types';
+import Ajv from 'ajv';
+import { JsonFormStepperDispatch } from './reducer';
+export interface JsonFormsStepperContextProviderProps {
+    children: ReactNode;
+    StepperProps: CategorizationStepperLayoutRendererProps & {
+        customDispatch?: Dispatch<any> & {
+            activeId?: number;
+        };
+    };
+}
+export interface JsonFormsStepperContextProps {
+    stepperDispatch: JsonFormStepperDispatch;
+    selectStepperState: () => StepperContextDataType;
+    selectIsDisabled: () => boolean;
+    selectIsActive: (id: number) => boolean;
+    selectPath: () => string;
+    selectCategory: (id: number) => CategoryState;
+    goToPage: (id: number, updateCategoryId?: number) => void;
+}
+export declare const isErrorPathIncluded: (errorPaths: string[], path: string) => boolean;
+export declare const getIncompletePaths: (ajv: Ajv, scopes: string[]) => string[];
+export declare const JsonFormsStepperContext: import("react").Context<JsonFormsStepperContextProps | undefined>;
+export declare const JsonFormsStepperContextProvider: ({ children, StepperProps, }: JsonFormsStepperContextProviderProps) => JSX.Element;

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

@@ -0,0 +1,3 @@
+export * from './StepperContext';
+export * from './types';
+export * from './reducer';

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

@@ -0,0 +1,26 @@
+import { StepperContextDataType } from './types';
+import { ErrorObject } from 'ajv';
+import { Dispatch } from 'react';
+export type JsonFormStepperDispatch = Dispatch<StepperAction>;
+export type StepperAction = {
+    type: 'page/next';
+} | {
+    type: 'page/prev';
+} | {
+    type: 'page/to/index';
+    payload: {
+        id: number;
+    };
+} | {
+    type: 'update/category';
+    payload: {
+        errors: ErrorObject[];
+        id: number;
+    };
+} | {
+    type: 'validate/form';
+    payload: {
+        errors?: ErrorObject[];
+    };
+};
+export declare const stepperReducer: (state: StepperContextDataType, action: StepperAction) => StepperContextDataType;

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

@@ -0,0 +1,27 @@
+import { Categorization, Category } from '@jsonforms/core';
+export interface CategoryInternalState {
+    isCompleted?: boolean;
+    isVisited?: boolean;
+    isValid?: boolean;
+    id: number;
+    uischema?: CategorizationElement;
+    isEnabled?: boolean;
+    visible?: boolean;
+    path?: string;
+}
+export interface CategoryConfig {
+    label: string;
+    scopes: string[];
+}
+export type CategoryState = CategoryInternalState & CategoryConfig;
+export type CategoriesState = Array<CategoryState>;
+export interface StepperContextDataType {
+    categories: CategoriesState;
+    activeId: number;
+    hasNextButton: boolean;
+    hasPrevButton: boolean;
+    path: string;
+    isOnReview: boolean;
+    isValid: boolean;
+}
+export type CategorizationElement = Category | Categorization;

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

@@ -1,3 +1,4 @@
+import { Categorization, Category } from '@jsonforms/core';
 import { StatePropsOfLayout } from '@jsonforms/core';
 import { AjvProps } from '../../util/layout';
 import { TranslateProps } from '@jsonforms/react';
@@ -10,3 +11,4 @@ export interface FormStepperComponentProps {
     controlledNav?: number;
     readOnly?: boolean;
 }
+export type CategorizationElement = Category | Categorization;

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

@@ -1 +1,2 @@
 export declare const getProperty: any;
+export declare const pickPropertyValues: (obj: any, property: string) => string[];

package/src/lib/util/layout.d.ts

@@ -1,4 +1,4 @@
-import { ComponentType } from 'react';
+import React, { ComponentType } from 'react';
 import type { UISchemaElement } from '@jsonforms/core';
 import { JsonFormsCellRendererRegistryEntry, JsonFormsRendererRegistryEntry, JsonSchema, OwnPropsOfRenderer } from '@jsonforms/core';
 import Ajv from 'ajv';
@@ -14,3 +14,5 @@ export interface AjvProps {
 }
 export declare const withAjvProps: <P extends object>(Component: ComponentType<AjvProps & P>) => (props: P) => import("react/jsx-runtime").JSX.Element;
 export declare const LayoutRenderer: ({ elements, schema, path, enabled, direction, renderers, cells, visible, width, }: LayoutRendererProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const ReviewLayoutRenderer: ({ elements, schema, path, enabled, direction, renderers, cells, visible, width, }: LayoutRendererProps) => import("react/jsx-runtime").JSX.Element | null;
+export declare const ReviewGrid: import("styled-components/dist/types").IStyledComponentBase<"web", import("styled-components").FastOmit<React.DetailedHTMLProps<React.HTMLAttributes<HTMLDivElement>, HTMLDivElement>, never>> & string;

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

@@ -1,19 +0,0 @@
-/// <reference types="react" />
-import { GoAFormStepStatusType } from '@abgov/react-components-new';
-export type StepInputStatus = {
-    id: string;
-    value: unknown;
-    required: boolean;
-    type: string | string[] | undefined;
-    step: number;
-};
-export interface StatusTable {
-    [key: string]: StepInputStatus;
-}
-export declare const StepperContext: import("react").Context<{
-    updateStatus: (status: StepInputStatus) => void;
-    isInitialized: (_: string) => boolean;
-    stepId: number;
-}>;
-export declare const getCompletionStatus: (table: StatusTable, step: number, isFormChanged?: boolean) => GoAFormStepStatusType | undefined;
-export declare const logRequiredFields: (table: StatusTable, step: number) => void;