@soleil-se/app-util 3.0.3 → 4.0.0

package/CHANGELOG.md

@@ -1,24 +1,26 @@
-# Change Log
-
+# Changelog
 All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-## [3.0.3](https://github.com/soleilit/server-monorepo/compare/@soleil-api/webapp-util@3.0.2...@soleil-api/webapp-util@3.0.3) (2020-11-03)
-
-**Note:** Version bump only for package @soleil-api/webapp-util
-
 
+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).
 
+## [4.0.0] - 2021-01-27
+A much needed major overhaul of the package.   
+See [MIGRATION](./MIGRATION.md).
 
+### Changed
+- Major refactoring of package.
+- Exports for render functions are moved. 
+- All documented constants and functions from base import (`@soleil-api/webapp-util`) now works both in a server and client context.
 
-# Changelog
-All notable changes to this project will be documented in this file.
+### Removed
+- `noScript` option in `render` (formerly `renderApp`) has been removed. If a no script message is needed use the `html` option wrapped in `<noscript>`.
+- `@soleil-api/webapp-util/app-data` has been removed, use [getAppData](./README.md#getAppData) from `@soleil-api/webapp-util`.
 
-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).
+## [3.0.3] - 2020-11-03
+- Nothing, Lerna wanted to publish...
 
 ## [3.0.2] - 2020-10-19
-### Added
 - Nothing, Lerna wanted to publish...
 
 ## [3.0.1] - 2020-09-28
@@ -79,20 +81,3 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `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/MIGRATION.md

@@ -0,0 +1,136 @@
+# Migration
+
+Migration from version 2 or 3 to 4.
+
+<!-- TOC -->
+
+- [renderApp](#renderapp)
+- [renderTemplate](#rendertemplate)
+- [getRouteUri](#getrouteuri)
+- [AppData](#appdata)
+  - [Get data](#get-data)
+  - [Standard values](#standard-values)
+- [Svelte](#svelte)
+  - [Server](#server)
+  - [Client](#client)
+- [Vue](#vue)
+
+<!-- /TOC -->
+
+## renderApp
+Export moved and renamed.
+
+Old:
+```js
+import { renderApp } from '@soleil-api/webapp-util';
+```
+New:
+```js
+import { render } from '@soleil-api/webapp-util/server';
+```
+## renderTemplate
+Export moved.   
+
+Old:
+```js
+import { renderTemplate } from '@soleil-api/webapp-util';
+```
+New:
+```js
+import { renderTemplate } from '@soleil-api/webapp-util/server';
+```
+## getRouteUri
+URIs for routes was previously passed as props when rendering an application. This is no longer needed.   
+Now you can use `getRouteUri` in a client context as well.  
+
+Old:
+```js
+import AppData from '@soleil-api/webapp-util/app-data';
+
+const getItems = async () => {
+  return fetch(AppData.itemsRoute)
+    .then((res) => res.json());
+};
+``` 
+New:
+```js
+import { getRouteUri } from '@soleil-api/webapp-util';
+
+const getItems = async () => {
+  return fetch(getRouteUri('/items'))
+    .then((res) => res.json());
+};
+```
+## AppData
+
+### Get data
+The default export as object and `@soleil-api/webapp-util/app-data` import is removed.
+
+Old:
+```js
+import AppData from '@soleil-api/webapp-util/app-data';
+
+const { myValue } = AppData;
+```
+New:
+```js
+import { getAppData } from '@soleil-api/webapp-util';
+
+// Get value with key
+const myValue = getAppData('myValue');
+// Or with destructuring
+const { myValue } = getAppData();
+```
+### Standard values
+Values that was set as sandard are now moved.
+
+Old:
+```js
+import AppData from '@soleil-api/webapp-util/app-data';
+
+const { isOnline, isOffline, uniqueId } = AppData;
+```
+New:
+```js
+import { isOffline, isOnline, getNamespace } from '@soleil-api/webapp-util';
+
+const uniqueId = getNamespace();
+```
+
+## Svelte
+### Server
+Export moved.   
+Export `renderClient` is removed, use `render` from `'@soleil-api/webapp-util/server`
+
+Old:
+```js
+import { render } from '@soleil-api/webapp-util/svelte-server';
+```
+New:
+```js
+import { render } from '@soleil-api/webapp-util/server/svelte';
+```
+### Client
+Export moved.
+
+Old:
+```js
+import { render } from '@soleil-api/webapp-util/svelte-client';
+```
+New:
+```js
+import { render } from '@soleil-api/webapp-util/client/svelte';
+```
+
+## Vue
+Export moved.
+
+Old:
+```js
+import render from '@soleil-api/webapp-util/render-vue';
+```
+New:
+```js
+import { render } from '@soleil-api/webapp-util/client/vue';
+```
+