Merge pull request #231 from dajiaji/bump-to-1_0_2

Bump version up to 1.0.2.
dajiaji · Aug 6, 2023 · b2666b1 · b2666b1
2 parents 64a756c + e320e2d
commit b2666b1
Show file tree

Hide file tree

Showing 10 changed files with 73 additions and 65 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -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

diff --git a/README.md b/README.md
@@ -183,8 +183,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  // import * as hpke from "https://esm.sh/hpke-js@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  // import * as hpke from "https://esm.sh/hpke-js@1.0.2";
   // ...
 </script>
 
@@ -201,8 +201,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  // import * as hpke from "https://unpkg.com/hpke-js@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  // import * as hpke from "https://unpkg.com/hpke-js@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -239,9 +239,9 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-// import * as hpke from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts";
-// import * as hpke from "https://deno.land/x/hpke@1.0.1/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+// import * as hpke from "https://deno.land/x/hpke@1.0.2/x/dhkem-x25519/mod.ts";
+// import * as hpke from "https://deno.land/x/hpke@1.0.2/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -285,8 +285,8 @@ Browsers:
   <head></head>
   <body>
     <script type="module">
-      import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.1";
-      // import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/hpke-js@1.0.1";
+      import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
+      // import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/hpke-js@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -400,15 +400,15 @@ doHpke();
 Deno:
 
 ```js
-import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts";
-// import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/mod.ts";
+import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke@1.0.2/x/dhkem-x25519/mod.ts";
+// import { KemId, KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/mod.ts";
 
 async function doHpke() {
   // setup
   const suite = new CipherSuite({
     kem: new DhkemX25519HkdfSha256(),
-    // If you use "https://deno.land/x/hpke@1.0.1/mod.ts", you can specify it with id as follows:
+    // If you use "https://deno.land/x/hpke@1.0.2/mod.ts", you can specify it with id as follows:
     // kem: KemId.DhkemX25519HkdfSha256, 
     kdf: KdfId.HkdfSha256,
     aead: AeadId.Aes128Gcm,

diff --git a/core/README.md b/core/README.md
@@ -33,8 +33,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  // import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  // import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
 </script>
 
 <!-- use the latest stable version -->
@@ -49,8 +49,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  import { KemId, KdfId, AeadId, CipherSuite} from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  import { KemId, KdfId, AeadId, CipherSuite} from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -75,7 +75,7 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -102,8 +102,8 @@ This section shows some typical usage examples.
   <head></head>
   <body>
     <script type="module">
-      // import * as hpke from "https://esm.sh/hpke-js@1.0.1";
-      import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.1";
+      // import * as hpke from "https://esm.sh/hpke-js@1.0.2";
+      import { KemId, KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -189,7 +189,7 @@ doHpke();
 ### Deno
 
 ```js
-import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
+import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
 
 async function doHpke() {
   // setup

diff --git a/samples/node/package.json b/samples/node/package.json
@@ -7,6 +7,6 @@
   "author": "Ajitomi Daisuke <ajitomi@gmail.com> (https://github.com/dajiaji)",
   "license": "MIT",
   "dependencies": {
-    "@hpke/core": "^1.0.1"
+    "@hpke/core": "^1.0.2"
   }
 }
diff --git a/samples/ts-node/package.json b/samples/ts-node/package.json
@@ -6,7 +6,7 @@
   "author": "Ajitomi Daisuke <ajitomi@gmail.com> (https://github.com/dajiaji)",
   "license": "MIT",
   "dependencies": {
-    "@hpke/core": "^1.0.1",
+    "@hpke/core": "^1.0.2",
     "ts-node": "^10.7.0"
   }
 }
diff --git a/src/cipherSuiteNative.ts b/src/cipherSuiteNative.ts
@@ -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:

diff --git a/x/chacha20poly1305/README.md b/x/chacha20poly1305/README.md
@@ -31,8 +31,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  import * as chacha20 from "https://esm.sh/@hpke/chacha20poly1305@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  import * as chacha20 from "https://esm.sh/@hpke/chacha20poly1305@1.0.2";
   // ...
 </script>
 
@@ -49,8 +49,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  import * as chacha20 from "https://unpkg.com/@hpke/chacha20poly1305@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  import * as chacha20 from "https://unpkg.com/@hpke/chacha20poly1305@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -75,8 +75,8 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import * as chacha20 from "https://deno.land/x/hpke@1.0.1/x/chacha20poly1305/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import * as chacha20 from "https://deno.land/x/hpke@1.0.2/x/chacha20poly1305/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -104,9 +104,9 @@ This section shows some typical usage examples.
   <head></head>
   <body>
     <script type="module">
-      // import * as hpke from "https://esm.sh/hpke-js@1.0.1";
-      import { KemId, KdfId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.1";
-      import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305@1.0.1";
+      // import * as hpke from "https://esm.sh/hpke-js@1.0.2";
+      import { KemId, KdfId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
+      import { Chacha20Poly1305 } from "https://esm.sh/@hpke/chacha20poly1305@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -193,8 +193,8 @@ doHpke();
 ### Deno
 
 ```js
-import { KemId, KdfId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import { Chacha20Poly1305 } from "https://deno.land/x/hpke@1.0.1/x/chacha20poly1305/mod.ts";
+import { KemId, KdfId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import { Chacha20Poly1305 } from "https://deno.land/x/hpke@1.0.2/x/chacha20poly1305/mod.ts";
 
 async function doHpke() {
   // setup

diff --git a/x/dhkem-secp256k1/README.md b/x/dhkem-secp256k1/README.md
@@ -34,8 +34,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  import * as secp256k1 from "https://esm.sh/@hpke/dhkem-secp256k1@1.0.2";
   // ...
 </script>
 
@@ -52,8 +52,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  import * as secp256k1 from "https://unpkg.com/@hpke/dhkem-secp256k1@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  import * as secp256k1 from "https://unpkg.com/@hpke/dhkem-secp256k1@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -78,8 +78,8 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import * as secp256k1 from "https://deno.land/x/hpke@1.0.1/x/dhkem-secp256k1/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import * as secp256k1 from "https://deno.land/x/hpke@1.0.2/x/dhkem-secp256k1/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -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/core@1.0.1";
-      import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/dhkem-secp256k1@1.0.1";
+      import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
+      import { DhkemSecp256k1HkdfSha256 } from "https://esm.sh/@hpke/dhkem-secp256k1@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -195,8 +195,8 @@ doHpke();
 ### Deno
 
 ```js
-import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import { DhkemSecp256k1HkdfSha256 } from "https://deno.land/x/hpke@1.0.1/x/dhkem-secp256k1/mod.ts";
+import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import { DhkemSecp256k1HkdfSha256 } from "https://deno.land/x/hpke@1.0.2/x/dhkem-secp256k1/mod.ts";
 
 async function doHpke() {
   // setup

diff --git a/x/dhkem-x25519/README.md b/x/dhkem-x25519/README.md
@@ -31,8 +31,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  import * as x25519 from "https://esm.sh/@hpke/dhkem-x25519@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  import * as x25519 from "https://esm.sh/@hpke/dhkem-x25519@1.0.2";
   // ...
 </script>
 
@@ -49,8 +49,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  import * as x25519 from "https://unpkg.com/@hpke/dhkem-x25519@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  import * as x25519 from "https://unpkg.com/@hpke/dhkem-x25519@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -75,8 +75,8 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import * as x25519 from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import * as x25519 from "https://deno.land/x/hpke@1.0.2/x/dhkem-x25519/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -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/core@1.0.1";
-      import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519@1.0.1";
+      import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
+      import { DhkemX25519HkdfSha256 } from "https://esm.sh/@hpke/dhkem-x25519@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -192,8 +192,8 @@ doHpke();
 ### Deno
 
 ```js
-import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke@1.0.1/x/dhkem-x25519/mod.ts";
+import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import { DhkemX25519HkdfSha256 } from "https://deno.land/x/hpke@1.0.2/x/dhkem-x25519/mod.ts";
 
 async function doHpke() {
   // setup

diff --git a/x/dhkem-x448/README.md b/x/dhkem-x448/README.md
@@ -31,8 +31,8 @@ Using esm.sh:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://esm.sh/@hpke/core@1.0.1";
-  import * as x448 from "https://esm.sh/@hpke/dhkem-x448@1.0.1";
+  import * as hpke from "https://esm.sh/@hpke/core@1.0.2";
+  import * as x448 from "https://esm.sh/@hpke/dhkem-x448@1.0.2";
   // ...
 </script>
 
@@ -49,8 +49,8 @@ Using unpkg:
 ```html
 <!-- use a specific version -->
 <script type="module">
-  import * as hpke from "https://unpkg.com/@hpke/core@1.0.1/esm/mod.js";
-  import * as x448 from "https://unpkg.com/@hpke/dhkem-x448@1.0.1/esm/mod.js";
+  import * as hpke from "https://unpkg.com/@hpke/core@1.0.2/esm/mod.js";
+  import * as x448 from "https://unpkg.com/@hpke/dhkem-x448@1.0.2/esm/mod.js";
   // ...
 </script>
 ```
@@ -75,8 +75,8 @@ Using deno.land:
 
 ```js
 // use a specific version
-import * as hpke from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import * as x448 from "https://deno.land/x/hpke@1.0.1/x/dhkem-x448/mod.ts";
+import * as hpke from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import * as x448 from "https://deno.land/x/hpke@1.0.2/x/dhkem-x448/mod.ts";
 
 // use the latest stable version
 import * as hpke from "https://deno.land/x/hpke/core/mod.ts";
@@ -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/core@1.0.1";
-      import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/dhkem-x448@1.0.1";
+      import { KdfId, AeadId, CipherSuite } from "https://esm.sh/@hpke/core@1.0.2";
+      import { DhkemX448HkdfSha512 } from "https://esm.sh/@hpke/dhkem-x448@1.0.2";
 
       globalThis.doHpke = async () => {
 
@@ -192,8 +192,8 @@ doHpke();
 ### Deno
 
 ```js
-import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.1/core/mod.ts";
-import { DhkemX448HkdfSha512 } from "https://deno.land/x/hpke@1.0.1/x/dhkem-x448/mod.ts";
+import { KdfId, AeadId, CipherSuite } from "https://deno.land/x/hpke@1.0.2/core/mod.ts";
+import { DhkemX448HkdfSha512 } from "https://deno.land/x/hpke@1.0.2/x/dhkem-x448/mod.ts";
 
 async function doHpke() {
   // setup