RevelaNetwork/Revela
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

rework changelog

Browse source
This commit is contained in:
David Reed 2022-12-08 18:21:04 -05:00
parent 9a4bd531fc
commit 875187b310
No known key found for this signature in database
GPG key ID: 2211691D8A1EE72F
1 changed files with 22 additions and 51 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
CHANGELOG.md
View file

@ -1,59 +1,30 @@
# v1.0.4 # v1.0.4
`uv.client.js` is now a bundle. Make sure this file is accounted for in any workflows (eg. extracting the tarball automatically). - This version of Ultraviolet introduces support for passing a list of Bare servers in the `uv.config.js` file. This allows users to specify multiple servers that the service worker can choose from, improving reliability and failover.
- Minor bug fixes (caught with ESLint) and improvements.
See the release on [GitHub](https://github.com/titaniumnetwork-dev/Ultraviolet/releases/tag/v1.0.4-beta) for more details. - The [@tomphttp/bare-client](https://www.npmjs.com/package/@tomphttp/bare-client) package has been implemented, allowing users to use Ultraviolet with Bare server V2 and older versions of the Bare server.
- In previous versions, the `uv.client.js` script was bundled with `uv.bundle.js`. In this version, `uv.client.js` is separate and needs to be included separately in any workflows that use it.
# v1.0.4-beta.x
- Provide randomly chosen bare server URL & refactor (bare server load balancing)
# v1.0.4-beta.6
Fixes:
- Cookies not being set (fixes Recaptcha, Google sign-in)
- Source map errors (webpack)
# v1.0.4-beta
Experimental Bare Server v2 support
- Accomplished by using @tomphttp/bare-client
- More stable
- Faster (caching)
### Pre-Update (Memory)
<img src="https://cdn.discordapp.com/attachments/951957740337643543/1043383736227598396/image.png">
### Post Update (Memory)
<img src="https://cdn.discordapp.com/attachments/959140616149794816/1048364779787530330/image.png">
# v1.0.3 # v1.0.3
Stable release. - In previous versions, the `uvPath` export was the default export from the Ultraviolet module. In this version, `uvPath` is no longer the default export and needs to be imported explicitly.
- Here is an example of how to import the library:
```js
import { uvPath } from '@titaniumnetwork-dev/ultraviolet';
```
# v1.0.2 # v1.0.2
This package now targets CommonJS. - This version of Ultraviolet is built using CommonJS, which means it can be used with CommonJS-based module systems such as Node.js.
- This version also includes a stock `sw.js` script that users can use as a starting point for their service worker.
# v1.0.1 # v1.0.1
In your `sw.js` script, you MUST import `uv.bundle.js` then `uv.config.js` in order. This is because we can no longer hard-code the paths. Ideally, we would import `uv.config.js` then use the config.bundle path in the serviceworker, however the config is dependant on `uv.bundle.js`, which we don't know the location to. - In the `sw.js` script, users must now import `uv.bundle.js` and `uv.config.js` in that order. This is because `uv.config.js` relies on `uv.bundle.js`, and the paths to these files cannot be hard-coded in the `sw.js` script.
- Minor bug fixes and improvements.
Old: - Users must still use the `uv.config.js` file to specify the paths to all the Ultraviolet scripts, including `uv.bundle.js` and `uv.config.js`.
- Here an example of the changes you might make to your `sw.js` script in this Ultraviolet version:
```js
importScripts('./uv/uv.sw.js');
const sw = new UVServiceWorker();
self.addEventListener('fetch', (event) => event.respondWith(sw.fetch(event)));
```
New:
```diff ```diff
+ importScripts('./uv/uv.bundle.js'); + importScripts('./uv/uv.bundle.js');
@ -62,11 +33,11 @@ importScripts('./uv/uv.sw.js');
const sw = new UVServiceWorker(); const sw = new UVServiceWorker();
self.addEventListener('fetch', event => self.addEventListener('fetch', (event) => event.respondWith(sw.fetch(event)));
event.respondWith(
sw.fetch(event)
)
);
``` ```
You are still required to specify all paths in `uv.config.js`. # v1.0.0
- This is the first official release of the Ultraviolet library.
- The `uv.bundle.js` script is built using Webpack, allowing users to easily bundle their own scripts and dependencies with Ultraviolet.
- This project is still under active development, and future releases will include new features and improvements.