@rebasepro/types 0.5.0 → 0.6.0

package/dist/controllers/client.d.ts

@@ -1,6 +1,8 @@
 import type { User } from "../users";
 import type { RebaseData } from "./data";
 import type { EmailService } from "./email";
+import type { StorageSource } from "./storage";
+import type { CronJobStatus, CronJobLogEntry } from "../types/cron";
 /**
  * Event type for authentication state changes
  */
@@ -14,7 +16,6 @@ export interface RebaseSession {
     expiresAt: number;
     user: User;
 }
-import type { StorageSource } from "./storage";
 /**
  * Unified Authentication Client Interface
  * Pure functional SDK interface, decoupled from UI and React hooks
@@ -111,8 +112,65 @@ export interface AdminAPI {
     }>;
 }
 /**
- * Overarching abstraction that unites Data, Auth, Storage, and Email.
- * Adapters for Supabase or Firebase simply need to implement this interface.
+ * Client-side Cron job management interface.
+ * @group Cron
+ */
+export interface CronAPI {
+    listJobs(): Promise<{
+        jobs: CronJobStatus[];
+    }>;
+    getJob(jobId: string): Promise<{
+        job: CronJobStatus;
+    }>;
+    triggerJob(jobId: string): Promise<{
+        log: CronJobLogEntry;
+        job: CronJobStatus;
+    }>;
+    getJobLogs(jobId: string, options?: {
+        limit?: number;
+    }): Promise<{
+        logs: CronJobLogEntry[];
+    }>;
+    toggleJob(jobId: string, enabled: boolean): Promise<{
+        job: CronJobStatus;
+    }>;
+}
+/**
+ * Options for invoking a custom backend function.
+ * @group Functions
+ */
+export interface FunctionInvokeOptions {
+    /** HTTP method — defaults to `"POST"`. */
+    method?: "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
+    /** Sub-path appended after the function name. */
+    path?: string;
+    /** Extra headers merged into the request. */
+    headers?: Record<string, string>;
+}
+/**
+ * Client interface for invoking custom backend functions.
+ * @group Functions
+ */
+export interface FunctionsAPI {
+    /**
+     * Invoke a custom backend function by name.
+     *
+     * @typeParam T - Expected shape of the response payload.
+     * @param name    - Function name (filename without extension, e.g. `"extract-job"`).
+     * @param payload - Optional JSON-serialisable body sent as POST.
+     * @param options - Optional overrides (method, sub-path, headers).
+     */
+    invoke<T = unknown>(name: string, payload?: unknown, options?: FunctionInvokeOptions): Promise<T>;
+}
+/**
+ * The single, canonical Rebase client interface.
+ *
+ * Used everywhere: the server-side `rebase` singleton, the SDK's
+ * `createRebaseClient()`, React context, cron job context, etc.
+ *
+ * Core fields (`data`, `auth`) are always present. Everything else
+ * is optional — which capabilities are populated depends on the
+ * runtime environment and adapter.
  */
 export interface RebaseClient<DB = unknown> {
     /** Unified Data access layer */
@@ -123,43 +181,32 @@ export interface RebaseClient<DB = unknown> {
     storage?: StorageSource;
     /**
      * Server-side email service.
-     *
-     * Available when SMTP (or a custom `sendEmail` function) is configured
-     * in the backend auth config. `undefined` when email is not configured.
-     *
-     * > **Note:** This is only available on the server-side `rebase` singleton.
-     * > The client-side SDK does not include an email service.
+     * Available when SMTP or a custom `sendEmail` function is configured.
      */
     email?: EmailService;
     /** Admin API for user management */
     admin?: AdminAPI;
-    /**
-     * The base HTTP URL of the backend server.
-     * Exposed by the SDK client (`@rebasepro/client`) and used to auto-derive
-     * the `ApiConfigProvider` URL.
-     */
+    /** Cron job management API */
+    cron?: CronAPI;
+    /** Custom backend functions API */
+    functions?: FunctionsAPI;
+    /** Base HTTP URL of the backend server */
     baseUrl?: string;
-    /**
-     * WebSocket client for realtime subscriptions and admin capabilities.
-     * Exposed by the SDK client (`@rebasepro/client`). The shape is intentionally
-     * left as `unknown` in the base interface — callers should narrow via feature
-     * detection (e.g. `typeof ws.executeSql === "function"`).
-     */
+    /** WebSocket client for realtime subscriptions */
     ws?: unknown;
+    /** Set the auth token for subsequent requests */
+    setToken?(token: string | null): void;
+    /** Set a function that lazily resolves the auth token */
+    setAuthTokenGetter?(getter: () => Promise<string | null>): void;
+    /** Set handler called when a request returns 401 */
+    setOnUnauthorized?(handler: () => Promise<boolean>): void;
+    /** Resolve the current auth token */
+    resolveToken?(): Promise<string | null>;
+    /** Make a raw HTTP call to the backend */
+    call?<T = unknown>(endpoint: string, payload?: unknown): Promise<T>;
     /**
      * Execute raw SQL against the database.
-     *
-     * Only available server-side when the backend uses a SQL database
-     * (PostgreSQL, MySQL, etc.). `undefined` for document databases
-     * (MongoDB, Firestore) and on the client-side SDK.
-     *
-     * @example
-     * ```typescript
-     * // In a cron job or custom function:
-     * if (ctx.client.sql) {
-     *     const rows = await ctx.client.sql("SELECT count(*) FROM orders");
-     * }
-     * ```
+     * Only available server-side with a SQL database.
      */
     sql?(query: string, options?: {
         database?: string;

package/dist/controllers/customization_controller.d.ts

@@ -1,4 +1,3 @@
-import React from "react";
 import type { EntityLinkBuilder } from "../types/entity_link_builder";
 import type { Locale } from "../types/locales";
 import type { EntityAction } from "../types/entity_actions";
@@ -6,6 +5,7 @@ import type { EntityCustomView } from "../types/entity_views";
 import type { RebasePlugin } from "../types/plugins";
 import type { PropertyConfig } from "../types/property_config";
 import type { SlotContribution } from "../types/slots";
+import type { ComponentOverrideMap } from "../types/component_overrides";
 export type CustomizationController = {
     /**
      * Builder for generating utility links for entities
@@ -49,12 +49,13 @@ export type CustomizationController = {
      * the `propertyConfig` prop of a property in a collection.
      */
     propertyConfigs: Record<string, PropertyConfig>;
-    components?: {
-        /**
-         * Component to render when a reference is missing
-         */
-        missingReference?: React.ComponentType<{
-            path: string;
-        }>;
-    };
+    /**
+     * Global component overrides. Keys are component names from
+     * {@link OverridableComponentName}. Values replace the default
+     * implementation everywhere in the app.
+     *
+     * Collection-scoped overrides (set on individual collections)
+     * take precedence over global overrides.
+     */
+    components?: ComponentOverrideMap;
 };

package/dist/index.es.js

@@ -1,222 +1,274 @@
-class EntityReference {
-  __type = "reference";
-  /**
-   * ID of the entity
-   */
-  id;
-  /**
-   * A string representing the path of the referenced document (relative
-   * to the root of the database).
-   */
-  path;
-  /**
-   * Which driver (e.g., 'postgres', 'firestore').
-   * Defaults to "(default)" if not specified.
-   */
-  driver;
-  /**
-   * Which database within the driver.
-   * Defaults to "(default)" if not specified.
-   */
-  databaseId;
-  /**
-   * Create a reference to an entity.
-   *
-   * @example
-   * // Simple reference (most common case)
-   * new EntityReference({ id: "123", path: "users" })
-   *
-   * // With driver
-   * new EntityReference({ id: "123", path: "analytics", driver: "firestore" })
-   */
-  constructor(props) {
-    this.id = props.id;
-    this.path = props.path;
-    this.driver = props.driver;
-    this.databaseId = props.databaseId;
-  }
-  get pathWithId() {
-    return `${this.path}/${this.id}`;
-  }
-  /**
-   * Get the full path including driver and database prefixes if specified.
-   * For the common case (single driver, single db), this just returns pathWithId.
-   */
-  get fullPath() {
-    const parts = [];
-    if (this.driver && this.driver !== "(default)") {
-      parts.push(this.driver);
-    }
-    if (this.databaseId && this.databaseId !== "(default)") {
-      parts.push(this.databaseId);
-    }
-    if (parts.length > 0) {
-      return `${parts.join(":")}:::${this.path}/${this.id}`;
-    }
-    return this.pathWithId;
-  }
-  isEntityReference() {
-    return true;
-  }
-}
-class EntityRelation {
-  __type = "relation";
-  /**
-   * ID of the entity
-   */
-  id;
-  /**
-   * A string representing the path of the referenced document (relative
-   * to the root of the database).
-   */
-  path;
-  /**
-   * Pre-fetched data payload to eliminate N+1 queries.
-   * When present, clients can use this directly instead of fetching.
-   */
-  data;
-  constructor(id, path, data) {
-    this.id = id;
-    this.path = path;
-    this.data = data;
-  }
-  get pathWithId() {
-    return `${this.path}/${this.id}`;
-  }
-  isEntityReference() {
-    return false;
-  }
-  isEntityRelation() {
-    return true;
-  }
-}
-class GeoPoint {
-  /**
-   * The latitude of this GeoPoint instance.
-   */
-  latitude;
-  /**
-   * The longitude of this GeoPoint instance.
-   */
-  longitude;
-  constructor(latitude, longitude) {
-    this.latitude = latitude;
-    this.longitude = longitude;
-  }
-}
-class Vector {
-  value;
-  constructor(value) {
-    this.value = value;
-  }
-}
+//#region src/types/entities.ts
+/**
+* Class used to create a reference to an entity in a different path.
+*
+* @example
+* // Simple reference (most common case - single driver, single db)
+* new EntityReference({ id: "123", path: "users" })
+*
+* // Reference to a different driver (e.g., Firestore)
+* new EntityReference({ id: "123", path: "analytics", driver: "firestore" })
+*
+* // Reference to a specific database within a driver
+* new EntityReference({ id: "123", path: "orders", driver: "postgres", databaseId: "orders_db" })
+*/
+var EntityReference = class {
+	__type = "reference";
+	/**
+	* ID of the entity
+	*/
+	id;
+	/**
+	* A string representing the path of the referenced document (relative
+	* to the root of the database).
+	*/
+	path;
+	/**
+	* Which driver (e.g., 'postgres', 'firestore').
+	* Defaults to "(default)" if not specified.
+	*/
+	driver;
+	/**
+	* Which database within the driver.
+	* Defaults to "(default)" if not specified.
+	*/
+	databaseId;
+	/**
+	* Create a reference to an entity.
+	*
+	* @example
+	* // Simple reference (most common case)
+	* new EntityReference({ id: "123", path: "users" })
+	*
+	* // With driver
+	* new EntityReference({ id: "123", path: "analytics", driver: "firestore" })
+	*/
+	constructor(props) {
+		this.id = props.id;
+		this.path = props.path;
+		this.driver = props.driver;
+		this.databaseId = props.databaseId;
+	}
+	get pathWithId() {
+		return `${this.path}/${this.id}`;
+	}
+	/**
+	* Get the full path including driver and database prefixes if specified.
+	* For the common case (single driver, single db), this just returns pathWithId.
+	*/
+	get fullPath() {
+		const parts = [];
+		if (this.driver && this.driver !== "(default)") parts.push(this.driver);
+		if (this.databaseId && this.databaseId !== "(default)") parts.push(this.databaseId);
+		if (parts.length > 0) return `${parts.join(":")}:::${this.path}/${this.id}`;
+		return this.pathWithId;
+	}
+	isEntityReference() {
+		return true;
+	}
+};
+/**
+* Class used to create a reference to an entity in a different path
+*/
+var EntityRelation = class {
+	__type = "relation";
+	/**
+	* ID of the entity
+	*/
+	id;
+	/**
+	* A string representing the path of the referenced document (relative
+	* to the root of the database).
+	*/
+	path;
+	/**
+	* Pre-fetched data payload to eliminate N+1 queries.
+	* When present, clients can use this directly instead of fetching.
+	*/
+	data;
+	constructor(id, path, data) {
+		this.id = id;
+		this.path = path;
+		this.data = data;
+	}
+	get pathWithId() {
+		return `${this.path}/${this.id}`;
+	}
+	isEntityReference() {
+		return false;
+	}
+	isEntityRelation() {
+		return true;
+	}
+};
+var GeoPoint = class {
+	/**
+	* The latitude of this GeoPoint instance.
+	*/
+	latitude;
+	/**
+	* The longitude of this GeoPoint instance.
+	*/
+	longitude;
+	constructor(latitude, longitude) {
+		this.latitude = latitude;
+		this.longitude = longitude;
+	}
+};
+var Vector = class {
+	value;
+	constructor(value) {
+		this.value = value;
+	}
+};
+//#endregion
+//#region src/types/collections.ts
+/**
+* Type guard for PostgreSQL collections.
+* Returns true if the collection uses the Postgres driver (or the default driver).
+* @group Models
+*/
 function isPostgresCollection(collection) {
-  return !collection.driver || collection.driver === "postgres";
+	return !collection.driver || collection.driver === "postgres";
 }
+/**
+* Type guard for Firebase / Firestore collections.
+* @group Models
+*/
 function isFirebaseCollection(collection) {
-  return collection.driver === "firestore";
+	return collection.driver === "firestore";
 }
+/**
+* Type guard for MongoDB collections.
+* @group Models
+*/
 function isMongoDBCollection(collection) {
-  return collection.driver === "mongodb";
+	return collection.driver === "mongodb";
 }
+//#endregion
+//#region src/types/backend.ts
+/**
+* Type guard: does this admin support SQL operations?
+* @group Admin
+*/
 function isSQLAdmin(admin) {
-  return !!admin && typeof admin.executeSql === "function";
+	return !!admin && typeof admin.executeSql === "function";
 }
+/**
+* Type guard: does this admin support document operations?
+* @group Admin
+*/
 function isDocumentAdmin(admin) {
-  return !!admin && (typeof admin.executeAggregate === "function" || typeof admin.fetchCollectionStats === "function");
+	return !!admin && (typeof admin.executeAggregate === "function" || typeof admin.fetchCollectionStats === "function");
 }
+/**
+* Type guard: does this admin support schema management?
+* @group Admin
+*/
 function isSchemaAdmin(admin) {
-  return !!admin && (typeof admin.fetchUnmappedTables === "function" || typeof admin.fetchTableMetadata === "function");
+	return !!admin && (typeof admin.fetchUnmappedTables === "function" || typeof admin.fetchTableMetadata === "function");
 }
+/**
+* Type guard: does this admin support database branching?
+* @group Admin
+*/
 function isBranchAdmin(admin) {
-  return !!admin && typeof admin.createBranch === "function";
+	return !!admin && typeof admin.createBranch === "function";
 }
-const POSTGRES_CAPABILITIES = {
-  key: "postgres",
-  label: "PostgreSQL",
-  supportsRelations: true,
-  supportsSubcollections: false,
-  supportsRLS: true,
-  supportsReferences: false,
-  supportsColumnTypes: true,
-  supportsRealtime: true,
-  supportsSQLAdmin: true,
-  supportsDocumentAdmin: false,
-  supportsSchemaAdmin: true
+//#endregion
+//#region src/types/data_source.ts
+/** @group Models */
+var POSTGRES_CAPABILITIES = {
+	key: "postgres",
+	label: "PostgreSQL",
+	supportsRelations: true,
+	supportsSubcollections: false,
+	supportsRLS: true,
+	supportsReferences: false,
+	supportsColumnTypes: true,
+	supportsRealtime: true,
+	supportsSQLAdmin: true,
+	supportsDocumentAdmin: false,
+	supportsSchemaAdmin: true
 };
-const FIREBASE_CAPABILITIES = {
-  key: "firestore",
-  label: "Firebase / Firestore",
-  supportsRelations: false,
-  supportsSubcollections: true,
-  supportsRLS: false,
-  supportsReferences: true,
-  supportsColumnTypes: false,
-  supportsRealtime: true,
-  supportsSQLAdmin: false,
-  supportsDocumentAdmin: false,
-  supportsSchemaAdmin: false
+/** @group Models */
+var FIREBASE_CAPABILITIES = {
+	key: "firestore",
+	label: "Firebase / Firestore",
+	supportsRelations: false,
+	supportsSubcollections: true,
+	supportsRLS: false,
+	supportsReferences: true,
+	supportsColumnTypes: false,
+	supportsRealtime: true,
+	supportsSQLAdmin: false,
+	supportsDocumentAdmin: false,
+	supportsSchemaAdmin: false
 };
-const MONGODB_CAPABILITIES = {
-  key: "mongodb",
-  label: "MongoDB",
-  supportsRelations: false,
-  supportsSubcollections: true,
-  supportsRLS: false,
-  supportsReferences: true,
-  supportsColumnTypes: false,
-  supportsRealtime: false,
-  supportsSQLAdmin: false,
-  supportsDocumentAdmin: true,
-  supportsSchemaAdmin: true
+/** @group Models */
+var MONGODB_CAPABILITIES = {
+	key: "mongodb",
+	label: "MongoDB",
+	supportsRelations: false,
+	supportsSubcollections: true,
+	supportsRLS: false,
+	supportsReferences: true,
+	supportsColumnTypes: false,
+	supportsRealtime: false,
+	supportsSQLAdmin: false,
+	supportsDocumentAdmin: true,
+	supportsSchemaAdmin: true
 };
-const DEFAULT_CAPABILITIES = {
-  key: "(default)",
-  label: "Default",
-  supportsRelations: true,
-  supportsSubcollections: true,
-  supportsRLS: true,
-  supportsReferences: true,
-  supportsColumnTypes: true,
-  supportsRealtime: true,
-  supportsSQLAdmin: true,
-  supportsDocumentAdmin: true,
-  supportsSchemaAdmin: true
+/**
+* Fallback capabilities when the driver is unknown.
+* Enables everything so nothing is hidden unexpectedly.
+* @group Models
+*/
+var DEFAULT_CAPABILITIES = {
+	key: "(default)",
+	label: "Default",
+	supportsRelations: true,
+	supportsSubcollections: true,
+	supportsRLS: true,
+	supportsReferences: true,
+	supportsColumnTypes: true,
+	supportsRealtime: true,
+	supportsSQLAdmin: true,
+	supportsDocumentAdmin: true,
+	supportsSchemaAdmin: true
 };
-const CAPABILITIES_REGISTRY = {
-  postgres: POSTGRES_CAPABILITIES,
-  firestore: FIREBASE_CAPABILITIES,
-  mongodb: MONGODB_CAPABILITIES,
-  "(default)": DEFAULT_CAPABILITIES
+var CAPABILITIES_REGISTRY = {
+	postgres: POSTGRES_CAPABILITIES,
+	firestore: FIREBASE_CAPABILITIES,
+	mongodb: MONGODB_CAPABILITIES,
+	"(default)": DEFAULT_CAPABILITIES
 };
+/**
+* Look up capabilities for a given driver key.
+* If `driver` is undefined or not found, returns `DEFAULT_CAPABILITIES`.
+* @group Models
+*/
 function getDataSourceCapabilities(driver) {
-  if (!driver) return POSTGRES_CAPABILITIES;
-  return CAPABILITIES_REGISTRY[driver] ?? DEFAULT_CAPABILITIES;
+	if (!driver) return POSTGRES_CAPABILITIES;
+	return CAPABILITIES_REGISTRY[driver] ?? DEFAULT_CAPABILITIES;
 }
+/**
+* Register custom capabilities for a third-party driver.
+* @group Models
+*/
 function registerDataSourceCapabilities(capabilities) {
-  CAPABILITIES_REGISTRY[capabilities.key] = capabilities;
+	CAPABILITIES_REGISTRY[capabilities.key] = capabilities;
 }
+//#endregion
+//#region src/types/component_ref.ts
+/**
+* Type guard: checks if a value is a `LazyComponentRef` produced by the
+* Vite transform plugin.
+*/
 function isLazyComponentRef(ref) {
-  return typeof ref === "object" && ref !== null && "__rebaseLazy" in ref && ref.__rebaseLazy === true;
+	return typeof ref === "object" && ref !== null && "__rebaseLazy" in ref && ref.__rebaseLazy === true;
 }
-export {
-  DEFAULT_CAPABILITIES,
-  EntityReference,
-  EntityRelation,
-  FIREBASE_CAPABILITIES,
-  GeoPoint,
-  MONGODB_CAPABILITIES,
-  POSTGRES_CAPABILITIES,
-  Vector,
-  getDataSourceCapabilities,
-  isBranchAdmin,
-  isDocumentAdmin,
-  isFirebaseCollection,
-  isLazyComponentRef,
-  isMongoDBCollection,
-  isPostgresCollection,
-  isSQLAdmin,
-  isSchemaAdmin,
-  registerDataSourceCapabilities
-};
-//# sourceMappingURL=index.es.js.map
+//#endregion
+export { DEFAULT_CAPABILITIES, EntityReference, EntityRelation, FIREBASE_CAPABILITIES, GeoPoint, MONGODB_CAPABILITIES, POSTGRES_CAPABILITIES, Vector, getDataSourceCapabilities, isBranchAdmin, isDocumentAdmin, isFirebaseCollection, isLazyComponentRef, isMongoDBCollection, isPostgresCollection, isSQLAdmin, isSchemaAdmin, registerDataSourceCapabilities };
+
+//# sourceMappingURL=index.es.js.map