oauth2-cli 0.8.2 → 0.8.4

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.8.4](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.8.3...oauth2-cli/0.8.4) (2026-02-19)
+
+
+### Features
+
+* human-readable client name for clarity ([68b4287](https://github.com/battis/oauth2-cli/commit/68b42872998ec423440d07447012282528e3ee76))
+
+## [0.8.3](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.8.2...oauth2-cli/0.8.3) (2026-02-18)
+
+
+### Bug Fixes
+
+* continued server timeout improvements ([2e8d275](https://github.com/battis/oauth2-cli/commit/2e8d275706be411b317e2257bd97ee8f7fe4bc95))
+
 ## [0.8.2](https://github.com/battis/oauth2-cli/compare/oauth2-cli/0.8.1...oauth2-cli/0.8.2) (2026-02-18)
 
 

package/dist/Client.d.ts

@@ -14,6 +14,8 @@ import * as Token from './Token/index.js';
  */
 export declare const DEFAULT_REDIRECT_URI = "http://localhost:3000/oauth2-cli/redirect";
 export type ClientOptions<C extends Credentials = Credentials> = {
+    /** Human-readable name for client in messages */
+    name?: string;
     /** Credentials for server access */
     credentials: C;
     /** Optional request components to inject */
@@ -66,6 +68,7 @@ type GetTokenOptions = {
  */
 export declare class Client<C extends Credentials = Credentials> extends EventEmitter {
     static readonly TokenEvent = "token";
+    readonly name?: string;
     protected credentials: C;
     protected base_url?: requestish.URL.ish;
     protected config?: OpenIDClient.Configuration;
@@ -74,7 +77,8 @@ export declare class Client<C extends Credentials = Credentials> extends EventEm
     private token?;
     private tokenLock;
     private storage?;
-    constructor({ credentials, base_url, views, inject, storage }: ClientOptions<C>);
+    constructor({ name, credentials, base_url, views, inject, storage }: ClientOptions<C>);
+    clientName(): string;
     get redirect_uri(): requestish.URL.ish;
     /**
      * @throws IndeterminateConfiguration if provided credentials combined with

package/dist/Client.js

@@ -19,6 +19,7 @@ export const DEFAULT_REDIRECT_URI = 'http://localhost:3000/oauth2-cli/redirect';
  */
 export class Client extends EventEmitter {
     static TokenEvent = 'token';
+    name;
     credentials;
     base_url;
     config;
@@ -27,14 +28,21 @@ export class Client extends EventEmitter {
     token;
     tokenLock = new Mutex();
     storage;
-    constructor({ credentials, base_url, views, inject, storage }) {
+    constructor({ name, credentials, base_url, views, inject, storage }) {
         super();
+        this.name = name;
         this.credentials = credentials;
         this.base_url = base_url;
         this.views = views;
         this.inject = inject;
         this.storage = storage;
     }
+    clientName() {
+        if (this.name && this.name.length > 0) {
+            return this.name;
+        }
+        return 'oauth2-cli';
+    }
     get redirect_uri() {
         return this.credentials.redirect_uri;
     }
@@ -61,7 +69,7 @@ export class Client extends EventEmitter {
             }, this.credentials.client_id, { client_secret: this.credentials.client_secret });
         }
         if (!this.config) {
-            throw new Error('The client configuration could not be constructed from provided credentials.', {
+            throw new Error(`The ${this.clientName()} configuration could not be constructed from provided credentials.`, {
                 cause: {
                     credentials: this.credentials,
                     'OpenID configuration result': error
@@ -121,7 +129,7 @@ export class Client extends EventEmitter {
                 : undefined));
         }
         catch (cause) {
-            session.reject(new Error('Error making Authorization Code Grant request', { cause }));
+            session.reject(new Error(`Error making ${this.clientName()} Authorization Code Grant request`, { cause }));
         }
     }
     async refreshTokenGrant({ refresh_token = this.token?.refresh_token, inject: request } = {}) {
@@ -161,7 +169,7 @@ export class Client extends EventEmitter {
     async save(token) {
         this.token = token;
         if (!token.access_token) {
-            throw new Error('No access_token in response.', {
+            throw new Error(`No access_token in response to ${this.clientName()}.`, {
                 cause: token
             });
         }
@@ -190,7 +198,7 @@ export class Client extends EventEmitter {
                 requestish.URL.toString(this.base_url || this.credentials.issuer), requestish.URL.toString(url).replace(/^\/?/, ''));
             }
             else {
-                throw new Error(`Invalid request URL "${url}"`, {
+                throw new Error(`Invalid request URL "${url}" to ${this.clientName()}`, {
                     cause: {
                         base_url: this.base_url,
                         issuer: this.credentials.issuer,
@@ -221,7 +229,7 @@ export class Client extends EventEmitter {
             return (await response.json());
         }
         else {
-            throw new Error('The response could not be parsed as JSON.', {
+            throw new Error(`The response could not be parsed as JSON by ${this.clientName()}.`, {
                 cause: response
             });
         }

package/dist/Session.d.ts

@@ -13,7 +13,7 @@ export type SessionOptions = {
 };
 export type SessionResolver = (response: Token.Response) => void | Promise<void>;
 export declare class Session {
-    private readonly client;
+    readonly client: Client;
     private readonly outOfBandRedirectServer;
     /** PKCE code_verifier */
     readonly code_verifier: string;
@@ -28,7 +28,7 @@ export declare class Session {
      * {@link authorizationCodeGrant}
      */
     get resolve(): SessionResolver;
-    reject(error: Error): void;
+    reject(cause: unknown): void;
     constructor({ client, views, inject: request }: SessionOptions);
     /** Instantiate the web server that will listen for the out-of-band redirect */
     protected instantiateWebServer(options: Omit<WebServer.WebServerOptions, 'session'>): WebServer.WebServerInterface;

package/dist/Session.js

@@ -20,16 +20,16 @@ export class Session {
      */
     get resolve() {
         if (!this._resolve) {
-            throw new Error('callback is missing');
+            throw new Error(`${this.client.clientName()}'s Session resolve method is ${this._resolve}`);
         }
         return this._resolve;
     }
-    reject(error) {
-        throw error;
+    reject(cause) {
+        throw new Error(`${this.client.clientName()}'s Session failed`, { cause });
     }
     constructor({ client, views, inject: request }) {
-        this.spinner = ora('Awaiting interactive authorization').start();
         this.client = client;
+        this.spinner = ora(`${this.client.clientName()} awaiting interactive authorization`).start();
         this.inject = request;
         this.outOfBandRedirectServer = this.instantiateWebServer({ views });
     }
@@ -47,36 +47,48 @@ export class Session {
             try {
                 this._resolve = (response) => {
                     let closed = false;
-                    this.spinner.text =
-                        'Waiting for out-of-band redirect server to shut down';
+                    this.spinner.text = `${this.client.clientName()} waiting for out-of-band redirect server to shut down`;
                     this.outOfBandRedirectServer.close().then(() => {
                         closed = true;
-                        this.spinner.succeed('Interactive authorization complete');
+                        this.spinner.succeed(`Interactive authorization for ${this.client.clientName()} complete`);
                         resolve(response);
                     });
                     setTimeout(() => {
                         if (!closed) {
                             this.spinner.text =
-                                'Still waiting for out-of-band redirect server to shut down.\n' +
-                                    '  Your browser may be holding the connection to the server open.\n' +
-                                    '  Please close the "Authorization Complete" tab in your browser.\n\n' +
-                                    '    If you are browsing in Chrome, close the window.\n' +
-                                    '    If you are browsing in Opera, quit the browser.';
+                                `Still waiting for out-of-band redirect server for ${this.client.clientName()} to shut down.\n` +
+                                    '  Your browser may be holding the connection to the server open.\n\n' +
+                                    '  Please close the "Authorization Complete" tab in your browser.';
+                        }
+                    }, 5000);
+                    setTimeout(() => {
+                        if (!closed) {
+                            this.spinner.text =
+                                `Still waiting for out-of-band redirect server for ${this.client.clientName()} to shut down.\n` +
+                                    '  Your browser may be holding the connection to the server open.\n\n' +
+                                    '  Please close the browser window.';
                         }
                     }, 10000);
+                    setTimeout(() => {
+                        if (!closed) {
+                            this.spinner.text =
+                                `Still waiting for out-of-band redirect server for ${this.client.clientName()} to shut down.\n` +
+                                    '  Your browser may be holding the connection to the server open.\n\n' +
+                                    '  Please quit the browser.';
+                        }
+                    }, 15000);
                 };
                 const url = gcrtl
                     .expand(this.outOfBandRedirectServer.authorization_endpoint, this.client.redirect_uri)
                     .toString();
                 //open(url);
-                this.spinner.text = `Please continue interactive authorization at ${Colors.url(url)} in your browser`;
+                this.spinner.text = `Please continue interactive authorization for ${this.client.clientName()} at ${Colors.url(url)} in your browser`;
             }
             catch (cause) {
-                this.spinner.text =
-                    'Waiting for out-of-band redirect server to shut down';
+                this.spinner.text = `Waiting for out-of-band redirect server for ${this.client.clientName()} to shut down`;
                 this.outOfBandRedirectServer.close().then(() => {
-                    this.spinner.fail('Interactive authorization failed');
-                    reject(new Error('Error in Authorization Code flow', { cause }));
+                    this.spinner.fail(`Interactive authorization for ${this.client.clientName()} failed`);
+                    reject(new Error(`Error in Authorization Code flow for ${this.client.clientName()}`, { cause }));
                 });
             }
         });
@@ -93,8 +105,7 @@ export class Session {
      * Code Grant flow
      */
     async handleAuthorizationCodeRedirect(req) {
-        this.spinner.text =
-            'Completing access token request with provided authorization code';
+        this.spinner.text = `Completing access token request fro ${this.client.clientName()} with provided authorization code`;
         return await this.client.handleAuthorizationCodeRedirect(req, this);
     }
 }

package/dist/WebServer.d.ts

@@ -15,6 +15,15 @@ export type WebServerOptions = {
      * URL, the first step in the Authorization Code Grant flow.
      */
     authorize_endpoint?: PathString;
+    /**
+     * The number of milliseconds of inactivity before a socket is presumed to
+     * have timed out. This can be reduced to limit potential wait times during
+     * interactive authentication, but must still be long enough to allow time for
+     * the authorization code to be exchanged for an access token.
+     *
+     * Defaults to 1000 milliseconds
+     */
+    timeout?: number;
 };
 export declare const DEFAULT_AUTHORIZE_ENDPOINT = "/oauth2-cli/authorize";
 export interface WebServerInterface {
@@ -35,7 +44,7 @@ export declare class WebServer implements WebServerInterface {
     protected readonly port: string;
     readonly authorization_endpoint: PathString;
     private server;
-    constructor({ session, views, authorize_endpoint }: WebServerOptions);
+    constructor({ session, views, authorize_endpoint, timeout }: WebServerOptions);
     /**
      * Set the path to folder of *.ejs templates
      *

package/dist/WebServer.js

@@ -23,7 +23,8 @@ export class WebServer {
     port;
     authorization_endpoint;
     server;
-    constructor({ session, views, authorize_endpoint = DEFAULT_AUTHORIZE_ENDPOINT }) {
+    constructor({ session, views, authorize_endpoint = DEFAULT_AUTHORIZE_ENDPOINT, timeout = 1000 // milliseconds
+     }) {
         this.session = session;
         this.authorization_endpoint = authorize_endpoint;
         this.views = views;
@@ -37,6 +38,9 @@ export class WebServer {
         app.get(this.authorization_endpoint, this.handleAuthorizationEndpoint.bind(this));
         app.get(gcrtl.path(url), this.handleRedirect.bind(this));
         this.server = app.listen(gcrtl.port(url));
+        this.server.timeout = timeout;
+        this.server.keepAliveTimeout = 0;
+        this.server.keepAliveTimeoutBuffer = 0;
     }
     /**
      * Set the path to folder of *.ejs templates
@@ -61,11 +65,12 @@ export class WebServer {
         this.views = views;
     }
     async render(res, template, data = {}) {
+        const name = this.session.client.clientName();
         async function attemptToRender(views) {
             if (ejs && views) {
                 const viewPath = path.resolve(import.meta.dirname, views, template);
                 if (fs.existsSync(viewPath)) {
-                    res.send(await ejs.renderFile(viewPath, data));
+                    res.send(await ejs.renderFile(viewPath, { name, ...data }));
                     return true;
                 }
             }
@@ -87,12 +92,15 @@ export class WebServer {
         try {
             await this.session.handleAuthorizationCodeRedirect(req);
             if (!(await this.render(res, 'complete.ejs'))) {
-                res.send('You may close this window.');
+                res.send(`${this.session.client.clientName()} authorization complete. You may close this window.`);
             }
         }
         catch (error) {
             if (!(await this.render(res, 'error.ejs', { error }))) {
-                res.send(error);
+                res.send({
+                    client: this.session.client.clientName(),
+                    error
+                });
             }
         }
     }
@@ -101,7 +109,7 @@ export class WebServer {
         return new Promise((resolve, reject) => {
             this.server.close((cause) => {
                 if (cause) {
-                    reject(new Error('Error shutting down out-of-band redirect web server', {
+                    reject(new Error(`Error shutting down ${this.session.client.clientName()} out-of-band redirect web server`, {
                         cause
                     }));
                 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "oauth2-cli",
-  "version": "0.8.2",
+  "version": "0.8.4",
   "description": "Acquire API access tokens via OAuth 2.0 within CLI tools",
   "homepage": "https://github.com/battis/oauth2-cli/tree/main/packages/oauth2-cli#readme",
   "repository": {

package/views/complete.ejs

@@ -30,7 +30,10 @@
   <body>
     <div class="wrapper">
       <div class="center container">
-        <h1>Authorization Complete</h1>
+        <h1>
+          <%= name %>
+          Authorization Complete
+        </h1>
         <p>You may close this window.</p>
       </div>
     </div>

package/views/error.ejs

@@ -30,11 +30,12 @@
   <body>
     <div class="wrapper">
       <div class="center container">
-        <h1>Authorization Error</h1>
+        <h1>
+          <%= name %>
+          Authorization Error
+        </h1>
         <div class="alert alert-danger" role="alert">
-          <% if (typeof error === 'string') { %><%= error %><<% } else { %>
-          <pre><%= JSON.stringify(error,null,2) %></pre>
-          <% } %>
+          <pre><%= JSON.stringify(error, null, 2) %></pre>
         </div>
         <p>You may close this window.</p>
       </div>