@vertigis/workflow 5.31.0

package/amd/activities/essentials/GetEssentialsSite.d.ts

@@ -0,0 +1,226 @@
+/// <reference types="arcgis-js-api" />
+import { EmptyInputs, IActivityContext, IActivityHandler } from "../../IActivityHandler";
+export interface Claim {
+    /** Indicates the intermediate issuer of the claim. */
+    issuer: string;
+    /** Indicates the original issuer of the claim. */
+    originalIssuer: string;
+    /** Indicates the type of the claim.*/
+    type: string;
+    /** Indicates the value of the claim. */
+    value: string;
+    /** Indicates the type of the value. */
+    valueType: string;
+}
+export interface DataLink {
+    /** The display name. */
+    displayName: string;
+    /** The ID of the DataLink */
+    id: string;
+    /** Indicates whether the data fetched by the datalink represents a one to one relationship with the feature. */
+    isOneToOne: boolean;
+    /** The properties of the DataLink, defined by the administrator on the server. */
+    properties: any;
+    /** The visibility of the DataLink. */
+    visible: boolean;
+}
+export interface Field {
+    /** The field alias.*/
+    alias: string;
+    /** The type of data the field contains. */
+    dataType: string;
+    /** The display name of the field. */
+    displayName: string;
+    /** Whether the field is presented as editable in the user interface. */
+    editable: boolean;
+    /** The name of the field. */
+    name: string;
+    /** Whether the field will be searched as part of the layer search. */
+    searchable: boolean;
+    /** Whether the field is visible in reports. */
+    visible: boolean;
+}
+export interface Identity {
+    /** A string representing the type of authentication used. */
+    authenticationType: string;
+    /** Contains the list of claims associated with this identity.*/
+    claims: Claim[];
+    /** Flag that indicates if the identity was authenticated. */
+    isAuthenticated: boolean;
+    /** Indicates the label (friendly name) of this identity. */
+    label: string;
+    /** Indicates which claim type is the name. */
+    nameClaimType: string;
+    /** Indicates which claim type is the role. */
+    roleClaimType: string;
+}
+export interface Layer {
+    /** Gets the collection of DataLink objects that belongs to the Layer. */
+    dataLinks: DataLink[];
+    /** The display name of the Layer. */
+    displayName: string;
+    /** The format for a description of a feature from this layer. */
+    featureDescription: string;
+    /** The format for a label of a feature. */
+    featureLabel: string;
+    /** The format for a long description of a feature. */
+    featureLongDescription: string;
+    /** Shape type of the layer. One of: None | Point | Multipoint | Polygon | Line */
+    featureType: string;
+    /** Array of fields associated with this layer. */
+    fields: Field[];
+    /** The full extent of the layer. */
+    fullExtent: __esri.Extent;
+    /** Whether the Layer has attachments associated with it. */
+    hasAttachments: boolean;
+    /** The ID of the Layer. */
+    id: string;
+    /** Whether or not this layer can be identified in the client application. */
+    identifiable: boolean;
+    /** Indicates whether or not a layer was created by a user at runtime **/
+    isUserCreated: boolean;
+    /** The name of the Layer. */
+    name: string;
+    /** Gets the ID of the parent Layer. */
+    parentLayerId: string;
+    /** The properties of the Layer as defined by the administrator on the server. */
+    properties: any;
+    /** A flag indicating whether the layer is queryable or not. */
+    queryable: boolean;
+    /** The collection of Report objects that belongs to the Layer. */
+    reports: Report[];
+    /**  Indicates if the layer is searchable. */
+    searchable: boolean;
+    /** Gets the IDs of all Layer objects that are sub-layers (children) of this Layer. The value is only set when the layer is a group layer. */
+    subLayerIds: string[];
+    /** The type of the layer, such as feature layer, raster layer, group layer, etc. */
+    type: number;
+}
+export interface Map {
+    /** The full extent of the Map. */
+    fullExtent: __esri.Extent;
+    /** The initial extent of the Map. */
+    initialExtent: __esri.Extent;
+    /** The collection of MapService objects. */
+    mapServices: MapService[];
+}
+export interface MapService {
+    /** Description of the map service.  */
+    description: string;
+    /** The display name of the MapService. */
+    displayName: string;
+    /** The ID of the MapService. */
+    id: string;
+    /** Boolean indicating whether this map service is time aware or not */
+    isTimeAware: boolean;
+    /** Indicates whether or not a mapService was created by a user at runtime **/
+    isUserCreated: boolean;
+    /** The collection of Layer objects. */
+    layers: Layer[];
+    /**  The properties of the MapService, as defined by the administrator on the server. */
+    properties: any;
+    /** The Esri map service Layer object. */
+    serviceLayer: __esri.Layer;
+    /** A unique identifier for the service. */
+    serviceTag: string;
+    /** The security token that must be provided when requesting the service from ArcGIS Server. */
+    serviceToken: string;
+    /** The URL of the map service published by ArcGIS Server. */
+    serviceUrl: string;
+    /** The collection of table objects. */
+    tables: Layer[];
+}
+export interface NamedExtent {
+    /** The display name of the NamedExtent. */
+    displayName: string;
+    /** The extent of the NamedExtent. */
+    extent: __esri.Extent;
+    /** The ID of the NamedExtent.*/
+    id: string;
+    /** The properties of the NamedExtent, as defined by an administrator. */
+    properties: any;
+}
+export interface Principal {
+    /** Indicates the expiration time of the principal. */
+    expiry?: string;
+    /** Collection of identities that represents the current user. */
+    identities: Identity[];
+    /** Flag that indicates if the user was authenticated or not. */
+    isAuthenticated: boolean;
+    /** Indicates the label (friendly name) of this principal. */
+    label: string;
+}
+export interface PrintTemplate {
+    /** The description of the PrintTemplate. */
+    description: string;
+    /** The display name of the PrintTemplate. */
+    displayName: string;
+    /** The ID of the PrintTemplate. */
+    id: string;
+    /** The properties of the PrintTemplate, defined by the administrator on the server. */
+    properties: any;
+    /** The visibility of the PrintTemplate.*/
+    visible: boolean;
+}
+export interface Report {
+    /** The description of the Report. */
+    description: string;
+    /** The display name of the Report. */
+    displayName: string;
+    /** The ID of the Report.*/
+    id: string;
+    /** The properties of the Report, defined by the administrator on the server. */
+    properties: any;
+    /** The visibility of the Report. */
+    visible: boolean;
+}
+export interface SearchTable {
+    /** The display name of the SearchTable. */
+    displayName: string;
+    /** The ID of the SearchTable.*/
+    id: string;
+}
+export interface Site {
+    /** The current version of Geocortex Essentials serving the Site. */
+    currentVersion: string;
+    /** The ID of the Site. */
+    id: string;
+    /** The display name of the Site. */
+    displayName: string;
+    /** The Essentials Map defined in the Site. */
+    essentialsMap: Map;
+    /** Collection of NamedExtent objects associated with the Site. */
+    namedExtents: NamedExtent[];
+    /** Information about the connected user. */
+    principal: Principal;
+    /** Collection of PrintTemplate objects associated with the Site. */
+    printTemplates: PrintTemplate[];
+    /** The properties of the Site, as defined by the administrator on the server.*/
+    properties: any;
+    /** Collection of SearchTable objects associated with the Site.*/
+    searchTables: SearchTable[];
+    /** The URL to the Geocortex Essentials Site's REST endpoint. */
+    url: string;
+    /** Collection of Workflow objects associated with the Site. */
+    workflows: Workflow[];
+}
+export interface Workflow {
+    /** The display name of the Workflow.  */
+    displayName: string;
+    /** The ID of the Workflow. */
+    id: string;
+    /** The properties of the Workflow, as defined by an administrator. */
+    properties: any;
+    /** Whether to run the Workflow on startup of the client application.  */
+    runOnStartup: boolean;
+}
+/** Defines outputs from the GetEssentialsSite activity. */
+export interface GetEssentialsSiteOutputs {
+    /** The Essentials site. */
+    site: Site;
+}
+export declare class GetEssentialsSite implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: EmptyInputs, context: IActivityContext): GetEssentialsSiteOutputs;
+}

package/amd/activities/essentials/GetEssentialsSite.js

@@ -0,0 +1 @@
+define(["require","exports"],function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.GetEssentialsSite=void 0;var i=(s.prototype.execute=function(e,t){return{site:t.ambient.trivia.site}},s.action="gcx:wf:essentials::GetEssentialsSite",s.suite="gcx:wf:builtin",s);function s(){}t.GetEssentialsSite=i});

package/amd/activities/essentials/RunEssentialsWorkflow.d.ts

@@ -0,0 +1,26 @@
+import { Lookup } from "../../Collections";
+import { IActivityHandler, IActivityContext } from "../../IActivityHandler";
+import { ChannelProvider } from "../core/ChannelProvider";
+/** Defines inputs for the RunEssentialsWorkflow activity. */
+export interface RunEssentialsWorkflowInputs {
+    /** The URL of the Essentials Workflow, without the "/run" ending. */
+    url: string;
+    /** The input arguments of the Essentials workflow. */
+    arguments?: Lookup<any>;
+    /** The timeout for the request/response. */
+    timeout?: number;
+}
+/** Defines outputs for the RunEssentialsWorkflow activity. */
+export interface RunEssentialsWorkflowOutputs {
+    /** The resulting values of the Out and In/Out Arguments from the Essentials workflow. */
+    result: Lookup<any>;
+}
+export declare class RunEssentialsWorkflow implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: RunEssentialsWorkflowInputs, context: IActivityContext, type: typeof ChannelProvider): PromiseLike<RunEssentialsWorkflowOutputs>;
+    private isString;
+    private getWorkflowSchema;
+    private validateInputs;
+    private constructInArgs;
+}

package/amd/activities/essentials/RunEssentialsWorkflow.js

@@ -0,0 +1 @@
+define(["require","exports","tslib","../../Errors","../../Hooks","../../Validation","../../deps/bluebird_fork","../core/ChannelProvider"],function(e,t,r,c,n,s,f,i){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.RunEssentialsWorkflow=void 0,f=(0,r.__importDefault)(f);var l=function(){this.inputs={}},i=(o.prototype.execute=function(r,n,i){var o=this,a=s.validation.string("url",r.url,s.validation.never);return this.getWorkflowSchema(a,i).then(function(e){var t=o.validateInputs(r.arguments,e);if(t)return f.default.reject(t);var l=i.create(void 0,"geocortex");l.request.url=a+"/run",l.timeout=s.validation.number("timeout",r.timeout,6e4),l.request.method="POST",l.request.headers["Content-Type"]="application/x-www-form-urlencoded",l.request.json={inargs:o.constructInArgs(r.arguments,e),f:"json"},n.cancellationToken.finally(function(){l.cancel()});var p=(new Date).valueOf();return l.send().then(function(u){return f.default.attempt(function(){var e=(new Date).valueOf()-p,t={result:{}};if(u){var r=l.getResponseData(l.response.payload);if("Completed"===r.status){var n=r.outputs;if(n)for(var i=0,o=n;i<o.length;i++){var a=o[i],s=a.name,a=a.value;t.result[s]=a}return t}}n=new c.GenericActivityError(void 0,"Error running Essentials Workflow activity.");return n.timedOut=e>=l.timeout,n.elapsed=e,n.error=l.response.error,n.partialResult=t,f.default.reject(n)})})})},o.prototype.isString=function(e){return"string"==typeof e},o.prototype.getWorkflowSchema=function(e,t){var s=this,u=t.create(void 0,"geocortex");return u.request.url=e,u.request.json={f:"json",deep:!0},u.send().then(function(e){if(e){var t=new l,r=u.getResponseData(u.response.payload).inputs;if(r)for(var n=0,i=r;n<i.length;n++){var o=i[n],a=o.name,o=o.typeName;s.isString(a)&&s.isString(o)&&(t.inputs[a]={name:a,typeName:o})}return f.default.resolve(t)}r=new c.GenericActivityError(void 0,"Error running Essentials Workflow activity. Error retrieving workflow schema.");return f.default.reject(r)})},o.prototype.validateInputs=function(e,t){var r,n,i=[],o=[];for(r in t.inputs)e.hasOwnProperty(r)||i.push(r);for(n in e)t.inputs.hasOwnProperty(n)||o.push(n);if(0<i.length+o.length){var a="",s="";return i.length&&(a=" Missing parameters: "+i),o.length&&(s=" Unexpected parameters: "+o),new c.GenericActivityError(void 0,"Invalid parameters supplied to Essentials Workflow activity."+a+s)}},o.prototype.constructInArgs=function(e,t){var r,n=[];for(r in e)n.push({name:r,typeName:t.inputs[r].typeName,value:e[r]});return n},o.action="gcx:wf:essentials::RunEssentialsWorkflow",o.suite="gcx:wf:builtin",(0,r.__decorate)([(0,n.activate)(i.ChannelProvider)],o));function o(){}t.RunEssentialsWorkflow=i});

package/amd/activities/essentials/RunEssentialsWorkflowActivity.d.ts

@@ -0,0 +1,18 @@
+import { Lookup } from "../../Collections";
+import { IActivityHandler } from "../../IActivityHandler";
+/** Defines inputs for the RunEssentialsWorkflowActivity activity. */
+export interface RunEssentialsWorkflowActivityInputs {
+    action: "Alert" | "CaptureGeometry" | "Confirm" | "ExportMap" | "GetBrowserUrl" | "GetExternalTimeInfo" | "GetExternalValue" | "GetSelectedFeatures" | "PrintMap" | "Prompt" | "Report" | "SetExternalValue" | string;
+    /** The input arguments to the activity. */
+    inputs: any;
+}
+/** Defines outputs for the RunEssentialsWorkflow activity. */
+export interface RunEssentialsWorkflowActivityOutputs {
+    /** The output arguments of the Essentials workflow activity. */
+    result: Lookup<any>;
+}
+export declare class RunEssentialsWorkflowActivity implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: RunEssentialsWorkflowActivityInputs): Promise<RunEssentialsWorkflowActivityOutputs>;
+}

package/amd/activities/essentials/RunEssentialsWorkflowActivity.js

@@ -0,0 +1 @@
+define(["require","exports","../../Errors"],function(t,e,i){"use strict";Object.defineProperty(e,"__esModule",{value:!0}),e.RunEssentialsWorkflowActivity=void 0;var o=(n.prototype.execute=function(t){throw new i.ActivityNotImplementedError(n.action)},n.action="gcx:wf:essentials::RunEssentialsWorkflowActivity",n.suite="gcx:wf:builtin",n);function n(){}e.RunEssentialsWorkflowActivity=o});

package/amd/activities/forms/ActivateFormElement.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 ActivateFormElementInputs {
+    form: DisplayFormOutputs;
+    /** The ID of the form element to activate. */
+    elementName?: string | defs.Element;
+}
+export declare class ActivateFormElement implements IActivityHandler {
+    static action: string;
+    static suite: string;
+    execute(inputs: ActivateFormElementInputs, context: IActivityContext): Deferrable<EmptyOutputs>;
+}

package/amd/activities/forms/ActivateFormElement.js

@@ -0,0 +1 @@
+define(["require","exports","../../Validation","./FormElementMap"],function(e,t,r,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.ActivateFormElement=void 0;var o=(i.prototype.execute=function(e,t){var o=e.elementName,e=e.form;return"object"==typeof o&&(e=(0,n.getFormForElement)(o)),r.validation.exists("form",e),o=e.actor.getElementName(o,e.event),e.actor.assignElementProperty(o,"autoActivate",!0),{}},i.action="gcx:wf:forms::ActivateFormElement",i.suite="gcx:wf:builtin",i);function i(){}t.ActivateFormElement=o});

package/amd/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/amd/activities/forms/AddFormElement.js

@@ -0,0 +1 @@
+define(["require","exports","../../Validation","./FormElementMap"],function(e,t,a,m){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.AddFormElement=void 0;var n=(r.prototype.execute=function(e,t){var n=e.elementName,r=e.elementType,o=e.element,i=e.targetForm,e=e.form,e=i||e;if(a.validation.exists("form",e),a.validation.string("elementName",n,a.validation.never),a.validation.string("elementType",r,a.validation.never),"Header"===r)throw new Error("A form cannot contain more than one header element.");o=e.actor.addElement(n,r,o);return(0,m.setFormForElement)(o,e),{}},r.action="gcx:wf:forms::AddFormElement",r.suite="gcx:wf:builtin",r);function r(){}t.AddFormElement=n});

package/amd/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/amd/activities/forms/ClearFormElementError.js

@@ -0,0 +1 @@
+define(["require","exports","../../Validation","./FormElementMap"],function(e,r,o,n){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.ClearFormElementError=void 0;var t=(i.prototype.execute=function(e,r){var t=e.elementName,e=e.form;return"object"==typeof t&&(e=(0,n.getFormForElement)(t)),o.validation.exists("form",e),t=e.actor.getElementName(t,e.event),e.actor.setElementError(t,void 0),{}},i.action="gcx:wf:forms::ClearFormElementError",i.suite="gcx:wf:builtin",i);function i(){}r.ClearFormElementError=t});

package/amd/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/amd/activities/forms/CompleteForm.js

@@ -0,0 +1 @@
+define(["require","exports","../../Validation"],function(e,t,o){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.CompleteForm=void 0;var i=(r.prototype.execute=function(e){var t=o.validation.exists("form",e.form),e=o.validation.string("result",e.result,o.validation.never);return t.result=e,{}},r.action="gcx:wf:forms::CompleteForm",r.suite="gcx:wf:builtin",r);function r(){}t.CompleteForm=i});

package/amd/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/amd/activities/forms/DisplayForm.js

@@ -0,0 +1 @@
+define(["require","exports","tslib","../../Hooks","../../deps/bluebird_fork","./FormElementMap","./FormRenderer"],function(e,t,r,o,a,n,u){"use strict";function s(r,o){var n,u,e=new a.default(function(e,t){n=e,u=t}),i=r();return function e(){for(;i.isFulfilled();){var t;if(void 0===(t=i.value()))break;if(void 0!==(t=o(t))){n(t);break}i=r()}i.isPending()&&i.then(e),i.isRejected()&&u(i.reason())}(),e}Object.defineProperty(t,"__esModule",{value:!0}),t.DisplayForm=void 0,a=(0,r.__importDefault)(a);var l,u=((l=i).createRenderer=function(e,t,r){var o=t.luid,n=!1!==e.reset,u=e.name;"string"==typeof u&&(o=":"+u);var i=this.renderers,a=i[o];void 0===a&&(n=!0,u=function(){delete i[o],a.dispose()},((a=i[o]=r.create()).state=t.ambient).completion.then(u,u)),n?a.load(e.form,e.template):a.load();n="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"!==n&&"modal"!==n?{name:n,region:e}:n,a},i.prototype.execute=function(e,u,t){var i=u.state;if(void 0!==i){var r=i.outputs,o=u.caught;if(void 0!==o){var n=r.event,n=n?"Error in ".concat(n.name," element's ").concat(n.type," event in"):"Error in a subworkflow of";return console.error("".concat(n," a Display Form activity: ").concat(o.message),o),u.fork("catch"),i.busy(),i.outputs={actor:i,state:i.form.elements,event:r.event,route:!1,error:o},l.updateElementMap(i.outputs),i.outputs}o=r.result;if("string"==typeof o)return i.spinNoBlock(),i.outputs={actor:i,state:i.form.elements,event:r.event,route:!1,result:o,status:o},l.updateElementMap(i.outputs),i.outputs;if("object"==typeof o&&null!==o)return i.spinNoBlock(),a.default.reject(o);r.route&&i.route(r.event)}else i=l.createRenderer(e,u,t),u.persist(i);return i.outputs=void 0,s(function(){var e=i.observe();return e.isFulfilled()&&void 0===e.value()&&i.dispose(),e},function(e){var t,r=e.value,o=("submit"===e.type||"end"===e.type)&&"string"==typeof r?r:void 0;function n(){return t=i.outputs={actor:i,state:i.form.elements,event:e,route:!1,result:o,status:o},l.updateElementMap(i.outputs),i.outputs}if(!i.trap(e)&&u.hasBranch(e.routingKey)){r=e.cancellationToken;if(null!=r){if(a.default.resolve(r).isFulfilled())return void i.route(e);r.then(function(){i.outputs===t&&u.goto()})}else i.busy();return u.fork(e.routingKey),u.registerForErrors(),n()}if(void 0!==o)return i.spinNoBlock(),n();i.route(e)})},i.updateElementMap=function(e){if(e&&e.state)for(var t in e.state)(0,n.setFormForElement)(e.state[t],e)},i.renderers={},i.action="gcx:wf:forms:form:DisplayForm",i.suite="gcx:wf:builtin",l=(0,r.__decorate)([(0,o.activate)(u.FormRenderer)],i));function i(){}t.DisplayForm=u});

package/amd/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/amd/activities/forms/Errors.js

@@ -0,0 +1 @@
+define(["require","exports","tslib","../../Errors"],function(e,r,t,o){"use strict";Object.defineProperty(r,"__esModule",{value:!0}),r.NoFormElementAvailableError=r.FormElementNotFoundError=void 0;var n,i=(n=o.ActivityError,(0,t.__extends)(a,n),a);function a(e){var r=n.call(this)||this;return r.message="string"==typeof e?"The form does not contain an element with the name '".concat(e,"'."):"The form does not contain this element: ".concat(e),r}r.FormElementNotFoundError=i;var s,t=(s=o.ActivityError,(0,t.__extends)(l,s),l);function l(){var e=s.call(this)||this;return e.message="No form element was available either via activity input or form event.",e}r.NoFormElementAvailableError=t});

package/amd/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/amd/activities/forms/FilterFormElementItems.js

@@ -0,0 +1 @@
+define(["require","exports","../../Validation","./FormElementMap"],function(e,t,n,i){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.FilterFormElementItems=void 0;var r=(o.prototype.execute=function(e){var t=e.elementName,r=e.form,o=e.phrase;return"object"==typeof t&&(r=(0,i.getFormForElement)(t)),n.validation.exists("form",r),t=r.actor.getElementName(t,r.event),"string"!=typeof o&&(o="string"==typeof(e=r.event.argument)?e:""),{result:r.actor.filterItems(t,o)}},o.action="gcx:wf:forms::FilterFormElementItems",o.suite="gcx:wf:builtin",o);function o(){}t.FilterFormElementItems=r});

package/amd/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/amd/activities/forms/FormElementMap.js

@@ -0,0 +1 @@
+define(["require","exports"],function(e,t){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),t.setFormForElement=t.getFormForElement=void 0;var r=new WeakMap;t.getFormForElement=function(e){return r.get(e)},t.setFormForElement=function(e,t){r.set(e,t)}});

package/amd/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/amd/activities/forms/FormRenderer.js

@@ -0,0 +1 @@
+define(["require","exports","tslib","../../Errors","../../forms/FormComponent","../../forms/FormHost","../../forms/renderers","../../forms/utils","./Errors"],function(e,t,p,r,n,o,i,s,a){"use strict";function c(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}}Object.defineProperty(t,"__esModule",{value:!0}),t.FormRenderer=t.defs=void 0,Object.defineProperty(t,"defs",{enumerable:!0,get:function(){return o.defs}});var l,u=(l=o.FormHost,(0,p.__extends)(f,l),f.create=function(){return new this},f.createCustom=function(){var e=new this;return e.custom=!0,e},f.register=function(e){var t=this;e.factories.push(function(e){return e===t.type?t:void 0})},f.prototype.spinNoBlock=function(){return this.spin()},f.prototype.hideElement=function(e){e.visible=!1,this.invalidate()},f.prototype.showElement=function(e){e.visible=!0,this.invalidate()},f.prototype.setCurrentItem=function(e,t,r){var n,o,i=this.getElement(e);if(!i||!i.items)return!1;switch(r){case"index":n=function(e,t,r){var n=Object.keys(i.items);"number"==typeof r||parseInt(r);return 0<n.length&&e===n[r]};break;case"item":n=function(e,t,r){return r===t};break;case"key":n=function(e,t,r){return r===e};break;case"label":n=function(e,t,r){return r===t.label};break;case"value":n=function(e,t,r){return r===t.value};break;default:throw new Error("Unsupported value for itemMatchType: "+r)}for(o in i.items)if(n(o,i.items[o],t))return i.current=o,this.invalidate(e),this.cascade(e),!0;return!1},f.prototype.setElementError=function(e,t,r){this.errors[e]=c("error",t,r)},f.prototype.assignElementProperty=function(t,r,n,e){n=c(r,n,e);var o=this.getElement(t);if(o[r]!==n){var i={},s=this.getElementRegistration(o);if(null!=s&&s.onPropertyChange)try{var a=function(e,t){i[e]!==t&&(i[e]=t,s.onPropertyChange({properties:(0,p.__assign)((0,p.__assign)({},o),i),property:e,setProperty:a}))};a(r,n)}catch(e){throw console.error('Error setting element property.\nElement: "'.concat(t,'"\nProperty: "').concat(r,'"\nValue: ').concat(n,"\n"),e),e}else i[r]=n;for(var l=0,u=Object.keys(i);l<u.length;l++){var f=u[l];o[f]=i[f]}if(s&&"value"in i&&this.post("changed",{name:t,value:i.value}),o.customType)this.refresh();else switch(r){case"autoActivate":case"collapsed":case"visible":this.invalidate();break;default:this.invalidate(t)}}},f.prototype.assignItemsToElement=function(e,t,r){var n,o=this.getElement(e),i=o.items||{};for(n in!1!==r&&(i={}),t)i[n]=t[n];o.items=i,"GeometryPicker"!==o.type&&"ItemPicker"!==o.type||delete o.state,this.invalidate(e)},f.prototype.assignElementItemProperty=function(e,t,r,n,o){this.getElement(e).items[t][r]=c(r,n,o),this.refresh(e)},f.prototype.deriveLocale=function(e){return e?l.prototype.deriveLocale.call(this,e):(null===(e=this.state)||void 0===e?void 0:e.locale)||"inv"},f.prototype.dispose=function(){if(l.prototype.dispose.call(this)){var e=this.state;return null!=e&&e.completion.isPending()&&e.reject(new r.ActivityCancellationError),!0}return!1},f.prototype.load=function(e,t){var r,t=l.prototype.load.call(this,e,t);if(t&&null!==(r=this.form)&&void 0!==r&&r.elements)for(var n in this.form.elements){var o=this.form.elements[n],i=this.getElementRegistration(o);i&&i.getInitialProperties&&(o=(0,p.__assign)((0,p.__assign)({},o),i.getInitialProperties()),this.form.elements[n]=o)}return t},f.prototype.isRelated=function(e){return this.state&&this.state.trivia&&this.state.trivia.isDescendantOf&&this.state.trivia.isDescendantOf(e.state)},f.prototype.getElement=function(e,t){var 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 a.FormElementNotFoundError(r);return t}throw new a.NoFormElementAvailableError},f.prototype.getElementName=function(e,t){if(e){if("string"==typeof e)return e;for(var r in this.form.elements)if(this.form.elements[r]===e)return r;throw new a.FormElementNotFoundError(e)}if(t&&t.name)return t.name;throw new a.NoFormElementAvailableError},f.prototype.getElementRegistration=function(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)},f.prototype.renderHtml=function(e,t){return l.prototype.renderHtml.call(this,this.getText(e),t)},f.prototype.renderText=function(e){return l.prototype.renderText.call(this,this.getText(e))},f.prototype.filterItems=function(e,t){var r=this.find(e);if(null==r)return!1;var n=r.items;if(null==n)return!1;if("string"!=typeof t)return t;var o,i=!1,s={},a=t.toLowerCase().split(/\s+/);for(o in n)for(var l=n[o],u=this.renderText(l.label).toLowerCase().split(/\s+/),f=0,p=a;f<p.length;f++){var c=p[f];if(0<c.length)for(var m=0,h=u;m<h.length;m++){var d=h[m];0<d.length&&(0!==c.indexOf(d)&&0!==d.indexOf(c)||(i=!0,s[o]=l))}}return r.items=s,this.invalidate(e),i},f.prototype.isStatus=function(e){return null!=e&&"string"==typeof e.status},f.prototype.getText=function(e){if(void 0!==this.state){var t=this.state.environment.getText;if("function"==typeof t){if(s.text.isMarkdown(e))return{markdown:t(e.markdown)};if(s.text.isStatus(e))return{markdown:t("@form-element-status-".concat(e.status))};if(e&&"@"===e[0]){t=t(e);if(t)return t}}}return e},f.prototype.renderCustom=function(e,t){if(e instanceof n.FormComponent)return i.element.renderCustom(e,t)},f.prototype.addElement=function(e,t,r){if(this.form.elements.hasOwnProperty(e))throw new Error("Element already present: ".concat(e));var n={};if("object"==typeof r)for(var o in r)n[o]=r[o];n.type=t;var i=n.section;if(i){t=void 0;if("object"==typeof i?t=i.name:"string"==typeof i&&(t=i),"header"===t||"footer"===t)throw new Error("Elements cannot be added to the header or footer.")}return this.form.elements[e]=n,this.invalidate(),n},f.type="F889738A-EBE2-4D52-8B46-3E24CC6E30F6:FormRenderer",f);function f(){return null!==l&&l.apply(this,arguments)||this}t.FormRenderer=u});