dalux-build-api 2.0.0 → 2.0.2

package/README.md

@@ -1,17 +1,11 @@
-# Dalux Build API
+# Dalux Build API – Node.js Client
 
-API clients for the [Dalux Build REST API](https://app.swaggerhub.com/apis-docs/Dalux/DaluxBuild-api/4.14), available in two languages:
+A lightweight Node.js client for the [Dalux Build REST API](https://app.swaggerhub.com/apis-docs/Dalux/DaluxBuild-api/4.14).
 
-| Language | Location             | Documentation                        |
-| -------- | -------------------- | ------------------------------------ |
-| Node.js  | [`/`](.)             | See below                            |
-| Python   | [`/python`](python/) | [python/README.md](python/README.md) |
-
----
-
-# Node.js Client
-
-A lightweight Node.js client for the Dalux Build REST API.
+See the [repo root README](../README.md) for the Python client
+(`dalux-build`) and the [webhook server](../webhook-server/README.md) built
+on it — the two clients are versioned, tested, and released together; see
+[../CONTRIBUTING.md](../CONTRIBUTING.md).
 
 ## Requirements
 
@@ -41,6 +35,53 @@ const dalux = createClient({
 
 The returned object exposes one namespace per API group (see [API Reference](#api-reference) below).
 
+## Next.js (browser-safe, no CORS)
+
+Dalux API keys must stay server-side, and CORS is controlled by the Dalux API rather than this SDK.
+For Client Components, use the package's same-origin Next.js adapter: the browser calls your own
+App Router endpoint, and that endpoint uses the regular Dalux client on the server.
+
+```js
+// app/api/dalux/route.js
+import { createClient } from "dalux-build-api";
+import { createDaluxRouteHandler } from "dalux-build-api/next";
+import { getCurrentUser } from "@/lib/auth";
+
+const dalux = createClient({
+  baseUrl: process.env.DALUX_BASE_URL,
+  apiKey: process.env.DALUX_API_KEY,
+});
+
+export const POST = createDaluxRouteHandler({
+  client: dalux,
+  // Required: expose only the methods this application needs.
+  allowedMethods: {
+    projects: ["listProjects", "getProject"],
+    tasks: ["getProjectTasks", "getAllProjectTasks"],
+  },
+  // Recommended: connect this to your application's session/authorization.
+  authorize: async (request) => Boolean(await getCurrentUser(request)),
+});
+```
+
+```js
+// app/projects/Projects.jsx
+"use client";
+
+import { createBrowserClient } from "dalux-build-api/browser";
+
+const dalux = createBrowserClient({ url: "/api/dalux" });
+
+export async function loadProjects() {
+  return dalux.projects.listProjects();
+}
+```
+
+The browser entry contains no Axios, Node.js filesystem modules, base URL, or API key. Calls use
+same-origin `fetch`, so the browser does not make a cross-origin Dalux request. Write methods are
+supported only when you explicitly add them to `allowedMethods`; protect the route with your app's
+authorization before exposing them.
+
 ### Examples
 
 **List all projects**
@@ -85,7 +126,7 @@ const allTasks = await dalux.tasks.getAllProjectTasks(
 
 **Files: browse (6.1), fetch all pages, download**
 
-`listFiles` and `getAllFiles` call **GET `/6.1/projects/{projectId}/file_areas/{fileAreaId}/files`** (Dalux `listFiles`). Supported query parameters include `folderId`, `updatedAfter`, and `includeProperties` (see the official spec). Single-file metadata still uses **GET `/5.0/.../files/{fileId}`** (`getFile`).
+`listFiles` and `getAllFiles` call **GET `/6.1/projects/{projectId}/file_areas/{fileAreaId}/files`** (Dalux `listFiles`). The documented optional query parameter is `includeProperties`; pagination uses Dalux's returned bookmark links. Single-file metadata still uses **GET `/5.0/.../files/{fileId}`** (`getFile`).
 
 ```js
 const allFiles = await dalux.files.getAllFiles(
@@ -192,10 +233,15 @@ All API namespaces are accessible on the object returned by `createClient`:
 | `versionSets`      | `VersionSetsApi`      | Version sets and version set files                             |
 | `workPackages`     | `WorkPackagesApi`     | Work packages on a project                                     |
 
+`InspectionPlansApi` and `TestPlansApi` mirror the Python client's list behavior: their `list*`
+methods return the typed `items` array by default and accept `fullResponse = true` as the third
+argument to retain pagination metadata and links. Each collection also has a `getAll*` method that
+follows Dalux bookmark pagination automatically.
+
 ### ProjectsApi
 
 | Method                                      | HTTP  | Path                                                           |
-| ------------------------------------------- | ----- | -------------------------------------------------------------- |
+| -------------------------------------------- | ----- | ---------------------------------------------------------------- |
 | `listProjects(params?)`                     | GET   | `/5.1/projects`                                                |
 | `getProject(projectId)`                     | GET   | `/5.0/projects/{projectId}`                                    |
 | `createProject(body)`                       | POST  | `/5.0/projects`                                                |
@@ -218,7 +264,7 @@ All API namespaces are accessible on the object returned by `createClient`:
 ### CompanyCatalogApi
 
 | Method                                             | HTTP  | Path                                                                        |
-| -------------------------------------------------- | ----- | --------------------------------------------------------------------------- |
+| -------------------------------------------------- | ----- | ----------------------------------------------------------------------------- |
 | `getCompanies(params?)`                            | GET   | `/2.2/companyCatalog`                                                       |
 | `getCompany(catalogCompanyId)`                     | GET   | `/1.2/companyCatalog/{catalogCompanyId}`                                    |
 | `createCompany(body)`                              | POST  | `/2.2/companyCatalog`                                                       |
@@ -244,7 +290,7 @@ Query params: pass OData options on `getProjectTasks` / `getAllProjectTasks` (fo
 ### FileAreasApi
 
 | Method                               | HTTP | Path                                                |
-| ------------------------------------ | ---- | --------------------------------------------------- |
+| ------------------------------------- | ---- | ----------------------------------------------------- |
 | `getFileAreas(projectId, params?)`   | GET  | `/5.1/projects/{projectId}/file_areas`              |
 | `getFileArea(projectId, fileAreaId)` | GET  | `/1.0/projects/{projectId}/file_areas/{fileAreaId}` |
 
@@ -253,7 +299,7 @@ Query params: pass OData options on `getProjectTasks` / `getAllProjectTasks` (fo
 Browse and paginated helpers use **route version 6.1** for the file collection. `getFile` (one file by id) uses **5.0**, as in the [Dalux Build API](https://app.swaggerhub.com/apis-docs/Dalux/DaluxBuild-api/4.14).
 
 | Method                                                                    | HTTP            | Path                                                                                                            |
-| ------------------------------------------------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------- |
+| --------------------------------------------------------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------ |
 | `listFiles(projectId, fileAreaId, params?)`                               | GET             | `/6.1/projects/{projectId}/file_areas/{fileAreaId}/files`                                                       |
 | `getAllFiles(projectId, fileAreaId, params?, verbose?)`                   | GET (paginated) | Same — all file `items` via bookmark / `metadata.totalRemainingItems`                                           |
 | `getAllFilesInFolder(projectId, fileAreaId, folderId, params?, verbose?)` | —               | Uses `getAllFiles` then filters by `data.folderId`                                                              |
@@ -267,7 +313,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### FoldersApi
 
 | Method                                                      | HTTP | Path                                                                   |
-| ----------------------------------------------------------- | ---- | ---------------------------------------------------------------------- |
+| ------------------------------------------------------------- | ---- | -------------------------------------------------------------------------- |
 | `listFolders(projectId, fileAreaId, params?)`               | GET  | `/5.1/projects/{projectId}/file_areas/{fileAreaId}/folders`            |
 | `getFolder(projectId, fileAreaId, folderId)`                | GET  | `/5.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}` |
 | `getFolderFilesProperties(projectId, fileAreaId, folderId)` | GET  | `/1.0/.../folders/{folderId}/files/properties/1.0/mappings`            |
@@ -275,7 +321,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### FileUploadApi
 
 | Method                                                     | HTTP | Path                                                       |
-| ---------------------------------------------------------- | ---- | ---------------------------------------------------------- |
+| ------------------------------------------------------------ | ---- | -------------------------------------------------------------- |
 | `createUpload(projectId, fileAreaId, body)`                | POST | `/1.0/projects/{projectId}/file_areas/{fileAreaId}/upload` |
 | `uploadFilePart(projectId, fileAreaId, uploadGuid, chunk)` | POST | `/1.0/.../upload/{uploadGuid}`                             |
 | `finishUpload(projectId, fileAreaId, uploadGuid, body)`    | POST | `/2.0/.../upload/{uploadGuid}/finalize`                    |
@@ -283,13 +329,13 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### FileRevisionsApi
 
 | Method                                                                  | HTTP | Path                                                         |
-| ----------------------------------------------------------------------- | ---- | ------------------------------------------------------------ |
+| --------------------------------------------------------------------------- | ---- | ------------------------------------------------------------ |
 | `getFileRevisionContent(projectId, fileAreaId, fileId, fileRevisionId)` | GET  | `/2.0/.../files/{fileId}/revisions/{fileRevisionId}/content` |
 
 ### FormsApi
 
 | Method                                          | HTTP | Path                                          |
-| ----------------------------------------------- | ---- | --------------------------------------------- |
+| -------------------------------------------------- | ---- | ------------------------------------------------ |
 | `getProjectForms(projectId, params?)`           | GET  | `/2.1/projects/{projectId}/forms`             |
 | `getForm(projectId, formId)`                    | GET  | `/1.2/projects/{projectId}/forms/{formId}`    |
 | `getProjectFormAttachments(projectId, params?)` | GET  | `/2.1/projects/{projectId}/forms/attachments` |
@@ -297,7 +343,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### UsersApi
 
 | Method                                 | HTTP | Path                                       |
-| -------------------------------------- | ---- | ------------------------------------------ |
+| ----------------------------------------- | ---- | ---------------------------------------------- |
 | `getUser(userId)`                      | GET  | `/1.1/users/{userId}`                      |
 | `listProjectUsers(projectId, params?)` | GET  | `/1.2/projects/{projectId}/users`          |
 | `getProjectUser(projectId, userId)`    | GET  | `/1.1/projects/{projectId}/users/{userId}` |
@@ -305,13 +351,13 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### ProjectTemplatesApi
 
 | Method                          | HTTP | Path                    |
-| ------------------------------- | ---- | ----------------------- |
+| ---------------------------------- | ---- | --------------------------- |
 | `listProjectTemplates(params?)` | GET  | `/1.1/projectTemplates` |
 
 ### InspectionPlansApi
 
 | Method                                                | HTTP | Path                                                    |
-| ----------------------------------------------------- | ---- | ------------------------------------------------------- |
+| -------------------------------------------------------- | ---- | ------------------------------------------------------------ |
 | `listInspectionPlans(projectId, params?)`             | GET  | `/1.2/projects/{projectId}/inspectionPlans`             |
 | `listInspectionPlanItems(projectId, params?)`         | GET  | `/1.1/projects/{projectId}/inspectionPlanItems`         |
 | `listInspectionPlanItemZones(projectId, params?)`     | GET  | `/1.1/projects/{projectId}/inspectionPlanItemZones`     |
@@ -320,7 +366,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### TestPlansApi
 
 | Method                                          | HTTP | Path                                              |
-| ----------------------------------------------- | ---- | ------------------------------------------------- |
+| ---------------------------------------------------- | ---- | -------------------------------------------------- |
 | `listTestPlans(projectId, params?)`             | GET  | `/1.2/projects/{projectId}/testPlans`             |
 | `listTestPlanItems(projectId, params?)`         | GET  | `/1.1/projects/{projectId}/testPlanItems`         |
 | `listTestPlanItemZones(projectId, params?)`     | GET  | `/1.1/projects/{projectId}/testPlanItemZones`     |
@@ -329,7 +375,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### VersionSetsApi
 
 | Method                                                    | HTTP | Path                                                             |
-| --------------------------------------------------------- | ---- | ---------------------------------------------------------------- |
+| ------------------------------------------------------------- | ---- | ---------------------------------------------------------------- |
 | `getVersionSets(projectId, params?)`                      | GET  | `/2.1/projects/{projectId}/version_sets`                         |
 | `getVersionSet(projectId, versionSetId)`                  | GET  | `/2.0/projects/{projectId}/version_sets/{versionSetId}`          |
 | `listFileAreaVersionSets(projectId, fileAreaId, params?)` | GET  | `/2.1/projects/{projectId}/file_areas/{fileAreaId}/version_sets` |
@@ -338,7 +384,7 @@ Browse and paginated helpers use **route version 6.1** for the file collection.
 ### WorkPackagesApi
 
 | Method                                 | HTTP | Path                                     |
-| -------------------------------------- | ---- | ---------------------------------------- |
+| ----------------------------------------- | ---- | --------------------------------------------- |
 | `listWorkPackages(projectId, params?)` | GET  | `/1.0/projects/{projectId}/workpackages` |
 
 ## Advanced Usage
@@ -365,39 +411,24 @@ const projects = new ProjectsApi(apiClient);
 const tasks = new TasksApi(apiClient);
 ```
 
-## Development
+## Testing
 
 ```bash
-# Install dependencies
-npm install
-
-# Run tests with coverage
-npm test
+npm install                       # from the repo root (this is an npm workspace)
+npm test --workspace=javascript   # Jest, with coverage
 ```
 
-## Maintainer: npm releases
-
-### Automatic (push to `main`)
-
-1. Merge to `main` (or push directly). **CI** must pass.
-2. After **both** the Node and Python test jobs succeed, **CI** calls **Publish npm Package** via `workflow_call` (same run as CI, so it does not depend on `workflow_run`).
-3. The publish job only runs when that push changes `package.json`, `package-lock.json`, `src/`, or `test/`.
-4. **Version bump** uses the same rules as the Python publisher ([commit message tokens](python/README.md#maintainer-pypi-releases)), but the **current** semver is **`max(python/pyproject.toml, package.json)`** so npm catches up when the Python package is ahead.
-5. It runs tests again, publishes to npm, then pushes `chore: release vX.Y.Z [skip npm]`, tag `vX.Y.Z`, and a **GitHub Release** (unless the tag already exists). **`[skip npm]`** skips a second publish pass and skips **CI** on that sync commit.
-
-### Manual
-
-- **Actions → Publish npm Package → Run workflow** for **patch / minor / major** (same test → publish → sync commit → tag → **GitHub Release**). The entry workflow is [npm-publish.yml](.github/workflows/npm-publish.yml); it delegates to [npm-publish-reusable.yml](.github/workflows/npm-publish-reusable.yml) (GitHub requires `workflow_call` in its own file).
-- **GitHub Release (published)** publishes the version already in `package.json` at that tag (no version bump in the workflow).
-
-Create a GitHub **environment** named `npm` with secret **`NPM_TOKEN`**. If pushes or releases from `GITHUB_TOKEN` are blocked, set **`RELEASE_PAT`** as described in [python/README.md](python/README.md#maintainer-pypi-releases).
-
-### First publish and `E404` on `npm publish`
+CI runs this on Node.js 20/22/24 — see
+[`../.github/workflows/tests.yml`](../.github/workflows/tests.yml).
 
-If CI fails with **`404 Not Found - PUT …/dalux-build-api`** and **`is not in this registry`**, the package does not exist on npm yet **or** your token is not allowed to **create** it.
+## Releasing
 
-- **Classic [Automation](https://docs.npmjs.com/about-access-tokens#automation-tokens)** tokens only publish packages your account **already** maintains. They cannot create a **new** package name. Fix: use a **granular access token** with write access to the `@bruadam` scope (or all packages), or run **`npm publish --access public`** once locally while logged in as the owner, then switch CI back to an automation token.
-- Confirm the package is not taken by someone else: [https://www.npmjs.com/package/dalux-build-api](https://www.npmjs.com/package/dalux-build-api).
+This package is versioned and published together with the Python client by
+[Changesets](https://github.com/changesets/changesets) — there is no manual
+edit of `version` in `package.json`, and nothing publishes to npm unless the
+full test suite (Node.js, Python, webhook server) passes first. See
+[../CONTRIBUTING.md](../CONTRIBUTING.md#how-releases-work) for the full flow
+and [../README.md](../README.md#releasing) for the PyPI side of it.
 
 ## License
 

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "dalux-build-api",
-  "version": "2.0.0",
+  "version": "2.0.2",
   "description": "Node.js client for the Dalux Build API",
   "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./browser": "./src/browser.js",
+    "./next": "./src/next.js"
+  },
   "files": [
     "src",
     "README.md"
@@ -24,12 +29,13 @@
   "license": "MIT",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/bruadam/dalux-build.git"
+    "url": "git+https://github.com/bruadam/dalux-build.git",
+    "directory": "javascript"
   },
   "bugs": {
     "url": "https://github.com/bruadam/dalux-build/issues"
   },
-  "homepage": "https://github.com/bruadam/dalux-build#readme",
+  "homepage": "https://github.com/bruadam/dalux-build/tree/main/javascript#readme",
   "publishConfig": {
     "access": "public"
   },

package/src/api/FileRevisionsApi.js

@@ -20,11 +20,13 @@ class FileRevisionsApi {
    * @param {string} fileRevisionId
    * @returns {Promise<Buffer>} Raw binary content
    */
-  getFileRevisionContent(projectId, fileAreaId, fileId, fileRevisionId) {
-    return this._client.get(
+  async getFileRevisionContent(projectId, fileAreaId, fileId, fileRevisionId) {
+    const data = await this._client.get(
       `/2.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/revisions/${fileRevisionId}/content`,
       {},
+      { responseType: 'arraybuffer' },
     );
+    return Buffer.from(data);
   }
 }
 

package/src/api/FilesApi.js

@@ -26,7 +26,7 @@ class FilesApi {
    * GET /6.1/projects/{projectId}/file_areas/{fileAreaId}/files
    * @param {string} projectId
    * @param {string} fileAreaId
-   * @param {object} [params] - Optional params (e.g. folderId, updatedAfter, includeProperties). The files endpoint does not support OData $filter.
+   * @param {object} [params] - Optional documented params such as includeProperties. The files endpoint does not support OData $filter.
    * @returns {Promise<object>}
    */
   async listFiles(projectId, fileAreaId, params = {}) {
@@ -161,6 +161,26 @@ class FilesApi {
     return path.resolve(filePath);
   }
 
+  /**
+   * Fetch a file's raw bytes from a direct download URL using X-API-KEY, without
+   * writing to disk. Useful when the caller needs to relay the content onward
+   * (e.g. as an HTTP response body) rather than save it to a local filesystem.
+   * @param {string} downloadLink
+   * @returns {Promise<{ buffer: Buffer, contentType: string|undefined }>}
+   */
+  async downloadFileBuffer(downloadLink) {
+    const apiKey = this._client.configuration.apiKey;
+    const response = await axios.get(downloadLink, {
+      headers: { 'X-API-KEY': apiKey },
+      responseType: 'arraybuffer',
+      validateStatus: () => true,
+    });
+    if (response.status !== 200) {
+      throw new Error(`Failed to download file. Status code: ${response.status}`);
+    }
+    return { buffer: Buffer.from(response.data), contentType: response.headers['content-type'] };
+  }
+
   /**
    * Get a file by IDs or by full path.
    *

package/src/api/InspectionPlansApi.js

@@ -1,7 +1,17 @@
 'use strict';
 
-const { convertToModel } = require('../models/convert');
-const { InspectionPlansListResponseSchema } = require('../models/inspectionPlans');
+const { convertToModel, convertToModelList } = require('../models/convert');
+const { paginate } = require('../utils/pagination');
+const {
+  InspectionPlanSchema,
+  InspectionPlanItemSchema,
+  InspectionPlanItemZoneSchema,
+  InspectionPlanRegistrationSchema,
+  InspectionPlansListResponseSchema,
+  InspectionPlanItemsListResponseSchema,
+  InspectionPlanItemZonesListResponseSchema,
+  InspectionPlanRegistrationsListResponseSchema,
+} = require('../models/inspectionPlans');
 
 /**
  * API methods for inspection plans.
@@ -19,11 +29,27 @@ class InspectionPlansApi {
    * GET /1.2/projects/{projectId}/inspectionPlans
    * @param {string} projectId
    * @param {object} [params]
-   * @returns {Promise<object>} InspectionPlansListResponse ({ items, metadata?, links? })
+   * @param {boolean} [fullResponse=false]
+   * @returns {Promise<object[]|object>}
    */
-  async listInspectionPlans(projectId, params = {}) {
+  async listInspectionPlans(projectId, params = {}, fullResponse = false) {
     const response = await this._client.get(`/1.2/projects/${projectId}/inspectionPlans`, params);
-    return convertToModel(response, InspectionPlansListResponseSchema, 'InspectionPlansListResponse');
+    const result = convertToModel(
+      response,
+      InspectionPlansListResponseSchema,
+      'InspectionPlansListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllInspectionPlans(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.2/projects/${projectId}/inspectionPlans`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, InspectionPlanSchema, 'InspectionPlan');
   }
 
   /**
@@ -33,8 +59,24 @@ class InspectionPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listInspectionPlanItems(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
+  async listInspectionPlanItems(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
+    const result = convertToModel(
+      response,
+      InspectionPlanItemsListResponseSchema,
+      'InspectionPlanItemsListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllInspectionPlanItems(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.1/projects/${projectId}/inspectionPlanItems`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, InspectionPlanItemSchema, 'InspectionPlanItem');
   }
 
   /**
@@ -44,8 +86,24 @@ class InspectionPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listInspectionPlanItemZones(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
+  async listInspectionPlanItemZones(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
+    const result = convertToModel(
+      response,
+      InspectionPlanItemZonesListResponseSchema,
+      'InspectionPlanItemZonesListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllInspectionPlanItemZones(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.1/projects/${projectId}/inspectionPlanItemZones`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, InspectionPlanItemZoneSchema, 'InspectionPlanItemZone');
   }
 
   /**
@@ -55,11 +113,27 @@ class InspectionPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listInspectionPlanRegistrations(projectId, params = {}) {
-    return this._client.get(
+  async listInspectionPlanRegistrations(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(
+      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
+      params,
+    );
+    const result = convertToModel(
+      response,
+      InspectionPlanRegistrationsListResponseSchema,
+      'InspectionPlanRegistrationsListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllInspectionPlanRegistrations(projectId, params = {}, verbose = false) {
+    const items = await paginate(
       `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
+      this._client,
       params,
+      verbose,
     );
+    return convertToModelList(items, InspectionPlanRegistrationSchema, 'InspectionPlanRegistration');
   }
 }
 

package/src/api/TestPlansApi.js

@@ -1,7 +1,17 @@
 'use strict';
 
-const { convertToModel } = require('../models/convert');
-const { TestPlansListResponseSchema } = require('../models/testPlans');
+const { convertToModel, convertToModelList } = require('../models/convert');
+const { paginate } = require('../utils/pagination');
+const {
+  TestPlanSchema,
+  TestPlanItemSchema,
+  TestPlanItemZoneSchema,
+  TestPlanRegistrationSchema,
+  TestPlansListResponseSchema,
+  TestPlanItemsListResponseSchema,
+  TestPlanItemZonesListResponseSchema,
+  TestPlanRegistrationsListResponseSchema,
+} = require('../models/testPlans');
 
 /**
  * API methods for test plans.
@@ -19,11 +29,27 @@ class TestPlansApi {
    * GET /1.2/projects/{projectId}/testPlans
    * @param {string} projectId
    * @param {object} [params]
-   * @returns {Promise<object>} TestPlansListResponse ({ items, metadata?, links? })
+   * @param {boolean} [fullResponse=false]
+   * @returns {Promise<object[]|object>}
    */
-  async listTestPlans(projectId, params = {}) {
+  async listTestPlans(projectId, params = {}, fullResponse = false) {
     const response = await this._client.get(`/1.2/projects/${projectId}/testPlans`, params);
-    return convertToModel(response, TestPlansListResponseSchema, 'TestPlansListResponse');
+    const result = convertToModel(
+      response,
+      TestPlansListResponseSchema,
+      'TestPlansListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllTestPlans(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.2/projects/${projectId}/testPlans`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, TestPlanSchema, 'TestPlan');
   }
 
   /**
@@ -33,8 +59,24 @@ class TestPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listTestPlanItems(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanItems`, params);
+  async listTestPlanItems(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/testPlanItems`, params);
+    const result = convertToModel(
+      response,
+      TestPlanItemsListResponseSchema,
+      'TestPlanItemsListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllTestPlanItems(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.1/projects/${projectId}/testPlanItems`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, TestPlanItemSchema, 'TestPlanItem');
   }
 
   /**
@@ -44,8 +86,24 @@ class TestPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listTestPlanItemZones(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanItemZones`, params);
+  async listTestPlanItemZones(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/testPlanItemZones`, params);
+    const result = convertToModel(
+      response,
+      TestPlanItemZonesListResponseSchema,
+      'TestPlanItemZonesListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllTestPlanItemZones(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.1/projects/${projectId}/testPlanItemZones`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, TestPlanItemZoneSchema, 'TestPlanItemZone');
   }
 
   /**
@@ -55,8 +113,24 @@ class TestPlansApi {
    * @param {object} [params]
    * @returns {Promise<object>}
    */
-  listTestPlanRegistrations(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanRegistrations`, params);
+  async listTestPlanRegistrations(projectId, params = {}, fullResponse = false) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/testPlanRegistrations`, params);
+    const result = convertToModel(
+      response,
+      TestPlanRegistrationsListResponseSchema,
+      'TestPlanRegistrationsListResponse',
+    );
+    return fullResponse ? result : (result?.items || []);
+  }
+
+  async getAllTestPlanRegistrations(projectId, params = {}, verbose = false) {
+    const items = await paginate(
+      `/1.1/projects/${projectId}/testPlanRegistrations`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(items, TestPlanRegistrationSchema, 'TestPlanRegistration');
   }
 }
 

package/src/apiClient.js

@@ -44,6 +44,9 @@ class ApiClient {
   _getErrorDetail(response) {
     try {
       const data = response.data;
+      if (Buffer.isBuffer(data) || data instanceof ArrayBuffer) {
+        return Buffer.from(data).toString('utf8').slice(0, 200);
+      }
       if (data && typeof data === 'object') {
         if (data.message) return data.message;
         if (data.error) return data.error;
@@ -76,11 +79,12 @@ class ApiClient {
    * Perform a GET request.
    * @param {string} path  - URL path (e.g. '/5.1/projects')
    * @param {object} [params] - Query string parameters
+   * @param {object} [config] - Extra axios config (e.g. { responseType: 'arraybuffer' } for binary content)
    * @returns {Promise<any>} Parsed response body
    */
-  async get(path, params = {}) {
+  async get(path, params = {}, config = {}) {
     try {
-      const response = await this._axios.get(path, { params });
+      const response = await this._axios.get(path, { params, ...config });
       return response.data;
     } catch (err) {
       this._handleAxiosError(err, path);

package/src/browser.js

@@ -0,0 +1,84 @@
+'use strict';
+
+const RESOURCES = [
+  'projects',
+  'companies',
+  'companyCatalog',
+  'fileAreas',
+  'fileRevisions',
+  'fileUpload',
+  'files',
+  'folders',
+  'forms',
+  'inspectionPlans',
+  'projectTemplates',
+  'tasks',
+  'testPlans',
+  'users',
+  'versionSets',
+  'workPackages',
+];
+
+class DaluxProxyError extends Error {
+  constructor(message, { name = 'DaluxProxyError', status, details } = {}) {
+    super(message);
+    this.name = name;
+    this.status = status;
+    this.details = details;
+  }
+}
+
+/**
+ * Create a browser-safe Dalux client backed by a same-origin server route.
+ * The Dalux API key remains on the server; this client never accepts one.
+ *
+ * @param {object} [options]
+ * @param {string} [options.url='/api/dalux']
+ * @param {typeof fetch} [options.fetch]
+ * @param {Record<string, string>} [options.headers]
+ */
+function createBrowserClient({ url = '/api/dalux', fetch: fetchImpl, headers = {} } = {}) {
+  const request = fetchImpl || globalThis.fetch;
+  if (typeof request !== 'function') {
+    throw new Error('A fetch implementation is required');
+  }
+
+  const invoke = async (resource, method, args) => {
+    const response = await request(url, {
+      method: 'POST',
+      headers: { 'Content-Type': 'application/json', ...headers },
+      body: JSON.stringify({ resource, method, args }),
+    });
+
+    let payload;
+    try {
+      payload = await response.json();
+    } catch {
+      throw new DaluxProxyError(`Dalux proxy returned HTTP ${response.status} without JSON`, {
+        status: response.status,
+      });
+    }
+
+    if (!response.ok || !payload.ok) {
+      const error = payload.error || {};
+      throw new DaluxProxyError(error.message || `Dalux proxy returned HTTP ${response.status}`, {
+        name: error.name,
+        status: response.status,
+        details: error.details,
+      });
+    }
+    return payload.data;
+  };
+
+  return Object.fromEntries(RESOURCES.map((resource) => [
+    resource,
+    new Proxy({}, {
+      get(_target, method) {
+        if (typeof method !== 'string' || method === 'then') return undefined;
+        return (...args) => invoke(resource, method, args);
+      },
+    }),
+  ]));
+}
+
+module.exports = { createBrowserClient, DaluxProxyError };

package/src/models/index.js

@@ -43,9 +43,27 @@ const { CompaniesListResponseSchema, CompanyResponseSchema } = require('./compan
 
 const { CompanyCatalogListResponseSchema, CompanyCatalogResponseSchema } = require('./companyCatalog');
 
-const { InspectionPlanSchema, InspectionPlansListResponseSchema } = require('./inspectionPlans');
+const {
+  InspectionPlanSchema,
+  InspectionPlanItemSchema,
+  InspectionPlanItemZoneSchema,
+  InspectionPlanRegistrationSchema,
+  InspectionPlansListResponseSchema,
+  InspectionPlanItemsListResponseSchema,
+  InspectionPlanItemZonesListResponseSchema,
+  InspectionPlanRegistrationsListResponseSchema,
+} = require('./inspectionPlans');
 
-const { TestPlanSchema, TestPlansListResponseSchema } = require('./testPlans');
+const {
+  TestPlanSchema,
+  TestPlanItemSchema,
+  TestPlanItemZoneSchema,
+  TestPlanRegistrationSchema,
+  TestPlansListResponseSchema,
+  TestPlanItemsListResponseSchema,
+  TestPlanItemZonesListResponseSchema,
+  TestPlanRegistrationsListResponseSchema,
+} = require('./testPlans');
 
 const { FormSchema, FormsListResponseSchema, FormResponseSchema } = require('./forms');
 
@@ -116,10 +134,22 @@ module.exports = {
   CompanyCatalogResponseSchema,
   // Inspection Plans
   InspectionPlanSchema,
+  InspectionPlanItemSchema,
+  InspectionPlanItemZoneSchema,
+  InspectionPlanRegistrationSchema,
   InspectionPlansListResponseSchema,
+  InspectionPlanItemsListResponseSchema,
+  InspectionPlanItemZonesListResponseSchema,
+  InspectionPlanRegistrationsListResponseSchema,
   // Test Plans
   TestPlanSchema,
+  TestPlanItemSchema,
+  TestPlanItemZoneSchema,
+  TestPlanRegistrationSchema,
   TestPlansListResponseSchema,
+  TestPlanItemsListResponseSchema,
+  TestPlanItemZonesListResponseSchema,
+  TestPlanRegistrationsListResponseSchema,
   // Forms
   FormSchema,
   FormsListResponseSchema,

package/src/models/inspectionPlans/index.js

@@ -3,16 +3,59 @@
 const { z } = require('zod');
 const { listResponseSchema } = require('../helpers');
 
-/**
- * Mirrors models/inspection_plans/models.py::InspectionPlan — an empty
- * placeholder in Python, so list items stay untyped (unwrapped but
- * otherwise unvalidated).
- */
-const InspectionPlanSchema = z.any();
+const optionalString = z.string().nullish();
+const optionalInteger = z.number().int().nullish();
+
+const InspectionPlanSchema = z.object({
+  inspectionPlanId: optionalString,
+  name: optionalString,
+  workpackageId: optionalString,
+}).passthrough();
+
+const InspectionPlanItemSchema = z.object({
+  inspectionPlanItemId: optionalString,
+  inspectionPlanId: optionalString,
+  number: optionalString,
+  subject: optionalString,
+  heading: optionalString,
+  subHeading: optionalString,
+  extentType: optionalString,
+  planned: optionalInteger,
+  ongoing: optionalInteger,
+  completed: optionalInteger,
+  nonPlannedOngoing: optionalInteger,
+  nonPlannedCompleted: optionalInteger,
+}).passthrough();
+
+const InspectionPlanItemZoneSchema = z.object({
+  inspectionPlanItemId: optionalString,
+  inspectionPlanItemZoneId: optionalString,
+  name: optionalString,
+  planned: optionalInteger,
+  ongoing: optionalInteger,
+  completed: optionalInteger,
+}).passthrough();
+
+const InspectionPlanRegistrationSchema = z.object({
+  status: optionalString,
+  formId: optionalString,
+  taskId: optionalString,
+  inspectionPlanItemId: optionalString,
+  inspectionPlanItemZoneId: optionalString,
+}).passthrough();
 
 const InspectionPlansListResponseSchema = listResponseSchema(InspectionPlanSchema);
+const InspectionPlanItemsListResponseSchema = listResponseSchema(InspectionPlanItemSchema);
+const InspectionPlanItemZonesListResponseSchema = listResponseSchema(InspectionPlanItemZoneSchema);
+const InspectionPlanRegistrationsListResponseSchema = listResponseSchema(InspectionPlanRegistrationSchema);
 
 module.exports = {
   InspectionPlanSchema,
+  InspectionPlanItemSchema,
+  InspectionPlanItemZoneSchema,
+  InspectionPlanRegistrationSchema,
   InspectionPlansListResponseSchema,
+  InspectionPlanItemsListResponseSchema,
+  InspectionPlanItemZonesListResponseSchema,
+  InspectionPlanRegistrationsListResponseSchema,
 };

package/src/models/testPlans/index.js

@@ -3,15 +3,59 @@
 const { z } = require('zod');
 const { listResponseSchema } = require('../helpers');
 
-/**
- * Mirrors models/test_plans/models.py::TestPlan — empty placeholder in
- * Python, so list items stay untyped.
- */
-const TestPlanSchema = z.any();
+const optionalString = z.string().nullish();
+const optionalInteger = z.number().int().nullish();
+
+const TestPlanSchema = z.object({
+  testPlanId: optionalString,
+  name: optionalString,
+  workpackageId: optionalString,
+}).passthrough();
+
+const TestPlanItemSchema = z.object({
+  testPlanItemId: optionalString,
+  testPlanId: optionalString,
+  number: optionalString,
+  subject: optionalString,
+  heading: optionalString,
+  subHeading: optionalString,
+  extentType: optionalString,
+  planned: optionalInteger,
+  ongoing: optionalInteger,
+  completed: optionalInteger,
+  nonPlannedOngoing: optionalInteger,
+  nonPlannedCompleted: optionalInteger,
+}).passthrough();
+
+const TestPlanItemZoneSchema = z.object({
+  testPlanItemId: optionalString,
+  testPlanItemZoneId: optionalString,
+  name: optionalString,
+  planned: optionalInteger,
+  ongoing: optionalInteger,
+  completed: optionalInteger,
+}).passthrough();
+
+const TestPlanRegistrationSchema = z.object({
+  status: optionalString,
+  formId: optionalString,
+  taskId: optionalString,
+  testPlanItemId: optionalString,
+  testPlanItemZoneId: optionalString,
+}).passthrough();
 
 const TestPlansListResponseSchema = listResponseSchema(TestPlanSchema);
+const TestPlanItemsListResponseSchema = listResponseSchema(TestPlanItemSchema);
+const TestPlanItemZonesListResponseSchema = listResponseSchema(TestPlanItemZoneSchema);
+const TestPlanRegistrationsListResponseSchema = listResponseSchema(TestPlanRegistrationSchema);
 
 module.exports = {
   TestPlanSchema,
+  TestPlanItemSchema,
+  TestPlanItemZoneSchema,
+  TestPlanRegistrationSchema,
   TestPlansListResponseSchema,
+  TestPlanItemsListResponseSchema,
+  TestPlanItemZonesListResponseSchema,
+  TestPlanRegistrationsListResponseSchema,
 };

package/src/next.js

@@ -0,0 +1,89 @@
+'use strict';
+
+function normalizeAllowedMethods(allowedMethods) {
+  const normalized = new Set();
+  if (Array.isArray(allowedMethods)) {
+    for (const method of allowedMethods) normalized.add(method);
+  } else if (allowedMethods && typeof allowedMethods === 'object') {
+    for (const [resource, methods] of Object.entries(allowedMethods)) {
+      for (const method of methods) normalized.add(`${resource}.${method}`);
+    }
+  }
+  if (normalized.size === 0) {
+    throw new Error('allowedMethods must explicitly expose at least one Dalux client method');
+  }
+  return normalized;
+}
+
+function json(body, status = 200) {
+  return Response.json(body, { status });
+}
+
+function errorStatus(error) {
+  if (error?.name === 'AuthenticationError') return 401;
+  if (error?.name === 'NotFoundError') return 404;
+  if (error?.name === 'RateLimitError') return 429;
+  if (error?.name === 'ValidationError') return 422;
+  return 502;
+}
+
+/**
+ * Create a Next.js App Router POST handler for a browser Dalux client.
+ *
+ * @param {object} options
+ * @param {object} options.client A server-side client from createClient().
+ * @param {string[]|Record<string, string[]>} options.allowedMethods Explicit RPC allow-list.
+ * @param {(request: Request) => boolean|Response|Promise<boolean|Response>} [options.authorize]
+ * @returns {(request: Request) => Promise<Response>}
+ */
+function createDaluxRouteHandler({ client, allowedMethods, authorize } = {}) {
+  if (!client || typeof client !== 'object') {
+    throw new Error('A server-side Dalux client is required');
+  }
+  const allowed = normalizeAllowedMethods(allowedMethods);
+
+  return async function POST(request) {
+    if (authorize) {
+      const authorization = await authorize(request);
+      if (authorization instanceof Response) return authorization;
+      if (!authorization) return json({ ok: false, error: { name: 'AuthenticationError', message: 'Unauthorized' } }, 401);
+    }
+
+    let payload;
+    try {
+      payload = await request.json();
+    } catch {
+      return json({ ok: false, error: { name: 'ValidationError', message: 'Request body must be JSON' } }, 400);
+    }
+
+    const { resource, method, args = [] } = payload || {};
+    const qualifiedMethod = `${resource}.${method}`;
+    if (!allowed.has(qualifiedMethod)) {
+      return json({ ok: false, error: { name: 'NotFoundError', message: `Method ${qualifiedMethod} is not exposed` } }, 404);
+    }
+    if (!Array.isArray(args)) {
+      return json({ ok: false, error: { name: 'ValidationError', message: 'args must be an array' } }, 400);
+    }
+
+    const target = client[resource];
+    const operation = target?.[method];
+    if (typeof operation !== 'function') {
+      return json({ ok: false, error: { name: 'NotFoundError', message: `Unknown method ${qualifiedMethod}` } }, 404);
+    }
+
+    try {
+      const data = await operation.apply(target, args);
+      return json({ ok: true, data: data === undefined ? null : data });
+    } catch (error) {
+      return json({
+        ok: false,
+        error: {
+          name: error?.name || 'ApiError',
+          message: error?.message || String(error),
+        },
+      }, errorStatus(error));
+    }
+  };
+}
+
+module.exports = { createDaluxRouteHandler };

package/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2026 Bruno Adam
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.