@immagin/client 0.2.0 → 0.2.2

package/README.md

@@ -17,19 +17,20 @@ import { Immagin } from '@immagin/client'
 
 const client = new Immagin({ apiKey: 'imk_...' })
 
-// Get a processed image URL
+// Get a processed image URL (via API)
 const url = await client.images.url('photos/hero.jpg', {
   size: [800, 600],
 })
 
 // Upload an image
-const file = new Blob([buffer], { type: 'image/jpeg' })
-await client.images.upload(file, { key: 'photos/hero.jpg' })
+import { readFileSync } from 'node:fs'
+const buffer = readFileSync('photo.jpg')
+await client.images.upload(buffer, 'photos/hero.jpg')
 ```
 
 ## Images
 
-### Get a processed URL
+### Get a processed URL (via API)
 
 Returns a signed URL that serves the image through Immagin's processing pipeline.
 
@@ -41,8 +42,7 @@ With transformations:
 
 ```ts
 const url = await client.images.url('photo.jpg', {
-  size: [400],          // width only
-  size: [400, 300],     // width and height
+  size: [400, 300],
   text: {
     text: 'Hello',
     position: 'bottom-right', // top-left, top-right, bottom-left, bottom-right, center
@@ -53,36 +53,54 @@ const url = await client.images.url('photo.jpg', {
 })
 ```
 
-### Get a pre-signed upload URL
+### Sign URLs locally (without API call)
 
-Returns a pre-signed S3 URL for direct upload. Useful when you need to handle the upload yourself (e.g. from a mobile app or with a custom upload flow).
+Generate signed image URLs on the server without making an API request. Requires `tenantId` and `tenantSecret` in the constructor.
 
 ```ts
-const { uploadUrl, key } = await client.images.signUrl('photos/hero.jpg', 'image/jpeg')
+const client = new Immagin({
+  apiKey: 'imk_...',
+  tenantId: 'your-tenant-id',
+  tenantSecret: 'your-tenant-secret',
+})
 
-// Upload directly to S3 yourself
-await fetch(uploadUrl, { method: 'PUT', body: file })
+// Synchronous - no network request
+const url = client.images.signedUrl('photo.jpg')
+
+// With transformations
+const thumb = client.images.signedUrl('photo.jpg', {
+  size: [800, 600],
+  text: { text: '© My Company', position: 'bottom-right', opacity: 0.5 },
+})
 ```
 
-### Upload
+> **Note:** This uses `node:crypto` and is intended for server-side use only. Never expose your tenant secret in client-side code.
 
-Convenience method that gets a signed URL and uploads in one call. The file goes directly to S3 and never passes through the API.
+### Get a pre-signed upload URL
+
+Returns a pre-signed S3 URL for direct upload (expires in 5 minutes). Useful for browser uploads where you don't want to expose your API key.
 
 ```ts
-// Browser
-const input = document.querySelector('input[type="file"]')
-await client.images.upload(input.files[0], {
-  key: 'uploads/photo.jpg',
-  contentType: 'image/jpeg',
+// Server: get the presigned URL
+const { uploadUrl, key } = await client.images.signUrl('photos/hero.jpg')
+// Return uploadUrl to the browser
+
+// Browser: upload directly to S3
+await fetch(uploadUrl, {
+  method: 'PUT',
+  body: file,
 })
+```
 
-// Node.js
+### Upload (Node.js)
+
+Convenience method that gets a signed URL and uploads in one call. The file goes directly to S3 and never passes through the API.
+
+```ts
 import { readFileSync } from 'node:fs'
+
 const buffer = readFileSync('photo.jpg')
-await client.images.upload(buffer, {
-  key: 'uploads/photo.jpg',
-  contentType: 'image/jpeg',
-})
+await client.images.upload(buffer, 'uploads/photo.jpg')
 ```
 
 ### List
@@ -107,7 +125,7 @@ await client.images.delete('uploads/photo.jpg')
 
 ## API Keys
 
-Manage API keys programmatically. Useful for building admin tools or rotating keys.
+Manage API keys programmatically.
 
 ### Create
 
@@ -151,8 +169,10 @@ try {
 
 ```ts
 const client = new Immagin({
-  apiKey: 'imk_...',       // Required
-  baseUrl: 'https://...',  // Optional, defaults to https://gateway.immag.in
+  apiKey: 'imk_...',              // Required
+  baseUrl: 'https://...',         // Optional, defaults to https://gateway.immag.in
+  tenantId: 'your-tenant-id',     // Optional, required for signedUrl()
+  tenantSecret: 'your-secret',    // Optional, required for signedUrl()
 })
 ```
 

package/dist/index.d.mts

@@ -13,10 +13,6 @@ interface ImageEdits {
   text?: TextOverlay;
 }
 interface ImageUrlOptions extends ImageEdits {}
-interface UploadOptions {
-  key: string;
-  contentType?: string;
-}
 interface UploadResult {
   uploadUrl: string;
   key: string;
@@ -60,8 +56,8 @@ declare class ImagesResource {
   constructor(client: Immagin);
   signedUrl(key: string, edits?: ImageEdits): string;
   url(key: string, options?: ImageUrlOptions): Promise<string>;
-  signUrl(key: string, contentType?: string): Promise<UploadResult>;
-  upload(file: Blob | Buffer | ReadableStream, options: UploadOptions): Promise<UploadResult>;
+  signUrl(key: string): Promise<UploadResult>;
+  upload(file: Blob | Buffer | ReadableStream, key: string): Promise<UploadResult>;
   list(options?: ListImagesOptions): Promise<ListImagesResult>;
   delete(key: string): Promise<void>;
 }
@@ -102,4 +98,4 @@ declare class ImmaginError extends Error {
   constructor(message: string, status: number, body?: unknown | undefined);
 }
 //#endregion
-export { type ApiKey, type CreateKeyResult, type ImageEdits, type ImageEntry, type ImageUrlOptions, Immagin, type ImmaginConfig, ImmaginError, type ListImagesOptions, type ListImagesResult, type TextOverlay, type TextPosition, type UploadOptions, type UploadResult };
+export { type ApiKey, type CreateKeyResult, type ImageEdits, type ImageEntry, type ImageUrlOptions, Immagin, type ImmaginConfig, ImmaginError, type ListImagesOptions, type ListImagesResult, type TextOverlay, type TextPosition, type UploadResult };

package/dist/index.mjs

@@ -1,6 +1,43 @@
 import { createHmac } from "node:crypto";
 
 //#region src/resources/images.ts
+const MIME_TYPES = {
+	jpg: "image/jpeg",
+	jpeg: "image/jpeg",
+	png: "image/png",
+	gif: "image/gif",
+	webp: "image/webp",
+	avif: "image/avif",
+	svg: "image/svg+xml",
+	tiff: "image/tiff",
+	tif: "image/tiff",
+	bmp: "image/bmp",
+	ico: "image/x-icon",
+	heic: "image/heic",
+	heif: "image/heif"
+};
+function mimeFromKey(key) {
+	const ext = key.split(".").pop()?.toLowerCase();
+	return ext ? MIME_TYPES[ext] : void 0;
+}
+function mimeFromBuffer(buf) {
+	if (buf.length < 12) return void 0;
+	if (buf[0] === 255 && buf[1] === 216 && buf[2] === 255) return "image/jpeg";
+	if (buf[0] === 137 && buf[1] === 80 && buf[2] === 78 && buf[3] === 71) return "image/png";
+	if (buf[0] === 71 && buf[1] === 73 && buf[2] === 70) return "image/gif";
+	if (buf[0] === 82 && buf[1] === 73 && buf[2] === 70 && buf[3] === 70 && buf[8] === 87 && buf[9] === 69 && buf[10] === 66 && buf[11] === 80) return "image/webp";
+	if (buf[0] === 66 && buf[1] === 77) return "image/bmp";
+	if (buf[4] === 102 && buf[5] === 116 && buf[6] === 121 && buf[7] === 112) {
+		const brand = buf.slice(8, 12).toString("ascii");
+		if (brand === "avif" || brand === "avis") return "image/avif";
+		if (brand === "heic" || brand === "heix") return "image/heic";
+		if (brand === "heif" || brand === "mif1") return "image/heif";
+	}
+}
+function mimeFromFile(file) {
+	if (typeof Blob !== "undefined" && file instanceof Blob && file.type) return file.type;
+	if (typeof Buffer !== "undefined" && Buffer.isBuffer(file)) return mimeFromBuffer(file);
+}
 var ImagesResource = class {
 	constructor(client) {
 		this.client = client;
@@ -28,15 +65,19 @@ var ImagesResource = class {
 		}
 		return (await this.client.request("GET", "/v1/images/url", { params })).url;
 	}
-	async signUrl(key, contentType) {
-		return this.client.request("POST", "/v1/images/sign-url", { body: {
+	async signUrl(key) {
+		const contentType = mimeFromKey(key);
+		return this.client.request("POST", "/v1/images/sign-url", { body: contentType ? {
 			key,
-			contentType: contentType || "application/octet-stream"
-		} });
+			contentType
+		} : { key } });
 	}
-	async upload(file, options) {
-		const { key, contentType } = options;
-		const signResult = await this.signUrl(key, contentType);
+	async upload(file, key) {
+		const contentType = mimeFromFile(file) ?? mimeFromKey(key);
+		const signResult = await this.client.request("POST", "/v1/images/sign-url", { body: contentType ? {
+			key,
+			contentType
+		} : { key } });
 		await fetch(signResult.uploadUrl, {
 			method: "PUT",
 			body: file,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@immagin/client",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "description": "Node.js and browser client for the Immagin image processing API",
   "type": "module",
   "license": "MIT",
@@ -34,15 +34,14 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsdown",
-    "dev": "tsdown --watch",
-    "test": "vitest run",
-    "prepublishOnly": "tsdown"
-  },
   "devDependencies": {
     "tsdown": "^0.20.3",
     "typescript": "^5.7.2",
     "vitest": "^3.0.5"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest run"
   }
-}
+}