@jsreport/jsreport-core 3.1.1 → 3.3.0

package/lib/main/templates.js

@@ -1,34 +1,34 @@
-
-module.exports = (reporter) => {
-  reporter.documentStore.registerEntityType('TemplateType', {
-    name: { type: 'Edm.String' },
-    content: { type: 'Edm.String', document: { extension: 'html', engine: true } },
-    recipe: { type: 'Edm.String' },
-    helpers: { type: 'Edm.String', document: { extension: 'js' }, schema: { type: 'object' } },
-    engine: { type: 'Edm.String' }
-  }, true)
-
-  reporter.documentStore.registerEntitySet('templates', {
-    entityType: 'jsreport.TemplateType',
-    splitIntoDirectories: true
-  })
-
-  reporter.initializeListeners.add('templates', () => {
-    const templatesCol = reporter.documentStore.collection('templates')
-
-    templatesCol.beforeInsertListeners.add('templates', (doc) => {
-      if (!doc.engine) {
-        throw reporter.createError('Template must contain engine', {
-          weak: true,
-          statusCode: 400
-        })
-      }
-      if (!doc.recipe) {
-        throw reporter.createError('Template must contain recipe', {
-          weak: true,
-          statusCode: 400
-        })
-      }
-    })
-  })
-}
+
+module.exports = (reporter) => {
+  reporter.documentStore.registerEntityType('TemplateType', {
+    name: { type: 'Edm.String' },
+    content: { type: 'Edm.String', document: { extension: 'html', engine: true } },
+    recipe: { type: 'Edm.String' },
+    helpers: { type: 'Edm.String', document: { extension: 'js' }, schema: { type: 'object' } },
+    engine: { type: 'Edm.String' }
+  }, true)
+
+  reporter.documentStore.registerEntitySet('templates', {
+    entityType: 'jsreport.TemplateType',
+    splitIntoDirectories: true
+  })
+
+  reporter.initializeListeners.add('templates', () => {
+    const templatesCol = reporter.documentStore.collection('templates')
+
+    templatesCol.beforeInsertListeners.add('templates', (doc) => {
+      if (!doc.engine) {
+        throw reporter.createError('Template must contain engine', {
+          weak: true,
+          statusCode: 400
+        })
+      }
+      if (!doc.recipe) {
+        throw reporter.createError('Template must contain recipe', {
+          weak: true,
+          statusCode: 400
+        })
+      }
+    })
+  })
+}

package/lib/main/validateEntityName.js

@@ -1,62 +1,62 @@
-/* eslint-disable no-control-regex, no-useless-escape */
-
-const createError = require('../shared/createError')
-
-const invalidFileNameCharacters = [
-  '<',
-  '>',
-  ':',
-  '"',
-  { character: '/', escaped: '\\/' },
-  { character: '\\', escaped: '\\\\' },
-  '|',
-  '?',
-  '*'
-]
-
-function getInvalidFileNameCharactersRegExp () {
-  // original regexp taken from https://github.com/sindresorhus/filename-reserved-regex
-  return new RegExp(`[${
-    invalidFileNameCharacters.map(c => typeof c === 'string' ? c : c.escaped).join('')
-  }\\x00-\\x1F]`, 'g')
-}
-
-module.exports = (name) => {
-  if (name == null || (typeof name === 'string' && name.trim() === '')) {
-    throw createError('Entity name can not be empty', {
-      statusCode: 400
-    })
-  }
-
-  if (typeof name !== 'string') {
-    throw createError('Entity name must be a string', {
-      statusCode: 400
-    })
-  }
-
-  if (name.trim() === '.') {
-    throw createError('Entity name can not be "."', {
-      statusCode: 400
-    })
-  }
-
-  if (name.trim() === '..') {
-    throw createError('Entity name can not be ".."', {
-      statusCode: 400
-    })
-  }
-
-  const containsInvalid = getInvalidFileNameCharactersRegExp().test(name)
-
-  if (containsInvalid) {
-    const msg = `Entity name can not contain characters ${
-      invalidFileNameCharacters.map(c => typeof c === 'string' ? c : c.character).join(', ')
-    } and non-printable characters. name used: ${name}`
-
-    throw createError(msg, {
-      statusCode: 400
-    })
-  }
-
-  return true
-}
+/* eslint-disable no-control-regex, no-useless-escape */
+
+const createError = require('../shared/createError')
+
+const invalidFileNameCharacters = [
+  '<',
+  '>',
+  ':',
+  '"',
+  { character: '/', escaped: '\\/' },
+  { character: '\\', escaped: '\\\\' },
+  '|',
+  '?',
+  '*'
+]
+
+function getInvalidFileNameCharactersRegExp () {
+  // original regexp taken from https://github.com/sindresorhus/filename-reserved-regex
+  return new RegExp(`[${
+    invalidFileNameCharacters.map(c => typeof c === 'string' ? c : c.escaped).join('')
+  }\\x00-\\x1F]`, 'g')
+}
+
+module.exports = (name) => {
+  if (name == null || (typeof name === 'string' && name.trim() === '')) {
+    throw createError('Entity name can not be empty', {
+      statusCode: 400
+    })
+  }
+
+  if (typeof name !== 'string') {
+    throw createError('Entity name must be a string', {
+      statusCode: 400
+    })
+  }
+
+  if (name.trim() === '.') {
+    throw createError('Entity name can not be "."', {
+      statusCode: 400
+    })
+  }
+
+  if (name.trim() === '..') {
+    throw createError('Entity name can not be ".."', {
+      statusCode: 400
+    })
+  }
+
+  const containsInvalid = getInvalidFileNameCharactersRegExp().test(name)
+
+  if (containsInvalid) {
+    const msg = `Entity name can not contain characters ${
+      invalidFileNameCharacters.map(c => typeof c === 'string' ? c : c.character).join(', ')
+    } and non-printable characters. name used: ${name}`
+
+    throw createError(msg, {
+      statusCode: 400
+    })
+  }
+
+  return true
+}

package/lib/shared/createError.js

@@ -1,36 +1,36 @@
-const _omit = require('lodash.omit')
-
-module.exports = function (message, options = {}) {
-  const { original } = options
-  let error
-
-  if (message == null && original != null) {
-    error = original
-  } else {
-    error = new Error(message)
-
-    if (original != null) {
-      error.entity = original.entity
-      error.lineNumber = original.lineNumber
-      error.property = original.property
-
-      if (error.message == null || error.message === '') {
-        error.message = `${original.message}`
-      } else {
-        error.message += `. ${original.message}`
-      }
-
-      if (error.stack != null && original.stack != null) {
-        error.stack += `\ncaused by: ${original.stack}`
-      }
-    }
-  }
-
-  Object.assign(error, _omit(options, 'original'))
-
-  if ((error.statusCode === 400 || error.statusCode === 404) && error.weak == null) {
-    error.weak = true
-  }
-
-  return error
-}
+const _omit = require('lodash.omit')
+
+module.exports = function (message, options = {}) {
+  const { original } = options
+  let error
+
+  if (message == null && original != null) {
+    error = original
+  } else {
+    error = new Error(message)
+
+    if (original != null) {
+      error.entity = original.entity
+      error.lineNumber = original.lineNumber
+      error.property = original.property
+
+      if (error.message == null || error.message === '') {
+        error.message = `${original.message}`
+      } else {
+        error.message += `. ${original.message}`
+      }
+
+      if (error.stack != null && original.stack != null) {
+        error.stack += `\ncaused by: ${original.stack}`
+      }
+    }
+  }
+
+  Object.assign(error, _omit(options, 'original'))
+
+  if ((error.statusCode === 400 || error.statusCode === 404) && error.weak == null) {
+    error.weak = true
+  }
+
+  return error
+}

package/lib/shared/encryption.js

@@ -1,114 +1,114 @@
-const crypto = require('crypto')
-
-module.exports = (reporter) => {
-  const DEFAULT_ENCRYPTION = 'aes-128-gcm'
-  const DEFAULT_IV_LENGTH = 16 // For AES, this is always 16
-  const prefix = 'jrEncrypt'
-
-  function getEncryptionOpts (opts) {
-    let secret = opts.secret
-    let encryption = opts.encryption
-    let ivLength = opts.ivLength
-
-    if (!secret && reporter.options.encryption) {
-      secret = reporter.options.encryption.secretKey
-    }
-
-    if (!encryption) {
-      encryption = DEFAULT_ENCRYPTION
-    }
-
-    if (!ivLength) {
-      ivLength = DEFAULT_IV_LENGTH
-    }
-
-    return {
-      secret,
-      encryption,
-      ivLength
-    }
-  }
-
-  async function encrypt (text, opts = {}) {
-    if (reporter.options.encryption && reporter.options.encryption.enabled === false) {
-      return text
-    }
-
-    const { secret, encryption, ivLength } = getEncryptionOpts(opts)
-
-    if (!secret) {
-      throw reporter.createError('using reporter.encryption.encrypt requires to specify a secret, make sure to pass one or to define the "options.encryption.secretKey" option in config', {
-        statusCode: 400,
-        encryptionNoSecret: true
-      })
-    }
-
-    const iv = crypto.randomBytes(ivLength)
-    const cipher = crypto.createCipheriv(encryption, Buffer.from(secret), iv)
-    let encrypted = cipher.update(text)
-
-    encrypted = Buffer.concat([encrypted, cipher.final()])
-
-    const authTag = cipher.getAuthTag()
-
-    return `${prefix}$${authTag.toString('hex')}:${iv.toString('hex')}:${encrypted.toString('hex')}`
-  }
-
-  async function decrypt (rawText, opts = {}) {
-    const isTextEncrypted = isEncrypted(rawText)
-
-    if (isTextEncrypted && reporter.options.encryption.enabled === false) {
-      throw reporter.createError('using reporter.encryption.decrypt to restore encrypted value requires to enable encryption, make sure to enable it using "options.encryption.enabled" option in config', {
-        statusCode: 400,
-        encryptionDisabled: true
-      })
-    }
-
-    if (!isTextEncrypted) {
-      return rawText
-    }
-
-    const { secret, encryption } = getEncryptionOpts(opts)
-
-    if (!secret) {
-      throw reporter.createError('using reporter.encryption.decrypt requires to specify a secret, make sure to pass one or to define the "options.encryption.secretKey" option in config', {
-        statusCode: 400,
-        encryptionNoSecret: true
-      })
-    }
-
-    try {
-      const text = rawText.replace(new RegExp('^' + prefix + '\\$'), '')
-      const textParts = text.split(':')
-      const authTag = Buffer.from(textParts.shift(), 'hex')
-      const iv = Buffer.from(textParts.shift(), 'hex')
-      const encryptedText = Buffer.from(textParts.join(':'), 'hex')
-      const decipher = crypto.createDecipheriv(encryption, Buffer.from(secret), iv)
-
-      decipher.setAuthTag(authTag)
-
-      let decrypted = decipher.update(encryptedText)
-
-      decrypted = Buffer.concat([decrypted, decipher.final()])
-
-      return decrypted.toString()
-    } catch (e) {
-      throw reporter.createError(`reporter.encryption.decrypt failed, make sure "options.encryption.secretKey" was not changed and you are using the same key which was used to encrypt content. ${e.message}`, {
-        statusCode: 400,
-        encryptionDecryptFail: true
-      })
-    }
-  }
-
-  function isEncrypted (text) {
-    if (text == null) {
-      return false
-    }
-
-    const regExp = new RegExp('^' + prefix + '\\$[^:\\s]+:[^:\\s]+')
-
-    return regExp.test(text)
-  }
-
-  return { encrypt, decrypt, isEncrypted }
-}
+const crypto = require('crypto')
+
+module.exports = (reporter) => {
+  const DEFAULT_ENCRYPTION = 'aes-128-gcm'
+  const DEFAULT_IV_LENGTH = 16 // For AES, this is always 16
+  const prefix = 'jrEncrypt'
+
+  function getEncryptionOpts (opts) {
+    let secret = opts.secret
+    let encryption = opts.encryption
+    let ivLength = opts.ivLength
+
+    if (!secret && reporter.options.encryption) {
+      secret = reporter.options.encryption.secretKey
+    }
+
+    if (!encryption) {
+      encryption = DEFAULT_ENCRYPTION
+    }
+
+    if (!ivLength) {
+      ivLength = DEFAULT_IV_LENGTH
+    }
+
+    return {
+      secret,
+      encryption,
+      ivLength
+    }
+  }
+
+  async function encrypt (text, opts = {}) {
+    if (reporter.options.encryption && reporter.options.encryption.enabled === false) {
+      return text
+    }
+
+    const { secret, encryption, ivLength } = getEncryptionOpts(opts)
+
+    if (!secret) {
+      throw reporter.createError('using reporter.encryption.encrypt requires to specify a secret, make sure to pass one or to define the "options.encryption.secretKey" option in config', {
+        statusCode: 400,
+        encryptionNoSecret: true
+      })
+    }
+
+    const iv = crypto.randomBytes(ivLength)
+    const cipher = crypto.createCipheriv(encryption, Buffer.from(secret), iv)
+    let encrypted = cipher.update(text)
+
+    encrypted = Buffer.concat([encrypted, cipher.final()])
+
+    const authTag = cipher.getAuthTag()
+
+    return `${prefix}$${authTag.toString('hex')}:${iv.toString('hex')}:${encrypted.toString('hex')}`
+  }
+
+  async function decrypt (rawText, opts = {}) {
+    const isTextEncrypted = isEncrypted(rawText)
+
+    if (isTextEncrypted && reporter.options.encryption.enabled === false) {
+      throw reporter.createError('using reporter.encryption.decrypt to restore encrypted value requires to enable encryption, make sure to enable it using "options.encryption.enabled" option in config', {
+        statusCode: 400,
+        encryptionDisabled: true
+      })
+    }
+
+    if (!isTextEncrypted) {
+      return rawText
+    }
+
+    const { secret, encryption } = getEncryptionOpts(opts)
+
+    if (!secret) {
+      throw reporter.createError('using reporter.encryption.decrypt requires to specify a secret, make sure to pass one or to define the "options.encryption.secretKey" option in config', {
+        statusCode: 400,
+        encryptionNoSecret: true
+      })
+    }
+
+    try {
+      const text = rawText.replace(new RegExp('^' + prefix + '\\$'), '')
+      const textParts = text.split(':')
+      const authTag = Buffer.from(textParts.shift(), 'hex')
+      const iv = Buffer.from(textParts.shift(), 'hex')
+      const encryptedText = Buffer.from(textParts.join(':'), 'hex')
+      const decipher = crypto.createDecipheriv(encryption, Buffer.from(secret), iv)
+
+      decipher.setAuthTag(authTag)
+
+      let decrypted = decipher.update(encryptedText)
+
+      decrypted = Buffer.concat([decrypted, decipher.final()])
+
+      return decrypted.toString()
+    } catch (e) {
+      throw reporter.createError(`reporter.encryption.decrypt failed, make sure "options.encryption.secretKey" was not changed and you are using the same key which was used to encrypt content. ${e.message}`, {
+        statusCode: 400,
+        encryptionDecryptFail: true
+      })
+    }
+  }
+
+  function isEncrypted (text) {
+    if (text == null) {
+      return false
+    }
+
+    const regExp = new RegExp('^' + prefix + '\\$[^:\\s]+:[^:\\s]+')
+
+    return regExp.test(text)
+  }
+
+  return { encrypt, decrypt, isEncrypted }
+}

package/lib/shared/folders/index.js

@@ -1,11 +1,11 @@
-const resolveFolderFromPath = require('./resolveFolderFromPath')
-const resolveEntityFromPath = require('./resolveEntityFromPath')
-const resolveEntityPath = require('./resolveEntityPath')
-
-module.exports = (reporter) => {
-  return {
-    resolveEntityPath: resolveEntityPath(reporter),
-    resolveFolderFromPath: resolveFolderFromPath(reporter),
-    resolveEntityFromPath: resolveEntityFromPath(reporter)
-  }
-}
+const resolveFolderFromPath = require('./resolveFolderFromPath')
+const resolveEntityFromPath = require('./resolveEntityFromPath')
+const resolveEntityPath = require('./resolveEntityPath')
+
+module.exports = (reporter) => {
+  return {
+    resolveEntityPath: resolveEntityPath(reporter),
+    resolveFolderFromPath: resolveFolderFromPath(reporter),
+    resolveEntityFromPath: resolveEntityFromPath(reporter)
+  }
+}

package/lib/shared/folders/normalizeEntityPath.js

@@ -1,15 +1,15 @@
-const path = require('path')
-
-module.exports = function normalizeEntityPath (entityPath, { currentPath }, req) {
-  let parentPath = '/'
-
-  if (req && req.context.currentFolderPath) {
-    parentPath = req.context.currentFolderPath
-  }
-
-  if (currentPath) {
-    parentPath = currentPath
-  }
-
-  return path.posix.resolve(parentPath, entityPath).replace(/\\/g, '/')
-}
+const path = require('path')
+
+module.exports = function normalizeEntityPath (entityPath, { currentPath }, req) {
+  let parentPath = '/'
+
+  if (req && req.context.currentFolderPath) {
+    parentPath = req.context.currentFolderPath
+  }
+
+  if (currentPath) {
+    parentPath = currentPath
+  }
+
+  return path.posix.resolve(parentPath, entityPath).replace(/\\/g, '/')
+}