@nickchristensen/ppls 1.0.4 → 1.1.0

package/README.md

@@ -108,7 +108,7 @@ EXAMPLES
   $ ppls config get hostname
 ```
 
-_See code: [src/commands/config/get.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/config/get.ts)_
+_See code: [src/commands/config/get.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/config/get.ts)_
 
 ## `ppls config init`
 
@@ -131,7 +131,7 @@ EXAMPLES
   $ ppls config init
 ```
 
-_See code: [src/commands/config/init.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/config/init.ts)_
+_See code: [src/commands/config/init.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/config/init.ts)_
 
 ## `ppls config list`
 
@@ -155,7 +155,7 @@ EXAMPLES
   $ ppls config list
 ```
 
-_See code: [src/commands/config/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/config/list.ts)_
+_See code: [src/commands/config/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/config/list.ts)_
 
 ## `ppls config remove KEY`
 
@@ -178,7 +178,7 @@ EXAMPLES
   $ ppls config remove token
 ```
 
-_See code: [src/commands/config/remove.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/config/remove.ts)_
+_See code: [src/commands/config/remove.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/config/remove.ts)_
 
 ## `ppls config set KEY VALUE`
 
@@ -204,7 +204,7 @@ EXAMPLES
   $ ppls config set headers '{"X-Api-Key":"token"}'
 ```
 
-_See code: [src/commands/config/set.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/config/set.ts)_
+_See code: [src/commands/config/set.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/config/set.ts)_
 
 ## `ppls correspondents add NAME`
 
@@ -236,7 +236,7 @@ EXAMPLES
   $ ppls correspondents add "Acme Corp"
 ```
 
-_See code: [src/commands/correspondents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/correspondents/add.ts)_
+_See code: [src/commands/correspondents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/correspondents/add.ts)_
 
 ## `ppls correspondents delete ID`
 
@@ -271,7 +271,7 @@ EXAMPLES
   $ ppls correspondents delete 123
 ```
 
-_See code: [src/commands/correspondents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/correspondents/delete.ts)_
+_See code: [src/commands/correspondents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/correspondents/delete.ts)_
 
 ## `ppls correspondents list`
 
@@ -280,14 +280,14 @@ List correspondents
 ```
 USAGE
   $ ppls correspondents list [--date-format <value>] [--header <value>...] [--hostname <value>] [--plain | --json |
-    --table] [--token <value>] [--page <value>] [--page-size <value>] [--id-in <value> | --name-contains <value>]
-    [--sort <value>]
+    --table] [--token <value>] [--id-in <value> | --name-contains <value>] [--page <value> --page-size <value>] [--sort
+    <value>]
 
 FLAGS
   --id-in=<value>          Filter by id list (comma-separated)
   --name-contains=<value>  Filter by name substring
   --page=<value>           Page number to fetch
-  --page-size=<value>      Number of results per page
+  --page-size=<value>      [default: disable pagination, all results] Number of results per page
   --sort=<value>           Sort results by the provided field
 
 GLOBAL FLAGS
@@ -308,7 +308,7 @@ EXAMPLES
   $ ppls correspondents list
 ```
 
-_See code: [src/commands/correspondents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/correspondents/list.ts)_
+_See code: [src/commands/correspondents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/correspondents/list.ts)_
 
 ## `ppls correspondents show ID`
 
@@ -340,7 +340,7 @@ EXAMPLES
   $ ppls correspondents show 123
 ```
 
-_See code: [src/commands/correspondents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/correspondents/show.ts)_
+_See code: [src/commands/correspondents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/correspondents/show.ts)_
 
 ## `ppls correspondents update ID`
 
@@ -375,7 +375,7 @@ EXAMPLES
   $ ppls correspondents update 123 --name "Acme Corp"
 ```
 
-_See code: [src/commands/correspondents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/correspondents/update.ts)_
+_See code: [src/commands/correspondents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/correspondents/update.ts)_
 
 ## `ppls custom-fields add NAME`
 
@@ -413,7 +413,7 @@ EXAMPLES
   $ ppls custom-fields add "Due Date" --data-type date
 ```
 
-_See code: [src/commands/custom-fields/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/custom-fields/add.ts)_
+_See code: [src/commands/custom-fields/add.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/custom-fields/add.ts)_
 
 ## `ppls custom-fields delete ID`
 
@@ -448,7 +448,7 @@ EXAMPLES
   $ ppls custom-fields delete 123
 ```
 
-_See code: [src/commands/custom-fields/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/custom-fields/delete.ts)_
+_See code: [src/commands/custom-fields/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/custom-fields/delete.ts)_
 
 ## `ppls custom-fields list`
 
@@ -457,14 +457,14 @@ List custom fields
 ```
 USAGE
   $ ppls custom-fields list [--date-format <value>] [--header <value>...] [--hostname <value>] [--plain | --json |
-    --table] [--token <value>] [--page <value>] [--page-size <value>] [--id-in <value> | --name-contains <value>]
-    [--sort <value>]
+    --table] [--token <value>] [--id-in <value> | --name-contains <value>] [--page <value> --page-size <value>] [--sort
+    <value>]
 
 FLAGS
   --id-in=<value>          Filter by id list (comma-separated)
   --name-contains=<value>  Filter by name substring
   --page=<value>           Page number to fetch
-  --page-size=<value>      Number of results per page
+  --page-size=<value>      [default: disable pagination, all results] Number of results per page
   --sort=<value>           Sort results by the provided field
 
 GLOBAL FLAGS
@@ -485,7 +485,7 @@ EXAMPLES
   $ ppls custom-fields list
 ```
 
-_See code: [src/commands/custom-fields/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/custom-fields/list.ts)_
+_See code: [src/commands/custom-fields/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/custom-fields/list.ts)_
 
 ## `ppls custom-fields show ID`
 
@@ -517,7 +517,7 @@ EXAMPLES
   $ ppls custom-fields show 123
 ```
 
-_See code: [src/commands/custom-fields/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/custom-fields/show.ts)_
+_See code: [src/commands/custom-fields/show.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/custom-fields/show.ts)_
 
 ## `ppls custom-fields update ID`
 
@@ -556,7 +556,7 @@ EXAMPLES
   $ ppls custom-fields update 123 --name "Due Date"
 ```
 
-_See code: [src/commands/custom-fields/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/custom-fields/update.ts)_
+_See code: [src/commands/custom-fields/update.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/custom-fields/update.ts)_
 
 ## `ppls document-types add NAME`
 
@@ -588,7 +588,7 @@ EXAMPLES
   $ ppls document-types add "Invoice"
 ```
 
-_See code: [src/commands/document-types/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/document-types/add.ts)_
+_See code: [src/commands/document-types/add.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/document-types/add.ts)_
 
 ## `ppls document-types delete ID`
 
@@ -623,7 +623,7 @@ EXAMPLES
   $ ppls document-types delete 123
 ```
 
-_See code: [src/commands/document-types/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/document-types/delete.ts)_
+_See code: [src/commands/document-types/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/document-types/delete.ts)_
 
 ## `ppls document-types list`
 
@@ -632,14 +632,14 @@ List document types
 ```
 USAGE
   $ ppls document-types list [--date-format <value>] [--header <value>...] [--hostname <value>] [--plain | --json |
-    --table] [--token <value>] [--page <value>] [--page-size <value>] [--id-in <value> | --name-contains <value>]
-    [--sort <value>]
+    --table] [--token <value>] [--id-in <value> | --name-contains <value>] [--page <value> --page-size <value>] [--sort
+    <value>]
 
 FLAGS
   --id-in=<value>          Filter by id list (comma-separated)
   --name-contains=<value>  Filter by name substring
   --page=<value>           Page number to fetch
-  --page-size=<value>      Number of results per page
+  --page-size=<value>      [default: disable pagination, all results] Number of results per page
   --sort=<value>           Sort results by the provided field
 
 GLOBAL FLAGS
@@ -660,7 +660,7 @@ EXAMPLES
   $ ppls document-types list
 ```
 
-_See code: [src/commands/document-types/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/document-types/list.ts)_
+_See code: [src/commands/document-types/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/document-types/list.ts)_
 
 ## `ppls document-types show ID`
 
@@ -692,7 +692,7 @@ EXAMPLES
   $ ppls document-types show 123
 ```
 
-_See code: [src/commands/document-types/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/document-types/show.ts)_
+_See code: [src/commands/document-types/show.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/document-types/show.ts)_
 
 ## `ppls document-types update ID`
 
@@ -727,7 +727,7 @@ EXAMPLES
   $ ppls document-types update 123 --name "Invoice"
 ```
 
-_See code: [src/commands/document-types/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/document-types/update.ts)_
+_See code: [src/commands/document-types/update.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/document-types/update.ts)_
 
 ## `ppls documents add [PATH]`
 
@@ -769,7 +769,7 @@ EXAMPLES
   $ ppls documents add ./receipt.pdf --title "Receipt"
 ```
 
-_See code: [src/commands/documents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/add.ts)_
+_See code: [src/commands/documents/add.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/add.ts)_
 
 ## `ppls documents delete ID`
 
@@ -804,7 +804,7 @@ EXAMPLES
   $ ppls documents delete 123
 ```
 
-_See code: [src/commands/documents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/delete.ts)_
+_See code: [src/commands/documents/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/delete.ts)_
 
 ## `ppls documents download ID`
 
@@ -843,7 +843,7 @@ EXAMPLES
   $ ppls documents download 123,124 --output-dir ./downloads
 ```
 
-_See code: [src/commands/documents/download.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/download.ts)_
+_See code: [src/commands/documents/download.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/download.ts)_
 
 ## `ppls documents list`
 
@@ -852,14 +852,14 @@ List documents
 ```
 USAGE
   $ ppls documents list [--date-format <value>] [--header <value>...] [--hostname <value>] [--plain | --json |
-    --table] [--token <value>] [--page <value>] [--page-size <value>] [--id-in <value> | --name-contains <value>]
-    [--sort <value>]
+    --table] [--token <value>] [--id-in <value> | --name-contains <value>] [--page <value> --page-size <value>] [--sort
+    <value>]
 
 FLAGS
   --id-in=<value>          Filter by id list (comma-separated)
   --name-contains=<value>  Filter by name substring
   --page=<value>           Page number to fetch
-  --page-size=<value>      Number of results per page
+  --page-size=<value>      [default: disable pagination, all results] Number of results per page
   --sort=<value>           Sort results by the provided field
 
 GLOBAL FLAGS
@@ -880,7 +880,7 @@ EXAMPLES
   $ ppls documents list
 ```
 
-_See code: [src/commands/documents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/list.ts)_
+_See code: [src/commands/documents/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/list.ts)_
 
 ## `ppls documents show ID`
 
@@ -912,7 +912,7 @@ EXAMPLES
   $ ppls documents show 123
 ```
 
-_See code: [src/commands/documents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/show.ts)_
+_See code: [src/commands/documents/show.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/show.ts)_
 
 ## `ppls documents update ID`
 
@@ -955,7 +955,7 @@ EXAMPLES
   $ ppls documents update 123 --title "Receipt"
 ```
 
-_See code: [src/commands/documents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/documents/update.ts)_
+_See code: [src/commands/documents/update.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/documents/update.ts)_
 
 ## `ppls help [COMMAND]`
 
@@ -1007,7 +1007,7 @@ EXAMPLES
   $ ppls profile
 ```
 
-_See code: [src/commands/profile.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/profile.ts)_
+_See code: [src/commands/profile.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/profile.ts)_
 
 ## `ppls tags add NAME`
 
@@ -1044,7 +1044,7 @@ EXAMPLES
   $ ppls tags add Inbox
 ```
 
-_See code: [src/commands/tags/add.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/tags/add.ts)_
+_See code: [src/commands/tags/add.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/tags/add.ts)_
 
 ## `ppls tags delete ID`
 
@@ -1079,7 +1079,7 @@ EXAMPLES
   $ ppls tags delete 123
 ```
 
-_See code: [src/commands/tags/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/tags/delete.ts)_
+_See code: [src/commands/tags/delete.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/tags/delete.ts)_
 
 ## `ppls tags list`
 
@@ -1088,14 +1088,14 @@ List tags
 ```
 USAGE
   $ ppls tags list [--date-format <value>] [--header <value>...] [--hostname <value>] [--plain | --json |
-    --table] [--token <value>] [--page <value>] [--page-size <value>] [--id-in <value> | --name-contains <value>]
-    [--sort <value>]
+    --table] [--token <value>] [--id-in <value> | --name-contains <value>] [--page <value> --page-size <value>] [--sort
+    <value>]
 
 FLAGS
   --id-in=<value>          Filter by id list (comma-separated)
   --name-contains=<value>  Filter by name substring
   --page=<value>           Page number to fetch
-  --page-size=<value>      Number of results per page
+  --page-size=<value>      [default: disable pagination, all results] Number of results per page
   --sort=<value>           Sort results by the provided field
 
 GLOBAL FLAGS
@@ -1116,7 +1116,7 @@ EXAMPLES
   $ ppls tags list
 ```
 
-_See code: [src/commands/tags/list.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/tags/list.ts)_
+_See code: [src/commands/tags/list.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/tags/list.ts)_
 
 ## `ppls tags show ID`
 
@@ -1148,7 +1148,7 @@ EXAMPLES
   $ ppls tags show 123
 ```
 
-_See code: [src/commands/tags/show.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/tags/show.ts)_
+_See code: [src/commands/tags/show.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/tags/show.ts)_
 
 ## `ppls tags update ID`
 
@@ -1186,5 +1186,5 @@ EXAMPLES
   $ ppls tags update 123 --name Inbox
 ```
 
-_See code: [src/commands/tags/update.ts](https://github.com/nickchristensen/ppls/blob/v1.0.4/src/commands/tags/update.ts)_
+_See code: [src/commands/tags/update.ts](https://github.com/nickchristensen/ppls/blob/v1.1.0/src/commands/tags/update.ts)_
 <!-- commandsstop -->

package/dist/base-command.d.ts

@@ -40,7 +40,6 @@ export declare abstract class BaseCommand extends Command {
     protected fetchJson<T>(url: URL, tokenValue: string, headers?: Record<string, string>): Promise<T>;
     protected formatErrorMessage(response: Response): Promise<string>;
     protected loadUserConfig(): Promise<UserConfig>;
-    protected logRequestHeaders(label: string, headers: Record<string, string>): void;
     protected logTable(headers: TableColumn[], rows: TableRow[], options?: TableOptions): void;
     protected parseHeaderEntries(entries: string[], source: string): Record<string, string>;
     protected parseHeadersConfig(input: unknown, source: string): Record<string, string>;
@@ -48,7 +47,6 @@ export declare abstract class BaseCommand extends Command {
     protected patchApiJson<T>(flags: ApiFlags, path: string, body: unknown): Promise<T>;
     protected postApiFormData<T>(flags: ApiFlags, path: string, body: FormData): Promise<T>;
     protected postApiJson<T>(flags: ApiFlags, path: string, body: unknown): Promise<T>;
-    protected redactHeaderValue(key: string, value: string): string;
     protected requestJson<T>(options: {
         body?: unknown;
         headers: Record<string, string>;
@@ -59,7 +57,6 @@ export declare abstract class BaseCommand extends Command {
     protected resolveDateFormat(flags: Record<string, unknown>, metadata: CommandMetadata | undefined, userConfig: UserConfig): string;
     protected resolveGlobalFlags(flags: Record<string, unknown>, metadata?: CommandMetadata): Promise<ResolvedGlobalFlags>;
     protected resolveHeaders(flags: Record<string, unknown>, userConfig: UserConfig): Record<string, string>;
-    protected shouldLogHeaders(): boolean;
     protected shouldShowSpinner(): boolean;
     protected startSpinner(text: string): null | ReturnType<typeof yoctoSpinner>;
 }

package/dist/base-command.js

@@ -64,7 +64,6 @@ export class BaseCommand extends Command {
             Authorization: `Token ${flags.token}`,
             ...flags.headers,
         };
-        this.logRequestHeaders(`DELETE ${url.toString()}`, requestHeaders);
         const response = await fetch(url, {
             headers: requestHeaders,
             method: 'DELETE',
@@ -89,7 +88,6 @@ export class BaseCommand extends Command {
             Authorization: `Token ${flags.token}`,
             ...flags.headers,
         };
-        this.logRequestHeaders(`GET ${url.toString()}`, requestHeaders);
         const response = await fetch(url, {
             headers: requestHeaders,
         });
@@ -146,13 +144,6 @@ export class BaseCommand extends Command {
         })();
         return this.userConfigPromise;
     }
-    logRequestHeaders(label, headers) {
-        if (!this.shouldLogHeaders()) {
-            return;
-        }
-        const maskedHeaders = Object.fromEntries(Object.entries(headers).map(([key, value]) => [key, this.redactHeaderValue(key, value)]));
-        this.logToStderr(`${label} headers: ${JSON.stringify(maskedHeaders)}`);
-    }
     logTable(headers, rows, options) {
         this.log(renderTable(headers, rows, options));
     }
@@ -230,7 +221,6 @@ export class BaseCommand extends Command {
             Authorization: `Token ${flags.token}`,
             ...flags.headers,
         };
-        this.logRequestHeaders(`POST ${url.toString()}`, requestHeaders);
         const response = await fetch(url, {
             body,
             headers: requestHeaders,
@@ -255,17 +245,6 @@ export class BaseCommand extends Command {
             url,
         });
     }
-    redactHeaderValue(key, value) {
-        const normalized = key.toLowerCase();
-        if (normalized === 'authorization') {
-            const [scheme] = value.split(' ');
-            return scheme ? `${scheme} [REDACTED]` : '[REDACTED]';
-        }
-        if (normalized.includes('token') || normalized.includes('secret') || normalized.includes('api-key')) {
-            return '[REDACTED]';
-        }
-        return value;
-    }
     async requestJson(options) {
         const { body, headers, method, token, url } = options;
         const requestHeaders = {
@@ -274,7 +253,6 @@ export class BaseCommand extends Command {
             ...(body === undefined ? {} : { 'Content-Type': 'application/json' }),
             ...headers,
         };
-        this.logRequestHeaders(`${method} ${url.toString()}`, requestHeaders);
         const response = await fetch(url, {
             body: body === undefined ? undefined : JSON.stringify(body),
             headers: requestHeaders,
@@ -319,10 +297,6 @@ export class BaseCommand extends Command {
             ...flagHeaders,
         };
     }
-    shouldLogHeaders() {
-        const value = process.env.PPLS_DEBUG_HEADERS?.toLowerCase();
-        return value === '1' || value === 'true' || value === 'yes';
-    }
     shouldShowSpinner() {
         return Boolean(process.stderr.isTTY);
     }

package/dist/commands/documents/list.d.ts

@@ -5,5 +5,6 @@ export default class DocumentsList extends ListCommand<Document> {
     static examples: string[];
     protected listPath: string;
     protected tableAttrs: string[];
+    protected listParams(flags: Parameters<ListCommand['listParams']>[0]): Record<string, number | string | undefined>;
     protected plainTemplate(document: Document): string | undefined;
 }

package/dist/commands/documents/list.js

@@ -4,6 +4,13 @@ export default class DocumentsList extends ListCommand {
     static examples = ['<%= config.bin %> <%= command.id %>'];
     listPath = '/api/documents/';
     tableAttrs = ['id', 'title', 'created', 'added', 'correspondent', 'document_type', 'tags'];
+    listParams(flags) {
+        const params = super.listParams(flags);
+        delete params.name__icontains;
+        // eslint-disable-next-line camelcase -- API uses double-underscore field names.
+        params.title__icontains = flags['name-contains'];
+        return params;
+    }
     plainTemplate(document) {
         const title = document.title?.trim();
         if (!title) {

package/dist/list-command.d.ts

@@ -1,11 +1,11 @@
 import type { ApiFlags } from './base-command.js';
+import { BaseCommand } from './base-command.js';
 import { type TableColumn, type TableRow } from './helpers/table.js';
-import { PaginatedCommand } from './paginated-command.js';
 type ListCommandFlags = ApiFlags & {
     'id-in'?: string;
     'name-contains'?: string;
     page?: number;
-    'page-size'?: number;
+    'page-size': number;
     sort?: string;
 };
 type ListOutputFlags = ListCommandFlags & {
@@ -14,13 +14,13 @@ type ListOutputFlags = ListCommandFlags & {
     table?: boolean;
 };
 type TableColumnInput = string | TableColumn;
-export declare abstract class ListCommand<TRaw extends TableRow = TableRow, TOutput extends TableRow = TRaw> extends PaginatedCommand {
+export declare abstract class ListCommand<TRaw extends TableRow = TableRow, TOutput extends TableRow = TRaw> extends BaseCommand {
     static baseFlags: {
         'id-in': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'name-contains': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        sort: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         page: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'page-size': import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        'page-size': import("@oclif/core/interfaces").OptionFlag<number, import("@oclif/core/interfaces").CustomOptions>;
+        sort: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
         'date-format': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
         header: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
         hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
@@ -42,8 +42,8 @@ export declare abstract class ListCommand<TRaw extends TableRow = TableRow, TOut
         results: TOutput[];
     }): void;
     run(): Promise<TOutput[]>;
-    protected shouldAutoPaginate(flags: ListCommandFlags): boolean;
     protected transformResult(result: TRaw): TOutput;
     protected transformResults(results: TRaw[]): TOutput[];
+    private buildListUrl;
 }
 export {};

package/dist/list-command.js

@@ -1,9 +1,9 @@
 import { Flags } from '@oclif/core';
+import { BaseCommand } from './base-command.js';
 import { createValueFormatter } from './helpers/table.js';
-import { PaginatedCommand } from './paginated-command.js';
-export class ListCommand extends PaginatedCommand {
+export class ListCommand extends BaseCommand {
     static baseFlags = {
-        ...PaginatedCommand.baseFlags,
+        ...BaseCommand.baseFlags,
         'id-in': Flags.string({
             description: 'Filter by id list (comma-separated)',
             exclusive: ['name-contains'],
@@ -12,11 +12,22 @@ export class ListCommand extends PaginatedCommand {
             description: 'Filter by name substring',
             exclusive: ['id-in'],
         }),
+        page: Flags.integer({
+            dependsOn: ['page-size'],
+            description: 'Page number to fetch',
+            min: 1,
+        }),
+        'page-size': Flags.integer({
+            default: async ({ flags }) => (flags.page === undefined ? Number.MAX_SAFE_INTEGER : undefined),
+            defaultHelp: async () => 'disable pagination, all results',
+            description: 'Number of results per page',
+            min: 1,
+        }),
         sort: Flags.string({ description: 'Sort results by the provided field' }),
     };
     async fetchListResults(options) {
         const { flags, params = {}, path } = options;
-        const url = this.buildPaginatedUrlFromFlags({
+        const url = this.buildListUrl({
             flags,
             params: {
                 ordering: flags.sort,
@@ -24,11 +35,14 @@ export class ListCommand extends PaginatedCommand {
             },
             path,
         });
-        return this.fetchPaginatedResultsFromFlags({
-            autoPaginate: this.shouldAutoPaginate(flags),
-            flags,
-            url,
-        });
+        const spinner = this.startSpinner(`Fetching ${url.pathname}`);
+        try {
+            const payload = await this.fetchJson(url, flags.token, flags.headers);
+            return payload.results ?? [];
+        }
+        finally {
+            spinner?.stop();
+        }
     }
     listParams(flags) {
         return {
@@ -86,13 +100,20 @@ export class ListCommand extends PaginatedCommand {
         });
         return results;
     }
-    shouldAutoPaginate(flags) {
-        return flags.page === undefined && flags['page-size'] === undefined;
-    }
     transformResult(result) {
         return result;
     }
     transformResults(results) {
         return results.map((result) => this.transformResult(result));
     }
+    buildListUrl(options) {
+        const { flags, params = {}, path } = options;
+        const { page } = flags;
+        const pageSize = flags['page-size'];
+        return this.buildApiUrl(flags.hostname, path, {
+            ...params,
+            page,
+            'page_size': pageSize,
+        });
+    }
 }

package/oclif.manifest.json

@@ -575,20 +575,6 @@
           "multiple": false,
           "type": "option"
         },
-        "page": {
-          "description": "Page number to fetch",
-          "name": "page",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "page-size": {
-          "description": "Number of results per page",
-          "name": "page-size",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "id-in": {
           "description": "Filter by id list (comma-separated)",
           "exclusive": [
@@ -609,6 +595,24 @@
           "multiple": false,
           "type": "option"
         },
+        "page": {
+          "dependsOn": [
+            "page-size"
+          ],
+          "description": "Page number to fetch",
+          "name": "page",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "Number of results per page",
+          "name": "page-size",
+          "default": "disable pagination, all results",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
         "sort": {
           "description": "Sort results by the provided field",
           "name": "sort",
@@ -617,7 +621,7 @@
           "type": "option"
         }
       },
-      "hasDynamicHelp": false,
+      "hasDynamicHelp": true,
       "hiddenAliases": [],
       "id": "correspondents:list",
       "pluginAlias": "@nickchristensen/ppls",
@@ -1152,20 +1156,6 @@
           "multiple": false,
           "type": "option"
         },
-        "page": {
-          "description": "Page number to fetch",
-          "name": "page",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "page-size": {
-          "description": "Number of results per page",
-          "name": "page-size",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "id-in": {
           "description": "Filter by id list (comma-separated)",
           "exclusive": [
@@ -1186,6 +1176,24 @@
           "multiple": false,
           "type": "option"
         },
+        "page": {
+          "dependsOn": [
+            "page-size"
+          ],
+          "description": "Page number to fetch",
+          "name": "page",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "Number of results per page",
+          "name": "page-size",
+          "default": "disable pagination, all results",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
         "sort": {
           "description": "Sort results by the provided field",
           "name": "sort",
@@ -1194,7 +1202,7 @@
           "type": "option"
         }
       },
-      "hasDynamicHelp": false,
+      "hasDynamicHelp": true,
       "hiddenAliases": [],
       "id": "custom-fields:list",
       "pluginAlias": "@nickchristensen/ppls",
@@ -1728,20 +1736,6 @@
           "multiple": false,
           "type": "option"
         },
-        "page": {
-          "description": "Page number to fetch",
-          "name": "page",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "page-size": {
-          "description": "Number of results per page",
-          "name": "page-size",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "id-in": {
           "description": "Filter by id list (comma-separated)",
           "exclusive": [
@@ -1762,6 +1756,24 @@
           "multiple": false,
           "type": "option"
         },
+        "page": {
+          "dependsOn": [
+            "page-size"
+          ],
+          "description": "Page number to fetch",
+          "name": "page",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "Number of results per page",
+          "name": "page-size",
+          "default": "disable pagination, all results",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
         "sort": {
           "description": "Sort results by the provided field",
           "name": "sort",
@@ -1770,7 +1782,7 @@
           "type": "option"
         }
       },
-      "hasDynamicHelp": false,
+      "hasDynamicHelp": true,
       "hiddenAliases": [],
       "id": "document-types:list",
       "pluginAlias": "@nickchristensen/ppls",
@@ -2432,20 +2444,6 @@
           "multiple": false,
           "type": "option"
         },
-        "page": {
-          "description": "Page number to fetch",
-          "name": "page",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "page-size": {
-          "description": "Number of results per page",
-          "name": "page-size",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "id-in": {
           "description": "Filter by id list (comma-separated)",
           "exclusive": [
@@ -2466,6 +2464,24 @@
           "multiple": false,
           "type": "option"
         },
+        "page": {
+          "dependsOn": [
+            "page-size"
+          ],
+          "description": "Page number to fetch",
+          "name": "page",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "Number of results per page",
+          "name": "page-size",
+          "default": "disable pagination, all results",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
         "sort": {
           "description": "Sort results by the provided field",
           "name": "sort",
@@ -2474,7 +2490,7 @@
           "type": "option"
         }
       },
-      "hasDynamicHelp": false,
+      "hasDynamicHelp": true,
       "hiddenAliases": [],
       "id": "documents:list",
       "pluginAlias": "@nickchristensen/ppls",
@@ -3031,20 +3047,6 @@
           "multiple": false,
           "type": "option"
         },
-        "page": {
-          "description": "Page number to fetch",
-          "name": "page",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
-        "page-size": {
-          "description": "Number of results per page",
-          "name": "page-size",
-          "hasDynamicHelp": false,
-          "multiple": false,
-          "type": "option"
-        },
         "id-in": {
           "description": "Filter by id list (comma-separated)",
           "exclusive": [
@@ -3065,6 +3067,24 @@
           "multiple": false,
           "type": "option"
         },
+        "page": {
+          "dependsOn": [
+            "page-size"
+          ],
+          "description": "Page number to fetch",
+          "name": "page",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "page-size": {
+          "description": "Number of results per page",
+          "name": "page-size",
+          "default": "disable pagination, all results",
+          "hasDynamicHelp": true,
+          "multiple": false,
+          "type": "option"
+        },
         "sort": {
           "description": "Sort results by the provided field",
           "name": "sort",
@@ -3073,7 +3093,7 @@
           "type": "option"
         }
       },
-      "hasDynamicHelp": false,
+      "hasDynamicHelp": true,
       "hiddenAliases": [],
       "id": "tags:list",
       "pluginAlias": "@nickchristensen/ppls",
@@ -3309,5 +3329,5 @@
       ]
     }
   },
-  "version": "1.0.4"
+  "version": "1.1.0"
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@nickchristensen/ppls",
   "description": "A node-based paperless-ngx cli",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "author": "Nick Christensen",
   "bin": {
     "ppls": "bin/run.js"
@@ -80,11 +80,10 @@
     "lint": "eslint",
     "postpack": "shx rm -f oclif.manifest.json",
     "posttest": "npm run lint",
-    "prepack": "oclif manifest && oclif readme --no-aliases",
+    "prepack": "npm run build",
     "postbuild": "oclif manifest && oclif readme --no-aliases",
     "test": "mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif readme --no-aliases && git add README.md",
-    "publish": "npm publish --access public"
+    "version": "oclif readme --no-aliases && git add README.md"
   },
   "types": "dist/index.d.ts"
 }

package/dist/paginated-command.d.ts

@@ -1,49 +0,0 @@
-import type { ApiFlags } from './base-command.js';
-import { BaseCommand } from './base-command.js';
-type PaginatedFlags = ApiFlags & {
-    page?: number;
-    'page-size'?: number;
-};
-export declare abstract class PaginatedCommand extends BaseCommand {
-    static baseFlags: {
-        page: import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'page-size': import("@oclif/core/interfaces").OptionFlag<number | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        'date-format': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
-        header: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        hostname: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-        plain: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        table: import("@oclif/core/interfaces").BooleanFlag<boolean>;
-        token: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
-    };
-    protected buildPaginatedUrl(options: {
-        hostname: string;
-        page?: number;
-        pageSize?: number;
-        params?: Record<string, number | string | undefined>;
-        path: string;
-    }): URL;
-    protected buildPaginatedUrlFromFlags(options: {
-        flags: PaginatedFlags;
-        params?: Record<string, number | string | undefined>;
-        path: string;
-    }): URL;
-    protected fetchPaginatedResults<T>(options: {
-        autoPaginate: boolean;
-        headers: Record<string, string>;
-        spinnerText?: string;
-        token: string;
-        url: URL;
-    }): Promise<T[]>;
-    protected fetchPaginatedResultsFromFlags<T>(options: {
-        autoPaginate: boolean;
-        flags: {
-            headers: Record<string, string>;
-            token: string;
-        };
-        spinnerText?: string;
-        url: URL;
-    }): Promise<T[]>;
-    protected paginate<T>(url: URL, tokenValue: string, headers: Record<string, string>, autoPaginate: boolean): AsyncGenerator<T>;
-    protected normalizeNextUrl(nextUrl: URL, currentUrl: URL): URL;
-}
-export {};

package/dist/paginated-command.js

@@ -1,102 +0,0 @@
-import { Flags } from '@oclif/core';
-import { BaseCommand } from './base-command.js';
-export class PaginatedCommand extends BaseCommand {
-    static baseFlags = {
-        ...BaseCommand.baseFlags,
-        page: Flags.integer({ description: 'Page number to fetch' }),
-        'page-size': Flags.integer({ description: 'Number of results per page' }),
-    };
-    buildPaginatedUrl(options) {
-        const { hostname, page, pageSize, params = {}, path } = options;
-        if (page !== undefined && page < 1) {
-            this.error('Invalid page value. Page must be 1 or greater.');
-        }
-        if (pageSize !== undefined && pageSize < 1) {
-            this.error('Invalid page size. Page size must be 1 or greater.');
-        }
-        return this.buildApiUrl(hostname, path, {
-            ...params,
-            page,
-            'page_size': pageSize,
-        });
-    }
-    buildPaginatedUrlFromFlags(options) {
-        const { flags, params, path } = options;
-        return this.buildPaginatedUrl({
-            hostname: flags.hostname,
-            page: flags.page,
-            pageSize: flags['page-size'],
-            params,
-            path,
-        });
-    }
-    async fetchPaginatedResults(options) {
-        const { autoPaginate, headers, spinnerText, token, url } = options;
-        const spinner = this.startSpinner(spinnerText ?? `Fetching ${url.pathname}`);
-        const results = [];
-        try {
-            let nextUrl = url;
-            while (nextUrl) {
-                const currentUrl = nextUrl;
-                // eslint-disable-next-line no-await-in-loop -- pagination is sequential and depends on the next page URL.
-                const payload = await this.fetchJson(currentUrl, token, headers);
-                results.push(...(payload.results ?? []));
-                if (!autoPaginate || !payload.next) {
-                    break;
-                }
-                try {
-                    const parsedNext = new URL(payload.next, currentUrl);
-                    nextUrl = this.normalizeNextUrl(parsedNext, currentUrl);
-                }
-                catch {
-                    this.error('API returned an invalid next URL for pagination.');
-                }
-            }
-        }
-        finally {
-            spinner?.stop();
-        }
-        return results;
-    }
-    async fetchPaginatedResultsFromFlags(options) {
-        const { autoPaginate, flags, spinnerText, url } = options;
-        return this.fetchPaginatedResults({
-            autoPaginate,
-            headers: flags.headers,
-            spinnerText,
-            token: flags.token,
-            url,
-        });
-    }
-    async *paginate(url, tokenValue, headers, autoPaginate) {
-        let nextUrl = url;
-        while (nextUrl) {
-            const currentUrl = nextUrl;
-            // eslint-disable-next-line no-await-in-loop -- pagination is sequential and depends on the next page URL.
-            const payload = await this.fetchJson(currentUrl, tokenValue, headers);
-            const results = payload.results ?? [];
-            for (const result of results) {
-                yield result;
-            }
-            if (!autoPaginate || !payload.next) {
-                break;
-            }
-            try {
-                const parsedNext = new URL(payload.next, currentUrl);
-                nextUrl = this.normalizeNextUrl(parsedNext, currentUrl);
-            }
-            catch {
-                this.error('API returned an invalid next URL for pagination.');
-            }
-        }
-    }
-    normalizeNextUrl(nextUrl, currentUrl) {
-        if (currentUrl.protocol === 'https:' && nextUrl.protocol === 'http:' && nextUrl.hostname === currentUrl.hostname) {
-            nextUrl.protocol = currentUrl.protocol;
-            if (currentUrl.port) {
-                nextUrl.port = currentUrl.port;
-            }
-        }
-        return nextUrl;
-    }
-}