@rebasepro/types 0.21.0 → 0.21.1

package/README.md

@@ -9,31 +9,31 @@ pnpm add @rebasepro/types
 ```
 
 ESM-only: `"type": "module"` with no CommonJS build, so it is loaded with
-`import`. `require()` of it resolves only on Node 22.12+, which supports
-`require(esm)`.
+`import`. It needs Node `>=22.22.0` (its `engines` floor), where `require()`
+of it resolves too: Node has supported `require(esm)` since 22.12.
 
 ## What This Package Does
 
-Provides the canonical type definitions used across all Rebase packages — both client-side and server-side. This is a **types-only** package with no runtime dependencies. Every other `@rebasepro/*` package depends on it.
+Provides the canonical type definitions used across all Rebase packages — both client-side and server-side. It has no runtime dependencies, but it is not types-only: it also exports the constants and small runtime helpers those packages share (`ADMIN_PROPERTY_KEYS`, `GeoPoint`, `declaredDataSources`, …). Every other `@rebasepro/*` package depends on it.
 
 ## Key Exports
 
-### Collection & Snapshot Types
+### Collection & Entity Types
 
 | Export | Description |
 |--------|-------------|
 | `CollectionConfig` | Full collection definition (name, slug, properties, callbacks, security rules, views) |
 | `Property` | Union type for all property configurations (text, number, date, reference, array, map, etc.) |
-| `Snapshot` | Generic snapshot record type |
-| `CollectionCallbacks` | Lifecycle hooks (`onPreSave`, `onSaveSuccess`, `onDelete`, etc.) |
-| `SnapshotValues` | Record of property values for a snapshot |
+| `Entity` | Generic entity record type |
+| `CollectionCallbacks` | Lifecycle hooks (`afterRead`, `beforeSave`, `afterSave`, `afterSaveError`, `beforeDelete`, `afterDelete`) |
+| `EntityValues` | Record of property values for an entity |
 | `SecurityRule` | RLS-style access control rule for a collection |
 
 ### Backend & Driver Interfaces
 
 | Export | Description |
 |--------|-------------|
-| `DataDriver` | Abstract interface for database drivers (`fetchCollection`, `saveSnapshot`, `deleteSnapshot`, etc.) |
+| `DataDriver` | Abstract interface for database drivers (`fetchCollection`, `fetchOne`, `save`, `delete`, etc.) |
 | `DatabaseAdapter` | Pluggable database adapter interface (used by `server`) |
 | `BackendBootstrapper` | Lifecycle interface for initializing database drivers, auth, history, and realtime |
 | `DatabaseAdmin` | Admin operations interface (SQL execution, collection stats, table metadata) |
@@ -48,29 +48,26 @@ Provides the canonical type definitions used across all Rebase packages — both
 | Export | Description |
 |--------|-------------|
 | `AuthAdapter` | Pluggable auth adapter interface (for Clerk, Auth0, custom auth) |
-| `AuthController` | Client-side auth controller interface |
-| `RebaseUser` | User record type |
-| `Role` | Role definition type |
+| `User` | User record type |
 
 ### Controller Interfaces
 
 | Export | Description |
 |--------|-------------|
 | `RebaseClient` | Top-level client interface (data, auth, storage, email) |
-| `DataSourceDelegate` | Data operations interface for client-side data sources |
+| `RebaseServerClient` | The server-side `rebase` singleton: `RebaseClient` without `data`, plus `dataAsAdmin` |
 | `StorageSource` | File storage interface |
 | `CollectionRegistryInterface` | Collection lookup and registration |
-| `NavigationController` | App navigation interface |
 
 ### Other
 
 | Export | Description |
 |--------|-------------|
 | `CronJobDefinition` | Cron job configuration type |
-| `CollectionCallbacks` | Lifecycle callbacks for snapshot CRUD operations |
-| `PluginConfig` | Plugin system types |
+| `CollectionCallbacks` | Lifecycle callbacks for entity CRUD operations |
 | `WebSocketMessage` | WebSocket protocol message types |
-| `Locale` | Localization types |
+
+The admin panel's own types — `AuthController`, the plugin type `RebasePlugin`, `Locale` — live in `@rebasepro/cms-types`.
 
 ## Quick Start
 
@@ -79,7 +76,7 @@ import type {
   CollectionConfig,
   DataDriver,
   DatabaseAdapter,
-  RebaseUser,
+  User,
   Property,
 } from "@rebasepro/types";
 ```
@@ -93,5 +90,5 @@ Every `@rebasepro/*` package depends on this one. Key consumers:
 | `@rebasepro/server` | `DataDriver`, `DatabaseAdapter`, `BackendBootstrapper`, `AuthAdapter` |
 | `@rebasepro/server-postgres` | `BackendBootstrapper`, `InitializedDriver`, `RealtimeProvider` |
 | `@rebasepro/server-mongo` | `BackendBootstrapper`, `DataDriver`, `CollectionConfig` |
-| `@rebasepro/client` | `RebaseClient`, `DataSourceDelegate`, `StorageSource` |
-| `@rebasepro/cms` | `CollectionConfig`, `Property`, `PluginConfig`, controller interfaces |
+| `@rebasepro/client` | `RebaseClient`, `StorageSource` |
+| `@rebasepro/cms` | `CollectionConfig`, `Property`, controller interfaces |

package/dist/controllers/data_driver.d.ts

@@ -251,10 +251,19 @@ export interface UpdateManyProps<M extends Record<string, unknown> = Record<stri
  * @internal
  */
 export interface DeleteProps<M extends Record<string, unknown> = Record<string, unknown>> {
+    /**
+     * The row's address, and nothing about its contents.
+     *
+     * The driver reads the row itself, under the caller's own scope, and that
+     * read is what `beforeDelete` and `afterDelete` receive and what history
+     * records. This used to carry `values`, and the driver took them as the
+     * row — so over the WebSocket, which forwarded the client's frame, the
+     * caller wrote the audit record of their own deletion and could get past a
+     * `beforeDelete` that refused on a column by sending `values: {}`.
+     */
     row: {
         id: string | number;
         path: string;
-        values?: Partial<EntityValues<M>>;
     };
     collection?: CollectionConfig<M>;
     /**

package/dist/index.es.js

@@ -1906,6 +1906,60 @@ function declaredStorageSources() {
 	return declaredResources("bucket").map(resourceToStorageSource);
 }
 //#endregion
+//#region src/types/env_boolean.ts
+var YES = /* @__PURE__ */ new Set([
+	"true",
+	"1",
+	"yes",
+	"on"
+]);
+var NO = /* @__PURE__ */ new Set([
+	"false",
+	"0",
+	"no",
+	"off"
+]);
+/**
+* Read a boolean environment variable — one spelling rule for every reader.
+*
+* `true`, `1`, `yes` and `on` are true; `false`, `0`, `no` and `off` are
+* false. Case and surrounding whitespace are ignored. Anything else — unset,
+* blank, or a value that spells neither — is `undefined`, so the caller's
+* default decides and a typo lands on the side the caller chose:
+*
+* ```ts
+* parseEnvBoolean(env.FORCE_LOCAL_STORAGE) === true            // off unless said
+* parseEnvBoolean(env.REBASE_MCP_OPEN_REGISTRATION) !== false  // on unless said
+* ```
+*
+* It exists because every reader used to spell this itself, and they
+* disagreed. The reader that mattered tested the raw string for truthiness —
+* `!process.env.FORCE_LOCAL_STORAGE` — and every non-empty string is truthy,
+* so `FORCE_LOCAL_STORAGE=false`, written to say "there is no durable volume
+* here", switched the production storage guard off and sent uploads to a
+* container filesystem the next redeploy erased. Beside it, `=== "true"` made
+* `DISABLE_DB_ROLE_SWITCHING=1` do nothing and `!== "false"` made
+* `REBASE_MCP_OPEN_REGISTRATION=0` leave registration open.
+*
+* The boot schemas in `@rebasepro/server` (`loadEnv`, `loadBootEnv`) accept a
+* strict subset — `true`, `false` and blank — and refuse any other value
+* before the server starts. On that subset they read exactly what this reads,
+* so a variable a schema declares and something else reads lazily cannot mean
+* two different things.
+*
+* It lives in this package, with no dependencies, for the reason
+* {@link storageEnvSuffix} does: the runtime, its drivers and the CLI all read
+* these variables, and a second parser is a second chance to disagree.
+*
+* @group Models
+*/
+function parseEnvBoolean(value) {
+	if (value === void 0) return void 0;
+	const spelled = value.trim().toLowerCase();
+	if (YES.has(spelled)) return true;
+	if (NO.has(spelled)) return false;
+}
+//#endregion
 //#region src/types/component_ref.ts
 /**
 * Type guard: checks if a value is a `LazyComponentRef` produced by the
@@ -2418,6 +2472,6 @@ function isPublicStoragePath(path) {
 	return p.startsWith("public/") || p.startsWith(`default/public/`);
 }
 //#endregion
-export { ADMIN_COLLECTION_KEYS, ADMIN_PROPERTY_KEYS, ALL_WHERE_FILTER_OPS, ANONYMOUS_USER_ID, ANONYMOUS_USER_IDS, BATCH_REF_KEY, BUNDLE_FORMAT_VERSION, CANONICAL_TO_REST, DEFAULT_CAPABILITIES, DEFAULT_COMMIT_PATHS, DEFAULT_DATA_SOURCE_KEY, DEFAULT_FILTERABLE_RELATION_KINDS, DEFAULT_FUZZY_THRESHOLD, DEFAULT_LIST_LIMIT, DEFAULT_RESOURCE_KEY, DEFAULT_SEARCH_COLUMN, DEFAULT_SEARCH_LANGUAGE, DEFAULT_SEARCH_WEIGHT, DEFAULT_STORAGE_SOURCE_KEY, DEFAULT_TENANT_BYPASS_ROLES, DEFAULT_VECTOR_LIST_LIMIT, EntityReference, EntityRelation, FIELD_OPERATORS, FIREBASE_CAPABILITIES, GeoPoint, JUNCTION_PIVOT_KEY, LEGACY_RLS_JWT_SQL, LEGACY_RLS_ROLES_SQL, LEGACY_RLS_SCHEMA, LEGACY_RLS_UID_SQL, LIST_OPS, ListLimitError, MAX_INCLUDE_DEPTH, MAX_LIST_LIMIT, MONGODB_CAPABILITIES, NULL_OPS, POSTGRES_CAPABILITIES, PUBLIC_STORAGE_PREFIX, REBASE_SCHEMA, RELEVANCE_SORT_FIELD, RESERVED_BACKEND_PREFIXES, RESOURCE_GRAPH_VERSION, REST_TO_CANONICAL, RLS_IS_ANONYMOUS_SQL, RLS_JWT_SQL, RLS_ROLES_SQL, RLS_UID_SQL, RUNTIME_CONTRACT_VERSION, RebaseApiError, RebaseClientError, SCHEMA_VERSION_HEADER, Vector, amendResourceKind, bucket, buildResourceGraph, canonicalSchemaPayload, computeSchemaVersion, database, declareCron, declareFunction, declareResource, declaredDataSources, declaredDatabaseExtensions, declaredQueueConsumers, declaredResources, declaredStorageSources, declaredSubscriptions, deserializeCollections, encodeRelationAggregateSort, envBasesForResource, findEnvSuffixCollision, findStorageSuffixCollision, getCollectionDataPath, getDataSourceCapabilities, getDeclaredSubcollections, hasFieldOperation, hasForeignKeyOnTarget, isAnonymousUid, isBranchAdmin, isChannelBusInstance, isDocumentAdmin, isFieldOperation, isFirebaseCollectionConfig, isLazyComponentRef, isManyToMany, isMongoDBCollectionConfig, isPostgresCollectionConfig, isPublicStoragePath, isRelationAggregateSort, isRelationalCollectionConfig, isResourceHandle, isSQLAdmin, isSchemaAdmin, isSchemaEditingAdmin, isSerializedCollectionRef, isTenantClaimSource, isTenantMembershipSource, isToMany, isUnsupported, isValidEngine, nestAdminCollectionKeys, nestAdminKeysOf, nestAdminPropertyKeys, parseRelationAggregateSort, policy, queue, registerDataSourceCapabilities, registerResourceKind, reservedPrefixFor, resetDeclaredQueueConsumers, resetDeclaredResources, resetDeclaredSubscriptions, resolveClientListLimit, resolveResourceRefs, resourceEnvSuffix, resourceId, resourceKeyOf, resourceKind, resourceKinds, resourceToDataSource, resourceToStorageSource, rewriteLegacyRlsFunctions, serializeCollections, setQueueRuntime, setTopicRuntime, sortKeyToString, storageEnvSuffix, toCanonicalOp, topic, unsupportedMethod, usesLegacyRlsFunctions };
+export { ADMIN_COLLECTION_KEYS, ADMIN_PROPERTY_KEYS, ALL_WHERE_FILTER_OPS, ANONYMOUS_USER_ID, ANONYMOUS_USER_IDS, BATCH_REF_KEY, BUNDLE_FORMAT_VERSION, CANONICAL_TO_REST, DEFAULT_CAPABILITIES, DEFAULT_COMMIT_PATHS, DEFAULT_DATA_SOURCE_KEY, DEFAULT_FILTERABLE_RELATION_KINDS, DEFAULT_FUZZY_THRESHOLD, DEFAULT_LIST_LIMIT, DEFAULT_RESOURCE_KEY, DEFAULT_SEARCH_COLUMN, DEFAULT_SEARCH_LANGUAGE, DEFAULT_SEARCH_WEIGHT, DEFAULT_STORAGE_SOURCE_KEY, DEFAULT_TENANT_BYPASS_ROLES, DEFAULT_VECTOR_LIST_LIMIT, EntityReference, EntityRelation, FIELD_OPERATORS, FIREBASE_CAPABILITIES, GeoPoint, JUNCTION_PIVOT_KEY, LEGACY_RLS_JWT_SQL, LEGACY_RLS_ROLES_SQL, LEGACY_RLS_SCHEMA, LEGACY_RLS_UID_SQL, LIST_OPS, ListLimitError, MAX_INCLUDE_DEPTH, MAX_LIST_LIMIT, MONGODB_CAPABILITIES, NULL_OPS, POSTGRES_CAPABILITIES, PUBLIC_STORAGE_PREFIX, REBASE_SCHEMA, RELEVANCE_SORT_FIELD, RESERVED_BACKEND_PREFIXES, RESOURCE_GRAPH_VERSION, REST_TO_CANONICAL, RLS_IS_ANONYMOUS_SQL, RLS_JWT_SQL, RLS_ROLES_SQL, RLS_UID_SQL, RUNTIME_CONTRACT_VERSION, RebaseApiError, RebaseClientError, SCHEMA_VERSION_HEADER, Vector, amendResourceKind, bucket, buildResourceGraph, canonicalSchemaPayload, computeSchemaVersion, database, declareCron, declareFunction, declareResource, declaredDataSources, declaredDatabaseExtensions, declaredQueueConsumers, declaredResources, declaredStorageSources, declaredSubscriptions, deserializeCollections, encodeRelationAggregateSort, envBasesForResource, findEnvSuffixCollision, findStorageSuffixCollision, getCollectionDataPath, getDataSourceCapabilities, getDeclaredSubcollections, hasFieldOperation, hasForeignKeyOnTarget, isAnonymousUid, isBranchAdmin, isChannelBusInstance, isDocumentAdmin, isFieldOperation, isFirebaseCollectionConfig, isLazyComponentRef, isManyToMany, isMongoDBCollectionConfig, isPostgresCollectionConfig, isPublicStoragePath, isRelationAggregateSort, isRelationalCollectionConfig, isResourceHandle, isSQLAdmin, isSchemaAdmin, isSchemaEditingAdmin, isSerializedCollectionRef, isTenantClaimSource, isTenantMembershipSource, isToMany, isUnsupported, isValidEngine, nestAdminCollectionKeys, nestAdminKeysOf, nestAdminPropertyKeys, parseEnvBoolean, parseRelationAggregateSort, policy, queue, registerDataSourceCapabilities, registerResourceKind, reservedPrefixFor, resetDeclaredQueueConsumers, resetDeclaredResources, resetDeclaredSubscriptions, resolveClientListLimit, resolveResourceRefs, resourceEnvSuffix, resourceId, resourceKeyOf, resourceKind, resourceKinds, resourceToDataSource, resourceToStorageSource, rewriteLegacyRlsFunctions, serializeCollections, setQueueRuntime, setTopicRuntime, sortKeyToString, storageEnvSuffix, toCanonicalOp, topic, unsupportedMethod, usesLegacyRlsFunctions };
 
 //# sourceMappingURL=index.es.js.map