@vertigis/workflow 5.31.0

package/esm/activities/forms/AddFormElement.d.ts

@@ -0,0 +1,18 @@
+import { IActivityHandler, IActivityContext, Deferrable, 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" | "Section" | "Scanner" | "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 action: string;
+    static suite: string;
+    execute(inputs: AddFormElementInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/AddFormElement.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{setFormForElement}from"./FormElementMap.js";class AddFormElement{execute(e,t){var{elementName:n,elementType:r,element:m,targetForm:o}=e;let a=e["form"];if(a=o||a,validation.exists("form",a),validation.string("elementName",n,validation.never),validation.string("elementType",r,validation.never),"Header"===r)throw new Error("A form cannot contain more than one header element.");m=a.actor.addElement(n,r,m);return setFormForElement(m,a),{}}}AddFormElement.action="gcx:wf:forms::AddFormElement",AddFormElement.suite="gcx:wf:builtin";export{AddFormElement};

package/esm/activities/forms/ClearFormElementError.d.ts

@@ -0,0 +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 action: string;
+    static suite: string;
+    execute(inputs: ClearFormElementErrorInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/ClearFormElementError.js

@@ -0,0 +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};

package/esm/activities/forms/CompleteForm.d.ts

@@ -0,0 +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 action: string;
+    static suite: string;
+    execute(inputs: CompleteFormInputs): EmptyOutputs;
+}

package/esm/activities/forms/CompleteForm.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";class CompleteForm{execute(o){const t=validation.exists("form",o.form);o=validation.string("result",o.result,validation.never);return t.result=o,{}}}CompleteForm.action="gcx:wf:forms::CompleteForm",CompleteForm.suite="gcx:wf:builtin";export{CompleteForm};

package/esm/activities/forms/DisplayForm.d.ts

@@ -0,0 +1,46 @@
+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. */
+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 action: string;
+    static suite: string;
+    /** 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;
+}

package/esm/activities/forms/DisplayForm.js

@@ -0,0 +1 @@
+var DisplayForm_1;import{__decorate}from"tslib";import{activate}from"../../Hooks.js";import Bluebird from"../../deps/bluebird_fork.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};

package/esm/activities/forms/Errors.d.ts

@@ -0,0 +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();
+}

package/esm/activities/forms/Errors.js

@@ -0,0 +1 @@
+import{ActivityError}from"../../Errors.js";class FormElementNotFoundError extends ActivityError{constructor(r){super(),this.message="string"==typeof r?`The form does not contain an element with the name '${r}'.`:`The form does not contain this element: ${r}`}}class NoFormElementAvailableError extends ActivityError{constructor(){super(),this.message="No form element was available either via activity input or form event."}}export{FormElementNotFoundError,NoFormElementAvailableError};

package/esm/activities/forms/FilterFormElementItems.d.ts

@@ -0,0 +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 action: string;
+    static suite: string;
+    execute(inputs: FilterFormElementItemsInputs): FilterFormElementItemsOutputs;
+}

package/esm/activities/forms/FilterFormElementItems.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class FilterFormElementItems{execute(e){let{elementName:t,form:m,phrase:r}=e;return"object"==typeof t&&(m=getFormForElement(t)),validation.exists("form",m),t=m.actor.getElementName(t,m.event),"string"!=typeof r&&(e=m.event.argument,r="string"==typeof e?e:""),{result:m.actor.filterItems(t,r)}}}FilterFormElementItems.action="gcx:wf:forms::FilterFormElementItems",FilterFormElementItems.suite="gcx:wf:builtin";export{FilterFormElementItems};

package/esm/activities/forms/FormElementMap.d.ts

@@ -0,0 +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;

package/esm/activities/forms/FormElementMap.js

@@ -0,0 +1 @@
+const FormElementMap=new WeakMap;function getFormForElement(e){return FormElementMap.get(e)}function setFormForElement(e,t){FormElementMap.set(e,t)}export{getFormForElement,setFormForElement};

package/esm/activities/forms/FormRenderer.d.ts

@@ -0,0 +1,132 @@
+import { FormElementRegistration } from "../..";
+import { Activator } from "../../Activator";
+import { Lookup } from "../../Collections";
+import { FormHost, defs, Facility } from "../../forms/FormHost";
+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.
+ */
+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(facility?: Facility): 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;
+    /** Filters the items of an element based on heuristics. */
+    filterItems(elementName: string, input: string): boolean;
+    private isStatus;
+    protected getText(content: defs.Text): defs.Text;
+    renderCustom(component: {}, element: defs.Element): JSX.Element;
+    addElement(elementName: string, type: string, element: defs.Element): defs.Element;
+}

package/esm/activities/forms/FormRenderer.js

@@ -0,0 +1 @@
+import{ActivityCancellationError}from"../../Errors.js";import{FormComponent}from"../../forms/FormComponent.js";import{FormHost,defs}from"../../forms/FormHost.js";import{element as elementRenderers}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 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);"number"==typeof r||parseInt(r);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)=>r===t.label;break;case"value":n=(e,t,r)=>r===t.value;break;default:throw new Error("Unsupported value for itemMatchType: "+r)}for(const i in s.items)if(n(i,s.items[i],t))return s.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,n,e){n=sanitizeValue(r,n,e);const s=this.getElement(t);if(s[r]!==n){const i={},o=this.getElementRegistration(s);if(null!==o&&void 0!==o&&o.onPropertyChange)try{const a=(e,t)=>{i[e]!==t&&(i[e]=t,o.onPropertyChange({properties:{...s,...i},property:e,setProperty:a}))};a(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))s[l]=i[l];if(o&&"value"in i&&this.post("changed",{name:t,value:i.value}),s.customType)this.refresh();else switch(r){case"autoActivate":case"collapsed":case"visible":this.invalidate();break;default:this.invalidate(t)}}}assignItemsToElement(e,t,r){const n=this.getElement(e);let s=n.items||{};!1!==r&&(s={});for(const i in t)s[i]=t[i];n.items=s,"GeometryPicker"!==n.type&&"ItemPicker"!==n.type||delete n.state,this.invalidate(e)}assignElementItemProperty(e,t,r,n,s){const i=this.getElement(e);i.items[t][r]=sanitizeValue(r,n,s),this.refresh(e)}deriveLocale(e){return e?super.deriveLocale(e):(null===(e=this.state)||void 0===e?void 0:e.locale)||"inv"}dispose(){if(super.dispose()){const e=this.state;return void 0!==e&&null!==e&&e.completion.isPending()&&e.reject(new ActivityCancellationError),!0}return!1}load(e,t){var r,t=super.load(e,t);if(t&&null!==(r=this.form)&&void 0!==r&&r.elements)for(const s in this.form.elements){var n=this.form.elements[s];const i=this.getElementRegistration(n);i&&i.getInitialProperties&&(n={...n,...i.getInitialProperties()},this.form.elements[s]=n)}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&&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&&t.name)return t.name;throw new NoFormElementAvailableError}getElementRegistration(e){var t,r;return null===(t=null===(r=null===(t=this.state)||void 0===t?void 0:t.trivia)||void 0===r?void 0:r.getFormElementRegistration)||void 0===t?void 0:t.call(r,null!==(r=e.customType)&&void 0!==r?r:e.type)}renderHtml(e,t){return super.renderHtml(this.getText(e),t)}renderText(e){return super.renderText(this.getText(e))}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 i={};var o=t.toLowerCase().split(/\s+/);for(const m in n){var a=n[m];const f=this.renderText(a.label);var l=f.toLowerCase().split(/\s+/);for(const u of o)if(0<u.length)for(const c of l)0<c.length&&(0!==u.indexOf(c)&&0!==c.indexOf(u)||(s=!0,i[m]=a))}return r.items=i,this.invalidate(e),s}isStatus(e){return null!=e&&"string"==typeof e.status}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 elementRenderers.renderCustom(e,t)}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}}FormRenderer.type=guid+"FormRenderer";export{defs,FormRenderer};

package/esm/activities/forms/GetFormElementItemsFromCollection.d.ts

@@ -0,0 +1,44 @@
+import { Lookup } from "../../Collections";
+import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
+import { Item } from "../../forms/FormDefinition";
+export interface GetFormElementItemsFromCollectionInputs {
+    /** The collection to be converted to the items collection. */
+    collection: any[];
+    /** The name of the field used to populate the items' labels. If not provided, the item itself will be used as the label. */
+    labelFieldName?: string;
+    /** The name of the field used to populate the items' values. If not provided, the item itself is used in a DataRef object. */
+    valueFieldName?: string;
+}
+export interface GetFormElementItemsFromCollectionOutputs {
+    /** The result items collection. */
+    items: Lookup<Item>;
+}
+export declare class GetFormElementItemsFromCollection implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    /**
+     * Checks if there is a field name that matches the supplied label.
+     * @param label The label input to be checked.
+     * @param propertyNames The names of all valid properties.
+     */
+    private _isLabelFieldName;
+    /**
+     * Returns the property name to use based on the supplied value.
+     * If no match is found, `undefined` is returned.
+     * @param propertyName The user-input name of the property.
+     * @param propertyNames The names of all valid properties.
+     * @returns The name of the matching field, or `undefined` if no match was found.
+     */
+    private _getPropertyName;
+    /**
+     * Attempt to get the value of the specified property.
+     * If no match is found, `undefined` is returned.
+     * Values of `null` and `undefined` are converted to empty strings to prevent confusion with a "no match found" result.
+     * @param propertyName The user-input name of the property.
+     * @param propertyNames The names of all valid properties.
+     * @param item An item from the collection.
+     */
+    private _getPropertyValue;
+    private _getTokenValues;
+    execute(inputs: GetFormElementItemsFromCollectionInputs, context: IActivityContext): GetFormElementItemsFromCollectionOutputs;
+}

package/esm/activities/forms/GetFormElementItemsFromCollection.js

@@ -0,0 +1 @@
+import*as TemplateUtils from"../../TemplateUtils.js";import{validation}from"../../Validation.js";import{text}from"../../forms/utils.js";class GetFormElementItemsFromCollection{_isLabelFieldName(e,t){return null!=e&&0!==t.length&&e===this._getPropertyName(e,t)}_getPropertyName(e,t){return t.includes(e)?e:void 0}_getPropertyValue(e,t,l){return(e=this._getPropertyName(e,t))?TemplateUtils.valueOrEmptyString(l[e]):void 0}_getTokenValues(e,t,l){const o={};for(const i of e){var a,r=i.token;o.hasOwnProperty(r)||(a=this._getPropertyValue(r,t,l),a=TemplateUtils.getTokenValueString(r,a),o[r]=text.escapeTextForMarkdown(a))}return o}execute(l,e){var o=l.labelFieldName||void 0,a=validation.array("collection",l.collection,validation.never);const r={};var i=0<a.length?Object.keys(a[0]):[],n=this._isLabelFieldName(o,i),m=n?[]:TemplateUtils.findTokenInstances(o);for(let t=0;t<a.length;++t){var s,c=a[t];let e;e=n?c[l.labelFieldName]:o?(s=this._getTokenValues(m,i,c),TemplateUtils.replacePlaceholders(o,m,s)):c,void 0!==e&&null!==e||(e="");const u={};l.valueFieldName?u.value=c[l.valueFieldName]:u.value={refValueType:"data",type:"object",data:c},text.isMarkdown(e)?u.label=e:u.label=e.toString(),r[t]=u}return{items:r}}}GetFormElementItemsFromCollection.action="gcx:wf:forms::GetFormElementItemsFromCollection",GetFormElementItemsFromCollection.suite="gcx:wf:builtin";export{GetFormElementItemsFromCollection};

package/esm/activities/forms/GetFormElementProperty.d.ts

@@ -0,0 +1,19 @@
+import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface GetFormElementPropertyInputs {
+    form: DisplayFormOutputs;
+    /** The name of the form element. */
+    elementName?: string | defs.Element;
+    /** The name of the element property to get. */
+    name: string;
+}
+export interface GetFormElementPropertyOutputs {
+    /** The value of the property. */
+    value: any;
+}
+export declare class GetFormElementProperty implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: GetFormElementPropertyInputs, context: IActivityContext): GetFormElementPropertyOutputs;
+}

package/esm/activities/forms/GetFormElementProperty.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class GetFormElementProperty{execute(e,t){var{elementName:r,name:o}=e;let m=e["form"];return"object"==typeof r&&(m=getFormForElement(r)),validation.exists("form",m),{value:m.actor.getElement(r,m.event)[o]}}}GetFormElementProperty.action="gcx:wf:forms::GetFormElementProperty",GetFormElementProperty.suite="gcx:wf:builtin";export{GetFormElementProperty};

package/esm/activities/forms/GetFormElementValue.d.ts

@@ -0,0 +1,17 @@
+import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface GetFormElementValueInputs {
+    form: DisplayFormOutputs;
+    /** The name of the form element. */
+    elementName?: string | defs.Element;
+}
+export interface GetFormElementValueOutputs {
+    /** The value of the form element. */
+    value: any;
+}
+export declare class GetFormElementValue implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: GetFormElementValueInputs, context: IActivityContext): GetFormElementValueOutputs;
+}

package/esm/activities/forms/GetFormElementValue.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{isDataRef,isDateRangeRef,isDateTimeRef,isFilesRef,isGeometryRef,isItemsRef,isNumberRef,isScanRef}from"../../forms/utils.js";import{getFormForElement}from"./FormElementMap.js";class GetFormElementValue{execute(e,t){var m=e["elementName"];let a=e["form"];"object"==typeof m&&(a=getFormForElement(m)),validation.exists("form",a);let i=a.actor.getElement(m,a.event).value;return isDataRef(i)?i=i.data:isDateRangeRef(i)?i=[i.startDate,i.endDate]:isDateTimeRef(i)?i=i.value:isFilesRef(i)?i=i.files:isGeometryRef(i)?i=i.geometry:isItemsRef(i)?i=i.items:isNumberRef(i)?i=i.numeric:isScanRef(i)&&(i=i.value),{value:i}}}GetFormElementValue.action="gcx:wf:forms::GetFormElementValue",GetFormElementValue.suite="gcx:wf:builtin";export{GetFormElementValue};

package/esm/activities/forms/GetFormEventData.d.ts

@@ -0,0 +1,17 @@
+import { IActivityHandler } from "../../IActivityHandler";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface GetFormEventDataInputs {
+    form: DisplayFormOutputs;
+}
+export interface GetFormEventDataOutputs {
+    elementId?: string;
+    itemId?: string;
+    type?: string;
+    argument?: any;
+    value?: any;
+}
+export declare class GetFormEventData implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: GetFormEventDataInputs): GetFormEventDataOutputs;
+}

package/esm/activities/forms/GetFormEventData.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";class GetFormEventData{execute(t){t=t.form;validation.exists("form",t);t=t.event;return validation.exists("form.event",t),{elementId:t.name,itemId:t.item,type:t.type,argument:t.argument,value:t.value}}}GetFormEventData.action="gcx:wf:forms::GetFormEventData",GetFormEventData.suite="gcx:wf:builtin";export{GetFormEventData};

package/esm/activities/forms/HideFormElement.d.ts

@@ -0,0 +1,13 @@
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface HideFormElementInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to hide. */
+    elementName?: string | defs.Element;
+}
+export declare class HideFormElement implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: HideFormElementInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/HideFormElement.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class HideFormElement{execute(e,t){var m=e["elementName"];let o=e["form"];"object"==typeof m&&(o=getFormForElement(m)),validation.exists("form",o);m=o.actor.getElement(m,o.event);return o.actor.hideElement(m),{}}}HideFormElement.action="gcx:wf:forms::HideFormElement",HideFormElement.suite="gcx:wf:builtin";export{HideFormElement};

package/esm/activities/forms/PropagateFormEvent.d.ts

@@ -0,0 +1,10 @@
+import { EmptyOutputs, IActivityHandler } from "../../IActivityHandler";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface ControlEventInputs {
+    form: DisplayFormOutputs;
+}
+export declare class PropagateFormEvent implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: ControlEventInputs): EmptyOutputs;
+}

package/esm/activities/forms/PropagateFormEvent.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";class PropagateFormEvent{execute(t){const o=t.form;return validation.exists("form",o),o.route=!0,{}}}PropagateFormEvent.action="gcx:wf:forms::PropagateFormEvent",PropagateFormEvent.suite="gcx:wf:builtin";export{PropagateFormEvent};

package/esm/activities/forms/SetCurrentFormElementItem.d.ts

@@ -0,0 +1,18 @@
+import { IActivityHandler, IActivityContext, Deferrable } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetCurrentFormElementItemInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to update. */
+    elementName?: string | defs.Element;
+    matchType: "index" | "item" | "key" | "label" | "value" | string;
+    value: any;
+}
+export interface SetCurrentFormElementItemOutputs {
+    result: boolean;
+}
+export declare class SetCurrentFormElementItem implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetCurrentFormElementItemInputs, context: IActivityContext): Deferrable<SetCurrentFormElementItemOutputs>;
+}

package/esm/activities/forms/SetCurrentFormElementItem.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class SetCurrentFormElementItem{execute(e,t){var{matchType:a,value:m}=e;let{elementName:r,form:n}=e;switch("object"==typeof r&&(n=getFormForElement(r)),validation.exists("form",n),validation.string("matchType",a,validation.never),validation.exists("value",m),a){case"index":case"item":case"key":case"label":case"value":break;default:validation.fail("matchOn",'The `matchOn` input must be "index", "item", "key", "label" or "value".')}e=n.actor.getElementName(r,n.event);return{result:n.actor.setCurrentItem(e,m,a)}}}SetCurrentFormElementItem.action="gcx:wf:forms::SetCurrentFormElementItem",SetCurrentFormElementItem.suite="gcx:wf:builtin";export{SetCurrentFormElementItem};

package/esm/activities/forms/SetFormElementError.d.ts

@@ -0,0 +1,17 @@
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetFormElementErrorInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to apply the error to. */
+    elementName?: string | defs.Element;
+    /** The error message to apply to the form element. */
+    error: string;
+    /** Controls when strings are interpreted as markdown. */
+    markdown?: boolean;
+}
+export declare class SetFormElementError implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetFormElementErrorInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/SetFormElementError.js

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

package/esm/activities/forms/SetFormElementEvent.d.ts

@@ -0,0 +1,18 @@
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetFormElementEventInputs {
+    form: DisplayFormOutputs;
+    /** The id of the Display Form activity that contains the element to add the event to. */
+    displayFormId: string;
+    /** The ID of the form element to apply the event to. */
+    elementName?: string;
+    /** The name of the event to add to the Element. */
+    eventName: "cancel" | "changed" | "clicked" | "custom" | "dragged" | "load" | "populate" | "submit" | "suggest" | "validate" | string;
+    /** The id of the activity to be used as the event handler. This can be a Container, Subworkflow, or Try Catch. */
+    targetActivityId: string;
+}
+export declare class SetFormElementEvent implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetFormElementEventInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/SetFormElementEvent.js

@@ -0,0 +1 @@
+import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";class SetFormElementEvent{execute(e,t){var i=e["eventName"];let{displayFormId:r,elementName:n,form:o,targetActivityId:m}=e;if(r=validation.string("displayFormId",r),n=validation.string("elementName",n),m=validation.string("targetActivityId",m,validation.never),r&&"$"===r[0]&&(r=r.substring(1)),r=r||t.ambient.activityContexts.$$form.activity.id,!r)throw new GenericActivityError(`No form could be found. displayFormId=${e.displayFormId}`);if(!(n=o.actor.getElementName(n,o.event)))throw new GenericActivityError(`No form element could be found to assign the event to. elementName=${e.elementName}`);return"$"===m[0]&&(m=m.substring(1)),t.ambient.trivia.setFormElementEvent(r,m,n,i),{}}}SetFormElementEvent.action="gcx:wf:forms::SetFormElementEvent",SetFormElementEvent.suite="gcx:wf:builtin";export{SetFormElementEvent};

package/esm/activities/forms/SetFormElementItemProperty.d.ts

@@ -0,0 +1,21 @@
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetFormElementItemPropertyInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element bearing the items. */
+    elementName?: string | defs.Element;
+    /** The key of the item to modify. */
+    itemKey: string | number;
+    /** The name of the property to modify. */
+    propertyName: "checked" | "default" | "enabled" | "index" | "label" | "styleName" | "tooltip" | "validates" | "value" | "visible" | string;
+    /** The value of the property to assign. */
+    propertyValue: any;
+    /** Controls when strings are interpreted as markdown. */
+    markdown?: boolean;
+}
+export declare class SetFormElementItemProperty implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetFormElementItemPropertyInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/SetFormElementItemProperty.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class SetFormElementItemProperty{execute(e,t){var{propertyName:r,propertyValue:o,itemKey:m}=e;let{elementName:i,form:n}=e;"object"==typeof i&&(n=getFormForElement(i)),validation.exists("form",n),validation.exists("itemKey",m);let a=validation.string("itemKey",m,"");""===a&&(a=validation.number("itemKey",m,validation.never));m=a.toString(),e=validation.boolean("markdown",e.markdown,!0);return i=n.actor.getElementName(i,n.event),n.actor.assignElementItemProperty(i,m,r,o,e),{}}}SetFormElementItemProperty.action="gcx:wf:forms::SetFormElementItemProperty",SetFormElementItemProperty.suite="gcx:wf:builtin";export{SetFormElementItemProperty};

package/esm/activities/forms/SetFormElementItems.d.ts

@@ -0,0 +1,19 @@
+import { Lookup } from "../../Collections";
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { Item } from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetFormElementItemsInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the fom element to assign items to. */
+    elementName?: string | defs.Element;
+    /** The collection of items to assign to the element. */
+    items: Lookup<Item>;
+    /** Controls if the collection is cleared prior to assigning the items. */
+    reset?: boolean;
+}
+export declare class SetFormElementItems implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetFormElementItemsInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/esm/activities/forms/SetFormElementItems.js

@@ -0,0 +1 @@
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class SetFormElementItems{execute(e,t){var m=e["items"];let{elementName:o,form:r}=e;"object"==typeof o&&(r=getFormForElement(o)),validation.exists("form",r);e=validation.boolean("reset",e.reset,!0);return o=r.actor.getElementName(o,r.event),r.actor.assignItemsToElement(o,m,e),{}}}SetFormElementItems.action="gcx:wf:forms::SetFormElementItems",SetFormElementItems.suite="gcx:wf:builtin";export{SetFormElementItems};

package/esm/activities/forms/SetFormElementProperty.d.ts

@@ -0,0 +1,19 @@
+import { IActivityHandler, IActivityContext, Deferrable, EmptyOutputs } from "../../IActivityHandler";
+import * as defs from "../../forms/FormDefinition";
+import { DisplayFormOutputs } from "./DisplayForm";
+export interface SetFormElementPropertyInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to modify. */
+    elementName?: string | defs.Element;
+    /** The name of the element property to modify. */
+    propertyName: "autoActivate" | "checked" | "collapsed" | "current" | "delay" | "dependsOn" | "description" | "enabled" | "error" | "fileTypes" | "format" | "itemLabel" | "items" | "label" | "manualEntry" | "maxLength" | "minLength" | "orientation" | "prompt" | "readOnly" | "require" | "rowIndex" | "rowNumber" | "selectionMode" | "showFilter" | "size" | "styleName" | "title" | "titleLocation" | "tooltip" | "type" | "validates" | "value" | "visible" | "wrap" | string;
+    /** The value to assign to the property. */
+    propertyValue: any;
+    /** Controls when strings are interpreted as markdown. */
+    markdown?: boolean;
+}
+export declare class SetFormElementProperty implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: SetFormElementPropertyInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}