@rebasepro/server-postgresql 0.5.0 → 0.6.0

package/dist/common/src/util/entities.d.ts

@@ -1,58 +0,0 @@
-import { DataType, Entity, EntityReference, EntityRelation, EntityStatus, EntityValues, Properties, Property } from "@rebasepro/types";
-export declare function isReadOnly(property: Property): boolean;
-export declare function isHidden(property: Property): boolean;
-export declare function isPropertyBuilder(property?: Property): boolean;
-export declare function getDefaultValuesFor<M extends Record<string, unknown>>(properties: Properties): Partial<EntityValues<M>>;
-export declare function getDefaultValueFor(property?: Property): unknown;
-export declare function getDefaultValueFortype(type: DataType): unknown;
-/**
- * Update the automatic values in an entity before save
- * @group Driver
- */
-export declare function updateDateAutoValues<M extends Record<string, unknown>>({ inputValues, properties, status, timestampNowValue }: {
-    inputValues: Partial<EntityValues<M>>;
-    properties: Properties;
-    status: EntityStatus;
-    timestampNowValue: unknown;
-}): EntityValues<M>;
-/**
- * Add missing required fields, expected in the collection, to the values of an entity
- * @param values
- * @param properties
- * @group Driver
- */
-export declare function sanitizeData<M extends Record<string, unknown>>(values: EntityValues<M>, properties: Properties): Record<string, unknown>;
-export declare function getReferenceFrom<M extends Record<string, unknown>>(entity: Entity<M>): EntityReference;
-export declare function getRelationFrom<M extends Record<string, unknown>>(entity: Entity<M>): EntityRelation;
-/**
- * Normalize a value into a proper EntityRelation instance.
- * Handles EntityRelation class instances, and plain objects
- * with `__type === "relation"` or an `isEntityRelation()` method.
- *
- * Returns null if the value cannot be coerced.
- */
-export declare function normalizeToEntityRelation(value: unknown): EntityRelation | null;
-export declare function traverseValuesProperties<M extends Record<string, unknown>>(inputValues: Partial<EntityValues<M>>, properties: Properties, operation: (value: unknown, property: Property) => unknown): EntityValues<M> | undefined;
-export declare function traverseValueProperty(inputValue: unknown, property: Property, operation: (value: unknown, property: Property) => unknown): unknown;
-/**
- * Relation reference types used throughout the server layer.
- * These replace the 50+ manual `{ id, path, __type: "relation" }` constructions.
- */
-export interface RelationRef {
-    readonly id: string | number;
-    readonly path: string;
-    readonly __type: "relation";
-}
-export interface RelationRefWithData extends RelationRef {
-    readonly data: Entity;
-}
-/**
- * Create a lightweight relation stub for CMS views.
- * Replaces inline `{ id, path, __type: "relation" }` object literals.
- */
-export declare function createRelationRef(id: string | number, path: string): RelationRef;
-/**
- * Create a hydrated relation reference that includes the full entity data.
- * Used when entity data has been pre-fetched (e.g., via batch loading or JOINs).
- */
-export declare function createRelationRefWithData(id: string | number, path: string, data: Entity): RelationRefWithData;

package/dist/common/src/util/enums.d.ts

@@ -1,3 +0,0 @@
-import { EnumValueConfig, EnumValues } from "@rebasepro/types";
-export declare function enumToObjectEntries(enumValues: EnumValues): EnumValueConfig[];
-export declare function getLabelOrConfigFrom(enumValues: EnumValueConfig[], key?: string | number): EnumValueConfig | undefined;

package/dist/common/src/util/index.d.ts

@@ -1,16 +0,0 @@
-export * from "./collections";
-export * from "./common";
-export * from "./entities";
-export * from "./enums";
-export * from "./paths";
-export * from "./resolutions";
-export * from "./permissions";
-export * from "./references";
-export * from "./navigation_from_path";
-export * from "./parent_references_from_path";
-export * from "./builders";
-export * from "./storage";
-export * from "./callbacks";
-export * from "./relations";
-export * from "./conditions";
-export * from "./navigation_utils";

package/dist/common/src/util/navigation_from_path.d.ts

@@ -1,34 +0,0 @@
-import { EntityCollection } from "@rebasepro/types";
-type EntityCustomView<M extends Record<string, unknown> = Record<string, unknown>> = {
-    key: string;
-    [key: string]: unknown;
-};
-export type NavigationViewInternal<M extends Record<string, unknown> = Record<string, unknown>> = NavigationViewEntityInternal<M> | NavigationViewCollectionInternal<M> | NavigationViewEntityCustomInternal<M>;
-export interface NavigationViewEntityInternal<M extends Record<string, unknown>> {
-    type: "entity";
-    entityId: string | number;
-    slug: string;
-    path: string;
-    parentCollection: EntityCollection<M>;
-}
-export interface NavigationViewCollectionInternal<M extends Record<string, unknown>> {
-    type: "collection";
-    id: string;
-    slug: string;
-    path: string;
-    collection: EntityCollection<M>;
-}
-export interface NavigationViewEntityCustomInternal<M extends Record<string, unknown>> {
-    type: "custom_view";
-    slug: string;
-    path: string;
-    entityId: string | number;
-    view: EntityCustomView<M>;
-}
-export declare function getNavigationEntriesFromPath(props: {
-    path: string;
-    collections: EntityCollection[] | undefined;
-    currentFullPath?: string;
-    contextEntityViews?: EntityCustomView[];
-}): NavigationViewInternal[];
-export {};

package/dist/common/src/util/navigation_utils.d.ts

@@ -1,20 +0,0 @@
-import { EntityCollection } from "@rebasepro/types";
-export declare function removeInitialAndTrailingSlashes(s: string): string;
-export declare function removeInitialSlash(s: string): string;
-export declare function removeTrailingSlash(s: string): string;
-export declare function addInitialSlash(s: string): string;
-export declare function getLastSegment(path: string): string;
-export declare function resolveCollectionPathIds(path: string, allCollections: EntityCollection[]): string;
-/**
- * Find the corresponding view at any depth for a given path.
- * Note that path or segments of the paths can be collection aliases.
- * @param slugOrPath
- * @param collections
- */
-export declare function getCollectionBySlugWithin(slugOrPath: string, collections: EntityCollection[]): EntityCollection | undefined;
-/**
- * Get the subcollection combinations from a path:
- * "sites/es/locales" => ["sites/es/locales", "sites"]
- * @param subpaths
- */
-export declare function getCollectionPathsCombinations(subpaths: string[]): string[];

package/dist/common/src/util/parent_references_from_path.d.ts

@@ -1,6 +0,0 @@
-import { EntityCollection, EntityReference } from "@rebasepro/types";
-export declare function getParentReferencesFromPath(props: {
-    path: string;
-    collections: EntityCollection[] | undefined;
-    currentFullPath?: string;
-}): EntityReference[];

package/dist/common/src/util/paths.d.ts

@@ -1,14 +0,0 @@
-export declare const COLLECTION_PATH_SEPARATOR = "::";
-/**
- * Remove the entity ids from a given path
- * `products/B44RG6APH/locales` => `products::locales`
- * @param path
- */
-export declare function stripCollectionPath(path: string): string;
-export declare function segmentsToStrippedPath(paths: string[]): string;
-/**
- * Extract the collection path routes
- * `products/B44RG6APH/locales` => [`products`, `locales`]
- * @param path
- */
-export declare function fullPathToCollectionSegments(path: string): string[];

package/dist/common/src/util/permissions.d.ts

@@ -1,14 +0,0 @@
-import { Entity, EntityCollection, User } from "@rebasepro/types";
-/**
- * Minimal auth context for permission checking.
- * Only requires the user object — avoids forcing callers to construct
- * a full AuthController just to check permissions.
- */
-export interface AuthContext<USER extends User = User> {
-    user: USER | null;
-}
-export declare function checkOperation<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authContext: AuthContext<USER>, entity: Entity<M> | null, targetOperation: "select" | "insert" | "update" | "delete"): boolean;
-export declare function canReadCollection<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authContext: AuthContext<USER>): boolean;
-export declare function canEditEntity<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authContext: AuthContext<USER>, path: string, entity: Entity<M> | null): boolean;
-export declare function canCreateEntity<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authContext: AuthContext<USER>, path: string, entity: Entity<M> | null): boolean;
-export declare function canDeleteEntity<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authContext: AuthContext<USER>, path: string, entity: Entity<M> | null): boolean;

package/dist/common/src/util/references.d.ts

@@ -1,2 +0,0 @@
-import { EntityCollection } from "@rebasepro/types";
-export declare function getEntityImagePreviewPropertyKey<M extends Record<string, unknown>>(collection: EntityCollection<M>): string | undefined;

package/dist/common/src/util/relations.d.ts

@@ -1,22 +0,0 @@
-import { EntityCollection, Property, Relation } from "@rebasepro/types";
-export declare function sanitizeRelation(relation: Partial<Relation>, sourceCollection: EntityCollection, resolveCollection?: (slugOrTable: string) => EntityCollection | undefined): Relation;
-export declare function resolveCollectionRelations(collection: EntityCollection): Record<string, Relation>;
-export declare function resolvePropertyRelation({ propertyKey, property, sourceCollection }: {
-    propertyKey: string;
-    property: Property;
-    sourceCollection: EntityCollection;
-}): Relation | undefined;
-export declare function getTableName(collection: EntityCollection): string;
-export declare function getTableVarName(tableName: string): string;
-export declare function getEnumVarName(tableName: string, propName: string): string;
-export declare function getColumnName(fullColumn: string): string;
-/**
- * Look up a relation by key with forgiving normalization.
- *
- * `resolveCollectionRelations` stores each relation under a single canonical
- * key (no aliases). This helper tries the given key as-is, then falls back to
- * slug form (underscores → hyphens) and snake_case form (hyphens → underscores)
- * so that callers that receive a key from external input (URL path segments,
- * user-provided config, etc.) can still find the right entry.
- */
-export declare function findRelation(resolvedRelations: Record<string, Relation>, key: string): Relation | undefined;

package/dist/common/src/util/resolutions.d.ts

@@ -1,72 +0,0 @@
-import { ArrayProperty, AuthController, EntityCollection, EnumValueConfig, EnumValues, NumberProperty, Properties, Property, Relation, RelationProperty, StringProperty } from "@rebasepro/types";
-type PropertyConfig = {
-    property: unknown;
-    [key: string]: unknown;
-};
-/**
- * Resolve property builders, enums and arrays.
- */
-export type ResolvePropertyProps<M extends Record<string, unknown> = Record<string, unknown>> = {
-    property: Property;
-    propertyKey?: string;
-    values?: Partial<M>;
-    previousValues?: Partial<M>;
-    path?: string;
-    entityId?: string | number;
-    index?: number;
-    propertyConfigs?: Record<string, PropertyConfig>;
-    ignoreMissingFields?: boolean;
-    authController: AuthController;
-};
-export declare function resolveProperty<M extends Record<string, unknown> = Record<string, unknown>>(props: ResolvePropertyProps<M>): Property | null;
-export declare function resolveRelationProperty(property: RelationProperty, relations: Relation[], propertyKey?: string): RelationProperty;
-/**
- * Resolve enum aliases for a string or number property
- * @param property
- */
-export declare function resolvePropertyEnum(property: StringProperty | NumberProperty): StringProperty | NumberProperty;
-/**
- * Resolve enums and arrays for properties
- * @param properties
- * @param value
- */
-export declare function resolveProperties<M extends Record<string, unknown>>({ propertyKey, properties, ignoreMissingFields, ...props }: {
-    propertyKey?: string;
-    properties: Properties;
-    values?: Partial<M>;
-    previousValues?: Partial<M>;
-    path?: string;
-    entityId?: string | number;
-    index?: number;
-    propertyConfigs?: Record<string, PropertyConfig>;
-    ignoreMissingFields?: boolean;
-    authController: AuthController;
-}): Properties;
-export declare function resolveArrayProperties<M>({ propertyKey, property, ignoreMissingFields, ...props }: {
-    propertyKey?: string;
-    property: ArrayProperty;
-    values?: Partial<M>;
-    previousValues?: Partial<M>;
-    path?: string;
-    entityId?: string | number;
-    index?: number;
-    propertyConfigs?: Record<string, PropertyConfig>;
-    ignoreMissingFields?: boolean;
-    authController: AuthController;
-}): Property[];
-export declare function getArrayResolvedProperties({ propertyKey, propertyValue, property, ...props }: {
-    propertyValue: unknown;
-    propertyKey?: string;
-    property: ArrayProperty;
-    ignoreMissingFields: boolean;
-    values?: object;
-    previousValues?: object;
-    path?: string;
-    entityId?: string | number;
-    index?: number;
-    propertyConfigs?: Record<string, PropertyConfig>;
-    authController: AuthController;
-}): Property[];
-export declare function resolveEnumValues(input: EnumValues): EnumValueConfig[] | undefined;
-export declare function getSubcollections<M extends Record<string, unknown> = Record<string, unknown>>(collection: EntityCollection<M>): EntityCollection<Record<string, unknown>>[];
-export {};

package/dist/common/src/util/storage.d.ts

@@ -1,24 +0,0 @@
-import { ArrayProperty, EntityValues, StorageConfig, StringProperty, UploadedFileContext } from "@rebasepro/types";
-interface ResolveFilenameStringParams<M extends Record<string, unknown>> {
-    input: string | ((context: UploadedFileContext) => (Promise<string> | string));
-    storage: StorageConfig;
-    values: EntityValues<M>;
-    entityId?: string | number;
-    path?: string;
-    property: StringProperty | ArrayProperty;
-    file: File;
-    propertyKey: string;
-}
-export declare function resolveStorageFilenameString<M extends Record<string, unknown>>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveFilenameStringParams<M>): Promise<string>;
-interface ResolveStoragePathStringParams<M extends Record<string, unknown>> {
-    input: string | ((context: UploadedFileContext) => string);
-    storage: StorageConfig;
-    values: EntityValues<M>;
-    entityId?: string | number;
-    path?: string;
-    property: StringProperty | ArrayProperty;
-    file: File;
-    propertyKey: string;
-}
-export declare function resolveStoragePathString<M extends Record<string, unknown>>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveStoragePathStringParams<M>): string;
-export {};

package/dist/types/src/controllers/analytics_controller.d.ts

@@ -1,7 +0,0 @@
-export type AnalyticsController = {
-    /**
-     * Callback used to get analytics events from the CMS
-     */
-    onAnalyticsEvent?: (event: AnalyticsEvent, data?: object) => void;
-};
-export type AnalyticsEvent = "entity_click" | "entity_click_from_reference" | "reference_selection_clear" | "reference_selection_toggle" | "reference_selected_single" | "reference_selection_new_entity" | "edit_entity_clicked" | "entity_edited" | "new_entity_click" | "new_entity_saved" | "copy_entity_click" | "entity_copied" | "single_delete_dialog_open" | "multiple_delete_dialog_open" | "single_entity_deleted" | "multiple_entities_deleted" | "drawer_navigate_to_home" | "drawer_navigate_to_collection" | "drawer_navigate_to_view" | "home_navigate_to_collection" | "home_favorite_navigate_to_collection" | "home_navigate_to_view" | "home_navigate_to_admin_view" | "home_favorite_navigate_to_view" | "home_move_card" | "home_move_group" | "home_drop_new_group" | "collection_inline_editing" | "view_mode_changed" | "kanban_card_moved" | "kanban_column_reorder" | "kanban_property_changed" | "kanban_new_entity_in_column" | "kanban_backfill_order" | "card_view_entity_click" | "unmapped_event";

package/dist/types/src/controllers/auth.d.ts

@@ -1,104 +0,0 @@
-import type { User } from "../users";
-/**
- * Capabilities advertised by an auth provider.
- * UI components use this to show/hide features dynamically
- * (e.g. password reset, registration, session management).
- * @group Hooks and utilities
- */
-export interface AuthCapabilities {
-    emailPasswordLogin?: boolean;
-    googleLogin?: boolean;
-    registration?: boolean;
-    passwordReset?: boolean;
-    sessionManagement?: boolean;
-    profileUpdate?: boolean;
-    emailVerification?: boolean;
-    /** List of enabled OAuth provider IDs (e.g. ["google", "github", "discord"]) */
-    enabledProviders?: string[];
-}
-/**
- * Controller for retrieving the logged user or performing auth related operations.
- * Note that if you are implementing your AuthController, you probably will want
- * to do it as the result of a hook.
- * @group Hooks and utilities
- */
-export type AuthController<USER extends User = User, ExtraData = unknown> = {
-    /**
-     * The user currently logged in
-     * The values can be: the user object, null if they skipped login
-     */
-    user: USER | null;
-    /**
-     * Initial loading flag. It is used not to display the login screen
-     * when the app first loads, and it has not been checked whether the user
-     * is logged in or not.
-     */
-    initialLoading?: boolean;
-    /**
-     * Loading flag. It is used to display a loading screen when the user is
-     * logging in or out.
-     */
-    authLoading: boolean;
-    /**
-     * Sign out
-     */
-    signOut: () => Promise<void>;
-    /**
-     * Error initializing the authentication
-     */
-    authError?: unknown;
-    /**
-     * Error dispatched by the auth provider
-     */
-    authProviderError?: unknown;
-    /**
-     * You can use this method to retrieve the auth token for the current user.
-     */
-    getAuthToken: () => Promise<string>;
-    /**
-     * Has the user skipped the login process
-     */
-    loginSkipped: boolean;
-    extra: ExtraData;
-    setExtra: (extra: ExtraData) => void;
-    setUser?(user: USER | null): void;
-    setUserRoles?(roles: string[]): void;
-    /**
-     * Capabilities advertised by the auth provider.
-     * UI components use this to feature-detect what the backend supports.
-     */
-    capabilities?: AuthCapabilities;
-};
-/**
- * Extended auth controller with common optional auth methods.
- * Backend implementations (Rebase backend, Firebase, Supabase, etc.)
- * extend this with their own backend-specific extras.
- * @group Hooks and utilities
- */
-export interface AuthControllerExtended<USER extends User = User, ExtraData = unknown> extends AuthController<USER, ExtraData> {
-    /** Login with email and password */
-    emailPasswordLogin?(email: string, password: string): Promise<void>;
-    /** Login with Google — accepts an ID token, access token, or authorization code payload */
-    googleLogin?: (payload: {
-        idToken: string;
-    } | {
-        accessToken: string;
-    } | {
-        code: string;
-        redirectUri: string;
-    }) => Promise<void>;
-    /** Generic OAuth login — works with any provider. Posts payload to /auth/{providerId}. */
-    oauthLogin?: (providerId: string, payload: Record<string, unknown>) => Promise<void>;
-    /** Register a new user */
-    register?(email: string, password: string, displayName?: string): Promise<void>;
-    /** Skip login (for anonymous access if enabled) */
-    skipLogin?(): void;
-    /** Request password reset email */
-    forgotPassword?(email: string): Promise<void>;
-    /** Reset password using a token */
-    resetPassword?(token: string, password: string): Promise<void>;
-    /** Change password for the authenticated user */
-    changePassword?(oldPassword: string, newPassword: string): Promise<void>;
-    /** Update user profile */
-    updateProfile?(displayName?: string, photoURL?: string): Promise<USER>;
-}

package/dist/types/src/controllers/client.d.ts

@@ -1,168 +0,0 @@
-import type { User } from "../users";
-import type { RebaseData } from "./data";
-import type { EmailService } from "./email";
-/**
- * Event type for authentication state changes
- */
-export type AuthChangeEvent = "SIGNED_IN" | "SIGNED_OUT" | "TOKEN_REFRESHED" | "USER_UPDATED";
-/**
- * Standard session interface representing an authenticated state
- */
-export interface RebaseSession {
-    accessToken: string;
-    refreshToken: string;
-    expiresAt: number;
-    user: User;
-}
-import type { StorageSource } from "./storage";
-/**
- * Unified Authentication Client Interface
- * Pure functional SDK interface, decoupled from UI and React hooks
- */
-export interface AuthClient {
-    /**
-     * Get the current user from the server or cache
-     */
-    getUser(): Promise<User | null>;
-    /**
-     * Get the currently active session
-     */
-    getSession(): RebaseSession | null;
-    /**
-     * Sign out the current user and clear local session
-     */
-    signOut(): Promise<void>;
-    /**
-     * Subscribe to authentication state changes
-     */
-    onAuthStateChange(callback: (event: AuthChangeEvent, session: RebaseSession | null) => void): () => void;
-    /**
-     * Manually refresh the session token
-     */
-    refreshSession(): Promise<RebaseSession>;
-}
-/**
- * User record as returned by the Admin API.
- * @group Admin
- */
-export interface AdminUser {
-    uid: string;
-    email: string;
-    displayName: string | null;
-    photoURL: string | null;
-    provider: string;
-    roles: string[];
-    metadata?: Record<string, any>;
-    createdAt: string;
-    updatedAt: string;
-}
-/**
- * Client-side Admin API interface.
- * Provides user management operations.
- * @group Admin
- */
-export interface AdminAPI {
-    listUsers(): Promise<{
-        users: AdminUser[];
-    }>;
-    listUsersPaginated(options?: {
-        search?: string;
-        limit?: number;
-        offset?: number;
-        orderBy?: string;
-        orderDir?: "asc" | "desc";
-    }): Promise<{
-        users: AdminUser[];
-        total: number;
-        limit: number;
-        offset: number;
-    }>;
-    getUser(userId: string): Promise<{
-        user: AdminUser;
-    }>;
-    createUser(data: {
-        email: string;
-        displayName?: string;
-        password?: string;
-        roles?: string[];
-        metadata?: Record<string, any>;
-    }): Promise<{
-        user: AdminUser;
-    }>;
-    updateUser(userId: string, data: {
-        email?: string;
-        displayName?: string;
-        password?: string;
-        roles?: string[];
-        metadata?: Record<string, any>;
-    }): Promise<{
-        user: AdminUser;
-    }>;
-    deleteUser(userId: string): Promise<{
-        success: boolean;
-    }>;
-    bootstrap(): Promise<{
-        success: boolean;
-        message: string;
-        user: {
-            uid: string;
-            roles: string[];
-        };
-    }>;
-}
-/**
- * Overarching abstraction that unites Data, Auth, Storage, and Email.
- * Adapters for Supabase or Firebase simply need to implement this interface.
- */
-export interface RebaseClient<DB = unknown> {
-    /** Unified Data access layer */
-    data: RebaseData;
-    /** Unified Authentication layer */
-    auth: AuthClient;
-    /** Unified Storage layer */
-    storage?: StorageSource;
-    /**
-     * Server-side email service.
-     *
-     * Available when SMTP (or a custom `sendEmail` function) is configured
-     * in the backend auth config. `undefined` when email is not configured.
-     *
-     * > **Note:** This is only available on the server-side `rebase` singleton.
-     * > The client-side SDK does not include an email service.
-     */
-    email?: EmailService;
-    /** Admin API for user management */
-    admin?: AdminAPI;
-    /**
-     * The base HTTP URL of the backend server.
-     * Exposed by the SDK client (`@rebasepro/client`) and used to auto-derive
-     * the `ApiConfigProvider` URL.
-     */
-    baseUrl?: string;
-    /**
-     * WebSocket client for realtime subscriptions and admin capabilities.
-     * Exposed by the SDK client (`@rebasepro/client`). The shape is intentionally
-     * left as `unknown` in the base interface — callers should narrow via feature
-     * detection (e.g. `typeof ws.executeSql === "function"`).
-     */
-    ws?: unknown;
-    /**
-     * Execute raw SQL against the database.
-     *
-     * Only available server-side when the backend uses a SQL database
-     * (PostgreSQL, MySQL, etc.). `undefined` for document databases
-     * (MongoDB, Firestore) and on the client-side SDK.
-     *
-     * @example
-     * ```typescript
-     * // In a cron job or custom function:
-     * if (ctx.client.sql) {
-     *     const rows = await ctx.client.sql("SELECT count(*) FROM orders");
-     * }
-     * ```
-     */
-    sql?(query: string, options?: {
-        database?: string;
-        role?: string;
-    }): Promise<Record<string, unknown>[]>;
-}

package/dist/types/src/controllers/collection_registry.d.ts

@@ -1,46 +0,0 @@
-import type { EntityCollection } from "../types/collections";
-import type { EntityReference } from "../types/entities";
-/**
- * Controller that provides access to the registered entity collections.
- * @group Models
- */
-export type CollectionRegistryController<DB = Record<string, unknown>, EC extends EntityCollection = EntityCollection> = {
-    /**
-     * List of the mapped collections in the CMS.
-     * Each entry relates to a collection in the root database.
-     * Each of the navigation entries in this field
-     * generates an entry in the main menu.
-     */
-    collections?: EntityCollection[];
-    /**
-     * Is the registry ready to be used
-     */
-    initialised: boolean;
-    /**
-     * Get the collection configuration for a given path.
-     * The collection is resolved from the given path or alias.
-     */
-    getCollection: <K extends keyof DB>(slugOrPath: Extract<K, string>, includeUserOverride?: boolean) => EC | undefined;
-    /**
-     * Get the raw, un-normalized collection configuration.
-     * This bypasses the `CollectionRegistry` normalization (such as injecting `relation` instances).
-     * This is strictly for the Visual Editor to manipulate AST code without persisting runtime state.
-     */
-    getRawCollection: (slugOrPath: string) => EC | undefined;
-    /**
-     * Retrieve all the related parent references for a given path
-     * @param path
-     */
-    getParentReferencesFromPath: (path: string) => EntityReference[];
-    /**
-     * Retrieve all the related parent collection ids for a given path
-     * @param path
-     */
-    getParentCollectionSlugs: (path: string) => string[];
-    getParentEntityIds: (path: string) => string[];
-    /**
-     * Resolve paths from a list of ids
-     * @param ids
-     */
-    convertIdsToPaths: (ids: string[]) => string[];
-};