@rebasepro/types 0.7.0 → 0.9.0

package/src/types/properties.ts

@@ -2,10 +2,10 @@ import type { ComponentRef } from "./component_ref";
 
 import type { Entity, EntityReference, EntityRelation, EntityValues, GeoPoint, Vector } from "./entities";
 import type { JoinStep, OnAction, Relation } from "./relations";
-import type { EntityCollection, FilterValues } from "./collections";
+import type { CollectionConfig, FilterValues, WhereFilterOp } from "./collections";
 import type { ColorKey, ColorScheme } from "./chips";
 import type { AuthController } from "../controllers/auth";
-import type { EntityAfterReadProps, EntityBeforeSaveProps } from "./entity_callbacks";
+import type { AfterReadProps, BeforeSaveProps } from "./entity_callbacks";
 import type { User } from "../users";
 
 /**
@@ -16,7 +16,7 @@ export type PropertyCallbacks<T = unknown, M extends Record<string, unknown> = R
     /**
      * Callback used after fetching data, to transform the value before rendering
      */
-    afterRead?(props: Omit<EntityAfterReadProps<M, USER>, "entity"> & {
+    afterRead?(props: Omit<AfterReadProps<M, USER>, "entity"> & {
         value: T;
         entity: Entity<M> | undefined;
     }): Promise<T> | T;
@@ -25,7 +25,7 @@ export type PropertyCallbacks<T = unknown, M extends Record<string, unknown> = R
      * Callback used before saving, after validation.
      * You can modify the value before it's saved.
      */
-    beforeSave?(props: Omit<EntityBeforeSaveProps<M, USER>, "values"> & {
+    beforeSave?(props: Omit<BeforeSaveProps<M, USER>, "values"> & {
         value: T;
         previousValue: T | undefined;
         values: Partial<M>;
@@ -75,6 +75,20 @@ export type FirebaseProperties = {
     [key: string]: FirebaseProperty;
 };
 
+// MongoDB is a document store: it uses references (stored pointers), not
+// SQL-style relations/joins. Same gating as Firestore.
+export type MongoProperty = Exclude<Property, RelationProperty>;
+export type MongoProperties = {
+    [key: string]: MongoProperty;
+};
+
+/**
+ * Union of all engine-specific property maps. Use this at engine-agnostic
+ * boundaries (collection editor, normalization) where the concrete engine is
+ * unknown but the narrowed property constraint must be satisfied.
+ */
+export type EngineProperties = PostgresProperties | FirebaseProperties | MongoProperties;
+
 /**
  * A helper type to infer the underlying data type from a Property definition.
  * This is the core of the type inference system.
@@ -150,6 +164,33 @@ export interface BaseUIConfig<CustomProps = unknown> {
     customProps?: CustomProps;
     Field?: ComponentRef<any>;
     Preview?: ComponentRef<any>;
+
+    /**
+     * Narrow the filter operators offered for this property in collection
+     * filter UIs (table header filters and the Filters dialog).
+     *
+     * The final offered set is the **intersection** of the engine's
+     * capabilities, the property-type defaults, and this list — you can only
+     * *restrict*, never enable an operator the underlying engine cannot run.
+     *
+     * Pass an empty array to disable filtering on this property entirely.
+     *
+     * @example
+     * // Email column: exact match, contains, and null check only
+     * ui: { filterOperators: ["==", "ilike", "is-null"] }
+     */
+    filterOperators?: readonly WhereFilterOp[];
+
+    /**
+     * Replace the filter field rendered for this property in collection
+     * filter UIs. The component receives `FilterFieldBindingProps`
+     * (property, resolved `operators`, `value`, `setValue`, …).
+     *
+     * Takes precedence over the collection-level
+     * `components["Collection.FilterField"]` override and the built-in
+     * per-type filter fields.
+     */
+    Filter?: ComponentRef<any>;
 }
 
 export interface BaseProperty<CustomProps = unknown> {
@@ -190,10 +231,9 @@ export interface BaseProperty<CustomProps = unknown> {
      */
     validation?: PropertyValidationSchema;
 
-    /**
-     * This value will be set by default for new entities.
-     */
-    defaultValue?: unknown;
+    // NOTE: `defaultValue` is intentionally NOT on BaseProperty.
+    // Each concrete property type (StringProperty, NumberProperty, etc.)
+    // defines its own typed `defaultValue` for compile-time safety.
 
     /**
      * Use this to define dynamic properties that change based on certain conditions
@@ -235,16 +275,37 @@ export interface BaseProperty<CustomProps = unknown> {
  * @group Entity properties
  */
 export interface StringUIConfig extends BaseUIConfig {
+    /**
+     * Is this string property long enough so it should be displayed in
+     * a multiple line field. Defaults to false. If set to true,
+     * the number of lines adapts to the content
+     */
     multiline?: boolean;
+    /**
+     * Should this string property be displayed as a markdown field. If true,
+     * the field is rendered as a text editor that supports markdown highlight
+     * syntax. It also includes a preview of the result.
+     */
     markdown?: boolean;
+    /**
+     * Should this string be rendered as a tag instead of just text.
+     */
     previewAsTag?: boolean;
     clearable?: boolean;
+    /**
+     * If the value of this property is a URL, you can set this flag to true
+     * to add a link, or one of the supported media types to render a preview
+     */
     url?: boolean | PreviewType;
 }
 
 export interface StringProperty extends BaseProperty {
     ui?: StringUIConfig;
     type: "string";
+    /**
+     * Default value for new entities. Must be a string.
+     */
+    defaultValue?: string;
     /**
      * Optional database column type. If not set, it defaults to `varchar` or `uuid` depending on `isId` configuration.
      * Use `text` for strings with unbound length, `char` for fixed-length strings, or `varchar` for variable-length strings with a limit.
@@ -279,18 +340,6 @@ export interface StringProperty extends BaseProperty {
      *
      */
     enum?: EnumValues;
-    /**
-     * Is this string property long enough so it should be displayed in
-     * a multiple line field. Defaults to false. If set to true,
-     * the number of lines adapts to the content
-     */
-    multiline?: boolean;
-    /**
-     * Should this string property be displayed as a markdown field. If true,
-     * the field is rendered as a text editors that supports markdown highlight
-     * syntax. It also includes a preview of the result.
-     */
-    markdown?: boolean;
     /**
      * You can specify a `Storage` configuration. It is used to
      * indicate that this string refers to a path in your storage provider.
@@ -301,33 +350,16 @@ export interface StringProperty extends BaseProperty {
      * This property is used to indicate that the string is a user ID, and
      * it will be rendered as a user picker.
      * Note that the user ID needs to be the one used in your authentication
-     * provider, e.g. Firebase Auth.
+     * provider (e.g. the ID in your `users` table).
      * You can also use a property builder to specify the user path dynamically
      * based on other values of the entity.
      */
     userSelect?: boolean;
 
-    /**
-     * If the value of this property is a URL, you can set this flag to true
-     * to add a link, or one of the supported media types to render a preview
-     */
-    url?: boolean | PreviewType;
     /**
      * Does this field include an email
      */
     email?: boolean;
-    /**
-     * Should this string be rendered as a tag instead of just text.
-     */
-    previewAsTag?: boolean;
-
-    /**
-     * You can use this property (a string) to behave as a reference to another
-     * collection. The stored value is the ID of the entity in the
-     * collection, and the `path` prop is used to
-     * define the collection this reference points to.
-     */
-    reference?: ReferenceProperty;
 }
 
 /**
@@ -340,6 +372,10 @@ export interface NumberUIConfig extends BaseUIConfig {
 export interface NumberProperty extends BaseProperty {
     ui?: NumberUIConfig;
     type: "number";
+    /**
+     * Default value for new entities. Must be a number.
+     */
+    defaultValue?: number;
     /**
      * Optional database column type. Allows specifying exact database numeric types.
      * If not provided, integer fields (where validation.integer is true or isId is true) default to `integer`, others to `numeric`.
@@ -375,6 +411,10 @@ export interface NumberProperty extends BaseProperty {
 export interface BooleanProperty extends BaseProperty {
     ui?: BaseUIConfig;
     type: "boolean";
+    /**
+     * Default value for new entities. Must be a boolean.
+     */
+    defaultValue?: boolean;
     /**
      * Rules for validating this property
      */
@@ -391,6 +431,10 @@ export interface VectorUIConfig extends BaseUIConfig {
 export interface VectorProperty extends BaseProperty {
     ui?: VectorUIConfig;
     type: "vector";
+    /**
+     * Default value for new entities.
+     */
+    defaultValue?: Vector;
     dimensions: number;
     validation?: PropertyValidationSchema;
 }
@@ -400,6 +444,10 @@ export interface VectorProperty extends BaseProperty {
  */
 export interface BinaryProperty extends BaseProperty {
     type: "binary";
+    /**
+     * Default value for new entities. Must be a base64-encoded string.
+     */
+    defaultValue?: string;
     validation?: PropertyValidationSchema;
 }
 
@@ -407,12 +455,19 @@ export interface BinaryProperty extends BaseProperty {
  * @group Entity properties
  */
 export interface DateUIConfig extends BaseUIConfig {
+    /**
+     * Add an icon to clear the value and set it to `null`. Defaults to `false`
+     */
     clearable?: boolean;
 }
 
 export interface DateProperty extends BaseProperty {
     ui?: DateUIConfig;
     type: "date";
+    /**
+     * Default value for new entities. Must be a Date.
+     */
+    defaultValue?: Date;
     /**
      * Optional database column type. If not set, defaults to `timestamp` with timezone.
      */
@@ -438,10 +493,6 @@ export interface DateProperty extends BaseProperty {
      * `updated_on` fields
      */
     autoValue?: "on_create" | "on_update";
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
 }
 
 /**
@@ -450,6 +501,10 @@ export interface DateProperty extends BaseProperty {
 export interface GeopointProperty extends BaseProperty {
     ui?: BaseUIConfig;
     type: "geopoint";
+    /**
+     * Default value for new entities. Must be a GeoPoint.
+     */
+    defaultValue?: GeoPoint;
     /**
      * Rules for validating this property
      */
@@ -463,9 +518,29 @@ export interface ReferenceUIConfig extends BaseUIConfig {
     previewProperties?: string[];
 }
 
+/**
+ * A pointer to a entity, stored **as a value** on the row (id + path, and
+ * optionally a `driver`/`databaseId` for cross-datasource pointers).
+ *
+ * This is the native primitive of **document databases** — it maps 1:1 to a
+ * Firestore `DocumentReference`, and is persisted by the MongoDB driver as a
+ * tagged sub-document. It carries no schema-level relationship (no foreign key,
+ * no join, no cascade) and is resolved on demand.
+ *
+ * **Which to use:**
+ * - Firestore / MongoDB collection → use `reference`.
+ * - Postgres collection → use {@link RelationProperty} (`type: "relation"`),
+ *   which models a real foreign key / join with prefetch and cascade.
+ *
+ * @group Entity properties
+ */
 export interface ReferenceProperty extends BaseProperty {
     ui?: ReferenceUIConfig;
     type: "reference";
+    /**
+     * Default value for new entities. Must be a EntityReference.
+     */
+    defaultValue?: EntityReference;
     /**
      * Marks this field as a Primary Key / Unique Identifier.
      * Framework behavior: Auto-maps to `collection.primaryKeys` internally if not explicitly set.
@@ -507,9 +582,29 @@ export interface RelationUIConfig extends BaseUIConfig {
     widget?: "select" | "dialog";
 }
 
+/**
+ * A schema-level relationship between collections **within a single
+ * datasource** — backed by a foreign key, junction table, or explicit join
+ * path. The resolved value (an `EntityRelation`) can carry a prefetched entity
+ * payload to eliminate N+1 queries, and supports `onUpdate`/`onDelete` cascade.
+ *
+ * This is the native primitive of **relational databases** (Postgres). It is
+ * the SQL counterpart to {@link ReferenceProperty}.
+ *
+ * **Which to use:**
+ * - Postgres collection → use `relation`.
+ * - Firestore / MongoDB collection → use {@link ReferenceProperty}
+ *   (`type: "reference"`), a stored pointer with no join engine.
+ *
+ * @group Entity properties
+ */
 export interface RelationProperty extends BaseProperty {
     ui?: RelationUIConfig;
     type: "relation";
+    /**
+     * Default value for new entities. Must be a EntityRelation or array of EntityRelation.
+     */
+    defaultValue?: EntityRelation | EntityRelation[];
     /**
      * Marks this field as a Primary Key / Unique Identifier.
      * Framework behavior: Auto-maps to `collection.primaryKeys` internally if not explicitly set.
@@ -528,7 +623,7 @@ export interface RelationProperty extends BaseProperty {
      * When set, the framework treats this property as a self-contained relation
      * definition and no separate `relations[]` entry is needed.
      */
-    target?: string | (() => EntityCollection | string);
+    target?: string | (() => CollectionConfig | string);
 
     /**
      * Whether this property references one or many records.
@@ -596,7 +691,7 @@ export interface RelationProperty extends BaseProperty {
     /**
      * Overrides applied to the target collection when rendered as a subcollection tab.
      */
-    overrides?: Partial<EntityCollection>;
+    overrides?: Partial<CollectionConfig>;
 
     // ─── Framework-managed fields ───
 
@@ -649,6 +744,10 @@ export interface ArrayUIConfig extends BaseUIConfig {
 export interface ArrayProperty extends BaseProperty {
     ui?: ArrayUIConfig;
     type: "array";
+    /**
+     * Default value for new entities. Must be an array.
+     */
+    defaultValue?: unknown[];
     /**
      * Optional database column type. By default, maps to a native Postgres array
      * (e.g. `text[]`, `integer[]`/`numeric[]`, `boolean[]`) if the element type
@@ -729,6 +828,10 @@ export interface MapUIConfig extends BaseUIConfig {
 export interface MapProperty extends BaseProperty {
     ui?: MapUIConfig;
     type: "map";
+    /**
+     * Default value for new entities. Must be a record/object.
+     */
+    defaultValue?: Record<string, unknown>;
     /**
      * Optional database column type. Defaults to `jsonb`.
      */
@@ -921,6 +1024,23 @@ export interface ArrayPropertyValidationSchema extends PropertyValidationSchema
  * @group Entity properties
  */
 export type StorageConfig = {
+    /**
+     * Key referencing a named storage backend from the StorageRegistry.
+     * Must match a `StorageSourceDefinition.key` or a key registered
+     * in `initializeRebaseBackend({ storage: { ... } })`.
+     *
+     * When omitted, the default storage source is used.
+     */
+    storageSource?: string;
+
+    /**
+     * Store files for this property as **public**: they are placed under the
+     * public prefix and served via stable, token-less, permanent, CDN-cacheable
+     * URLs (safe to persist and hotlink). Use for public assets like avatars or
+     * storefront images. Defaults to `false` (private, short-lived signed URLs).
+     */
+    public?: boolean;
+
     /**
      * File MIME types that can be uploaded to this reference. Don't specify for
      * all.

package/src/types/property_config.tsx

@@ -85,7 +85,6 @@ export type PropertyConfigId =
     "group" |
     "key_value" |
     "reference" |
-    "reference_as_string" |
     "multi_references" |
     "relation" |
     "switch" |

package/src/types/relations.ts

@@ -1,4 +1,4 @@
-import type { EntityCollection } from "./collections";
+import type { CollectionConfig } from "./collections";
 
 /**
  * @group Models
@@ -20,7 +20,7 @@ export interface Relation {
     /**
      * The final collection you want to retrieve records from.
      */
-    target: (() => EntityCollection) | any;
+    target: (() => CollectionConfig) | any;
 
     /**
      * The nature of the relationship, determining if one or many records are returned.
@@ -282,7 +282,7 @@ export interface Relation {
      */
     onDelete?: OnAction;
 
-    overrides?: Partial<EntityCollection>;
+    overrides?: Partial<CollectionConfig>;
 
     validation?: {
         required?: boolean;

package/src/types/slots.tsx

@@ -1,5 +1,5 @@
 import React from "react";
-import type { CollectionActionsProps, EntityTableController, SelectionController, EntityCollection } from "./collections";
+import type { CollectionActionsProps, EntityTableController, SelectionController, CollectionConfig } from "./collections";
 import type { Entity } from "./entities";
 import type { PluginFormActionProps, PluginGenericProps, PluginHomePageActionsProps, PluginHomePageAdditionalCardsProps } from "./plugins";
 import type { Property } from "./properties";
@@ -128,7 +128,7 @@ export interface NavigationSlotProps {
  */
 export interface CollectionToolbarProps {
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
     tableController: EntityTableController;
@@ -141,7 +141,7 @@ export interface CollectionToolbarProps {
  */
 export interface CollectionEmptyStateProps {
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
     canCreate: boolean;
@@ -159,7 +159,7 @@ export interface CollectionHeaderActionProps {
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
     onHover: boolean;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     tableController: EntityTableController;
 }
 
@@ -171,7 +171,7 @@ export interface CollectionAddColumnProps {
     path: string;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
-    collection: EntityCollection;
+    collection: CollectionConfig;
     tableController: EntityTableController;
 }
 
@@ -181,7 +181,7 @@ export interface CollectionAddColumnProps {
  */
 export interface CollectionErrorProps {
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs?: string[];
     parentEntityIds?: string[];
     error: Error;
@@ -192,7 +192,7 @@ export interface CollectionErrorProps {
  * @group Plugins
  */
 export interface KanbanSetupProps {
-    collection: EntityCollection;
+    collection: CollectionConfig;
     fullPath: string;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
@@ -203,7 +203,7 @@ export interface KanbanSetupProps {
  * @group Plugins
  */
 export interface KanbanAddColumnProps {
-    collection: EntityCollection;
+    collection: CollectionConfig;
     fullPath: string;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
@@ -214,14 +214,14 @@ export interface KanbanAddColumnProps {
 
 /**
  * Props for `entity.row.actions` slot.
- * Rendered for each row in an entity collection table.
+ * Rendered for each row in a entity collection table.
  * @group Plugins
  */
 export interface EntityRowActionsProps {
     entity: Entity;
     entityId: string;
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
     selectionController: SelectionController;
@@ -238,7 +238,7 @@ export interface EntityFieldSlotProps {
     property: Property;
     path: string;
     entityId?: string | number;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     context: RebaseContext;
 }
 
@@ -249,7 +249,7 @@ export interface EntityFieldSlotProps {
  */
 export interface CollectionFilterPanelProps {
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
     tableController: EntityTableController;
@@ -290,7 +290,7 @@ export interface ShellToolbarProps {
  */
 export interface CollectionInsightsSlotProps {
     path: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     parentCollectionSlugs: string[];
     parentEntityIds: string[];
 }
@@ -302,6 +302,6 @@ export interface CollectionInsightsSlotProps {
  */
 export interface HomeCardInsightSlotProps {
     slug: string;
-    collection: EntityCollection;
+    collection: CollectionConfig;
     context: RebaseContext;
 }

package/src/types/storage_source.ts

@@ -0,0 +1,90 @@
+/**
+ * Describes a named storage backend — a place files live.
+ *
+ * Declared once and shared front + back: the frontend uses it to decide
+ * transport (HTTP proxy vs direct SDK), the backend uses the same `key`
+ * to resolve a StorageController, and collection properties reference
+ * a definition by its `key` via `StorageConfig.storageSource`.
+ *
+ * This mirrors the {@link DataSourceDefinition} pattern used for databases.
+ *
+ * @group Models
+ */
+
+/**
+ * The default storage source key, used when a property does not specify
+ * a `storageSource`. Shared by the frontend and backend registries so
+ * both agree on "the default storage backend".
+ * @group Models
+ */
+export const DEFAULT_STORAGE_SOURCE_KEY = "(default)";
+
+/**
+ * How the *frontend* reaches a storage backend.
+ *
+ * - `"server"` — through the Rebase backend REST API (`/api/storage`).
+ *   The backend holds the actual `StorageController` and routes by
+ *   storage-source key. This is the default and covers Local, S3, GCS,
+ *   and any other server-mediated engine.
+ * - `"direct"` — straight from the client to the external backend via
+ *   its own SDK (e.g. Firebase Storage via `@firebase/storage`).
+ *   The Rebase backend is **not** in the upload/download path.
+ *
+ * @group Models
+ */
+export type StorageSourceTransport = "server" | "direct";
+
+/**
+ * Declarative definition of a storage source — a named place files live.
+ *
+ * Declared once and shared front and back: the frontend uses it to decide
+ * transport (client HTTP proxy vs direct provider SDK), the backend uses
+ * the same `key` to resolve a `StorageController`, and collection
+ * properties reference a definition by its `key` via
+ * `StorageConfig.storageSource`.
+ *
+ * @group Models
+ */
+export interface StorageSourceDefinition {
+    /**
+     * Unique identifier for this storage source. Collection properties
+     * point at it via `StorageConfig.storageSource`.
+     * Defaults to {@link DEFAULT_STORAGE_SOURCE_KEY}.
+     */
+    key: string;
+
+    /**
+     * The engine backing this storage source (e.g. `"local"`, `"s3"`,
+     * `"gcs"`, `"firebase"`, `"azure"`, or a custom id).
+     */
+    engine: string;
+
+    /**
+     * How the frontend reaches this storage. Defaults to `"server"`.
+     *
+     * When `"direct"`, the client uses a provider-specific SDK
+     * (e.g. `@firebase/storage`) and the backend does not proxy
+     * upload/download traffic for this source.
+     */
+    transport: StorageSourceTransport;
+
+    /** Human-readable label for the UI (e.g. "Firebase Storage", "S3 Media"). */
+    label?: string;
+}
+
+/**
+ * A resolved storage source: the single source of truth that the frontend
+ * router and backend registry both derive from.
+ *
+ * @group Models
+ */
+export interface ResolvedStorageSource {
+    /** Storage source key (routing key, shared front + back). */
+    key: string;
+    /** Engine backing the source. */
+    engine: string;
+    /** Frontend transport. */
+    transport: StorageSourceTransport;
+    /** Human-readable label. */
+    label?: string;
+}

package/src/types/websockets.ts

@@ -1,5 +1,3 @@
-import { Entity } from "./entities";
-
 export interface WebSocketErrorPayload {
     error?: string | { message: string; code?: string };
     message?: string;
@@ -11,35 +9,35 @@ export interface WebSocketMessage {
     payload?: unknown;
     subscriptionId?: string;
     requestId?: string;
-    entities?: Entity<Record<string, unknown>>[];
-    entity?: Entity<Record<string, unknown>> | null;
+    rows?: Record<string, unknown>[];
+    row?: Record<string, unknown> | null;
     error?: string;
 }
 
 export interface CollectionUpdateMessage extends WebSocketMessage {
     type: "collection_update";
     subscriptionId: string;
-    entities: Entity<Record<string, unknown>>[];
+    rows: Record<string, unknown>[];
 }
 
-export interface EntityUpdateMessage extends WebSocketMessage {
-    type: "entity_update";
+export interface SingleUpdateMessage extends WebSocketMessage {
+    type: "single_update";
     subscriptionId: string;
-    entity: Entity<Record<string, unknown>> | null;
+    row: Record<string, unknown> | null;
 }
 
 /**
  * Lightweight patch message sent to collection subscribers when a single
- * entity is created, updated, or deleted. The client can merge this into
+ * row is created, updated, or deleted. The client can merge this into
  * its cached collection data for near-instant cross-tab updates without
  * waiting for a full collection refetch.
  */
-export interface CollectionEntityPatchMessage extends WebSocketMessage {
-    type: "collection_entity_patch";
+export interface CollectionPatchMessage extends WebSocketMessage {
+    type: "collection_patch";
     subscriptionId: string;
-    entityId: string;
-    /** The updated entity, or null if deleted */
-    entity: Entity<Record<string, unknown>> | null;
+    id: string;
+    /** The updated row, or null if deleted */
+    row: Record<string, unknown> | null;
 }
 
 /**