@nebula.js/cli-sense 2.0.0-beta.1

package/CHANGELOG.md

@@ -0,0 +1,87 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+# [2.0.0-beta.1](https://github.com/qlik-oss/nebula.js/compare/v1.7.0...v2.0.0-beta.1) (2021-09-21)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [1.7.0](https://github.com/qlik-oss/nebula.js/compare/v1.6.0...v1.7.0) (2021-08-24)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [1.6.0](https://github.com/qlik-oss/nebula.js/compare/v1.5.0...v1.6.0) (2021-08-16)
+
+### Bug Fixes
+
+- use same event in extensionwrapper ([#651](https://github.com/qlik-oss/nebula.js/issues/651)) ([f70c575](https://github.com/qlik-oss/nebula.js/commit/f70c575ecab3916e89bd4d5dbc7c5b76b1afe11e))
+- **extension-wrapper:** support paths argument in begin ([#639](https://github.com/qlik-oss/nebula.js/issues/639)) ([dbf7ea9](https://github.com/qlik-oss/nebula.js/commit/dbf7ea97ecec73c00d7a1e1a3d49ec57806cd763))
+- add isModal for sense legacy extension ([#637](https://github.com/qlik-oss/nebula.js/issues/637)) ([54171df](https://github.com/qlik-oss/nebula.js/commit/54171dfed03f42d71d825127104090777a38fe53))
+- **cli-sense:** apply default when using javascript api ([#633](https://github.com/qlik-oss/nebula.js/issues/633)) ([8eded30](https://github.com/qlik-oss/nebula.js/commit/8eded3055e2074a1ff718af69920f0eea0ea6462))
+
+### Features
+
+- switch --partial to default and add --legacy option ([#632](https://github.com/qlik-oss/nebula.js/issues/632)) ([6381cf6](https://github.com/qlik-oss/nebula.js/commit/6381cf6e796787823b888c08dae33342ca6606c7))
+
+# [1.5.0](https://github.com/qlik-oss/nebula.js/compare/v1.4.0...v1.5.0) (2021-07-01)
+
+### Features
+
+- update build and build legacy for nebula sense ([#627](https://github.com/qlik-oss/nebula.js/issues/627)) ([da61276](https://github.com/qlik-oss/nebula.js/commit/da61276431d3356aca98781a4be736251d08e384))
+
+# [1.4.0](https://github.com/qlik-oss/nebula.js/compare/v1.3.0...v1.4.0) (2021-06-28)
+
+### Bug Fixes
+
+- **deps:** update dependency fs-extra to v10 ([#616](https://github.com/qlik-oss/nebula.js/issues/616)) ([73bf35f](https://github.com/qlik-oss/nebula.js/commit/73bf35f53f1882f89207a1215c35fc3c59f9c35a))
+
+# [1.2.0](https://github.com/qlik-oss/nebula.js/compare/v1.1.1...v1.2.0) (2021-05-12)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+## [1.1.1](https://github.com/qlik-oss/nebula.js/compare/v1.1.0...v1.1.1) (2021-04-19)
+
+### Features
+
+- add device type ([#587](https://github.com/qlik-oss/nebula.js/issues/587)) ([f6e1ead](https://github.com/qlik-oss/nebula.js/commit/f6e1ead7e14f029b1f78fa354fb98b2e089b52a9))
+
+# [1.1.0](https://github.com/qlik-oss/nebula.js/compare/v1.1.0-alpha0...v1.1.0) (2021-02-01)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [1.1.0-alpha0](https://github.com/qlik-oss/nebula.js/compare/v1.0.2-alpha.1...v1.1.0-alpha0) (2021-01-21)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+## [1.0.2-alpha.1](https://github.com/qlik-oss/nebula.js/compare/v1.0.2-alpha.0...v1.0.2-alpha.1) (2020-12-04)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+## [1.0.1](https://github.com/qlik-oss/nebula.js/compare/v1.0.0...v1.0.1) (2020-06-22)
+
+### Bug Fixes
+
+- **cli-sense:** do not remove target dir ([#451](https://github.com/qlik-oss/nebula.js/issues/451)) ([0f5432e](https://github.com/qlik-oss/nebula.js/commit/0f5432e))
+
+# [1.0.0](https://github.com/qlik-oss/nebula.js/compare/v1.0.0-alpha.0...v1.0.0) (2020-06-09)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [1.0.0-alpha.0](https://github.com/qlik-oss/nebula.js/compare/v0.6.1...v1.0.0-alpha.0) (2020-06-09)
+
+### Features
+
+- **cli-sense:** build for legacy Sense ([#438](https://github.com/qlik-oss/nebula.js/issues/438)) ([5485eab](https://github.com/qlik-oss/nebula.js/commit/5485eab))
+
+# [0.5.0](https://github.com/qlik-oss/nebula.js/compare/v0.4.0...v0.5.0) (2020-04-20)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [0.4.0](https://github.com/qlik-oss/nebula.js/compare/v0.3.0...v0.4.0) (2020-04-02)
+
+**Note:** Version bump only for package @nebula.js/cli-sense
+
+# [0.3.0](https://github.com/qlik-oss/nebula.js/compare/v0.2.1...v0.3.0) (2020-03-30)
+
+**Note:** Version bump only for package @nebula.js/cli-sense

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License
+
+Copyright (c) 2019-present QlikTech International AB
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,143 @@
+# @nebula.js/cli-sense
+
+The `nebula sense` command builds a nebula visualization so that it can be used as an extension in Qlik Sense.
+
+## Install
+
+```sh
+npm install @nebula.js/cli
+```
+
+## Usage
+
+```sh
+nebula sense
+
+Build a nebula visualization as a Qlik Sense extension
+
+Options:
+  --version    Show version number                                     [boolean]
+  --ext        Extension definition                                     [string]
+  --meta       Extension meta information                               [string]
+  --output     Destination directory            [string] [default: "<name>-ext"]
+  --minify     Minify and uglify code                  [boolean] [default: true]
+  --sourcemap  Generate sourcemaps                    [boolean] [default: false]
+  --legacy     Generate legacy extension              [boolean] [default: false]
+  -h, --help   Show help                                               [boolean]
+```
+
+## Example
+
+### EXT
+
+You can set property panel definition and feature supprts by creating a separate file for the extension info and providing it as argument to `--ext`:
+
+Create a file called def.js and add the following:
+
+```js
+// def.js
+export default {
+  definition: {
+    // Property panel definition
+  },
+  support: {
+    export: true,
+    exportData: true,
+    snapshot: true,
+    viewData: true,
+  },
+  importProperties: null,
+  exportProperties: null,
+};
+```
+
+Run the command:
+
+```bash
+nebula sense --ext def.js
+```
+
+Note:
+Using the --ext option will overwrite any ext definition already presented on the chart, its main purpose is to support legacy option below.
+
+### Meta
+
+You can improve meta info about the extension, such as extension name, extension
+icon, and description by providing a `.json` formatted file and supply that filename
+as an argument to the `nebula sense` command with `--meta` option.
+
+Create a file called meta.json and add the following code demonstrating an example
+to set the extension meta information:
+
+```json
+{
+  "name": "My tasty banana extension",
+  "icon": "barchart",
+  "description": "Nebula test table wrapped in a Qlik Sense extension"
+}
+```
+
+Run the command:
+
+```bash
+nebula sense --meta meta.json
+```
+
+The meta data will be ended up in the `.qext` file used by the Qlik Sense.
+
+Copy the updated `your-chart-ext` directory to your `Extension` directory,
+overwriting the old version. Then the meta data of the extension has been changed.
+
+The rest of the required information is populated automatically based on the content in `package.json`.
+
+### Output
+
+Generate all required files into the specified `--output` folder called sn-table-ext:
+
+```bash
+nebula sense --output sn-table-ext
+```
+
+You can upload that folder as an extension on [Qlik Sense Enterprise for Windows](https://help.qlik.com/en-US/sense-developer/August2021/Subsystems/Extensions/Content/Sense_Extensions/Howtos/deploy-extensions.htm) or [SaaS editions of Qlik Sense](https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/Admin/mc-extensions.htm)
+
+### QEXT
+
+Running nebula sense generates a `QEXT` file for you, which is
+required for loading the visualization into sense.
+
+The `QEXT` file can also be manually created by yourself.
+Create a file called `your-extension-name.qext` and add the following code as an
+example:
+
+```json
+{
+  "name": "your-extension-name",
+  "version": "0.1.0",
+  "description": "",
+  "author": {
+    "name": "",
+    "email": ""
+  },
+  "icon": "extension",
+  "type": "visualization",
+  "supernova": true
+}
+```
+
+The `"supernova": true` attribute should not be added when building with the
+--legacy option below.
+
+### Legacy
+
+Qlik Sense before 2020 does not support nebula supernova natively, so a special
+build path is needed for visualizations to load properly in the client.
+For this purpose, use the --legacy option.
+
+```bash
+nebula sense --legacy
+```
+
+You can find that the generated `QEXT` file does not include `supernova: true`.
+
+Note:
+For old Qlik Sense, not all features of extension are presented.

package/command.js

@@ -0,0 +1,13 @@
+const init = require('./lib/init-config');
+const sense = require('./lib/sense');
+
+module.exports = {
+  command: 'sense',
+  desc: 'Build a nebula visualization as a Qlik Sense extension',
+  builder(yargs) {
+    init(yargs);
+  },
+  handler(argv) {
+    sense(argv);
+  },
+};

package/lib/api-entry.js

@@ -0,0 +1,11 @@
+const extend = require('extend');
+const yargs = require('yargs');
+const initConfig = require('./init-config');
+const sense = require('./sense');
+
+module.exports = (argv) => {
+  // not runnning via command line, run the config to inject default values
+  const defaultBuildConfig = initConfig(yargs([])).argv;
+  const senseConfig = extend(true, {}, defaultBuildConfig, argv);
+  sense(senseConfig);
+};

package/lib/build-legacy.js

@@ -0,0 +1,115 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+const rollup = require('rollup');
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+const common = require('@rollup/plugin-commonjs');
+const replace = require('@rollup/plugin-replace');
+const babel = require('rollup-plugin-babel');
+const { terser } = require('rollup-plugin-terser');
+
+async function build(argv) {
+  const cwd = process.cwd();
+
+  const supernovaPkg = require(path.resolve(cwd, 'package.json')); // eslint-disable-line
+
+  let extName = supernovaPkg.name.split('/').reverse()[0];
+
+  const { main } = supernovaPkg;
+
+  if (extName === main) {
+    extName = extName.replace(/\.js$/, '-ext.js');
+  }
+
+  const targetDir = argv.output !== '<name>-ext' ? argv.output : `${extName}-ext`;
+  const qextLegacyTargetDir = path.resolve(cwd, targetDir);
+  const qextFileName = path.resolve(qextLegacyTargetDir, `${extName}.qext`);
+  const qextFileNameJs = qextFileName.replace(/\.qext$/, '.js');
+
+  const extDefinition = argv.ext ? path.resolve(argv.ext) : '';
+
+  const relativeMainFile = `./${main.replace(/\.js$/, '')}`;
+
+  async function moveSnBundle() {
+    const code = await fs.readFile(path.resolve(cwd, main), { encoding: 'utf8' });
+    const replacedCode = code.replace(/@nebula.js\/stardust/g, '../nlib/@nebula.js/stardust/dist/stardust');
+
+    await fs.outputFile(path.resolve(qextLegacyTargetDir, main), replacedCode);
+  }
+
+  async function moveResources() {
+    await fs.copy(
+      path.resolve(path.dirname(require.resolve('@nebula.js/stardust')), 'dist'),
+      path.resolve(qextLegacyTargetDir, 'nlib/@nebula.js/stardust/dist')
+    );
+  }
+
+  async function createQextFiles() {
+    const qext = supernovaPkg.qext || {};
+    if (argv.meta) {
+      const meta = require(path.resolve(cwd, argv.meta)); // eslint-disable-line
+      Object.assign(qext, meta);
+    }
+    const contents = {
+      name: qext.name || extName,
+      version: supernovaPkg.version,
+      description: supernovaPkg.description,
+      author: supernovaPkg.author,
+      icon: qext.icon || 'extension',
+      preview: qext.preview,
+      type: 'visualization',
+    };
+
+    await fs.writeFile(qextFileName, JSON.stringify(contents, null, 2));
+  }
+
+  async function wrapIt() {
+    const bundle = await rollup.rollup({
+      input: path.resolve(__dirname, '../src/legacy/sn-ext.js'),
+      external: ['translator', 'qlik', './nlib/@nebula.js/stardust/dist/stardust', relativeMainFile],
+      plugins: [
+        replace({
+          __SN_DEF__: `${relativeMainFile}`,
+          __EXT_DEF__: `${extDefinition.replace(/\\/g, '/')}`,
+          preventAssignment: true,
+        }),
+        nodeResolve(),
+        common(),
+        babel({
+          babelrc: false,
+          exclude: [/node_modules/],
+          presets: [
+            [
+              '@babel/preset-env',
+              {
+                modules: false,
+                targets: {
+                  browsers: ['ie 11', 'chrome 47'],
+                },
+              },
+            ],
+          ],
+        }),
+        argv.minify &&
+          terser({
+            output: {
+              comments: /@license|@preserve|Copyright|license/,
+            },
+          }),
+      ],
+    });
+
+    await bundle.write({
+      file: qextFileNameJs,
+      format: 'amd',
+      sourcemap: argv.sourcemap,
+    });
+  }
+
+  await moveSnBundle();
+  await moveResources();
+  await wrapIt();
+  await createQextFiles();
+}
+
+module.exports = build;

package/lib/build.js

@@ -0,0 +1,121 @@
+const path = require('path');
+const fs = require('fs-extra');
+
+const rollup = require('rollup');
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+const common = require('@rollup/plugin-commonjs');
+const babel = require('rollup-plugin-babel');
+const { terser } = require('rollup-plugin-terser');
+
+async function build(argv) {
+  const cwd = process.cwd();
+
+  const supernovaPkg = require(path.resolve(cwd, 'package.json')); // eslint-disable-line
+
+  let extName = supernovaPkg.name.split('/').reverse()[0]; // replace(/\//, '-').replace('@', '');
+
+  const { main } = supernovaPkg;
+
+  if (extName === main) {
+    extName = extName.replace(/\.js$/, '-ext.js');
+  }
+  const { sourcemap } = argv;
+  const targetDir = argv.output !== '<name>-ext' ? argv.output : `${extName}-ext`;
+  const targetFile = 'ext';
+  const qextLegacyTargetDir = path.resolve(cwd, targetDir);
+  const qextFileName = path.resolve(qextLegacyTargetDir, `${extName}.qext`);
+  const qextFileNameJs = qextFileName.replace(/\.qext$/, '.js');
+
+  const extDefinition = argv.ext ? path.resolve(argv.ext) : undefined;
+
+  const createQextFiles = () => {
+    const qext = supernovaPkg.qext || {};
+    if (argv.meta) {
+      const meta = require(path.resolve(cwd, argv.meta)); // eslint-disable-line
+      Object.assign(qext, meta);
+    }
+    const contents = {
+      name: qext.name || extName,
+      version: supernovaPkg.version,
+      description: supernovaPkg.description,
+      author: supernovaPkg.author,
+      icon: qext.icon || 'extension',
+      preview: qext.preview,
+      type: 'visualization',
+      supernova: true,
+    };
+
+    let qextjs = fs.readFileSync(path.resolve(__dirname, extDefinition ? '../src/ext.js' : '../src/empty-ext.js'), {
+      encoding: 'utf8',
+    });
+    qextjs = qextjs.replace('{{DIST}}', `./${main.replace(/^[./]*/, '').replace(/\.js$/, '')}`);
+    qextjs = qextjs.replace('{{EXT}}', `./${targetFile}`);
+
+    fs.writeFileSync(qextFileName, JSON.stringify(contents, null, 2));
+    fs.writeFileSync(qextFileNameJs, qextjs);
+
+    if (supernovaPkg.files) {
+      [
+        extDefinition ? path.basename(qextLegacyTargetDir) : false,
+        path.basename(qextFileNameJs),
+        path.basename(qextFileName),
+      ]
+        .filter(Boolean)
+        .forEach((f) => {
+          if (!supernovaPkg.files.includes(f)) {
+            console.warn(`  \x1b[33mwarn:\x1b[0m \x1b[36m${f}\x1b[0m should be included in package.json 'files' array`);
+          }
+        });
+    }
+  };
+
+  const copySource = () => {
+    fs.copySync(path.resolve(main), path.resolve(targetDir, main));
+
+    if (sourcemap) {
+      fs.copySync(path.resolve(`${main}.map`), path.resolve(targetDir, `${main}.map`));
+    }
+  };
+
+  if (extDefinition) {
+    const bundle = await rollup.rollup({
+      input: extDefinition,
+      plugins: [
+        nodeResolve(),
+        common(),
+        babel({
+          babelrc: false,
+          exclude: [/node_modules/],
+          presets: [
+            [
+              '@babel/preset-env',
+              {
+                modules: false,
+                targets: {
+                  browsers: ['ie 11', 'chrome 47'],
+                },
+              },
+            ],
+          ],
+        }),
+        argv.minify &&
+          terser({
+            output: {
+              comments: /@license|@preserve|Copyright|license/,
+            },
+          }),
+      ],
+    });
+
+    await bundle.write({
+      file: path.resolve(qextLegacyTargetDir, `${targetFile}.js`),
+      format: 'amd',
+      sourcemap,
+    });
+  }
+
+  copySource();
+  createQextFiles();
+}
+
+module.exports = build;

package/lib/init-config.js

@@ -0,0 +1,38 @@
+const options = {
+  ext: {
+    type: 'string',
+    required: false,
+    desc: 'Extension definition',
+  },
+  meta: {
+    type: 'string',
+    required: false,
+    desc: 'Extension meta information',
+  },
+  output: {
+    type: 'string',
+    required: false,
+    default: '<name>-ext',
+    desc: 'Destination directory',
+  },
+  minify: {
+    type: 'boolean',
+    required: false,
+    default: true,
+    desc: 'Minify and uglify code',
+  },
+  sourcemap: {
+    type: 'boolean',
+    required: false,
+    default: false,
+    desc: 'Generate sourcemaps',
+  },
+  legacy: {
+    type: 'boolean',
+    required: false,
+    default: false,
+    desc: 'Generate legacy extension',
+  },
+};
+
+module.exports = (yargs) => yargs.options(options);

package/lib/sense.js

@@ -0,0 +1,11 @@
+const buildLegacy = require('./build-legacy');
+const build = require('./build');
+
+function sense(argv) {
+  if (argv.legacy) {
+    buildLegacy(argv);
+  } else {
+    build(argv);
+  }
+}
+module.exports = sense;

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@nebula.js/cli-sense",
+  "version": "2.0.0-beta.1",
+  "description": "Build a supernova as a Qlik Sense extension",
+  "license": "MIT",
+  "author": "QlikTech International AB",
+  "keywords": [
+    "nebula",
+    "sense",
+    "qlik",
+    "extension"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/qlik-oss/nebula.js.git"
+  },
+  "main": "lib/api-entry.js",
+  "files": [
+    "command.js",
+    "lib",
+    "src"
+  ],
+  "scripts": {
+    "lint": "eslint src"
+  },
+  "dependencies": {
+    "@babel/cli": "7.14.8",
+    "@babel/core": "7.15.0",
+    "@babel/preset-env": "7.15.0",
+    "@nebula.js/stardust": "^2.0.0-beta.1",
+    "@rollup/plugin-commonjs": "20.0.0",
+    "@rollup/plugin-node-resolve": "13.0.4",
+    "@rollup/plugin-replace": "3.0.0",
+    "extend": "3.0.2",
+    "fs-extra": "10.0.0",
+    "node-event-emitter": "0.0.1",
+    "rollup": "2.56.3",
+    "rollup-plugin-babel": "4.4.0",
+    "rollup-plugin-terser": "7.0.2",
+    "yargs": "17.1.1"
+  },
+  "gitHead": "851bf623f70a49f07615fe3b7e37b8b44fad534f"
+}

package/src/empty-ext.js

@@ -0,0 +1 @@
+define(['{{DIST}}'], (supernova) => supernova);

package/src/ext.js

@@ -0,0 +1,12 @@
+define(['{{DIST}}', '{{EXT}}'], (supernova, ext) =>
+  function supernovaExtension(env) {
+    var v = supernova(env);
+    var extDef = ext;
+    /* eslint no-underscore-dangle:0 */
+    if (ext.__esmodule === true) {
+      // Handles es modules with multiple exports
+      extDef = ext.default;
+    }
+    v.ext = typeof extDef === 'function' ? extDef(env) : extDef;
+    return v;
+  });

package/src/legacy/__tests__/selections.spec.js

@@ -0,0 +1,44 @@
+import createSelections from '../selections';
+
+describe('supernova-wrapper', () => {
+  describe('selections', () => {
+    let selectionsApi;
+    let backendApi;
+    let selections;
+
+    beforeEach(() => {
+      selectionsApi = {
+        activated: sinon.stub(),
+        deactivated: sinon.stub(),
+      };
+      backendApi = {
+        beginSelections: sinon.stub(),
+        endSelections: sinon.stub(),
+        model: {
+          resetMadeSelections: sinon.stub(),
+          app: {
+            switchModalSelection: sinon.stub(),
+          },
+        },
+      };
+      selections = createSelections({ selectionsApi, backendApi });
+      selections.emit = sinon.stub();
+    });
+
+    it('should `begin`', () => {
+      selections.begin();
+      expect(selectionsApi.activated).to.have.been.calledWithExactly(true);
+      expect(backendApi.beginSelections).to.have.been.calledWithExactly();
+      expect(selections.emit).to.have.been.calledWithExactly('activated');
+    });
+
+    it('should `begin` with paths', () => {
+      const paths = ['hypercubePath', 'otherHypercubePath'];
+      selections.begin(paths);
+      expect(selectionsApi.activated).to.have.been.calledWithExactly(true);
+      expect(backendApi.beginSelections).to.not.been.called;
+      expect(backendApi.model.app.switchModalSelection).to.have.been.calledWithExactly(backendApi.model, paths);
+      expect(selections.emit).to.have.been.calledWithExactly('activated');
+    });
+  });
+});

package/src/legacy/empty-ext.js

@@ -0,0 +1,3 @@
+const x = {};
+
+export { x as default };

package/src/legacy/permissions.js

@@ -0,0 +1,36 @@
+const INTERACTION_STATES = {
+  STATIC: 0,
+  ANALYSIS: 1,
+  EDIT: 2,
+};
+
+function showTooltip(options) {
+  if (options.tooltips) {
+    return true;
+  }
+  return options.interactionState === INTERACTION_STATES.ANALYSIS && options.tooltips !== false;
+}
+
+function permissions(options, backendApi) {
+  const p = [];
+  if (showTooltip(options)) {
+    p.push('passive');
+  }
+  if (
+    options.interactionState === INTERACTION_STATES.ANALYSIS &&
+    options.tooltips !== false &&
+    options.limitedInteraction !== true
+  ) {
+    p.push('interact');
+  }
+  if (!backendApi.isSnapshot) {
+    if (options.selections !== false) {
+      p.push('select');
+    }
+    p.push('fetch');
+  }
+
+  return p;
+}
+
+export default permissions;

package/src/legacy/selections.js

@@ -0,0 +1,82 @@
+/* eslint no-param-reassign: 0 */
+import EventEmitter from 'node-event-emitter';
+
+export default (scope) => {
+  const mixin = (obj) => {
+    Object.keys(EventEmitter.prototype).forEach((key) => {
+      obj[key] = EventEmitter.prototype[key];
+    });
+    EventEmitter.init(obj);
+    return obj;
+  };
+
+  // TODO one and only one
+
+  const selectionAPI = {
+    begin(paths) {
+      const suppressBeginSelections = true;
+      scope.selectionsApi.activated(suppressBeginSelections);
+      if (paths) {
+        scope.backendApi.model.app.switchModalSelection(scope.backendApi.model, paths);
+      } else {
+        scope.backendApi.beginSelections();
+      }
+      selectionAPI.emit('activated');
+    },
+    clear() {
+      scope.backendApi.model.resetMadeSelections();
+    },
+    confirm() {
+      scope.selectionsApi.confirm();
+    },
+    cancel() {
+      scope.selectionsApi.cancel();
+    },
+    select(s) {
+      if (!scope.selectionsApi.active) {
+        scope.backendApi.beginSelections();
+      }
+      scope.backendApi.model[s.method](...s.params).then((qSuccess) => {
+        if (!qSuccess) {
+          scope.selectionsApi.selectionsMade = false;
+          this.clear();
+        }
+      });
+      scope.selectionsApi.selectionsMade = s.method !== 'resetMadeSelections';
+    },
+    isActive() {
+      return scope.selectionsApi.active;
+    },
+    isModal() {
+      return scope.backendApi.model === (scope.backendApi.model.app && scope.backendApi.model.app.modalSelectionObject);
+    },
+    refreshToolbar() {
+      scope.selectionsApi.refreshToolbar();
+    },
+  };
+
+  mixin(selectionAPI);
+
+  scope.selectionsApi.confirm = () => {
+    scope.backendApi.endSelections(true).then(() => {
+      scope.selectionsApi.deactivated();
+      selectionAPI.emit('confirmed');
+      selectionAPI.emit('deactivated');
+    });
+  };
+
+  scope.selectionsApi.clear = () => {
+    scope.backendApi.clearSelections();
+    scope.selectionsApi.selectionsMade = false;
+    selectionAPI.emit('cleared');
+  };
+
+  scope.selectionsApi.cancel = () => {
+    scope.backendApi.endSelections(false);
+    scope.selectionsApi.deactivated();
+    selectionAPI.emit('canceled');
+    selectionAPI.emit('deactivated');
+  };
+
+  return selectionAPI;
+};

package/src/legacy/sn-ext.js

@@ -0,0 +1,287 @@
+/* eslint no-underscore-dangle: 0 */
+/* eslint import/no-unresolved: 0 */
+/* eslint import/extensions: 0 */
+
+// Sense dependencies
+import qlik from 'qlik';
+import senseTranslator from 'translator';
+
+// injected
+import snDefinition from '__SN_DEF__';
+import extDefinition from '__EXT_DEF__';
+import emptyExtDefinition from './empty-ext';
+
+// lib dependencies
+import { __DO_NOT_USE__ } from './nlib/@nebula.js/stardust/dist/stardust';
+
+// wrapper code
+import permissions from './permissions';
+import selectionsApi from './selections';
+
+const { generator: supernova, theme: themeFn, locale: localeFn } = __DO_NOT_USE__;
+
+// ------- locale ---------
+// use nebula locale API to ensure all viz get the same API regardless
+// if consumed in Sense or outside
+const loc = localeFn({
+  initial: senseTranslator.language,
+});
+const translator = {
+  ...loc.translator,
+  // wrap get() for this API in order to prefer strings provided by Sense
+  get(str, args) {
+    const s = senseTranslator.get(str, args);
+    if (s === str) {
+      return loc.translator.get(str, args);
+    }
+    return s;
+  },
+};
+// ------------------------
+
+// Galaxy is usually provided by @nebula.js/nucleus when a viz is instantiated.
+// Since nucleus is not being used in Sense yet, this interface MUST be provided explicitly here
+// and it MUST have the same interface as the one provided by nucleus.
+const galaxy = {
+  deviceType: 'auto',
+  translator,
+  flags: {
+    isEnabled: () => false,
+  },
+  anything: {},
+};
+
+const ALLOWED_OPTIONS = ['viewState', 'direction', 'renderer'];
+function limitOptions(newOptions, oldOptions) {
+  const op = {};
+  let opChanged = false;
+  Object.keys(newOptions).forEach((key) => {
+    if (ALLOWED_OPTIONS.indexOf(key) === -1) {
+      return;
+    }
+    op[key] = newOptions[key];
+    if (oldOptions[key] !== newOptions[key]) {
+      opChanged = true;
+    }
+  });
+  if (opChanged) {
+    return op;
+  }
+  return oldOptions;
+}
+
+function createActions(actions) {
+  return actions.map((a) => {
+    const senseItem = {
+      isIcon: true,
+      buttonClass: 'sel-toolbar-icon-toggle',
+      isActive() {
+        return a.active;
+      },
+      isDisabled() {
+        return a.disabled;
+      },
+      action() {
+        a.action();
+      },
+      getSvgIcon() {
+        const icon = a.getSvgIconShape();
+        const { viewBox = '0 0 16 16' } = icon;
+        const shapes = icon.shapes
+          .map(
+            ({ type, attrs }) =>
+              `<${type} ${Object.keys(attrs)
+                .map((k) => `${k}="${attrs[k]}"`)
+                .join(' ')}/>`
+          )
+          .join('');
+        return `<i style="display:inline-block;font-style:normal;line-height:0;text-align:center;text-transform:none;vertical-align:-.2em;text-rendering:optimizeLegibility;web-kit-font-smoothing:antialiased;moz-osx-font-smoothing:grayscale"><svg xmlns="http://www.w3.org/2000/svg" width="1em" height="1em" viewBox="${viewBox}" fill="currentColor">${shapes}</svg></i>`;
+      },
+    };
+    Object.defineProperties(senseItem, {
+      name: {
+        get: () => a.label,
+      },
+      hidden: {
+        get: () => a.hidden,
+      },
+    });
+    return senseItem;
+  });
+}
+
+function updateTheme(ref) {
+  return qlik
+    .currApp(ref)
+    .theme.getApplied()
+    .then((qTheme) => {
+      if (ref.nTheme.externalAPI.name() !== qTheme.id) {
+        ref.nTheme.internalAPI.setTheme(qTheme.properties, qTheme.id);
+      }
+    });
+}
+
+// ============= EXTENSON =====================================================
+
+const snGenerator = supernova(snDefinition, galaxy);
+const ext =
+  typeof extDefinition === 'function'
+    ? extDefinition({ translator })
+    : extDefinition || snGenerator.definition.ext || emptyExtDefinition || {};
+let data;
+
+if (snGenerator.qae.data.targets[0]) {
+  const d = snGenerator.qae.data.targets[0];
+  // supernova uses the convention of 'added' instead of 'add' since the
+  // method is called after the dimension/measures has been added to the hypercube.
+  // we therefore need to map supernova callbacks to the ones supported in Sense
+  const map = (v) => ({
+    ...v,
+    add: v.added,
+    remove: v.removed,
+    replace: v.replaced,
+    move: v.moved,
+  });
+
+  data = {};
+  if (d.dimensions) {
+    data.dimensions = map(d.dimensions);
+  }
+  if (d.measures) {
+    data.measures = map(d.measures);
+  }
+}
+
+const X = {
+  // overridable properties
+  definition: {
+    type: 'items',
+    component: 'accordion',
+    items: {
+      data: data
+        ? {
+            uses: 'data',
+          }
+        : undefined,
+      sorting: data
+        ? {
+            uses: 'sorting',
+          }
+        : undefined,
+      settings: {
+        uses: 'settings',
+      },
+    },
+  },
+  data,
+  // -- defaults for the following are injected in default-extension.js --
+  // support
+  // importProperties,
+  // exportProperties,
+  // ----
+  getSelectionToolbar() {
+    return [
+      ...this.senseItems,
+      {
+        name: 'Tooltip.clearSelection',
+        tid: 'selection-toolbar.clear',
+        isIcon: true,
+        buttonClass: 'clear',
+        iconClass: 'lui-icon lui-icon--clear-selections',
+        action: function action() {
+          this.selectionsApi.clear();
+        },
+        isDisabled: function isDisabled() {
+          return !this.selectionsApi.selectionsMade;
+        },
+      },
+    ];
+  },
+  // override with user config
+  ...ext,
+
+  // =============================================
+  // non-overridable properties
+  initialProperties: snGenerator.qae.properties.initial,
+  template: '<div style="height: 100%;position: relative"></div>',
+  mounted($element) {
+    const element = $element[0].children[0];
+    const selectionAPI = selectionsApi(this.$scope);
+    const sn = snGenerator.create({
+      model: this.backendApi.model,
+      app: this.backendApi.model.session.app,
+      selections: selectionAPI,
+      explicitResize: true,
+    });
+    this.sn = sn;
+    this.snComponent = sn.component;
+    this.snComponent.created();
+    this.snComponent.mounted(element);
+    this.senseItems = [];
+    const { senseItems } = this;
+    this.snComponent.observeActions((actions) => {
+      senseItems.length = 0;
+      senseItems.push(...createActions(actions));
+      this.$scope.selectionsApi.refreshToolbar();
+    });
+
+    this.nTheme = themeFn();
+
+    this.initiatedTheme = updateTheme(this);
+  },
+  suppressOnPaint: () => false,
+  paint() {
+    const perms = permissions(this.options, this.backendApi);
+    const constraints = {
+      passive: perms.indexOf('passive') === -1 || undefined,
+      active: perms.indexOf('interact') === -1 || undefined,
+      select: perms.indexOf('select') === -1 || undefined,
+    };
+    const opts = limitOptions(this.options, this.snComponent.context.options);
+    this._pureLayout = this.backendApi.model.pureLayout || this.backendApi.model.layout;
+    return this.initiatedTheme.then(() => {
+      updateTheme(this);
+      return this.snComponent.render({
+        layout: this.backendApi.model.pureLayout || this.backendApi.model.layout,
+        context: {
+          appLayout: {
+            qLocaleInfo: this.backendApi.localeInfo,
+          },
+          constraints,
+          theme: this.nTheme.externalAPI,
+        },
+        options: opts,
+      });
+    });
+  },
+  resize() {
+    if (this._pureLayout !== this.backendApi.model.pureLayout) {
+      return this.paint();
+    }
+    const opts = limitOptions(this.options, this.snComponent.context.options);
+    this.snComponent.context.options = opts;
+    return this.snComponent.resize();
+  },
+  setInteractionState() {
+    this.paint();
+  },
+  setSnapshotData(layout) {
+    return this.snComponent.setSnapshotData(layout);
+  },
+  getViewState() {
+    const ref = this.snComponent.getImperativeHandle();
+    if (ref && typeof ref.getViewState === 'function') {
+      return ref.getViewState();
+    }
+    return undefined;
+  },
+  destroy() {
+    this.sn.destroy();
+    if (this.snComponent) {
+      this.snComponent.willUnmount();
+      this.snComponent.destroy();
+    }
+  },
+};
+
+export { X as default };