@vertigis/workflow 5.36.0 → 5.37.1

package/activities/forms/AddFormElement.d.ts

@@ -1,18 +1,18 @@
-import { IActivityHandler, IActivityContext, EmptyOutputs } from "../../IActivityHandler";
-import * as defs from "../../forms/FormDefinition";
-import { DisplayFormOutputs } from "./DisplayForm";
-export interface AddFormElementInputs {
-    form: DisplayFormOutputs;
-    /** The ID of the form element to add. */
-    elementName: string;
-    /** The type of form element to add. */
-    elementType: "AutoComplete" | "ButtonBar" | "CheckBox" | "CheckGroup" | "Custom" | "DatePicker" | "DateRangePicker" | "DateTimePicker" | "DropDownList" | "FilePicker" | "GeometryPicker" | "HorizontalRule" | "Image" | "ItemPicker" | "ListBox" | "Number" | "NumberRangeSlider" | "NumberSlider" | "PasswordBox" | "RadioGroup" | "Scanner" | "Section" | "Signature" | "Text" | "TextArea" | "TextBox" | "TimePicker" | string;
-    /** The definition of the form element to add. */
-    element: defs.Element;
-    targetForm?: DisplayFormOutputs;
-}
-export declare class AddFormElement implements IActivityHandler {
-    static readonly action = "gcx:wf:forms::AddFormElement";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: AddFormElementInputs, context: IActivityContext): EmptyOutputs;
-}
+import { IActivityHandler, IActivityContext, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface AddFormElementInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to add. */
+    elementName: string;
+    /** The type of form element to add. */
+    elementType: "AutoComplete" | "ButtonBar" | "CheckBox" | "CheckGroup" | "Custom" | "DatePicker" | "DateRangePicker" | "DateTimePicker" | "DropDownList" | "FilePicker" | "GeometryPicker" | "HorizontalRule" | "Image" | "ItemPicker" | "ListBox" | "Number" | "NumberRangeSlider" | "NumberSlider" | "PasswordBox" | "RadioGroup" | "Scanner" | "Section" | "Signature" | "Text" | "TextArea" | "TextBox" | "TimePicker" | string;
+    /** The definition of the form element to add. */
+    element: defs.Element;
+    targetForm?: DisplayFormOutputs;
+}
+export declare class AddFormElement implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::AddFormElement";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: AddFormElementInputs, context: IActivityContext): EmptyOutputs;
+}

package/activities/forms/ClearFormElementError.d.ts

@@ -1,13 +1,13 @@
-import { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
-import * as defs from "../../forms/FormDefinition";
-import { DisplayFormOutputs } from "./DisplayForm";
-export interface ClearFormElementErrorInputs {
-    form: DisplayFormOutputs;
-    /** The ID of the form element to clear the errors from. */
-    elementName?: string | defs.Element;
-}
-export declare class ClearFormElementError implements IActivityHandler {
-    static readonly action = "gcx:wf:forms::ClearFormElementError";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: ClearFormElementErrorInputs): EmptyOutputs;
-}
+import { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface ClearFormElementErrorInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to clear the errors from. */
+    elementName?: string | defs.Element;
+}
+export declare class ClearFormElementError implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::ClearFormElementError";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: ClearFormElementErrorInputs): EmptyOutputs;
+}

package/activities/forms/CompleteForm.d.ts

@@ -1,11 +1,11 @@
-import { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
-import { DisplayFormOutputs } from "./DisplayForm";
-export interface CompleteFormInputs {
-    form: DisplayFormOutputs;
-    result: string;
-}
-export declare class CompleteForm implements IActivityHandler {
-    static readonly action = "gcx:wf:forms::CompleteForm";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: CompleteFormInputs): EmptyOutputs;
-}
+import { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface CompleteFormInputs {
+    form: DisplayFormOutputs;
+    result: string;
+}
+export declare class CompleteForm implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::CompleteForm";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: CompleteFormInputs): EmptyOutputs;
+}

package/activities/forms/DisplayForm.d.ts

@@ -1,49 +1,48 @@
-import { Lookup } from "../../Collections";
-import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
-import { FormRenderer, defs } from "./FormRenderer";
-/** Defines the inputs for a display form activity. */
-export interface DisplayFormInputs {
-    /** Indicates a name of the form (local to the running workflow). */
-    name: string;
-    /** Indicates the form resource to load if not yet loaded. */
-    form: defs.Form;
-    /** Indicates the form template to load if not yet loaded. */
-    template?: defs.Form;
-    /** Indicates what container to use when displaying the form. */
-    container?: "default" | "modal" | string;
-    /** Indicates what region to use when activating the form's container. */
-    region?: string;
-    /** Indicates that the form should be reset. */
-    reset?: boolean;
-}
-/**
- * Defines the outputs for a display form activity.
- * @public
- */
-export interface DisplayFormOutputs {
-    /** Indicates the state of the form. */
-    state: Lookup<defs.Element>;
-    /** Indicates the result for the form (if set, causes the form to exit on the next pass). */
-    result?: string;
-}
-/** Displays a form. */
-export declare class DisplayForm implements IActivityHandler {
-    static renderers: Lookup<FormRenderer>;
-    /**
-     * Creates a form renderer if it does not exist.
-     * @param inputs The inputs to create the renderer.
-     * @param context The context to use to create the renderer.
-     * @param type The type of FormRenderer (subclass) to create.
-     */
-    static createRenderer(inputs: DisplayFormInputs, context: IActivityContext, type: typeof FormRenderer): FormRenderer;
-    static readonly action = "gcx:wf:forms:form:DisplayForm";
-    static readonly suite = "gcx:wf:builtin";
-    /** Performs the operation on behalf of the engine. */
-    execute(inputs: DisplayFormInputs, context: IActivityContext, type: typeof FormRenderer): Promise<DisplayFormOutputs>;
-    /**
-     * Updates the references in the `ElementMap` for all of the elements
-     * contained in `displayFormOutputs`.
-     * @param displayFormOutputs The outputs of the `DisplayForm` activity.
-     */
-    private static updateElementMap;
-}
+import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
+import { FormRenderer, defs } from "./FormRenderer";
+/** Defines the inputs for a display form activity. */
+export interface DisplayFormInputs {
+    /** Indicates a name of the form (local to the running workflow). */
+    name: string;
+    /** Indicates the form resource to load if not yet loaded. */
+    form: defs.Form;
+    /** Indicates the form template to load if not yet loaded. */
+    template?: defs.Form;
+    /** Indicates what container to use when displaying the form. */
+    container?: "default" | "modal" | string;
+    /** Indicates what region to use when activating the form's container. */
+    region?: string;
+    /** Indicates that the form should be reset. */
+    reset?: boolean;
+}
+/**
+ * Defines the outputs for a display form activity.
+ * @public
+ */
+export interface DisplayFormOutputs {
+    /** Indicates the state of the form. */
+    state: Record<string, defs.Element>;
+    /** Indicates the result for the form (if set, causes the form to exit on the next pass). */
+    result?: string;
+}
+/** Displays a form. */
+export declare class DisplayForm implements IActivityHandler {
+    static renderers: Record<string, FormRenderer | undefined>;
+    /**
+     * Creates a form renderer if it does not exist.
+     * @param inputs The inputs to create the renderer.
+     * @param context The context to use to create the renderer.
+     * @param type The type of FormRenderer (subclass) to create.
+     */
+    static createRenderer(inputs: DisplayFormInputs, context: IActivityContext, type: typeof FormRenderer): FormRenderer;
+    static readonly action = "gcx:wf:forms:form:DisplayForm";
+    static readonly suite = "gcx:wf:builtin";
+    /** Performs the operation on behalf of the engine. */
+    execute(inputs: DisplayFormInputs, context: IActivityContext, type: typeof FormRenderer): Promise<DisplayFormOutputs>;
+    /**
+     * Updates the references in the `ElementMap` for all of the elements
+     * contained in `displayFormOutputs`.
+     * @param displayFormOutputs The outputs of the `DisplayForm` activity.
+     */
+    private static updateElementMap;
+}

package/activities/forms/Errors.d.ts

@@ -1,18 +1,18 @@
-import { ActivityError } from "../../Errors";
-import { Element } from "../../forms/FormDefinition";
-/**
- * Defines an error that occurs when an attempt was made to access a form
- * element using a name that was not found, or to find the name of an element
- * which wasn't present in the form.
- */
-export declare class FormElementNotFoundError extends ActivityError {
-    constructor(element: string | Element);
-}
-/**
- * Defines an error that occurs when an attempt was made to run an activity
- * that requires an element without specifying an element either directly via
- * an activity input or indirectly via a form event.
- */
-export declare class NoFormElementAvailableError extends ActivityError {
-    constructor();
-}
+import { ActivityError } from "../../Errors";
+import { Element } from "../../forms/FormDefinition";
+/**
+ * Defines an error that occurs when an attempt was made to access a form
+ * element using a name that was not found, or to find the name of an element
+ * which wasn't present in the form.
+ */
+export declare class FormElementNotFoundError extends ActivityError {
+    constructor(element: string | Element);
+}
+/**
+ * Defines an error that occurs when an attempt was made to run an activity
+ * that requires an element without specifying an element either directly via
+ * an activity input or indirectly via a form event.
+ */
+export declare class NoFormElementAvailableError extends ActivityError {
+    constructor();
+}

package/activities/forms/FilterFormElementItems.d.ts

@@ -1,16 +1,16 @@
-import { IActivityHandler } from "../../IActivityHandler";
-import * as defs from "../../forms/FormDefinition";
-import { DisplayFormOutputs } from "./DisplayForm";
-export interface FilterFormElementItemsInputs {
-    form: DisplayFormOutputs;
-    elementName?: string | defs.Element;
-    phrase?: string;
-}
-export interface FilterFormElementItemsOutputs {
-    result: boolean;
-}
-export declare class FilterFormElementItems implements IActivityHandler {
-    static readonly action = "gcx:wf:forms::FilterFormElementItems";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: FilterFormElementItemsInputs): FilterFormElementItemsOutputs;
-}
+import { IActivityHandler } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface FilterFormElementItemsInputs {
+    form: DisplayFormOutputs;
+    elementName?: string | defs.Element;
+    phrase?: string;
+}
+export interface FilterFormElementItemsOutputs {
+    result: boolean;
+}
+export declare class FilterFormElementItems implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::FilterFormElementItems";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: FilterFormElementItemsInputs): FilterFormElementItemsOutputs;
+}

package/activities/forms/FormElementMap.d.ts

@@ -1,13 +1,13 @@
-import { DisplayFormOutputs } from "./DisplayForm";
-import { defs } from "./FormRenderer";
-/**
- * Gets the form associated with the specified element.
- * @param element A form element.
- */
-export declare function getFormForElement(element: defs.Element): DisplayFormOutputs | undefined;
-/**
- * Sets the form associated with the specified element.
- * @param element A form element.
- * @param displayFormOutputs A set of form outputs, which are used to identify a form.
- */
-export declare function setFormForElement(element: defs.Element, displayFormOutputs: DisplayFormOutputs): void;
+import { DisplayFormOutputs } from "./DisplayForm";
+import { defs } from "./FormRenderer";
+/**
+ * Gets the form associated with the specified element.
+ * @param element A form element.
+ */
+export declare function getFormForElement(element: defs.Element): DisplayFormOutputs | undefined;
+/**
+ * Sets the form associated with the specified element.
+ * @param element A form element.
+ * @param displayFormOutputs A set of form outputs, which are used to identify a form.
+ */
+export declare function setFormForElement(element: defs.Element, displayFormOutputs: DisplayFormOutputs): void;

package/activities/forms/FormRenderer.d.ts

@@ -1,140 +1,139 @@
-import { Activator } from "../../Activator";
-import { Lookup } from "../../Collections";
-import { FormHost, defs } from "../../forms/FormHost";
-import { FormElementRegistration } from "../../forms/index";
-export { defs };
-/** Defines what the renderer exposes. */
-export interface FormActor {
-    /** Returns the element with the given name. If the element does not exist an error will be thrown. */
-    getElement(element: string | defs.Element, event?: defs.Event): defs.Element;
-    getElementRegistration(element: defs.Element): FormElementRegistration | undefined;
-    /** Returns the name of the given element. If the element does not exist an error will be thrown. */
-    getElementName(element: defs.Element | string, event?: defs.Event): string;
-    /** Sets element visibility to false. */
-    hideElement(element: defs.Element): void;
-    /** Sets element visibility to true. */
-    showElement(element: defs.Element): void;
-    /** Assigns an error message to an element. */
-    setElementError(elementName: string, error: string | undefined, markdown?: boolean): void;
-    /** Finds the specified item and sets it as the current one. Returns true if a match was found, false otherwise. */
-    setCurrentItem(elementName: string, value: defs.Value | defs.Text | defs.Item, matchType: defs.ItemMatchType): boolean;
-    /**
-     * Assigns a property to an element, or overwrites an existing property.
-     * @param elementName The name of the element to be updated.
-     * @param propertyName The name of the property of the element to be updated.
-     * @param propertyValue The new value for the element's property.
-     * @param markdown (optional) True if the value should be treated as markdown, false otherwise. The default value is false.
-     * @param event (optional) Only relevant when `propertyName` is `"value"`. If a boolean value, indicates whether or not to post a "changed" event. If a `Partial<defs.Element>` specifies some of the properties of the event to be posted. Any `name` and `value` provided here are ignored. The default value is true.
-     */
-    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: boolean, event?: Partial<defs.Event> | boolean): void;
-    /** Assigns an items property to an element. */
-    assignItemsToElement(elementName: string, items: Lookup<defs.Item>, reset?: boolean): void;
-    /** Assigns a property to an element item, or overwrites an existing property. */
-    assignElementItemProperty(elementName: string, itemKey: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
-    /** Filters the items of an element based on heuristics. */
-    filterItems(elementName: string, phrase: string): boolean;
-    /**
-     * Adds the supplied element to the form.
-     * @param elementName The unique name for the element.
-     * @param type The type of element to add.
-     * @param element The contents of the element to add.
-     */
-    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
-}
-/**
- * Renders a form on behalf of the DisplayForm activity.
- * @public
- */
-export declare class FormRenderer extends FormHost implements FormActor {
-    static type: string;
-    /** Creates a form renderer. */
-    static create(): FormRenderer;
-    /** Creates a custom form renderer. */
-    static createCustom(): FormRenderer;
-    /** Register this renderer class as the form renderer. */
-    static register(activator: Activator): void;
-    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
-    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: boolean, event?: Partial<defs.Event> | boolean): void;
-    assignElementItemProperty(elementName: string, itemKey: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
-    assignItemsToElement(elementName: string, items: Lookup<defs.Item>, reset?: boolean): void;
-    cancelTool(): void;
-    deriveLocale(): string;
-    /** Disposes the form renderer. */
-    dispose(): boolean;
-    /** Filters the items of an element based on heuristics. */
-    filterItems(elementName: string, input: string): boolean;
-    /**
-     * Returns the specified element or throws an error with a helpful message
-     * if the element does not exist. Throwing an error now makes it easier
-     * to debug than further downstream when it could be less obvious.
-     * Having a shared method allows us to have consistent behaviour and a
-     * consistent message.
-     *
-     * If the supplied element is already an instance of an Element, it is
-     * returned.
-     *
-     * If it is a string, it is looked up.
-     *
-     * If an element was not supplied, we check the supplied event to attempt
-     * to get the element name from there and subsequently look it up.
-     *
-     * This method throws a FormElementNotFoundError if an element name was
-     * supplied but not found, or if the element named in the event was not
-     * found.
-     *
-     * This method throws a NoFormElementAvailableError if no element name was
-     * specified and there was none specified in the event either.
-     *
-     * @param element The name of a form element, or the element itself.
-     * @param event The event for the form.
-     */
-    getElement(element: string | defs.Element, event?: defs.Event): defs.Element;
-    /**
-     * Returns the name of the specified element or throws an error with a
-     * helpful message if the element does not exist. Throwing an error now
-     * makes it easier to debug than further downstream when it could be less
-     * obvious. Having a shared method allows us to have consistent behaviour
-     * and a consistent message.
-     * If the supplied element is already a string, it is returned.
-     *
-     * If it is an actual instance of Element, it is looked up.
-     *
-     * If an element was not supplied, we check the supplied event to attempt
-     * to get the element name from there.
-     *
-     * This method throws a FormElementNotFoundError if an element instance was
-     * supplied but not found.
-     *
-     * This method throws a NoFormElementAvailableError if no element name was
-     * specified and there was none in the event either.
-     *
-     * @param element The name of a form element, or the element itself.
-     * @param event The event for the form.
-     */
-    getElementName(element: defs.Element | string, event?: defs.Event): string;
-    getElementRegistration(element: defs.Element): FormElementRegistration | undefined;
-    protected getText(content: defs.Text): defs.Text;
-    hideElement(element: defs.Element): void;
-    /**
-     * Checks to see if the other FormRenderer is related to this one.
-     * If two forms share the same ambient state, they belong to the
-     * same workflow. Otherwise they may yet be related if the other belongs to
-     * a workflow that is an ancestor of the current workflow.
-     * @param other The other FormRenderer to compare to this one.
-     */
-    isRelated(other: FormRenderer): any;
-    /** Loads the form. */
-    load(): boolean;
-    /** Loads the form with a new definition. */
-    load(form: defs.Form, template?: defs.Form): boolean;
-    /** Renders form text as HTML. */
-    renderHtml(content: defs.Text, htmlContentCategory?: defs.HTMLContentCategory): string;
-    /** Renders form text as plain text. */
-    renderText(content: defs.Text): string;
-    setCurrentItem(elementName: string, searchValue: defs.Value | defs.Text | defs.Item, itemMatchType: defs.ItemMatchType): boolean;
-    setElementError(elementName: string, error: string | undefined, markdown?: boolean): void;
-    showElement(element: defs.Element): void;
-    /** Used to request that the form spins without blocking the application. */
-    spinNoBlock(): boolean;
-    translateText(content: defs.Text): string | defs.MarkdownRef;
-}
+import { Activator } from "../../Activator";
+import { FormHost, defs } from "../../forms/FormHost";
+import { FormElementRegistration } from "../../forms/index";
+export { defs };
+/** Defines what the renderer exposes. */
+export interface FormActor {
+    /** Returns the element with the given name. If the element does not exist an error will be thrown. */
+    getElement(element: string | defs.Element | undefined, event?: defs.Event): defs.Element;
+    getElementRegistration(element: defs.Element): FormElementRegistration | undefined;
+    /** Returns the name of the given element. If the element does not exist an error will be thrown. */
+    getElementName(element: defs.Element | string | undefined, event?: defs.Event): string;
+    /** Sets element visibility to false. */
+    hideElement(element: defs.Element): void;
+    /** Sets element visibility to true. */
+    showElement(element: defs.Element): void;
+    /** Assigns an error message to an element. */
+    setElementError(elementName: string, error: string | undefined, markdown?: boolean): void;
+    /** Finds the specified item and sets it as the current one. Returns true if a match was found, false otherwise. */
+    setCurrentItem(elementName: string, value: defs.Value | defs.Text | defs.Item, matchType: defs.ItemMatchType): boolean;
+    /**
+     * Assigns a property to an element, or overwrites an existing property.
+     * @param elementName The name of the element to be updated.
+     * @param propertyName The name of the property of the element to be updated.
+     * @param propertyValue The new value for the element's property.
+     * @param markdown (optional) True if the value should be treated as markdown, false otherwise. The default value is false.
+     * @param event (optional) Only relevant when `propertyName` is `"value"`. If a boolean value, indicates whether or not to post a "changed" event. If a `Partial<defs.Element>` specifies some of the properties of the event to be posted. Any `name` and `value` provided here are ignored. The default value is true.
+     */
+    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: boolean, event?: Partial<defs.Event> | boolean): void;
+    /** Assigns an items property to an element. */
+    assignItemsToElement(elementName: string, items: Record<string, defs.Item>, reset?: boolean): void;
+    /** Assigns a property to an element item, or overwrites an existing property. */
+    assignElementItemProperty(elementName: string, itemKey: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
+    /** Filters the items of an element based on heuristics. */
+    filterItems(elementName: string, phrase: string): boolean;
+    /**
+     * Adds the supplied element to the form.
+     * @param elementName The unique name for the element.
+     * @param type The type of element to add.
+     * @param element The contents of the element to add.
+     */
+    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
+}
+/**
+ * Renders a form on behalf of the DisplayForm activity.
+ * @public
+ */
+export declare class FormRenderer extends FormHost implements FormActor {
+    static type: string;
+    /** Creates a form renderer. */
+    static create(): FormRenderer;
+    /** Creates a custom form renderer. */
+    static createCustom(): FormRenderer;
+    /** Register this renderer class as the form renderer. */
+    static register(activator: Activator): void;
+    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
+    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: boolean, event?: Partial<defs.Event> | boolean): void;
+    assignElementItemProperty(elementName: string, itemKey: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
+    assignItemsToElement(elementName: string, items: Record<string, defs.Item>, reset?: boolean): void;
+    cancelTool(): void;
+    deriveLocale(): string;
+    /** Disposes the form renderer. */
+    dispose(): boolean;
+    /** Filters the items of an element based on heuristics. */
+    filterItems(elementName: string, input: string): boolean;
+    /**
+     * Returns the specified element or throws an error with a helpful message
+     * if the element does not exist. Throwing an error now makes it easier
+     * to debug than further downstream when it could be less obvious.
+     * Having a shared method allows us to have consistent behaviour and a
+     * consistent message.
+     *
+     * If the supplied element is already an instance of an Element, it is
+     * returned.
+     *
+     * If it is a string, it is looked up.
+     *
+     * If an element was not supplied, we check the supplied event to attempt
+     * to get the element name from there and subsequently look it up.
+     *
+     * This method throws a FormElementNotFoundError if an element name was
+     * supplied but not found, or if the element named in the event was not
+     * found.
+     *
+     * This method throws a NoFormElementAvailableError if no element name was
+     * specified and there was none specified in the event either.
+     *
+     * @param element The name of a form element, or the element itself.
+     * @param event The event for the form.
+     */
+    getElement(element: string | defs.Element | undefined, event?: defs.Event): defs.Element;
+    /**
+     * Returns the name of the specified element or throws an error with a
+     * helpful message if the element does not exist. Throwing an error now
+     * makes it easier to debug than further downstream when it could be less
+     * obvious. Having a shared method allows us to have consistent behaviour
+     * and a consistent message.
+     * If the supplied element is already a string, it is returned.
+     *
+     * If it is an actual instance of Element, it is looked up.
+     *
+     * If an element was not supplied, we check the supplied event to attempt
+     * to get the element name from there.
+     *
+     * This method throws a FormElementNotFoundError if an element instance was
+     * supplied but not found.
+     *
+     * This method throws a NoFormElementAvailableError if no element name was
+     * specified and there was none in the event either.
+     *
+     * @param element The name of a form element, or the element itself.
+     * @param event The event for the form.
+     */
+    getElementName(element: defs.Element | string | undefined, event?: defs.Event): string;
+    getElementRegistration(element: defs.Element): FormElementRegistration | undefined;
+    protected getText(content: defs.Text | undefined): defs.Text | undefined;
+    hideElement(element: defs.Element): void;
+    /**
+     * Checks to see if the other FormRenderer is related to this one.
+     * If two forms share the same ambient state, they belong to the
+     * same workflow. Otherwise they may yet be related if the other belongs to
+     * a workflow that is an ancestor of the current workflow.
+     * @param other The other FormRenderer to compare to this one.
+     */
+    isRelated(other: FormRenderer): any;
+    /** Loads the form. */
+    load(): boolean;
+    /** Loads the form with a new definition. */
+    load(form: defs.Form, template?: defs.Form): boolean;
+    /** Renders form text as HTML. */
+    renderHtml(content: defs.Text, htmlContentCategory?: defs.HTMLContentCategory): string;
+    /** Renders form text as plain text. */
+    renderText(content: defs.Text | undefined): string;
+    setCurrentItem(elementName: string, searchValue: defs.Value | defs.Text | defs.Item, itemMatchType: defs.ItemMatchType): boolean;
+    setElementError(elementName: string, error: string | undefined, markdown?: boolean): void;
+    showElement(element: defs.Element): void;
+    /** Used to request that the form spins without blocking the application. */
+    spinNoBlock(): boolean;
+    translateText(content: defs.Text): string | defs.MarkdownRef | undefined;
+}