refactor!: Issuer.prototype.keystore is now private API

panva · Oct 27, 2021 · 0c23248 · 0c23248
1 parent 83376ac
commit 0c23248
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 20 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -31,7 +31,6 @@ If you or your business use openid-client, please consider becoming a [sponsor][
   - [issuer.Client](#issuerclient)
   - [issuer.FAPIClient](#issuerfapiclient)
   - [issuer.metadata](#issuermetadata)
-  - [issuer.keystore([forceReload])](#issuerkeystoreforcereload)
 - [Issuer.discover(issuer)](#issuerdiscoverissuer)
 - [Issuer.webfinger(input)](#issuerwebfingerinput)
 <!-- TOC Issuer END -->
@@ -111,15 +110,6 @@ Returns metadata from the issuer's discovery document.
 
 ---
 
-#### `issuer.keystore([forceReload])`
-
-Returns the issuer's `jwks_uri` keys as a [`jose`][jose] parsed JWKS.Keystore.
-
-- `forceReload`: `<boolean>` forces a reload of the issuer's jwks_uri. **Default:** 'false'
-- Returns: `Promise<jose.JWKS.KeyStore>`
-
----
-
 #### `Issuer.discover(issuer)`
 
 Loads OpenID Connect 1.0 and/or OAuth 2.0 Authorization Server Metadata documents. When the

diff --git a/lib/issuer.js b/lib/issuer.js
@@ -71,7 +71,7 @@ class Issuer {
 
   /**
    * @name keystore
-   * @api public
+   * @api private
    */
   async keystore(reload = false) {
     assertIssuerConfiguration(this, 'jwks_uri');

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -666,12 +666,6 @@ export class Issuer<TClient extends Client> {
   metadata: IssuerMetadata;
   [custom.http_options]: CustomHttpOptionsProvider;
 
-  /**
-   * Returns the issuer's jwks_uri keys as a `jose` parsed JWKS.Keystore.
-   * @param forceReload forces a reload of the issuer's jwks_uri
-   */
-  keystore(forceReload?: boolean): Promise<jose.JWKS.KeyStore>;
-
   /**
    * Loads OpenID Connect 1.0 and/or OAuth 2.0 Authorization Server Metadata documents.
    * When the issuer argument contains '.well-known' only that document is loaded, otherwise

diff --git a/types/openid-client-tests.ts b/types/openid-client-tests.ts
@@ -13,9 +13,6 @@ async (req: IncomingMessage) => {
     let issuer = await Issuer.discover('https://accounts.google.com');
     console.log('Discovered issuer %O', issuer.metadata.issuer);
 
-    issuer.keystore();
-    issuer.keystore(true);
-
     //
     issuer = new Issuer({
         issuer: 'https://accounts.google.com',