@narrative.io/data-collaboration-sdk-ts 0.10.2 → 0.11.1

package/build/base-api.d.ts

@@ -88,4 +88,5 @@ export declare abstract class BaseApi {
      */
     private constructHeaders;
     protected constructQueryString<T extends Record<string, any>>(parameters?: T): string;
+    protected drawLogo(): void;
 }

package/build/base-api.js

@@ -15,20 +15,21 @@ export class BaseApi {
      * @param {Environment} [config.environment='prod'] - Environment for the API (e.g. 'dev', 'prod').
      */
     constructor(config) {
-        this.verbose = config.verbose ?? false;
         this.apiKey = config.apiKey;
         this.environment = config.environment ?? "prod";
+        this.verbose = (config.verbose ?? false) || this.environment === "dev";
         this.headers = config.headers ?? {};
         this.base_api = mande(`${this.getBaseUrl()}`, {
             headers: this.constructHeaders(),
         });
+        this.drawLogo();
         if (this.verbose) {
-            console.log(`Using environment: ${this.environment}`);
-            console.log(`Using API key: ${this.apiKey ?? "undefined"}`);
-            console.log(`Using headers: ${JSON.stringify(this.constructHeaders())}`);
-            console.log(`Using base URL: ${this.getBaseUrl()}`);
-            console.log(`Using base API: ${JSON.stringify(this.base_api)}`);
-            console.log(`This is us: ${JSON.stringify(this)}`);
+            console.info(`Using environment: ${this.environment}`);
+            console.info(`Using API key: ${this.apiKey ?? "undefined"}`);
+            console.info(`Using headers: ${JSON.stringify(this.constructHeaders())}`);
+            console.info(`Using base URL: ${this.getBaseUrl()}`);
+            console.info(`Using base API: ${JSON.stringify(this.base_api)}`);
+            console.info(`This is us: ${JSON.stringify(this)}`);
         }
     }
     /**
@@ -169,4 +170,17 @@ export class BaseApi {
         }
         return queryParameters.length > 0 ? `?${queryParameters.join("&")}` : "";
     }
+    drawLogo() {
+        console.log("      ___           ___           ___           ___           ___                                                   ___     ");
+        console.log("     /\\  \\         /\\  \\         /\\  \\         /\\  \\         /\\  \\                                    ___          /\\__\\    ");
+        console.log("     \\:\\  \\       /::\\  \\       /::\\  \\       /::\\  \\       /::\\  \\         ___         ___          /\\  \\        /:/ _/_   ");
+        console.log("      \\:\\  \\     /:/\\:\\  \\     /:/\\:\\__\\     /:/\\:\\__\\     /:/\\:\\  \\       /\\__\\       /\\__\\         \\:\\  \\      /:/ /\\__\\  ");
+        console.log("  _____\\:\\  \\   /:/ /::\\  \\   /:/ /:/  /    /:/ /:/  /    /:/ /::\\  \\     /:/  /      /:/__/          \\:\\  \\    /:/ /:/ _/_ ");
+        console.log(" /::::::::\\__\\ /:/_/:/\\:\\__\\ /:/_/:/__/___ /:/_/:/__/___ /:/_/:/\\:\\__\\   /:/__/      /::\\  \\      ___  \\:\\__\\  /:/_/:/ /\\__\\");
+        console.log(" \\:\\~~\\~~\\/__/ \\:\\/:/  \\/__/ \\:\\/:::::/  / \\:\\/:::::/  / \\:\\/:/  \\/__/  /::\\  \\      \\/\\:\\  \\__  /\\  \\ |:|  |  \\:\\/:/ /:/  /");
+        console.log("  \\:\\  \\        \\::/__/       \\::/~~/~~~~   \\::/~~/~~~~   \\::/__/      /:/\\:\\  \\      ~~\\:\\/\\__\\ \\:\\  \\|:|  |   \\::/_/:/  / ");
+        console.log("   \\:\\  \\        \\:\\  \\        \\:\\~~\\        \\:\\~~\\        \\:\\  \\      \\/__\\:\\  \\        \\::/  /  \\:\\__|:|__|    \\:\\/:/  /  ");
+        console.log("    \\:\\__\\        \\:\\__\\        \\:\\__\\        \\:\\__\\        \\:\\__\\          \\:\\__\\       /:/  /    \\::::/__/      \\::/  /   ");
+        console.log("     \\/__/         \\/__/         \\/__/         \\/__/         \\/__/           \\/__/       \\/__/      ~~~~           \\/__/    ");
+    }
 }

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,60 @@ 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 (this.verbose) {
+            console.info(`Uploading file to S3: ${file.name}`);
+            console.info(`Upload URL: ${uploadInfo.url}`);
+            console.info(`Upload path: ${uploadInfo.path}`);
+            console.info(`Upload expiry: ${uploadInfo.expiry}`);
+            console.info(`Upload file type: ${file.type}`);
+            console.info(`Upload file size: ${file.size}`);
+        }
+        if (uploadInfo.expiry < new Date().toISOString()) {
+            throw new Error("Upload URL has expired");
+        }
+        try {
+            const response = await fetch(uploadInfo.url, {
+                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) {
+            console.error("Upload failed:", 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.2",
+  "version": "0.11.1",
   "main": "build/index.js",
   "repository": "github:narrative-io/data-collaboration-sdk-ts",
   "source": "src/index.ts",