@bangkeut-technology/supportdock-sdk 0.1.0 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 SupportDock
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -88,6 +88,24 @@ await sdk.sendFeedback({
     subject?: string,        // auto-generated from type if omitted
     metadata?: Record<string, string>,
     source?: string,         // default: 'mobile-app'
+    images?: string[],       // up to 3 base64 data URLs (PNG/JPEG/WebP/GIF, each ≤ 2 MB)
+});
+```
+
+#### Attaching images
+
+```ts
+// Convert a local image to base64 (React Native example)
+import * as FileSystem from 'expo-file-system';
+
+const base64 = await FileSystem.readAsStringAsync(imageUri, {
+    encoding: FileSystem.EncodingType.Base64,
+});
+
+await sdk.sendFeedback({
+    type: 'bug',
+    message: 'UI is broken on this screen',
+    images: [`data:image/png;base64,${base64}`],
 });
 ```
 
@@ -117,7 +135,7 @@ try {
 } catch (err) {
     if (err instanceof SupportDockError) {
         console.log(err.message); // Error message from API
-        console.log(err.status);  // HTTP status code (401, 429, etc.)
+        console.log(err.status); // HTTP status code (401, 429, etc.)
     }
 }
 ```

package/dist/client.js

@@ -45,7 +45,17 @@ class SupportDockClient {
      */
     async sendFeedback(options) {
         const metadata = { ...this.defaultMetadata, ...options.metadata };
-        return this.request('/api/feedback/remote', {
+        if (options.images) {
+            if (options.images.length > 3) {
+                throw new SupportDockError('Maximum 3 images allowed', 400);
+            }
+            for (const img of options.images) {
+                if (!/^data:image\/(png|jpeg|webp|gif);base64,/.test(img)) {
+                    throw new SupportDockError('Images must be base64-encoded data URLs (PNG, JPEG, WebP, or GIF)', 400);
+                }
+            }
+        }
+        return this.request('/api/v1/feedback/remote', {
             method: 'POST',
             body: JSON.stringify({
                 type: options.type ?? 'general',
@@ -55,31 +65,32 @@ class SupportDockClient {
                 subject: options.subject,
                 metadata: Object.keys(metadata).length > 0 ? metadata : undefined,
                 source: options.source ?? 'mobile-app',
+                images: options.images,
             }),
         });
     }
     // ─── FAQ ─────────────────────────────────────────────────────
     /** List all FAQ entries for this app. */
     async listFAQs() {
-        return this.request('/api/faqs/remote');
+        return this.request('/api/v1/faqs/remote');
     }
     /** Create a new FAQ entry. */
     async createFAQ(options) {
-        return this.request('/api/faqs/remote', {
+        return this.request('/api/v1/faqs/remote', {
             method: 'POST',
             body: JSON.stringify(options),
         });
     }
     /** Update an existing FAQ entry. */
     async updateFAQ(faqId, options) {
-        return this.request(`/api/faqs/remote/${faqId}`, {
+        return this.request(`/api/v1/faqs/remote/${faqId}`, {
             method: 'PATCH',
             body: JSON.stringify(options),
         });
     }
     /** Delete a FAQ entry. */
     async deleteFAQ(faqId) {
-        return this.request(`/api/faqs/remote/${faqId}`, {
+        return this.request(`/api/v1/faqs/remote/${faqId}`, {
             method: 'DELETE',
         });
     }

package/dist/types.d.ts

@@ -14,6 +14,8 @@ export interface FeedbackOptions {
     metadata?: Record<string, string>;
     /** Source identifier (defaults to 'mobile-app'). */
     source?: string;
+    /** Up to 3 base64-encoded data-URL images (PNG, JPEG, WebP, or GIF; each ≤ 2 MB). */
+    images?: string[];
 }
 export interface FeedbackResult {
     success: boolean;

package/package.json

@@ -1,15 +1,24 @@
 {
     "name": "@bangkeut-technology/supportdock-sdk",
-    "version": "0.1.0",
+    "version": "0.3.0",
     "description": "SupportDock SDK — submit feedback and manage FAQs from your React Native / Expo app",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
-    "files": ["dist"],
+    "files": [
+        "dist"
+    ],
     "scripts": {
         "build": "tsc",
         "prepublishOnly": "npm run build"
     },
-    "keywords": ["supportdock", "feedback", "faq", "react-native", "expo", "sdk"],
+    "keywords": [
+        "supportdock",
+        "feedback",
+        "faq",
+        "react-native",
+        "expo",
+        "sdk"
+    ],
     "license": "MIT",
     "publishConfig": {
         "access": "public"