@narrative.io/data-collaboration-sdk-ts 0.0.100 → 0.0.101

package/build/base-api.d.ts

@@ -4,11 +4,11 @@ import { type Config } from './types';
  * BaseApi class provides basic functionality for making API requests.
  */
 export declare abstract class BaseApi {
-    private readonly apiKey?;
-    private readonly environment;
-    private readonly base_api;
-    private readonly headers;
-    private readonly verbose;
+    protected readonly apiKey?: string;
+    protected readonly environment: string;
+    protected readonly base_api: MandeInstance;
+    protected readonly headers: Record<string, string>;
+    protected readonly verbose: boolean;
     /**
        * @param {Config} config - Configuration object.
        * @param {string} [config.apiKey] - API key.

package/build/company-info/index.d.ts

@@ -6,7 +6,7 @@ import { type CompanyInfo, type WhoAmI } from './types';
  * @extends BaseApi
  */
 declare class CompanyInfoApi extends BaseApi {
-    companyId: () => Promise<number>;
+    companyId(): Promise<number>;
     /**
      * Get the logged in company id
      * @returns {Promise<WhoAmI>}

package/build/company-info/index.js

@@ -11,9 +11,9 @@ const resourceName = 'company-info';
  * @extends BaseApi
  */
 class CompanyInfoApi extends BaseApi {
-    companyId = async () => {
+    async companyId() {
         return (await this.get(`${resourceName}/whoami`)).id;
-    };
+    }
     /**
      * Get the logged in company id
      * @returns {Promise<WhoAmI>}

package/build/mappings/index.d.ts

@@ -1,21 +1,37 @@
-import { type ApiRecords } from 'src/types';
+import type { Config, ApiRecords } from 'src/types';
 import { BaseApi } from '../base-api';
 import type { CreateMapping, Mapping } from './types';
+import { CompanyInfoApi } from '../company-info';
 /**
  * A class for accessing the Mappings API.
  * @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.
    */
     getMappings(): Promise<ApiRecords<Mapping>>;
     /**
-   * Creates a new mapping.
+   * Creates a private (specific to a company) mapping between a dataset and an attribute.
+   *
    * @param {CreateMapping} mapping - The mapping to be created.
-   * @return {Promise<Mapping>} Promise object represents the newly created mapping.
+   * @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.
+   * @public
+   * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
+   * @async
    */
-    createMapping(mapping: CreateMapping): Promise<Mapping>;
+    createPrivateMapping(mapping: CreateMapping, companyId?: number): Promise<Mapping>;
+    /**
+     * Retrieves the company ID from the API.
+     *
+     * @returns {Promise<number | undefined>} - A promise that resolves to the company ID.
+     * @private
+     * @async
+     */
+    private getCompanyId;
 }
 export { type Mapping, MappingsApi, type CreateMapping };

package/build/mappings/index.js

@@ -1,4 +1,5 @@
 import { BaseApi } from '../base-api';
+import { CompanyInfoApi } from '../company-info';
 /**
  * The name of the resource to be used in API requests.
  * @constant
@@ -11,6 +12,19 @@ const resourceName = 'mappings';
  * @extends BaseApi
  */
 class MappingsApi extends BaseApi {
+    companyInfoApi;
+    constructor(config, companyInfoApi) {
+        super(config);
+        this.companyInfoApi = companyInfoApi;
+        if (companyInfoApi === undefined) {
+            this.companyInfoApi = new CompanyInfoApi({
+                apiKey: this.apiKey,
+                environment: this.environment,
+                verbose: this.verbose,
+                headers: this.headers
+            });
+        }
+    }
     /**
    * Fetches all mappings.
    * @return {Promise<ApiRecords<Mapping>>} Promise object represents the API records of mappings.
@@ -19,12 +33,31 @@ class MappingsApi extends BaseApi {
         return await this.get(resourceName);
     }
     /**
-   * Creates a new mapping.
+   * Creates a private (specific to a company) mapping between a dataset and an attribute.
+   *
    * @param {CreateMapping} mapping - The mapping to be created.
-   * @return {Promise<Mapping>} Promise object represents the newly created mapping.
+   * @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.
+   * @public
+   * @throws {Error} - If the company ID is undefined and cannot be fetched from the API.
+   * @async
    */
-    async createMapping(mapping) {
-        return await this.post(resourceName, mapping);
+    async createPrivateMapping(mapping, companyId) {
+        companyId = companyId ?? await this.getCompanyId();
+        if (companyId === undefined)
+            throw new Error('Company ID is undefined');
+        const resource = `${resourceName}/companies/${companyId}`;
+        return await this.post(resource, mapping);
+    }
+    /**
+     * Retrieves the company ID from the API.
+     *
+     * @returns {Promise<number | undefined>} - A promise that resolves to the company ID.
+     * @private
+     * @async
+     */
+    async getCompanyId() {
+        return await this.companyInfoApi?.companyId();
     }
 }
 export { MappingsApi };

package/package.json

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