dalux-build-api 1.1.3 → 2.0.0

package/src/api/TestPlansApi.js

@@ -1,59 +1,63 @@
-'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';
+
+const { convertToModel } = require('../models/convert');
+const { TestPlansListResponseSchema } = 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]
+   * @returns {Promise<object>} TestPlansListResponse ({ items, metadata?, links? })
+   */
+  async listTestPlans(projectId, params = {}) {
+    const response = await this._client.get(`/1.2/projects/${projectId}/testPlans`, params);
+    return convertToModel(response, TestPlansListResponseSchema, 'TestPlansListResponse');
+  }
+
+  /**
+   * 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,52 @@
-'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';
+
+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,67 +1,75 @@
-'use strict';
-
-/**
- * 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>}
-   */
-  getVersionSets(projectId, params = {}) {
-    return this._client.get(`/2.1/projects/${projectId}/version_sets`, params);
-  }
-
-  /**
-   * Retrieve a specific version set.
-   * GET /2.0/projects/{projectId}/version_sets/{versionSetId}
-   * @param {string} projectId
-   * @param {string} versionSetId
-   * @returns {Promise<object>}
-   */
-  getVersionSet(projectId, versionSetId) {
-    return this._client.get(`/2.0/projects/${projectId}/version_sets/${versionSetId}`);
-  }
-
-  /**
-   * 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>}
-   */
-  listFileAreaVersionSets(projectId, fileAreaId, params = {}) {
-    return this._client.get(
-      `/2.1/projects/${projectId}/file_areas/${fileAreaId}/version_sets`,
-      params,
-    );
-  }
-
-  /**
-   * 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>}
-   */
-  listVersionSetFiles(projectId, versionSetId, params = {}) {
-    return this._client.get(
-      `/3.0/projects/${projectId}/version_sets/${versionSetId}/files`,
-      params,
-    );
-  }
-}
-
-module.exports = VersionSetsApi;
+'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,26 +1,30 @@
-'use strict';
-
-/**
- * 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>}
-   */
-  listWorkPackages(projectId, params = {}) {
-    return this._client.get(`/1.0/projects/${projectId}/workpackages`, params);
-  }
-}
-
-module.exports = WorkPackagesApi;
+'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,75 +1,139 @@
-'use strict';
-
-const axios = require('axios');
-
-/**
- * Base HTTP client that attaches the X-API-KEY header to every request.
- */
-class ApiClient {
-  /**
-   * @param {import('./configuration')} configuration
-   */
-  constructor(configuration) {
-    if (!configuration) {
-      throw new Error('configuration is required');
-    }
-    this.configuration = configuration;
-
-    this._axios = axios.create({
-      baseURL: configuration.baseUrl,
-      headers: {
-        'X-API-KEY': configuration.apiKey,
-        'Content-Type': 'application/json',
-      },
-    });
-  }
-
-  /**
-   * Perform a GET request.
-   * @param {string} path  - URL path (e.g. '/5.1/projects')
-   * @param {object} [params] - Query string parameters
-   * @returns {Promise<any>} Parsed response body
-   */
-  async get(path, params = {}) {
-    const response = await this._axios.get(path, { params });
-    return response.data;
-  }
-
-  /**
-   * 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 = {}) {
-    const response = await this._axios.post(path, body, { params, ...config });
-    return response.data;
-  }
-
-  /**
-   * Perform a PATCH request.
-   * @param {string} path
-   * @param {object} [body]
-   * @param {object} [params]
-   * @returns {Promise<any>}
-   */
-  async patch(path, body = {}, params = {}) {
-    const response = await this._axios.patch(path, body, { params });
-    return response.data;
-  }
-
-  /**
-   * Perform a DELETE request.
-   * @param {string} path
-   * @param {object} [params]
-   * @returns {Promise<any>}
-   */
-  async delete(path, params = {}) {
-    const response = await this._axios.delete(path, { params });
-    return response.data;
-  }
-}
-
-module.exports = ApiClient;
+'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 (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
+   * @returns {Promise<any>} Parsed response body
+   */
+  async get(path, params = {}) {
+    try {
+      const response = await this._axios.get(path, { params });
+      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;