@narrative.io/data-collaboration-sdk-ts 2.94.1 → 2.95.0

package/build/data-planes/types.d.ts

@@ -15,7 +15,7 @@ export interface DataPlanePlatform {
     region: DataPlanePlatformRegion;
 }
 export interface DataPlaneCollaborators {
-    use: Participants;
+    participants: Participants;
 }
 export interface DataPlane {
     type: DataPlaneType;

package/build/datasets/index.d.ts

@@ -1,8 +1,10 @@
 import type { UnknownJob } from "src/jobs/types";
 import { BaseApi } from "../base-api";
 import type { ApiRecords } from "../types";
-import type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetStatus, DatasetTableSummary, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, Histogram, IngestDatasetFileRequest, RecalculationInfo, RetentionPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotRange, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, Value } from "./types";
-export type { FilePerSnapshotResponse, Dataset, RetentionPolicy, DatasetTableSummaryAPIResponse, ColumnStatistics, UpdateDatasetRequest, SchemaFileConfigType, SchemaPropertiesType, DatasetStatus, DatasetWriteMode, SchemaFileConfig, SchemaProperties, SchemaProperty, SchemaPrimitiveProperty, SchemaObjectProperty, SchemaArrayProperty, SchemaArrayItems, SchemaArrayItemsPrimitive, SchemaArrayItemsObject, SchemaArrayItemsArray, Schema, AdvancedStatisticsMetadata, SnapshotRange, Configuration, Columns, ColumnSummary, BasicStatistics, AdvancedStatistics, Histogram, Value, CreateDatasetRequest, UpdateDatasetRefreshScheduleRequest, CreateDatasetRefreshScheduleRequest, };
+import type { DatasetStatisticsConfiguration, StatisticsConfigurationResponse } from "./statistics-types";
+import type { AdvancedStatistics, AdvancedStatisticsMetadata, BasicStatistics, ColumnStatistics, ColumnSummary, Columns, Configuration, CreateDatasetRefreshScheduleRequest, CreateDatasetRequest, Dataset, DatasetStatus, DatasetTableSummary, DatasetTableSummaryAPIResponse, DatasetWriteMode, FilePerSnapshotResponse, Histogram, IngestDatasetFileRequest, RecalculationInfo, RetentionPolicy, RetentionScheduleConfig, RowClock, RowTTLPolicy, Schema, SchemaArrayItems, SchemaArrayItemsArray, SchemaArrayItemsObject, SchemaArrayItemsPrimitive, SchemaArrayProperty, SchemaFileConfig, SchemaFileConfigType, SchemaObjectProperty, SchemaPrimitiveProperty, SchemaProperties, SchemaPropertiesType, SchemaProperty, SnapshotAgeExpression, SnapshotRange, SnapshotTTLPolicy, TableClock, TableClockKind, TableTTLPolicy, TTLPolicy, TTLPolicyKind, UpdateDatasetRefreshScheduleRequest, UpdateDatasetRequest, UpsertRetentionPoliciesRequest, Value } from "./types";
+export type { FilePerSnapshotResponse, Dataset, RetentionPolicy, RetentionScheduleConfig, RowClock, RowTTLPolicy, SnapshotAgeExpression, SnapshotTTLPolicy, TTLPolicy, TTLPolicyKind, TableClock, TableClockKind, TableTTLPolicy, UpsertRetentionPoliciesRequest, DatasetTableSummaryAPIResponse, ColumnStatistics, UpdateDatasetRequest, SchemaFileConfigType, SchemaPropertiesType, DatasetStatus, DatasetWriteMode, SchemaFileConfig, SchemaProperties, SchemaProperty, SchemaPrimitiveProperty, SchemaObjectProperty, SchemaArrayProperty, SchemaArrayItems, SchemaArrayItemsPrimitive, SchemaArrayItemsObject, SchemaArrayItemsArray, Schema, AdvancedStatisticsMetadata, SnapshotRange, Configuration, Columns, ColumnSummary, BasicStatistics, AdvancedStatistics, Histogram, Value, CreateDatasetRequest, UpdateDatasetRefreshScheduleRequest, CreateDatasetRefreshScheduleRequest, };
+export type { CronRefresh, DatasetFieldConfig, DatasetFieldNamespace, DatasetStatisticsConfiguration, HistogramOptions, HistogramOverflow, ManualRefresh, NestedNodeConfig, NestedPropertyConfig, NonPrimitiveNodeConfig, OnUpdateRefresh, PrimitiveNodeConfig, RefreshTrigger, RosettaStoneFieldConfig, RosettaStoneFieldNamespace, StatConfig, StatisticsConfigurationResponse, StatName, StatOptions, } from "./statistics-types";
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -166,6 +168,8 @@ export declare class DatasetApi extends BaseApi {
      * @public
      */
     updateRetentionPolicy(datasetId: number, policy: RetentionPolicy): Promise<Dataset>;
+    upsertRetentionPolicies(datasetId: number, request: UpsertRetentionPoliciesRequest): Promise<Dataset>;
+    disableDatasetRetentionPolicy(datasetId: number, policy: TTLPolicy): Promise<Dataset>;
     /**
      * Configures the statistics for a specific dataset column.
      * This method sends a PUT request to the specified endpoint to update the statistics configuration.
@@ -190,7 +194,9 @@ export declare class DatasetApi extends BaseApi {
      * @throws {Error} If there is an issue with the request or the response.
      * @memberof DatasetApi
      */
-    requestDatasetSample(datasetId: number): Promise<{
+    requestDatasetSample(datasetId: number, request?: {
+        compute_pool_id?: string;
+    }): Promise<{
         job_id: string;
     }>;
     /**
@@ -215,4 +221,7 @@ export declare class DatasetApi extends BaseApi {
     createDatasetRefreshSchedule(datasetId: number, refreshSchedule: CreateDatasetRefreshScheduleRequest): Promise<void>;
     updateDatasetRefreshSchedule(datasetId: number, refreshSchedule: UpdateDatasetRefreshScheduleRequest): Promise<void>;
     deleteDatasetRefreshSchedule(datasetId: number): Promise<void>;
+    putStatisticsConfiguration(datasetId: number, configuration: DatasetStatisticsConfiguration): Promise<StatisticsConfigurationResponse>;
+    getStatisticsConfiguration(datasetId: number): Promise<StatisticsConfigurationResponse>;
+    deleteStatisticsConfiguration(datasetId: number): Promise<StatisticsConfigurationResponse>;
 }

package/build/datasets/index.js

@@ -221,6 +221,14 @@ export class DatasetApi extends BaseApi {
     async updateRetentionPolicy(datasetId, policy) {
         return await this.put(`${resourceName}/${datasetId}/retention-policy`, policy);
     }
+    async upsertRetentionPolicies(datasetId, request) {
+        return await this.put(`${resourceName}/${datasetId}/retention-policy`, request);
+    }
+    async disableDatasetRetentionPolicy(datasetId, policy) {
+        return await this.upsertRetentionPolicies(datasetId, {
+            policies: [{ ...policy, enabled: false }],
+        });
+    }
     /**
      * Configures the statistics for a specific dataset column.
      * This method sends a PUT request to the specified endpoint to update the statistics configuration.
@@ -249,8 +257,8 @@ export class DatasetApi extends BaseApi {
      * @throws {Error} If there is an issue with the request or the response.
      * @memberof DatasetApi
      */
-    async requestDatasetSample(datasetId) {
-        return await this.post(`${resourceName}/${datasetId}/request-sample`);
+    async requestDatasetSample(datasetId, request) {
+        return await this.post(`${resourceName}/${datasetId}/request-sample`, request);
     }
     /**
      * Deletes a sample of a specified dataset by its ID.
@@ -287,4 +295,13 @@ export class DatasetApi extends BaseApi {
     async deleteDatasetRefreshSchedule(datasetId) {
         await this.delete(`${resourceName}/${datasetId}/refresh-schedule`);
     }
+    async putStatisticsConfiguration(datasetId, configuration) {
+        return await this.put(`${resourceName}/${datasetId}/statistics-configuration`, configuration);
+    }
+    async getStatisticsConfiguration(datasetId) {
+        return await this.get(`${resourceName}/${datasetId}/statistics-configuration`);
+    }
+    async deleteStatisticsConfiguration(datasetId) {
+        return await this.base_api.delete(`${resourceName}/${datasetId}/statistics-configuration`);
+    }
 }

package/build/datasets/statistics-types.d.ts

@@ -0,0 +1,81 @@
+export type StatName = "value_count" | "null_value_count" | "nan_value_count" | "lower_bound" | "upper_bound" | "approx_count_distinct" | "count_distinct" | "histogram" | "mean" | "standard_deviation" | "completeness";
+export type HistogramOverflow = "none" | "truncate";
+export interface HistogramOptions {
+    max_bins?: number;
+    overflow?: HistogramOverflow;
+}
+export interface StatOptions {
+    histogram?: HistogramOptions;
+}
+export type StatConfig = {
+    enabled_stats: StatName[];
+    stat_options?: StatOptions;
+} | {
+    enabled_stats?: StatName[];
+    stat_options: StatOptions;
+} | {
+    enabled_stats: StatName[];
+    stat_options: StatOptions;
+};
+export interface CronRefresh {
+    trigger: "cron";
+    cron_expression: string;
+}
+export interface OnUpdateRefresh {
+    trigger: "on_update";
+}
+export interface ManualRefresh {
+    trigger: "manual";
+}
+export type RefreshTrigger = CronRefresh | OnUpdateRefresh | ManualRefresh;
+export interface PrimitiveNodeConfig {
+    enabled_stats?: StatName[];
+    stat_options?: StatOptions;
+}
+export interface NonPrimitiveNodeConfig {
+    self?: StatConfig;
+    properties?: NestedPropertyConfig[];
+    items?: NestedNodeConfig;
+}
+export type NestedNodeConfig = PrimitiveNodeConfig | NonPrimitiveNodeConfig;
+export type NestedPropertyConfig = (PrimitiveNodeConfig & {
+    path: string;
+}) | (NonPrimitiveNodeConfig & {
+    path: string;
+});
+export type DatasetFieldConfig = (PrimitiveNodeConfig & {
+    field_name: string;
+}) | (NonPrimitiveNodeConfig & {
+    field_name: string;
+}) | {
+    field_name: string;
+};
+export type RosettaStoneFieldConfig = (PrimitiveNodeConfig & {
+    attribute_name: string;
+}) | (NonPrimitiveNodeConfig & {
+    attribute_name: string;
+}) | {
+    attribute_name: string;
+};
+export interface DatasetFieldNamespace {
+    scope?: StatConfig;
+    fields?: DatasetFieldConfig[];
+}
+export interface RosettaStoneFieldNamespace {
+    scope?: StatConfig;
+    fields?: RosettaStoneFieldConfig[];
+}
+export interface DatasetStatisticsConfiguration {
+    defaults: StatConfig;
+    refresh: RefreshTrigger;
+    dataset?: DatasetFieldNamespace;
+    rosetta_stone?: RosettaStoneFieldNamespace;
+}
+export interface StatisticsConfigurationResponse {
+    id: string;
+    dataset_id: number;
+    version: number;
+    created_at: string;
+    created_by: number;
+    configuration: DatasetStatisticsConfiguration;
+}

package/build/datasets/statistics-types.js

@@ -0,0 +1 @@
+export {};

package/build/datasets/types.d.ts

@@ -22,6 +22,9 @@ export interface Dataset {
     external_id?: string;
     data_plane?: DataPlane;
     materialized_view_config?: string;
+    compute_pool_config?: {
+        default_compute_pool_id?: string;
+    };
 }
 export interface DatasetStats extends DatasetSummaryStatistics {
     last_snapshot_added_bytes: number;
@@ -78,8 +81,6 @@ export interface DatasetTableSummaryAPIResponse {
 export type SchemaPropertiesType = "string" | "boolean" | "double" | "long" | "timestamptz" | "object" | "array";
 export type DatasetStatus = "active" | "archived" | "pending";
 export type DatasetWriteMode = "append" | "overwrite";
-type ExpressionlessRetentionPolicyType = "retain_everything" | "expire_everything";
-type ExpressionedRetentionPolicyType = "retain_when" | "expire_when";
 type SchemaType = "object" | "value";
 export declare enum Operator {
     GreaterThan = ">",
@@ -87,16 +88,66 @@ export declare enum Operator {
     GreaterThanOrEqualTo = ">=",
     LessThanOrEqualTo = "<="
 }
+export interface SnapshotAgeExpression {
+    type: "snapshot_age";
+    operator: Operator;
+    period: string;
+}
 export type RetentionPolicy = {
-    type: ExpressionlessRetentionPolicyType;
+    type: "retain_everything";
 } | {
-    type: ExpressionedRetentionPolicyType;
-    expression?: {
-        type: "snapshot_age";
-        operator: Operator;
-        period: string;
-    };
+    type: "expire_everything";
+} | {
+    type: "retain_when";
+    expression?: SnapshotAgeExpression;
+} | {
+    type: "expire_when";
+    expression?: SnapshotAgeExpression;
 };
+export interface RowClock {
+    kind: "event_time";
+    attribute?: string;
+}
+export type TTLPolicyKind = "row_ttl" | "table_ttl" | "snapshot_ttl";
+export interface RowTTLPolicy {
+    type: {
+        kind: "row_ttl";
+        clock?: RowClock;
+    };
+    enabled: boolean;
+    interval: string;
+}
+export type TableClockKind = "created_at" | "max_event_time" | "static_time";
+export interface TableClock {
+    kind: TableClockKind;
+    column?: string;
+}
+export interface TableTTLPolicy {
+    type: {
+        kind: "table_ttl";
+        clock: TableClock;
+    };
+    enabled: boolean;
+    interval: string;
+}
+export interface SnapshotTTLPolicy {
+    type: {
+        kind: "snapshot_ttl";
+    };
+    enabled: boolean;
+    interval: string;
+    snapshot_retention_policy: RetentionPolicy;
+}
+export type TTLPolicy = RowTTLPolicy | TableTTLPolicy | SnapshotTTLPolicy;
+export interface RetentionScheduleConfig {
+    schedule: string;
+    schedule_zone_id?: string;
+    status?: "active" | "pending" | "archived";
+}
+export interface UpsertRetentionPoliciesRequest {
+    policies: TTLPolicy[];
+    schedule_config?: RetentionScheduleConfig;
+}
 export type SchemaFileConfigType = "flat" | "json" | "parquet";
 export interface FlatFileConfig {
     type: "flat";

package/build/datasets/types.js

@@ -1,3 +1,4 @@
+// ---- Snapshot-level retention (legacy) ----
 export var Operator;
 (function (Operator) {
     Operator["GreaterThan"] = ">";

package/build/index.d.ts

@@ -15,6 +15,7 @@ export * from "./data-planes";
 export * from "./data-planes/types";
 export * from "./data-streams";
 export * from "./datasets";
+export * from "./datasets/statistics-types";
 export * from "./datasets/types";
 export * from "./encryption-materials";
 export * from "./encryption-materials/types";

package/build/index.js

@@ -15,6 +15,7 @@ export * from "./data-planes";
 export * from "./data-planes/types";
 export * from "./data-streams";
 export * from "./datasets";
+export * from "./datasets/statistics-types";
 export * from "./datasets/types";
 export * from "./encryption-materials";
 export * from "./encryption-materials/types";

package/build/jobs/types.d.ts

@@ -19,6 +19,7 @@ interface BaseJob {
     type: JobType;
     request_source: JobRequestSource;
     data_plane_id?: string;
+    compute_pool_id?: string;
     state: JobState;
     executor?: string;
     idempotency_key: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@narrative.io/data-collaboration-sdk-ts",
-	"version": "2.94.1",
+	"version": "2.95.0",
 	"main": "build/index.js",
 	"repository": "github:narrative-io/data-collaboration-sdk-ts",
 	"source": "src/index.ts",
@@ -28,19 +28,19 @@
 		"@babel/core": "7.29.0",
 		"@babel/preset-env": "7.29.0",
 		"@babel/preset-typescript": "7.28.5",
-		"@biomejs/biome": "2.3.14",
-		"@commitlint/cli": "20.4.1",
-		"@commitlint/config-conventional": "20.4.1",
+		"@biomejs/biome": "2.4.5",
+		"@commitlint/cli": "20.4.3",
+		"@commitlint/config-conventional": "20.4.3",
 		"@types/jest": "30.0.0",
 		"babel-jest": "30.2.0",
 		"jest": "30.2.0",
-		"lefthook": "2.1.0",
+		"lefthook": "2.1.2",
 		"ts-jest": "29.4.6"
 	},
 	"dependencies": {
 		"mande": "2.0.9",
 		"zod": "4.3.6",
-		"bignumber.js": "9.3.1"
+		"bignumber.js": "10.0.2"
 	},
 	"overrides": {
 		"semver@<7.5.2": "7.5.2"