dalux-build-api 1.1.3 → 2.0.0

package/src/api/ProjectsApi.js

@@ -1,106 +1,127 @@
-'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';
+
+const { findByField } = require('../utils/search');
+const { convertToModel } = require('../models/convert');
+const { ProjectsListResponseSchema, ProjectResponseSchema } = require('../models/projects');
+
+/**
+ * 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>} ProjectsListResponse ({ items: Project[], metadata?, links? })
+   */
+  async listProjects(params = {}) {
+    const response = await this._client.get('/5.1/projects', params);
+    return convertToModel(response, ProjectsListResponseSchema, 'ProjectsListResponse');
+  }
+
+  /**
+   * Get a specific project.
+   * GET /5.0/projects/{projectId}
+   * @param {string} projectId
+   * @returns {Promise<object>} ProjectResponse ({ data: Project, links? })
+   */
+  async getProject(projectId) {
+    const response = await this._client.get(`/5.0/projects/${projectId}`);
+    return convertToModel(response, ProjectResponseSchema, 'ProjectResponse');
+  }
+
+  /**
+   * Create a new project.
+   * POST /5.0/projects
+   * @param {object} body
+   * @returns {Promise<object>} ProjectResponse
+   */
+  async createProject(body) {
+    const response = await this._client.post('/5.0/projects', body);
+    return convertToModel(response, ProjectResponseSchema, 'ProjectResponse');
+  }
+
+  /**
+   * Update a project.
+   * PATCH /5.0/projects/{projectId}
+   * @param {string} projectId
+   * @param {object} body
+   * @returns {Promise<object>} ProjectResponse
+   */
+  async updateProject(projectId, body) {
+    const response = await this._client.patch(`/5.0/projects/${projectId}`, body);
+    return convertToModel(response, ProjectResponseSchema, 'ProjectResponse');
+  }
+
+  /**
+   * 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`);
+  }
+
+  /**
+   * Get a project ID by its name.
+   * @param {string} projectName
+   * @returns {Promise<string|null>} The projectId, or null if not found.
+   */
+  async getProjectByName(projectName) {
+    const response = await this.listProjects();
+    const items = (response && response.items) || [];
+    const project = findByField(items, 'projectName', projectName);
+    if (!project) return null;
+    return project.projectId || null;
+  }
+}
+
+module.exports = ProjectsApi;

package/src/api/TasksApi.js

@@ -1,161 +1,193 @@
-'use strict';
-
-/**
- * Build query params for GET /5.2/projects/.../tasks (OData).
- * If params contains typeId and no $filter, expands to
- *   $filter=data/type/typeId eq '<typeId>'
- * Single quotes in typeId are escaped as '' per OData. If $filter is set,
- * typeId is still omitted from the outgoing query (not merged).
- * @param {object} [params]
- * @returns {object}
- */
-function normalizeTaskParams(params = {}) {
-  const normalized = { ...params };
-  const typeId = normalized.typeId;
-  delete normalized.typeId;
-  if (typeId != null && normalized.$filter === undefined) {
-    const escaped = String(typeId).replace(/'/g, "''");
-    normalized.$filter = `data/type/typeId eq '${escaped}'`;
-  }
-  return normalized;
-}
-
-/**
- * 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). Pass typeId as shorthand for
-   *   OData $filter on task type, or pass $filter (and other OData options) directly.
-   * @returns {Promise<object>}
-   */
-  getProjectTasks(projectId, params = {}) {
-    return this._client.get(`/5.2/projects/${projectId}/tasks`, normalizeTaskParams(params));
-  }
-
-  /**
-   * Retrieve all tasks on a project by following bookmark pagination automatically.
-   * Matches Python client behaviour: uses metadata.totalRemainingItems when present;
-   * otherwise uses metadata.totalItems across pages as a ceiling so pagination cannot run forever.
-   * @param {string} projectId
-   * @param {object} [params] - Optional filters / OData (typeId shorthand supported).
-   * @param {boolean} [verbose=false] - Log progress to console.
-   * @returns {Promise<object[]>} All task items across all pages
-   */
-  async getAllProjectTasks(projectId, params = {}, verbose = false) {
-    const allItems = [];
-    const baseParams = normalizeTaskParams(params);
-    let currentParams = { ...baseParams };
-    let hasNextPage = true;
-    /** @type {number|null} */
-    let tasksItemsCeiling = null;
-
-    while (hasNextPage) {
-      const response = await this._client.get(`/5.2/projects/${projectId}/tasks`, currentParams);
-      const items = Array.isArray(response.items) ? response.items : [];
-      if (items.length) {
-        allItems.push(...items);
-      }
-      const meta = (response && response.metadata) || {};
-      let remaining;
-      let useFilesRemainingStop;
-
-      if (Object.prototype.hasOwnProperty.call(meta, 'totalRemainingItems')) {
-        remaining = Number(meta.totalRemainingItems);
-        useFilesRemainingStop = true;
-      } else if (Object.prototype.hasOwnProperty.call(meta, 'totalItems')) {
-        const ti = Number(meta.totalItems);
-        tasksItemsCeiling = Math.max(tasksItemsCeiling || 0, ti);
-        remaining = ti;
-        useFilesRemainingStop = false;
-      } else {
-        remaining = 0;
-        useFilesRemainingStop = true;
-      }
-
-      const nextLink = (response.links || []).find((l) => l.rel === 'nextPage');
-      const nextHref = nextLink ? nextLink.href : null;
-
-      if (verbose) {
-        const nextPart = nextHref ? ` next: ${nextHref}` : ' next: (none)';
-        if (useFilesRemainingStop) {
-          console.log(`Retrieved ${allItems.length} tasks so far, ${remaining} remaining...${nextPart}`);
-        } else if (tasksItemsCeiling != null) {
-          const remV = Math.max(0, tasksItemsCeiling - allItems.length);
-          console.log(`Retrieved ${allItems.length} tasks so far, ${remV} remaining...${nextPart}`);
-        } else {
-          console.log(`Retrieved ${allItems.length} tasks so far, ${remaining} remaining...${nextPart}`);
-        }
-      }
-
-      if (!items.length) {
-        hasNextPage = false;
-      } else if (useFilesRemainingStop && remaining === 0) {
-        hasNextPage = false;
-      } else if (
-        !useFilesRemainingStop &&
-        tasksItemsCeiling != null &&
-        allItems.length >= tasksItemsCeiling
-      ) {
-        hasNextPage = false;
-      } else if (nextLink) {
-        const bookmark = new URL(nextLink.href).searchParams.get('bookmark');
-        currentParams = { ...baseParams, bookmark };
-      } else {
-        hasNextPage = false;
-      }
-    }
-
-    if (verbose) {
-      console.log(`Done. Total tasks retrieved: ${allItems.length}`);
-    }
-    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);
-  }
-}
-
-TasksApi.normalizeTaskParams = normalizeTaskParams;
-
-module.exports = TasksApi;
+'use strict';
+
+const { convertToModel, convertToModelList } = require('../models/convert');
+const {
+  TaskSchema,
+  TaskChangeSchema,
+  TasksListResponseSchema,
+  TaskResponseSchema,
+  TaskChangesSchema,
+  TaskAttachmentsListResponseSchema,
+} = require('../models/tasks');
+
+/**
+ * Build query params for GET /5.2/projects/.../tasks (OData).
+ * If params contains typeId and no $filter, expands to
+ *   $filter=data/type/typeId eq '<typeId>'
+ * Single quotes in typeId are escaped as '' per OData. If $filter is set,
+ * typeId is still omitted from the outgoing query (not merged).
+ * @param {object} [params]
+ * @returns {object}
+ */
+function normalizeTaskParams(params = {}) {
+  const normalized = { ...params };
+  const typeId = normalized.typeId;
+  delete normalized.typeId;
+  if (typeId != null && normalized.$filter === undefined) {
+    const escaped = String(typeId).replace(/'/g, "''");
+    normalized.$filter = `data/type/typeId eq '${escaped}'`;
+  }
+  return normalized;
+}
+
+/**
+ * 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). Pass typeId as shorthand for
+   *   OData $filter on task type, or pass $filter (and other OData options) directly.
+   * @returns {Promise<object>}
+   */
+  async getProjectTasks(projectId, params = {}) {
+    const response = await this._client.get(`/5.2/projects/${projectId}/tasks`, normalizeTaskParams(params));
+    return convertToModel(response, TasksListResponseSchema, 'TasksListResponse');
+  }
+
+  /**
+   * Retrieve all tasks on a project by following bookmark pagination automatically.
+   * Matches Python client behaviour: uses metadata.totalRemainingItems when present;
+   * otherwise uses metadata.totalItems across pages as a ceiling so pagination cannot run forever.
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters / OData (typeId shorthand supported).
+   * @param {boolean} [verbose=false] - Log progress to console.
+   * @returns {Promise<object[]>} All task items across all pages
+   */
+  async getAllProjectTasks(projectId, params = {}, verbose = false) {
+    const allItems = [];
+    const baseParams = normalizeTaskParams(params);
+    let currentParams = { ...baseParams };
+    let hasNextPage = true;
+    /** @type {number|null} */
+    let tasksItemsCeiling = null;
+
+    while (hasNextPage) {
+      const response = await this._client.get(`/5.2/projects/${projectId}/tasks`, currentParams);
+      const items = Array.isArray(response.items) ? response.items : [];
+      if (items.length) {
+        allItems.push(...items);
+      }
+      const meta = (response && response.metadata) || {};
+      let remaining;
+      let useFilesRemainingStop;
+
+      if (Object.prototype.hasOwnProperty.call(meta, 'totalRemainingItems')) {
+        remaining = Number(meta.totalRemainingItems);
+        useFilesRemainingStop = true;
+      } else if (Object.prototype.hasOwnProperty.call(meta, 'totalItems')) {
+        const ti = Number(meta.totalItems);
+        tasksItemsCeiling = Math.max(tasksItemsCeiling || 0, ti);
+        remaining = ti;
+        useFilesRemainingStop = false;
+      } else {
+        remaining = 0;
+        useFilesRemainingStop = true;
+      }
+
+      const nextLink = (response.links || []).find((l) => l.rel === 'nextPage');
+      const nextHref = nextLink ? nextLink.href : null;
+
+      if (verbose) {
+        const nextPart = nextHref ? ` next: ${nextHref}` : ' next: (none)';
+        if (useFilesRemainingStop) {
+          console.log(`Retrieved ${allItems.length} tasks so far, ${remaining} remaining...${nextPart}`);
+        } else if (tasksItemsCeiling != null) {
+          const remV = Math.max(0, tasksItemsCeiling - allItems.length);
+          console.log(`Retrieved ${allItems.length} tasks so far, ${remV} remaining...${nextPart}`);
+        } else {
+          console.log(`Retrieved ${allItems.length} tasks so far, ${remaining} remaining...${nextPart}`);
+        }
+      }
+
+      if (!items.length) {
+        hasNextPage = false;
+      } else if (useFilesRemainingStop && remaining === 0) {
+        hasNextPage = false;
+      } else if (
+        !useFilesRemainingStop &&
+        tasksItemsCeiling != null &&
+        allItems.length >= tasksItemsCeiling
+      ) {
+        hasNextPage = false;
+      } else if (nextLink) {
+        const bookmark = new URL(nextLink.href).searchParams.get('bookmark');
+        currentParams = { ...baseParams, bookmark };
+      } else {
+        hasNextPage = false;
+      }
+    }
+
+    if (verbose) {
+      console.log(`Done. Total tasks retrieved: ${allItems.length}`);
+    }
+    return convertToModelList(allItems, TaskSchema, 'Task');
+  }
+
+  /**
+   * 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>}
+   */
+  async getTask(projectId, taskId) {
+    const response = await this._client.get(`/3.3/projects/${projectId}/tasks/${taskId}`);
+    return convertToModel(response, TaskResponseSchema, 'TaskResponse');
+  }
+
+  /**
+   * 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>}
+   */
+  async getProjectTaskChanges(projectId, params = {}) {
+    const response = await this._client.get(`/2.2/projects/${projectId}/tasks/changes`, params);
+    return convertToModel(response, TaskChangesSchema, 'TaskChanges');
+  }
+
+  /**
+   * 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>}
+   */
+  async getProjectTaskAttachments(projectId, params = {}) {
+    const response = await this._client.get(`/1.1/projects/${projectId}/tasks/attachments`, params);
+    return convertToModel(response, TaskAttachmentsListResponseSchema, 'TaskAttachmentsListResponse');
+  }
+
+  /**
+   * Retrieve all task changes by following bookmark pagination automatically.
+   * @param {string} projectId
+   * @param {object} [params] - Optional query parameters (e.g. updatedAfter).
+   * @param {boolean} [verbose=false]
+   * @returns {Promise<object[]>} All task change items across all pages.
+   */
+  async getAllProjectTaskChanges(projectId, params = {}, verbose = false) {
+    const { paginate } = require('../utils/pagination');
+    const raw = await paginate(
+      `/2.2/projects/${projectId}/tasks/changes`,
+      this._client,
+      params,
+      verbose,
+    );
+    return convertToModelList(raw, TaskChangeSchema, 'TaskChange');
+  }
+}
+
+TasksApi.normalizeTaskParams = normalizeTaskParams;
+
+module.exports = TasksApi;