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

package/build/attributes/types.d.ts

@@ -1,5 +1,5 @@
 export type Attribute = PrimitiveAttribute | ArrayAttribute | ObjectAttribute;
-interface BaseAttribute {
+export interface BaseAttribute {
     id: number;
     name: string;
     display_name?: string;
@@ -7,26 +7,25 @@ interface BaseAttribute {
     type: string;
     validations?: string[];
 }
-interface PrimitiveAttribute extends BaseAttribute {
+export interface PrimitiveAttribute extends BaseAttribute {
     type: 'string' | 'boolean' | 'double' | 'long' | 'timestamptz';
     enum?: string[] | number[] | boolean[];
     is_join_key?: boolean;
 }
-type SubAttribute = Partial<Omit<Attribute, 'name' | 'id'>> & {
+export type SubAttribute = Partial<Omit<Attribute, 'name' | 'id'>> & {
     type: string;
     enum?: string[] | number[] | boolean[];
     is_join_key?: boolean;
 };
-interface RefAttribute {
+export interface RefAttribute {
     $ref: number;
 }
-interface ArrayAttribute extends BaseAttribute {
+export interface ArrayAttribute extends BaseAttribute {
     type: 'array';
     items: SubAttribute;
 }
-interface ObjectAttribute extends BaseAttribute {
+export interface ObjectAttribute extends BaseAttribute {
     type: 'object';
     properties: Record<string, SubAttribute | RefAttribute>;
     required?: string[];
 }
-export {};

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

@@ -10,6 +10,8 @@ export interface Dataset {
     tags: string[];
     updated_at: Date;
     write_mode: DatasetWriteMode;
+    last_snapshot_created_at?: string;
+    active_dataset_stored_bytes?: number;
 }
 export interface DatasetColumnSummary {
     id: number;
@@ -74,4 +76,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,10 +3,11 @@ 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';
+import { type Resource, ResourceApi, type BucketCreationRequest, type UpdateAccessTypeRequest } from './resources';
 import { type Attribute } from './attributes/types';
 import { PingApi } from './ping';
 import { UploadsApi } from './uploads';
@@ -17,6 +18,6 @@ import { CompanyInfoApi, type CompanyInfo } from './company-info';
 import { InstallationsApi, type Installation } from './installations';
 declare class NarrativeApi extends BaseApi {
 }
-interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi {
+interface NarrativeApi extends BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi {
 }
-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, ResourceApi, type Resource, 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, type BucketCreationRequest, type UpdateAccessTypeRequest };

package/build/index.js

@@ -4,6 +4,7 @@ import { HealthCheckApi } from './health';
 import { RosettaStoneApi } from './rosetta-stone';
 import { applyMixins } from './utils';
 import { AttributeApi } from './attributes';
+import { ResourceApi } from './resources';
 import { PingApi } from './ping';
 import { UploadsApi } from './uploads';
 import { ProductsApi } from './products';
@@ -11,5 +12,5 @@ import { CompanyInfoApi } from './company-info';
 import { InstallationsApi } from './installations';
 class NarrativeApi extends BaseApi {
 }
-applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi]);
-export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi };
+applyMixins(NarrativeApi, [BaseApi, HealthCheckApi, DatasetApi, RosettaStoneApi, AttributeApi, PingApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi]);
+export { NarrativeApi, AttributeApi, HealthCheckApi, DatasetApi, PingApi, ProductsApi, CompanyInfoApi, InstallationsApi, UploadsApi, ResourceApi };

package/build/resources/index.d.ts

@@ -0,0 +1,38 @@
+/**
+ * @fileoverview This module provides methods for fetching resources.
+ * @author Your Name
+ */
+import { type ApiRecords } from '../types';
+import { BaseApi } from '../base-api';
+import { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest } from './types';
+export { type Resource, type BucketCreationRequest, type UpdateAccessTypeRequest };
+/**
+ * @class ResourceApi
+ * @extends {BaseApi}
+ * @description This class provides methods for fetching resources.
+ */
+export declare class ResourceApi extends BaseApi {
+    /**
+     * @function getBuckets
+     * @memberof ResourceApi
+     * @description Fetches a list of buckets for a given datasetId.
+     * @returns {Promise<ApiRecords<Resource>>} A promise that resolves to the list of resources.
+     */
+    getBuckets(): Promise<ApiRecords<Resource>>;
+    /**
+     * @function createBucket
+     * @memberof ResourceApi
+     * @description Creates a new bucket.
+     * @param {BucketCreationRequest} request - The bucket creation request object.
+     * @returns {Promise<Resource>} A promise that resolves to the created resource.
+     */
+    createBucket(request: BucketCreationRequest): Promise<Resource>;
+    /**
+     * @function updateAccessType
+     * @memberof ResourceApi
+     * @description Updates the access type of a resource.
+     * @param {UpdateAccessTypeRequest} request - The update access type request object.
+     * @returns {Promise<Resource>} A promise that resolves to the updated resource.
+     */
+    updateAccessType(request: UpdateAccessTypeRequest): Promise<Resource>;
+}

package/build/resources/index.js

@@ -0,0 +1,42 @@
+/**
+ * @fileoverview This module provides methods for fetching resources.
+ * @author Your Name
+ */
+import { BaseApi } from '../base-api';
+const resourceName = 'resources';
+/**
+ * @class ResourceApi
+ * @extends {BaseApi}
+ * @description This class provides methods for fetching resources.
+ */
+export class ResourceApi extends BaseApi {
+    /**
+     * @function getBuckets
+     * @memberof ResourceApi
+     * @description Fetches a list of buckets for a given datasetId.
+     * @returns {Promise<ApiRecords<Resource>>} A promise that resolves to the list of resources.
+     */
+    async getBuckets() {
+        return await this.get(`${resourceName}/buckets`);
+    }
+    /**
+     * @function createBucket
+     * @memberof ResourceApi
+     * @description Creates a new bucket.
+     * @param {BucketCreationRequest} request - The bucket creation request object.
+     * @returns {Promise<Resource>} A promise that resolves to the created resource.
+     */
+    async createBucket(request) {
+        return await this.post(`${resourceName}/buckets`, request);
+    }
+    /**
+     * @function updateAccessType
+     * @memberof ResourceApi
+     * @description Updates the access type of a resource.
+     * @param {UpdateAccessTypeRequest} request - The update access type request object.
+     * @returns {Promise<Resource>} A promise that resolves to the updated resource.
+     */
+    async updateAccessType(request) {
+        return await this.post(`${resourceName}/buckets/access`, request);
+    }
+}

package/build/resources/types.d.ts

@@ -0,0 +1,31 @@
+export interface Resource {
+    id: string;
+    company_id: number;
+    auth: {
+        type: 'bucket_policy' | 'role';
+        account_id: string;
+        external_id?: string;
+        role?: string;
+    };
+    name: string;
+    created_at: string;
+    updated_at: string;
+    is_access_mutable: boolean;
+}
+export interface RoleBasedBucketAccess {
+    type: 'role';
+    external_id: string;
+}
+export interface PolicyBasedBucketAccess {
+    type: 'bucket_policy';
+}
+export interface UpdateAccessTypeRequest {
+    bucket_name: string;
+    new_access: BucketAccess;
+}
+export type BucketAccess = RoleBasedBucketAccess | PolicyBasedBucketAccess;
+export interface BucketCreationRequest {
+    account_id: string;
+    resource_id: string;
+    access: BucketAccess;
+}

package/build/resources/types.js

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.0.32",
+  "version": "0.0.34",
   "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": {