import { type Scope } from "../../types.ts";
import type { BaseType, ShapeType } from "@ng-org/shex-orm";
import { DeepSignalSet } from "@ng-org/alien-deepsignals";
/**
 * Svelte 5 hook to subscribe to RDF data in the graph database using a shape, see {@link ShapeType}.
 *
 * Returns a {@link DeepSignalSet} that contain the objects matching the shape and that are within the scope.
 * Establishes a 2-way binding: Modifications to the object are immediately committed,
 * changes coming from the engine (or other components) cause an immediate rerender.
 *
 * @param shape The {@link ShapeType} the objects should have (generated by the `@ng-org/shex-orm` tool).
 * @param scope The {@link Scope} as graph string or scope object with graphs and subjects.
 * @returns A {@link DeepSignalSet} with the orm objects or an empty set, if still loading.\
 *          If the scope is explicitly set to `undefined`, an empty set is returned which errors
 *          if you try to make modifications on it.
 *
 * @example
 * ```svelte
 * <script lang="ts">
 *     // Gets all expense objects with `@id` <s1 IRI> or <s2 IRI> and `@graph` <g1 NURI> or <g2 NURI>
 *     const expenses: DeepSignal<Set<Expense>> = useShape(ExpenseShapeType,
 *         {graphs: ["<g1 NURI>", "<g2 NURI>"],
 *         subjects: ["<s1 NURI>", "<s2 NURI>"]});
 *
 *     const expensesSorted = computed(() => expenses.sort((a, b) =>
 *         a.dateOfPurchase.localeCompare(b.dateOfPurchase)
 *     ));
 *
 *     const createExpense = () => {
 *         expenses.add({
 *             "@graph": `<graph NURI>`,
 *             "@type": "did:ng:z:Expense",
 *             "@id": "", // Assigns ID automatically, if set to "".
 *             title: "New expense",
 *             dateOfPurchase: obj.dateOfPurchase ?? new Date().toISOString(),
 *         });
 *     };
 *
 *
 *     // Note that if you use `@id` (the subject IRI) as key, you need to ensure that it is unique within your scope.
 *     // If it is not (i.e. there are two graphs with the same subject), use the combination of `@graph` and `@id`.
 * </script>
 *
 * <section>
 *     <div>
 *         <button on:click={() => createExpense()}>
 *             + Add expense
 *         </button>
 *
 *         {# if expensesSorted.length === 0}
 *             <p>
 *                 No expense yet.
 *             </p>
 *         {:else}
 *             {#each expensesSorted as expense, index (expense['@id']) }
 *                 <ExpenseCard
 *                     expense={expense}
 *                 />
 *             {/each}
 *         {/if}
 *     </div>
 * </section>
 * ```
 *
 * ---
 * In the ExpenseCard component:
 * ```svelte
 * <script lang="ts">
 * let {
 *     expense,
 * }: { expense: DeepSignal<Expense>; } = $props();
 * </script>
 *
 * <div>
 *     <input
 *         bind:value={expense.title}
 *     />
 * </div>
 * ```
 */
export declare function useShape<T extends BaseType>(shape: ShapeType<T>, scope: Scope | string | undefined): DeepSignalSet<T>;
export default useShape;
//# sourceMappingURL=useShape.svelte.d.ts.map