@vertigis/workflow 5.45.1 → 5.46.1

package/activities/arcgis/SetLayerDefinitionExpression.d.ts

@@ -2,16 +2,15 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the SetLayerDefinitionExpression activity. */
 export interface SetLayerDefinitionExpressionInputs {
-    /** The ID of the layer whose definition is of interest. */
     layerId: string | number;
-    /** The optional index of the sublayer whose definition is of interest. Sublayers are associated with MapImageLayers. */
     sublayerId?: string | number;
-    /** The layer definition expression. */
     expression: string;
 }
 /** Defines outputs for the SetLayerDefinitionExpression activity. */
 export interface SetLayerDefinitionExpressionOutputs {
+    /** @description The previous layer definition expression. */
     oldExpression?: string;
+    /** @description The new layer definition expression. */
     newExpression?: string;
 }
 export declare class SetLayerDefinitionExpression implements IActivityHandler {

package/activities/arcgis/SetLayerPopup.d.ts

@@ -4,7 +4,6 @@ export interface SetLayerPopupInputs {
     template: object;
     layerId: string | number;
 }
-/** Sets a popup template on the given layer. The popup applies to all features of the layer. */
 export declare class SetLayerPopup implements IActivityHandler {
     static readonly action = "gcx:wf:arcgis::SetLayerPopup";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/SetLayerProperty.d.ts

@@ -2,18 +2,15 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the SetLayerProperty activity. */
 export interface SetLayerPropertyInputs {
-    /** The ID of the layer whose property is of interest. */
     layerId: string | number;
-    /** The name of the property of interest. This name is case-sensitive. */
     name: string;
-    /** The value for the property to set. */
     value: any;
 }
 /** Defines outputs for the SetLayerProperty activity. */
 export interface SetLayerPropertyOutputs {
-    /** The old value. */
+    /** @description The previous property value. */
     oldValue: any;
-    /** The new value. */
+    /** @description The new property value. */
     newValue: any;
 }
 export declare class SetLayerProperty implements IActivityHandler {

package/activities/arcgis/SetLayerVisibility.d.ts

@@ -2,18 +2,15 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the SetLayerVisibility activity. */
 export interface SetLayerVisibilityInputs {
-    /** The ID of the layer whose visibility is of interest. */
     layerId: string | number;
-    /** The optional index of the sublayer whose visibility is of interest. Sublayers are associated with MapImageLayers. */
     sublayerId?: string | number;
-    /** The visibility to set on the layer. */
     visible?: boolean;
 }
 /** Defines outputs for the SetLayerVisibility activity. */
 export interface SetLayerVisibilityOutputs {
-    /** Indicates that the layer was visible. */
+    /** @description Whether the layer was originally visible. */
     wasVisible?: boolean;
-    /** Indicates that the layer is visibile at the time of completing the activity. */
+    /** @description Whether the layer was visible at the time of completing the activity. */
     nowVisible?: boolean;
 }
 export declare class SetLayerVisibility implements IActivityHandler {

package/activities/arcgis/SetMap.d.ts

@@ -4,7 +4,6 @@ import type { IActivityHandler, EmptyOutputs } from "../../IActivityHandler";
  * @product This is intended for internal use only within VertiGIS Studio products.
  */
 export interface SetMapInputs {
-    /** The unique id of the map to use from now on. */
     mapId: string;
 }
 export declare class SetMap implements IActivityHandler {

package/activities/arcgis/SetViewExtent.d.ts

@@ -2,22 +2,19 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the SetViewExtent activity. */
 export interface SetViewExtentInputs {
-    /** The scale to set after the extent is set. */
     scale?: number;
-    /** Indicates the geometry to go to. */
     geometry?: __esri.Geometry | __esri.Geometry[];
-    /** Indicates the features to go to. */
     features?: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
 }
 /** Defines outputs for the SetViewExtent activity. */
 export interface SetViewExtentOutputs {
-    /** The previous extent. */
+    /** @description The previous extent. */
     oldExtent?: __esri.Extent;
-    /** The previous scale. */
+    /** @description The previous scale. */
     oldScale?: number;
-    /** The extent of the view, returned for convenience. */
+    /** @description The extent of the view. */
     newExtent?: __esri.Extent;
-    /** The new scale at the current extent. */
+    /** @description The new scale at the current extent. */
     newScale?: number;
 }
 export declare class SetViewExtent implements IActivityHandler {

package/activities/arcgis/SetViewpoint.d.ts

@@ -2,18 +2,15 @@ import { MapProvider } from "./MapProvider";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the SetViewpoint activity. */
 export interface SetViewpointInputs {
-    /** Indicates the geometry to go to. */
     geometry?: __esri.Geometry | __esri.Geometry[];
-    /** Indicates the features to go to. */
     features?: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
-    /** Indicates the viewpoint to go to. */
     viewpoint?: __esri.Viewpoint;
 }
 /** Defines outputs for the SetViewpoint activity. */
 export interface SetViewpointOutputs {
-    /** The previous viewpoint, returned for convenience. */
+    /** @description The previous viewpoint. */
     oldViewpoint?: __esri.Viewpoint;
-    /** The updated viewpoint, returned for convenience. */
+    /** @description The updated viewpoint. */
     newViewpoint?: __esri.Viewpoint;
 }
 export declare class SetViewpoint implements IActivityHandler {

package/activities/arcgis/ShowFeaturePopup.d.ts

@@ -3,7 +3,6 @@ import type { IActivityHandler, IActivityContext, EmptyOutputs } from "../../IAc
 export interface ShowFeaturePopupInputs {
     features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
 }
-/** Shows a popup for the given features. */
 export declare class ShowFeaturePopup implements IActivityHandler {
     static readonly action = "gcx:wf:arcgis::ShowFeaturePopup";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/SimplifyEngineTask.d.ts

@@ -1,11 +1,11 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Simplify activity. This activity relies on the geometry engine. */
 export interface SimplifyEngineTaskInputs {
-    /** The geometry to be simplified. */
     geometry: __esri.Geometry;
 }
 /** Defines outputs for the Simplify activity. */
 export interface SimplifyEngineTaskOutputs {
+    /** @description The simplified geometry. */
     geometry: __esri.Geometry;
 }
 export declare class SimplifyEngineTask implements IActivityHandler {

package/activities/arcgis/SortFeatureSet.d.ts

@@ -1,16 +1,13 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Sort Feature Set activity. */
 export interface SortFeatureSetInputs {
-    /** The feature set to sort. */
     features: __esri.Graphic | __esri.FeatureSet | __esri.Graphic[];
-    /** The case-sensitive name of the attribute to sort on. */
     sortAttribute: string;
-    /** Whether or not to sort in ascending order. If set to false, the feature set will be sorted in descending order. Defaults to true. */
     ascending?: boolean;
 }
 /** Defines outputs for the Sort Feature Set activity. */
 export interface SortFeatureSetOutputs {
-    /** The sorted features held within the feature set. */
+    /** @description The sorted features held within the feature set. */
     features: __esri.Graphic[];
 }
 export declare class SortFeatureSet implements IActivityHandler {

package/activities/arcgis/SymbolFromJson.d.ts

@@ -1,12 +1,11 @@
 import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs for the Symbol From JSON activity. */
 export interface SymbolFromJsonInputs {
-    /** The symbol JSON as a string or object. */
     json: string | object;
 }
 /** Defines outputs for the Symbol From JSON activity. */
 export interface SymbolFromJsonOutputs {
-    /** The symbol. */
+    /** @description The symbol result. */
     symbol?: __esri.Symbol;
 }
 export declare class SymbolFromJson implements IActivityHandler {

package/activities/arcgis/ToGeoCoordinateStringServiceTask.d.ts

@@ -1,26 +1,18 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the ToGeoCoordinateString task. This task requires a geometry service. */
 export interface ToGeoCoordinateStringServiceTaskInputs {
-    /** The URL of the ArcGIS geometry service. */
     url: string;
-    /** The spatial reference (or WKID of the spatial reference) of the XY-coordinates to be converted. */
     spatialReference: string | number | __esri.SpatialReference;
-    /** An array of XY-coordinates (in JSON format) to be converted. */
     coordinates: number[][];
-    /** The conversion type of the input strings. The default value is mgrs. */
     conversionType: "mgrs" | "usng" | "utm" | "geo-ref" | "gars" | "dms" | "ddm" | "dd" | string;
-    /** Conversion options for mgrs and utm conversion types. See http://resources.arcgis.com/en/help/arcgis-rest-api/index.html#//02r30000026w000000 for valid conversion modes and their descriptions. */
     conversionMode?: string;
-    /** The number of digits to output for each of the numerical portions of the string. The default value depends on conversionType. */
     numOfDigits?: number;
-    /** If true, then numeric portions of the string are rounded to the nearest whole magnitude as specified by numOfDigits. Otherwise, numeric portions of the string are truncated. The rounding parameter applies only to conversion types mgrs, usng, and geo-ref. Defaults to true. */
     rounding?: boolean;
-    /** If true, then spaces are added between components of the string. The addSpaces parameter applies only to conversion types mgrs, usng, and utm. The default value for mgrs is false, while the default value for both usng and utm is true. */
     addSpaces?: boolean;
 }
 /** Defines outputs for the ToGeoCoordinateString task. */
 export interface ToGeoCoordinateStringServiceTaskOutputs {
-    /** The array of well-known geocoordinate strings. */
+    /** @description The array of well-known geocoordinate strings. */
     strings: string[];
 }
 export declare class ToGeoCoordinateStringServiceTask implements IActivityHandler {

package/activities/arcgis/UnionEngineTask.d.ts

@@ -2,14 +2,12 @@ import type { IActivityHandler } from "../../IActivityHandler";
 /** Defines inputs to the Union activity. This activity makes use of the geometry engine.
     This activity constructs the set- theoretic union of the geometries in the input array.All inputs must be of the same type. */
 export interface UnionEngineTaskInputs {
-    /** An array of geometries to be unioned. */
     geometry1: __esri.Geometry | __esri.Geometry[];
-    /** An array of geometries to be unioned. */
     geometry2: __esri.Geometry | __esri.Geometry[];
 }
 /** Defines outputs to the Union activity. */
 export interface UnionEngineTaskOutputs {
-    /** The results should be an array of a single geometry comprising the union of the input geometries. */
+    /** @description The unioned geometry result. */
     geometry: __esri.Geometry;
 }
 export declare class UnionEngineTask implements IActivityHandler {

package/activities/arcgis/UnionServiceTask.d.ts

@@ -1,16 +1,13 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the Union. This activity relies on an ArcGIS Geometry Service REST endpoint. */
 export interface UnionServiceTaskInputs {
-    /** The URL of the ArcGIS geometry service. */
     url: string;
-    /** Indicates a single geometry or an array of geometries to union. */
     geometry1: __esri.Geometry | __esri.Geometry[];
-    /** Indicates a single geometry or an array of geometries to union. */
     geometry2: __esri.Geometry | __esri.Geometry[];
 }
 /** Defines the outputs for the Union activity. */
 export interface UnionServiceTaskOutputs {
-    /** The results should be a single geometry. */
+    /** @description The unioned results. */
     geometry: __esri.Geometry;
 }
 export declare class UnionServiceTask implements IActivityHandler {

package/activities/arcgis/UpdateAttachment.d.ts

@@ -1,27 +1,20 @@
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 export interface UpdateAttachmentInputs {
-    /** 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;
     attachmentId: 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;
-    /** Optional parameter specifying whether the response will report the time attachments were updated. If returnEditMoment = true, the server will report the time in the response's editMoment key. The default value is false. Requires ArcGIS Server v.10.5+. */
     returnEditMoment?: boolean;
-    /** The ID of the attachment that has already been uploaded to the server.This parameter only applies if the supportsAttachmentsByUploadId property of the layer or table is true. Requires ArcGIS Server v.10.4+. */
     uploadId?: number;
-    /** The time span in milliseconds to wait for the request's results. */
     timeout?: number;
 }
 export interface UpdateAttachmentOutputs {
+    /** @description The result object indicating if the attachment was successfully updated. */
     result: any;
 }
-/** Update an attachment to the feature specified by the object id. */
 export declare class UpdateAttachment implements IActivityHandler {
     static readonly action = "gcx:wf:arcgis::UpdateAttachment";
     static readonly suite = "gcx:wf:builtin";

package/activities/arcgis/UpdateAttachment.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 UpdateAttachment{async execute(t,e){var a=validation.urlOrLayer(t).trim(),n=validation.number("objectId",t.objectId,validation.never);const i=validation.number("attachmentId",t.attachmentId,validation.never);var r=validation.exists("attachment",t.attachment,validation.never),o=validation.string("gdbVersion",t.gdbVersion),d=validation.boolean("returnEditMoment",t.returnEditMoment,!1),m=validation.number("uploadId",t.uploadId),c=validation.number("timeout",t.timeout),n=addToPath(a,`${n}/updateAttachment`);let s=validation.string("attachmentName",t.attachmentName,"").trim();""===s&&(s=void 0);const l=new FormData;l.append("f","json"),l.append("attachmentId",i.toString()),l.append("attachment",r,s),o&&l.append("gdbVersion",o),l.append("returnEditMoment",d?"true":"false"),null!=m&&l.append("uploadId",m?"true":"false");c={body:l,cacheBust:!1,method:"post",responseType:"json",signal:e.cancellationToken.signal,timeout:c},c=(await esriRequest(n,c)).data.updateAttachmentResult;if(!c)throw new GenericActivityError('Error running the "Update Attachment" activity. The response did not include the required "updateAttachmentResult" property.');return{result:c}}}UpdateAttachment.action="gcx:wf:arcgis::UpdateAttachment",UpdateAttachment.suite="gcx:wf:builtin";export{UpdateAttachment};
+import esriRequest from"@arcgis/core/request";import{GenericActivityError}from"../../Errors.js";import{validation}from"../../Validation.js";import{addToPath}from"./tools.js";class UpdateAttachment{async execute(t,e){var a=validation.urlOrLayer(t).trim(),n=validation.number("objectId",t.objectId,validation.never);const i=validation.number("attachmentId",t.attachmentId,validation.never);var r=validation.exists("attachment",t.attachment,validation.never),o=validation.string("gdbVersion",t.gdbVersion),d=validation.boolean("returnEditMoment",t.returnEditMoment,!1),m=validation.number("uploadId",t.uploadId),c=validation.number("timeout",t.timeout),n=addToPath(a,`${n}/updateAttachment`);let s=validation.string("attachmentName",t.attachmentName,"").trim();""===s&&(s=void 0);const l=new FormData;l.append("f","json"),l.append("attachmentId",i.toString()),l.append("attachment",r,s),o&&l.append("gdbVersion",o),l.append("returnEditMoment",d?"true":"false"),null!=m&&l.append("uploadId",m?"true":"false");c={body:l,cacheBust:!1,method:"post",responseType:"json",signal:e.cancellationToken.signal,timeout:c},c=(await esriRequest(n,c)).data.updateAttachmentResult;if(!c)throw new GenericActivityError(void 0,'Error running the "Update Attachment" activity. The response did not include the required "updateAttachmentResult" property.');return{result:c}}}UpdateAttachment.action="gcx:wf:arcgis::UpdateAttachment",UpdateAttachment.suite="gcx:wf:builtin";export{UpdateAttachment};

package/activities/arcgis/UpdateFeatures.d.ts

@@ -2,20 +2,16 @@ import type { ApplyEditResult, ApplyEditsResponse } from "./libs/arcGisRestApi";
 import type { IActivityHandler, IActivityContext } from "../../IActivityHandler";
 /** Defines inputs for the UpdateFeatures activity. */
 export interface UpdateFeaturesInputs {
-    /** 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 update in 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 UpdateFeaturesOutputs {
-    /** Indicates the results that were returned. */
+    /** @description The results of the update operation. */
     results: ApplyEditResult[];
+    /** @description Whether the update operation completed successfully. */
     success: boolean;
 }
 export declare class UpdateFeatures implements IActivityHandler {

package/activities/arcgis/printing.d.ts

@@ -0,0 +1,212 @@
+export declare const ENGINE_TASK_ASYNC_POLLING_INTERVAL_MS = 1500;
+export declare const ENGINE_TASK_PARAM_WEB_MAP = "Web_Map_as_JSON";
+export declare const ENGINE_TASK_PARAM_ADDITIONAL_SETTINGS = "Additional_Settings_as_JSON";
+export declare const ENGINE_TASK_PARAM_ADDITIONAL_WEB_MAPS = "Additional_Web_Maps_as_JSON";
+export declare const ENGINE_TASK_PARAM_FORMAT = "Format";
+export declare const ENGINE_TASK_PARAM_LAYOUT_TEMPLATE = "Layout_Template";
+export declare const ENGINE_VGS_LAYOUT_REF_PREFEX = "vglay_";
+export declare const ENGINE_TASK_PARAM_RETURN_ADDITIONAL_LAYOUT_INFO = "Return_Additional_Info";
+export interface CustomPictureElementProps {
+    /** Width and Height of the Element in Page Units. */
+    elementSize: number[];
+    /** Default Value of the Element. */
+    value: string;
+}
+/**
+ * Custom Picture Element.
+ * The key is the element name. The value is the default value of the Element.
+ */
+export type CustomPictureElement = Record<string, CustomPictureElementProps>;
+/**
+ * Custom Text Element.
+ * The key is the element name. The value is the default value of the Element.
+ */
+export type CustomTextElement = Record<string, string>;
+/** Map Frame Information. */
+export interface WebMapFrameElement {
+    /** Width and Height of the Element in Page Units. */
+    elementSize: number[];
+    /** Name of the Map Frame. */
+    name: string;
+}
+/** Further Layout Information. */
+export interface LayoutOptions {
+    /** [non-ESRI Property] List of available Custom Picture Elements. See Print Documentation for more Information on Custom Picture Elements. */
+    customPictureElements?: CustomPictureElement[];
+    /** List of available Custom Text Elements. See Print Documentation for more Information on Custom Text Elements. */
+    customTextElements?: CustomTextElement[];
+    /** Whether a predefined Author Text is available. */
+    hasAuthorText: boolean;
+    /** Whether a predefined Copyright Text is available. */
+    hasCopyrightText: boolean;
+    /** Whether a Legend Element is available. */
+    hasLegend: boolean;
+    /** Whether a predefined Title Text is available. */
+    hasTitleText: boolean;
+}
+/**
+ * Layout Template Information. If Task is requested with Parameter 'Return_Additional_Info' = true,
+ * the Layout Information might contain additional Properties, not available in the ESRI Standard.
+ * See Print Documentation for more Information.
+ */
+export interface LayoutInfo {
+    /** Further Layout Information. */
+    layoutOptions: LayoutOptions;
+    /** Name of the Layout. */
+    layoutTemplate: string;
+    /** Page Size [width, height] */
+    pageSize: number[];
+    /** Page Units. */
+    pageUnits: string;
+    /**  */
+    portalItem: {
+        description: string;
+        /** Url of the item in portal. */
+        home: string;
+        /** The id of the portal item. */
+        id: string;
+        /** The name of the print layout. */
+        name: string;
+        /** The title of the print layout. */
+        title: string;
+        vgsId: string;
+        vgsLayoutPackageRefs: string[];
+        vgsPrintPageType: string;
+        vgsPrintRequestTypes: string[];
+    };
+    /** [non-ESRI Property] Further Map Frame Information. */
+    webMapFrameElements?: WebMapFrameElement[];
+    /** Size of the Map Frame. [width, height] If there are multiple Map Frames on the Layout, it returns Information only for the Map Frame that is named 'WEBMAP_MAP_FRAME'. */
+    webMapFrameSize?: number[];
+}
+export interface AdditionalMap {
+    name: string;
+    Map_As_JSON: ExportWebMap;
+}
+/**
+ * The name of a Map Frame element within a layout.
+ */
+export declare enum MapFrameElementName {
+    WEBMAP_MAP_FRAME = "WEBMAP_MAP_FRAME",
+    OVERVIEW = "OVERVIEW"
+}
+export interface ExportSpatialReference {
+    wkid: number;
+    latestWkid?: number;
+}
+export interface ExportExtent {
+    xmin: number;
+    ymin: number;
+    xmax: number;
+    ymax: number;
+    spatialReference: ExportSpatialReference;
+}
+export interface ExportMapOptions {
+    /**
+     * You can change the map's background color. When there are more than one maps in a layout,
+     * this is applied to the map associated to a map frame named `WEBMAP_MAP_FRAME`.
+     */
+    background?: {
+        color: number[];
+    };
+    /**
+     * A required property that defines the extent of the map.
+     * The spatial reference of the extent object is optional;
+     * when it is not provided, it is assumed to be in the map's spatial reference.
+     * When the aspect ratio of the map extent is different than the size of the map
+     * on the output page or the `exportOptions:outputSize`, you might notice
+     * more features on the output map.
+     */
+    extent: ExportExtent;
+    /**
+     * This represents the number of degrees by which the data frame will be rotated, measured counterclockwise from the north. To rotate clockwise, use a negative value.
+     */
+    rotation?: number;
+    /**
+     * The map scale at which you want your map to be exported. This property is optional but recommended for getting optimal results. The scale property is especially useful when map services in this web map have scale-dependent layers or reference scales set. Since the map that you are viewing on the web app may be smaller than the size of the output map (for example, 8.5 x 11 in. or A4 size), the scale of the output map will be different and you could see differences in features and/or symbols in the web application as compared with the output map.
+     *
+     * When scale is used, it takes precedence over the extent, but the output map is drawn at the requested scale centered on the center of the extent.
+     */
+    scale?: number;
+    /**
+     * The spatial reference of the map. The order of preference when spatialReference is missing is as follows:
+     *
+     *   1. `mapOptions.extent.spatialReference`
+     *   2. `baseMap.baseMapLayers.spatialReference`
+     *   3. Map template's spatial reference
+     */
+    spatialReference?: ExportSpatialReference;
+    /**
+     * If there is a time-aware layer and you want it to be drawn at a specified time, specify this property.
+     * This order list can have one or two elements. Add two elements (startTime followed by endTime ) to represent a time extent,
+     * or provide only one time element to represent a time instant. Times are always in UTC.
+     */
+    time?: any[];
+}
+export interface ExportOperationalLayer {
+    id?: string;
+    layerType: "ArcGISFeatureLayer" | "ArcGISImageServiceLayer" | "ArcGISMapServiceLayer" | "ArcGISTiledImageServiceLayer" | "ArcGISTiledMapServiceLayer" | "VectorTileLayer" | "WebTiledLayer" | "WFS" | "WMS" | "KML";
+    url?: string;
+    token?: string;
+    title?: string;
+    opacity?: number;
+    visibility?: boolean;
+    minScale?: number;
+    maxScale?: number;
+}
+export interface ExportBaseMapLayer {
+    url: string;
+    opacity?: number;
+}
+export interface ExportBaseMap {
+    title: string;
+    baseMapLayers: ExportBaseMapLayer[];
+}
+export interface ExportOptions {
+    dpi?: number;
+    outputSize?: number[];
+}
+/**
+ * @product This is intended for internal use only within VertiGIS Studio products.
+ */
+export interface ExportWebMap {
+    baseMap: ExportBaseMap;
+    /** The base layers. */
+    baseLayers?: any[];
+    /** */
+    exportOptions?: ExportOptions;
+    /** The ground layers. */
+    groundLayers?: any[];
+    /** Details about the layout of the map. */
+    layoutOptions?: {
+        authorText?: string;
+        copyrightText?: string;
+        customTextElements?: Record<string, string>[];
+        legendOptions?: {
+            operationalLayersAutoSet: false;
+            operationalLayers: Record<string, string>[];
+        };
+        titleText?: string;
+    };
+    /** VertiGIS Export Web Map - Map Options as JSON. Remaining Properties are defined by ESRI Export Web Map - Map Options Specification. */
+    mapOptions: ExportMapOptions;
+    /** The operational layers. */
+    operationalLayers: ExportOperationalLayer[];
+    reportOptions: any;
+    /** The spatial reference. */
+    spatialReference: __esri.SpatialReference;
+}
+/** The parameters that are required for including a map in a
+ * report or print job.
+ */
+export interface WebmapPrintParameters {
+    /** The extent in 4326 spatial reference. */
+    extent?: __esri.Extent;
+    /** The name of the map control in the report or print template. */
+    mapName: string;
+    /** The scale of the map in the report or print template. */
+    scale?: number;
+    /** The webmap. */
+    webmap: ExportWebMap;
+}
+export declare function getWebMapOverviewPrintScale(printScale: number, overviewMapFrame: WebMapFrameElement, mainMapFrame: WebMapFrameElement | undefined): number;

package/activities/arcgis/printing.js

@@ -0,0 +1 @@
+const ENGINE_OVERVIEW_MAP_ZOOM_OUT_FACTOR=4,ENGINE_TASK_ASYNC_POLLING_INTERVAL_MS=1500,ENGINE_TASK_PARAM_WEB_MAP="Web_Map_as_JSON",ENGINE_TASK_PARAM_ADDITIONAL_SETTINGS="Additional_Settings_as_JSON",ENGINE_TASK_PARAM_ADDITIONAL_WEB_MAPS="Additional_Web_Maps_as_JSON",ENGINE_TASK_PARAM_FORMAT="Format",ENGINE_TASK_PARAM_LAYOUT_TEMPLATE="Layout_Template",ENGINE_VGS_LAYOUT_REF_PREFEX="vglay_",ENGINE_TASK_PARAM_RETURN_ADDITIONAL_LAYOUT_INFO="Return_Additional_Info";var MapFrameElementName;function getWebMapOverviewPrintScale(_,A,E){if(A&&E){const N=A.elementSize[0],e=A.elementSize[1],T=E.elementSize[0],I=E.elementSize[1];E=Math.min(T/N,I/e);_=Math.round(_*E*ENGINE_OVERVIEW_MAP_ZOOM_OUT_FACTOR)}return _}!function(_){_.WEBMAP_MAP_FRAME="WEBMAP_MAP_FRAME",_.OVERVIEW="OVERVIEW"}(MapFrameElementName=MapFrameElementName||{});export{ENGINE_TASK_ASYNC_POLLING_INTERVAL_MS,ENGINE_TASK_PARAM_WEB_MAP,ENGINE_TASK_PARAM_ADDITIONAL_SETTINGS,ENGINE_TASK_PARAM_ADDITIONAL_WEB_MAPS,ENGINE_TASK_PARAM_FORMAT,ENGINE_TASK_PARAM_LAYOUT_TEMPLATE,ENGINE_VGS_LAYOUT_REF_PREFEX,ENGINE_TASK_PARAM_RETURN_ADDITIONAL_LAYOUT_INFO,MapFrameElementName,getWebMapOverviewPrintScale};

package/activities/arcgis/printingFields.d.ts

@@ -0,0 +1,88 @@
+export declare enum LayoutField {
+    TITLE = "title_value",
+    TITLE_CAPTION = "title_caption",
+    CREATOR = "creator_value",
+    CREATOR_CAPTION = "creator_caption",
+    CREATED = "createdat_value",
+    CREATED_CAPTION = "createdat_caption",
+    ORGNAME = "orgname_value",
+    ORGNAME_CAPTION = "orgname_caption",
+    ORGADRESS = "orgadr_value",
+    ORGADRESS_CAPTION = "orgadr_caption",
+    DISCLAIMER = "disclaimer_value",
+    DISCLAIMER_CAPTION = "disclaimer_caption",
+    SCALE = "scale_value",
+    SCALE_CAPTION = "scale_caption",
+    SCALE_OV = "scale_value_ov",
+    SCALE_OV_CAPTION = "scale_caption_ov",
+    PHONE = "phone_value",
+    PHONE_CAPTION = "phone_caption",
+    MOBILEPHONE = "mobilephone_value",
+    MOBILEPHONE_CAPTION = "mobilephone_caption",
+    FAX = "fax_value",
+    FAX_CAPTION = "fax_caption",
+    EMAIL = "email_value",
+    EMAIL_CAPTION = "email_caption",
+    CRS = "syn_crs",
+    CRS_CAPTION = "syn_crs_caption",
+    PAGE_INFO = "syn_index",
+    PAGE_INFO_CAPTION = "syn_index_caption",
+    TIME_CAPTION = "time_caption",
+    TIME_CURRENT = "current_time_value",
+    TIME_CURRENT_CAPTION = "current_time_caption",
+    TIME_START_END = "start_end_time_value",
+    TIME_START_END_CAPTION = "start_end_time_caption",
+    TIME_START = "start_time_value",
+    TIME_START_CAPTION = "start_time_caption",
+    TIME_END = "end_time_value",
+    TIME_END_CAPTION = "end_time_caption",
+    RANGE_CAPTION = "range_caption",
+    COPYRIGHT = "syn_copyright",
+    COPYRIGHT_CAPTION = "syn_copyright_caption",
+    MAPVIEW = "syn_mapview",
+    MAPVIEW_CAPTION = "syn_mapview_caption",
+    USER_GIVEN_NAME = "user_given_name_value",
+    USER_GIVEN_NAME_CAPTION = "user_given_name_caption",
+    USER_LAST_NAME = "user_sur_name_value",
+    USER_LAST_NAME_CAPTION = "user_sur_name_caption",
+    USER_COMPANY = "user_company_value",
+    USER_COMPANY_CAPTION = "user_company_caption",
+    USER_DIVISION = "user_division_value",
+    USER_DIVISION_CAPTION = "user_division_caption",
+    USER_DEPARTMENT = "user_department_value",
+    USER_DEPARTMENT_CAPTION = "user_department_caption",
+    USER_COUNTRY = "user_country_value",
+    USER_COUNTRY_CAPTION = "user_country_caption",
+    USER_CITY = "user_city_value",
+    USER_CITY_CAPTION = "user_city_caption",
+    USER_STREET_ADDRESS = "user_street_address_value",
+    USER_STREET_ADDRESS_CAPTION = "user_street_address_caption",
+    USER_ZIPCODE = "user_zipcode_value",
+    USER_ZIPCODE_CAPTION = "user_zipcode_caption"
+}
+/**
+ * This defines the language keys for members of `LayoutField` that must be translated
+ * prior to being sent in a Gen2 print operation. Any `LayoutField` absent from this list
+ * is not a translated caption field.
+ */
+export declare const LayoutFieldTranslations: Record<string, string>;
+/**
+ * Details about whether the layout field is an auto-value or not.
+ * An auto-value is a field whose value can be auto-generated by the client or printing engine.
+ */
+export interface AutoValueInfo {
+    /**
+     * True if a field is an auto-value, false otherwise.
+     */
+    isAutoValue: boolean;
+    /**
+     * True if the auot-value must be set by the client, false if the printing engine will populate it.
+     */
+    isClientValue: boolean;
+}
+/**
+ * Gets information about whether the specified layout field is an auto-value or not.
+ * @param layoutFieldName The name of a layout field.
+ * @returns Details about whether the layout field is an auto-value or not.
+ */
+export declare function getAutoValueInfo(layoutFieldName: string): AutoValueInfo;

package/activities/arcgis/printingFields.js

@@ -0,0 +1 @@
+var LayoutField;!function(e){e.TITLE="title_value",e.TITLE_CAPTION="title_caption",e.CREATOR="creator_value",e.CREATOR_CAPTION="creator_caption",e.CREATED="createdat_value",e.CREATED_CAPTION="createdat_caption",e.ORGNAME="orgname_value",e.ORGNAME_CAPTION="orgname_caption",e.ORGADRESS="orgadr_value",e.ORGADRESS_CAPTION="orgadr_caption",e.DISCLAIMER="disclaimer_value",e.DISCLAIMER_CAPTION="disclaimer_caption",e.SCALE="scale_value",e.SCALE_CAPTION="scale_caption",e.SCALE_OV="scale_value_ov",e.SCALE_OV_CAPTION="scale_caption_ov",e.PHONE="phone_value",e.PHONE_CAPTION="phone_caption",e.MOBILEPHONE="mobilephone_value",e.MOBILEPHONE_CAPTION="mobilephone_caption",e.FAX="fax_value",e.FAX_CAPTION="fax_caption",e.EMAIL="email_value",e.EMAIL_CAPTION="email_caption",e.CRS="syn_crs",e.CRS_CAPTION="syn_crs_caption",e.PAGE_INFO="syn_index",e.PAGE_INFO_CAPTION="syn_index_caption",e.TIME_CAPTION="time_caption",e.TIME_CURRENT="current_time_value",e.TIME_CURRENT_CAPTION="current_time_caption",e.TIME_START_END="start_end_time_value",e.TIME_START_END_CAPTION="start_end_time_caption",e.TIME_START="start_time_value",e.TIME_START_CAPTION="start_time_caption",e.TIME_END="end_time_value",e.TIME_END_CAPTION="end_time_caption",e.RANGE_CAPTION="range_caption",e.COPYRIGHT="syn_copyright",e.COPYRIGHT_CAPTION="syn_copyright_caption",e.MAPVIEW="syn_mapview",e.MAPVIEW_CAPTION="syn_mapview_caption",e.USER_GIVEN_NAME="user_given_name_value",e.USER_GIVEN_NAME_CAPTION="user_given_name_caption",e.USER_LAST_NAME="user_sur_name_value",e.USER_LAST_NAME_CAPTION="user_sur_name_caption",e.USER_COMPANY="user_company_value",e.USER_COMPANY_CAPTION="user_company_caption",e.USER_DIVISION="user_division_value",e.USER_DIVISION_CAPTION="user_division_caption",e.USER_DEPARTMENT="user_department_value",e.USER_DEPARTMENT_CAPTION="user_department_caption",e.USER_COUNTRY="user_country_value",e.USER_COUNTRY_CAPTION="user_country_caption",e.USER_CITY="user_city_value",e.USER_CITY_CAPTION="user_city_caption",e.USER_STREET_ADDRESS="user_street_address_value",e.USER_STREET_ADDRESS_CAPTION="user_street_address_caption",e.USER_ZIPCODE="user_zipcode_value",e.USER_ZIPCODE_CAPTION="user_zipcode_caption"}(LayoutField=LayoutField||{});const LayoutFieldTranslations={[LayoutField.TITLE_CAPTION]:"printing-gen2-title",[LayoutField.CREATOR_CAPTION]:"printing-gen2-creator",[LayoutField.CREATED_CAPTION]:"printing-gen2-created",[LayoutField.ORGNAME_CAPTION]:"printing-gen2-organization",[LayoutField.ORGADRESS_CAPTION]:"printing-gen2-address",[LayoutField.DISCLAIMER_CAPTION]:"printing-gen2-disclaimer",[LayoutField.SCALE_CAPTION]:"printing-gen2-scale",[LayoutField.SCALE_OV_CAPTION]:"printing-gen2-overview-scale",[LayoutField.PHONE_CAPTION]:"printing-gen2-phone",[LayoutField.MOBILEPHONE_CAPTION]:"printing-gen2-mobile-phone",[LayoutField.FAX_CAPTION]:"printing-gen2-fax",[LayoutField.EMAIL_CAPTION]:"printing-gen2-email",[LayoutField.CRS_CAPTION]:"printing-gen2-spatial-reference",[LayoutField.PAGE_INFO_CAPTION]:"printing-gen2-page",[LayoutField.TIME_CAPTION]:"printing-gen2-time",[LayoutField.TIME_CURRENT_CAPTION]:"printing-gen2-current-time",[LayoutField.TIME_START_END_CAPTION]:"printing-gen2-start-end-time",[LayoutField.TIME_START_CAPTION]:"printing-gen2-start-time",[LayoutField.TIME_END_CAPTION]:"printing-gen2-end-time",[LayoutField.RANGE_CAPTION]:"printing-gen2-range",[LayoutField.COPYRIGHT_CAPTION]:"printing-gen2-copyright",[LayoutField.MAPVIEW_CAPTION]:"printing-gen2-map-view",[LayoutField.USER_GIVEN_NAME_CAPTION]:"printing-gen2-first-name",[LayoutField.USER_LAST_NAME_CAPTION]:"printing-gen2-last-name",[LayoutField.USER_COMPANY_CAPTION]:"printing-gen2-company",[LayoutField.USER_DIVISION_CAPTION]:"printing-gen2-division",[LayoutField.USER_DEPARTMENT_CAPTION]:"printing-gen2-department",[LayoutField.USER_COUNTRY_CAPTION]:"printing-gen2-country",[LayoutField.USER_CITY_CAPTION]:"printing-gen2-city",[LayoutField.USER_STREET_ADDRESS_CAPTION]:"printing-gen2-street",[LayoutField.USER_ZIPCODE_CAPTION]:"printing-gen2-zip-code"};function getAutoValueInfo(e){let _=!1,i=!1;switch(e){case LayoutField.CREATOR:case LayoutField.EMAIL:case LayoutField.USER_GIVEN_NAME:case LayoutField.USER_LAST_NAME:i=!0;case LayoutField.CREATED:case LayoutField.CRS:case LayoutField.SCALE:case LayoutField.SCALE_OV:case LayoutField.PAGE_INFO:case LayoutField.TIME_CURRENT:case LayoutField.TIME_START_END:case LayoutField.TIME_START:case LayoutField.TIME_END:_=!0}return{isAutoValue:_,isClientValue:i}}export{LayoutField,LayoutFieldTranslations,getAutoValueInfo};