@rebasepro/types 0.5.0 → 0.6.0

package/dist/index.umd.js

@@ -1,226 +1,296 @@
 (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 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;
-    }
-  }
-  function isPostgresCollection(collection) {
-    return !collection.driver || collection.driver === "postgres";
-  }
-  function isFirebaseCollection(collection) {
-    return collection.driver === "firestore";
-  }
-  function isMongoDBCollection(collection) {
-    return collection.driver === "mongodb";
-  }
-  function isSQLAdmin(admin) {
-    return !!admin && typeof admin.executeSql === "function";
-  }
-  function isDocumentAdmin(admin) {
-    return !!admin && (typeof admin.executeAggregate === "function" || typeof admin.fetchCollectionStats === "function");
-  }
-  function isSchemaAdmin(admin) {
-    return !!admin && (typeof admin.fetchUnmappedTables === "function" || typeof admin.fetchTableMetadata === "function");
-  }
-  function isBranchAdmin(admin) {
-    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
-  };
-  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
-  };
-  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
-  };
-  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
-  };
-  const CAPABILITIES_REGISTRY = {
-    postgres: POSTGRES_CAPABILITIES,
-    firestore: FIREBASE_CAPABILITIES,
-    mongodb: MONGODB_CAPABILITIES,
-    "(default)": DEFAULT_CAPABILITIES
-  };
-  function getDataSourceCapabilities(driver) {
-    if (!driver) return POSTGRES_CAPABILITIES;
-    return CAPABILITIES_REGISTRY[driver] ?? DEFAULT_CAPABILITIES;
-  }
-  function registerDataSourceCapabilities(capabilities) {
-    CAPABILITIES_REGISTRY[capabilities.key] = capabilities;
-  }
-  function isLazyComponentRef(ref) {
-    return typeof ref === "object" && ref !== null && "__rebaseLazy" in ref && ref.__rebaseLazy === true;
-  }
-  exports2.DEFAULT_CAPABILITIES = DEFAULT_CAPABILITIES;
-  exports2.EntityReference = EntityReference;
-  exports2.EntityRelation = EntityRelation;
-  exports2.FIREBASE_CAPABILITIES = FIREBASE_CAPABILITIES;
-  exports2.GeoPoint = GeoPoint;
-  exports2.MONGODB_CAPABILITIES = MONGODB_CAPABILITIES;
-  exports2.POSTGRES_CAPABILITIES = POSTGRES_CAPABILITIES;
-  exports2.Vector = Vector;
-  exports2.getDataSourceCapabilities = getDataSourceCapabilities;
-  exports2.isBranchAdmin = isBranchAdmin;
-  exports2.isDocumentAdmin = isDocumentAdmin;
-  exports2.isFirebaseCollection = isFirebaseCollection;
-  exports2.isLazyComponentRef = isLazyComponentRef;
-  exports2.isMongoDBCollection = isMongoDBCollection;
-  exports2.isPostgresCollection = isPostgresCollection;
-  exports2.isSQLAdmin = isSQLAdmin;
-  exports2.isSchemaAdmin = isSchemaAdmin;
-  exports2.registerDataSourceCapabilities = registerDataSourceCapabilities;
-  Object.defineProperty(exports2, Symbol.toStringTag, { value: "Module" });
+	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/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";
+	}
+	/**
+	* Type guard for Firebase / Firestore collections.
+	* @group Models
+	*/
+	function isFirebaseCollection(collection) {
+		return collection.driver === "firestore";
+	}
+	/**
+	* Type guard for MongoDB collections.
+	* @group Models
+	*/
+	function isMongoDBCollection(collection) {
+		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";
+	}
+	/**
+	* 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
+	/** @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 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;
+	}
+	/**
+	* Register custom capabilities for a third-party driver.
+	* @group Models
+	*/
+	function registerDataSourceCapabilities(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;
+	}
+	//#endregion
+	exports.DEFAULT_CAPABILITIES = DEFAULT_CAPABILITIES;
+	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.Vector = Vector;
+	exports.getDataSourceCapabilities = getDataSourceCapabilities;
+	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.registerDataSourceCapabilities = registerDataSourceCapabilities;
 });
-//# sourceMappingURL=index.umd.js.map
+
+//# sourceMappingURL=index.umd.js.map