@rebasepro/types 0.8.0 → 0.9.0

package/src/types/policy.ts

@@ -27,6 +27,7 @@ export type PolicyExpression =
     | RolesOverlapPolicyExpression
     | RolesContainPolicyExpression
     | AuthenticatedPolicyExpression
+    | ExistsInPolicyExpression
     | RawPolicyExpression;
 
 /** Always allows. Compiles to `true`. @group Models */
@@ -42,13 +43,13 @@ export interface FalsePolicyExpression {
 /** Logical AND — every operand must pass. @group Models */
 export interface AndPolicyExpression {
     kind: "and";
-    operands: PolicyExpression[];
+    operands: readonly PolicyExpression[];
 }
 
 /** Logical OR — at least one operand must pass. @group Models */
 export interface OrPolicyExpression {
     kind: "or";
-    operands: PolicyExpression[];
+    operands: readonly PolicyExpression[];
 }
 
 /** Logical negation. @group Models */
@@ -78,7 +79,7 @@ export interface ComparePolicyExpression {
  */
 export interface RolesOverlapPolicyExpression {
     kind: "rolesOverlap";
-    roles: string[];
+    roles: readonly string[];
 }
 
 /**
@@ -88,7 +89,7 @@ export interface RolesOverlapPolicyExpression {
  */
 export interface RolesContainPolicyExpression {
     kind: "rolesContain";
-    roles: string[];
+    roles: readonly string[];
 }
 
 /**
@@ -99,6 +100,45 @@ export interface AuthenticatedPolicyExpression {
     kind: "authenticated";
 }
 
+/**
+ * Membership / relational access: true when at least one row exists in another
+ * collection (a join/membership table) matching `where`. This is what lets you
+ * scope reads to "rows whose team the caller belongs to" without an N+1
+ * per-row lookup — it compiles to a single correlated `EXISTS` subquery.
+ *
+ * Inside `where`, {@link FieldPolicyOperand} (`policy.field`) references a column
+ * of the joined collection, while {@link OuterFieldPolicyOperand}
+ * (`policy.outerField`) references a column of the row being checked (the outer
+ * table under RLS). Combine with {@link AuthUidPolicyOperand} to correlate to
+ * the caller.
+ *
+ * @example
+ * ```ts
+ * // documents visible only to members of the document's team:
+ * policy.existsIn({
+ *   collection: "team_members",
+ *   where: policy.and(
+ *     policy.compare(policy.field("team_id"), "eq", policy.outerField("team_id")),
+ *     policy.compare(policy.field("user_id"), "eq", policy.authUid()),
+ *   ),
+ * })
+ * // → EXISTS (SELECT 1 FROM team_members _ex0
+ * //           WHERE _ex0.team_id = documents.team_id AND _ex0.user_id = auth.uid())
+ * ```
+ *
+ * Postgres-authoritative: like {@link RawPolicyExpression}, the JavaScript
+ * evaluator treats it as *unknown* (it cannot run a subquery client-side), so
+ * enforcement is always the database's.
+ * @group Models
+ */
+export interface ExistsInPolicyExpression {
+    kind: "existsIn";
+    /** Slug of the collection to search (the join / membership table). */
+    collection: string;
+    /** Condition evaluated against the joined collection's rows. */
+    where: PolicyExpression;
+}
+
 /**
  * A raw PostgreSQL boolean expression — the full-power escape hatch.
  *
@@ -118,6 +158,7 @@ export interface RawPolicyExpression {
  */
 export type PolicyOperand =
     | FieldPolicyOperand
+    | OuterFieldPolicyOperand
     | LiteralPolicyOperand
     | AuthUidPolicyOperand
     | AuthRolesPolicyOperand;
@@ -129,6 +170,18 @@ export interface FieldPolicyOperand {
     name: string;
 }
 
+/**
+ * A column value on the *outer* row when used inside {@link ExistsInPolicyExpression}
+ * — i.e. the row the RLS policy is being evaluated for, referenced from within the
+ * subquery. Outside an `existsIn` it is equivalent to {@link FieldPolicyOperand}.
+ * @group Models
+ */
+export interface OuterFieldPolicyOperand {
+    kind: "outerField";
+    /** The property/column name on the outer collection. */
+    name: string;
+}
+
 /** A constant value. @group Models */
 export interface LiteralPolicyOperand {
     kind: "literal";
@@ -157,16 +210,19 @@ export interface AuthRolesPolicyOperand {
 export const policy = {
     true: (): TruePolicyExpression => ({ kind: "true" }),
     false: (): FalsePolicyExpression => ({ kind: "false" }),
-    and: (...operands: PolicyExpression[]): AndPolicyExpression => ({ kind: "and", operands }),
-    or: (...operands: PolicyExpression[]): OrPolicyExpression => ({ kind: "or", operands }),
+    and: (...operands: readonly PolicyExpression[]): AndPolicyExpression => ({ kind: "and", operands: operands as PolicyExpression[] }),
+    or: (...operands: readonly PolicyExpression[]): OrPolicyExpression => ({ kind: "or", operands: operands as PolicyExpression[] }),
     not: (operand: PolicyExpression): NotPolicyExpression => ({ kind: "not", operand }),
     compare: (left: PolicyOperand, op: PolicyCompareOperator, right: PolicyOperand): ComparePolicyExpression =>
         ({ kind: "compare", op, left, right }),
-    rolesOverlap: (roles: string[]): RolesOverlapPolicyExpression => ({ kind: "rolesOverlap", roles }),
-    rolesContain: (roles: string[]): RolesContainPolicyExpression => ({ kind: "rolesContain", roles }),
+    rolesOverlap: (roles: readonly string[]): RolesOverlapPolicyExpression => ({ kind: "rolesOverlap", roles: roles as string[] }),
+    rolesContain: (roles: readonly string[]): RolesContainPolicyExpression => ({ kind: "rolesContain", roles: roles as string[] }),
     authenticated: (): AuthenticatedPolicyExpression => ({ kind: "authenticated" }),
+    existsIn: (args: { collection: string; where: PolicyExpression }): ExistsInPolicyExpression =>
+        ({ kind: "existsIn", collection: args.collection, where: args.where }),
     raw: (sql: string): RawPolicyExpression => ({ kind: "raw", sql }),
     field: (name: string): FieldPolicyOperand => ({ kind: "field", name }),
+    outerField: (name: string): OuterFieldPolicyOperand => ({ kind: "outerField", name }),
     literal: (value: string | number | boolean | null): LiteralPolicyOperand => ({ kind: "literal", value }),
     authUid: (): AuthUidPolicyOperand => ({ kind: "authUid" }),
     authRoles: (): AuthRolesPolicyOperand => ({ kind: "authRoles" })

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>;
@@ -164,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> {
@@ -492,7 +519,7 @@ export interface ReferenceUIConfig extends BaseUIConfig {
 }
 
 /**
- * A pointer to an entity, stored **as a value** on the row (id + path, and
+ * 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
@@ -511,7 +538,7 @@ export interface ReferenceProperty extends BaseProperty {
     ui?: ReferenceUIConfig;
     type: "reference";
     /**
-     * Default value for new entities. Must be an EntityReference.
+     * Default value for new entities. Must be a EntityReference.
      */
     defaultValue?: EntityReference;
     /**
@@ -575,7 +602,7 @@ export interface RelationProperty extends BaseProperty {
     ui?: RelationUIConfig;
     type: "relation";
     /**
-     * Default value for new entities. Must be an EntityRelation or array of EntityRelation.
+     * Default value for new entities. Must be a EntityRelation or array of EntityRelation.
      */
     defaultValue?: EntityRelation | EntityRelation[];
     /**
@@ -596,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.
@@ -664,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 ───
 
@@ -1006,6 +1033,14 @@ export type StorageConfig = {
      */
     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/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/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;
 }
 
 /**

package/src/users/user.ts

@@ -1,11 +1,18 @@
 
 /**
- * This interface represents a user.
- * It has some of the same fields as a Firebase User.
- * Note that in the default implementation, we simply take the Firebase user
- * and use it as a Rebase user, so that means that even if they are not mapped
- * in this interface, it contains all the methods of the former, such as `delete`,
- * `getIdToken`, etc.
+ * The canonical representation of an authenticated user in the Rebase ecosystem.
+ *
+ * Used by {@link AuthController}, collections, callbacks, and both the
+ * `@rebasepro/client` and `@rebasepro/auth` packages. All other user types
+ * (`RebaseUser`, `UserInfo`) are deprecated aliases of this type.
+ *
+ * **Backend-managed fields** (`uid`, `email`, `roles`, `metadata`, `createdAt`)
+ * are populated by the server. **Client-visible fields** (`displayName`,
+ * `photoURL`, `providerId`, `isAnonymous`, `emailVerified`) may be set during
+ * authentication or profile updates.
+ *
+ * @see AdminUser — the admin-API DTO, which adds audit fields (`createdAt`,
+ * `updatedAt`) and required `roles`.
  *
  * @group Models
  */
@@ -27,16 +34,22 @@ export type User = {
      */
     readonly photoURL: string | null;
     /**
-     * The provider used to authenticate the user.
+     * The provider used to authenticate the user (e.g. `"password"`,
+     * `"google"`, `"github"`).
      */
     readonly providerId: string;
     /**
-     *
+     * Whether the user is anonymous (created via anonymous sign-in).
      */
     readonly isAnonymous: boolean;
 
     /**
-     * Role IDs assigned to this user (e.g. ["admin", "editor"]).
+     * Whether the user's email address has been verified.
+     */
+    readonly emailVerified?: boolean;
+
+    /**
+     * Role IDs assigned to this user (e.g. `["admin", "editor"]`).
      */
     roles?: string[];