@vcmap/ui 6.0.0-rc.8 → 6.0.0-rc.9

package/src/manager/window/windowManager.js

@@ -107,7 +107,7 @@ export function isSlotPosition(windowPosition) {
  *   parentId?: string,
  *   component: import("vue").Component<T>,
  *   headerComponent?: import("vue").Component<T>,
- *   state? : Partial<WindowState>,
+ *   state? : WindowStateOptions,
  *   position? : Partial<WindowPositionOptions>,
  *   slot?: WindowSlot,
  *   props?: T,
@@ -118,17 +118,37 @@ export function isSlotPosition(windowPosition) {
  * @property {string} [parentId] An optional ID of a parent window for 'dynamicChild' slot. Parent windows with slot dynamicRight are not supported.
  * @property {import("vue").Component<T, unknown, unknown>} component Main Component which is shown below the header.
  * @property {import("vue").Component<T, unknown, unknown>} [headerComponent] Replaces the Header Component.
- * @property {Partial<WindowState>} [state]
+ * @property {WindowStateOptions} [state]
  * @property {Partial<WindowPositionOptions>} [position] Will be merged with default position for slot
  * @property {WindowSlot} [slot]
  * @property {T} [props]
  * @property {Object} [provides]
  */
 
+/**
+ * @typedef {T|import('vue').Ref<T>|import('vue').ComputedRef<T>} OptionsOrRef
+ * @template T
+ */
+
+/**
+ * @typedef {Object} WindowStateOptions
+ * @property {OptionsOrRef<boolean>} [hideHeader] be used to not show the header.
+ * @property {OptionsOrRef<boolean>} [hidePin] be used to not show the pin button.
+ * @property {OptionsOrRef<string|string[]>} [headerTitle] An optional translatable header. If an array is provided all elements are translated and joined afterward.
+ * @property {OptionsOrRef<string>} [headerIcon]
+ * @property {OptionsOrRef<Array<import("../../actions/actionHelper.js").VcsAction>>} [headerActions]
+ * @property {OptionsOrRef<number>} [headerActionsOverflow]
+ * @property {OptionsOrRef<string>} [infoUrl] An optional url referencing help or further information on the window's content.
+ * @property {OptionsOrRef<function():string>} [infoUrlCallback] An optional function returning an url referencing help or further information. Can be used for urls depending on the app's locale, e.g. app.getHelpUrl()
+ * @property {Record<string, string>} [styles] Can be used to add additional styles to the root WindowComponent. Use Vue Style Bindings Object Syntax https://vuejs.org/v2/guide/class-and-style.html
+ * @property {Array<string>|Record<string,string>} [classes] Can be used to add additional classes to the root WindowComponent. Use Vue Class Bindings Syntax https://vuejs.org/v2/guide/class-and-style.html
+ */
+
 /**
  * @typedef {Object} WindowState
  * @property {string} id
  * @property {string|vcsAppSymbol} owner Owner of the window, set by windowManager on add
+ * @property {string|undefined} parentId - the parent of this window
  * @property {boolean} [hideHeader] be used to not show the header.
  * @property {boolean} [hidePin] be used to not show the pin button.
  * @property {string|string[]} [headerTitle] An optional translatable header. If an array is provided all elements are translated and joined afterward.
@@ -599,6 +619,7 @@ class WindowManager {
       ? [...(windowComponentOptions?.state?.classes ?? [])]
       : { ...windowComponentOptions?.state?.classes };
 
+    /** @type {WindowState} */
     const state = reactive({
       id,
       parentId,

package/src/obliqueFallbackWarnings.d.ts

@@ -0,0 +1,5 @@
+/**
+ * @param {import("./vcsUiApp.js").default} app
+ * @returns {() => void}
+ */
+export default function createObliqueFallbackWarnings(app: import("./vcsUiApp.js").default): () => void;

package/src/obliqueFallbackWarnings.js

@@ -0,0 +1,54 @@
+import { ObliqueMap } from '@vcmap/core';
+import { NotificationType } from './notifier/notifier.js';
+
+function createNotification(app) {
+  app.notifier.add({
+    title: 'navigation.obliqueFallback.title',
+    type: NotificationType.WARNING,
+    message: 'navigation.obliqueFallback.message',
+  });
+}
+
+/**
+ * @param {import("./vcsUiApp.js").default} app
+ * @returns {() => void}
+ */
+export default function createObliqueFallbackWarnings(app) {
+  const fallbackMapEventListener =
+    app.maps.fallbackMapActivated.addEventListener(() => {
+      createNotification(app);
+    });
+
+  const mapListeners = new Map();
+  const setMapListener = (map) => {
+    mapListeners.set(
+      map,
+      map.failedToSetCollection.addEventListener(() => {
+        createNotification(app);
+      }),
+    );
+  };
+
+  app.maps.getByType(ObliqueMap.className).forEach(setMapListener);
+
+  const mapAddedListener = app.maps.added.addEventListener((map) => {
+    if (map instanceof ObliqueMap) {
+      setMapListener(map);
+    }
+  });
+
+  const mapRemovedListener = app.maps.removed.addEventListener((map) => {
+    mapListeners.get(map)?.();
+    mapListeners.delete(map);
+  });
+
+  return () => {
+    fallbackMapEventListener();
+    mapAddedListener();
+    mapRemovedListener();
+    [...mapListeners.values()].forEach((cb) => {
+      cb();
+    });
+    mapListeners.clear();
+  };
+}

package/src/uiConfig.d.ts

@@ -456,6 +456,7 @@ declare class UiConfig extends Collection<UiConfigurationItem<unknown>> {
                 readonly fogScreenSpaceErrorFactor?: number | undefined;
                 readonly resolutionScale?: number | undefined;
                 readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
             } | undefined;
             readonly medium?: {
                 readonly sse?: number | undefined;
@@ -465,6 +466,7 @@ declare class UiConfig extends Collection<UiConfigurationItem<unknown>> {
                 readonly fogScreenSpaceErrorFactor?: number | undefined;
                 readonly resolutionScale?: number | undefined;
                 readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
             } | undefined;
             readonly high?: {
                 readonly sse?: number | undefined;
@@ -474,6 +476,7 @@ declare class UiConfig extends Collection<UiConfigurationItem<unknown>> {
                 readonly fogScreenSpaceErrorFactor?: number | undefined;
                 readonly resolutionScale?: number | undefined;
                 readonly layerSSEFactor?: number | undefined;
+                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
             } | undefined;
         } | undefined;
         /**

package/src/vcsUiApp.d.ts

@@ -195,6 +195,7 @@ declare class VcsUiApp extends VcsApp {
      */
     mounted: import("@vcmap/core").VcsEvent<string>;
     _destroySiteConfig: () => void;
+    _destroyObliqueFallback: () => void;
     /**
      * @type {import("@vcmap/core").OverrideCollection<VcsPlugin<Object, Object>, Collection<VcsPlugin<Object, Object>>, Object>}
      */
@@ -251,10 +252,7 @@ declare class VcsUiApp extends VcsApp {
      * @returns {ReturnType<typeof import("vuetify").createVuetify>}
      */
     get vuetify(): {
-        install: (app: import("vue").App<any>) => void; /**
-         * @type {WindowManager}
-         * @private
-         */
+        install: (app: import("vue").App<any>) => void;
         defaults: import("vue").Ref<import("vuetify").DefaultsInstance>;
         display: import("vuetify").DisplayInstance;
         theme: import("vuetify").ThemeInstance & {
@@ -284,7 +282,33 @@ declare class VcsUiApp extends VcsApp {
                     formats?: any;
                 }) => import("vuetify").DateInstance) | import("vuetify").DateInstance;
                 formats?: Record<string, any> | undefined;
-                locale: Record<string, any>;
+                locale: Record<string, any>; /**
+                 * Interface for VcsPlugins.
+                 * The function implementing the interface should not throw!
+                 * @typedef {{
+                 *   name: string,
+                 *   version: string,
+                 *   mapVersion: string,
+                 *   i18n?: Object<string, unknown>,
+                 *   initialize?: function(import("@src/vcsUiApp.js").default, S=):void|Promise<void>,
+                 *   onVcsAppMounted?: function(import("@src/vcsUiApp.js").default):void,
+                 *   toJSON?: function(): C,
+                 *   getDefaultOptions?: function(): C,
+                 *   getState?: function(boolean=):S|Promise<S>,
+                 *   getConfigEditors?: function():Array<PluginConfigEditor<object>>,
+                 *   destroy?: function(): void
+                 * }} VcsPlugin
+                 * @template {Object} C - plugin config
+                 * @template {Object} S - plugin state
+                 * @property {Object<string, *>} [i18n] - the i18n messages of this plugin
+                 * @property {function(import("@src/vcsUiApp.js").default, S=)} initialize - called on plugin added. Is passed the VcsUiApp and optionally, the state for the plugin
+                 * @property {function(import("@src/vcsUiApp.js").default)} onVcsAppMounted - called on mounted of VcsApp.vue
+                 * @property {function():C} [toJSON] - should return the plugin's serialization excluding all default values
+                 * @property {function():C} [getDefaultOptions] - should return the plugin's default options
+                 * @property {function(boolean=):S|Promise<S>} [getState] - should return the plugin's state or a promise for said state. is passed a "for url" flag. If true, only the state relevant for sharing a URL should be passed and short keys shall be used
+                 * @property {Array<PluginConfigEditor>} [getConfigEditors] - should return components for configuring the plugin or custom items defined by the plugin
+                 * @api
+                 */
             };
             instance: {
                 locale?: any;
@@ -293,15 +317,16 @@ declare class VcsUiApp extends VcsApp {
                 toJsDate: (value: unknown) => Date;
                 parseISO: (date: string) => unknown;
                 toISO: (date: unknown) => string;
-                startOfDay: (date: unknown) => unknown; /**
-                 * @type {OverviewMap}
-                 * @private
-                 */
+                startOfDay: (date: unknown) => unknown;
                 endOfDay: (date: unknown) => unknown;
                 startOfWeek: (date: unknown, firstDayOfWeek?: string | number | undefined) => unknown;
                 endOfWeek: (date: unknown) => unknown;
                 startOfMonth: (date: unknown) => unknown;
                 endOfMonth: (date: unknown) => unknown;
+                /**
+                 * @type {ContextMenuManager}
+                 * @private
+                 */
                 startOfYear: (date: unknown) => unknown;
                 endOfYear: (date: unknown) => unknown;
                 isAfter: (date: unknown, comparing: unknown) => boolean;
@@ -323,7 +348,9 @@ declare class VcsUiApp extends VcsApp {
                 getDiff: (date: unknown, comparing: unknown, unit?: string | undefined) => number;
                 getWeekArray: (date: unknown, firstDayOfWeek?: string | number | undefined) => unknown[][];
                 getWeekdays: (firstDayOfWeek?: string | number | undefined) => string[];
-                getMonth: (date: unknown) => number;
+                getMonth: (date: unknown) => number; /**
+                 * @type {import("@vcmap/core").OverrideClassRegistry<typeof AbstractFeatureInfoView>}
+                 */
                 setMonth: (date: unknown, month: number) => unknown;
                 getDate: (date: unknown) => number;
                 setDate: (date: unknown, day: number) => unknown;

package/src/vcsUiApp.js

@@ -45,6 +45,7 @@ import { createVueI18n, setupI18n } from './vuePlugins/i18n.js';
 import { callbackClassRegistry } from './callback/vcsCallback.js';
 import createSiteConfig from './siteConfig.js';
 import { createVcsVuetify } from './vuePlugins/vuetify.js';
+import createObliqueFallbackWarnings from './obliqueFallbackWarnings.js';
 
 /**
  * @typedef {import("@vcmap/core").VcsModuleConfig & {
@@ -374,6 +375,8 @@ class VcsUiApp extends VcsApp {
     this.mounted = new VcsEvent();
 
     this._destroySiteConfig = createSiteConfig(this._uiConfig);
+
+    this._destroyObliqueFallback = createObliqueFallbackWarnings(this);
   }
 
   /**
@@ -753,6 +756,7 @@ class VcsUiApp extends VcsApp {
     this._featureInfo.destroy();
     this._uiConfig.destroy();
     this._destroySiteConfig();
+    this._destroyObliqueFallback();
     super.destroy();
   }
 }

package/src/vuePlugins/i18n.js

@@ -9,6 +9,7 @@ import { resolveValue } from '@intlify/core-base';
 export function createVueI18n() {
   return createI18n({
     legacy: false,
+    globalInjection: true,
     locale: 'en',
     missingWarn: false,
     fallbackWarn: false,