@narrative.io/data-collaboration-sdk-ts 0.5.0 → 0.6.0

package/build/mappings/index.d.ts

@@ -3,30 +3,58 @@ import { BaseApi } from "../base-api";
 import type { CreateMapping, Mapping, MappingTestResult, MappingTestResults } from "./types";
 import { CompanyInfoApi } from "../company-info";
 /**
- * A class for accessing the Mappings API.
+ * Class representing the Mappings API.
+ * Extends the BaseApi to provide functionalities specific to mappings.
  * @extends BaseApi
  */
 declare class MappingsApi extends BaseApi {
     private readonly companyInfoApi?;
     constructor(config: Config, companyInfoApi?: CompanyInfoApi | undefined);
     /**
-     * Fetches all mappings.
-     * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
+     * Retrieves all mappings.
+     *
+     * @returns {Promise<ApiRecords<Mapping>>} A promise that resolves to a collection of Mapping records.
+     * @public
+     * @async
      */
     getMappings(): Promise<ApiRecords<Mapping>>;
     /**
-     * Creates a private (specific to a company) mapping between a dataset and an attribute.
+     * Creates a new mapping specific to a company.
      *
-     * @param {CreateMapping} mapping - The mapping to be created.
-     * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
-     * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
+     * @param {CreateMapping} mapping - The mapping configuration to be created.
+     * @param {number} [companyId] - Optional company ID. If not provided, it will be fetched from the API.
+     * @returns {Promise<Mapping>} A promise that resolves to the created mapping.
      * @public
-     * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
      * @async
+     * @throws {Error} Throws an error if the company ID is undefined and cannot be fetched.
      */
     createPrivateMapping(mapping: CreateMapping, companyId?: number): Promise<Mapping>;
+    /**
+     * Tests a mapping configuration and returns the results.
+     *
+     * @param {CreateMapping} mapping - The mapping configuration to test.
+     * @returns {Promise<MappingTestResults>} A promise that resolves to the test results of the mapping.
+     * @public
+     * @async
+     */
     testMapping(mapping: CreateMapping): Promise<MappingTestResults>;
+    /**
+     * Previews a sample of the mapping results.
+     *
+     * @param {string} mappingId - The ID of the mapping to preview.
+     * @returns {Promise<MappingTestResults>} A promise that resolves to the sample test results of the mapping.
+     * @public
+     * @async
+     */
     previewMapping(mappingId: string): Promise<MappingTestResults>;
+    /**
+     * Deletes a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to delete.
+     * @returns {Promise<void>} A promise that resolves when the mapping is successfully deleted.
+     * @public
+     * @async
+     */
     deleteMapping(mappingId: string): Promise<void>;
     /**
      * Retrieves the company ID from the API.
@@ -36,8 +64,42 @@ declare class MappingsApi extends BaseApi {
      * @async
      */
     private getCompanyId;
+    /**
+     * Accepts a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to accept.
+     * @returns {Promise<void>} A promise that resolves when the mapping is accepted.
+     * @public
+     * @async
+     */
     acceptMapping(mappingId: string): Promise<void>;
+    /**
+     * Rejects a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to reject.
+     * @returns {Promise<void>} A promise that resolves when the mapping is rejected.
+     * @public
+     * @async
+     */
     rejectMapping(mappingId: string): Promise<void>;
+    /**
+     * Updates a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to update.
+     * @param {CreateMapping} mapping - The mapping configuration to update.
+     * @returns {Promise<Mapping>} A promise that resolves to the updated mapping.
+     * @public
+     * @async
+     */
     updateMapping(mappingId: string, mapping: Pick<CreateMapping, "mapping">): Promise<Mapping>;
+    /**
+     * Retrieves a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to retrieve.
+     * @returns {Promise<Mapping>} A promise that resolves to the retrieved mapping.
+     * @public
+     * @async
+     */
+    getMapping(mappingId: string): Promise<Mapping>;
 }
 export { type Mapping, MappingsApi, type CreateMapping, type MappingTestResult, type MappingTestResults, };

package/build/mappings/index.js

@@ -8,7 +8,8 @@ import { CompanyInfoApi } from "../company-info";
  */
 const resourceName = "mappings";
 /**
- * A class for accessing the Mappings API.
+ * Class representing the Mappings API.
+ * Extends the BaseApi to provide functionalities specific to mappings.
  * @extends BaseApi
  */
 class MappingsApi extends BaseApi {
@@ -26,21 +27,24 @@ class MappingsApi extends BaseApi {
         }
     }
     /**
-     * Fetches all mappings.
-     * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
+     * Retrieves all mappings.
+     *
+     * @returns {Promise<ApiRecords<Mapping>>} A promise that resolves to a collection of Mapping records.
+     * @public
+     * @async
      */
     async getMappings() {
         return await this.get(resourceName);
     }
     /**
-     * Creates a private (specific to a company) mapping between a dataset and an attribute.
+     * Creates a new mapping specific to a company.
      *
-     * @param {CreateMapping} mapping - The mapping to be created.
-     * @param {number} [companyId] - The ID of the company. If not provided, will be fetched from the API.
-     * @returns {Promise<Mapping>} - A promise that resolves to the created mapping.
+     * @param {CreateMapping} mapping - The mapping configuration to be created.
+     * @param {number} [companyId] - Optional company ID. If not provided, it will be fetched from the API.
+     * @returns {Promise<Mapping>} A promise that resolves to the created mapping.
      * @public
-     * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
      * @async
+     * @throws {Error} Throws an error if the company ID is undefined and cannot be fetched.
      */
     async createPrivateMapping(mapping, companyId) {
         companyId = companyId ?? (await this.getCompanyId());
@@ -49,12 +53,36 @@ class MappingsApi extends BaseApi {
         const resource = `${resourceName}/companies/${companyId}`;
         return await this.post(resource, mapping);
     }
+    /**
+     * Tests a mapping configuration and returns the results.
+     *
+     * @param {CreateMapping} mapping - The mapping configuration to test.
+     * @returns {Promise<MappingTestResults>} A promise that resolves to the test results of the mapping.
+     * @public
+     * @async
+     */
     async testMapping(mapping) {
         return await this.post(`${resourceName}/test`, mapping);
     }
+    /**
+     * Previews a sample of the mapping results.
+     *
+     * @param {string} mappingId - The ID of the mapping to preview.
+     * @returns {Promise<MappingTestResults>} A promise that resolves to the sample test results of the mapping.
+     * @public
+     * @async
+     */
     async previewMapping(mappingId) {
         return await this.get(`${resourceName}/${mappingId}/sample`);
     }
+    /**
+     * Deletes a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to delete.
+     * @returns {Promise<void>} A promise that resolves when the mapping is successfully deleted.
+     * @public
+     * @async
+     */
     async deleteMapping(mappingId) {
         await this.delete(`${resourceName}/${mappingId}`);
     }
@@ -68,14 +96,50 @@ class MappingsApi extends BaseApi {
     async getCompanyId() {
         return await this.companyInfoApi?.companyId();
     }
+    /**
+     * Accepts a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to accept.
+     * @returns {Promise<void>} A promise that resolves when the mapping is accepted.
+     * @public
+     * @async
+     */
     async acceptMapping(mappingId) {
         await this.post(`${resourceName}/${mappingId}/accept`);
     }
+    /**
+     * Rejects a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to reject.
+     * @returns {Promise<void>} A promise that resolves when the mapping is rejected.
+     * @public
+     * @async
+     */
     async rejectMapping(mappingId) {
         await this.post(`${resourceName}/${mappingId}/reject`);
     }
+    /**
+     * Updates a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to update.
+     * @param {CreateMapping} mapping - The mapping configuration to update.
+     * @returns {Promise<Mapping>} A promise that resolves to the updated mapping.
+     * @public
+     * @async
+     */
     async updateMapping(mappingId, mapping) {
         return await this.put(`${resourceName}/${mappingId}`, mapping);
     }
+    /**
+     * Retrieves a mapping.
+     *
+     * @param {string} mappingId - The ID of the mapping to retrieve.
+     * @returns {Promise<Mapping>} A promise that resolves to the retrieved mapping.
+     * @public
+     * @async
+     */
+    async getMapping(mappingId) {
+        return await this.get(`${resourceName}/${mappingId}`);
+    }
 }
 export { MappingsApi, };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.5.0",
+  "version": "0.6.0",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",