@kalisio/kdk 2.3.2 → 2.4.1

package/.eslintignore

@@ -1 +1,2 @@
-core/client/components/action/KAction.vue
+core/client/components/action/KAction.vue
+map/client/components/catalog/KLayersPanel.vue

package/.github/workflows/main.yaml

@@ -25,7 +25,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        node: [ 18, 20 ]
+        node: [ 18, 22 ]
         mongo: [ 5, 6, 7 ]
     name: Additional tests
     if: ${{ contains(github.event.head_commit.message, 'additional tests') }}
@@ -40,7 +40,7 @@ jobs:
       - name: Setup workspace
         env:
           KALISIO_GITHUB_URL: ${{ secrets.KALISIO_GITHUB_URL }}
-        run: bash ./scripts/setup_workspace.sh
+        run: bash ./scripts/setup_workspace.sh -n ${{ matrix.node }}
       - name: Run tests
         env:
           SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
@@ -60,7 +60,7 @@ jobs:
       - name: Setup workspace
         env:
           KALISIO_GITHUB_URL: ${{ secrets.KALISIO_GITHUB_URL }}
-        run: bash ./scripts/setup_workspace.sh
+        run: bash ./scripts/setup_workspace.sh -k nokli -n 18
       - name: Build docs
         env:
           SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}

package/README.md

@@ -29,3 +29,4 @@ This project is licensed under the MIT License - see the [license file](./LICENS
 This project is sponsored by 
 
 [![Kalisio](https://s3.eu-central-1.amazonaws.com/kalisioscope/kalisio/kalisio-logo-black-256x84.png)](https://kalisio.com)
+

package/core/api/db.js

@@ -29,7 +29,12 @@ export function createObjectID (id) {
   if (isObjectID(id)) return id
   // Take care that numbers could be a valid object ID
   else if ((typeof id === 'number') || !ObjectID.isValid(id)) return null
-  else return new ObjectID(id)
+  else {
+    const objectId = new ObjectID(id)
+    // It appears that ObjectID.isValid is not reliable in some driver versions, see eg https://jira.mongodb.org/browse/NODE-3760
+    // So that we use an additional check here
+    return (objectId.toString() === id ? objectId : null)
+  }
 }
 
 // Utility function used to convert from string to MongoDB IDs as required eg by queries

package/core/api/hooks/hooks.model.js

@@ -224,7 +224,7 @@ export function setExpireAfter (delayInSeconds) {
 export async function distinct (hook) {
   const params = hook.params
   const query = params.query
-  if (!query.$distinct) return hook
+  if (!query || !query.$distinct) return hook
   const collection = hook.service.Model
   hook.result = await collection.distinct(query.$distinct, _.omit(query, ['$distinct']))
   return hook

package/core/api/hooks/hooks.schemas.js

@@ -28,7 +28,6 @@ export function validateData (schema) {
 
     items.forEach((item, index) => {
       if (item.status === 'rejected') {
-        console.log(item.reason)
         item.validationError = {
           message: item.reason.message,
           data: item.reason.data.map(error => {
@@ -58,7 +57,6 @@ export function validateData (schema) {
     const hasError = (errors.length > 0)
     if (hasError) {
       const firstError = errors[0]
-      console.log(firstError)
       // Single item case => raise the error
       if (!isArray) throw new BadRequest(firstError.message, firstError.data)
       // Multiple items case => raise if no valid data found

package/core/api/models/messages.model.mongodb.js

@@ -0,0 +1,13 @@
+export default function (app, options) {
+  const db = options.db || app.db
+  options.Model = db.collection('messages')
+  // Collation provided in query ensure sorting to be case insensitive w.r.t. user's language
+  // We built indices with collation to cover the most used languages, it requires different naming...
+  options.Model.createIndex({ createdAt: -1 })
+  options.Model.createIndex({ title: 1 }, { name: 'title-en', collation: { locale: 'en', strength: 1 } })
+  options.Model.createIndex({ title: 1 }, { name: 'title-fr', collation: { locale: 'fr', strength: 1 } })
+  options.Model.createIndex({ body: 1 }, { name: 'body-en', collation: { locale: 'en', strength: 1 } })
+  options.Model.createIndex({ body: 1 }, { name: 'body-fr', collation: { locale: 'fr', strength: 1 } })
+  options.Model.createIndex({ author: 1 }, { name: 'author-en', collation: { locale: 'en', strength: 1 } })
+  options.Model.createIndex({ author: 1 }, { name: 'author-fr', collation: { locale: 'fr', strength: 1 } })
+}

package/core/api/services/authorisations/authorisations.service.js

@@ -1,5 +1,5 @@
 import _ from 'lodash'
-import LruCache from 'lru-cache'
+import { LRUCache } from 'lru-cache'
 import makeDebug from 'debug'
 import { defineAbilities } from '../../../common/permissions.js'
 
@@ -92,7 +92,11 @@ export default {
     const config = app.get('authorisation')
     if (config && config.cache) {
       // Store abilities of the N most active users in LRU cache (defaults to 1000)
-      this.cache = new LruCache(config.cache.maxUsers || 1000)
+      const max = config.cache.maxUsers || 1000
+      // LRU cache lib switched from positional parameters to options object at some point
+      // so that now we directly pass the options to it while before we used the max argument
+      if (!config.cache.max && !config.cache.ttl && !config.cache.maxSize) config.cache.max = max
+      this.cache = new LRUCache(config.cache)
       debug('Using LRU cache for user abilities')
     } else {
       debug('Do not use LRU cache for user abilities')
@@ -127,13 +131,18 @@ export default {
   async updateAbilities (subject) {
     if (this.cache) {
       if (subject && subject._id) {
-        this.cache.del(subject._id.toString())
+        this.cache.delete(subject._id.toString())
       } else {
-        this.cache.del(ANONYMOUS_USER)
+        this.cache.delete(ANONYMOUS_USER)
       }
     }
 
     const abilities = await this.getAbilities(subject)
     return abilities
+  },
+
+  // Clear abilities
+  clearAbilities() {
+    if (this.cache) this.cache.clear()
   }
 }

package/core/api/services/index.js

@@ -38,6 +38,19 @@ export function removeStorageService (options = {}) {
   return app.removeService(app.getService('storage', options.context))
 }
 
+export function createMessagesService (options = {}) {
+  const app = this
+  return app.createService('messages', Object.assign({
+    servicesPath,
+    modelsPath
+  }, options))
+}
+
+export function removeMessagesService (options = {}) {
+  const app = this
+  return app.removeService(app.getService('messages', options.context))
+}
+
 export function createDatabasesService (options = {}) {
   const app = this
 
@@ -118,6 +131,12 @@ export default async function () {
     debug('\'import-export\' service created')
   }
 
+  const messagesConfig = app.get('messages')
+  if (messagesConfig) {
+    await createMessagesService.call(app)
+    debug('\'messages\' service created')
+  }
+
   const orgConfig = app.get('organisations')
   if (orgConfig) {
     await createOrganisationService.call(app)

package/core/api/services/messages/messages.hooks.js

@@ -0,0 +1,38 @@
+import fuzzySearch from 'feathers-mongodb-fuzzy-search'
+import commonHooks from 'feathers-hooks-common'
+import { diacriticSearch } from '../../hooks/index.js'
+
+export default {
+  before: {
+    all: [],
+    find: [
+      fuzzySearch({ fields: ['title', 'body', 'author'] }),
+      diacriticSearch()
+    ],
+    get: [],
+    create: [commonHooks.setNow('createdAt')],
+    update: [],
+    patch: [],
+    remove: []
+  },
+
+  after: {
+    all: [],
+    find: [],
+    get: [],
+    create: [],
+    update: [],
+    patch: [],
+    remove: []
+  },
+
+  error: {
+    all: [],
+    find: [],
+    get: [],
+    create: [],
+    update: [],
+    patch: [],
+    remove: []
+  }
+}

package/core/client/api.js

@@ -10,7 +10,6 @@ import configuration from 'config'
 import { permissions } from '../common/index.js'
 import { Store } from './store.js'
 import { Events } from './events.js'
-import { LocalStorage } from './local-storage.js'
 
 // Setup log level
 if (_.get(configuration, 'logs.level')) {
@@ -22,7 +21,6 @@ if (_.get(configuration, 'logs.level')) {
 export function createClient (config) {
   // Initiate the client
   const api = feathers()
-  const baseUrlStorageKey = 'baseUrl'
 
   // Matchers that can be added to customize route guards
   let matchers = []
@@ -137,35 +135,6 @@ export function createClient (config) {
     if (options.context) service.context = options.context
     return service
   }
-  // Change the base URL/domain to be used (useful for mobile apps)
-  api.setBaseUrl = function (baseUrl) {
-    LocalStorage.set(baseUrlStorageKey, baseUrl)
-    // Updating this setting live does not seem to work well in Feathers
-    // For now the caller should simply "reload" the app
-    /*
-    if (config.transport === 'http') {
-      Object.keys(this.services).forEach(path => {
-        const service = this.service(path)
-        if (service.base) {
-          service.base = `${baseUrl}/${path}`
-        }
-      })
-    } else {
-      let socket = io(baseUrl, {
-        transports: ['websocket'],
-        path: (config.apiPath || '/') + 'ws'
-      })
-      this.configure(feathers.socketio(socket))
-    }
-    */
-  }
-  // Get the base URL/domain to be used (useful for mobile apps)
-  api.getBaseUrl = function () {
-    // We can override the default app origin anyway
-    const origin = config.domain || config.origin || window.location.origin
-    // Check for registered custom base Url if any
-    return LocalStorage.get(baseUrlStorageKey, origin)
-  }
   // Helper fonctions to access/alter config used at creation time
   api.getConfig = function (path) {
     return (path ? _.get(config, path) : config)
@@ -173,6 +142,9 @@ export function createClient (config) {
   api.setConfig = function (path, value) {
     _.set(config, path, value)
   }
+  api.hasConfig = function (path, value) {
+    return _.has(config, path, value)
+  }
 
   api.can = function () {
     let service, context, resource
@@ -230,7 +202,7 @@ export function createClient (config) {
     return result
   }
 
-  const origin = api.getBaseUrl()
+  const origin = api.getConfig('domain')
   if (config.transport === 'http') {
     api.transporter = feathers.rest(origin).fetch(window.fetch.bind(window))
     api.configure(api.transporter)
@@ -280,6 +252,9 @@ export function createClient (config) {
     return this
   }
 
+  // Define domain in config if not forced
+  if (!api.getConfig('domain')) api.setConfig('domain', window.location.origin)
+
   return api
 }
 

package/core/client/capabilities.js

@@ -7,9 +7,9 @@ import { Store } from './store.js'
 // Export singleton
 export const Capabilities = {
   async initialize () {
-    const capabilities = await window.fetch(api.getBaseUrl() + _.get(config, 'apiPath') + '/capabilities')
+    const capabilities = await window.fetch(api.getConfig('domain') + _.get(config, 'apiPath') + '/capabilities')
     const content = await capabilities.json()
-    logger.debug('[KDK] fetched capabilities:', JSON.stringify(content, null, 4))
+    logger.debug('[KDK] Fetched capabilities:', content)
     this.content = content
     // Backend might override some defaults in client config
     _.forOwn(_.pick(content, ['gateway']), (value, key) => {

package/core/client/components/KActivity.vue

@@ -1,8 +1,6 @@
 <template>
-  <KPage>
-    <template v-slot:page-content>
-      <slot  />
-    </template>
+  <KPage :padding="padding">
+    <slot />
   </KPage>
 </template>
 
@@ -25,6 +23,10 @@ export default {
     layout: {
       type: [Object, Function],
       default: () => null
+    },
+    mode: {
+      type: String,
+      default: null
     }
   },
   setup (props) {
@@ -32,12 +34,28 @@ export default {
     logger.debug(`[KDK] Reading '${props.name}' activity options with key ${keyName}`)
     const options = _.get(config, keyName, {})
     const { setCurrentActivity } = useActivity(keyName, options)
-    const { configureLayout, clearLayout } = useLayout()
+    const { Layout, configureLayout, clearLayout, setLayoutMode } = useLayout()
     return {
       options,
       setCurrentActivity,
+      Layout,
       configureLayout,
-      clearLayout
+      clearLayout,
+      setLayoutMode
+    }
+  },
+  computed: {
+    padding () {
+      return this.Layout.padding
+    }
+  },
+  watch: {
+    mode: {
+      // [!] cannot be immediate as it is required that the activity is configured first
+      handler (value) {
+        logger.debug(`[KDK] Setting layout on '${value}' mode`)
+        if (value) this.setLayoutMode(value)
+      }
     }
   },
   methods: {
@@ -54,6 +72,11 @@ export default {
       this.configureLayout(_.merge({}, this.options, customLayout), concreteActivity)
       // set the current activity
       this.setCurrentActivity(concreteActivity)
+      // apply the mode if needed
+      if (this.mode) this.setLayoutMode(this.mode)
+    },
+    getOptions () {
+      return this.options
     }
   },
   async mounted () {

package/core/client/components/KContent.vue

@@ -1,6 +1,6 @@
 <template>
   <div>
-    <template v-for="component in avaiableComponents" :key="component.uid">
+    <template v-for="component in availableComponents" :key="component.uid">
       <Suspense v-if="component.suspense">
         <component
           v-if="component.isVisible && !component.isHidden"
@@ -61,7 +61,7 @@ const props = defineProps({
 const emit = defineEmits(['triggered'])
 
 // Computed
-const avaiableComponents = computed(() => {
+const availableComponents = computed(() => {
   if (_.isEmpty(props.content)) return []
   let components = filterContent(props.content, props.filter || {})
   components = getComponents(components, props.mode, props.context)

package/core/client/components/KDialog.vue

@@ -10,18 +10,18 @@
     <Suspense>
       <!-- component with v-model -->
       <component
-        v-if="_.has(attrs, 'v-model')"
+        v-if="model"
         ref="componentRef"
         :is="computedComponent"
         v-model="computedModel"
-        v-bind="computedProps"
+        v-bind="attrs"
       />
       <!-- component without v-model -->
       <component
         v-else
         ref="componentRef"
         :is="computedComponent"
-        v-bind="computedProps"
+        v-bind="attrs"
       />
     </Suspense>
   </KModal>
@@ -97,7 +97,7 @@ const computedButtons = computed(() => {
       const cancelButton = _.clone(props.cancelAction)
       if (cancelButton.handler) {
         cancelButton.handler = async () => {
-          // ! call the origonal handler to avoid recurcive call
+          // ! call the original handler to avoid recursive call
           const result = await callHandler(props.cancelAction.handler)
           // close dialog whatever the result of the handler
           onDialogCancel(result)
@@ -141,9 +141,6 @@ const computedModel = computed({
     emit('update:modelValue', value)
   }
 })
-const computedProps = computed(() => {
-  return _.omit(attrs, ['v-model'])
-})
 
 // Functions
 async function callHandler (handler) {

package/core/client/components/KStamp.vue

@@ -6,13 +6,10 @@
       'column items-center q-gutter-y-sm': direction === 'vertical',
       'row items-center no-wrap q-gutter-x-sm': direction === 'horizontal'
     }">
-      <div>
-        <q-icon v-if="canShowIcon" :size="iconSize" :name="icon" />
-          <q-tooltip v-if="!canShowText">
-            {{ $tie(text) }}
-          </q-tooltip>
+      <div v-if="canShowIcon">
+        <q-icon :size="iconSize" :name="icon" />
       </div>
-      <div v-if="canShowText" class="ellipsis" :style="`font-size: ${textSize};`"
+      <div class="ellipsis" :style="`font-size: ${textSize};`"
         v-bind:class="{'text-center': direction === 'vertical' }"
       >
          {{ $tie(text) }}
@@ -59,7 +56,4 @@ const $q = useQuasar()
 const canShowIcon = computed(() => {
   return !_.isEmpty(props.icon)
 })
-const canShowText = computed(() => {
-  return props.direction === 'vertical' || _.isEmpty(props.icon) || $q.screen.gt.xs
-})
 </script>

package/core/client/components/KStore.vue

@@ -18,10 +18,8 @@ Events.on('store-changed', (path, value) => updateLazy(path, value))
 
 // functions
 function onLazyLoad ({ node, key, done, fail }) {
-  setTimeout(() => {
-    done(convertStore(_.get(Store, key), 1))
-    lazy.value = addPath(lazy.value)
-  }, 1000)
+  done(convertStore(_.get(Store, key), 1))
+  lazy.value = addPath(lazy.value)
 }
 function convertStore (node, maxDepth = -1, depth = 0) {
   if (maxDepth >= 0 && maxDepth === depth) return

package/core/client/components/KTab.vue

@@ -0,0 +1,95 @@
+<template>
+  <div v-if="hasTabs" class="fit column">
+    <!-- Tabs -->
+    <q-tabs
+      v-model="current"
+      :no-caps="noCaps"
+      outside-arrows
+      mobile-arrows
+      :dense="dense"
+      class="full-width text-primary"
+    >
+      <template v-for="(tab, index) in tabs" :key="tab">
+        <q-tab :name="tab" :id="tab" :label="getLabel(index) || tab" />
+      </template>
+    </q-tabs>
+    <q-separator />
+    <!-- Panel -->
+    <KContent
+      :id="`${current}-panel`"
+      :content="panel"
+      :mode="current"
+      :filter="filter"
+      @triggered="onTriggered"
+      class="col full-width"
+    />
+  </div>
+</template>
+
+<script setup>
+import _ from 'lodash'
+import { ref, computed } from 'vue'
+import { i18n } from '../i18n.js'
+import KContent from './KContent.vue'
+
+// Props
+const props = defineProps({
+  content: {
+    type: Object,
+    default: () => null
+  },
+  mode: {
+    type: String,
+    default: undefined
+  },
+  filter: {
+    type: Object,
+    default: () => {}
+  },
+  context: {
+    type: Object,
+    default: () => null
+  },
+  labels: {
+    type: Array,
+    default: () => null
+  },
+  noCaps: {
+    type: Boolean,
+    default: true
+  },
+  dense: {
+    type: Boolean,
+    default: false
+  }
+})
+
+// Emit
+const emit = defineEmits(['triggered'])
+
+// Data
+const current = ref(props.mode || _.head(getModes()))
+
+// Computed
+const hasTabs = computed(() => {
+  return !_.isEmpty(tabs.value)
+})
+const tabs = computed(() => {
+  return getModes()
+})
+const panel = computed(() => {
+  return _.get(props.content, current.value)
+})
+
+// Function
+function getModes () {
+  return _.keys(props.content)
+}
+function getLabel (index) {
+  const label = _.nth(props.labels, index)
+  if (label) return i18n.tie(label)
+}
+function onTriggered (params) {
+  emit('triggered', params)
+}
+</script>

package/core/client/components/action/KAction.vue

@@ -10,7 +10,8 @@
     :icon="!iconRight ? computedIcon : undefined"
     :icon-right="iconRight ? computedIcon : undefined"
     :size="size"
-    flat
+    :flat="flat"
+    :outline="outline"
     :round="label === null"
     :rounded="label !== null"
     :stack="stack"
@@ -111,6 +112,10 @@
     label-class="bg-primary text-white text-caption k-fab-action"
     :disable="computedDisabled"
     @click="onClicked">
+    <!-- tooltip -->
+    <q-tooltip v-if="computedTooltip" anchor="top middle" self="bottom right">
+      {{ computedTooltip }}
+    </q-tooltip>
     <!-- badge -->
     <q-badge v-if="badge" v-bind="badge">
       <q-icon v-if="badge.icon" v-bind="badge.icon" />
@@ -163,11 +168,13 @@ import { i18n } from '../../i18n.js'
 import { actionProps } from '../../utils/utils.actions'
 import { bindParams } from '../../utils/utils.content.js'
 
+// Props
+const props = defineProps(actionProps)
+
 // Data
 const route = useRoute()
 const router = useRouter()
 const $q = useQuasar()
-const props = defineProps(actionProps)
 const isToggled = _.has(props, 'toggle.value') ? toRef(props.toggle, 'value') : ref(props.toggled)
 
 // Emit
@@ -282,6 +289,12 @@ async function onClicked (event) {
 watch(() => props.toggled, (value) => {
   if (isToggled.value !== value) isToggled.value = value
 })
+
+// Expose
+defineExpose({
+  isToggled,
+  toggle
+})
 </script>
 
 <style lang="scss" scoped>

package/core/client/components/action/KBugReportAction.vue

@@ -13,10 +13,12 @@ import { i18n } from '../../i18n'
 import { getPlatform } from '../../utils/utils.platform'
 import { actionProps } from '../../utils/utils.actions'
 import { useVersion } from '../../composables'
-import KAction from './/KAction.vue'
+import KAction from './KAction.vue'
 
-// Data
+// Props
 const props = defineProps(_.omit(actionProps, ['toggle', 'url', 'handler', 'route', 'dialog']))
+
+// Data
 const { clientVersionName, apiVersionName } = useVersion()
 const platform = getPlatform()
 

package/core/client/components/action/KToggleFullscreenAction.vue

@@ -0,0 +1,25 @@
+<template>
+  <KAction
+    ref="actionRef"
+    v-bind="props"
+    :handler="toggleFullscreen"
+  />
+</template>
+
+<script setup>
+import _ from 'lodash'
+import { ref, watch } from 'vue'
+import { actionProps, Fullscreen, toggleFullscreen } from '../../utils'
+import KAction from './KAction.vue'
+
+// Props
+const props = defineProps(_.omit(actionProps, ['url', 'handler', 'dialog', 'route', 'closePopup']))
+
+// Data
+const actionRef = ref(null)
+
+// Watch
+watch(Fullscreen, () => {
+  if (actionRef.value.isToggled !== Fullscreen.value) actionRef.value.toggle()
+})
+</script>