@firstflow/react 0.0.1 → 0.0.101

package/dist/internal.d.mts

@@ -0,0 +1,131 @@
+import { N as NormalizedFeedbackConfig, p as NormalizedFeedbackFormConfig, q as FeedbackModulePublic, I as IssueFormValues, r as NormalizedConfig, s as NormalizedFieldConfig, t as IssueContextMetadata, O as OpenOptions, u as IssuePayload, v as RawIssueFieldConfig, R as RawIssuesConfig, V as ValidationResult, w as IssueReporterInstance, x as IssueReportData, y as CreateIssueReporterOptions } from './events-DAiGBrYc.mjs';
+export { z as FEEDBACK_SUBMITTED, B as ISSUE_SUBMITTED, D as IssueModulePublic, M as MessageFeedbackSubmitPayload, a as RawFeedbackConfig } from './events-DAiGBrYc.mjs';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+
+type UseFirstflowFeedbackMessageResult = {
+    rating: 'like' | 'dislike' | null;
+    selectedTags: string[];
+    comment: string;
+    submitting: boolean;
+    submitted: boolean;
+    error: string | null;
+    setRating: (r: 'like' | 'dislike') => void;
+    toggleTag: (tag: string) => void;
+    setComment: (c: string) => void;
+    submit: () => Promise<void>;
+    clearError: () => void;
+    isEnabled: boolean;
+    config: NormalizedFeedbackConfig | null;
+    sideConfig: NormalizedFeedbackFormConfig | null;
+};
+type UseFirstflowFeedbackMessageOptions = {
+    conversationId: string;
+    messageId: string;
+    messagePreview: string;
+    metadata?: Record<string, unknown>;
+};
+/**
+ * **Module mode** — `useFirstflowFeedback()`
+ * Returns `firstflow.feedback`: programmatic `submit(payload)`, `getConfig()`, `isEnabled()` (e.g. Thread slot, one-off submits).
+ *
+ * **Message mode** — `useFirstflowFeedback({ conversationId, messageId, messagePreview, metadata? })`
+ * Headless per-message state: rating, tags, comment, `submit()`, localStorage.
+ */
+declare function useFirstflowFeedback(): FeedbackModulePublic;
+declare function useFirstflowFeedback(options: UseFirstflowFeedbackMessageOptions): UseFirstflowFeedbackMessageResult;
+
+type UseFirstflowIssueFormResult = {
+    /** Current field values (ids from config). */
+    values: IssueFormValues;
+    setValue: (fieldId: string, value: string) => void;
+    setValues: (next: IssueFormValues) => void;
+    errors: Record<string, string>;
+    submitting: boolean;
+    submitted: boolean;
+    submitError: string | null;
+    /** Validate only; sets `errors`. Returns whether valid. */
+    validate: () => boolean;
+    /** Validate, then `reportIssue` with merged `open()` context (messageId, etc.). */
+    submit: () => Promise<void>;
+    /** Clear values to empty, errors, submit state. */
+    reset: () => void;
+    clearSubmitError: () => void;
+    isEnabled: boolean;
+    config: NormalizedConfig;
+    title: string;
+    triggerLabel: string;
+    submitLabel: string;
+    cancelLabel: string;
+    cancelEnabled: boolean;
+    uiText: {
+        title: string;
+        triggerLabel: string;
+        submitLabel: string;
+        cancelLabel: string;
+        cancelEnabled: boolean;
+        promptText: string;
+    };
+    fields: NormalizedFieldConfig[];
+    promptText: string;
+};
+/**
+ * Headless issue form: same validation + submit as {@link IssueReporter}.
+ * Build any UI; merge context from `open({ messageId, conversationId, … })` on submit.
+ */
+declare function useFirstflowIssueForm(): UseFirstflowIssueFormResult;
+
+/**
+ * Issue module types. Use the Issue namespace so the root package stays platform-first.
+ */
+
+declare const issue_IssueContextMetadata: typeof IssueContextMetadata;
+declare const issue_NormalizedConfig: typeof NormalizedConfig;
+declare const issue_NormalizedFieldConfig: typeof NormalizedFieldConfig;
+declare const issue_OpenOptions: typeof OpenOptions;
+declare const issue_RawIssueFieldConfig: typeof RawIssueFieldConfig;
+declare const issue_RawIssuesConfig: typeof RawIssuesConfig;
+declare const issue_ValidationResult: typeof ValidationResult;
+declare namespace issue {
+  export { IssueFormValues as FormValues, issue_IssueContextMetadata as IssueContextMetadata, issue_NormalizedConfig as NormalizedConfig, issue_NormalizedFieldConfig as NormalizedFieldConfig, issue_OpenOptions as OpenOptions, IssuePayload as Payload, issue_RawIssueFieldConfig as RawIssueFieldConfig, issue_RawIssuesConfig as RawIssuesConfig, issue_ValidationResult as ValidationResult };
+}
+
+declare function useFirstflowIssueReporter(): {
+    reporter: IssueReporterInstance;
+    open: (options?: OpenOptions) => void;
+    reportIssue: (data: IssueReportData) => Promise<void>;
+    submit: (data: IssueReportData) => Promise<void>;
+    config: NormalizedConfig;
+    isModalOpen: boolean;
+    closeModal: () => void;
+};
+
+type IssueReporterProps = {
+    showTrigger?: boolean;
+};
+declare function IssueReporter({ showTrigger }: IssueReporterProps): react_jsx_runtime.JSX.Element | null;
+
+type IssueReporterContextValue = {
+    reporter: IssueReporterInstance;
+    isModalOpen: boolean;
+    openModal: (options?: OpenOptions) => void;
+    closeModal: () => void;
+    openOptionsRef: React.MutableRefObject<OpenOptions | undefined>;
+};
+type IssueReporterProviderProps = {
+    reporter: IssueReporterInstance;
+    children: ReactNode;
+};
+/**
+ * Provides React bindings and modal state only. Config lifecycle and submission stay in the reporter instance.
+ */
+declare function IssueReporterProvider({ reporter, children, }: IssueReporterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useIssueReporterContext(): IssueReporterContextValue;
+
+/**
+ * Factory: returns an instance. No global state; callback ref from Provider for open().
+ * Issue events are sent via the platform analytics layer only (no direct transport/backend calls from here).
+ */
+declare function createIssueReporter(options: CreateIssueReporterOptions): IssueReporterInstance;
+
+export { CreateIssueReporterOptions, FeedbackModulePublic, issue as Issue, IssueContextMetadata, IssueFormValues, IssuePayload, IssueReporter, IssueReporterInstance, type IssueReporterProps, IssueReporterProvider, NormalizedConfig, NormalizedFeedbackConfig, NormalizedFieldConfig, OpenOptions, RawIssueFieldConfig, RawIssuesConfig, type UseFirstflowFeedbackMessageOptions, type UseFirstflowFeedbackMessageResult, type UseFirstflowIssueFormResult, ValidationResult, createIssueReporter, useFirstflowFeedback, useFirstflowIssueForm, useFirstflowIssueReporter, useIssueReporterContext };

package/dist/internal.d.ts

@@ -0,0 +1,131 @@
+import { N as NormalizedFeedbackConfig, p as NormalizedFeedbackFormConfig, q as FeedbackModulePublic, I as IssueFormValues, r as NormalizedConfig, s as NormalizedFieldConfig, t as IssueContextMetadata, O as OpenOptions, u as IssuePayload, v as RawIssueFieldConfig, R as RawIssuesConfig, V as ValidationResult, w as IssueReporterInstance, x as IssueReportData, y as CreateIssueReporterOptions } from './events-DAiGBrYc.js';
+export { z as FEEDBACK_SUBMITTED, B as ISSUE_SUBMITTED, D as IssueModulePublic, M as MessageFeedbackSubmitPayload, a as RawFeedbackConfig } from './events-DAiGBrYc.js';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import React, { ReactNode } from 'react';
+
+type UseFirstflowFeedbackMessageResult = {
+    rating: 'like' | 'dislike' | null;
+    selectedTags: string[];
+    comment: string;
+    submitting: boolean;
+    submitted: boolean;
+    error: string | null;
+    setRating: (r: 'like' | 'dislike') => void;
+    toggleTag: (tag: string) => void;
+    setComment: (c: string) => void;
+    submit: () => Promise<void>;
+    clearError: () => void;
+    isEnabled: boolean;
+    config: NormalizedFeedbackConfig | null;
+    sideConfig: NormalizedFeedbackFormConfig | null;
+};
+type UseFirstflowFeedbackMessageOptions = {
+    conversationId: string;
+    messageId: string;
+    messagePreview: string;
+    metadata?: Record<string, unknown>;
+};
+/**
+ * **Module mode** — `useFirstflowFeedback()`
+ * Returns `firstflow.feedback`: programmatic `submit(payload)`, `getConfig()`, `isEnabled()` (e.g. Thread slot, one-off submits).
+ *
+ * **Message mode** — `useFirstflowFeedback({ conversationId, messageId, messagePreview, metadata? })`
+ * Headless per-message state: rating, tags, comment, `submit()`, localStorage.
+ */
+declare function useFirstflowFeedback(): FeedbackModulePublic;
+declare function useFirstflowFeedback(options: UseFirstflowFeedbackMessageOptions): UseFirstflowFeedbackMessageResult;
+
+type UseFirstflowIssueFormResult = {
+    /** Current field values (ids from config). */
+    values: IssueFormValues;
+    setValue: (fieldId: string, value: string) => void;
+    setValues: (next: IssueFormValues) => void;
+    errors: Record<string, string>;
+    submitting: boolean;
+    submitted: boolean;
+    submitError: string | null;
+    /** Validate only; sets `errors`. Returns whether valid. */
+    validate: () => boolean;
+    /** Validate, then `reportIssue` with merged `open()` context (messageId, etc.). */
+    submit: () => Promise<void>;
+    /** Clear values to empty, errors, submit state. */
+    reset: () => void;
+    clearSubmitError: () => void;
+    isEnabled: boolean;
+    config: NormalizedConfig;
+    title: string;
+    triggerLabel: string;
+    submitLabel: string;
+    cancelLabel: string;
+    cancelEnabled: boolean;
+    uiText: {
+        title: string;
+        triggerLabel: string;
+        submitLabel: string;
+        cancelLabel: string;
+        cancelEnabled: boolean;
+        promptText: string;
+    };
+    fields: NormalizedFieldConfig[];
+    promptText: string;
+};
+/**
+ * Headless issue form: same validation + submit as {@link IssueReporter}.
+ * Build any UI; merge context from `open({ messageId, conversationId, … })` on submit.
+ */
+declare function useFirstflowIssueForm(): UseFirstflowIssueFormResult;
+
+/**
+ * Issue module types. Use the Issue namespace so the root package stays platform-first.
+ */
+
+declare const issue_IssueContextMetadata: typeof IssueContextMetadata;
+declare const issue_NormalizedConfig: typeof NormalizedConfig;
+declare const issue_NormalizedFieldConfig: typeof NormalizedFieldConfig;
+declare const issue_OpenOptions: typeof OpenOptions;
+declare const issue_RawIssueFieldConfig: typeof RawIssueFieldConfig;
+declare const issue_RawIssuesConfig: typeof RawIssuesConfig;
+declare const issue_ValidationResult: typeof ValidationResult;
+declare namespace issue {
+  export { IssueFormValues as FormValues, issue_IssueContextMetadata as IssueContextMetadata, issue_NormalizedConfig as NormalizedConfig, issue_NormalizedFieldConfig as NormalizedFieldConfig, issue_OpenOptions as OpenOptions, IssuePayload as Payload, issue_RawIssueFieldConfig as RawIssueFieldConfig, issue_RawIssuesConfig as RawIssuesConfig, issue_ValidationResult as ValidationResult };
+}
+
+declare function useFirstflowIssueReporter(): {
+    reporter: IssueReporterInstance;
+    open: (options?: OpenOptions) => void;
+    reportIssue: (data: IssueReportData) => Promise<void>;
+    submit: (data: IssueReportData) => Promise<void>;
+    config: NormalizedConfig;
+    isModalOpen: boolean;
+    closeModal: () => void;
+};
+
+type IssueReporterProps = {
+    showTrigger?: boolean;
+};
+declare function IssueReporter({ showTrigger }: IssueReporterProps): react_jsx_runtime.JSX.Element | null;
+
+type IssueReporterContextValue = {
+    reporter: IssueReporterInstance;
+    isModalOpen: boolean;
+    openModal: (options?: OpenOptions) => void;
+    closeModal: () => void;
+    openOptionsRef: React.MutableRefObject<OpenOptions | undefined>;
+};
+type IssueReporterProviderProps = {
+    reporter: IssueReporterInstance;
+    children: ReactNode;
+};
+/**
+ * Provides React bindings and modal state only. Config lifecycle and submission stay in the reporter instance.
+ */
+declare function IssueReporterProvider({ reporter, children, }: IssueReporterProviderProps): react_jsx_runtime.JSX.Element;
+declare function useIssueReporterContext(): IssueReporterContextValue;
+
+/**
+ * Factory: returns an instance. No global state; callback ref from Provider for open().
+ * Issue events are sent via the platform analytics layer only (no direct transport/backend calls from here).
+ */
+declare function createIssueReporter(options: CreateIssueReporterOptions): IssueReporterInstance;
+
+export { CreateIssueReporterOptions, FeedbackModulePublic, issue as Issue, IssueContextMetadata, IssueFormValues, IssuePayload, IssueReporter, IssueReporterInstance, type IssueReporterProps, IssueReporterProvider, NormalizedConfig, NormalizedFeedbackConfig, NormalizedFieldConfig, OpenOptions, RawIssueFieldConfig, RawIssuesConfig, type UseFirstflowFeedbackMessageOptions, type UseFirstflowFeedbackMessageResult, type UseFirstflowIssueFormResult, ValidationResult, createIssueReporter, useFirstflowFeedback, useFirstflowIssueForm, useFirstflowIssueReporter, useIssueReporterContext };