@rebasepro/types 0.8.0 → 0.9.1-canary.09aaf62

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,66 @@ 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;
+    /**
+     * Channel name, on broadcast and presence frames.
+     *
+     * These are addressed by channel rather than by `requestId` or
+     * `subscriptionId`, so this is the only field that routes them.
+     */
+    channel?: string;
 }
 
+/**
+ * The key columns a collection's rows are addressed by.
+ *
+ * A row is exactly its columns and carries no address, so a subscriber that has
+ * to recognise one — to patch it, or to keep its reference across a refetch —
+ * derives the address from these. The SDK is usable with no collections
+ * declared at all, so the server is the only side that knows them.
+ *
+ * Undefined when the server cannot resolve them: a table with no primary key
+ * and no `id` column has no address, and rows of it cannot be recognised by
+ * anyone.
+ */
+export type WirePrimaryKeys = { fieldName: string; type: "string" | "number"; isUUID?: boolean }[];
+
 export interface CollectionUpdateMessage extends WebSocketMessage {
     type: "collection_update";
     subscriptionId: string;
-    entities: Entity<Record<string, unknown>>[];
+    rows: Record<string, unknown>[];
+    /**
+     * See {@link WirePrimaryKeys}. Sent with the rows themselves — and not only
+     * with a patch — because a CDC-originated change sends no patch at all: it
+     * invalidates and goes straight to a refetch, and the merge that preserves
+     * unchanged rows' references needs an address to match them by.
+     */
+    pks?: WirePrimaryKeys;
 }
 
-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;
+    /** The address of the row this patch refers to — derived, never read off it. */
+    id: string;
+    /** The updated row, or null if deleted */
+    row: Record<string, unknown> | null;
+    /** See {@link WirePrimaryKeys}: how the subscriber finds {@link id} in its cache. */
+    pks?: WirePrimaryKeys;
 }
 
 /**

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/app` 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[];
 

package/dist/index.umd.js

@@ -1,458 +0,0 @@
-(function(global, factory) {
-	typeof exports === "object" && typeof module !== "undefined" ? factory(exports) : typeof define === "function" && define.amd ? define(["exports"], factory) : (global = typeof globalThis !== "undefined" ? globalThis : global || self, factory(global["Rebase Types"] = {}));
-})(this, function(exports) {
-	Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-	//#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/filter-operators.ts
-	/** Maps canonical operators to their REST short-code equivalents. */
-	var CANONICAL_TO_REST = {
-		"==": "eq",
-		"!=": "neq",
-		">": "gt",
-		">=": "gte",
-		"<": "lt",
-		"<=": "lte",
-		"in": "in",
-		"not-in": "nin",
-		"array-contains": "cs",
-		"array-contains-any": "csa"
-	};
-	/** Maps REST short-code operators to their canonical equivalents. */
-	var REST_TO_CANONICAL = {
-		"eq": "==",
-		"neq": "!=",
-		"gt": ">",
-		"gte": ">=",
-		"lt": "<",
-		"lte": "<=",
-		"in": "in",
-		"nin": "not-in",
-		"cs": "array-contains",
-		"csa": "array-contains-any"
-	};
-	/** All canonical operator strings for runtime validation. */
-	var CANONICAL_OPS = new Set([
-		"<",
-		"<=",
-		"==",
-		"!=",
-		">=",
-		">",
-		"in",
-		"not-in",
-		"array-contains",
-		"array-contains-any"
-	]);
-	/**
-	* Resolve any operator string (canonical or REST short-code) to its
-	* canonical `WhereFilterOp` form. Returns `undefined` for unknown operators.
-	*
-	* @example
-	* toCanonicalOp("==")   // "=="
-	* toCanonicalOp("eq")   // "=="
-	* toCanonicalOp("cs")   // "array-contains"
-	* toCanonicalOp("xyz")  // undefined
-	*/
-	function toCanonicalOp(op) {
-		if (CANONICAL_OPS.has(op)) return op;
-		return REST_TO_CANONICAL[op];
-	}
-	//#endregion
-	//#region src/types/collections.ts
-	/**
-	* Type guard for PostgreSQL collections.
-	* Returns true if the collection uses the Postgres engine (or the default engine).
-	* @group Models
-	*/
-	function isPostgresCollection(collection) {
-		return !collection.engine || collection.engine === "postgres";
-	}
-	/**
-	* Type guard for Firebase / Firestore collections.
-	* @group Models
-	*/
-	function isFirebaseCollection(collection) {
-		return collection.engine === "firestore";
-	}
-	/**
-	* Type guard for MongoDB collections.
-	* @group Models
-	*/
-	function isMongoDBCollection(collection) {
-		return collection.engine === "mongodb";
-	}
-	/**
-	* Returns the data path for a collection.
-	* For Firestore or MongoDB collections with a `path`, returns that value;
-	* otherwise falls back to `slug`.
-	*/
-	function getCollectionDataPath(collection) {
-		if (isFirebaseCollection(collection) && collection.path) return collection.path;
-		if (isMongoDBCollection(collection) && collection.path) return collection.path;
-		return collection.slug;
-	}
-	/**
-	* Reads a collection's driver-declared subcollections thunk (the `subcollections`
-	* field) independent of engine identity, so engine-agnostic code doesn't have to
-	* type-guard against a specific driver. Returns `undefined` when the collection
-	* declares none.
-	*
-	* Pair with `getDataSourceCapabilities(engine).supportsSubcollections` to decide
-	* whether the engine honours subcollections at all before reading them.
-	* @group Models
-	*/
-	function getDeclaredSubcollections(collection) {
-		return collection.subcollections;
-	}
-	//#endregion
-	//#region src/types/policy.ts
-	/** @group Models */
-	var policy = {
-		true: () => ({ kind: "true" }),
-		false: () => ({ kind: "false" }),
-		and: (...operands) => ({
-			kind: "and",
-			operands
-		}),
-		or: (...operands) => ({
-			kind: "or",
-			operands
-		}),
-		not: (operand) => ({
-			kind: "not",
-			operand
-		}),
-		compare: (left, op, right) => ({
-			kind: "compare",
-			op,
-			left,
-			right
-		}),
-		rolesOverlap: (roles) => ({
-			kind: "rolesOverlap",
-			roles
-		}),
-		rolesContain: (roles) => ({
-			kind: "rolesContain",
-			roles
-		}),
-		authenticated: () => ({ kind: "authenticated" }),
-		raw: (sql) => ({
-			kind: "raw",
-			sql
-		}),
-		field: (name) => ({
-			kind: "field",
-			name
-		}),
-		literal: (value) => ({
-			kind: "literal",
-			value
-		}),
-		authUid: () => ({ kind: "authUid" }),
-		authRoles: () => ({ kind: "authRoles" })
-	};
-	//#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";
-	}
-	/**
-	* Type guard: does this admin support document operations?
-	* @group Admin
-	*/
-	function isDocumentAdmin(admin) {
-		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");
-	}
-	/**
-	* Type guard: does this admin support database branching?
-	* @group Admin
-	*/
-	function isBranchAdmin(admin) {
-		return !!admin && typeof admin.createBranch === "function";
-	}
-	//#endregion
-	//#region src/types/data_source.ts
-	/**
-	* The default data-source key, used when a collection does not name a
-	* `dataSource`. Shared by the frontend router and the backend driver
-	* registry so both agree on "the default database".
-	* @group Models
-	*/
-	var DEFAULT_DATA_SOURCE_KEY = "(default)";
-	/** @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
-	};
-	/** @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
-	};
-	/** @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
-	};
-	/**
-	* 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
-	};
-	var CAPABILITIES_REGISTRY = {
-		postgres: POSTGRES_CAPABILITIES,
-		firestore: FIREBASE_CAPABILITIES,
-		mongodb: MONGODB_CAPABILITIES,
-		"(default)": DEFAULT_CAPABILITIES
-	};
-	/**
-	* Look up capabilities for a given engine key.
-	* If `engine` is undefined or not found, returns `DEFAULT_CAPABILITIES`.
-	* @group Models
-	*/
-	function getDataSourceCapabilities(engine) {
-		if (!engine) return POSTGRES_CAPABILITIES;
-		return CAPABILITIES_REGISTRY[engine] ?? DEFAULT_CAPABILITIES;
-	}
-	/**
-	* Register custom capabilities for a third-party driver.
-	* @group Models
-	*/
-	function registerDataSourceCapabilities(capabilities) {
-		CAPABILITIES_REGISTRY[capabilities.key] = capabilities;
-	}
-	//#endregion
-	//#region src/types/storage_source.ts
-	/**
-	* 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
-	*/
-	var DEFAULT_STORAGE_SOURCE_KEY = "(default)";
-	//#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;
-	}
-	//#endregion
-	exports.CANONICAL_TO_REST = CANONICAL_TO_REST;
-	exports.DEFAULT_CAPABILITIES = DEFAULT_CAPABILITIES;
-	exports.DEFAULT_DATA_SOURCE_KEY = DEFAULT_DATA_SOURCE_KEY;
-	exports.DEFAULT_STORAGE_SOURCE_KEY = DEFAULT_STORAGE_SOURCE_KEY;
-	exports.EntityReference = EntityReference;
-	exports.EntityRelation = EntityRelation;
-	exports.FIREBASE_CAPABILITIES = FIREBASE_CAPABILITIES;
-	exports.GeoPoint = GeoPoint;
-	exports.MONGODB_CAPABILITIES = MONGODB_CAPABILITIES;
-	exports.POSTGRES_CAPABILITIES = POSTGRES_CAPABILITIES;
-	exports.REST_TO_CANONICAL = REST_TO_CANONICAL;
-	exports.Vector = Vector;
-	exports.getCollectionDataPath = getCollectionDataPath;
-	exports.getDataSourceCapabilities = getDataSourceCapabilities;
-	exports.getDeclaredSubcollections = getDeclaredSubcollections;
-	exports.isBranchAdmin = isBranchAdmin;
-	exports.isDocumentAdmin = isDocumentAdmin;
-	exports.isFirebaseCollection = isFirebaseCollection;
-	exports.isLazyComponentRef = isLazyComponentRef;
-	exports.isMongoDBCollection = isMongoDBCollection;
-	exports.isPostgresCollection = isPostgresCollection;
-	exports.isSQLAdmin = isSQLAdmin;
-	exports.isSchemaAdmin = isSchemaAdmin;
-	exports.policy = policy;
-	exports.registerDataSourceCapabilities = registerDataSourceCapabilities;
-	exports.toCanonicalOp = toCanonicalOp;
-});
-
-//# sourceMappingURL=index.umd.js.map