@kalisio/kdk 2.5.2 → 2.6.0

package/.github/workflows/main.yaml

@@ -1,9 +1,31 @@
 name: ci
-on: [ push, workflow_dispatch ]
+on:
+  push:
+  workflow_dispatch:
+    inputs:
+      run_tests:
+        description: "Run tests"
+        default: false
+        required: false
+        type: boolean
+      additional_tests:
+        description: "Additional tests"
+        default: false
+        required: false
+        type: boolean
+      build_docs:
+        description: "Build docs"
+        default: false
+        required: false
+        type: boolean
 
 jobs:
   run_tests:
     name: Run tests
+    if: ${{
+      github.event_name == 'workflow_dispatch' && inputs.run_tests ||
+      github.event_name == 'push'
+      }}
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout repo
@@ -19,16 +41,20 @@ jobs:
       - name: Run tests
         env:
           SOPS_AGE_KEY: ${{ secrets.SOPS_AGE_KEY }}
-        run: bash ./scripts/run_tests.sh -c -r ${{ github.job }}
+        # run: bash ./scripts/run_tests.sh -c -r ${{ github.job }}
+        run: bash ./scripts/run_tests.sh -r ${{ github.job }}
   
   additional_tests:
     strategy:
       fail-fast: false
       matrix:
-        node: [ 18, 22 ]
-        mongo: [ 5, 6, 7 ]
+        node: [ 20, 22 ]
+        mongo: [ 8 ]
     name: Additional tests
-    if: ${{ contains(github.event.head_commit.message, 'additional tests') }}
+    if: ${{
+      github.event_name == 'workflow_dispatch' && inputs.additional_tests ||
+      github.event_name == 'push' && contains(github.event.head_commit.message, 'additional tests')
+      }}
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout repo
@@ -48,7 +74,10 @@ jobs:
 
   build_docs:
     name: Build doc
-    if: ${{ startsWith(github.event.head_commit.message, 'docs:') || contains(github.event.head_commit.message, 'build doc') }}
+    if: ${{
+      github.event_name == 'workflow_dispatch' && inputs.build_docs ||
+      github.event_name == 'push' && contains(github.event.head_commit.message, 'doc')
+      }}
     runs-on: ubuntu-22.04
     steps:
       - name: Checkout repo

package/client.globe.js

@@ -0,0 +1,8 @@
+// Need this as export * only exports named exports but not the default export
+import core from './core/client/index.js'
+import map from './map/client/globe.js'
+const kdk = { core, map }
+
+export default kdk
+export * as kdkCore from './core/client/index.js'
+export * as kdkMap from './map/client/globe.js'

package/client.js

@@ -0,0 +1,8 @@
+// Need this as export * only exports named exports but not the default export
+import core from './core/client/index.js'
+import map from './map/client/index.js'
+const kdk = { core, map }
+
+export default kdk
+export * as kdkCore from './core/client/index.js'
+export * as kdkMap from './map/client/index.js'

package/client.map.js

@@ -0,0 +1,8 @@
+// Need this as export * only exports named exports but not the default export
+import core from './core/client/index.js'
+import map from './map/client/map.js'
+const kdk = { core, map }
+
+export default kdk
+export * as kdkCore from './core/client/index.js'
+export * as kdkMap from './map/client/map.js'

package/core/api/hooks/hooks.push.js

@@ -14,6 +14,9 @@ export async function sendNewSubscriptionEmail (hook) {
   if (hook.type !== 'after') {
     throw new Error('The \'sendNewSubscriptionEmail\' hook should only be used as a \'after\' hook.')
   }
+  const app = hook.app
+  const mailerService = app.getService('mailer')
+  if (!mailerService) return
   // Check for a new subscription if any
   const currentUser = hook.result
   const previousUser = hook.params.user
@@ -32,8 +35,6 @@ export async function sendNewSubscriptionEmail (hook) {
   }
   debug('Last subscription uses uses a new fingerprint')
   // Send an email to notify the user
-  const app = hook.app
-  const mailerService = app.getService('mailer')
   const domainPath = app.get('domain') + '/#/'
   const email = {
     subject: 'Security alert - new browser detected',

package/core/api/hooks/hooks.tags.js

@@ -0,0 +1,56 @@
+import makeDebug from 'debug'
+
+const debug = makeDebug('kdk:core:tags:hooks')
+
+export async function reflectTagUpdate (hook) {
+  const { app, result, params, method } = hook
+
+  const { service: targetService, property, name, description, color } = result
+
+  if (!targetService) return hook
+
+  const service = app.getService(targetService)
+  if (!service) {
+    debug('Service not found: ', targetService)
+    return hook
+  }
+
+  const previousItem = params.previousItem || {}
+
+  const records = await service.find({
+    query: {
+      [property]: {
+        $elemMatch: {
+          name: previousItem.name,
+          color: previousItem.color
+        }
+      },
+
+      $select: ['_id', property]
+    },
+    paginate: false
+  })
+
+  for (const record of records) {
+    const updatedTags = record[property].map(tag => {
+      if (tag.name === previousItem.name && tag.color === previousItem.color) {
+        if (method === 'remove') {
+          // If the tag is being removed, we return null to filter it out
+          return null
+        }
+        return {
+          ...tag,
+          name,
+          description,
+          color
+        }
+      }
+      return tag
+    }).filter(Boolean)
+    await service.patch(record._id, {
+      [property]: updatedTags
+    })
+  }
+
+  return hook
+}

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

@@ -0,0 +1,8 @@
+export default function (app, options) {
+  const db = options.db || app.db
+  options.Model = db.collection('tags')
+  // 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({ name: 1 }, { name: 'name-en', collation: { locale: 'en', strength: 1 } })
+  options.Model.createIndex({ name: 1 }, { name: 'name-fr', collation: { locale: 'fr', strength: 1 } })
+}

package/core/api/services/index.js

@@ -56,7 +56,7 @@ export function createStorageService (options = {}) {
   return app.createService('storage', Object.assign({
     servicesPath,
     modelsPath,
-    methods: ['create', 'get', 'find', 'remove', 'createMultipartUpload', 'completeMultipartUpload', 'uploadPart', 'putObject'],
+    methods: ['create', 'get', 'find', 'remove', 'createMultipartUpload', 'completeMultipartUpload', 'uploadPart', 'putObject', 'uploadFile', 'downloadFile'],
     events: ['multipart-upload-created', 'multipart-upload-completed', 'part-uploaded', 'object-put'],
     id: '_id'
   }, options))
@@ -93,6 +93,31 @@ export function removeDatabasesService (options = {}) {
   return app.removeService(app.getService('databases', options.context))
 }
 
+export function createTagsService (options = {}) {
+  const app = this
+  return app.createService('tags', Object.assign({
+    servicesPath,
+    modelsPath
+  }, options))
+}
+
+export async function createDefaultTags () {
+  const app = this
+  const defaultTags = app.get('tags').defaultTags
+  if (!defaultTags) return
+  const tagsService = app.getService('tags')
+  // Create default tags if not already done
+  const tags = await tagsService.find({ paginate: false })
+  for (let i = 0; i < defaultTags.length; i++) {
+    const defaultTag = defaultTags[i]
+    const createdTag = _.find(tags, { name: defaultTag.name })
+    if (!createdTag) {
+      app.logger.info('Initializing default tag (name = ' + defaultTag.name + ')')
+      await tagsService.create(defaultTag)
+    }
+  }
+}
+
 export default async function () {
   const app = this
 
@@ -131,7 +156,7 @@ export default async function () {
 
   const messagesConfig = app.get('messages')
   if (messagesConfig) {
-    await createMessagesService.call(app)
+    await createMessagesService.call(app, messagesConfig)
     debug('\'messages\' service created')
   }
 
@@ -146,4 +171,10 @@ export default async function () {
     await app.createService('push', { servicesPath })
     debug('\'push\' service created')
   }
+
+  const tagsConfig = app.get('tags')
+  if (tagsConfig) {
+    await createTagsService.call(app, tagsConfig)
+    debug('\'tags\' service created')
+  }
 }

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

@@ -0,0 +1,47 @@
+import fuzzySearch from 'feathers-mongodb-fuzzy-search'
+import { diacriticSearch } from '../../hooks/hooks.query.js'
+import { hooks as kdkCoreHooks } from '../../index.js'
+import { reflectTagUpdate } from '../../hooks/hooks.tags.js'
+
+function addFieldToCheckUnique (property) {
+  return (query, hook) => {
+    const value = hook.data[property]
+    if (value === undefined) return
+    query[property] = value
+  }
+}
+
+export default {
+  before: {
+    all: [],
+    find: [
+      fuzzySearch({ fields: ['name'] }),
+      diacriticSearch()
+    ],
+    get: [],
+    create: [kdkCoreHooks.checkUnique({ field: 'name', query: addFieldToCheckUnique('service') })],
+    update: [kdkCoreHooks.checkUnique({ field: 'name', query: addFieldToCheckUnique('service') }), kdkCoreHooks.populatePreviousObject],
+    patch: [kdkCoreHooks.checkUnique({ field: 'name', query: addFieldToCheckUnique('service') }), kdkCoreHooks.populatePreviousObject],
+    remove: [kdkCoreHooks.populatePreviousObject]
+  },
+
+  after: {
+    all: [],
+    find: [],
+    get: [],
+    create: [],
+    update: [reflectTagUpdate],
+    patch: [reflectTagUpdate],
+    remove: [reflectTagUpdate]
+  },
+
+  error: {
+    all: [],
+    find: [],
+    get: [],
+    create: [],
+    update: [],
+    patch: [],
+    remove: []
+  }
+}

package/core/client/api.js

@@ -5,7 +5,7 @@ import moment from 'moment'
 import jwtdecode from 'jwt-decode'
 import feathers from '@feathersjs/client'
 import { io } from 'socket.io-client'
-import reactive from 'feathers-reactive/dist/feathers-reactive.js'
+import { rx as reactive } from 'feathers-reactive'
 import createOfflineService from '@kalisio/feathers-localforage'
 import configuration from 'config'
 import { permissions } from '../common/index.js'
@@ -140,14 +140,14 @@ export async function createClient (config) {
         // api.getService('xxx').on('event', () => ...)
         // In this case we simply warn and return the wrapper to the online service.
         // However, it is up to the application to make sure of not using such components when offline
-        // throw new Error('Cannot retrieve offline service ' + name + ' for context ' + (typeof context === 'object' ? context._id : context))
-        logger.warn('[KDK] Cannot retrieve offline service ' + name + ' for context ' + (typeof context === 'object' ? context._id : context))
+        // throw new Error('Cannot retrieve offline service ' + name + ' for context ' + (context && (typeof context === 'object') ? context._id : context))
+        logger.warn('[KDK] Cannot retrieve offline service ' + name + ' for context ' + (context && (typeof context === 'object') ? context._id : context))
       }
     }
     if (!service) {
       service = api.getOnlineService(name, context, options)
       if (!service) {
-        throw new Error('Cannot retrieve service ' + name + ' for context ' + (typeof context === 'object' ? context._id : context))
+        throw new Error('Cannot retrieve service ' + name + ' for context ' + (context && (typeof context === 'object') ? context._id : context))
       }
     }
     return service
@@ -356,7 +356,7 @@ export async function createClient (config) {
   // We also add a random query parameter to prevent cached responses.
   if (!api.isDisconnected) {
     try {
-      const url = new URL(api.getConfig('domain'))
+      const url = new URL(api.getConfig('domain') + config.apiPath + '/capabilities')
       url.searchParams.set('random', Math.random().toFixed(18).substring(2, 18))
       await window.fetch(url.toString(), { method: 'HEAD' })
     } catch (error) {

package/core/client/components/KActivity.vue

@@ -8,6 +8,7 @@
 import _ from 'lodash'
 import logger from 'loglevel'
 import { useActivity, useLayout } from '../composables'
+import { Events } from '../events.js'
 import KPage from './layout/KPage.vue'
 
 export default {
@@ -79,11 +80,11 @@ export default {
   async created () {
     await this.configure()
     // whenever the user abilities are updated, update activity as well
-    this.$events.on('user-abilities-changed', this.configure)
+    Events.on('user-abilities-changed', this.configure)
   },
   beforeUnmount () {
     logger.debug(`[KDK] Clearing '${this.name}' activity`)
-    this.$events.off('user-abilities-changed', this.configure)
+    Events.off('user-abilities-changed', this.configure)
     // Clear the layout
     this.clearLayout()
   }

package/core/client/components/KChip.vue

@@ -20,7 +20,7 @@
     <div v-if="computedLabel"
       :id="id"
       class="ellipsis"
-      :class="{ 'q-pl-sm': !dense && icon, 'q-pl-xs': dense && icon }"
+      :class="{ 'q-pl-sm': !dense && (icon || isTruncated ) , 'q-pl-xs': dense && (icon || isTruncated) }"
     >
       {{ computedLabel }}
       <q-resize-observer @resize="onResize" />
@@ -125,7 +125,7 @@ const computedState = computed({
     return props.modelValue
   },
   set: function (state) {
-    emit('updated:modelValue', state)
+    emit('update:modelValue', state)
   }
 })
 const computedLabel = computed(() => {

package/core/client/components/KEditor.vue

@@ -11,7 +11,9 @@
 import _ from 'lodash'
 import logger from 'loglevel'
 import { ref } from 'vue'
-import { api, Context, i18n } from '@kalisio/kdk/core.client'
+import { i18n } from '../i18n.js'
+import { api } from '../api.js'
+import { Context } from '../context.js'
 import { Notify } from 'quasar'
 
 // Props

package/core/client/components/KFollower.vue

@@ -24,12 +24,12 @@ const props = defineProps({
     type: String,
     required: true
   },
-  position: {
+  anchor: {
     type: String,
     default: 'top-right'
   },
   offset: {
-    type: [Number, Array],
+    type: Array,
     default: [0, 0]
   }
 })
@@ -45,9 +45,9 @@ const computedStyle = computed(() => {
   const hOffset = `${props.offset[0]}px`
   const vOffset = `${props.offset[1]}px`
   const style = {
-    position: 'fixed'
+    position: 'absolute'
   }
-  switch (props.position) {
+  switch (props.anchor) {
     case 'top-right':
       style.top = vOffset
       style.right = hOffset

package/core/client/components/KStore.vue

@@ -7,7 +7,7 @@ import _ from 'lodash'
 import moment from 'moment'
 import { Store, i18n } from '..'
 import { ref } from 'vue'
-import KTree from './KTree'
+import KTree from './KTree.vue'
 import { Events } from '../events.js'
 
 // Data

package/core/client/components/KTab.vue

@@ -1,5 +1,5 @@
 <template>
-  <div v-if="hasTabs" class="fit column">
+  <div v-if="hasTabs && current" class="fit column">
     <!-- Tabs -->
     <q-tabs
       v-model="current"
@@ -8,9 +8,14 @@
       mobile-arrows
       :dense="dense"
       class="full-width text-primary"
+      @update:model-value="onTabChanged"
     >
       <template v-for="(tab, index) in tabs" :key="tab">
-        <q-tab :name="tab" :id="tab" :label="getLabel(index) || tab" />
+        <q-tab
+          :name="tab"
+          :id="tab"
+          :label="getLabel(index) || tab"
+        />
       </template>
     </q-tabs>
     <q-separator />
@@ -20,7 +25,7 @@
       :content="panel"
       :mode="current"
       :filter="filter"
-      @triggered="onTriggered"
+      @triggered="onContentTriggered"
       class="col full-width"
     />
   </div>
@@ -28,7 +33,7 @@
 
 <script setup>
 import _ from 'lodash'
-import { ref, computed } from 'vue'
+import { ref, computed, watch } from 'vue'
 import { i18n } from '../i18n.js'
 import KContent from './KContent.vue'
 
@@ -65,10 +70,10 @@ const props = defineProps({
 })
 
 // Emit
-const emit = defineEmits(['triggered'])
+const emit = defineEmits(['tab-changed', 'triggered'])
 
 // Data
-const current = ref(props.mode || _.head(getModes()))
+const current = ref(null)
 
 // Computed
 const hasTabs = computed(() => {
@@ -81,6 +86,11 @@ const panel = computed(() => {
   return _.get(props.content, current.value)
 })
 
+// Watch
+watch(() => props.mode, (mode) => {
+  current.value = mode
+}, { immediate: true })
+
 // Function
 function getModes () {
   return _.keys(props.content)
@@ -89,7 +99,10 @@ function getLabel (index) {
   const label = _.nth(props.labels, index)
   if (label) return i18n.tie(label)
 }
-function onTriggered (params) {
+function onTabChanged (params) {
+  emit('tab-changed', params)
+}
+function onContentTriggered (params) {
   emit('triggered', params)
 }
 </script>

package/core/client/components/account/KProfile.vue

@@ -9,29 +9,29 @@
       @triggered="onTriggered"
     />
     <!-- Avatar -->
-    <div v-if="avatar && computedAvatar" class="q-py-sm column items-center">
+    <div v-if="avatar && userAvatar" class="q-py-sm column items-center">
       <KAvatar
-        :subject="computedAvatar"
+        :subject="userAvatar"
         size="5rem"
       />
     </div>
     <!-- Information -->
     <div class="q-py-sm column items-center">
       <div class="text-subtitle1 text-weight-medium">
-        {{ computedName }}
+        {{ userName }}
       </div>
-      <div v-if="description && computedDescription" class="text-caption">
-        {{ computedDescription }}
+      <div v-if="description && userDescription" class="text-caption">
+        {{ userDescription }}
       </div>
     </div>
     <!-- Role -->
-    <div v-if="role && computedRole" class="q-py-sm column items-center">
+    <div v-if="role && userRole" class="q-py-sm column items-center">
       <KChip
         color="primary"
         text-color="white"
         square
         size=".85rem"
-        :label="$t(`roles.${computedRole}`)"
+        :label="$t(`roles.${userRole}`)"
       />
     </div>
   </div>
@@ -40,7 +40,7 @@
 <script setup>
 import _ from 'lodash'
 import { computed } from 'vue'
-import { Store } from '../../store.js'
+import { useUser } from '../../composables'
 import KAvatar from '../KAvatar.vue'
 import KPanel from '../KPanel.vue'
 import KChip from '../KChip.vue'
@@ -73,7 +73,7 @@ const props = defineProps({
 const emit = defineEmits(['triggered'])
 
 // Data
-const User = Store.getRef('user')
+const { User, name: userName, description: userDescription, avatar: userAvatar, role: userRole } = useUser()
 
 // Computed
 const header = computed(() => {
@@ -123,22 +123,6 @@ const header = computed(() => {
   }
   return actions
 })
-const computedName = computed(() => {
-  return _.get(User.value, 'profile.name', _.get(User.value, 'profile.username', _.get(User.value, 'email', '')))
-})
-const computedDescription = computed(() => {
-  return _.get(User.value, 'profile.description', '')
-})
-const computedAvatar = computed(() => {
-  return _.get(User.value, 'profile', {})
-})
-const computedRole = computed(() => {
-  const permissions = _.get(User.value, 'permissions')
-  if (permissions) {
-    if (_.isString(permissions)) return permissions
-    return permissions[0]
-  }
-})
 
 // Functions
 function onTriggered (args) {

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

@@ -23,7 +23,7 @@
     <!-- icon -->
     <KIcon v-if="!iconRight && computedIcon" :icon="computedIcon" />
     <!-- label -->
-    <div v-if="computedLabel" :class="{ 'ellipsis q-pr-md': iconRight, 'ellipsis q-pl-md': !iconRight }">
+    <div v-if="computedLabel" :class="{ 'ellipsis q-pr-md': iconRight, 'ellipsis q-pl-md': !iconRight && computedIcon }">
       {{ computedLabel }}
     </div>
     <!-- tooltip -->
@@ -32,7 +32,7 @@
     </q-tooltip>
     <!-- badge -->
     <q-badge v-if="badge" v-bind="badge" :label="computedBadgeLabel">
-      <q-icon v-if="badge.icon" v-bind="badge.icon" />
+      <KIcon v-if="badge.icon" v-bind="badge.icon" />
     </q-badge>
     <!-- extra content -->
     <slot>
@@ -90,13 +90,13 @@
    -->
   <q-btn v-else-if="renderer === 'fab'"
     :id="id"
-    class="k-action-fab"
     :color="computedColor"
     :size="size"
     :round="true"
     :dense="dense"
     :disable="computedDisabled"
     @click="onClicked"
+    class="k-fab"
   >
     <!-- icon -->
     <KIcon v-if="!iconRight && computedIcon" :icon="computedIcon" />
@@ -106,7 +106,7 @@
     </q-tooltip>
     <!-- badge -->
     <q-badge v-if="badge" v-bind="badge" :label="computedBadgeLabel">
-      <q-icon v-if="badge.icon" v-bind="badge.icon" />
+      <KIcon v-if="badge.icon" v-bind="badge.icon" />
     </q-badge>
   </q-btn>
   <!--
@@ -114,17 +114,17 @@
   -->
   <q-fab-action v-else-if="renderer === 'fab-action'"
     :id="id"
-    class="k-action-fab-action"
     no-caps
-    :icon="computedIcon"
+    :icon="iconRight ? computedIcon : undefined"
     :color="computedColor"
     :label="computedLabel"
     square
     external-label
     :label-position="iconRight ? 'left' : 'right'"
-    label-class="bg-primary text-white text-caption k-fab-action"
+    label-class="text-white text-caption"
     :disable="computedDisabled"
     @click="onClicked"
+    class="k-fab-action"
   >
     <!-- icon -->
     <KIcon v-if="!iconRight && computedIcon" :icon="computedIcon" />
@@ -141,7 +141,7 @@
     Tab renderer
   -->
   <q-btn v-else-if="renderer === 'tab'"
-    :class="{'k-action-tab-active': isToggled }"
+    :class="{'k-tab-action-active': isToggled }"
     :id="id"
     no-caps
     no-wrap
@@ -314,11 +314,11 @@ defineExpose({
 </script>
 
 <style lang="scss" scoped>
-.k-action-fab, .k-action-fab-action {
+.k-fab, .k-fab-action {
   border: 2px solid;
   border-color: v-bind(computedColor) - 75%; 
 }
-.k-action-tab-active {
+.k-tab-action-active {
   border-bottom: solid 2px;
 }
 .k-action-toggled {