@vcmap/ui 6.0.0-rc.2 → 6.0.0-rc.5

package/src/actions/StyleSelector.vue

@@ -7,7 +7,7 @@
         @click.stop="select(item.value)"
       >
         <v-list-item-title
-          :class="{ 'primary--text': item.value === currentStyleName }"
+          :class="{ 'text-primary': item.value === currentStyleName }"
         >
           {{ $st(item.text) }}
         </v-list-item-title>

package/src/actions/actionHelper.js

@@ -1,5 +1,5 @@
 import { v4 as uuid } from 'uuid';
-import { check, checkMaybe } from '@vcsuite/check';
+import { check, maybe, oneOf, optional } from '@vcsuite/check';
 import {
   Collection,
   Extent,
@@ -48,8 +48,8 @@ import SearchComponent from '../search/SearchComponent.vue';
  */
 export function getActionFromOptions(options) {
   check(options.name, String);
-  checkMaybe(options.title, String);
-  checkMaybe(options.icon, String);
+  check(options.title, maybe(String));
+  check(options.icon, maybe(String));
   check(options.callback, Function);
   options.active = parseBoolean(options.active, false);
   options.hasUpdate = parseBoolean(options.hasUpdate, false);
@@ -67,8 +67,8 @@ export function getActionFromOptions(options) {
 export function createMapButtonAction(actionOptions, mapName, maps) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
   });
   check(mapName, String);
   check(maps, MapCollection);
@@ -104,12 +104,12 @@ export function createToggleAction(
 ) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
-    hasUpdate: [undefined, Boolean],
+    icon: optional(String),
+    title: optional(String),
+    hasUpdate: optional(Boolean),
   });
   check(windowComponent, { id: String });
-  check(owner, [String, vcsAppSymbol]);
+  check(owner, oneOf(String, vcsAppSymbol));
 
   const action = reactive({
     ...actionOptions,
@@ -153,11 +153,17 @@ export function createToggleAction(
 export function createSearchButtonAction(app) {
   let destroyAction = () => {};
   const searchAction = ref(null);
+  const uiConfig = app.uiConfig.config;
+
   const determineAction = () => {
     if (app.windowManager.has('searchId')) {
       app.windowManager.remove('searchId');
     }
-    if (app.search.size > 0 && searchAction.value === null) {
+    if (
+      !uiConfig.hideSearch &&
+      app.search.size > 0 &&
+      searchAction.value === null
+    ) {
       const action = createToggleAction(
         {
           name: 'search.title',
@@ -178,7 +184,10 @@ export function createSearchButtonAction(app) {
       );
       destroyAction = action.destroy;
       searchAction.value = reactive(action.action);
-    } else if (app.search.size === 0 && searchAction.value !== null) {
+    } else if (
+      (uiConfig.hideSearch || app.search.size === 0) &&
+      searchAction.value !== null
+    ) {
       destroyAction();
       destroyAction = () => {};
       searchAction.value = null;
@@ -186,6 +195,8 @@ export function createSearchButtonAction(app) {
   };
   determineAction();
   const listeners = [
+    app.uiConfig.added.addEventListener(determineAction),
+    app.uiConfig.removed.addEventListener(determineAction),
     app.search.added.addEventListener(determineAction),
     app.search.removed.addEventListener(determineAction),
   ];
@@ -256,10 +267,10 @@ export function createOverviewMapAction(
 export function createModalAction(actionOptions, modalComponent, app, owner) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
   });
-  check(owner, [String, vcsAppSymbol]);
+  check(owner, oneOf(String, vcsAppSymbol));
 
   const id = uuid();
   const { position: windowPositionOptions, ...component } = modalComponent;
@@ -334,10 +345,10 @@ export function createModalAction(actionOptions, modalComponent, app, owner) {
 export function createLinkAction(actionOptions, url) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
   });
-  check(url, [String, Function]);
+  check(url, oneOf(String, Function));
 
   return {
     ...actionOptions,
@@ -369,10 +380,10 @@ export function createGoToViewpointAction(
 ) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
   });
-  check(viewpoint, [Viewpoint, String]);
+  check(viewpoint, oneOf(Viewpoint, String));
   check(viewpointCollection, Collection);
   check(mapCollection, MapCollection);
 
@@ -422,8 +433,8 @@ export function createZoomToFeatureAction(
 ) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
   });
   check(feature, Feature);
   check(mapCollection, MapCollection);

package/src/actions/flightActions.js

@@ -1,5 +1,5 @@
 import { reactive } from 'vue';
-import { check, checkMaybe } from '@vcsuite/check';
+import { check, maybe, ofEnum } from '@vcsuite/check';
 import {
   createFlightVisualization,
   exportFlightAsGeoJson,
@@ -87,7 +87,7 @@ export const PlayerDirection = {
  * @returns {{action: import("./actionHelper.js").VcsAction, destroy: () => void}}
  */
 export function createStepAction(app, instance, direction) {
-  check(direction, Object.values(PlayerDirection));
+  check(direction, ofEnum(PlayerDirection));
 
   let player;
   const action = reactive({
@@ -123,7 +123,7 @@ export function createStepAction(app, instance, direction) {
  * @returns {{ action: import("./actionHelper.js").VcsAction & { listeners:Object<string,()=>void>, destroy: () => void }}}
  */
 export function createFastAction(app, instance, direction) {
-  check(direction, Object.values(PlayerDirection));
+  check(direction, ofEnum(PlayerDirection));
 
   let player;
   const sign = direction === PlayerDirection.Forward ? 1 : -1;
@@ -421,8 +421,8 @@ export function createExportFlightAction(instance, isPathExport = false) {
  * @returns {Promise<boolean>}
  */
 export async function importFlights(app, files, moduleId, importSuccessCb) {
-  checkMaybe(moduleId, String);
-  checkMaybe(importSuccessCb, Function);
+  check(moduleId, maybe(String));
+  check(importSuccessCb, maybe(Function));
 
   const { vueI18n } = app;
   const results = await Promise.all(

package/src/actions/listActions.d.ts

@@ -1,10 +1,3 @@
-/**
- * Creates an action for renaming an item in a VcsList. Shows VcsTextfield in VcsList.
- * @param {import("../components/lists/VcsList.vue").VcsListItem} item
- * @param {Partial<import("./actionHelper.js").ActionOptions>} [actionOptions={}]
- * @returns {import("./actionHelper.js").VcsAction}
- */
-export function createListItemRenameAction(item: import("../components/lists/VcsList.vue").VcsListItem, actionOptions?: Partial<import("./actionHelper.js").ActionOptions> | undefined): import("./actionHelper.js").VcsAction;
 /**
  * Creates an action for renaming an item in a VcsList.
  * @param {import("@vcmap/core").Collection<T>} collection
@@ -16,23 +9,23 @@ export function createListItemRenameAction(item: import("../components/lists/Vcs
 export function createListItemDeleteAction<T extends Object>(collection: import("@vcmap/core").Collection<T>, item: T, actionOptions?: Partial<import("./actionHelper.js").ActionOptions> | undefined): import("./actionHelper.js").VcsAction;
 /**
  * Creates an action based on a provided selection
- * @param {import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>} selection
+ * @param {import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>} selection
  * @param {import("./actionHelper.js").ActionOptions & {callback:import("./actionHelper.js").ActionCallback}} [actionOptions]
  * @returns {{action: import("vue").UnwrapRef<import("./actionHelper.js").VcsAction>, destroy: import("vue").WatchStopHandle}}
  */
-export function createListItemBulkAction(selection: import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>, actionOptions?: (import("./actionHelper.js").ActionOptions & {
+export function createListItemBulkAction(selection: import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>, actionOptions?: (import("./actionHelper.js").ActionOptions & {
     callback: import("./actionHelper.js").ActionCallback;
 }) | undefined): {
     action: import("vue").UnwrapRef<import("./actionHelper.js").VcsAction>;
     destroy: import("vue").WatchStopHandle;
 };
 /**
- * @param {import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>} selection
+ * @param {import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>} selection
  * @param {import("./actionHelper.js").ActionCallback} exportCallback
  * @param {string|symbol} owner
  * @returns {{action: import("../manager/collectionManager/collectionManager.js").OwnedAction, destroy: (function(): void)}}
  */
-export function createListExportAction(selection: import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>, exportCallback: import("./actionHelper.js").ActionCallback, owner: string | symbol): {
+export function createListExportAction(selection: import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>, exportCallback: import("./actionHelper.js").ActionCallback, owner: string | symbol): {
     action: import("../manager/collectionManager/collectionManager.js").OwnedAction;
     destroy: (() => void);
 };

package/src/actions/listActions.js

@@ -1,5 +1,5 @@
 import { reactive, watch } from 'vue';
-import { check } from '@vcsuite/check';
+import { check, oneOf, optional } from '@vcsuite/check';
 import { getLogger } from '@vcsuite/logger';
 import { parseGeoJSON } from '@vcmap/core';
 import VcsImportComponent from '../components/import/VcsImportComponent.vue';
@@ -8,22 +8,6 @@ import { WindowSlot } from '../manager/window/windowManager.js';
 import { vcsAppSymbol } from '../pluginHelper.js';
 import { NotificationType } from '../notifier/notifier.js';
 
-/**
- * Creates an action for renaming an item in a VcsList. Shows VcsTextfield in VcsList.
- * @param {import("../components/lists/VcsList.vue").VcsListItem} item
- * @param {Partial<import("./actionHelper.js").ActionOptions>} [actionOptions={}]
- * @returns {import("./actionHelper.js").VcsAction}
- */
-export function createListItemRenameAction(item, actionOptions = {}) {
-  return {
-    name: 'list.renameItem',
-    ...actionOptions,
-    callback: () => {
-      item.rename = true;
-    },
-  };
-}
-
 /**
  * Creates an action for renaming an item in a VcsList.
  * @param {import("@vcmap/core").Collection<T>} collection
@@ -50,15 +34,15 @@ export function createListItemDeleteAction(
 
 /**
  * Creates an action based on a provided selection
- * @param {import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>} selection
+ * @param {import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>} selection
  * @param {import("./actionHelper.js").ActionOptions & {callback:import("./actionHelper.js").ActionCallback}} [actionOptions]
  * @returns {{action: import("vue").UnwrapRef<import("./actionHelper.js").VcsAction>, destroy: import("vue").WatchStopHandle}}
  */
 export function createListItemBulkAction(selection, actionOptions) {
   check(actionOptions, {
     name: String,
-    icon: [undefined, String],
-    title: [undefined, String],
+    icon: optional(String),
+    title: optional(String),
     callback: Function,
   });
 
@@ -75,7 +59,7 @@ export function createListItemBulkAction(selection, actionOptions) {
 }
 
 /**
- * @param {import("vue").Ref<Array<import("../components/lists/VcsList.vue").VcsListItem>>} selection
+ * @param {import("vue").Ref<Array<import("../components/lists/VcsListItemComponent.vue").VcsListItem>>} selection
  * @param {import("./actionHelper.js").ActionCallback} exportCallback
  * @param {string|symbol} owner
  * @returns {{action: import("../manager/collectionManager/collectionManager.js").OwnedAction, destroy: (function(): void)}}
@@ -218,7 +202,7 @@ export function createListImportAction(
   parentId,
 ) {
   check(importCallback, Function);
-  check(owner, [String, vcsAppSymbol]);
+  check(owner, oneOf(String, vcsAppSymbol));
   check(parentId, String);
 
   const { action, destroy } = createToggleAction(

package/src/actions/stateRefAction.js

@@ -1,5 +1,5 @@
 import { reactive, watch } from 'vue';
-import { check } from '@vcsuite/check';
+import { check, ofEnum } from '@vcsuite/check';
 
 /**
  * @enum {number}
@@ -28,7 +28,7 @@ const stateIconMap = {
  */
 export function createStateRefAction(name, stateRef, callback) {
   check(name, String);
-  check(stateRef?.value, Object.values(StateActionState));
+  check(stateRef?.value, ofEnum(StateActionState));
   check(callback, Function);
 
   const currentState = stateRef.value;