@vertigis/workflow 5.45.1 → 5.46.0

package/activities/arcgis/runUtils.d.ts

@@ -28,26 +28,7 @@ export interface DataSource {
     value: any;
 }
 /**
- * Minimal definition of a serialized webmap.
- * @product This is intended for internal use only within VertiGIS Studio products.
- */
-export interface Webmap {
-    operationalLayers: any[];
-    spatialReference: __esri.SpatialReference;
-    baseLayers?: any[];
-    groundLayers?: any[];
-}
-/** The parameters that are required for including a map in a
- * report or print job.
- */
-export interface WebmapPrintParameters {
-    extent?: __esri.Extent;
-    mapName: string;
-    scale?: number;
-    webmap: Webmap;
-}
-/**
- * Checks the staatus of a Print/Report job.
+ * Checks the status of a Print/Report job.
  * @param serviceUrl The URL of the Printing or Reporting service.
  * @param token The Bearer token.
  * @param ticket The ticket returned from the original job/run request.

package/activities/arcgis/runUtils.js

@@ -1 +1 @@
-const DEV_SERVICE_URL="http://localhost:3000/";async function checkJobStatus(e,t,r,o,n){const s=o.new();if(n.finally(function(){s.cancel()}),s.request.url=`${e}/job/artifacts?ticket=${r}`,t&&(s.request.headers.Authorization=`Bearer ${t}`),!await s.send())throw console.error("Unable to check job status.",s.response.message),new Error("Unable to check job status.");const a=JSON.parse(s.response.content);if(console.debug(a),a.results?.some(e=>"JobQuit"===e.$type)){t=a.results.filter(e=>"JobResult"===e.$type)[0];if(t)return`${e}/job/result?ticket=${r}&tag=${t.tag}`;throw console.error("Job failed."),new Error("Job failed.")}return null}async function checkResult(e,t,r,o,n,s){var a=await checkJobStatus(e,t,r,n,s);return a||(await delay(o),checkResult(e,t,r,1.1*o,n,s))}async function delay(t){return new Promise(e=>setTimeout(e,t))}async function getMapControlNames(e,t,r,o,n){const s=[];n=await getTemplateMetadata(e,t,r,o,n);if(n?.response&&n.response.controls)for(const a of n.response.controls)if("Map"===a.controlType){const c=a.purpose;s.push(c.substring(0,c.indexOf(".")))}return s}async function getServiceToken(e,t,r,o){const n=o.new();if(n.request.url=`${e}/auth/token/run`,n.request.method="POST",n.request.headers={"Content-Type":"application/json"},n.request.json={accessToken:r,portalUrl:t},!await n.send())throw console.error("Unable to generate run token.",n.response.message),Error("Unable to generate run token");t=JSON.parse(n.response.content);return(t.response||t).token}async function getTemplateMetadata(e,t,r,o,n){const s=o.new();if(n.finally(function(){s.cancel()}),s.request.url=`${t}/job/metadata`,s.request.method="POST",s.request.json={template:{itemId:e.itemId,portalUrl:e.portalUrl}},s.request.headers["Content-Type"]="application/json",r&&(s.request.headers.Authorization=`Bearer ${r}`),!await s.send())throw console.error("Unable to retrieve template metadata.",s.response.message),new Error("Unable to retrieve template metadata.");r=JSON.parse(s.response.content);return console.debug(r),r}async function runJob(e,t,r,o){const n=o.new();if(n.request.url=`${e}/job/run`,n.request.method="POST",n.request.headers={"Content-Type":"application/json"},t&&(n.request.headers.Authorization=`Bearer ${t}`),n.request.json=r,!await n.send())throw console.error("Unable to run job.",n.response.message),Error("Unable to run job");r=JSON.parse(n.response.content);return console.debug("job/run",r),r}function getServiceUrl(e,t){let r=e;return r?0===r.toLowerCase().indexOf(DEV_SERVICE_URL)?r="http://localhost:43222/":-1!==(e=r.indexOf("#"))&&(r=r.substring(0,e)):r=`https://apps.vertigisstudio.com/${t}/`,r+="/"===r.slice(-1)?"service":"/service",r}export{checkJobStatus,checkResult,getMapControlNames,getServiceToken,runJob,getServiceUrl};
+const DEV_SERVICE_URL="http://localhost:3000/";async function checkJobStatus(e,t,r,o,n){const s=o.new();if(n.finally(function(){s.cancel()}),s.request.url=`${e}/job/artifacts?ticket=${r}`,t&&(s.request.headers.Authorization=`Bearer ${t}`),!await s.send())throw console.error("Unable to check job status.",s.response.message),new Error("Unable to check job status.");const a=JSON.parse(s.response.content);if(console.debug(a),a.results?.some(e=>"JobQuit"===e.$type)){t=a.results.filter(e=>"JobResult"===e.$type)[0];if(t)return`${e}/job/result?ticket=${r}&tag=${t.tag}`;throw console.error("Job failed."),new Error("Job failed.")}return null}async function checkResult(e,t,r,o,n,s){var a=await checkJobStatus(e,t,r,n,s);return a||(await delay(o),checkResult(e,t,r,1.1*o,n,s))}async function delay(t){return new Promise(e=>setTimeout(e,t))}async function getMapControlNames(e,t,r,o,n){const s=[];n=await getTemplateMetadata(e,t,r,o,n);if(n?.response&&n.response.controls)for(const a of n.response.controls)if("Map"===a.controlType){const c=a.purpose;s.push(c.substring(0,c.indexOf(".")))}return s}async function getServiceToken(e,t,r,o){const n=o.new();if(n.request.url=`${e}/auth/token/run`,n.request.method="POST",n.request.headers={"Content-Type":"application/json"},n.request.json={accessToken:r,portalUrl:t},!await n.send())throw console.error("Unable to generate run token.",n.response.message),new Error("Unable to generate run token");t=JSON.parse(n.response.content);return(t.response||t).token}async function getTemplateMetadata(e,t,r,o,n){const s=o.new();if(n.finally(function(){s.cancel()}),s.request.url=`${t}/job/metadata`,s.request.method="POST",s.request.json={template:{itemId:e.itemId,portalUrl:e.portalUrl}},s.request.headers["Content-Type"]="application/json",r&&(s.request.headers.Authorization=`Bearer ${r}`),!await s.send())throw console.error("Unable to retrieve template metadata.",s.response.message),new Error("Unable to retrieve template metadata.");r=JSON.parse(s.response.content);return console.debug(r),r}async function runJob(e,t,r,o){const n=o.new();if(n.request.url=`${e}/job/run`,n.request.method="POST",n.request.headers={"Content-Type":"application/json"},t&&(n.request.headers.Authorization=`Bearer ${t}`),n.request.json=r,!await n.send())throw console.error("Unable to run job.",n.response.message),new Error("Unable to run job");r=JSON.parse(n.response.content);return console.debug("job/run",r),r}function getServiceUrl(e,t){let r=e;return r?0===r.toLowerCase().indexOf(DEV_SERVICE_URL)?r="http://localhost:43222/":-1!==(e=r.indexOf("#"))&&(r=r.substring(0,e)):r=`https://apps.vertigisstudio.com/${t}/`,r+="/"===r.slice(-1)?"service":"/service",r}export{checkJobStatus,checkResult,getMapControlNames,getServiceToken,runJob,getServiceUrl};

package/activities/arcgis/shared.js

@@ -1 +1 @@
-import esriId from"@arcgis/core/identity/IdentityManager";function getAuthenticationToken(e){return esriId.findCredential(e)?.token||""}function parsePortalItemUrl(e){e=e.match(/^(.*?)\/home\/item\.html\?id=(.*?)(#.*)?$/);if(e)return{portalUrl:e[1],itemId:e[2]}}function getPortalDataUrl(e,t){return`${e.portalUrl}/sharing/rest/content/items/${e.itemId}?f=json&token=${t}`}async function getPortalItem(e,t,n){const r=t.create(void 0,"arcgis");if(n.finally(function(){r.cancel()}),r.request.url=e,!await r.send())throw console.error("Unable to get portal item.",r.response.message),Error("Unable to get portal item.");return r.getResponseData(r.response.payload)}function formatGlobalId(e){return"}"!=(e="{"!=e[0]?"{"+e:e)[e.length-1]&&(e+="}"),e}function combineGlobalIds(e){return`[${e.map(e=>`"${formatGlobalId(e)}"`).join(",")}]`}function equalsIgnoreCase(e,t){return e===t||null!=e&&(null!=t&&e.toLowerCase()===t.toLowerCase())}function getFieldName(t,e){return Object.keys(e).find(e=>equalsIgnoreCase(t,e))}function containsIgnoreCase(e,t){return e.some(e=>equalsIgnoreCase(e,t))}export{getAuthenticationToken,parsePortalItemUrl,getPortalDataUrl,getPortalItem,formatGlobalId,combineGlobalIds,equalsIgnoreCase,getFieldName,containsIgnoreCase};
+import esriId from"@arcgis/core/identity/IdentityManager";function getAuthenticationToken(e){return esriId.findCredential(e)?.token||""}function parsePortalItemUrl(e){e=e.match(/^(.*?)\/home\/item\.html\?id=(.*?)(#.*)?$/);if(e)return{portalUrl:e[1],itemId:e[2]}}function getPortalDataUrl(e,t){return`${e.portalUrl}/sharing/rest/content/items/${e.itemId}?f=json&token=${t}`}async function getPortalItem(e,t,n){const r=t.create(void 0,"arcgis");if(n.finally(function(){r.cancel()}),r.request.url=e,!await r.send())throw console.error("Unable to get portal item.",r.response.message),new Error("Unable to get portal item.");return r.getResponseData(r.response.payload)}function formatGlobalId(e){return"}"!=(e="{"!=e[0]?"{"+e:e)[e.length-1]&&(e+="}"),e}function combineGlobalIds(e){return`[${e.map(e=>`"${formatGlobalId(e)}"`).join(",")}]`}function equalsIgnoreCase(e,t){return e===t||null!=e&&(null!=t&&e.toLowerCase()===t.toLowerCase())}function getFieldName(t,e){return Object.keys(e).find(e=>equalsIgnoreCase(t,e))}function containsIgnoreCase(e,t){return e.some(e=>equalsIgnoreCase(e,t))}export{getAuthenticationToken,parsePortalItemUrl,getPortalDataUrl,getPortalItem,formatGlobalId,combineGlobalIds,equalsIgnoreCase,getFieldName,containsIgnoreCase};

package/activities/browser/GetBrowserInfo.d.ts

@@ -1,9 +1,9 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Describes the outputs of the Get Browser Info activity. */
 export interface GetBrowserInfoOutputs {
-    /** The URL of the browser. */
+    /** @description The URL of the browser. */
     url: string;
-    /** The user agent string of the browser. */
+    /** @description The user agent string of the browser. */
     userAgent: string;
 }
 export declare class GetBrowserInfo implements IActivityHandler {

package/activities/core/Annotation.d.ts

@@ -1,5 +1,4 @@
 import type { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
-/** An activity that provides the ability to add annotation/comments to a workflow. */
 export declare class Annotation implements IActivityHandler {
     static readonly action = "gcx:wf:core::Annotation";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/CalculateDate.d.ts

@@ -9,7 +9,9 @@ export interface CalculateDateInputs {
 }
 /** Defines outputs to the Calculate Date activity. */
 export interface CalculateDateOutputs {
+    /** @description The result as a Date object. */
     date: Date;
+    /** @description The result as the number of milliseconds since the Unix Epoch. Example: `1360017870652`. */
     value: number;
 }
 export declare class CalculateDate implements IActivityHandler {

package/activities/core/Cast.d.ts

@@ -6,7 +6,7 @@ export interface CastInputs {
 }
 /** Defines outputs for the Cast activity. */
 export interface CastOutputs {
-    /** The input value cast to the specified type. */
+    /** @description The input value cast to the specified type. */
     result: any;
 }
 export declare class Cast implements IActivityHandler {

package/activities/core/Container.d.ts

@@ -1,5 +1,4 @@
 import type { IActivityHandler, IActivityContext, EmptyInputs, EmptyOutputs } from "../../IActivityHandler";
-/** An activity to that acts as a container for nested workflow components. */
 export declare class Container implements IActivityHandler {
     static readonly action = "gcx:wf:core::Container";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/ConvertBytesToText.d.ts

@@ -5,6 +5,7 @@ export interface ConvertBytesToTextInputs {
 }
 /** Defines outputs from the ConvertBytesToText activity. */
 export interface ConvertBytesToTextOutputs {
+    /** @description The text of the encoded byte array. */
     text: string;
 }
 export declare class ConvertBytesToText implements IActivityHandler {

package/activities/core/ConvertDataTableToFeatureSet.d.ts

@@ -3,6 +3,7 @@ export interface ConvertDataTableToFeatureSetInputs {
     dataTable: object;
 }
 export interface ConvertDataTableToFeatureSetOutputs {
+    /** @description An object like a feature set. This object can be passed to the Get Feature Set From JSON activity to create an Esri feature set. */
     featureSet: object;
 }
 export declare class ConvertDataTableToFeatureSet implements IActivityHandler {

package/activities/core/ConvertTextToBytes.d.ts

@@ -5,6 +5,7 @@ export interface ConvertTextToBytesInputs {
 }
 /** Defines outputs from the ConvertTextToBytes activity. */
 export interface ConvertTextToBytesOutputs {
+    /** @description The encoded byte array of text. */
     bytes: number[];
 }
 export declare class ConvertTextToBytes implements IActivityHandler {

package/activities/core/ConvertToJson.d.ts

@@ -1,12 +1,11 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines outputs for the ConvertToJson activity. */
 export interface ConvertToJsonInputs {
-    /** The object to convert to JSON text. */
     object: any;
 }
 /** Defines outputs for the ConvertToJson activity. */
 export interface ConvertToJsonOutputs {
-    /** The JSON text. */
+    /** @description The JSON text. */
     json: string;
 }
 export declare class ConvertToJson implements IActivityHandler {

package/activities/core/CreateFile.d.ts

@@ -7,6 +7,7 @@ export interface CreateFileInputs {
 }
 /** Defines outputs from the CreateFile activity. */
 export interface CreateFileOutputs {
+    /** @description The file containing the input content. */
     result: File;
 }
 export declare class CreateFile implements IActivityHandler {

package/activities/core/CreateValue.d.ts

@@ -2,18 +2,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs to the Create Value activity. */
 export interface CreateValueInputs {
-    /** The expression to evaluate. */
     expression: any;
 }
 /** Defines outputs to the Create Value activity. */
 export interface CreateValueOutputs {
-    /** The result of the expression evaluation. */
+    /** @description The value that is the result of the expression evaluation. */
     result: any;
 }
-/**
- * Evaluates an expression and returns the result.
- * This activity is functionally equivalent to the Evaluate activity.
- */
 export declare class CreateValue implements IActivityHandler {
     static readonly action = "gcx:wf:core::CreateValue";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/DecodeUriComponent.d.ts

@@ -5,6 +5,7 @@ export interface DecodeUriComponentInputs {
 }
 /** Outputs for the DecodeUriComponent activity. */
 export interface DecodeUriComponentOutputs {
+    /** @description The decoded value. */
     result: string;
 }
 export declare class DecodeUriComponent implements IActivityHandler {

package/activities/core/Delay.d.ts

@@ -8,7 +8,6 @@ export type DurationRef = {
 export type Duration = number | string | DurationRef;
 /** Defines the inputs for the Delay activity. */
 export interface DelayInputs {
-    /** Indicates the duration in milliseconds. */
     duration: number | string | DurationRef;
 }
 export declare class Delay implements IActivityHandler {

package/activities/core/EncodeUriComponent.d.ts

@@ -5,6 +5,7 @@ export interface EncodeUriComponentInputs {
 }
 /** Outputs for the EncodeUriComponent activity. */
 export interface EncodeUriComponentOutputs {
+    /** @description The encoded value. */
     result: string;
 }
 export declare class EncodeUriComponent implements IActivityHandler {

package/activities/core/Evaluate.d.ts

@@ -2,15 +2,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs to the Evaluate activity. */
 export interface EvaluateInputs {
-    /** The expression to evaluate. */
     expression: any;
 }
 /** Defines outputs to the Evaluate activity. */
 export interface EvaluateOutputs {
-    /** The result of the expression evaluation. */
+    /** @description The result of the expression evaluation. */
     result: any;
 }
-/** Evaluates an expression and returns the result. */
 export declare class Evaluate implements IActivityHandler {
     static readonly action = "gcx:wf:core::Evaluate";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/EvaluateAsync.d.ts

@@ -2,15 +2,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs to the activity. */
 export interface EvaluateAsyncInputs {
-    /** The expression to evaluate asynchronously. */
     expression: any;
 }
 /** Defines outputs to the activity. */
 export interface EvaluateAsyncOutputs {
-    /** The result of the expression evaluation. */
+    /** @description The result of the expression evaluation. */
     result: any;
 }
-/** Evaluates an asynchronous expression and returns the result. */
 export declare class EvaluateAsync implements IActivityHandler {
     static readonly action = "gcx:wf:core::EvaluateAsync";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/ExecuteFunction.d.ts

@@ -4,7 +4,7 @@ export interface ExecuteFunctionInputs {
     arguments?: Record<string, any>;
 }
 export interface ExecuteFunctionOutputs {
-    arguments?: Record<string, any>;
+    /** @description The result of the Function activity. */
     result: any;
 }
 export declare class ExecuteFunction implements IActivityHandler {

package/activities/core/ForEach.d.ts

@@ -1,21 +1,19 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs to the ForEach activity. */
 export interface ForEachInputs {
-    /** A collection of items to iterate over. */
     items: any[] | Iterable<any> | Record<string, any>;
-    /** Whether or not to continue processing items. */
     exit?: boolean;
     itemType?: "any" | "string" | "number" | "esri.AddressCandidate" | "esri.Extent" | "esri.FeatureSet" | "esri.Geometry" | "esri.Graphic" | "esri.Layer" | "esri.Multipoint" | "esri.Point" | "esri.Polygon" | "esri.Polyline" | "esri.PortalGroup" | "esri.PortalUser" | "esri.SpatialReference" | "esri.Symbol" | string;
 }
 /** Defines outputs to the ForEach activity. */
 export interface ForEachOutputs {
-    /** The key of the item currently being processed. */
+    /** @description The key of the item currently being processed. */
     key?: string;
-    /** The pass that the loop is on, if looping. */
+    /** @description The pass that the loop is on. */
     pass?: number;
-    /** The count of the items. */
+    /** @description The count of the items. */
     count?: number;
-    /** The current item from the items collection */
+    /** @description The current item from the items collection. */
     item?: any;
 }
 export declare class ForEach implements IActivityHandler {

package/activities/core/FormatDate.d.ts

@@ -6,10 +6,15 @@ export interface FormatDateInputs {
 }
 /** Defines outputs to the Format Date activity. */
 export interface FormatDateOutputs {
+    /** @description The date formatted as per the `format` input. The current device (or browser) locale is used. */
     formatted: string;
+    /** @description The date formatted in the ISO8601 standard. Example: `2013-02-04T22:44:30.652Z`. */
     iso: string;
+    /** @description The date formatted as a standard english string in the local time zone. Example: `Mon Feb 04 2013 14:44:30 GMT-0800`. */
     local: string;
+    /** @description The number of milliseconds since the Unix Epoch. Example: `1360017870652`. */
     unix: number;
+    /** @description The date formatted as a standard english string using the UTC time zone. Example: `Mon, 04 Feb 2013 22:44:30 GMT`. */
     utc: string;
 }
 export declare class FormatDate implements IActivityHandler {

package/activities/core/Function.d.ts

@@ -1,12 +1,15 @@
 import type { ExecuteFunctionOutputs } from "./ExecuteFunction";
 import type { IActivityContext, IActivityHandler } from "../../IActivityHandler";
 export interface FunctionInputs {
+    /** The inputs to the function. */
     subworkflow: ExecuteFunctionOutputs;
     argumentsType?: "any" | "{ addressCandidate: esri.AddressCandidate }" | "{ extent: esri.Extent }" | "{ featureSet: esri.FeatureSet }" | "{ geometry: esri.Geometry }" | "{ graphic: esri.Graphic }" | "{ id: number; name: string; location: esri.Point; }" | "{ layer: esri.Layer }" | "{ multiPoint: esri.Multipoint }" | "{ point: esri.Point }" | "{ polygon: esri.Polygon }" | "{ polyline: esri.Polyline }" | "{ portalGroup: esri.PortalGroup }" | "{ portalUser: esri.PortalUser }" | "{ spatialReference: esri.SpatialReference }" | "{ symbol: esri.Symbol }" | string;
     resultType?: "any" | "ArrayBuffer" | "boolean" | "Date" | "Error" | "Function" | "number" | "number[]" | "Object" | "string" | "string[]" | "esri.Graphic" | "esri.Extent" | "esri.Geometry" | "esri.Multipoint" | "esri.Point" | "esri.Polygon" | "esri.Polyline" | "esri.PortalGroup" | "esri.PortalUser" | "esri.SpatialReference" | "esri.Layer" | "esri.Symbol" | "esri.AddressCandidate" | "esri.FeatureSet" | "{ id: number; name: string; location: esri.Point; }" | string;
 }
 export interface FunctionOutputs {
+    /** @description The input arguments to the function. This will only be populated if the function is called by an Execute Function activity. */
     arguments?: Record<string, any>;
+    /** @description A function to set the result of the function which will be returned to the Execute Function activity that called the Function activity. */
     setResult: (value: any) => void;
 }
 export declare class Function implements IActivityHandler {

package/activities/core/GetBase64StringFromBytes.d.ts

@@ -5,7 +5,7 @@ export interface GetBase64StringFromBytesInputs {
 }
 /** Defines outputs for the GetBase64StringFromBytes activity. */
 export interface GetBase64StringFromBytesOutputs {
-    /** The base-64 encoded string. */
+    /** @description The base-64 encoded string. */
     result: string;
 }
 export declare class GetBase64StringFromBytes implements IActivityHandler {

package/activities/core/GetBase64StringFromFile.d.ts

@@ -5,6 +5,7 @@ export interface GetBase64StringFromFileInputs {
 }
 /** Defines outputs from the GetBase64StringFromFile activity. */
 export interface GetBase64StringFromFileOutputs {
+    /** @description The content of the file represented as a base-64 encoded string. */
     result: string;
 }
 export declare class GetBase64StringFromFile implements IActivityHandler {

package/activities/core/GetBytesFromBase64String.d.ts

@@ -5,7 +5,7 @@ export interface GetBytesFromBase64StringInputs {
 }
 /** Defines outputs for the GetBytesFromBase64String activity. */
 export interface GetBytesFromBase64StringOutputs {
-    /** The decoded bytes. */
+    /** @description The decoded bytes. */
     result: number[];
 }
 export declare class GetBytesFromBase64String implements IActivityHandler {

package/activities/core/GetFirstItem.d.ts

@@ -5,6 +5,7 @@ export interface GetFirstItemInputs {
 }
 /** Defines outputs from the GetFirstItem activity. */
 export interface GetFirstItemOutputs {
+    /** @description The first item. */
     item: any;
 }
 export declare class GetFirstItem implements IActivityHandler {

package/activities/core/GetItemAtIndex.d.ts

@@ -6,6 +6,7 @@ export interface GetItemAtIndexInputs {
 }
 /** Defines outputs from the GetItemAtIndex activity. */
 export interface GetItemAtIndexOutputs {
+    /** @description The item. */
     item: any;
 }
 export declare class GetItemAtIndex implements IActivityHandler {

package/activities/core/GetLastItem.d.ts

@@ -5,6 +5,7 @@ export interface GetLastItemInputs {
 }
 /** Defines outputs from the GetLastItem activity. */
 export interface GetLastItemOutputs {
+    /** @description The last item. */
     item: any;
 }
 export declare class GetLastItem implements IActivityHandler {

package/activities/core/GetLogLevel.d.ts

@@ -1,5 +1,10 @@
 import type { IActivityHandler, EmptyInputs, IActivityContext } from "../../IActivityHandler";
 export interface GetLogLevelOutputs {
+    /**
+     * @description The workflow log level.
+     * The Log activity will only log messages whose level is greater than or equal to this workflow log level.
+     * Log levels in decreasing rank are: "error", "warning", "log", "info", and "debug".
+     */
     level: "error" | "warning" | "log" | "info" | "debug";
 }
 export declare class GetLogLevel implements IActivityHandler {

package/activities/core/GetTextFromFile.d.ts

@@ -6,6 +6,7 @@ export interface GetTextFromFileInputs {
 }
 /** Defines outputs from the GetTextFromFile activity. */
 export interface GetTextFromFileOutputs {
+    /** @description The text content of the file. */
     result: string;
 }
 export declare class GetTextFromFile implements IActivityHandler {

package/activities/core/GetWorkflowInputs.d.ts

@@ -2,9 +2,9 @@
 import type { IActivityHandler, IActivityContext, EmptyInputs } from "../../IActivityHandler";
 /** Defines outputs to the GetWorkflowInputs activity. */
 export interface GetWorkflowInputsOutputs {
+    /** @description The inputs to the workflow. */
     inputs: object;
 }
-/** Activity which gets the input parameters of the workflow. */
 export declare class GetWorkflowInputs implements IActivityHandler {
     static readonly action = "gcx:wf:core::GetWorkflowInputs";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/If.d.ts

@@ -1,15 +1,13 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs to the If activity. */
 export interface IfInputs {
-    /** Indicates the boolean value to act upon. */
     condition: boolean;
 }
 /** Defines outputs to the If activity. */
 export interface IfOutputs {
-    /** Indicates the branch that was taken. */
+    /** @description Reflects the condition as given in the inputs. */
     result: boolean;
 }
-/** Branches based on a condition. */
 export declare class If implements IActivityHandler {
     static readonly action = "gcx:wf:core::If";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/Log.d.ts

@@ -1,11 +1,9 @@
 import type { IActivityHandler, EmptyOutputs, IActivityContext } from "../../IActivityHandler";
 /** Inputs for the Log activity. */
 export interface LogInputs {
-    /** The message to log. */
     message: any;
     level?: "error" | "warning" | "log" | "info" | "debug";
 }
-/** An activity to log a message natively (in the console?) */
 export declare class Log implements IActivityHandler {
     static readonly action = "gcx:wf:core::Log";
     static readonly suite = "gcx:wf:builtin";

package/activities/core/Loop.d.ts

@@ -1,22 +1,17 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs to the Loop activity. */
 export interface LoopInputs {
-    /** Whether or not the loop should break. Unnecessary if collection has a value. */
     exit?: boolean;
-    /** Whether or not the loop should progress. */
     loop?: boolean;
-    /** A collection of items to iterate over to control the loop. */
     collection?: any[];
-    /** The lower bound on how many passes the loop should take. The default is 0. */
     count?: number;
-    /** The upper bound on how many passes the loop should take. The default is 1000. */
     limit?: number;
 }
 /** Defines outputs to the Loop activity. */
 export interface LoopOutputs {
-    /** The pass that the loop is on, if looping. */
+    /** @description The pass that the loop is on. */
     pass?: number;
-    /** Deprecated: The item from the collection. This is only available if collection input was provided. */
+    /** @description The item from the collection. This is only available if collection input was provided. */
     item?: any;
 }
 export declare class Loop implements IActivityHandler {

package/activities/core/ParseJson.d.ts

@@ -1,12 +1,11 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines outputs for the ParseJson activity. */
 export interface ParseJsonInputs {
-    /** The JSON text to parse. */
     json: string;
 }
 /** Defines outputs for the ParseJson activity. */
 export interface ParseJsonOutputs {
-    /** The object corresponding to the given JSON text. */
+    /** @description The object corresponding to the given JSON text. */
     result: any;
 }
 export declare class ParseJson implements IActivityHandler {

package/activities/core/ParseNumber.d.ts

@@ -3,6 +3,7 @@ export interface ParseNumberInputs {
     value: string;
 }
 export interface ParseNumberOutputs {
+    /** @description The numeric value. */
     result: number;
 }
 export declare class ParseNumber implements IActivityHandler {

package/activities/core/ParseUrl.d.ts

@@ -1,20 +1,19 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines outputs for the GetBrowserUrl activity. */
 export interface ParseUrlInputs {
-    /** The URL to parse. */
     url?: string;
 }
 /** Defines outputs for the GetBrowserUrl activity. */
 export interface ParseUrlOutputs {
-    /** The URL that was parsed. */
+    /** @description The URL that was parsed. */
     url?: string;
-    /** The query string of the URL as key value pairs. */
+    /** @description The query string of the URL as key value pairs. */
     query?: Record<string, string>;
-    /** The query string of the URL. */
+    /** @description The query string of the URL. */
     queryString?: string;
-    /** The request portion of the URL that excludes the query and fragment. */
+    /** @description The request portion of the URL that excludes the query and fragment. */
     request?: string;
-    /** The fragment of the URL. */
+    /** @description The fragment of the URL. */
     fragment?: string;
 }
 export declare class ParseUrl implements IActivityHandler {

package/activities/core/RegexMatches.d.ts

@@ -8,6 +8,7 @@ export interface RegexMatchesInputs {
 }
 /** Defines outputs for the RegexMatches activity. */
 export interface RegexMatchesOutputs {
+    /** @description Whether the regular expression pattern found a match. */
     result: boolean;
 }
 export declare class RegexMatches implements IActivityHandler {

package/activities/core/RegexReplace.d.ts

@@ -9,6 +9,7 @@ export interface RegexReplaceInputs {
 }
 /** Defines outputs for the RegexReplace activity. */
 export interface RegexReplaceOutputs {
+    /** @description The updated text. */
     result: string;
 }
 export declare class RegexReplace implements IActivityHandler {

package/activities/core/RemoveItem.d.ts

@@ -5,6 +5,7 @@ export interface RemoveItemInputs {
     item: any;
 }
 export interface RemoveItemOutputs {
+    /** @description Whether the item was removed. True if the item was removed; otherwise, false. */
     removed: boolean;
 }
 export declare class RemoveItem implements IActivityHandler {

package/activities/core/RunActivity.d.ts

@@ -2,7 +2,6 @@ import type { EmptyOutputs, IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the RunActivity activity. */
 export interface RunActivityInputs {
     action: string;
-    /** The input arguments to the activity. */
     arguments?: Record<string, any>;
 }
 export declare class RunActivity implements IActivityHandler {

package/activities/core/SetProperty.d.ts

@@ -1,11 +1,8 @@
 import type { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
 /** Defines inputs for the SetProperty activity. */
 export interface SetPropertyInputs {
-    /** The object to set the property on. */
     object: object;
-    /** The name of the property to set. */
     propertyName: string;
-    /** The value of the property. */
     propertyValue?: any;
 }
 export declare class SetProperty implements IActivityHandler {

package/activities/core/Switch.d.ts

@@ -2,14 +2,13 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs to the Switch activity. */
 export interface SwitchInputs {
-    /** Indicates the value to switch on. */
     value?: string | number | boolean;
 }
 /** Defines outputs to the Switch activity. */
 export interface SwitchOutputs {
-    /** Indicates that the default was taken. */
+    /** @description Indicates that the default was taken. */
     default: boolean;
-    /** Indicates the branch that was taken. */
+    /** @description The branch that was taken. */
     result?: any;
 }
 export declare class Switch implements IActivityHandler {

package/activities/core/TextReplace.d.ts

@@ -8,6 +8,7 @@ export interface TextReplaceInputs {
 }
 /** Defines outputs for the TextReplace activity. */
 export interface TextReplaceOutputs {
+    /** @description The modified text. */
     result: string;
 }
 export declare class TextReplace implements IActivityHandler {

package/activities/core/TryCatch.d.ts

@@ -2,7 +2,7 @@
 import type { IActivityHandler, IActivityContext, EmptyInputs } from "../../IActivityHandler";
 /** Defines outputs for the TryCatch activity. */
 export interface TryCatchOutputs {
-    /** Indicates the error if one was caught. */
+    /** @description The error if one was caught. */
     error?: Error;
 }
 export declare class TryCatch implements IActivityHandler {