@rebasepro/client-postgresql 0.0.1-canary.4d4fb3e → 0.0.1-canary.ca2cb6e

package/dist/types/src/types/properties.d.ts

@@ -1,11 +1,11 @@
 import React from "react";
-import { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity } from "./entities";
-import { FilterValues } from "./collections";
-import { ColorKey, ColorScheme } from "./chips";
-import { AuthController } from "../controllers";
-import { Relation } from "./relations";
-import { EntityAfterReadProps, EntityBeforeSaveProps } from "./entity_callbacks";
-import { User } from "../users";
+import type { EntityReference, EntityRelation, EntityValues, GeoPoint, Entity } from "./entities";
+import type { Relation, JoinStep, OnAction } from "./relations";
+import type { EntityCollection, FilterValues } from "./collections";
+import type { ColorKey, ColorScheme } from "./chips";
+import type { AuthController } from "../controllers/auth";
+import type { EntityAfterReadProps, EntityBeforeSaveProps } from "./entity_callbacks";
+import type { User } from "../users";
 /**
  * Callbacks/Hooks for individual property fields
  * @group Entity properties
@@ -14,7 +14,7 @@ export type PropertyCallbacks<T = unknown, M extends Record<string, unknown> = R
     /**
      * Callback used after fetching data, to transform the value before rendering
      */
-    afterRead?(props: Omit<EntityAfterReadProps<M, USER>, 'entity'> & {
+    afterRead?(props: Omit<EntityAfterReadProps<M, USER>, "entity"> & {
         value: T;
         entity: Entity<M> | undefined;
     }): Promise<T> | T;
@@ -22,7 +22,7 @@ export type PropertyCallbacks<T = unknown, M extends Record<string, unknown> = R
      * Callback used before saving, after validation.
      * You can modify the value before it's saved.
      */
-    beforeSave?(props: Omit<EntityBeforeSaveProps<M, USER>, 'values'> & {
+    beforeSave?(props: Omit<EntityBeforeSaveProps<M, USER>, "values"> & {
         value: T;
         previousValue: T | undefined;
         values: Partial<M>;
@@ -41,30 +41,49 @@ export type Properties = {
  * This is the core of the type inference system.
  */
 export type InferPropertyType<P extends Property> = P extends StringProperty ? string : P extends NumberProperty ? number : P extends BooleanProperty ? boolean : P extends DateProperty ? Date : P extends GeopointProperty ? GeoPoint : P extends ReferenceProperty ? EntityReference : P extends RelationProperty ? EntityRelation | EntityRelation[] : P extends ArrayProperty ? (P["of"] extends Property ? InferPropertyType<P["of"]>[] : unknown[]) : P extends MapProperty ? (P["properties"] extends Properties ? InferEntityType<P["properties"]> : Record<string, unknown>) : never;
+/**
+ * Helper type that determines whether a property is required.
+ * Uses direct structural matching against `{ validation: { required: true } }`
+ * (without the optional marker on `validation`), which correctly narrows
+ * literal `true` while treating widened `boolean` as not-required.
+ */
+type IsRequired<P extends Property> = P extends {
+    validation: {
+        required: true;
+    };
+} ? true : false;
+/**
+ * Extract keys from Properties where the property is required.
+ */
+type RequiredPropertyKeys<P extends Properties> = {
+    [K in keyof P]: IsRequired<P[K]> extends true ? K : never;
+}[keyof P];
+/**
+ * Extract keys from Properties where the property is optional.
+ */
+type OptionalPropertyKeys<P extends Properties> = {
+    [K in keyof P]: IsRequired<P[K]> extends true ? never : K;
+}[keyof P];
 /**
  * A generic type that converts a `Properties` schema definition into a corresponding
  * TypeScript entity type. It correctly handles required and optional properties.
  *
+ * A property is considered required when it has `validation: { required: true }`.
+ * The `true` must be a literal type — if `required` is typed as `boolean`,
+ * the property will be treated as optional (use `as const` for literal inference).
+ *
  * @example
  * const productSchema = {
- * name: { type: 'string', validation: { required: true } },
- * price: { type: 'number' }
- * };
+ *   name: { type: 'string', validation: { required: true } },
+ *   price: { type: 'number' }
+ * } as const satisfies Properties;
  * type Product = InferEntityType<typeof productSchema>;
  * // Result: { name: string; price?: number; }
  */
 export type InferEntityType<P extends Properties> = {
-    -readonly [K in keyof P as P[K] extends {
-        validation?: {
-            required: true;
-        };
-    } ? K : never]: InferPropertyType<P[K]>;
+    -readonly [K in RequiredPropertyKeys<P>]: InferPropertyType<P[K]>;
 } & {
-    -readonly [K in keyof P as P[K] extends {
-        validation?: {
-            required: true;
-        };
-    } ? never : K]?: InferPropertyType<P[K]>;
+    -readonly [K in OptionalPropertyKeys<P>]?: InferPropertyType<P[K]>;
 };
 /**
  * Interface including all common properties of a CMS property.
@@ -396,14 +415,79 @@ export interface RelationProperty extends BaseProperty {
      */
     isId?: boolean;
     /**
-     * The name of the relation this property refers to. This name must match
-     * one of the `relationName`s defined in the top-level `relations` array
-     * of the collection.
+     * The target collection this relation points to.
+     * When set, the framework treats this property as a self-contained relation
+     * definition and no separate `relations[]` entry is needed.
+     */
+    target?: () => EntityCollection;
+    /**
+     * Whether this property references one or many records.
+     * Defaults to `"one"`.
+     */
+    cardinality?: "one" | "many";
+    /**
+     * Which side owns the persistence for this relationship.
+     * - `"owning"`: The foreign key (for one-to-one) or junction table (for many-to-many) is on this collection.
+     * - `"inverse"`: The foreign key is on the target collection's table.
+     * Defaults to `"owning"`.
+     */
+    direction?: "owning" | "inverse";
+    /**
+     * The name of the corresponding relation on the target collection.
+     * Used for inverse relations to locate the owning side.
+     */
+    inverseRelationName?: string;
+    /**
+     * Column on THIS table that stores the foreign key to the target.
+     * Required when `direction` is `"owning"` and `cardinality` is `"one"`.
+     * Auto-inferred if not set.
+     * @example "author_id"
+     */
+    localKey?: string;
+    /**
+     * Column on the TARGET table that stores the foreign key back to this entity.
+     * Required when `direction` is `"inverse"`.
+     * Auto-inferred if not set.
+     * @example "post_id"
+     */
+    foreignKeyOnTarget?: string;
+    /**
+     * Junction table configuration for many-to-many relationships.
+     * Required when `cardinality` is `"many"` and `direction` is `"owning"`.
+     * Auto-inferred if not set.
+     */
+    through?: {
+        table: string;
+        sourceColumn: string;
+        targetColumn: string;
+    };
+    /**
+     * Explicit, ordered join path for advanced multi-hop relations.
+     * When set, overrides `localKey`, `foreignKeyOnTarget`, and `through`.
+     */
+    joinPath?: JoinStep[];
+    /**
+     * Cascade action on update.
+     */
+    onUpdate?: OnAction;
+    /**
+     * Cascade action on delete.
+     */
+    onDelete?: OnAction;
+    /**
+     * Overrides applied to the target collection when rendered as a subcollection tab.
+     */
+    overrides?: Partial<EntityCollection>;
+    /**
+     * Optional name for this relation. Defaults to the property key at runtime.
+     * Only needed when the relation name should differ from the property key,
+     * or for backward compatibility with existing `relations[]` entries.
      */
-    relationName: string;
+    relationName?: string;
     /**
-     * The resolved relation object.
-     * This is set by the framework
+     * The resolved relation object, populated by the framework at normalization time.
+     * **Do not set manually** — it is computed from the inline fields above
+     * or looked up from the collection's `relations[]` array.
      */
     relation?: Relation;
     /**
@@ -765,7 +849,7 @@ export type StorageConfig = {
      * When set to true, this flag indicates that the bucket name will be
      * included in the saved storage path.
      *
-     * E.g. `gs://my-bucket/path/to/file.png` instead of just `path/to/file.png`
+     * E.g. `s3://my-bucket/path/to/file.png` instead of just `path/to/file.png`
      *
      * Defaults to false.
      */
@@ -860,7 +944,7 @@ export interface ImageResize {
      * - `contain`: Scale down to fit within bounds, preserving aspect ratio (default)
      * - `cover`: Scale to fill bounds, preserving aspect ratio (may crop)
      */
-    mode?: 'contain' | 'cover';
+    mode?: "contain" | "cover";
     /**
      * Output format for the resized image.
      * - `original`: Keep the original format (default)
@@ -868,7 +952,7 @@ export interface ImageResize {
      * - `png`: Convert to PNG
      * - `webp`: Convert to WebP
      */
-    format?: 'original' | 'jpeg' | 'png' | 'webp';
+    format?: "original" | "jpeg" | "png" | "webp";
     /**
      * Quality for lossy formats (JPEG, WebP). Number between 0 and 100.
      * Higher is better quality but larger file size. Defaults to 80.
@@ -1048,11 +1132,11 @@ export interface ConditionContext {
      * Current form/entity values.
      * Date values are converted to Unix timestamps (milliseconds).
      */
-    values: Record<string, any>;
+    values: Record<string, unknown>;
     /**
      * Previous values before the current edit session.
      */
-    previousValues: Record<string, any>;
+    previousValues: Record<string, unknown>;
     /**
      * Current value of this property specifically.
      */
@@ -1089,3 +1173,4 @@ export interface ConditionContext {
      */
     now: number;
 }
+export {};

package/dist/types/src/types/relations.d.ts

@@ -1,4 +1,4 @@
-import { EntityCollection } from "./collections";
+import type { EntityCollection } from "./collections";
 /**
  * @group Models
  */

package/dist/types/src/types/slots.d.ts

@@ -1,9 +1,9 @@
 import React from "react";
-import { CollectionActionsProps, EntityTableController, SelectionController, EntityCollection } from "./collections";
-import { Entity } from "./entities";
-import { PluginFormActionProps, PluginGenericProps, PluginHomePageActionsProps, PluginHomePageAdditionalCardsProps } from "./plugins";
-import { Property } from "./properties";
-import { RebaseContext } from "../rebase_context";
+import type { CollectionActionsProps, EntityTableController, SelectionController, EntityCollection } from "./collections";
+import type { Entity } from "./entities";
+import type { PluginFormActionProps, PluginGenericProps, PluginHomePageActionsProps, PluginHomePageAdditionalCardsProps } from "./plugins";
+import type { Property } from "./properties";
+import type { RebaseContext } from "../rebase_context";
 /**
  * Registry mapping slot names to their component prop types.
  * Each key represents a UI extension point in the CMS.
@@ -14,6 +14,8 @@ export interface SlotRegistry {
     "home.cards": PluginHomePageAdditionalCardsProps;
     "home.children.start": PluginGenericProps;
     "home.children.end": PluginGenericProps;
+    /** Compact insight widget rendered inline in a home page collection card. */
+    "home.card.insight": HomeCardInsightSlotProps;
     "home.collection.actions": PluginHomePageActionsProps;
     /** Rendered below the logo in the sidebar drawer. */
     "navigation.header": NavigationSlotProps;
@@ -28,6 +30,8 @@ export interface SlotRegistry {
     "collection.toolbar": CollectionToolbarProps;
     /** Custom empty-state component when a collection has no data. */
     "collection.empty-state": CollectionEmptyStateProps;
+    /** Insight widgets rendered above the collection table. */
+    "collection.insights": CollectionInsightsSlotProps;
     "form.actions": PluginFormActionProps;
     "form.actions.top": PluginFormActionProps;
     /** Rendered before the form title / field list. */
@@ -74,7 +78,7 @@ export interface SlotContribution<K extends SlotName = SlotName> {
     /**
      * Additional props to merge into the slot props before rendering.
      */
-    props?: Record<string, any>;
+    props?: Record<string, unknown>;
     /**
      * Ordering hint. Lower values render first. Defaults to 50.
      */
@@ -226,3 +230,23 @@ export interface GlobalSearchProps {
 export interface ShellToolbarProps {
     context: RebaseContext;
 }
+/**
+ * Props for `collection.insights` slot.
+ * Insight widgets rendered above the collection table.
+ * @group Plugins
+ */
+export interface CollectionInsightsSlotProps {
+    path: string;
+    collection: EntityCollection;
+    parentCollectionIds: string[];
+}
+/**
+ * Props for `home.card.insight` slot.
+ * Compact insight rendered inline in a home page collection card.
+ * @group Plugins
+ */
+export interface HomeCardInsightSlotProps {
+    slug: string;
+    collection: EntityCollection;
+    context: RebaseContext;
+}

package/dist/types/src/types/translations.d.ts

@@ -44,6 +44,8 @@ export interface RebaseTranslations {
     clear_filter: string;
     clear_filter_sort: string;
     clear_sort: string;
+    /** Reset all active filters */
+    clear_all: string;
     no_items: string;
     no_entries_found: string;
     all_entries_loaded: string;
@@ -124,6 +126,20 @@ export interface RebaseTranslations {
     /** Shown in unsaved-changes dialogs */
     are_you_sure_leave: string;
     passkey_error_unsupported: string;
+    /** Snackbar message after a successful save */
+    saved_correctly: string;
+    /** Snackbar title when a beforeSave callback throws */
+    error_before_saving: string;
+    /** Snackbar title when an afterSave callback throws */
+    error_after_saving: string;
+    /** Snackbar title when the save itself fails */
+    error_saving_entity: string;
+    /** Alert shown when the entity does not exist in the database */
+    entity_does_not_exist: string;
+    /** Tooltip when the form has unsaved modifications */
+    form_modified: string;
+    /** Tooltip when the form is in sync with the database */
+    form_in_sync: string;
     admin: string;
     home: string;
     this_form_has_errors: string;
@@ -267,6 +283,8 @@ export interface RebaseTranslations {
     any_of_these: string;
     only_admins_edit_roles: string;
     error_user_not_found: string;
+    /** Placeholder / label for the "all roles" filter option */
+    all_roles: string;
     role: string;
     name_of_this_role: string;
     id_of_this_role: string;
@@ -373,6 +391,7 @@ export interface RebaseTranslations {
     no_filterable_properties: string;
     apply_filters: string;
     list: string;
+    table_view_mode: string;
     cards: string;
     board: string;
     initialize_kanban_order_desc: string;
@@ -380,6 +399,7 @@ export interface RebaseTranslations {
     kanban_view_requires_enum: string;
     no_enum_values_configured: string;
     items_need_backfill: string;
+    kanban_order_not_configured: string;
     initialize: string;
     confirm_multiple_delete: string;
     delete_entity_confirm_title: string;
@@ -823,4 +843,28 @@ export interface RebaseTranslations {
     studio_kanban_configure?: string;
     studio_missing_reference_error?: string;
     studio_new_collection_add?: string;
+    db_column_type?: string;
+    primary_key_unique_id?: string;
+    spread_children_as_columns?: string;
+    mode?: string;
+    timezone?: string;
+    target_collection?: string;
+    storage_file_name?: string;
+    storage_path?: string;
+    storage_max_size?: string;
+    storage_resize_mode?: string;
+    storage_output_format?: string;
+    storage_max_width?: string;
+    storage_max_height?: string;
+    storage_quality?: string;
+    storage_file_upload_config?: string;
+    storage_image_resize_config?: string;
+    storage_all_file_types?: string;
+    storage_allowed_file_types?: string;
+    storage_include_bucket_url?: string;
+    storage_save_url?: string;
+    datetime_automatic_value?: string;
+    markdown_paste_behavior?: string;
+    markdown_strip_html?: string;
+    markdown_convert_pasted?: string;
 }

package/dist/types/src/types/user_management_delegate.d.ts

@@ -51,6 +51,7 @@ export interface UserManagementDelegate<USER extends User = User> {
         offset?: number;
         orderBy?: string;
         orderDir?: "asc" | "desc";
+        roleId?: string;
     }) => Promise<{
         users: USER[];
         total: number;

package/package.json

@@ -1,90 +1,87 @@
 {
-    "name": "@rebasepro/client-postgresql",
-    "type": "module",
-    "version": "0.0.1-canary.4d4fb3e",
-    "description": "PostgreSQL data source client for Rebase",
-    "funding": {
-        "url": "https://github.com/sponsors/rebaseco"
+  "name": "@rebasepro/client-postgresql",
+  "type": "module",
+  "version": "0.0.1-canary.ca2cb6e",
+  "description": "PostgreSQL data source client for Rebase",
+  "funding": {
+    "url": "https://github.com/sponsors/rebaseco"
+  },
+  "author": "Rebase",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/rebasepro/rebase.git",
+    "directory": "packages/client-postgresql"
+  },
+  "main": "./dist/index.umd.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "source": "src/index.ts",
+  "engines": {
+    "node": ">=14"
+  },
+  "keywords": [
+    "rebase",
+    "postgresql",
+    "database",
+    "client",
+    "typescript",
+    "admin"
+  ],
+  "jest": {
+    "transform": {
+      "^.+\\.tsx?$": "ts-jest"
     },
-    "author": "Rebase",
-    "license": "MIT",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/rebasepro/rebase.git",
-        "directory": "packages/client-postgresql"
-    },
-    "main": "./dist/index.umd.js",
-    "module": "./dist/index.es.js",
-    "types": "./dist/index.d.ts",
-    "source": "src/index.ts",
-    "engines": {
-        "node": ">=14"
-    },
-    "keywords": [
-        "firebase",
-        "cms",
-        "admin",
-        "admin panel",
-        "postgresql",
-        "database",
-        "rebase",
-        "client"
+    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+    "moduleFileExtensions": [
+      "ts",
+      "tsx",
+      "js",
+      "jsx",
+      "json",
+      "node"
     ],
-    "scripts": {
-        "watch": "vite build --watch",
-        "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
-        "prepublishOnly": "pnpm run build",
-        "test:lint": "eslint \"src/**\" --quiet",
-        "test": "jest --passWithNoTests",
-        "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
-    },
-    "jest": {
-        "transform": {
-            "^.+\\.tsx?$": "ts-jest"
-        },
-        "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
-        "moduleFileExtensions": [
-            "ts",
-            "tsx",
-            "js",
-            "jsx",
-            "json",
-            "node"
-        ],
-        "moduleNameMapper": {
-            "^@rebasepro/core$": "<rootDir>/../core/src/index.ts",
-            "^@rebasepro/common$": "<rootDir>/../common/src/index.ts",
-            "^@rebasepro/types$": "<rootDir>/../types/src/index.ts"
-        }
-    },
-    "exports": {
-        ".": {
-            "types": "./dist/index.d.ts",
-            "development": "./src/index.ts",
-            "import": "./dist/index.es.js",
-            "require": "./dist/index.umd.js"
-        },
-        "./package.json": "./package.json"
-    },
-    "dependencies": {
-        "@rebasepro/client": "0.0.1-canary.4d4fb3e",
-        "@rebasepro/types": "0.0.1-canary.4d4fb3e"
-    },
-    "peerDependencies": {
-        "react": ">=19.0.0",
-        "react-dom": ">=19.0.0"
-    },
-    "devDependencies": {
-        "@types/jest": "^29.5.14",
-        "@types/react": "^19.0.8",
-        "@types/react-dom": "^19.0.3",
-        "jest": "^29.7.0",
-        "ts-jest": "^29.4.5",
-        "typescript": "^5.0.0",
-        "vite": "^5.0.0"
-    },
-    "gitHead": "71bcef3c51a458cd054f7924cc18efbbe515dcc8",
-    "publishConfig": {
-        "access": "public"
+    "moduleNameMapper": {
+      "^@rebasepro/core$": "<rootDir>/../core/src/index.ts",
+      "^@rebasepro/common$": "<rootDir>/../common/src/index.ts",
+      "^@rebasepro/types$": "<rootDir>/../types/src/index.ts"
     }
-}
+  },
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "development": "./src/index.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.umd.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@rebasepro/client": "0.0.1-canary.ca2cb6e",
+    "@rebasepro/types": "0.0.1-canary.ca2cb6e"
+  },
+  "peerDependencies": {
+    "react": ">=19.0.0",
+    "react-dom": ">=19.0.0"
+  },
+  "devDependencies": {
+    "@types/jest": "^29.5.14",
+    "@types/react": "^19.0.8",
+    "@types/react-dom": "^19.0.3",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.4.5",
+    "typescript": "^5.0.0",
+    "vite": "^5.0.0"
+  },
+  "gitHead": "d935eefa5aa8d1009a2398cfac2c1e4ee9aeb6b6",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "watch": "vite build --watch",
+    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
+    "test:lint": "eslint \"src/**\" --quiet",
+    "test": "jest --passWithNoTests",
+    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
+  }
+}