dalux-build-api 1.0.0

package/src/api/FilesApi.js

@@ -0,0 +1,72 @@
+'use strict';
+
+/**
+ * API methods for files within a file area.
+ */
+class FilesApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all files on the given project and file area.
+   * GET /6.0/projects/{projectId}/file_areas/{fileAreaId}/files
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {object} [params] - Optional filters (e.g. folderId, updatedAfter)
+   * @returns {Promise<object>}
+   */
+  listFiles(projectId, fileAreaId, params = {}) {
+    return this._client.get(
+      `/6.0/projects/${projectId}/file_areas/${fileAreaId}/files`,
+      params,
+    );
+  }
+
+  /**
+   * Retrieve a specific file.
+   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} fileId
+   * @returns {Promise<object>}
+   */
+  getFile(projectId, fileAreaId, fileId) {
+    return this._client.get(
+      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}`,
+    );
+  }
+
+  /**
+   * Retrieve properties mapping for a specific file.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/properties/1.0/mappings
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} fileId
+   * @returns {Promise<object>}
+   */
+  getFilePropertiesMapping(projectId, fileAreaId, fileId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/properties/1.0/mappings`,
+    );
+  }
+
+  /**
+   * Retrieve valid property values for a specific file property mapping.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/files/properties/1.0/mappings/{filePropertyId}/values
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} filePropertyId
+   * @returns {Promise<object>}
+   */
+  getFilePropertyMappingValues(projectId, fileAreaId, filePropertyId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/files/properties/1.0/mappings/${filePropertyId}/values`,
+    );
+  }
+}
+
+module.exports = FilesApi;

package/src/api/FoldersApi.js

@@ -0,0 +1,58 @@
+'use strict';
+
+/**
+ * API methods for folders within a file area.
+ */
+class FoldersApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all folders on the given project and file area.
+   * GET /5.1/projects/{projectId}/file_areas/{fileAreaId}/folders
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listFolders(projectId, fileAreaId, params = {}) {
+    return this._client.get(
+      `/5.1/projects/${projectId}/file_areas/${fileAreaId}/folders`,
+      params,
+    );
+  }
+
+  /**
+   * Retrieve a specific folder.
+   * GET /5.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} folderId
+   * @returns {Promise<object>}
+   */
+  getFolder(projectId, fileAreaId, folderId) {
+    return this._client.get(
+      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}`,
+    );
+  }
+
+  /**
+   * Retrieve all properties for each file type in a specific folder.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}/folders/{folderId}/files/properties/1.0/mappings
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} folderId
+   * @returns {Promise<object>}
+   */
+  getFolderFilesProperties(projectId, fileAreaId, folderId) {
+    return this._client.get(
+      `/1.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}/files/properties/1.0/mappings`,
+    );
+  }
+}
+
+module.exports = FoldersApi;

package/src/api/FormsApi.js

@@ -0,0 +1,48 @@
+'use strict';
+
+/**
+ * API methods for forms on a project.
+ */
+class FormsApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Retrieve forms on a project.
+   * GET /2.1/projects/{projectId}/forms
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectForms(projectId, params = {}) {
+    return this._client.get(`/2.1/projects/${projectId}/forms`, params);
+  }
+
+  /**
+   * Retrieve a specific form.
+   * GET /1.2/projects/{projectId}/forms/{formId}
+   * @param {string} projectId
+   * @param {string} formId
+   * @returns {Promise<object>}
+   */
+  getForm(projectId, formId) {
+    return this._client.get(`/1.2/projects/${projectId}/forms/${formId}`);
+  }
+
+  /**
+   * Retrieve attachments on forms on a project in incremental updates.
+   * GET /2.1/projects/{projectId}/forms/attachments
+   * @param {string} projectId
+   * @param {object} [params] - Optional filters (e.g. updatedAfter)
+   * @returns {Promise<object>}
+   */
+  getProjectFormAttachments(projectId, params = {}) {
+    return this._client.get(`/2.1/projects/${projectId}/forms/attachments`, params);
+  }
+}
+
+module.exports = FormsApi;

package/src/api/InspectionPlansApi.js

@@ -0,0 +1,62 @@
+'use strict';
+
+/**
+ * API methods for inspection plans.
+ */
+class InspectionPlansApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Browse all inspection plans on the given project.
+   * GET /1.2/projects/{projectId}/inspectionPlans
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlans(projectId, params = {}) {
+    return this._client.get(`/1.2/projects/${projectId}/inspectionPlans`, params);
+  }
+
+  /**
+   * Browse all inspection plan items on the given project.
+   * GET /1.1/projects/{projectId}/inspectionPlanItems
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanItems(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
+  }
+
+  /**
+   * Browse all inspection plan item zones on the given project.
+   * GET /1.1/projects/{projectId}/inspectionPlanItemZones
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanItemZones(projectId, params = {}) {
+    return this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
+  }
+
+  /**
+   * Browse all inspection plan registrations on the given project.
+   * GET /2.1/projects/{projectId}/inspectionPlanRegistrations
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listInspectionPlanRegistrations(projectId, params = {}) {
+    return this._client.get(
+      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
+      params,
+    );
+  }
+}
+
+module.exports = InspectionPlansApi;

package/src/api/ProjectTemplatesApi.js

@@ -0,0 +1,25 @@
+'use strict';
+
+/**
+ * API methods for project templates.
+ */
+class ProjectTemplatesApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get all available project templates on the company profile.
+   * GET /1.1/projectTemplates
+   * @param {object} [params]
+   * @returns {Promise<object>}
+   */
+  listProjectTemplates(params = {}) {
+    return this._client.get('/1.1/projectTemplates', params);
+  }
+}
+
+module.exports = ProjectTemplatesApi;

package/src/api/ProjectsApi.js

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

package/src/api/TasksApi.js

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

package/src/api/TestPlansApi.js

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

package/src/api/UsersApi.js

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

package/src/api/VersionSetsApi.js

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

package/src/api/WorkPackagesApi.js

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