@baruchiro/paperless-mcp 1.0.0 → 2.0.0

package/build/tools/mail.test.js

@@ -0,0 +1,212 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_test_1 = require("node:test");
+const index_js_1 = require("@modelcontextprotocol/sdk/client/index.js");
+const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
+const mail_1 = require("./mail");
+class TestTransport {
+    start() {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    send(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            queueMicrotask(() => { var _a, _b; return (_b = (_a = this.peer) === null || _a === void 0 ? void 0 : _a.onmessage) === null || _b === void 0 ? void 0 : _b.call(_a, message); });
+        });
+    }
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            (_a = this.onclose) === null || _a === void 0 ? void 0 : _a.call(this);
+        });
+    }
+}
+function createTransportPair() {
+    const clientTransport = new TestTransport();
+    const serverTransport = new TestTransport();
+    clientTransport.peer = serverTransport;
+    serverTransport.peer = clientTransport;
+    return { clientTransport, serverTransport };
+}
+function parseToolText(result) {
+    var _a;
+    const item = (_a = result.content) === null || _a === void 0 ? void 0 : _a[0];
+    if (!item || item.type !== "text") {
+        throw new Error("Expected text tool response");
+    }
+    return JSON.parse(item.text);
+}
+function withMailClient(api, run) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const server = new mcp_js_1.McpServer({ name: "paperless-mail-test", version: "1.0.0" });
+        (0, mail_1.registerMailTools)(server, api);
+        const client = new index_js_1.Client({
+            name: "paperless-mail-test-client",
+            version: "1.0.0",
+        });
+        const { clientTransport, serverTransport } = createTransportPair();
+        yield server.connect(serverTransport);
+        yield client.connect(clientTransport);
+        try {
+            yield run(client);
+        }
+        finally {
+            yield client.close();
+            yield server.close();
+        }
+    });
+}
+(0, node_test_1.test)("mail tools are registered", () => __awaiter(void 0, void 0, void 0, function* () {
+    yield withMailClient({}, (client) => __awaiter(void 0, void 0, void 0, function* () {
+        const result = yield client.listTools();
+        const names = result.tools.map((tool) => tool.name).sort();
+        strict_1.default.deepEqual(names, [
+            "create_mail_rule",
+            "delete_mail_rule",
+            "get_mail_account",
+            "get_mail_rule",
+            "list_mail_accounts",
+            "list_mail_rules",
+            "process_mail_account",
+            "update_mail_rule",
+        ]);
+    }));
+}));
+(0, node_test_1.test)("list_mail_accounts redacts returned passwords", () => __awaiter(void 0, void 0, void 0, function* () {
+    const api = {
+        getMailAccounts: (queryString) => __awaiter(void 0, void 0, void 0, function* () {
+            return ({
+                count: 1,
+                next: null,
+                previous: null,
+                results: [
+                    {
+                        id: 1,
+                        name: "Inbox",
+                        username: "paperless@example.test",
+                        password: "secret",
+                        queryString,
+                    },
+                ],
+            });
+        }),
+    };
+    yield withMailClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+        const result = (yield client.callTool({
+            name: "list_mail_accounts",
+            arguments: { page: 2, page_size: 10 },
+        }));
+        const response = parseToolText(result);
+        strict_1.default.equal(response.results[0].password, undefined);
+        strict_1.default.equal(response.results[0].queryString, "page=2&page_size=10");
+    }));
+}));
+(0, node_test_1.test)("get_mail_account redacts returned password", () => __awaiter(void 0, void 0, void 0, function* () {
+    const api = {
+        getMailAccount: (id) => __awaiter(void 0, void 0, void 0, function* () {
+            return ({
+                id,
+                name: "Inbox",
+                username: "paperless@example.test",
+                password: "secret",
+            });
+        }),
+    };
+    yield withMailClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+        const result = (yield client.callTool({
+            name: "get_mail_account",
+            arguments: { id: 7 },
+        }));
+        const account = parseToolText(result);
+        strict_1.default.deepEqual(account, {
+            id: 7,
+            name: "Inbox",
+            username: "paperless@example.test",
+        });
+    }));
+}));
+(0, node_test_1.test)("process_mail_account reports success after processing", () => __awaiter(void 0, void 0, void 0, function* () {
+    const calls = [];
+    const api = {
+        processMailAccount: (id) => __awaiter(void 0, void 0, void 0, function* () {
+            calls.push(["process", id]);
+        }),
+    };
+    yield withMailClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+        const result = (yield client.callTool({
+            name: "process_mail_account",
+            arguments: { id: 5 },
+        }));
+        const response = parseToolText(result);
+        strict_1.default.deepEqual(response, { status: "processed" });
+    }));
+    strict_1.default.deepEqual(calls, [["process", 5]]);
+}));
+(0, node_test_1.test)("mail rule write tools pass through payloads", () => __awaiter(void 0, void 0, void 0, function* () {
+    const calls = [];
+    const api = {
+        createMailRule: (data) => __awaiter(void 0, void 0, void 0, function* () {
+            calls.push(["create", data]);
+            return Object.assign({ id: 3 }, data);
+        }),
+        updateMailRule: (id, data) => __awaiter(void 0, void 0, void 0, function* () {
+            calls.push(["update", id, data]);
+            return Object.assign({ id }, data);
+        }),
+        deleteMailRule: (id) => __awaiter(void 0, void 0, void 0, function* () {
+            calls.push(["delete", id]);
+        }),
+    };
+    yield withMailClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+        yield client.callTool({
+            name: "create_mail_rule",
+            arguments: {
+                name: "Invoices",
+                account: 1,
+                folder: "INBOX",
+                filter_from: "billing@example.test",
+                assign_tags: [3, 15],
+            },
+        });
+        yield client.callTool({
+            name: "update_mail_rule",
+            arguments: {
+                id: 3,
+                enabled: false,
+            },
+        });
+        yield client.callTool({
+            name: "delete_mail_rule",
+            arguments: {
+                id: 3,
+                confirm: true,
+            },
+        });
+    }));
+    strict_1.default.deepEqual(calls, [
+        [
+            "create",
+            {
+                name: "Invoices",
+                account: 1,
+                folder: "INBOX",
+                filter_from: "billing@example.test",
+                assign_tags: [3, 15],
+            },
+        ],
+        ["update", 3, { enabled: false }],
+        ["delete", 3],
+    ]);
+}));

package/build/tools/notes.d.ts

@@ -0,0 +1,3 @@
+import { McpServer } from "@modelcontextprotocol/sdk/server/mcp";
+import { PaperlessAPI } from "../api/PaperlessAPI";
+export declare function registerNoteTools(server: McpServer, api: PaperlessAPI): void;

package/build/tools/notes.js

@@ -0,0 +1,55 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.registerNoteTools = registerNoteTools;
+const zod_1 = require("zod");
+const middlewares_1 = require("./utils/middlewares");
+function notesResult(notes) {
+    return {
+        content: [
+            {
+                type: "text",
+                text: JSON.stringify(notes),
+            },
+        ],
+    };
+}
+function registerNoteTools(server, api) {
+    server.tool("list_document_notes", "List all notes attached to a document. Notes are free-text comments on a document and are the natural place for an audit trail (e.g. \"invoice paid on X from account Y\") or progress notes on an action item.", {
+        id: zod_1.z.number().describe("The document ID"),
+    }, (0, middlewares_1.withErrorHandling)((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!api)
+            throw new Error("Please configure API connection first");
+        return notesResult(yield api.getDocumentNotes(args.id));
+    })));
+    server.tool("create_document_note", "Add a note to a document. Use this to record an audit trail or progress note directly on the document. Returns the document's full list of notes after the note is added.", {
+        id: zod_1.z.number().describe("The document ID"),
+        note: zod_1.z.string().min(1).describe("The note text to add"),
+    }, (0, middlewares_1.withErrorHandling)((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!api)
+            throw new Error("Please configure API connection first");
+        return notesResult(yield api.createDocumentNote(args.id, args.note));
+    })));
+    server.tool("delete_document_note", "⚠️ DESTRUCTIVE: Permanently delete a single note from a document by its note ID. This operation is irreversible. Returns the document's remaining notes.", {
+        id: zod_1.z.number().describe("The document ID"),
+        note_id: zod_1.z.number().describe("The ID of the note to delete"),
+        confirm: zod_1.z
+            .boolean()
+            .describe("Must be true to confirm this destructive operation"),
+    }, (0, middlewares_1.withErrorHandling)((args) => __awaiter(this, void 0, void 0, function* () {
+        if (!api)
+            throw new Error("Please configure API connection first");
+        if (!args.confirm) {
+            throw new Error("Confirmation required for destructive operation. Set confirm: true to proceed.");
+        }
+        return notesResult(yield api.deleteDocumentNote(args.id, args.note_id));
+    })));
+}

package/build/tools/notes.test.d.ts

@@ -0,0 +1 @@
+export {};

package/build/tools/notes.test.js

@@ -0,0 +1,177 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const strict_1 = __importDefault(require("node:assert/strict"));
+const node_test_1 = require("node:test");
+const index_js_1 = require("@modelcontextprotocol/sdk/client/index.js");
+const mcp_js_1 = require("@modelcontextprotocol/sdk/server/mcp.js");
+const notes_1 = require("./notes");
+class TestTransport {
+    start() {
+        return __awaiter(this, void 0, void 0, function* () { });
+    }
+    send(message) {
+        return __awaiter(this, void 0, void 0, function* () {
+            queueMicrotask(() => { var _a, _b; return (_b = (_a = this.peer) === null || _a === void 0 ? void 0 : _a.onmessage) === null || _b === void 0 ? void 0 : _b.call(_a, message); });
+        });
+    }
+    close() {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            (_a = this.onclose) === null || _a === void 0 ? void 0 : _a.call(this);
+        });
+    }
+}
+function createTransportPair() {
+    const clientTransport = new TestTransport();
+    const serverTransport = new TestTransport();
+    clientTransport.peer = serverTransport;
+    serverTransport.peer = clientTransport;
+    return { clientTransport, serverTransport };
+}
+function parseToolText(result) {
+    var _a;
+    const item = (_a = result.content) === null || _a === void 0 ? void 0 : _a[0];
+    if (!item || item.type !== "text") {
+        throw new Error("Expected text tool response");
+    }
+    return JSON.parse(item.text);
+}
+function createNoteApi(notes = []) {
+    const calls = {
+        getDocumentNotes: [],
+        createDocumentNote: [],
+        deleteDocumentNote: [],
+    };
+    const api = {
+        getDocumentNotes: (id) => __awaiter(this, void 0, void 0, function* () {
+            calls.getDocumentNotes.push(id);
+            return notes;
+        }),
+        createDocumentNote: (id, note) => __awaiter(this, void 0, void 0, function* () {
+            calls.createDocumentNote.push([id, note]);
+            return notes;
+        }),
+        deleteDocumentNote: (id, noteId) => __awaiter(this, void 0, void 0, function* () {
+            calls.deleteDocumentNote.push([id, noteId]);
+            return notes;
+        }),
+    };
+    return { api, calls };
+}
+function withNoteClient(api, run) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const server = new mcp_js_1.McpServer({ name: "paperless-note-test", version: "1.0.0" });
+        (0, notes_1.registerNoteTools)(server, api);
+        const client = new index_js_1.Client({
+            name: "paperless-note-test-client",
+            version: "1.0.0",
+        });
+        const { clientTransport, serverTransport } = createTransportPair();
+        yield server.connect(serverTransport);
+        yield client.connect(clientTransport);
+        try {
+            yield run(client);
+        }
+        finally {
+            yield client.close();
+            yield server.close();
+        }
+    });
+}
+(0, node_test_1.describe)("document note tools", () => {
+    const sampleNotes = [
+        {
+            id: 5,
+            note: "Paid 2026-06-30",
+            created: "2026-06-30T10:00:00Z",
+            user: { id: 3, username: "nick" },
+        },
+    ];
+    (0, node_test_1.test)("create_document_note posts the note text to the document", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, calls } = createNoteApi(sampleNotes);
+        yield withNoteClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            const result = (yield client.callTool({
+                name: "create_document_note",
+                arguments: { id: 1740, note: "Antwort an Finanzamt versendet" },
+            }));
+            strict_1.default.ok(!result.isError, (_a = parseToolText(result)) === null || _a === void 0 ? void 0 : _a.error);
+            strict_1.default.deepEqual(parseToolText(result), sampleNotes);
+        }));
+        strict_1.default.deepEqual(calls.createDocumentNote, [
+            [1740, "Antwort an Finanzamt versendet"],
+        ]);
+    }));
+    (0, node_test_1.test)("list_document_notes fetches notes for the document", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, calls } = createNoteApi(sampleNotes);
+        yield withNoteClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            const result = (yield client.callTool({
+                name: "list_document_notes",
+                arguments: { id: 42 },
+            }));
+            strict_1.default.ok(!result.isError, (_a = parseToolText(result)) === null || _a === void 0 ? void 0 : _a.error);
+            strict_1.default.deepEqual(parseToolText(result), sampleNotes);
+        }));
+        strict_1.default.deepEqual(calls.getDocumentNotes, [42]);
+    }));
+    (0, node_test_1.test)("delete_document_note removes a note by its note ID when confirmed", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, calls } = createNoteApi([]);
+        yield withNoteClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a;
+            const result = (yield client.callTool({
+                name: "delete_document_note",
+                arguments: { id: 42, note_id: 5, confirm: true },
+            }));
+            strict_1.default.ok(!result.isError, (_a = parseToolText(result)) === null || _a === void 0 ? void 0 : _a.error);
+        }));
+        strict_1.default.deepEqual(calls.deleteDocumentNote, [[42, 5]]);
+    }));
+    (0, node_test_1.test)("delete_document_note refuses to delete without confirmation", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, calls } = createNoteApi([]);
+        yield withNoteClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+            var _a, _b;
+            const result = (yield client.callTool({
+                name: "delete_document_note",
+                arguments: { id: 42, note_id: 5, confirm: false },
+            }));
+            strict_1.default.ok(result.isError, "expected an error when confirm is false");
+            strict_1.default.match((_b = (_a = parseToolText(result)) === null || _a === void 0 ? void 0 : _a.error) !== null && _b !== void 0 ? _b : "", /confirm/i);
+        }));
+        strict_1.default.equal(calls.deleteDocumentNote.length, 0, "no delete should be sent without confirmation");
+    }));
+    (0, node_test_1.test)("create_document_note rejects an empty note", () => __awaiter(void 0, void 0, void 0, function* () {
+        const { api, calls } = createNoteApi(sampleNotes);
+        yield withNoteClient(api, (client) => __awaiter(void 0, void 0, void 0, function* () {
+            // Depending on the installed MCP SDK version, an input-schema (zod)
+            // violation either rejects with a protocol error (-32602) or resolves
+            // with a CallToolResult carrying isError: true. Accept both so the test
+            // stays correct across SDK versions.
+            let rejected = false;
+            let result;
+            try {
+                result = (yield client.callTool({
+                    name: "create_document_note",
+                    arguments: { id: 1, note: "" },
+                }));
+            }
+            catch (_a) {
+                rejected = true;
+            }
+            strict_1.default.ok(rejected || (result === null || result === void 0 ? void 0 : result.isError), "expected an empty note to be rejected");
+        }));
+        strict_1.default.equal(calls.createDocumentNote.length, 0, "no note should be created when validation fails");
+    }));
+});

package/build/tools/utils/descriptions.d.ts

@@ -1 +1 @@
-export declare const CUSTOM_FIELD_VALUE_DESCRIPTION = "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) \u2014 NOT trailing symbol format (e.g., 10.00$). For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456]).";
+export declare const CUSTOM_FIELD_VALUE_DESCRIPTION = "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) \u2014 NOT trailing symbol format (e.g., 10.00$). For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456]). For select fields, pass the option's label (the display text from get_custom_field / list_custom_fields); the server translates it to the encoding Paperless expects.";

package/build/tools/utils/descriptions.js

@@ -1,4 +1,4 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CUSTOM_FIELD_VALUE_DESCRIPTION = void 0;
-exports.CUSTOM_FIELD_VALUE_DESCRIPTION = "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) — NOT trailing symbol format (e.g., 10.00$). For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456]).";
+exports.CUSTOM_FIELD_VALUE_DESCRIPTION = "The value for the custom field. For monetary fields, use currency code prefix format (e.g., USD10.00, GBP123.45, EUR9.99) — NOT trailing symbol format (e.g., 10.00$). For documentlink fields, use a single document ID (e.g., 123) or an array of document IDs (e.g., [123, 456]). For select fields, pass the option's label (the display text from get_custom_field / list_custom_fields); the server translates it to the encoding Paperless expects.";

package/build/tools/utils/documentQuery.d.ts

@@ -0,0 +1,71 @@
+import { z } from "zod";
+declare const CUSTOM_FIELD_QUERY_GROUP_OPERATORS: readonly ["AND", "OR"];
+export type CustomFieldQueryValue = string | number | boolean | null | Array<string | number | boolean | null>;
+export type CustomFieldQuery = [fieldNameOrId: string | number, operator: string, value: CustomFieldQueryValue] | [
+    groupOperator: (typeof CUSTOM_FIELD_QUERY_GROUP_OPERATORS)[number],
+    clauses: CustomFieldQuery[]
+];
+export declare const customFieldQuerySchema: z.ZodType<CustomFieldQuery>;
+export declare const paperlessFilterValueSchema: z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">]>;
+export declare const paperlessFiltersSchema: z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">]>>;
+export declare const LIST_DOCUMENTS_ARGS_SHAPE: {
+    custom_field_query: z.ZodOptional<z.ZodString>;
+    page: z.ZodOptional<z.ZodNumber>;
+    page_size: z.ZodOptional<z.ZodNumber>;
+    search: z.ZodOptional<z.ZodString>;
+    correspondent: z.ZodOptional<z.ZodNumber>;
+    document_type: z.ZodOptional<z.ZodNumber>;
+    tag: z.ZodOptional<z.ZodNumber>;
+    storage_path: z.ZodOptional<z.ZodNumber>;
+    created__date__gte: z.ZodOptional<z.ZodString>;
+    created__date__lte: z.ZodOptional<z.ZodString>;
+    ordering: z.ZodOptional<z.ZodString>;
+    archive_serial_number: z.ZodOptional<z.ZodNumber>;
+    archive_serial_number__isnull: z.ZodOptional<z.ZodBoolean>;
+    custom_fields__icontains: z.ZodOptional<z.ZodString>;
+};
+export declare const QUERY_DOCUMENTS_ARGS_SHAPE: {
+    query: z.ZodOptional<z.ZodString>;
+    more_like_id: z.ZodOptional<z.ZodNumber>;
+    custom_field_query: z.ZodOptional<z.ZodType<CustomFieldQuery, z.ZodTypeDef, CustomFieldQuery>>;
+    paperless_filters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnion<[z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, z.ZodArray<z.ZodUnion<[z.ZodString, z.ZodNumber, z.ZodBoolean]>, "many">]>>>;
+    page: z.ZodOptional<z.ZodNumber>;
+    page_size: z.ZodOptional<z.ZodNumber>;
+    search: z.ZodOptional<z.ZodString>;
+    correspondent: z.ZodOptional<z.ZodNumber>;
+    document_type: z.ZodOptional<z.ZodNumber>;
+    tag: z.ZodOptional<z.ZodNumber>;
+    storage_path: z.ZodOptional<z.ZodNumber>;
+    created__date__gte: z.ZodOptional<z.ZodString>;
+    created__date__lte: z.ZodOptional<z.ZodString>;
+    ordering: z.ZodOptional<z.ZodString>;
+    archive_serial_number: z.ZodOptional<z.ZodNumber>;
+    archive_serial_number__isnull: z.ZodOptional<z.ZodBoolean>;
+    custom_fields__icontains: z.ZodOptional<z.ZodString>;
+};
+export declare const SEARCH_DOCUMENTS_ARGS_SHAPE: {
+    query: z.ZodString;
+};
+export type PaperlessFilterValue = z.infer<typeof paperlessFilterValueSchema>;
+export type BuildDocumentQueryArgs = {
+    page?: number;
+    page_size?: number;
+    ordering?: string;
+    query?: string;
+    search?: string;
+    more_like_id?: number;
+    correspondent?: number;
+    document_type?: number;
+    tag?: number;
+    storage_path?: number;
+    created__date__gte?: string;
+    created__date__lte?: string;
+    archive_serial_number?: number;
+    archive_serial_number__isnull?: boolean;
+    custom_field_query?: string | CustomFieldQuery;
+    custom_fields__icontains?: string;
+    paperless_filters?: Record<string, PaperlessFilterValue>;
+};
+export declare const DOCUMENT_QUERY_PAPERLESS_FILTER_KEYS: readonly ["added__date__gt", "added__date__gte", "added__date__lt", "added__date__lte", "added__day", "added__gt", "added__gte", "added__lt", "added__lte", "added__month", "added__year", "archive_serial_number", "archive_serial_number__gt", "archive_serial_number__gte", "archive_serial_number__isnull", "archive_serial_number__lt", "archive_serial_number__lte", "checksum__icontains", "checksum__iendswith", "checksum__iexact", "checksum__istartswith", "content__icontains", "content__iendswith", "content__iexact", "content__istartswith", "correspondent__id", "correspondent__id__in", "correspondent__id__none", "correspondent__isnull", "correspondent__name__icontains", "correspondent__name__iendswith", "correspondent__name__iexact", "correspondent__name__istartswith", "created__date__gt", "created__date__gte", "created__date__lt", "created__date__lte", "created__day", "created__gt", "created__gte", "created__lt", "created__lte", "created__month", "created__year", "custom_field_query", "custom_fields__icontains", "custom_fields__id__all", "custom_fields__id__in", "custom_fields__id__none", "document_type__id", "document_type__id__in", "document_type__id__none", "document_type__isnull", "document_type__name__icontains", "document_type__name__iendswith", "document_type__name__iexact", "document_type__name__istartswith", "fields", "full_perms", "has_custom_fields", "id", "id__in", "is_in_inbox", "is_tagged", "mime_type", "modified__date__gt", "modified__date__gte", "modified__date__lt", "modified__date__lte", "modified__day", "modified__gt", "modified__gte", "modified__lt", "modified__lte", "modified__month", "modified__year", "ordering", "original_filename__icontains", "original_filename__iendswith", "original_filename__iexact", "original_filename__istartswith", "owner__id", "owner__id__in", "owner__id__none", "owner__isnull", "page", "page_size", "query", "search", "shared_by__id", "storage_path__id", "storage_path__id__in", "storage_path__id__none", "storage_path__isnull", "storage_path__name__icontains", "storage_path__name__iendswith", "storage_path__name__iexact", "storage_path__name__istartswith", "tags__id", "tags__id__all", "tags__id__in", "tags__id__none", "tags__name__icontains", "tags__name__iendswith", "tags__name__iexact", "tags__name__istartswith", "title__icontains", "title__iendswith", "title__iexact", "title__istartswith", "title_content"];
+export declare function buildDocumentQueryString(args: BuildDocumentQueryArgs): string;
+export {};