@rebasepro/cms-types 0.17.3 → 0.18.0

package/dist/types/property_options.d.ts

@@ -13,9 +13,47 @@ import type { PropertySpan } from "./form_layout.js";
  * @group Entity properties
  */
 export interface AdminPropertyOptions<CustomProps = unknown> {
+    /**
+     * Width of this property's column in the table view, in pixels. Omit and the
+     * table derives one from the property type.
+     *
+     * A person can drag a column wider, and that is remembered per user; this is
+     * the width everyone starts from.
+     */
     columnWidth?: number;
+    /**
+     * Keep this property out of the table and card views. It is still on the
+     * entity form, and still read and written by the API.
+     *
+     * For a field that should not leave the server at all, use
+     * `excludeFromApi` on the property itself — this one is presentation, and
+     * hiding a secret with it hides it from exactly one screen.
+     */
     hideFromCollection?: boolean;
+    /**
+     * Render the **value**, not a control. Defaults to `false`.
+     *
+     * The distinction from {@link disabled} is what the field looks like and
+     * what it can do. `readOnly` shows the value as text: nothing to focus,
+     * nothing to clear, and no explanation owed, because there is no control to
+     * wonder about. Use it for something the server owns — a computed total, an
+     * `autoValue` timestamp.
+     *
+     * A property that is read-only *for some people* is not this: that is a
+     * security rule, and writing it here leaves the column writable through the
+     * API by anyone who skips the panel.
+     */
     readOnly?: boolean;
+    /**
+     * Render the control, greyed out. Defaults to `false`.
+     *
+     * The counterpart to {@link readOnly}: this one is a field that *could* be
+     * edited but is not, right now — usually because of a condition, which is
+     * why it takes a config with a `disabledMessage` saying why and a
+     * `clearOnDisabled` for the value that no longer applies. The control stays
+     * visible so the reader can see the shape of what they are not allowed to
+     * fill in.
+     */
     disabled?: boolean | PropertyDisabledConfig;
     /**
      * How many of the form grid's {@link FORM_GRID_COLUMNS} columns this field
@@ -25,8 +63,34 @@ export interface AdminPropertyOptions<CustomProps = unknown> {
      * are declared in.
      */
     span?: PropertySpan;
+    /**
+     * Anything your own {@link Field} or {@link Preview} needs, passed straight
+     * through untouched.
+     *
+     * Typed by the property's own `CustomProps` parameter, so a custom field
+     * declares what it expects and a collection that supplies the wrong shape is
+     * a compile error rather than an `undefined` at render time.
+     */
     customProps?: CustomProps;
+    /**
+     * Replace the form control for this property.
+     *
+     * The component receives `FieldProps` — the value, `setValue`, the resolved
+     * property, the whole entity's values, and any {@link customProps}. It owns
+     * the input; validation, the label and the error line stay with the form.
+     *
+     * A `ComponentRef` rather than a component so a collection stays
+     * serializable: the reference is a registered key, which survives being sent
+     * to the schema editor and written back to the file.
+     */
     Field?: ComponentRef<any>;
+    /**
+     * Replace how this property renders when it is *not* being edited — a table
+     * cell, a card line, a reference chip.
+     *
+     * Separate from {@link Field} because the two are read in different places
+     * and at different sizes; overriding one and not the other is normal.
+     */
     Preview?: ComponentRef<any>;
     /**
      * Narrow the filter operators offered for this property in collection
@@ -74,6 +138,12 @@ export interface AdminStringOptions extends AdminPropertyOptions {
      * Should this string be rendered as a tag instead of just text.
      */
     previewAsTag?: boolean;
+    /**
+     * Add an icon that sets the value to `null`. Defaults to `false`.
+     *
+     * Worth setting where empty and empty-string are different answers — an
+     * unset middle name is not the same as one somebody deleted.
+     */
     clearable?: boolean;
     /**
      * How to render a string that holds a URL: a link, or one of the supported
@@ -110,7 +180,9 @@ export interface NumberFormatOptions {
      * amount read `1,234.50` for one user and `1.234,50` for another.
      */
     locale?: string;
+    /** Pad to at least this many decimals — `2` writes `5` as `5.00`. */
     minimumFractionDigits?: number;
+    /** Round to at most this many decimals. Does not change the stored value. */
     maximumFractionDigits?: number;
     /** `"compact"` renders `12000` as `12K`. Useful in narrow table columns. */
     notation?: "standard" | "compact";
@@ -119,6 +191,12 @@ export interface NumberFormatOptions {
  * @group Entity properties
  */
 export interface AdminNumberOptions extends AdminPropertyOptions {
+    /**
+     * Add an icon that sets the value to `null`. Defaults to `false`.
+     *
+     * Numbers are where this matters most: without it, clearing the input
+     * leaves `0`, and "no price" and "free" become the same row.
+     */
     clearable?: boolean;
     /**
      * Write this number out as currency, a percentage, or with fixed decimals.
@@ -131,6 +209,13 @@ export interface AdminNumberOptions extends AdminPropertyOptions {
  * @group Entity properties
  */
 export interface AdminVectorOptions extends AdminPropertyOptions {
+    /**
+     * Add an icon that sets the embedding to `null`. Defaults to `false`.
+     *
+     * A vector is normally written by whatever generates it, so this is for the
+     * case where a human needs to say "this one is stale" and let it be
+     * recomputed.
+     */
     clearable?: boolean;
 }
 /**
@@ -146,6 +231,15 @@ export interface AdminDateOptions extends AdminPropertyOptions {
  * @group Entity properties
  */
 export interface AdminReferenceOptions extends AdminPropertyOptions {
+    /**
+     * Which of the *target's* properties are shown in the chip that stands in
+     * for the referenced entity. At most three fit; the rest are ignored.
+     *
+     * Defaults to the target collection's own `admin.previewProperties`, then to
+     * a derived guess. Name them here when the referring context wants different
+     * ones — an order line wants the product's SKU, the catalogue wants its
+     * name.
+     */
     previewProperties?: string[];
     /**
      * Offer only entities that pass this filter in the selection dialog.
@@ -161,6 +255,13 @@ export interface AdminReferenceOptions extends AdminPropertyOptions {
  * @group Entity properties
  */
 export interface AdminRelationOptions extends AdminPropertyOptions {
+    /**
+     * Which of the *target's* properties are shown in the chip that stands in
+     * for the related row. At most three fit; the rest are ignored.
+     *
+     * Defaults to the target collection's own `admin.previewProperties`, then to
+     * a derived guess. Name them here when this side wants different ones.
+     */
     previewProperties?: string[];
     /**
      * Which widget selects the related entity. Defaults to `select`.
@@ -193,7 +294,20 @@ export interface AdminRelationOptions extends AdminPropertyOptions {
  * @group Entity properties
  */
 export interface AdminArrayOptions extends AdminPropertyOptions {
+    /**
+     * Open every element on load instead of collapsing them to one line each.
+     * Defaults to `false`.
+     *
+     * Expanding is right for a short list of small elements and wrong for a long
+     * one: twenty open cards is a form nobody can find the bottom of.
+     */
     expanded?: boolean;
+    /**
+     * Drop the per-element chrome — the frame, the header, the index — and
+     * render the children alone. Defaults to `false`.
+     *
+     * For an array of one simple field, where the chrome is most of the pixels.
+     */
     minimalistView?: boolean;
     /**
      * Can the elements in this array be reordered by dragging. Defaults to
@@ -210,8 +324,25 @@ export interface AdminArrayOptions extends AdminPropertyOptions {
  * @group Entity properties
  */
 export interface AdminMapOptions extends AdminPropertyOptions {
+    /**
+     * Open the map's fields on load instead of collapsing them behind its
+     * header. Defaults to `false`.
+     */
     expanded?: boolean;
+    /**
+     * Drop the map's frame and header and render its fields alone. Defaults to
+     * `false`.
+     */
     minimalistView?: boolean;
+    /**
+     * Lay the map's fields out as if they were the parent's own, rather than
+     * grouped inside it. Defaults to `false`.
+     *
+     * Presentation only — the values still nest under this property's key in the
+     * row, and in every read the API serves. It is for a group that is a
+     * grouping in the schema and not in the form: an address, a set of
+     * dimensions.
+     */
     spreadChildren?: boolean;
     /**
      * Which of the map's own properties are shown when it is rendered as a
@@ -252,4 +383,4 @@ export type PreviewType = "image" | "video" | "audio" | "file";
  * collection validator in `@rebasepro/server` needs it and may not import this
  * package, and this clause is what stops the data from drifting off the types.
  */
-export declare const ADMIN_PROPERTY_KEYS: readonly ["canAddElements", "clearable", "columnWidth", "customProps", "disabled", "expanded", "Field", "Filter", "filterOperators", "fixedFilter", "hideFromCollection", "includeEntityLink", "includeId", "markdown", "minimalistView", "multiline", "Preview", "previewAsTag", "previewProperties", "readOnly", "sortable", "span", "spreadChildren", "urlPreview", "widget"];
+export declare const ADMIN_PROPERTY_KEYS: readonly ["canAddElements", "clearable", "columnWidth", "customProps", "disabled", "expanded", "Field", "Filter", "filterOperators", "fixedFilter", "format", "hideFromCollection", "includeEntityLink", "includeId", "markdown", "minimalistView", "multiline", "Preview", "previewAsTag", "previewProperties", "readOnly", "renderInForm", "sortable", "span", "spreadChildren", "urlPreview", "widget"];

package/dist/types/slots.d.ts

@@ -87,11 +87,21 @@ export interface SlotContribution<K extends SlotName = SlotName> {
      */
     slot: K;
     /**
-     * The component to render in the slot.
-     * Typed loosely so mixed-slot arrays work.
-     * Type safety is provided at the `useSlot` call site.
+     * The component to render in the slot, taking that slot's props.
+     *
+     * This was `React.ComponentType<any>`, "typed loosely so mixed-slot arrays
+     * work" — and the looseness was doing real damage: `{ slot:
+     * "collection.actions", Component: MyThing }` typechecked whatever
+     * `MyThing`'s props were, so a component written against the wrong slot's
+     * props compiled, registered, and then read `undefined` off every prop it
+     * expected. The only check was at the `useSlot` render site, which is
+     * inside the framework and reports nothing to the author.
+     *
+     * The mixed-array problem is real but is a problem with the *array*, not
+     * with this field: see {@link AnySlotContribution}, which distributes over
+     * the slot names so each element is checked against its own slot.
      */
-    Component: React.ComponentType<any>;
+    Component: React.ComponentType<SlotRegistry[K]>;
     /**
      * Additional props to merge into the slot props before rendering.
      */
@@ -101,6 +111,22 @@ export interface SlotContribution<K extends SlotName = SlotName> {
      */
     order?: number;
 }
+/**
+ * A contribution to *some* slot, checked against that slot.
+ *
+ * `SlotContribution[]` cannot be the type of a mixed list: with `K` left at its
+ * default the props become the union of every slot's, and a component is
+ * contravariant in its props, so nothing satisfies it. Distributing the union
+ * over the slot names instead gives one member per slot, and TypeScript picks
+ * the member whose `slot` matches — which is what makes
+ * `{ slot: "collection.actions", Component: WrongProps }` an error at the
+ * declaration rather than a silent `undefined` at render.
+ *
+ * @group Plugins
+ */
+export type AnySlotContribution = {
+    [K in SlotName]: SlotContribution<K>;
+}[SlotName];
 /**
  * Props for `navigation.header` and `navigation.footer` slots.
  * @group Plugins

package/dist/types/translations.d.ts

@@ -205,6 +205,10 @@ export interface RebaseTranslations {
     reference_not_set: string;
     reference_does_not_exist: string;
     entity_not_found: string;
+    /** Why a record the URL names is not there, without asserting it never was. */
+    entity_not_found_body?: string;
+    /** Way out of a record that does not exist. `{{name}}` is the collection. */
+    back_to_collection?: string;
     file_not_found: string;
     unsaved_changes_in_entity: string;
     delete_this_role: string;
@@ -622,10 +626,6 @@ export interface RebaseTranslations {
     no_collections_found_to_setup: string;
     collections_have_been_setup: string;
     error_setting_up_collections: string;
-    add_your: string;
-    database_collections: string;
-    no_unmapped_collections: string;
-    welcome_to_rebase: string;
     admin_panel_ready_bring_data: string;
     admin_panel_ready_get_started: string;
     auto_detect_collections: string;
@@ -802,6 +802,10 @@ export interface RebaseTranslations {
     studio_sql_sidebar_no_history?: string;
     studio_sql_sidebar_history_hint?: string;
     studio_sql_sidebar_delete_snippet?: string;
+    /** Accessible name for the ✕ on a query tab. */
+    studio_sql_close_tab?: string;
+    /** Accessible name for the + beside the query tabs. */
+    studio_sql_new_tab?: string;
     studio_schema_tables?: string;
     studio_schema_loading?: string;
     studio_schema_no_tables?: string;
@@ -986,4 +990,92 @@ export interface RebaseTranslations {
     history_new_entity?: string;
     /** End of the paginated revision list */
     history_no_more?: string;
+    /** Heading for the admin's default navigation group. */
+    studio_group_views?: string;
+    /** Heading for the admin's `Admin` navigation group. */
+    studio_group_admin?: string;
+    /** Heading for the admin's `Settings` navigation group. */
+    studio_group_settings?: string;
+    studio_group_database?: string;
+    studio_group_compute?: string;
+    studio_group_storage?: string;
+    studio_group_api?: string;
+    studio_group_access_control?: string;
+    studio_tool_sql?: string;
+    studio_tool_sql_description?: string;
+    studio_tool_js?: string;
+    studio_tool_js_description?: string;
+    studio_tool_rls?: string;
+    studio_tool_rls_description?: string;
+    studio_tool_storage?: string;
+    studio_tool_storage_description?: string;
+    studio_tool_cron?: string;
+    studio_tool_cron_description?: string;
+    studio_tool_schema_visualizer?: string;
+    studio_tool_schema_visualizer_description?: string;
+    studio_tool_branches?: string;
+    studio_tool_branches_description?: string;
+    studio_tool_backups?: string;
+    studio_tool_backups_description?: string;
+    studio_tool_api?: string;
+    studio_tool_api_description?: string;
+    studio_tool_logs?: string;
+    studio_tool_logs_description?: string;
+    studio_tool_api_keys?: string;
+    studio_tool_api_keys_description?: string;
+    studio_backups_denied_title?: string;
+    studio_backups_denied_hint?: string;
+    studio_backups_read_failed?: string;
+    studio_backups_downloading?: string;
+    studio_cron_denied_title?: string;
+    studio_cron_denied_hint?: string;
+    studio_cron_read_failed?: string;
+    studio_api_keys_denied_title?: string;
+    studio_api_keys_denied_hint?: string;
+    studio_api_keys_read_failed?: string;
+    studio_api_keys_empty_title?: string;
+    studio_api_keys_empty_hint?: string;
+    studio_api_keys_revoke?: string;
+    studio_api_keys_select_hint?: string;
+    studio_api_keys_permissions?: string;
+    studio_api_keys_no_permissions?: string;
+    studio_api_keys_revoke_confirmation?: string;
+    studio_api_keys_name_label?: string;
+    studio_api_keys_access_label?: string;
+    studio_api_keys_admin_granted?: string;
+    studio_api_keys_admin_granted_hint?: string;
+    studio_api_keys_done?: string;
+    studio_api_keys_status_active?: string;
+    studio_api_keys_status_expired?: string;
+    studio_api_keys_status_revoked?: string;
+    studio_api_keys_stat_status?: string;
+    studio_api_keys_stat_last_used?: string;
+    studio_api_keys_stat_expires?: string;
+    studio_api_keys_never?: string;
+    studio_api_keys_role_service?: string;
+    studio_api_keys_stat_rate_limit?: string;
+    studio_api_keys_rate_limit_default?: string;
+    studio_api_keys_stat_created_by?: string;
+    studio_api_keys_copy_failed?: string;
+    studio_branches_denied_title?: string;
+    studio_branches_denied_hint?: string;
+    studio_branches_read_failed?: string;
+    studio_schema_no_collections?: string;
+    studio_schema_no_collections_body?: string;
+    studio_schema_introspect_hint?: string;
+    studio_rls_enable_confirm_title?: string;
+    studio_rls_enable_confirm_body?: string;
+    studio_rls_disable_confirm_title?: string;
+    studio_rls_disable_confirm_body?: string;
+    studio_rls_drop_policy_title?: string;
+    studio_rls_drop_policy_body?: string;
+    studio_rls_unapplied?: string;
+    studio_rls_unapplied_tooltip?: string;
+    studio_branches_unavailable_title?: string;
+    studio_branches_unavailable_body?: string;
+    studio_backups_not_configured_title?: string;
+    studio_backups_not_configured_body?: string;
+    studio_cron_empty_title?: string;
+    studio_cron_empty_body?: string;
+    studio_read_the_docs?: string;
 }

package/package.json

@@ -1,35 +1,38 @@
 {
   "name": "@rebasepro/cms-types",
-  "type": "module",
-  "version": "0.17.3",
-  "description": "Rebase admin-panel type definitions — the React-flavoured half of the type surface",
-  "funding": {
-    "url": "https://github.com/sponsors/rebaseco"
+  "version": "0.18.0",
+  "description": "Type definitions for the Rebase admin panel — CMS and Studio — the React-flavoured half of the type surface",
+  "keywords": [
+    "rebase",
+    "admin",
+    "cms",
+    "typescript",
+    "react",
+    "headless cms"
+  ],
+  "homepage": "https://rebase.pro",
+  "bugs": {
+    "url": "https://github.com/rebasepro/rebase/issues"
   },
-  "author": "Rebase",
-  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "https://github.com/rebasepro/rebase.git",
     "directory": "packages/cms-types"
   },
+  "funding": {
+    "url": "https://github.com/sponsors/rebasepro"
+  },
+  "license": "MIT",
+  "author": "Rebase",
+  "type": "module",
   "main": "./dist/index.es.js",
   "module": "./dist/index.es.js",
   "types": "./dist/index.d.ts",
-  "source": "src/index.ts",
   "engines": {
-    "node": ">=20"
+    "node": ">=22.22.0"
   },
-  "keywords": [
-    "rebase",
-    "admin",
-    "cms",
-    "typescript",
-    "react",
-    "headless cms"
-  ],
   "dependencies": {
-    "@rebasepro/types": "0.17.3"
+    "@rebasepro/types": "0.18.0"
   },
   "devDependencies": {
     "@types/jest": "^30.0.0",
@@ -46,12 +49,11 @@
     "vite": "^8.1.5"
   },
   "peerDependencies": {
-    "react": "^19.0.0",
-    "react-dom": "^19.0.0"
+    "react": "^19.2.7",
+    "react-dom": "^19.2.7"
   },
   "files": [
-    "dist",
-    "src"
+    "dist"
   ],
   "publishConfig": {
     "access": "public"
@@ -60,7 +62,8 @@
     ".": {
       "types": "./dist/index.d.ts",
       "development": "./dist/index.es.js",
-      "import": "./dist/index.es.js"
+      "import": "./dist/index.es.js",
+      "default": "./dist/index.es.js"
     },
     "./package.json": "./package.json"
   },
@@ -98,6 +101,7 @@
     "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json && node ../../tooling/scripts/add-dts-extensions.mjs dist && node ../../tooling/scripts/assert-build-output.mjs",
     "test:lint": "eslint \"src/**\" --quiet",
     "test": "jest --passWithNoTests",
+    "test:watch": "jest --watch",
     "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
   }
 }