jsreport 2.11.0 → 3.0.1

package/README.md

@@ -1,87 +1,5 @@
-
-
-
 # jsreport
 
-[![Join the chat at https://gitter.im/jsreport/jsreport](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jsreport/jsreport?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-[![NPM Version](http://img.shields.io/npm/v/jsreport.svg?style=flat-square)](https://npmjs.com/package/jsreport)
-[![NPM Downloads](https://img.shields.io/npm/dt/jsreport.svg?style=flat-square)](https://npmjs.com/package/jsreport)
-[![Docker Pulls](https://img.shields.io/docker/pulls/jsreport/jsreport)](https://hub.docker.com/r/jsreport/jsreport)
-[![Build Status](https://travis-ci.org/jsreport/jsreport.png?branch=master)](https://travis-ci.org/jsreport/jsreport)
-
-**Official distribution of jsreport**<br/>
-*An open-source platform for designing and rendering various reports.*
-
-jsreport is a reporting server which lets developers define reports using  javascript templating engines (like jsrender or handlebars). It supports various report output formats like html, pdf, excel and others.  It also includes advanced reporting features like user management, REST API, scheduling, designer or sending emails.
-
-You can find more information on the official project website https://jsreport.net    
-
-![studio](https://github.com/jsreport/website/blob/master/public/img/jsreport-demo.gif?raw=true)
-
-## Installation
-see [https://jsreport.net/on-prem](http://jsreport.net/on-prem)
-
-> **npm install -g jsreport-cli**<br/>
-> **jsreport init**<br/>
-> **jsreport configure**<br/>
-> **jsreport start**
-
-To change environment use cmd `set NODE_ENV=development` or use options your IDE provides. If you don't specify node environment jsreport assumes `development` as default.
-
-## Documentation
-
-see [https://jsreport.net/learn](https://jsreport.net/learn) for an overview of concepts, guides, clients and general documentation.
-
-## Configuration
-jsreport loads `jsreport.config.json` configuration file on start. The configuration file is the most common way to adapt jsreport settings like http port. In addition to configuration file you can use also corresponding command-line arguments or options passed directly through nodejs code.
-
-See [config](https://jsreport.net/learn/configuration) documentation for details.
-
-## Extensions
-The jsreport official distribution includes the most of the currently implemented extensions. However, there are still new extensions popping up which are not yet part of jsreport and you may like to additionally install it. See the list of extensions [here](https://github.com/jsreport/jsreport-core#list-of-extensions).
-
-You are also not limited to extensions we provide to you and  you can implement your own. See the [Implementing custom extension](https://jsreport.net/learn/custom-extension) article.
-
-## Node.js
-
-You can find documentation for adapting this jsreport distribution using nodejs and also information for integrating it into an existing nodejs application in the article [adapting jsreport](https://jsreport.net/learn/adapting-jsreport).
-
-This distribution includes many extensions like jsreport studio you may not need. To start from the ground see repository [jsreport-core](https://github.com/jsreport/jsreport-core).
-
-## Contributions
-
-jsreport is split into many separated repositories usually representing extensions or other reusable libraries. Please forward your contributions to the dedicated repository.
-
-## Roadmap
-- integrate to the xlsx recipe the same templating capabilities as in the docx
-- pdf linearization, PDF/A
-- docx/pptx - simple html embedding, raw openxml, memory optimization
-- word extension for reports design
-- async studio rendering - real-time log output
-- signing jsreport.exe
-- html-to-xlsx - images, filters...
-- nodejs workers usage
-- drag and drop designer [#121](../../issues/121) 
-
-More in the [backlog](https://github.com/jsreport/jsreport/issues).
-
-**Missing a feature? Submit a feature request.**
-
-## Vulnerabilities
-
-We guarantee every release is stable and has 0 vulnerabilities mentioned in the npm audit. When you see a security warning in your audit, please just wait until we release the next version with the dependencies update, there is no need to create a ticket for it. In case you see a direct impact on jsreport security, please send us an email and we will apply a direct hotfix if it will be possible.
-
-## Licensing
-Copyright (C) 2020 Jan Blaha
-
-Do you want to use jsreport for a personal purpose, in a school project or a non-profit organization?
-Then you don't need the author's permission, just go on and use it. You can use jsreport without the author's permission
-also when having a maximum 5 templates stored in jsreport storage.
-
-For commercial projects using more than 5 stored report templates see [Pricing page](https://jsreport.net/buy).
-
-Under any of the licenses, free or not, you are allowed to download the source code and make your own edits.
-
-In every case, there are no warranties of any kind provided:
+**The main jsreport distribution package**
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+See the readme in the root of the monorepo [README](https://github.com/jsreport/jsreport/blob/master/README.md).

package/index.js

@@ -1,75 +1,39 @@
-'use strict'
-
-/*!
- * Copyright(c) 2018 Jan Blaha
- */
-
-var semver = require('semver')
-var packageJson = require('./package.json')
-
-if (!semver.satisfies(process.versions.node, packageJson.engines.node)) {
-  console.error(
-    'jsreport requires to have installed a nodejs version of at least ' +
-    packageJson.engines.node +
-    ' but you have installed version ' + process.versions.node + '. please update your nodejs version and try again'
-  )
-
-  process.exit(1)
-}
-
-const extend = require('node.extend.without.arrays')
-const path = require('path')
-const core = require('jsreport-core')
-const main = require('./lib/main')
-
-const renderDefaults = {
-  store: { provider: 'memory' },
-  blobStorage: { provider: 'memory' },
-  rootDirectory: path.join(__dirname, '../../'),
-  logger: {
-    console: { silent: true },
-    file: { silent: true },
-    error: { silent: true }
-  },
-  extensions: {
-    express: { enabled: false },
-    scheduling: { enabled: false },
-    authentication: { enabled: false },
-    authorization: { enabled: false },
-    studio: { enabled: false },
-    'sample-template': { enabled: false },
-    'version-control': { enabled: false },
-    'public-templates': { enabled: false }
-  }
-}
-
-function render (req) {
-  if (!core.Reporter.instance) {
-    return main({
-      parentModuleDirectory: path.dirname(module.parent.filename)
-    }, renderDefaults).init().then(function () {
-      return core.Reporter.instance.render(req)
-    })
-  }
-
-  return core.Reporter.instance.render(req)
-}
-
-function extendDefaults (config) {
-  return extend(true, renderDefaults, config)
-}
-
-module.exports = function (options, defaults) {
-  options = options || {}
-
-  options.parentModuleDirectory = path.dirname(module.parent.filename)
-
-  return main(options, defaults)
-}
-
-module.exports.Reporter = core.Reporter
-module.exports.renderDefaults = renderDefaults
-module.exports.render = render
-module.exports.extendDefaults = extendDefaults
-module.exports.reporter = core.Reporter.instance
-module.exports.core = core
+'use strict'
+
+/*!
+ * Copyright(c) 2018 Jan Blaha
+ */
+
+const semver = require('semver')
+const packageJson = require('./package.json')
+
+if (!semver.satisfies(process.versions.node, packageJson.engines.node)) {
+  console.error(
+    'jsreport requires to have installed a nodejs version of at least ' +
+    packageJson.engines.node +
+    ' but you have installed version ' + process.versions.node + '. please update your nodejs version and try again'
+  )
+
+  process.exit(1)
+}
+
+const path = require('path')
+const core = require('@jsreport/jsreport-core')
+const main = require('./lib/main')
+
+module.exports = function (options, defaults) {
+  options = options || {}
+
+  // when jsreport is loaded from ESM, module.parent does not exists
+  if (module.parent) {
+    options.parentModuleDirectory = path.dirname(module.parent.filename)
+  } else {
+    // we set empty value to ensure jsreport-core does not override it with its custom default
+    options.parentModuleDirectory = ''
+  }
+
+  return main(options, defaults)
+}
+
+module.exports.Reporter = core.Reporter
+module.exports.core = core

package/lib/extendConfig.js

@@ -1,56 +1,35 @@
-const path = require('path')
-const mkdirp = require('mkdirp')
-
-function addTransports (reporter) {
-  // this condition prevents adding the same transports again.
-  // usually this only happens when testing where there is a
-  // lot of jsreport instances created
-  if (
-    reporter.logger.transports.console ||
-    reporter.logger.transports.file ||
-    reporter.logger.transports.error
-  ) {
-    return
-  }
-
-  const defaultLevel = reporter.options.mode === 'production' ? 'info' : 'debug'
-
-  reporter.options.logger.console = Object.assign({
-    transport: 'console',
-    level: defaultLevel,
-    timestamp: true,
-    colorize: true,
-    handleExceptions: true,
-    humanReadableUnhandledException: true
-  }, reporter.options.logger.console)
-
-  reporter.options.logger.file = Object.assign({
-    transport: 'file',
-    level: defaultLevel,
-    filename: 'logs/reporter.log',
-    maxsize: 10485760,
-    handleExceptions: true,
-    humanReadableUnhandledException: true,
-    json: false
-  }, reporter.options.logger.file)
-
-  reporter.options.logger.error = Object.assign({
-    transport: 'file',
-    level: 'error',
-    filename: 'logs/error.log',
-    handleExceptions: true,
-    humanReadableUnhandledException: true,
-    json: false
-  }, reporter.options.logger.error)
-
-  // winston doesn't create the directories for logs automatically
-  // we don't want to do it for developers as well, but also we want to make jsreport with default config running
-  // without errors, so we break the consistency here and precreate the logs directory if the config equals to default
-  if (reporter.options.logger.file.filename === 'logs/reporter.log' && reporter.options.logger.file.silent !== true) {
-    mkdirp.sync(path.dirname(reporter.options.logger.file.filename))
-  }
-}
-
-module.exports = (reporter) => {
-  addTransports(reporter)
-}
+const { loggerFormat, createDefaultLoggerFormat } = require('@jsreport/jsreport-core')
+const defaultLoggerFormatWithTimestamp = createDefaultLoggerFormat({ timestamp: true })
+
+function addTransports (reporter) {
+  reporter.options.logger.console = Object.assign({
+    transport: 'console',
+    level: 'debug',
+    handleExceptions: true,
+    format: loggerFormat.combine(
+      loggerFormat.colorize(),
+      defaultLoggerFormatWithTimestamp()
+    )
+  }, reporter.options.logger.console)
+
+  reporter.options.logger.file = Object.assign({
+    transport: 'file',
+    level: 'debug',
+    filename: 'logs/reporter.log',
+    maxsize: 10485760,
+    handleExceptions: true
+  }, reporter.options.logger.file)
+
+  reporter.options.logger.error = Object.assign({
+    transport: 'file',
+    level: 'error',
+    filename: 'logs/error.log',
+    handleExceptions: true
+  }, reporter.options.logger.error)
+
+  // nothing else to do here, winston creates the directory specified in file transport .filename automatically
+}
+
+module.exports = (reporter) => {
+  addTransports(reporter)
+}

package/lib/main.js

@@ -1,20 +1,20 @@
-const path = require('path')
-const core = require('jsreport-core')
-const packagejson = require('../package.json')
-const extendConfig = require('./extendConfig')
-
-module.exports = (options, defaults) => {
-  options = options || {}
-
-  const defaultsToUse = Object.assign({}, {
-    discover: true,
-    rootDirectory: path.join(__dirname, '../../../'),
-    loadConfig: true
-  }, defaults)
-
-  const reporter = core(options, defaultsToUse)
-
-  reporter.version = packagejson.version
-
-  return reporter.afterConfigLoaded(extendConfig)
-}
+const path = require('path')
+const core = require('@jsreport/jsreport-core')
+const packageJson = require('../package.json')
+const extendConfig = require('./extendConfig')
+
+module.exports = (options, defaults) => {
+  options = options || {}
+
+  const defaultsToUse = Object.assign({}, {
+    discover: true,
+    rootDirectory: path.join(__dirname, '../../../'),
+    loadConfig: true
+  }, defaults)
+
+  const reporter = core(options, defaultsToUse)
+
+  reporter.version = packageJson.version
+
+  return reporter.afterConfigLoaded(extendConfig)
+}

package/package.json

@@ -1,14 +1,6 @@
 {
   "name": "jsreport",
-  "version": "2.11.0",
-  "author": {
-    "name": "Jan Blaha",
-    "email": "jan.blaha@hotmail.com"
-  },
-  "contributors": [
-    "BJR Matos <bjrmatos@gmail.com> (https://github.com/bjrmatos)",
-    "Jan Blaha"
-  ],
+  "version": "3.0.1",
   "description": "javascript based business reporting",
   "keywords": [
     "report",
@@ -16,97 +8,97 @@
     "javascript"
   ],
   "homepage": "https://github.com/jsreport/jsreport",
+  "bugs": {
+    "url": "https://github.com/jsreport/jsreport/issues"
+  },
   "repository": {
     "type": "git",
     "url": "git@github.com:jsreport/jsreport.git"
   },
-  "standard": {
-    "ignore": [
-      "data/**"
-    ],
-    "globals": [
-      "describe",
-      "it",
-      "beforeEach",
-      "afterEach",
-      "define"
-    ]
+  "license": "LGPL",
+  "author": {
+    "name": "Jan Blaha",
+    "email": "jan.blaha@hotmail.com"
   },
-  "jsreport": {
-    "entryPoint": "server.js"
+  "contributors": [
+    {
+      "name": "BJR Matos",
+      "email": "bjrmatos@gmail.com",
+      "url": "https://github.com/bjrmatos"
+    },
+    {
+      "name": "Jan Blaha"
+    }
+  ],
+  "main": "index.js",
+  "files": [
+    "lib",
+    "index.js",
+    "example.server.js"
+  ],
+  "scripts": {
+    "test": "mocha test --timeout 35000 && standard"
   },
   "dependencies": {
-    "handlebars": "4.7.6",
-    "jsreport-assets": "1.7.0",
-    "jsreport-authentication": "2.6.1",
-    "jsreport-authorization": "2.4.0",
-    "jsreport-base": "2.0.2",
-    "jsreport-browser-client": "2.2.2",
-    "jsreport-child-templates": "1.4.0",
-    "jsreport-chrome-pdf": "1.10.0",
-    "jsreport-cli": "2.2.5",
-    "jsreport-core": "2.10.1",
-    "jsreport-data": "2.4.0",
-    "jsreport-debug": "2.1.3",
-    "jsreport-docx": "2.9.0",
-    "jsreport-express": "2.8.1",
-    "jsreport-freeze": "2.0.0",
-    "jsreport-fs-store": "2.9.1",
-    "jsreport-handlebars": "2.1.0",
-    "jsreport-html-to-xlsx": "2.8.3",
-    "jsreport-import-export": "2.1.1",
-    "jsreport-jsrender": "2.1.1",
-    "jsreport-licensing": "2.2.3",
-    "jsreport-pdf-utils": "1.10.1",
-    "jsreport-pptx": "0.7.0",
-    "jsreport-public-templates": "2.2.0",
-    "jsreport-reports": "2.5.1",
-    "jsreport-resources": "2.1.0",
-    "jsreport-sample-template": "2.6.1",
-    "jsreport-scheduling": "2.5.0",
-    "jsreport-scripts": "2.6.0",
-    "jsreport-static-pdf": "0.4.0",
-    "jsreport-studio": "2.10.1",
-    "jsreport-studio-theme-dark": "0.3.0",
-    "jsreport-tags": "2.5.0",
-    "jsreport-templates": "2.4.0",
-    "jsreport-text": "2.0.0",
-    "jsreport-version-control": "1.6.0",
-    "jsreport-xlsx": "2.5.0",
-    "mkdirp": "0.5.5",
-    "node.extend.without.arrays": "1.1.6",
-    "puppeteer": "2.0.0",
+    "handlebars": "4.7.7",
+    "@jsreport/jsreport-assets": "3.0.0",
+    "@jsreport/jsreport-authentication": "3.0.0",
+    "@jsreport/jsreport-authorization": "3.0.1",
+    "@jsreport/jsreport-base": "3.0.0",
+    "@jsreport/jsreport-browser-client": "3.0.0",
+    "@jsreport/jsreport-child-templates": "3.0.0",
+    "@jsreport/jsreport-chrome-pdf": "3.0.0",
+    "@jsreport/jsreport-cli": "3.0.0",
+    "@jsreport/jsreport-components": "3.0.0",
+    "@jsreport/jsreport-core": "3.0.1",
+    "@jsreport/jsreport-data": "3.0.0",
+    "@jsreport/jsreport-docx": "3.0.0",
+    "@jsreport/jsreport-express": "3.0.0",
+    "@jsreport/jsreport-freeze": "3.0.1",
+    "@jsreport/jsreport-fs-store": "3.0.0",
+    "@jsreport/jsreport-handlebars": "3.0.0",
+    "@jsreport/jsreport-html-to-xlsx": "3.0.0",
+    "@jsreport/jsreport-import-export": "3.0.0",
+    "@jsreport/jsreport-jsrender": "3.0.0",
+    "@jsreport/jsreport-licensing": "3.0.1",
+    "@jsreport/jsreport-localization": "3.0.0",
+    "@jsreport/jsreport-npm": "3.0.1",
+    "@jsreport/jsreport-pdf-utils": "3.0.0",
+    "@jsreport/jsreport-pptx": "3.0.0",
+    "@jsreport/jsreport-public-templates": "3.0.0",
+    "@jsreport/jsreport-reports": "3.0.0",
+    "@jsreport/jsreport-sample-template": "3.0.0",
+    "@jsreport/jsreport-scheduling": "3.0.0",
+    "@jsreport/jsreport-scripts": "3.0.0",
+    "@jsreport/jsreport-static-pdf": "3.0.0",
+    "@jsreport/jsreport-studio": "3.0.0",
+    "@jsreport/jsreport-studio-theme-dark": "3.0.0",
+    "@jsreport/jsreport-tags": "3.0.0",
+    "@jsreport/jsreport-text": "3.0.0",
+    "@jsreport/jsreport-version-control": "3.0.0",
+    "@jsreport/jsreport-xlsx": "3.0.0",
+    "puppeteer": "10.4.0",
     "semver": "6.3.0"
   },
   "devDependencies": {
-    "archiver": "3.0.0",
-    "cross-env": "5.2.1",
-    "eslint": "5.16.0",
-    "eslint-config-standard": "12.0.0",
-    "eslint-config-standard-react": "7.0.2",
-    "in-publish": "2.0.1",
-    "jsreport-compile": "2.5.1",
-    "jsreport-puppeteer-compile": "1.2.2",
     "mocha": "6.2.0",
-    "npm-run-all": "4.1.5",
-    "rimraf": "2.6.3",
     "should": "13.2.3",
-    "standard": "12.0.1"
-  },
-  "scripts": {
-    "test": "mocha test --timeout 35000 && standard",
-    "compile": "node compile.js",
-    "start": "node server.js"
+    "standard": "16.0.3"
   },
   "engines": {
-    "node": ">=8.9"
+    "node": ">=16.11"
   },
-  "main": "index.js",
-  "license": "LGPL",
-  "files": [
-    "lib",
-    "index.js",
-    "config.md",
-    "example.server.js"
-  ]
+  "jsreport": {
+    "entryPoint": "server.js"
+  },
+  "standard": {
+    "ignore": [
+      "data/**"
+    ],
+    "env": {
+      "mocha": true,
+      "browser": true,
+      "node": true
+    }
+  }
 }