@vertigis/workflow 5.36.0 → 5.37.1

package/activities/forms/FormRenderer.js

@@ -1 +1 @@
-import{ActivityAbortedError}from"../../Errors.js";import{FormHost,defs}from"../../forms/FormHost.js";import{FormElementTypes}from"../../forms/constants.js";import{BuiltInFormElements}from"../../forms/manifest.js";import{text}from"../../forms/utils.js";import{FormElementNotFoundError,NoFormElementAvailableError}from"./Errors.js";function toMarkdownRef(e,t){if("string"!=typeof t)return t;switch(e){case"description":case"error":case"itemLabel":case"label":case"title":return{markdown:t};default:return 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 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}assignElementProperty(t,r,s,e=!1,n=!0){e&&(s=toMarkdownRef(r,s));const o=this.getElement(t);if(o[r]!==s){const i={},a=this.getElementRegistration(o);if(a?.onPropertyChange)try{const l=(e,t)=>{i[e]!==t&&(i[e]=t,a.onPropertyChange({properties:{...o,...i},property:e,setProperty:l}))};l(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))o[m]=i[m];if(a&&"value"in i&&!1!==n&&(n={..."object"==typeof n?n:{},name:t,value:i.value},this.post("changed",n)),o.customType||BuiltInFormElements[o.type])this.refresh();else switch(r){case"autoActivate":case"collapsed":case"visible":this.invalidate();break;default:this.invalidate(t)}}}assignElementItemProperty(e,t,r,s,n){const o=this.getElement(e);o.items[t][r]=n?toMarkdownRef(r,s):s,this.refresh(e)}assignItemsToElement(e,t,r){const s=this.getElement(e);let n=s.items||{};!1!==r&&(n={});for(const o in t)n[o]=t[o];s.items=n,s.type!==FormElementTypes.GEOMETRYPICKER&&s.type!==FormElementTypes.ITEMPICKER||delete s.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 s=r.items;if(null==s)return!1;if("string"!=typeof t)return t;let n=!1;const o={};var i=t.toLowerCase().split(/\s+/);for(const m in s){var a=s[m];const f=this.renderText(a.label);var l=f.toLowerCase().split(/\s+/);for(const c of i)if(0<c.length)for(const h of l)0<h.length&&(0!==c.indexOf(h)&&0!==h.indexOf(c)||(n=!0,o[m]=a))}return r.items=o,this.invalidate(e),n}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){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}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 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}renderHtml(e,t){return super.renderHtml(this.getText(e),t)}renderText(e){return super.renderText(this.getText(e))}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 o in n.items)if(s(o,n.items[o],t))return n.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};
+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 c of i)if(0<c.length)for(const h of m)0<h.length&&0===h.indexOf(c)&&(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,[FormElementTypes.AUTOCOMPLETE,FormElementTypes.DROPDOWNLIST,FormElementTypes.RADIOGROUP].includes(s.type)&&(s.label=s.items[o].label,s.value=s.items[o].value),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};

package/activities/forms/GetFormElementItemsFromCollection.d.ts

@@ -1,50 +1,49 @@
-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 readonly action = "gcx:wf:forms::GetFormElementItemsFromCollection";
-    static readonly suite = "gcx:wf:builtin";
-    /**
-     * 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;
-    /**
-     * Gets all of the property names that are valid for the specified object.
-     * We can't simply rely on `Object.keys(obj)` as it could be inheriting properties.
-     * Instead, we check every prototype.
-     */
-    private getPropertyNames;
-    execute(inputs: GetFormElementItemsFromCollectionInputs, context: IActivityContext): GetFormElementItemsFromCollectionOutputs;
-}
+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: Record<string, Item>;
+}
+export declare class GetFormElementItemsFromCollection implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::GetFormElementItemsFromCollection";
+    static readonly suite = "gcx:wf:builtin";
+    /**
+     * 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;
+    /**
+     * Gets all of the property names that are valid for the specified object.
+     * We can't simply rely on `Object.keys(obj)` as it could be inheriting properties.
+     * Instead, we check every prototype.
+     */
+    private getPropertyNames;
+    execute(inputs: GetFormElementItemsFromCollectionInputs, context: IActivityContext): GetFormElementItemsFromCollectionOutputs;
+}

package/activities/forms/GetFormElementItemsFromCollection.js

@@ -1 +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 r,a=i.token;o.hasOwnProperty(a)||(r=this._getPropertyValue(a,t,l),r=TemplateUtils.getTokenValueString(a,r),o[a]=text.escapeTextForMarkdown(r))}return o}getPropertyNames(e){const t=[];if(!e)return t;for(const l in e)"function"!=typeof e[l]&&t.push(l);return t}execute(l,e){var o=l.labelFieldName||void 0,r=validation.array("collection",l.collection,validation.never);const a={};var i=0<r.length?this.getPropertyNames(r[0]):[],n=this._isLabelFieldName(o,i),s=n?[]:TemplateUtils.findTokenInstances(o);for(let t=0;t<r.length;++t){var m,c=r[t];let e;e=n?c[l.labelFieldName]:o?(m=this._getTokenValues(s,i,c),TemplateUtils.replacePlaceholders(o,s,m)):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(),a[t]=u}return{items:a}}}GetFormElementItemsFromCollection.action="gcx:wf:forms::GetFormElementItemsFromCollection",GetFormElementItemsFromCollection.suite="gcx:wf:builtin";export{GetFormElementItemsFromCollection};
+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){t=this._getPropertyName(e,t);return t?TemplateUtils.valueOrEmptyString(l[t]):void 0}_getTokenValues(e,t,l){const o={};for(const i of e){var r,a=i.token;o.hasOwnProperty(a)||(r=this._getPropertyValue(a,t,l),r=TemplateUtils.getTokenValueString(a,r),o[a]=text.escapeTextForMarkdown(r))}return o}getPropertyNames(e){const t=[];if(!e)return t;for(const l in e)"function"!=typeof e[l]&&t.push(l);return t}execute(l,e){var o=l.labelFieldName||void 0,r=validation.array("collection",l.collection,validation.never);const a={};var i=0<r.length?this.getPropertyNames(r[0]):[],n=this._isLabelFieldName(o,i),s=n?[]:TemplateUtils.findTokenInstances(o);for(let t=0;t<r.length;++t){var m,c=r[t];let e;e=n?c[l.labelFieldName]:o?(m=this._getTokenValues(s,i,c),TemplateUtils.replacePlaceholders(o,s,m)):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(),a[t]=u}return{items:a}}}GetFormElementItemsFromCollection.action="gcx:wf:forms::GetFormElementItemsFromCollection",GetFormElementItemsFromCollection.suite="gcx:wf:builtin";export{GetFormElementItemsFromCollection};

package/activities/forms/GetFormElementProperty.d.ts

@@ -1,19 +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 readonly action = "gcx:wf:forms::GetFormElementProperty";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: GetFormElementPropertyInputs, context: IActivityContext): GetFormElementPropertyOutputs;
-}
+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 readonly action = "gcx:wf:forms::GetFormElementProperty";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: GetFormElementPropertyInputs, context: IActivityContext): GetFormElementPropertyOutputs;
+}

package/activities/forms/GetFormElementValue.d.ts

@@ -1,17 +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 readonly action = "gcx:wf:forms::GetFormElementValue";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: GetFormElementValueInputs, context: IActivityContext): GetFormElementValueOutputs;
-}
+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 readonly action = "gcx:wf:forms::GetFormElementValue";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: GetFormElementValueInputs, context: IActivityContext): GetFormElementValueOutputs;
+}

package/activities/forms/GetFormEventData.d.ts

@@ -1,17 +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 readonly action = "gcx:wf:forms::GetFormEventData";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: GetFormEventDataInputs): GetFormEventDataOutputs;
-}
+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 readonly action = "gcx:wf:forms::GetFormEventData";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: GetFormEventDataInputs): GetFormEventDataOutputs;
+}

package/activities/forms/HideFormElement.d.ts

@@ -1,13 +1,13 @@
-import { IActivityHandler, 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 readonly action = "gcx:wf:forms::HideFormElement";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: HideFormElementInputs): EmptyOutputs;
-}
+import { IActivityHandler, 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 readonly action = "gcx:wf:forms::HideFormElement";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: HideFormElementInputs): EmptyOutputs;
+}

package/activities/forms/PropagateFormEvent.d.ts

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

package/activities/forms/SetCurrentFormElementItem.d.ts

@@ -1,18 +1,18 @@
-import { IActivityHandler } 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 readonly action = "gcx:wf:forms::SetCurrentFormElementItem";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetCurrentFormElementItemInputs): SetCurrentFormElementItemOutputs;
-}
+import { IActivityHandler } 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 readonly action = "gcx:wf:forms::SetCurrentFormElementItem";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetCurrentFormElementItemInputs): SetCurrentFormElementItemOutputs;
+}

package/activities/forms/SetCurrentFormElementItem.js

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

package/activities/forms/SetFormElementError.d.ts

@@ -1,17 +1,17 @@
-import { IActivityHandler, 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 readonly action = "gcx:wf:forms::SetFormElementError";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetFormElementErrorInputs): EmptyOutputs;
-}
+import { IActivityHandler, 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 readonly action = "gcx:wf:forms::SetFormElementError";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetFormElementErrorInputs): EmptyOutputs;
+}

package/activities/forms/SetFormElementEvent.d.ts

@@ -1,18 +1,18 @@
-import { IActivityHandler, IActivityContext, 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 readonly action = "gcx:wf:forms::SetFormElementEvent";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetFormElementEventInputs, context: IActivityContext): EmptyOutputs;
-}
+import { IActivityHandler, IActivityContext, 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 readonly action = "gcx:wf:forms::SetFormElementEvent";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetFormElementEventInputs, context: IActivityContext): EmptyOutputs;
+}

package/activities/forms/SetFormElementItemProperty.d.ts

@@ -1,21 +1,34 @@
-import { IActivityHandler, 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 readonly action = "gcx:wf:forms::SetFormElementItemProperty";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetFormElementItemPropertyInputs): EmptyOutputs;
-}
+import { IActivityHandler, 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 readonly action = "gcx:wf:forms::SetFormElementItemProperty";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetFormElementItemPropertyInputs): EmptyOutputs;
+    /**
+     * This list is based on the data type of the property rather than how the content is rendered.
+     * In order to support markdown, a property needs to support the `MarkdownRef` data type,
+     * which is included in `Text`, defined in `FormDefinition`. If a Form Element subsequently
+     * passed this to `renderText()`, it would still handle the markdown appropriately. Styling would be stripped out
+     * and you would be left with readable text. For example "**hello** there" would become "hello there".
+     *
+     * On the other hand, properties that expect a `string` must not ever be set to a `MarkdownRef`
+     * as the element is not expected to perform any conversion on them.
+     * @param propertyName The name of the property to check
+     * @returns True if this property could accept markdown, false otherwise.
+     */
+    private propertyAllowsMarkdown;
+}

package/activities/forms/SetFormElementItemProperty.js

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

package/activities/forms/SetFormElementItems.d.ts

@@ -1,19 +1,18 @@
-import { Lookup } from "../../Collections";
-import { IActivityHandler, 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 readonly action = "gcx:wf:forms::SetFormElementItems";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetFormElementItemsInputs): EmptyOutputs;
-}
+import { IActivityHandler, 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: Record<string, Item>;
+    /** Controls if the collection is cleared prior to assigning the items. */
+    reset?: boolean;
+}
+export declare class SetFormElementItems implements IActivityHandler {
+    static readonly action = "gcx:wf:forms::SetFormElementItems";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetFormElementItemsInputs): EmptyOutputs;
+}

package/activities/forms/SetFormElementProperty.d.ts

@@ -1,19 +1,32 @@
-import { IActivityHandler, 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: "accessibleDescription" | "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" | "showMinMaxLabels" | "showTickMarks" | "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 readonly action = "gcx:wf:forms::SetFormElementProperty";
-    static readonly suite = "gcx:wf:builtin";
-    execute(inputs: SetFormElementPropertyInputs): EmptyOutputs;
-}
+import { IActivityHandler, 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: "accessibleDescription" | "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" | "showMinMaxLabels" | "showTickMarks" | "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 readonly action = "gcx:wf:forms::SetFormElementProperty";
+    static readonly suite = "gcx:wf:builtin";
+    execute(inputs: SetFormElementPropertyInputs): EmptyOutputs;
+    /**
+     * This list is based on the data type of the property rather than how the content is rendered.
+     * In order to support markdown, a property needs to support the `MarkdownRef` data type,
+     * which is included in `Text`, defined in `FormDefinition`. If a Form Element subsequently
+     * passed this to `renderText()`, it would still handle the markdown appropriately. Styling would be stripped out
+     * and you would be left with readable text. For example "**hello** there" would become "hello there".
+     *
+     * On the other hand, properties that expect a `string` must not ever be set to a `MarkdownRef`
+     * as the element is not expected to perform any conversion on them.
+     * @param propertyName The name of the property to check
+     * @returns True if this property could accept markdown, false otherwise.
+     */
+    private propertyAllowsMarkdown;
+}

package/activities/forms/SetFormElementProperty.js

@@ -1 +1 @@
-import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class SetFormElementProperty{execute(e){var{propertyName:t,propertyValue:r}=e;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.assignElementProperty(o,t,r,e),{}}}SetFormElementProperty.action="gcx:wf:forms::SetFormElementProperty",SetFormElementProperty.suite="gcx:wf:builtin";export{SetFormElementProperty};
+import{validation}from"../../Validation.js";import{getFormForElement}from"./FormElementMap.js";class SetFormElementProperty{execute(e){var{propertyName:t,propertyValue:r}=e;let{elementName:o,form:a}=e;"object"==typeof o&&(a=getFormForElement(o)),validation.exists("form",a);let m=validation.boolean("markdown",e.markdown);return void 0===m&&(m=this.propertyAllowsMarkdown(t)),o=a.actor.getElementName(o,a.event),a.actor.assignElementProperty(o,t,r,m,!1),{}}propertyAllowsMarkdown(e){switch(e){case"description":case"error":case"itemLabel":case"label":case"prompt":case"title":case"tooltip":return!0;default:return!1}}}SetFormElementProperty.action="gcx:wf:forms::SetFormElementProperty",SetFormElementProperty.suite="gcx:wf:builtin";export{SetFormElementProperty};