@livinglogic/livingapi 1.0.0 → 1.1.1

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Changes
 
+## 1.1.0 (2023-03-17)
+
+Add `Panel` attributes `header_type`, `header_background`, `text_color`,
+`background_color1` and `background_color2`.
+
+
+## 1.0.1 (2023-03-16)
+
+Fixed name of the attribute for the "nothing selected" option: `nonekey` has
+been renamed to `none_key` and `nonelabel` has been renamed to `none_label`.
+
+Added the class `MenuItem` and `Panel` and the `App` attributes `menus` and
+`panel` for the menus/panels that appear on various LivingApps pages.
+
+Added attribute `App.datasource`.
+
+Fixed name of "geo distance" method (`Globals.dist()`).
+
+
 ## 1.0.0 (2023-02-02)
 
 The image of a `ImageLayoutControl` can now be changed (via Javascript and UL4).

package/HOWTO-release.md

@@ -0,0 +1,74 @@
+# How to release a new LivingAPI version
+
+
+## Requirements
+
+This project uses "git flow", so to be able to properly create releases you
+have to execute `git flow init` once.
+
+Also you need to have `npm` installed, and you need to have run `npm install`
+once.
+
+
+## During development
+
+Document changes in `CHANGELOG.md`. Ideally this is done during development.
+If not, do a diff against the last released version and document the changes
+you see.
+
+
+## Preparing for a release
+
+1.	When the time comes for a release, open a release branch like this:
+
+	```
+	git flow release start x.y.z
+	```
+
+	(using the correct version number).
+
+2. Bump the version number in `package.json`. Since the version number is
+	incorporated into the generated source and the generated source is checked
+	in, you have to build the release files, after you update the version number
+	like this:
+	
+	```
+	npm run build
+	```
+	
+	This should rebuild `dist/umd/livingapi.js`, `dist/umd/livingapi.js.map`,
+	`dist/esm-node/livingapi.js`, `dist/esm-node/livingapi.js.map`,
+	`dist/esm-static/livingapi.js` and `dist/esm-static/livingapi.js.map`.
+
+3.	Update UL4 and LivingAPI version number in the example code in `README.md`.
+
+4. Check in the resulting changes.
+
+5.	Close the release branch with the following command:
+
+	```
+	git flow release finish x.y.z
+	```
+
+	(using the same version number that you used in step 1).
+
+6.	Push all changes to the internal Gitlab instance with:
+
+	```
+	git push --all
+	```
+
+	The internal Gitlab instance will automatically mirror what you pushed to
+	`github.com`.
+
+
+## Releasing the new version on `npmjs.org`
+
+To push the finish release to `npmjs.org` do the following:
+
+```
+npm publish --access public
+```
+
+The release should be visible at https://www.npmjs.com/package/@livinglogic/livingapi
+after this.

package/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright 2016-2018 by LivingLogic AG, Bayreuth/Germany
+Copyright 2016-2023 by LivingLogic AG, Bayreuth/Germany
 
 All Rights Reserved
 

package/README.md

@@ -9,7 +9,7 @@ For more info about LivingApps and the LivingAPI see
 https://my.living-apps.de/docs/LivingAPI.html (in german).
 
 
-# Build instructions
+## Build instructions
 
 Install the npm packages:
 
@@ -25,7 +25,7 @@ npm run build
 ```
 
 
-# Using the LivingAPI in your project
+## Using the LivingAPI in your project
 
 In your HTML include the following:
 
@@ -41,7 +41,7 @@ do
 
 ```html
 <script type="module">
-	import * as la from '/static/livingapi/0.13.0/dist/esm-static/livingapi.js';
+	import * as la from '/static/livingapi/1.0.1/dist/esm-static/livingapi.js';
 	...
 </script>
 ```
@@ -50,15 +50,13 @@ or (if you need both UL4 and LivingAPI):
 
 ```html
 <script type="module">
-	import * as ul4 from '/static/ul4/1.11.0/dist/esm/ul4.js';
-	import * as la from '/static/livingapi/0.13.0/dist/esm-static/livingapi.js';
+	import * as ul4 from '/static/ul4/1.15.2/dist/esm/ul4.js';
+	import * as la from '/static/livingapi/1.0.1/dist/esm-static/livingapi.js';
 	...
 </script>
 ```
 
-
-
-# Authors
+## Authors
 
 - Walter Dörwald: `ul4.js` and `livingapi.js`