import { DiscreteRoot } from "../../types.ts";
import { DeepSignal } from "@ng-org/alien-deepsignals";
/**
 * Svelte 5 hook to subscribe to existing 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 engine (or other components) cause an immediate rerender.
 *
 * In comparison to {@link svelteUseShape}, 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 reactive JSON object of the CRDT document.
 *
 *@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);
 *
 *     $effect(() => {
 *         // If the CRDT document is still empty, we need to initialize it.
 *         if (doc && !doc.expenses) {
 *             doc.expenses = [];
 *         }
 *     });
 *
 *     const createExpense = () => {
 *         // Note that we use *expense["@id"]* 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
 *         // preceding objects are removed or added from the array.
 *         // The `@id` is an NURI with the schema `<documentId>:d:<object-specific id>`.
 *         // Since the `@id` is generated in the engine, the object is
 *         // *preliminarily given a mock id* which will be replaced immediately.
 *         expenses.push({
 *             title: "New expense",
 *             date: new Date().toISOString(),
 *         });
 *      };
 *
 *
 * </script>
 *
 * <section>
 *     <div>
 *         <button on:click={() => createExpense({})}/>
 *
 *         {#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
 *         bind:value={expense.title}
 *     />
 * </div>
 * ```
 */
export declare function useDiscrete<T = DiscreteRoot>(documentIdOrPromise: string | Promise<string> | undefined): {
    doc: DeepSignal<T | undefined>;
};
//# sourceMappingURL=useDiscrete.svelte.d.ts.map