@patch-adams/plugin-feedback 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,331 @@
+import { PatchAdamsPlugin } from '@patch-adams/core';
+import { z } from 'zod';
+
+/**
+ * Issue subtype definition
+ */
+declare const IssueSubtypeSchema: z.ZodObject<{
+    /** Unique identifier for the subtype */
+    id: z.ZodString;
+    /** Display label for the subtype */
+    label: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+}, {
+    id: string;
+    label: string;
+}>;
+/**
+ * Issue type definition with optional subtypes
+ */
+declare const IssueTypeSchema: z.ZodObject<{
+    /** Unique identifier for the issue type */
+    id: z.ZodString;
+    /** Display label for the issue type */
+    label: z.ZodString;
+    /** Optional subtypes that appear when this type is selected */
+    subtypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        /** Unique identifier for the subtype */
+        id: z.ZodString;
+        /** Display label for the subtype */
+        label: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+    }, {
+        id: string;
+        label: string;
+    }>, "many">>;
+}, "strip", z.ZodTypeAny, {
+    id: string;
+    label: string;
+    subtypes?: {
+        id: string;
+        label: string;
+    }[] | undefined;
+}, {
+    id: string;
+    label: string;
+    subtypes?: {
+        id: string;
+        label: string;
+    }[] | undefined;
+}>;
+/**
+ * Metadata options - what to include with feedback submissions
+ */
+declare const MetadataOptionsSchema: z.ZodObject<{
+    /** Include the course ID from LRS bridge (if available) */
+    courseId: z.ZodDefault<z.ZodBoolean>;
+    /** Include the current lesson/page ID (URL hash or pathname) */
+    lessonId: z.ZodDefault<z.ZodBoolean>;
+    /** Include the browser user agent */
+    userAgent: z.ZodDefault<z.ZodBoolean>;
+    /** Include timestamp of submission */
+    timestamp: z.ZodDefault<z.ZodBoolean>;
+    /** Include the full current URL */
+    url: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    courseId: boolean;
+    lessonId: boolean;
+    userAgent: boolean;
+    timestamp: boolean;
+    url: boolean;
+}, {
+    courseId?: boolean | undefined;
+    lessonId?: boolean | undefined;
+    userAgent?: boolean | undefined;
+    timestamp?: boolean | undefined;
+    url?: boolean | undefined;
+}>;
+/**
+ * Default issue types if none are provided
+ */
+declare const DEFAULT_ISSUE_TYPES: z.infer<typeof IssueTypeSchema>[];
+/**
+ * Full feedback plugin configuration schema
+ */
+declare const FeedbackConfigSchema: z.ZodObject<{
+    /** Whether the feedback plugin is enabled */
+    enabled: z.ZodDefault<z.ZodBoolean>;
+    /** API endpoint URL for submitting feedback (optional - if not set, logs to console) */
+    endpoint: z.ZodOptional<z.ZodString>;
+    /** HTTP method for the endpoint (default: POST) */
+    method: z.ZodDefault<z.ZodEnum<["POST", "PUT"]>>;
+    /** Additional headers to send with the request */
+    headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    /** Position of the feedback tab (left or right side of screen) */
+    position: z.ZodDefault<z.ZodEnum<["left", "right"]>>;
+    /** Text displayed on the feedback tab */
+    tabText: z.ZodDefault<z.ZodString>;
+    /** Background color of the feedback tab */
+    tabColor: z.ZodDefault<z.ZodString>;
+    /** Text color of the feedback tab */
+    tabTextColor: z.ZodDefault<z.ZodString>;
+    /** Z-index for the feedback widget (default: 9999) */
+    zIndex: z.ZodDefault<z.ZodNumber>;
+    /** Show star rating field */
+    showRating: z.ZodDefault<z.ZodBoolean>;
+    /** Whether rating is required to submit */
+    ratingRequired: z.ZodDefault<z.ZodBoolean>;
+    /** Number of stars in the rating (default: 5) */
+    ratingStars: z.ZodDefault<z.ZodNumber>;
+    /** Show issue type dropdown */
+    showIssueType: z.ZodDefault<z.ZodBoolean>;
+    /** Whether issue type is required to submit */
+    issueTypeRequired: z.ZodDefault<z.ZodBoolean>;
+    /** Available issue types (uses defaults if not provided) */
+    issueTypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        /** Unique identifier for the issue type */
+        id: z.ZodString;
+        /** Display label for the issue type */
+        label: z.ZodString;
+        /** Optional subtypes that appear when this type is selected */
+        subtypes: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            /** Unique identifier for the subtype */
+            id: z.ZodString;
+            /** Display label for the subtype */
+            label: z.ZodString;
+        }, "strip", z.ZodTypeAny, {
+            id: string;
+            label: string;
+        }, {
+            id: string;
+            label: string;
+        }>, "many">>;
+    }, "strip", z.ZodTypeAny, {
+        id: string;
+        label: string;
+        subtypes?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    }, {
+        id: string;
+        label: string;
+        subtypes?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    }>, "many">>;
+    /** Show comment textarea */
+    showComment: z.ZodDefault<z.ZodBoolean>;
+    /** Whether comment is required to submit */
+    commentRequired: z.ZodDefault<z.ZodBoolean>;
+    /** Maximum length for comments (default: 500) */
+    commentMaxLength: z.ZodDefault<z.ZodNumber>;
+    /** Placeholder text for comment field (uses translation if not set) */
+    commentPlaceholder: z.ZodOptional<z.ZodString>;
+    /** Locale for UI text (en or fr) */
+    locale: z.ZodDefault<z.ZodEnum<["en", "fr"]>>;
+    /** Custom translations (overrides built-in translations) */
+    translations: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+    /** What metadata to include with feedback submissions */
+    includeMetadata: z.ZodDefault<z.ZodObject<{
+        /** Include the course ID from LRS bridge (if available) */
+        courseId: z.ZodDefault<z.ZodBoolean>;
+        /** Include the current lesson/page ID (URL hash or pathname) */
+        lessonId: z.ZodDefault<z.ZodBoolean>;
+        /** Include the browser user agent */
+        userAgent: z.ZodDefault<z.ZodBoolean>;
+        /** Include timestamp of submission */
+        timestamp: z.ZodDefault<z.ZodBoolean>;
+        /** Include the full current URL */
+        url: z.ZodDefault<z.ZodBoolean>;
+    }, "strip", z.ZodTypeAny, {
+        courseId: boolean;
+        lessonId: boolean;
+        userAgent: boolean;
+        timestamp: boolean;
+        url: boolean;
+    }, {
+        courseId?: boolean | undefined;
+        lessonId?: boolean | undefined;
+        userAgent?: boolean | undefined;
+        timestamp?: boolean | undefined;
+        url?: boolean | undefined;
+    }>>;
+    /** Auto-close modal after successful submission (default: true) */
+    autoClose: z.ZodDefault<z.ZodBoolean>;
+    /** Delay in ms before auto-closing after success (default: 2000) */
+    autoCloseDelay: z.ZodDefault<z.ZodNumber>;
+    /** Enable debug logging (default: false) */
+    debug: z.ZodDefault<z.ZodBoolean>;
+}, "strip", z.ZodTypeAny, {
+    enabled: boolean;
+    method: "POST" | "PUT";
+    position: "left" | "right";
+    tabText: string;
+    tabColor: string;
+    tabTextColor: string;
+    zIndex: number;
+    showRating: boolean;
+    ratingRequired: boolean;
+    ratingStars: number;
+    showIssueType: boolean;
+    issueTypeRequired: boolean;
+    showComment: boolean;
+    commentRequired: boolean;
+    commentMaxLength: number;
+    locale: "en" | "fr";
+    includeMetadata: {
+        courseId: boolean;
+        lessonId: boolean;
+        userAgent: boolean;
+        timestamp: boolean;
+        url: boolean;
+    };
+    autoClose: boolean;
+    autoCloseDelay: number;
+    debug: boolean;
+    endpoint?: string | undefined;
+    headers?: Record<string, string> | undefined;
+    issueTypes?: {
+        id: string;
+        label: string;
+        subtypes?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    }[] | undefined;
+    commentPlaceholder?: string | undefined;
+    translations?: Record<string, string> | undefined;
+}, {
+    enabled?: boolean | undefined;
+    endpoint?: string | undefined;
+    method?: "POST" | "PUT" | undefined;
+    headers?: Record<string, string> | undefined;
+    position?: "left" | "right" | undefined;
+    tabText?: string | undefined;
+    tabColor?: string | undefined;
+    tabTextColor?: string | undefined;
+    zIndex?: number | undefined;
+    showRating?: boolean | undefined;
+    ratingRequired?: boolean | undefined;
+    ratingStars?: number | undefined;
+    showIssueType?: boolean | undefined;
+    issueTypeRequired?: boolean | undefined;
+    issueTypes?: {
+        id: string;
+        label: string;
+        subtypes?: {
+            id: string;
+            label: string;
+        }[] | undefined;
+    }[] | undefined;
+    showComment?: boolean | undefined;
+    commentRequired?: boolean | undefined;
+    commentMaxLength?: number | undefined;
+    commentPlaceholder?: string | undefined;
+    locale?: "en" | "fr" | undefined;
+    translations?: Record<string, string> | undefined;
+    includeMetadata?: {
+        courseId?: boolean | undefined;
+        lessonId?: boolean | undefined;
+        userAgent?: boolean | undefined;
+        timestamp?: boolean | undefined;
+        url?: boolean | undefined;
+    } | undefined;
+    autoClose?: boolean | undefined;
+    autoCloseDelay?: number | undefined;
+    debug?: boolean | undefined;
+}>;
+type FeedbackConfig = z.infer<typeof FeedbackConfigSchema>;
+type IssueType = z.infer<typeof IssueTypeSchema>;
+type IssueSubtype = z.infer<typeof IssueSubtypeSchema>;
+type MetadataOptions = z.infer<typeof MetadataOptionsSchema>;
+
+/**
+ * Generate the feedback widget JavaScript code.
+ * This produces a self-contained IIFE that creates and manages the feedback widget.
+ */
+declare function generateFeedbackWidget(config: FeedbackConfig): string;
+
+/**
+ * Generate the CSS styles for the feedback widget.
+ * Styles are scoped with #pa-feedback-container to avoid conflicts.
+ */
+declare function generateFeedbackStyles(config: FeedbackConfig): string;
+
+interface Translations {
+    title: string;
+    ratingLabel: string;
+    issueTypeLabel: string;
+    selectIssueType: string;
+    subtypeLabel: string;
+    selectSubtype: string;
+    commentLabel: string;
+    commentPlaceholder: string;
+    submit: string;
+    submitting: string;
+    thankYou: string;
+    errorSubmitting: string;
+    errorRequired: string;
+    characterCount: string;
+}
+declare const translations: Record<string, Translations>;
+declare function getTranslations(locale: string, overrides?: Record<string, string>): Translations;
+
+/**
+ * @patch-adams/plugin-feedback
+ *
+ * Feedback widget plugin for Patch-Adams.
+ * Injects a customizable feedback form into patched Rise courses.
+ *
+ * Features:
+ * - Star rating
+ * - Issue type/subtype selection
+ * - Comment text area
+ * - Multi-language support (en/fr)
+ * - Customizable appearance
+ * - Automatic metadata collection
+ * - Configurable API endpoint
+ */
+
+/**
+ * Feedback plugin for Patch-Adams
+ */
+declare const feedbackPlugin: PatchAdamsPlugin<FeedbackConfig>;
+
+export { DEFAULT_ISSUE_TYPES, type FeedbackConfig, FeedbackConfigSchema, type IssueSubtype, type IssueType, type MetadataOptions, type Translations, feedbackPlugin as default, feedbackPlugin, generateFeedbackStyles, generateFeedbackWidget, getTranslations, translations };