@narrative.io/data-collaboration-sdk-ts 2.63.0 → 2.64.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -64,9 +64,9 @@ declare class ConnectionsApi extends BaseApi {
64
64
  *
65
65
  * @public
66
66
  * @async
67
- * @returns {Promise<ConnectionV2[]>} A promise that resolves to an array of connection objects.
67
+ * @returns {Promise<ApiRecords<ConnectionV2>>} A promise that resolves to an array of connection objects.
68
68
  * @throws Will throw an error if the API call fails.
69
69
  */
70
- getConnectionsV2(): Promise<ConnectionV2[]>;
70
+ getConnections(): Promise<ApiRecords<ConnectionV2>>;
71
71
  }
72
72
  export { type Connection, type ConnectionV2, type ConnectionStatus, ConnectionsApi, };
@@ -83,10 +83,10 @@ class ConnectionsApi extends BaseApi {
83
83
  *
84
84
  * @public
85
85
  * @async
86
- * @returns {Promise<ConnectionV2[]>} A promise that resolves to an array of connection objects.
86
+ * @returns {Promise<ApiRecords<ConnectionV2>>} A promise that resolves to an array of connection objects.
87
87
  * @throws Will throw an error if the API call fails.
88
88
  */
89
- async getConnectionsV2() {
89
+ async getConnections() {
90
90
  const url = `v2/${resourceName}`;
91
91
  return await this.get(url);
92
92
  }
@@ -1,3 +1,4 @@
1
+ import type { UnknownJob } from "src/jobs/types";
1
2
  import { BaseApi } from "../base-api";
2
3
  import type { ApiRecords } from "../types";
3
4
  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";
@@ -178,15 +179,15 @@ export declare class DatasetApi extends BaseApi {
178
179
  */
179
180
  deleteDatasetSample(datasetId: number): Promise<void>;
180
181
  /**
181
- * Refreshes the materlized view for the given dataset id.
182
+ * Refreshes the materialized view for the given dataset id.
182
183
  *
183
184
  * @param {number} datasetId - The ID of the dataset for which to refresh the materialized view.
184
- * @returns {Promise<AdvancedStatistics>} A Promise that resolves on success.
185
+ * @returns {Promise<UnknownJob>} A Promise that resolves with a job object to track the refresh operation.
185
186
  * @throws {Error} If there is an issue with the request or the response.
186
187
  * @memberof DatasetApi
187
188
  * @public
188
189
  */
189
- refreshMaterializedView(datasetId: number): Promise<void>;
190
+ refreshMaterializedView(datasetId: number): Promise<UnknownJob>;
190
191
  createDatasetRefreshSchedule(datasetId: number, refreshSchedule: CreateDatasetRefreshScheduleRequest): Promise<void>;
191
192
  updateDatasetRefreshSchedule(datasetId: number, refreshSchedule: UpdateDatasetRefreshScheduleRequest): Promise<void>;
192
193
  deleteDatasetRefreshSchedule(datasetId: number): Promise<void>;
@@ -217,10 +217,10 @@ export class DatasetApi extends BaseApi {
217
217
  await this.delete(`${resourceName}/${datasetId}/sample`);
218
218
  }
219
219
  /**
220
- * Refreshes the materlized view for the given dataset id.
220
+ * Refreshes the materialized view for the given dataset id.
221
221
  *
222
222
  * @param {number} datasetId - The ID of the dataset for which to refresh the materialized view.
223
- * @returns {Promise<AdvancedStatistics>} A Promise that resolves on success.
223
+ * @returns {Promise<UnknownJob>} A Promise that resolves with a job object to track the refresh operation.
224
224
  * @throws {Error} If there is an issue with the request or the response.
225
225
  * @memberof DatasetApi
226
226
  * @public
@@ -5,6 +5,9 @@ interface GetJobsParameters extends Record<string, string | number | boolean | u
5
5
  dataset_id?: number;
6
6
  per_page?: number;
7
7
  offset?: number;
8
+ order_by?: "created_at_asc" | "created_at_desc";
9
+ state?: "cancelled" | "completed" | "failed" | "pending" | "pending_cancellation" | "running";
10
+ type?: string;
8
11
  }
9
12
  /**
10
13
  * @module JobsApi
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@narrative.io/data-collaboration-sdk-ts",
3
- "version": "2.63.0",
3
+ "version": "2.64.1",
4
4
  "main": "build/index.js",
5
5
  "repository": "github:narrative-io/data-collaboration-sdk-ts",
6
6
  "source": "src/index.ts",
@@ -23,18 +23,18 @@
23
23
  "@babel/core": "7.28.0",
24
24
  "@babel/preset-env": "7.28.0",
25
25
  "@babel/preset-typescript": "7.27.1",
26
- "@biomejs/biome": "2.1.3",
26
+ "@biomejs/biome": "2.1.4",
27
27
  "@commitlint/cli": "19.8.1",
28
28
  "@commitlint/config-conventional": "19.8.1",
29
29
  "@types/jest": "30.0.0",
30
30
  "babel-jest": "30.0.5",
31
31
  "jest": "30.0.5",
32
32
  "lefthook": "1.12.2",
33
- "ts-jest": "29.4.0"
33
+ "ts-jest": "29.4.1"
34
34
  },
35
35
  "dependencies": {
36
36
  "mande": "2.0.9",
37
- "zod": "4.0.14",
37
+ "zod": "4.0.17",
38
38
  "bignumber.js": "9.3.1"
39
39
  },
40
40
  "overrides": {