@rebasepro/types 0.8.0 → 0.9.0

package/dist/index.umd.js

@@ -2,9 +2,66 @@
 	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/errors.ts
+	/**
+	* The single error type thrown across the entire Rebase client surface —
+	* HTTP data/control-plane calls, realtime/WebSocket operations, and
+	* client-side logic errors (e.g. an unknown collection accessor). A `catch`
+	* block only ever needs to check for this one class:
+	*
+	* ```ts
+	* import { RebaseApiError } from "@rebasepro/client"; // re-exported
+	*
+	* try {
+	*   await client.data.products.update(id, { price: 9 });
+	* } catch (e) {
+	*   if (e instanceof RebaseApiError) {
+	*     if (e.status === 404) { ... }   // HTTP failures carry a status
+	*     console.error(e.code, e.details);
+	*   }
+	* }
+	* ```
+	*
+	* `status` is present for HTTP failures and `undefined` otherwise, so its
+	* presence distinguishes transport-level errors from realtime/logic errors.
+	*
+	* @group Errors
+	*/
+	var RebaseApiError = class extends Error {
+		/** HTTP status code, or `undefined` for non-HTTP errors. */
+		status;
+		/** Stable machine-readable error code, when the server supplied one. */
+		code;
+		/** Structured error payload from the server, when present. */
+		details;
+		constructor(message, init = {}) {
+			super(message);
+			this.name = "RebaseApiError";
+			this.status = init.status;
+			this.code = init.code;
+			this.details = init.details;
+			if (init.cause !== void 0) this.cause = init.cause;
+		}
+	};
+	/**
+	* Client-side logic error — raised before any request is made (e.g. accessing
+	* an unknown collection accessor when a typed dictionary is configured).
+	*
+	* A subclass of {@link RebaseApiError} (with no `status`), so a single
+	* `catch (e) { if (e instanceof RebaseApiError) ... }` handles it too.
+	*
+	* @group Errors
+	*/
+	var RebaseClientError = class extends RebaseApiError {
+		constructor(message) {
+			super(message);
+			this.name = "RebaseClientError";
+		}
+	};
+	//#endregion
 	//#region src/types/entities.ts
 	/**
-	* Class used to create a reference to an entity in a different path.
+	* Class used to create a reference to a entity in a different path.
 	*
 	* @example
 	* // Simple reference (most common case - single driver, single db)
@@ -38,7 +95,7 @@
 		*/
 		databaseId;
 		/**
-		* Create a reference to an entity.
+		* Create a reference to a entity.
 		*
 		* @example
 		* // Simple reference (most common case)
@@ -72,7 +129,7 @@
 		}
 	};
 	/**
-	* Class used to create a reference to an entity in a different path
+	* Class used to create a reference to a entity in a different path
 	*/
 	var EntityRelation = class {
 		__type = "relation";
@@ -138,7 +195,13 @@
 		"in": "in",
 		"not-in": "nin",
 		"array-contains": "cs",
-		"array-contains-any": "csa"
+		"array-contains-any": "csa",
+		"like": "like",
+		"ilike": "ilike",
+		"not-like": "nlike",
+		"not-ilike": "nilike",
+		"is-null": "isnull",
+		"is-not-null": "notnull"
 	};
 	/** Maps REST short-code operators to their canonical equivalents. */
 	var REST_TO_CANONICAL = {
@@ -151,10 +214,26 @@
 		"in": "in",
 		"nin": "not-in",
 		"cs": "array-contains",
-		"csa": "array-contains-any"
+		"csa": "array-contains-any",
+		"like": "like",
+		"ilike": "ilike",
+		"nlike": "not-like",
+		"nilike": "not-ilike",
+		"isnull": "is-null",
+		"notnull": "is-not-null"
 	};
-	/** All canonical operator strings for runtime validation. */
-	var CANONICAL_OPS = new Set([
+	/**
+	* Operators that test for null/not-null and therefore ignore their value.
+	* Codecs normalize the value of these conditions to `null`.
+	*/
+	var NULL_OPS = new Set(["is-null", "is-not-null"]);
+	/**
+	* Every canonical operator, in a stable order. Useful for engine capability
+	* declarations ({@link DataSourceCapabilities.filterOperators}) and for
+	* building operator subsets.
+	* @group Models
+	*/
+	var ALL_WHERE_FILTER_OPS = [
 		"<",
 		"<=",
 		"==",
@@ -164,8 +243,16 @@
 		"in",
 		"not-in",
 		"array-contains",
-		"array-contains-any"
-	]);
+		"array-contains-any",
+		"like",
+		"ilike",
+		"not-like",
+		"not-ilike",
+		"is-null",
+		"is-not-null"
+	];
+	/** All canonical operator strings for runtime validation. */
+	var CANONICAL_OPS = new Set(ALL_WHERE_FILTER_OPS);
 	/**
 	* Resolve any operator string (canonical or REST short-code) to its
 	* canonical `WhereFilterOp` form. Returns `undefined` for unknown operators.
@@ -187,21 +274,21 @@
 	* Returns true if the collection uses the Postgres engine (or the default engine).
 	* @group Models
 	*/
-	function isPostgresCollection(collection) {
+	function isPostgresCollectionConfig(collection) {
 		return !collection.engine || collection.engine === "postgres";
 	}
 	/**
 	* Type guard for Firebase / Firestore collections.
 	* @group Models
 	*/
-	function isFirebaseCollection(collection) {
+	function isFirebaseCollectionConfig(collection) {
 		return collection.engine === "firestore";
 	}
 	/**
 	* Type guard for MongoDB collections.
 	* @group Models
 	*/
-	function isMongoDBCollection(collection) {
+	function isMongoDBCollectionConfig(collection) {
 		return collection.engine === "mongodb";
 	}
 	/**
@@ -210,8 +297,8 @@
 	* otherwise falls back to `slug`.
 	*/
 	function getCollectionDataPath(collection) {
-		if (isFirebaseCollection(collection) && collection.path) return collection.path;
-		if (isMongoDBCollection(collection) && collection.path) return collection.path;
+		if (isFirebaseCollectionConfig(collection) && collection.path) return collection.path;
+		if (isMongoDBCollectionConfig(collection) && collection.path) return collection.path;
 		return collection.slug;
 	}
 	/**
@@ -260,6 +347,11 @@
 			roles
 		}),
 		authenticated: () => ({ kind: "authenticated" }),
+		existsIn: (args) => ({
+			kind: "existsIn",
+			collection: args.collection,
+			where: args.where
+		}),
 		raw: (sql) => ({
 			kind: "raw",
 			sql
@@ -268,6 +360,10 @@
 			kind: "field",
 			name
 		}),
+		outerField: (name) => ({
+			kind: "outerField",
+			name
+		}),
 		literal: (value) => ({
 			kind: "literal",
 			value
@@ -324,6 +420,7 @@
 		supportsReferences: false,
 		supportsColumnTypes: true,
 		supportsRealtime: true,
+		filterOperators: ALL_WHERE_FILTER_OPS,
 		supportsSQLAdmin: true,
 		supportsDocumentAdmin: false,
 		supportsSchemaAdmin: true
@@ -338,6 +435,7 @@
 		supportsReferences: true,
 		supportsColumnTypes: false,
 		supportsRealtime: true,
+		filterOperators: ALL_WHERE_FILTER_OPS.filter((op) => op !== "like" && op !== "ilike" && op !== "not-like" && op !== "not-ilike"),
 		supportsSQLAdmin: false,
 		supportsDocumentAdmin: false,
 		supportsSchemaAdmin: false
@@ -352,6 +450,7 @@
 		supportsReferences: true,
 		supportsColumnTypes: false,
 		supportsRealtime: false,
+		filterOperators: ALL_WHERE_FILTER_OPS,
 		supportsSQLAdmin: false,
 		supportsDocumentAdmin: true,
 		supportsSchemaAdmin: true
@@ -370,6 +469,7 @@
 		supportsReferences: true,
 		supportsColumnTypes: true,
 		supportsRealtime: true,
+		filterOperators: ALL_WHERE_FILTER_OPS,
 		supportsSQLAdmin: true,
 		supportsDocumentAdmin: true,
 		supportsSchemaAdmin: true
@@ -427,6 +527,34 @@
 		return typeof ref === "object" && ref !== null && "__rebaseLazy" in ref && ref.__rebaseLazy === true;
 	}
 	//#endregion
+	//#region src/controllers/storage.ts
+	/**
+	* Path prefix that marks an object as **public**. Files stored under this
+	* prefix are served without any auth token via a stable, permanent,
+	* CDN-cacheable URL (see {@link StorageSource.getSignedUrl}). Shared by the
+	* client SDK and the backend so both agree on which objects are public.
+	*
+	* @group Models
+	*/
+	var PUBLIC_STORAGE_PREFIX = "public/";
+	/**
+	* True when a storage key/path points at a public object (lives under
+	* {@link PUBLIC_STORAGE_PREFIX}). The check is applied to the key *within the
+	* bucket* — strip any `bucket/` and `scheme://` prefixes first.
+	*
+	* @group Models
+	*/
+	function isPublicStoragePath(path) {
+		if (!path) return false;
+		let p = path;
+		const scheme = p.indexOf("://");
+		if (scheme !== -1) p = p.substring(scheme + 3);
+		p = p.replace(/^\/+/, "");
+		if (p.split("/").some((seg) => seg === "..")) return false;
+		return p.startsWith("public/") || p.startsWith(`default/public/`);
+	}
+	//#endregion
+	exports.ALL_WHERE_FILTER_OPS = ALL_WHERE_FILTER_OPS;
 	exports.CANONICAL_TO_REST = CANONICAL_TO_REST;
 	exports.DEFAULT_CAPABILITIES = DEFAULT_CAPABILITIES;
 	exports.DEFAULT_DATA_SOURCE_KEY = DEFAULT_DATA_SOURCE_KEY;
@@ -436,18 +564,23 @@
 	exports.FIREBASE_CAPABILITIES = FIREBASE_CAPABILITIES;
 	exports.GeoPoint = GeoPoint;
 	exports.MONGODB_CAPABILITIES = MONGODB_CAPABILITIES;
+	exports.NULL_OPS = NULL_OPS;
 	exports.POSTGRES_CAPABILITIES = POSTGRES_CAPABILITIES;
+	exports.PUBLIC_STORAGE_PREFIX = PUBLIC_STORAGE_PREFIX;
 	exports.REST_TO_CANONICAL = REST_TO_CANONICAL;
+	exports.RebaseApiError = RebaseApiError;
+	exports.RebaseClientError = RebaseClientError;
 	exports.Vector = Vector;
 	exports.getCollectionDataPath = getCollectionDataPath;
 	exports.getDataSourceCapabilities = getDataSourceCapabilities;
 	exports.getDeclaredSubcollections = getDeclaredSubcollections;
 	exports.isBranchAdmin = isBranchAdmin;
 	exports.isDocumentAdmin = isDocumentAdmin;
-	exports.isFirebaseCollection = isFirebaseCollection;
+	exports.isFirebaseCollectionConfig = isFirebaseCollectionConfig;
 	exports.isLazyComponentRef = isLazyComponentRef;
-	exports.isMongoDBCollection = isMongoDBCollection;
-	exports.isPostgresCollection = isPostgresCollection;
+	exports.isMongoDBCollectionConfig = isMongoDBCollectionConfig;
+	exports.isPostgresCollectionConfig = isPostgresCollectionConfig;
+	exports.isPublicStoragePath = isPublicStoragePath;
 	exports.isSQLAdmin = isSQLAdmin;
 	exports.isSchemaAdmin = isSchemaAdmin;
 	exports.policy = policy;