@nickchristensen/ppls 1.0.1

package/dist/commands/config/remove.js

@@ -0,0 +1,26 @@
+import { Args, Command } from '@oclif/core';
+import { readConfig, writeConfig } from '../../helpers/config-store.js';
+export default class ConfigRemove extends Command {
+    static args = {
+        key: Args.string({ description: 'Config key', required: true }),
+    };
+    static description = 'Remove a config value';
+    static enableJsonFlag = true;
+    static examples = ['<%= config.bin %> <%= command.id %> token'];
+    async run() {
+        const { args } = await this.parse();
+        const typedArgs = args;
+        const config = await readConfig(this.config.configDir);
+        if (Object.hasOwn(config, typedArgs.key)) {
+            delete config[typedArgs.key];
+            await writeConfig(this.config.configDir, config);
+            if (!this.jsonEnabled()) {
+                this.log(`Removed ${typedArgs.key}`);
+            }
+        }
+        else if (!this.jsonEnabled()) {
+            this.log(`Config key ${typedArgs.key} not set.`);
+        }
+        return config;
+    }
+}

package/dist/commands/config/set.d.ts

@@ -0,0 +1,12 @@
+import { Command } from '@oclif/core';
+import { type ConfigData } from '../../helpers/config-store.js';
+export default class ConfigSet extends Command {
+    static args: {
+        key: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+        value: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static enableJsonFlag: boolean;
+    static examples: string[];
+    run(): Promise<ConfigData>;
+}

package/dist/commands/config/set.js

@@ -0,0 +1,58 @@
+import { Args, Command } from '@oclif/core';
+import { readConfig, writeConfig } from '../../helpers/config-store.js';
+const parseConfigValue = (raw) => {
+    let trimmed = raw.trim();
+    if (!trimmed) {
+        return '';
+    }
+    if ((trimmed.startsWith("'") && trimmed.endsWith("'")) ||
+        (trimmed.startsWith('"') && trimmed.endsWith('"'))) {
+        trimmed = trimmed.slice(1, -1).trim();
+    }
+    if (trimmed.startsWith('{') || trimmed.startsWith('[')) {
+        try {
+            return JSON.parse(trimmed);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            throw new Error(`Invalid JSON value: ${message}`);
+        }
+    }
+    return trimmed;
+};
+export default class ConfigSet extends Command {
+    static args = {
+        key: Args.string({ description: 'Config key', required: true }),
+        value: Args.string({ description: 'Config value', required: true }),
+    };
+    static description = 'Set a config value';
+    static enableJsonFlag = true;
+    static examples = [
+        '<%= config.bin %> <%= command.id %> hostname https://paperless.example.com',
+        '<%= config.bin %> <%= command.id %> headers \'{"X-Api-Key":"token"}\'',
+    ];
+    async run() {
+        const { args } = await this.parse();
+        const typedArgs = args;
+        const config = await readConfig(this.config.configDir);
+        let parsedValue;
+        try {
+            parsedValue = parseConfigValue(typedArgs.value);
+        }
+        catch (error) {
+            const message = error instanceof Error ? error.message : String(error);
+            this.error(message);
+        }
+        if (typedArgs.key === 'headers' &&
+            (!parsedValue || typeof parsedValue !== 'object' || Array.isArray(parsedValue))) {
+            this.warn('Config key "headers" must be a JSON object. Example: {"X-Api-Key":"token"}');
+            return config;
+        }
+        config[typedArgs.key] = parsedValue;
+        await writeConfig(this.config.configDir, config);
+        if (!this.jsonEnabled()) {
+            this.log(`Set ${typedArgs.key}`);
+        }
+        return config;
+    }
+}

package/dist/commands/correspondents/add.d.ts

@@ -0,0 +1,12 @@
+import type { Correspondent, CorrespondentCreate } from '../../types/correspondents.js';
+import { AddCommand } from '../../add-command.js';
+export default class CorrespondentsAdd extends AddCommand<CorrespondentCreate, Correspondent> {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    protected createPath: string;
+    protected buildPayload(args: unknown, _flags: Record<string, unknown>): CorrespondentCreate;
+    protected plainTemplate(correspondent: Correspondent): string | undefined;
+}

package/dist/commands/correspondents/add.js

@@ -0,0 +1,20 @@
+import { Args } from '@oclif/core';
+import { AddCommand } from '../../add-command.js';
+export default class CorrespondentsAdd extends AddCommand {
+    static args = {
+        name: Args.string({ description: 'Correspondent name', required: true }),
+    };
+    static description = 'Create a correspondent';
+    static examples = ['<%= config.bin %> <%= command.id %> "Acme Corp"'];
+    createPath = '/api/correspondents/';
+    buildPayload(args, _flags) {
+        const typedArgs = args;
+        return {
+            'matching_algorithm': 6,
+            name: typedArgs.name,
+        };
+    }
+    plainTemplate(correspondent) {
+        return `[${correspondent.id}] ${correspondent.name}`;
+    }
+}

package/dist/commands/correspondents/delete.d.ts

@@ -0,0 +1,16 @@
+import { DeleteCommand } from '../../delete-command.js';
+export default class CorrespondentsDelete extends DeleteCommand {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected deleteLabel(id: number | string): string;
+    protected deletePath(id: number | string): string;
+}

package/dist/commands/correspondents/delete.js

@@ -0,0 +1,18 @@
+import { Args, Flags } from '@oclif/core';
+import { DeleteCommand } from '../../delete-command.js';
+export default class CorrespondentsDelete extends DeleteCommand {
+    static args = {
+        id: Args.integer({ description: 'Correspondent id', required: true }),
+    };
+    static description = 'Delete a correspondent';
+    static examples = ['<%= config.bin %> <%= command.id %> 123'];
+    static flags = {
+        yes: Flags.boolean({ char: 'y', description: 'Skip confirmation prompt' }),
+    };
+    deleteLabel(id) {
+        return `correspondent ${id}`;
+    }
+    deletePath(id) {
+        return `/api/correspondents/${id}/`;
+    }
+}

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

@@ -0,0 +1,9 @@
+import type { Correspondent } from '../../types/correspondents.js';
+import { ListCommand } from '../../list-command.js';
+export default class CorrespondentsList extends ListCommand<Correspondent> {
+    static description: string;
+    static examples: string[];
+    protected listPath: string;
+    protected tableAttrs: string[];
+    protected plainTemplate(correspondent: Correspondent): string | undefined;
+}

package/dist/commands/correspondents/list.js

@@ -0,0 +1,15 @@
+import { ListCommand } from '../../list-command.js';
+export default class CorrespondentsList extends ListCommand {
+    static description = 'List correspondents';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    listPath = '/api/correspondents/';
+    tableAttrs = ['id', 'name', 'slug', 'document_count'];
+    plainTemplate(correspondent) {
+        if (!correspondent.name) {
+            return;
+        }
+        const count = correspondent.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${correspondent.id}] ${correspondent.name}${suffix}`;
+    }
+}

package/dist/commands/correspondents/show.d.ts

@@ -0,0 +1,14 @@
+import type { Correspondent } from '../../types/correspondents.js';
+import { ShowCommand } from '../../show-command.js';
+export default class CorrespondentsShow extends ShowCommand<Correspondent> {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    protected plainTemplate(correspondent: Correspondent): string | undefined;
+    protected showPath(id: number | string): string;
+}

package/dist/commands/correspondents/show.js

@@ -0,0 +1,17 @@
+import { Args } from '@oclif/core';
+import { ShowCommand } from '../../show-command.js';
+export default class CorrespondentsShow extends ShowCommand {
+    static args = {
+        id: Args.integer({ description: 'Correspondent id', required: true }),
+    };
+    static description = 'Show correspondent details';
+    static examples = ['<%= config.bin %> <%= command.id %> 123'];
+    plainTemplate(correspondent) {
+        const count = correspondent.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${correspondent.id}] ${correspondent.name}${suffix}`;
+    }
+    showPath(id) {
+        return `/api/correspondents/${id}/`;
+    }
+}

package/dist/commands/correspondents/update.d.ts

@@ -0,0 +1,18 @@
+import type { Correspondent, CorrespondentUpdate } from '../../types/correspondents.js';
+import { UpdateCommand } from '../../update-command.js';
+export default class CorrespondentsUpdate extends UpdateCommand<CorrespondentUpdate, Correspondent> {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    protected buildPayload(_args: unknown, flags: Record<string, unknown>): CorrespondentUpdate;
+    protected plainTemplate(correspondent: Correspondent): string | undefined;
+    protected updatePath(id: number | string): string;
+}

package/dist/commands/correspondents/update.js

@@ -0,0 +1,24 @@
+import { Args, Flags } from '@oclif/core';
+import { UpdateCommand } from '../../update-command.js';
+export default class CorrespondentsUpdate extends UpdateCommand {
+    static args = {
+        id: Args.integer({ description: 'Correspondent id', required: true }),
+    };
+    static description = 'Update a correspondent';
+    static examples = ['<%= config.bin %> <%= command.id %> 123 --name "Acme Corp"'];
+    static flags = {
+        name: Flags.string({ description: 'Correspondent name' }),
+    };
+    buildPayload(_args, flags) {
+        const typedFlags = flags;
+        return {
+            name: typedFlags.name,
+        };
+    }
+    plainTemplate(correspondent) {
+        return `[${correspondent.id}] ${correspondent.name}`;
+    }
+    updatePath(id) {
+        return `/api/correspondents/${id}/`;
+    }
+}

package/dist/commands/custom-fields/add.d.ts

@@ -0,0 +1,16 @@
+import type { CustomField, CustomFieldCreate } from '../../types/custom-fields.js';
+import { AddCommand } from '../../add-command.js';
+export default class CustomFieldsAdd extends AddCommand<CustomFieldCreate, CustomField> {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'data-type': import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        option: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    protected createPath: string;
+    protected buildPayload(args: unknown, flags: Record<string, unknown>): CustomFieldCreate;
+    protected plainTemplate(field: CustomField): string | undefined;
+}

package/dist/commands/custom-fields/add.js

@@ -0,0 +1,91 @@
+import { Args, Flags } from '@oclif/core';
+import { AddCommand } from '../../add-command.js';
+const dataTypeOptions = [
+    'boolean',
+    'date',
+    'integer',
+    'number',
+    'monetary',
+    'text',
+    'url',
+    'document link',
+    'select',
+    'long text',
+];
+const dataTypeMap = {
+    boolean: 'boolean',
+    date: 'date',
+    'document link': 'documentlink',
+    integer: 'integer',
+    'long text': 'longtext',
+    monetary: 'monetary',
+    number: 'float',
+    select: 'select',
+    text: 'string',
+    url: 'url',
+};
+export default class CustomFieldsAdd extends AddCommand {
+    static args = {
+        name: Args.string({ description: 'Custom field name', required: true }),
+    };
+    static description = 'Create a custom field';
+    static examples = ['<%= config.bin %> <%= command.id %> "Due Date" --data-type date'];
+    static flags = {
+        'data-type': Flags.string({
+            description: 'Custom field data type',
+            options: [...dataTypeOptions],
+            relationships: [
+                {
+                    flags: [
+                        {
+                            name: 'option',
+                            when: async (flags) => flags['data-type'] === 'select',
+                        },
+                    ],
+                    type: 'all',
+                },
+            ],
+            required: true,
+        }),
+        option: Flags.string({
+            description: 'Select option label (repeatable)',
+            multiple: true,
+            relationships: [
+                {
+                    flags: [
+                        {
+                            name: 'data-type',
+                            when: async (flags) => flags['data-type'] !== 'select',
+                        },
+                    ],
+                    type: 'none',
+                },
+            ],
+        }),
+    };
+    createPath = '/api/custom_fields/';
+    buildPayload(args, flags) {
+        const typedArgs = args;
+        const dataType = flags['data-type'].trim().toLowerCase();
+        const mappedType = dataTypeMap[dataType];
+        const options = flags.option ?? [];
+        const selectOptions = options.map((option) => option.trim()).filter(Boolean);
+        if (!mappedType) {
+            this.error(`Unsupported data type "${dataType}".`);
+        }
+        return {
+            'data_type': mappedType,
+            'extra_data': mappedType === 'select'
+                ? {
+                    'select_options': selectOptions.map((label) => ({ label })),
+                }
+                : undefined,
+            name: typedArgs.name,
+        };
+    }
+    plainTemplate(field) {
+        const count = field.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${field.id}] ${field.name}${suffix}`;
+    }
+}

package/dist/commands/custom-fields/delete.d.ts

@@ -0,0 +1,16 @@
+import { DeleteCommand } from '../../delete-command.js';
+export default class CustomFieldsDelete extends DeleteCommand {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected deleteLabel(id: number | string): string;
+    protected deletePath(id: number | string): string;
+}

package/dist/commands/custom-fields/delete.js

@@ -0,0 +1,18 @@
+import { Args, Flags } from '@oclif/core';
+import { DeleteCommand } from '../../delete-command.js';
+export default class CustomFieldsDelete extends DeleteCommand {
+    static args = {
+        id: Args.integer({ description: 'Custom field id', required: true }),
+    };
+    static description = 'Delete a custom field';
+    static examples = ['<%= config.bin %> <%= command.id %> 123'];
+    static flags = {
+        yes: Flags.boolean({ char: 'y', description: 'Skip confirmation prompt' }),
+    };
+    deleteLabel(id) {
+        return `custom field ${id}`;
+    }
+    deletePath(id) {
+        return `/api/custom_fields/${id}/`;
+    }
+}

package/dist/commands/custom-fields/list.d.ts

@@ -0,0 +1,9 @@
+import type { CustomField } from '../../types/custom-fields.js';
+import { ListCommand } from '../../list-command.js';
+export default class CustomFieldsList extends ListCommand<CustomField> {
+    static description: string;
+    static examples: string[];
+    protected listPath: string;
+    protected tableAttrs: string[];
+    protected plainTemplate(customField: CustomField): string | undefined;
+}

package/dist/commands/custom-fields/list.js

@@ -0,0 +1,12 @@
+import { ListCommand } from '../../list-command.js';
+export default class CustomFieldsList extends ListCommand {
+    static description = 'List custom fields';
+    static examples = ['<%= config.bin %> <%= command.id %>'];
+    listPath = '/api/custom_fields/';
+    tableAttrs = ['id', 'name', 'data_type', 'document_count'];
+    plainTemplate(customField) {
+        const count = customField.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${customField.id}] ${customField.name}${suffix}`;
+    }
+}

package/dist/commands/custom-fields/show.d.ts

@@ -0,0 +1,14 @@
+import type { CustomField } from '../../types/custom-fields.js';
+import { ShowCommand } from '../../show-command.js';
+export default class CustomFieldsShow extends ShowCommand<CustomField> {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    protected plainTemplate(customField: CustomField): string | undefined;
+    protected showPath(id: number | string): string;
+}

package/dist/commands/custom-fields/show.js

@@ -0,0 +1,17 @@
+import { Args } from '@oclif/core';
+import { ShowCommand } from '../../show-command.js';
+export default class CustomFieldsShow extends ShowCommand {
+    static args = {
+        id: Args.integer({ description: 'Custom field id', required: true }),
+    };
+    static description = 'Show custom field details';
+    static examples = ['<%= config.bin %> <%= command.id %> 123'];
+    plainTemplate(customField) {
+        const count = customField.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${customField.id}] ${customField.name}${suffix}`;
+    }
+    showPath(id) {
+        return `/api/custom_fields/${id}/`;
+    }
+}

package/dist/commands/custom-fields/update.d.ts

@@ -0,0 +1,20 @@
+import type { CustomField, CustomFieldUpdate } from '../../types/custom-fields.js';
+import { UpdateCommand } from '../../update-command.js';
+export default class CustomFieldsUpdate extends UpdateCommand<CustomFieldUpdate, CustomField> {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        'data-type': import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        name: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        option: import("@oclif/core/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/interfaces").CustomOptions>;
+    };
+    protected buildPayload(_args: unknown, flags: Record<string, unknown>): CustomFieldUpdate;
+    protected plainTemplate(field: CustomField): string | undefined;
+    protected updatePath(id: number | string): string;
+}

package/dist/commands/custom-fields/update.js

@@ -0,0 +1,93 @@
+import { Args, Flags } from '@oclif/core';
+import { UpdateCommand } from '../../update-command.js';
+const dataTypeOptions = [
+    'boolean',
+    'date',
+    'integer',
+    'number',
+    'monetary',
+    'text',
+    'url',
+    'document link',
+    'select',
+    'long text',
+];
+const dataTypeMap = {
+    boolean: 'boolean',
+    date: 'date',
+    'document link': 'documentlink',
+    integer: 'integer',
+    'long text': 'longtext',
+    monetary: 'monetary',
+    number: 'float',
+    select: 'select',
+    text: 'string',
+    url: 'url',
+};
+export default class CustomFieldsUpdate extends UpdateCommand {
+    static args = {
+        id: Args.integer({ description: 'Custom field id', required: true }),
+    };
+    static description = 'Update a custom field';
+    static examples = ['<%= config.bin %> <%= command.id %> 123 --name "Due Date"'];
+    static flags = {
+        'data-type': Flags.string({
+            description: 'Custom field data type',
+            options: [...dataTypeOptions],
+            relationships: [
+                {
+                    flags: [
+                        {
+                            name: 'option',
+                            when: async (flags) => flags['data-type'] === 'select',
+                        },
+                    ],
+                    type: 'all',
+                },
+            ],
+        }),
+        name: Flags.string({ description: 'Custom field name' }),
+        option: Flags.string({
+            description: 'Select option label (repeatable)',
+            multiple: true,
+            relationships: [
+                {
+                    flags: [
+                        {
+                            name: 'data-type',
+                            when: async (flags) => flags['data-type'] !== 'select',
+                        },
+                    ],
+                    type: 'none',
+                },
+            ],
+        }),
+    };
+    buildPayload(_args, flags) {
+        const typedFlags = flags;
+        const dataType = typedFlags['data-type']?.trim().toLowerCase();
+        const mappedType = dataType ? dataTypeMap[dataType] : undefined;
+        const options = typedFlags.option ?? [];
+        const selectOptions = options.map((option) => option.trim()).filter(Boolean);
+        if (dataType && !mappedType) {
+            this.error(`Unsupported data type "${dataType}".`);
+        }
+        return {
+            'data_type': mappedType,
+            'extra_data': mappedType === 'select'
+                ? {
+                    'select_options': selectOptions.map((label) => ({ label })),
+                }
+                : undefined,
+            name: typedFlags.name,
+        };
+    }
+    plainTemplate(field) {
+        const count = field.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${field.id}] ${field.name}${suffix}`;
+    }
+    updatePath(id) {
+        return `/api/custom_fields/${id}/`;
+    }
+}

package/dist/commands/document-types/add.d.ts

@@ -0,0 +1,12 @@
+import type { DocumentType, DocumentTypeCreate } from '../../types/document-types.js';
+import { AddCommand } from '../../add-command.js';
+export default class DocumentTypesAdd extends AddCommand<DocumentTypeCreate, DocumentType> {
+    static args: {
+        name: import("@oclif/core/interfaces").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    protected createPath: string;
+    protected buildPayload(args: unknown, _flags: Record<string, unknown>): DocumentTypeCreate;
+    protected plainTemplate(documentType: DocumentType): string | undefined;
+}

package/dist/commands/document-types/add.js

@@ -0,0 +1,22 @@
+import { Args } from '@oclif/core';
+import { AddCommand } from '../../add-command.js';
+export default class DocumentTypesAdd extends AddCommand {
+    static args = {
+        name: Args.string({ description: 'Document type name', required: true }),
+    };
+    static description = 'Create a document type';
+    static examples = ['<%= config.bin %> <%= command.id %> "Invoice"'];
+    createPath = '/api/document_types/';
+    buildPayload(args, _flags) {
+        const typedArgs = args;
+        return {
+            'matching_algorithm': 6,
+            name: typedArgs.name,
+        };
+    }
+    plainTemplate(documentType) {
+        const count = documentType.document_count;
+        const suffix = count === undefined ? '' : ` (${count} ${count === 1 ? 'document' : 'documents'})`;
+        return `[${documentType.id}] ${documentType.name}${suffix}`;
+    }
+}

package/dist/commands/document-types/delete.d.ts

@@ -0,0 +1,16 @@
+import { DeleteCommand } from '../../delete-command.js';
+export default class DocumentTypesDelete extends DeleteCommand {
+    static args: {
+        id: import("@oclif/core/interfaces").Arg<number, {
+            max?: number;
+            min?: number;
+        }>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        yes: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    protected deleteLabel(id: number | string): string;
+    protected deletePath(id: number | string): string;
+}