convex-ents 0.4.2 → 0.4.3

package/dist/{index-6qe2c6eO.d.ts → index-WGlX_PmZ.d.ts}

@@ -1,7 +1,7 @@
 import { GenericEntsDataModel, GenericEdgeConfig, Expand, EdgeConfig, 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, IndexRangeBuilder, NamedIndex, IndexRange, WithoutSystemFields, WithOptionalSystemFields, GenericDataModel, GenericDatabaseReader, GenericDatabaseWriter, Scheduler } from 'convex/server';
+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 { ScheduledDeleteFuncRef } from './deletion.js';
 
 declare class WriterImplBase<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> {
@@ -66,7 +66,7 @@ interface PromiseTable<EntsDataModel extends GenericEntsDataModel, Table extends
     get<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, value0: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>): PromiseEntOrNull<EntsDataModel, Table>;
     get(id: GenericId<Table>): PromiseEntOrNull<EntsDataModel, Table>;
     /**
-     * Fetch a document from the DB using given index, throw if it doesn't exist.
+     * 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, value0: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>): PromiseEnt<EntsDataModel, Table>;
     /**
@@ -165,13 +165,22 @@ declare function entWrapper<EntsDataModel extends GenericEntsDataModel, Table ex
 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>;
-type EntsTable<EntsDataModel extends GenericEntsDataModel> = {
+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>;
 };
+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>;
+    system: EntsTableReader<EntsSystemDataModel>;
 };
 declare class EntInstance<EntsDataModel extends GenericEntsDataModel, Table extends TableNamesInDataModel<EntsDataModel>> {
     edge<Edge extends keyof EntsDataModel[Table]["edges"]>(edge: Edge): PromiseEdge<EntsDataModel, Table, Edge>;
@@ -207,7 +216,7 @@ interface PromiseTableWriter<Table extends TableNamesInDataModel<EntsDataModel>,
     get<Indexes extends EntsDataModel[Table]["indexes"], Index extends keyof Indexes>(indexName: Index, value0: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>): PromiseEntWriterOrNull<EntsDataModel, Table>;
     get(id: GenericId<Table>): PromiseEntWriterOrNull<EntsDataModel, Table>;
     /**
-     * Fetch a document from the DB using given index, throw if it doesn't exist.
+     * 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, value0: FieldTypeFromFieldPath<DocumentByName<EntsDataModel, Table>, Indexes[Index][0]>): PromiseEntWriter<EntsDataModel, Table>;
     /**
@@ -365,4 +374,4 @@ declare function getWriteRule(entDefinitions: GenericEntsDataModel, table: strin
 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 PromiseQueryWriter as A, type PromiseEntsWriter as B, type PromisePaginationResultWriter as C, type PromiseTableWriter as D, type EdgeChanges as E, type PromiseEntWriterOrNull as F, type GenericEnt as G, type PromiseEntWriter as H, type GenericEntWriter as I, type PromiseEntId as J, type EntQueryCtx as K, type EntMutationCtx as L, type DocRetriever as M, addEntRules as N, getReadRule as O, type PromiseOrderedQueryOrNull as P, getWriteRule as Q, getEdgeDefinitions as R, getDeletionConfig as S, WriterImplBase as W, type WithEdgeInserts as a, type WithEdges as b, type WithEdgePatches as c, type PromiseQueryOrNull as d, type PromiseTableBase as e, type PromiseTable as f, type PromiseOrderedQueryBase as g, type PromiseOrderedQuery as h, type PromiseQuery as i, type PromisePaginationResultOrNull as j, type PromisePaginationResult as k, type PromiseEntsOrNull as l, type PromiseEnts as m, type PromiseEntsOrNulls as n, type PromiseEdgeEntsOrNull as o, type PromiseEdgeEnts as p, type PromiseEntOrNull as q, type PromiseEnt as r, type PromiseArrayOrNull as s, type PromiseArray as t, entWrapper as u, entsTableFactory as v, type Ent as w, type PromiseEdge as x, type PromiseEdgeOrThrow as y, type PromiseOrderedQueryWriter as z };
+export { type PromiseEdgeOrThrow as A, type PromiseOrderedQueryWriter as B, type PromiseQueryWriter as C, type PromiseEntsWriter as D, type EdgeChanges as E, type PromisePaginationResultWriter as F, type GenericEnt as G, type PromiseTableWriter as H, type PromiseEntWriterOrNull as I, type PromiseEntWriter as J, type GenericEntWriter as K, type PromiseEntId as L, type EntQueryCtx as M, type EntMutationCtx as N, type DocRetriever as O, type PromiseOrderedQueryOrNull as P, addEntRules as Q, getReadRule as R, getWriteRule as S, getEdgeDefinitions as T, getDeletionConfig as U, WriterImplBase as W, type WithEdgeInserts as a, type WithEdges as b, type WithEdgePatches as c, type PromiseQueryOrNull as d, type PromiseTableBase as e, type PromiseTable as f, type PromiseOrderedQueryBase as g, type PromiseOrderedQuery as h, type PromiseQuery as i, type PromisePaginationResultOrNull as j, type PromisePaginationResult as k, type PromiseEntsOrNull as l, type PromiseEnts as m, type PromiseEntsOrNulls as n, type PromiseEdgeEntsOrNull as o, type PromiseEdgeEnts as p, type PromiseEntOrNull as q, type PromiseEnt as r, type PromiseArrayOrNull as s, type PromiseArray as t, entWrapper as u, entsTableFactory as v, type EntsTable as w, type EntsTableWriter as x, type Ent as y, type PromiseEdge as z };

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 export { EntDefinition, defineEnt, defineEntSchema, getEntDefinitions } from './schema.js';
-export { G as GenericEnt, I as GenericEntWriter, p as PromiseEdgeEnts, o as PromiseEdgeEntsOrNull, r as PromiseEnt, J as PromiseEntId, q as PromiseEntOrNull, H as PromiseEntWriter, F as PromiseEntWriterOrNull, m as PromiseEnts, l as PromiseEntsOrNull, n as PromiseEntsOrNulls, B as PromiseEntsWriter, h as PromiseOrderedQuery, g as PromiseOrderedQueryBase, P as PromiseOrderedQueryOrNull, z as PromiseOrderedQueryWriter, i as PromiseQuery, d as PromiseQueryOrNull, A as PromiseQueryWriter, f as PromiseTable, e as PromiseTableBase, D as PromiseTableWriter, N as addEntRules, v as entsTableFactory } from './index-6qe2c6eO.js';
+export { G as GenericEnt, K as GenericEntWriter, p as PromiseEdgeEnts, o as PromiseEdgeEntsOrNull, r as PromiseEnt, L as PromiseEntId, q as PromiseEntOrNull, J as PromiseEntWriter, I as PromiseEntWriterOrNull, m as PromiseEnts, l as PromiseEntsOrNull, n as PromiseEntsOrNulls, D as PromiseEntsWriter, h as PromiseOrderedQuery, g as PromiseOrderedQueryBase, P as PromiseOrderedQueryOrNull, B as PromiseOrderedQueryWriter, i as PromiseQuery, d as PromiseQueryOrNull, C as PromiseQueryWriter, f as PromiseTable, e as PromiseTableBase, H as PromiseTableWriter, Q as addEntRules, v as entsTableFactory } from './index-WGlX_PmZ.js';
 export { scheduledDeleteFactory } from './deletion.js';
 import 'convex/server';
 import 'convex/values';

package/dist/index.js

@@ -856,7 +856,12 @@ var PromisePaginationResultOrNullImpl = class extends Promise {
 };
 var PromiseTableImpl = class extends PromiseQueryOrNullImpl {
   constructor(ctx, entDefinitions, table) {
-    super(ctx, entDefinitions, table, async () => ctx.db.query(table));
+    super(
+      ctx,
+      entDefinitions,
+      table,
+      async () => isSystemTable(table) ? ctx.db.system.query(table) : ctx.db.query(table)
+    );
   }
   get(...args) {
     return this.getImpl(args);
@@ -883,7 +888,7 @@ var PromiseTableImpl = class extends PromiseQueryOrNullImpl {
         return {
           id,
           doc: async () => {
-            const doc = await this.ctx.db.get(id);
+            const doc = await (isSystemTable(this.table) ? this.ctx.db.system.get(id) : this.ctx.db.get(id));
             if (throwIfNull && doc === null) {
               throw new Error(
                 `Document not found with id \`${id}\` in table "${this.table}"`
@@ -921,7 +926,7 @@ var PromiseTableImpl = class extends PromiseQueryOrNullImpl {
         });
         return await Promise.all(
           ids.map(async (id) => {
-            const doc = await this.ctx.db.get(id);
+            const doc = await (isSystemTable(this.table) ? this.ctx.db.system.get(id) : this.ctx.db.get(id));
             if (doc === null) {
               throw new Error(
                 `Document not found with id \`${id}\` in table "${this.table}"`
@@ -1310,7 +1315,7 @@ function entWrapper(fields, ctx, entDefinitions, table) {
     writable: false,
     configurable: false
   });
-  Object.entries(entDefinitions[table].defaults).map(
+  Object.entries(entDefinitions[table]?.defaults ?? []).map(
     ([field, value]) => {
       if (doc[field] === void 0) {
         doc[field] = value;
@@ -1321,26 +1326,28 @@ function entWrapper(fields, ctx, entDefinitions, table) {
 }
 function entsTableFactory(ctx, entDefinitions, options) {
   const enrichedCtx = options !== void 0 ? { ...ctx, ...options } : ctx;
-  return (table, indexName, indexRange) => {
-    if (typeof table !== "string") {
-      throw new Error(`Expected table name, got \`${table}\``);
+  const table = (table2, indexName, indexRange) => {
+    if (typeof table2 !== "string") {
+      throw new Error(`Expected table name, got \`${table2}\``);
     }
     if (indexName !== void 0) {
       return new PromiseTableImpl(
         enrichedCtx,
         entDefinitions,
-        table
+        table2
       ).withIndex(indexName, indexRange);
     }
     if (ctx.db.insert !== void 0) {
       return new PromiseTableWriterImpl(
         enrichedCtx,
         entDefinitions,
-        table
+        table2
       );
     }
-    return new PromiseTableImpl(enrichedCtx, entDefinitions, table);
+    return new PromiseTableImpl(enrichedCtx, entDefinitions, table2);
   };
+  table.system = table;
+  return table;
 }
 var PromiseTableWriterImpl = class extends PromiseTableImpl {
   constructor(ctx, entDefinitions, table) {
@@ -1444,7 +1451,7 @@ var PromiseEntWriterImpl = class extends PromiseEntOrNullImpl {
                       ).collect() : []
                     )
                   )
-                )).map((edgeDoc) => edgeDoc._id);
+                )).flat().map((edgeDoc) => edgeDoc._id);
                 edges[key] = {
                   add,
                   removeEdges
@@ -1600,6 +1607,9 @@ function getEdgeDefinitions(entDefinitions, table) {
 function getDeletionConfig(entDefinitions, table) {
   return entDefinitions[table].deletionConfig;
 }
+function isSystemTable(table) {
+  return table.startsWith("_");
+}
 
 // src/deletion.ts
 var import_server3 = require("convex/server");