Wq-app

**wq.app 1.0.0** is finally here! This is the first stable release of wq.app 1.0, which is now ready for production use.

Changes since wq.app 1.0.0 RC2

* [wq/model.js](https://wq.io/docs/model-js)
* Handle boolean filter fields (82)
* [wq/app.js](https://wq.io/docs/app-js)
* Include last context in `postdelete` URL render (80)
* Test and fix various EAV filter use cases (wq/wq.db66)
* [wq/map.js](https://wq.io/docs/map-js) / [wq/locate.js](https://wq.io/docs/locate-js)
* Remove `onshow` in favor of better [wq/app.js](https://wq.io/docs/app-js) plugin support (d5f47f2)
* Detect and utilize [cordova-plugin-bluetooth-geolocation](https://github.com/heigeo/cordova-plugin-bluetooth-geolocation) in [wq/locate.js](https://wq.io/docs/locate-js) (1ad8d0d)
* Other fixes (bf00503, 31ed208)
* [Build tool](https://wq.io/docs/build)
* Add separate `splash` option to [wq phonegap](https://wq.io/docs/wq-phonegap) (b5d5788)
* Incorporate default CSS from wq.start template (061afec)

* Incorporate [Code of Conduct](https://github.com/wq/wq.app/blob/master/CODE_OF_CONDUCT.md) and [Contributing Guidelines](https://github.com/wq/wq.app/blob/master/CONTRIBUTING.md)

wq.app RC2 brings a number of minor bug fixes and improvements to [RC1](https://github.com/wq/wq.app/releases/tag/v1.0.0rc1).

* Generate scss folder for swatch tests (87 by tomaszn)
* Update vendored Leaflet & leaflet plugins
* Added `wq-status` option to `<progress>` plugin (7eca458, see [docs](https://wq.io/docs/progress-js))
* Handle case when outbox syncs during a list view data fetch (45162e0)
* Various other fixes (see [commit log](https://github.com/wq/wq.app/compare/v1.0.0rc1...v1.0.0rc2))

**wq.app 1.0.0 RC1** brings enhanced support for PhoneGap/Cordova, an improved offline cache configuration API, and a number of other enhancements.

PhoneGap/Cordova support
* New `wq icons` command to automatically generate icons and splash screens for Android, iOS, and Windows (wq/wq-django-template1, b3e1824, 7677e58, 0d8e196, 6438304, a3f84ab)
* New `wq phonegap` command to automatically generate values for `config.xml`, zip it up together with the built JavaScript application and generated icons, and upload everything to [PhoneGap Build](https://build.phonegap.com) (wq/wq-django-template4, 1d8698d, ).
* Various JavaScript improvements to improve PhoneGap compatibility (08f4764, a576254, c0f8e1d)

The updated [wq django template](https://github.com/wq/wq-django-template) automatically takes advantage of these new features.

New Configuration for Pagination/Offline Caching

The configuration options affecting pagination and offline caching (`per_page`, `partial`, `max_local_pages`, `filter`, and `reversed`) have been unified and replaced with a new `cache` setting. See [Pagination and Caching](https://wq.io/1.0/docs/pagination-and-caching) for details (47, 452b0d2).

Other Improvements & Fixes
Thanks to tomaszn for reporting several of these issues.

Editing & Outbox ([wq/app.js])
* Properly support deletion (80, 4bf65be, 9cb2298)
* Ensure plugins run when loading items from outbox (77, 68efcba)
* Make custom postsave URLs work for items still in outbox (78, 95fb93a)
* Improve editing for nested forms (72, f2ddbe8)
* Improve file support (70, ea5835c, 8b7f577)
* Change default behavior from `loadMissingAsHtml` to `loadMissingAsJson` (02526bf)

Charting
* [wq/pandas.js] improve handling of blank values and field lookups (73 via ast0815, f484f5d)
* [wq/chartapp.js] fix field lookup (3d25c6f)

Maps
* [wq/map.js] more robust handling of wq/app.js pages (d5afe08, 68efcba)
* [wq/mapserv.js] add esri-feature layer type (557a668)
* [wq/locate.js] populate GeoJSON geometry field if present (da13a01)

Other
* [wq/markdown.js] syntax highlighting for server-rendered markdown (014b75d)

[wq/app.js]: https://wq.io/docs/app-js
[wq/pandas.js]: https://wq.io/docs/pandas-js
[wq/chartapp.js]: https://wq.io/docs/chartapp-js
[wq/map.js]: https://wq.io/docs/map-js
[wq/mapserv.js]: https://wq.io/docs/mapserv-js
[wq/locate.js]: https://wq.io/docs/locate-js
[wq/markdown.js]: https://wq.io/docs/markdown-js

**wq.app 1.0 beta 2** brings a lot of cleanup and a few new features. Note that this release is no longer compatible with Internet Explorer 8.

API Improvements
- Flatten the per-page configuration for [wq/map.js](https://wq.io/docs/map-js) to make it more managable. Instead of:

javascript
config.pages[page].map[mode].maps.main.layers = [...];


you can just do

javascript
config.pages[page].map = {
'mode': mode,
'map': 'main', // optional
'layers': [...]
};


Also added the option to pre-register an oneach function (not unlike the pre-registered layer types) so it can be referenced from a JSON configuration object.
- Make it so [wq/outbox.js](https://wq.io/docs/outbox-js) items are accessible via foreign key references even before they are synced. The sync process now automatically determines the proper order to send records to the server and updates the references on the fly. To assign labels to items in the outbox (since the Python `__str__` function is not available), a new `label_template` property is now supported on the configuration object. See the release notes for [wq.db 1.0.0b3](https://github.com/wq/wq.db/releases/tag/v1.0.0b3) for more information.
- Use a recursive in-place serializer for files saved in `localForage` (see localForage/localForage603). Note that the new store uses a different naming convention and the contents of the old offline cache will not be automatically transferred to the new one.
- Support lookups for foreign keys within [natural keys](https://github.com/wq/django-natural-keys), and plugins on server-rendered non-list pages.

Third Party Libraries
- Update Leaflet from 0.7 to 1.0
- Update d3.js from 3.5 to 4.2
- Drop es5-shim and support for IE8
- Drop jquery.validate, proj4, proj4leaflet, and rbush (all rarely used in production wq applications)
- Add [leaflet.wms](https://github.com/heigeo/leaflet.wms) and [localforage-memoryStorageDriver](https://github.com/localForage/localForage-memoryStorageDriver)
- Update most other libraries (except jQuery Mobile which will be updated in a future release)

For the full set of changes, compare the list in [wq.app 1.0.0b1](https://github.com/wq/wq.app/blob/v1.0.0b1/js/README.mdlibrary-versions) vs. [wq.app 1.0.0b2](https://github.com/wq/wq.app/blob/v1.0.0b2/js/README.mdlibrary-versions).

Other modules
- Update `wq/markdown.js` and `wq/progress.js` to work as [wq/app.js plugins](https://wq.io/docs/app-js)
- Add `wq/chartapp.js`, a wq/app.js plugin combining [wq/chart.js](https://wq.io/docs/chart-js) and [wq/pandas.js](https://wq.io/docs/pandas-js)
- Drop `wq/appcache.js`, `wq/online.js`, and `wq/owl.js`

**wq.app 1.0 beta** brings a number of new features and bug fixes to **wq.app 1.0 alpha 2**.

[wq/app.js](https://wq.io/docs/app-js)

Plugin API
- Added two additional asynchronous plugin hooks. Returning a `Promise` from either hook will cause further processing to wait until the `Promise` is resolved.
- `[plugin].context(currentContext, routeInfo)` is called just before rendering a page template. This makes it possible to perform arbitrary asynchronous data lookups before navigating to a new page (30). Think Django's context processors, but on the client and asynchronous.
- `[plugin].onsave(outboxItem, serverResponse)` is called just after a successful outbox submission (344e776). This makes it possible to perform additional work (e.g. custom model updates) before continuing.
- Made all plugin attributes optional, so you can register anonymous plugins - though they won't be configurable (59).

Router / Template Modes
- Added support for arbitrary route modes beyond the default `list`, `detail`, and `edit` (de578f4). Custom modes have URLs of the form `/items/123/custommode` and will be rendered with templates named e.g. `item_custommode.html`. Modes should be specified as part of the page configuration, e.g.:

javascript
{
"name": "item",
"url": "items",
"list": "true",

// Client+server modes
"modes": ["list", "detail", "edit", "custommode"],

// Server-only modes
"server_modes": ["servercustommode"]
}


Both client+server and server-only modes can be specified. Client+server modes will be rendered on the client once `wq/app.js` initializes. Server-only modes are always rendered on the server, but can still take advantage of the plugin infrastructure (`[plugin].run()`). Since wq/app.js automatically loads URLs it doesn't recognize from the server, it is not necessary to register server-only modes if they don't require plugins.
- New `wq/patterns.js` plugin to support the common case of attaching multiple nested records to a single parent form (ee0b6a2).
- `[parent]_label` context variable for foreign keys (2a40fc7).

Other Improvements
- Added `app.nav(url, changePageOptions)` and `app.refresh()` to facilitate common page navigation tasks (ee0b6a2).
- Option to render `postsave` URLs as templates (a2b31d4)

[wq/map.js](https://wq.io/docs/map-js)
- Support multiple maps on the same page (34664cd).
- Switch default basemaps from MapQuest to Stamen, one of the few remaining free providers that doesn't require an API key (68).
- Simplify integration of Esri basemaps via `wq/mapserv.js` (a2e4249).

[wq/model.js](https://wq.io/docs/model-js)
- Allow specifying the store backing the model as a string name (16a7b42). This makes it possible to configure custom model stores via JSON, and initialize them in JavaScript elsewhere.
- Deep-copy items retrieved from indexes to ensure modification doesn't have unexpected side effects (c4b7c34).

Other Fixes
- Ensure `bar-shadow: false` actually disables text shadows in SCSS themes (5bee3ba).
- Code style improvements

Quick update to the [wq.app 1.0 alpha](https://github.com/wq/wq.app/releases/v1.0.0a1) release for better compatibility with [wq.start 1.0.0a1](https://github.com/wq/wq.start/releases/v1.0.0a1).