@oauth2-cli/qui-cli 1.2.15 → 2.0.0

package/CHANGELOG.md

@@ -2,6 +2,17 @@
 
 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.
 
+## [2.0.0](https://github.com/battis/oauth2-cli/compare/qui-cli-plugin/1.2.15...qui-cli-plugin/2.0.0) (2026-03-22)
+
+
+### ⚠ BREAKING CHANGES
+
+* detect and automate traversing paginated collections
+
+### Features
+
+* detect and automate traversing paginated collections ([28d6c6a](https://github.com/battis/oauth2-cli/commit/28d6c6ad90deb01059804d11ee692ec413a03345))
+
 ## [1.2.13](https://github.com/battis/oauth2-cli/compare/qui-cli-plugin/1.2.12...qui-cli-plugin/1.2.13) (2026-03-10)
 
 ### Bug Fixes

package/dist/Client.d.ts

@@ -16,5 +16,5 @@ export declare class Client<C extends OAuth2CLI.Credentials = OAuth2CLI.Credenti
     getConfiguration(): Promise<OpenIDClient.Configuration>;
     protected prepareRequest(config: OpenIDClient.Configuration, accessToken: string, url: URL, method: string, body?: OpenIDClient.FetchBody, headers?: Headers | undefined, options?: OpenIDClient.DPoPOptions | undefined): Promise<OAuth2CLI.PreparedRequest>;
     protected prepareResponse(response: Response): Promise<Response>;
-    requestJSON<J extends JSONValue = JSONValue>(url: URL.ish, method?: string, body?: Body.ish, headers?: Headers.ish, dPoPOptions?: OpenIDClient.DPoPOptions): Promise<J>;
+    request<T extends JSONValue = JSONValue>(url: URL.ish, method?: string, body?: Body.ish, headers?: Headers.ish, dPoPOptions?: OpenIDClient.DPoPOptions): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
 }

package/dist/Client.js

@@ -39,13 +39,18 @@ export class Client extends OAuth2CLI.Client {
         })}`);
         return response;
     }
-    async requestJSON(url, method = 'GET', body, headers = {}, dPoPOptions) {
-        const json = await super.requestJSON(url, method, body, headers, dPoPOptions);
-        Log.debug(`JSON body from ${this.name}: ${typeof json === 'object' && json
-            ? Log.syntaxColor(json)
-            : typeof json === 'string'
-                ? Colors.quotedValue(`"${json}"`)
-                : Colors.value(json)}`);
-        return json;
+    async request(url, method = 'GET', body, headers = {}, dPoPOptions) {
+        const data = await super.request(url, method, body, headers, dPoPOptions);
+        if (data instanceof OAuth2CLI.PaginatedCollection) {
+            Log.debug(`First page of data from ${this.name}: ${Log.syntaxColor(data)}`);
+        }
+        else {
+            Log.debug(`JSON data from ${this.name}: ${typeof data === 'object' && data
+                ? Log.syntaxColor(data)
+                : typeof data === 'string'
+                    ? Colors.quotedValue(`"${data}"`)
+                    : Colors.value(data)}`);
+        }
+        return data;
     }
 }

package/dist/OAuth2.d.ts

@@ -27,22 +27,22 @@ export declare const client: () => import("./Client.js").Client<import("oauth2-c
  *
  * @see {@link OAuth2Plugin.request}
  */
-export declare const request: (url: import("requestish/dist/URL.js").ish, method?: string | undefined, body?: import("requestish/dist/Body.js").ish, headers?: import("requestish/dist/Headers.js").ish, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<Response>;
+export declare const requestRaw: (url: import("requestish/dist/URL.js").ish, method?: string | undefined, body?: import("requestish/dist/Body.js").ish, headers?: import("requestish/dist/Headers.js").ish, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<Response>;
 /**
  * Convenience method
  *
  * @see {@link OAuth2Plugin.requestJSON}
  */
-export declare const requestJSON: <T extends import("@battis/typescript-tricks").JSONValue>(url: import("requestish/dist/URL.js").ish, method?: string | undefined, body?: import("requestish/dist/Body.js").ish, headers?: import("requestish/dist/Headers.js").ish, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<T>;
+export declare const request: <T extends import("@battis/typescript-tricks").JSONValue>(url: import("requestish/dist/URL.js").ish, method?: string | undefined, body?: import("requestish/dist/Body.js").ish, headers?: import("requestish/dist/Headers.js").ish, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<T | import("oauth2-cli").PaginatedCollection<T>>;
 /**
  * Convenience method
  *
  * @see {@link OAuth2Plugin.fetch}
  */
-export declare const fetch: (input: import("requestish/dist/URL.js").ish, init?: RequestInit | undefined, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<Response>;
+export declare const fetchRaw: (input: import("requestish/dist/URL.js").ish, init?: RequestInit | undefined, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<Response>;
 /**
  * Conveneince method
  *
  * @see {@link OAuth2Plugin.fetchJSON}
  */
-export declare const fetchJSON: <T extends import("@battis/typescript-tricks").JSONValue>(input: import("requestish/dist/URL.js").ish, init?: RequestInit | undefined, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<T>;
+export declare const fetch: <T extends import("@battis/typescript-tricks").JSONValue>(input: import("requestish/dist/URL.js").ish, init?: RequestInit | undefined, dPoPOptions?: import("openid-client").DPoPOptions | undefined) => Promise<T | import("oauth2-cli").PaginatedCollection<T>>;

package/dist/OAuth2.js

@@ -33,23 +33,23 @@ export const client = () => plugin.client;
  *
  * @see {@link OAuth2Plugin.request}
  */
-export const request = plugin.request.bind(plugin);
+export const requestRaw = plugin.requestRaw.bind(plugin);
 /**
  * Convenience method
  *
  * @see {@link OAuth2Plugin.requestJSON}
  */
-export const requestJSON = plugin.requestJSON.bind(plugin);
+export const request = plugin.request.bind(plugin);
 /**
  * Convenience method
  *
  * @see {@link OAuth2Plugin.fetch}
  */
-export const fetch = plugin.fetch.bind(plugin);
+export const fetchRaw = plugin.fetchRaw.bind(plugin);
 /**
  * Conveneince method
  *
  * @see {@link OAuth2Plugin.fetchJSON}
  */
-export const fetchJSON = plugin.fetchJSON.bind(plugin);
+export const fetch = plugin.fetch.bind(plugin);
 await register(plugin);

package/dist/OAuth2Plugin.d.ts

@@ -131,24 +131,24 @@ export declare class OAuth2Plugin<C extends OAuth2CLI.Credentials = OAuth2CLI.Cr
      *
      * @see {@link OAuth2CLI.Client.request}
      */
-    request(...args: Parameters<OAuth2CLI.Client<C>['request']>): Promise<Response>;
+    requestRaw(...args: Parameters<OAuth2CLI.Client<C>['requestRaw']>): Promise<Response>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.requestJSON}
      */
-    requestJSON<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['requestJSON']>): Promise<T>;
+    request<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['request']>): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetch}
      */
-    fetch(...args: Parameters<OAuth2CLI.Client<C>['fetch']>): Promise<Response>;
+    fetchRaw(...args: Parameters<OAuth2CLI.Client<C>['fetchRaw']>): Promise<Response>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetchJSON}
      */
-    fetchJSON<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['fetchJSON']>): Promise<T>;
+    fetch<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['fetch']>): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
 }
 export {};

package/dist/OAuth2Plugin.js

@@ -257,31 +257,31 @@ export class OAuth2Plugin {
      *
      * @see {@link OAuth2CLI.Client.request}
      */
-    request(...args) {
-        return this.client.request(...args);
+    requestRaw(...args) {
+        return this.client.requestRaw(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.requestJSON}
      */
-    requestJSON(...args) {
-        return this.client.requestJSON(...args);
+    request(...args) {
+        return this.client.request(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetch}
      */
-    fetch(...args) {
-        return this.client.fetch(...args);
+    fetchRaw(...args) {
+        return this.client.fetchRaw(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetchJSON}
      */
-    fetchJSON(...args) {
-        return this.client.fetchJSON(...args);
+    fetch(...args) {
+        return this.client.fetch(...args);
     }
 }

package/extendable/Client.d.ts

@@ -16,5 +16,5 @@ export declare class Client<C extends OAuth2CLI.Credentials = OAuth2CLI.Credenti
     getConfiguration(): Promise<OpenIDClient.Configuration>;
     protected prepareRequest(config: OpenIDClient.Configuration, accessToken: string, url: URL, method: string, body?: OpenIDClient.FetchBody, headers?: Headers | undefined, options?: OpenIDClient.DPoPOptions | undefined): Promise<OAuth2CLI.PreparedRequest>;
     protected prepareResponse(response: Response): Promise<Response>;
-    requestJSON<J extends JSONValue = JSONValue>(url: URL.ish, method?: string, body?: Body.ish, headers?: Headers.ish, dPoPOptions?: OpenIDClient.DPoPOptions): Promise<J>;
+    request<T extends JSONValue = JSONValue>(url: URL.ish, method?: string, body?: Body.ish, headers?: Headers.ish, dPoPOptions?: OpenIDClient.DPoPOptions): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
 }

package/extendable/Client.js

@@ -39,13 +39,18 @@ export class Client extends OAuth2CLI.Client {
         })}`);
         return response;
     }
-    async requestJSON(url, method = 'GET', body, headers = {}, dPoPOptions) {
-        const json = await super.requestJSON(url, method, body, headers, dPoPOptions);
-        Log.debug(`JSON body from ${this.name}: ${typeof json === 'object' && json
-            ? Log.syntaxColor(json)
-            : typeof json === 'string'
-                ? Colors.quotedValue(`"${json}"`)
-                : Colors.value(json)}`);
-        return json;
+    async request(url, method = 'GET', body, headers = {}, dPoPOptions) {
+        const data = await super.request(url, method, body, headers, dPoPOptions);
+        if (data instanceof OAuth2CLI.PaginatedCollection) {
+            Log.debug(`First page of data from ${this.name}: ${Log.syntaxColor(data)}`);
+        }
+        else {
+            Log.debug(`JSON data from ${this.name}: ${typeof data === 'object' && data
+                ? Log.syntaxColor(data)
+                : typeof data === 'string'
+                    ? Colors.quotedValue(`"${data}"`)
+                    : Colors.value(data)}`);
+        }
+        return data;
     }
 }

package/extendable/OAuth2Plugin.d.ts

@@ -131,24 +131,24 @@ export declare class OAuth2Plugin<C extends OAuth2CLI.Credentials = OAuth2CLI.Cr
      *
      * @see {@link OAuth2CLI.Client.request}
      */
-    request(...args: Parameters<OAuth2CLI.Client<C>['request']>): Promise<Response>;
+    requestRaw(...args: Parameters<OAuth2CLI.Client<C>['requestRaw']>): Promise<Response>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.requestJSON}
      */
-    requestJSON<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['requestJSON']>): Promise<T>;
+    request<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['request']>): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetch}
      */
-    fetch(...args: Parameters<OAuth2CLI.Client<C>['fetch']>): Promise<Response>;
+    fetchRaw(...args: Parameters<OAuth2CLI.Client<C>['fetchRaw']>): Promise<Response>;
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetchJSON}
      */
-    fetchJSON<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['fetchJSON']>): Promise<T>;
+    fetch<T extends JSONValue>(...args: Parameters<OAuth2CLI.Client<C>['fetch']>): Promise<T | OAuth2CLI.PaginatedCollection<T>>;
 }
 export {};

package/extendable/OAuth2Plugin.js

@@ -257,31 +257,31 @@ export class OAuth2Plugin {
      *
      * @see {@link OAuth2CLI.Client.request}
      */
-    request(...args) {
-        return this.client.request(...args);
+    requestRaw(...args) {
+        return this.client.requestRaw(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.requestJSON}
      */
-    requestJSON(...args) {
-        return this.client.requestJSON(...args);
+    request(...args) {
+        return this.client.request(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetch}
      */
-    fetch(...args) {
-        return this.client.fetch(...args);
+    fetchRaw(...args) {
+        return this.client.fetchRaw(...args);
     }
     /**
      * Convenience method
      *
      * @see {@link OAuth2CLI.Client.fetchJSON}
      */
-    fetchJSON(...args) {
-        return this.client.fetchJSON(...args);
+    fetch(...args) {
+        return this.client.fetch(...args);
     }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oauth2-cli/qui-cli",
-  "version": "1.2.15",
+  "version": "2.0.0",
   "description": "@qui-cli/plugin wrapper for oauth2-cli",
   "homepage": "https://github.com/battis/oauth2-cli/tree/main/packages/qui-cli#readme",
   "repository": {
@@ -19,7 +19,7 @@
     "@battis/descriptive-types": "^0.2.6",
     "@battis/typescript-tricks": "^0.8.1",
     "requestish": "0.1.12",
-    "oauth2-cli": "1.2.8"
+    "oauth2-cli": "2.0.0"
   },
   "devDependencies": {
     "@tsconfig/node24": "^24.0.4",