@oauth2-cli/qui-cli-plugin 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -2,6 +2,28 @@
 
 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.2.3](https://github.com/battis/oauth2-cli/compare/qui-cli-plugin/0.2.2...qui-cli-plugin/0.2.3) (2025-12-23)
+
+
+### Bug Fixes
+
+* allow partial override of environment variable names and suppressed opt args ([c8a118b](https://github.com/battis/oauth2-cli/commit/c8a118ba6dae62f29549ef272448a4a6adea553c))
+
+## [0.2.2](https://github.com/battis/oauth2-cli/compare/qui-cli-plugin/0.2.1...qui-cli-plugin/0.2.2) (2025-12-23)
+
+
+### Features
+
+* add optional typing to requestJSON() ([5f7cf39](https://github.com/battis/oauth2-cli/commit/5f7cf39d8dc0ca86cbe3df7e8493d3273e630573))
+* configurable options and usage ([aadbc4b](https://github.com/battis/oauth2-cli/commit/aadbc4bffc9eda241763ecd9f134963517250e5f))
+* default suppress token path storage ([9df7f4f](https://github.com/battis/oauth2-cli/commit/9df7f4f6312713e2086366350f0c546a975b2c31))
+* provide EnvironmentStorage implementation ([55fc676](https://github.com/battis/oauth2-cli/commit/55fc676716fa1e4830a6a890b6d0bf5cecf0f57f))
+
+
+### Bug Fixes
+
+* update to current [@qui-cli](https://github.com/qui-cli) versions ([d54c521](https://github.com/battis/oauth2-cli/commit/d54c5210e55586ed688afa42840ec2b9e1cffeb0))
+
 ## [0.2.1](https://github.com/battis/oauth2-cli/compare/qui-cli-plugin/0.2.0...qui-cli-plugin/0.2.1) (2025-09-11)
 
 

package/dist/EnvironmentStorage.d.ts

@@ -0,0 +1,7 @@
+import { Token, TokenStorage } from 'oauth2-cli';
+export declare class EnvironmentStorage implements TokenStorage {
+    private tokenEnvVar;
+    constructor(tokenEnvVar?: string);
+    load(): Promise<Token | undefined>;
+    save(tokens: Token): Promise<Token>;
+}

package/dist/EnvironmentStorage.js

@@ -0,0 +1,25 @@
+import { Env } from '@qui-cli/env-1password';
+import { Token } from 'oauth2-cli';
+export class EnvironmentStorage {
+    tokenEnvVar;
+    constructor(tokenEnvVar = 'ACCESS_TOKEN') {
+        this.tokenEnvVar = tokenEnvVar;
+    }
+    async load() {
+        try {
+            const data = JSON.parse(await Env.get({ key: this.tokenEnvVar }));
+            if (!data.access_token) {
+                throw new Error('No access token');
+            }
+            return Token.fromResponse(data);
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+        }
+        catch (_) {
+            return undefined;
+        }
+    }
+    async save(tokens) {
+        await Env.set({ key: this.tokenEnvVar, value: JSON.stringify(tokens) });
+        return tokens;
+    }
+}

package/dist/OAuth2CLI.d.ts

@@ -1,8 +1,29 @@
 import { PathString, URLString } from '@battis/descriptive-types';
-import '@battis/qui-cli.env';
-import * as Plugin from '@battis/qui-cli.plugin';
+import '@qui-cli/env-1password';
+import * as Plugin from '@qui-cli/plugin';
 import * as OAuth2 from 'oauth2-cli';
 import * as OpenIDClient from 'openid-client';
+type EnvironmentVars = {
+    client_id: string;
+    client_secret: string;
+    redirect_uri: string;
+    authorization_endpoint: string;
+    token_endpoint: string;
+    token_path: string;
+    access_token: string;
+};
+type OptionSuppression = {
+    clientId?: boolean;
+    clientSecret?: boolean;
+    redirectUri?: boolean;
+    authorizationEndpoint?: boolean;
+    tokenEndpoint?: boolean;
+    tokenPath?: boolean;
+};
+type Usage = {
+    heading: string;
+    text?: string[];
+};
 export type Configuration = Plugin.Configuration & {
     client_id?: string;
     client_secret?: string;
@@ -11,12 +32,18 @@ export type Configuration = Plugin.Configuration & {
     token_endpoint?: URLString;
     store?: OAuth2.TokenStorage;
     token_path?: PathString;
+    env: EnvironmentVars;
+    man: Usage;
+    suppress?: OptionSuppression;
 };
 export declare const name = "@oauth2-cli/qui-cli-plugin";
-export declare const src: string;
-export declare function configure(config?: Configuration): void;
+export declare function configure(proposal?: Partial<Configuration> & {
+    env?: Partial<EnvironmentVars>;
+    suppress?: Partial<OptionSuppression>;
+}): void;
 export declare function options(): Plugin.Options;
-export declare function init(args: Plugin.ExpectedArguments<typeof options>): void;
+export declare function init(args: Plugin.ExpectedArguments<typeof options>): Promise<void>;
 export declare function getToken(): Promise<OAuth2.Token | undefined>;
 export declare function request(url: URL | string, method?: string, body?: OpenIDClient.FetchBody, headers?: Record<string, string>, options?: OpenIDClient.DPoPOptions): Promise<Response>;
-export declare function requestJSON(url: URL | string, method?: string, body?: OpenIDClient.FetchBody, headers?: Record<string, string>, options?: OpenIDClient.DPoPOptions): Promise<unknown>;
+export declare function requestJSON<T = unknown>(url: URL | string, method?: string, body?: OpenIDClient.FetchBody, headers?: Record<string, string>, options?: OpenIDClient.DPoPOptions): Promise<T>;
+export {};

package/dist/OAuth2CLI.js

@@ -1,58 +1,118 @@
-import { Colors } from '@battis/qui-cli.colors';
-import '@battis/qui-cli.env';
-import * as Plugin from '@battis/qui-cli.plugin';
-import { Root } from '@battis/qui-cli.root';
+import { Colors } from '@qui-cli/colors';
+import '@qui-cli/env-1password';
+import { Env } from '@qui-cli/env-1password';
+import { Root } from '@qui-cli/root';
 import path from 'node:path';
 import * as OAuth2 from 'oauth2-cli';
+import { EnvironmentStorage } from './EnvironmentStorage.js';
 export const name = '@oauth2-cli/qui-cli-plugin';
-export const src = import.meta.dirname;
-let client_id = undefined;
-let client_secret = undefined;
-let redirect_uri = undefined;
-let authorization_endpoint = undefined;
-let token_endpoint = undefined;
-let store = undefined;
+const config = {
+    redirect_uri: 'http://localhost:3000/redirect',
+    env: {
+        client_id: 'CLIENT_ID',
+        client_secret: 'CLIENT_SECRET',
+        redirect_uri: 'REDIRECT_URI',
+        authorization_endpoint: 'AUTHORIZATION_ENDPOINT',
+        token_endpoint: 'TOKEN_ENDPOINT',
+        token_path: 'TOKEN_PATH',
+        access_token: 'ACCESS_TOKEN'
+    },
+    man: {
+        heading: 'OAuth 2.0 client options'
+    },
+    suppress: {
+        tokenPath: true
+    }
+};
 let client = undefined;
-export function configure(config = {}) {
-    client_id = Plugin.hydrate(config.client_id, client_id);
-    client_secret = Plugin.hydrate(config.client_secret, client_secret);
-    redirect_uri = Plugin.hydrate(config.redirect_uri, redirect_uri);
-    authorization_endpoint = Plugin.hydrate(config.authorization_endpoint, authorization_endpoint);
-    token_endpoint = Plugin.hydrate(config.token_endpoint, token_endpoint);
-    if (config.store) {
-        store = config.store;
+export function configure(proposal = {}) {
+    for (const key in proposal) {
+        if (proposal[key] !== undefined) {
+            config[key] = proposal[key];
+        }
     }
-    else if (config.token_path) {
-        store = new OAuth2.FileStorage(path.resolve(Root.path(), config.token_path));
+    if (!config.store) {
+        if (config.token_path) {
+            config.store = new OAuth2.FileStorage(path.resolve(Root.path(), config.token_path));
+        }
+        else {
+            config.store = new EnvironmentStorage(config.env.access_token);
+        }
     }
 }
 export function options() {
     return {
+        man: [
+            { level: 1, text: config.man.heading },
+            ...(config.man.text || []).map((t) => ({ text: t }))
+        ],
         opt: {
-            clientId: {
-                description: `OAuth 2.0 client ID (defaults to environment variable ${Colors.value('CLIENT_ID')})`
-            },
-            clientSecret: {
-                description: `OAuth 2.0 client secret (defaults to environment variable ${Colors.value('CLIENT_SECRET')}`
-            },
-            redirectUri: {
-                description: `OAuth 2.0 redirect URI (must be to host ${Colors.url('localhost')}, e.g. ${Colors.quotedValue(`"http://localhost:3000/oauth2/redirect"`)}, defaults to environment variables ${Colors.value('REDIRECT_URI')})`
-            },
-            authorizationEndpoint: {
-                description: `OAuth 2.0 authorization endpoint (defaults to environment variable ${Colors.value('AUTHORIZATION_ENDPOINT')}`
-            },
-            tokenEndpoint: {
-                description: `OAuth 2.0 token endpoint (will fall back to authorization endpoint if not provided, defaults to environment variable ${Colors.value('TOKEN_ENDPOINT')}`
-            },
-            tokenPath: {
-                description: `Path to token storage JSON file (defaults to environent variable ${Colors.value('TOKEN_PATH')}`
-            }
+            ...(config.suppress?.clientId
+                ? {}
+                : {
+                    clientId: {
+                        description: `OAuth 2.0 client ID (defaults to environment variable ${Colors.value(config.env.client_id)})`,
+                        secret: true,
+                        default: config.client_id
+                    }
+                }),
+            ...(config.suppress?.clientSecret
+                ? {}
+                : {
+                    clientSecret: {
+                        description: `OAuth 2.0 client secret (defaults to environment variable ${Colors.value(config.env.client_secret)}`,
+                        secret: true,
+                        default: config.client_secret
+                    }
+                }),
+            ...(config.suppress?.redirectUri
+                ? {}
+                : {
+                    redirectUri: {
+                        description: `OAuth 2.0 redirect URI (must be to host ${Colors.url('localhost')}, defaults to environment variables ${Colors.value(config.env.redirect_uri)})`,
+                        hint: Colors.quotedValue(`"${config.redirect_uri}"`),
+                        default: config.redirect_uri
+                    }
+                }),
+            ...(config.suppress?.authorizationEndpoint
+                ? {}
+                : {
+                    authorizationEndpoint: {
+                        description: `OAuth 2.0 authorization endpoint (defaults to environment variable ${Colors.value(config.env.authorization_endpoint)}`,
+                        default: config.authorization_endpoint
+                    }
+                }),
+            ...(config.suppress?.tokenEndpoint
+                ? {}
+                : {
+                    tokenEndpoint: {
+                        description: `OAuth 2.0 token endpoint (will fall back to authorization endpoint if not provided, defaults to environment variable ${Colors.value(config.env.token_endpoint)}`,
+                        default: config.token_endpoint
+                    }
+                }),
+            ...(config.suppress?.tokenPath
+                ? {}
+                : {
+                    tokenPath: {
+                        description: `Path to token storage JSON file (defaults to environent variable ${Colors.value(config.env.token_path)}`,
+                        default: config.token_path
+                    }
+                })
         }
     };
 }
-export function init(args) {
-    const { values: { clientId: client_id = process.env.CLIENT_ID, clientSecret: client_secret = process.env.CLIENT_SECRET, redirectUri: redirect_uri = process.env.REDIRECT_URI, authorizationEndpoint: authorization_endpoint = process.env
-        .AUTHORIZATION_ENDPOINT, tokenEndpoint: token_endpoint = process.env.TOKEN_ENDPOINT, tokenPath: token_path = process.env.TOKEN_PATH } } = args;
+export async function init(args) {
+    const { values: { clientId: client_id = await Env.get({
+        key: config.env.client_id
+    }), clientSecret: client_secret = await Env.get({
+        key: config.env.client_secret
+    }), redirectUri: redirect_uri = await Env.get({
+        key: config.env.redirect_uri
+    }), authorizationEndpoint: authorization_endpoint = await Env.get({
+        key: config.env.authorization_endpoint
+    }), tokenEndpoint: token_endpoint = await Env.get({
+        key: config.env.token_endpoint
+    }), tokenPath: token_path = await Env.get({ key: config.env.token_path }) } } = args;
     configure({
         client_id,
         client_secret,
@@ -64,6 +124,7 @@ export function init(args) {
 }
 function getClient() {
     if (!client) {
+        const { client_id, client_secret, redirect_uri, authorization_endpoint, token_endpoint, store } = config;
         if (!client_id) {
             throw new Error('OAuth 2.0 client ID not defined');
         }
@@ -94,5 +155,5 @@ export async function request(url, method = 'GET', body, headers, options) {
     return await getClient().request(url, method, body, headers, options);
 }
 export async function requestJSON(url, method = 'GET', body, headers, options) {
-    return await getClient().requestJSON(url, method, body, headers, options);
+    return (await getClient().requestJSON(url, method, body, headers, options));
 }

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 import * as OAuth2 from './OAuth2CLI.js';
+export * from './EnvironmentStorage.js';
 export { OAuth2 };

package/dist/index.js

@@ -1,4 +1,5 @@
-import { register } from '@battis/qui-cli.plugin';
+import { register } from '@qui-cli/plugin';
 import * as OAuth2 from './OAuth2CLI.js';
-await register(OAuth2);
+export * from './EnvironmentStorage.js';
 export { OAuth2 };
+await register(OAuth2);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/qui-cli-plugin",
-  "version": "0.2.1",
+  "version": "0.2.3",
   "description": "@battis/qui-cli.plugin wrapper for oauth2-cli",
   "homepage": "https://github.com/battis/oauth2-cli/tree/main/packages/qui-cli-plugin#readme",
   "repository": {
@@ -16,26 +16,26 @@
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "dependencies": {
-    "openid-client": "^6.8.0",
-    "oauth2-cli": "0.2.1"
+    "openid-client": "^6.8.1",
+    "oauth2-cli": "0.2.2"
   },
   "devDependencies": {
-    "@battis/descriptive-types": "^0.2.3",
-    "@battis/qui-cli.colors": "^2.1.0",
-    "@battis/qui-cli.env": "^2.1.2",
-    "@battis/qui-cli.plugin": "^2.4.2",
-    "@battis/qui-cli.root": "^2.0.5",
-    "@tsconfig/node20": "^20.1.6",
-    "commit-and-tag-version": "^12.6.0",
+    "@battis/descriptive-types": "^0.2.6",
+    "@qui-cli/colors": "^3.1.1",
+    "@qui-cli/env-1password": "^1.2.0",
+    "@qui-cli/plugin": "^4.0.0",
+    "@qui-cli/root": "^3.0.4",
+    "@tsconfig/node20": "^20.1.8",
+    "commit-and-tag-version": "^12.6.1",
     "del-cli": "^6.0.0",
     "npm-run-all": "^4.1.5",
-    "typescript": "^5.9.2"
+    "typescript": "^5.9.3"
   },
   "peerDependencies": {
-    "@battis/qui-cli.colors": "^2.0",
-    "@battis/qui-cli.env": "^2.0",
-    "@battis/qui-cli.plugin": "^2.2",
-    "@battis/qui-cli.root": "^2.0"
+    "@qui-cli/colors": "3.x",
+    "@qui-cli/env-1password": "1.x",
+    "@qui-cli/plugin": "4.x",
+    "@qui-cli/root": "3.x"
   },
   "scripts": {
     "clean": "del ./dist",

package/.versionrc.json

@@ -1,5 +0,0 @@
-{
-  "path": ".",
-  "tag-prefix": "qui-cli-plugin/",
-  "releaseCommitMessageFormat": "chore(qui-cli-plugin): @oauth2-cli/qui-cli-plugin@{{currentTag}}"
-}

package/src/OAuth2CLI.ts

@@ -1,144 +0,0 @@
-import { PathString, URLString } from '@battis/descriptive-types';
-import { Colors } from '@battis/qui-cli.colors';
-import '@battis/qui-cli.env';
-import * as Plugin from '@battis/qui-cli.plugin';
-import { Root } from '@battis/qui-cli.root';
-import path from 'node:path';
-import * as OAuth2 from 'oauth2-cli';
-import * as OpenIDClient from 'openid-client';
-
-export type Configuration = Plugin.Configuration & {
-  client_id?: string;
-  client_secret?: string;
-  redirect_uri?: URLString;
-  authorization_endpoint?: URLString;
-  token_endpoint?: URLString;
-  store?: OAuth2.TokenStorage;
-  token_path?: PathString;
-};
-
-export const name = '@oauth2-cli/qui-cli-plugin';
-export const src = import.meta.dirname;
-
-let client_id: string | undefined = undefined;
-let client_secret: string | undefined = undefined;
-let redirect_uri: URLString | undefined = undefined;
-let authorization_endpoint: URLString | undefined = undefined;
-let token_endpoint: URLString | undefined = undefined;
-let store: OAuth2.TokenStorage | undefined = undefined;
-let client: OAuth2.Client | undefined = undefined;
-
-export function configure(config: Configuration = {}) {
-  client_id = Plugin.hydrate(config.client_id, client_id);
-  client_secret = Plugin.hydrate(config.client_secret, client_secret);
-  redirect_uri = Plugin.hydrate(config.redirect_uri, redirect_uri);
-  authorization_endpoint = Plugin.hydrate(
-    config.authorization_endpoint,
-    authorization_endpoint
-  );
-  token_endpoint = Plugin.hydrate(config.token_endpoint, token_endpoint);
-  if (config.store) {
-    store = config.store;
-  } else if (config.token_path) {
-    store = new OAuth2.FileStorage(
-      path.resolve(Root.path(), config.token_path)
-    );
-  }
-}
-
-export function options(): Plugin.Options {
-  return {
-    opt: {
-      clientId: {
-        description: `OAuth 2.0 client ID (defaults to environment variable ${Colors.value('CLIENT_ID')})`
-      },
-      clientSecret: {
-        description: `OAuth 2.0 client secret (defaults to environment variable ${Colors.value('CLIENT_SECRET')}`
-      },
-      redirectUri: {
-        description: `OAuth 2.0 redirect URI (must be to host ${Colors.url('localhost')}, e.g. ${Colors.quotedValue(`"http://localhost:3000/oauth2/redirect"`)}, defaults to environment variables ${Colors.value('REDIRECT_URI')})`
-      },
-      authorizationEndpoint: {
-        description: `OAuth 2.0 authorization endpoint (defaults to environment variable ${Colors.value('AUTHORIZATION_ENDPOINT')}`
-      },
-      tokenEndpoint: {
-        description: `OAuth 2.0 token endpoint (will fall back to authorization endpoint if not provided, defaults to environment variable ${Colors.value('TOKEN_ENDPOINT')}`
-      },
-      tokenPath: {
-        description: `Path to token storage JSON file (defaults to environent variable ${Colors.value('TOKEN_PATH')}`
-      }
-    }
-  };
-}
-
-export function init(args: Plugin.ExpectedArguments<typeof options>) {
-  const {
-    values: {
-      clientId: client_id = process.env.CLIENT_ID,
-      clientSecret: client_secret = process.env.CLIENT_SECRET,
-      redirectUri: redirect_uri = process.env.REDIRECT_URI,
-      authorizationEndpoint: authorization_endpoint = process.env
-        .AUTHORIZATION_ENDPOINT,
-      tokenEndpoint: token_endpoint = process.env.TOKEN_ENDPOINT,
-      tokenPath: token_path = process.env.TOKEN_PATH
-    }
-  } = args;
-  configure({
-    client_id,
-    client_secret,
-    redirect_uri,
-    authorization_endpoint,
-    token_endpoint,
-    token_path
-  });
-}
-
-function getClient() {
-  if (!client) {
-    if (!client_id) {
-      throw new Error('OAuth 2.0 client ID not defined');
-    }
-    if (!client_secret) {
-      throw new Error('OAuth 2.0 client secret not defined');
-    }
-    if (!redirect_uri) {
-      throw new Error('OAuth 2.0 redirect URI not defined');
-    }
-    if (!authorization_endpoint) {
-      throw new Error('OAuth 2.0 authorization endpoint not defined');
-    }
-    client = new OAuth2.Client({
-      client_id,
-      client_secret,
-      redirect_uri,
-      authorization_endpoint,
-      token_endpoint,
-      store
-    });
-  }
-  return client;
-}
-
-export async function getToken() {
-  return await getClient().getToken();
-}
-
-export async function request(
-  url: URL | string,
-  method: string = 'GET',
-  body?: OpenIDClient.FetchBody,
-  headers?: Record<string, string>,
-  options?: OpenIDClient.DPoPOptions
-) {
-  return await getClient().request(url, method, body, headers, options);
-}
-
-export async function requestJSON(
-  url: URL | string,
-  method: string = 'GET',
-  body?: OpenIDClient.FetchBody,
-  headers?: Record<string, string>,
-  options?: OpenIDClient.DPoPOptions
-) {
-  return await getClient().requestJSON(url, method, body, headers, options);
-}

package/src/index.ts

@@ -1,5 +0,0 @@
-import { register } from '@battis/qui-cli.plugin';
-import * as OAuth2 from './OAuth2CLI.js';
-
-await register(OAuth2);
-export { OAuth2 };

package/tsconfig.json

@@ -1,8 +0,0 @@
-{
-  "extends": "@tsconfig/node20/tsconfig.json",
-  "compilerOptions": {
-    "declaration": true,
-    "outDir": "./dist"
-  },
-  "include": ["./src"]
-}