@rebasepro/server-postgresql 0.5.0 → 0.6.1

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

@@ -1,67 +0,0 @@
-import React from "react";
-/**
- * Controller to open the side dialog
- * @group Hooks and utilities
- */
-export interface SideDialogsController {
-    /**
-     * Close the last panel
-     */
-    close: () => void;
-    /**
-     * List of side panels currently open
-     */
-    sidePanels: SideDialogPanelProps[];
-    /**
-     * Override the current side panels
-     * @param panels
-     */
-    setSidePanels: (panels: SideDialogPanelProps[]) => void;
-    /**
-     * Open one or multiple side panels
-     * @param props
-     */
-    open: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
-    /**
-     * Replace the last open panel with the given one
-     * @param props
-     */
-    replace: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
-}
-/**
- * Props used to open a side dialog
- * @group Hooks and utilities
- */
-export interface SideDialogPanelProps {
-    /**
-     * A key that identifies this panel
-     */
-    key: string;
-    /**
-     * The component type that will be rendered
-     */
-    component: React.ReactNode;
-    /**
-     * Optional width of the panel
-     */
-    width?: string;
-    /**
-     * When open, change the URL to this path.
-     * Note that if you want to restore state from a URL you need to add the
-     * logic yourself by listening to URL updates, and probably call `open`.
-     */
-    urlPath?: string;
-    /**
-     * If the navigation stack is empty (you landed in the `urlPath` url), what
-     * url path to change to when the panel gets closed.
-     */
-    parentUrlPath?: string;
-    /**
-     * Callback when the panel is closed
-     */
-    onClose?: () => void;
-    /**
-     * Use this prop to store additional data in the panel
-     */
-    additional?: unknown;
-}

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

@@ -1,97 +0,0 @@
-import type { Entity } from "../types/entities";
-import type { EntityCollection } from "../types/collections";
-/**
- * Props used to open a side dialog
- * @group Hooks and utilities
- */
-export interface EntitySidePanelProps<M extends Record<string, unknown> = Record<string, unknown>> {
-    /**
-     * Absolute path of the entity
-     */
-    path: string;
-    /**
-     * ID of the entity, if not set, it means we are creating a new entity
-     */
-    entityId?: string | number;
-    /**
-     * Set this flag to true if you want to make a copy of an existing entity
-     */
-    copy?: boolean;
-    /**
-     * Open the entity with a selected sub-collection view. If the panel for this
-     * entity was already open, it is replaced.
-     */
-    selectedTab?: string;
-    /**
-     * Use this prop to override the width of the form view.
-     * e.g. "600px"
-     */
-    width?: number | string;
-    /**
-     * Collection representing the entities of this view.
-     * If you leave it blank it will be induced by your navigation
-     */
-    collection?: EntityCollection<M>;
-    /**
-     * Should update the URL when opening the dialog.
-     * Consider that if the collection that you provide is not defined in the base
-     * config of your `Rebase` component, you will not be able to recreate
-     * the state if copying the URL to a different window.
-     */
-    updateUrl?: boolean;
-    /**
-     * Callback when the entity is updated
-     * @param params
-     */
-    onUpdate?: (params: {
-        entity: Entity<M>;
-    }) => void;
-    /**
-     * Callback when the dialog is closed
-     */
-    onClose?: () => void;
-    /**
-     * Should this panel close when saving
-     */
-    closeOnSave?: boolean;
-    /**
-     * Override some form properties
-     */
-    formProps?: Record<string, unknown>;
-    /**
-     * Allow the user to open the entity fullscreen
-     */
-    allowFullScreen?: boolean;
-    /**
-     * Pre-populate the form with these values when creating a new entity.
-     * Only applied when `entityId` is not set (i.e. the form is in "new" mode).
-     * Useful for actions that fetch data from an external source (e.g. a URL)
-     * and want to pre-fill the document before the user saves.
-     */
-    defaultValues?: Partial<M>;
-}
-/**
- * Controller to open the side dialog displaying entity forms
- * @group Hooks and utilities
- */
-export interface SideEntityController {
-    /**
-     * Close the last panel
-     */
-    close: () => void;
-    /**
-     * Open a new entity sideDialog. By default, the collection and configuration
-     * of the view is fetched from the collections you have specified in the
-     * navigation.
-     * At least you need to pass the path of the entity you would like
-     * to edit. You can set an entityId if you would like to edit and existing one
-     * (or a new one with that id).
-     * @param props
-     */
-    open: <M extends Record<string, unknown> = Record<string, unknown>>(props: EntitySidePanelProps<M>) => void;
-    /**
-     * Replace the last open entity panel with the given one.
-     * @param props
-     */
-    replace: <M extends Record<string, unknown> = Record<string, unknown>>(props: EntitySidePanelProps<M>) => void;
-}

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

@@ -1,24 +0,0 @@
-/**
- * Possible snackbar types
- * @group Hooks and utilities
- */
-export type SnackbarMessageType = "success" | "info" | "warning" | "error";
-/**
- * Controller to display snackbars
- * @group Hooks and utilities
- */
-export interface SnackbarController {
-    /**
-     * Close the currently open snackbar
-     */
-    close: () => void;
-    /**
-     * Display a new snackbar. You need to specify the type and message.
-     * You can optionally specify a title
-     */
-    open: (props: {
-        type: SnackbarMessageType;
-        message: React.ReactNode;
-        autoHideDuration?: number;
-    }) => void;
-}

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

@@ -1,171 +0,0 @@
-/**
- * @group Models
- */
-export interface UploadFileProps {
-    file: File;
-    key: string;
-    metadata?: Record<string, unknown>;
-    bucket?: string;
-}
-/**
- * @group Models
- */
-export interface UploadFileResult {
-    /**
-     * Storage key including the file name where the file was uploaded.
-     */
-    key: string;
-    /**
-     * Bucket where the file was uploaded
-     */
-    bucket: string;
-    /**
-     * Fully qualified storage URL for the uploaded file.
-     *
-     * For example: `s3://my-bucket/path/to/file.png`.
-     *
-     * This is optional for backwards compatibility.
-     */
-    storageUrl?: string;
-}
-/**
- * @group Models
- */
-export interface DownloadConfig {
-    /**
-     * Temporal url that can be used to download the file
-     */
-    url: string | null;
-    metadata?: DownloadMetadata;
-    fileNotFound?: boolean;
-}
-/**
- * The full set of object metadata, including read-only properties.
- * @public
- */
-export declare interface DownloadMetadata {
-    /**
-     * The bucket this object is contained in.
-     */
-    bucket: string;
-    /**
-     * The full path of this object.
-     */
-    fullPath: string;
-    /**
-     * The short name of this object, which is the last component of the full path.
-     * For example, if path is 'full/path/image.png', name is 'image.png'.
-     */
-    name: string;
-    /**
-     * The size of this object, in bytes.
-     */
-    size: number;
-    /**
-     * Type of the uploaded file
-     * e.g. "image/jpeg"
-     */
-    contentType: string;
-    customMetadata: Record<string, unknown>;
-}
-/**
- * @group Models
- */
-export interface StorageSource {
-    /**
-     * Upload an object, specifying a key
-     * @param file
-     * @param key
-     * @param metadata
-     * @param bucket
-     */
-    putObject: ({ file, key, metadata, bucket }: UploadFileProps) => Promise<UploadFileResult>;
-    /**
-     * Convert a storage key or URL into a download configuration (signed URL equivalent)
-     * @param keyOrUrl
-     * @param bucket
-     */
-    getSignedUrl: (keyOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
-    /**
-     * Get an object from a storage key.
-     * It returns null if the object does not exist.
-     * @param key
-     * @param bucket
-     */
-    getObject: (key: string, bucket?: string) => Promise<File | null>;
-    /**
-     * Delete an object.
-     * @param key
-     * @param bucket
-     */
-    deleteObject: (key: string, bucket?: string) => Promise<void>;
-    /**
-     * List the contents of a prefix.
-     * @param prefix
-     * @param options
-     */
-    listObjects: (prefix: string, options?: {
-        bucket?: string;
-        maxResults?: number;
-        pageToken?: string;
-    }) => Promise<StorageListResult>;
-}
-/**
- * Result returned by list().
- * @public
- */
-export declare interface StorageListResult {
-    /**
-     * References to prefixes (sub-folders). You can call list() on them to
-     * get its contents.
-     *
-     * Folders are implicit based on '/' in the object paths.
-     * For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a')
-     * will return '/a/b' as a prefix.
-     */
-    prefixes: StorageReference[];
-    /**
-     * Objects in this directory.
-     * You can call getMetadata() and getDownloadUrl() on them.
-     */
-    items: StorageReference[];
-    /**
-     * If set, there might be more results for this list. Use this token to resume the list.
-     */
-    nextPageToken?: string;
-}
-/**
- * Represents a reference to an S3-compatible storage object. Developers can
- * upload, download, and delete objects, as well as get/set object metadata.
- * @public
- */
-export declare interface StorageReference {
-    /**
-     * Returns a s3:// URL for this object in the form
-     *   `s3://<bucket>/<path>/<to>/<object>`
-     * @returns The s3:// URL.
-     */
-    toString(): string;
-    /**
-     * A reference to the root of this object's bucket.
-     */
-    root: StorageReference;
-    /**
-     * The name of the bucket containing this reference's object.
-     */
-    bucket: string;
-    /**
-     * The full path of this object.
-     */
-    fullPath: string;
-    /**
-     * The short name of this object, which is the last component of the full path.
-     * For example, if path is 'full/path/image.png', name is 'image.png'.
-     */
-    name: string;
-    /**
-     * A reference pointing to the parent location of this reference, or null if
-     * this reference is the root.
-     */
-    parent: StorageReference | null;
-}

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

@@ -1,4 +0,0 @@
-export * from "./rebase_context";
-export * from "./types";
-export * from "./controllers";
-export * from "./users";

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

@@ -1,122 +0,0 @@
-import type { AnalyticsController } from "./controllers/analytics_controller";
-import type { AuthController } from "./controllers/auth";
-import type { StorageSource } from "./controllers/storage";
-import type { UserConfigurationPersistence } from "./controllers/local_config_persistence";
-import type { DatabaseAdmin } from "./types/backend";
-import type { RebaseClient } from "./controllers/client";
-import type { RebaseData } from "./controllers/data";
-import type { User } from "./users";
-import type { UserManagementDelegate } from "./types/user_management_delegate";
-/**
- * Context that is provided to entity callbacks (hooks).
- * It contains only the dependencies that are available in both the frontend and the backend.
- * @group Hooks and utilities
- */
-export type RebaseCallContext<USER extends User = User> = {
-    /**
-     * The Rebase client instance.
-     * Available in all entity callbacks (beforeSave, afterSave, afterRead,
-     * beforeDelete, afterDelete) and in CollectionActionsProps via context.
-     * Use it to call backend functions, access data, storage, etc.
-     *
-     * @example
-     * // In a beforeSave callback:
-     * const result = await context.client.functions.invoke('my-function', { ... });
-     *
-     * @example
-     * // In a CollectionAction component:
-     * const { client } = props.context;
-     * const result = await client.functions.invoke('extract-job', { url });
-     */
-    client: RebaseClient;
-    /**
-     * Unified data access — `context.data.products.create(...)`.
-     * Access any collection as a dynamic property.
-     */
-    data: RebaseData;
-    /**
-     * Used storage implementation
-     */
-    storageSource: StorageSource;
-    /**
-     * Set by the backend when callbacks are executed on the server.
-     */
-    user?: USER;
-};
-/**
- * Context that includes the internal controllers and contexts used by the app.
- * Some controllers and context included in this context can be accessed
- * directly from their respective hooks.
- * @group Hooks and utilities
- * @see useRebaseContext
- */
-export type RebaseContext<USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>> = RebaseCallContext<USER> & {
-    authController: AuthControllerType;
-    /**
-     * Controller mapping strings to collections
-     */
-    collectionRegistryController?: import("./controllers/collection_registry").CollectionRegistryController;
-    /**
-     * Controller for navigation state
-     */
-    navigationStateController?: import("./controllers/navigation").NavigationStateController;
-    /**
-     * Controller for side dialogs (side sheets)
-     */
-    sideDialogsController?: import("./controllers/side_dialogs_controller").SideDialogsController;
-    /**
-     * Controller to open the side dialog displaying entity forms
-     */
-    sideEntityController?: import("./controllers/side_entity_controller").SideEntityController;
-    /**
-     * Controller resolving URLs in the CMS
-     */
-    urlController?: import("./controllers/navigation").UrlController;
-    /**
-     * Controller to handle simple confirmation and alert dialogs
-     */
-    dialogsController?: import("./controllers/dialogs_controller").DialogsController;
-    /**
-     * Controller for CMS customization
-     */
-    customizationController?: import("./controllers/customization_controller").CustomizationController;
-    /**
-     * Controller for effective role
-     */
-    effectiveRoleController?: {
-        effectiveRole: string | null;
-        setEffectiveRole: (role: string | null) => void;
-    };
-    /**
-     * Use this controller to access data stored in the browser for the user
-     */
-    userConfigPersistence?: UserConfigurationPersistence;
-    /**
-     * Callback to send analytics events
-     */
-    analyticsController?: AnalyticsController;
-    /**
-     * This section is used to manage users in the CMS.
-     * It is used to show user information in various places of the CMS,
-     * for example, to show who created or modified an entity,
-     * or to assign ownership of an entity.
-     *
-     * In the base CMS, this information is not used for access control.
-     * You can pass your own implementation of this section, to populate
-     * the dropdown of users when assigning ownership of an entity,
-     * or to show more information about the user.
-     *
-     * If you are using the Rebase user management plugin, this
-     * section will be implemented automatically.
-     */
-    userManagement?: UserManagementDelegate<USER>;
-    /**
-     * Administrative database operations (SQL, schema discovery).
-     * Only available in developer/admin contexts.
-     */
-    databaseAdmin?: DatabaseAdmin;
-    /**
-     * Controller for snackbars
-     */
-    snackbarController?: import("./controllers/snackbar").SnackbarController;
-};