@kalisio/kdk 2.4.1 → 2.5.1

package/core/client/context.js

@@ -0,0 +1,38 @@
+import _ from 'lodash'
+import logger from 'loglevel'
+import config from 'config'
+import { api } from './api.js'
+import { Store } from './store.js'
+
+// Export singleton
+export const Context = {
+  serviceName: null,
+  service: null,
+  initialize () {
+    this.serviceName = _.get(config, 'context.service')
+    if (!_.isEmpty(this.serviceName)) {
+      // initialize the store
+      Store.set('context', null)
+      logger.debug(`[KDK] Context configured with service '${this.serviceName}'`)
+    }
+  },
+  get () {
+    return Store.get('context')
+  },
+  getId () {
+    return _.get(this.get(), '_id')
+  },
+  getRef () {
+    return Store.getRef('context')
+  },
+  getService () {
+    if (_.isEmpty(this.serviceName)) throw new Error('[KDK] Context service undefined !')
+    if (this.service) return this.service
+    this.service = api.getService(this.serviceName)
+    if (_.isNil(this.service)) throw new Error('[KDK] Context service not found !')
+    return this.service
+  },
+  set (context) {
+    Store.set('context', context)
+  }
+}

package/core/client/directives/v-hover.js

@@ -1,23 +1,26 @@
-import { getPlatform } from '../utils/utils.platform.js'
-const Platform = getPlatform()
+import { Platform } from '../platform.js'
 
 export const vHover = {
 
   mounted (el, binding) {
     if (Platform.touch) return
     el.__vHoverEnter__ = binding.value.enter || (() => {})
+    el.__vHoverOver__ = binding.value.over || (() => {})
     el.__vHoverLeave__ = binding.value.leave || (() => {})
 
     // Add Event Listeners
-    el.addEventListener('mouseover', el.__vHoverEnter__)
+    el.addEventListener('mouseenter', el.__vHoverEnter__)
+    el.addEventListener('mouseover', el.__vHoverOver__)
     el.addEventListener('mouseleave', el.__vHoverLeave__)
   },
 
   beforeUnmount (el, binding) {
     // Remove Event Listeners
-    el.removeEventListener('mouseover', el.__vHoverEnter__)
+    el.removeEventListener('mouseenter', el.__vHoverEnter__)
+    el.removeEventListener('mouseover', el.__vHoverOver__)
     el.removeEventListener('mouseleave', el.__vHoverLeave__)
     delete el.__vHoverEnter__
+    delete el.__vHoverOver__
     delete el.__vHoverLeave__
   }
 }

package/core/client/document.js

@@ -2,44 +2,72 @@ import _ from 'lodash'
 import logger from 'loglevel'
 import config from 'config'
 import sanitize from 'sanitize-html'
-import showdown from 'showdown'
 import { i18n } from './i18n.js'
 
 export const Document = {
   initialize () {
-    this.options = _.get(config, 'document')
-    this.options = _.defaultsDeep(this.options, {
+    this.options = _.defaultsDeep(_.get(config, 'document'), {
       viewers: {
         htm: 'document/KHtml',
         html: 'document/KHtml',
+        'text/html': 'document/KHtml',
+        txt: 'document/KHtml',
+        'text/plain': 'document/KHtml',
+        csv: 'document/KCsv',
+        'text/csv': 'document/KCsv',
         md: 'document/KMarkdown',
+        'text/markdown': 'document/KMarkdown',
         pdf: 'document/KPdf',
+        'application/pdf': 'document/KPdf',
         jpg: 'document/KImage',
         jpeg: 'document/KImage',
-        png: 'document/KImage'
+        'image/jpeg': 'document/KImage',
+        png: 'document/KImage',
+        'image/png': 'document/KImage',
+        apng: 'document/KImage',
+        'image/apng': 'document/KImage',
+        gif: 'document/KImage',
+        'image/gif': 'document/KImage',
+        svg: 'document/KImage',
+        'image/svg+xml': 'document/KImage',
+        webp: 'document/KImage',
+        'image/webp': 'document/KImage',
+        mp4: 'document/KVideo',
+        'video/mp4': 'document/KVideo',
+        mkv: 'document/KVideo',
+        'video/x-matroska': 'document/KVideo',
+        mov: 'document/KVideo',
+        'video/quicktime': 'document/KVideo',
+        webm: 'document/KVideo',
+        'video/webm': 'document/KVideo'
+      },
+      browser: {
+        scrollableViewers: ['document/KHtml', 'document/KMarkdown', 'document/KCsv']
       },
       htmlSanitizer: {
-        allowedTags: sanitize.defaults.allowedTags.concat(['img'])
+        allowedTags: sanitize.defaults.allowedTags.concat(['img', 'strike']),
+        allowedAttributes: _.assign(sanitize.defaults.allowedAttributes, { div: ['style'] })
       },
       mdConverter: {}
     })
-    logger.debug('[KDK] Configuring documents with options:', this.options)
+    logger.debug('[KDK] Document initialized with options:', this.options)
   },
-  register (mimeTypes, viewer) {
-    if (!_.isArray(mimeTypes)) mimeTypes = [mimeTypes]
-    _.forEach(mimeTypes, mimeType => {
-      _.set(this.options, `viewers.${mimeType}`, viewer)
+  register (types, viewer) {
+    if (!_.isArray(types)) types = [types]
+    _.forEach(types, type => {
+      _.set(this.options, `viewers.${type}`, viewer)
     })
   },
+  getViewer (type) {
+    return _.get(this.options, `viewers.${type}`)
+  },
+  hasViewer (type) {
+    return !_.isNil(this.getViewer(type))
+  },
   sanitizeHtml (html) {
     if (_.isNil(html)) return null
     return sanitize(html, this.options.htmlSanitizer)
   },
-  convertMdToHtml (md) {
-    if (_.isNil(md)) return null
-    const converter = new showdown.Converter(this.options.mdConverter)
-    return converter.makeHtml(md)
-  },
   async fetchUrl (url, localize) {
     if (_.isEmpty(url)) return null
     // localize the url if needed

package/core/client/events.js

@@ -1,3 +1,3 @@
-import Emitter from 'tiny-emitter'
+import { EventBus } from 'quasar'
 
-export const Events = new Emitter()
+export const Events = new EventBus()

package/core/client/exporter.js

@@ -9,12 +9,12 @@ import { i18n } from './i18n.js'
 const ExporterQueue = {
   initialize (maxConcurrentRequests) {
     this.maxConcurrentRequests = maxConcurrentRequests
-    logger.debug(`[KDK] Configuring exporter with '${maxConcurrentRequests}' maxConcurrentRequests`)
     this.pendingRequests = []
     this.runningRequests = []
     this.exportService = api.getService('import-export')
     this.exportService.on('export-created', params => this.onRequestCreated(params))
     this.exportService.on('export-completed', params => this.onRequestCompleted(params))
+    logger.debug(`[KDK] Exported initialized with '${maxConcurrentRequests}' maxConcurrentRequests`)
   },
   push (request) {
     this.pendingRequests.push(request)
@@ -32,8 +32,9 @@ const ExporterQueue = {
         filename = `${_.get(request, 'basename', request.service)}_${timestamp}.${request.format}`
         if (_.get(request, 'gzip', true)) filename += '.gz'
       }
-      // retrienve the target service path
-      const servicePath = api.getServicePath(request.service).substring(1)
+      // retrieve the target service path
+      let servicePath = api.getServicePath(request.service)
+      if (servicePath.startsWith('/')) servicePath = servicePath.substring(1)
       // retrieve the transform assigned to the format
       const transform = _.get(request, 'transform.' + request.format)
       // create the export request
@@ -72,7 +73,7 @@ const ExporterQueue = {
     }
     // close the notification
     request.notification()
-    // donwload the file
+    // download the file
     if (params.SignedUrl) {
       // Use an iframe to download the file
       // see https://github.com/socketio/socket.io/issues/4436

package/core/client/filter.js

@@ -1,7 +1,6 @@
 import _ from 'lodash'
 import { Events } from './events.js'
 import { Store } from './store.js'
-import { api } from './api.js'
 
 // Export singleton
 export const Filter = {
@@ -46,14 +45,8 @@ export const Filter = {
     items.forEach(item => {
       // We must have only one item per service
       const itemQuery = { [item.field]: item[item.field] }
-      // Check if base qury
+      // Check if base query
       if (item.baseQuery) Object.assign(itemQuery, item.baseQuery)
-      // Check if the service is contextual
-      const options = api.getServiceOptions(item.service)
-      // If so add context to distinguish items coming from different ones
-      if (options.context && Store.get('context')) {
-        itemQuery.context = Store.get('context._id')
-      }
       Object.assign(query, { [item.service]: { $elemMatch: itemQuery } })
     })
     // Avoid reentrance as we listen to other filter property changes

package/core/client/guards.js

@@ -85,7 +85,7 @@ export function beforeGuard (to, from, next) {
   for (const guard of guards) {
     const result = guard(user, to, from)
     if (typeof result === 'string') {
-      logger.debug('Navigation guard would redirect to route ' + result)
+      logger.debug('[KDK] Navigation guard would redirect to route ' + result)
       if (typeof next === 'function') {
         // Guard are used to check if a route is reachable when the user navigate
         // but redirection should be handled at the app level to avoid concurrence
@@ -96,7 +96,7 @@ export function beforeGuard (to, from, next) {
         return result
       }
     } else if (!result) {
-      logger.debug('Navigation aborted by guard')
+      logger.debug('[KDK] Navigation aborted by guard')
       if (typeof next === 'function') {
         return next(false)
       } else {
@@ -105,7 +105,7 @@ export function beforeGuard (to, from, next) {
     }
   }
 
-  logger.debug('Navigation guards passed')
+  logger.debug('[KDK] Navigation guards passed')
   if (typeof next === 'function') {
     return next()
   } else {

package/core/client/hooks/hooks.logger.js

@@ -2,7 +2,7 @@
 import logger from 'loglevel'
 
 export function log (hook) {
-  let message = `${hook.type}: ${hook.path} - Method: ${hook.method}`
+  let message = `[KDK] ${hook.type}: ${hook.path} - Method: ${hook.method}`
 
   if (hook.type === 'error') {
     message += `: ${hook.error.message}`

package/core/client/hooks/hooks.offline.js

@@ -0,0 +1,32 @@
+import _ from 'lodash'
+import { uid } from 'quasar'
+
+export function removeServerSideParameters(context) {
+  const params = context.params
+  _.unset(params, 'query.$locale')
+  _.unset(params, 'query.$collation')
+  _.unset(params, 'query.populate')
+  if (_.has(params, 'query.upsert')) {
+    _.set(params, 'upsert', _.get(params, 'query.upsert'))
+    _.unset(params, 'query.upsert')
+  }
+}
+
+export function generateId(context) {
+  const params = context.params
+  // Generate ID only when not doing a snapshot because it should keep data as it is on the server side
+  // Typically some services like the catalog deliver objects without any IDs (as directly coming from the configuration not the database)
+  // and this property is used to make some difference in the way the GUI interpret this objects
+  if (params.snapshot) return
+  const data = (Array.isArray(context.data) ? context.data : [context.data])
+  // Update only items without any ID
+  data.filter(item => !item._id).forEach(item => {
+    item._id = uid().toString()
+  })
+}
+
+export function ensureSerializable(context) {
+  // Serialization in localforage will raise error with structures that are not raw JSON:
+  // JS proxy objects, function properties, etc.
+  if (context.data) context.data = _.cloneDeep(context.data)
+}

package/core/client/hooks/index.js

@@ -1,3 +1,4 @@
-export * from './hooks.logger.js'
 export * from './hooks.events.js'
+export * from './hooks.logger.js'
+export * from './hooks.offline.js'
 export * from './hooks.users.js'