@narrative.io/data-collaboration-sdk-ts 0.0.11 → 0.0.12

package/build/datasets/index.d.ts

@@ -1,6 +1,6 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import { type Dataset } from './types';
+import { type DatasetTableSummary, type Dataset } from './types';
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -18,4 +18,14 @@ export declare class DatasetApi extends BaseApi {
      * @returns {Promise<ApiRecords<Dataset>>} - Promise resolving to an array of datasets
      */
     getDatasets(): Promise<ApiRecords<Dataset>>;
+    /**
+     * Get summary information for a dataset.
+     *
+     * @param {number} datasetId - The ID of the dataset to get summary information for.
+     * @param {boolean} [allRecords=false] - If `true`, all records in the dataset will be returned. If `false`, only a limited number of records will be returned.
+     * @param {number} [perPage=100] - The number of records to return per page.
+     * @param {number} [offset=0] - The offset to start returning records from.
+     * @returns {Promise<ApiRecords<DatasetTableSummary>>} A promise that resolves with the dataset summary information.
+     */
+    getDatasetSummary(datasetId: number, allRecords?: boolean, perPage?: number, offset?: number): Promise<ApiRecords<DatasetTableSummary>>;
 }

package/build/datasets/index.js

@@ -21,4 +21,16 @@ export class DatasetApi extends BaseApi {
     async getDatasets() {
         return await this.get(`${resourceName}`);
     }
+    /**
+     * Get summary information for a dataset.
+     *
+     * @param {number} datasetId - The ID of the dataset to get summary information for.
+     * @param {boolean} [allRecords=false] - If `true`, all records in the dataset will be returned. If `false`, only a limited number of records will be returned.
+     * @param {number} [perPage=100] - The number of records to return per page.
+     * @param {number} [offset=0] - The offset to start returning records from.
+     * @returns {Promise<ApiRecords<DatasetTableSummary>>} A promise that resolves with the dataset summary information.
+     */
+    async getDatasetSummary(datasetId, allRecords = false, perPage = 100, offset = 0) {
+        return await this.get(`${resourceName}/${datasetId}/stats?all_records=${String(allRecords)}&per_page=${perPage}&offset=${offset}`);
+    }
 }

package/build/datasets/types.d.ts

@@ -11,6 +11,35 @@ export interface Dataset {
     updated_at: Date;
     write_mode: DatasetWriteMode;
 }
+export interface DatasetColumnSummary {
+    id: number;
+    name: string;
+    type: string;
+    nan_value_count?: number;
+    null_value_count?: number;
+    value_count?: number;
+    lower_bound?: any;
+    upper_bound?: any;
+    column_stored_bytes?: number;
+}
+export interface DatasetTableSummary {
+    snapshot_id: number;
+    est_total_dataset_stored_files: number;
+    est_total_dataset_stored_records: number;
+    est_total_dataset_stored_bytes: number;
+    active_dataset_stored_files: number;
+    active_dataset_stored_records: number;
+    active_dataset_stored_bytes: number;
+    snapshot_added_files: number;
+    snapshot_added_records: number;
+    snapshot_deleted_records: number;
+    snapshot_added_bytes: number;
+    snapshot_deleted_files: number;
+    snapshot_added_delete_files: number;
+    snapshot_removed_delete_files: number;
+    snapshot_removed_bytes: number;
+    column_sumary: DatasetColumnSummary[];
+}
 type SchemaFileConfigType = 'flat';
 type SchemaPropertiesType = 'string' | 'number' | 'boolean';
 type DatasetStatus = 'active' | 'archived';

package/build/index.d.ts

@@ -3,11 +3,11 @@ import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { type Environment, type Config, type ApiRecords } from './types';
-import { type Dataset } from './datasets/types';
+import { type Dataset, type DatasetTableSummary } from './datasets/types';
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
 declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi {
 }
-export { NarrativeApi, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords };
+export { NarrativeApi, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary };

package/package.json

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