@soleil-se/app-util 1.0.2 → 1.0.3

package/README.md

@@ -6,39 +6,62 @@
 ```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.
+### `renderVue(name, data, [noScript])` ⇒ `String`
+Get HTML for rendering a Vue application.
+
+**Returns**: `String` - HTML for rendering a Vue application.
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| name | `String` |  | Name of the app, has to match the name of the Vue application. |
+| data | `Object` |  | Data that will be available in `$options`. |
+| [noScript] | `String` | `''` | HTML 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. 
+### `getRouteUri(route)` ⇒ `String`
+Get URI for a route.
+
+**Returns**: `String` - URI for route.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| route | `String` | A route. |
 ```javascript
 const routeUri = getRouteUri('/my-route');
 ```
-### `getResourceUri`
+### `getResourceUri(resource)` ⇒ `String`
 Get URI for a resource.
+
+**Returns**: `String` - URI for a resource.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| resource | `String` | A resource. |
 ```javascript
 const resourceUri = getResourceUri('file/in/resource.png');
 ```
-### `renderTemplate`
-Renders a Underscore template to a string.
+### `renderTemplate(template, [values])` ⇒ `String`
+Renders a Underscore template and returns a string.
+
+**Returns**: `String` - Rendered template
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| template | `String` |  | Underscore template. |
+| [values] | `Object` | `{}` | Values. |
 ```javascript
 const string = renderTemplate('<div><%= foo %></div>', {
   foo: 'bar',
 });
 ```
 ### `isOffline`
+If the webapp is running in offline mode or not.
+
 ```javascript
 if(isOffline) {
   // Do something
 }
 ```
-
-
-

package/dist/index.js

@@ -4,12 +4,24 @@ import VersionUtil from 'VersionUtil';
 import app from 'app';
 import _ from 'underscore';
 
+/** If the webapp is running in offline mode or not. */
 export var isOffline = VersionUtil.getCurrentVersion() === VersionUtil.OFFLINE_VERSION;
 
+/**
+ * Get URI for a resource.
+ * @param {String} resource A resource.
+ * @returns {String} URI for a resource.
+ */
 export function getResourceUri(resource) {
   return ("/webapp-files/" + (app.webAppId) + "/" + (app.webAppVersion) + "/" + resource);
 }
 
+/**
+ * Renders a Underscore template and returns a string.
+ * @param {String} template Underscore template.
+ * @param {Object} [values={}] Values.
+ * @returns {String} Rendered template
+ */
 export function renderTemplate(template, values) {
   if ( values === void 0 ) values = {};
 
@@ -19,6 +31,13 @@ export function renderTemplate(template, values) {
   return _.template(template)(values);
 }
 
+/**
+ * Get HTML for rendering a Vue application.
+ * @param {String} name Name of the app, has to match the name of the Vue application.
+ * @param {Object} data Data that will be available in `$options`.
+ * @param {String} [noScript=''] HTML that will be printed when JavaScript is not available.
+ * @returns {String} HTML for rendering a Vue application.
+ */
 export function renderVue(name, data, noScript) {
   if ( noScript === void 0 ) noScript = '';
 
@@ -29,6 +48,11 @@ export function renderVue(name, data, noScript) {
   return html;
 }
 
+/**
+ * Get URI for a route.
+ * @param {String} route A route.
+ * @returns {String} URI for route.
+ */
 export function getRouteUri(route) {
   var currentPortlet = PortletContextUtil.getCurrentPortlet();
   if (currentPortlet) {

package/package.json

@@ -1,13 +1,17 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "main": "./dist/index.js",
   "author": "Soleil AB",
   "license": "UNLICENSED",
   "private": false,
+  "homepage": "https://github.com/soleilit/server-monorepo/tree/master/packages/app-util",
   "scripts": {
     "build": "npx buble ./src/index.js --output ./dist/index.js --no modules --objectAssign=Object.assign"
   },
+  "peerDependencies": {
+    "underscore": "^1.9.1"
+  },
   "dependencies": {},
   "devDependencies": {}
 }

package/src/index.js

@@ -4,12 +4,24 @@ import VersionUtil from 'VersionUtil';
 import app from 'app';
 import _ from 'underscore';
 
+/** If the webapp is running in offline mode or not. */
 export const isOffline = VersionUtil.getCurrentVersion() === VersionUtil.OFFLINE_VERSION;
 
+/**
+ * Get URI for a resource.
+ * @param {String} resource A resource.
+ * @returns {String} URI for a resource.
+ */
 export function getResourceUri(resource) {
   return `/webapp-files/${app.webAppId}/${app.webAppVersion}/${resource}`;
 }
 
+/**
+ * Renders a Underscore template and returns a string.
+ * @param {String} template Underscore template.
+ * @param {Object} [values={}] Values.
+ * @returns {String} Rendered template
+ */
 export function renderTemplate(template, values = {}) {
   if (typeof template === 'function') {
     return template(values);
@@ -17,6 +29,13 @@ export function renderTemplate(template, values = {}) {
   return _.template(template)(values);
 }
 
+/**
+ * Get HTML for rendering a Vue application.
+ * @param {String} name Name of the app, has to match the name of the Vue application.
+ * @param {Object} data Data that will be available in `$options`.
+ * @param {String} [noScript=''] HTML that will be printed when JavaScript is not available.
+ * @returns {String} HTML for rendering a Vue application.
+ */
 export function renderVue(name, data, noScript = '') {
   const options = { webapp: app, isOffline, ...data };
 
@@ -30,6 +49,11 @@ export function renderVue(name, data, noScript = '') {
   return html;
 }
 
+/**
+ * Get URI for a route.
+ * @param {String} route A route.
+ * @returns {String} URI for route.
+ */
 export function getRouteUri(route) {
   const currentPortlet = PortletContextUtil.getCurrentPortlet();
   if (currentPortlet) {