...
',\n});\n\n// Update content\nconst updated = await page.update({\n markdown: '# Updated Content',\n});\n\n// Comments\nconst comments = await page.getComments();\nawait page.addComment({ html: 'Looks good!
' });\n\n// Export\nconst md = await page.export('markdown');\n```\n\n### š Shelves\n\n```typescript\nconst shelves = await bookstack.getShelves();\nconst shelf = await bookstack.getShelf(1);\n\nconst newShelf = await bookstack.createShelf({\n name: 'Backend Services',\n description: 'All backend service documentation',\n books: [1, 2, 3], // Array of book IDs\n});\n\n// Get books on this shelf\nconst books = await shelf.getBooks();\n\n// Update book assignments\nawait shelf.update({ books: [1, 2, 3, 4] });\n```\n\n### š Search\n\n```typescript\nconst results = await bookstack.search('deployment guide');\n// Returns: IBookStackSearchResult[] with id, name, type, url, preview_html\n```\n\n### š Attachments\n\n```typescript\nconst attachments = await bookstack.getAttachments();\nconst attachment = await bookstack.getAttachment(1);\n\n// Create a link attachment\nconst link = await bookstack.createAttachment({\n name: 'External Reference',\n uploaded_to: 1, // Page ID\n link: 'https://example.com/docs',\n});\n\nawait bookstack.updateAttachment(1, { name: 'Renamed' });\nawait bookstack.deleteAttachment(1);\n```\n\n### š¬ Comments\n\n```typescript\nconst comments = await bookstack.getComments();\nconst comment = await bookstack.getComment(1);\n\nawait bookstack.createComment({\n page_id: 1,\n html: 'Great article!
',\n reply_to: 2, // Reply to comment with local_id 2\n});\n\nawait bookstack.updateComment(1, { html: 'Updated comment
' });\nawait bookstack.deleteComment(1);\n```\n\n### š¼ļø Image Gallery\n\n```typescript\nconst images = await bookstack.getImages();\nconst image = await bookstack.getImage(1);\nawait bookstack.updateImage(1, { name: 'diagram-v2' });\nawait bookstack.deleteImage(1);\n```\n\n### š„ Users & Roles\n\n```typescript\n// Users\nconst users = await bookstack.getUsers();\nconst user = await bookstack.getUser(1);\nconst newUser = await bookstack.createUser({\n name: 'Jane Doe',\n email: 'jane@example.com',\n roles: [1, 2],\n send_invite: true,\n});\nawait bookstack.updateUser(1, { name: 'Jane Smith' });\nawait bookstack.deleteUser(1, { migrate_ownership_id: 2 });\n\n// Roles\nconst roles = await bookstack.getRoles();\nconst role = await bookstack.getRole(1);\nawait bookstack.createRole({\n display_name: 'Editor',\n description: 'Can edit content',\n permissions: ['page-update', 'chapter-update'],\n});\n```\n\n### š Admin Endpoints\n\n```typescript\n// System info\nconst info = await bookstack.getSystemInfo();\n// { version, instance_id, app_name, base_url }\n\n// Audit log\nconst logs = await bookstack.getAuditLog();\n\n// Recycle bin\nconst deleted = await bookstack.getRecycleBinItems();\nawait bookstack.restoreRecycleBinItem(1); // { restore_count: 3 }\nawait bookstack.destroyRecycleBinItem(1); // { delete_count: 3 }\n\n// Content permissions\nconst perms = await bookstack.getContentPermissions('book', 1);\nawait bookstack.updateContentPermissions('book', 1, {\n owner_id: 2,\n role_permissions: [\n { role_id: 1, view: true, create: true, update: true, delete: false },\n ],\n fallback_permissions: { inheriting: true },\n});\n```\n\n## Auto-Pagination\n\nAll list methods automatically paginate through results. BookStack uses offset-based pagination (max 500 per request). The client handles this transparently:\n\n```typescript\n// Gets ALL books, regardless of how many exist\nconst allBooks = await bookstack.getBooks();\n\n// Pass options to control pagination behavior\nconst firstPage = await bookstack.getBooks({ offset: 0, count: 10 });\n\n// Sort and filter\nconst filtered = await bookstack.getBooks({\n sort: '+name',\n filter: { 'name:like': '%Guide%' },\n});\n```\n\n## Exported Types\n\nAll interfaces are exported for use in your own code:\n\n```typescript\nimport type {\n IBookStackBook,\n IBookStackChapter,\n IBookStackPage,\n IBookStackShelf,\n IBookStackAttachment,\n IBookStackComment,\n IBookStackUser,\n IBookStackRole,\n IBookStackSearchResult,\n IBookStackTag,\n IBookStackListParams,\n TBookStackExportFormat,\n} from '@apiclient.xyz/bookstack';\n```\n\n## License and Legal Information\n\nThis repository contains open-source code licensed under the MIT License. A copy of the license can be found in the [license](./license) file.\n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH or third parties, and are not included within the scope of the MIT license granted herein.\n\nUse of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.\n\n### Company Information\n\nTask Venture Capital GmbH\nRegistered at District Court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n","readmeFilename":"readme.md"}