@coreviz/sdk 1.0.0 → 1.0.1

package/README.md

@@ -1,6 +1,6 @@
 # @coreviz/sdk
 
-CoreViz SDK - A JavaScript/Node.js interface for CoreViz's Vision AI APIs.
+The official JavaScript/TypeScript SDK for CoreViz's Vision AI APIs. Easily integrate powerful image analysis and manipulation features into your applications.
 
 ## Installation
 
@@ -8,17 +8,111 @@ CoreViz SDK - A JavaScript/Node.js interface for CoreViz's Vision AI APIs.
 npm install @coreviz/sdk
 ```
 
-## Usage
+## Configuration
 
-```js
-const coreviz = require('@coreviz/sdk');
-coreviz();
+To use the AI features, you need a CoreViz API key.
+Set the `COREVIZ_API_KEY` environment variable in your project.
+
+```bash
+export COREVIZ_API_KEY=your_api_key_here
 ```
 
-## Development
+## API Reference
+
+### `describe(image)`
+
+Generates a detailed text description of an image.
+
+**Parameters:**
+- `image` (string): The image to describe. Can be a base64 string or a URL.
 
-This is currently a placeholder package. The actual API functionality will be implemented soon.
+**Returns:**
+- `Promise<string>`: A text description of the image.
+
+**Example:**
+
+```typescript
+import { describe } from '@coreviz/sdk';
+
+const description = await describe('https://example.com/image.jpg');
+console.log(description);
+```
+
+### `tag(image, options)`
+
+Analyzes an image and returns relevant tags or classifications based on a prompt.
+
+**Parameters:**
+- `image` (string): The image to analyze. Can be a base64 string or a URL.
+- `options` (object):
+  - `prompt` (string): The context or question to guide the tagging (e.g., "What objects are in this image?").
+  - `options` (string[], optional): A specific list of tags to choose from.
+  - `multiple` (boolean, optional): Whether to allow multiple tags (default: `true`).
+
+**Returns:**
+- `Promise<TagResponse>`: An object containing:
+  - `tags` (string[]): The list of identified tags.
+  - `raw` (unknown): The raw API response.
+
+**Example:**
+
+```typescript
+import { tag } from '@coreviz/sdk';
+
+const result = await tag('base64_image_string...', {
+  prompt: "Is this indoor or outdoor?",
+  options: ["indoor", "outdoor"],
+  multiple: false
+});
+console.log(result.tags); // ["indoor"]
+```
+
+### `edit(image, options)`
+
+Modifies an image based on a text prompt using generative AI.
+
+**Parameters:**
+- `image` (string): The image to edit. Can be a base64 string or a URL.
+- `options` (object):
+  - `prompt` (string): Description of the desired edit.
+  - `aspectRatio` (string, optional): Target aspect ratio (`'match_input_image'`, `'1:1'`, `'16:9'`, `'9:16'`, `'4:3'`, `'3:4'`).
+  - `outputFormat` (string, optional): `'jpg'` or `'png'`.
+  - `model` (string, optional): The model to use (default: `'flux-kontext-max'`).
+
+**Returns:**
+- `Promise<string>`: The edited image as a base64 string or URL.
+
+**Example:**
+
+```typescript
+import { edit } from '@coreviz/sdk';
+
+const editedImage = await edit('https://example.com/photo.jpg', {
+  prompt: "Make it look like a painting",
+  aspectRatio: "1:1"
+});
+```
+
+### `resize(input, maxWidth?, maxHeight?)`
+
+Utility function to resize images client-side or server-side before processing.
+
+**Parameters:**
+- `input` (string | File): The image to resize.
+- `maxWidth` (number, optional): Maximum width (default: 1920).
+- `maxHeight` (number, optional): Maximum height (default: 1080).
+
+**Returns:**
+- `Promise<string>`: The resized image as a base64 string.
+
+**Example:**
+
+```typescript
+import { resize } from '@coreviz/sdk';
+
+const resized = await resize(myFileObject, 800, 600);
+```
 
 ## License
 
-MIT 
+MIT

package/dist/describe.d.ts

@@ -1 +1,5 @@
-export declare function describe(image: string): Promise<string | undefined>;
+export interface DescribeOptions {
+    token?: string;
+    apiKey?: string;
+}
+export declare function describe(image: string, options?: DescribeOptions): Promise<string | undefined>;

package/dist/describe.js

@@ -2,15 +2,21 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.describe = describe;
 const resize_1 = require("./resize");
-async function describe(image) {
+async function describe(image, options) {
     try {
         const resizedImage = await (0, resize_1.resize)(image);
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        if (options?.token) {
+            headers['Authorization'] = `Bearer ${options.token}`;
+        }
+        else {
+            headers['x-api-key'] = options?.apiKey || process.env.COREVIZ_API_KEY || "";
+        }
         const response = await fetch(`https://lab.coreviz.io/api/ai/describe`, {
             method: 'POST',
-            headers: {
-                'x-api-key': process.env.COREVIZ_API_KEY || "",
-                'Content-Type': 'application/json',
-            },
+            headers,
             body: JSON.stringify({ image: resizedImage }),
         });
         if (!response.ok) {

package/dist/edit.d.ts

@@ -3,5 +3,7 @@ export interface EditOptions {
     aspectRatio?: 'match_input_image' | '1:1' | '16:9' | '9:16' | '4:3' | '3:4';
     outputFormat?: 'jpg' | 'png';
     model?: 'flux-kontext-max' | 'google/nano-banana' | 'seedream-4';
+    token?: string;
+    apiKey?: string;
 }
 export declare function edit(image: string, options: EditOptions): Promise<string | undefined>;

package/dist/edit.js

@@ -5,12 +5,18 @@ const resize_1 = require("./resize");
 async function edit(image, options) {
     try {
         const resizedImage = await (0, resize_1.resize)(image);
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        if (options.token) {
+            headers['Authorization'] = `Bearer ${options.token}`;
+        }
+        else {
+            headers['x-api-key'] = options.apiKey || process.env.COREVIZ_API_KEY || "";
+        }
         const response = await fetch(`https://lab.coreviz.io/api/ai/edit`, {
             method: 'POST',
-            headers: {
-                'x-api-key': process.env.COREVIZ_API_KEY || "",
-                'Content-Type': 'application/json',
-            },
+            headers,
             body: JSON.stringify({
                 image: resizedImage,
                 prompt: options.prompt,

package/dist/index.d.ts

@@ -1,6 +1,6 @@
-import { describe } from './describe';
+import { describe, DescribeOptions } from './describe';
 import { resize } from './resize';
 import { edit, EditOptions } from './edit';
 import { tag, TagOptions, TagResponse } from './tag';
 export { describe, resize, edit, tag };
-export type { EditOptions, TagOptions, TagResponse };
+export type { EditOptions, TagOptions, TagResponse, DescribeOptions };

package/dist/tag.d.ts

@@ -2,6 +2,8 @@ export interface TagOptions {
     prompt: string;
     options?: string[];
     multiple?: boolean;
+    token?: string;
+    apiKey?: string;
 }
 export interface TagResponse {
     tags: string[];

package/dist/tag.js

@@ -5,12 +5,18 @@ const resize_1 = require("./resize");
 async function tag(image, options) {
     try {
         const resizedImage = await (0, resize_1.resize)(image);
+        const headers = {
+            'Content-Type': 'application/json',
+        };
+        if (options.token) {
+            headers['Authorization'] = `Bearer ${options.token}`;
+        }
+        else {
+            headers['x-api-key'] = options.apiKey || process.env.COREVIZ_API_KEY || "";
+        }
         const response = await fetch("https://lab.coreviz.io/api/ai/tag", {
             method: 'POST',
-            headers: {
-                'x-api-key': process.env.COREVIZ_API_KEY || "",
-                'Content-Type': 'application/json',
-            },
+            headers,
             body: JSON.stringify({
                 image: resizedImage,
                 prompt: options.prompt,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@coreviz/sdk",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "CoreViz SDK",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -34,4 +34,4 @@
   "dependencies": {
     "sharp": "^0.34.5"
   }
-}
+}