@soleil-se/app-util 2.0.0 → 2.1.0

package/CHANGELOG.md

@@ -0,0 +1,39 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2.1.0] - 2020-02-14
+### Added
+- App data import in client, `@soleil-api/webapp-util/app-data`.
+- `getViewUri` to get the URI that also renders the page.
+- `isOnline` to see if the app is online.
+
+### Changed
+- `vue` is now an optional depedency.  
+
+## [2.0.0] - 2020-02-12
+### Changed
+- Now using `currentScript` to reference the script element the app is running in to pass data when using `renderApp`.
+- `renderApp` is no longer using appName.
+- `render` is now called directly in `./app_src/client/index.js`. 
+- `render` and `App` no longer needs to be exported from `./app_src/client/index.js`. 
+
+## [1.2.4] - 2020-12-12
+### Fixed
+- `TypeError: Cannot call method getIdentifier of null` when app is viewed in Addons. 
+
+## [1.2.2] - 2019-05-20
+### Fixed
+- Removed `_sitePage` from `currentPageId` in `getRouteUri`.
+
+## [1.2.1] - 2019-05-09
+### Added
+- Added timestamp to WebApp script tag to prevent cache when uploading a new version.
+
+## [1.2.0] - 2019-05-07
+### Changed
+- `getRouteUri` now returns the standalone route.
+- HTML comment to not include this.name in `renderApp`.
+

package/README.md

@@ -3,6 +3,9 @@ Utility functions for Webapps.
 ## Install
 `yarn add @soleil-se/webapp-util`
 
+## Changelog
+[See changelog](CHANGELOG.md).
+
 ## Migration 1.x.x to 2.x.x
 
 Now using `currentScript` to reference the script element the app is running in to pass data. 
@@ -56,19 +59,55 @@ import App from './App.vue';
 
 render(App);
 ```
-### `getRouteUri(route)` ⇒ `String`
-Get URI for a route.
 
-**Returns**: `String` - URI for route.
+##### **App data**
+If you need to use the data that is available for the App you can use `@soleil-se/webapp-util/app-data`.
+
+For example when you need a route URI from the server:
+```javascript
+import AppData from '@soleil-se/webapp-util/app-data';
+import superagent from 'superagent';
+​
+const searchThings = async (query) => {
+  const { body } = await superagent
+    .get(AppData.searchRoute)
+    .query({ query });
+  return body;
+};
+​
+export default searchThings;
+```
+
+## `getRouteUri(route)` ⇒ `String`
+Get URI for a route, same as `getStandaloneUrl` in SiteVision template.   
+https://developer.sitevision.se/docs/webapps/template#h-Methods
+
+**Returns**: <code>String</code> - URI for route.
 
 | Param | Type | Description |
 | --- | --- | --- |
-| route | `String` | A route. |
+| route | <code>String</code> | A route. |
+
 
 #### Example
 ```javascript
 const routeUri = getRouteUri('/my-route');
 ```
+## `getViewUri(route)` ⇒ `String`
+Get URI for a view, same as `getUrl` in SiteVision template.   
+https://developer.sitevision.se/docs/webapps/template#h-Methods
+
+**Returns**: <code>String</code> - URI for view.
+
+| Param | Type | Description |
+| --- | --- | --- |
+| route | <code>String</code> | A route. |
+
+#### Example
+```javascript
+const viewUri = getViewUri('/my-route');
+```
+
 ### `getResourceUri(resource)` ⇒ `String`
 Get URI for a resource.
 
@@ -78,6 +117,7 @@ Get URI for a resource.
 | --- | --- | --- |
 | resource | `String` | A resource. |
 
+
 #### Example
 ```javascript
 const resourceUri = getResourceUri('file/in/resource.png');
@@ -106,3 +146,12 @@ if(isOffline) {
   // Do something
 }
 ```
+
+### `isOnline`
+If the webapp is running in online mode or not.
+
+```javascript
+if(isOnline) {
+  // Do something
+}
+```

package/app-data/.eslintrc

@@ -0,0 +1,4 @@
+{
+  "extends": "@soleil/eslint-config-sitevision/client",
+  "root": true
+}

package/app-data/index.js

@@ -0,0 +1,7 @@
+import { parseAttribute } from '../attribute-util';
+
+/**
+ * Get appData from the currentScript element.
+ * @returns {Object} AppData.
+ */
+export default parseAttribute('data-app');

package/attribute-util/.eslintrc

@@ -0,0 +1,4 @@
+{
+  "extends": "@soleil/eslint-config-sitevision/client",
+  "root": true
+}

package/attribute-util/index.js

@@ -0,0 +1,22 @@
+const { currentScript } = document;
+/**
+ * JSON decode an attribute on the currentScript element.
+ * Use if attribute contains a JSON-object.
+ * @param {String} attribute Attribute to decode.
+ * @returns {Object} Decoded JSON object.
+ */
+export const decodeAttribute = (attribute) => {
+  const encoded = currentScript.getAttribute(attribute);
+  if (encoded) {
+    return decodeURIComponent(encoded);
+  }
+  return undefined;
+};
+
+/**
+ * Parse an attribute on the currentScript element.
+ * Us if the attribute is a String.
+ * @param {String} attribute
+ * @returns {String} Parsed attribute value.
+ */
+export const parseAttribute = (attribute) => JSON.parse(decodeAttribute(attribute));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@soleil-se/app-util",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Utility functions for Webapps.",
   "main": "./src/index.js",
   "author": "Soleil AB",
@@ -14,5 +14,8 @@
   "dependencies": {
     "current-script-polyfill": "^1.0.0"
   },
+  "optionalDependencies": {
+    "vue": "^2.6.11"
+  },
   "devDependencies": {}
 }

package/render-vue/.eslintrc

@@ -1,3 +1,4 @@
 {
-  "extends": "@soleil/eslint-config-sitevision/client"
+  "extends": "@soleil/eslint-config-sitevision/client",
+  "root": true  
 }

package/render-vue/index.js

@@ -1,17 +1,8 @@
 import 'current-script-polyfill';
 import Vue from 'vue';
 
-const { currentScript } = document;
-
-const decodeAttribute = (attribute) => {
-  const encoded = currentScript.getAttribute(attribute);
-  if (encoded) {
-    return decodeURIComponent(encoded);
-  }
-  return undefined;
-};
-
-const parseAttribute = (attribute) => JSON.parse(decodeAttribute(attribute));
+import { decodeAttribute } from '../attribute-util';
+import appData from '../app-data';
 
 const offlineModeMixin = {
   mounted() {
@@ -32,12 +23,12 @@ const offlineModeMixin = {
  */
 export default function render(App) {
   const selector = decodeAttribute('data-selector');
-  const options = parseAttribute('data-app');
+  const options = appData;
 
   Object.assign(App, options, {
     mixins: [offlineModeMixin],
   });
-  
+
   const mountElementExists = !!document.querySelector(selector);
 
   if (mountElementExists) {

package/src/index.js

@@ -1,4 +1,5 @@
 import PortletContextUtil from 'PortletContextUtil';
+import PropertyUtil from 'PropertyUtil';
 import VersionUtil from 'VersionUtil';
 import appInfo from 'appInfo';
 /* Underscore is provided by SiteVision */
@@ -7,8 +8,11 @@ import _ from 'underscore';
 
 /** If the webapp is running in offline mode or not. */
 export const isOffline = VersionUtil.getCurrentVersion() === VersionUtil.OFFLINE_VERSION;
+/** If the webapp is running in online mode or not. */
+export const isOnline = !isOffline;
 
-const portletId = PortletContextUtil.getCurrentPortlet().getIdentifier().replace('.', '_');
+const currentPortlet = PortletContextUtil.getCurrentPortlet();
+const portletId = currentPortlet ? currentPortlet.getIdentifier().replace('.', '_') : '';
 
 /**
  * Get URI for a resource.
@@ -82,7 +86,7 @@ export function renderApp(data, {
 }
 
 /**
- * Get URI for a route.
+ * Get URI for a route, same as `getStandaloneUrl` in SiteVision template.
  * @param {String} route A route.
  * @returns {String} URI for route.
  */
@@ -92,10 +96,22 @@ export function getRouteUri(route) {
   return `/appresource/${currentPageId}/${currentPortletId}/${route}`.replace(/\/\//g, '/');
 }
 
+/**
+ * Get URI for a view, same as `getUrl` in SiteVision template.
+ * @param {String} route A route.
+ * @returns {String} URI for view.
+ */
+export function getViewUri(route) {
+  const currentPageUri = PropertyUtil.getString(PortletContextUtil.getCurrentPage(), 'URI');
+  return `${currentPageUri}?sv.${portletId}.route=${encodeURI(route)}&sv.target=${portletId}`;
+}
+
 export default {
   getRouteUri,
+  getViewUri,
   getResourceUri,
   renderApp,
   renderTemplate,
   isOffline,
+  isOnline,
 };