@narrative.io/data-collaboration-sdk-ts 0.0.104 → 0.0.106

package/build/datasets/index.d.ts

@@ -1,6 +1,6 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics, RetentionPolicy } from './types';
+import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics, RetentionPolicy, DatasetTableSummary } from './types';
 export { type FilePerSnapshotResponse, type Dataset, type RetentionPolicy, type DatasetTableSummaryAPIResponse, type ColumnStatistics };
 /**
  * @module DatasetApi
@@ -82,6 +82,16 @@ export declare class DatasetApi extends BaseApi {
    */
     getColumnStats(datasetId: number): Promise<ColumnStatistics>;
     /**
+   * Fetches the summary statistics for a given dataset.
+   *
+   * @param {number} datasetId - The ID of the dataset to fetch summary statistics for.
+   * @returns {Promise<ApiRecords<DatasetTableSummary>>} A Promise that resolves with an object containing the dataset summary statistics.
+   * @throws {Error} If there is an issue with the request or the response.
+   * @memberof DatasetApi
+   * @public
+   */
+    getStatistics(datasetId: number, offset?: number, size?: number): Promise<ApiRecords<DatasetTableSummary>>;
+    /**
    * Updates the retention policy of a specific dataset.
    *
    * @param {number} datasetId - The ID of the dataset to update the retention policy for.

package/build/datasets/index.js

@@ -101,6 +101,18 @@ export class DatasetApi extends BaseApi {
         return await this.get(`${resourceName}/${datasetId}/column-stats`);
     }
     /**
+   * Fetches the summary statistics for a given dataset.
+   *
+   * @param {number} datasetId - The ID of the dataset to fetch summary statistics for.
+   * @returns {Promise<ApiRecords<DatasetTableSummary>>} A Promise that resolves with an object containing the dataset summary statistics.
+   * @throws {Error} If there is an issue with the request or the response.
+   * @memberof DatasetApi
+   * @public
+   */
+    async getStatistics(datasetId, offset = 0, size = 1000) {
+        return await this.get(`${resourceName}/${datasetId}/stats?offset=${offset}&per_page=${size}`);
+    }
+    /**
    * Updates the retention policy of a specific dataset.
    *
    * @param {number} datasetId - The ID of the dataset to update the retention policy for.

package/build/index.d.ts

@@ -29,6 +29,6 @@ import { type ConversationMessageRole, isConversationMessageRole, type Conversat
 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, MappingsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AppsApi {
 }
 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, type RetentionPolicy };

package/build/index.js

@@ -22,5 +22,5 @@ import { isConversationMessageRole, isConversationMessageName, isConversationUse
 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, MappingsApi]);
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi, NqlApi, DataStreamsApi, ForecastApi, ContractsApi, AuthenticationApi, MappingsApi, AppsApi]);
 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/nql/DataRulesConverter.js

@@ -81,7 +81,6 @@ function ensureAtLeastOneRequired(dataRulesAttributes) {
  * @throws {Error} - Throws an error if price filter conditions are not met.
  */
 function getPriceFromNql(nqlObject) {
-    console.log('yyy', JSON.stringify(nqlObject.where.filterExpressions));
     const priceFilter = nqlObject.where.filterExpressions.filter((expr) => ('left' in expr && typeof expr.left === 'object' && expr.left.field === '_price_cpm_usd') || ('right' in expr && typeof expr.right === 'object' && expr.right.field === '_price_cpm_usd'));
     if (priceFilter.length !== 1) {
         throw new Error('Expected exactly one price filter');

package/package.json

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