@vcmap/ui 6.3.10 → 7.0.0-rc.1

package/src/uiConfig.d.ts

@@ -341,352 +341,7 @@ declare class UiConfig extends Collection<UiConfigurationItem<unknown>> {
     /**
      * @type {import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Record<string, *> & UiConfigObject>>}
      */
-    get config(): {
-        readonly [x: string]: any;
-        /**
-         * - the company logo to display. this will override any and all css overrides.
-         */
-        readonly logo?: string | undefined;
-        /**
-         * - the company logo to display in dark mode. this will override any and all css overrides. if not set, the `logo` will be used
-         */
-        readonly logoDark?: string | undefined;
-        /**
-         * - an alternative logo to display in mobile view
-         */
-        readonly mobileLogo?: string | undefined;
-        /**
-         * - an alternative logo to display in mobile view and dark mode. if not set, the `mobileLogo` will be used
-         */
-        readonly mobileLogoDark?: string | undefined;
-        /**
-         * - an optional title to display next to the company logo
-         */
-        readonly appTitle?: string | undefined;
-        /**
-         * - an optional primary color to use in all themes, can be overwritten by `vuetifyTheme`
-         */
-        readonly primaryColor?: string | undefined;
-        /**
-         * - an optional flag whether to activate feature info on startup (default active)
-         */
-        readonly startingFeatureInfo?: boolean | undefined;
-        /**
-         * - an optional flag whether to enable deep picking via right click context menu (default active)
-         */
-        readonly enableDeepPicking?: boolean | undefined;
-        /**
-         * - mouse event, when position display is updated. Either 'click' (default) or 'move'.
-         */
-        readonly positionDisplayEventType?: string | undefined;
-        /**
-         * - A template for rendering information of the current image in oblique mode, e.g. '{{ name }}' printing the image's name
-         */
-        readonly obliqueFooterTemplate?: string | undefined;
-        /**
-         * - an optional URL to a help landing page
-         */
-        readonly helpBaseUrl?: string | undefined;
-        /**
-         * - an option imprint, will show a link in the footer. Default title is 'footer.imprint.title'.
-         */
-        readonly imprint?: {
-            readonly title?: string | undefined;
-            readonly url?: string | {
-                readonly hash: string;
-                readonly host: string;
-                readonly hostname: string;
-                readonly href: string;
-                readonly toString: () => string;
-                readonly origin: string;
-                readonly password: string;
-                readonly pathname: string;
-                readonly port: string;
-                readonly protocol: string;
-                readonly search: string;
-                readonly searchParams: ReadonlyMap<string, string | null>;
-                readonly username: string;
-                readonly toJSON: () => string;
-            } | undefined;
-            readonly content?: string | undefined;
-        } | undefined;
-        /**
-         * - an option dataProtection, will show a link in the footer. Default title is 'footer.dataProtection.title'.
-         */
-        readonly dataProtection?: {
-            readonly title?: string | undefined;
-            readonly url?: string | {
-                readonly hash: string;
-                readonly host: string;
-                readonly hostname: string;
-                readonly href: string;
-                readonly toString: () => string;
-                readonly origin: string;
-                readonly password: string;
-                readonly pathname: string;
-                readonly port: string;
-                readonly protocol: string;
-                readonly search: string;
-                readonly searchParams: ReadonlyMap<string, string | null>;
-                readonly username: string;
-                readonly toJSON: () => string;
-            } | undefined;
-            readonly content?: string | undefined;
-        } | undefined;
-        /**
-         * - optionnal, additional information to show in the footer as links or dialogs
-         */
-        readonly footerInformation?: readonly {
-            readonly title?: string | undefined;
-            readonly url?: string | {
-                readonly hash: string;
-                readonly host: string;
-                readonly hostname: string;
-                readonly href: string;
-                readonly toString: () => string;
-                readonly origin: string;
-                readonly password: string;
-                readonly pathname: string;
-                readonly port: string;
-                readonly protocol: string;
-                readonly search: string;
-                readonly searchParams: ReadonlyMap<string, string | null>;
-                readonly username: string;
-                readonly toJSON: () => string;
-            } | undefined;
-            readonly content?: string | undefined;
-        }[] | undefined;
-        /**
-         * - an option splashScreen, will show a splash Screen on Map Load.
-         */
-        readonly splashScreen?: {
-            readonly title?: string | undefined;
-            readonly icon?: string | undefined;
-            readonly content?: string | undefined;
-            readonly name?: string | undefined;
-            readonly checkBoxText?: string | undefined;
-            readonly buttonTitle?: string | undefined;
-            readonly secondaryButtonTitle?: string | undefined;
-            readonly exitCallbackOptions?: readonly {
-                readonly type: string;
-            }[] | undefined;
-            readonly secondaryCallbackOptions?: readonly {
-                readonly type: string;
-            }[] | undefined;
-            readonly menuEntry?: boolean | undefined;
-            readonly acceptInput?: boolean | undefined;
-            /**
-             * Whether the Secondary Button is disabled as well as long as the checkbox is not checked.
-             */
-            readonly requireInputForSecondary?: boolean | undefined;
-            /**
-             * Whether to display a checkbox allowing the user not to see the SplashScreen again. This parameter is relative to moduleId and configuration; the SplashScreen will be shown again in case of any change.
-             */
-            readonly enableDontShowAgain?: boolean | undefined;
-            readonly position?: {
-                readonly width?: string | undefined;
-                readonly height?: string | undefined;
-                readonly maxHeight?: string | undefined;
-                readonly maxWidth?: string | undefined;
-            } | undefined;
-        } | undefined;
-        /**
-         * - an option customScreen, will show a Custom Menu Point that opens a window with custom content.
-         */
-        readonly customScreen?: {
-            readonly title?: string | undefined;
-            readonly icon?: string | undefined;
-            readonly content?: string | undefined;
-            readonly name?: string | undefined;
-            readonly windowPosition?: {
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly left?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly top?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly right?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly bottom?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly width?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly height?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly maxHeight?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly maxWidth?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly minHeight?: string | number | undefined;
-                /**
-                 * Can be a css position string (e.g. '320px' or '50%') number values are treated as `px` values
-                 */
-                readonly minWidth?: string | number | undefined;
-            } | undefined;
-        } | undefined;
-        /**
-         * - the favicon to set
-         */
-        readonly favicon?: string | undefined;
-        /**
-         * - the title to display in the tab of the browser
-         */
-        readonly headerTitle?: string | undefined;
-        /**
-         * - an optional flag whether to show the Locator in the map.
-         */
-        readonly showLocator?: boolean | undefined;
-        /**
-         * - an optional flag to hide the Rotator in the map.
-         */
-        readonly hideRotationButton?: boolean | undefined;
-        /**
-         * - an optional flag that describes the time per rotation in seconds.
-         */
-        readonly timePerRotation?: number | undefined;
-        /**
-         * - can be used to hide the default Header of the map
-         */
-        readonly hideHeader?: boolean | undefined;
-        /**
-         * - can be used to hide the integrated Search bar
-         */
-        readonly hideSearch?: boolean | undefined;
-        /**
-         * - can be used to set the pitch angle of the viewpoint of features zoomed to from Search, in degrees. Defaults to -35 degrees.
-         */
-        readonly searchViewpointPitch?: number | undefined;
-        /**
-         * - can be used to hide the sharee button
-         */
-        readonly hideShareButton?: boolean | undefined;
-        /**
-         * - can be used to hide the menu button
-         */
-        readonly hideMenuButton?: boolean | undefined;
-        /**
-         * - can be used to hide the default Map Buttons
-         */
-        readonly hideMapButtons?: boolean | undefined;
-        /**
-         * - can be used to hide the toolbox
-         */
-        readonly hideToolbox?: boolean | undefined;
-        /**
-         * - can be used to hide the navigation
-         */
-        readonly hideMapNavigation?: boolean | undefined;
-        /**
-         * - can be used to hide the footer
-         */
-        readonly hideFooter?: boolean | undefined;
-        /**
-         * - can be used to hide the myWorkspace button
-         */
-        readonly hideMyWorkspace?: boolean | undefined;
-        /**
-         * - can be used to hide the contentTree
-         */
-        readonly hideContentTree?: boolean | undefined;
-        /**
-         * - can be used to hide the rendering order action in the contentTree, which allows for temporary changes of rendering order
-         */
-        readonly hideContentTreeRenderingOrder?: boolean | undefined;
-        /**
-         * - can be used to hide the legend
-         */
-        readonly hideLegend?: boolean | undefined;
-        /**
-         * - can be used to hide the settings Window
-         */
-        readonly hideSettings?: boolean | undefined;
-        /**
-         * - can be used to hide the oblique name in the footer
-         */
-        readonly hideObliqueFooter?: boolean | undefined;
-        /**
-         * - can be used to hide the panorama name in the footer
-         */
-        readonly hidePanoramaFooter?: boolean | undefined;
-        /**
-         * - can be used to activate the overviewMap on startup
-         */
-        readonly overviewMapActiveOnStartup?: boolean | undefined;
-        /**
-         * - can be used to activate a contentTree on startup
-         */
-        readonly contentTreeActiveOnStartup?: boolean | undefined;
-        /**
-         * - the display quality settings
-         */
-        readonly displayQuality?: {
-            readonly startingQualityLevel?: import("@vcmap/core").DisplayQualityLevel | undefined;
-            readonly startingMobileQualityLevel?: import("@vcmap/core").DisplayQualityLevel | undefined;
-            readonly low?: {
-                readonly sse?: number | undefined;
-                readonly fxaa?: boolean | undefined;
-                readonly fogEnabled?: boolean | undefined;
-                readonly fogDensity?: number | undefined;
-                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;
-                readonly fxaa?: boolean | undefined;
-                readonly fogEnabled?: boolean | undefined;
-                readonly fogDensity?: number | undefined;
-                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;
-                readonly fxaa?: boolean | undefined;
-                readonly fogEnabled?: boolean | undefined;
-                readonly fogDensity?: number | undefined;
-                readonly fogScreenSpaceErrorFactor?: number | undefined;
-                readonly resolutionScale?: number | undefined;
-                readonly layerSSEFactor?: number | undefined;
-                readonly msaa?: 1 | 2 | 4 | 8 | undefined;
-            } | undefined;
-        } | undefined;
-        /**
-         * - Vuetify Theming, also see vuetify configuraton https://vuetifyjs.com/en/features/theme/
-         */
-        readonly vuetifyTheme?: any;
-        /**
-         * - open the legend window, if new layer has a config
-         */
-        readonly openLegendOnAdd?: boolean | undefined;
-        /**
-         * - automatically close the legend window, if no layer has a config
-         */
-        readonly autoCloseLegend?: boolean | undefined;
-        /**
-         * - can be used to apply a scale factor to the overviewMap
-         */
-        readonly overviewMapScaleFactor?: number | undefined;
-    };
+    get config(): import("vue").DeepReadonly<import("vue").UnwrapNestedRefs<Record<string, any> & UiConfigObject>>;
     /**
      * @type {import("vue").Ref<boolean>}
      */

package/src/vcsUiApp.d.ts

@@ -203,19 +203,19 @@ declare class VcsUiApp extends VcsApp {
     /**
      * @type {import("@vcmap/core").OverrideCollection<ContentTreeItem, ContentTreeCollection>}
      */
-    get contentTree(): import("@vcmap/core").OverrideCollection<ContentTreeItem, ContentTreeCollection, import("./contentTree/contentTreeItem.js").ContentTreeItemOptions>;
+    get contentTree(): import("@vcmap/core").OverrideCollection<ContentTreeItem, ContentTreeCollection>;
     /**
      * @type {import("@vcmap/core").OverrideClassRegistry<typeof import("./callback/vcsCallback.js").default>}
      */
-    get callbackClassRegistry(): OverrideClassRegistry<typeof import("./callback/vcsCallback.js").default>;
+    get callbackClassRegistry(): import("@vcmap/core").OverrideClassRegistry<typeof import("./callback/vcsCallback.js").default>;
     /**
      * @type {import("@vcmap/core").OverrideClassRegistry<typeof ContentTreeItem>}
      */
-    get contentTreeClassRegistry(): OverrideClassRegistry<typeof ContentTreeItem>;
+    get contentTreeClassRegistry(): import("@vcmap/core").OverrideClassRegistry<typeof ContentTreeItem>;
     /**
      * @type {import("@vcmap/core").OverrideClassRegistry<typeof AbstractFeatureInfoView>}
      */
-    get featureInfoClassRegistry(): OverrideClassRegistry<typeof AbstractFeatureInfoView>;
+    get featureInfoClassRegistry(): import("@vcmap/core").OverrideClassRegistry<typeof AbstractFeatureInfoView>;
     /**
      * @returns {ToolboxManager}
      */
@@ -247,96 +247,11 @@ declare class VcsUiApp extends VcsApp {
     /**
      * @returns {import("vue-i18n").I18n}
      */
-    get vueI18nPlugin(): import("vue-i18n").I18n<any, any, any, string, boolean>;
+    get vueI18nPlugin(): import("vue-i18n").I18n;
     /**
      * @returns {ReturnType<typeof import("vuetify").createVuetify>}
      */
-    get vuetify(): {
-        install: (app: import("vue").App<any>) => void;
-        defaults: import("vue").Ref<import("vuetify").DefaultsInstance>;
-        display: import("vuetify").DisplayInstance;
-        theme: import("vuetify").ThemeInstance & {
-            install: (app: import("vue").App<any>) => void; /**
-             * @type {WindowManager}
-             * @private
-             */
-        };
-        icons: {
-            defaultSet: string;
-            aliases: Partial<import("vuetify").IconAliases>;
-            sets: Record<string, import("vuetify").IconSet>;
-        };
-        locale: {
-            isRtl: import("vue").Ref<boolean>;
-            rtl: import("vue").Ref<Record<string, boolean>>;
-            rtlClasses: import("vue").Ref<string>;
-            name: string;
-            messages: import("vue").Ref<import("vuetify").LocaleMessages>;
-            current: import("vue").Ref<string>;
-            fallback: import("vue").Ref<string>;
-            t: (key: string, ...params: unknown[]) => string;
-            n: (value: number) => string;
-            provide: (props: import("vuetify").LocaleOptions) => import("vuetify").LocaleInstance;
-        };
-        date: {
-            options: {
-                adapter: (new (options: {
-                    locale: any;
-                    formats?: any;
-                }) => import("vuetify").DateInstance) | import("vuetify").DateInstance;
-                formats?: Record<string, any> | undefined;
-                locale: Record<string, any>;
-            };
-            instance: {
-                locale?: any;
-                date: (value?: any) => unknown;
-                format: (date: unknown, formatString: string) => string;
-                toJsDate: (value: unknown) => Date;
-                parseISO: (date: string) => unknown;
-                toISO: (date: unknown) => string;
-                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;
-                startOfYear: (date: unknown) => unknown;
-                endOfYear: (date: unknown) => unknown;
-                isAfter: (date: unknown, comparing: unknown) => boolean;
-                isAfterDay: (value: unknown, comparing: unknown) => boolean;
-                isSameDay: (date: unknown, comparing: unknown) => boolean;
-                isSameMonth: (date: unknown, comparing: unknown) => boolean;
-                isSameYear: (value: unknown, comparing: unknown) => boolean;
-                isBefore: (date: unknown, comparing: unknown) => boolean;
-                isEqual: (date: unknown, comparing: unknown) => boolean;
-                isValid: (date: any) => boolean;
-                isWithinRange: (date: unknown, range: [unknown, unknown]) => boolean;
-                addMinutes: (date: unknown, amount: number) => unknown;
-                addHours: (date: unknown, amount: number) => unknown;
-                addDays: (date: unknown, amount: number) => unknown;
-                addWeeks: (date: unknown, amount: number) => unknown;
-                addMonths: (date: unknown, amount: number) => unknown;
-                getYear: (date: unknown) => number;
-                setYear: (date: unknown, year: number) => unknown;
-                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;
-                setMonth: (date: unknown, month: number) => unknown;
-                getDate: (date: unknown) => number;
-                setDate: (date: unknown, day: number) => unknown;
-                getNextMonth: (date: unknown) => unknown;
-                getPreviousMonth: (date: unknown) => unknown;
-                getHours: (date: unknown) => number;
-                setHours: (date: unknown, hours: number) => unknown;
-                getMinutes: (date: unknown) => number; /**
-                 * @returns {PanelManager}
-                 */
-                setMinutes: (date: unknown, minutes: number) => unknown;
-            };
-        };
-        goTo: import("vuetify").GoToInstance;
-    };
+    get vuetify(): ReturnType<typeof import("vuetify").createVuetify>;
     /**
      * @returns {import("vue-i18n").Composer<{}, {}, {}, string, string, string>}
      */
@@ -356,7 +271,7 @@ declare class VcsUiApp extends VcsApp {
     /**
      * @type {import("@vcmap/core").OverrideCollection<import("./uiConfig.js").UiConfigurationItem<unknown>, UiConfig>}
      */
-    get uiConfig(): import("@vcmap/core").OverrideCollection<import("./uiConfig.js").UiConfigurationItem<unknown>, UiConfig, import("./uiConfig.js").UiConfigurationItem<unknown>>;
+    get uiConfig(): import("@vcmap/core").OverrideCollection<import("./uiConfig.js").UiConfigurationItem<unknown>, UiConfig>;
     /**
      * @type {Notifier}
      */
@@ -371,7 +286,7 @@ declare class VcsUiApp extends VcsApp {
      * @param {string=} [subpageVersion=undefined] - default version is the mapVersion, can be provided to use a plugin specific version
      * @returns {function():string}
      */
-    getHelpUrlCallback(path?: string | undefined, subpage?: string | undefined, subpageVersion?: string | undefined): () => string;
+    getHelpUrlCallback(path?: string, subpage?: string, subpageVersion?: string | undefined): () => string;
     /**
      * Get the state of the application. When passed the forUrl flag, only a minimal set of states shall be provided for a sharable link to the current state (to ensure
      * the maximum URL length is not exceeded). This includes: layer active state & styling, active map, active viewpoint,
@@ -391,7 +306,6 @@ import { VcsEvent } from '@vcmap/core';
 import { Collection } from '@vcmap/core';
 import ContentTreeItem from './contentTree/contentTreeItem.js';
 import ContentTreeCollection from './contentTree/contentTreeCollection.js';
-import { OverrideClassRegistry } from '@vcmap/core';
 import AbstractFeatureInfoView from './featureInfo/abstractFeatureInfoView.js';
 import ToolboxManager from './manager/toolbox/toolboxManager.js';
 import WindowManager from './manager/window/windowManager.js';

package/src/vcsUiApp.js

@@ -21,11 +21,11 @@ import ToolboxManager, {
 import WindowManager from './manager/window/windowManager.js';
 import PanelManager from './manager/panel/panelManager.js';
 import NavbarManager from './manager/navbarManager.js';
-// eslint-disable-next-line no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import ContentTreeCollection, { // imported for type
   createContentTreeCollection,
 } from './contentTree/contentTreeCollection.js';
-// eslint-disable-next-line no-unused-vars
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
 import ContentTreeItem, { // imported for type
   contentTreeClassRegistry,
 } from './contentTree/contentTreeItem.js';
@@ -47,9 +47,9 @@ import { version } from '../package.json';
 import Search from './search/search.js';
 import Notifier from './notifier/notifier.js';
 import AbstractFeatureInfoView from './featureInfo/abstractFeatureInfoView.js';
-import { createVueI18n, setupI18n } from './vuePlugins/i18n.js';
+import { createVueI18n, setupI18n } from './vuePlugins/i18n.ts';
 import { callbackClassRegistry } from './callback/vcsCallback.js';
-import createSiteConfig from './siteConfig.js';
+import createSiteConfig from './siteConfig.ts';
 import { createVcsVuetify } from './vuePlugins/vuetify.js';
 import createObliqueFallbackWarnings from './obliqueFallbackWarnings.js';
 

package/src/vuePlugins/i18n.d.ts

@@ -1,16 +1,26 @@
+import { type I18n, type TranslateOptions, type NamedValue } from 'vue-i18n';
+import type { Plugin } from 'vue';
+import type VcsUiApp from '../vcsUiApp.js';
 /**
  * creates a new VueI18n Instance.
- * @returns {import("vue-i18n").I18n}
  */
-export function createVueI18n(): import("vue-i18n").I18n;
+export declare function createVueI18n(): I18n;
+declare module '@vue/runtime-core' {
+    interface ComponentCustomProperties {
+        $st(key: string | number | undefined | null): string;
+        $st(key: string | number | undefined | null, plural: number, options?: TranslateOptions): string;
+        $st(key: string | number | undefined | null, defaultMsg: string, options?: TranslateOptions): string;
+        $st(key: string | number | undefined | null, list: unknown[], options?: TranslateOptions): string;
+        $st(key: string | number | undefined | null, list: unknown[], plural: number): string;
+        $st(key: string | number | undefined | null, list: unknown[], defaultMsg: string): string;
+        $st(key: string | number | undefined | null, named: NamedValue, options?: TranslateOptions): string;
+        $st(key: string | number | undefined | null, named: NamedValue, plural: number): string;
+        $st(key: string | number | undefined | null, named: NamedValue, defaultMsg: string): string;
+    }
+}
 /**
  * creates a Vue Plugin with a new $st template helper which can handle undefined. Will just redirect to vueI18n,
  * if key is a string
- * @returns {import("vue").Plugin}
  */
-export function createSafeI18n(): import("vue").Plugin;
-/**
- * @param {import("../vcsUiApp.js").default} app
- * @returns {function():void} returns a destroy function
- */
-export function setupI18n(app: import("../vcsUiApp.js").default): () => void;
+export declare function createSafeI18n(): Plugin;
+export declare function setupI18n(app: VcsUiApp): () => void;