convex-ents 0.9.5 → 0.10.0

package/dist/{index-nOBiMg01.d.ts → index-olos0Rx-.d.ts}

@@ -1,7 +1,8 @@
-import { GenericEntsDataModel, GenericEdgeConfig, Expand, EdgeConfig, DeletionConfig } from './schema.js';
+import { GenericEntsDataModel, GenericEdgeConfig, Expand, DeletionConfig } from './schema.js';
 import * as convex_values from 'convex/values';
-import { GenericId } from 'convex/values';
-import { TableNamesInDataModel, GenericDocument, DocumentByName, FilterBuilder, NamedTableInfo, ExpressionOrValue, PaginationOptions, IndexNames, FieldTypeFromFieldPath, SearchIndexNames, SearchFilterBuilder, NamedSearchIndex, SearchFilter, PaginationResult, SystemDataModel, IndexRangeBuilder, NamedIndex, IndexRange, WithoutSystemFields, WithOptionalSystemFields, GenericDataModel, GenericDatabaseReader, GenericDatabaseWriter, Scheduler } from 'convex/server';
+import { GenericId, JSONValue, Value } from 'convex/values';
+import { TableNamesInDataModel, GenericDocument, DocumentByName, FilterBuilder, NamedTableInfo, ExpressionOrValue, PaginationOptions, IndexNames, FieldTypeFromFieldPath, SearchIndexNames, SearchFilterBuilder, NamedSearchIndex, SearchFilter, PaginationResult, IndexRangeBuilder, NamedIndex, IndexRange, WithoutSystemFields, WithOptionalSystemFields, GenericDataModel, GenericDatabaseReader, GenericDatabaseWriter, Scheduler, GenericActionCtx, FunctionReference } from 'convex/server';
+import { IndexFieldTypesForEq, EntsSystemDataModel, PromiseEdgeResult } from './shared.js';
 import { ScheduledDeleteFuncRef } from './deletion.js';
 
 declare class WriterImplBase<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> {
@@ -36,7 +37,7 @@ type EdgeChanges = Record<string, {
 
 interface PromiseOrderedQueryOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>[] | null> {
     filter(predicate: (q: FilterBuilder<NamedTableInfo<EntsDataModel, Table>>) => ExpressionOrValue<boolean>): this;
-    map<TOutput>(callbackFn: (value: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>, index: number, array: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>[]) => Promise<TOutput> | TOutput): PromiseArrayOrNull<TOutput>;
+    map<TOutput>(callbackFn: (value: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>, index: number, array: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>[]) => TOutput | Promise<TOutput>): PromiseArrayOrNull<TOutput>;
     paginate(paginationOpts: PaginationOptions): PromisePaginationResultOrNull<EntsDataModel, Table>;
     take(n: number): PromiseEntsOrNull<EntsDataModel, Table>;
     first(): PromiseEntOrNull<EntsDataModel, Table>;
@@ -64,15 +65,19 @@ interface PromiseTableBase<EntsDataModel extends GenericEntsDataModel, Table ext
     getManyX<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, values: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>[]): PromiseEnts<EntsDataModel, Table>;
     getManyX(ids: GenericId<Table>[]): PromiseEnts<EntsDataModel, Table>;
     /**
-     * Returns the string ID format for the ID in a given table, or null if the ID
+     * If given a valid ID for the given table, returns it, or returns null if the ID
      * is from a different table or is not a valid ID.
      *
      * This does not guarantee that the ID exists (i.e. `table("foo").get(id)` may return `null`).
-     *
-     * @param tableName - The name of the table.
-     * @param id - The ID string.
      */
     normalizeId(id: string): GenericId<Table> | null;
+    /**
+     * If given a valid ID for the given table, returns it, or throws if the ID
+     * is from a different table or is not a valid ID.
+     *
+     * This does not guarantee that the ID exists (i.e. `table("foo").get(id)` may return `null`).
+     */
+    normalizeIdX(id: string): GenericId<Table>;
 }
 interface PromiseTable<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseQuery<EntsDataModel, Table>, PromiseTableBase<EntsDataModel, Table> {
     get<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, ...values: IndexFieldTypesForEq<EntsDataModel, Table, Indexes[Index]>): PromiseEntOrNull<EntsDataModel, Table>;
@@ -324,9 +329,11 @@ interface PromiseArray<T> extends Promise<T[]> {
     filter(predicate: (value: T, index: number, array: T[]) => unknown): Promise<T[]>;
 }
 declare function entWrapper<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>>(fields: DocumentByName<EntsDataModel, Table>, ctx: EntQueryCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table): Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>;
-declare function entsTableFactory<Ctx extends EntQueryCtx<any>, EntsDataModel extends GenericEntsDataModel>(ctx: Ctx, entDefinitions: EntsDataModel, options?: {
-    scheduledDelete: ScheduledDeleteFuncRef;
-}): Ctx extends EntMutationCtx<any> ? EntsTableWriter<EntsDataModel> : EntsTable<EntsDataModel>;
+declare function entsTableFactory<Ctx extends EntQueryCtx<any> | EntActionCtx<any>, EntsDataModel extends GenericEntsDataModel>(ctx: Ctx, entDefinitions: EntsDataModel, options?: {
+    scheduledDelete?: ScheduledDeleteFuncRef;
+    actionRead?: ActionReadFuncRef;
+    actionWrite?: ActionWriteFuncRef;
+}): Ctx extends EntActionCtx<any> ? EntsTableAction<EntsDataModel> : Ctx extends EntMutationCtx<any> ? EntsTableWriter<EntsDataModel> : EntsTable<EntsDataModel>;
 type EntsTableReader<EntsDataModel extends GenericEntsDataModel> = {
     <Table extends TableNamesInDataModel<EntsDataModel>, IndexName extends IndexNames<NamedTableInfo<EntsDataModel, Table>>>(table: Table, indexName: IndexName, indexRange?: (q: IndexRangeBuilder<DocumentByName<EntsDataModel, Table>, NamedIndex<NamedTableInfo<EntsDataModel, Table>, IndexName>>) => IndexRange): PromiseQuery<EntsDataModel, Table>;
     <Table extends TableNamesInDataModel<EntsDataModel>>(table: Table): PromiseTable<EntsDataModel, Table>;
@@ -334,11 +341,6 @@ type EntsTableReader<EntsDataModel extends GenericEntsDataModel> = {
 type EntsTable<EntsDataModel extends GenericEntsDataModel> = EntsTableReader<EntsDataModel> & {
     system: EntsTableReader<EntsSystemDataModel>;
 };
-type EntsSystemDataModel = {
-    [key in keyof SystemDataModel]: SystemDataModel[key] & {
-        edges: Record<string, never>;
-    };
-};
 type EntsTableWriter<EntsDataModel extends GenericEntsDataModel> = {
     <Table extends TableNamesInDataModel<EntsDataModel>, IndexName extends IndexNames<NamedTableInfo<EntsDataModel, Table>>>(table: Table, indexName: IndexName, indexRange?: (q: IndexRangeBuilder<DocumentByName<EntsDataModel, Table>, NamedIndex<NamedTableInfo<EntsDataModel, Table>, IndexName>>) => IndexRange): PromiseTableWriter<Table, EntsDataModel>;
     <Table extends TableNamesInDataModel<EntsDataModel>>(table: Table): PromiseTableWriter<Table, EntsDataModel>;
@@ -351,7 +353,6 @@ declare class EntInstance<EntsDataModel extends GenericEntsDataModel, Table exte
 }
 type Ent<Table extends TableNamesInDataModel<EntsDataModel>, Doc extends DocumentByName<EntsDataModel, Table>, EntsDataModel extends GenericEntsDataModel> = Doc & EntInstance<EntsDataModel, Table>;
 type GenericEnt<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> = Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>;
-type PromiseEdgeResult<EdgeConfig extends GenericEdgeConfig, MultipleRef, MultipleField, SingleRef, SingleField> = EdgeConfig["cardinality"] extends "multiple" ? EdgeConfig["type"] extends "ref" ? MultipleRef : MultipleField : EdgeConfig["type"] extends "ref" ? SingleRef : SingleField;
 type PromiseEdge<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEnts<EntsDataModel, ToTable>, PromiseQuery<EntsDataModel, ToTable>, PromiseEntOrNull<EntsDataModel, ToTable>, PromiseEnt<EntsDataModel, ToTable>>;
 type PromiseEdgeOrThrow<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEnts<EntsDataModel, ToTable>, PromiseQuery<EntsDataModel, ToTable>, PromiseEnt<EntsDataModel, ToTable>, PromiseEnt<EntsDataModel, ToTable>>;
 type PromiseEdgeOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEntsOrNull<EntsDataModel, ToTable>, PromiseQueryOrNull<EntsDataModel, ToTable>, PromiseEntOrNull<EntsDataModel, ToTable>, PromiseEntOrNull<EntsDataModel, ToTable>>;
@@ -496,6 +497,7 @@ interface PromiseEntId<EntsDataModel extends GenericEntsDataModel, Table extends
 }
 interface EntQueryCtx<DataModel extends GenericDataModel> {
     db: GenericDatabaseReader<DataModel>;
+    vectorSearch?: undefined;
 }
 interface EntMutationCtx<DataModel extends GenericDataModel> extends EntQueryCtx<DataModel> {
     db: GenericDatabaseWriter<DataModel>;
@@ -505,10 +507,6 @@ type DocRetriever<ID, Doc> = () => Promise<{
     id: ID;
     doc: () => Promise<Doc>;
 }>;
-type IndexFieldTypesForEq<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, T extends string[]> = Pop<{
-    [K in keyof T]: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, T[K]>;
-}>;
-type Pop<T extends any[]> = T extends [...infer Rest, infer _Last] ? Rest : never;
 declare function addEntRules<EntsDataModel extends GenericEntsDataModel>(entDefinitions: EntsDataModel, rules: {
     [Table in keyof EntsDataModel]?: Table extends TableNamesInDataModel<EntsDataModel> ? {
         read?: (ent: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel>) => Promise<boolean>;
@@ -545,7 +543,373 @@ declare function getWriteRule(entDefinitions: GenericEntsDataModel, table: strin
     ent: Ent<any, GenericDocument, any>;
     value: undefined;
 }) => Promise<boolean>) | undefined;
-declare function getEdgeDefinitions<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>>(entDefinitions: EntsDataModel, table: Table): Record<keyof EntsDataModel[Table]["edges"], EdgeConfig>;
 declare function getDeletionConfig<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>>(entDefinitions: EntsDataModel, table: Table): DeletionConfig | undefined;
 
-export { type EntQueryCtx as $, type PromiseEnt as A, type PromiseArrayOrNull as B, type PromiseArray as C, entWrapper as D, type EdgeChanges as E, entsTableFactory as F, type EntsTable as G, type EntsTableWriter as H, type Ent as I, type GenericEnt as J, type PromiseEdge as K, type PromiseEdgeOrThrow as L, type PromiseEdgeWriter as M, type PromiseEdgeWriterOrThrow as N, type PromiseEdgeWriterOrNull as O, type PromiseOrderedQueryOrNull as P, type PromiseOrderedQueryWriter as Q, type PromiseQueryWriter as R, type PromiseEntsWriter as S, type PromisePaginationResultWriterOrNull as T, type PromisePaginationResultWriter as U, type PromiseTableWriter as V, WriterImplBase as W, type PromiseEntWriterOrNull as X, type PromiseEntWriter as Y, type GenericEntWriter as Z, type PromiseEntId as _, type WithEdgeInserts as a, type EntMutationCtx as a0, type DocRetriever as a1, addEntRules as a2, getReadRule as a3, getWriteRule as a4, getEdgeDefinitions as a5, getDeletionConfig as a6, type WithEdges as b, type WithEdgePatches as c, type PromiseOrderedQueryWriterOrNull as d, type PromiseQueryOrNull as e, type PromiseQueryWriterOrNull as f, type PromiseTableBase as g, type PromiseTable as h, type PromiseOrderedQueryBase as i, type PromiseOrderedQuery as j, type PromiseQuery as k, type PromisePaginationResultOrNull as l, type PromisePaginationResult as m, type PromiseEntsOrNull as n, type PromiseEntsWriterOrNull as o, type PromiseEnts as p, type PromiseEntsOrNulls as q, type PromiseEdgeOrderedEntsOrNull as r, type PromiseEdgeEntsOrNull as s, type PromiseEdgeOrderedEntsWriterOrNull as t, type PromiseEdgeEntsWriterOrNull as u, type PromiseEdgeOrderedEnts as v, type PromiseEdgeEnts as w, type PromiseEdgeOrderedEntsWriter as x, type PromiseEdgeEntsWriter as y, type PromiseEntOrNull as z };
+interface EntActionCtx<DataModel extends GenericDataModel> {
+    runQuery: GenericActionCtx<DataModel>["runQuery"];
+    runMutation: GenericActionCtx<DataModel>["runMutation"];
+    vectorSearch: GenericActionCtx<DataModel>["vectorSearch"];
+}
+type ActionReadFuncRef = FunctionReference<"query", "internal", {
+    read: SerializedRead;
+}, any>;
+type ActionWriteFuncRef = FunctionReference<"mutation", "internal", {
+    write: SerializedWrite;
+}, any>;
+type SerializedRead = ({
+    table: [string, string?, ReadonlyArray<SerializedRangeExpression>?];
+} | {
+    search: [string, ReadonlyArray<SerializedSearchFilter>];
+} | {
+    order: ["asc" | "desc", string?];
+} | {
+    normalizeId: string;
+} | {
+    normalizeIdX: string;
+} | {
+    get: any[];
+} | {
+    getX: any[];
+} | {
+    getMany: any[];
+} | {
+    getManyX: any[];
+} | {
+    filter: JSONValue;
+} | {
+    take: number;
+} | {
+    paginate: PaginationOptions;
+} | {
+    first: true;
+} | {
+    firstX: true;
+} | {
+    unique: true;
+} | {
+    uniqueX: true;
+} | {
+    edge: string;
+} | {
+    edgeX: string;
+} | {
+    has: GenericId<any>;
+})[];
+type SerializedWrite = (SerializedRead[number] | {
+    insert: WithoutSystemFields<WithEdgeInserts<GenericDocument, any>>;
+} | {
+    insertMany: WithoutSystemFields<WithEdgeInserts<GenericDocument, any>>[];
+} | {
+    patch: Partial<WithEdgePatches<GenericDocument, any>>;
+} | {
+    replace: WithOptionalSystemFields<WithEdges<GenericDocument, any>>;
+} | {
+    delete: true;
+})[];
+type SerializedRangeExpression = {
+    type: "Eq" | "Gt" | "Gte" | "Lt" | "Lte";
+    fieldPath: string;
+    value: JSONValue;
+};
+declare function entsActionReadFactory(ctx: {
+    table: EntsTable<any>;
+}, args_: {
+    [key: string]: unknown;
+}): Promise<any>;
+declare function entsActionWriteFactory(ctx: {
+    table: EntsTableWriter<any>;
+}, args_: {
+    [key: string]: unknown;
+}): Promise<any>;
+type EntsTableAction<EntsDataModel extends GenericEntsDataModel> = {
+    <Table extends TableNamesInDataModel<EntsDataModel>, IndexName extends IndexNames<NamedTableInfo<EntsDataModel, Table>>>(table: Table, indexName: IndexName, indexRange?: (q: IndexRangeBuilder<DocumentByName<EntsDataModel, Table>, NamedIndex<NamedTableInfo<EntsDataModel, Table>, IndexName>>) => IndexRange): PromiseTableAction<Table, EntsDataModel>;
+    <Table extends TableNamesInDataModel<EntsDataModel>>(table: Table): PromiseTableAction<Table, EntsDataModel>;
+    system: EntsTableAction<EntsSystemDataModel>;
+};
+interface PromiseTableAction<Table extends TableNamesInDataModel<EntsDataModel>, EntsDataModel extends GenericEntsDataModel> extends PromiseQueryAction<EntsDataModel, Table> {
+    /**
+     * If given a valid ID for the given table, returns it, or returns null if the ID
+     * is from a different table or is not a valid ID.
+     *
+     * This does not guarantee that the ID exists (i.e. `table("foo").get(id)` may return `null`).
+     */
+    normalizeId(id: string): Promise<GenericId<Table> | null>;
+    /**
+     * If given a valid ID for the given table, returns it, or throws if the ID
+     * is from a different table or is not a valid ID.
+     *
+     * This does not guarantee that the ID exists (i.e. `table("foo").get(id)` may return `null`).
+     */
+    normalizeIdX(id: string): Promise<GenericId<Table>>;
+    get<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, ...values: IndexFieldTypesForEq<EntsDataModel, Table, Indexes[Index]>): PromiseEntActionOrNull<EntsDataModel, Table>;
+    get(id: GenericId<Table>): PromiseEntActionOrNull<EntsDataModel, Table>;
+    /**
+     * Fetch a unique document from the DB using given index, throw if it doesn't exist.
+     */
+    getX<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, ...values: IndexFieldTypesForEq<EntsDataModel, Table, Indexes[Index]>): PromiseEntAction<EntsDataModel, Table>;
+    /**
+     * Fetch a document from the DB for a given ID, throw if it doesn't exist.
+     */
+    getX(id: GenericId<Table>): PromiseEntAction<EntsDataModel, Table>;
+    getMany<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, values: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>[]): PromiseEntsActionOrNulls<EntsDataModel, Table>;
+    getMany(ids: GenericId<Table>[]): PromiseEntsActionOrNulls<EntsDataModel, Table>;
+    getManyX<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, values: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>[]): PromiseEntsAction<EntsDataModel, Table>;
+    getManyX(ids: GenericId<Table>[]): PromiseEntsAction<EntsDataModel, Table>;
+    /**
+     * Query by running a full text search against a search index.
+     *
+     * Search queries must always search for some text within the index's
+     * `searchField`. This query can optionally add equality filters for any
+     * `filterFields` specified in the index.
+     *
+     * Documents will be returned in relevance order based on how well they
+     * match the search text.
+     *
+     * To learn about full text search, see [Indexes](https://docs.convex.dev/text-search).
+     *
+     * @param indexName - The name of the search index to query.
+     * @param searchFilter - A search filter expression constructed with the
+     * supplied {@link SearchFilterBuilder}. This defines the full text search to run
+     * along with equality filtering to run within the search index.
+     * @returns - A query that searches for matching documents, returning them
+     * in relevancy order.
+     */
+    search<IndexName extends SearchIndexNames<NamedTableInfo<EntsDataModel, Table>>>(indexName: IndexName, searchFilter: (q: SearchFilterBuilder<DocumentByName<EntsDataModel, Table>, NamedSearchIndex<NamedTableInfo<EntsDataModel, Table>, IndexName>>) => SearchFilter): PromiseOrderedQueryAction<EntsDataModel, Table>;
+    /**
+     * Insert a new document into a table.
+     *
+     * @param table - The name of the table to insert a new document into.
+     * @param value - The {@link Value} to insert into the given table.
+     * @returns - {@link GenericId} of the new document.
+     */
+    insert(value: Expand<WithoutSystemFields<WithEdgeInserts<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>>): PromiseEntIdAction<EntsDataModel, Table>;
+    /**
+     * Insert new documents into a table.
+     *
+     * @param table - The name of the table to insert a new document into.
+     * @param value - The {@link Value} to insert into the given table.
+     * @returns - {@link GenericId} of the new document.
+     */
+    insertMany(values: Expand<WithoutSystemFields<WithEdgeInserts<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>>[]): Promise<GenericId<Table>[]>;
+}
+interface PromiseEntIdAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<GenericId<Table>> {
+    get(): Promise<DocumentByName<EntsDataModel, Table>>;
+}
+interface PromiseEntActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table> | null> {
+    edge<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge): PromiseEdgeActionOrNull<EntsDataModel, Table, Edge>;
+}
+interface PromiseEntAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>> {
+    edge<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge): PromiseEdgeAction<EntsDataModel, Table, Edge>;
+    /**
+     * Patch this existing document, shallow merging it with the given partial
+     * document.
+     *
+     * New fields are added. Existing fields are overwritten. Fields set to
+     * `undefined` are removed.
+     *
+     * @param value - The partial {@link GenericDocument} to merge into this document. If this new value
+     * specifies system fields like `_id`, they must match the document's existing field values.
+     */
+    patch(value: Partial<Expand<WithEdgePatches<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>>): PromiseEntIdAction<EntsDataModel, Table>;
+    /**
+     * Replace the value of an existing document, overwriting its old value.
+     *
+     * @param value - The new {@link GenericDocument} for the document. This value can omit the system fields,
+     * and the database will preserve them in.
+     */
+    replace(value: Expand<WithOptionalSystemFields<WithEdges<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>>): PromiseEntIdAction<EntsDataModel, Table>;
+    /**
+     * Delete this existing document.
+     *
+     * @param id - The {@link GenericId} of the document to remove.
+     */
+    delete(): Promise<GenericId<Table>>;
+}
+interface PromiseEntsActionOrNulls<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<(DocumentByName<EntsDataModel, Table> | null)[]> {
+}
+interface PromiseEntsActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>[] | null> {
+}
+interface PromiseEntsAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>[]> {
+}
+type PromiseEdgeAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEntsAction<EntsDataModel, ToTable>, PromiseQueryAction<EntsDataModel, ToTable>, PromiseEntActionOrNull<EntsDataModel, ToTable>, PromiseEntAction<EntsDataModel, ToTable>>;
+type PromiseEdgeActionOrThrow<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEntsAction<EntsDataModel, ToTable>, PromiseQueryAction<EntsDataModel, ToTable>, PromiseEntAction<EntsDataModel, ToTable>, PromiseEntAction<EntsDataModel, ToTable>>;
+type PromiseEdgeActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>, Edge extends keyof EntsDataModel[Table]["edges"], Config extends GenericEdgeConfig = EntsDataModel[Table]["edges"][Edge], ToTable extends TableNamesInDataModel<EntsDataModel> = EntsDataModel[Table]["edges"][Edge]["to"]> = PromiseEdgeResult<Config, PromiseEdgeEntsActionOrNull<EntsDataModel, ToTable>, PromiseQueryActionOrNull<EntsDataModel, ToTable>, PromiseEntActionOrNull<EntsDataModel, ToTable>, PromiseEntActionOrNull<EntsDataModel, ToTable>>;
+interface PromiseEdgeOrderedEntsActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseEntsActionOrNull<EntsDataModel, Table> {
+    /**
+     * Paginate the ents on the other end of the edge.
+     * Results are ordered by edge's `_creationTime`.
+     */
+    paginate(paginationOpts: PaginationOptions): PromisePaginationResultActionOrNull<EntsDataModel, Table>;
+    /**
+     * Take the first `n` ents on the other end of the edge
+     * ordered by edge's `_creationTime`.
+     */
+    take(n: number): PromiseEntsActionOrNull<EntsDataModel, Table>;
+    /**
+     * Returns the first ent on the other end of the edge
+     * ordered by edge's `_creationTime`, or `null`.
+     */
+    first(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    /**
+     * Returns the only ent on the other end of the edge,
+     * `null` if there are none, or throws if there are more than one.
+     */
+    unique(): PromiseEntActionOrNull<EntsDataModel, Table>;
+}
+interface PromiseEdgeEntsActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseEdgeOrderedEntsActionOrNull<EntsDataModel, Table> {
+    /**
+     * Returns whether there is an ent with given ID on the other side
+     * the edge. Returns null if chained to a null result.
+     * @param id The ID of the ent on the other end of the edge
+     */
+    has(id: GenericId<Table>): Promise<boolean | null>;
+    /**
+     * Query the ents on the other end of the edge
+     * ordered by edge's `_creationTime`.
+     */
+    order(order: "asc" | "desc", indexName?: IndexNames<NamedTableInfo<EntsDataModel, Table>>): PromiseEdgeOrderedEntsActionOrNull<EntsDataModel, Table>;
+}
+interface PromiseEdgeOrderedEntsAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseEntsAction<EntsDataModel, Table> {
+    /**
+     * Paginate the ents on the other end of the edge.
+     * Results are ordered by edge's `_creationTime`.
+     */
+    paginate(paginationOpts: PaginationOptions): PromisePaginationResultAction<EntsDataModel, Table>;
+    /**
+     * Take the first `n` ents on the other end of the edge
+     * ordered by edge's `_creationTime`.
+     */
+    take(n: number): PromiseEntsAction<EntsDataModel, Table>;
+    /**
+     * Returns the first ent on the other end of the edge
+     * ordered by edge's `_creationTime`, or `null`.
+     */
+    first(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    /**
+     * Returns the first ent on the other end of the edge
+     * ordered by edge's `_creationTime`, or throws if there
+     * are no ents on the other end of the edge.
+     */
+    firstX(): PromiseEntAction<EntsDataModel, Table>;
+    /**
+     * Returns the only ent on the other end of the edge,
+     * `null` if there are none, or throws if there are more than one.
+     */
+    unique(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    /**
+     * Returns the only ent on the other end of the edge,
+     * or throws if there are none or more than one.
+     */
+    uniqueX(): PromiseEntAction<EntsDataModel, Table>;
+}
+interface PromiseEdgeEntsAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseEdgeOrderedEntsAction<EntsDataModel, Table> {
+    /**
+     * Returns whether there is an ent with given ID on the other side
+     * the edge.
+     * @param id The ID of the ent on the other end of the edge
+     */
+    has(id: GenericId<Table>): Promise<boolean>;
+    /**
+     * Query the ents on the other end of the edge
+     * ordered by edge's `_creationTime`.
+     */
+    order(order: "asc" | "desc", indexName?: IndexNames<NamedTableInfo<EntsDataModel, Table>>): PromiseEdgeOrderedEntsAction<EntsDataModel, Table>;
+}
+interface PromiseOrderedQueryAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>[]> {
+    filter(predicate: (q: FilterBuilder<NamedTableInfo<EntsDataModel, Table>>) => ExpressionOrValue<boolean>): this;
+    paginate(paginationOpts: PaginationOptions): PromisePaginationResultAction<EntsDataModel, Table>;
+    take(n: number): PromiseEntsAction<EntsDataModel, Table>;
+    first(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    firstX(): PromiseEntAction<EntsDataModel, Table>;
+    unique(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    uniqueX(): PromiseEntAction<EntsDataModel, Table>;
+}
+interface PromiseQueryAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseOrderedQueryAction<EntsDataModel, Table> {
+    order(order: "asc" | "desc", indexName?: IndexNames<NamedTableInfo<EntsDataModel, Table>>): PromiseOrderedQueryAction<EntsDataModel, Table>;
+}
+interface PromisePaginationResultActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<PaginationResult<DocumentByName<EntsDataModel, Table>> | null> {
+}
+interface PromisePaginationResultAction<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<PaginationResult<DocumentByName<EntsDataModel, Table>>> {
+}
+interface PromiseOrderedQueryActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>[] | null> {
+    filter(predicate: (q: FilterBuilder<NamedTableInfo<EntsDataModel, Table>>) => ExpressionOrValue<boolean>): this;
+    paginate(paginationOpts: PaginationOptions): PromisePaginationResultActionOrNull<EntsDataModel, Table>;
+    take(n: number): PromiseEntsActionOrNull<EntsDataModel, Table>;
+    first(): PromiseEntActionOrNull<EntsDataModel, Table>;
+    unique(): PromiseEntActionOrNull<EntsDataModel, Table>;
+}
+interface PromiseQueryActionOrNull<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseOrderedQueryActionOrNull<EntsDataModel, Table> {
+    order(order: "asc" | "desc", indexName?: IndexNames<NamedTableInfo<EntsDataModel, Table>>): PromiseOrderedQueryActionOrNull<EntsDataModel, Table>;
+}
+declare class PromiseQueryActionOrNullImpl<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table>[] | null> implements PromiseQueryActionOrNull<EntsDataModel, Table> {
+    protected ctx: EntActionCtx<EntsDataModel>;
+    protected entDefinitions: EntsDataModel;
+    protected table: Table;
+    protected read: SerializedRead;
+    constructor(ctx: EntActionCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table, read: SerializedRead);
+    filter(predicate: (q: FilterBuilder<NamedTableInfo<EntsDataModel, Table>>) => ExpressionOrValue<boolean>): any;
+    order(order: "asc" | "desc", indexName?: IndexNames<NamedTableInfo<EntsDataModel, Table>>): any;
+    paginate(paginationOpts: PaginationOptions): PromisePaginationResultActionOrNullImpl<EntsDataModel, Table>;
+    take(n: number): Promise<any>;
+    first(): any;
+    firstX(): any;
+    unique(): any;
+    uniqueX(): any;
+    then<TResult1 = DocumentByName<EntsDataModel, Table>[] | null, TResult2 = never>(onfulfilled?: ((value: DocumentByName<EntsDataModel, Table>[] | null) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+}
+declare class PromiseTableActionImpl<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends PromiseQueryActionOrNullImpl<EntsDataModel, Table> {
+    constructor(ctx: EntActionCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table);
+    get(...args: any[]): PromiseEntActionImpl<EntsDataModel, Table>;
+    getX(...args: any[]): PromiseEntActionImpl<EntsDataModel, Table>;
+    getMany(...args: any[]): Promise<any>;
+    getManyX(...args: any[]): Promise<any>;
+    normalizeId(id: string): Promise<GenericId<Table> | null>;
+    normalizeIdX(id: string): Promise<GenericId<Table>>;
+    withIndex(indexName: IndexNames<NamedTableInfo<EntsDataModel, Table>>, indexRange?: (q: IndexRangeBuilder<DocumentByName<EntsDataModel, Table>, NamedIndex<NamedTableInfo<EntsDataModel, Table>, typeof indexName>>) => IndexRange): PromiseQueryActionOrNullImpl<EntsDataModel, Table>;
+    search<IndexName extends SearchIndexNames<NamedTableInfo<EntsDataModel, Table>>>(indexName: IndexName, searchFilter: (q: SearchFilterBuilder<DocumentByName<EntsDataModel, Table>, NamedSearchIndex<NamedTableInfo<EntsDataModel, Table>, IndexName>>) => SearchFilter): PromiseQueryActionOrNullImpl<EntsDataModel, Table>;
+    insert(value: WithoutSystemFields<WithEdgeInserts<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>): PromiseEntIdActionImpl<EntsDataModel, Table>;
+    insertMany(values: WithoutSystemFields<WithEdgeInserts<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>[]): Promise<any>;
+}
+declare class PromisePaginationResultActionOrNullImpl<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<PaginationResult<DocumentByName<EntsDataModel, Table>> | null> implements PromisePaginationResultActionOrNull<EntsDataModel, Table> {
+    private ctx;
+    private entDefinitions;
+    private table;
+    private read;
+    constructor(ctx: EntActionCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table, read: SerializedRead);
+    then<TResult1 = DocumentByName<EntsDataModel, Table>[] | null, TResult2 = never>(onfulfilled?: ((value: PaginationResult<DocumentByName<EntsDataModel, Table>> | null) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+}
+declare class PromiseEntActionImpl<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<DocumentByName<EntsDataModel, Table> | null> {
+    protected ctx: EntActionCtx<EntsDataModel>;
+    protected entDefinitions: EntsDataModel;
+    protected table: Table;
+    protected read: SerializedRead;
+    constructor(ctx: EntActionCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table, read: SerializedRead);
+    then<TResult1 = Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel> | null, TResult2 = never>(onfulfilled?: ((value: Ent<Table, DocumentByName<EntsDataModel, Table>, EntsDataModel> | null) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+    edge<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge): any;
+    edgeX<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge): any;
+    edgeImpl<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge, throwIfNull?: boolean): any;
+    patch(value: Partial<WithEdgePatches<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>): PromiseEntIdActionImpl<EntsDataModel, Table>;
+    replace(value: WithOptionalSystemFields<WithEdges<DocumentByName<EntsDataModel, Table>, EntsDataModel[Table]["edges"]>>): PromiseEntIdActionImpl<EntsDataModel, Table>;
+    delete(): Promise<any>;
+}
+declare class PromiseEntIdActionImpl<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> extends Promise<GenericId<Table>> implements PromiseEntIdAction<EntsDataModel, Table> {
+    private ctx;
+    private entDefinitions;
+    private table;
+    private write;
+    constructor(ctx: EntActionCtx<EntsDataModel>, entDefinitions: EntsDataModel, table: Table, write: SerializedWrite);
+    get(): Promise<any>;
+    then<TResult1 = GenericId<Table>, TResult2 = never>(onfulfilled?: ((value: GenericId<Table>) => TResult1 | PromiseLike<TResult1>) | undefined | null, onrejected?: ((reason: any) => TResult2 | PromiseLike<TResult2>) | undefined | null): Promise<TResult1 | TResult2>;
+}
+declare function serializeExpression(expr: ExpressionOrValue<Value | undefined>): JSONValue;
+type SerializedSearchFilter = {
+    type: "Search";
+    fieldPath: string;
+    value: string;
+} | {
+    type: "Eq";
+    fieldPath: string;
+    value: Value;
+};
+
+export { type EntQueryCtx as $, type PromiseEnt as A, type PromiseArrayOrNull as B, type PromiseArray as C, entWrapper as D, type EdgeChanges as E, entsTableFactory as F, type EntsTable as G, type EntsTableWriter as H, type Ent as I, type GenericEnt as J, type PromiseEdge as K, type PromiseEdgeOrThrow as L, type PromiseEdgeWriter as M, type PromiseEdgeWriterOrThrow as N, type PromiseEdgeWriterOrNull as O, type PromiseOrderedQueryOrNull as P, type PromiseOrderedQueryWriter as Q, type PromiseQueryWriter as R, type PromiseEntsWriter as S, type PromisePaginationResultWriterOrNull as T, type PromisePaginationResultWriter as U, type PromiseTableWriter as V, WriterImplBase as W, type PromiseEntWriterOrNull as X, type PromiseEntWriter as Y, type GenericEntWriter as Z, type PromiseEntId as _, type WithEdgeInserts as a, type EntMutationCtx as a0, type DocRetriever as a1, addEntRules as a2, getReadRule as a3, getWriteRule as a4, getDeletionConfig as a5, type EntActionCtx as a6, type ActionReadFuncRef as a7, type ActionWriteFuncRef as a8, entsActionReadFactory as a9, entsActionWriteFactory as aa, type EntsTableAction as ab, type PromiseTableAction as ac, type PromiseEntIdAction as ad, type PromiseEntActionOrNull as ae, type PromiseEntAction as af, type PromiseEntsActionOrNulls as ag, type PromiseEntsActionOrNull as ah, type PromiseEntsAction as ai, type PromiseEdgeAction as aj, type PromiseEdgeActionOrThrow as ak, type PromiseEdgeActionOrNull as al, type PromiseEdgeOrderedEntsActionOrNull as am, type PromiseEdgeEntsActionOrNull as an, type PromiseEdgeOrderedEntsAction as ao, type PromiseEdgeEntsAction as ap, type PromiseOrderedQueryAction as aq, type PromiseQueryAction as ar, type PromisePaginationResultActionOrNull as as, type PromisePaginationResultAction as at, type PromiseOrderedQueryActionOrNull as au, type PromiseQueryActionOrNull as av, PromiseTableActionImpl as aw, serializeExpression as ax, type SerializedSearchFilter as ay, type WithEdges as b, type WithEdgePatches as c, type PromiseOrderedQueryWriterOrNull as d, type PromiseQueryOrNull as e, type PromiseQueryWriterOrNull as f, type PromiseTableBase as g, type PromiseTable as h, type PromiseOrderedQueryBase as i, type PromiseOrderedQuery as j, type PromiseQuery as k, type PromisePaginationResultOrNull as l, type PromisePaginationResult as m, type PromiseEntsOrNull as n, type PromiseEntsWriterOrNull as o, type PromiseEnts as p, type PromiseEntsOrNulls as q, type PromiseEdgeOrderedEntsOrNull as r, type PromiseEdgeEntsOrNull as s, type PromiseEdgeOrderedEntsWriterOrNull as t, type PromiseEdgeEntsWriterOrNull as u, type PromiseEdgeOrderedEnts as v, type PromiseEdgeEnts as w, type PromiseEdgeOrderedEntsWriter as x, type PromiseEdgeEntsWriter as y, type PromiseEntOrNull as z };

package/dist/index.d.ts

@@ -1,5 +1,6 @@
 export { EntDefinition, defineEnt, defineEntFromTable, defineEntSchema, defineEntsFromTables, getEntDefinitions } from './schema.js';
-export { J as GenericEnt, Z as GenericEntWriter, w as PromiseEdgeEnts, s as PromiseEdgeEntsOrNull, y as PromiseEdgeEntsWriter, M as PromiseEdgeWriter, O as PromiseEdgeWriterOrNull, N as PromiseEdgeWriterOrThrow, A as PromiseEnt, _ as PromiseEntId, z as PromiseEntOrNull, Y as PromiseEntWriter, X as PromiseEntWriterOrNull, p as PromiseEnts, n as PromiseEntsOrNull, q as PromiseEntsOrNulls, S as PromiseEntsWriter, o as PromiseEntsWriterOrNull, j as PromiseOrderedQuery, i as PromiseOrderedQueryBase, P as PromiseOrderedQueryOrNull, Q as PromiseOrderedQueryWriter, d as PromiseOrderedQueryWriterOrNull, k as PromiseQuery, e as PromiseQueryOrNull, R as PromiseQueryWriter, f as PromiseQueryWriterOrNull, h as PromiseTable, g as PromiseTableBase, V as PromiseTableWriter, a2 as addEntRules, F as entsTableFactory } from './index-nOBiMg01.js';
+export { J as GenericEnt, Z as GenericEntWriter, w as PromiseEdgeEnts, s as PromiseEdgeEntsOrNull, y as PromiseEdgeEntsWriter, M as PromiseEdgeWriter, O as PromiseEdgeWriterOrNull, N as PromiseEdgeWriterOrThrow, A as PromiseEnt, _ as PromiseEntId, z as PromiseEntOrNull, Y as PromiseEntWriter, X as PromiseEntWriterOrNull, p as PromiseEnts, n as PromiseEntsOrNull, q as PromiseEntsOrNulls, S as PromiseEntsWriter, o as PromiseEntsWriterOrNull, j as PromiseOrderedQuery, i as PromiseOrderedQueryBase, P as PromiseOrderedQueryOrNull, Q as PromiseOrderedQueryWriter, d as PromiseOrderedQueryWriterOrNull, k as PromiseQuery, e as PromiseQueryOrNull, R as PromiseQueryWriter, f as PromiseQueryWriterOrNull, h as PromiseTable, g as PromiseTableBase, V as PromiseTableWriter, a2 as addEntRules, a9 as entsActionReadFactory, aa as entsActionWriteFactory, F as entsTableFactory } from './index-olos0Rx-.js';
 export { scheduledDeleteFactory } from './deletion.js';
 import 'convex/server';
 import 'convex/values';
+import './shared.js';