@vertigis/viewer-spec 61.21.0 → 61.23.0

package/app-config/web/DxfExportModelProperties.d.ts

@@ -0,0 +1,14 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Controls which layers are included when exporting to DXF.
+ */
+export type DxfExportLayerOption = "all" | "visible" | "visible-on-map";
+/**
+ * Configuration for a dxf-export component.
+ */
+export interface DxfExportModelProperties extends ComponentModelProperties {
+    /**
+     * Controls which layers are included in the DXF export.
+     */
+    selectedLayerOption?: DxfExportLayerOption;
+}

package/app-config/web/DxfExportModelProperties.js

@@ -0,0 +1 @@
+export{};

package/app-config/web/GeoDataModelProperties.d.ts

@@ -4,13 +4,17 @@ import type { ModelProperties } from "./ModelProperties.js";
  */
 export interface GeoDataModelProperties extends ModelProperties {
     /**
-     * The geoDataServiceUrl for the upload service that needs to import the
-     * LPKX and FGDB files.
+     * The URL for the upload service that needs to import the LPKX and FGDB
+     * files.
      */
     geoDataServiceUrl?: string;
     /**
-     * The displayServiceUrl for the upload service that needs to import the
-     * LPKX and FGDB files.
+     * The URL for the upload service that needs to import the LPKX and FGDB
+     * files.
      */
     displayServiceUrl?: string;
+    /**
+     * The URL for the upload service that needs to import DXF export files.
+     */
+    dxfExportServiceUrl?: string;
 }

package/layout/schema/layout-web.xsd

@@ -64,10 +64,10 @@
         </complexType>
     </element>
 
-    <element name="copy-features" substitutionGroup="base:component">
+    <element name="dxf-export" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">
-                A component that copies source features to an editable target layer.
+                A component that exports map layers in a selected area to a DXF file.
             </documentation>
         </annotation>
         <complexType>

package/messaging/registry/auth.d.ts

@@ -136,6 +136,13 @@ export declare class AuthOperations extends OperationRegistry {
      * @mobileOnly
      */
     get getExistingCredential(): Operation<CredentialRequestInfo, Credential>;
+    /**
+     * Gets a credential. Returns an existing credential if one exists. Prompts
+     * the user for sign in if one cannot be found. Mobile only.
+     *
+     * @mobileOnly
+     */
+    get getCredential(): Operation<CredentialRequestInfo, Credential>;
     /**
      * Check if sign-in is currently supported by the authentication manager.
      * Web only.

package/messaging/registry/auth.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as n}from"../OperationRegistry.js";export class AuthCommands extends e{_prefix="auth";get signIn(){return this._get("sign-in")}get signOut(){return this._get("sign-out")}}export class AuthOperations extends n{_prefix="auth";get getCurrentUser(){return this._get("get-current-user")}get getExistingCredential(){return this._get("get-existing-credential")}get isSignInAvailable(){return this._get("is-sign-in-available")}}export class AuthEvents extends t{_prefix="auth";get signInCancelled(){return this._get("sign-in-cancelled")}get signInCompleted(){return this._get("sign-in-completed")}get portalSignInCompleted(){return this._get("portal-sign-in-completed")}get signInFailed(){return this._get("sign-in-failed")}get signInRequested(){return this._get("sign-in-requested")}get signOutCompleted(){return this._get("sign-out-completed")}get signOutRequested(){return this._get("sign-out-requested")}get tokenRefreshed(){return this._get("token-refreshed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as n}from"../OperationRegistry.js";export class AuthCommands extends e{_prefix="auth";get signIn(){return this._get("sign-in")}get signOut(){return this._get("sign-out")}}export class AuthOperations extends n{_prefix="auth";get getCurrentUser(){return this._get("get-current-user")}get getExistingCredential(){return this._get("get-existing-credential")}get getCredential(){return this._get("get-credential")}get isSignInAvailable(){return this._get("is-sign-in-available")}}export class AuthEvents extends t{_prefix="auth";get signInCancelled(){return this._get("sign-in-cancelled")}get signInCompleted(){return this._get("sign-in-completed")}get portalSignInCompleted(){return this._get("portal-sign-in-completed")}get signInFailed(){return this._get("sign-in-failed")}get signInRequested(){return this._get("sign-in-requested")}get signOutCompleted(){return this._get("sign-out-completed")}get signOutRequested(){return this._get("sign-out-requested")}get tokenRefreshed(){return this._get("token-refreshed")}}

package/messaging/registry/layers.d.ts

@@ -8,7 +8,7 @@ import type { Event } from "../Event.js";
 import { EventRegistry } from "../EventRegistry.js";
 import type { Operation } from "../Operation.js";
 import { OperationRegistry } from "../OperationRegistry.js";
-import type { HasFiles, HasLayers, HasMaps, HasRenderers, HasSymbols, LayersLike } from "../common.js";
+import type { HasFiles, HasLayers, HasMaps, HasRenderers, HasSymbols, HasUITarget, LayersLike } from "../common.js";
 /**
  * Arguments for the "layers.visibility-changed" event.
  */
@@ -120,6 +120,125 @@ export interface FromDxfArgs extends HasFiles {
      */
     outputSpatialReference?: SpatialReferenceJson;
 }
+/**
+ * A sublayer included in a DXF export.
+ */
+export interface DxfExportSublayer {
+    /**
+     * The sublayer ID.
+     */
+    id: string;
+    /**
+     * The name to use for the sublayer in the exported file.
+     */
+    name: string;
+    /**
+     * The source layer ID.
+     */
+    layerId?: string | number;
+    /**
+     * The source layer URL.
+     */
+    layerURL?: string;
+    /**
+     * The geodatabase version to export.
+     */
+    gdbVersion?: string;
+    /**
+     * The layer ID to query.
+     */
+    queryLayer?: string;
+}
+/**
+ * A layer included in a DXF export.
+ */
+export interface DxfExportLayer {
+    /**
+     * The layer ID.
+     */
+    id: string;
+    /**
+     * The name to use for the layer in the exported file.
+     */
+    name: string;
+    /**
+     * The source layer ID.
+     */
+    layerId?: string | number;
+    /**
+     * The source layer URL.
+     */
+    layerURL?: string;
+    /**
+     * The geodatabase version to export.
+     */
+    gdbVersion?: string;
+    /**
+     * The layer ID to query.
+     */
+    queryLayer?: string;
+    /**
+     * Sublayers included in the export.
+     */
+    sublayers?: DxfExportSublayer[];
+}
+/**
+ * Arguments for the layers.to-dxf operation.
+ */
+export interface ToDxfConversionArgs {
+    /**
+     * The DXF export API version.
+     */
+    apiVersion: "1.0";
+    /**
+     * The token used to access secured layers.
+     */
+    authToken?: string;
+    /**
+     * Whether geometries crossing the export area are clipped or included.
+     */
+    boundaryBehavior: "clip" | "include";
+    /**
+     * The polygon ring defining the area to export.
+     */
+    exportArea: number[][];
+    /**
+     * The AutoCAD version of the exported file.
+     */
+    formatOption: "AutoCAD2000" | "AutoCAD2010";
+    /**
+     * The layers to export.
+     */
+    layers: DxfExportLayer[];
+    /**
+     * Whether to create an ASCII or binary DXF file.
+     */
+    resultType: "DXF" | "Binary DXF";
+    /**
+     * The spatial reference of the export area.
+     */
+    spatialReference?: SpatialReferenceJson;
+    /**
+     * The spatial reference of the exported file.
+     */
+    targetSpatialReference?: SpatialReferenceJson;
+    /**
+     * The ID of the user requesting the export.
+     */
+    userID?: string;
+    /**
+     * The name of the user requesting the export.
+     */
+    username?: string;
+    /**
+     * The version name used by the export service.
+     */
+    versionName: "DEFAULT";
+    /**
+     * The URL of the web map data to export.
+     */
+    webMapUrl?: string;
+}
 /**
  * Arguments for the layers.from-url operation.
  */
@@ -131,6 +250,12 @@ export interface FromUrlArgs {
 }
 export declare class LayersCommands extends CommandRegistry {
     protected readonly _prefix = "layers";
+    /**
+     * Displays the DXF export log UI. Web only.
+     *
+     * @webOnly
+     */
+    get displayDxfLog(): Command<HasUITarget>;
     /**
      * Guard command for enabling the layers.set-symbol command. Web only.
      *
@@ -305,6 +430,12 @@ export declare class LayersOperations extends OperationRegistry {
      * @webOnly
      */
     get fromDxf(): Operation<FromDxfArgs | Blob | Blob[], HasLayers>;
+    /**
+     * Exports map layers to a DXF file. Web only.
+     *
+     * @webOnly
+     */
+    get toDxf(): Operation<ToDxfConversionArgs, Blob>;
     /**
      * Attempts to create layer(s) from a url. Web only.
      *

package/messaging/registry/layers.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class LayersCommands extends e{_prefix="layers";get ensureCanSetSymbol(){return this._get("ensure-can-set-symbol")}get resetDefinitionExpression(){return this._get("reset-definition-expression")}get resetSymbol(){return this._get("reset-symbol")}get setDefinitionExpression(){return this._get("set-definition-expression")}get setLabelClasses(){return this._get("set-label-classes")}get setPopupTemplate(){return this._get("set-popup-template")}get setSymbol(){return this._get("set-symbol")}get setTaskSettings(){return this._get("set-task-settings")}get setTitle(){return this._get("set-title")}get setVisibility(){return this._get("set-visibility")}get showLabels(){return this._get("show-labels")}get hideLabels(){return this._get("hide-labels")}}export class LayersOperations extends s{_prefix="layers";get getPopupTemplate(){return this._get("get-popup-template")}get getLabelClasses(){return this._get("get-label-classes")}get getTaskSettings(){return this._get("get-task-settings")}get getTitle(){return this._get("get-title")}get editSettings(){return this._get("edit-settings")}get editLabelSettings(){return this._get("edit-symbol-settings")}get editSymbols(){return this._get("edit-symbols")}get fromKml(){return this._get("from-kml")}get fromFgdb(){return this._get("from-fgdb")}get fromLpkx(){return this._get("from-lpkx")}get fromDxf(){return this._get("from-dxf")}get fromUrl(){return this._get("from-url")}}export class LayersEvents extends t{_prefix="layers";get definitionExpressionChanged(){return this._get("definition-expression-changed")}get visibilityChanged(){return this._get("visibility-changed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export class LayersCommands extends e{_prefix="layers";get displayDxfLog(){return this._get("display-dxf-log")}get ensureCanSetSymbol(){return this._get("ensure-can-set-symbol")}get resetDefinitionExpression(){return this._get("reset-definition-expression")}get resetSymbol(){return this._get("reset-symbol")}get setDefinitionExpression(){return this._get("set-definition-expression")}get setLabelClasses(){return this._get("set-label-classes")}get setPopupTemplate(){return this._get("set-popup-template")}get setSymbol(){return this._get("set-symbol")}get setTaskSettings(){return this._get("set-task-settings")}get setTitle(){return this._get("set-title")}get setVisibility(){return this._get("set-visibility")}get showLabels(){return this._get("show-labels")}get hideLabels(){return this._get("hide-labels")}}export class LayersOperations extends s{_prefix="layers";get getPopupTemplate(){return this._get("get-popup-template")}get getLabelClasses(){return this._get("get-label-classes")}get getTaskSettings(){return this._get("get-task-settings")}get getTitle(){return this._get("get-title")}get editSettings(){return this._get("edit-settings")}get editLabelSettings(){return this._get("edit-symbol-settings")}get editSymbols(){return this._get("edit-symbols")}get fromKml(){return this._get("from-kml")}get fromFgdb(){return this._get("from-fgdb")}get fromLpkx(){return this._get("from-lpkx")}get fromDxf(){return this._get("from-dxf")}get toDxf(){return this._get("to-dxf")}get fromUrl(){return this._get("from-url")}}export class LayersEvents extends t{_prefix="layers";get definitionExpressionChanged(){return this._get("definition-expression-changed")}get visibilityChanged(){return this._get("visibility-changed")}}