@scalemule/nextjs 0.0.41 → 0.1.0

package/dist/index.d.mts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode } from 'react';
+import { ReactNode, ReactElement } from 'react';
 import { MoneyClient } from '@scalemule/money';
 export { MoneyClient, MoneyClientConfig, createMoneyClient } from '@scalemule/money';
 import { RealtimeService } from '@scalemule/sdk';
@@ -346,6 +346,106 @@ interface UseShareReturn {
 }
 declare function useShare(options?: UseShareOptions): UseShareReturn;
 
+/**
+ * Public types for the feedback hook + widget.
+ *
+ * Mirrors the JSON shape returned by `scalemule-feedback`'s public endpoints
+ * (`/v1/feedback/submit`, `/v1/feedback/items`). Dashboard/admin shapes live
+ * server-side and are not exported here — customer apps interact with the
+ * SDK only through the end-user surface.
+ */
+type FeedbackType = 'bug_report' | 'feature_request' | 'improvement' | 'other';
+type FeedbackStatus = 'new' | 'reviewed' | 'planned' | 'in_progress' | 'completed' | 'declined';
+type FeedbackPriority = 'low' | 'medium' | 'high' | 'urgent';
+/**
+ * The end-user-visible shape of a feedback item. Excludes staff-only fields
+ * (assigned_to, internal_notes, email of OTHER users, etc.) that the service
+ * never returns through `/items`.
+ */
+interface FeedbackItem {
+    id: string;
+    type: FeedbackType;
+    title: string;
+    description: string;
+    status: FeedbackStatus;
+    priority: FeedbackPriority;
+    tags: string[] | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Body for `POST /v1/feedback/submit`.
+ *
+ * `email` is required when no end-user session is present — the gateway omits
+ * `x-user-id` in that case and the service rejects with 400 unless email is
+ * given. When a session exists, email is optional.
+ */
+interface FeedbackItemInput {
+    type: FeedbackType;
+    title: string;
+    description: string;
+    email?: string;
+    tags?: string[];
+}
+
+interface UseFeedbackOptions {
+    /** Optional status filter applied to the list call. */
+    status?: FeedbackStatus;
+    /** Optional type filter. */
+    type?: FeedbackType;
+    /** When false, suppress the initial list fetch (the widget submits without listing). */
+    enabled?: boolean;
+}
+interface UseFeedbackResult {
+    /** End-user's own feedback items for the current tenant. Empty when not signed in. */
+    items: FeedbackItem[];
+    loading: boolean;
+    error: ApiError | null;
+    /** Submit a new feedback item. Returns the persisted item on success. */
+    submit: (input: FeedbackItemInput) => Promise<FeedbackItem>;
+    /** Re-fetch the list. */
+    refresh: () => Promise<void>;
+}
+/**
+ * Hook for end-user feedback submission and read-own.
+ *
+ * Calls go through `client` from `ScaleMuleProvider`, which attaches the
+ * configured API key and (when present) the user session token. Tenancy
+ * (`x-app-id`) is derived by the gateway from the API key — never set
+ * client-side.
+ */
+declare function useFeedback(options?: UseFeedbackOptions): UseFeedbackResult;
+
+interface FeedbackWidgetProps {
+    /** Floating-button corner. Default `bottom-right`. */
+    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+    /** Default selected type when the modal opens. Default `feature_request`. */
+    defaultType?: FeedbackType;
+    /** Restrict the type select to this subset. Default: all four types. */
+    allowedTypes?: FeedbackType[];
+    /** Trigger button label. Default `Feedback`. */
+    triggerLabel?: string;
+    /** `light`/`dark`/`auto` (matches OS). Default `auto`. */
+    theme?: 'light' | 'dark' | 'auto';
+    /** Optional class for the trigger button (use to override styling). */
+    className?: string;
+    /** Called after a successful submit. */
+    onSubmitted?: (item: FeedbackItem) => void;
+}
+/**
+ * Floating feedback widget. Renders nothing until the trigger is clicked,
+ * then opens a small modal with type / title / description fields. Submits
+ * via `useFeedback().submit()` — inherits identity from `ScaleMuleProvider`.
+ *
+ * If the end-user is not signed in, the widget shows an additional `email`
+ * field (required by the service for anonymous submissions).
+ *
+ * Tenant must have `feedback_app_config.enabled = TRUE` for `/submit` to
+ * accept submissions; otherwise the service responds with 404
+ * `FEEDBACK_DISABLED` and the widget surfaces the error message.
+ */
+declare function FeedbackWidget(props: FeedbackWidgetProps): ReactElement | null;
+
 /**
  * Client-side validation helpers
  *
@@ -504,4 +604,4 @@ declare function createSafeLogger(prefix: string): {
     error: (message: string, data?: unknown) => void;
 };
 
-export { ApiError, type FeatureFlagEvaluation, type FeatureFlagEvaluation as FeatureFlagResult, ListFilesParams, LoginResponse, type PasswordValidationResult, type PhoneCountry, type PhoneValidationResult, type RealtimeEvent, type RealtimeMessage, type RealtimeStatus, ScaleMuleClient, ScaleMuleConfig, ScaleMuleProvider, type ScaleMuleProviderProps, UseAnalyticsOptions, UseAnalyticsReturn, UseAuthReturn, UseBillingReturn, UseContentReturn, type UseFeatureFlagsOptions, type UseFeatureFlagsReturn, type UseFeatureFlagsOptions as UseFlagsOptions, type UseFeatureFlagsReturn as UseFlagsReturn, type UsePushNotificationsOptions, type UsePushNotificationsReturn, type UseRealtimeOptions, type UseRealtimeReturn, type UseShareOptions, type UseShareReturn, UseUserReturn, User, type UsernameValidationResult, composePhone, createSafeLogger, normalizePhone, phoneCountries, sanitizeForLog, useAnalytics, useAuth, useBilling, useContent, useFeatureFlags, useMoney, useMoneyClient, usePushNotifications, useRealtime, useScaleMule, useScaleMuleClient, useShare, useUser, validateForm, validators };
+export { ApiError, type FeatureFlagEvaluation, type FeatureFlagEvaluation as FeatureFlagResult, type FeedbackItem, type FeedbackItemInput, type FeedbackPriority, type FeedbackStatus, type FeedbackType, FeedbackWidget, type FeedbackWidgetProps, ListFilesParams, LoginResponse, type PasswordValidationResult, type PhoneCountry, type PhoneValidationResult, type RealtimeEvent, type RealtimeMessage, type RealtimeStatus, ScaleMuleClient, ScaleMuleConfig, ScaleMuleProvider, type ScaleMuleProviderProps, UseAnalyticsOptions, UseAnalyticsReturn, UseAuthReturn, UseBillingReturn, UseContentReturn, type UseFeatureFlagsOptions, type UseFeatureFlagsReturn, type UseFeedbackOptions, type UseFeedbackResult, type UseFeatureFlagsOptions as UseFlagsOptions, type UseFeatureFlagsReturn as UseFlagsReturn, type UsePushNotificationsOptions, type UsePushNotificationsReturn, type UseRealtimeOptions, type UseRealtimeReturn, type UseShareOptions, type UseShareReturn, UseUserReturn, User, type UsernameValidationResult, composePhone, createSafeLogger, normalizePhone, phoneCountries, sanitizeForLog, useAnalytics, useAuth, useBilling, useContent, useFeatureFlags, useFeedback, useMoney, useMoneyClient, usePushNotifications, useRealtime, useScaleMule, useScaleMuleClient, useShare, useUser, validateForm, validators };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
-import { ReactNode } from 'react';
+import { ReactNode, ReactElement } from 'react';
 import { MoneyClient } from '@scalemule/money';
 export { MoneyClient, MoneyClientConfig, createMoneyClient } from '@scalemule/money';
 import { RealtimeService } from '@scalemule/sdk';
@@ -346,6 +346,106 @@ interface UseShareReturn {
 }
 declare function useShare(options?: UseShareOptions): UseShareReturn;
 
+/**
+ * Public types for the feedback hook + widget.
+ *
+ * Mirrors the JSON shape returned by `scalemule-feedback`'s public endpoints
+ * (`/v1/feedback/submit`, `/v1/feedback/items`). Dashboard/admin shapes live
+ * server-side and are not exported here — customer apps interact with the
+ * SDK only through the end-user surface.
+ */
+type FeedbackType = 'bug_report' | 'feature_request' | 'improvement' | 'other';
+type FeedbackStatus = 'new' | 'reviewed' | 'planned' | 'in_progress' | 'completed' | 'declined';
+type FeedbackPriority = 'low' | 'medium' | 'high' | 'urgent';
+/**
+ * The end-user-visible shape of a feedback item. Excludes staff-only fields
+ * (assigned_to, internal_notes, email of OTHER users, etc.) that the service
+ * never returns through `/items`.
+ */
+interface FeedbackItem {
+    id: string;
+    type: FeedbackType;
+    title: string;
+    description: string;
+    status: FeedbackStatus;
+    priority: FeedbackPriority;
+    tags: string[] | null;
+    created_at: string;
+    updated_at: string;
+}
+/**
+ * Body for `POST /v1/feedback/submit`.
+ *
+ * `email` is required when no end-user session is present — the gateway omits
+ * `x-user-id` in that case and the service rejects with 400 unless email is
+ * given. When a session exists, email is optional.
+ */
+interface FeedbackItemInput {
+    type: FeedbackType;
+    title: string;
+    description: string;
+    email?: string;
+    tags?: string[];
+}
+
+interface UseFeedbackOptions {
+    /** Optional status filter applied to the list call. */
+    status?: FeedbackStatus;
+    /** Optional type filter. */
+    type?: FeedbackType;
+    /** When false, suppress the initial list fetch (the widget submits without listing). */
+    enabled?: boolean;
+}
+interface UseFeedbackResult {
+    /** End-user's own feedback items for the current tenant. Empty when not signed in. */
+    items: FeedbackItem[];
+    loading: boolean;
+    error: ApiError | null;
+    /** Submit a new feedback item. Returns the persisted item on success. */
+    submit: (input: FeedbackItemInput) => Promise<FeedbackItem>;
+    /** Re-fetch the list. */
+    refresh: () => Promise<void>;
+}
+/**
+ * Hook for end-user feedback submission and read-own.
+ *
+ * Calls go through `client` from `ScaleMuleProvider`, which attaches the
+ * configured API key and (when present) the user session token. Tenancy
+ * (`x-app-id`) is derived by the gateway from the API key — never set
+ * client-side.
+ */
+declare function useFeedback(options?: UseFeedbackOptions): UseFeedbackResult;
+
+interface FeedbackWidgetProps {
+    /** Floating-button corner. Default `bottom-right`. */
+    position?: 'bottom-right' | 'bottom-left' | 'top-right' | 'top-left';
+    /** Default selected type when the modal opens. Default `feature_request`. */
+    defaultType?: FeedbackType;
+    /** Restrict the type select to this subset. Default: all four types. */
+    allowedTypes?: FeedbackType[];
+    /** Trigger button label. Default `Feedback`. */
+    triggerLabel?: string;
+    /** `light`/`dark`/`auto` (matches OS). Default `auto`. */
+    theme?: 'light' | 'dark' | 'auto';
+    /** Optional class for the trigger button (use to override styling). */
+    className?: string;
+    /** Called after a successful submit. */
+    onSubmitted?: (item: FeedbackItem) => void;
+}
+/**
+ * Floating feedback widget. Renders nothing until the trigger is clicked,
+ * then opens a small modal with type / title / description fields. Submits
+ * via `useFeedback().submit()` — inherits identity from `ScaleMuleProvider`.
+ *
+ * If the end-user is not signed in, the widget shows an additional `email`
+ * field (required by the service for anonymous submissions).
+ *
+ * Tenant must have `feedback_app_config.enabled = TRUE` for `/submit` to
+ * accept submissions; otherwise the service responds with 404
+ * `FEEDBACK_DISABLED` and the widget surfaces the error message.
+ */
+declare function FeedbackWidget(props: FeedbackWidgetProps): ReactElement | null;
+
 /**
  * Client-side validation helpers
  *
@@ -504,4 +604,4 @@ declare function createSafeLogger(prefix: string): {
     error: (message: string, data?: unknown) => void;
 };
 
-export { ApiError, type FeatureFlagEvaluation, type FeatureFlagEvaluation as FeatureFlagResult, ListFilesParams, LoginResponse, type PasswordValidationResult, type PhoneCountry, type PhoneValidationResult, type RealtimeEvent, type RealtimeMessage, type RealtimeStatus, ScaleMuleClient, ScaleMuleConfig, ScaleMuleProvider, type ScaleMuleProviderProps, UseAnalyticsOptions, UseAnalyticsReturn, UseAuthReturn, UseBillingReturn, UseContentReturn, type UseFeatureFlagsOptions, type UseFeatureFlagsReturn, type UseFeatureFlagsOptions as UseFlagsOptions, type UseFeatureFlagsReturn as UseFlagsReturn, type UsePushNotificationsOptions, type UsePushNotificationsReturn, type UseRealtimeOptions, type UseRealtimeReturn, type UseShareOptions, type UseShareReturn, UseUserReturn, User, type UsernameValidationResult, composePhone, createSafeLogger, normalizePhone, phoneCountries, sanitizeForLog, useAnalytics, useAuth, useBilling, useContent, useFeatureFlags, useMoney, useMoneyClient, usePushNotifications, useRealtime, useScaleMule, useScaleMuleClient, useShare, useUser, validateForm, validators };
+export { ApiError, type FeatureFlagEvaluation, type FeatureFlagEvaluation as FeatureFlagResult, type FeedbackItem, type FeedbackItemInput, type FeedbackPriority, type FeedbackStatus, type FeedbackType, FeedbackWidget, type FeedbackWidgetProps, ListFilesParams, LoginResponse, type PasswordValidationResult, type PhoneCountry, type PhoneValidationResult, type RealtimeEvent, type RealtimeMessage, type RealtimeStatus, ScaleMuleClient, ScaleMuleConfig, ScaleMuleProvider, type ScaleMuleProviderProps, UseAnalyticsOptions, UseAnalyticsReturn, UseAuthReturn, UseBillingReturn, UseContentReturn, type UseFeatureFlagsOptions, type UseFeatureFlagsReturn, type UseFeedbackOptions, type UseFeedbackResult, type UseFeatureFlagsOptions as UseFlagsOptions, type UseFeatureFlagsReturn as UseFlagsReturn, type UsePushNotificationsOptions, type UsePushNotificationsReturn, type UseRealtimeOptions, type UseRealtimeReturn, type UseShareOptions, type UseShareReturn, UseUserReturn, User, type UsernameValidationResult, composePhone, createSafeLogger, normalizePhone, phoneCountries, sanitizeForLog, useAnalytics, useAuth, useBilling, useContent, useFeatureFlags, useFeedback, useMoney, useMoneyClient, usePushNotifications, useRealtime, useScaleMule, useScaleMuleClient, useShare, useUser, validateForm, validators };