@bangkeut-technology/supportdock-sdk 0.1.0

package/README.md

@@ -0,0 +1,135 @@
+# @bangkeut-technology/supportdock-sdk
+
+Official SDK for [SupportDock](https://supportdock.io) — submit feedback and manage FAQs from your React Native / Expo app.
+
+## Install
+
+```bash
+npm install @bangkeut-technology/supportdock-sdk
+```
+
+## Quick Start
+
+```ts
+import { SupportDockClient } from '@bangkeut-technology/supportdock-sdk';
+
+const sdk = new SupportDockClient({
+    apiKey: 'sdk_your_api_key',
+});
+
+// Submit feedback
+await sdk.sendFeedback({
+    type: 'bug',
+    message: 'App crashes when opening settings',
+    email: 'user@example.com',
+    metadata: { appVersion: '2.1.0', platform: 'ios' },
+});
+
+// List FAQs
+const faqs = await sdk.listFAQs();
+```
+
+## React Hook (Expo / React Native)
+
+```tsx
+import { useSupportDock } from '@bangkeut-technology/supportdock-sdk';
+import { Platform } from 'react-native';
+
+function FeedbackScreen() {
+    const { sendFeedback, loading, error, success } = useSupportDock({
+        apiKey: 'sdk_your_api_key',
+        defaultMetadata: {
+            appVersion: '2.1.0',
+            platform: Platform.OS,
+        },
+    });
+
+    const handleSubmit = async () => {
+        await sendFeedback({
+            type: 'bug',
+            message: 'Something went wrong',
+            email: userEmail,
+        });
+    };
+
+    if (success) return <Text>Thanks for your feedback!</Text>;
+
+    return (
+        <View>
+            <Button onPress={handleSubmit} disabled={loading} title="Send Feedback" />
+            {error && <Text style={{ color: 'red' }}>{error}</Text>}
+        </View>
+    );
+}
+```
+
+## API
+
+### `SupportDockClient`
+
+```ts
+const sdk = new SupportDockClient({
+    apiKey: string;          // Required — your app's API key (starts with sdk_)
+    baseUrl?: string;        // Default: 'https://supportdock.io'
+    defaultMetadata?: Record<string, string>;  // Merged into every feedback submission
+    timeout?: number;        // Request timeout in ms (default: 10000)
+});
+```
+
+### Feedback
+
+```ts
+// Submit feedback
+await sdk.sendFeedback({
+    type: 'bug' | 'feature' | 'question' | 'general',  // default: 'general'
+    message: string,         // required
+    email?: string,
+    name?: string,
+    subject?: string,        // auto-generated from type if omitted
+    metadata?: Record<string, string>,
+    source?: string,         // default: 'mobile-app'
+});
+```
+
+### FAQs
+
+```ts
+// List all FAQs
+const faqs = await sdk.listFAQs();
+
+// Create FAQ
+const faq = await sdk.createFAQ({ question: '...', answer: '...', sortOrder: 0 });
+
+// Update FAQ
+await sdk.updateFAQ(faqId, { answer: 'Updated answer' });
+
+// Delete FAQ
+await sdk.deleteFAQ(faqId);
+```
+
+### Error Handling
+
+```ts
+import { SupportDockError } from '@bangkeut-technology/supportdock-sdk';
+
+try {
+    await sdk.sendFeedback({ message: '...' });
+} catch (err) {
+    if (err instanceof SupportDockError) {
+        console.log(err.message); // Error message from API
+        console.log(err.status);  // HTTP status code (401, 429, etc.)
+    }
+}
+```
+
+## Get Your API Key
+
+1. Go to your app dashboard on [supportdock.io](https://supportdock.io)
+2. Click **Generate API key**
+3. Copy the key (starts with `sdk_`)
+
+Requires a Pro plan.
+
+## License
+
+MIT

package/dist/client.d.ts

@@ -0,0 +1,31 @@
+import type { SupportDockConfig, FeedbackOptions, FeedbackResult, FAQ, CreateFAQOptions, UpdateFAQOptions } from './types';
+export declare class SupportDockClient {
+    private apiKey;
+    private baseUrl;
+    private defaultMetadata;
+    private timeout;
+    constructor(config: SupportDockConfig);
+    private request;
+    /**
+     * Submit feedback from your app.
+     *
+     * ```ts
+     * await sdk.sendFeedback({ type: 'bug', message: 'App crashes on launch' });
+     * ```
+     */
+    sendFeedback(options: FeedbackOptions): Promise<FeedbackResult>;
+    /** List all FAQ entries for this app. */
+    listFAQs(): Promise<FAQ[]>;
+    /** Create a new FAQ entry. */
+    createFAQ(options: CreateFAQOptions): Promise<FAQ>;
+    /** Update an existing FAQ entry. */
+    updateFAQ(faqId: string, options: UpdateFAQOptions): Promise<FAQ>;
+    /** Delete a FAQ entry. */
+    deleteFAQ(faqId: string): Promise<{
+        success: boolean;
+    }>;
+}
+export declare class SupportDockError extends Error {
+    status: number;
+    constructor(message: string, status: number);
+}

package/dist/client.js

@@ -0,0 +1,95 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SupportDockError = exports.SupportDockClient = void 0;
+const DEFAULT_BASE_URL = 'https://supportdock.io';
+const DEFAULT_TIMEOUT = 10000;
+class SupportDockClient {
+    constructor(config) {
+        if (!config.apiKey)
+            throw new Error('SupportDock: apiKey is required');
+        this.apiKey = config.apiKey;
+        this.baseUrl = (config.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, '');
+        this.defaultMetadata = config.defaultMetadata ?? {};
+        this.timeout = config.timeout ?? DEFAULT_TIMEOUT;
+    }
+    async request(path, options = {}) {
+        const controller = new AbortController();
+        const timer = setTimeout(() => controller.abort(), this.timeout);
+        try {
+            const res = await fetch(`${this.baseUrl}${path}`, {
+                ...options,
+                signal: controller.signal,
+                headers: {
+                    'Content-Type': 'application/json',
+                    'x-api-key': this.apiKey,
+                    ...options.headers,
+                },
+            });
+            const data = await res.json();
+            if (!res.ok) {
+                throw new SupportDockError(data.error ?? `Request failed with status ${res.status}`, res.status);
+            }
+            return data;
+        }
+        finally {
+            clearTimeout(timer);
+        }
+    }
+    // ─── Feedback ────────────────────────────────────────────────
+    /**
+     * Submit feedback from your app.
+     *
+     * ```ts
+     * await sdk.sendFeedback({ type: 'bug', message: 'App crashes on launch' });
+     * ```
+     */
+    async sendFeedback(options) {
+        const metadata = { ...this.defaultMetadata, ...options.metadata };
+        return this.request('/api/feedback/remote', {
+            method: 'POST',
+            body: JSON.stringify({
+                type: options.type ?? 'general',
+                message: options.message,
+                email: options.email,
+                name: options.name,
+                subject: options.subject,
+                metadata: Object.keys(metadata).length > 0 ? metadata : undefined,
+                source: options.source ?? 'mobile-app',
+            }),
+        });
+    }
+    // ─── FAQ ─────────────────────────────────────────────────────
+    /** List all FAQ entries for this app. */
+    async listFAQs() {
+        return this.request('/api/faqs/remote');
+    }
+    /** Create a new FAQ entry. */
+    async createFAQ(options) {
+        return this.request('/api/faqs/remote', {
+            method: 'POST',
+            body: JSON.stringify(options),
+        });
+    }
+    /** Update an existing FAQ entry. */
+    async updateFAQ(faqId, options) {
+        return this.request(`/api/faqs/remote/${faqId}`, {
+            method: 'PATCH',
+            body: JSON.stringify(options),
+        });
+    }
+    /** Delete a FAQ entry. */
+    async deleteFAQ(faqId) {
+        return this.request(`/api/faqs/remote/${faqId}`, {
+            method: 'DELETE',
+        });
+    }
+}
+exports.SupportDockClient = SupportDockClient;
+class SupportDockError extends Error {
+    constructor(message, status) {
+        super(message);
+        this.name = 'SupportDockError';
+        this.status = status;
+    }
+}
+exports.SupportDockError = SupportDockError;

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSupportDock = exports.SupportDockError = exports.SupportDockClient = void 0;
+var client_1 = require("./client");
+Object.defineProperty(exports, "SupportDockClient", { enumerable: true, get: function () { return client_1.SupportDockClient; } });
+Object.defineProperty(exports, "SupportDockError", { enumerable: true, get: function () { return client_1.SupportDockError; } });
+var react_1 = require("./react");
+Object.defineProperty(exports, "useSupportDock", { enumerable: true, get: function () { return react_1.useSupportDock; } });

package/dist/react.d.ts

@@ -0,0 +1,22 @@
+import { SupportDockClient } from './client';
+import type { SupportDockConfig, FeedbackOptions, FeedbackResult } from './types';
+/**
+ * React hook for submitting feedback from your Expo / React Native app.
+ *
+ * ```tsx
+ * const { sendFeedback, loading, error, success } = useSupportDock({
+ *   apiKey: 'sdk_your_key',
+ *   defaultMetadata: { appVersion: '2.0.0', platform: Platform.OS },
+ * });
+ *
+ * await sendFeedback({ type: 'bug', message: 'Something went wrong' });
+ * ```
+ */
+export declare function useSupportDock(config: SupportDockConfig): {
+    sendFeedback: (options: FeedbackOptions) => Promise<FeedbackResult>;
+    loading: boolean;
+    error: string | null;
+    success: boolean;
+    reset: () => void;
+    client: SupportDockClient;
+};

package/dist/react.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.useSupportDock = useSupportDock;
+const react_1 = require("react");
+const client_1 = require("./client");
+/**
+ * React hook for submitting feedback from your Expo / React Native app.
+ *
+ * ```tsx
+ * const { sendFeedback, loading, error, success } = useSupportDock({
+ *   apiKey: 'sdk_your_key',
+ *   defaultMetadata: { appVersion: '2.0.0', platform: Platform.OS },
+ * });
+ *
+ * await sendFeedback({ type: 'bug', message: 'Something went wrong' });
+ * ```
+ */
+function useSupportDock(config) {
+    const clientRef = (0, react_1.useRef)(null);
+    if (!clientRef.current) {
+        clientRef.current = new client_1.SupportDockClient(config);
+    }
+    const [loading, setLoading] = (0, react_1.useState)(false);
+    const [error, setError] = (0, react_1.useState)(null);
+    const [success, setSuccess] = (0, react_1.useState)(false);
+    const sendFeedback = (0, react_1.useCallback)(async (options) => {
+        setLoading(true);
+        setError(null);
+        setSuccess(false);
+        try {
+            const result = await clientRef.current.sendFeedback(options);
+            setSuccess(true);
+            return result;
+        }
+        catch (err) {
+            const message = err instanceof Error ? err.message : 'Failed to send feedback';
+            setError(message);
+            return { success: false, error: message };
+        }
+        finally {
+            setLoading(false);
+        }
+    }, []);
+    const reset = (0, react_1.useCallback)(() => {
+        setError(null);
+        setSuccess(false);
+    }, []);
+    return { sendFeedback, loading, error, success, reset, client: clientRef.current };
+}

package/dist/types.d.ts

@@ -0,0 +1,49 @@
+export type FeedbackType = 'bug' | 'feature' | 'question' | 'general';
+export interface FeedbackOptions {
+    /** Feedback type. Defaults to 'general'. */
+    type?: FeedbackType;
+    /** The feedback message (required). */
+    message: string;
+    /** Sender email (optional). */
+    email?: string;
+    /** Sender name (optional). */
+    name?: string;
+    /** Subject line (optional — auto-generated from type if omitted). */
+    subject?: string;
+    /** Arbitrary metadata (e.g. appVersion, platform, deviceModel). */
+    metadata?: Record<string, string>;
+    /** Source identifier (defaults to 'mobile-app'). */
+    source?: string;
+}
+export interface FeedbackResult {
+    success: boolean;
+    error?: string;
+}
+export interface FAQ {
+    id: string;
+    question: string;
+    answer: string;
+    sortOrder: number;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface CreateFAQOptions {
+    question: string;
+    answer: string;
+    sortOrder?: number;
+}
+export interface UpdateFAQOptions {
+    question?: string;
+    answer?: string;
+    sortOrder?: number;
+}
+export interface SupportDockConfig {
+    /** Your app's API key (starts with sdk_). */
+    apiKey: string;
+    /** Base URL. Defaults to https://supportdock.io. */
+    baseUrl?: string;
+    /** Default metadata merged into every feedback submission. */
+    defaultMetadata?: Record<string, string>;
+    /** Request timeout in ms. Defaults to 10000. */
+    timeout?: number;
+}

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -0,0 +1,29 @@
+{
+    "name": "@bangkeut-technology/supportdock-sdk",
+    "version": "0.1.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"],
+    "scripts": {
+        "build": "tsc",
+        "prepublishOnly": "npm run build"
+    },
+    "keywords": ["supportdock", "feedback", "faq", "react-native", "expo", "sdk"],
+    "license": "MIT",
+    "publishConfig": {
+        "access": "public"
+    },
+    "peerDependencies": {
+        "react": ">=18.0.0"
+    },
+    "peerDependenciesMeta": {
+        "react": {
+            "optional": true
+        }
+    },
+    "devDependencies": {
+        "@types/react": "^19.0.0",
+        "typescript": "^5.0.0"
+    }
+}