@bangkeut-technology/supportdock-sdk 0.2.0 → 0.4.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

@@ -89,6 +89,7 @@ await sdk.sendFeedback({
     metadata?: Record<string, string>,
     source?: string,         // default: 'mobile-app'
     images?: string[],       // up to 3 base64 data URLs (PNG/JPEG/WebP/GIF, each ≤ 2 MB)
+    attachments?: { name: string; data: string }[],  // up to 3 PDFs (each ≤ 5 MB)
 });
 ```
 
@@ -109,6 +110,23 @@ await sdk.sendFeedback({
 });
 ```
 
+#### Attaching PDFs
+
+```ts
+// Convert a local PDF to base64 (React Native example)
+import * as FileSystem from 'expo-file-system';
+
+const base64 = await FileSystem.readAsStringAsync(pdfUri, {
+    encoding: FileSystem.EncodingType.Base64,
+});
+
+await sdk.sendFeedback({
+    type: 'bug',
+    message: 'Steps to reproduce are in the attached report',
+    attachments: [{ name: 'report.pdf', data: `data:application/pdf;base64,${base64}` }],
+});
+```
+
 ### FAQs
 
 ```ts

package/dist/client.js

@@ -55,7 +55,20 @@ class SupportDockClient {
                 }
             }
         }
-        return this.request('/api/feedback/remote', {
+        if (options.attachments) {
+            if (options.attachments.length > 3) {
+                throw new SupportDockError('Maximum 3 PDF attachments allowed', 400);
+            }
+            for (const att of options.attachments) {
+                if (!att?.name) {
+                    throw new SupportDockError('Each attachment requires a name', 400);
+                }
+                if (!/^data:application\/pdf;base64,/.test(att.data ?? '')) {
+                    throw new SupportDockError('Attachments must be base64-encoded PDF data URLs', 400);
+                }
+            }
+        }
+        return this.request('/api/v1/feedback/remote', {
             method: 'POST',
             body: JSON.stringify({
                 type: options.type ?? 'general',
@@ -66,31 +79,32 @@ class SupportDockClient {
                 metadata: Object.keys(metadata).length > 0 ? metadata : undefined,
                 source: options.source ?? 'mobile-app',
                 images: options.images,
+                attachments: options.attachments,
             }),
         });
     }
     // ─── 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/index.d.ts

@@ -1,3 +1,3 @@
 export { SupportDockClient, SupportDockError } from './client';
 export { useSupportDock } from './react';
-export type { SupportDockConfig, FeedbackOptions, FeedbackResult, FeedbackType, FAQ, CreateFAQOptions, UpdateFAQOptions, } from './types';
+export type { SupportDockConfig, FeedbackOptions, FeedbackAttachment, FeedbackResult, FeedbackType, FAQ, CreateFAQOptions, UpdateFAQOptions, } from './types';

package/dist/types.d.ts

@@ -1,4 +1,10 @@
 export type FeedbackType = 'bug' | 'feature' | 'question' | 'general';
+export interface FeedbackAttachment {
+    /** Display filename, e.g. "logs.pdf". */
+    name: string;
+    /** Base64-encoded PDF data URL (data:application/pdf;base64,…); ≤ 5 MB. */
+    data: string;
+}
 export interface FeedbackOptions {
     /** Feedback type. Defaults to 'general'. */
     type?: FeedbackType;
@@ -16,6 +22,8 @@ export interface FeedbackOptions {
     source?: string;
     /** Up to 3 base64-encoded data-URL images (PNG, JPEG, WebP, or GIF; each ≤ 2 MB). */
     images?: string[];
+    /** Up to 3 PDF files ({ name, data }); each ≤ 5 MB. */
+    attachments?: FeedbackAttachment[];
 }
 export interface FeedbackResult {
     success: boolean;

package/package.json

@@ -1,7 +1,11 @@
 {
     "name": "@bangkeut-technology/supportdock-sdk",
-    "version": "0.2.0",
+    "version": "0.4.0",
     "description": "SupportDock SDK — submit feedback and manage FAQs from your React Native / Expo app",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/bangkeut-technology/supportdock-sdk-js.git"
+    },
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "files": [