@vertigis/workflow 5.32.0 → 5.32.2

package/amd/app/AppActivity.d.ts

@@ -1,3 +1,11 @@
+import { Application, Map, Site, Widget } from "@vertigis/workflow/runtime/app";
+import React from "react";
+import { FormRenderer } from "../activities/forms/FormRenderer";
+/**
+ * Re-export react for use in custom activities. This is not a pattern we encourage,
+ * but there are legacy custom activity packs that will break without it.
+ */
+export { React };
 /** Properties that control how an activity user interface is hosted by the host application. */
 export interface ShowProps {
     /** The name of the container that will host the activity user interface. */
@@ -24,8 +32,51 @@ export interface RenderResolve<T> {
     /** Returns a rejection to the activity. */
     reject(reason: any): any;
 }
+export interface IAppActivity {
+    /**
+     * The host application. For example:
+     * - Geocortex Viewer for HTML5: https://docs.vertigisstudio.com/essentials/gvh/latest/api-help/classes/_mapping_infrastructure_amd_d_._geocortex_infrastructure_viewer_.viewerapplication.html
+     * - Web AppBuilder: https://developers.arcgis.com/web-appbuilder/api-reference
+     */
+    app: Application;
+    /**
+     * The map of the host application. For example:
+     * - ArcGIS API for JavaScript v3: https://developers.arcgis.com/javascript/3/jsapi/map-amd.html
+     * - ArcGIS API for JavaScript v4: https://developers.arcgis.com/javascript/latest/api-reference/esri-Map.html
+     */
+    map: Map;
+    /**
+     * The Geocortex Essentials site of the host application. This is available in Geocortex Viewer for HTML5 applications only.
+     * See https://docs.vertigisstudio.com/essentials/gvh/latest/api-help/classes/_essentials_amd_d_._geocortex_essentials_site_.site.html
+     */
+    site: Site;
+    /**
+     * The Web AppBuilder widget running the workflow. This is available in Web AppBuilder applications only.
+     */
+    widget: Widget;
+    createRenderer(): FormRenderer;
+    /** Performs the activity execution logic. */
+    execute(...args: any[]): any;
+    /** Renders the activity user interface. */
+    render<T, TState>(method: RenderMethod<T, this, TState>, state: TState): Promise<T>;
+    /** Renders the activity user interface. */
+    render<T>(method: RenderMethod<T, this, any>): Promise<T>;
+    /** Renders the activity user interface. */
+    render(visual: JSX.Element): Promise<React.Component<any, any> | Element>;
+    /** Renders the activity user interface. */
+    render(visual: any): Promise<any>;
+    /** Renders the activity user interface. */
+    render(): Promise<HTMLElement>;
+    /** Renders the activity user interface. */
+    render(visual?: any, state?: any): Promise<any>;
+}
+export interface AppActivityConstructor {
+    new (): IAppActivity;
+}
 /**
  * A base activity implementation that provides access to application level resources and
  * facilitates rendering of custom user interfaces.
+ * @deprecated Decorate your activity's class with `@activate(<ClassName>)` to use `<ClassName>` in your activity instead.
+ *             e.g. If you add `@activate(MapProvider)` before your class, you can add `mapProvider: typeof MapProvider` as an extra parameter to its `execute()` method.
  */
-export declare function AppActivity(): void;
+export declare const AppActivity: AppActivityConstructor;

package/amd/app/AppActivity.js

@@ -1 +1 @@
-define(["require","exports","tslib","react","react-dom","../Task"],function(e,t,c,r,u,n){"use strict";function i(){var i=this.execute;this.execute=function(e,r){var n=this,t=r.ambient.trivia;return this.app=t.app,this.map=t.map,this.site=t.site,this.widget=t.widget,this.FormRenderer=t.FormRenderer,this.completion=r.ambient.completion,this.execute=i,this.createRenderer=function(){var e,t=n.renderer;return void 0===t&&((t=n.renderer=n.FormRenderer.createCustom()).state=r.ambient,e=function(){return t.dispose()},n.completion.then(e,e)),n.renderer||(n.renderer=n.FormRenderer.createCustom())},i.apply(this,arguments)}}Object.defineProperty(t,"__esModule",{value:!0}),t.AppActivity=void 0,(t.AppActivity=i).prototype.createRenderer=function(){return null},i.prototype.applyProps=function(e){var t=this.createRenderer();!function(e,t){var r=!1;if(null!=t)for(var n in t)e[n]!==t[n]&&(e[n]=t[n],r=!0);return r}(this.showProps||(this.showProps={}),e)||(e=this.showProps,t.form={defaults:{container:e.container},elements:{header:{type:"Header",section:"header",title:{markdown:e.title},value:e.icon}}},t.invalidate())},i.prototype.show=function(e){return this.applyProps(e),this.createRenderer().show()},i.prototype.spin=function(e){return this.applyProps(e),this.createRenderer().spin()},i.prototype.spinNoBlock=function(e){return this.applyProps(e),this.createRenderer().spinNoBlock()},i.prototype.hide=function(){return this.createRenderer().hide()},i.prototype.render=function(t,p){return(0,c.__awaiter)(this,void 0,void 0,function(){var o,s,a;return(0,c.__generator)(this,function(e){return o=this.createRenderer().container,"function"==typeof t?(s=this,a=t,[2,new n.Task(function(n,i){return(0,c.__awaiter)(this,void 0,void 0,function(){var t,r;return(0,c.__generator)(this,function(e){switch(e.label){case 0:return(t=n.bind(void 0)).reject=i.bind(void 0),r=u.render,[4,a.call(s,t,p)];case 1:return r.apply(void 0,[e.sent(),o]),[2]}})})})]):(0,r.isValidElement)(t)?[2,new n.Task(function(e){(0,u.render)(t,o,e)})]:[2,o]})})}});
+define(["require","exports","tslib","react","react","react-dom","../Task"],function(e,t,c,r,i,u,n){"use strict";Object.defineProperty(t,"__esModule",{value:!0}),i=(t.AppActivity=t.React=void 0,c.__importDefault)(i),t.React=i.default,t.AppActivity=function(){var n=this.execute;this.execute=function(e,r){var i=this,t=r.ambient.trivia;return this.app=t.app,this.map=t.map,this.site=t.site,this.widget=t.widget,this.FormRenderer=t.FormRenderer,this.completion=r.ambient.completion,this.execute=n,this.createRenderer=function(){var e,t=i.renderer;return void 0===t&&((t=i.renderer=i.FormRenderer.createCustom()).state=r.ambient,e=function(){return t.dispose()},i.completion.then(e,e)),i.renderer||(i.renderer=i.FormRenderer.createCustom())},n.apply(this,arguments)}},t.AppActivity.prototype.createRenderer=function(){return null},t.AppActivity.prototype.applyProps=function(e){var t=this.createRenderer();!function(e,t){var r=!1;if(null!=t)for(var i in t)e[i]!==t[i]&&(e[i]=t[i],r=!0);return r}(this.showProps||(this.showProps={}),e)||(e=this.showProps,t.form={defaults:{container:e.container},elements:{header:{type:"Header",section:"header",title:{markdown:e.title},value:e.icon}}},t.invalidate())},t.AppActivity.prototype.show=function(e){return this.applyProps(e),this.createRenderer().show()},t.AppActivity.prototype.spin=function(e){return this.applyProps(e),this.createRenderer().spin()},t.AppActivity.prototype.spinNoBlock=function(e){return this.applyProps(e),this.createRenderer().spinNoBlock()},t.AppActivity.prototype.hide=function(){return this.createRenderer().hide()},t.AppActivity.prototype.render=function(t,a){return(0,c.__awaiter)(this,void 0,void 0,function(){var o,p,s;return(0,c.__generator)(this,function(e){return o=this.createRenderer().container,"function"==typeof t?(p=this,s=t,[2,new n.Task(function(i,n){return(0,c.__awaiter)(this,void 0,void 0,function(){var t,r;return(0,c.__generator)(this,function(e){switch(e.label){case 0:return(t=i.bind(void 0)).reject=n.bind(void 0),r=u.render,[4,s.call(p,t,a)];case 1:return r.apply(void 0,[e.sent(),o]),[2]}})})})]):(0,r.isValidElement)(t)?[2,new n.Task(function(e){(0,u.render)(t,o,e)})]:[2,o]})})}});

package/amd/app/RegisterCustomFormElementBase.d.ts

@@ -1,3 +1,5 @@
+/// <reference types="react" />
+import { IActivityHandler, IActivityContext, Deferrable } from "../IActivityHandler";
 import { Element } from "../forms/FormDefinition";
 /**
  * The props of a custom form element.
@@ -16,9 +18,17 @@ export interface CustomFormElementProps {
      */
     raiseEvent: (eventName: "changed" | "clicked" | "custom", eventValue: any) => void;
 }
+export interface IRegisterCustomFormElementBase extends IActivityHandler {
+    /** Executes the logic for an activity. */
+    execute(inputs: {}, context: IActivityContext, ...args: any[]): Deferrable<{}>;
+    register: (name: string, component: React.ComponentClass<CustomFormElementProps> | React.FunctionComponent<CustomFormElementProps>) => void;
+}
+export interface RegisterCustomFormElementBaseConstructor {
+    new (): IRegisterCustomFormElementBase;
+}
 /**
  * A base activity implementation that provides a convenient way to register
  * custom form elements to be used in Display Form activities.
  * @deprecated Use `FormElementRegistration` instead.
  */
-export declare function RegisterCustomFormElementBase(): void;
+export declare const RegisterCustomFormElementBase: RegisterCustomFormElementBaseConstructor;