cob-cli 2.25.0 → 2.27.1

package/README.Development.md

@@ -1,294 +0,0 @@
-# Templates
-
-Mainly for `cob-cli customize` purposes, the `templates` directory has all necessary files to customize a CoB application in standard/predefined ways.
-
----
-## cob-dashboard-template
-
-These are the base files needed to have our recomend dashboard infra-structure. It's preconfigured with **vue**, **vuetify** , **@cob/rest-api-wrapper** and **@cob/dashboard-info** dependencies.
-
-The steps necessary to achieve this final configuration are the following:
-
-### 1. `vue create cob-dashboard-template` 
-
-   The only option to select is *use version 2* of vue, ie, no babel, no lint, no test, etc.
-
-   From the resulting directory we will only use 1 file, `package.json`.
-
-   In 2021.04.14 the result was:
-```json
-{
-  "name": "cob-dashboard-template",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build"
-  },
-  "dependencies": {
-    "vue": "^2.6.11"
-  },
-  "devDependencies": {
-    "@vue/cli-service": "~4.5.0",
-    "vue-template-compiler": "^2.6.11"
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not dead"
-  ]
-}
-```
-
-
-### 2. `vue add vuetify`
-
-   The choosen options were:
-```
-? Choose a preset: Configure (advanced)
-? Use a pre-made template? (will replace App.vue and HelloWorld.vue) Yes
-? Use custom theme? No
-? Use custom properties (CSS variables)? No
-? Select icon font Material Design Icons
-? Use fonts as a dependency (for Electron or offline)? No
-? Use a-la-carte components? No
-? Use babel/polyfill? No
-? Select locale English
-```
-   This command will add the following lines to `package.json`
-
-```json
-"vuetify": "^2.4.0"
-"vue-cli-plugin-vuetify": "~2.3.1",
-```
-with the following end result
-```json 
-{
-  "name": "cob-dashboard-template",
-  "version": "0.1.0",
-  "private": true,
-  "scripts": {
-    "serve": "vue-cli-service serve",
-    "build": "vue-cli-service build"
-  },
-  "dependencies": {
-    "vue": "^2.6.11",
-    "vuetify": "^2.4.0"
-  },
-  "devDependencies": {
-    "@vue/cli-service": "~4.5.0",
-    "vue-cli-plugin-vuetify": "~2.3.1",
-    "vue-template-compiler": "^2.6.11"
-  },
-  "browserslist": [
-    "> 1%",
-    "last 2 versions",
-    "not dead",
-    "not ie <= 10"
-  ]
-}
-```
-
-Two other files are relevant for the end result:
-
-`src/main.js`
-```javascript
-import Vue from 'vue'
-import App from './App.vue'
-import vuetify from './plugins/vuetify';
-
-Vue.config.productionTip = false
-
-new Vue({
-  vuetify,
-  render: function (h) { return h(App) }
-}).$mount('#app')
-```
-
-`src/plugins/vuetify.js`
-```javascript
-import Vue from 'vue';
-import Vuetify from 'vuetify';
-import 'vuetify/dist/vuetify.min.css';
-
-Vue.use(Vuetify);
-
-export default new Vuetify({
-});
-```
-
-### 3. Delete all files irrelevant files
-For our app we only need the files we specified above (`package.json`, `src/main.js` and `src/plugins/vuetify.js`)
-
-### 4. Add the cob dependencies
-```
-npm i --save @cob/rest-api-wrapper
-npm i --save @cob/dashboard-info
-npm i --save @cob/ui-vue-components
-```
-
-This adds the following lines to `package.json` (in 2021.04.14):
-```json
-  "dependencies": {
-    "@cob/dashboard-info": "^2.2.5",
-    "@cob/rest-api-wrapper": "^2.1.6",
-    "@cob/ui-vue-components": "^4.1.0",
-```
-`@cob/ui-vue-components` needs to be loaded by vue. For this add `src/plugins/cobUiVueComponents.js` and change `src/main.js`:
-
-`src/plugins/cobUiVueComponents.js`
-```javascript
-import Vue from 'vue';
-import CobUiVueComponents from '@cob/ui-vue-components';
-
-Vue.use(CobUiVueComponents);
-
-export default CobUiVueComponents
-```
-
-`src/main.js`
-```javascript
-import Vue from 'vue'
-import App from './App.vue'
-import vuetify from './plugins/vuetify';
-import cobUiVueComponents from './plugins/cobUiVueComponents';
-
-Vue.config.productionTip = false
-
-new Vue({
-  vuetify,
-  cobUiVueComponents,
-  render: function (h) { return h(App) }
-}).$mount('#app')
-```
-
-### 5. Add an `App.vue` example
-A simple page that uses all libs and adds a splash screen with the relevant links.
-```html
-<template>
-  <v-app>
-    <v-main>
-      <HelloWorld 
-        :msg='"Welcome " + userInfo.username'
-        :extraInfo='domainCount.value  ? "(your domain 1 has " + domainCount.value + " instances)" : "(no backend info)"'
-      />
-    </v-main>
-  </v-app>
-</template>
-
-<script>
-import { umLoggedin } from '@cob/rest-api-wrapper';
-import { domainCount } from '@cob/dashboard-info';
-
-export default {
-  name: 'App',
-  data: () => ({
-      userInfo   : {},
-      domainCount: domainCount(1),
-  }),
-  created() {
-      umLoggedin().then( userInfo => this.userInfo = userInfo )
-  }
-};
-</script>
-```
-
-### 6. Add webpack configuration
-To run any (known) vue aplication in a CoB server there are only two files necessary to add to an existing vue project:
-* `vue.config.js` - this file is the vue version os `webpack.config.js` and it has 2 purposes: 
-  1. serve a version of the app with hot-reload, during development. 
-  
-      You can start serving the app directly on the app directory, using `npm run serve`, or on the top cob-cli project directory, with `cob-cli test -d <app dir name>`. This file will support both methods and will get the server to proxy the requests to from the top directory `.server` file. If this file is not present the `learning.cultofbits.com` server will be used.
-
-      The entry point is the `http://localhost:8041/<app dir name>/dashboard.html` and all requests for `/<app dir name>/**` will be served locally. All CoB urls will be proxied to the specified server.
-
-  1. build the files necessary to deploy the aplication to production
-
-      The build process is done by `npm run build` and it will produce in `./dist` all the files that need to be copied to the server (which will be done by `cob-cli deploy`).
-
-      While being executed this code will also set a `rmIntegrated` variable that flags if it's building the final files or serving the files (to be usedby the `dashboard.html`). 
-
-* `src/dashboard.html` 
-
-  because CoB servers will look at a `#/cob.custom-resource/<...>/<dashboard name>` URL and try to load `/recordm/localresource/<dashboard name>/dist/dashboard.html` this file will suport both be built for that purpose and, simultaneasly, be served locally, with the extra HTML necessary tags.
-
-  It will produce an output for serving localy or production based on the `rmIntegrated` webpack variable.
-
-### 7. Test the end result
-After these steps you can:
-```
-$ cd templates/cob-dashboard-template
-$ npm i 
-$ npm run serve
-```
-it will use the `learning.cultofbits.com` site as backend and display the inteded example.
-
-
-
-# Debugging
- Using VSCode you can debug the command line behaviour. The file `.vscode/launch.json` has the commands and arguments that will be used. Note that the `cob-cli` command will run on the on the directories specified in this file.
-
-# TODO:
-   * Support manual mode deploy (basically the copy intructions and a deploy process script)
-   * Consider adding autocomplete to cob-cli (see package [commander-auto-complete](https://www.npmjs.com/package/commander-auto-complete)), specifically:
-      > _If you want this done automatically for you, you could add that script to npm lifecycle hooks_
-
-
-# References:
-
-## Packages 
-   * Used:
-      * https://www.npmjs.com/package/commander
-      * https://www.npmjs.com/package/inquirer
-      * https://www.npmjs.com/package/listr
-      * https://www.npmjs.com/package/simple-git
-      * https://www.npmjs.com/package/execa
-      * https://www.npmjs.com/package/fs-extra
-
-   * Potentials:
-      * https://www.npmjs.com/package/copy-template-dir
-      * https://www.npmjs.com/package/commander-auto-complete
-
-## About npm cli
-   * Base info about adding node cmds to path environment :
-      * https://medium.com/@thatisuday/creating-cli-executable-global-npm-module-5ef734febe32
-   * Additional info about supporting multiple commands and parsing arguments: 
-      * https://itnext.io/making-cli-app-with-ease-using-commander-js-and-inquirer-js-f3bbd52977ac
-   * About inquirer e listr
-      * https://www.twilio.com/blog/how-to-build-a-cli-with-node-js
-   * NPM package publishing: 
-      * https://zellwk.com/blog/publish-to-npm/
-   * Others:
-      * https://www.sitepoint.com/javascript-command-line-interface-cli-node-js/
-      * https://www.keithcirkel.co.uk/how-to-use-npm-as-a-build-tool/
-      * https://nodesource.com/blog/node-js-powerful-beautiful-clis
-
-## About using commit messages to manage semantic-release:
-   * https://www.conventionalcommits.org/en/v1.0.0/
-   * https://github.com/semantic-release/semantic-release
-   * https://github.com/semantic-release/semantic-release/blob/master/docs/extending/plugins-list.md
-   * https://github.com/oleg-koval/semantic-release-npm-github-publish (from [Shareable configurations list](https://github.com/semantic-release/semantic-release/blob/master/docs/extending/shareable-configurations-list.md))
-   * https://marketplace.visualstudio.com/items?itemName=vivaxy.vscode-conventional-commits
-   * https://blog.usejournal.com/semantic-release-with-nodejs-full-gitlab-ci-flow-dfee9639f20f
-
-## About using git for production deployments
-   * About deploys: 
-      * https://dev.to/becodeorg/deploy-an-application-automatically-using-github-hooks-50fd
-      * https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks
-      * https://devcenter.heroku.com/articles/git
-      * https://wpengine.com/support/git/
-      * https://wpengine.com/support/deploying-code-with-bitbucket-pipelines-wp-engine/
-      * https://security.stackexchange.com/questions/45452/is-using-git-for-deploying-a-bad-practice
-      * https://www.git-scm.com/docs/githooks
-   * Proposed git Workflow: 
-      * https://githubflow.github.io (in contrast with https://nvie.com/posts/a-successful-git-branching-model/)
-      * https://gist.github.com/cjsteel/5bdab49c97ecacb67904056ccdcb956d
-
-## Improving vue boilerplate
- * https://gitlab.com/cob/vue-cli-preset
- * https://gitlab.com/cob/solutions-template
- * https://gitlab.com/cob/vue-cli-plugin-dashboard
- * https://medium.com/justfrontendthings/how-to-create-and-publish-your-own-vuejs-component-library-on-npm-using-vue-cli-28e60943eed3
- * https://cli.vuejs.org/dev-guide/plugin-dev.html#discoverability
- * https://javascript.info/promise-chaining#tasks
- * https://github.com/vuejs/vue-cli/tree/9c1e797ac6c25b5827403693e018eb199300d067/packages/%40vue/cli-service/generator/template/src

package/README.publish.md

@@ -1,10 +0,0 @@
-Para avançar a versão e publicar:
-
-`npm version [<newversion> | major | minor | patch | premajor | preminor | prepatch | prerelease | from-git]`
-
-Exemplo:
-```
-npm version patch
-git push
-npm publish
-```

package/customizations/backend.email.js

@@ -1,10 +0,0 @@
-exports.option = {
-  name: 'Send an email after something happens (https://learning.cultofbits.com)', 
-  short: "Send Email",
-  questions: [
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion
-  ],
-  customization: function (answers) {
-      console.log("TODO - SendEmail:" + JSON.stringify(answers, null, '  '));
-  }
-}

package/customizations/backend.js

@@ -1,14 +0,0 @@
-exports.option = {
-  name: 'Backend - Add a server event based behaviour (https://learning.cultofbits.com)', 
-  short: "Backend",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Select one?',
-    choices: [
-        require("./backend.vuepress").option,
-        require("./backend.email").option,
-        require("./backend.updateField").option
-    ]}
-  ]
-}

package/customizations/backend.updateField.js

@@ -1,11 +0,0 @@
-exports.option = {
-  name: 'Update a field (https://learning.cultofbits.com)', 
-  short: "Update",
-  questions: [
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion,
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion2
-  ],
-  customization: function (answers) {
-      console.log("TODO - updateField:" + JSON.stringify(answers, null, '  '));
-  }
-}

package/customizations/backend.vuepress.js

@@ -1,35 +0,0 @@
-exports.option = { 
-    name: 'Vuepress - Recordm based CMS ', 
-    short: "Dash",
-    questions: [
-    ],
-    customization: async function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        await copy("../../templates/backend/vuepress/others/vuepress/","./others/vuepress/")
-        await copy("../../templates/backend/vuepress/integrationm/actions/","./integrationm/actions/")
-        //TODO: ln -s /opt/others/vuepress/nginx/dist/ /usr/share/nginx/html/docs
-        //TODO: create/update definition (original na learning)
-        //TODO: create/update permissions
-        //TODO: criar instância .site. e .site.home.
-        //TODO: perguntar id da definição de conteúdo e substituir onde necessário (actions e References.vue e graph.vue)
-        //TODO: deploy (to have content actions)
-        //TODO: indicar que é necessário configurar o ./other/vuepress/config.json
-        //TODO: indicar que é necessário configurar o ./other/vuepress/config.js
-        //TODO: build 
-        //TODO: deploy
-        /*
-        Sequência:
-            1. cob-cli customize backend.vuepress 
-            2. git add .; git commit -m “chore: cob-cli customize backend.vuepress"
-            2. cob-cli deploy
-            2. ln -s /opt/others/vuepress/nginx/dist/ /usr/share/nginx/html/docs (na máquina)
-            3. install Contents definition
-            4. add permissions
-            5. config server.json
-            6. create contents:
-                 .site.
-                 .site.home. 
-                 .site.home.sitemap
-        */
-    }
-}

package/customizations/dashboard.dash.js

@@ -1,14 +0,0 @@
-exports.option = { 
-    name: 'Dash - Dynamic Dashboard based on instances from a specific definition', 
-    short: "Dash",
-    questions: [
-    ],
-    customization: async function (answers) {
-        console.log("\nApplying Dash keyword customizations ...")
-
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const  target = "./recordm/customUI/dash/"
-        await copy("../../templates/dashboards/dash/",target)
-        return require("../templates/dashboards/dash/package.json").version
-    }
-}

package/customizations/dashboard.js

@@ -1,14 +0,0 @@
-exports.option = {
-  name: 'Dashboards - Create or change dashboards (https://learning.cultofbits.com)', 
-  short: "Dashboards",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Which type of dashboard?',
-    choices: [
-        require("./dashboard.dash").option,
-        require("./dashboard.simple").option,
-        require("./dashboard.vue").option
-    ]}
-  ]
-}

package/customizations/dashboard.simple.js

@@ -1,12 +0,0 @@
-exports.option = { 
-    name: 'Simple - Just HTML code and cob libs', 
-    short: "Simple",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const  target = "./recordm/customUI/"+answers.name+".html"
-        return copy("../../templates/dashboards/cob-dashboard-html/demoDashboard.html",target)
-    }
-}

package/customizations/dashboard.vue.empty.js

@@ -1,12 +0,0 @@
-exports.option = { 
-    name: 'Simple - basic files to start from scratch', 
-    short: "Simple",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        const { copy } = require("../lib/task_lists/customize_copy");
-        const target = "./recordm/customUI/"+answers.name+"/"
-        return copy("../../templates/dashboard/cob-dashboard-vue/",target)
-    }
-}

package/customizations/dashboard.vue.grid.js

@@ -1,10 +0,0 @@
-exports.option = { 
-    name: "Grid - simple grid structure", 
-    short: "Grid",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        console.log("TODO - vueGrid:" + JSON.stringify(answers, null, '  '));
-    }
-}

package/customizations/dashboard.vue.js

@@ -1,14 +0,0 @@
-exports.option = { 
-  name: 'Vue - Vue + Vuetify + cob libs', 
-  short: "Vue",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Which template do you want to start with?',
-    choices: [
-      require("./dashboard.vue.empty").option,
-      require("./dashboard.vue.grid").option,
-      require("./dashboard.vue.menuAndGrid").option,
-    ]}
-  ]
-}

package/customizations/dashboard.vue.menuAndGrid.js

@@ -1,10 +0,0 @@
-exports.option = { 
-    name: "Menu+Grid - menu column and simple grid structure", 
-    short: "GrMenu+Gridid",
-    questions: [
-        require("../lib/task_lists/customize_questions").dashboardNameQuestion
-    ],
-    customization: function (answers) {
-        console.log("TODO - vueMenuGrid:" + JSON.stringify(answers, null, '  '));
-    }
-}

package/customizations/frontend.common.js

@@ -1,16 +0,0 @@
-exports.option = {
-  name: 'Common - Typical frontend customizations (https://learning.cultofbits.com)', 
-  short: "Common",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying common frontend customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      const target = "./recordm/customUI/"
-      await copy("../../templates/frontend/common/",target)
-      await mergeFiles("Frontend.Common")
-      return require("../templates/frontend/common/package.json").version
-  }
-}

package/customizations/frontend.easy.js

@@ -1,16 +0,0 @@
-exports.option = {
-  name: 'Easy - Permission management helper', 
-  short: "Easy",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying easy customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      await copy("../../templates/frontend/easy/webapp/", "./userm/customUI/easy/")
-      await copy("../../templates/frontend/easy/css/", "./userm/customUI/css/")
-      await copy("../../templates/frontend/easy/js/", "./userm/customUI/js/")
-      await mergeFiles("Frontend.Easy")
-  }
-}

package/customizations/frontend.formatList.currency.js

@@ -1,17 +0,0 @@
-exports.option = { 
-  name: 'FormatCurrency - Make $style[currency] available on definitions', 
-  short: "Simple",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying FormatCurrency frontend customizations ...")
-      
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      
-      const target = "./recordm/customUI/"
-      await copy("../../templates/frontend/formatList/currency/",target)
-      await mergeFiles("frontend.formatList.currency.js")
-      return require("../templates/frontend/formatList/currency/package.json").version
-  }
-}

package/customizations/frontend.formatList.js

@@ -1,13 +0,0 @@
-exports.option = {
-  name: 'FormatList - Add classes to change the style of specified columns in search results', 
-  short: "FormatList",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Select one?',
-    choices: [
-        require("./frontend.formatList.currency").option//,
-        // require("./frontend.formatList.percentage").option
-    ]}
-  ]
-}

package/customizations/frontend.js

@@ -1,14 +0,0 @@
-exports.option = {
-  name: 'Frontend - Change behaviour of standard interface (https://learning.cultofbits.com)', 
-  short: "Frontend",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Select one?',
-    choices: [
-        require("./frontend.common").option,
-        require("./frontend.easy").option,
-        require("./frontend.formatList").option
-    ]}
-  ]
-}

package/customizations/importer.js

@@ -1,10 +0,0 @@
-exports.option = {
-  name: 'Importer - Add a server event based behaviour (https://learning.cultofbits.com)', 
-  short: "Backend",
-  questions: [
-    require("../lib/task_lists/customize_questions").dashboardNameQuestion
-  ],
-  customization: function (answers) {
-    console.log("TODO - importer:" + JSON.stringify(answers, null, '  '));
-  }
-}

package/customizations/keywords.audit.js

@@ -1,18 +0,0 @@
-exports.option = {
-  name: 'Audit - Allows for $user in definitions (https://learning.cultofbits.com/docs/cob-platform/admins/managing-information/available-customizations/audit/)', 
-  short: "Audit",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying Audit keyword customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      const fe_target = "./recordm/customUI/"
-      await copy("../../templates/keywords/audit/frontend",fe_target)
-      const be_target = "./integrationm/"
-      await copy("../../templates/keywords/audit/backend",be_target)
-      await mergeFiles("Keyword.Audit")
-      return require("../templates/keywords/audit/package.json").version
-  }
-}

package/customizations/keywords.calc.js

@@ -1,18 +0,0 @@
-exports.option = {
-  name: 'Calc - Allows for $calc in definitions (https://learning.cultofbits.com)', 
-  short: "Calc",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying Calc keyword customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      const fe_target = "./recordm/customUI/"
-      await copy("../../templates/keywords/calc/frontend",fe_target)
-      const be_target = "./integrationm/"
-      await copy("../../templates/keywords/calc/backend/",be_target)
-      await mergeFiles("Keyword.Calc")
-      return require("../templates/keywords/calc/package.json").version
-  }
-}

package/customizations/keywords.image.js

@@ -1,16 +0,0 @@
-exports.option = {
-  name: 'Image - Allows for $image[.replace|.add][(width)]', 
-  short: "Image",
-  questions: [
-  ],
-  customization: async function (answers) {
-      console.log("\nApplying Image keyword customizations ...")
-
-      const { copy } = require("../lib/task_lists/customize_copy");
-      const { mergeFiles } = require("../lib/task_lists/customize_mergeFiles");
-      const fe_target = "./recordm/customUI/"
-      await copy("../../templates/keywords/image/frontend",fe_target)
-      await mergeFiles("Keyword.Image")
-      return require("../templates/keywords/image/package.json").version
-  }
-}

package/customizations/keywords.js

@@ -1,17 +0,0 @@
-exports.option = {
-  name: 'Keywords - Add a keyword for use in definitions (https://learning.cultofbits.com/docs/cob-platform/admins/managing-information/available-customizations/)', 
-  short: "Keywords",
-  followUp: [ {
-    type: 'list',
-    name: 'choosenFollowUp',
-    message: 'Select one?',
-    choices: [
-        require("./keywords.calc").option,
-        require("./keywords.audit").option,
-        require("./keywords.styleResults").option,
-        require("./keywords.image").option,
-        require("./keywords.kibana").option,
-        require("./keywords.log").option
-    ]}
-  ]
-}