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

package/build/base-api.d.ts

@@ -87,4 +87,5 @@ export declare abstract class BaseApi {
      * @private
      */
     private constructHeaders;
+    constructQueryString<T extends Record<string, number | string | boolean | undefined>>(parameters?: T): string;
 }

package/build/base-api.js

@@ -151,4 +151,18 @@ export class BaseApi {
         }
         return headers;
     }
+    constructQueryString(parameters) {
+        const queryParameters = [];
+        if (parameters !== undefined) {
+            Object.keys(parameters)
+                .filter((key) => key in parameters)
+                .forEach((key) => queryParameters.push({ [key]: String(parameters[key]) }));
+        }
+        const queryString = queryParameters.length > 0
+            ? queryParameters
+                .map((param) => Object.entries(param).map(([key, value]) => `${key}=${value}`))
+                .join("&")
+            : "";
+        return queryString.length > 0 ? `?${queryString}` : "";
+    }
 }

package/build/index.d.ts

@@ -31,11 +31,11 @@ import { MappingsApi, type Mapping, type MappingTestResult } from "./mappings";
 import type { ValueMapping, ObjectMapping, CreateMapping } from "./mappings/types";
 import { type AccessRule, AccessRulesApi } from "./access-rules/";
 import { type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, SubscriptionsApi } from "./subscriptions";
-import { type Job, JobsApi } from "./jobs";
+import { type Job, type GetJobsParameters, JobsApi } from "./jobs";
 import { WhoAmIApi } from "./whoami";
 import { ConnectionsApi, type Connection } from "./connections";
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AccessRulesApi, AppsApi, SubscriptionsApi, JobsApi, WhoAmIApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, 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 Connection, 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 UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, 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, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, compileStatement, parseStatement, };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, ConnectionsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, AppsApi, MappingsApi, AccessRulesApi, SubscriptionsApi, JobsApi, WhoAmIApi, 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 Connection, 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 UpdateDatasetRequest, type SchemaFileConfigType, type SchemaPropertiesType, type DatasetStatus, type DatasetWriteMode, type SchemaFileConfig, type SchemaProperties, type SchemaProperty, type SchemaPrimitiveProperty, type SchemaObjectProperty, type SchemaArrayProperty, type SchemaArrayItems, type SchemaArrayItemsPrimitive, type SchemaArrayItemsObject, type SchemaArrayItemsArray, type Schema, type AdvancedStatisticsMetadata, type SnapshotRange, type Configuration, type Columns, type ColumnSummary, type ColumnStatistics, type BasicStatistics, type AdvancedStatistics, type Histogram, type Value, type CreateDatasetRequest, type IngestDatasetFileRequest, type Product, type MonetaryAmount, type CompanyInfo, type Installation, type Profile, type FilePerSnapshotResponse, type BucketCreationRequest, type UpdateAccessTypeRequest, type CompiledNql, type CreateMaterializedView, type GetJobsParameters, type Deduplication, type Explain, type Expression, type Raw, type Select, type Statement, type Table, type Nql, type NqlAst, 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, type RetentionPolicy, type AccessRule, type Subscription, type SubscriptionDetails, type DataStreamSubscriptionDetails, type MarketplaceSubscriptionDetails, type SubscriptionOutput, type SubscriptionType, type SubscriptionStatus, type SubscriptionBudget, type Job, type User, type Mapping, type MappingTestResult, type ValueMapping, type ObjectMapping, type CreateMapping, compileStatement, parseStatement, };

package/build/jobs/index.d.ts

@@ -1,6 +1,11 @@
 import { type ApiRecords } from "../types";
 import { BaseApi } from "../base-api";
 import { type Job } from "./types";
+interface GetJobsParameters extends Record<string, string | number | boolean | undefined> {
+    dataset_id?: number;
+    per_page?: number;
+    offset?: number;
+}
 /**
  * @module JobsApi
  * @description This module provides methods for fetching jobs records.
@@ -11,11 +16,11 @@ declare class JobsApi extends BaseApi {
      * Get all jobs for the current company
      * @returns {Promise<ApiRecords<Job>>} - Promise resolving with the list of jobs.
      */
-    getJobs(): Promise<ApiRecords<Job>>;
+    getJobs(parameters?: GetJobsParameters): Promise<ApiRecords<Job>>;
     /**
      * Get a specific job by id
      * @returns {Promise<Job>} - Promise resolving with the job.
      */
     getJob(jobId: string): Promise<Job>;
 }
-export { type Job, JobsApi };
+export { type Job, JobsApi, type GetJobsParameters };

package/build/jobs/index.js

@@ -10,8 +10,9 @@ class JobsApi extends BaseApi {
      * Get all jobs for the current company
      * @returns {Promise<ApiRecords<Job>>} - Promise resolving with the list of jobs.
      */
-    async getJobs() {
-        return await this.get(resourceName);
+    async getJobs(parameters) {
+        const queryString = this.constructQueryString(parameters);
+        return await this.get(`${resourceName}${queryString}`);
     }
     /**
      * Get a specific job by id

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.7.0",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -28,7 +28,7 @@
     "@types/jest": "^29.5.0",
     "babel-jest": "^29.4.3",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-config-standard-with-typescript": "^42.0.0",
+    "eslint-config-standard-with-typescript": "^43.0.0",
     "eslint-plugin-prettier": "^5.0.0",
     "husky": "^8.0.0",
     "jest": "^29.4.3",