Skip to content

Commit 40bdb92

Browse files
committed
doc: Release v1.1.5
1 parent 1ceaa7d commit 40bdb92

File tree

3 files changed

+107
-55
lines changed

3 files changed

+107
-55
lines changed

CHANGELOG.md

Lines changed: 71 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,99 @@
1+
# v1.1.5
2+
3+
## Bug Fix
4+
5+
* Fix bug in serializing number-like strings that include plus, with AQF ([@dmaccormack](https://github.com/dmaccormack "Link to profile for user dmaccormack"))
6+
7+
## New Feature
8+
9+
* ignore null array/object member parse option ([@dmaccormack](https://github.com/dmaccormack "Link to profile for user dmaccormack"))
10+
11+
## Dependency Updates
12+
13+
The following dependencies were updated: @babel/core, jsdom, multiple dependencies
14+
115
# v1.1.4
16+
217
## Added
3-
- Add typescript declaration file [view commit](http://github.com/jsonurl/jsonurl-js/commit/13f1fd474b46ba68a544d9ae9a59a34bee0c8a4a)
18+
19+
* Add typescript declaration file [view commit](http://github.com/jsonurl/jsonurl-js/commit/13f1fd474b46ba68a544d9ae9a59a34bee0c8a4a)
20+
421
## Changed
5-
- Update dependencies [view commit](http://github.com/jsonurl/jsonurl-js/commit/9dbebe2f823bb8de9f8a552c972933c1ad2f9866)
22+
23+
* Update dependencies [view commit](http://github.com/jsonurl/jsonurl-js/commit/9dbebe2f823bb8de9f8a552c972933c1ad2f9866)
624

725
# v1.1.3
26+
827
Unpublished.
928

1029
# v1.1.2
30+
1131
## Changed
12-
- Fix interface regression [view commit](http://github.com/jsonurl/jsonurl-js/commit/e4c83f8f13035aa63218d7717442460fdfb27cda)
32+
33+
* Fix interface regression [view commit](http://github.com/jsonurl/jsonurl-js/commit/e4c83f8f13035aa63218d7717442460fdfb27cda)
1334

1435
# v1.1.1
36+
1537
## Added
16-
- Add support for AQF syntax [view commit](http://github.com/jsonurl/jsonurl-js/commit/65a1b09918b5005487b18aa5c66d8fd4a30309aa)
17-
- Add parse and stringify option noEmptyComposite [view commit](http://github.com/jsonurl/jsonurl-js/commit/202fb34b0da3d7358085bea7af2a21e441519b9f)
18-
- Add getMissingValue() parse option [view commit](http://github.com/jsonurl/jsonurl-js/commit/450d00c3127dc63b6606e7891219888b45e6241a)
19-
- Add support for coercing null to empty string on parse/stringify [view commit](http://github.com/jsonurl/jsonurl-js/commit/a564595b984283306ddee1d2aea6cb6d156098a3)
20-
- Add support for empty keys and empty string values [view commit](http://github.com/jsonurl/jsonurl-js/commit/6b94a0dadfc3d5ea8f21218f9bbee1205772f68b)
38+
39+
* Add support for AQF syntax [view commit](http://github.com/jsonurl/jsonurl-js/commit/65a1b09918b5005487b18aa5c66d8fd4a30309aa)
40+
* Add parse and stringify option noEmptyComposite [view commit](http://github.com/jsonurl/jsonurl-js/commit/202fb34b0da3d7358085bea7af2a21e441519b9f)
41+
* Add getMissingValue() parse option [view commit](http://github.com/jsonurl/jsonurl-js/commit/450d00c3127dc63b6606e7891219888b45e6241a)
42+
* Add support for coercing null to empty string on parse/stringify [view commit](http://github.com/jsonurl/jsonurl-js/commit/a564595b984283306ddee1d2aea6cb6d156098a3)
43+
* Add support for empty keys and empty string values [view commit](http://github.com/jsonurl/jsonurl-js/commit/6b94a0dadfc3d5ea8f21218f9bbee1205772f68b)
44+
2145
## Changed
22-
- Ignore extraneous ampersands for wfu-implied-composite values [view commit](http://github.com/jsonurl/jsonurl-js/commit/f288b33fbe9e8e88450a56d0878155dd85c85d1d)
23-
- Upgrade dependencies [view commit](http://github.com/jsonurl/jsonurl-js/commit/045008b511250f9da45ce3f85ed16a05a3b887b4)
24-
- Fix bug when encoding more than one left/right paren in string literal [view commit](http://github.com/jsonurl/jsonurl-js/commit/217ef164776a4fa5c2bd8361fdc5e06b6c0a3c84)
25-
- Upgrade multiple dependencies
46+
47+
* Ignore extraneous ampersands for wfu-implied-composite values [view commit](http://github.com/jsonurl/jsonurl-js/commit/f288b33fbe9e8e88450a56d0878155dd85c85d1d)
48+
* Upgrade dependencies [view commit](http://github.com/jsonurl/jsonurl-js/commit/045008b511250f9da45ce3f85ed16a05a3b887b4)
49+
* Fix bug when encoding more than one left/right paren in string literal [view commit](http://github.com/jsonurl/jsonurl-js/commit/217ef164776a4fa5c2bd8361fdc5e06b6c0a3c84)
50+
* Upgrade multiple dependencies
2651

2752
# v1.0.3
53+
2854
## Added
29-
- Added support for implied string literals [view commit](http://github.com/jsonurl/jsonurl-js/commit/1ff72c6c590be33eb9792e3f26086d893e137534)
55+
56+
* Added support for implied string literals [view commit](http://github.com/jsonurl/jsonurl-js/commit/1ff72c6c590be33eb9792e3f26086d893e137534)
3057

3158
# v1.0.2
59+
3260
## Added
33-
- Add support for x-www-form-urlencoded style separators [view commit](http://github.com/jsonurl/jsonurl-js/commit/2faa2482a176d69f8297f7ab095178dba164d74f)
61+
62+
* Add support for x-www-form-urlencoded style separators [view commit](http://github.com/jsonurl/jsonurl-js/commit/2faa2482a176d69f8297f7ab095178dba164d74f)
63+
3464
## Changed
35-
- update: Fix edge case of apos followed by string literal [view commit](http://github.com/jsonurl/jsonurl-js/commit/4dc2f185bd4862fbe83f49857eca136142c7639e)
36-
- doc: Mark non-exported classes as private [view commit](http://github.com/jsonurl/jsonurl-js/commit/271ab69e76448002692801ff065bb67ac939415f)
37-
- upgrade @babel/cli to 7.11.6
38-
- upgrade eslint to 7.9.0
39-
- upgrade eslint-plugin-jest to 23.18.0
40-
- upgrade jest to 26.4.2
41-
- upgrade jsdoc to 3.6.6
42-
- upgrade prettier to 2.1.2
43-
- upgrade rollup to 2.28.1
44-
- upgrade @rollup/plugin-babel to 5.2.1
45-
- upgrade rollup-plugin-terser to 7.0.2
65+
66+
* update: Fix edge case of apos followed by string literal [view commit](http://github.com/jsonurl/jsonurl-js/commit/4dc2f185bd4862fbe83f49857eca136142c7639e)
67+
* doc: Mark non-exported classes as private [view commit](http://github.com/jsonurl/jsonurl-js/commit/271ab69e76448002692801ff065bb67ac939415f)
68+
* upgrade @babel/cli to 7.11.6
69+
* upgrade eslint to 7.9.0
70+
* upgrade eslint-plugin-jest to 23.18.0
71+
* upgrade jest to 26.4.2
72+
* upgrade jsdoc to 3.6.6
73+
* upgrade prettier to 2.1.2
74+
* upgrade rollup to 2.28.1
75+
* upgrade @rollup/plugin-babel to 5.2.1
76+
* upgrade rollup-plugin-terser to 7.0.2
4677

4778
# v1.0.1
79+
4880
## Added
49-
- Add support for implied arrays and objects [view commit](http://github.com/jsonurl/jsonurl-js/commit/ee83d9c5c6d6cbc1643c721ba223a004ee4e8781)
50-
- Add JSDoc support [view commit](http://github.com/jsonurl/jsonurl-js/commit/5706a2975632201ef574b23dc38d00bb2a154737)
81+
82+
* Add support for implied arrays and objects [view commit](http://github.com/jsonurl/jsonurl-js/commit/ee83d9c5c6d6cbc1643c721ba223a004ee4e8781)
83+
* Add JSDoc support [view commit](http://github.com/jsonurl/jsonurl-js/commit/5706a2975632201ef574b23dc38d00bb2a154737)
84+
5185
## Changed
52-
- upgrade @babel/preset-env to 7.10.4 [view commit](http://github.com/jsonurl/jsonurl-js/commit/0e2019124c303847e21aa2bb0a63ef3bf528a64d)
53-
- upgrade rollup to 2.18.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/ef9ded9e4df15d0d2404f29245e80cc7ae161255)
54-
- upgrade lodash from 4.17.19 [view commit](http://github.com/jsonurl/jsonurl-js/commit/0d78ec646e2731923163fb9641995b5087e82b15)
55-
- upgrade eslint from to 7.3.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/131e5b073e7823d81f480b1f077f8dd1be3299b9)
56-
- upgrade eslint-plugin-prettier to 3.1.4 [view commit](http://github.com/jsonurl/jsonurl-js/commit/80b350a03e894b63a1e34a3cc362635b4f0ea532)
57-
- upgrade eslint-plugin-jest to 23.17.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/684957f78145c30bf2c306a644cb1be4268b7501)
58-
- Do not mix named and default exports [view commit](http://github.com/jsonurl/jsonurl-js/commit/dd772cae0c3501cec252a1ed42387de514b9c6a3)
59-
- Split the test suite into multiple files [view commit](http://github.com/jsonurl/jsonurl-js/commit/60cf88e968e7c408722dc16404150197529feeab)
60-
- Rename main.js -> JsonURL.js [view commit](http://github.com/jsonurl/jsonurl-js/commit/ee83d9c5c6d6cbc1643c721ba223a004ee4e8781)
6186

87+
* upgrade @babel/preset-env to 7.10.4 [view commit](http://github.com/jsonurl/jsonurl-js/commit/0e2019124c303847e21aa2bb0a63ef3bf528a64d)
88+
* upgrade rollup to 2.18.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/ef9ded9e4df15d0d2404f29245e80cc7ae161255)
89+
* upgrade lodash from 4.17.19 [view commit](http://github.com/jsonurl/jsonurl-js/commit/0d78ec646e2731923163fb9641995b5087e82b15)
90+
* upgrade eslint from to 7.3.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/131e5b073e7823d81f480b1f077f8dd1be3299b9)
91+
* upgrade eslint-plugin-prettier to 3.1.4 [view commit](http://github.com/jsonurl/jsonurl-js/commit/80b350a03e894b63a1e34a3cc362635b4f0ea532)
92+
* upgrade eslint-plugin-jest to 23.17.1 [view commit](http://github.com/jsonurl/jsonurl-js/commit/684957f78145c30bf2c306a644cb1be4268b7501)
93+
* Do not mix named and default exports [view commit](http://github.com/jsonurl/jsonurl-js/commit/dd772cae0c3501cec252a1ed42387de514b9c6a3)
94+
* Split the test suite into multiple files [view commit](http://github.com/jsonurl/jsonurl-js/commit/60cf88e968e7c408722dc16404150197529feeab)
95+
* Rename main.js -> JsonURL.js [view commit](http://github.com/jsonurl/jsonurl-js/commit/ee83d9c5c6d6cbc1643c721ba223a004ee4e8781)
6296

6397
# v1.0.0
64-
- Initial release
6598

99+
* Initial release

README.md

Lines changed: 32 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,87 +1,105 @@
1-
# JSON→URL
1+
# JSON→URL
2+
23
[![License: MIT](https://img.shields.io/github/license/jsonurl/jsonurl-js.svg?label=License)][license]
34
[![NPM version](https://img.shields.io/npm/v/@jsonurl/jsonurl.svg)](https://www.npmjs.com/package/@jsonurl/jsonurl)
45
[![CI](https://github.com/jsonurl/jsonurl-js/workflows/ci/badge.svg?branch=main)](https://github.com/jsonurl/jsonurl-js/actions/workflows/ci.yml)
5-
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=alert_status)](https://sonarcloud.io/dashboard?id=jsonurl-js)
6-
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=coverage)](https://sonarcloud.io/dashboard?id=jsonurl-js)
7-
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=ncloc)](https://sonarcloud.io/dashboard?id=jsonurl-js)
8-
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=security_rating)](https://sonarcloud.io/dashboard?id=jsonurl-js)
9-
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=jsonurl-js)
10-
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jsonurl-js)
6+
[![Quality Gate](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=alert_status)](https://sonarcloud.io/dashboard?id=jsonurl-js)
7+
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=coverage)](https://sonarcloud.io/dashboard?id=jsonurl-js)
8+
[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=ncloc)](https://sonarcloud.io/dashboard?id=jsonurl-js)
9+
[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=security_rating)](https://sonarcloud.io/dashboard?id=jsonurl-js)
10+
[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=jsonurl-js)
11+
[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=jsonurl-js\&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=jsonurl-js)
1112
[![Known Vulnerabilities](https://snyk.io/test/github/jsonurl/jsonurl-js/badge.svg?targetFile=package.json)](https://snyk.io/test/github/jsonurl/jsonurl-js?targetFile=package.json)
1213
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js?ref=badge_shield)
1314
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
1415
[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-green)](CONTRIBUTING.md)
1516
[![project chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://jsonurl.zulipchat.com/)
1617

1718
## About
19+
1820
[RFC8259][RFC8259] describes the JSON data model and interchange format, which is widely
1921
used in application-level protocols including RESTful APIs. It is common for
2022
applications to request resources via the HTTP POST method, with JSON entities.
2123
However, POST is suboptimal for requests which do not modify a resource's
22-
state. JSON→URL defines a text format for the JSON data model suitable
24+
state. JSONURL defines a text format for the JSON data model suitable
2325
for use within a [URL][RFC1738]/[URI][RFC3986].
2426

2527
## Usage
26-
JSON→URL is available as a commonjs module (suitable for use in Node), ES6
28+
29+
JSON→URL is available as a commonjs module (suitable for use in Node), ES6
2730
module, or a script that may be used directly in a browser.
2831

2932
### NPM install
33+
3034
```sh
3135
npm install @jsonurl/jsonurl --save
3236
```
3337

3438
### CJS
39+
3540
```js
3641
const JsonURL = require("@jsonurl/jsonurl");
3742
```
43+
3844
### ES6 (Node + Babel)
45+
3946
```js
4047
import JsonURL from "@jsonurl/jsonurl";
4148
```
49+
4250
### Browser script tag
51+
4352
```html
4453
<script
45-
src="https://cdn.jsdelivr.net/npm/@jsonurl/[email protected].4"
46-
integrity="sha384-cAoahJrz7ddx7/ssU1HF42WDaFsYMPIq+INgCzl/qgMHuLWQU+jLtnWzTvJPOcpe"
54+
src="https://cdn.jsdelivr.net/npm/@jsonurl/[email protected].5"
55+
integrity="sha512-PgDMK2pu/5iHU+sUvfCWIKugVg2NLSN1jmQJyJKbQw1MZAMvrU7XX3fPv4FJXgGBxTCsDnjhMmlZK5pzgPndTQ=="
4756
crossorigin="anonymous"></script>
4857
```
4958

5059
### The JavaScript API
60+
5161
Once included, the API is the same for all three.
5262

5363
[![RunKit: Hello, World!](https://img.shields.io/badge/RunKit-Hello%2C%20World!-ff69b4)][runkit1]
64+
5465
```js
5566
let value = JsonURL.parse( "(Hello:World!)" );
5667
let string = JsonURL.stringify( value );
5768
```
5869

59-
If you intend to use JSON&#x2192;URL inside a browser's address bar then you'll want to
70+
If you intend to use JSONURL inside a browser's address bar then you'll want to
6071
enable the AQF (address bar query string friendly) syntax.
6172

6273
[![RunKit: Hello, Browser Address Bar!](https://img.shields.io/badge/RunKit-Hello%2C%20Address%20Bar!-ff69b4)][runkit2]
74+
6375
```js
6476
let value = JsonURL.parse( "(Hello:Address Bar!!)", { AQF: true });
6577
let string = JsonURL.stringify( value, { AQF: true } );
6678
```
6779

6880
There are additional options available, but that's all you need to get started.
6981

70-
JSON&#x2192;URL has no runtime dependencies.
82+
JSONURL has no runtime dependencies.
7183

7284
## Security
85+
7386
The parser is designed to parse untrusted input. It supports limits on
7487
the number of parsed values and depth of nested arrays or objects.
7588
When the limit is exceeded an Error is thrown, and reasonable limit values are
7689
set by default.
7790

7891
[RFC8259]: https://tools.ietf.org/html/rfc8259
92+
7993
[RFC3986]: https://tools.ietf.org/html/rfc3986
94+
8095
[RFC1738]: https://tools.ietf.org/html/rfc1738
96+
8197
[license]: https://opensource.org/licenses/MIT
98+
8299
[runkit1]: https://runkit.com/jsonurl/hello-world
83-
[runkit2]: https://runkit.com/jsonurl/hello-aqf
84100

101+
[runkit2]: https://runkit.com/jsonurl/hello-aqf
85102

86103
## License
104+
87105
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js?ref=badge_large)

SECURITY.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,21 @@ The following versions are actively supported, including security updates.
66

77
| Version | Supported |
88
| ------- | ------------------ |
9-
| 1.1.4 | :white_check_mark: |
10-
| < 1.1.4 | :x: |
9+
| 1.1.5 | :white_check_mark: |
10+
| < 1.1.5 | :x: |
1111

1212
## Reporting a Vulnerability
1313

1414
First: thank you for engaging in responsible disclosure!
1515

1616
If you beleive you've found a vulnerability or other security related issue
17-
please email a complete description to jsonurl.org ``at'' gmail.com.
17+
please email a complete description to jsonurl.org \`\`at'' gmail.com.
1818
If the issue is accepted a discussion will begin on a private
1919
[Zulip][zulip] channel, and you mabe be invited to participate. Once a fix
2020
is in place, and a new release is made, a GitHub security advisory will be
2121
created to make the information public.
2222

23-
If the vulnerability is declined a Github issue may still be created,
23+
If the vulnerability is declined a Github issue may still be created,
2424
and/or the Zulip channel may be made public, to make the discussion public
2525
if the repository owners see value in that. Otherwise, we appreciate your
2626
engagement in responsible disclosure and you are now free to disclose

0 commit comments

Comments
 (0)