@narrative.io/data-collaboration-sdk-ts 0.10.1 → 0.11.0

package/build/access-rules/types.d.ts

@@ -58,6 +58,8 @@ interface SharedAccessRule {
     schema: AccessRuleSchema;
     price_cpm_usd: number;
     metadata: AccessRuleMetadata;
+    created_at: string;
+    updated_at: string;
     type: "shared";
 }
 interface OwnedAccessRule {
@@ -76,6 +78,8 @@ interface OwnedAccessRule {
     collaborators: AccessRuleCollaborators;
     price_cpm_usd: number;
     metadata: AccessRuleMetadata;
+    created_at: string;
+    updated_at: string;
     type: "owned";
 }
 export type AccessRuleV2 = OwnedAccessRule | SharedAccessRule;

package/build/uploads/index.d.ts

@@ -1,5 +1,5 @@
 import { BaseApi } from "../base-api";
-import { type UploadsResponse } from "./types";
+import { type ConfirmDatasetUpload, type UploadsResponse } from "./types";
 /**
  * API class for handling file uploads.
  * @extends BaseApi
@@ -13,5 +13,24 @@ declare class UploadsApi extends BaseApi {
      * @returns {Promise<UploadsResponse>} - A Promise resolving to the response data.
      */
     getUploadUrl(uploadPath: string): Promise<UploadsResponse>;
+    /**
+     * Confirms the completion of an upload process.
+     * This method should be called after a file has been uploaded to the provided URL to finalize the upload.
+     *
+     * @async
+     * @param {number} datasetId - The unique identifier of the dataset being uploaded.
+     * @param {string} uploadPath - The path where the file was uploaded.
+     * @returns {Promise<void>} A promise resolving when the upload confirmation is complete.
+     */
+    confirmUpload(datasetId: number, uploadInfo: UploadsResponse): Promise<void>;
+    /**
+     * Uploads a file to a given presigned S3 URL.
+     * The user selects a file from a form in the browser, and this function handles the upload to S3.
+     *
+     * @param {File} file - The file to be uploaded, typically obtained from a file input in the browser.
+     * @param {string} presignedUrl - The presigned URL to which the file should be uploaded.
+     * @returns {Promise<boolean>} A promise that resolves to true if the file is successfully uploaded.
+     */
+    uploadFileToS3(file: File, uploadInfo: UploadsResponse): Promise<boolean>;
 }
-export { type UploadsResponse, UploadsApi };
+export { type UploadsResponse, type ConfirmDatasetUpload, UploadsApi };

package/build/uploads/index.js

@@ -21,5 +21,51 @@ class UploadsApi extends BaseApi {
     async getUploadUrl(uploadPath) {
         return await this.post(`${resourceName}/${uploadPath}`);
     }
+    /**
+     * Confirms the completion of an upload process.
+     * This method should be called after a file has been uploaded to the provided URL to finalize the upload.
+     *
+     * @async
+     * @param {number} datasetId - The unique identifier of the dataset being uploaded.
+     * @param {string} uploadPath - The path where the file was uploaded.
+     * @returns {Promise<void>} A promise resolving when the upload confirmation is complete.
+     */
+    async confirmUpload(datasetId, uploadInfo) {
+        await this.put(`${resourceName}/${datasetId}`, {
+            source_file: uploadInfo.path,
+        });
+    }
+    /**
+     * Uploads a file to a given presigned S3 URL.
+     * The user selects a file from a form in the browser, and this function handles the upload to S3.
+     *
+     * @param {File} file - The file to be uploaded, typically obtained from a file input in the browser.
+     * @param {string} presignedUrl - The presigned URL to which the file should be uploaded.
+     * @returns {Promise<boolean>} A promise that resolves to true if the file is successfully uploaded.
+     */
+    async uploadFileToS3(file, uploadInfo) {
+        if (uploadInfo.expiry < new Date().toISOString()) {
+            throw new Error("Upload URL has expired");
+        }
+        try {
+            const response = await fetch(uploadInfo.path, {
+                method: "PUT",
+                body: file,
+                headers: {
+                    "Content-Type": file.type,
+                },
+            });
+            // Check if the upload was successful
+            if (response.status === 200) {
+                return true;
+            }
+            else {
+                return false;
+            }
+        }
+        catch (error) {
+            return false;
+        }
+    }
 }
 export { UploadsApi };

package/build/uploads/types.d.ts

@@ -3,3 +3,6 @@ export interface UploadsResponse {
     url: string;
     expiry: string;
 }
+export interface ConfirmDatasetUpload {
+    source_file: string;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@narrative.io/data-collaboration-sdk-ts",
-  "version": "0.10.1",
+  "version": "0.11.0",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",