@bedrock/record-cipher 1.0.0 → 1.0.1

package/lib/RecordCipher.js

@@ -169,14 +169,16 @@ export class RecordCipher {
 
   /**
    * Creates a `RecordCipher` instance for encrypting and/or decrypting
-   * record `secrets`. The default encoding mode for the `secrets` is `cbor`,
-   * which supports any binary subfields present in `secrets`. The encoding
-   * can alternatively be set to `json` for backwards compatiblity with
-   * modules that previously encoded using JSON, not CBOR.
+   * record `secrets` (usually secret "keys" of some sort). The default
+   * encoding mode for the `secrets` is `cbor`, which supports any binary
+   * subfields present in `secrets`. The encoding can alternatively be set to
+   * `json` for backwards compatiblity with modules that previously encoded
+   * using JSON, not CBOR.
    *
    * @param {object} options - The options to use.
-   * @param {string} [options.currentKekId] - The ID of the KEK to use for
-   *   new encryptions; may be set to `null` to disable encryption; if not
+   * @param {string} [options.currentKekId] - The ID of the KEK (Key Encryption
+   *   Key, i.e., a key used to encrypt secrets, usually other "keys") to use
+   *   for new encryptions; may be set to `null` to disable encryption; if not
    *   set, it will be automatically set to the first KEK ID in the `keks`
    *   array if it is not empty (otherwise it will be set to `null`).
    * @param {Array} [options.keks=[]] - An array of objects, each with an `id`
@@ -193,7 +195,7 @@ export class RecordCipher {
    */
   static async create({currentKekId, keks = [], encoding = 'cbor'} = {}) {
     if(!(currentKekId === undefined || currentKekId === null ||
-      typeof currentKekId !== 'string')) {
+      typeof currentKekId === 'string')) {
       throw new TypeError('"currentKekId" must be a string or null.');
     }
     if(!Array.isArray(keks)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bedrock/record-cipher",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "type": "module",
   "description": "Bedrock Record Cipher",
   "license": "SEE LICENSE IN LICENSE.md",