dalux-build-api 2.3.0 → 2.4.0

package/src/api/FoldersApi.js

@@ -1,283 +0,0 @@
-'use strict';
-
-const { paginate } = require('../utils/pagination');
-const { findByField } = require('../utils/search');
-const { validateProjectId, validateFileAreaId } = require('../utils/validation');
-const { resolveFolderIdFromNamedPath } = require('../utils/pathResolver');
-const { convertToModel, convertToModelList } = require('../models/convert');
-const { FolderSchema, FolderResponseSchema, FoldersListResponseSchema } = require('../models/folders');
-
-/**
- * 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 (single page).
-   * GET /5.1/projects/{projectId}/file_areas/{fileAreaId}/folders
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  async listFolders(projectId, fileAreaId, params = {}) {
-    const response = await this._client.get(
-      `/5.1/projects/${projectId}/file_areas/${fileAreaId}/folders`,
-      params,
-    );
-    return convertToModel(response, FoldersListResponseSchema, 'FoldersListResponse');
-  }
-
-  /**
-   * Retrieve all folders by following bookmark pagination automatically.
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object} [params]
-   * @param {boolean} [verbose=false]
-   * @returns {Promise<object[]>} All folder items across all pages.
-   */
-  async getAllFolders(projectId, fileAreaId, params = {}, verbose = false) {
-    validateProjectId(projectId);
-    validateFileAreaId(fileAreaId);
-    const endpoint = `/5.1/projects/${projectId}/file_areas/${fileAreaId}/folders`;
-    const raw = await paginate(endpoint, this._client, params, verbose);
-    return convertToModelList(raw, FolderSchema, 'Folder');
-  }
-
-  /**
-   * 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>}
-   */
-  async getFolder(projectId, fileAreaId, folderId) {
-    const response = await this._client.get(
-      `/5.0/projects/${projectId}/file_areas/${fileAreaId}/folders/${folderId}`,
-    );
-    return convertToModel(response, FolderResponseSchema, 'FolderResponse');
-  }
-
-  /**
-   * Get a folder using a full path starting with the file area name.
-   * e.g. "Files/4_Design/C07_Geometry"
-   * @param {string} projectId
-   * @param {string} path - Full path starting with file area name.
-   * @param {boolean} [verbose=false]
-   * @returns {Promise<object|null>} Folder response or null if not found.
-   */
-  async getFolderByPath(projectId, path, verbose = false) {
-    validateProjectId(projectId);
-    const { fileAreaId, folderId } = await resolveFolderIdFromNamedPath(
-      this._client, projectId, path, { verbose },
-    );
-    if (!fileAreaId || !folderId) return null;
-    return this.getFolder(projectId, fileAreaId, 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`,
-    );
-  }
-
-  /**
-   * Get a folder by name within a file area, optionally filtered by parent folder.
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} folderName
-   * @param {string|null} [parentFolderId=null]
-   * @returns {Promise<object|null>} Folder item or null if not found.
-   */
-  async getFolderByName(projectId, fileAreaId, folderName, parentFolderId = null) {
-    validateProjectId(projectId);
-    validateFileAreaId(fileAreaId);
-    const allFolders = await this.getAllFolders(projectId, fileAreaId);
-    const folder = findByField(allFolders, 'folderName', folderName);
-    if (!folder) return null;
-    if (parentFolderId != null && folder.parentFolderId !== parentFolderId) {
-      return null;
-    }
-    return convertToModel({ data: folder }, FolderResponseSchema, 'FolderResponse');
-  }
-
-  /**
-   * Resolve a folder path (e.g. "Folder1/Folder2") to a folder ID.
-   * Supports wildcard matching with * in path segments.
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {string} folderPath - e.g. "Folder1/SubFolder" or a wildcard path ("*" matches any single segment)
-   * @param {boolean} [verbose=false]
-   * @returns {Promise<string|null>} Folder ID or null if not found.
-   */
-  async getFileAreaTreeByPath(projectId, fileAreaId, folderPath, verbose = false) {
-    const allFolders = await this.getAllFolders(projectId, fileAreaId);
-
-    const cleanPath = folderPath.replace(/^\/|\/$/g, '');
-    const pathParts = cleanPath.split('/').map((p) => p.trim()).filter(Boolean);
-    if (!pathParts.length) return null;
-
-    function getData(item) {
-      return item.data || item;
-    }
-    function getFid(item) {
-      const d = getData(item);
-      return d.folderId || d.id || null;
-    }
-    function getPid(item) {
-      const d = getData(item);
-      return d.parentFolderId || d.parentId || '';
-    }
-    function getName(item) {
-      const d = getData(item);
-      return d.folderName || d.name || '';
-    }
-
-    // Collect valid folder IDs
-    const validFolderIds = new Set(allFolders.map(getFid).filter(Boolean));
-    const fileAreaRootId = fileAreaId;
-
-    let candidateParentIds = new Set([fileAreaRootId, null, '']);
-
-    for (const segment of pathParts) {
-      const pattern = segment.toLowerCase();
-      const nextCandidates = new Set();
-      for (const item of allFolders) {
-        const fid = getFid(item);
-        const pid = getPid(item);
-        const name = getName(item).toLowerCase();
-        // The folder's effective parent: if pid is not in validFolderIds, treat as root
-        const effectivePid = validFolderIds.has(pid) ? pid : fileAreaRootId;
-        if (candidateParentIds.has(effectivePid) && _fnmatch(name, pattern)) {
-          if (fid) nextCandidates.add(fid);
-        }
-      }
-      if (!nextCandidates.size) {
-        if (verbose) console.log(`Folder segment '${segment}' not found`);
-        return null;
-      }
-      candidateParentIds = nextCandidates;
-    }
-
-    const result = [...candidateParentIds];
-    if (result.length === 1) return result[0];
-    if (result.length > 1) {
-      if (verbose) console.log(`Multiple folders match path '${folderPath}'`);
-      return result[0];
-    }
-    return null;
-  }
-
-  /**
-   * Build the complete folder+file tree for a file area.
-   * Fetches all folders (and optionally all files) and assembles them into a nested tree.
-   * When *filesApi* is provided, folders and files are fetched concurrently.
-   *
-   * Each node has the shape:
-   * ```
-   * { id, name, path, raw, children: [...], files: [...] }
-   * ```
-   * The returned root node represents the file-area root (id=null).
-   *
-   * @param {string} projectId
-   * @param {string} fileAreaId
-   * @param {object|null} [filesApi] - Optional FilesApi instance; when provided files are
-   *   fetched in parallel and attached to their folder nodes.
-   * @param {boolean} [verbose=false]
-   * @returns {Promise<object>} Root tree node.
-   */
-  async getFileAreaTree(projectId, fileAreaId, filesApi = null, verbose = false) {
-    let allFolders, allFiles;
-
-    if (filesApi) {
-      [allFolders, allFiles] = await Promise.all([
-        this.getAllFolders(projectId, fileAreaId, {}, verbose),
-        filesApi.getAllFiles(projectId, fileAreaId, {}, verbose),
-      ]);
-    } else {
-      allFolders = await this.getAllFolders(projectId, fileAreaId, {}, verbose);
-      allFiles = [];
-    }
-
-    if (verbose) {
-      console.log(`Building tree: ${allFolders.length} folder(s), ${allFiles.length} file(s)`);
-    }
-
-    function fid(item) {
-      const d = item.data || item;
-      return d.folderId || d.id || null;
-    }
-    function pid(item) {
-      const d = item.data || item;
-      return d.parentFolderId || d.parentId || null;
-    }
-    function name(item) {
-      const d = item.data || item;
-      return d.folderName || d.name || fid(item) || '?';
-    }
-
-    // Build node map
-    const nodes = {};
-    for (const folder of allFolders) {
-      const id = fid(folder);
-      if (!id) continue;
-      nodes[id] = { id, name: name(folder), path: '', raw: folder, children: [], files: [] };
-    }
-
-    // Wire parent→child
-    const root = { id: null, name: fileAreaId, path: '', raw: null, children: [], files: [] };
-    const validIds = new Set(Object.keys(nodes));
-    for (const folder of allFolders) {
-      const id = fid(folder);
-      if (!id) continue;
-      const parentId = pid(folder);
-      const parent = (parentId && validIds.has(parentId)) ? nodes[parentId] : root;
-      parent.children.push(nodes[id]);
-    }
-
-    // Compute paths
-    function setPaths(node, parentPath) {
-      node.path = parentPath ? `${parentPath}/${node.name}` : node.name;
-      for (const child of node.children) setPaths(child, node.path);
-    }
-    for (const child of root.children) setPaths(child, '');
-
-    // Attach files to their folder nodes
-    for (const f of allFiles) {
-      const folderIdVal = (f.data || {}).folderId || f.folderId || null;
-      const target = (folderIdVal && nodes[folderIdVal]) ? nodes[folderIdVal] : root;
-      target.files.push(f);
-    }
-
-    return root;
-  }
-}
-
-/**
- * Simple fnmatch-style wildcard matching (only * is supported).
- * @param {string} str
- * @param {string} pattern
- * @returns {boolean}
- */
-function _fnmatch(str, pattern) {
-  if (!pattern.includes('*')) return str === pattern;
-  const re = new RegExp('^' + pattern.replace(/[.+^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*') + '$');
-  return re.test(str);
-}
-
-module.exports = FoldersApi;

package/src/api/FormsApi.js

@@ -1,53 +0,0 @@
-'use strict';
-
-const { convertToModel } = require('../models/convert');
-const { FormsListResponseSchema, FormResponseSchema } = require('../models/forms');
-
-/**
- * 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>} FormsListResponse ({ items, metadata?, links? })
-   */
-  async getProjectForms(projectId, params = {}) {
-    const response = await this._client.get(`/2.1/projects/${projectId}/forms`, params);
-    return convertToModel(response, FormsListResponseSchema, 'FormsListResponse');
-  }
-
-  /**
-   * Retrieve a specific form.
-   * GET /1.2/projects/{projectId}/forms/{formId}
-   * @param {string} projectId
-   * @param {string} formId
-   * @returns {Promise<object>} FormResponse ({ data, links? })
-   */
-  async getForm(projectId, formId) {
-    const response = await this._client.get(`/1.2/projects/${projectId}/forms/${formId}`);
-    return convertToModel(response, FormResponseSchema, 'FormResponse');
-  }
-
-  /**
-   * 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

@@ -1,140 +0,0 @@
-'use strict';
-
-const { convertToModel, convertToModelList } = require('../models/convert');
-const { paginate } = require('../utils/pagination');
-const {
-  InspectionPlanSchema,
-  InspectionPlanItemSchema,
-  InspectionPlanItemZoneSchema,
-  InspectionPlanRegistrationSchema,
-  InspectionPlansListResponseSchema,
-  InspectionPlanItemsListResponseSchema,
-  InspectionPlanItemZonesListResponseSchema,
-  InspectionPlanRegistrationsListResponseSchema,
-} = require('../models/inspectionPlans');
-
-/**
- * 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]
-   * @param {boolean} [fullResponse=false]
-   * @returns {Promise<object[]|object>}
-   */
-  async listInspectionPlans(projectId, params = {}, fullResponse = false) {
-    const response = await this._client.get(`/1.2/projects/${projectId}/inspectionPlans`, params);
-    const result = convertToModel(
-      response,
-      InspectionPlansListResponseSchema,
-      'InspectionPlansListResponse',
-    );
-    return fullResponse ? result : (result?.items || []);
-  }
-
-  async getAllInspectionPlans(projectId, params = {}, verbose = false) {
-    const items = await paginate(
-      `/1.2/projects/${projectId}/inspectionPlans`,
-      this._client,
-      params,
-      verbose,
-    );
-    return convertToModelList(items, InspectionPlanSchema, 'InspectionPlan');
-  }
-
-  /**
-   * Browse all inspection plan items on the given project.
-   * GET /1.1/projects/{projectId}/inspectionPlanItems
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  async listInspectionPlanItems(projectId, params = {}, fullResponse = false) {
-    const response = await this._client.get(`/1.1/projects/${projectId}/inspectionPlanItems`, params);
-    const result = convertToModel(
-      response,
-      InspectionPlanItemsListResponseSchema,
-      'InspectionPlanItemsListResponse',
-    );
-    return fullResponse ? result : (result?.items || []);
-  }
-
-  async getAllInspectionPlanItems(projectId, params = {}, verbose = false) {
-    const items = await paginate(
-      `/1.1/projects/${projectId}/inspectionPlanItems`,
-      this._client,
-      params,
-      verbose,
-    );
-    return convertToModelList(items, InspectionPlanItemSchema, 'InspectionPlanItem');
-  }
-
-  /**
-   * 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>}
-   */
-  async listInspectionPlanItemZones(projectId, params = {}, fullResponse = false) {
-    const response = await this._client.get(`/1.1/projects/${projectId}/inspectionPlanItemZones`, params);
-    const result = convertToModel(
-      response,
-      InspectionPlanItemZonesListResponseSchema,
-      'InspectionPlanItemZonesListResponse',
-    );
-    return fullResponse ? result : (result?.items || []);
-  }
-
-  async getAllInspectionPlanItemZones(projectId, params = {}, verbose = false) {
-    const items = await paginate(
-      `/1.1/projects/${projectId}/inspectionPlanItemZones`,
-      this._client,
-      params,
-      verbose,
-    );
-    return convertToModelList(items, InspectionPlanItemZoneSchema, 'InspectionPlanItemZone');
-  }
-
-  /**
-   * Browse all inspection plan registrations on the given project.
-   * GET /2.1/projects/{projectId}/inspectionPlanRegistrations
-   * @param {string} projectId
-   * @param {object} [params]
-   * @returns {Promise<object>}
-   */
-  async listInspectionPlanRegistrations(projectId, params = {}, fullResponse = false) {
-    const response = await this._client.get(
-      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
-      params,
-    );
-    const result = convertToModel(
-      response,
-      InspectionPlanRegistrationsListResponseSchema,
-      'InspectionPlanRegistrationsListResponse',
-    );
-    return fullResponse ? result : (result?.items || []);
-  }
-
-  async getAllInspectionPlanRegistrations(projectId, params = {}, verbose = false) {
-    const items = await paginate(
-      `/2.1/projects/${projectId}/inspectionPlanRegistrations`,
-      this._client,
-      params,
-      verbose,
-    );
-    return convertToModelList(items, InspectionPlanRegistrationSchema, 'InspectionPlanRegistration');
-  }
-}
-
-module.exports = InspectionPlansApi;

package/src/api/ProjectTemplatesApi.js

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

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