@soleil-se/app-util 1.0.0

package/README.md

@@ -0,0 +1,44 @@
+# Webapp Util
+## Install
+`yarn add @soleil-se/webapp-util`
+
+## Usage
+```javascript
+import { renderVue, getRouteUri, getResourceUri, renderTemplate, isOffline } from '@soleil-se/webapp-util';
+```
+### `renderVue`
+Prints bootstrap code for a Vue application.   
+`name` has to match the name of the Vue application.   
+`data` is an object that will be available in `$options`.   
+`noScript` is a HTML-string that will be printed when JavaScript is not available.
+```javascript
+router.get('/', (req, res) => {
+  res.send(renderVue('AppName', data, noScript));
+});
+```
+### `getRouteUri`
+Get URI for a route. 
+```javascript
+const routeUri = getRouteUri('/my-route');
+```
+### `getResourceUri`
+Get URI for a resource.
+```javascript
+const resourceUri = getResourceUri('file/in/resource.png');
+```
+### `renderTemplate`
+Renders a Underscore template to a string.
+```javascript
+const string = renderTemplate('<div><%= foo %></div>', {
+  foo: 'bar',
+});
+```
+### `isOffline`
+```javascript
+if(isOffline) {
+  // Do something
+}
+```
+
+
+

package/dist/index.js

@@ -0,0 +1,48 @@
+import PropertyUtil from 'PropertyUtil';
+import PortletContextUtil from 'PortletContextUtil';
+import VersionUtil from 'VersionUtil';
+import app from 'app';
+import _ from 'underscore';
+
+export var isOffline = VersionUtil.getCurrentVersion() === VersionUtil.OFFLINE_VERSION;
+
+export function getResourceUri(resource) {
+  return ("/webapp-files/" + (app.webAppId) + "/" + (app.webAppVersion) + "/" + resource);
+}
+
+export function renderTemplate(template, values) {
+  if ( values === void 0 ) values = {};
+
+  if (typeof template === 'function') {
+    return template(values);
+  }
+  return _.template(template)(values);
+}
+
+export function renderVue(name, data, noScript) {
+  if ( noScript === void 0 ) noScript = '';
+
+  var options = Object.assign({}, {webapp: app, isOffline: isOffline}, data);
+
+  var vueUri = getResourceUri('vue/index.js');
+  var html = "<!-- Generated by WebappUtil.renderVue() -->\n<div data-vue-name=\"" + name + "\" data-vue-portlet=\"" + (app.portletId) + "\">" + noScript + "</div>\n<script src=\"" + vueUri + "\"></script>\n<script type=\"text/javascript\">\n  vueApps['" + name + "'].render('" + name + "', '" + (app.portletId) + "', " + (JSON.stringify(options)) + ");\n</script>";
+  return html;
+}
+
+export function getRouteUri(route) {
+  var currentPortlet = PortletContextUtil.getCurrentPortlet();
+  if (currentPortlet) {
+    var currentPortletId = currentPortlet.getIdentifier();
+    var currentPageUri = PropertyUtil.getString(PortletContextUtil.getCurrentPage(), 'URI');
+    return (currentPageUri + "?sv." + currentPortletId + ".route=" + (encodeURI(route)) + "&sv.target=" + currentPortletId);
+  }
+  return '';
+}
+
+export default {
+  getRouteUri: getRouteUri,
+  getResourceUri: getResourceUri,
+  renderVue: renderVue,
+  renderTemplate: renderTemplate,
+  isOffline: isOffline,
+};

package/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@soleil-se/app-util",
+  "version": "1.0.0",
+  "main": "./dist/index.js",
+  "author": "Soleil AB",
+  "license": "UNLICENSED",
+  "private": false,
+  "scripts": {
+    "build": "npx buble ./src/index.js --output ./dist/index.js --no modules --objectAssign=Object.assign"
+  },
+  "dependencies": {},
+  "devDependencies": {}
+}

package/src/index.js

@@ -0,0 +1,49 @@
+import PropertyUtil from 'PropertyUtil';
+import PortletContextUtil from 'PortletContextUtil';
+import VersionUtil from 'VersionUtil';
+import app from 'app';
+import _ from 'underscore';
+
+export const isOffline = VersionUtil.getCurrentVersion() === VersionUtil.OFFLINE_VERSION;
+
+export function getResourceUri(resource) {
+  return `/webapp-files/${app.webAppId}/${app.webAppVersion}/${resource}`;
+}
+
+export function renderTemplate(template, values = {}) {
+  if (typeof template === 'function') {
+    return template(values);
+  }
+  return _.template(template)(values);
+}
+
+export function renderVue(name, data, noScript = '') {
+  const options = { webapp: app, isOffline, ...data };
+
+  const vueUri = getResourceUri('vue/index.js');
+  const html = `<!-- Generated by WebappUtil.renderVue() -->
+<div data-vue-name="${name}" data-vue-portlet="${app.portletId}">${noScript}</div>
+<script src="${vueUri}"></script>
+<script type="text/javascript">
+  vueApps['${name}'].render('${name}', '${app.portletId}', ${JSON.stringify(options)});
+</script>`;
+  return html;
+}
+
+export function getRouteUri(route) {
+  const currentPortlet = PortletContextUtil.getCurrentPortlet();
+  if (currentPortlet) {
+    const currentPortletId = currentPortlet.getIdentifier();
+    const currentPageUri = PropertyUtil.getString(PortletContextUtil.getCurrentPage(), 'URI');
+    return `${currentPageUri}?sv.${currentPortletId}.route=${encodeURI(route)}&sv.target=${currentPortletId}`;
+  }
+  return '';
+}
+
+export default {
+  getRouteUri,
+  getResourceUri,
+  renderVue,
+  renderTemplate,
+  isOffline,
+};