refactor: hide internal private fields and drop ProduceJWT inheritance

Author: panva

docs/jwe/general/encrypt/interfaces/Recipient.md

@@ -12,7 +12,7 @@ Used to build General JWE object's individual recipients.
 
 ▸ **addRecipient**(...`args`): [`Recipient`](Recipient.md)
 
-A shorthand for calling addRecipient() on the enclosing GeneralEncrypt instance
+A shorthand for calling addRecipient() on the enclosing [GeneralEncrypt](../classes/GeneralEncrypt.md) instance
 
 #### Parameters
 
@@ -30,7 +30,7 @@ A shorthand for calling addRecipient() on the enclosing GeneralEncrypt instance
 
 ▸ **done**(): [`GeneralEncrypt`](../classes/GeneralEncrypt.md)
 
-Returns the enclosing GeneralEncrypt
+Returns the enclosing [GeneralEncrypt](../classes/GeneralEncrypt.md) instance
 
 #### Returns
 
@@ -42,7 +42,7 @@ Returns the enclosing GeneralEncrypt
 
 ▸ **encrypt**(...`args`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralJWE`](../../../../types/interfaces/GeneralJWE.md)\>
 
-A shorthand for calling encrypt() on the enclosing GeneralEncrypt instance
+A shorthand for calling encrypt() on the enclosing [GeneralEncrypt](../classes/GeneralEncrypt.md) instance
 
 #### Parameters
 

docs/jws/general/sign/interfaces/Signature.md

@@ -12,7 +12,7 @@ Used to build General JWS object's individual signatures.
 
 ▸ **addSignature**(...`args`): [`Signature`](Signature.md)
 
-A shorthand for calling addSignature() on the enclosing GeneralSign instance
+A shorthand for calling addSignature() on the enclosing [GeneralSign](../classes/GeneralSign.md) instance
 
 #### Parameters
 
@@ -30,7 +30,7 @@ A shorthand for calling addSignature() on the enclosing GeneralSign instance
 
 ▸ **done**(): [`GeneralSign`](../classes/GeneralSign.md)
 
-Returns the enclosing GeneralSign
+Returns the enclosing [GeneralSign](../classes/GeneralSign.md) instance
 
 #### Returns
 
@@ -78,7 +78,7 @@ Sets the JWS Unprotected Header on the Signature object.
 
 ▸ **sign**(...`args`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`GeneralJWS`](../../../../types/interfaces/GeneralJWS.md)\>
 
-A shorthand for calling encrypt() on the enclosing GeneralSign instance
+A shorthand for calling encrypt() on the enclosing [GeneralSign](../classes/GeneralSign.md) instance
 
 #### Parameters
 

docs/jwt/produce/README.md

@@ -42,6 +42,7 @@
 - [JWTPayload](interfaces/JWTPayload.md)
 - [JWTVerifyResult](interfaces/JWTVerifyResult.md)
 - [KeyObject](interfaces/KeyObject.md)
+- [ProduceJWT](interfaces/ProduceJWT.md)
 - [ResolvedKey](interfaces/ResolvedKey.md)
 - [SignOptions](interfaces/SignOptions.md)
 - [VerifyOptions](interfaces/VerifyOptions.md)

docs/types/README.md

@@ -1,28 +1,10 @@
-# Class: ProduceJWT
+# Interface: ProduceJWT
 
 ## [💗 Help the project](https://github.com/sponsors/panva)
 
 Support from the community to continue maintaining and improving this module is welcome. If you find the module useful, please consider supporting the project by [becoming a sponsor](https://github.com/sponsors/panva).
 
-Generic class for JWT producing.
-
-## Constructors
-
-### new ProduceJWT()
-
-▸ **new ProduceJWT**(`payload`): [`ProduceJWT`](ProduceJWT.md)
-
-[ProduceJWT](ProduceJWT.md) constructor
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `payload` | [`JWTPayload`](../../../types/interfaces/JWTPayload.md) | The JWT Claims Set object. Defaults to an empty object. |
-
-#### Returns
-
-[`ProduceJWT`](ProduceJWT.md)
+Generic interface for JWT producing classes.
 
 ## Methods
 

docs/jwt/produce/classes/ProduceJWT.md renamed to docs/types/interfaces/ProduceJWT.md

@@ -24,10 +24,6 @@ if (err instanceof jose.errors.JWTExpired) {
 }
 ```
 
-## Implements
-
-- [`JWTClaimValidationFailed`](JWTClaimValidationFailed.md)
-
 ## Properties
 
 ### claim

docs/util/errors/classes/JWTExpired.md

@@ -31,6 +31,25 @@ index 3bac9b3..147c793 100644
      const md = [];
      if (model.implementationOf) {
          if (options.headingLevel !== -1) {
+diff --git a/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.memberWithGroups.js b/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.memberWithGroups.js
+index 98bc919..4854c90 100644
+--- a/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.memberWithGroups.js
++++ b/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.memberWithGroups.js
+@@ -24,10 +24,10 @@ export function memberWithGroups(model, options) {
+             md.push(this.partials.typeParametersList(model.typeParameters));
+         }
+     }
+-    if (model.implementedTypes?.length) {
+-        md.push(heading(options.headingLevel, this.i18n.theme_implements()));
+-        md.push(unorderedList(model.implementedTypes.map((implementedType) => this.partials.someType(implementedType))));
+-    }
++    // if (model.implementedTypes?.length) {
++    //     md.push(heading(options.headingLevel, this.i18n.theme_implements()));
++    //     md.push(unorderedList(model.implementedTypes.map((implementedType) => this.partials.someType(implementedType))));
++    // }
+     if (model.kind === ReflectionKind.Class && model.categories?.length) {
+         model.groups
+             ?.filter((group) => group.title === this.i18n.kind_plural_constructor())
 diff --git a/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.reflectionIndex.js b/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.reflectionIndex.js
 index bcb597c..d96c2eb 100644
 --- a/node_modules/typedoc-plugin-markdown/dist/theme/context/partials/member.reflectionIndex.js

patches/typedoc-plugin-markdown+4.3.1.patch

@@ -18,7 +18,6 @@ export { jwtVerify } from './jwt/verify.js'
 export type { JWTVerifyOptions, JWTVerifyGetKey } from './jwt/verify.js'
 export { jwtDecrypt } from './jwt/decrypt.js'
 export type { JWTDecryptOptions, JWTDecryptGetKey } from './jwt/decrypt.js'
-export type { ProduceJWT } from './jwt/produce.js'
 
 export { CompactEncrypt } from './jwe/compact/encrypt.js'
 export { FlattenedEncrypt } from './jwe/flattened/encrypt.js'
@@ -104,6 +103,7 @@ export type {
   JWTPayload,
   JWTVerifyResult,
   KeyObject,
+  ProduceJWT,
   ResolvedKey,
   SignOptions,
   VerifyOptions,

src/index.ts

@@ -26,16 +26,15 @@ import { FlattenedEncrypt } from '../flattened/encrypt.js'
  * ```
  */
 export class CompactEncrypt {
-  /** @ignore */
-  private _flattened: FlattenedEncrypt
+  #flattened: FlattenedEncrypt
 
   /**
    * {@link CompactEncrypt} constructor
    *
    * @param plaintext Binary representation of the plaintext to encrypt.
    */
   constructor(plaintext: Uint8Array) {
-    this._flattened = new FlattenedEncrypt(plaintext)
+    this.#flattened = new FlattenedEncrypt(plaintext)
   }
 
   /**
@@ -48,7 +47,7 @@ export class CompactEncrypt {
    * @param cek JWE Content Encryption Key.
    */
   setContentEncryptionKey(cek: Uint8Array): this {
-    this._flattened.setContentEncryptionKey(cek)
+    this.#flattened.setContentEncryptionKey(cek)
     return this
   }
 
@@ -62,7 +61,7 @@ export class CompactEncrypt {
    * @param iv JWE Initialization Vector.
    */
   setInitializationVector(iv: Uint8Array): this {
-    this._flattened.setInitializationVector(iv)
+    this.#flattened.setInitializationVector(iv)
     return this
   }
 
@@ -72,7 +71,7 @@ export class CompactEncrypt {
    * @param protectedHeader JWE Protected Header object.
    */
   setProtectedHeader(protectedHeader: types.CompactJWEHeaderParameters): this {
-    this._flattened.setProtectedHeader(protectedHeader)
+    this.#flattened.setProtectedHeader(protectedHeader)
     return this
   }
 
@@ -84,7 +83,7 @@ export class CompactEncrypt {
    * @param parameters JWE Key Management parameters.
    */
   setKeyManagementParameters(parameters: types.JWEKeyManagementHeaderParameters): this {
-    this._flattened.setKeyManagementParameters(parameters)
+    this.#flattened.setKeyManagementParameters(parameters)
     return this
   }
 
@@ -99,7 +98,7 @@ export class CompactEncrypt {
     key: types.CryptoKey | types.KeyObject | types.JWK | Uint8Array,
     options?: types.EncryptOptions,
   ): Promise<string> {
-    const jwe = await this._flattened.encrypt(key, options)
+    const jwe = await this.#flattened.encrypt(key, options)
 
     return [jwe.protected, jwe.encrypted_key, jwe.iv, jwe.ciphertext, jwe.tag].join('.')
   }