@nebula.js/cli-create 3.0.3 → 3.1.0-alpha.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nebula.js/cli-create",
-  "version": "3.0.3",
+  "version": "3.1.0-alpha.0",
   "description": "",
   "license": "MIT",
   "author": "QlikTech International AB",
@@ -27,5 +27,5 @@
     "fs-extra": "10.1.0",
     "inquirer": "8.2.4"
   },
-  "gitHead": "2beefab5a936527fe5cdd20b98784d72199327fb"
+  "gitHead": "06eb9b2d1876ac3abce9a1c749c0b428d3251481"
 }

package/templates/mashup/_package.json

@@ -13,8 +13,8 @@
   "dependencies": {
     "@nebula.js/stardust": "<%= nebulaVersion %>",
     "@nebula.js/sn-bar-chart": "^1.x",
-    "@qlik/sdk": "^0.9.1",
+    "@qlik/sdk": "^0.12.0",
     "enigma.js": "^2.6.3",
-    "parcel": "^2.3.2"
+    "parcel": "^2.7.0"
   }
 }

package/templates/mashup/src/Authenticator.js

@@ -0,0 +1,86 @@
+import enigma from 'enigma.js';
+import schema from 'enigma.js/schemas/12.936.0.json';
+import { Auth, AuthType } from '@qlik/sdk';
+
+export default class Authenticator {
+  /**
+   *
+   * @param {String} appId  - application id from sense client
+   * @param {Strign} url    - tenant url
+   */
+  constructor({ appId, url }) {
+    this.authInstance = null;
+    this.appId = appId;
+    this.host = url.replace(/^https?:\/\//, '').replace(/\/?/, '');
+  }
+
+  /**
+   * gets you the promise of enigma instance for your app
+   * based on webIntegrationId
+   * @param {Strign} webIntegrationId - your web Integration Id from managment console
+   * @returns {Promise<IEnigmaClass>} enigma app promise
+   */
+  async AuthenticateWithWebIntegrationId({ webIntegrationId }) {
+    this.authInstance = new Auth({
+      authType: AuthType.WebIntegration,
+      autoRedirect: true,
+      host: this.host,
+      webIntegrationId,
+    });
+
+    if (!this.authInstance.isAuthenticated()) {
+      this.authInstance.authenticate();
+    } else return this.getEnigmaApp();
+
+    return null;
+  }
+
+  /**
+   * gets you the promise of enigma instance for your app
+   * based on clientId
+   * @param {Strign} clientId     - your client Id from managment console
+   * @param {Strign} redirectUri  - the redirect url while bringing you the code + state, default is `window.location.origin`
+   * @returns {Promise<IEnigmaClass>} enigma app promise
+   */
+  async AuthenticateWithOAuth({ clientId, redirectUri }) {
+    this.authInstance = new Auth({
+      authType: AuthType.OAuth2,
+      host: this.host,
+      redirectUri: redirectUri || window.location.origin,
+      clientId,
+    });
+
+    const urlParams = new URLSearchParams(window.location.search);
+    if (urlParams.get('code')) {
+      try {
+        await this.authInstance.authorize(window.location.href);
+        const url = new URL(window.location);
+        url.searchParams.delete('code');
+        url.searchParams.delete('state');
+        window.history.replaceState(null, null, url);
+      } catch (error) {
+        console.error({ error });
+      }
+
+      return this.getEnigmaApp();
+    }
+
+    if (!(await this.authInstance.isAuthorized())) {
+      const { url } = await this.authInstance.generateAuthorizationUrl();
+      const protocol = url.includes('https://') ? 'https' : 'http';
+      window.location = `${protocol}://${url}`;
+    }
+
+    return null;
+  }
+
+  /**
+   * returns a promise of enigma instance
+   * @returns {Promise<IEnigmaClass>} enigma app instance promise
+   */
+  async getEnigmaApp() {
+    const url = await this.authInstance.generateWebsocketUrl(this.appId);
+    const enigmaGlobal = await enigma.create({ schema, url }).open();
+    return enigmaGlobal.openDoc(this.appId);
+  }
+}

package/templates/mashup/src/connect.js

@@ -1,24 +1,26 @@
-import enigma from 'enigma.js';
-import schema from 'enigma.js/schemas/12.936.0.json';
-import { Auth, AuthType } from '@qlik/sdk';
+import { AuthType } from '@qlik/sdk';
+import Authenticator from './Authenticator';
 
-async function connect({ url, webIntegrationId, appId }) {
-  const authInstance = new Auth({
-    webIntegrationId,
-    autoRedirect: true,
-    authType: AuthType.WebIntegration,
-    host: url.replace(/^https?:\/\//, '').replace(/\/?/, ''),
+async function connect({ connectionType, url, appId, ...rest }) {
+  const AuthenticatorInstance = new Authenticator({
+    url,
+    appId,
   });
 
-  if (!authInstance.isAuthenticated()) {
-    authInstance.authenticate();
-  } else {
-    const wssUrl = await authInstance.generateWebsocketUrl(appId);
-    const enigmaGlobal = await enigma.create({ schema, url: wssUrl }).open();
-    return enigmaGlobal.openDoc(appId);
-  }
+  switch (connectionType) {
+    case AuthType.WebIntegration: {
+      return AuthenticatorInstance.AuthenticateWithWebIntegrationId({
+        ...rest,
+      });
+    }
+
+    case AuthType.OAuth2: {
+      return AuthenticatorInstance.AuthenticateWithOAuth({ ...rest });
+    }
 
-  return null;
+    default:
+      throw new Error('Please Provide a `connectionType` to proceed!');
+  }
 }
 
 export default connect;

package/templates/mashup/src/index.js

@@ -1,12 +1,18 @@
 /* eslint-disable */
+import { AuthType } from '@qlik/sdk';
 import embed from './configure';
 import connect from './connect';
 
 async function run() {
   const app = await connect({
+    connectionType: '<AuthType.SOME_CONNECTION_TYPE>',
     url: '<URL>',
-    webIntegrationId: '<Qlik web integration id>',
     appId: '<App id>',
+
+    // you should use only one of below keys
+    // based on your `connectionType`
+    clientId: '<Qlik OAuth client id>',
+    webIntegrationId: '<Qlik web integration id>',
   });
 
   const n = embed(app);

package/templates/sn/none/_package.json

@@ -10,7 +10,7 @@
   "keywords": ["qlik", "nebula", "stardust"],
   "files": ["dist"],
   "engines": {
-    "node": ">=8"
+    "node": ">=18"
   },
   "main": "dist/<%= name %>.js",
   "module": "dist/<%= name %>.esm.js",

package/templates/sn/picasso/common/_package.json

@@ -10,7 +10,7 @@
   "keywords": ["qlik", "nebula", "stardust"],
   "files": ["dist"],
   "engines": {
-    "node": ">=8"
+    "node": ">=18"
   },
   "main": "dist/<%= name %>.js",
   "module": "dist/<%= name %>.esm.js",