tako-sdk 0.1.4 → 0.1.5

package/dist/index.cjs

@@ -28,7 +28,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// src/types.ts
+// src/types/types.ts
 var SourceIndex = /* @__PURE__ */ ((SourceIndex2) => {
   SourceIndex2["TAKO"] = "tako";
   SourceIndex2["WEB"] = "web";
@@ -123,6 +123,122 @@ var TakoClient = class {
     const response = await this.request("/knowledge_search", "POST", requestBody);
     return response || { outputs: { knowledge_cards: [] } };
   }
+  /**
+   * Get an image for a knowledge card
+   * @param cardId The ID of the knowledge card
+   * @returns bytes of the image
+   */
+  async getImage(cardId) {
+    const response = await this.request(`/image/${cardId}`, "GET");
+    return response?.image ? Uint8Array.from(atob(response.image), (c) => c.charCodeAt(0)) : new Uint8Array();
+  }
+  /**
+   * Beta visualize a file or a dataset (beta endpoint)
+   * @param takoFormattedDataset Tako formatted dataset to visualize
+   * @param fileId The ID of the file to visualize
+   * @param query The query to visualize the dataset
+   * @returns Knowledge search results
+   */
+  async betaVisualize(takoFormattedDataset, fileId, query) {
+    if (takoFormattedDataset == null && fileId == null) {
+      throw new Error("Either takoFormattedDataset or fileId must be provided");
+    }
+    if (takoFormattedDataset != null && fileId != null) {
+      throw new Error("Only one of takoFormattedDataset or fileId must be provided");
+    }
+    const visualizeRequest = {
+      tako_formatted_dataset: takoFormattedDataset,
+      file_id: fileId,
+      query
+    };
+    const response = await this.request("/beta/visualize", "POST", visualizeRequest);
+    return response || { outputs: { knowledge_cards: [] } };
+  }
+  /**
+   * Upload a file to Tako using presigned URL (supports .csv, .xls, .xlsx, .parquet up to 5MB)
+   * @param file The file to upload
+   * @returns The ID of the uploaded file
+   */
+  async betaUploadFile(file) {
+    const maxSize = 5 * 1024 * 1024;
+    if (file.size > maxSize) {
+      throw new Error("File size exceeds 5MB limit");
+    }
+    const supportedFormats = [".csv", ".xls", ".xlsx", ".parquet"];
+    const fileExtension = file.name.toLowerCase().substring(file.name.lastIndexOf("."));
+    if (!supportedFormats.includes(fileExtension)) {
+      throw new Error(`Unsupported file format. Supported formats: ${supportedFormats.join(", ")}`);
+    }
+    const uploadUrlResponse = await this.getFileUploadUrl(file.name);
+    return await this.uploadFileToAws(file, uploadUrlResponse);
+  }
+  /**
+   * Get a presigned URL for file upload (private method)
+   * @param fileName Name of the file to upload
+   * @returns Presigned URL response with upload details
+   */
+  async getFileUploadUrl(fileName) {
+    const url = `${this.baseUrl}${this.pathPrefix}/beta/file_upload_url?file_name=${encodeURIComponent(fileName)}`;
+    const headers = {
+      "X-API-Key": this.apiKey
+    };
+    const response = await fetch(url, {
+      method: "GET",
+      headers
+    });
+    if (!response.ok) {
+      const errorData = await response.json();
+      const message = errorData.message || response.statusText;
+      switch (response.status) {
+        case 401:
+          throw new TakoUnauthorizedException(message, errorData);
+        case 429:
+          throw new TakoRateLimitException(message, errorData);
+        default:
+          throw new TakoException(response.status, message, errorData);
+      }
+    }
+    return await response.json();
+  }
+  /**
+   * Upload file to AWS S3 using presigned URL (private method)
+   * @param file The file to upload
+   * @param uploadUrlResponse The presigned URL response
+   * @returns The file ID from the presigned URL response
+   */
+  async uploadFileToAws(file, uploadUrlResponse) {
+    const formData = new FormData();
+    Object.entries(uploadUrlResponse.fields).forEach(([key, value]) => {
+      formData.append(key, value);
+    });
+    formData.append("file", file);
+    const response = await fetch(uploadUrlResponse.url, {
+      method: "POST",
+      body: formData
+    });
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(`Failed to upload file to AWS S3: ${response.status} ${response.statusText}. ${errorText}`);
+    }
+    return uploadUrlResponse.file_id;
+  }
+  /**
+   * Connect a file to Tako for visualization and analysis (beta endpoint)
+   * @param fileUrl URL of the file to connect to
+   * @param fileId Optional ID of the file to connect to. If not provided, a new file ID will be generated
+   * @returns Object containing 'message' and 'id' fields
+   */
+  async betaFileConnector(fileUrl, fileId) {
+    if (!fileUrl?.trim()) {
+      throw new Error("File URL is required");
+    }
+    const requestBody = {
+      file_url: fileUrl,
+      ...fileId ? { file_id: fileId } : {}
+    };
+    const response = await this.request("/beta/file_connector", "POST", requestBody);
+    return response || { message: "", id: "" };
+  }
 };
 
 // src/index.ts

package/dist/index.d.cts

@@ -59,6 +59,76 @@ declare class TakoRateLimitException extends TakoException {
     constructor(message?: string, details?: any);
 }
 
+declare enum TakoDataFormatValueType {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    DATE = "date",
+    FLOAT = "float",
+    NULL = "null",
+    ANY = "any"
+}
+/**
+ * Each cell contains a single aspect (variable + value)
+ */
+interface TakoDataFormatCellValue {
+    /** The name of the variable */
+    variable_name: string;
+    /**
+     * The value of the variable.
+     * If the variable is a date, format it as an ISO 8601 string.
+     */
+    value: string | number | boolean | null;
+}
+/**
+ * Each cell contains a single aspect (variable + value)
+ */
+interface TakoDataFormatRowValues {
+    cell_values: TakoDataFormatCellValue[];
+}
+/**
+ * Variable contains rich metadata about the variables for each observation
+ */
+interface TakoDataFormatVariable {
+    /** The human friendly name of the column variable */
+    name: string;
+    /** The type of the column variable */
+    type: TakoDataFormatValueType;
+    /** The units of the variable in the data */
+    units?: string | null;
+    /** Whether the data is sortable by this variable */
+    is_sortable?: boolean | null;
+    /** Whether a higher value of this variable is better */
+    is_higher_better?: boolean | null;
+}
+interface TakoDataFormatQuantitativeVariable extends TakoDataFormatVariable {
+}
+interface TakoDataFormatTemporalVariable extends TakoDataFormatVariable {
+}
+interface TakoDataFormatCategoricalVariable extends TakoDataFormatVariable {
+}
+type ValidTakoDataFormatVariable = TakoDataFormatTemporalVariable | TakoDataFormatCategoricalVariable | TakoDataFormatVariable | TakoDataFormatQuantitativeVariable;
+/**
+ * A single dataset contains all column variables and all the rows of data
+ */
+interface TakoDataFormatDataset {
+    /** The title of the dataset */
+    title: string;
+    /** The description of the dataset */
+    description?: string | null;
+    /** Details about all variables in the dataset */
+    variables: ValidTakoDataFormatVariable[];
+    /**
+     * Each row contains a single coherent set of values with each
+     * cell having different aspects (variable + value)
+     */
+    rows: TakoDataFormatRowValues[];
+}
+interface FileConnectorResponse {
+    message: string;
+    id: string;
+}
+
 /**
  * Tako API Client
  */
@@ -86,6 +156,46 @@ declare class TakoClient {
      * @returns Knowledge search results
      */
     knowledgeSearch(text: string, sourceIndexes?: SourceIndex[]): Promise<KnowledgeSearchResponse>;
+    /**
+     * Get an image for a knowledge card
+     * @param cardId The ID of the knowledge card
+     * @returns bytes of the image
+     */
+    getImage(cardId: string): Promise<Uint8Array>;
+    /**
+     * Beta visualize a file or a dataset (beta endpoint)
+     * @param takoFormattedDataset Tako formatted dataset to visualize
+     * @param fileId The ID of the file to visualize
+     * @param query The query to visualize the dataset
+     * @returns Knowledge search results
+     */
+    betaVisualize(takoFormattedDataset?: TakoDataFormatDataset | null, fileId?: string | null, query?: string | null): Promise<KnowledgeSearchResponse>;
+    /**
+     * Upload a file to Tako using presigned URL (supports .csv, .xls, .xlsx, .parquet up to 5MB)
+     * @param file The file to upload
+     * @returns The ID of the uploaded file
+     */
+    betaUploadFile(file: File): Promise<string>;
+    /**
+     * Get a presigned URL for file upload (private method)
+     * @param fileName Name of the file to upload
+     * @returns Presigned URL response with upload details
+     */
+    private getFileUploadUrl;
+    /**
+     * Upload file to AWS S3 using presigned URL (private method)
+     * @param file The file to upload
+     * @param uploadUrlResponse The presigned URL response
+     * @returns The file ID from the presigned URL response
+     */
+    private uploadFileToAws;
+    /**
+     * Connect a file to Tako for visualization and analysis (beta endpoint)
+     * @param fileUrl URL of the file to connect to
+     * @param fileId Optional ID of the file to connect to. If not provided, a new file ID will be generated
+     * @returns Object containing 'message' and 'id' fields
+     */
+    betaFileConnector(fileUrl: string, fileId?: string): Promise<FileConnectorResponse>;
 }
 
 /**

package/dist/index.d.ts

@@ -59,6 +59,76 @@ declare class TakoRateLimitException extends TakoException {
     constructor(message?: string, details?: any);
 }
 
+declare enum TakoDataFormatValueType {
+    STRING = "string",
+    NUMBER = "number",
+    BOOLEAN = "boolean",
+    DATE = "date",
+    FLOAT = "float",
+    NULL = "null",
+    ANY = "any"
+}
+/**
+ * Each cell contains a single aspect (variable + value)
+ */
+interface TakoDataFormatCellValue {
+    /** The name of the variable */
+    variable_name: string;
+    /**
+     * The value of the variable.
+     * If the variable is a date, format it as an ISO 8601 string.
+     */
+    value: string | number | boolean | null;
+}
+/**
+ * Each cell contains a single aspect (variable + value)
+ */
+interface TakoDataFormatRowValues {
+    cell_values: TakoDataFormatCellValue[];
+}
+/**
+ * Variable contains rich metadata about the variables for each observation
+ */
+interface TakoDataFormatVariable {
+    /** The human friendly name of the column variable */
+    name: string;
+    /** The type of the column variable */
+    type: TakoDataFormatValueType;
+    /** The units of the variable in the data */
+    units?: string | null;
+    /** Whether the data is sortable by this variable */
+    is_sortable?: boolean | null;
+    /** Whether a higher value of this variable is better */
+    is_higher_better?: boolean | null;
+}
+interface TakoDataFormatQuantitativeVariable extends TakoDataFormatVariable {
+}
+interface TakoDataFormatTemporalVariable extends TakoDataFormatVariable {
+}
+interface TakoDataFormatCategoricalVariable extends TakoDataFormatVariable {
+}
+type ValidTakoDataFormatVariable = TakoDataFormatTemporalVariable | TakoDataFormatCategoricalVariable | TakoDataFormatVariable | TakoDataFormatQuantitativeVariable;
+/**
+ * A single dataset contains all column variables and all the rows of data
+ */
+interface TakoDataFormatDataset {
+    /** The title of the dataset */
+    title: string;
+    /** The description of the dataset */
+    description?: string | null;
+    /** Details about all variables in the dataset */
+    variables: ValidTakoDataFormatVariable[];
+    /**
+     * Each row contains a single coherent set of values with each
+     * cell having different aspects (variable + value)
+     */
+    rows: TakoDataFormatRowValues[];
+}
+interface FileConnectorResponse {
+    message: string;
+    id: string;
+}
+
 /**
  * Tako API Client
  */
@@ -86,6 +156,46 @@ declare class TakoClient {
      * @returns Knowledge search results
      */
     knowledgeSearch(text: string, sourceIndexes?: SourceIndex[]): Promise<KnowledgeSearchResponse>;
+    /**
+     * Get an image for a knowledge card
+     * @param cardId The ID of the knowledge card
+     * @returns bytes of the image
+     */
+    getImage(cardId: string): Promise<Uint8Array>;
+    /**
+     * Beta visualize a file or a dataset (beta endpoint)
+     * @param takoFormattedDataset Tako formatted dataset to visualize
+     * @param fileId The ID of the file to visualize
+     * @param query The query to visualize the dataset
+     * @returns Knowledge search results
+     */
+    betaVisualize(takoFormattedDataset?: TakoDataFormatDataset | null, fileId?: string | null, query?: string | null): Promise<KnowledgeSearchResponse>;
+    /**
+     * Upload a file to Tako using presigned URL (supports .csv, .xls, .xlsx, .parquet up to 5MB)
+     * @param file The file to upload
+     * @returns The ID of the uploaded file
+     */
+    betaUploadFile(file: File): Promise<string>;
+    /**
+     * Get a presigned URL for file upload (private method)
+     * @param fileName Name of the file to upload
+     * @returns Presigned URL response with upload details
+     */
+    private getFileUploadUrl;
+    /**
+     * Upload file to AWS S3 using presigned URL (private method)
+     * @param file The file to upload
+     * @param uploadUrlResponse The presigned URL response
+     * @returns The file ID from the presigned URL response
+     */
+    private uploadFileToAws;
+    /**
+     * Connect a file to Tako for visualization and analysis (beta endpoint)
+     * @param fileUrl URL of the file to connect to
+     * @param fileId Optional ID of the file to connect to. If not provided, a new file ID will be generated
+     * @returns Object containing 'message' and 'id' fields
+     */
+    betaFileConnector(fileUrl: string, fileId?: string): Promise<FileConnectorResponse>;
 }
 
 /**

package/dist/index.js

@@ -1,4 +1,4 @@
-// src/types.ts
+// src/types/types.ts
 var SourceIndex = /* @__PURE__ */ ((SourceIndex2) => {
   SourceIndex2["TAKO"] = "tako";
   SourceIndex2["WEB"] = "web";
@@ -93,6 +93,122 @@ var TakoClient = class {
     const response = await this.request("/knowledge_search", "POST", requestBody);
     return response || { outputs: { knowledge_cards: [] } };
   }
+  /**
+   * Get an image for a knowledge card
+   * @param cardId The ID of the knowledge card
+   * @returns bytes of the image
+   */
+  async getImage(cardId) {
+    const response = await this.request(`/image/${cardId}`, "GET");
+    return response?.image ? Uint8Array.from(atob(response.image), (c) => c.charCodeAt(0)) : new Uint8Array();
+  }
+  /**
+   * Beta visualize a file or a dataset (beta endpoint)
+   * @param takoFormattedDataset Tako formatted dataset to visualize
+   * @param fileId The ID of the file to visualize
+   * @param query The query to visualize the dataset
+   * @returns Knowledge search results
+   */
+  async betaVisualize(takoFormattedDataset, fileId, query) {
+    if (takoFormattedDataset == null && fileId == null) {
+      throw new Error("Either takoFormattedDataset or fileId must be provided");
+    }
+    if (takoFormattedDataset != null && fileId != null) {
+      throw new Error("Only one of takoFormattedDataset or fileId must be provided");
+    }
+    const visualizeRequest = {
+      tako_formatted_dataset: takoFormattedDataset,
+      file_id: fileId,
+      query
+    };
+    const response = await this.request("/beta/visualize", "POST", visualizeRequest);
+    return response || { outputs: { knowledge_cards: [] } };
+  }
+  /**
+   * Upload a file to Tako using presigned URL (supports .csv, .xls, .xlsx, .parquet up to 5MB)
+   * @param file The file to upload
+   * @returns The ID of the uploaded file
+   */
+  async betaUploadFile(file) {
+    const maxSize = 5 * 1024 * 1024;
+    if (file.size > maxSize) {
+      throw new Error("File size exceeds 5MB limit");
+    }
+    const supportedFormats = [".csv", ".xls", ".xlsx", ".parquet"];
+    const fileExtension = file.name.toLowerCase().substring(file.name.lastIndexOf("."));
+    if (!supportedFormats.includes(fileExtension)) {
+      throw new Error(`Unsupported file format. Supported formats: ${supportedFormats.join(", ")}`);
+    }
+    const uploadUrlResponse = await this.getFileUploadUrl(file.name);
+    return await this.uploadFileToAws(file, uploadUrlResponse);
+  }
+  /**
+   * Get a presigned URL for file upload (private method)
+   * @param fileName Name of the file to upload
+   * @returns Presigned URL response with upload details
+   */
+  async getFileUploadUrl(fileName) {
+    const url = `${this.baseUrl}${this.pathPrefix}/beta/file_upload_url?file_name=${encodeURIComponent(fileName)}`;
+    const headers = {
+      "X-API-Key": this.apiKey
+    };
+    const response = await fetch(url, {
+      method: "GET",
+      headers
+    });
+    if (!response.ok) {
+      const errorData = await response.json();
+      const message = errorData.message || response.statusText;
+      switch (response.status) {
+        case 401:
+          throw new TakoUnauthorizedException(message, errorData);
+        case 429:
+          throw new TakoRateLimitException(message, errorData);
+        default:
+          throw new TakoException(response.status, message, errorData);
+      }
+    }
+    return await response.json();
+  }
+  /**
+   * Upload file to AWS S3 using presigned URL (private method)
+   * @param file The file to upload
+   * @param uploadUrlResponse The presigned URL response
+   * @returns The file ID from the presigned URL response
+   */
+  async uploadFileToAws(file, uploadUrlResponse) {
+    const formData = new FormData();
+    Object.entries(uploadUrlResponse.fields).forEach(([key, value]) => {
+      formData.append(key, value);
+    });
+    formData.append("file", file);
+    const response = await fetch(uploadUrlResponse.url, {
+      method: "POST",
+      body: formData
+    });
+    if (!response.ok) {
+      const errorText = await response.text();
+      throw new Error(`Failed to upload file to AWS S3: ${response.status} ${response.statusText}. ${errorText}`);
+    }
+    return uploadUrlResponse.file_id;
+  }
+  /**
+   * Connect a file to Tako for visualization and analysis (beta endpoint)
+   * @param fileUrl URL of the file to connect to
+   * @param fileId Optional ID of the file to connect to. If not provided, a new file ID will be generated
+   * @returns Object containing 'message' and 'id' fields
+   */
+  async betaFileConnector(fileUrl, fileId) {
+    if (!fileUrl?.trim()) {
+      throw new Error("File URL is required");
+    }
+    const requestBody = {
+      file_url: fileUrl,
+      ...fileId ? { file_id: fileId } : {}
+    };
+    const response = await this.request("/beta/file_connector", "POST", requestBody);
+    return response || { message: "", id: "" };
+  }
 };
 
 // src/index.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tako-sdk",
-  "version": "0.1.4",
+  "version": "0.1.5",
   "description": "JavaScript/TypeScript SDK for the Tako API",
   "type": "module",
   "main": "dist/index.js",
@@ -12,10 +12,8 @@
   "scripts": {
     "build": "tsup src/index.ts --format cjs,esm --dts",
     "lint": "eslint src/**/*.ts",
-    "test": "jest",
-    "prepublishOnly": "npm run build",
-    "test:js": "node test.js",
-    "test:ts": "node --loader ts-node/esm test.ts"
+    "test": "node --import tsx test/client.test.ts",
+    "prepublishOnly": "npm run build"
   },
   "keywords": [
     "tako",
@@ -34,13 +32,14 @@
     "ts-jest": "^29.1.1",
     "ts-node": "^10.9.2",
     "tsup": "^7.1.0",
+    "tsx": "^4.20.1",
     "typescript": "^5.1.6"
   },
   "peerDependencies": {
-    "typescript": ">=4.7.0",
-    "eslint": "^7.0.0 || ^8.0.0",
     "@typescript-eslint/eslint-plugin": "^5.0.0 || ^6.0.0",
-    "@typescript-eslint/parser": "^5.0.0 || ^6.0.0"
+    "@typescript-eslint/parser": "^5.0.0 || ^6.0.0",
+    "eslint": "^7.0.0 || ^8.0.0",
+    "typescript": ">=4.7.0"
   },
   "engines": {
     "node": ">=14.0.0"