@narrative.io/data-collaboration-sdk-ts 0.0.99 → 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/index.d.ts

@@ -26,8 +26,9 @@ import { AuthenticationApi, type LoginRequest, type LoginResponse, type Register
 import { AppsApi, type App } from './apps';
 import type { ForecastBody } from './nql/types';
 import { type ConversationMessageRole, isConversationMessageRole, type ConversationMessageName, isConversationMessageName, type ConversationUserMessage, isConversationUserMessage, type ConversationAssistantMessage, isConversationAssistantMessage, type ConversationSystemMessage, isConversationSystemMessage, type ConversationFunctionMessage, isConversationFunctionMessage, type ConversationMessage, isConversationMessage, type ConversationIOMessage, isConversationInputMessage, type ConversationMessages, isConversationMessages, isType, type RosettaRequestMessage, isRosettaRequestMessage, type ConversationMessageFunctionCall, isConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from './rosetta/types';
+import { MappingsApi } from './mappings';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall, type App, type Resource, type UploadsResponse, type PingStatus, type Attribute, type ShallowAttribute, type RefAttribute, type SubAttribute, type PrimitiveAttribute, type ArrayAttribute, type ObjectAttribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type Nql, type NqlField, type NqlResult, type NqlQueryInput, type NqlCompileResult, type NqlExpression, type NqlWhere, type NqlFilterExpression, type NqlBooleanExpression, type NqlFilterBinaryExpression, type NqlFilterUnaryExpression, type DataStream, type DataRules, type ColumnSet, type ColumnWithFilterAndExport, type AttributeSet, type ForecastRequest, type ForecastResponse, type CostForecastRequest, type CostForecastResponse, type JobState, type ContractDetails, type CustomerContract, type PaymentMethod, type ContractRateView, type LoginRequest, type LoginResponse, type RegisterRequest, type RegisterResponse, type LoggedInUser, type StytchToken, type ApiToken, type UserRole, type RegistrationStatus, type RegistrationStatusRequest, type RegistrationStatusResponse, type ForecastBody, type ConversationAssistantMessage, type ConversationFunctionMessage, type ConversationIOMessage, type ConversationMessage, type ConversationMessageName, type ConversationMessageRole, type ConversationMessages, type ConversationSystemMessage, type ConversationUserMessage, type RosettaRequestMessage, type ConversationMessageFunctionCall, type ConversationAssistantMessageWithFunctionCall, type RosettaResponseMessage, type ConversationAssistantMessageWithoutFunctionCall };

package/build/index.js

@@ -19,7 +19,8 @@ import { convertNqlObjectToForecastBody } from './nql/DataRulesConverter';
 import { AuthenticationApi } from './authentication';
 import { AppsApi } from './apps';
 import { isConversationMessageRole, isConversationMessageName, isConversationUserMessage, isConversationAssistantMessage, isConversationSystemMessage, isConversationFunctionMessage, isConversationMessage, isConversationInputMessage, isConversationMessages, isType, isRosettaRequestMessage, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isConversationAssistantMessageWithoutFunctionCall } from './rosetta/types';
+import { MappingsApi } from './mappings';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, getNqlObject, buildNql, convertNqlObjectToForecastBody, isConversationAssistantMessage, isConversationFunctionMessage, isConversationInputMessage, isConversationMessage, isConversationMessageName, isConversationMessageRole, isConversationMessages, isConversationSystemMessage, isConversationUserMessage, isType, isConversationMessageFunctionCall, isConversationAssistantMessageWithFunctionCall, isRosettaRequestMessage, isConversationAssistantMessageWithoutFunctionCall };

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.99",
+  "version": "0.0.101",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",