import { UseDeepSignalResult } from "@ng-org/alien-deepsignals/svelte4";
import { DiscreteRoot } from "../../types.ts";
/**
 * Svelte 4 hook to subscribe to discrete (JSON) CRDT documents.
 * You can modify the returned object like any other JSON object. Changes are immediately
 * reflected in the CRDT.
 *
 * Establishes a 2-way binding: Modifications to the object are immediately committed,
 * changes coming from the backend (or other components) cause an immediate rerender.
 *
 * In comparison to {@link svelte4UseShape}, discrete CRDTs are untyped.
 * You can put any JSON data inside and need to validate the schema yourself.
 *
 * @param documentIdOrPromise The NURI of the CRDT document or a promise to that.
 * @returns The store of the reactive JSON object of the CRDT document or undefined.
 *
 * @example
 * ```svelte
 * <script lang="ts">
 *
 *     // We assume you have created a CRDT document already, as below.
 *     // const documentId = await ng.doc_create(
 *     //     session_id,
 *     //     crdt, // "Automerge" | "YMap" | "YArray"
 *     //     crdt === "Automerge" ? "data:json" : crdt === "YMap ? "data:map" : "data:array",
 *     //     "store",
 *     //     undefined
 *
 *     const doc = useDiscrete(documentIdPromise);
 *
 *     // If the CRDT document is still empty, we need to initialize it.
 *     $: if (doc && !doc.expenses) {
 *         doc.expenses = [];
 *     }
 *
 *     // Call doc.expenses.push({title: "Example title"}), to add new elements.
 *
 *     // Note that we use expense["@id"] NURI as a key in the expense list.
 *     // Every object added to a CRDT array gets a stable `@id` property assigned
 *     // which you can use for referencing objects in arrays even as
 *     // objects are removed from the array.
 *     // Since the `@id` is generated in the backend, the object is preliminarily
 *     // given a mock ID which will be replaced immediately
 * </script>
 *
 * <section>
 *     <div>
 *         {#if !doc}
 *             Loading...
 *         {:else if doc.expenses.length === 0}
 *         <p>
 *             Nothing tracked yet - log your first purchase to kick things off.
 *         </p>
 *         {:else}
 *         {#each doc.expenses as expense, index (expense['@id']) }
 *             <ExpenseCard
 *             expense={expense}
 *             />
 *         {/each}
 *         {/if}
 *     </div>
 * </section>
 * ```
 *
 * ---
 * In the ExpenseCard component:
 * ```svelte
 *     let {
 *         expense = $bindable(),
 *     }: { expense: Expense; } = $props();
 * </script>
 *
 * <div>
 *     <input
 *         value={expense.title ?? ""}
 *         oninput={(event) => {expense.title = event.currentTarget?.value ?? ""}}
 *         placeholder="Expense title"
 *     />
 * </div>
 * ```
 *
 */
export declare function useDiscrete<T = DiscreteRoot>(documentIdOrPromise: string | Promise<string> | undefined): {
    doc: UseDeepSignalResult<T | undefined>;
};
//# sourceMappingURL=useDiscrete.svelte.d.ts.map