@rebasepro/types 0.10.0 → 0.10.1-canary.0a881d4

package/src/types/properties.ts

@@ -4,7 +4,7 @@ import type { Entity, EntityReference, EntityRelation, EntityValues, GeoPoint, V
 import type { JoinStep, OnAction, Relation } from "./relations";
 import type { CollectionConfig, FilterValues, WhereFilterOp } from "./collections";
 import type { ColorKey, ColorScheme } from "./chips";
-import type { AuthController } from "../controllers/auth";
+import type { AuthState } from "../controllers/auth_state";
 import type { AfterReadProps, BeforeSaveProps } from "./entity_callbacks";
 import type { User } from "../users";
 
@@ -151,50 +151,7 @@ export type InferEntityType<P extends Properties> = {
     -readonly [K in OptionalPropertyKeys<P>]?: InferPropertyType<P[K]>;
 };
 
-/**
- * Interface including all common properties of a CMS property.
- * @group Entity properties
- */
-export interface BaseUIConfig<CustomProps = unknown> {
-    columnWidth?: number;
-    hideFromCollection?: boolean;
-    readOnly?: boolean;
-    disabled?: boolean | PropertyDisabledConfig;
-    widthPercentage?: number;
-    customProps?: CustomProps;
-    Field?: ComponentRef<any>;
-    Preview?: ComponentRef<any>;
-
-    /**
-     * Narrow the filter operators offered for this property in collection
-     * filter UIs (table header filters and the Filters dialog).
-     *
-     * The final offered set is the **intersection** of the engine's
-     * capabilities, the property-type defaults, and this list — you can only
-     * *restrict*, never enable an operator the underlying engine cannot run.
-     *
-     * Pass an empty array to disable filtering on this property entirely.
-     *
-     * @example
-     * // Email column: exact match, contains, and null check only
-     * ui: { filterOperators: ["==", "ilike", "is-null"] }
-     */
-    filterOperators?: readonly WhereFilterOp[];
-
-    /**
-     * Replace the filter field rendered for this property in collection
-     * filter UIs. The component receives `FilterFieldBindingProps`
-     * (property, resolved `operators`, `value`, `setValue`, …).
-     *
-     * Takes precedence over the collection-level
-     * `components["Collection.FilterField"]` override and the built-in
-     * per-type filter fields.
-     */
-    Filter?: ComponentRef<any>;
-}
-
 export interface BaseProperty<CustomProps = unknown> {
-    ui?: BaseUIConfig<CustomProps>;
     /**
      * Property name (e.g. Product)
      */
@@ -285,36 +242,7 @@ export interface BaseProperty<CustomProps = unknown> {
 
 }
 
-/**
- * @group Entity properties
- */
-export interface StringUIConfig extends BaseUIConfig {
-    /**
-     * Is this string property long enough so it should be displayed in
-     * a multiple line field. Defaults to false. If set to true,
-     * the number of lines adapts to the content
-     */
-    multiline?: boolean;
-    /**
-     * Should this string property be displayed as a markdown field. If true,
-     * the field is rendered as a text editor that supports markdown highlight
-     * syntax. It also includes a preview of the result.
-     */
-    markdown?: boolean;
-    /**
-     * Should this string be rendered as a tag instead of just text.
-     */
-    previewAsTag?: boolean;
-    clearable?: boolean;
-    /**
-     * If the value of this property is a URL, you can set this flag to true
-     * to add a link, or one of the supported media types to render a preview
-     */
-    url?: boolean | PreviewType;
-}
-
 export interface StringProperty extends BaseProperty {
-    ui?: StringUIConfig;
     type: "string";
     /**
      * Default value for new entities. Must be a string.
@@ -374,17 +302,19 @@ export interface StringProperty extends BaseProperty {
      * Does this field include an email
      */
     email?: boolean;
-}
 
-/**
- * @group Entity properties
- */
-export interface NumberUIConfig extends BaseUIConfig {
-    clearable?: boolean;
+    /**
+     * Does this string hold a URL?
+     *
+     * A statement about the *data*, which is why it sits here beside `email`
+     * rather than in the admin block: the OpenAPI generator turns it into
+     * `format: "uri"`, so it is part of the published API contract. How the panel
+     * renders it — as a link, an image, a video — is `admin.urlPreview`.
+     */
+    url?: boolean;
 }
 
 export interface NumberProperty extends BaseProperty {
-    ui?: NumberUIConfig;
     type: "number";
     /**
      * Default value for new entities. Must be a number.
@@ -423,7 +353,6 @@ export interface NumberProperty extends BaseProperty {
  * @group Entity properties
  */
 export interface BooleanProperty extends BaseProperty {
-    ui?: BaseUIConfig;
     type: "boolean";
     /**
      * Default value for new entities. Must be a boolean.
@@ -435,15 +364,7 @@ export interface BooleanProperty extends BaseProperty {
     validation?: PropertyValidationSchema;
 }
 
-/**
- * @group Entity properties
- */
-export interface VectorUIConfig extends BaseUIConfig {
-    clearable?: boolean;
-}
-
 export interface VectorProperty extends BaseProperty {
-    ui?: VectorUIConfig;
     type: "vector";
     /**
      * Default value for new entities.
@@ -465,18 +386,7 @@ export interface BinaryProperty extends BaseProperty {
     validation?: PropertyValidationSchema;
 }
 
-/**
- * @group Entity properties
- */
-export interface DateUIConfig extends BaseUIConfig {
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
-}
-
 export interface DateProperty extends BaseProperty {
-    ui?: DateUIConfig;
     type: "date";
     /**
      * Default value for new entities. Must be a Date.
@@ -513,7 +423,6 @@ export interface DateProperty extends BaseProperty {
  * @group Entity properties
  */
 export interface GeopointProperty extends BaseProperty {
-    ui?: BaseUIConfig;
     type: "geopoint";
     /**
      * Default value for new entities. Must be a GeoPoint.
@@ -525,13 +434,6 @@ export interface GeopointProperty extends BaseProperty {
     validation?: PropertyValidationSchema;
 }
 
-/**
- * @group Entity properties
- */
-export interface ReferenceUIConfig extends BaseUIConfig {
-    previewProperties?: string[];
-}
-
 /**
  * A pointer to a entity, stored **as a value** on the row (id + path, and
  * optionally a `driver`/`databaseId` for cross-datasource pointers).
@@ -549,7 +451,6 @@ export interface ReferenceUIConfig extends BaseUIConfig {
  * @group Entity properties
  */
 export interface ReferenceProperty extends BaseProperty {
-    ui?: ReferenceUIConfig;
     type: "reference";
     /**
      * Default value for new entities. Must be a EntityReference.
@@ -588,14 +489,6 @@ export interface ReferenceProperty extends BaseProperty {
     includeEntityLink?: boolean;
 }
 
-/**
- * @group Entity properties
- */
-export interface RelationUIConfig extends BaseUIConfig {
-    previewProperties?: string[];
-    widget?: "select" | "dialog";
-}
-
 /**
  * A schema-level relationship between collections **within a single
  * datasource** — backed by a foreign key, junction table, or explicit join
@@ -613,7 +506,6 @@ export interface RelationUIConfig extends BaseUIConfig {
  * @group Entity properties
  */
 export interface RelationProperty extends BaseProperty {
-    ui?: RelationUIConfig;
     type: "relation";
     /**
      * Default value for new entities. Must be a EntityRelation or array of EntityRelation.
@@ -747,16 +639,7 @@ export interface RelationProperty extends BaseProperty {
     widget?: "select" | "dialog";
 }
 
-/**
- * @group Entity properties
- */
-export interface ArrayUIConfig extends BaseUIConfig {
-    expanded?: boolean;
-    minimalistView?: boolean;
-}
-
 export interface ArrayProperty extends BaseProperty {
-    ui?: ArrayUIConfig;
     type: "array";
     /**
      * Default value for new entities. Must be an array.
@@ -830,17 +713,7 @@ export interface ArrayProperty extends BaseProperty {
     canAddElements?: boolean;
 }
 
-/**
- * @group Entity properties
- */
-export interface MapUIConfig extends BaseUIConfig {
-    expanded?: boolean;
-    minimalistView?: boolean;
-    spreadChildren?: boolean;
-}
-
 export interface MapProperty extends BaseProperty {
-    ui?: MapUIConfig;
     type: "map";
     /**
      * Default value for new entities. Must be a record/object.
@@ -887,34 +760,9 @@ export type PropertyBuilderProps<M extends Record<string, unknown> = Record<stri
     index?: number;
     path: string;
     entityId?: string | number;
-    authController: AuthController;
+    authController: AuthState;
 };
 
-/**
- * @group Entity properties
- */
-export interface PropertyDisabledConfig {
-    /**
-     * Enable this flag if you would like to clear the value of the field
-     * when the corresponding property gets disabled.
-     *
-     * This is useful for keeping data consistency when you have conditional
-     * properties.
-     */
-    clearOnDisabled?: boolean;
-
-    /**
-     * Explanation of why this property is disabled (e.g. a different field
-     * needs to be enabled)
-     */
-    disabledMessage?: string;
-
-    /**
-     * Set this flag to true if you want to hide this field when disabled
-     */
-    hidden?: boolean;
-}
-
 /**
  * We use this type to define mapping between string or number values in
  * the data source to a label (such in a select dropdown).
@@ -1195,12 +1043,6 @@ export interface UploadedFileContext {
     storage: StorageConfig;
 }
 
-/**
- * Used for previewing urls if the download file is known
- * @group Entity properties
- */
-export type PreviewType = "image" | "video" | "audio" | "file";
-
 /**
  * MIME types for storage fields
  * @see https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types/Common_types

package/src/types/schema_version.ts

@@ -0,0 +1,112 @@
+import type { CollectionConfig } from "./collections";
+import { serializeCollections } from "./collection_contract";
+
+/**
+ * The schema version stamp.
+ *
+ * One function, used in three places that must agree or the whole drift-detection
+ * story is noise: `rebase build` writes it into a bundle manifest, the runtime
+ * serves it from the contract endpoint, and a generated SDK records the value it
+ * was built from. If any two of those computed it differently, every client would
+ * look permanently out of date.
+ *
+ * It covers **collections only** — the client's contract is the shape of the
+ * data, so editing a hook or a server function must not invalidate every SDK in
+ * every repository. That is a deliberate narrowing, not an oversight.
+ */
+
+/** Stable stringify: object keys sorted at every level, so key order cannot alter the hash. */
+function canonicalize(value: unknown): string {
+    if (value === null || typeof value !== "object") {
+        return JSON.stringify(value) ?? "null";
+    }
+    if (Array.isArray(value)) {
+        return `[${value.map(canonicalize).join(",")}]`;
+    }
+    const entries = Object.entries(value as Record<string, unknown>)
+        .filter(([, v]) => v !== undefined)
+        .sort(([a], [b]) => (a < b ? -1 : a > b ? 1 : 0));
+    return `{${entries.map(([k, v]) => `${JSON.stringify(k)}:${canonicalize(v)}`).join(",")}}`;
+}
+
+/**
+ * Reduce a collection to the parts a generated client is actually built from.
+ *
+ * The version answers one question — "is this SDK stale?" — so it must change
+ * exactly when the generated types could change, and never otherwise. Hashing a
+ * whole collection fails both halves of that:
+ *
+ * - Security rules, callbacks, icons, groups and UI settings do not appear in a
+ *   generated client, so including them reports perfectly current SDKs as stale.
+ * - Worse, they are not stable *inputs*. The runtime applies default security
+ *   rules when it loads collections, so the same source hashed before and after
+ *   loading produced two different answers — a build-time stamp that could never
+ *   match the server that served it.
+ *
+ * Codegen reads the slug (for the `Database` key and type names), the properties,
+ * and the relations. That is the projection.
+ */
+function projectForCodegen(collection: CollectionConfig): Record<string, unknown> {
+    const source = collection as CollectionConfig & {
+        relations?: unknown;
+        subcollections?: CollectionConfig[];
+        path?: string;
+        engine?: unknown;
+        dataSource?: unknown;
+    };
+
+    return {
+        slug: collection.slug ?? source.path,
+        properties: collection.properties,
+        relations: source.relations,
+        // The engine decides whether relations are resolved at all: codegen asks
+        // `getDataSourceCapabilities(collection.engine).supportsRelations`, and an
+        // engine that answers no drops every foreign-key column from the
+        // generated Row/Insert/Update types. Moving a collection to such an
+        // engine is a real change to the generated types, so it has to move the
+        // version. `dataSource` is what resolves to `engine`, so it counts too.
+        engine: source.engine,
+        dataSource: source.dataSource,
+        subcollections: source.subcollections?.map(projectForCodegen)
+    };
+}
+
+/**
+ * Compute the canonical string a schema version hashes.
+ *
+ * Exposed separately so the hashing itself can differ by environment: Node has
+ * `crypto`, and callers without it can still compare canonical forms directly.
+ */
+export function canonicalSchemaPayload(collections: CollectionConfig[]): string {
+    const projected = serializeCollections(collections)
+        .map(collection => projectForCodegen(collection as CollectionConfig));
+    return canonicalize(projected);
+}
+
+/**
+ * A short, non-cryptographic digest of the canonical payload.
+ *
+ * FNV-1a style, 64 bits, as two 32-bit halves. This is an identity, not a
+ * security boundary: nothing trusts a schema version to prove anything, it only
+ * answers "is this the same schema as before". A hand-rolled hash keeps this
+ * module free of `node:crypto`, so the identical function runs in the browser,
+ * in the CLI, and in the runtime — which is the property that actually matters.
+ */
+export function computeSchemaVersion(collections: CollectionConfig[]): string {
+    const payload = canonicalSchemaPayload(collections);
+
+    let h1 = 0x811c9dc5;
+    let h2 = 0x01000193;
+
+    for (let i = 0; i < payload.length; i++) {
+        const code = payload.charCodeAt(i);
+        h1 ^= code;
+        // Multiply by the FNV prime using shifts to stay in 32-bit integer math.
+        h1 = (h1 + ((h1 << 1) + (h1 << 4) + (h1 << 7) + (h1 << 8) + (h1 << 24))) >>> 0;
+        h2 ^= code + i;
+        h2 = (h2 + ((h2 << 1) + (h2 << 5) + (h2 << 9) + (h2 << 15) + (h2 << 24))) >>> 0;
+    }
+
+    const hex = (n: number): string => n.toString(16).padStart(8, "0");
+    return `v1:${hex(h1)}${hex(h2)}`;
+}