dalux-build-api 1.0.0 → 1.0.1

package/src/api/VersionSetsApi.js

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

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

package/src/apiClient.js

@@ -1,75 +1,75 @@
-'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');
+
+/**
+ * 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;

package/src/configuration.js

@@ -1,24 +1,24 @@
-'use strict';
-
-/**
- * Configuration for the Dalux Build API client.
- */
-class Configuration {
-  /**
-   * @param {object} options
-   * @param {string} options.baseUrl  - The API base URL provided by Dalux (e.g. https://api.dalux.com/build)
-   * @param {string} options.apiKey  - Your company-specific X-API-KEY
-   */
-  constructor({ baseUrl, apiKey } = {}) {
-    if (!baseUrl) {
-      throw new Error('baseUrl is required');
-    }
-    if (!apiKey) {
-      throw new Error('apiKey is required');
-    }
-    this.baseUrl = baseUrl.replace(/\/$/, '');
-    this.apiKey = apiKey;
-  }
-}
-
-module.exports = Configuration;
+'use strict';
+
+/**
+ * Configuration for the Dalux Build API client.
+ */
+class Configuration {
+  /**
+   * @param {object} options
+   * @param {string} options.baseUrl  - The API base URL provided by Dalux (e.g. https://api.dalux.com/build)
+   * @param {string} options.apiKey  - Your company-specific X-API-KEY
+   */
+  constructor({ baseUrl, apiKey } = {}) {
+    if (!baseUrl) {
+      throw new Error('baseUrl is required');
+    }
+    if (!apiKey) {
+      throw new Error('apiKey is required');
+    }
+    this.baseUrl = baseUrl.replace(/\/$/, '');
+    this.apiKey = apiKey;
+  }
+}
+
+module.exports = Configuration;

package/src/index.js

@@ -1,92 +1,92 @@
-'use strict';
-
-const Configuration = require('./configuration');
-const ApiClient = require('./apiClient');
-
-const CompaniesApi = require('./api/CompaniesApi');
-const CompanyCatalogApi = require('./api/CompanyCatalogApi');
-const FileAreasApi = require('./api/FileAreasApi');
-const FileRevisionsApi = require('./api/FileRevisionsApi');
-const FileUploadApi = require('./api/FileUploadApi');
-const FilesApi = require('./api/FilesApi');
-const FoldersApi = require('./api/FoldersApi');
-const FormsApi = require('./api/FormsApi');
-const InspectionPlansApi = require('./api/InspectionPlansApi');
-const ProjectTemplatesApi = require('./api/ProjectTemplatesApi');
-const ProjectsApi = require('./api/ProjectsApi');
-const TasksApi = require('./api/TasksApi');
-const TestPlansApi = require('./api/TestPlansApi');
-const UsersApi = require('./api/UsersApi');
-const VersionSetsApi = require('./api/VersionSetsApi');
-const WorkPackagesApi = require('./api/WorkPackagesApi');
-
-/**
- * Create a fully configured Dalux Build API client.
- *
- * @param {object} options
- * @param {string} options.baseUrl  - The API base URL (obtain from Dalux support)
- * @param {string} options.apiKey  - Your X-API-KEY (manage via Dalux Settings › Integrations › API Identities)
- * @returns {{
- *   projects: ProjectsApi,
- *   companies: CompaniesApi,
- *   companyCatalog: CompanyCatalogApi,
- *   fileAreas: FileAreasApi,
- *   fileRevisions: FileRevisionsApi,
- *   fileUpload: FileUploadApi,
- *   files: FilesApi,
- *   folders: FoldersApi,
- *   forms: FormsApi,
- *   inspectionPlans: InspectionPlansApi,
- *   projectTemplates: ProjectTemplatesApi,
- *   tasks: TasksApi,
- *   testPlans: TestPlansApi,
- *   users: UsersApi,
- *   versionSets: VersionSetsApi,
- *   workPackages: WorkPackagesApi
- * }}
- */
-function createClient({ baseUrl, apiKey } = {}) {
-  const configuration = new Configuration({ baseUrl, apiKey });
-  const apiClient = new ApiClient(configuration);
-
-  return {
-    projects: new ProjectsApi(apiClient),
-    companies: new CompaniesApi(apiClient),
-    companyCatalog: new CompanyCatalogApi(apiClient),
-    fileAreas: new FileAreasApi(apiClient),
-    fileRevisions: new FileRevisionsApi(apiClient),
-    fileUpload: new FileUploadApi(apiClient),
-    files: new FilesApi(apiClient),
-    folders: new FoldersApi(apiClient),
-    forms: new FormsApi(apiClient),
-    inspectionPlans: new InspectionPlansApi(apiClient),
-    projectTemplates: new ProjectTemplatesApi(apiClient),
-    tasks: new TasksApi(apiClient),
-    testPlans: new TestPlansApi(apiClient),
-    users: new UsersApi(apiClient),
-    versionSets: new VersionSetsApi(apiClient),
-    workPackages: new WorkPackagesApi(apiClient),
-  };
-}
-
-module.exports = {
-  createClient,
-  Configuration,
-  ApiClient,
-  CompaniesApi,
-  CompanyCatalogApi,
-  FileAreasApi,
-  FileRevisionsApi,
-  FileUploadApi,
-  FilesApi,
-  FoldersApi,
-  FormsApi,
-  InspectionPlansApi,
-  ProjectTemplatesApi,
-  ProjectsApi,
-  TasksApi,
-  TestPlansApi,
-  UsersApi,
-  VersionSetsApi,
-  WorkPackagesApi,
-};
+'use strict';
+
+const Configuration = require('./configuration');
+const ApiClient = require('./apiClient');
+
+const CompaniesApi = require('./api/CompaniesApi');
+const CompanyCatalogApi = require('./api/CompanyCatalogApi');
+const FileAreasApi = require('./api/FileAreasApi');
+const FileRevisionsApi = require('./api/FileRevisionsApi');
+const FileUploadApi = require('./api/FileUploadApi');
+const FilesApi = require('./api/FilesApi');
+const FoldersApi = require('./api/FoldersApi');
+const FormsApi = require('./api/FormsApi');
+const InspectionPlansApi = require('./api/InspectionPlansApi');
+const ProjectTemplatesApi = require('./api/ProjectTemplatesApi');
+const ProjectsApi = require('./api/ProjectsApi');
+const TasksApi = require('./api/TasksApi');
+const TestPlansApi = require('./api/TestPlansApi');
+const UsersApi = require('./api/UsersApi');
+const VersionSetsApi = require('./api/VersionSetsApi');
+const WorkPackagesApi = require('./api/WorkPackagesApi');
+
+/**
+ * Create a fully configured Dalux Build API client.
+ *
+ * @param {object} options
+ * @param {string} options.baseUrl  - The API base URL (obtain from Dalux support)
+ * @param {string} options.apiKey  - Your X-API-KEY (manage via Dalux Settings › Integrations › API Identities)
+ * @returns {{
+ *   projects: ProjectsApi,
+ *   companies: CompaniesApi,
+ *   companyCatalog: CompanyCatalogApi,
+ *   fileAreas: FileAreasApi,
+ *   fileRevisions: FileRevisionsApi,
+ *   fileUpload: FileUploadApi,
+ *   files: FilesApi,
+ *   folders: FoldersApi,
+ *   forms: FormsApi,
+ *   inspectionPlans: InspectionPlansApi,
+ *   projectTemplates: ProjectTemplatesApi,
+ *   tasks: TasksApi,
+ *   testPlans: TestPlansApi,
+ *   users: UsersApi,
+ *   versionSets: VersionSetsApi,
+ *   workPackages: WorkPackagesApi
+ * }}
+ */
+function createClient({ baseUrl, apiKey } = {}) {
+  const configuration = new Configuration({ baseUrl, apiKey });
+  const apiClient = new ApiClient(configuration);
+
+  return {
+    projects: new ProjectsApi(apiClient),
+    companies: new CompaniesApi(apiClient),
+    companyCatalog: new CompanyCatalogApi(apiClient),
+    fileAreas: new FileAreasApi(apiClient),
+    fileRevisions: new FileRevisionsApi(apiClient),
+    fileUpload: new FileUploadApi(apiClient),
+    files: new FilesApi(apiClient),
+    folders: new FoldersApi(apiClient),
+    forms: new FormsApi(apiClient),
+    inspectionPlans: new InspectionPlansApi(apiClient),
+    projectTemplates: new ProjectTemplatesApi(apiClient),
+    tasks: new TasksApi(apiClient),
+    testPlans: new TestPlansApi(apiClient),
+    users: new UsersApi(apiClient),
+    versionSets: new VersionSetsApi(apiClient),
+    workPackages: new WorkPackagesApi(apiClient),
+  };
+}
+
+module.exports = {
+  createClient,
+  Configuration,
+  ApiClient,
+  CompaniesApi,
+  CompanyCatalogApi,
+  FileAreasApi,
+  FileRevisionsApi,
+  FileUploadApi,
+  FilesApi,
+  FoldersApi,
+  FormsApi,
+  InspectionPlansApi,
+  ProjectTemplatesApi,
+  ProjectsApi,
+  TasksApi,
+  TestPlansApi,
+  UsersApi,
+  VersionSetsApi,
+  WorkPackagesApi,
+};