@dyrected/vue 2.18.1 → 2.20.0

package/dist/composables/useTrash.d.ts

@@ -0,0 +1,67 @@
+import { ComputedRef, Ref } from 'vue';
+import { TrashController } from '@dyrected/admin/public';
+import { TrashEntry } from '@dyrected/sdk';
+export interface UseTrashOptions {
+    pageSize?: number;
+    initialSearchQuery?: string;
+    onRestore?: (restored: unknown, trashId: string) => void | Promise<void>;
+    onPurge?: (trashId: string) => void | Promise<void>;
+    onEmpty?: () => void | Promise<void>;
+}
+export interface VueTrashPagination {
+    page: ComputedRef<number>;
+    limit: ComputedRef<number>;
+    totalPages: ComputedRef<number>;
+    hasNextPage: ComputedRef<boolean>;
+    hasPrevPage: ComputedRef<boolean>;
+    setPage: (page: number) => Promise<void>;
+    setLimit: (limit: number) => Promise<void>;
+}
+export interface UseTrashResult {
+    entries: ComputedRef<TrashEntry[]>;
+    total: ComputedRef<number>;
+    isLoading: ComputedRef<boolean>;
+    error: ComputedRef<Error | null>;
+    page: ComputedRef<number>;
+    limit: ComputedRef<number>;
+    totalPages: ComputedRef<number>;
+    hasNextPage: ComputedRef<boolean>;
+    hasPrevPage: ComputedRef<boolean>;
+    searchQuery: ComputedRef<string>;
+    pagination: VueTrashPagination;
+    search: (query: string) => Promise<void>;
+    restore: (id: string, options?: {
+        overrides?: Record<string, unknown>;
+    }) => Promise<unknown>;
+    restoreMany: (ids: string[]) => Promise<{
+        restored: string[];
+        failed: unknown[];
+        count: number;
+    }>;
+    keep: (id: string, options?: {
+        purgeAt?: Date | string | number | null;
+    } | boolean) => Promise<{
+        message: string;
+        purgeAt: number | null;
+    }>;
+    purge: (id: string) => Promise<{
+        message: string;
+    }>;
+    empty: (confirm?: string) => Promise<{
+        message: string;
+        count: number;
+    }>;
+    refetch: () => Promise<void>;
+    controller: Ref<TrashController>;
+}
+/**
+ * Vue composable for browsing and managing trashed documents in a collection.
+ *
+ * @example
+ * ```vue
+ * <script setup>
+ * const { entries, total, isLoading, pagination, restore, keep, purge, empty } = useTrash("guests");
+ * </script>
+ * ```
+ */
+export declare function useTrash(collection: string | Ref<string>, options?: UseTrashOptions): UseTrashResult;