@vertigis/workflow 5.35.1 → 5.37.0

package/activities/forms/ClearFormElementError.d.ts

@@ -1,13 +1,13 @@
-import { IActivityHandler, IActivityContext, Deferrable, 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, context: IActivityContext): Deferrable<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/ClearFormElementError.js

@@ -1 +1 @@
-import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class ClearFormElementError{execute(e,r){let{elementName:o,form:t}=e;return"object"==typeof o&&(t=getFormForElement(o)),validation.exists("form",t),o=t.actor.getElementName(o,t.event),t.actor.setElementError(o,void 0),{}}}ClearFormElementError.action="gcx:wf:forms::ClearFormElementError",ClearFormElementError.suite="gcx:wf:builtin";export{ClearFormElementError};
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class ClearFormElementError{execute(e){let{elementName:r,form:o}=e;return"object"==typeof r&&(o=getFormForElement(r)),validation.exists("form",o),r=o.actor.getElementName(r,o.event),o.actor.setElementError(r,void 0),{}}}ClearFormElementError.action="gcx:wf:forms::ClearFormElementError",ClearFormElementError.suite="gcx:wf:builtin";export{ClearFormElementError};

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, Deferrable } 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): Deferrable<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/DisplayForm.js

@@ -1 +1 @@
-var DisplayForm_1;import{__decorate}from"tslib";import Bluebird from"bluebird";import{activate}from"../../Hooks.js";import{setFormForElement}from"./FormElementMap.js";import{FormRenderer}from"./FormRenderer.js";function loop(r,o){let i,s;var e=new Bluebird((e,t)=>{i=e,s=t});let n=r();return function e(){for(;n.isFulfilled();){var t;if(void 0===(t=n.value()))break;if(void 0!==(t=o(t))){i(t);break}n=r()}n.isPending()&&n.then(e),n.isRejected()&&s(n.reason())}(),e}let DisplayForm=DisplayForm_1=class{static createRenderer(e,t,r){let o=t.luid,i=!1!==e.reset;var s=e.name;"string"==typeof s&&(o=":"+s);const n=this.renderers;let a=n[o];if(void 0===a){i=!0,a=n[o]=r.create();const l=a.state=t.ambient;var u=function(){delete n[o],a.dispose()};l.completion.then(u,u)}i?a.load(e.form,e.template):a.load();u="string"==typeof e.container?e.container:"default",e="string"==typeof e.region?e.region:void 0;return a.form.defaults.container=void 0!==e||"default"!==u&&"modal"!==u?{name:u,region:e}:u,a}execute(e,n,t){let a=n.state;if(void 0!==a){var r=a.outputs,o=n.caught;if(void 0!==o){var i=r.event,i=i?`Error in ${i.name} element's ${i.type} event in`:"Error in a subworkflow of";return console.error(`${i} a Display Form activity: ${o.message}`,o),n.fork("catch"),a.busy(),a.outputs={actor:a,state:a.form.elements,event:r.event,route:!1,error:o},DisplayForm_1.updateElementMap(a.outputs),a.outputs}o=r.result;if("string"==typeof o)return a.spinNoBlock(),a.outputs={actor:a,state:a.form.elements,event:r.event,route:!1,result:o,status:o},DisplayForm_1.updateElementMap(a.outputs),a.outputs;if("object"==typeof o&&null!==o)return a.spinNoBlock(),Bluebird.reject(o);r.route&&a.route(r.event)}else a=DisplayForm_1.createRenderer(e,n,t),n.persist(a);return a.outputs=void 0,loop(function(){const e=a.observe();return e.isFulfilled()&&void 0===e.value()&&a.dispose(),e},function(e){let t;var r=e.value;const o=("submit"===e.type||"end"===e.type)&&"string"==typeof r?r:void 0;function i(){return t=a.outputs={actor:a,state:a.form.elements,event:e,route:!1,result:o,status:o},DisplayForm_1.updateElementMap(a.outputs),a.outputs}if(!a.trap(e)&&n.hasBranch(e.routingKey)){const s=e.cancellationToken;if(void 0!==s&&null!==s){if(Bluebird.resolve(s).isFulfilled())return void a.route(e);s.then(function(){a.outputs===t&&n.goto()})}else a.busy();return n.fork(e.routingKey),n.registerForErrors(),i()}if(void 0!==o)return a.spinNoBlock(),i();a.route(e)})}static updateElementMap(e){if(e&&e.state)for(const t in e.state)setFormForElement(e.state[t],e)}};DisplayForm.renderers={},DisplayForm.action="gcx:wf:forms:form:DisplayForm",DisplayForm.suite="gcx:wf:builtin",DisplayForm=DisplayForm_1=__decorate([activate(FormRenderer)],DisplayForm);export{DisplayForm};
+var DisplayForm_1;import{__decorate}from"tslib";import Bluebird from"bluebird";import{activate}from"../../Hooks.js";import{setFormForElement}from"./FormElementMap.js";import{FormRenderer}from"./FormRenderer.js";function loop(r,o){let i,s;var e=new Bluebird((e,t)=>{i=e,s=t});let n=r();return function e(){for(;n.isFulfilled();){var t;if(void 0===(t=n.value()))break;if(void 0!==(t=o(t))){i(t);break}n=r()}n.isPending()&&n.then(e),n.isRejected()&&s(n.reason())}(),e}let DisplayForm=DisplayForm_1=class{static createRenderer(e,t,r){let o=t.luid;var i=!1!==e.reset,s=e.name;"string"==typeof s&&(o=":"+s);const n=this.renderers;let l=n[o],a;if(l&&(!1==i&&(a=l.form),delete n[o],l=void 0),void 0===l){l=n[o]=r.create(),a&&(l.form=a);const m=l.state=t.ambient;var u=function(){delete n[o],l.dispose()};m.completion.then(u,u)}a?l.load():l.load(e.form,e.template);u="string"==typeof e.container?e.container:"default",e="string"==typeof e.region?e.region:void 0;return l.form.defaults.container=void 0!==e||"default"!==u&&"modal"!==u?{name:u,region:e}:u,l}execute(e,n,t){let l=n.state;if(void 0!==l){var r=l.outputs,o=n.caught;if(void 0!==o){var i=r.event,i=i?`Error in ${i.name} element's ${i.type} event in`:"Error in a subworkflow of";return console.error(`${i} a Display Form activity: ${o.message}`,o),n.fork("catch"),l.busy(),l.outputs={actor:l,state:l.form.elements,event:r.event,route:!1,error:o},DisplayForm_1.updateElementMap(l.outputs),l.cancelTool(),Promise.resolve(l.outputs)}o=r.result;if("string"==typeof o)return l.spinNoBlock(),l.outputs={actor:l,state:l.form.elements,event:r.event,route:!1,result:o,status:o},DisplayForm_1.updateElementMap(l.outputs),l.cancelTool(),Promise.resolve(l.outputs);if("object"==typeof o&&null!==o)return l.spinNoBlock(),Bluebird.reject(o);r.route&&l.route(r.event)}else l=DisplayForm_1.createRenderer(e,n,t),n.persist(l);return l.outputs=void 0,loop(function(){const e=l.observe();return e.isFulfilled()&&void 0===e.value()&&(console.warn("Error detecting observing form. Promise is fulfilled with no value."),l.dispose()),e},function(e){let t;var r=e.value;const o=("submit"===e.type||"end"===e.type)&&"string"==typeof r?r:void 0;function i(){return t=l.outputs={actor:l,state:l.form.elements,event:e,route:!1,result:o,status:o},DisplayForm_1.updateElementMap(l.outputs),l.cancelTool(),l.outputs}if(!l.trap(e)&&n.hasBranch(e.routingKey)){const s=e.cancellationToken;if(void 0!==s&&null!==s){if(Bluebird.resolve(s).isFulfilled())return void l.route(e);s.then(function(){l.outputs===t&&n.goto()})}else l.busy();return n.fork(e.routingKey),n.registerForErrors(),i()}if(void 0!==o)return l.spinNoBlock(),i();l.route(e)})}static updateElementMap(e){if(e&&e.state)for(const t in e.state)setFormForElement(e.state[t],e)}};DisplayForm.renderers={},DisplayForm.action="gcx:wf:forms:form:DisplayForm",DisplayForm.suite="gcx:wf:builtin",DisplayForm=DisplayForm_1=__decorate([activate(FormRenderer)],DisplayForm);export{DisplayForm};

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,134 +1,139 @@
-/// <reference types="react" />
-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, 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. */
-    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: 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;
-    /** Used to request that the form spins without blocking the application. */
-    spinNoBlock(): boolean;
-    hideElement(element: defs.Element): void;
-    showElement(element: defs.Element): void;
-    setCurrentItem(elementName: string, searchValue: defs.Value | defs.Text | defs.Item, itemMatchType: defs.ItemMatchType): boolean;
-    setElementError(elementName: string, error: string, markdown?: boolean): void;
-    assignElementProperty(elementName: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
-    assignItemsToElement(elementName: string, items: Lookup<defs.Item>, reset?: boolean): void;
-    assignElementItemProperty(elementName: string, itemKey: string, propertyName: string, propertyValue: any, markdown?: boolean): void;
-    deriveLocale(): string;
-    /** Disposes the form renderer. */
-    dispose(): boolean;
-    /** Loads the form. */
-    load(): boolean;
-    /** Loads the form with a new definition. */
-    load(form: defs.Form, template?: defs.Form): boolean;
-    /**
-     * 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;
-    /**
-     * 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;
-    /** Renders form text as HTML. */
-    renderHtml(content: defs.Text, htmlContentCategory?: defs.HTMLContentCategory): string;
-    /** Renders form text as plain text. */
-    renderText(content: defs.Text): string;
-    translateText(content: defs.Text): string | defs.MarkdownRef;
-    /** Filters the items of an element based on heuristics. */
-    filterItems(elementName: string, input: string): boolean;
-    protected getText(content: defs.Text): defs.Text;
-    renderCustom(component: {}, element: defs.Element): JSX.Element;
-    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
-}
+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;
+}

package/activities/forms/FormRenderer.js

@@ -1 +1 @@
-import{ActivityAbortedError}from"../../Errors.js";import{FormComponent}from"../../forms/FormComponent.js";import{FormHost,defs}from"../../forms/FormHost.js";import{FormElementTypes}from"../../forms/constants.js";import{renderElement}from"../../forms/renderers.js";import{text}from"../../forms/utils.js";import{FormElementNotFoundError,NoFormElementAvailableError}from"./Errors.js";function sanitizeValue(e,t,r){if("string"!=typeof t)return t;if(!0!==r)return t;switch(e){case"description":case"error":case"label":case"prompt":case"title":case"tooltip":case"itemLabel":break;default:return t}return{markdown:t}}const guid="F889738A-EBE2-4D52-8B46-3E24CC6E30F6:";class FormRenderer extends FormHost{static create(){return new this}static createCustom(){const e=new this;return e.custom=!0,e}static register(e){e.factories.push(e=>e===this.type?this:void 0)}spinNoBlock(){return this.spin()}hideElement(e){e.visible=!1,this.invalidate()}showElement(e){e.visible=!0,this.invalidate()}setCurrentItem(e,t,r){const n=this.getElement(e);if(!n||!n.items)return!1;let s;switch(r){case"index":s=(e,t,r)=>{var s=Object.keys(n.items);return 0<s.length&&e===s[r]};break;case"item":s=(e,t,r)=>r===t;break;case"key":s=(e,t,r)=>r===e;break;case"label":s=(e,t,r)=>r===t.label;break;case"value":s=(e,t,r)=>r===t.value;break;default:throw new Error("Unsupported value for itemMatchType: "+r)}for(const i in n.items)if(s(i,n.items[i],t))return n.current=i,this.invalidate(e),this.cascade(e),!0;return!1}setElementError(e,t,r){this.errors[e]=sanitizeValue("error",t,r)}assignElementProperty(t,r,s,e){s=sanitizeValue(r,s,e);const n=this.getElement(t);if(n[r]!==s){const i={},o=this.getElementRegistration(n);if(o?.onPropertyChange)try{const a=(e,t)=>{i[e]!==t&&(i[e]=t,o.onPropertyChange({properties:{...n,...i},property:e,setProperty:a}))};a(r,s)}catch(e){throw console.error(`Error setting element property.\nElement: "${t}"\nProperty: "${r}"\nValue: ${s}\n`,e),e}else i[r]=s;for(const m of Object.keys(i))n[m]=i[m];if(o&&"value"in i&&this.post("changed",{name:t,value:i.value}),n.customType)this.refresh();else switch(r){case"autoActivate":case"collapsed":case"visible":this.invalidate();break;default:this.invalidate(t)}}}assignItemsToElement(e,t,r){const s=this.getElement(e);let n=s.items||{};!1!==r&&(n={});for(const i in t)n[i]=t[i];s.items=n,"GeometryPicker"!==s.type&&"ItemPicker"!==s.type||delete s.state,this.invalidate(e)}assignElementItemProperty(e,t,r,s,n){const i=this.getElement(e);i.items[t][r]=sanitizeValue(r,s,n),this.refresh(e)}deriveLocale(){return this.state?.locale||super.deriveLocale()}dispose(){if(super.dispose()){const e=this.state;return void 0!==e&&null!==e&&e.completion.isPending()&&e.reject(new ActivityAbortedError),!0}return!1}load(e,t){t=super.load(e,t);if(t&&this.form?.elements)for(const s in this.form.elements){var r=this.form.elements[s];const n=this.getElementRegistration(r);n&&n.getInitialProperties&&(r={...r,...n.getInitialProperties()},this.form.elements[s]=r)}return t}isRelated(e){return this.state&&this.state.trivia&&this.state.trivia.isDescendantOf&&this.state.trivia.isDescendantOf(e.state)}getElement(e,t){let r;if(e){if("string"!=typeof e)return e;r=e}else t?.name&&(r=t.name);if(r){t=this.form.elements[r];if(!t)throw new FormElementNotFoundError(r);return t}throw new NoFormElementAvailableError}getElementName(e,t){if(e){if("string"==typeof e)return e;for(const r in this.form.elements)if(this.form.elements[r]===e)return r;throw new FormElementNotFoundError(e)}if(t?.name)return t.name;throw new NoFormElementAvailableError}getElementRegistration(e){return this.state?.trivia?.getFormElementRegistration?.(e.customType??e.type)}renderHtml(e,t){return super.renderHtml(this.getText(e),t)}renderText(e){return super.renderText(this.getText(e))}translateText(e){return super.translateText(this.getText(e))}filterItems(e,t){const r=this.find(e);if(void 0===r||null===r)return!1;var s=r.items;if(null==s)return!1;if("string"!=typeof t)return t;let n=!1;const i={};var o=t.toLowerCase().split(/\s+/);for(const l in s){var a=s[l];const f=this.renderText(a.label);var m=f.toLowerCase().split(/\s+/);for(const c of o)if(0<c.length)for(const u of m)0<u.length&&(0!==c.indexOf(u)&&0!==u.indexOf(c)||(n=!0,i[l]=a))}return r.items=i,this.invalidate(e),n}getText(e){if(void 0!==this.state){const r=this.state.environment.getText;if("function"==typeof r){if(text.isMarkdown(e))return{markdown:r(e.markdown)};if(text.isStatus(e))return{markdown:r(`@form-element-status-${e.status}`)};if(e&&"@"===e[0]){var t=r(e);if(t)return t}}}return e}renderCustom(e,t){if(e instanceof FormComponent)return renderElement(FormElementTypes.CUSTOM,e,t)}addElement(e,t,r){if(this.form.elements.hasOwnProperty(e))throw new Error(`Element already present: ${e}`);const s={};if("object"==typeof r)for(const n in r)s[n]=r[n];s.type=t;t=s.section;if(t){let e;if("object"==typeof t?e=t.name:"string"==typeof t&&(e=t),"header"===e||"footer"===e)throw new Error("Elements cannot be added to the header or footer.")}return this.form.elements[e]=s,this.invalidate(),s}}FormRenderer.type=guid+"FormRenderer";export{defs,FormRenderer};
+import{ActivityAbortedError}from"../../Errors.js";import{FormHost,defs}from"../../forms/FormHost.js";import{FormElementTypes}from"../../forms/constants.js";import{getContent}from"../../forms/textUtilities.js";import{text}from"../../forms/utils.js";import{FormElementNotFoundError,NoFormElementAvailableError}from"./Errors.js";function toMarkdownRef(e,t){return"string"!=typeof t?t:{markdown:t}}const guid="F889738A-EBE2-4D52-8B46-3E24CC6E30F6:";class FormRenderer extends FormHost{static create(){return new this}static createCustom(){const e=new this;return e.custom=!0,e}static register(e){e.factories.push(e=>e===this.type?this:void 0)}addElement(e,t,r){if(this.form.elements.hasOwnProperty(e))throw new Error(`Element already present: ${e}`);const n={};if("object"==typeof r)for(const s in r)n[s]=r[s];n.type=t;t=n.section;if(t){let e;if("object"==typeof t?e=t.name:"string"==typeof t&&(e=t),"header"===e||"footer"===e)throw new Error("Elements cannot be added to the header or footer.")}return this.form.elements[e]=n,this.invalidate(),n}assignElementProperty(t,r,n,e=!1,s=!0){e&&(n=toMarkdownRef(r,n));const o=this.getElement(t);if(o[r]!==n){const i={},a=this.getElementRegistration(o);if(a?.onPropertyChange)try{const m=(e,t)=>{i[e]!==t&&(i[e]=t,a.onPropertyChange({properties:{...o,...i},property:e,setProperty:m}))};m(r,n)}catch(e){throw console.error(`Error setting element property.\nElement: "${t}"\nProperty: "${r}"\nValue: ${n}\n`,e),e}else i[r]=n;for(const l of Object.keys(i))o[l]=i[l];a&&"value"in i&&!1!==s&&(t={..."object"==typeof s?s:{},name:t,value:i.value},this.post("changed",t)),this.refresh()}}assignElementItemProperty(e,t,r,n,s){const o=this.getElement(e);o.items[t][r]=s?toMarkdownRef(r,n):n,this.refresh(e)}assignItemsToElement(e,t,r){const n=this.getElement(e);let s=n.items||{};!1!==r&&(s={});for(const o in t)s[o]=t[o];n.items=s,n.type!==FormElementTypes.GEOMETRYPICKER&&n.type!==FormElementTypes.ITEMPICKER||delete n.state,this.invalidate(e)}cancelTool(){}deriveLocale(){return this.state?.locale||super.deriveLocale()}dispose(){if(super.dispose()){const e=this.state;return void 0!==e&&null!==e&&e.completion.isPending()&&e.reject(new ActivityAbortedError),!0}return!1}filterItems(e,t){const r=this.find(e);if(void 0===r||null===r)return!1;var n=r.items;if(null==n)return!1;if("string"!=typeof t)return t;let s=!1;const o={};var i=t.toLowerCase().split(/\s+/);for(const l in n){var a=n[l];const f=this.renderText(a.label);var m=f.toLowerCase().split(/\s+/);for(const h of i)if(0<h.length)for(const c of m)0<c.length&&0===c.indexOf(h)&&(s=!0,o[l]=a)}return r.items=o,this.invalidate(e),s}getElement(e,t){let r;if(e){if("string"!=typeof e)return e;r=e}else t?.name&&(r=t.name);if(r){t=this.form.elements[r];if(!t)throw new FormElementNotFoundError(r);return t}throw new NoFormElementAvailableError}getElementName(e,t){if(e){if("string"==typeof e)return e;for(const r in this.form.elements)if(this.form.elements[r]===e)return r;throw new FormElementNotFoundError(e)}if(t?.name)return t.name;throw new NoFormElementAvailableError}getElementRegistration(e){return this.state?.trivia?.getFormElementRegistration?.(e.customType??e.type)}getText(e){var t=this.state;if(void 0!==t){const r=t.environment.getText;if("function"==typeof r){if(text.isMarkdown(e))return{markdown:r(e.markdown)};if(text.isStatus(e))return{markdown:r(`@form-element-status-${e.status}`)};if(e&&"@"===e[0]){t=r(e);if(t)return t}}}return e}hideElement(e){e.visible=!1,this.invalidate()}isRelated(e){return this.state&&this.state.trivia&&this.state.trivia.isDescendantOf&&this.state.trivia.isDescendantOf(e.state)}load(e,t){t=super.load(e,t);if(t&&this.form?.elements)for(const n in this.form.elements){var r=this.form.elements[n];const s=this.getElementRegistration(r);s&&s.getInitialProperties&&(r={...r,...s.getInitialProperties()},this.form.elements[n]=r)}return t}renderHtml(e,t){return super.renderHtml(this.getText(e),t)}renderText(e){return super.renderText(this.getText(e))}setCurrentItem(e,t,r){const s=this.getElement(e);if(!s||!s.items)return!1;let n;switch(r){case"index":n=(e,t,r)=>{var n=Object.keys(s.items);return 0<n.length&&e===n[r]};break;case"item":n=(e,t,r)=>r===t;break;case"key":n=(e,t,r)=>r===e;break;case"label":n=(e,t,r)=>getContent(r)===getContent(t.label);break;case"value":n=(e,t,r)=>r===t.value;break;default:throw new Error("Unsupported value for itemMatchType: "+r)}for(const o in s.items)if(n(o,s.items[o],t))return s.current=o,this.invalidate(e),this.cascade(e),!0;return!1}setElementError(e,t,r=!1){this.errors[e]=r?toMarkdownRef("error",t):t}showElement(e){e.visible=!0,this.invalidate()}spinNoBlock(){return this.spin()}translateText(e){return super.translateText(this.getText(e))}}FormRenderer.type=guid+"FormRenderer";export{defs,FormRenderer};