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

package/dist/types/component_ref.d.ts

@@ -1,4 +1,36 @@
-import type React from "react";
+/**
+ * How a collection points at a UI component without the backend learning about React.
+ *
+ * This file is the hinge the BaaS/admin split turns on. `ComponentRef` is named
+ * by `properties.ts` (`ui.Field`, `ui.Preview`, `ui.Filter`), and `properties.ts`
+ * must stay in the React-free core because every backend subsystem — validation,
+ * the drizzle schema generator, the OpenAPI generator, the SDK codegen — reads
+ * property definitions. If `ComponentRef` needed `React.ComponentType`, the whole
+ * property model would have to move to the admin layer with it.
+ *
+ * So the React types are described structurally instead of imported. Every form
+ * a React component takes is assignable to {@link ComponentLike}:
+ *
+ * - a function component is `(props: P) => ReactNode`
+ * - a class component satisfies the construct signature (`Component` has `render`)
+ * - `memo` and `forwardRef` return exotic components, which are callable
+ *
+ * The cost is that the return type is `unknown` rather than `ReactNode`, so a
+ * function that returns something React could not render is accepted here.
+ * `@rebasepro/admin-types` re-exports a `ReactComponentRef<P>` narrowed against
+ * the real `React.ComponentType` for authoring and for the admin's internals,
+ * which restores that check where it can be enforced.
+ */
+/**
+ * Structural stand-in for `React.ComponentType<P>`.
+ *
+ * Deliberately not `Function` or `unknown`: those would accept anything and the
+ * resolver's runtime heuristics ({@link ComponentRef} form 3) would be all that
+ * stood between a typo and a blank screen.
+ */
+export type ComponentLike<P = any> = ((props: P) => unknown) | (new (props: P, context?: unknown) => {
+    render(): unknown;
+});
 /**
  * Internal marker for a lazily-loaded component reference.
  * Created by the Vite transform plugin when converting string paths
@@ -9,11 +41,11 @@ import type React from "react";
 export interface LazyComponentRef<P = unknown> {
     readonly __rebaseLazy: true;
     readonly load: () => Promise<{
-        default: React.ComponentType<P>;
+        default: ComponentLike<P>;
     }>;
 }
 /**
- * A reference to a React component that can be provided in three forms:
+ * A reference to a UI component that can be provided in three forms:
  *
  * 1. **String path** (recommended for collection configs):
  *    ```ts
@@ -34,12 +66,13 @@ export interface LazyComponentRef<P = unknown> {
  *    ```
  *    Importing a component at the top level will pull React into the
  *    backend runtime — only safe in code that the backend never imports.
+ *    `pnpm check:headless` fails on a collection file that does this.
  *
  * @group Types
  */
-export type ComponentRef<P = any> = React.ComponentType<P> | LazyComponentRef<P> | (() => Promise<{
-    default: React.ComponentType<P>;
-}>) | string;
+export type ComponentRef<P = any> = string | LazyComponentRef<P> | (() => Promise<{
+    default: ComponentLike<P>;
+}>) | ComponentLike<P>;
 /**
  * Type guard: checks if a value is a `LazyComponentRef` produced by the
  * Vite transform plugin.

package/dist/types/entity_callbacks.d.ts

@@ -1,7 +1,7 @@
 import type { CollectionConfig } from "./collections";
 import type { EntityStatus, EntityValues } from "./entities";
 import type { User } from "../users";
-import type { RebaseCallContext } from "../rebase_context";
+import type { RebaseCallContext } from "../call_context";
 /**
  * Lifecycle callbacks for entity CRUD operations.
  *

package/dist/types/index.d.ts

@@ -2,25 +2,15 @@ export * from "./entities";
 export * from "./filter-operators";
 export * from "./chips";
 export * from "./properties";
+export * from "./admin_block";
 export * from "./collections";
 export * from "./relations";
 export * from "./policy";
-export * from "./locales";
-export * from "./entity_link_builder";
-export * from "./user_management_delegate";
+export * from "./security_rules";
 export * from "./entity_callbacks";
-export * from "./export_import";
-export * from "./modify_collections";
-export * from "./formex";
 export * from "./websockets";
 export * from "./backend";
-export * from "./translations";
-export * from "./plugins";
-export * from "./builders";
-export * from "./slots";
-export * from "./entity_actions";
-export * from "./property_config";
-export * from "./entity_views";
+export * from "./channel_bus";
 export * from "./data_source";
 export * from "./storage_source";
 export * from "./cron";
@@ -28,6 +18,8 @@ export * from "./backup";
 export * from "./component_ref";
 export * from "./auth_adapter";
 export * from "./database_adapter";
-export * from "./breadcrumbs";
-export * from "./component_overrides";
 export * from "./api_keys";
+export * from "./project_manifest";
+export * from "./collection_contract";
+export * from "./schema_version";
+export * from "./storage_authorize";

package/dist/types/project_manifest.d.ts

@@ -0,0 +1,336 @@
+/**
+ * The project manifest (`rebase.json`) and the build artifacts derived from it.
+ *
+ * Three separate documents live in this file, and keeping them distinct matters:
+ *
+ * 1. {@link RebaseProjectManifest} — `rebase.json`. **Authored** by the developer,
+ *    committed to the repository. Declares topology only: which runtime major the
+ *    project targets, and which apps *this repository* contributes to the project.
+ *    Schema, security rules, hooks and functions stay in TypeScript under the
+ *    config package — nothing that needs a type system belongs here.
+ *
+ * 2. {@link RebaseProjectLink} — the per-checkout link (`.rebase/cloud.json`).
+ *    **Not committed**, because it is per-developer like a git remote. Says which
+ *    deployed project this working copy points at, whether that is a Rebase Cloud
+ *    project or the base URL of a self-hosted backend.
+ *
+ * 3. {@link RebaseBundleManifest} — `manifest.json` inside a built bundle.
+ *    **Generated**, never hand-edited. It is the lockfile analogue: the exact
+ *    contract a built artifact claims to satisfy, which the runtime validates
+ *    before it boots and a control plane validates before it deploys.
+ *
+ * A repository declares only the apps it contains. The set of apps belonging to a
+ * project is held by the project itself, which is what makes multi-repo projects
+ * work: two repositories never need to know about each other, only about the
+ * project.
+ */
+/**
+ * Which kind of thing an app is.
+ *
+ * - `backend` — the collections/hooks/functions that define the project's API.
+ *   Exactly one per *project* (not per repository); the registry enforces it.
+ * - `static`  — a pre-built client bundle (SPA, static site) served over CDN.
+ * - `admin`   — the Rebase admin panel, either hosted by the platform or built
+ *   into this repository.
+ * - `mobile`  — a native app. Registration only: it gets client credentials and
+ *   configuration, and is never built or hosted here.
+ * - `custom`  — an arbitrary container image built from a Dockerfile. The eject
+ *   hatch: full control, no managed-runtime guarantees.
+ */
+export type RebaseAppType = "backend" | "static" | "admin" | "mobile" | "custom";
+/**
+ * The backend app: the project's API surface.
+ *
+ * Paths are relative to the directory holding `rebase.json`. The defaults match
+ * the layout `rebase init` scaffolds, so a stock project may declare simply
+ * `{ "type": "backend" }`.
+ */
+export interface RebaseBackendAppConfig {
+    type: "backend";
+    /** Directory of the config package (collections + index). Default `config`. */
+    config?: string;
+    /** Directory of server functions. Default `backend/functions`. */
+    functions?: string;
+    /** Directory of cron job definitions. Default `backend/crons` when present. */
+    crons?: string;
+    /**
+     * Path to the generated Drizzle schema module (tables/enums/relations).
+     * Default `backend/src/schema.generated.ts`.
+     */
+    schema?: string;
+    /**
+     * Which collections source the runtime uses.
+     *
+     * - `cms` (default) — collections come from the config package.
+     * - `baas` — collections are introspected from the live database at boot and
+     *   the config package is not required.
+     */
+    mode?: "cms" | "baas";
+    /**
+     * Module path (relative to `config`) exporting the auth users collection as
+     * its default export. Default `collections/users`.
+     */
+    usersCollection?: string;
+}
+/**
+ * A static client bundle — SPA or static site — built here and served from CDN.
+ */
+export interface RebaseStaticAppConfig {
+    type: "static";
+    /** Package directory containing the client sources. */
+    root: string;
+    /** Command that produces `output`. Run from the repository root. */
+    build?: string;
+    /** Directory of built assets, relative to the repository root. */
+    output: string;
+    /**
+     * Serve `index.html` for unmatched paths (client-side routing).
+     * Default `true` — the overwhelmingly common case for a client app, and a
+     * static *site* generator emits real files for its routes anyway.
+     */
+    spa?: boolean;
+}
+/**
+ * The admin panel.
+ *
+ * `hosted` is the default and means the platform serves it — nothing is built
+ * into this repository and nothing ships in the bundle. `bundled` builds it here,
+ * which is what a self-hosted or air-gapped deployment wants.
+ */
+export interface RebaseAdminAppConfig {
+    type: "admin";
+    mode?: "hosted" | "bundled";
+    /** Only for `bundled`: package directory containing the admin sources. */
+    root?: string;
+    /** Only for `bundled`: build command. */
+    build?: string;
+    /** Only for `bundled`: directory of built assets. */
+    output?: string;
+}
+/**
+ * A native app. Registered for credentials and configuration; never built here.
+ */
+export interface RebaseMobileAppConfig {
+    type: "mobile";
+    platform: "ios" | "android" | "other";
+}
+/**
+ * An app built from a Dockerfile into an arbitrary image.
+ *
+ * This is the deliberate escape hatch. A project containing one is not eligible
+ * for the managed runtime — the platform cannot make guarantees about an image
+ * it did not build — but it still deploys, and nothing else about the project
+ * changes.
+ */
+export interface RebaseCustomAppConfig {
+    type: "custom";
+    /** Dockerfile path relative to the repository root. */
+    dockerfile?: string;
+    /** Build context relative to the repository root. Default `.`. */
+    context?: string;
+    /** Port the container listens on. Default 8080. */
+    port?: number;
+}
+export type RebaseAppConfig = RebaseBackendAppConfig | RebaseStaticAppConfig | RebaseAdminAppConfig | RebaseMobileAppConfig | RebaseCustomAppConfig;
+/**
+ * `rebase.json` — the authored project manifest.
+ */
+export interface RebaseProjectManifest {
+    /** JSON Schema URL, for editor completion. Ignored by the tooling. */
+    $schema?: string;
+    /**
+     * The runtime **major** this project targets, as a semver range
+     * (e.g. `^1`, `~1.4`, or an exact `1.4.2` to pin).
+     *
+     * The platform upgrades patches and minors underneath a project without
+     * asking; it never crosses a major. See {@link RUNTIME_CONTRACT_VERSION}.
+     */
+    runtime: string;
+    /**
+     * Apps this repository contributes, keyed by app name. The key is the app's
+     * identity within the project: it is what `rebase deploy <app>` names, what
+     * client credentials are issued against, and what a second repository must
+     * not collide with.
+     */
+    apps: Record<string, RebaseAppConfig>;
+}
+/**
+ * The per-checkout project link.
+ *
+ * Deliberately separate from `rebase.json`: the manifest is committed and shared,
+ * while the link is per-developer. Keeping them in one file would mean either
+ * committing someone's project id or gitignoring the topology.
+ */
+export interface RebaseProjectLink {
+    /**
+     * A Rebase Cloud project id, or the base URL of any running Rebase backend
+     * (`https://api.example.com`). Both are first-class: every command that
+     * accepts a project reference accepts either, so a self-hosted project has
+     * the same tooling as a cloud one.
+     */
+    project: string;
+    /** Organization slug. Cloud projects only. */
+    org?: string;
+    /** Explicit API base URL, when it differs from the project's default. */
+    apiUrl?: string;
+}
+/**
+ * Whether a project can run on the managed runtime, and if not, precisely why.
+ *
+ * The reasons are returned rather than summarised so tooling can print something
+ * a developer can act on. "Not eligible" is never a dead end — it selects the
+ * custom-runtime path, which still deploys.
+ */
+export interface ManagedCompatibility {
+    eligible: boolean;
+    reasons: string[];
+}
+/**
+ * Version of the bundle *format* itself.
+ *
+ * Bumped only when the on-disk layout changes in a way an older runtime could
+ * not read. A runtime accepts any bundle whose `bundleFormat` is less than or
+ * equal to its own — old bundles keep booting on new runtimes, which is the
+ * whole point of separating the artifact from the engine.
+ */
+export declare const BUNDLE_FORMAT_VERSION = 1;
+/**
+ * The runtime contract major.
+ *
+ * Distinct from the `@rebasepro/server` package version: the package may release
+ * any number of minors and patches while this stays put. It changes only when
+ * the bundle/runtime contract breaks compatibility, and a project's
+ * `manifest.runtime` range is matched against *this*.
+ */
+export declare const RUNTIME_CONTRACT_VERSION = 1;
+/** Where the runtime finds each part of the bundle. Paths are bundle-relative. */
+export interface RebaseBundleEntrypoints {
+    /** Compiled config package directory (collections live under it). */
+    config?: string;
+    /** Compiled collections directory, when it differs from `<config>/collections`. */
+    collections?: string;
+    /** Compiled functions directory. */
+    functions?: string;
+    /** Compiled crons directory. */
+    crons?: string;
+    /** Compiled Drizzle schema module. */
+    schema?: string;
+    /** Module exporting the auth users collection (default export). */
+    usersCollection?: string;
+    /** Built admin assets, when the admin panel is bundled rather than hosted. */
+    admin?: string;
+    /** Built static assets to serve from the runtime, when not on a CDN. */
+    static?: string;
+}
+/**
+ * A native module found in the dependency closure.
+ *
+ * Recorded rather than merely counted so a rejection can name the offending
+ * package instead of saying "something here is native".
+ */
+export interface NativeDependency {
+    name: string;
+    /** Why it was flagged — a `.node` binary, a gyp build, or an install script. */
+    reason: string;
+}
+/**
+ * `manifest.json` — generated, and the document the runtime and control plane
+ * both validate against.
+ */
+export interface RebaseBundleManifest {
+    /** @see BUNDLE_FORMAT_VERSION */
+    bundleFormat: number;
+    runtime: {
+        /** The `runtime` range copied from `rebase.json`. */
+        range: string;
+        /** Exact `@rebasepro/server` version this bundle was built against. */
+        builtAgainst: string;
+        /** Runtime contract major this bundle requires. */
+        contract: number;
+    };
+    /**
+     * Hash of the compiled collection definitions.
+     *
+     * This is the contract stamp. A generated SDK records the value it was built
+     * from, a client sends it back, and a mismatch is what lets the platform say
+     * "this app was built against an older schema" instead of failing mysteriously
+     * at the first request. It covers collections only — a hook edit does not
+     * change a client's contract, so it must not invalidate every SDK.
+     */
+    schemaVersion: string;
+    /** Which app in `rebase.json` this bundle was built from. */
+    app: string;
+    /**
+     * What the runtime does with this bundle.
+     *
+     * - `cms` — a backend with declared collections; the runtime provisions their
+     *   tables and serves the data API.
+     * - `baas` — a backend that introspects an existing database rather than
+     *   declaring collections.
+     * - `static` — no backend at all: the bundle is a built SPA (`entry.static`),
+     *   and the runtime only serves those assets. No database, no data sources —
+     *   this is how a `static`/`admin` app runs on the same image as the backend.
+     */
+    mode: "cms" | "baas" | "static";
+    entry: RebaseBundleEntrypoints;
+    /** Collection slugs contained in the bundle, for quick inspection. */
+    collections?: string[];
+    hooks: {
+        /**
+         * Whether the dependency closure contains native code.
+         *
+         * The managed runtime refuses these: a prebuilt binary cannot be run on
+         * an image the platform did not build it for, and the honest failure is
+         * at deploy time rather than at 3am in a crash loop.
+         */
+        native: boolean;
+        nativeModules?: NativeDependency[];
+    };
+    /**
+     * What the bundle's config says about storage access control.
+     *
+     * Storage is not under RLS and its keys share one flat namespace, so a
+     * deployment with file storage enabled and no access model serves every
+     * user's files to every signed-in user. The runtime refuses to boot in that
+     * state — which, on a hosted platform that enables storage from the *console*
+     * rather than from the bundle, surfaces as a crash loop the developer cannot
+     * read.
+     *
+     * Recording it here lets a host reject the deploy with the reason instead.
+     * Absent on bundles built before this field existed.
+     */
+    storage?: {
+        /** Whether the config package exports a `storageAuthorize` hook. */
+        authorize: boolean;
+    };
+    deps: {
+        /** Runtime dependencies of user code, as declared. */
+        declared: Record<string, string>;
+    };
+    build: {
+        /** `@rebasepro/cli` version that produced this bundle. */
+        cli: string;
+        /** Node major the bundle was compiled on. */
+        node: string;
+        /** ISO-8601. */
+        createdAt: string;
+    };
+}
+/** The contract a running backend serves at `GET /api/meta/contract`. */
+export interface RebaseProjectContract {
+    /** Matches {@link RebaseBundleManifest.schemaVersion}. */
+    schemaVersion: string;
+    runtime: {
+        /** `@rebasepro/server` version currently running. */
+        version: string;
+        contract: number;
+    };
+    mode: "cms" | "baas";
+    /** Full collection definitions, serialized — the input to SDK generation. */
+    collections: unknown[];
+    /** Collection slugs, for cheap inspection without parsing the definitions. */
+    collectionSlugs: string[];
+    generatedAt: string;
+}
+/** Header carrying the schema version an SDK was generated from. */
+export declare const SCHEMA_VERSION_HEADER = "x-rebase-schema";