@rebasepro/client-postgresql 0.0.1-canary.bbcb8b4 → 0.0.1-canary.c53f5db

package/dist/client/src/collection.d.ts

@@ -1,4 +1,4 @@
-import { Transport } from "./transport";
+import { Transport, FindParams } from "./transport";
 import { RebaseWebSocketClient } from "./websocket";
 import { CollectionAccessor } from "@rebasepro/types";
 import { FilterOperator, QueryBuilder } from "./query_builder";
@@ -15,5 +15,6 @@ export interface CollectionClient<M extends Record<string, unknown> = Record<str
     offset(count: number): QueryBuilder<M>;
     search(searchString: string): QueryBuilder<M>;
     include(...relations: string[]): QueryBuilder<M>;
+    count(params?: FindParams): Promise<number>;
 }
 export declare function createCollectionClient<M extends Record<string, unknown> = Record<string, unknown>>(transport: Transport, slug: string, ws?: RebaseWebSocketClient): CollectionClient<M>;

package/dist/types/src/controllers/collection_registry.d.ts

@@ -36,7 +36,8 @@ export type CollectionRegistryController<DB = Record<string, unknown>, EC extend
      * Retrieve all the related parent collection ids for a given path
      * @param path
      */
-    getParentCollectionIds: (path: string) => string[];
+    getParentCollectionSlugs: (path: string) => string[];
+    getParentEntityIds: (path: string) => string[];
     /**
      * Resolve paths from a list of ids
      * @param ids

package/dist/types/src/controllers/data_driver.d.ts

@@ -144,12 +144,19 @@ export interface DataDriver {
         path: string;
         databaseId?: string;
         collection: EntityCollection;
-        parentCollectionIds?: string[];
+        parentCollectionSlugs?: string[];
+        parentEntityIds?: string[];
     }) => Promise<boolean>;
     /**
      * Flag to indicate if the driver has requested the initialization of the text search index
      */
     needsInitTextSearch?: boolean;
+    /**
+     * Optional REST-optimised fetch service. When present, the REST API
+     * generator uses these methods instead of the generic `fetchEntity` /
+     * `fetchCollection` pipeline, enabling include-aware eager-loading.
+     */
+    restFetchService?: RestFetchService;
     /**
      * Return the admin capabilities of this driver.
      * @see SQLAdmin
@@ -158,3 +165,31 @@ export interface DataDriver {
      */
     admin?: import("../types/backend").DatabaseAdmin;
 }
+/**
+ * REST-optimised fetch service exposed by drivers that support
+ * eager-loading of relations via `include`.
+ *
+ * The methods return flattened rows (`{ id, ...columns }`) rather
+ * than the `Entity<M>` wrapper used by the generic DataDriver API.
+ *
+ * @group DataDriver
+ */
+export interface RestFetchService {
+    /**
+     * Fetch a collection of flattened entities with optional relation includes.
+     */
+    fetchCollectionForRest(collectionPath: string, options?: {
+        filter?: FilterValues<string>;
+        orderBy?: string;
+        order?: "desc" | "asc";
+        limit?: number;
+        offset?: number;
+        startAfter?: Record<string, unknown>;
+        searchString?: string;
+        databaseId?: string;
+    }, include?: string[]): Promise<Record<string, unknown>[]>;
+    /**
+     * Fetch a single flattened entity with optional relation includes.
+     */
+    fetchEntityForRest(collectionPath: string, entityId: string | number, include?: string[], databaseId?: string): Promise<Record<string, unknown> | null>;
+}

package/dist/types/src/types/backend_hooks.d.ts

@@ -0,0 +1,187 @@
+import type { AdminUser, AdminRole } from "../controllers/client";
+/**
+ * Context passed to every backend hook.
+ * Provides information about the request that triggered the hook.
+ * @group Backend Hooks
+ */
+export interface BackendHookContext {
+    /** The currently authenticated user making the request (if any) */
+    requestUser?: {
+        userId: string;
+        roles: string[];
+    };
+    /** The HTTP method of the request */
+    method: "GET" | "POST" | "PUT" | "DELETE";
+}
+/**
+ * Hooks for intercepting Admin User data at the API boundary.
+ *
+ * These hooks run on the server after the database operation completes
+ * but before the response is sent to the client.
+ *
+ * @group Backend Hooks
+ */
+export interface UserHooks {
+    /**
+     * Transform a user record after it's read from the database,
+     * before it's returned to the client.
+     *
+     * Return the modified user, or `null` to filter it out entirely
+     * (the user won't appear in listings or individual fetches).
+     */
+    afterRead?(user: AdminUser, context: BackendHookContext): AdminUser | null | Promise<AdminUser | null>;
+    /**
+     * Transform user data before it's written to the database.
+     * Runs on POST (create) and PUT (update).
+     *
+     * Return the (possibly modified) data to proceed with the save.
+     * Throw an error to abort the operation.
+     */
+    beforeSave?(data: {
+        email?: string;
+        displayName?: string;
+        roles?: string[];
+    }, context: BackendHookContext): {
+        email?: string;
+        displayName?: string;
+        roles?: string[];
+    } | Promise<{
+        email?: string;
+        displayName?: string;
+        roles?: string[];
+    }>;
+    /**
+     * Called after a user is successfully created or updated.
+     * Useful for side-effects like sending notifications.
+     */
+    afterSave?(user: AdminUser, context: BackendHookContext): void | Promise<void>;
+    /**
+     * Called before a user is deleted. Throw to prevent deletion.
+     */
+    beforeDelete?(userId: string, context: BackendHookContext): void | Promise<void>;
+    /**
+     * Called after a user is successfully deleted.
+     */
+    afterDelete?(userId: string, context: BackendHookContext): void | Promise<void>;
+}
+/**
+ * Hooks for intercepting Admin Role data at the API boundary.
+ * @group Backend Hooks
+ */
+export interface RoleHooks {
+    /**
+     * Transform a role record after it's read from the database,
+     * before it's returned to the client.
+     *
+     * Return the modified role, or `null` to filter it out entirely.
+     */
+    afterRead?(role: AdminRole, context: BackendHookContext): AdminRole | null | Promise<AdminRole | null>;
+}
+/**
+ * Hooks for intercepting collection entity data at the REST API boundary.
+ *
+ * These run **after** per-collection `EntityCallbacks` (which execute inside
+ * the DataDriver) and provide a single cross-cutting interception point for
+ * ALL collections flowing through the REST API.
+ *
+ * Every callback receives the collection `slug` so you can target specific
+ * collections or apply logic globally.
+ *
+ * @group Backend Hooks
+ */
+export interface DataHooks {
+    /**
+     * Transform an entity after it's read from the database,
+     * before it's returned to the client.
+     *
+     * Runs for both list (GET /:slug) and single (GET /:slug/:id) fetches.
+     * Return the modified entity, or `null` to filter it out.
+     *
+     * @param slug - The collection slug (e.g. "orders", "products")
+     * @param entity - The flattened entity object (id + values merged)
+     * @param context - Request context (authenticated user, HTTP method)
+     */
+    afterRead?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): Record<string, unknown> | null | Promise<Record<string, unknown> | null>;
+    /**
+     * Transform entity values before they are written to the database.
+     * Runs on POST (create) and PUT (update).
+     *
+     * Return the (possibly modified) values. Throw to abort the save.
+     *
+     * @param slug - The collection slug
+     * @param values - The raw request body values
+     * @param entityId - The entity ID (only present on updates)
+     * @param context - Request context
+     */
+    beforeSave?(slug: string, values: Record<string, unknown>, entityId: string | undefined, context: BackendHookContext): Record<string, unknown> | Promise<Record<string, unknown>>;
+    /**
+     * Called after an entity is successfully saved (created or updated).
+     * Useful for side-effects like syncing to external systems.
+     *
+     * @param slug - The collection slug
+     * @param entity - The saved entity (flattened)
+     * @param context - Request context
+     */
+    afterSave?(slug: string, entity: Record<string, unknown>, context: BackendHookContext): void | Promise<void>;
+    /**
+     * Called before an entity is deleted. Throw to prevent deletion.
+     *
+     * @param slug - The collection slug
+     * @param entityId - The entity ID being deleted
+     * @param context - Request context
+     */
+    beforeDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
+    /**
+     * Called after an entity is successfully deleted.
+     *
+     * @param slug - The collection slug
+     * @param entityId - The deleted entity ID
+     * @param context - Request context
+     */
+    afterDelete?(slug: string, entityId: string, context: BackendHookContext): void | Promise<void>;
+}
+/**
+ * Backend-level hooks for intercepting data at the API boundary.
+ *
+ * These hooks run server-side after database operations complete and before
+ * API responses are sent.
+ *
+ * - `users` / `roles` — intercept admin user and role management endpoints
+ * - `data` — intercept ALL collection entity data flowing through the REST API
+ *
+ * `data` hooks complement per-collection `EntityCallbacks`. Entity callbacks
+ * run inside the DataDriver (close to the DB); data hooks run at the HTTP
+ * boundary (close to the client). Use data hooks for cross-cutting concerns
+ * like audit logging, response enrichment, or field masking.
+ *
+ * @example
+ * ```typescript
+ * const hooks: BackendHooks = {
+ *     data: {
+ *         afterRead(slug, entity, ctx) {
+ *             // Mask PII for non-admin users across all collections
+ *             if (!ctx.requestUser?.roles.includes("admin") && entity.email) {
+ *                 return { ...entity, email: "***" };
+ *             }
+ *             return entity;
+ *         }
+ *     },
+ *     users: {
+ *         afterRead(user, ctx) {
+ *             if (user.email.endsWith("@system.internal")) return null;
+ *             return user;
+ *         }
+ *     }
+ * };
+ * ```
+ *
+ * @group Backend Hooks
+ */
+export interface BackendHooks {
+    /** Hooks for intercepting user management data */
+    users?: UserHooks;
+    /** Hooks for intercepting role management data */
+    roles?: RoleHooks;
+    /** Hooks for intercepting ALL collection entity data via the REST API */
+    data?: DataHooks;
+}

package/dist/types/src/types/collections.d.ts

@@ -19,9 +19,8 @@ import type { EntityAction } from "./entity_actions";
  */
 export interface BaseEntityCollection<M extends Record<string, unknown> = Record<string, unknown>, USER extends User = User> {
     /**
-     * You can set an alias that will be used internally instead of the `path`.
-     * The `alias` value will be used to determine the URL of the collection,
-     * while `path` will still be used in the driver.
+     * You can set an alias that will be used internally instead of the collection name.
+     * The `slug` value will be used to determine the URL of the collection.
      * Note that you can use this value in reference properties too.
      */
     slug: string;
@@ -158,17 +157,17 @@ export interface BaseEntityCollection<M extends Record<string, unknown> = Record
     /**
      * Force a filter in this view. If applied, the rest of the filters will
      * be disabled. Filters applied with this prop cannot be changed.
-     * e.g. `forceFilter: { age: [">", 18] }`
-     * e.g. `forceFilter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
+     * e.g. `fixedFilter: { age: [">", 18] }`
+     * e.g. `fixedFilter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
      */
-    readonly forceFilter?: FilterValues<Extract<keyof M, string> | (string & {})>;
+    readonly fixedFilter?: FilterValues<Extract<keyof M, string> | (string & {})>;
     /**
      * Initial filters applied to the collection this collection is related to.
      * Defaults to none. Filters applied with this prop can be changed.
-     * e.g. `filter: { age: [">", 18] }`
-     * e.g. `filter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
+     * e.g. `defaultFilter: { age: [">", 18] }`
+     * e.g. `defaultFilter: { related_user: ["==", new EntityReference("sdc43dsw2", "users")] }`
      */
-    readonly filter?: FilterValues<Extract<keyof M, string> | (string & {})>;
+    readonly defaultFilter?: FilterValues<Extract<keyof M, string> | (string & {})>;
     /**
      * Default sort applied to this collection.
      * When setting this prop, entities will have a default order
@@ -457,7 +456,8 @@ export interface CollectionActionsProps<M extends Record<string, unknown> = Reco
     /**
      * Array of the parent path segments like `['users']`
      */
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     /**
      * The collection configuration
      */

package/dist/types/src/types/entity_views.d.ts

@@ -1,10 +1,9 @@
 import React from "react";
 import type { Entity, EntityValues } from "./entities";
 import type { EntityCollection } from "./collections";
+import type { FormexController } from "./formex";
 /**
  * Context passed to custom fields and entity views.
- * This is the base definition — `@rebasepro/admin` re-exports a
- * fully-typed version that narrows the `formex` field.
  * @group Form custom fields
  */
 export interface FormContext<M extends Record<string, unknown> = Record<string, unknown>> {
@@ -38,10 +37,8 @@ export interface FormContext<M extends Record<string, unknown> = Record<string,
     openEntityMode: "side_panel" | "full_screen" | "split";
     /**
      * The underlying formex controller that powers the form.
-     * Prefer importing `FormContext` from `@rebasepro/admin` for the
-     * fully-typed `FormexController<M>` version.
      */
-    formex: Record<string, unknown>;
+    formex: FormexController<M>;
     disabled: boolean;
 }
 export type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
@@ -57,5 +54,6 @@ export interface EntityCustomViewParams<M extends Record<string, unknown> = Reco
     entity?: Entity<M>;
     modifiedValues?: EntityValues<M>;
     formContext: FormContext<M>;
-    parentCollectionIds?: string[];
+    parentCollectionSlugs?: string[];
+    parentEntityIds?: string[];
 }

package/dist/types/src/types/formex.d.ts

@@ -0,0 +1,40 @@
+import React, { FormEvent } from "react";
+export type FormexController<T = any> = {
+    values: T;
+    initialValues: T;
+    setValues: (values: T) => void;
+    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
+    touched: Record<string, boolean>;
+    setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
+    setTouched: (touched: Record<string, boolean>) => void;
+    dirty: boolean;
+    setDirty: (dirty: boolean) => void;
+    setSubmitCount: (submitCount: number) => void;
+    errors: Record<string, string>;
+    setFieldError: (key: string, error?: string) => void;
+    handleChange: (event: React.SyntheticEvent) => void;
+    handleBlur: (event: React.FocusEvent) => void;
+    handleSubmit: (event?: FormEvent<HTMLFormElement>) => void;
+    validate: () => void;
+    resetForm: (props?: FormexResetProps<T>) => void;
+    submitCount: number;
+    isSubmitting: boolean;
+    setSubmitting: (isSubmitting: boolean) => void;
+    isValidating: boolean;
+    /**
+     * The version of the form. This is incremented every time the form is reset
+     * or the form is submitted.
+     */
+    version: number;
+    debugId?: string;
+    undo: () => void;
+    redo: () => void;
+    canUndo: boolean;
+    canRedo: boolean;
+};
+export type FormexResetProps<T = any> = {
+    values?: T;
+    submitCount?: number;
+    errors?: Record<string, string>;
+    touched?: Record<string, boolean>;
+};

package/dist/types/src/types/index.d.ts

@@ -10,6 +10,7 @@ export * from "./entity_callbacks";
 export * from "./entity_overrides";
 export * from "./export_import";
 export * from "./modify_collections";
+export * from "./formex";
 export * from "./websockets";
 export * from "./backend";
 export * from "./translations";
@@ -21,3 +22,4 @@ export * from "./property_config";
 export * from "./entity_views";
 export * from "./data_source";
 export * from "./cron";
+export * from "./backend_hooks";

package/dist/types/src/types/plugins.d.ts

@@ -157,7 +157,8 @@ export interface PluginHooks {
      */
     onColumnsReorder?: (props: {
         fullPath: string;
-        parentCollectionIds: string[];
+        parentCollectionSlugs: string[];
+        parentEntityIds: string[];
         collection: EntityCollection;
         newPropertiesOrder: string[];
     }) => void;
@@ -166,7 +167,8 @@ export interface PluginHooks {
      */
     onKanbanColumnsReorder?: (props: {
         fullPath: string;
-        parentCollectionIds: string[];
+        parentCollectionSlugs: string[];
+        parentEntityIds: string[];
         collection: EntityCollection;
         kanbanColumnProperty: string;
         newColumnsOrder: string[];
@@ -241,7 +243,8 @@ export interface PluginHomePageActionsProps<EP extends object = object, M extend
 export interface PluginFormActionProps<USER extends User = User, EC extends EntityCollection = EntityCollection> {
     entityId?: string | number;
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     status: EntityStatus;
     collection: EC;
     disabled: boolean;

package/dist/types/src/types/properties.d.ts

@@ -384,9 +384,9 @@ export interface ReferenceProperty extends BaseProperty {
     path?: string;
     /**
      * Allow selection of entities that pass the given filter only.
-     * e.g. `forceFilter: { age: [">=", 18] }`
+     * e.g. `fixedFilter: { age: [">=", 18] }`
      */
-    forceFilter?: FilterValues<string>;
+    fixedFilter?: FilterValues<string>;
     /**
      * Properties that need to be rendered when displaying a preview of this
      * reference. If not specified the first 3 are used. Only the first 3
@@ -492,9 +492,9 @@ export interface RelationProperty extends BaseProperty {
     relation?: Relation;
     /**
      * Allow selection of entities that pass the given filter only.
-     * e.g. `forceFilter: { age: [">=", 18] }`
+     * e.g. `fixedFilter: { age: [">=", 18] }`
      */
-    forceFilter?: FilterValues<string>;
+    fixedFilter?: FilterValues<string>;
     /**
      * Properties that need to be rendered when displaying a preview of this
      * reference. If not specified the first 3 are used. Only the first 3

package/dist/types/src/types/slots.d.ts

@@ -100,7 +100,8 @@ export interface NavigationSlotProps {
 export interface CollectionToolbarProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     tableController: EntityTableController;
     selectionController: SelectionController;
 }
@@ -111,7 +112,8 @@ export interface CollectionToolbarProps {
 export interface CollectionEmptyStateProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     canCreate: boolean;
     onNewClick?: () => void;
 }
@@ -123,7 +125,8 @@ export interface CollectionHeaderActionProps {
     property: Property;
     propertyKey: string;
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     onHover: boolean;
     collection: EntityCollection;
     tableController: EntityTableController;
@@ -134,7 +137,8 @@ export interface CollectionHeaderActionProps {
  */
 export interface CollectionAddColumnProps {
     path: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     collection: EntityCollection;
     tableController: EntityTableController;
 }
@@ -145,7 +149,8 @@ export interface CollectionAddColumnProps {
 export interface CollectionErrorProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds?: string[];
+    parentCollectionSlugs?: string[];
+    parentEntityIds?: string[];
     error: Error;
 }
 /**
@@ -155,7 +160,8 @@ export interface CollectionErrorProps {
 export interface KanbanSetupProps {
     collection: EntityCollection;
     fullPath: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
 }
 /**
  * Props for the `kanban.add-column` slot.
@@ -164,7 +170,8 @@ export interface KanbanSetupProps {
 export interface KanbanAddColumnProps {
     collection: EntityCollection;
     fullPath: string;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     columnProperty: string;
 }
 /**
@@ -177,7 +184,8 @@ export interface EntityRowActionsProps {
     entityId: string;
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     selectionController: SelectionController;
     context: RebaseContext;
 }
@@ -202,7 +210,8 @@ export interface EntityFieldSlotProps {
 export interface CollectionFilterPanelProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
     tableController: EntityTableController;
     context: RebaseContext;
 }
@@ -238,7 +247,8 @@ export interface ShellToolbarProps {
 export interface CollectionInsightsSlotProps {
     path: string;
     collection: EntityCollection;
-    parentCollectionIds: string[];
+    parentCollectionSlugs: string[];
+    parentEntityIds: string[];
 }
 /**
  * Props for `home.card.insight` slot.

package/dist/types/src/types/translations.d.ts

@@ -461,6 +461,10 @@ export interface RebaseTranslations {
     reset_password_success?: string;
     reset_password_confirmation?: string;
     error_resetting_password?: string;
+    /** Permission-denied empty states */
+    no_permission_to_view_users?: string;
+    no_permission_to_view_roles?: string;
+    no_permission_description?: string;
     /** Editor table-bubble */
     add_row_before: string;
     add_row_after: string;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/client-postgresql",
   "type": "module",
-  "version": "0.0.1-canary.bbcb8b4",
+  "version": "0.0.1-canary.c53f5db",
   "description": "PostgreSQL data source client for Rebase",
   "funding": {
     "url": "https://github.com/sponsors/rebaseco"
@@ -57,8 +57,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@rebasepro/client": "0.0.1-canary.bbcb8b4",
-    "@rebasepro/types": "0.0.1-canary.bbcb8b4"
+    "@rebasepro/client": "0.0.1-canary.c53f5db",
+    "@rebasepro/types": "0.0.1-canary.c53f5db"
   },
   "peerDependencies": {
     "react": ">=19.0.0",