@vertigis/viewer-spec 42.10.0

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

@@ -0,0 +1,42 @@
+import type { ItemRef } from "../common/ItemRef.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { ReportModelProperties } from "./ReportModelProperties.js";
+/**
+ * Properties that can be passed into the constructor for {@link PrintTemplate}.
+ */
+export interface PrintTemplateModelProperties extends ReportModelProperties {
+}
+/**
+ * A spatial reference grid to use for printing.
+ */
+export interface SpatialReferenceGrid {
+    /**
+     * The name of the spatial reference.
+     */
+    displayName: string;
+    /**
+     * The well-known ID if there is one.
+     */
+    wkid?: number;
+    /**
+     * The well-known text if no well-known ID is provided.
+     */
+    wkt?: string;
+}
+/**
+ * Configuration for a print form component.
+ */
+export interface PrintFormModelProperties extends ComponentModelProperties {
+    /**
+     * The templates to choose from.
+     */
+    templates?: (ItemRef | PrintTemplateModelProperties)[];
+    /**
+     * The spatial reference grids to choose from.
+     */
+    grids?: SpatialReferenceGrid[];
+    /**
+     * The supported print resolutions to choose from.
+     */
+    resolutions?: number[];
+}

package/app-config/web/PrintFormModelProperties.js

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

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

@@ -0,0 +1,15 @@
+import type { PortalItemLike } from "@vertigis/arcgis-extensions/utilities/portal";
+import type { ModelProperties } from "./ModelProperties.js";
+/**
+ * Properties that can be passed into the constructor for {@link ReportBase}.
+ */
+export interface ReportModelProperties extends ModelProperties {
+    /**
+     * See {@link ReportBase.title}.
+     */
+    title?: string;
+    /**
+     * See {@link ReportBase.portalItem}.
+     */
+    portalItem?: PortalItemLike;
+}

package/app-config/web/ReportModelProperties.js

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

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

@@ -0,0 +1,93 @@
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ResultsModelProperties as CommonResultsModelProperties } from "../common/ResultsModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+import type { FeatureListProperties } from "./FeatureListProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface ResultsModelProperties extends CommonResultsModelProperties, ComponentModelProperties {
+    /**
+     * A command or set of commands to execute when all features have been
+     * removed. This action is only supported in Geocortex Mobile Viewer.
+     */
+    onAllFeaturesRemoved?: Action;
+    /**
+     * A command or set of commands to execute when a feature or group of
+     * features is deselected. Web only.
+     */
+    onDeselect?: Action;
+    /**
+     * A command or set of commands to execute when a feature gets added.
+     */
+    onFeatureAdd?: Action;
+    /**
+     * A command or set of commands to execute when a single feature is clicked.
+     */
+    onFeatureClick?: Action;
+    /**
+     * A command or set of commands to execute when a feature becomes invisible.
+     */
+    onFeatureHide?: Action;
+    /**
+     * A command or set of commands to execute when a feature gets removed.
+     */
+    onFeatureRemove?: Action;
+    /**
+     * A command or set of commands to execute when a feature becomes visible.
+     */
+    onFeatureShow?: Action;
+    /**
+     * A command or set of commands to execute when a feature or group is
+     * moused-over. Web only.
+     */
+    onHover?: Action;
+    /**
+     * A command or set of commands to execute when a feature or group is
+     * has finished the moused-over event. Web only.
+     */
+    onHoverEnd?: Action;
+    /**
+     * A command or set of commands to execute when a feature or group of
+     * features is selected. Web only.
+     */
+    onSelect?: Action;
+    /**
+     * The admin preference for the view mode used to display the results. The
+     * default is "ungrouped". Web only.
+     */
+    viewMode?: ViewMode;
+    /**
+     * The admin preference for the card size used to display the results. The
+     * default is "standard". Web only.
+     */
+    cardSize?: CardSize;
+    /**
+     * Whether or not to allow the user to change feature grouping. Web only.
+     */
+    showViewModeToggle?: boolean;
+    /**
+     * Whether or not to allow results to be filtered by source. Web only.
+     */
+    showFilter?: boolean;
+    /**
+     * Whether or not to allow the user to change the card size. Web only.
+     */
+    showSizeToggle?: boolean;
+    /**
+     * The list of features contained by the results model. This property is
+     * only serialized into saved projects. Web only.
+     */
+    results?: FeatureListProperties;
+}
+/**
+ * Specifies whether a results list component should display results grouped by source.
+ *
+ * @webOnly
+ */
+export declare type ViewMode = "ungrouped" | "grouped";
+/**
+ * Specifies what card size a results list component should use to display result items.
+ *
+ * @webOnly
+ */
+export declare type CardSize = "standard" | "compact";

package/app-config/web/ResultsModelProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a scale input component.
+ */
+export interface ScaleInputModelProperties extends ComponentModelProperties {
+}

package/app-config/web/ScaleInputModelProperties.js

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

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

@@ -0,0 +1,22 @@
+import type { ScalebarModelProperties as CommonScalebarModelProperties } from "../common/ScalebarModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * The visual style to set for the scalebar.
+ */
+export declare enum ScalebarStyle {
+    RULER = "ruler",
+    LINE = "line"
+}
+/**
+ * @inheritdoc
+ */
+export interface ScalebarModelProperties extends CommonScalebarModelProperties, ComponentModelProperties {
+    /**
+     * The visual style for the scalebar.
+     */
+    style?: ScalebarStyle;
+    /**
+     * Whether or not to show both metric and US customary units at once.
+     */
+    showDualUnits?: boolean;
+}

package/app-config/web/ScalebarModelProperties.js

@@ -0,0 +1 @@
+export var ScalebarStyle;!function(e){e.RULER="ruler",e.LINE="line"}(ScalebarStyle||(ScalebarStyle={}));

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

@@ -0,0 +1,22 @@
+import type { SearchModelProperties as CommonSearchModelProperties } from "../common/SearchModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface SearchModelProperties extends CommonSearchModelProperties, ComponentModelProperties {
+    /**
+     * By default the search area will be expanded to try and return the
+     * specified maxResults. Set to true to disable this behavior.
+     */
+    disableSearchAreaExpansion?: boolean;
+    /**
+     * This setting is used to indicate if the geocoder should be used by the
+     * search.
+     */
+    geocoderEnabled?: boolean;
+    /**
+     * The maximum number of suggestions to show based on the user's input.
+     * Setting this to 0 will disable suggestions.
+     */
+    maxSuggestions?: number;
+}

package/app-config/web/SearchModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { SplitModelProperties as CommonSplitModelProperties } from "../common/SplitModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface SplitModelProperties extends CommonSplitModelProperties, ComponentModelProperties {
+}

package/app-config/web/SplitModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { StackModelProperties as CommonStackModelProperties } from "../common/StackModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface StackModelProperties extends CommonStackModelProperties, ComponentModelProperties {
+}

package/app-config/web/StackModelProperties.js

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

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

@@ -0,0 +1,6 @@
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * Configuration for a tabs component.
+ */
+export interface TabsModelProperties extends ComponentModelProperties {
+}

package/app-config/web/TabsModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { TextModelProperties as CommonTextModelProperties } from "../common/TextModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface TextModelProperties extends CommonTextModelProperties, ComponentModelProperties {
+}

package/app-config/web/TextModelProperties.js

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

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

@@ -0,0 +1,12 @@
+import type { ItemRef } from "../common/ItemRef.js";
+import type { UserModelProperties as CommonUserModelProperties } from "../common/UserModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface UserModelProperties extends CommonUserModelProperties, ComponentModelProperties {
+    /**
+     * A menu to display in the user component's fly-out panel.
+     */
+    menu?: ItemRef;
+}

package/app-config/web/UserModelProperties.js

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

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

@@ -0,0 +1,10 @@
+import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
+/**
+ * Configuration for a user preferences component.
+ */
+export interface UserPreferencesModelProperties extends ServiceModelProperties {
+    /**
+     * The amount of time we debounce the save operation for.
+     */
+    saveDelay?: number;
+}

package/app-config/web/UserPreferencesModelProperties.js

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

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

@@ -0,0 +1,84 @@
+import type { EntityProperties } from "@vertigis/arcgis-extensions/Entity";
+import type { Action } from "@vertigis/arcgis-extensions/support/Action";
+import type { ItemRef } from "../common/ItemRef.js";
+import type { ServiceModelProperties } from "../common/ServiceModelProperties.js";
+/**
+ * The privacy policy link location options.
+ */
+export declare type PrivacyPolicyLocation = "app-top-beginning" | "app-top-end" | "app-bottom-beginning" | "app-bottom-end" | "map-top-beginning" | "map-top-end" | "map-bottom-beginning" | "map-bottom-end" | "user-component" | "app-footer";
+/**
+ * Information on how and where to display the privacy policy link.
+ */
+export interface PrivacyPolicyInfo extends EntityProperties {
+    /**
+     * The location in which the privacy policy information should be shown.
+     * Defaults to user-component and falls back to the app-footer
+     * if the specified location is not available.
+     */
+    location?: PrivacyPolicyLocation;
+    /**
+     * Optional markdown that contains additional information. This information
+     * is shown in a secondary dialog when the location is not the user
+     * component, or directly in the user component when it is the location.
+     */
+    markdown?: string;
+}
+/**
+ * Global configuration for a VertiGIS Web application.
+ */
+export interface VertigisWebModelProperties extends ServiceModelProperties {
+    /**
+     * Action to be triggered when viewer initialization is complete.
+     */
+    onInitialized?: Action;
+    /**
+     * Action to be triggered on viewer initialization before layout selection.
+     */
+    onInitializing?: Action;
+    /**
+     * Allowed origin for sending and receiving PostMessages.
+     */
+    postMessageAllowedOrigin?: string;
+    /**
+     * The privacy policy information.
+     */
+    privacyPolicyInfo?: PrivacyPolicyInfo;
+    /**
+     * The collection of rules specifying the proxy URL to use for a given URL
+     * prefix.
+     */
+    proxyRules?: ProxyRule[];
+    /**
+     * The proxy URL for the application.
+     */
+    proxyUrl?: string;
+    /**
+     * Indicates whether cross origin requests made to the associated server
+     * should include credentials such as cookies and authorization headers.
+     */
+    trustedServers?: string[];
+    /**
+     * The version of the Geocortex Web Viewer that was used to create this app
+     * configuration.
+     */
+    version?: string;
+    /**
+     * The active layout of the Geocortex Web Viewer. This property is only
+     * serialized to saved projects.
+     */
+    layout?: ItemRef;
+}
+/**
+ * An object specifying a URL that should use a specific proxy.
+ */
+export interface ProxyRule {
+    /**
+     * The URL of the proxy.
+     */
+    proxyUrl: string;
+    /**
+     * The URL prefix of the resources that should be accessed through the given
+     * proxy.
+     */
+    urlPrefix: string;
+}

package/app-config/web/VertigisWebModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { WorkflowModelProperties as CommonWorkflowModelProperties } from "../common/WorkflowModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface WorkflowModelProperties extends CommonWorkflowModelProperties, ComponentModelProperties {
+}

package/app-config/web/WorkflowModelProperties.js

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

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

@@ -0,0 +1,7 @@
+import type { ZoomModelProperties as CommonZoomModelProperties } from "../common/ZoomModelProperties.js";
+import type { ComponentModelProperties } from "./ComponentModelProperties.js";
+/**
+ * @inheritdoc
+ */
+export interface ZoomModelProperties extends CommonZoomModelProperties, ComponentModelProperties {
+}

package/app-config/web/ZoomModelProperties.js

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

package/docs/Geocortex Apps.md

@@ -0,0 +1,311 @@
+# Geocortex Apps
+
+## Introduction
+
+A Geocortex App is a JSON document containing configuration for an application
+that is built on top of the Geocortex API. Building on the Esri Web Map
+Specification, Geocortex Apps enable a declarative approach to working with the
+Geocortex and Esri APIs. Rather than initializing the properties of API objects
+programmatically in code, you can define all of their settings externally in an
+App JSON document. Then, you can access the configured objects via the
+`AppContainer` class. Here is an example Geocortex App containing a map
+extension and a menu:
+
+```
+{
+    "schemaVersion": "1.0",
+    "items": [
+        {
+            "$type": "map-extension",
+            "id": "default",
+            "title": "LA County",
+            "webMap": "b6c7a4a9eb5a4954a0d284c6c53537d2"
+        },
+        {
+            "$type": "menu",
+            "id": "i-want-to",
+            "items": [
+                {
+                    "id": "zoom-in",
+                    "title": "Zoom In"
+                },
+                {
+                    "id": "zoom-out",
+                    "title": "Zoom Out"
+                }
+            ]
+        }
+    ]
+}
+```
+
+In code, you would then access the items defined in this App like so:
+
+```
+const appJson = ... // Load the JSON from somewhere.
+const container = new AppContainer(appJson);
+const mapX = await container.get("map-extension", "default");
+const iwtm = await container.get("menu", "i-want-to");
+```
+
+With the exception of a few special App properties like `$type`, the JSON for
+each item uses the same schema that is supported by the constructor for the
+corresponding API object. For example, this produces the same end result as the
+above code:
+
+```
+const mapX = new MapExtension({
+    "id": "default",
+    "title": "LA County",
+    "webMap": "b6c7a4a9eb5a4954a0d284c6c53537d2"
+});
+const iwtm = new Menu({
+    "id": "i-want-to",
+    "items": [
+        {
+            "id": "zoom-in",
+            "title": "Zoom In"
+        },
+        {
+            "id": "zoom-out",
+            "title": "Zoom Out"
+        }
+    ]
+});
+```
+
+## App Items
+
+The `items` property of an App contains the set of configured items for an
+application (order is irrelevant). At minimum, each item must have `id` and
+`$type` properties (see [ItemType](apidoc://ItemType/ItemType) for a list of
+default supported types). The combination of type and ID must be unique within
+an App. This means that you are permitted to have two items with an ID of
+`"default"`, but only if they are of different types. IDs must consist of only
+[unreserved URI characters](https://tools.ietf.org/html/rfc3986).
+
+Any remaining properties on an item that do not start with "\$" are its
+configured settings, and vary based on the type of item. For example, the map
+extension's `"title"` property in the previous example. These properties will
+get passed in to the appropriate [item factory](#Custom-Item-Types) for that
+item type.
+
+### Item URIs
+
+Items in an App can be uniquely identified via URIs that use a special `item://`
+scheme, like so:
+
+```
+item://<type>/<id>
+```
+
+The AppContainer class allows retrieving an item via its `item://` URI:
+
+```
+const mapX = await container.get("item://map-extension/default");
+```
+
+### Item References
+
+The property values for an item can reference other items, using `item://` URIs.
+For example:
+
+```
+items: [
+    {
+        "$type": "layer-extension",
+        "id": "incidents",
+        "layer": {
+            "layerType": "ArcGISFeatureLayer",
+            "url": "http://sampleserver6.arcgisonline.com/arcgis/rest/services/SF311/FeatureServer/0"
+        }
+    },
+    {
+        $type: "map-extension",
+        id: "default",
+        layerExtensions: [
+            "item://layer-extension/incidents"
+        ]
+    }
+]
+```
+
+When the `item://map-extension/default` item is requested from the AppContainer,
+it will first create the `item://layer-extension/incidents` object that it
+references, and then substitute it in place of the reference prior to creating
+the map extension.
+
+**NOTE**: Regardless of how many times an item is requested or referenced by
+other items, only a single object instance is ever created per unique item.
+
+### Custom Item Types
+
+By default, AppContainer is pre-configured to understand the various items types
+that are built in the Geocortex API, e.g. MapExtension and Menu. However, you
+can work with custom item types in an App by registering custom item factories
+with AppContainer. An item factory is just a method that takes item
+configuration and produces an actual object. For more information, see
+[AppContainer.registerType()](apidoc://AppContainer.registerType).
+
+You can also override the built-in factories for Geocortex API items with your
+own factories to customize how these items are created.
+
+## Settings
+
+An App may contain a `settings` block at the top level, which is a place to
+define custom, application-wide settings as a set of key/value pairs. The key is
+a unique name for the setting, and the value is a simple scalar value (string,
+boolean, or number).
+
+```
+{
+    "schemaVersion": "1.0",
+    "settings": {
+        "baseServiceUrl": "http://sampleserver6.arcgisonline.com/arcgis/rest/",
+        "defaultMaxResults": 300
+    }
+}
+```
+
+Settings can be accessed programmatically via the
+[AppContainer.settings](apidoc://AppContainer.settings) property. Setting values
+can also be referenced within an App by using a special URI syntax:
+
+```
+setting://<setting-name>.
+```
+
+Whenever an item’s property has a value like this, the configuration loader will
+substitute it for the actual setting value. This is useful when a setting is
+used by more than one item in an App, as it gives you a single place to change
+it. You can also insert a setting’s value into a string property or other
+settings, by surrounding the `setting://` URI with `{}` characters within a
+string. For example:
+
+```
+{
+    "schemaVersion": "1.0",
+    "settings": {
+        "baseServiceUrl": "http://sampleserver6.arcgisonline.com/arcgis/rest"
+    },
+    items: [
+        {
+            "$type": "layer-extension",
+            "id": "hurricanes",
+            "layer": {
+                "layerType": "ArcGISMapServiceLayer",
+                "url": "{setting://baseServiceUrl}/services/Hurricanes/MapServer"
+            }
+        }
+    ]
+}
+```
+
+## Failure Modes
+
+By default, when one item references another and the referenced item cannot be
+created, then the original item cannot be created either. In this case an error
+will occur when you attempt to get the original item from the App container. You
+can adjust this behavior by defining a custom failure mode for an item in the
+top-level `failureModes` property. This property maps an `item://` URI to the
+failure mode value for that item. Possible values are `"error"`, `"warn"`, and
+`"ignore"`, with `"error"` being the default. For example:
+
+```
+{
+    "schemaVersion": "1.0",
+    items: [
+        {
+            "$type": "layer-extension",
+            "id": "broken",
+            "layer": {
+                "url": "invalid URL"
+            }
+        },
+        {
+            $type: "map-extension",
+            id: "default",
+            layerExtensions: [
+                "item://layer-extension/broken"
+            ]
+        }
+    ],
+    "failureModes": [
+        "item://layer-extension/broken": "warn"
+    ]
+}
+```
+
+In this example, the item `item://layer-extension/broken` contains an invalid
+URL, and so it cannot be created. Normally this would mean that
+`item://map-extension/default` couldn't be created either, but because of the
+configured failure mode of `"warn"` for the layer extension, the map extension
+can still be created. The AppContainer will remove the invalid URI prior to
+creating the map extension, and will raise a special `configWarning` event
+containing details about the item that could not be created. In this case, the
+host application should handle this event by warning the end user about the
+missing layer.
+
+Failure modes are also passed on to the item factories. This means that objects
+that are created by the AppContainer can also respond to failure modes. For
+example, MapExtension will honor a layer extension's failure mode if the layer
+fails to load successfully (e.g. the map service is currently unavailable). The
+exact behavior depends on the type of object.
+
+## App Imports
+
+An App can import one or more other Apps via the top-level `import` block. This
+is a list of one or more URLs pointing to other Apps to import, like so:
+
+```
+{
+    "schemaVersion": "1.0",
+    "import": [
+        "http://some.company.com/apps/default-basemaps.app.json",
+        "default-layers.app.json"
+    ]
+}
+```
+
+When an App imports another one, the items, settings, failure modes, etc.
+defined in the referenced app become part of the current App, as though they had
+been defined inline.
+
+If the current App contains one or more items that also appear in the imported
+App, then the items' properties are merged, with locally defined property values
+overriding imported ones. Similarly, locally defined settings and failure modes
+override ones that are imported. If multiple Apps are imported, then content
+from Apps that appear later in the list of imports will override the content of
+earlier ones.
+
+An imported App can itself contain App imports. In that case, those inner imports
+are resolved first, and the resulting App is then imported into the outer one.
+
+## Importing Apps from Portal
+
+It is possible to import Apps from a portal instance by using one of the
+following URI patterns:
+
+-   portal://<portal-id>/<item-id>
+-   portal://<item-id>
+
+The first version (with _portal-id_) can be used when you want to specify the
+portal instance where the item is located. In order for this portal:// URI to
+successfully be resolved, you must associate _portal-id_ with an instance of
+@arcgis/core/portal/Portal. This can be done using the _portals_ map in
+@vertigis/arcgis-extensions/config.
+
+You can import App configuration from a portal instance like this:
+
+```
+{
+    "schemaVersion": "1.0",
+    "import": [
+        "portal://test-portal/abcdef0123456789abcdef0123456789,
+    ]
+}
+```
+
+If the imported configuration has any further imports in form
+portal://<item-id>, these will be changed to use the _portal-id_ of the parent
+App.