@vertigis/viewer-spec 56.23.0 → 56.25.0

package/messaging/registry/printing.d.ts

@@ -1,166 +1,166 @@
-import type Viewpoint from "@arcgis/core/Viewpoint";
-import type Extent from "@arcgis/core/geometry/Extent";
-import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
-import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
-import type { Command } from "../Command.js";
-import { CommandRegistry } from "../CommandRegistry.js";
-import type { Event } from "../Event.js";
-import { EventRegistry } from "../EventRegistry.js";
-import type { MapsLike } from "../common.js";
-/**
- * A set of parameters used to run a job.
- */
-export type JobParameters = Record<string, unknown>;
-/**
- * The export formats allowed for the layout print.
- */
-export type LayoutExportFormats = "AIX" | "BMP" | "MF" | "EPS" | "GIF" | "JPG" | "PDF" | "PNG" | "PNG32" | "SVG" | "SVGZ" | "TGA" | "TIFF";
-/**
- * The arguments required by the printing.run command when printing with ArcGIS
- * Pro layouts.
- */
-export interface RunLayoutPrintArgs extends RunPrintArgsBase {
-    /**
-     * The ID of the layout item to be printed.
-     */
-    layoutId: string;
-    /**
-     * The export format of the layout print.
-     */
-    exportFormat?: LayoutExportFormats;
-}
-/**
- * The arguments required by the printing.run command when printing with
- * templates.
- */
-export interface RunPrintArgs extends RunPrintArgsBase {
-    /**
-     * The WKID of the spatial reference used to draw a grid on the map(s).
-     */
-    grid?: SpatialReference;
-}
-/**
- * The base arguments for the printing.run command.
- */
-interface RunPrintArgsBase {
-    /**
-     * The map(s) to print.
-     */
-    maps: MapsLike;
-    /**
-     * The ID of the report item.
-     */
-    id?: string;
-    /**
-     * The title of the report.
-     */
-    title?: string;
-    /**
-     * The portal item where the report is located.
-     */
-    portalItem?: PortalItemLike;
-    /**
-     * The DPI with which to print.
-     */
-    dpi?: number;
-    /**
-     * The scale of the map(s). Defaults to the map's current scale.
-     */
-    scale?: number;
-    /**
-     * The initial extent of the 2D map(s). Defaults to the map's current
-     * extent. If scale is provided, only the center point is used.
-     */
-    extent?: Extent;
-    /**
-     * The initial viewpoint of the 3D map(s). Defaults to the scene's current
-     * viewpoint.
-     */
-    viewpoint?: Viewpoint;
-    /**
-     * The rotation of the map(s). Defaults to the map's current rotation.
-     */
-    rotation?: number;
-    /**
-     * Additional parameters used in the print template, specified as key-value
-     * pairs.
-     */
-    parameters?: JobParameters;
-    /**
-     * A unique ID used to track a print job.
-     */
-    instanceId?: string;
-}
-/**
- * Base for the Print Event Args interfaces.
- */
-export interface PrintEventArgsBase {
-    /**
-     * The ID of the print template being used.
-     */
-    printTemplateId: string;
-    /**
-     * A unique ID to track the running of this print.
-     */
-    instanceId: string;
-}
-/**
- * Arguments for the printing.print-error event.
- */
-export interface PrintErrorEventArgs extends PrintEventArgsBase {
-    /**
-     * The error message.
-     */
-    message: string;
-    /**
-     * The HTTP status code associated with the error, if it's a HTTP error.
-     */
-    errorCode?: number;
-}
-/**
- * Arguments for the printing.print-finished event.
- */
-export interface PrintFinishedEventArgs extends PrintEventArgsBase {
-    /**
-     * The URL from which to download the print.
-     */
-    downloadUrl: string;
-}
-/**
- * Arguments for the printing.print-progress event.
- */
-export interface PrintProgressEventArgs extends PrintEventArgsBase {
-}
-/**
- * Arguments for the printing.print-started event.
- */
-export interface PrintStartedEventArgs extends PrintEventArgsBase {
-}
-export declare class PrintCommands extends CommandRegistry {
-    protected readonly _prefix = "printing";
-    /**
-     * Run a print job with a given map and template/layout.
-     */
-    get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
-}
-export declare class PrintEvents extends EventRegistry {
-    protected readonly _prefix = "printing";
-    /**
-     * Raised when a print has started running.
-     */
-    get printStarted(): Event<PrintStartedEventArgs>;
-    /**
-     * Raised while a print is running to provide updates on its status.
-     */
-    get printProgress(): Event<PrintProgressEventArgs>;
-    /**
-     * Raised when a print has finished running. Event arguments include the
-     * print download URL.
-     */
-    get printFinished(): Event<PrintFinishedEventArgs>;
-    /**
-     * Raised when an error occurs with running a print.
-     */
-    get printError(): Event<PrintErrorEventArgs>;
-}
-export {};
+import type Viewpoint from "@arcgis/core/Viewpoint";
+import type Extent from "@arcgis/core/geometry/Extent";
+import type SpatialReference from "@arcgis/core/geometry/SpatialReference";
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { Command } from "../Command.js";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event.js";
+import { EventRegistry } from "../EventRegistry.js";
+import type { MapsLike } from "../common.js";
+/**
+ * A set of parameters used to run a job.
+ */
+export type JobParameters = Record<string, unknown>;
+/**
+ * The export formats allowed for the layout print.
+ */
+export type LayoutExportFormats = "AIX" | "BMP" | "MF" | "EPS" | "GIF" | "JPG" | "PDF" | "PNG" | "PNG32" | "SVG" | "SVGZ" | "TGA" | "TIFF";
+/**
+ * The arguments required by the printing.run command when printing with ArcGIS
+ * Pro layouts.
+ */
+export interface RunLayoutPrintArgs extends RunPrintArgsBase {
+    /**
+     * The ID of the layout item to be printed.
+     */
+    layoutId: string;
+    /**
+     * The export format of the layout print.
+     */
+    exportFormat?: LayoutExportFormats;
+}
+/**
+ * The arguments required by the printing.run command when printing with
+ * templates.
+ */
+export interface RunPrintArgs extends RunPrintArgsBase {
+    /**
+     * The WKID of the spatial reference used to draw a grid on the map(s).
+     */
+    grid?: SpatialReference;
+}
+/**
+ * The base arguments for the printing.run command.
+ */
+interface RunPrintArgsBase {
+    /**
+     * The map(s) to print.
+     */
+    maps: MapsLike;
+    /**
+     * The ID of the report item.
+     */
+    id?: string;
+    /**
+     * The title of the report.
+     */
+    title?: string;
+    /**
+     * The portal item where the report is located.
+     */
+    portalItem?: PortalItemLike;
+    /**
+     * The DPI with which to print.
+     */
+    dpi?: number;
+    /**
+     * The scale of the map(s). Defaults to the map's current scale.
+     */
+    scale?: number;
+    /**
+     * The initial extent of the 2D map(s). Defaults to the map's current
+     * extent. If scale is provided, only the center point is used.
+     */
+    extent?: Extent;
+    /**
+     * The initial viewpoint of the 3D map(s). Defaults to the scene's current
+     * viewpoint.
+     */
+    viewpoint?: Viewpoint;
+    /**
+     * The rotation of the map(s). Defaults to the map's current rotation.
+     */
+    rotation?: number;
+    /**
+     * Additional parameters used in the print template, specified as key-value
+     * pairs.
+     */
+    parameters?: JobParameters;
+    /**
+     * A unique ID used to track a print job.
+     */
+    instanceId?: string;
+}
+/**
+ * Base for the Print Event Args interfaces.
+ */
+export interface PrintEventArgsBase {
+    /**
+     * The ID of the print template being used.
+     */
+    printTemplateId: string;
+    /**
+     * A unique ID to track the running of this print.
+     */
+    instanceId: string;
+}
+/**
+ * Arguments for the printing.print-error event.
+ */
+export interface PrintErrorEventArgs extends PrintEventArgsBase {
+    /**
+     * The error message.
+     */
+    message: string;
+    /**
+     * The HTTP status code associated with the error, if it's a HTTP error.
+     */
+    errorCode?: number;
+}
+/**
+ * Arguments for the printing.print-finished event.
+ */
+export interface PrintFinishedEventArgs extends PrintEventArgsBase {
+    /**
+     * The URL from which to download the print.
+     */
+    downloadUrl: string;
+}
+/**
+ * Arguments for the printing.print-progress event.
+ */
+export interface PrintProgressEventArgs extends PrintEventArgsBase {
+}
+/**
+ * Arguments for the printing.print-started event.
+ */
+export interface PrintStartedEventArgs extends PrintEventArgsBase {
+}
+export declare class PrintCommands extends CommandRegistry {
+    protected readonly _prefix = "printing";
+    /**
+     * Run a print job with a given map and template/layout.
+     */
+    get run(): Command<RunPrintArgs | RunLayoutPrintArgs>;
+}
+export declare class PrintEvents extends EventRegistry {
+    protected readonly _prefix = "printing";
+    /**
+     * Raised when a print has started running.
+     */
+    get printStarted(): Event<PrintStartedEventArgs>;
+    /**
+     * Raised while a print is running to provide updates on its status.
+     */
+    get printProgress(): Event<PrintProgressEventArgs>;
+    /**
+     * Raised when a print has finished running. Event arguments include the
+     * print download URL.
+     */
+    get printFinished(): Event<PrintFinishedEventArgs>;
+    /**
+     * Raised when an error occurs with running a print.
+     */
+    get printError(): Event<PrintErrorEventArgs>;
+}
+export {};

package/messaging/registry/printing.js

@@ -1 +1 @@
-import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class PrintCommands extends r{constructor(){super(...arguments),this._prefix="printing"}get run(){return this._get("run")}}export class PrintEvents extends t{constructor(){super(...arguments),this._prefix="printing"}get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}
+import{CommandRegistry as r}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";export class PrintCommands extends r{_prefix="printing";get run(){return this._get("run")}}export class PrintEvents extends t{_prefix="printing";get printStarted(){return this._get("print-started")}get printProgress(){return this._get("print-progress")}get printFinished(){return this._get("print-finished")}get printError(){return this._get("print-error")}}

package/messaging/registry/project.d.ts

@@ -1,144 +1,144 @@
-import type { AppConfig } from "../../app-config";
-import type { SharedProject } from "../../app-config/web/SharedProjectsModelProperties";
-import type { Command } from "../Command";
-import { CommandRegistry } from "../CommandRegistry.js";
-import type { Event } from "../Event";
-import { EventRegistry } from "../EventRegistry.js";
-import type { Operation } from "../Operation";
-import { OperationRegistry } from "../OperationRegistry.js";
-import type { Blob } from "../common";
-/**
- * An object that has a `appConfig` property.
- */
-export interface HasAppConfig {
-    /**
-     * The AppConfig for the command or operation.
-     */
-    appConfig?: AppConfig;
-}
-/**
- * Arguments for the project.delete-shared command. Only available in VertiGIS
- * Studio Web.
- */
-export interface DeleteSharedProjectArgs extends Partial<SharedProject> {
-    /**
-     * Whether to show a confirm prompt, when overwriting a shared project.
-     * Defaults to 'true'.
-     */
-    showConfirm?: boolean;
-}
-/**
- * Arguments for the project.show-settings command. Only available in VertiGIS
- * Studio Web.
- */
-export interface ShowSharedProjectArgs extends Partial<SharedProject>, HasAppConfig {
-    /**
-     * Whether to create a new project. If a project is provided it will be used
-     * as the starting point for configuration.
-     */
-    createNewProject?: boolean;
-}
-/**
- * Arguments for the project.save-shared operation. Only available in VertiGIS
- * Studio Web.
- */
-export interface SaveSharedProjectArgs extends Partial<SharedProject>, HasAppConfig {
-    /**
-     * Whether to show a confirm prompt, when overwriting a shared project.
-     * Defaults to 'true'.
-     */
-    showConfirm?: boolean;
-}
-export declare class ProjectCommands extends CommandRegistry {
-    protected readonly _prefix = "project";
-    /**
-     * Loads a project's app config and updates the application's current state,
-     * accordingly. If more than one file is provided, only the first will be
-     * loaded. Web only.
-     *
-     * @webOnly
-     */
-    get load(): Command<AppConfig | HasAppConfig | SharedProject | Blob | Blob[]>;
-    /**
-     * Create or updates a shared project with the specified shared project
-     * details and project config. Web only.
-     *
-     * @webOnly
-     */
-    get saveShared(): Command<SaveSharedProjectArgs>;
-    /**
-     * Guard command for enabling the project.save-shared command. Web only.
-     *
-     * @webOnly
-     */
-    get ensureCanSaveShared(): Command<SaveSharedProjectArgs>;
-    /**
-     * Shows a shared projects settings. Requires a shared-projects component to
-     * be in the layout. Web only.
-     *
-     * @webOnly
-     */
-    get showSettings(): Command<ShowSharedProjectArgs>;
-    /**
-     * Shows a shared projects share link. Requires a shared-projects component
-     * to be in the layout. Web only.
-     *
-     * @webOnly
-     */
-    get showShareLink(): Command<SharedProject>;
-    /**
-     * Deletes a shared project and its associated project config. Web only.
-     *
-     * @webOnly
-     */
-    get deleteShared(): Command<DeleteSharedProjectArgs>;
-}
-export declare class ProjectOperations extends OperationRegistry {
-    protected readonly _prefix = "project";
-    /**
-     * Creates app config for a project, based on the current state of the
-     * application. Web only.
-     *
-     * @webOnly
-     */
-    get create(): Operation<unknown, AppConfig | HasAppConfig>;
-    /**
-     * Returns a Shared Project Content. Web only.
-     *
-     * @webOnly
-     */
-    get getSharedContent(): Operation<SharedProject, HasAppConfig>;
-    /**
-     * Returns a url share link for the provided Shared Project. Web only.
-     *
-     * @webOnly
-     */
-    get getShareLink(): Operation<SharedProject, string>;
-    /**
-     * Returns a list of Shared Projects. Web only.
-     *
-     * @webOnly
-     */
-    get getShared(): Operation<void, SharedProject[]>;
-}
-export declare class ProjectEvents extends EventRegistry {
-    protected readonly _prefix = "project";
-    /**
-     * Raised when a project is loaded. Web only.
-     *
-     * @webOnly
-     */
-    get loaded(): Event<SharedProject>;
-    /**
-     * Raised when a shared project is added. Web only.
-     *
-     * @webOnly
-     */
-    get shareAdded(): Event<SharedProject>;
-    /**
-     * Raised when a shared project is removed. Web only.
-     *
-     * @webOnly
-     */
-    get shareRemoved(): Event<SharedProject>;
-}
+import type { AppConfig } from "../../app-config";
+import type { SharedProject } from "../../app-config/web/SharedProjectsModelProperties";
+import type { Command } from "../Command";
+import { CommandRegistry } from "../CommandRegistry.js";
+import type { Event } from "../Event";
+import { EventRegistry } from "../EventRegistry.js";
+import type { Operation } from "../Operation";
+import { OperationRegistry } from "../OperationRegistry.js";
+import type { Blob } from "../common";
+/**
+ * An object that has a `appConfig` property.
+ */
+export interface HasAppConfig {
+    /**
+     * The AppConfig for the command or operation.
+     */
+    appConfig?: AppConfig;
+}
+/**
+ * Arguments for the project.delete-shared command. Only available in VertiGIS
+ * Studio Web.
+ */
+export interface DeleteSharedProjectArgs extends Partial<SharedProject> {
+    /**
+     * Whether to show a confirm prompt, when overwriting a shared project.
+     * Defaults to 'true'.
+     */
+    showConfirm?: boolean;
+}
+/**
+ * Arguments for the project.show-settings command. Only available in VertiGIS
+ * Studio Web.
+ */
+export interface ShowSharedProjectArgs extends Partial<SharedProject>, HasAppConfig {
+    /**
+     * Whether to create a new project. If a project is provided it will be used
+     * as the starting point for configuration.
+     */
+    createNewProject?: boolean;
+}
+/**
+ * Arguments for the project.save-shared operation. Only available in VertiGIS
+ * Studio Web.
+ */
+export interface SaveSharedProjectArgs extends Partial<SharedProject>, HasAppConfig {
+    /**
+     * Whether to show a confirm prompt, when overwriting a shared project.
+     * Defaults to 'true'.
+     */
+    showConfirm?: boolean;
+}
+export declare class ProjectCommands extends CommandRegistry {
+    protected readonly _prefix = "project";
+    /**
+     * Loads a project's app config and updates the application's current state,
+     * accordingly. If more than one file is provided, only the first will be
+     * loaded. Web only.
+     *
+     * @webOnly
+     */
+    get load(): Command<AppConfig | HasAppConfig | SharedProject | Blob | Blob[]>;
+    /**
+     * Create or updates a shared project with the specified shared project
+     * details and project config. Web only.
+     *
+     * @webOnly
+     */
+    get saveShared(): Command<SaveSharedProjectArgs>;
+    /**
+     * Guard command for enabling the project.save-shared command. Web only.
+     *
+     * @webOnly
+     */
+    get ensureCanSaveShared(): Command<SaveSharedProjectArgs>;
+    /**
+     * Shows a shared projects settings. Requires a shared-projects component to
+     * be in the layout. Web only.
+     *
+     * @webOnly
+     */
+    get showSettings(): Command<ShowSharedProjectArgs>;
+    /**
+     * Shows a shared projects share link. Requires a shared-projects component
+     * to be in the layout. Web only.
+     *
+     * @webOnly
+     */
+    get showShareLink(): Command<SharedProject>;
+    /**
+     * Deletes a shared project and its associated project config. Web only.
+     *
+     * @webOnly
+     */
+    get deleteShared(): Command<DeleteSharedProjectArgs>;
+}
+export declare class ProjectOperations extends OperationRegistry {
+    protected readonly _prefix = "project";
+    /**
+     * Creates app config for a project, based on the current state of the
+     * application. Web only.
+     *
+     * @webOnly
+     */
+    get create(): Operation<unknown, AppConfig | HasAppConfig>;
+    /**
+     * Returns a Shared Project Content. Web only.
+     *
+     * @webOnly
+     */
+    get getSharedContent(): Operation<SharedProject, HasAppConfig>;
+    /**
+     * Returns a url share link for the provided Shared Project. Web only.
+     *
+     * @webOnly
+     */
+    get getShareLink(): Operation<SharedProject, string>;
+    /**
+     * Returns a list of Shared Projects. Web only.
+     *
+     * @webOnly
+     */
+    get getShared(): Operation<void, SharedProject[]>;
+}
+export declare class ProjectEvents extends EventRegistry {
+    protected readonly _prefix = "project";
+    /**
+     * Raised when a project is loaded. Web only.
+     *
+     * @webOnly
+     */
+    get loaded(): Event<SharedProject>;
+    /**
+     * Raised when a shared project is added. Web only.
+     *
+     * @webOnly
+     */
+    get shareAdded(): Event<SharedProject>;
+    /**
+     * Raised when a shared project is removed. Web only.
+     *
+     * @webOnly
+     */
+    get shareRemoved(): Event<SharedProject>;
+}

package/messaging/registry/project.js

@@ -1 +1 @@
-import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class ProjectCommands extends e{constructor(){super(...arguments),this._prefix="project"}get load(){return this._get("load")}get saveShared(){return this._get("save-shared")}get ensureCanSaveShared(){return this._get("ensure-can-save-shared")}get showSettings(){return this._get("show-settings")}get showShareLink(){return this._get("show-share-link")}get deleteShared(){return this._get("delete-shared")}}export class ProjectOperations extends r{constructor(){super(...arguments),this._prefix="project"}get create(){return this._get("create")}get getSharedContent(){return this._get("get-shared-content")}get getShareLink(){return this._get("get-share-link")}get getShared(){return this._get("get-shared")}}export class ProjectEvents extends t{constructor(){super(...arguments),this._prefix="project"}get loaded(){return this._get("loaded")}get shareAdded(){return this._get("share-added")}get shareRemoved(){return this._get("share-removed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as r}from"../OperationRegistry.js";export class ProjectCommands extends e{_prefix="project";get load(){return this._get("load")}get saveShared(){return this._get("save-shared")}get ensureCanSaveShared(){return this._get("ensure-can-save-shared")}get showSettings(){return this._get("show-settings")}get showShareLink(){return this._get("show-share-link")}get deleteShared(){return this._get("delete-shared")}}export class ProjectOperations extends r{_prefix="project";get create(){return this._get("create")}get getSharedContent(){return this._get("get-shared-content")}get getShareLink(){return this._get("get-share-link")}get getShared(){return this._get("get-shared")}}export class ProjectEvents extends t{_prefix="project";get loaded(){return this._get("loaded")}get shareAdded(){return this._get("share-added")}get shareRemoved(){return this._get("share-removed")}}