@voltro/database 0.26.0 → 0.28.0

package/dist/index.d.ts

@@ -488,6 +488,9 @@ export declare interface CdcConfig {
  *  warns. See this file's header for why it is 512 and why it is not `0`. */
 export declare const CHANGE_LISTENER_CEILING = 512;
 
+/** A row was removed from the table. `new` is null, always. */
+export declare const changeDelete: (table: string, row: Row, meta?: ChangeEventMeta) => ChangeEvent;
+
 /**
  * A row-change event emitted by the data store (in-memory) or the CDC
  * consumer (Postgres logical replication). Drives the reactive engine.
@@ -548,6 +551,29 @@ export declare type ChangeEvent = {
     readonly procedure?: string;
 };
 
+/** Attribution and origin, identical on every constructor. */
+export declare type ChangeEventMeta = Pick<ChangeEvent, 'origin' | 'traceId' | 'subjectId' | 'procedure'>;
+
+/** A row was created. `old` is null, always. */
+export declare const changeInsert: (table: string, row: Row, meta?: ChangeEventMeta) => ChangeEvent;
+
+/**
+ * A row was SOFT-deleted — an `update` that sets `deletedAt`.
+ *
+ * Not a `delete`, and that is the point. A test reaching for `changeDelete`
+ * here is describing a hard delete, which is a different event with different
+ * consequences: a soft delete is reversible, so anything cascading off it
+ * destroys rows a restore cannot bring back.
+ *
+ * `at` defaults to a fixed instant rather than `new Date()`: the value is never
+ * what a soft-delete rule reads — the null → non-null TRANSITION is — and a
+ * moving default makes a test that snapshots the event flake for no reason.
+ */
+export declare const changeSoftDelete: (table: string, row: Row, opts?: {
+    readonly at?: string | Date;
+    readonly column?: string;
+} & ChangeEventMeta) => ChangeEvent;
+
 /**
  * Whether the DataStore emits ChangeEvents inline from each write
  * (`inline`) or via the dialect's CDC consumer (`cdc`).
@@ -560,6 +586,9 @@ export declare type ChangeEvent = {
  */
 export declare type ChangeStrategy = 'inline' | 'cdc';
 
+/** A row changed. Both sides are present, because an update has both. */
+export declare const changeUpdate: (table: string, before: Row, after: Row, meta?: ChangeEventMeta) => ChangeEvent;
+
 /**
  * Claim the attribution for an echo, or `undefined` if this write did not
  * originate here.
@@ -4820,6 +4849,20 @@ export declare interface SchemaTable extends TableLike {
     readonly tableName: string;
     readonly fields: Record<string, ColumnDefinition<unknown>>;
     readonly appliedIndexes: ReadonlyArray<TableIndex>;
+    /**
+     * The plugin references DECLARED on this table, surviving `table()`.
+     *
+     * `pluginRefSpecOf` reads a column BUILDER, and materialisation replaces it
+     * with a plain field descriptor — so without this the declaration is
+     * unreadable the moment the table exists, and any tool deriving structure
+     * from the schema sees an ordinary `text()` column.
+     */
+    readonly appliedPluginRefs?: ReadonlyArray<{
+        readonly column: string;
+        readonly target: () => unknown;
+        readonly orphanPolicy: PluginRefOrphanPolicy;
+        readonly onSoftDelete: boolean;
+    }>;
     /**
      * Declared full-text indexes. Carried so a `SchemaTable`-annotated table
      * is still a valid `queryFor(...)` input (the builder reads this to let
@@ -5247,6 +5290,20 @@ export declare interface Table<Name extends string, Fields extends Record<string
     readonly isReactive: Reactive;
     readonly appliedMixins: ReadonlyArray<AnyMixin>;
     readonly appliedIndexes: ReadonlyArray<TableIndex>;
+    /**
+     * The plugin references DECLARED on this table, surviving `table()`.
+     *
+     * `pluginRefSpecOf` reads a column BUILDER, and materialisation replaces it
+     * with a plain field descriptor — so without this the declaration is
+     * unreadable the moment the table exists, and any tool deriving structure
+     * from the schema sees an ordinary `text()` column.
+     */
+    readonly appliedPluginRefs?: ReadonlyArray<{
+        readonly column: string;
+        readonly target: () => unknown;
+        readonly orphanPolicy: PluginRefOrphanPolicy;
+        readonly onSoftDelete: boolean;
+    }>;
     readonly appliedUniques: ReadonlyArray<TableUnique>;
     readonly appliedFullText: ReadonlyArray<TableFullTextIndex>;
     readonly appliedChecks: ReadonlyArray<TableCheck>;