dalux-build-api 1.1.3 → 2.0.0

package/package.json

@@ -1,46 +1,47 @@
-{
-  "name": "dalux-build-api",
-  "version": "1.1.3",
-  "description": "Node.js client for the Dalux Build API",
-  "main": "src/index.js",
-  "files": [
-    "src",
-    "README.md"
-  ],
-  "scripts": {
-    "test": "jest --coverage",
-    "build": "npm pack",
-    "pack:check": "npm pack --dry-run",
-    "release:check": "npm test && npm run pack:check"
-  },
-  "keywords": [
-    "dalux",
-    "build",
-    "api",
-    "client",
-    "construction"
-  ],
-  "author": "Bruno Adam",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bruadam/Dalux-Build-API.git"
-  },
-  "bugs": {
-    "url": "https://github.com/bruadam/Dalux-Build-API/issues"
-  },
-  "homepage": "https://github.com/bruadam/Dalux-Build-API#readme",
-  "publishConfig": {
-    "access": "public"
-  },
-  "dependencies": {
-    "axios": "^1.7.7"
-  },
-  "devDependencies": {
-    "axios-mock-adapter": "^2.1.0",
-    "jest": "^29.7.0"
-  },
-  "jest": {
-    "testEnvironment": "node"
-  }
-}
+{
+  "name": "dalux-build-api",
+  "version": "2.0.0",
+  "description": "Node.js client for the Dalux Build API",
+  "main": "src/index.js",
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "scripts": {
+    "test": "jest --coverage",
+    "build": "npm pack",
+    "pack:check": "npm pack --dry-run",
+    "release:check": "npm test && npm run pack:check"
+  },
+  "keywords": [
+    "dalux",
+    "build",
+    "api",
+    "client",
+    "construction"
+  ],
+  "author": "Bruno Adam",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/bruadam/dalux-build.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bruadam/dalux-build/issues"
+  },
+  "homepage": "https://github.com/bruadam/dalux-build#readme",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "axios": "^1.7.7",
+    "zod": "^3.23.8"
+  },
+  "devDependencies": {
+    "axios-mock-adapter": "^2.1.0",
+    "jest": "^29.7.0"
+  },
+  "jest": {
+    "testEnvironment": "node"
+  }
+}

package/src/api/CompaniesApi.js

@@ -1,60 +1,67 @@
-'use strict';
-
-/**
- * API methods for managing companies on a project.
- */
-class CompaniesApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Get companies on a project.
-   * GET /3.1/projects/{projectId}/companies
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  listProjectCompanies(projectId, params = {}) {
-    return this._client.get(`/3.1/projects/${projectId}/companies`, params);
-  }
-
-  /**
-   * Get a specific company on a project.
-   * GET /3.0/projects/{projectId}/companies/{companyId}
-   * @param {string} projectId
-   * @param {string} companyId
-   * @returns {Promise<object>}
-   */
-  getProjectCompany(projectId, companyId) {
-    return this._client.get(`/3.0/projects/${projectId}/companies/${companyId}`);
-  }
-
-  /**
-   * Add a company to a project.
-   * POST /3.1/projects/{projectId}/companies
-   * @param {string} projectId
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  createProjectCompany(projectId, body) {
-    return this._client.post(`/3.1/projects/${projectId}/companies`, body);
-  }
-
-  /**
-   * Update a company on a project.
-   * PATCH /3.0/projects/{projectId}/companies/{companyId}
-   * @param {string} projectId
-   * @param {string} companyId
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  updateProjectCompany(projectId, companyId, body) {
-    return this._client.patch(`/3.0/projects/${projectId}/companies/${companyId}`, body);
-  }
-}
-
-module.exports = CompaniesApi;
+'use strict';
+
+const { convertToModel } = require('../models/convert');
+const { CompaniesListResponseSchema, CompanyResponseSchema } = require('../models/companies');
+
+/**
+ * API methods for managing companies on a project.
+ */
+class CompaniesApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get companies on a project.
+   * GET /3.1/projects/{projectId}/companies
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>} CompaniesListResponse ({ items: ProjectCompany[], metadata?, links? })
+   */
+  async listProjectCompanies(projectId, params = {}) {
+    const response = await this._client.get(`/3.1/projects/${projectId}/companies`, params);
+    return convertToModel(response, CompaniesListResponseSchema, 'CompaniesListResponse');
+  }
+
+  /**
+   * Get a specific company on a project.
+   * GET /3.0/projects/{projectId}/companies/{companyId}
+   * @param {string} projectId
+   * @param {string} companyId
+   * @returns {Promise<object>} CompanyResponse ({ data: ProjectCompany, links? })
+   */
+  async getProjectCompany(projectId, companyId) {
+    const response = await this._client.get(`/3.0/projects/${projectId}/companies/${companyId}`);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+
+  /**
+   * Add a company to a project.
+   * POST /3.1/projects/{projectId}/companies
+   * @param {string} projectId
+   * @param {object} body
+   * @returns {Promise<object>} CompanyResponse
+   */
+  async createProjectCompany(projectId, body) {
+    const response = await this._client.post(`/3.1/projects/${projectId}/companies`, body);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+
+  /**
+   * Update a company on a project.
+   * PATCH /3.0/projects/{projectId}/companies/{companyId}
+   * @param {string} projectId
+   * @param {string} companyId
+   * @param {object} body
+   * @returns {Promise<object>} CompanyResponse
+   */
+  async updateProjectCompany(projectId, companyId, body) {
+    const response = await this._client.patch(`/3.0/projects/${projectId}/companies/${companyId}`, body);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+}
+
+module.exports = CompaniesApi;

package/src/api/CompanyCatalogApi.js

@@ -1,108 +1,129 @@
-'use strict';
-
-/**
- * API methods for the company catalog.
- */
-class CompanyCatalogApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Get companies registered in the company catalog.
-   * GET /2.2/companyCatalog
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  getCompanies(params = {}) {
-    return this._client.get('/2.2/companyCatalog', params);
-  }
-
-  /**
-   * Get a specific company from the catalog.
-   * GET /1.2/companyCatalog/{catalogCompanyId}
-   * @param {string} catalogCompanyId
-   * @returns {Promise<object>}
-   */
-  getCompany(catalogCompanyId) {
-    return this._client.get(`/1.2/companyCatalog/${catalogCompanyId}`);
-  }
-
-  /**
-   * Add a company to the catalog.
-   * POST /2.2/companyCatalog
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  createCompany(body) {
-    return this._client.post('/2.2/companyCatalog', body);
-  }
-
-  /**
-   * Update a company in the catalog.
-   * PATCH /2.1/companyCatalog/{catalogCompanyId}
-   * @param {string} catalogCompanyId
-   * @param {object} body
-   * @returns {Promise<object>}
-   */
-  updateCompany(catalogCompanyId, body) {
-    return this._client.patch(`/2.1/companyCatalog/${catalogCompanyId}`, body);
-  }
-
-  /**
-   * Get metadata of a specific company from the catalog.
-   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata
-   * @param {string} catalogCompanyId
-   * @returns {Promise<object>}
-   */
-  listCompanyMetadata(catalogCompanyId) {
-    return this._client.get(`/1.0/companyCatalog/${catalogCompanyId}/metadata`);
-  }
-
-  /**
-   * Get all metadata available for a PATCH company-catalog operation.
-   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings
-   * @param {string} catalogCompanyId
-   * @returns {Promise<object>}
-   */
-  listCompanyMetadataMappings(catalogCompanyId) {
-    return this._client.get(`/1.0/companyCatalog/${catalogCompanyId}/metadata/1.0/mappings`);
-  }
-
-  /**
-   * Get available values for metadata in a PATCH company-catalog operation.
-   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings/{key}/values
-   * @param {string} catalogCompanyId
-   * @param {string} key
-   * @returns {Promise<object>}
-   */
-  listCompanyMetadataValues(catalogCompanyId, key) {
-    return this._client.get(
-      `/1.0/companyCatalog/${catalogCompanyId}/metadata/1.0/mappings/${key}/values`,
-    );
-  }
-
-  /**
-   * Get all metadata available for a POST company-catalog operation.
-   * GET /1.0/companyCatalog/metadata/1.0/mappings
-   * @returns {Promise<object>}
-   */
-  listMetadataMappingsForCompanies() {
-    return this._client.get('/1.0/companyCatalog/metadata/1.0/mappings');
-  }
-
-  /**
-   * Get available values for metadata in a POST company-catalog operation.
-   * GET /1.0/companyCatalog/metadata/1.0/mappings/{key}/values
-   * @param {string} key
-   * @returns {Promise<object>}
-   */
-  listMetadataValuesForCompanies(key) {
-    return this._client.get(`/1.0/companyCatalog/metadata/1.0/mappings/${key}/values`);
-  }
-}
-
-module.exports = CompanyCatalogApi;
+'use strict';
+
+const { findByField } = require('../utils/search');
+const { convertToModel } = require('../models/convert');
+const { CompaniesListResponseSchema, CompanyResponseSchema } = require('../models/companies');
+
+/**
+ * API methods for the company catalog.
+ */
+class CompanyCatalogApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Get companies registered in the company catalog.
+   * GET /2.2/companyCatalog
+   * @param {object} [params]
+   * @returns {Promise<object>} CompaniesListResponse ({ items: ProjectCompany[], metadata?, links? })
+   */
+  async getCompanies(params = {}) {
+    const response = await this._client.get('/2.2/companyCatalog', params);
+    return convertToModel(response, CompaniesListResponseSchema, 'CompaniesListResponse');
+  }
+
+  /**
+   * Get a specific company from the catalog.
+   * GET /1.2/companyCatalog/{catalogCompanyId}
+   * @param {string} catalogCompanyId
+   * @returns {Promise<object>} CompanyResponse ({ data: ProjectCompany, links? })
+   */
+  async getCompany(catalogCompanyId) {
+    const response = await this._client.get(`/1.2/companyCatalog/${catalogCompanyId}`);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+
+  /**
+   * Add a company to the catalog.
+   * POST /2.2/companyCatalog
+   * @param {object} body
+   * @returns {Promise<object>} CompanyResponse
+   */
+  async createCompany(body) {
+    const response = await this._client.post('/2.2/companyCatalog', body);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+
+  /**
+   * Update a company in the catalog.
+   * PATCH /2.1/companyCatalog/{catalogCompanyId}
+   * @param {string} catalogCompanyId
+   * @param {object} body
+   * @returns {Promise<object>} CompanyResponse
+   */
+  async updateCompany(catalogCompanyId, body) {
+    const response = await this._client.patch(`/2.1/companyCatalog/${catalogCompanyId}`, body);
+    return convertToModel(response, CompanyResponseSchema, 'CompanyResponse');
+  }
+
+  /**
+   * Get metadata of a specific company from the catalog.
+   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata
+   * @param {string} catalogCompanyId
+   * @returns {Promise<object>}
+   */
+  listCompanyMetadata(catalogCompanyId) {
+    return this._client.get(`/1.0/companyCatalog/${catalogCompanyId}/metadata`);
+  }
+
+  /**
+   * Get all metadata available for a PATCH company-catalog operation.
+   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings
+   * @param {string} catalogCompanyId
+   * @returns {Promise<object>}
+   */
+  listCompanyMetadataMappings(catalogCompanyId) {
+    return this._client.get(`/1.0/companyCatalog/${catalogCompanyId}/metadata/1.0/mappings`);
+  }
+
+  /**
+   * Get available values for metadata in a PATCH company-catalog operation.
+   * GET /1.0/companyCatalog/{catalogCompanyId}/metadata/1.0/mappings/{key}/values
+   * @param {string} catalogCompanyId
+   * @param {string} key
+   * @returns {Promise<object>}
+   */
+  listCompanyMetadataValues(catalogCompanyId, key) {
+    return this._client.get(
+      `/1.0/companyCatalog/${catalogCompanyId}/metadata/1.0/mappings/${key}/values`,
+    );
+  }
+
+  /**
+   * Get all metadata available for a POST company-catalog operation.
+   * GET /1.0/companyCatalog/metadata/1.0/mappings
+   * @returns {Promise<object>}
+   */
+  listMetadataMappingsForCompanies() {
+    return this._client.get('/1.0/companyCatalog/metadata/1.0/mappings');
+  }
+
+  /**
+   * Get available values for metadata in a POST company-catalog operation.
+   * GET /1.0/companyCatalog/metadata/1.0/mappings/{key}/values
+   * @param {string} key
+   * @returns {Promise<object>}
+   */
+  listMetadataValuesForCompanies(key) {
+    return this._client.get(`/1.0/companyCatalog/metadata/1.0/mappings/${key}/values`);
+  }
+
+  /**
+   * Get a company ID by its name from the catalog.
+   * @param {string} companyName
+   * @returns {Promise<string|null>} The catalogCompanyId, or null if not found.
+   */
+  async getCompanyByName(companyName) {
+    const response = await this.getCompanies();
+    const items = (response && response.items) || [];
+    const company = findByField(items, 'name', companyName);
+    if (!company) return null;
+    return company.catalogCompanyId || null;
+  }
+}
+
+module.exports = CompanyCatalogApi;

package/src/api/FileAreasApi.js

@@ -1,37 +1,57 @@
-'use strict';
-
-/**
- * API methods for file areas on a project.
- */
-class FileAreasApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Retrieve the file areas on the given project.
-   * GET /5.1/projects/{projectId}/file_areas
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  getFileAreas(projectId, params = {}) {
-    return this._client.get(`/5.1/projects/${projectId}/file_areas`, params);
-  }
-
-  /**
-   * Retrieve a specific file area.
-   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @returns {Promise<object>}
-   */
-  getFileArea(projectId, fileAreaId) {
-    return this._client.get(`/1.0/projects/${projectId}/file_areas/${fileAreaId}`);
-  }
-}
-
-module.exports = FileAreasApi;
+'use strict';
+
+const { findByField } = require('../utils/search');
+const { convertToModel } = require('../models/convert');
+const { FileAreaSchema, FileAreasListResponseSchema } = require('../models/fileAreas');
+
+/**
+ * API methods for file areas on a project.
+ */
+class FileAreasApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Retrieve the file areas on the given project.
+   * GET /5.1/projects/{projectId}/file_areas
+   * @param {string} projectId
+   * @param {object} [params]
+   * @returns {Promise<object>} FileAreasListResponse ({ items: FileArea[], metadata?, links? })
+   */
+  async getFileAreas(projectId, params = {}) {
+    const response = await this._client.get(`/5.1/projects/${projectId}/file_areas`, params);
+    return convertToModel(response, FileAreasListResponseSchema, 'FileAreasListResponse');
+  }
+
+  /**
+   * Retrieve a specific file area.
+   * GET /1.0/projects/{projectId}/file_areas/{fileAreaId}
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @returns {Promise<object>} FileArea (not wrapped in a data envelope, matches Python)
+   */
+  async getFileArea(projectId, fileAreaId) {
+    const response = await this._client.get(`/1.0/projects/${projectId}/file_areas/${fileAreaId}`);
+    return convertToModel(response, FileAreaSchema, 'FileArea');
+  }
+
+  /**
+   * Get a file area ID by its name for a project.
+   * @param {string} projectId
+   * @param {string} fileAreaName
+   * @returns {Promise<string|null>} The fileAreaId, or null if not found.
+   */
+  async getFileAreaByName(projectId, fileAreaName) {
+    const response = await this.getFileAreas(projectId);
+    const items = (response && response.items) || [];
+    const area = findByField(items, 'fileAreaName', fileAreaName);
+    if (!area) return null;
+    return area.fileAreaId || null;
+  }
+}
+
+module.exports = FileAreasApi;

package/src/api/FileRevisionsApi.js

@@ -1,31 +1,31 @@
-'use strict';
-
-/**
- * API methods for file revision content.
- */
-class FileRevisionsApi {
-  /**
-   * @param {import('../apiClient')} apiClient
-   */
-  constructor(apiClient) {
-    this._client = apiClient;
-  }
-
-  /**
-   * Retrieve content of a specific file revision.
-   * GET /2.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/revisions/{fileRevisionId}/content
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} fileId
-   * @param {string} fileRevisionId
-   * @returns {Promise<Buffer>} Raw binary content
-   */
-  getFileRevisionContent(projectId, fileAreaId, fileId, fileRevisionId) {
-    return this._client.get(
-      `/2.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/revisions/${fileRevisionId}/content`,
-      {},
-    );
-  }
-}
-
-module.exports = FileRevisionsApi;
+'use strict';
+
+/**
+ * API methods for file revision content.
+ */
+class FileRevisionsApi {
+  /**
+   * @param {import('../apiClient')} apiClient
+   */
+  constructor(apiClient) {
+    this._client = apiClient;
+  }
+
+  /**
+   * Retrieve content of a specific file revision.
+   * GET /2.0/projects/{projectId}/file_areas/{fileAreaId}/files/{fileId}/revisions/{fileRevisionId}/content
+   * @param {string} projectId
+   * @param {string} fileAreaId
+   * @param {string} fileId
+   * @param {string} fileRevisionId
+   * @returns {Promise<Buffer>} Raw binary content
+   */
+  getFileRevisionContent(projectId, fileAreaId, fileId, fileRevisionId) {
+    return this._client.get(
+      `/2.0/projects/${projectId}/file_areas/${fileAreaId}/files/${fileId}/revisions/${fileRevisionId}/content`,
+      {},
+    );
+  }
+}
+
+module.exports = FileRevisionsApi;