@vertigis/viewer-spec 52.0.0 → 53.0.0

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

@@ -26,11 +26,11 @@ export interface HasVisibilityFilters {
      * end-user. If both visibleTo and hiddenFrom are undefined/empty, the
      * component will be visible to all users.
      */
-    visibleTo?: VisibilityFilter[];
+    visibleTo?: Iterable<VisibilityFilter>;
     /**
      * Filters that determine whether the UI element is hidden from a given
      * end-user. If both visibleTo and hiddenFrom are undefined/empty, the
      * component will be visible to all users.
      */
-    hiddenFrom?: VisibilityFilter[];
+    hiddenFrom?: Iterable<VisibilityFilter>;
 }

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

@@ -0,0 +1,12 @@
+import type { ItemRef } from "../common/ItemRef.js";
+import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
+/**
+ * Configuration for project service.
+ */
+export interface ProjectModelProperties extends ServiceModelProperties {
+    /**
+     * The active layout of VertiGIS Studio Web. This property is only
+     * serialized to saved projects.
+     */
+    layout?: ItemRef;
+}

package/app-config/web/ProjectModelProperties.js

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

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

@@ -0,0 +1,53 @@
+import type { ItemRef } from "../common/ItemRef";
+import type { ComponentModelProperties } from "./ComponentModelProperties";
+import type { HasVisibilityFilters, PortalUsername } from "./HasVisibilityFilters";
+/**
+ * Configuration for a shared project.
+ */
+export interface SharedProject extends HasVisibilityFilters {
+    /**
+     * The unique ID for this entity.
+     */
+    readonly id: string;
+    /**
+     * A human-readable title for the shared project.
+     */
+    title: string;
+    /**
+     * A description for the shared project.
+     */
+    description: string;
+    /**
+     * The created Date.
+     */
+    created: Date;
+    /**
+     * Indicates if the shared project is shared as 'read only'.
+     */
+    readOnly?: boolean;
+    /**
+     * The modified Date.
+     */
+    modified?: Date;
+    /**
+     * The username of the last modifier.
+     */
+    modifiedBy?: PortalUsername;
+    /**
+     * The username of the owner.
+     */
+    owner?: PortalUsername;
+}
+/**
+ * Configuration for the Shared Projects component.
+ */
+export interface SharedProjectsModelProperties extends ComponentModelProperties {
+    /**
+     * The actions to be shown in the shared projects title context menu.
+     */
+    titleActions?: ItemRef;
+    /**
+     * The actions to be shown in the shared projects list context menu.
+     */
+    projectActions?: ItemRef;
+}

package/app-config/web/SharedProjectsModelProperties.js

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

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

@@ -0,0 +1,30 @@
+import type { ServiceModelProperties } from "../common/ServiceModelProperties";
+/**
+ * Configuration for an application specific shared storage share. Backed by an
+ * S3 api compatible service.
+ */
+export interface SharedStorageModelProperties extends ServiceModelProperties {
+    /**
+     * The bucket for the share.
+     */
+    bucket?: string;
+    /**
+     * The endpoint to be used.
+     */
+    endpoint?: string;
+    /**
+     * The portal item that holds the read write credentials for shared storage.
+     * Access to these credentials will be limited by its portal item sharing
+     * settings. This portal item should never be shared publicly as this would
+     * provide public read write access to your endpoint. Extra care should be
+     * given to restrict the scope of these credentials to only the specific
+     * endpoint and bucket needed.
+     */
+    credentialsPortalItem?: string;
+    /**
+     * Additional config that will be passed to the S3 api config on
+     * initialization. (See
+     * https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/clients/client-s3/interfaces/s3clientconfig.html).
+     */
+    additionalConfiguration?: Record<string, unknown>;
+}

package/app-config/web/SharedStorageModelProperties.js

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

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

@@ -1,6 +1,5 @@
 import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
 import type { ApplicationModelProperties } from "../common/ApplicationModelProperties.js";
-import type { ItemRef } from "../common/ItemRef.js";
 /**
  * The privacy policy link location options.
  */
@@ -58,11 +57,6 @@ export interface VertigisWebModelProperties extends ApplicationModelProperties {
      * configuration.
      */
     version?: string;
-    /**
-     * The active layout of VertiGIS Studio Web. This property is only
-     * serialized to saved projects.
-     */
-    layout?: ItemRef;
 }
 /**
  * An object specifying a URL that should use a specific proxy.

package/layout/schema/layout-common.xsd

@@ -222,6 +222,17 @@
                 </documentation>
             </annotation>
         </attribute>
+        <attribute name="available" type="boolean">
+            <annotation>
+                <documentation xml:lang="en">
+                    This property marks a component as being available. The
+                    interpretation of what effect this has is up to the component.
+                    Currently the only component that will react to this property
+                    is the task-bar, which will have the effect of showing/hiding
+                    the tab/button for that component. Defaults to true. Mobile only.
+                </documentation>
+            </annotation>
+        </attribute>
     </complexType>
 
     <!-- Basic Components -->

package/layout/schema/layout-web.xsd

@@ -197,6 +197,19 @@
         </complexType>
     </element>
 
+    <element name="shared-projects" substitutionGroup="base:component">
+        <annotation>
+            <documentation xml:lang="en">
+                A component that allows the user to manage and view shared projects.
+            </documentation>
+        </annotation>
+        <complexType>
+            <complexContent>
+                <extension base="base:Component" />
+            </complexContent>
+        </complexType>
+    </element>
+
     <element name="results-table" substitutionGroup="base:component">
         <annotation>
             <documentation xml:lang="en">

package/messaging/registry/Commands.d.ts

@@ -22,6 +22,7 @@ import { OfflineCommands } from "./offline.js";
 import { PanelCommands } from "./panel.js";
 import { PhotosCommands } from "./photos.js";
 import { PrintCommands } from "./printing.js";
+import { ProjectCommands } from "./project.js";
 import { RegionCommands } from "./region.js";
 import { ReportsCommands } from "./reports.js";
 import { ResultsCommands } from "./results.js";
@@ -54,6 +55,7 @@ export declare class Commands extends CommandRegistry {
     readonly measurement: MeasurementCommands;
     readonly offline: OfflineCommands;
     readonly panel: PanelCommands;
+    readonly project: ProjectCommands;
     readonly photos: PhotosCommands;
     readonly printing: PrintCommands;
     readonly region: RegionCommands;

package/messaging/registry/Commands.js

@@ -1 +1 @@
-import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as t}from"./auth.js";import{BasemapCommands as i}from"./basemap.js";import{ChartsCommands as m}from"./charts.js";import{DrawingCommands as r}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as h}from"./file.js";import{GeolocationCommands as a}from"./geolocation.js";import{GeometryToolbarCommands as n}from"./geometry-toolbar.js";import{GeometryCommands as p}from"./geometry.js";import{HighlightsCommands as g}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as f}from"./kpi.js";import{LayerComparisonCommands as j}from"./layer-comparison.js";import{LayerPresetsCommands as _}from"./layer-presets.js";import{LayersCommands as l}from"./layers.js";import{LocationMarkerCommands as c}from"./location-marker.js";import{MapCommands as y}from"./map.js";import{MeasurementCommands as u}from"./measurement.js";import{OfflineCommands as d}from"./offline.js";import{PanelCommands as k}from"./panel.js";import{PhotosCommands as b}from"./photos.js";import{PrintCommands as C}from"./printing.js";import{RegionCommands as v}from"./region.js";import{ReportsCommands as x}from"./reports.js";import{ResultsCommands as A}from"./results.js";import{SearchCommands as M}from"./search.js";import{SketchingCommands as P}from"./sketching.js";import{StudioAnalyticsCommands as R}from"./studioAnalytics.js";import{SystemCommands as T}from"./system.js";import{UICommands as q}from"./ui.js";import{ViewerCommands as z}from"./viewer.js";import{WorkflowCommands as B}from"./workflow.js";export class Commands extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.auth=new t(this._messages),this.basemap=new i(this._messages),this.charts=new m(this._messages),this.drawing=new r(this._messages),this.edit=new o(this._messages),this.file=new h(this._messages),this.geolocation=new a(this._messages),this.geometry=new p(this._messages),this.geometryToolbar=new n(this._messages),this.highlights=new g(this._messages),this.iwtm=new w(this._messages),this.kpi=new f(this._messages),this.layers=new l(this._messages),this.layerComparison=new j(this._messages),this.layerPresets=new _(this._messages),this.locationMarker=new c(this._messages),this.map=new y(this._messages),this.measurement=new u(this._messages),this.offline=new d(this._messages),this.panel=new k(this._messages),this.photos=new b(this._messages),this.printing=new C(this._messages),this.region=new v(this._messages),this.reports=new x(this._messages),this.results=new A(this._messages),this.search=new M(this._messages),this.sketching=new P(this._messages),this.studioAnalytics=new R(this._messages),this.system=new T(this._messages),this.ui=new q(this._messages),this.viewer=new z(this._messages),this.workflow=new B(this._messages)}}
+import{CommandRegistry as s}from"../CommandRegistry.js";import{AppCommands as e}from"./app.js";import{AuthCommands as t}from"./auth.js";import{BasemapCommands as i}from"./basemap.js";import{ChartsCommands as m}from"./charts.js";import{DrawingCommands as r}from"./drawing.js";import{EditCommands as o}from"./edit.js";import{FileCommands as h}from"./file.js";import{GeolocationCommands as a}from"./geolocation.js";import{GeometryToolbarCommands as n}from"./geometry-toolbar.js";import{GeometryCommands as p}from"./geometry.js";import{HighlightsCommands as g}from"./highlights.js";import{IwtmCommands as w}from"./iwtm.js";import{KpiCommands as f}from"./kpi.js";import{LayerComparisonCommands as j}from"./layer-comparison.js";import{LayerPresetsCommands as _}from"./layer-presets.js";import{LayersCommands as l}from"./layers.js";import{LocationMarkerCommands as c}from"./location-marker.js";import{MapCommands as y}from"./map.js";import{MeasurementCommands as u}from"./measurement.js";import{OfflineCommands as d}from"./offline.js";import{PanelCommands as k}from"./panel.js";import{PhotosCommands as b}from"./photos.js";import{PrintCommands as C}from"./printing.js";import{ProjectCommands as v}from"./project.js";import{RegionCommands as x}from"./region.js";import{ReportsCommands as A}from"./reports.js";import{ResultsCommands as M}from"./results.js";import{SearchCommands as P}from"./search.js";import{SketchingCommands as R}from"./sketching.js";import{StudioAnalyticsCommands as T}from"./studioAnalytics.js";import{SystemCommands as q}from"./system.js";import{UICommands as z}from"./ui.js";import{ViewerCommands as B}from"./viewer.js";import{WorkflowCommands as D}from"./workflow.js";export class Commands extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.auth=new t(this._messages),this.basemap=new i(this._messages),this.charts=new m(this._messages),this.drawing=new r(this._messages),this.edit=new o(this._messages),this.file=new h(this._messages),this.geolocation=new a(this._messages),this.geometry=new p(this._messages),this.geometryToolbar=new n(this._messages),this.highlights=new g(this._messages),this.iwtm=new w(this._messages),this.kpi=new f(this._messages),this.layers=new l(this._messages),this.layerComparison=new j(this._messages),this.layerPresets=new _(this._messages),this.locationMarker=new c(this._messages),this.map=new y(this._messages),this.measurement=new u(this._messages),this.offline=new d(this._messages),this.panel=new k(this._messages),this.project=new v(this._messages),this.photos=new b(this._messages),this.printing=new C(this._messages),this.region=new x(this._messages),this.reports=new A(this._messages),this.results=new M(this._messages),this.search=new P(this._messages),this.sketching=new R(this._messages),this.studioAnalytics=new T(this._messages),this.system=new q(this._messages),this.ui=new z(this._messages),this.viewer=new B(this._messages),this.workflow=new D(this._messages)}}

package/messaging/registry/Events.d.ts

@@ -17,6 +17,7 @@ import { PanelEvents } from "./panel.js";
 import { PhotosEvents } from "./photos.js";
 import { PortalEvents } from "./portal.js";
 import { PrintEvents } from "./printing.js";
+import { ProjectEvents } from "./project.js";
 import { RegionEvents } from "./region.js";
 import { ReportEvents } from "./reports.js";
 import { ResultsEvents } from "./results.js";
@@ -43,6 +44,7 @@ export declare class Events extends EventRegistry {
     readonly map: MapEvents;
     readonly offline: OfflineEvents;
     readonly panel: PanelEvents;
+    readonly project: ProjectEvents;
     readonly photos: PhotosEvents;
     readonly portal: PortalEvents;
     readonly printing: PrintEvents;

package/messaging/registry/Events.js

@@ -1 +1 @@
-import{EventRegistry as s}from"../EventRegistry.js";import{AppConfigEvents as t}from"./app-config.js";import{AppEvents as e}from"./app.js";import{AuthEvents as i}from"./auth.js";import{BookmarkEvents as o}from"./bookmark.js";import{DeviceEvents as m}from"./device.js";import{DisplayEvents as r}from"./display.js";import{EditEvents as h}from"./edit.js";import{GeolocationEvents as a}from"./geolocation.js";import{InputEvents as p}from"./input.js";import{LayersEvents as n}from"./layers.js";import{LayoutEvents as g}from"./layout.js";import{LocationMarkerEvents as f}from"./location-marker.js";import{MapEvents as w}from"./map.js";import{OfflineEvents as j}from"./offline.js";import{PanelEvents as _}from"./panel.js";import{PhotosEvents as l}from"./photos.js";import{PortalEvents as c}from"./portal.js";import{PrintEvents as u}from"./printing.js";import{RegionEvents as k}from"./region.js";import{ReportEvents as d}from"./reports.js";import{ResultsEvents as y}from"./results.js";import{SearchEvents as v}from"./search.js";import{SettingsEvents as b}from"./settings.js";import{ShortcutEvents as x}from"./shortcut.js";import{TasksEvents as E}from"./tasks.js";import{UIEvents as C}from"./ui.js";import{ViewerEvents as M}from"./viewer.js";import{WorkflowEvents as R}from"./workflow.js";export class Events extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.appConfig=new t(this._messages),this.auth=new i(this._messages),this.bookmark=new o(this._messages),this.device=new m(this._messages),this.display=new r(this._messages),this.edit=new h(this._messages),this.geolocation=new a(this._messages),this.input=new p(this._messages),this.layers=new n(this._messages),this.layout=new g(this._messages),this.locationMarker=new f(this._messages),this.map=new w(this._messages),this.offline=new j(this._messages),this.panel=new _(this._messages),this.photos=new l(this._messages),this.portal=new c(this._messages),this.printing=new u(this._messages),this.region=new k(this._messages),this.reports=new d(this._messages),this.results=new y(this._messages),this.search=new v(this._messages),this.settings=new b(this._messages),this.shortcuts=new x(this._messages),this.tasks=new E(this._messages),this.ui=new C(this._messages),this.viewer=new M(this._messages),this.workflow=new R(this._messages)}}
+import{EventRegistry as s}from"../EventRegistry.js";import{AppConfigEvents as t}from"./app-config.js";import{AppEvents as e}from"./app.js";import{AuthEvents as i}from"./auth.js";import{BookmarkEvents as o}from"./bookmark.js";import{DeviceEvents as r}from"./device.js";import{DisplayEvents as m}from"./display.js";import{EditEvents as h}from"./edit.js";import{GeolocationEvents as a}from"./geolocation.js";import{InputEvents as p}from"./input.js";import{LayersEvents as n}from"./layers.js";import{LayoutEvents as g}from"./layout.js";import{LocationMarkerEvents as f}from"./location-marker.js";import{MapEvents as w}from"./map.js";import{OfflineEvents as j}from"./offline.js";import{PanelEvents as _}from"./panel.js";import{PhotosEvents as l}from"./photos.js";import{PortalEvents as c}from"./portal.js";import{PrintEvents as u}from"./printing.js";import{ProjectEvents as k}from"./project.js";import{RegionEvents as d}from"./region.js";import{ReportEvents as y}from"./reports.js";import{ResultsEvents as v}from"./results.js";import{SearchEvents as b}from"./search.js";import{SettingsEvents as x}from"./settings.js";import{ShortcutEvents as E}from"./shortcut.js";import{TasksEvents as C}from"./tasks.js";import{UIEvents as M}from"./ui.js";import{ViewerEvents as R}from"./viewer.js";import{WorkflowEvents as q}from"./workflow.js";export class Events extends s{constructor(){super(...arguments),this.app=new e(this._messages),this.appConfig=new t(this._messages),this.auth=new i(this._messages),this.bookmark=new o(this._messages),this.device=new r(this._messages),this.display=new m(this._messages),this.edit=new h(this._messages),this.geolocation=new a(this._messages),this.input=new p(this._messages),this.layers=new n(this._messages),this.layout=new g(this._messages),this.locationMarker=new f(this._messages),this.map=new w(this._messages),this.offline=new j(this._messages),this.panel=new _(this._messages),this.project=new k(this._messages),this.photos=new l(this._messages),this.portal=new c(this._messages),this.printing=new u(this._messages),this.region=new d(this._messages),this.reports=new y(this._messages),this.results=new v(this._messages),this.search=new b(this._messages),this.settings=new x(this._messages),this.shortcuts=new E(this._messages),this.tasks=new C(this._messages),this.ui=new M(this._messages),this.viewer=new R(this._messages),this.workflow=new q(this._messages)}}

package/messaging/registry/Operations.d.ts

@@ -19,6 +19,7 @@ import { MeasurementOperations } from "./measurement.js";
 import { MessagingOperations } from "./messaging.js";
 import { NetworkOperations } from "./network.js";
 import { OfflineOperations } from "./offline.js";
+import { ProjectOperations } from "./project.js";
 import { ResultsOperations } from "./results.js";
 import { SketchingOperations } from "./sketching.js";
 import { SystemOperations } from "./system.js";
@@ -46,6 +47,7 @@ export declare class Operations extends OperationRegistry {
     readonly messaging: MessagingOperations;
     readonly network: NetworkOperations;
     readonly offline: OfflineOperations;
+    readonly project: ProjectOperations;
     readonly sketching: SketchingOperations;
     readonly system: SystemOperations;
     readonly results: ResultsOperations;

package/messaging/registry/Operations.js

@@ -1 +1 @@
-import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as t}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as m}from"./basemap.js";import{ChartOperations as o}from"./charts.js";import{DebugConsoleOperations as r}from"./debugConsole.js";import{DrawingOperations as h}from"./drawing.js";import{EditOperations as a}from"./edit.js";import{FileOperations as g}from"./file.js";import{GeocodeOperations as n}from"./geocode.js";import{GeolocationOperations as p}from"./geolocation.js";import{GeometryOperations as w}from"./geometry.js";import{HighlightsOperations as f}from"./highlights.js";import{KpiOperations as j}from"./kpi.js";import{LogViewerOperations as _}from"./logViewer.js";import{MapOperations as l}from"./map.js";import{MeasurementOperations as c}from"./measurement.js";import{MessagingOperations as u}from"./messaging.js";import{NetworkOperations as d}from"./network.js";import{OfflineOperations as k}from"./offline.js";import{ResultsOperations as y}from"./results.js";import{SketchingOperations as b}from"./sketching.js";import{SystemOperations as v}from"./system.js";import{TasksOperations as x}from"./tasks.js";import{UIOperations as C}from"./ui.js";import{ViewerOperations as O}from"./viewer.js";import{WorkflowOperations as V}from"./workflow.js";export class Operations extends s{constructor(){super(...arguments),this.arcade=new t(this._messages),this.auth=new i(this._messages),this.app=new e(this._messages),this.basemap=new m(this._messages),this.charts=new o(this._messages),this.edit=new a(this._messages),this.drawing=new h(this._messages),this.file=new g(this._messages),this.geocode=new n(this._messages),this.geolocation=new p(this._messages),this.geometry=new w(this._messages),this.highlights=new f(this._messages),this.kpi=new j(this._messages),this.logViewer=new _(this._messages),this.map=new l(this._messages),this.measurement=new c(this._messages),this.messaging=new u(this._messages),this.network=new d(this._messages),this.offline=new k(this._messages),this.sketching=new b(this._messages),this.system=new v(this._messages),this.results=new y(this._messages),this.tasks=new x(this._messages),this.ui=new C(this._messages),this.viewer=new O(this._messages),this.workflow=new V(this._messages),this.debugConsole=new r(this._messages)}}
+import{OperationRegistry as s}from"../OperationRegistry.js";import{AppOperations as e}from"./app.js";import{ArcadeOperations as t}from"./arcade.js";import{AuthOperations as i}from"./auth.js";import{BasemapOperations as m}from"./basemap.js";import{ChartOperations as o}from"./charts.js";import{DebugConsoleOperations as r}from"./debugConsole.js";import{DrawingOperations as h}from"./drawing.js";import{EditOperations as a}from"./edit.js";import{FileOperations as g}from"./file.js";import{GeocodeOperations as n}from"./geocode.js";import{GeolocationOperations as p}from"./geolocation.js";import{GeometryOperations as w}from"./geometry.js";import{HighlightsOperations as f}from"./highlights.js";import{KpiOperations as j}from"./kpi.js";import{LogViewerOperations as _}from"./logViewer.js";import{MapOperations as l}from"./map.js";import{MeasurementOperations as c}from"./measurement.js";import{MessagingOperations as u}from"./messaging.js";import{NetworkOperations as d}from"./network.js";import{OfflineOperations as k}from"./offline.js";import{ProjectOperations as y}from"./project.js";import{ResultsOperations as b}from"./results.js";import{SketchingOperations as v}from"./sketching.js";import{SystemOperations as x}from"./system.js";import{TasksOperations as C}from"./tasks.js";import{UIOperations as O}from"./ui.js";import{ViewerOperations as V}from"./viewer.js";import{WorkflowOperations as R}from"./workflow.js";export class Operations extends s{constructor(){super(...arguments),this.arcade=new t(this._messages),this.auth=new i(this._messages),this.app=new e(this._messages),this.basemap=new m(this._messages),this.charts=new o(this._messages),this.edit=new a(this._messages),this.drawing=new h(this._messages),this.file=new g(this._messages),this.geocode=new n(this._messages),this.geolocation=new p(this._messages),this.geometry=new w(this._messages),this.highlights=new f(this._messages),this.kpi=new j(this._messages),this.logViewer=new _(this._messages),this.map=new l(this._messages),this.measurement=new c(this._messages),this.messaging=new u(this._messages),this.network=new d(this._messages),this.offline=new k(this._messages),this.project=new y(this._messages),this.sketching=new v(this._messages),this.system=new x(this._messages),this.results=new b(this._messages),this.tasks=new C(this._messages),this.ui=new O(this._messages),this.viewer=new V(this._messages),this.workflow=new R(this._messages),this.debugConsole=new r(this._messages)}}

package/messaging/registry/app.d.ts

@@ -95,8 +95,9 @@ export declare class AppCommands extends CommandRegistry {
     /**
      * 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.
+     * loaded. Deprecated; use project.load instead.
      *
+     * @deprecated
      * @webOnly
      */
     get loadProject(): Command<AppConfig | Blob | Blob[]>;
@@ -200,8 +201,9 @@ export declare class AppOperations extends OperationRegistry {
     get getVersion(): Operation<void, string>;
     /**
      * Creates app config for a project, based on the current state of the
-     * application.
+     * application. Deprecated; use project.create instead.
      *
+     * @deprecated
      * @webOnly
      */
     get createProject(): Operation<void, AppConfig>;

package/messaging/registry/project.d.ts

@@ -0,0 +1,141 @@
+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 {
+    /**
+     * 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.
+     *
+     * @webOnly
+     */
+    get load(): Command<AppConfig | HasAppConfig | SharedProject | Blob | Blob[]>;
+    /**
+     * Create or updates a shared project with the specified shared project
+     * details and project config.
+     *
+     * @webOnly
+     */
+    get saveShared(): Command<SaveSharedProjectArgs>;
+    /**
+     * Guard command for enabling the project.save-shared command.
+     *
+     * @webOnly
+     */
+    get ensureCanSaveShared(): Command<SaveSharedProjectArgs>;
+    /**
+     * Shows a shared projects settings. Requires a shared-projects component to
+     * be in the layout.
+     *
+     * @webOnly
+     */
+    get showSettings(): Command<ShowSharedProjectArgs>;
+    /**
+     * Shows a shared projects share link. Requires a shared-projects component
+     * to be in the layout.
+     *
+     * @webOnly
+     */
+    get showShareLink(): Command<SharedProject>;
+    /**
+     * Deletes a shared project and its associated project config.
+     *
+     * @webOnly
+     */
+    get deleteShared(): Command<DeleteSharedProjectArgs>;
+}
+export declare class ProjectOperations extends OperationRegistry {
+    /**
+     * Creates app config for a project, based on the current state of the
+     * application.
+     *
+     * @webOnly
+     */
+    get create(): Operation<unknown, AppConfig | HasAppConfig>;
+    /**
+     * Returns a Shared Project Content.
+     *
+     * @webOnly
+     */
+    get getSharedContent(): Operation<SharedProject, HasAppConfig>;
+    /**
+     * Returns a url share link for the provided Shared Project.
+     *
+     * @webOnly
+     */
+    get getShareLink(): Operation<SharedProject, string>;
+    /**
+     * Returns a list of Shared Projects.
+     *
+     * @webOnly
+     */
+    get getShared(): Operation<void, SharedProject[]>;
+}
+export declare class ProjectEvents extends EventRegistry {
+    /**
+     * Raised when a project is loaded.
+     *
+     * @webOnly
+     */
+    get loaded(): Event<SharedProject>;
+    /**
+     * Raised when a shared project is added.
+     *
+     * @webOnly
+     */
+    get shareAdded(): Event<SharedProject>;
+    /**
+     * Raised when a shared project is removed.
+     *
+     * @webOnly
+     */
+    get shareRemoved(): Event<SharedProject>;
+}

package/messaging/registry/project.js

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

package/messaging/registry/system.d.ts

@@ -13,11 +13,26 @@ export interface DownloadArgs {
     /**
      * The blob to download.
      */
-    result: Blob | Record<string, unknown> | string;
+    result?: Blob | Record<string, unknown> | string;
     /**
      * A filename for the download.
      */
-    name: string;
+    name?: string;
+    /**
+     * Optionally specify the record attribute to be used as the result content.
+     * Defaults to 'result'.
+     */
+    resultAttribute?: string;
+    /**
+     * Optionally specify the record attribute to be used as the file name.
+     * Defaults to 'name'.
+     */
+    fileNameAttribute?: string;
+    /**
+     * Optionally specify the file name extension to be used if the file name
+     * does not end with one. Defaults to '.json'.
+     */
+    fileNameExtension?: string;
 }
 /**
  * Arguments for the system.read-file operation.

package/messaging/registry/ui.d.ts

@@ -1,3 +1,4 @@
+import type { ItemRef } from "app-config/common/ItemRef.js";
 import type { UIDensity } from "../../app-config/common/BrandingModelProperties.js";
 import type { TranslatableText, TranslateOptions } from "../../app-config/common/TranslatableText.js";
 import type { Command } from "../Command.js";
@@ -306,6 +307,26 @@ export declare class UICommands extends CommandRegistry {
      * Hides a notification previously shown to the user.
      */
     get hideNotification(): Command;
+    /**
+     * Marks a component as being available. The interpretation of what effect
+     * this has is up to the component. Currently the only component that will
+     * react to this is the task-bar, which will have the effect of showing the
+     * tab/button for that component. The argument can be an id of the
+     * component, or the model for the component.
+     *
+     * @mobileOnly
+     */
+    get makeAvailable(): Command<ComponentId | Model>;
+    /**
+     * Marks a component as being unavailable. The interpretation of what effect
+     * this has is up to the component. Currently the only component that will
+     * react to this is the task-bar, which will have the effect of hiding the
+     * tab/button for that component, and deactivating the component. The
+     * argument can be an id of the component, or the model for the component.
+     *
+     * @mobileOnly
+     */
+    get makeUnavailable(): Command<ComponentId | Model>;
     /**
      * Forces assistive technology (screen readers) to narrate a translatable
      * message to the end user.
@@ -343,6 +364,14 @@ export declare class UIOperations extends OperationRegistry {
      * Gets user confirmation by way of a popup box.
      */
     get confirm(): Operation<ConfirmOperationArgs, boolean>;
+    /**
+     * Get the IDs of components in the current layout that are backed by the
+     * given model. Most models are used by a single component, but in some
+     * cases multiple components can share a model.
+     *
+     * @webOnly
+     */
+    get getComponentIds(): Operation<ItemRef, string>;
     /**
      * Gets the current locale code for the application. (example: "en", "fr" or
      * "de-AT").

package/messaging/registry/ui.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 var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}
+import{CommandRegistry as e}from"../CommandRegistry.js";import{EventRegistry as t}from"../EventRegistry.js";import{OperationRegistry as s}from"../OperationRegistry.js";export var NotificationCategory;!function(e){e.ERROR="error",e.INFO="info",e.SUCCESS="success",e.WARNING="warning"}(NotificationCategory||(NotificationCategory={}));export var NotificationType;!function(e){e.AUTO="auto",e.APP="app",e.SYSTEM="system"}(NotificationType||(NotificationType={}));export var Position;!function(e){e.BOTTOM="bottom",e.LEFT="left",e.RIGHT="right",e.TOP="top"}(Position||(Position={}));export class UICommands extends e{get activate(){return this._messages.command("ui.activate")}get activeToggle(){return this._messages.command("ui.active-toggle")}get alert(){return this._messages.command("ui.alert")}get await(){return this._messages.command("ui.await")}get deactivate(){return this._messages.command("ui.deactivate")}get displayBusyState(){return this._messages.command("ui.display-busy-state")}get displayNotification(){return this._messages.command("ui.display-notification")}get pauseNotifications(){return this._messages.command("ui.pause-notifications")}get resumeNotifications(){return this._messages.command("ui.resume-notifications")}get focus(){return this._messages.command("ui.focus")}get hideBusyState(){return this._messages.command("ui.hide-busy-state")}get hideNotification(){return this._messages.command("ui.hide-notification")}get makeAvailable(){return this._messages.command("ui.make-available")}get makeUnavailable(){return this._messages.command("ui.make-unavailable")}get narrate(){return this._messages.command("ui.narrate")}get setDensity(){return this._messages.command("ui.set-density")}get setLocale(){return this._messages.command("ui.set-locale")}get setTheme(){return this._messages.command("ui.set-theme")}get setVisualState(){return this._messages.command("ui.set-visual-state")}}export class UIOperations extends s{get confirm(){return this._messages.operation("ui.confirm")}get getComponentIds(){return this._messages.operation("ui.get-component-ids")}get getLocale(){return this._messages.operation("ui.get-locale")}get getTheme(){return this._messages.operation("ui.get-theme")}get getThemes(){return this._messages.operation("ui.get-themes")}get getVisualState(){return this._messages.operation("ui.get-visual-state")}get prompt(){return this._messages.operation("ui.prompt")}}export class UIEvents extends t{get activated(){return this._messages.event("ui.activated")}get added(){return this._messages.event("ui.added")}get ancestorActivated(){return this._messages.event("ui.ancestor-activated")}get ancestorDeactivated(){return this._messages.event("ui.ancestor-deactivated")}get deactivated(){return this._messages.event("ui.deactivated")}get densityChanged(){return this._messages.event("ui.density-changed")}get localeChanged(){return this._messages.event("ui.locale-changed")}get initializing(){return this._messages.event("ui.initializing")}get initialized(){return this._messages.event("ui.initialized")}get removed(){return this._messages.event("ui.removed")}get reordered(){return this._messages.event("ui.reordered")}get themeChanged(){return this._messages.event("ui.theme-changed")}get visualStateChanged(){return this._messages.event("ui.visual-state-changed")}}