@vertigis/workflow 5.45.1 → 5.46.0

package/LanguageStringUtils.js

@@ -1 +1 @@
-const defaultStrings={"common-all":"All","common-cancel":"Cancel","common-clear":"Clear","common-color":"Color","common-done":"Done","common-edit":"Edit","common-end":"End","common-none":"None","common-ok":"OK","common-start":"Start","common-to":"to","common-today":"Today","common-undo":"Undo","date-range-picker-end-text":"End Date","date-range-picker-start-text":"Start Date","file-picker-remove-item-label":"Remove file","form-element-status-failure":"Failure","form-element-status-invalid":"Invalid input","form-element-status-missing":"Required","form-element-status-pending":"Working...","form-element-status-trivial":"No data","geometry-picker-remove-item-label":"Remove location","item-picker-hidden-selected-item":"1 hidden item is also selected.","item-picker-hidden-selected-items":"hidden items are also selected.","item-picker-select":"Select","item-picker-select-visible":"Select Visible","sketch-size":"Size","sketch-tool":"Tool","sketch-tool-highlighter":"Highlighter","sketch-tool-pen":"Pen"};function getStringsForProgram(e,t){const o={...defaultStrings};if(t.strings)for(const i of Object.keys(t.strings))o[i]=t.strings[i];var n=e.getStrings(t.locale);for(const m of Object.keys(n))o[m]=n[m];return o}export{getStringsForProgram};
+const defaultStrings={"common-all":"All","common-cancel":"Cancel","common-clear":"Clear","common-color":"Color","common-done":"Done","common-edit":"Edit","common-end":"End","common-none":"None","common-ok":"OK","common-start":"Start","common-to":"to","common-today":"Today","common-undo":"Undo","date-range-picker-end-text":"End Date","date-range-picker-start-text":"Start Date","file-picker-remove-item-label":"Remove file","form-element-status-failure":"Failure","form-element-status-invalid":"Invalid input","form-element-status-missing":"Required","form-element-status-pending":"Working...","form-element-status-trivial":"No data","geometry-picker-remove-item-label":"Remove location","item-picker-hidden-selected-item":"1 hidden item is also selected.","item-picker-hidden-selected-items":"hidden items are also selected.","item-picker-select":"Select","item-picker-select-visible":"Select Visible","printing-gen2-address":"Address","printing-gen2-city":"City","printing-gen2-company":"Company","printing-gen2-copyright":"Copyright","printing-gen2-country":"Country","printing-gen2-created":"Created","printing-gen2-creator":"Creator","printing-gen2-current-time":"Time","printing-gen2-department":"Department","printing-gen2-disclaimer":"Disclaimer","printing-gen2-division":"Division","printing-gen2-email":"E-Mail","printing-gen2-end-time":"End Time","printing-gen2-fax":"Fax","printing-gen2-first-name":"First Name","printing-gen2-last-name":"Last Name","printing-gen2-map-view":"Map View","printing-gen2-mobile-phone":"Mobile Phone","printing-gen2-organization":"Organization","printing-gen2-overview-scale":"Overview Scale","printing-gen2-page":"Page","printing-gen2-phone":"Phone","printing-gen2-range":"Range","printing-gen2-scale":"Scale","printing-gen2-spatial-reference":"Spatial Reference","printing-gen2-start-end-time":"Start / End Time","printing-gen2-start-time":"Start Time","printing-gen2-street":"Street","printing-gen2-time":"Time","printing-gen2-title":"Title","printing-gen2-zip-code":"ZIP Code","sketch-size":"Size","sketch-tool":"Tool","sketch-tool-highlighter":"Highlighter","sketch-tool-pen":"Pen"};function getStringsForProgram(e,n){const i={...defaultStrings};if(n.strings)for(const r of Object.keys(n.strings))i[r]=n.strings[r];var t=e.getStrings(n.locale);for(const o of Object.keys(t))i[o]=t[o];return i}export{getStringsForProgram};

package/activities/app/GetApplicationData.d.ts

@@ -4,6 +4,7 @@ export interface GetApplicationDataInputs {
     visibility: "memory" | "application" | "global" | string;
 }
 export interface GetApplicationDataOutputs {
+    /** @description The data that was retrieved. */
     value: any;
 }
 export declare class GetApplicationData implements IActivityHandler {

package/activities/app/GetApplicationInfo.d.ts

@@ -4,8 +4,11 @@ import type { IActivityHandler } from "../../IActivityHandler";
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface GetApplicationInfoOutputs {
+    /** @description The name of the application. */
     name: string;
+    /** @description The version of the application. */
     version?: string;
+    /** @description Additional application information that is specific to the host application. */
     info: any;
 }
 export declare class GetApplicationInfo implements IActivityHandler {

package/activities/app/GetUserInfo.d.ts

@@ -4,8 +4,11 @@ import type { IActivityHandler } from "../../IActivityHandler";
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface GetUserInfoOutputs {
+    /** @description The login name of the currently logged-in user. */
     username: string;
+    /** @description The email address of the currently logged-in user. */
     email: string;
+    /** @description The security roles that the currently logged-in user belongs to. */
     roles: string[];
 }
 export declare class GetUserInfo implements IActivityHandler {

package/activities/app/PublishEvent.d.ts

@@ -1,12 +1,9 @@
 import type { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
 /** Inputs for the PublishEvent activity. */
 export interface PublishEventInputs {
-    /** The name of the event to publish. */
     eventName: string;
-    /** The event argument data to publish. */
     eventArgument?: any;
 }
-/** Activity which publishes a named event in the host application. */
 export declare class PublishEvent implements IActivityHandler {
     static readonly action = "gcx:wf:app::PublishEvent";
     static readonly suite = "gcx:wf:builtin";

package/activities/app/RemoveApplicationData.d.ts

@@ -3,6 +3,7 @@ export interface RemoveApplicationDataInputs {
     visibility: "memory" | "application" | "global" | string;
 }
 export interface RemoveApplicationDataOutputs {
+    /** @description Whether or not the specified key was removed. */
     removed: boolean;
 }
 export declare class RemoveApplicationData {

package/activities/app/RunCommand.d.ts

@@ -4,12 +4,9 @@ import type { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface RunCommandInputs {
-    /** The name of the command to invoke. */
     commandName: string;
-    /** The parameter to pass to the command. */
     commandParameter?: any;
 }
-/** Activity which runs a named command in the host application. */
 export declare class RunCommand implements IActivityHandler {
     static readonly action = "gcx:wf:app::RunCommand";
     static readonly suite = "gcx:wf:builtin";

package/activities/app/RunOperation.d.ts

@@ -4,9 +4,7 @@ import type { IActivityHandler } from "../../IActivityHandler";
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface RunOperationInputs {
-    /** The name of the operation to invoke. */
     operationName: string;
-    /** The parameter to pass to the operation. */
     operationParameter?: any;
 }
 /**
@@ -14,10 +12,9 @@ export interface RunOperationInputs {
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface RunOperationOutputs {
-    /** The result of the operation. */
+    /** @description The result of the operation. */
     result: any;
 }
-/** Activity which runs a named operation in the host application. */
 export declare class RunOperation implements IActivityHandler {
     static readonly action = "gcx:wf:app::RunOperation";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/AddAttachment.d.ts

@@ -1,22 +1,17 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 export interface AddAttachmentInputs {
-    /** The URL of the ArcGIS feature layer or table. Either url or layer is required. */
     url?: string;
-    /** The ArcGIS feature layer or table. Either url or layer is required. */
     layer?: __esri.Layer;
     objectId: number;
     attachment: File;
-    /** Optional name for the attachment. When absent, the name of the file is used. */
     attachmentName?: string;
-    /** The geodatabase version on which the operation will be performed. This argument only applies to layers or tables that support versioned data. Requires ArcGIS Server v.10.1+. */
     gdbVersion?: string;
-    /** The time span in milliseconds to wait for the request's results. */
     timeout?: number;
 }
 export interface AddAttachmentOutputs {
+    /** @description The result object indicating if the attachment was successfully added. */
     result: any;
 }
-/** Add an attachment to the feature specified by the object id. */
 export declare class AddAttachment implements IActivityHandler {
     static readonly action = "gcx:wf:arcgis::AddAttachment";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/AddAttachment.js

@@ -1 +1 @@
-import esriRequest from"@arcgis/core/request";import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{addToPath}from"./tools.js";class AddAttachment{async execute(t,e){var a=validation.urlOrLayer(t).trim(),i=validation.number("objectId",t.objectId,validation.never),n=validation.exists("attachmentIds",t.attachment,validation.never),r=validation.string("gdbVersion",t.gdbVersion),o=validation.number("timeout",t.timeout,void 0),i=addToPath(a,`${i}/addAttachment`);let d=validation.string("attachmentName",t.attachmentName,"").trim();""===d&&(d=void 0);const s=new FormData;s.append("attachment",n,d),r&&s.append("gdbVersion",r),s.append("f","json");o={body:s,cacheBust:!1,method:"post",responseType:"json",signal:e.cancellationToken.signal,timeout:o},o=(await esriRequest(i,o)).data?.addAttachmentResult;if(!o)throw new GenericActivityError('Error running the "Add Attachment" activity. The response did not include the required "addAttachmentResult" property.');return{result:o}}}AddAttachment.action="gcx:wf:arcgis::AddAttachment",AddAttachment.suite="gcx:wf:builtin";export{AddAttachment};
+import esriRequest from"@arcgis/core/request";import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{addToPath}from"./tools.js";class AddAttachment{async execute(t,e){var a=validation.urlOrLayer(t).trim(),i=validation.number("objectId",t.objectId,validation.never),n=validation.exists("attachmentIds",t.attachment,validation.never),r=validation.string("gdbVersion",t.gdbVersion),o=validation.number("timeout",t.timeout,void 0),i=addToPath(a,`${i}/addAttachment`);let d=validation.string("attachmentName",t.attachmentName,"").trim();""===d&&(d=void 0);const s=new FormData;s.append("attachment",n,d),r&&s.append("gdbVersion",r),s.append("f","json");o={body:s,cacheBust:!1,method:"post",responseType:"json",signal:e.cancellationToken.signal,timeout:o},o=(await esriRequest(i,o)).data?.addAttachmentResult;if(!o)throw new GenericActivityError(void 0,'Error running the "Add Attachment" activity. The response did not include the required "addAttachmentResult" property.');return{result:o}}}AddAttachment.action="gcx:wf:arcgis::AddAttachment",AddAttachment.suite="gcx:wf:builtin";export{AddAttachment};

package/activities/arcgis/AddFeatureLayer.d.ts

@@ -2,16 +2,13 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines the inputs for the Add Feature Layer activity */
 export interface AddFeatureLayerInputs {
-    /** The features to be included in the new layer. */
     features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
-    /** The display name of the new layer. */
     displayName: string;
-    /** The fields to be included in the new layer. */
     fields: __esri.Field[];
 }
 /** Defines the outputs for the Add Feature Layer Activity */
 export interface AddFeatureLayerOutputs {
-    /** The new feature layer that was created. */
+    /** @description The new feature layer that was created. */
     layer?: __esri.FeatureLayer;
 }
 export declare class AddFeatureLayer implements IActivityHandler {

package/activities/arcgis/AddFeatures.d.ts

@@ -2,20 +2,16 @@ import type { ApplyEditResult, ApplyEditsResponse } from "./libs/arcGisRestApi";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the AddFeatures activity. */
 export interface AddFeaturesInputs {
-    /** The URL of the ArcGIS feature layer or table to edit. Either url or layer input is required. */
     url?: string;
-    /** The ArcGIS feature layer or table to edit. Either url or layer input is required.  */
     layer?: __esri.Layer;
-    /** The features to add to the layer or table. When adding to a layer, the features' geometries must have the same spatial reference as the layer. */
     features: __esri.Graphic | __esri.Graphic[];
-    /** The geodatabase version on which the operation will be performed. This argument only applies to layers or tables that support versioned data. Requires ArcGIS Server v.10.1+. */
     gdbVersion?: string;
-    /** The time span in milliseconds to wait for the request's results. */
     timeout?: number;
 }
 export interface AddFeaturesOutputs {
-    /** Indicates the results that were returned. */
+    /** @description The results that were returned. */
     results: ApplyEditResult[];
+    /** @description Whether the add operation completed successfully. */
     success: boolean;
 }
 export declare class AddFeatures implements IActivityHandler {

package/activities/arcgis/AddGraphics.d.ts

@@ -5,11 +5,8 @@ import type { IActivityHandler, IActivityContext } from "../../IActivityHandler"
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface AddGraphicsInputs {
-    /** The ID of the graphics layer to add the features to. */
     layerId?: string | number;
-    /** The set of features to add to the layer. */
     features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
-    /** Whether or not all features should be removed from the layer. Defauts to false. */
     removeAllFeatures?: boolean;
 }
 /**
@@ -17,7 +14,7 @@ export interface AddGraphicsInputs {
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface AddGraphicsOutputs {
-    /** Indicates the features that were added. */
+    /** @description The features that were added. */
     features: __esri.Graphic[];
 }
 export declare class AddGraphics implements IActivityHandler {

package/activities/arcgis/ArcadeScript.d.ts

@@ -1,17 +1,14 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Arcade script. */
 export interface ArcadeScriptInputs {
-    /** The Arcade script to execute. */
     script: string;
-    /** The parameters to pass to the Arcade script. */
     parameters?: Record<string, any>;
-    /** The profile describing the types of the parameters. */
     profile?: __esri.Profile | "feature-reduction-popup" | "feature-reduction-popup-element" | "feature-z" | "field-calculation" | "form-calculation" | "form-constraint" | "labeling" | "popup" | "popup-element" | "visualization" | string;
-    /** The spatial reference to use when executing the Arcade script. */
     spatialReference?: __esri.SpatialReference;
 }
 /** Defines outputs for the Arcade script. */
 export interface ArcadeScriptOutputs {
+    /** @description The result of the Arcade script. */
     result: any;
 }
 export declare class ArcadeScript implements IActivityHandler {

package/activities/arcgis/AreaEngineTask.d.ts

@@ -1,15 +1,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Area activity. This activity relies on the geometry engine. */
 export interface AreaEngineTaskInputs {
-    /** The polygon whose area is being calculated. */
     geometry: __esri.Polygon;
-    /** Determines whether the area to be calculated is geodesic. If not, the planar area is returned. Defaults to false. Note: geodesic areas only work with WGS84 (wkid: 4326) and Web Mercator spatial references. */
     geodesic?: boolean;
-    /** Measurement unit of the return value. Defaults to the units of the input geometry. */
     unit?: "acres" | "ares" | "hectares" | "square-feet" | "square-meters" | "square-yards" | "square-kilometers" | "square-miles" | string | number;
 }
 /** Defines outputs for the Area activity. */
 export interface AreaEngineTaskOutputs {
+    /** @description The result area. */
     area: number;
 }
 export declare class AreaEngineTask implements IActivityHandler {

package/activities/arcgis/BufferEngineTask.d.ts

@@ -1,22 +1,17 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs to the Buffer activity. This activity makes use of the geometry engine. */
 export interface BufferEngineTaskInputs {
-    /** The buffer input geometry. The geometry and distance parameters must be specified as either both arrays or both non-arrays. */
     geometry: __esri.Geometry | __esri.Geometry[];
-    /** The specified distance(s) for buffering. */
     distance: number | number[];
-    /** Measurement unit of the distances. Defaults to the units of the input geometries. */
     unit?: "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards" | string;
-    /** Determines whether to use a geodesic buffer or a non-geodesic buffer */
     geodesic?: boolean;
-    /** Determines whether the output geometries should be unioned into a single polygon. */
     union?: boolean;
 }
 /** Defines outputs for the Buffer activity. */
 export interface BufferEngineTaskOutputs {
-    /** Indicates the first buffer or result (or the union result). */
+    /** @description The first buffer or result (or the union result). */
     geometry?: __esri.Polygon;
-    /** Indicates all buffer results. */
+    /** @description The buffer results. */
     results?: __esri.Polygon[];
 }
 export declare class BufferEngineTask implements IActivityHandler {

package/activities/arcgis/BufferServiceTask.d.ts

@@ -2,28 +2,20 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the Buffer activity. This activity relies on an ArcGIS Geometry Service REST endpoint. */
 export interface BufferServiceTaskInputs {
-    /** The URL of the ArcGIS geometry service. */
     url: string;
-    /** The geometries to buffer. */
     geometry: __esri.Geometry | __esri.Geometry[];
-    /** The distances the input geometries are buffered. */
     distance: number | number[];
-    /** The units for calculating each buffer distance. If units are not specified, they are inferred from bufferSpatialReference. If bufferSpatialReference is not specified, units are derived from the features being buffered. */
     unit?: "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards" | string;
-    /** The spatial reference in which the geometries are buffered. If bufferSpatialReference is not specified, the geometries are buffered in the spatial reference specified by outSpatialReference. If outSpatialReference is also not specified, they are buffered in the spatial reference of the features. */
     bufferSpatialReference?: number | string | __esri.SpatialReference;
-    /** The spatial reference for the returned geometries. If outSpatialReference is not specified, the geometries are output in the spatial reference specified by bufferSpatialReference. If bufferSpatialReference is also not specified, they are in the spatial reference of the features. */
     outSpatialReference?: number | string | __esri.SpatialReference;
-    /** If the input geometries are in geographic coordinate system, set geodesic to true in order to generate a buffer polygon using a geodesic distance. Requires ArcGIS Server 10.1+ geometry service. */
     geodesic?: boolean;
-    /** If true, all geometries buffered at a given distance are unioned into a single (possibly multipart) polygon, and the unioned geometry is placed in the output array. Defaults to false. */
     union?: boolean;
 }
 /** Defines outputs for the Buffer activity. */
 export interface BufferServiceTaskOutputs {
-    /** Indicates the first buffer or result (or the union result). */
+    /** @description The first buffer result. */
     geometry?: __esri.Polygon;
-    /** Indicates all buffer results. */
+    /** @description The buffer results. */
     results?: __esri.Polygon[];
 }
 export declare class BufferServiceTask implements IActivityHandler {

package/activities/arcgis/CastGeometry.d.ts

@@ -5,15 +5,15 @@ export interface CastGeometryInputs {
 }
 /** Defines outputs for the Cast Geometry activity. */
 export interface CastGeometryOutputs {
-    /** The geometry as a point. */
+    /** @description The geometry as a point. */
     point?: __esri.Point;
-    /** The geometry as a polygon. */
+    /** @description The geometry as a polygon. */
     polygon?: __esri.Polygon;
-    /** The geometry as a polyline. */
+    /** @description The geometry as a polyline. */
     polyline?: __esri.Polyline;
-    /** The geometry as a extent. */
+    /** @description The geometry as an extent. */
     extent?: __esri.Extent;
-    /** The geometry as a multipoint. */
+    /** @description The geometry as a multipoint. */
     multipoint?: __esri.Multipoint;
 }
 export declare class CastGeometry implements IActivityHandler {

package/activities/arcgis/ClearGraphics.d.ts

@@ -2,7 +2,6 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext, EmptyOutputs } from "../../IActivityHandler";
 /** Defines inputs for the ClearGraphics activity. */
 export interface ClearGraphicsInputs {
-    /** The ID of the graphics layer to clear. */
     layerId?: string | number;
 }
 export declare class ClearGraphics implements IActivityHandler {

package/activities/arcgis/ClipEngineTask.d.ts

@@ -1,14 +1,12 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Clip activity. This activity makes use of the geometry engine. */
 export interface ClipEngineTaskInputs {
-    /** The geometry to be clipped. */
     geometry: __esri.Geometry;
-    /** The envelope used to clip. */
     extent: __esri.Extent;
 }
 /** Defines outputs for the Clip activity. */
 export interface ClipEngineTaskOutputs {
-    /** The clipped geometry. */
+    /** @description The clipped geometry. */
     geometry: __esri.Geometry;
 }
 export declare class ClipEngineTask implements IActivityHandler {

package/activities/arcgis/ClosestFacilityTask.d.ts

@@ -2,85 +2,59 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the basic Closest Facility Task activity. This task is related to the Route and Service Area tasks. */
 export interface ClosestFacilityTaskInputs {
-    /** The URL to the ArcGIS network analysis service. */
     url: string;
-    /** The set of facilities loaded as network locations during analysis. These can be specified as either a DataLayer or a FeatureSet. Either the URL or the features should be specified, but not both. */
     facilities: __esri.DataLayer | __esri.FeatureSet | __esri.NetworkFeatureSet | __esri.NetworkUrl;
-    /** The set of incidents loaded as network locations during analysis. Can be an instance of a DataLayer or FeatureSet. Either a URL or features should be supplied, but not both. */
     incidents: __esri.DataLayer | __esri.FeatureSet | __esri.NetworkFeatureSet | __esri.NetworkUrl;
-    /** The list of network attribute names to be accumulated with the analysis; i.e., which attributes should be returned as part of the response. The defaulted is as defined in the specific routing network layer. See: http://resources.arcgis.com/en/help/main/10.2/index.html#//00470000000m000000 */
     accumulateAttributes?: string[];
-    /** An array of parameter values. If present, an attribute name, parameter name, and value must be specified. */
     attributeParameterValues?: __esri.AttributeParameterValue[];
-    /** The cutoff value used to determine when to stop traversing. */
     defaultCutoff?: number;
-    /** The number of facilities to find. */
     defaultTargetFacilityCount?: number;
-    /** The language used when generating driving directions. This parameter applies only when returnDirections parameter is set to true. If an unsupported language code is specified, the service returns the directions using the default language, English. */
     directionsLanguage?: string;
-    /** The length unit to use when computing directions. The default is as defined in the specific routing network layer. Known values: centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards. */
     directionsLengthUnits?: string;
-    /** Defines the amount of direction information returned. Default value: standard. Known values: complete | complete-no-events | instructions-only | standard | summary-only. */
     directionsOutputType?: string;
-    /** The style to be used when returning directions. The default will be as defined in the network layer. View the REST layer description for your network service to see a list of supported styles. */
     directionsStyleName?: "desktop" | "navigation" | "campus" | string;
-    /** The name of network attribute to use for the drive time when computing directions. The default is as defined in the specific routing network layer. */
     directionsTimeAttribute?: string;
-    /** If true, avoids network elements restricted by barriers or restrictions specified in restrictionAttributes. Default value: true. */
     doNotLocateOnRestrictedElements?: boolean;
-    /** The network attribute name to be used as the impedance attribute in the analysis. The default is as defined in the routing network layer. You can specify any attribute names listed in the Service Directory under Network Dataset -> Network Attributes as "Usage Type: esriNAUTCost". You can also specify a value of "none" to indicate that no network attributes should be used for impedance. For example, set impedanceAttribute to "Time" for the quickest route, or to "Length" for the shortest drive, assuming the service has those two esriNAUTCost attributes. */
     impedanceAttribute?: string;
     impedenceAttribute?: string;
-    /** The precision of the output geometry after generalization. If 0, no generalization of output geometry is performed. If present and positive, it represents the MaximumAllowableOffset parameter and generalization is performed according to IPolycurve.Generalize. */
     outputGeometryPrecision?: number;
-    /** The units of the output geometry precision. Known Values: centimeters | decimal-degrees | decimeters | feet | inches | kilometers | meters | miles | millimeters | nautical-miles | points | yards. */
     outputGeometryPrecisionUnits?: string;
-    /** The type of output lines to be generated in the result. Default Value: true-shape. Known Values: none | straight | true-shape | true-shape-with-measure. */
     outputLines?: string;
-    /** The spatial reference (or well-known ID of same) for the geometries returned with the analysis results. If not specified, the geometries are returned in the spatial reference of the map. */
     outSpatialReference?: number | string | __esri.SpatialReference;
-    /** The set of point barriers loaded as network locations during analysis. Can be an instance of a DataLayer or FeatureSet. Either a URL or features should be supplied, but not both. */
     pointBarriers?: __esri.DataLayer | __esri.FeatureSet;
-    /** The set of polygon barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using DataFile. Note that either the features or url property should be specified. */
     polygonBarriers?: __esri.DataLayer | __esri.FeatureSet;
-    /** The set of polyline barriers loaded as network locations during analysis. At ArcGIS Server 10.1, an optional url property was added. Use this property to specify a REST query request to a Feature, Map or GP Service that returns a JSON feature set. The url property can be specified using DataFile. Note that either the features or url property should be specified. */
     polylineBarriers?: __esri.DataLayer | __esri.FeatureSet;
-    /** The list of network attribute names to be used as restrictions with the analysis. The default is as defined in the specific routing network layer used in your ClosestFacilityTask. Possible values are listed in the Service Directory under Network Dataset -> Network Attributes. You can also specify a value of none to indicate that no network attributes should be used as restrictions. If you specify an empty array, it will default to the default of the service. */
     restrictionAttributes?: string[];
-    /** Specifies how U-Turns should be handled. The default is as defined in the specific routing network layer. Known Values: allow-backtrack | at-dead-ends-only | no-backtrack | at-dead-ends-and-intersections. */
     restrictUTurns?: string;
-    /** If true, barriers are returned in the directions property of each RouteResult. Default Value: false. */
     returnDirections?: boolean;
-    /** If true, facilities will be returned with the analysis results. Default Value: false */
     returnFacilities?: boolean;
-    /** If true, incidents will be returned with the analysis results. Default value: false. */
     returnIncidents?: boolean;
-    /** If true, point barriers will be returned in the barriers property of the ClosestFacilitySolveResult. Default value: false. */
     returnPointBarriers?: boolean;
-    /** If true, polygon barriers are returned in the barriers property of the ClosestFacilitySolveResult. Default value: false. */
     returnPolygonBarriers?: boolean;
-    /** If true, polyline barriers are returned in the barriers property of the ClosestFacilitySolveResult. Default value: false. */
     returnPolylineBarriers?: boolean;
-    /** If true, routes are generated and returned in the route property of each ClosestFacilitySolveResult. Default Value: true */
     returnRoutes?: boolean;
-    /** The arrival or departure date and time. For example, if the travelDirection is set to TO_FACILITY and timeOfDayUsage is set to "end" and timeOfDay is set to 8:00 a.m., the returned route(s) will be setup to arrive at the facility at 8:00 a.m. local time. Requires ArcGIS Server service version 10.1 or greater. */
     timeOfDay?: Date;
-    /** Defines the way the timeOfDay value is used. The default value is defined in the network layer. Requires ArcGIS Server service version 10.1 or greater. Known values: start | end. */
     timeOfDayUsage?: string;
-    /** Options for traveling to or from the facility. Default values are defined by the network layer. See NATravelDirection for a list of valid values. */
     travelDirection?: string;
-    /** If true, the hierarchy attribute for the network should be used in analysis. The default is as defined in the specific routing network layer. */
     useHierarchy?: boolean;
 }
 /** defines outputs for the Closest Facility Task activity. */
 export interface ClosestFacilityTaskOutputs {
+    /** @description The directions. */
     directions: __esri.DirectionsFeatureSet | __esri.DirectionsFeatureSet[];
+    /** @description The facilities points. */
     facilities: __esri.FeatureSet;
+    /** @description The incidents points. */
     incidents: __esri.FeatureSet;
+    /** @description The messages returned by the network analysis service. */
     messages: __esri.NAMessage[];
+    /** @description The point barriers. */
     pointBarriers: __esri.FeatureSet;
+    /** @description The polygon barriers. */
     polygonBarriers: __esri.FeatureSet;
+    /** @description The polyline barriers. */
     polylineBarriers: __esri.FeatureSet;
+    /** @description The routes. */
     routes: __esri.FeatureSet;
 }
 export declare class ClosestFacilityTask implements IActivityHandler {

package/activities/arcgis/CompareGeometries.d.ts

@@ -1,14 +1,12 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines imports for the CompareGeometries activity. This activity relies on the geometry engine. */
 export interface CompareGeometriesInputs {
-    /** The first geometry being compared. */
     geometry1: __esri.Geometry;
-    /** The second geometry being compared. */
     geometry2: __esri.Geometry;
-    /** The comparison operation. */
     operation: "contains" | "crosses" | "disjoint" | "equals" | "intersects" | "overlaps" | "touches" | "within" | string;
 }
 export interface CompareGeometriesOutputs {
+    /** @description The result of the geometry comparison. */
     result?: boolean;
 }
 export declare class CompareGeometries implements IActivityHandler {

package/activities/arcgis/ConvertValueToArcGisFieldType.d.ts

@@ -4,6 +4,7 @@ export interface ConvertValueToArcGisFieldTypeInputs {
     type: "double" | "integer" | "long" | "oid" | "single" | "small-integer" | string;
 }
 export interface ConvertValueToArcGisFieldTypeOutputs {
+    /** @description The value converted to the specified type. */
     result: object;
 }
 export declare class ConvertValueToArcGisFieldType implements IActivityHandler {

package/activities/arcgis/CreateFeatureSet.d.ts

@@ -7,7 +7,7 @@ export interface CreateFeatureSetInputs {
 }
 /** Defines outputs for the Create Feature Set activity. */
 export interface CreateFeatureSetOutputs {
-    /** The FeatureSet. */
+    /** @description The Feature Set result. */
     featureSet: __esri.FeatureSet;
 }
 export declare class CreateFeatureSet implements IActivityHandler {

package/activities/arcgis/CreateGraphic.d.ts

@@ -7,7 +7,7 @@ export interface CreateGraphicInputs {
 }
 /** Defines outputs for the Create Graphic activity. */
 export interface CreateGraphicOutputs {
-    /** The Feature result. */
+    /** @description The Feature result. */
     feature: __esri.Graphic;
 }
 export declare class CreateGraphic implements IActivityHandler {

package/activities/arcgis/CreatePoint.d.ts

@@ -7,7 +7,7 @@ export interface CreatePointInputs {
 }
 /** Defines outputs for the Create Point activity. */
 export interface CreatePointOutputs {
-    /** The Point. */
+    /** @description The Point result. */
     point: __esri.Point;
 }
 export declare class CreatePoint implements IActivityHandler {

package/activities/arcgis/CutEngineTask.d.ts

@@ -1,14 +1,12 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Cut activity. This activity relies on the geometry engine. */
 export interface CutEngineTaskInputs {
-    /** The geometry (a Polyline or Polygon) to be cut. */
     geometry: __esri.Geometry;
-    /** The polyline which cuts the geometry. */
     cutter: __esri.Polyline;
 }
 /** Defines outputs for the Cut activity. */
 export interface CutEngineTaskOutputs {
-    /** An array with zero, one, two, or three entries. For Polylines, all left cuts are grouped together in the first Geometry. Right cuts and coincident cuts are grouped in the second Geometry and each undefined cut, along with any uncut parts, are output as separate Polylines. For Polygons, all left cuts are grouped in the first Polygon, all right cuts are grouped in the second Polygon, and each undefined cut, along with any left-over parts after cutting, are output as a separate Polygon. If no cuts are returned then the array will be empty. An undefined cut will only be produced if a left cut or right cut was produced and there was a part left over after cutting, or a cut is bounded to the left and right of the cutter. */
+    /** @description The result array of geometries created by cutting the input geometry with the cutter. */
     geometry: __esri.Geometry[];
 }
 export declare class CutEngineTask implements IActivityHandler {

package/activities/arcgis/DeleteAttachments.d.ts

@@ -1,20 +1,16 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 export interface DeleteAttachmentsInputs {
-    /** The URL of the ArcGIS feature layer or table. Either url or layer is required. */
     url?: string;
-    /** The ArcGIS feature layer or table. Either url or layer is required. */
     layer?: __esri.Layer;
     objectId: number;
     attachmentIds: number | number[];
-    /** The geodatabase version on which the operation will be performed. This argument only applies to layers or tables that support versioned data. Requires ArcGIS Server v.10.1+. */
     gdbVersion?: string;
-    /** The time span in milliseconds to wait for the request's results. */
     timeout?: number;
 }
 export interface DeleteAttachmentsOutputs {
+    /** @description The result objects, one for each attachment indicating if it was successfully removed. */
     results: object[];
 }
-/** Delete attachments associated with the specified object id. */
 export declare class DeleteAttachments implements IActivityHandler {
     static readonly action = "gcx:wf:arcgis::DeleteAttachments";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/DeleteAttachments.js

@@ -1 +1 @@
-import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{addToPath,post}from"./tools.js";class DeleteAttachments{async execute(t,e){var a=validation.urlOrLayer(t).trim(),i=validation.number("objectId",t.objectId,validation.never),n=validation.array("attachmentIds",t.attachmentIds,validation.never).join(","),r=validation.string("gdbVersion",t.gdbVersion),t=validation.number("timeout",t.timeout,void 0),i=addToPath(a,`${i}/deleteAttachments`);const o={attachmentIds:n};r&&(o.gdbVersion=r);var e=(await post(i,o,t,e.cancellationToken.signal))["deleteAttachmentResults"];if(!e)throw new GenericActivityError('Error running the "Delete Attachments" activity. The response did not include the required "deleteAttachmentResults" property.');return{results:e}}}DeleteAttachments.action="gcx:wf:arcgis::DeleteAttachments",DeleteAttachments.suite="gcx:wf:builtin";export{DeleteAttachments};
+import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{addToPath,post}from"./tools.js";class DeleteAttachments{async execute(t,e){var a=validation.urlOrLayer(t).trim(),i=validation.number("objectId",t.objectId,validation.never),n=validation.array("attachmentIds",t.attachmentIds,validation.never).join(","),r=validation.string("gdbVersion",t.gdbVersion),t=validation.number("timeout",t.timeout,void 0),i=addToPath(a,`${i}/deleteAttachments`);const o={attachmentIds:n};r&&(o.gdbVersion=r);var e=(await post(i,o,t,e.cancellationToken.signal))["deleteAttachmentResults"];if(!e)throw new GenericActivityError(void 0,'Error running the "Delete Attachments" activity. The response did not include the required "deleteAttachmentResults" property.');return{results:e}}}DeleteAttachments.action="gcx:wf:arcgis::DeleteAttachments",DeleteAttachments.suite="gcx:wf:builtin";export{DeleteAttachments};

package/activities/arcgis/DeleteFeatures.d.ts

@@ -2,23 +2,18 @@ import type { ApplyEditResult, ApplyEditsResponse } from "./libs/arcGisRestApi";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the DeleteFeatures activity. */
 export interface DeleteFeaturesInputs {
-    /** The URL of the ArcGIS feature layer or table to edit. Either url or layer is required. */
     url?: string;
-    /** The ArcGIS feature layer or table to edit. Either url or layer is required. */
     layer?: __esri.Layer;
     features?: number | number[] | __esri.Graphic | __esri.Graphic[] | string | string[];
-    /** Indicates if the features to be deleted should be identified by Global IDs instead of Object IDs. The default value is false. */
     useGlobalIds?: boolean;
-    /** Indicates the field which contains the OBJECTID or GlobalID for all features. */
     objectIdField?: string;
-    /** The geodatabase version on which the operation will be performed. This argument only applies to layers or tables that support versioned data. Requires ArcGIS Server v.10.1+. */
     gdbVersion?: string;
-    /** The time span in milliseconds to wait for the request's results. */
     timeout?: number;
 }
 export interface DeleteFeaturesOutputs {
-    /** Indicates the results given after deletion. */
+    /** @description The results given after deletion. */
     results: ApplyEditResult[];
+    /** @description Whether the delete operation completed successfully. */
     success: boolean;
 }
 export declare class DeleteFeatures implements IActivityHandler {

package/activities/arcgis/DeleteFeatures.js

@@ -1 +1 @@
-import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{combineGlobalIds,getFieldName}from"./shared.js";import{addToPath,post}from"./tools.js";class DeleteFeatures{async execute(e,t){var s=validation.urlOrLayer(e),s=addToPath(s,"applyEdits"),o=validation.boolean("useGlobalIds",e.useGlobalIds,!1),i=validation.string("objectIdField",e.objectIdField,o?"GlobalID":"OBJECTID"),a=validation.string("gdbVersion",e.gdbVersion),r=validation.number("timeout",e.timeout);const l=[],n=[];let d;for(const p of validation.array("features",e.features,validation.never))if("number"==typeof p)l.push(p);else if("string"==typeof p)o?n.push(p):(u=parseInt(p),isNaN(u)||l.push(u));else{var u=p.attributes;if("object"==typeof u){if(!d&&(d=getFieldName(i,u),!d))throw new GenericActivityError(`Error running the "Delete Features" activity. Feature does not have a "${i}" property.`);u=u[d];(o?n:l).push(u)}}a={deletes:o?combineGlobalIds(n):l.toString(),gdbVersion:a,useGlobalIds:o};const c=await post(s,a,r,t.cancellationToken.signal);this.onApplyEditsComplete(c);t=!!c.deleteResults?.every(e=>e.success);return{results:c.deleteResults,success:t}}onApplyEditsComplete(e){}}DeleteFeatures.action="gcx:wf:arcgis::DeleteFeatures",DeleteFeatures.suite="gcx:wf:builtin";export{DeleteFeatures};
+import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{combineGlobalIds,getFieldName}from"./shared.js";import{addToPath,post}from"./tools.js";class DeleteFeatures{async execute(e,t){var o=validation.urlOrLayer(e),o=addToPath(o,"applyEdits"),s=validation.boolean("useGlobalIds",e.useGlobalIds,!1),i=validation.string("objectIdField",e.objectIdField,s?"GlobalID":"OBJECTID"),a=validation.string("gdbVersion",e.gdbVersion),r=validation.number("timeout",e.timeout);const l=[],n=[];let d;for(const p of validation.array("features",e.features,validation.never))if("number"==typeof p)l.push(p);else if("string"==typeof p)s?n.push(p):(u=parseInt(p),isNaN(u)||l.push(u));else{var u=p.attributes;if("object"==typeof u){if(!d&&(d=getFieldName(i,u),!d))throw new GenericActivityError(void 0,`Error running the "Delete Features" activity. Feature does not have a "${i}" property.`);u=u[d];(s?n:l).push(u)}}a={deletes:s?combineGlobalIds(n):l.toString(),gdbVersion:a,useGlobalIds:s};const c=await post(o,a,r,t.cancellationToken.signal);this.onApplyEditsComplete(c);t=!!c.deleteResults?.every(e=>e.success);return{results:c.deleteResults,success:t}}onApplyEditsComplete(e){}}DeleteFeatures.action="gcx:wf:arcgis::DeleteFeatures",DeleteFeatures.suite="gcx:wf:builtin";export{DeleteFeatures};

package/activities/arcgis/DensifyEngineTask.d.ts

@@ -1,16 +1,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Densify activity. This activity relies on the geometry engine. */
 export interface DensifyEngineTaskInputs {
-    /** The geometry to be densified. */
     geometry: __esri.Geometry;
-    /** The maximum segment length allowed. Must be a positive value. */
     maxSegmentLength?: number;
-    /** Measurement unit for maxSegmentLength. Defaults to the units of the input geometry. Known values: meters | feet | kilometers | miles | nautical-miles | yards. */
     unit?: string | number;
 }
 /** Defines outputs for the Densify activity. */
 export interface DensifyEngineTaskOutputs {
-    /** The densified geometry. */
+    /** @description The densified geometry. */
     geometry: __esri.Geometry;
 }
 export declare class DensifyEngineTask implements IActivityHandler {