@rebasepro/types 0.0.1-canary.0

package/dist/index.es.js

@@ -0,0 +1,113 @@
+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 datasource (e.g., 'postgres', 'firestore').
+   * Defaults to "(default)" if not specified.
+   */
+  datasource;
+  /**
+   * Which database within the datasource.
+   * 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 datasource
+   * new EntityReference({ id: "123", path: "analytics", datasource: "firestore" })
+   */
+  constructor(props) {
+    this.id = props.id;
+    this.path = props.path;
+    this.datasource = props.datasource;
+    this.databaseId = props.databaseId;
+  }
+  get pathWithId() {
+    return `${this.path}/${this.id}`;
+  }
+  /**
+   * Get the full path including datasource and database prefixes if specified.
+   * For the common case (single datasource, single db), this just returns pathWithId.
+   */
+  get fullPath() {
+    const parts = [];
+    if (this.datasource && this.datasource !== "(default)") {
+      parts.push(this.datasource);
+    }
+    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;
+  constructor(id, path) {
+    this.id = id;
+    this.path = path;
+  }
+  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;
+  }
+}
+export {
+  EntityReference,
+  EntityRelation,
+  GeoPoint,
+  Vector
+};
+//# sourceMappingURL=index.es.js.map

package/dist/index.es.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.es.js","sources":["../src/types/entities.ts"],"sourcesContent":["/**\n * New or existing status\n * @group Models\n */\nexport type EntityStatus = \"new\" | \"existing\" | \"copy\";\n\n/**\n * Representation of an entity fetched from the datasource\n * @group Models\n */\nexport interface Entity<M extends object = object> {\n\n    /**\n     * ID of the entity\n     */\n    id: string | number;\n\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    path: string;\n\n    /**\n     * Current values\n     */\n    values: EntityValues<M>;\n\n    /**\n     * Which datasource this entity belongs to (e.g., 'postgres', 'firestore').\n     * If not specified, the default datasource is assumed.\n     */\n    datasource?: string;\n\n    /**\n     * Which database within the datasource (e.g., for Firestore multi-database).\n     * If not specified, the default database of the datasource is used.\n     */\n    databaseId?: string;\n}\n\n/**\n * This type represents a record of key value pairs as described in an\n * entity collection.\n * @group Models\n */\nexport type EntityValues<M extends object> = M;\n\n/**\n * Props for creating an EntityReference\n */\nexport interface EntityReferenceProps {\n    /** ID of the entity */\n    id: string;\n    /** Path of the collection (relative to the root of the database) */\n    path: string;\n    /** Which datasource (e.g., 'postgres', 'firestore'). Defaults to \"(default)\" */\n    datasource?: string;\n    /** Which database within the datasource. Defaults to \"(default)\" */\n    databaseId?: string;\n}\n\n/**\n * Class used to create a reference to an entity in a different path.\n * \n * @example\n * // Simple reference (most common case - single datasource, single db)\n * new EntityReference({ id: \"123\", path: \"users\" })\n * \n * // Reference to a different datasource (e.g., Firestore)\n * new EntityReference({ id: \"123\", path: \"analytics\", datasource: \"firestore\" })\n * \n * // Reference to a specific database within a datasource\n * new EntityReference({ id: \"123\", path: \"orders\", datasource: \"postgres\", databaseId: \"orders_db\" })\n */\nexport class EntityReference {\n\n    readonly __type = \"reference\";\n    /**\n     * ID of the entity\n     */\n    readonly id: string;\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    readonly path: string;\n\n    /**\n     * Which datasource (e.g., 'postgres', 'firestore').\n     * Defaults to \"(default)\" if not specified.\n     */\n    readonly datasource?: string;\n\n    /**\n     * Which database within the datasource.\n     * Defaults to \"(default)\" if not specified.\n     */\n    readonly databaseId?: string;\n\n    /**\n     * Create a reference to an entity.\n     * \n     * @example\n     * // Simple reference (most common case)\n     * new EntityReference({ id: \"123\", path: \"users\" })\n     * \n     * // With datasource\n     * new EntityReference({ id: \"123\", path: \"analytics\", datasource: \"firestore\" })\n     */\n    constructor(props: EntityReferenceProps) {\n        this.id = props.id;\n        this.path = props.path;\n        this.datasource = props.datasource;\n        this.databaseId = props.databaseId;\n    }\n\n    get pathWithId() {\n        return `${this.path}/${this.id}`;\n    }\n\n    /**\n     * Get the full path including datasource and database prefixes if specified.\n     * For the common case (single datasource, single db), this just returns pathWithId.\n     */\n    get fullPath() {\n        const parts: string[] = [];\n\n        // Add datasource prefix if not default\n        if (this.datasource && this.datasource !== \"(default)\") {\n            parts.push(this.datasource);\n        }\n\n        // Add database prefix if specified\n        if (this.databaseId && this.databaseId !== \"(default)\") {\n            parts.push(this.databaseId);\n        }\n\n        if (parts.length > 0) {\n            return `${parts.join(\":\")}:::${this.path}/${this.id}`;\n        }\n        return this.pathWithId;\n    }\n\n    isEntityReference() {\n        return true;\n    }\n}\n\n/**\n * Class used to create a reference to an entity in a different path\n */\nexport class EntityRelation {\n\n    readonly __type = \"relation\";\n    /**\n     * ID of the entity\n     */\n    readonly id: string | number;\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    readonly path: string;\n\n    constructor(id: string | number, path: string) {\n        this.id = id;\n        this.path = path;\n    }\n\n    get pathWithId() {\n        return `${this.path}/${this.id}`;\n    }\n\n    isEntityReference() {\n        return false;\n    }\n\n    isEntityRelation() {\n        return true;\n    }\n}\n\nexport class GeoPoint {\n\n    /**\n     * The latitude of this GeoPoint instance.\n     */\n    readonly latitude: number;\n    /**\n     * The longitude of this GeoPoint instance.\n     */\n    readonly longitude: number;\n\n    constructor(latitude: number, longitude: number) {\n        this.latitude = latitude;\n        this.longitude = longitude;\n    }\n}\n\nexport class Vector {\n    readonly value: number[];\n\n    constructor(value: number[]) {\n        this.value = value;\n    }\n}\n"],"names":["EntityReference","__type","id","path","datasource","databaseId","constructor","props","pathWithId","fullPath","parts","push","length","join","isEntityReference","EntityRelation","isEntityRelation","GeoPoint","latitude","longitude","Vector","value"],"mappings":"AA2EO,MAAMA,gBAAgB;AAAA,EAEhBC,SAAS;AAAA;AAAA;AAAA;AAAA,EAITC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAKAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAMAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAMAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAYTC,YAAYC,OAA6B;AACrC,SAAKL,KAAKK,MAAML;AAChB,SAAKC,OAAOI,MAAMJ;AAClB,SAAKC,aAAaG,MAAMH;AACxB,SAAKC,aAAaE,MAAMF;AAAAA,EAC5B;AAAA,EAEA,IAAIG,aAAa;AACb,WAAO,GAAG,KAAKL,IAAI,IAAI,KAAKD,EAAE;AAAA,EAClC;AAAA;AAAA;AAAA;AAAA;AAAA,EAMA,IAAIO,WAAW;AACX,UAAMC,QAAkB,CAAA;AAGxB,QAAI,KAAKN,cAAc,KAAKA,eAAe,aAAa;AACpDM,YAAMC,KAAK,KAAKP,UAAU;AAAA,IAC9B;AAGA,QAAI,KAAKC,cAAc,KAAKA,eAAe,aAAa;AACpDK,YAAMC,KAAK,KAAKN,UAAU;AAAA,IAC9B;AAEA,QAAIK,MAAME,SAAS,GAAG;AAClB,aAAO,GAAGF,MAAMG,KAAK,GAAG,CAAC,MAAM,KAAKV,IAAI,IAAI,KAAKD,EAAE;AAAA,IACvD;AACA,WAAO,KAAKM;AAAAA,EAChB;AAAA,EAEAM,oBAAoB;AAChB,WAAO;AAAA,EACX;AACJ;AAKO,MAAMC,eAAe;AAAA,EAEfd,SAAS;AAAA;AAAA;AAAA;AAAA,EAITC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,EAKAC;AAAAA,EAETG,YAAYJ,IAAqBC,MAAc;AAC3C,SAAKD,KAAKA;AACV,SAAKC,OAAOA;AAAAA,EAChB;AAAA,EAEA,IAAIK,aAAa;AACb,WAAO,GAAG,KAAKL,IAAI,IAAI,KAAKD,EAAE;AAAA,EAClC;AAAA,EAEAY,oBAAoB;AAChB,WAAO;AAAA,EACX;AAAA,EAEAE,mBAAmB;AACf,WAAO;AAAA,EACX;AACJ;AAEO,MAAMC,SAAS;AAAA;AAAA;AAAA;AAAA,EAKTC;AAAAA;AAAAA;AAAAA;AAAAA,EAIAC;AAAAA,EAETb,YAAYY,UAAkBC,WAAmB;AAC7C,SAAKD,WAAWA;AAChB,SAAKC,YAAYA;AAAAA,EACrB;AACJ;AAEO,MAAMC,OAAO;AAAA,EACPC;AAAAA,EAETf,YAAYe,OAAiB;AACzB,SAAKA,QAAQA;AAAAA,EACjB;AACJ;"}

package/dist/index.umd.js

@@ -0,0 +1,117 @@
+(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(exports2) {
+  "use strict";
+  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 datasource (e.g., 'postgres', 'firestore').
+     * Defaults to "(default)" if not specified.
+     */
+    datasource;
+    /**
+     * Which database within the datasource.
+     * 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 datasource
+     * new EntityReference({ id: "123", path: "analytics", datasource: "firestore" })
+     */
+    constructor(props) {
+      this.id = props.id;
+      this.path = props.path;
+      this.datasource = props.datasource;
+      this.databaseId = props.databaseId;
+    }
+    get pathWithId() {
+      return `${this.path}/${this.id}`;
+    }
+    /**
+     * Get the full path including datasource and database prefixes if specified.
+     * For the common case (single datasource, single db), this just returns pathWithId.
+     */
+    get fullPath() {
+      const parts = [];
+      if (this.datasource && this.datasource !== "(default)") {
+        parts.push(this.datasource);
+      }
+      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;
+    constructor(id, path) {
+      this.id = id;
+      this.path = path;
+    }
+    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;
+    }
+  }
+  exports2.EntityReference = EntityReference;
+  exports2.EntityRelation = EntityRelation;
+  exports2.GeoPoint = GeoPoint;
+  exports2.Vector = Vector;
+  Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
+});
+//# sourceMappingURL=index.umd.js.map

package/dist/index.umd.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.umd.js","sources":["../src/types/entities.ts"],"sourcesContent":["/**\n * New or existing status\n * @group Models\n */\nexport type EntityStatus = \"new\" | \"existing\" | \"copy\";\n\n/**\n * Representation of an entity fetched from the datasource\n * @group Models\n */\nexport interface Entity<M extends object = object> {\n\n    /**\n     * ID of the entity\n     */\n    id: string | number;\n\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    path: string;\n\n    /**\n     * Current values\n     */\n    values: EntityValues<M>;\n\n    /**\n     * Which datasource this entity belongs to (e.g., 'postgres', 'firestore').\n     * If not specified, the default datasource is assumed.\n     */\n    datasource?: string;\n\n    /**\n     * Which database within the datasource (e.g., for Firestore multi-database).\n     * If not specified, the default database of the datasource is used.\n     */\n    databaseId?: string;\n}\n\n/**\n * This type represents a record of key value pairs as described in an\n * entity collection.\n * @group Models\n */\nexport type EntityValues<M extends object> = M;\n\n/**\n * Props for creating an EntityReference\n */\nexport interface EntityReferenceProps {\n    /** ID of the entity */\n    id: string;\n    /** Path of the collection (relative to the root of the database) */\n    path: string;\n    /** Which datasource (e.g., 'postgres', 'firestore'). Defaults to \"(default)\" */\n    datasource?: string;\n    /** Which database within the datasource. Defaults to \"(default)\" */\n    databaseId?: string;\n}\n\n/**\n * Class used to create a reference to an entity in a different path.\n * \n * @example\n * // Simple reference (most common case - single datasource, single db)\n * new EntityReference({ id: \"123\", path: \"users\" })\n * \n * // Reference to a different datasource (e.g., Firestore)\n * new EntityReference({ id: \"123\", path: \"analytics\", datasource: \"firestore\" })\n * \n * // Reference to a specific database within a datasource\n * new EntityReference({ id: \"123\", path: \"orders\", datasource: \"postgres\", databaseId: \"orders_db\" })\n */\nexport class EntityReference {\n\n    readonly __type = \"reference\";\n    /**\n     * ID of the entity\n     */\n    readonly id: string;\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    readonly path: string;\n\n    /**\n     * Which datasource (e.g., 'postgres', 'firestore').\n     * Defaults to \"(default)\" if not specified.\n     */\n    readonly datasource?: string;\n\n    /**\n     * Which database within the datasource.\n     * Defaults to \"(default)\" if not specified.\n     */\n    readonly databaseId?: string;\n\n    /**\n     * Create a reference to an entity.\n     * \n     * @example\n     * // Simple reference (most common case)\n     * new EntityReference({ id: \"123\", path: \"users\" })\n     * \n     * // With datasource\n     * new EntityReference({ id: \"123\", path: \"analytics\", datasource: \"firestore\" })\n     */\n    constructor(props: EntityReferenceProps) {\n        this.id = props.id;\n        this.path = props.path;\n        this.datasource = props.datasource;\n        this.databaseId = props.databaseId;\n    }\n\n    get pathWithId() {\n        return `${this.path}/${this.id}`;\n    }\n\n    /**\n     * Get the full path including datasource and database prefixes if specified.\n     * For the common case (single datasource, single db), this just returns pathWithId.\n     */\n    get fullPath() {\n        const parts: string[] = [];\n\n        // Add datasource prefix if not default\n        if (this.datasource && this.datasource !== \"(default)\") {\n            parts.push(this.datasource);\n        }\n\n        // Add database prefix if specified\n        if (this.databaseId && this.databaseId !== \"(default)\") {\n            parts.push(this.databaseId);\n        }\n\n        if (parts.length > 0) {\n            return `${parts.join(\":\")}:::${this.path}/${this.id}`;\n        }\n        return this.pathWithId;\n    }\n\n    isEntityReference() {\n        return true;\n    }\n}\n\n/**\n * Class used to create a reference to an entity in a different path\n */\nexport class EntityRelation {\n\n    readonly __type = \"relation\";\n    /**\n     * ID of the entity\n     */\n    readonly id: string | number;\n    /**\n     * A string representing the path of the referenced document (relative\n     * to the root of the database).\n     */\n    readonly path: string;\n\n    constructor(id: string | number, path: string) {\n        this.id = id;\n        this.path = path;\n    }\n\n    get pathWithId() {\n        return `${this.path}/${this.id}`;\n    }\n\n    isEntityReference() {\n        return false;\n    }\n\n    isEntityRelation() {\n        return true;\n    }\n}\n\nexport class GeoPoint {\n\n    /**\n     * The latitude of this GeoPoint instance.\n     */\n    readonly latitude: number;\n    /**\n     * The longitude of this GeoPoint instance.\n     */\n    readonly longitude: number;\n\n    constructor(latitude: number, longitude: number) {\n        this.latitude = latitude;\n        this.longitude = longitude;\n    }\n}\n\nexport class Vector {\n    readonly value: number[];\n\n    constructor(value: number[]) {\n        this.value = value;\n    }\n}\n"],"names":["EntityReference","__type","id","path","datasource","databaseId","constructor","props","pathWithId","fullPath","parts","push","length","join","isEntityReference","EntityRelation","isEntityRelation","GeoPoint","latitude","longitude","Vector","value"],"mappings":";;;;EA2EO,MAAMA,gBAAgB;AAAA,IAEhBC,SAAS;AAAA;AAAA;AAAA;AAAA,IAITC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAKAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAMAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAMAC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAYTC,YAAYC,OAA6B;AACrC,WAAKL,KAAKK,MAAML;AAChB,WAAKC,OAAOI,MAAMJ;AAClB,WAAKC,aAAaG,MAAMH;AACxB,WAAKC,aAAaE,MAAMF;AAAAA,IAC5B;AAAA,IAEA,IAAIG,aAAa;AACb,aAAO,GAAG,KAAKL,IAAI,IAAI,KAAKD,EAAE;AAAA,IAClC;AAAA;AAAA;AAAA;AAAA;AAAA,IAMA,IAAIO,WAAW;AACX,YAAMC,QAAkB,CAAA;AAGxB,UAAI,KAAKN,cAAc,KAAKA,eAAe,aAAa;AACpDM,cAAMC,KAAK,KAAKP,UAAU;AAAA,MAC9B;AAGA,UAAI,KAAKC,cAAc,KAAKA,eAAe,aAAa;AACpDK,cAAMC,KAAK,KAAKN,UAAU;AAAA,MAC9B;AAEA,UAAIK,MAAME,SAAS,GAAG;AAClB,eAAO,GAAGF,MAAMG,KAAK,GAAG,CAAC,MAAM,KAAKV,IAAI,IAAI,KAAKD,EAAE;AAAA,MACvD;AACA,aAAO,KAAKM;AAAAA,IAChB;AAAA,IAEAM,oBAAoB;AAChB,aAAO;AAAA,IACX;AAAA,EACJ;AAAA,EAKO,MAAMC,eAAe;AAAA,IAEfd,SAAS;AAAA;AAAA;AAAA;AAAA,IAITC;AAAAA;AAAAA;AAAAA;AAAAA;AAAAA,IAKAC;AAAAA,IAETG,YAAYJ,IAAqBC,MAAc;AAC3C,WAAKD,KAAKA;AACV,WAAKC,OAAOA;AAAAA,IAChB;AAAA,IAEA,IAAIK,aAAa;AACb,aAAO,GAAG,KAAKL,IAAI,IAAI,KAAKD,EAAE;AAAA,IAClC;AAAA,IAEAY,oBAAoB;AAChB,aAAO;AAAA,IACX;AAAA,IAEAE,mBAAmB;AACf,aAAO;AAAA,IACX;AAAA,EACJ;AAAA,EAEO,MAAMC,SAAS;AAAA;AAAA;AAAA;AAAA,IAKTC;AAAAA;AAAAA;AAAAA;AAAAA,IAIAC;AAAAA,IAETb,YAAYY,UAAkBC,WAAmB;AAC7C,WAAKD,WAAWA;AAChB,WAAKC,YAAYA;AAAAA,IACrB;AAAA,EACJ;AAAA,EAEO,MAAMC,OAAO;AAAA,IACPC;AAAAA,IAETf,YAAYe,OAAiB;AACzB,WAAKA,QAAQA;AAAAA,IACjB;AAAA,EACJ;;;;;;;"}

package/dist/rebase_context.d.ts

@@ -0,0 +1,91 @@
+import { AnalyticsController, AuthController, CustomizationController, DataSource, DialogsController, NavigationController, SideDialogsController, SideEntityController, SnackbarController, StorageSource, UserConfigurationPersistence } from "./controllers";
+import { User } from "./users";
+import { UserManagementDelegate, EffectiveRoleController } from "./types";
+/**
+ * Context that is provided to entity callbacks (hooks).
+ * It contains only the dependencies that are available in both the frontend and the backend.
+ * @group Hooks and utilities
+ */
+export type RebaseCallContext<USER extends User = User> = {
+    /**
+     * Connector to your database, e.g. your Firestore database
+     */
+    dataSource: DataSource;
+    /**
+     * Used storage implementation
+     */
+    storageSource: StorageSource;
+    /**
+     * Set by the backend when callbacks are executed on the server.
+     */
+    user?: USER;
+};
+/**
+ * Context that includes the internal controllers and contexts used by the app.
+ * Some controllers and context included in this context can be accessed
+ * directly from their respective hooks.
+ * @group Hooks and utilities
+ * @see useRebaseContext
+ */
+export type RebaseContext<USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>> = RebaseCallContext<USER> & {
+    /**
+     * Context that includes the resolved navigation and utility methods and
+     * attributes.
+     * @see useNavigation
+     */
+    navigation?: NavigationController;
+    /**
+     * Controller to open the side dialog displaying entity forms
+     * @see useSideEntityController
+     */
+    sideEntityController?: SideEntityController;
+    /**
+     * Controller used to open side dialogs
+     * This is the controller used internally by side entity dialogs
+     * or reference dialogs.
+     */
+    sideDialogsController?: SideDialogsController;
+    /**
+     * Controller used to open regular dialogs
+     */
+    dialogsController?: DialogsController;
+    /**
+     * Used auth controller
+     */
+    authController?: AuthControllerType;
+    /**
+     * This controller holds the customization options for the CMS.
+     */
+    customizationController?: CustomizationController;
+    /**
+     * Use this controller to display snackbars
+     */
+    snackbarController?: SnackbarController;
+    /**
+     * Use this controller to access data stored in the browser for the user
+     */
+    userConfigPersistence?: UserConfigurationPersistence;
+    /**
+     * Callback to send analytics events
+     */
+    analyticsController?: AnalyticsController;
+    /**
+     * This section is used to manage users in the CMS.
+     * It is used to show user information in various places of the CMS,
+     * for example, to show who created or modified an entity,
+     * or to assign ownership of an entity.
+     *
+     * In the base CMS, this information is not used for access control.
+     * You can pass your own implementation of this section, to populate
+     * the dropdown of users when assigning ownership of an entity,
+     * or to show more information about the user.
+     *
+     * If you are using the Rebase user management plugin, this
+     * section will be implemented automatically.
+     */
+    userManagement?: UserManagementDelegate<USER>;
+    /**
+     * Controller to simulate different roles when dev mode is active.
+     */
+    effectiveRoleController?: EffectiveRoleController;
+};

package/dist/types/backend.d.ts

@@ -0,0 +1,254 @@
+import { Entity, EntityCollection, FilterValues, WhereFilterOp } from "./index";
+/**
+ * Abstract database connection interface.
+ * Represents a connection to any database system.
+ */
+export interface DatabaseConnection {
+    /**
+     * Type identifier for this database (e.g., 'postgres', 'mongodb', 'mysql')
+     */
+    readonly type: string;
+    /**
+     * Whether the connection is currently active
+     */
+    readonly isConnected?: boolean;
+    /**
+     * Close the database connection
+     */
+    close?(): Promise<void>;
+}
+/**
+ * A single filter condition for database queries
+ */
+export interface QueryFilter {
+    field: string;
+    operator: WhereFilterOp;
+    value: unknown;
+}
+/**
+ * Options for fetching a collection of entities
+ */
+export interface FetchCollectionOptions<M extends Record<string, any> = any> {
+    filter?: FilterValues<Extract<keyof M, string>>;
+    orderBy?: string;
+    order?: "desc" | "asc";
+    limit?: number;
+    startAfter?: unknown;
+    searchString?: string;
+    databaseId?: string;
+}
+/**
+ * Options for searching entities
+ */
+export interface SearchOptions<M extends Record<string, any> = any> {
+    filter?: FilterValues<Extract<keyof M, string>>;
+    orderBy?: string;
+    order?: "desc" | "asc";
+    limit?: number;
+    databaseId?: string;
+}
+/**
+ * Options for counting entities
+ */
+export interface CountOptions<M extends Record<string, any> = any> {
+    filter?: FilterValues<Extract<keyof M, string>>;
+    databaseId?: string;
+}
+/**
+ * Abstract condition builder interface.
+ * Implementations translate Rebase filter conditions to database-specific queries.
+ *
+ * Note: This interface can be implemented as instance methods or as a class with static methods.
+ * For static implementations (like DrizzleConditionBuilder), use the ConditionBuilderStatic type.
+ *
+ * @template T The type of condition returned by the builder (e.g., SQL for PostgreSQL, Filter<Document> for MongoDB)
+ */
+export interface ConditionBuilder<T = any> {
+    /**
+     * Build filter conditions from Rebase FilterValues
+     */
+    buildFilterConditions<M extends Record<string, any>>(filter: FilterValues<Extract<keyof M, string>>, collectionPath: string, ...args: unknown[]): T[];
+    /**
+     * Build search conditions for text search
+     */
+    buildSearchConditions(searchString: string, properties: Record<string, unknown>, ...args: unknown[]): T[];
+    /**
+     * Combine multiple conditions with AND operator
+     */
+    combineConditionsWithAnd(conditions: T[]): T | undefined;
+    /**
+     * Combine multiple conditions with OR operator
+     */
+    combineConditionsWithOr(conditions: T[]): T | undefined;
+}
+/**
+ * Static condition builder type for implementations using static methods.
+ * Use this type when the class provides static methods rather than instance methods.
+ *
+ * @example
+ * // DrizzleConditionBuilder satisfies this type
+ * const builder: ConditionBuilderStatic<SQL> = DrizzleConditionBuilder;
+ */
+export type ConditionBuilderStatic<T = any> = {
+    buildFilterConditions<M extends Record<string, any>>(filter: FilterValues<Extract<keyof M, string>>, ...args: unknown[]): T[];
+    buildSearchConditions(searchString: string, properties: Record<string, unknown>, ...args: unknown[]): T[];
+    combineConditionsWithAnd(conditions: T[]): T | undefined;
+    combineConditionsWithOr(conditions: T[]): T | undefined;
+};
+/**
+ * Abstract entity repository interface.
+ * Handles all CRUD operations for entities in the database.
+ *
+ * Implementations should handle:
+ * - Entity serialization/deserialization
+ * - Relation resolution
+ * - ID generation and conversion
+ */
+export interface EntityRepository {
+    /**
+     * Fetch a single entity by ID
+     */
+    fetchEntity<M extends Record<string, any>>(collectionPath: string, entityId: string | number, databaseId?: string): Promise<Entity<M> | undefined>;
+    /**
+     * Fetch a collection of entities with optional filtering, ordering, and pagination
+     */
+    fetchCollection<M extends Record<string, any>>(collectionPath: string, options?: FetchCollectionOptions<M>): Promise<Entity<M>[]>;
+    /**
+     * Search entities by text
+     */
+    searchEntities<M extends Record<string, any>>(collectionPath: string, searchString: string, options?: SearchOptions<M>): Promise<Entity<M>[]>;
+    /**
+     * Count entities in a collection
+     */
+    countEntities<M extends Record<string, any>>(collectionPath: string, options?: CountOptions<M>): Promise<number>;
+    /**
+     * Save an entity (create or update)
+     */
+    saveEntity<M extends Record<string, any>>(collectionPath: string, values: Partial<M>, entityId?: string | number, databaseId?: string): Promise<Entity<M>>;
+    /**
+     * Delete an entity by ID
+     */
+    deleteEntity(collectionPath: string, entityId: string | number, databaseId?: string): Promise<void>;
+    /**
+     * Check if a field value is unique in a collection
+     */
+    checkUniqueField(collectionPath: string, fieldName: string, value: unknown, excludeEntityId?: string, databaseId?: string): Promise<boolean>;
+}
+/**
+ * Configuration for subscribing to a collection
+ */
+export interface CollectionSubscriptionConfig {
+    clientId: string;
+    path: string;
+    filter?: unknown;
+    orderBy?: string;
+    order?: "desc" | "asc";
+    limit?: number;
+    startAfter?: unknown;
+    databaseId?: string;
+    searchString?: string;
+}
+/**
+ * Configuration for subscribing to a single entity
+ */
+export interface EntitySubscriptionConfig {
+    clientId: string;
+    path: string;
+    entityId: string | number;
+}
+/**
+ * Abstract realtime provider interface.
+ * Handles real-time subscriptions and notifications for entity changes.
+ */
+export interface RealtimeProvider {
+    /**
+     * Subscribe to collection changes
+     */
+    subscribeToCollection(subscriptionId: string, config: CollectionSubscriptionConfig, callback?: (entities: Entity[]) => void): void;
+    /**
+     * Subscribe to single entity changes
+     */
+    subscribeToEntity(subscriptionId: string, config: EntitySubscriptionConfig, callback?: (entity: Entity | null) => void): void;
+    /**
+     * Unsubscribe from a subscription
+     */
+    unsubscribe(subscriptionId: string): void;
+    /**
+     * Notify all relevant subscribers of an entity update
+     */
+    notifyEntityUpdate(path: string, entityId: string, entity: Entity | null, databaseId?: string): Promise<void>;
+}
+/**
+ * Abstract collection registry interface.
+ * Manages registration and lookup of entity collections.
+ */
+export interface CollectionRegistryInterface {
+    /**
+     * Register a collection
+     */
+    register(collection: EntityCollection): void;
+    /**
+     * Get a collection by its path
+     */
+    getCollectionByPath(path: string): EntityCollection | undefined;
+    /**
+     * Get all registered collections
+     */
+    getCollections(): EntityCollection[];
+}
+/**
+ * Abstract data transformer interface.
+ * Handles serialization/deserialization between frontend and database formats.
+ */
+export interface DataTransformer {
+    /**
+     * Transform entity data for storage in the database
+     */
+    serializeToDatabase<M extends Record<string, any>>(entity: M, collection: EntityCollection): Record<string, any>;
+    /**
+     * Transform database data back to entity format
+     */
+    deserializeFromDatabase<M extends Record<string, any>>(data: Record<string, any>, collection: EntityCollection): Promise<M>;
+}
+/**
+ * Configuration for creating a database backend
+ */
+export interface BackendConfig {
+    /**
+     * Type of database backend
+     */
+    type: string;
+    /**
+     * Database connection (implementation-specific)
+     */
+    connection: unknown;
+    /**
+     * Schema definition (implementation-specific, e.g., Drizzle schema for PostgreSQL)
+     */
+    schema?: unknown;
+}
+/**
+ * A complete backend instance with all required services
+ */
+export interface BackendInstance {
+    /**
+     * Entity repository for CRUD operations
+     */
+    entityRepository: EntityRepository;
+    /**
+     * Realtime provider for subscriptions
+     */
+    realtimeProvider: RealtimeProvider;
+    /**
+     * Collection registry
+     */
+    collectionRegistry: CollectionRegistryInterface;
+    /**
+     * The underlying database connection
+     */
+    connection: DatabaseConnection;
+}
+/**
+ * Factory function type for creating backend instances
+ */
+export type BackendFactory<TConfig extends BackendConfig = BackendConfig> = (config: TConfig) => BackendInstance;

package/dist/types/chips.d.ts

@@ -0,0 +1,5 @@
+export type ColorScheme = {
+    color: string;
+    text: string;
+};
+export type ColorKey = "blueLighter" | "cyanLighter" | "tealLighter" | "greenLighter" | "yellowLighter" | "orangeLighter" | "redLighter" | "pinkLighter" | "purpleLighter" | "grayLighter" | "blueLight" | "cyanLight" | "tealLight" | "greenLight" | "yellowLight" | "orangeLight" | "redLight" | "pinkLight" | "purpleLight" | "grayLight" | "blueDark" | "cyanDark" | "tealDark" | "greenDark" | "yellowDark" | "orangeDark" | "redDark" | "pinkDark" | "purpleDark" | "grayDark" | "blueDarker" | "cyanDarker" | "tealDarker" | "greenDarker" | "yellowDarker" | "orangeDarker" | "redDarker" | "pinkDarker" | "purpleDarker" | "grayDarker";