@narrative.io/data-collaboration-sdk-ts 0.0.96 → 0.0.98

package/build/authentication/types.d.ts

@@ -46,6 +46,7 @@ export interface RegistrationStatusRequest {
 }
 export interface RegistrationStatusResponse {
     status: RegistrationStatus;
+    email: string;
     stytch_session_token: string;
     stytch_session_jwt: string;
 }

package/build/datasets/index.d.ts

@@ -1,7 +1,7 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse } from './types';
-export { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse };
+import type { FilePerSnapshotResponse, Dataset, DatasetTableSummaryAPIResponse, ColumnStatistics } from './types';
+export { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse, type ColumnStatistics };
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -71,4 +71,5 @@ export declare class DatasetApi extends BaseApi {
     getDatasetFileDownloadUrl(datasetId: number, snapshotId: number, fileId: string): Promise<{
         download_url: string;
     }>;
+    getColumnStats(datasetId: number): Promise<ColumnStatistics>;
 }

package/build/datasets/index.js

@@ -88,4 +88,7 @@ export class DatasetApi extends BaseApi {
     async getDatasetFileDownloadUrl(datasetId, snapshotId, fileId) {
         return await this.post(`${resourceName}/${datasetId}/snapshots/${snapshotId}/files-added/${fileId}/download`);
     }
+    async getColumnStats(datasetId) {
+        return await this.get(`${resourceName}/${datasetId}/column-stats`);
+    }
 }

package/build/datasets/types.d.ts

@@ -41,7 +41,7 @@ export interface DatasetTableSummary {
     snapshot_added_delete_files: number;
     snapshot_removed_delete_files: number;
     snapshot_removed_bytes: number;
-    column_sumary: DatasetColumnSummary[];
+    column_summary: DatasetColumnSummary[];
 }
 export interface DatasetTableSummaryAPIResponse {
     dataset_id: number;
@@ -96,4 +96,61 @@ export interface FilePerSnapshotResponse {
     has_next: boolean;
     next_snapshot: number | null;
 }
+export interface ColumnStatistics {
+    advanced_statistics_metadata: AdvancedStatisticsMetadata;
+    columns_summary: ColumnSummary[];
+}
+interface AdvancedStatisticsMetadata {
+    snapshot_range: SnapshotRange;
+    configuration: Configuration;
+}
+interface SnapshotRange {
+    from_snapshot: string;
+    until_snapshot: string;
+    from_snapshot_timestamp: string;
+    until_snapshot_timestamp: string;
+}
+interface Configuration {
+    value_histogram: Columns;
+    completeness: Columns;
+    approx_count_distinct: Columns;
+    count_distinct: Columns;
+    observed_types_histogram: Columns;
+    mean: Columns;
+    deviation: Columns;
+}
+interface Columns {
+    columns: string[];
+}
+interface ColumnSummary {
+    name: string;
+    type: string;
+    basic_statistics: BasicStatistics;
+    advanced_statistics: AdvancedStatistics;
+}
+interface BasicStatistics {
+    nan_value_count: number | null;
+    null_value_count: number;
+    lower_bound: string | number;
+    upper_bound: string | number;
+    value_count: number;
+    column_store_bytes: number;
+}
+interface AdvancedStatistics {
+    approx_count_distinct: number | null;
+    count_distinct: null;
+    histogram: Histogram | null;
+    mean: number | null;
+    standard_deviation: number | null;
+    completeness: number;
+    observed_types: Histogram | null;
+}
+interface Histogram {
+    values: Record<string, Value>;
+    number_of_bins: number;
+}
+interface Value {
+    absolute: number;
+    ratio: number;
+}
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.96",
+  "version": "0.0.98",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -27,7 +27,7 @@
     "@commitlint/config-conventional": "^17.4.2",
     "@types/jest": "^29.5.0",
     "babel-jest": "^29.4.3",
-    "eslint-config-standard-with-typescript": "^36.0.0",
+    "eslint-config-standard-with-typescript": "^37.0.0",
     "husky": "^8.0.0",
     "jest": "^29.4.3",
     "ts-jest": "^29.0.5"