dalux-build-api 1.0.0 → 1.0.4

package/src/api/ProjectsApi.js

@@ -1,106 +1,106 @@
-'use strict';
-
-/**
- * API methods for project management.
- */
-class ProjectsApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Get all available projects.
-   * GET /5.1/projects
-   * @param {object} [params] - Optional query parameters (e.g. updatedAfter)
-   * @returns {Promise<object>}
-   */
-  listProjects(params = {}) {
-    return this._client.get('/5.1/projects', params);
-  }
-
-  /**
-   * Get a specific project.
-   * GET /5.0/projects/{projectId}
-   * @param {string} projectId
-   * @returns {Promise<object>}
-   */
-  getProject(projectId) {
-    return this._client.get(`/5.0/projects/${projectId}`);
-  }
-
-  /**
-   * Create a new project.
-   * POST /5.0/projects
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  createProject(body) {
-    return this._client.post('/5.0/projects', body);
-  }
-
-  /**
-   * Update a project.
-   * PATCH /5.0/projects/{projectId}
-   * @param {string} projectId
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  updateProject(projectId, body) {
-    return this._client.patch(`/5.0/projects/${projectId}`, body);
-  }
-
-  /**
-   * Get all metadata available for POST project operations.
-   * GET /1.0/projects/metadata/1.0/mappings
-   * @returns {Promise<object>}
-   */
-  listMetadataMappingsForProjects() {
-    return this._client.get('/1.0/projects/metadata/1.0/mappings');
-  }
-
-  /**
-   * Get available values for a metadata key in POST project operations.
-   * GET /1.0/projects/metadata/1.0/mappings/{key}/values
-   * @param {string} key
-   * @returns {Promise<object>}
-   */
-  listMetadataValuesForProjects(key) {
-    return this._client.get(`/1.0/projects/metadata/1.0/mappings/${key}/values`);
-  }
-
-  /**
-   * Get metadata of a specific project.
-   * GET /1.0/projects/{projectId}/metadata
-   * @param {string} projectId
-   * @returns {Promise<object>}
-   */
-  listProjectMetadata(projectId) {
-    return this._client.get(`/1.0/projects/${projectId}/metadata`);
-  }
-
-  /**
-   * Get all metadata available for PATCH project operations.
-   * GET /1.0/projects/{projectId}/metadata/1.0/mappings
-   * @param {string} projectId
-   * @returns {Promise<object>}
-   */
-  listProjectMetadataMappings(projectId) {
-    return this._client.get(`/1.0/projects/${projectId}/metadata/1.0/mappings`);
-  }
-
-  /**
-   * Get available values for metadata in a PATCH project operation.
-   * GET /1.0/projects/{projectId}/metadata/1.0/mappings/{key}/values
-   * @param {string} projectId
-   * @param {string} key
-   * @returns {Promise<object>}
-   */
-  listProjectMetadataValues(projectId, key) {
-    return this._client.get(`/1.0/projects/${projectId}/metadata/1.0/mappings/${key}/values`);
-  }
-}
-
-module.exports = ProjectsApi;
+'use strict';
+
+/**
+ * API methods for project management.
+ */
+class ProjectsApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get all available projects.
+   * GET /5.1/projects
+   * @param {object} [params] - Optional query parameters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  listProjects(params = {}) {
+    return this._client.get('/5.1/projects', params);
+  }
+
+  /**
+   * Get a specific project.
+   * GET /5.0/projects/{projectId}
+   * @param {string} projectId
+   * @returns {Promise<object>}
+   */
+  getProject(projectId) {
+    return this._client.get(`/5.0/projects/${projectId}`);
+  }
+
+  /**
+   * Create a new project.
+   * POST /5.0/projects
+   * @param {object} body
+   * @returns {Promise<object>}
+   */
+  createProject(body) {
+    return this._client.post('/5.0/projects', body);
+  }
+
+  /**
+   * Update a project.
+   * PATCH /5.0/projects/{projectId}
+   * @param {string} projectId
+   * @param {object} body
+   * @returns {Promise<object>}
+   */
+  updateProject(projectId, body) {
+    return this._client.patch(`/5.0/projects/${projectId}`, body);
+  }
+
+  /**
+   * Get all metadata available for POST project operations.
+   * GET /1.0/projects/metadata/1.0/mappings
+   * @returns {Promise<object>}
+   */
+  listMetadataMappingsForProjects() {
+    return this._client.get('/1.0/projects/metadata/1.0/mappings');
+  }
+
+  /**
+   * Get available values for a metadata key in POST project operations.
+   * GET /1.0/projects/metadata/1.0/mappings/{key}/values
+   * @param {string} key
+   * @returns {Promise<object>}
+   */
+  listMetadataValuesForProjects(key) {
+    return this._client.get(`/1.0/projects/metadata/1.0/mappings/${key}/values`);
+  }
+
+  /**
+   * Get metadata of a specific project.
+   * GET /1.0/projects/{projectId}/metadata
+   * @param {string} projectId
+   * @returns {Promise<object>}
+   */
+  listProjectMetadata(projectId) {
+    return this._client.get(`/1.0/projects/${projectId}/metadata`);
+  }
+
+  /**
+   * Get all metadata available for PATCH project operations.
+   * GET /1.0/projects/{projectId}/metadata/1.0/mappings
+   * @param {string} projectId
+   * @returns {Promise<object>}
+   */
+  listProjectMetadataMappings(projectId) {
+    return this._client.get(`/1.0/projects/${projectId}/metadata/1.0/mappings`);
+  }
+
+  /**
+   * Get available values for metadata in a PATCH project operation.
+   * GET /1.0/projects/{projectId}/metadata/1.0/mappings/{key}/values
+   * @param {string} projectId
+   * @param {string} key
+   * @returns {Promise<object>}
+   */
+  listProjectMetadataValues(projectId, key) {
+    return this._client.get(`/1.0/projects/${projectId}/metadata/1.0/mappings/${key}/values`);
+  }
+}
+
+module.exports = ProjectsApi;

package/src/api/TasksApi.js

@@ -1,59 +1,87 @@
-'use strict';
-
-/**
- * API methods for tasks, approvals, safety issues, observations and good practices.
- */
-class TasksApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Retrieve tasks, approvals, safety issues, safety observations and good practices on a project.
-   * GET /5.1/projects/{projectId}/tasks
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters (e.g. updatedAfter, status, typeFilter)
-   * @returns {Promise<object>}
-   */
-  getProjectTasks(projectId, params = {}) {
-    return this._client.get(`/5.1/projects/${projectId}/tasks`, params);
-  }
-
-  /**
-   * Retrieve a specific task/approval/safety issue/safety observation/good practice.
-   * GET /3.3/projects/{projectId}/tasks/{taskId}
-   * @param {string} projectId
-   * @param {string} taskId
-   * @returns {Promise<object>}
-   */
-  getTask(projectId, taskId) {
-    return this._client.get(`/3.3/projects/${projectId}/tasks/${taskId}`);
-  }
-
-  /**
-   * Retrieve task changes on a project in incremental updates.
-   * GET /2.2/projects/{projectId}/tasks/changes
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters (e.g. updatedAfter)
-   * @returns {Promise<object>}
-   */
-  getProjectTaskChanges(projectId, params = {}) {
-    return this._client.get(`/2.2/projects/${projectId}/tasks/changes`, params);
-  }
-
-  /**
-   * Retrieve attachments on tasks on a project.
-   * GET /1.1/projects/{projectId}/tasks/attachments
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters (e.g. updatedAfter)
-   * @returns {Promise<object>}
-   */
-  getProjectTaskAttachments(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/tasks/attachments`, params);
-  }
-}
-
-module.exports = TasksApi;
+'use strict';
+
+/**
+ * API methods for tasks, approvals, safety issues, observations and good practices.
+ */
+class TasksApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Retrieve tasks, approvals, safety issues, safety observations and good practices on a project.
+  * GET /5.2/projects/{projectId}/tasks
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter, status, typeFilter)
+   * @returns {Promise<object>}
+   */
+  getProjectTasks(projectId, params = {}) {
+    return this._client.get(`/5.2/projects/${projectId}/tasks`, params);
+  }
+
+  /**
+   * Retrieve all tasks on a project by following bookmark pagination automatically.
+   * Combines all pages into a single array of items.
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter, status, typeFilter)
+   * @returns {Promise<object[]>} All task items across all pages
+   */
+  async getAllProjectTasks(projectId, params = {}) {
+    const allItems = [];
+    let currentParams = { ...params };
+    let hasNextPage = true;
+
+    while (hasNextPage) {
+      const response = await this._client.get(`/5.2/projects/${projectId}/tasks`, currentParams);
+      if (Array.isArray(response.items)) {
+        allItems.push(...response.items);
+      }
+      const nextLink = (response.links || []).find(l => l.rel === 'nextPage');
+      if (nextLink) {
+        const bookmark = new URL(nextLink.href).searchParams.get('bookmark');
+        currentParams = { ...params, bookmark };
+      } else {
+        hasNextPage = false;
+      }
+    }
+    return allItems;
+  }
+
+  /**
+   * Retrieve a specific task/approval/safety issue/safety observation/good practice.
+   * GET /3.3/projects/{projectId}/tasks/{taskId}
+   * @param {string} projectId
+   * @param {string} taskId
+   * @returns {Promise<object>}
+   */
+  getTask(projectId, taskId) {
+    return this._client.get(`/3.3/projects/${projectId}/tasks/${taskId}`);
+  }
+
+  /**
+   * Retrieve task changes on a project in incremental updates.
+   * GET /2.2/projects/{projectId}/tasks/changes
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectTaskChanges(projectId, params = {}) {
+    return this._client.get(`/2.2/projects/${projectId}/tasks/changes`, params);
+  }
+
+  /**
+   * Retrieve attachments on tasks on a project.
+   * GET /1.1/projects/{projectId}/tasks/attachments
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectTaskAttachments(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/tasks/attachments`, params);
+  }
+}
+
+module.exports = TasksApi;

package/src/api/TestPlansApi.js

@@ -1,59 +1,59 @@
-'use strict';
-
-/**
- * API methods for test plans.
- */
-class TestPlansApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Browse all test plans on the given project.
-   * GET /1.2/projects/{projectId}/testPlans
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listTestPlans(projectId, params = {}) {
-    return this._client.get(`/1.2/projects/${projectId}/testPlans`, params);
-  }
-
-  /**
-   * Browse all test plan items on the given project.
-   * GET /1.1/projects/{projectId}/testPlanItems
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listTestPlanItems(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanItems`, params);
-  }
-
-  /**
-   * Browse all test plan item zones on the given project.
-   * GET /1.1/projects/{projectId}/testPlanItemZones
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listTestPlanItemZones(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanItemZones`, params);
-  }
-
-  /**
-   * Browse all test plan registrations on the given project.
-   * GET /1.1/projects/{projectId}/testPlanRegistrations
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listTestPlanRegistrations(projectId, params = {}) {
-    return this._client.get(`/1.1/projects/${projectId}/testPlanRegistrations`, params);
-  }
-}
-
-module.exports = TestPlansApi;
+'use strict';
+
+/**
+ * API methods for test plans.
+ */
+class TestPlansApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all test plans on the given project.
+   * GET /1.2/projects/{projectId}/testPlans
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listTestPlans(projectId, params = {}) {
+    return this._client.get(`/1.2/projects/${projectId}/testPlans`, params);
+  }
+
+  /**
+   * Browse all test plan items on the given project.
+   * GET /1.1/projects/{projectId}/testPlanItems
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listTestPlanItems(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/testPlanItems`, params);
+  }
+
+  /**
+   * Browse all test plan item zones on the given project.
+   * GET /1.1/projects/{projectId}/testPlanItemZones
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listTestPlanItemZones(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/testPlanItemZones`, params);
+  }
+
+  /**
+   * Browse all test plan registrations on the given project.
+   * GET /1.1/projects/{projectId}/testPlanRegistrations
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listTestPlanRegistrations(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/testPlanRegistrations`, params);
+  }
+}
+
+module.exports = TestPlansApi;

package/src/api/UsersApi.js

@@ -1,47 +1,47 @@
-'use strict';
-
-/**
- * API methods for users.
- */
-class UsersApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Get a specific user.
-   * GET /1.1/users/{userId}
-   * @param {string} userId
-   * @returns {Promise<object>}
-   */
-  getUser(userId) {
-    return this._client.get(`/1.1/users/${userId}`);
-  }
-
-  /**
-   * Get users on a project.
-   * GET /1.2/projects/{projectId}/users
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listProjectUsers(projectId, params = {}) {
-    return this._client.get(`/1.2/projects/${projectId}/users`, params);
-  }
-
-  /**
-   * Get a specific user on a project.
-   * GET /1.1/projects/{projectId}/users/{userId}
-   * @param {string} projectId
-   * @param {string} userId
-   * @returns {Promise<object>}
-   */
-  getProjectUser(projectId, userId) {
-    return this._client.get(`/1.1/projects/${projectId}/users/${userId}`);
-  }
-}
-
-module.exports = UsersApi;
+'use strict';
+
+/**
+ * API methods for users.
+ */
+class UsersApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get a specific user.
+   * GET /1.1/users/{userId}
+   * @param {string} userId
+   * @returns {Promise<object>}
+   */
+  getUser(userId) {
+    return this._client.get(`/1.1/users/${userId}`);
+  }
+
+  /**
+   * Get users on a project.
+   * GET /1.2/projects/{projectId}/users
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listProjectUsers(projectId, params = {}) {
+    return this._client.get(`/1.2/projects/${projectId}/users`, params);
+  }
+
+  /**
+   * Get a specific user on a project.
+   * GET /1.1/projects/{projectId}/users/{userId}
+   * @param {string} projectId
+   * @param {string} userId
+   * @returns {Promise<object>}
+   */
+  getProjectUser(projectId, userId) {
+    return this._client.get(`/1.1/projects/${projectId}/users/${userId}`);
+  }
+}
+
+module.exports = UsersApi;