@btst/plugin-form-builder 0.0.0-stage → 1.0.0-beta.0

package/dist/client/hooks/index.d.cts

@@ -0,0 +1,378 @@
+'use client';
+import { d as SerializedFormSubmissionSummary } from '../../shared/plugin-form-builder.Cmk083dA.cjs';
+import { SubmissionListFormContext } from '../../api/index.cjs';
+import { SerializedForm, SerializedFormSubmissionWithData, SerializedFormSubmission } from '../../types.cjs';
+import * as _tanstack_react_query from '@tanstack/react-query';
+import { ResourceFormConfig, ResourceFormResult } from '@btst/stack/plugins/client/hooks';
+import { CreateFormInput, UpdateFormInput } from '../../query-keys.cjs';
+import '@btst/stack/plugins/api';
+import '@btst/stack/authorization';
+import '@btst/stack/context';
+import '../../permissions.cjs';
+import 'zod';
+import '@btst/stack/plugins/client';
+import '../../shared/plugin-form-builder.Bbl9NufB.cjs';
+import '@btst/db';
+import 'zod/v4/core';
+import 'better-call';
+
+interface UseFormsOptions {
+    /** Filter by status */
+    status?: "active" | "inactive" | "archived";
+    /** Number of items per page (default: 20) */
+    limit?: number;
+    /** Whether to enable the query (default: true) */
+    enabled?: boolean;
+    /** Free-text search across form names and slugs */
+    search?: string;
+}
+interface UseFormsResult {
+    forms: SerializedForm[];
+    total: number;
+    isLoading: boolean;
+    error: Error | null;
+    loadMore: () => void;
+    hasMore: boolean;
+    isLoadingMore: boolean;
+    refetch: () => void;
+}
+/**
+ * Hook for fetching paginated forms (admin)
+ */
+declare function useForms(options?: UseFormsOptions): UseFormsResult;
+/**
+ * Suspense variant of useForms
+ */
+declare function useSuspenseForms(options?: UseFormsOptions): {
+    forms: SerializedForm[];
+    total: number;
+    loadMore: () => Promise<unknown>;
+    hasMore: boolean;
+    isLoadingMore: boolean;
+    refetch: () => Promise<unknown>;
+};
+/**
+ * Hook for fetching a form by ID (admin)
+ */
+declare function useFormById(id: string): {
+    form: SerializedForm | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => void;
+};
+/**
+ * Suspense variant of useFormById
+ */
+declare function useSuspenseFormById(id: string): {
+    form: SerializedForm | null;
+    refetch: () => Promise<unknown>;
+};
+/**
+ * Fetches editor data through the same update permission as the edit route.
+ */
+declare function useSuspenseFormForUpdate(id: string): {
+    form: SerializedForm | null;
+    refetch: () => Promise<unknown>;
+};
+/**
+ * Hook for fetching a form by slug (public)
+ */
+declare function useFormBySlug(slug: string): {
+    form: SerializedForm | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => void;
+};
+/**
+ * Suspense variant of useFormBySlug
+ */
+declare function useSuspenseFormBySlug(slug: string): {
+    form: SerializedForm | null;
+    refetch: () => Promise<unknown>;
+};
+/**
+ * Hook for creating a form
+ */
+declare function useCreateForm(): _tanstack_react_query.UseMutationResult<SerializedForm, Error, CreateFormInput>;
+/**
+ * Hook for updating a form
+ */
+declare function useUpdateForm(): _tanstack_react_query.UseMutationResult<SerializedForm, Error, {
+    id: string;
+    data: UpdateFormInput;
+}>;
+/**
+ * Hook for deleting a form
+ */
+declare function useDeleteForm(): _tanstack_react_query.UseMutationResult<{
+    success: boolean;
+}, Error, string>;
+/**
+ * Form lifecycle hook for creating/editing forms, built on the core resource
+ * `useForm`: submits the right mutation, awaits invalidation, notifies via
+ * `useNotify()`, redirects, and maps server validation issues to
+ * `fieldErrors`.
+ */
+declare function useFormBuilderForm<TValues>(config: ResourceFormConfig<TValues, SerializedForm | null, SerializedForm>): ResourceFormResult<TValues, SerializedForm | null, SerializedForm>;
+/**
+ * Hook for submitting a form (public)
+ */
+declare function useSubmitForm(slug: string): {
+    mutate: (vars: {
+        data: Record<string, unknown>;
+    }) => void;
+    mutateAsync: (vars: {
+        data: Record<string, unknown>;
+    }) => Promise<SerializedFormSubmission & {
+        form: {
+            successMessage?: string;
+            redirectUrl?: string;
+        };
+    }>;
+    data: undefined;
+    variables: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    status: "idle";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (vars: {
+        data: Record<string, unknown>;
+    }) => void;
+    mutateAsync: (vars: {
+        data: Record<string, unknown>;
+    }) => Promise<SerializedFormSubmission & {
+        form: {
+            successMessage?: string;
+            redirectUrl?: string;
+        };
+    }>;
+    data: undefined;
+    variables: {
+        slug: string;
+        data: Record<string, unknown>;
+    };
+    error: null;
+    isError: false;
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    status: "pending";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (vars: {
+        data: Record<string, unknown>;
+    }) => void;
+    mutateAsync: (vars: {
+        data: Record<string, unknown>;
+    }) => Promise<SerializedFormSubmission & {
+        form: {
+            successMessage?: string;
+            redirectUrl?: string;
+        };
+    }>;
+    data: undefined;
+    error: Error;
+    variables: {
+        slug: string;
+        data: Record<string, unknown>;
+    };
+    isError: true;
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    status: "error";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (vars: {
+        data: Record<string, unknown>;
+    }) => void;
+    mutateAsync: (vars: {
+        data: Record<string, unknown>;
+    }) => Promise<SerializedFormSubmission & {
+        form: {
+            successMessage?: string;
+            redirectUrl?: string;
+        };
+    }>;
+    data: SerializedFormSubmission & {
+        form: {
+            successMessage?: string;
+            redirectUrl?: string;
+        };
+    };
+    error: null;
+    variables: {
+        slug: string;
+        data: Record<string, unknown>;
+    };
+    isError: false;
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    status: "success";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+};
+interface UseSubmissionsOptions {
+    /** Number of items per page (default: 20) */
+    limit?: number;
+    /** Whether to enable the query (default: true) */
+    enabled?: boolean;
+}
+interface UseSubmissionsResult {
+    form: SubmissionListFormContext | null;
+    submissions: SerializedFormSubmissionSummary[];
+    total: number;
+    isLoading: boolean;
+    error: Error | null;
+    loadMore: () => void;
+    hasMore: boolean;
+    isLoadingMore: boolean;
+    refetch: () => void;
+}
+/**
+ * Hook for fetching paginated submissions for a form (admin)
+ */
+declare function useSubmissions(formId: string, options?: UseSubmissionsOptions): UseSubmissionsResult;
+/**
+ * Suspense variant of useSubmissions
+ */
+declare function useSuspenseSubmissions(formId: string, options?: UseSubmissionsOptions): {
+    form: SubmissionListFormContext | null;
+    submissions: SerializedFormSubmissionSummary[];
+    total: number;
+    loadMore: () => Promise<unknown>;
+    hasMore: boolean;
+    isLoadingMore: boolean;
+    refetch: () => Promise<unknown>;
+};
+interface UseSubmissionOptions {
+    /** Whether to enable the query (default: true). */
+    enabled?: boolean;
+}
+/**
+ * Fetch one submission through its record-scoped authorization rule.
+ */
+declare function useSubmission(formId: string, submissionId?: string, options?: UseSubmissionOptions): {
+    submission: SerializedFormSubmissionWithData | null;
+    isLoading: boolean;
+    error: Error | null;
+    refetch: () => void;
+};
+/**
+ * Hook for deleting a submission
+ */
+declare function useDeleteSubmission(formId: string): {
+    mutate: (subId: string) => void;
+    mutateAsync: (subId: string) => Promise<{
+        success: boolean;
+    }>;
+    data: undefined;
+    variables: undefined;
+    error: null;
+    isError: false;
+    isIdle: true;
+    isPending: false;
+    isSuccess: false;
+    status: "idle";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (subId: string) => void;
+    mutateAsync: (subId: string) => Promise<{
+        success: boolean;
+    }>;
+    data: undefined;
+    variables: {
+        formId: string;
+        subId: string;
+    };
+    error: null;
+    isError: false;
+    isIdle: false;
+    isPending: true;
+    isSuccess: false;
+    status: "pending";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (subId: string) => void;
+    mutateAsync: (subId: string) => Promise<{
+        success: boolean;
+    }>;
+    data: undefined;
+    error: Error;
+    variables: {
+        formId: string;
+        subId: string;
+    };
+    isError: true;
+    isIdle: false;
+    isPending: false;
+    isSuccess: false;
+    status: "error";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+} | {
+    mutate: (subId: string) => void;
+    mutateAsync: (subId: string) => Promise<{
+        success: boolean;
+    }>;
+    data: {
+        success: boolean;
+    };
+    error: null;
+    variables: {
+        formId: string;
+        subId: string;
+    };
+    isError: false;
+    isIdle: false;
+    isPending: false;
+    isSuccess: true;
+    status: "success";
+    reset: () => void;
+    context: unknown;
+    failureCount: number;
+    failureReason: Error | null;
+    isPaused: boolean;
+    submittedAt: number;
+};
+
+export { CreateFormInput, SerializedFormSubmissionSummary, UpdateFormInput, useCreateForm, useDeleteForm, useDeleteSubmission, useFormBuilderForm, useFormById, useFormBySlug, useForms, useSubmission, useSubmissions, useSubmitForm, useSuspenseFormById, useSuspenseFormBySlug, useSuspenseFormForUpdate, useSuspenseForms, useSuspenseSubmissions, useUpdateForm };
+export type { UseFormsOptions, UseFormsResult, UseSubmissionOptions, UseSubmissionsOptions, UseSubmissionsResult };