Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump version up to 1.0.2. #231

Merged
merged 1 commit into from
Aug 6, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CHANGES.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Changes

## Version 1.0.2

Released 2023-08-06

- [(#230) Simplify and expose HpkeError.](https://github.com/dajiaji/hpke-js/pull/230)
- [(#229) Rename \*ContextInterface to \*Context.](https://github.com/dajiaji/hpke-js/pull/229)
- [(#227) Refine tsdoc description.](https://github.com/dajiaji/hpke-js/pull/227)

## Version 1.0.1

Released 2023-08-06
Expand Down
26 changes: 13 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,8 +183,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
// import * as hpke from "https://esm.sh/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
// import * as hpke from "https://esm.sh/[email protected].2";
// ...
</script>

Expand All @@ -201,8 +201,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
// import * as hpke from "https://unpkg.com/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// import * as hpke from "https://unpkg.com/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand Down Expand Up @@ -239,9 +239,9 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
// import * as hpke from "https://deno.land/x/[email protected].1/x/dhkem-x25519/mod.ts";
// import * as hpke from "https://deno.land/x/[email protected].1/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";
// import * as hpke from "https://deno.land/x/[email protected].2/x/dhkem-x25519/mod.ts";
// import * as hpke from "https://deno.land/x/[email protected].2/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand Down Expand Up @@ -285,8 +285,8 @@ Browsers:
<head></head>
<body>
<script type="module">
import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/[email protected].1";
import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -400,15 +400,15 @@ doHpke();
Deno:

```js
import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/[email protected].1/x/dhkem-x25519/mod.ts";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/mod.ts";
import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/[email protected].2/x/dhkem-x25519/mod.ts";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/mod.ts";

async function doHpke() {
// setup
const suite = new CipherSuite({
kem: new DhkemX25519HkdfSha256(),
// If you use "https://deno.land/x/[email protected].1/mod.ts", you can specify it with id as follows:
// If you use "https://deno.land/x/[email protected].2/mod.ts", you can specify it with id as follows:
// kem: KemId.DhkemX25519HkdfSha256,
kdf: KdfId.HkdfSha256,
aead: AeadId.Aes128Gcm,
Expand Down
16 changes: 8 additions & 8 deletions core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
// import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
</script>

<!-- use the latest stable version -->
Expand All @@ -49,8 +49,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import { KemId, KdfId, AeadId, CipherSuite} from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
import { KemId, KdfId, AeadId, CipherSuite} from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand All @@ -75,7 +75,7 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand All @@ -102,8 +102,8 @@ This section shows some typical usage examples.
<head></head>
<body>
<script type="module">
// import * as hpke from "https://esm.sh/[email protected].1";
import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
// import * as hpke from "https://esm.sh/[email protected].2";
import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -189,7 +189,7 @@ doHpke();
### Deno

```js
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";

async function doHpke() {
// setup
Expand Down
2 changes: 1 addition & 1 deletion samples/node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@
"author": "Ajitomi Daisuke <[email protected]> (https://github.com/dajiaji)",
"license": "MIT",
"dependencies": {
"@hpke/core": "^1.0.1"
"@hpke/core": "^1.0.2"
}
}
2 changes: 1 addition & 1 deletion samples/ts-node/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
"author": "Ajitomi Daisuke <[email protected]> (https://github.com/dajiaji)",
"license": "MIT",
"dependencies": {
"@hpke/core": "^1.0.1",
"@hpke/core": "^1.0.2",
"ts-node": "^10.7.0"
}
}
2 changes: 1 addition & 1 deletion src/cipherSuiteNative.ts
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ import * as errors from "./errors.ts";
* @remarks
*
* This is the super class of {@link CipherSuite} and the same as
* {@link https://deno.land/x/hpke@1.0.1/core/mod.ts?s=CipherSuite | @hpke/core#CipherSuite },
* {@link https://deno.land/x/hpke/core/mod.ts?s=CipherSuite | @hpke/core#CipherSuite },
* which supports only the ciphersuites that can be implemented on the native
* {@link https://www.w3.org/TR/WebCryptoAPI/ | Web Cryptography API}.
* Therefore, the following cryptographic algorithms are not supported for now:
Expand Down
22 changes: 11 additions & 11 deletions x/chacha20poly1305/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
import * as chacha20 from "https://esm.sh/@hpke/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
import * as chacha20 from "https://esm.sh/@hpke/[email protected].2";
// ...
</script>

Expand All @@ -49,8 +49,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as chacha20 from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
import * as chacha20 from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand All @@ -75,8 +75,8 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
import * as chacha20 from "https://deno.land/x/[email protected].1/x/chacha20poly1305/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";
import * as chacha20 from "https://deno.land/x/[email protected].2/x/chacha20poly1305/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand Down Expand Up @@ -104,9 +104,9 @@ This section shows some typical usage examples.
<head></head>
<body>
<script type="module">
// import * as hpke from "https://esm.sh/[email protected].1";
import { KemId, KdfId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
import { Chacha20Poly1305 } from "https://esm.sh/@hpke/[email protected].1";
// import * as hpke from "https://esm.sh/[email protected].2";
import { KemId, KdfId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
import { Chacha20Poly1305 } from "https://esm.sh/@hpke/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -193,8 +193,8 @@ doHpke();
### Deno

```js
import { KemId, KdfId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { Chacha20Poly1305 } from "https://deno.land/x/[email protected].1/x/chacha20poly1305/mod.ts";
import { KemId, KdfId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";
import { Chacha20Poly1305 } from "https://deno.land/x/[email protected].2/x/chacha20poly1305/mod.ts";

async function doHpke() {
// setup
Expand Down
20 changes: 10 additions & 10 deletions x/dhkem-secp256k1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
import * as secp256k1 from "https://esm.sh/@hpke/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
import * as secp256k1 from "https://esm.sh/@hpke/[email protected].2";
// ...
</script>

Expand All @@ -52,8 +52,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as secp256k1 from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
import * as secp256k1 from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand All @@ -78,8 +78,8 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
import * as secp256k1 from "https://deno.land/x/[email protected].1/x/dhkem-secp256k1/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";
import * as secp256k1 from "https://deno.land/x/[email protected].2/x/dhkem-secp256k1/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand Down Expand Up @@ -107,8 +107,8 @@ This section shows some typical usage examples.
<head></head>
<body>
<script type="module">
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/[email protected].1";
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -195,8 +195,8 @@ doHpke();
### Deno

```js
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { DhkemSecp256k1HkdfSha256 } from "https://deno.land/x/[email protected].1/x/dhkem-secp256k1/mod.ts";
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";
import { DhkemSecp256k1HkdfSha256 } from "https://deno.land/x/[email protected].2/x/dhkem-secp256k1/mod.ts";

async function doHpke() {
// setup
Expand Down
20 changes: 10 additions & 10 deletions x/dhkem-x25519/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
import * as x25519 from "https://esm.sh/@hpke/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
import * as x25519 from "https://esm.sh/@hpke/[email protected].2";
// ...
</script>

Expand All @@ -49,8 +49,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as x25519 from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
import * as x25519 from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand All @@ -75,8 +75,8 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
import * as x25519 from "https://deno.land/x/[email protected].1/x/dhkem-x25519/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";
import * as x25519 from "https://deno.land/x/[email protected].2/x/dhkem-x25519/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand Down Expand Up @@ -104,8 +104,8 @@ This section shows some typical usage examples.
<head></head>
<body>
<script type="module">
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/[email protected].1";
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -192,8 +192,8 @@ doHpke();
### Deno

```js
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/[email protected].1/x/dhkem-x25519/mod.ts";
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";
import { DhkemX25519HkdfSha256 } from "https://deno.land/x/[email protected].2/x/dhkem-x25519/mod.ts";

async function doHpke() {
// setup
Expand Down
20 changes: 10 additions & 10 deletions x/dhkem-x448/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ Using esm.sh:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://esm.sh/@hpke/[email protected].1";
import * as x448 from "https://esm.sh/@hpke/[email protected].1";
import * as hpke from "https://esm.sh/@hpke/[email protected].2";
import * as x448 from "https://esm.sh/@hpke/[email protected].2";
// ...
</script>

Expand All @@ -49,8 +49,8 @@ Using unpkg:
```html
<!-- use a specific version -->
<script type="module">
import * as hpke from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as x448 from "https://unpkg.com/@hpke/[email protected].1/esm/mod.js";
import * as hpke from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
import * as x448 from "https://unpkg.com/@hpke/[email protected].2/esm/mod.js";
// ...
</script>
```
Expand All @@ -75,8 +75,8 @@ Using deno.land:

```js
// use a specific version
import * as hpke from "https://deno.land/x/[email protected].1/core/mod.ts";
import * as x448 from "https://deno.land/x/[email protected].1/x/dhkem-x448/mod.ts";
import * as hpke from "https://deno.land/x/[email protected].2/core/mod.ts";
import * as x448 from "https://deno.land/x/[email protected].2/x/dhkem-x448/mod.ts";

// use the latest stable version
import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
Expand Down Expand Up @@ -104,8 +104,8 @@ This section shows some typical usage examples.
<head></head>
<body>
<script type="module">
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].1";
import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/[email protected].1";
import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/[email protected].2";
import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/[email protected].2";

globalThis.doHpke = async () => {

Expand Down Expand Up @@ -192,8 +192,8 @@ doHpke();
### Deno

```js
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].1/core/mod.ts";
import { DhkemX448HkdfSha512 } from "https://deno.land/x/[email protected].1/x/dhkem-x448/mod.ts";
import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/[email protected].2/core/mod.ts";
import { DhkemX448HkdfSha512 } from "https://deno.land/x/[email protected].2/x/dhkem-x448/mod.ts";

async function doHpke() {
// setup
Expand Down
Loading