dalux-build-api 2.3.0 → 2.4.0

package/src/api/TasksApi.js

@@ -1,193 +0,0 @@
-'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;

package/src/api/TestPlansApi.js

@@ -1,137 +0,0 @@
-'use strict';
-
-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.
- */
-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]
-   * @param {boolean} [fullResponse=false]
-   * @returns {Promise<object[]|object>}
-   */
-  async listTestPlans(projectId, params = {}, fullResponse = false) {
-    const response = await this._client.get(`/1.2/projects/${projectId}/testPlans`, params);
-    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');
-  }
-
-  /**
-   * Browse all test plan items on the given project.
-   * GET /1.1/projects/{projectId}/testPlanItems
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  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');
-  }
-
-  /**
-   * 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>}
-   */
-  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');
-  }
-
-  /**
-   * Browse all test plan registrations on the given project.
-   * GET /1.1/projects/{projectId}/testPlanRegistrations
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  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');
-  }
-}
-
-module.exports = TestPlansApi;

package/src/api/UsersApi.js

@@ -1,52 +0,0 @@
-'use strict';
-
-const { convertToModel } = require('../models/convert');
-const { UserResponseSchema, UsersListResponseSchema } = require('../models/users');
-
-/**
- * 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>} UserResponse ({ data: User, links? })
-   */
-  async getUser(userId) {
-    const response = await this._client.get(`/1.1/users/${userId}`);
-    return convertToModel(response, UserResponseSchema, 'UserResponse');
-  }
-
-  /**
-   * Get users on a project.
-   * GET /1.2/projects/{projectId}/users
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>} UsersListResponse ({ items: ProjectUser[], metadata?, links? })
-   */
-  async listProjectUsers(projectId, params = {}) {
-    const response = await this._client.get(`/1.2/projects/${projectId}/users`, params);
-    return convertToModel(response, UsersListResponseSchema, 'UsersListResponse');
-  }
-
-  /**
-   * 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;

package/src/api/VersionSetsApi.js

@@ -1,75 +0,0 @@
-'use strict';
-
-const { convertToModel } = require('../models/convert');
-const { VersionSetsListResponseSchema, VersionSetResponseSchema } = require('../models/versionSets');
-const { FilesListResponseSchema } = require('../models/files');
-
-/**
- * API methods for version sets.
- */
-class VersionSetsApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Retrieve the version sets on the given project.
-   * GET /2.1/projects/{projectId}/version_sets
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>} VersionSetsListResponse ({ items: VersionSet[], metadata?, links? })
-   */
-  async getVersionSets(projectId, params = {}) {
-    const response = await this._client.get(`/2.1/projects/${projectId}/version_sets`, params);
-    return convertToModel(response, VersionSetsListResponseSchema, 'VersionSetsListResponse');
-  }
-
-  /**
-   * Retrieve a specific version set.
-   * GET /2.0/projects/{projectId}/version_sets/{versionSetId}
-   * @param {string} projectId
-   * @param {string} versionSetId
-   * @returns {Promise<object>} VersionSetResponse ({ data: VersionSet, links? })
-   */
-  async getVersionSet(projectId, versionSetId) {
-    const response = await this._client.get(`/2.0/projects/${projectId}/version_sets/${versionSetId}`);
-    return convertToModel(response, VersionSetResponseSchema, 'VersionSetResponse');
-  }
-
-  /**
-   * Browse all version sets on the given file area and project.
-   * GET /2.1/projects/{projectId}/file_areas/{fileAreaId}/version_sets
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} [params]
-   * @returns {Promise<object>} VersionSetsListResponse
-   */
-  async listFileAreaVersionSets(projectId, fileAreaId, params = {}) {
-    const response = await this._client.get(
-      `/2.1/projects/${projectId}/file_areas/${fileAreaId}/version_sets`,
-      params,
-    );
-    return convertToModel(response, VersionSetsListResponseSchema, 'VersionSetsListResponse');
-  }
-
-  /**
-   * Browse all files on the given project and given version set.
-   * GET /3.0/projects/{projectId}/version_sets/{versionSetId}/files
-   * @param {string} projectId
-   * @param {string} versionSetId
-   * @param {object} [params]
-   * @returns {Promise<object>} FilesListResponse (cross-endpoint reuse of the Files model, matches Python)
-   */
-  async listVersionSetFiles(projectId, versionSetId, params = {}) {
-    const response = await this._client.get(
-      `/3.0/projects/${projectId}/version_sets/${versionSetId}/files`,
-      params,
-    );
-    return convertToModel(response, FilesListResponseSchema, 'FilesListResponse');
-  }
-}
-
-module.exports = VersionSetsApi;

package/src/api/WorkPackagesApi.js

@@ -1,30 +0,0 @@
-'use strict';
-
-const { convertToModel } = require('../models/convert');
-const { WorkPackagesListResponseSchema } = require('../models/workPackages');
-
-/**
- * API methods for work packages on a project.
- */
-class WorkPackagesApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Browse all work packages on the given project.
-   * GET /1.0/projects/{projectId}/workpackages
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>} WorkPackagesListResponse ({ items: WorkPackage[], metadata?, links? })
-   */
-  async listWorkPackages(projectId, params = {}) {
-    const response = await this._client.get(`/1.0/projects/${projectId}/workpackages`, params);
-    return convertToModel(response, WorkPackagesListResponseSchema, 'WorkPackagesListResponse');
-  }
-}
-
-module.exports = WorkPackagesApi;

package/src/apiClient.js

@@ -1,143 +0,0 @@
-'use strict';
-
-const axios = require('axios');
-const { NotFoundError, AuthenticationError, RateLimitError, ApiError } = require('./utils/errors');
-
-// Load .env file when dotenv is available (optional peer dep)
-try {
-  require('dotenv').config();
-} catch (_) { /* dotenv not installed – skip */ }
-
-/**
- * Base HTTP client that attaches the X-API-KEY header to every request.
- *
- * When *configuration* is omitted the client reads ``DALUX_BASE_URL`` and
- * ``DALUX_API_KEY`` from the environment, matching the Python client behaviour.
- */
-class ApiClient {
-  /**
-   * @param {import('./configuration')} [configuration]
-   */
-  constructor(configuration) {
-    if (!configuration) {
-      const Configuration = require('./configuration');
-      configuration = new Configuration();
-    }
-    this.configuration = configuration;
-
-    this._axios = axios.create({
-      baseURL: configuration.baseUrl,
-      headers: {
-        'X-API-KEY': configuration.apiKey,
-        'Content-Type': 'application/json',
-        'Accept': 'application/json',
-        'User-Agent': 'dalux-build-js/1.0',
-      },
-    });
-  }
-
-  /**
-   * Extract a human-readable error detail from an Axios error response.
-   * @param {import('axios').AxiosResponse} response
-   * @returns {string}
-   */
-  _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;
-        return JSON.stringify(data);
-      }
-      return String(data).slice(0, 100);
-    } catch {
-      return `HTTP ${response.status}`;
-    }
-  }
-
-  /**
-   * Map an Axios error to the appropriate Dalux error class.
-   * @param {import('axios').AxiosError} err
-   * @param {string} path
-   */
-  _handleAxiosError(err, path) {
-    if (err.response) {
-      const { status } = err.response;
-      const detail = this._getErrorDetail(err.response);
-      if (status === 404) throw new NotFoundError(`Resource not found: ${path}`);
-      if (status === 401) throw new AuthenticationError('Authentication failed');
-      if (status === 429) throw new RateLimitError('Rate limit exceeded');
-      throw new ApiError(`API request failed: ${detail}`);
-    }
-    throw new ApiError(`Request failed: ${err.message}`);
-  }
-
-  /**
-   * 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 = {}, config = {}) {
-    try {
-      const response = await this._axios.get(path, { params, ...config });
-      return response.data;
-    } catch (err) {
-      this._handleAxiosError(err, path);
-    }
-  }
-
-  /**
-   * Perform a POST request.
-   * @param {string} path
-   * @param {object} [body]
-   * @param {object} [params]
-   * @param {object} [config] - Extra axios config (e.g. custom headers or responseType)
-   * @returns {Promise<any>}
-   */
-  async post(path, body = {}, params = {}, config = {}) {
-    try {
-      const response = await this._axios.post(path, body, { params, ...config });
-      return response.data;
-    } catch (err) {
-      this._handleAxiosError(err, path);
-    }
-  }
-
-  /**
-   * Perform a PATCH request.
-   * @param {string} path
-   * @param {object} [body]
-   * @param {object} [params]
-   * @returns {Promise<any>}
-   */
-  async patch(path, body = {}, params = {}) {
-    try {
-      const response = await this._axios.patch(path, body, { params });
-      return response.data;
-    } catch (err) {
-      this._handleAxiosError(err, path);
-    }
-  }
-
-  /**
-   * Perform a DELETE request.
-   * @param {string} path
-   * @param {object} [params]
-   * @returns {Promise<any>}
-   */
-  async delete(path, params = {}) {
-    try {
-      const response = await this._axios.delete(path, { params });
-      return response.data;
-    } catch (err) {
-      this._handleAxiosError(err, path);
-    }
-  }
-}
-
-module.exports = ApiClient;