@narrative.io/data-collaboration-sdk-ts 0.0.32 → 0.0.33

package/build/datasets/index.d.ts

@@ -1,6 +1,7 @@
 import { type ApiRecords } from '../types';
 import { BaseApi } from '../base-api';
-import { type Dataset, type DatasetTableSummaryAPIResponse } from './types';
+import { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse } from './types';
+export { type FilePerSnapshotResponse, type Dataset, type DatasetTableSummaryAPIResponse };
 /**
  * @module DatasetApi
  * @description This module provides methods for fetching datasets.
@@ -42,4 +43,32 @@ export declare class DatasetApi extends BaseApi {
     const records = await getDatasetSample(datasetId, size);
     */
     getDatasetSample(datasetId: number, size?: number): Promise<ApiRecords<Record<string, string>>>;
+    /**
+     * Fetches a list of dataset files based on the provided parameters.
+     *
+     * @param {number} datasetId - The ID of the dataset to fetch files for.
+     * @param {number} [size] - The number of snapshots to return. Optional.
+     * @param {number} [offset] - The starting index of the file list. Optional.
+     * @param {string} [afterTimestamp] - Fetch files with a timestamp greater than or equal to the given value. Optional.
+     * @param {number} [fromSnapshotId] - Fetch files from the specified snapshot ID. Optional.
+     * @returns {Promise<FilePerSnapshotResponse>} A Promise that resolves with the fetched dataset files.
+     * @throws {Error} If there is an issue with the request or the response.
+     * @memberof DatasetApi
+     * @public
+   */
+    getDatasetFiles(datasetId: number, size?: number, offset?: number, afterTimestamp?: string, fromSnapshotId?: number): Promise<FilePerSnapshotResponse>;
+    /**
+     * Fetches the download URL for a specific dataset file.
+     *
+     * @param {number} datasetId - The ID of the dataset to fetch the file download URL for.
+     * @param {number} snapshotId - The ID of the snapshot the file is associated with.
+     * @param {string} fileId - The ID of the file to fetch the download URL for.
+     * @returns {Promise<{ download_url: string }>} A Promise that resolves with an object containing the download URL.
+     * @throws {Error} If there is an issue with the request or the response.
+     * @memberof DatasetApi
+     * @public
+     */
+    getDatasetFileDownloadUrl(datasetId: number, snapshotId: number, fileId: string): Promise<{
+        download_url: string;
+    }>;
 }

package/build/datasets/index.js

@@ -49,4 +49,43 @@ export class DatasetApi extends BaseApi {
     async getDatasetSample(datasetId, size = 1000) {
         return await this.get(`${resourceName}/${datasetId}/sample?size=${size}`);
     }
+    /**
+     * Fetches a list of dataset files based on the provided parameters.
+     *
+     * @param {number} datasetId - The ID of the dataset to fetch files for.
+     * @param {number} [size] - The number of snapshots to return. Optional.
+     * @param {number} [offset] - The starting index of the file list. Optional.
+     * @param {string} [afterTimestamp] - Fetch files with a timestamp greater than or equal to the given value. Optional.
+     * @param {number} [fromSnapshotId] - Fetch files from the specified snapshot ID. Optional.
+     * @returns {Promise<FilePerSnapshotResponse>} A Promise that resolves with the fetched dataset files.
+     * @throws {Error} If there is an issue with the request or the response.
+     * @memberof DatasetApi
+     * @public
+   */
+    async getDatasetFiles(datasetId, size, offset, afterTimestamp, fromSnapshotId) {
+        const params = new URLSearchParams();
+        if (size != null)
+            params.append('per_page', String(size));
+        if (offset != null)
+            params.append('offset', String(offset));
+        if (afterTimestamp != null)
+            params.append('timestamp.gte', afterTimestamp);
+        if (fromSnapshotId != null)
+            params.append('from_snapshot_id', String(fromSnapshotId));
+        return await this.get(`${resourceName}/${datasetId}/find-files?${params.toString()}`);
+    }
+    /**
+     * Fetches the download URL for a specific dataset file.
+     *
+     * @param {number} datasetId - The ID of the dataset to fetch the file download URL for.
+     * @param {number} snapshotId - The ID of the snapshot the file is associated with.
+     * @param {string} fileId - The ID of the file to fetch the download URL for.
+     * @returns {Promise<{ download_url: string }>} A Promise that resolves with an object containing the download URL.
+     * @throws {Error} If there is an issue with the request or the response.
+     * @memberof DatasetApi
+     * @public
+     */
+    async getDatasetFileDownloadUrl(datasetId, snapshotId, fileId) {
+        return await this.get(`${resourceName}/${datasetId}/snapshots/${snapshotId}/files-added/${fileId}/download`);
+    }
 }

package/build/datasets/types.d.ts

@@ -74,4 +74,18 @@ interface Schema {
     required: string[];
     primary: string;
 }
+interface File {
+    path: string;
+    size: number;
+}
+interface Snapshot {
+    files: File[];
+    snapshot_id: number;
+    timestamp: string;
+}
+export interface FilePerSnapshotResponse {
+    files_per_snapshot: Snapshot[];
+    has_next: boolean;
+    next_snapshot: number | null;
+}
 export {};

package/build/index.d.ts

@@ -3,7 +3,7 @@ import { DatasetApi } from './datasets';
 import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { type Environment, type Config, type ApiRecords, type MonetaryAmount } from './types';
-import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSummary } from './datasets/types';
+import { type DatasetTableSummaryAPIResponse, type Dataset, type DatasetTableSummary, type FilePerSnapshotResponse } from './datasets/types';
 import { type HealthCheckResult } from './health/types';
 import { type SampleRecords } from './rosetta-stone/types';
 import { AttributeApi } from './attributes';
@@ -19,4 +19,4 @@ declare class NarrativeApi extends BaseApi {
 }
 interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi {
 }
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, type UploadsResponse, type PingStatus, type Attribute, type Environment, type Config, type ApiRecords, type Dataset, type HealthCheckResult, type SampleRecords, type DatasetTableSummary, type DatasetTableSummaryAPIResponse, type Product, type MonetaryAmount, type CompanyInfo, type Installation };
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, type UploadsResponse, type PingStatus, type Attribute, 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 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.32",
+  "version": "0.0.33",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",
@@ -35,7 +35,7 @@
     "eslint-plugin-promise": "^6.1.1",
     "jest": "^29.4.3",
     "ts-jest": "^29.0.5",
-    "typescript": "^4.9.5",
+    "typescript": "^5.0.2",
     "husky": "^8.0.0"
   },
   "dependencies": {