@rebasepro/types 0.6.1 → 0.8.0

package/dist/index.umd.js

@@ -126,30 +126,156 @@
 		}
 	};
 	//#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 driver (or the default driver).
+	* Returns true if the collection uses the Postgres engine (or the default engine).
 	* @group Models
 	*/
 	function isPostgresCollection(collection) {
-		return !collection.driver || collection.driver === "postgres";
+		return !collection.engine || collection.engine === "postgres";
 	}
 	/**
 	* Type guard for Firebase / Firestore collections.
 	* @group Models
 	*/
 	function isFirebaseCollection(collection) {
-		return collection.driver === "firestore";
+		return collection.engine === "firestore";
 	}
 	/**
 	* Type guard for MongoDB collections.
 	* @group Models
 	*/
 	function isMongoDBCollection(collection) {
-		return collection.driver === "mongodb";
+		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?
@@ -181,6 +307,13 @@
 	}
 	//#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",
@@ -248,13 +381,13 @@
 		"(default)": DEFAULT_CAPABILITIES
 	};
 	/**
-	* Look up capabilities for a given driver key.
-	* If `driver` is undefined or not found, returns `DEFAULT_CAPABILITIES`.
+	* Look up capabilities for a given engine key.
+	* If `engine` is undefined or not found, returns `DEFAULT_CAPABILITIES`.
 	* @group Models
 	*/
-	function getDataSourceCapabilities(driver) {
-		if (!driver) return POSTGRES_CAPABILITIES;
-		return CAPABILITIES_REGISTRY[driver] ?? DEFAULT_CAPABILITIES;
+	function getDataSourceCapabilities(engine) {
+		if (!engine) return POSTGRES_CAPABILITIES;
+		return CAPABILITIES_REGISTRY[engine] ?? DEFAULT_CAPABILITIES;
 	}
 	/**
 	* Register custom capabilities for a third-party driver.
@@ -264,6 +397,27 @@
 		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
@@ -273,15 +427,21 @@
 		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;
@@ -290,7 +450,9 @@
 	exports.isPostgresCollection = isPostgresCollection;
 	exports.isSQLAdmin = isSQLAdmin;
 	exports.isSchemaAdmin = isSchemaAdmin;
+	exports.policy = policy;
 	exports.registerDataSourceCapabilities = registerDataSourceCapabilities;
+	exports.toCanonicalOp = toCanonicalOp;
 });
 
 //# sourceMappingURL=index.umd.js.map