edsger-feedback 0.1.0

package/README.md

@@ -0,0 +1,87 @@
+# edsger-feedback
+
+Submit user feedback to [Edsger](https://edsger.ai) products programmatically.
+
+## Installation
+
+```bash
+npm install edsger-feedback
+```
+
+## Quick Start
+
+```ts
+import { submitFeedback } from 'edsger-feedback'
+
+const result = await submitFeedback({
+  slug: 'spoke-translator',
+  title: 'Add dark mode',
+  description: 'It would be great to have a dark mode option.',
+  category: 'feature_request',
+  reporterEmail: 'user@example.com',
+})
+
+console.log('Feedback submitted:', result.id)
+```
+
+## API
+
+### `submitFeedback(options)`
+
+Submit feedback for a product. Returns `Promise<FeedbackResult>`.
+
+| Option | Type | Required | Description |
+|--------|------|----------|-------------|
+| `slug` | `string` | Yes | Product slug (e.g. `"spoke-translator"`) |
+| `title` | `string` | Yes | Feedback title (max 200 characters) |
+| `description` | `string` | Yes | Feedback description (max 5000 characters) |
+| `category` | `FeedbackCategory` | No | One of `bug`, `feature_request`, `improvement`, `question`, `other`. Defaults to `other` |
+| `reporterName` | `string` | No | Reporter's name |
+| `reporterEmail` | `string` | No | Reporter's email |
+
+**Returns:**
+
+```ts
+{ id: string; createdAt: string }
+```
+
+### `getFeedbackConfig(slug)`
+
+Get the feedback page configuration for a product. Returns `Promise<FeedbackConfig>`.
+
+**Returns:**
+
+```ts
+{
+  productId: string
+  productName: string
+  customTitle: string | null
+  welcomeMessage: string | null
+  slug: string
+}
+```
+
+## Error Handling
+
+All errors are thrown as `FeedbackError` with a `statusCode` property.
+
+```ts
+import { submitFeedback, FeedbackError } from 'edsger-feedback'
+
+try {
+  await submitFeedback({ ... })
+} catch (err) {
+  if (err instanceof FeedbackError) {
+    console.error(err.message, err.statusCode)
+    // e.g. "Too many submissions..." 429
+  }
+}
+```
+
+## Requirements
+
+- Node.js >= 18 (uses native `fetch`)
+
+## License
+
+ISC

package/dist/client.d.ts

@@ -0,0 +1,25 @@
+import type { SubmitFeedbackOptions, FeedbackResult, FeedbackConfig } from './types.js';
+/**
+ * Get the feedback page config for a product slug.
+ * Useful for checking if feedback collection is enabled.
+ */
+export declare function getFeedbackConfig(slug: string): Promise<FeedbackConfig>;
+/**
+ * Submit feedback for a product.
+ *
+ * @example
+ * ```ts
+ * import { submitFeedback } from 'edsger-feedback'
+ *
+ * const result = await submitFeedback({
+ *   slug: 'spoke-translator',
+ *   title: 'Add dark mode',
+ *   description: 'It would be great to have a dark mode option.',
+ *   category: 'feature_request',
+ *   reporterEmail: 'user@example.com',
+ * })
+ *
+ * console.log('Feedback submitted:', result.id)
+ * ```
+ */
+export declare function submitFeedback(options: SubmitFeedbackOptions): Promise<FeedbackResult>;

package/dist/client.js

@@ -0,0 +1,94 @@
+import { FeedbackError } from './types.js';
+const ENDPOINT = 'https://ktkogvogdaffjmvrewiu.supabase.co/functions/v1/public-feedback';
+const VALID_CATEGORIES = [
+    'bug',
+    'feature_request',
+    'improvement',
+    'question',
+    'other',
+];
+/**
+ * Get the feedback page config for a product slug.
+ * Useful for checking if feedback collection is enabled.
+ */
+export async function getFeedbackConfig(slug) {
+    const res = await fetch(`${ENDPOINT}?slug=${encodeURIComponent(slug)}`);
+    const data = await res.json();
+    if (!res.ok) {
+        throw new FeedbackError(data.error || 'Failed to load feedback config', res.status);
+    }
+    const config = data.config;
+    return {
+        productId: config.product_id,
+        productName: config.product_name,
+        customTitle: config.custom_title,
+        welcomeMessage: config.welcome_message,
+        slug: config.slug,
+    };
+}
+/**
+ * Submit feedback for a product.
+ *
+ * @example
+ * ```ts
+ * import { submitFeedback } from 'edsger-feedback'
+ *
+ * const result = await submitFeedback({
+ *   slug: 'spoke-translator',
+ *   title: 'Add dark mode',
+ *   description: 'It would be great to have a dark mode option.',
+ *   category: 'feature_request',
+ *   reporterEmail: 'user@example.com',
+ * })
+ *
+ * console.log('Feedback submitted:', result.id)
+ * ```
+ */
+export async function submitFeedback(options) {
+    validate(options);
+    const res = await fetch(ENDPOINT, {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({
+            slug: options.slug,
+            category: options.category || 'other',
+            title: options.title.trim(),
+            description: options.description.trim(),
+            reporter_name: options.reporterName?.trim() || undefined,
+            reporter_email: options.reporterEmail?.trim() || undefined,
+        }),
+    });
+    const data = await res.json();
+    if (!res.ok) {
+        throw new FeedbackError(data.error || 'Failed to submit feedback', res.status);
+    }
+    return {
+        id: data.feedback.id,
+        createdAt: data.feedback.created_at,
+    };
+}
+function validate(options) {
+    if (!options.slug) {
+        throw new FeedbackError('slug is required', 400);
+    }
+    if (!options.title?.trim()) {
+        throw new FeedbackError('title is required', 400);
+    }
+    if (options.title.length > 200) {
+        throw new FeedbackError('title must be 200 characters or less', 400);
+    }
+    if (!options.description?.trim()) {
+        throw new FeedbackError('description is required', 400);
+    }
+    if (options.description.length > 5000) {
+        throw new FeedbackError('description must be 5000 characters or less', 400);
+    }
+    if (options.category &&
+        !VALID_CATEGORIES.includes(options.category)) {
+        throw new FeedbackError(`Invalid category. Must be one of: ${VALID_CATEGORIES.join(', ')}`, 400);
+    }
+    if (options.reporterEmail &&
+        !/^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(options.reporterEmail)) {
+        throw new FeedbackError('Invalid email format', 400);
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+export { submitFeedback, getFeedbackConfig } from './client.js';
+export { FeedbackError, type SubmitFeedbackOptions, type FeedbackResult, type FeedbackConfig, type FeedbackCategory, } from './types.js';

package/dist/index.js

@@ -0,0 +1,2 @@
+export { submitFeedback, getFeedbackConfig } from './client.js';
+export { FeedbackError, } from './types.js';

package/dist/types.d.ts

@@ -0,0 +1,30 @@
+export type FeedbackCategory = 'bug' | 'feature_request' | 'improvement' | 'question' | 'other';
+export interface SubmitFeedbackOptions {
+    /** Product slug, e.g. "spoke-translator" */
+    slug: string;
+    /** Feedback title (required, max 200 characters) */
+    title: string;
+    /** Feedback description (required, max 5000 characters) */
+    description: string;
+    /** Feedback category (defaults to "other") */
+    category?: FeedbackCategory;
+    /** Reporter name (optional) */
+    reporterName?: string;
+    /** Reporter email (optional, used for rate limiting) */
+    reporterEmail?: string;
+}
+export interface FeedbackResult {
+    id: string;
+    createdAt: string;
+}
+export interface FeedbackConfig {
+    productId: string;
+    productName: string;
+    customTitle: string | null;
+    welcomeMessage: string | null;
+    slug: string;
+}
+export declare class FeedbackError extends Error {
+    readonly statusCode: number;
+    constructor(message: string, statusCode: number);
+}

package/dist/types.js

@@ -0,0 +1,8 @@
+export class FeedbackError extends Error {
+    statusCode;
+    constructor(message, statusCode) {
+        super(message);
+        this.statusCode = statusCode;
+        this.name = 'FeedbackError';
+    }
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "edsger-feedback",
+  "version": "0.1.0",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "tsc",
+    "dev": "tsc --watch",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "edsger",
+    "feedback",
+    "user-feedback",
+    "product-feedback"
+  ],
+  "author": "",
+  "license": "ISC",
+  "description": "Submit user feedback to Edsger products programmatically",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/stevenzg/edsger.git",
+    "directory": "packages/feedback"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "devDependencies": {
+    "@types/node": "^20.0.0",
+    "typescript": "^5.0.0"
+  }
+}