mikes-php-image-handler 1.0.0

package/README.md

@@ -0,0 +1,64 @@
+# mikes-php-image-handler
+
+A Node.js client for uploading and managing images on a custom PHP image server. It allows you to seamlessly upload images from a backend server (e.g. Express, Next.js) to a remote PHP server that optimizes them and stores them efficiently.
+
+## Installation
+
+```bash
+npm install mikes-php-image-handler
+```
+
+## Usage Example
+
+```javascript
+const { VampireImageClient } = require('mikes-php-image-handler');
+const fs = require('fs');
+
+// Initialize the client
+const imageClient = new VampireImageClient({
+    baseUrl: 'https://img.miketsak.gr',
+    apiKey: 'your_api_key_here'
+});
+
+async function run() {
+    // 1. Upload an Image
+    const fileBuffer = fs.readFileSync('./test-image.jpg');
+    // For buffers, you must provide a filename so the server knows the extension
+    const uploadResult = await imageClient.uploadImage(fileBuffer, 'test-image.jpg');
+    
+    if (uploadResult.success) {
+        console.log('Image uploaded successfully!');
+        console.log('URL:', uploadResult.url);
+    } else {
+        console.error('Upload failed:', uploadResult.error);
+    }
+
+    // 2. Delete an Image
+    if (uploadResult.success) {
+        const deleteResult = await imageClient.deleteImage(uploadResult.filename);
+        if (deleteResult.success) {
+            console.log('Image deleted successfully!');
+        }
+    }
+}
+
+run();
+```
+
+## API Reference
+
+### `new VampireImageClient(options)`
+- `options.baseUrl`: The URL of your PHP image API (e.g., `https://img.miketsak.gr`).
+- `options.apiKey`: The secret API key used for authentication.
+
+### `uploadImage(file, filename?)`
+- `file`: Can be a `Buffer`, a `Blob`, or a `File` object.
+- `filename`: Required if `file` is a Buffer. Represents the original name of the file (e.g., `avatar.png`).
+- **Returns**: A Promise resolving to an object `{ success: boolean, url?: string, filename?: string, error?: string }`.
+
+### `deleteImage(filename)`
+- `filename`: The name of the file on the remote server to delete (e.g., `img_669cdb8a4f.jpg`).
+- **Returns**: A Promise resolving to an object `{ success: boolean, message?: string, error?: string }`.
+
+## License
+ISC

package/dist/index.d.ts

@@ -0,0 +1,32 @@
+export interface VampireImageClientOptions {
+    apiKey: string;
+    baseUrl: string;
+}
+export interface UploadResponse {
+    success?: boolean;
+    url?: string;
+    filename?: string;
+    error?: string;
+}
+export interface DeleteResponse {
+    success?: boolean;
+    message?: string;
+    error?: string;
+}
+export declare class VampireImageClient {
+    private apiKey;
+    private baseUrl;
+    constructor(options: VampireImageClientOptions);
+    private getHeaders;
+    /**
+     * Upload an image to the PHP server.
+     * @param file A standard File or Blob object (from browser)
+     * @param filename Optional filename (mainly for Node.js usage where Blob might not have a name)
+     */
+    uploadImage(file: Blob, filename?: string): Promise<UploadResponse>;
+    /**
+     * Delete an image by its filename
+     * @param filename The exact filename (e.g., 'img_123.jpg')
+     */
+    deleteImage(filename: string): Promise<DeleteResponse>;
+}

package/dist/index.js

@@ -0,0 +1,77 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.VampireImageClient = void 0;
+class VampireImageClient {
+    apiKey;
+    baseUrl;
+    constructor(options) {
+        this.apiKey = options.apiKey;
+        this.baseUrl = options.baseUrl.replace(/\/$/, '');
+    }
+    getHeaders(isFormData = false) {
+        const headers = {
+            'Authorization': `Bearer ${this.apiKey}`
+        };
+        if (!isFormData) {
+            headers['Content-Type'] = 'application/json';
+        }
+        return headers;
+    }
+    /**
+     * Upload an image to the PHP server.
+     * @param file A standard File or Blob object (from browser)
+     * @param filename Optional filename (mainly for Node.js usage where Blob might not have a name)
+     */
+    async uploadImage(file, filename) {
+        const formData = new FormData();
+        if (filename) {
+            formData.append('image', file, filename);
+        }
+        else {
+            formData.append('image', file);
+        }
+        try {
+            const response = await fetch(`${this.baseUrl}/upload`, {
+                method: 'POST',
+                headers: this.getHeaders(true),
+                body: formData
+            });
+            if (!response.ok) {
+                const text = await response.text();
+                throw new Error(`Upload failed with status ${response.status}: ${text}`);
+            }
+            const data = await response.json();
+            return data;
+        }
+        catch (error) {
+            return {
+                error: error instanceof Error ? error.message : String(error)
+            };
+        }
+    }
+    /**
+     * Delete an image by its filename
+     * @param filename The exact filename (e.g., 'img_123.jpg')
+     */
+    async deleteImage(filename) {
+        try {
+            const response = await fetch(`${this.baseUrl}/delete`, {
+                method: 'DELETE',
+                headers: this.getHeaders(),
+                body: JSON.stringify({ filename })
+            });
+            if (!response.ok) {
+                const text = await response.text();
+                throw new Error(`Delete failed with status ${response.status}: ${text}`);
+            }
+            const data = await response.json();
+            return data;
+        }
+        catch (error) {
+            return {
+                error: error instanceof Error ? error.message : String(error)
+            };
+        }
+    }
+}
+exports.VampireImageClient = VampireImageClient;

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "mikes-php-image-handler",
+  "version": "1.0.0",
+  "description": "A Node.js client for uploading and managing images on a custom PHP image server.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc",
+    "watch": "tsc -w"
+  },
+  "devDependencies": {
+    "typescript": "^5.0.0",
+    "@types/node": "^20.0.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,100 @@
+export interface VampireImageClientOptions {
+    apiKey: string;
+    baseUrl: string;
+}
+
+export interface UploadResponse {
+    success?: boolean;
+    url?: string;
+    filename?: string;
+    error?: string;
+}
+
+export interface DeleteResponse {
+    success?: boolean;
+    message?: string;
+    error?: string;
+}
+
+export class VampireImageClient {
+    private apiKey: string;
+    private baseUrl: string;
+
+    constructor(options: VampireImageClientOptions) {
+        this.apiKey = options.apiKey;
+        this.baseUrl = options.baseUrl.replace(/\/$/, '');
+    }
+
+    private getHeaders(isFormData = false): HeadersInit {
+        const headers: HeadersInit = {
+            'Authorization': `Bearer ${this.apiKey}`
+        };
+        
+        if (!isFormData) {
+            headers['Content-Type'] = 'application/json';
+        }
+
+        return headers;
+    }
+
+    /**
+     * Upload an image to the PHP server.
+     * @param file A standard File or Blob object (from browser)
+     * @param filename Optional filename (mainly for Node.js usage where Blob might not have a name)
+     */
+    async uploadImage(file: Blob, filename?: string): Promise<UploadResponse> {
+        const formData = new FormData();
+        
+        if (filename) {
+            formData.append('image', file, filename);
+        } else {
+            formData.append('image', file);
+        }
+
+        try {
+            const response = await fetch(`${this.baseUrl}/upload`, {
+                method: 'POST',
+                headers: this.getHeaders(true),
+                body: formData
+            });
+
+            if (!response.ok) {
+                const text = await response.text();
+                throw new Error(`Upload failed with status ${response.status}: ${text}`);
+            }
+
+            const data: UploadResponse = await response.json();
+            return data;
+        } catch (error) {
+            return {
+                error: error instanceof Error ? error.message : String(error)
+            };
+        }
+    }
+
+    /**
+     * Delete an image by its filename
+     * @param filename The exact filename (e.g., 'img_123.jpg')
+     */
+    async deleteImage(filename: string): Promise<DeleteResponse> {
+        try {
+            const response = await fetch(`${this.baseUrl}/delete`, {
+                method: 'DELETE',
+                headers: this.getHeaders(),
+                body: JSON.stringify({ filename })
+            });
+
+            if (!response.ok) {
+                const text = await response.text();
+                throw new Error(`Delete failed with status ${response.status}: ${text}`);
+            }
+
+            const data: DeleteResponse = await response.json();
+            return data;
+        } catch (error) {
+            return {
+                error: error instanceof Error ? error.message : String(error)
+            };
+        }
+    }
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "compilerOptions": {
+    "target": "es2022",
+    "module": "commonjs",
+    "declaration": true,
+    "outDir": "./dist",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"]
+}