@rebasepro/types 0.0.1-canary.0

package/src/controllers/side_entity_controller.tsx

@@ -0,0 +1,104 @@
+import { Entity, EntityCollection } from "../types";
+import { EntityFormProps } from "../components";
+
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface EntitySidePanelProps<M extends Record<string, any> = any> {
+
+    /**
+     * 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<any> }) => void;
+
+    /**
+     * Callback when the dialog is closed
+     */
+    onClose?: () => void;
+
+    /**
+     * Should this panel close when saving
+     */
+    closeOnSave?: boolean;
+
+    /**
+     * Override some form properties
+     */
+    formProps?: Partial<EntityFormProps<M>>;
+
+    /**
+     * Allow the user to open the entity fullscreen
+     */
+    allowFullScreen?: boolean;
+}
+
+/**
+ * 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, any> = any>(props: EntitySidePanelProps<M>) => void;
+
+    /**
+     * Replace the last open entity panel with the given one.
+     * @param props
+     */
+    replace: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+}

package/src/controllers/snackbar.ts

@@ -0,0 +1,29 @@
+
+/**
+ * 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/src/controllers/storage.ts

@@ -0,0 +1,196 @@
+/**
+ * @group Models
+ */
+export interface UploadFileProps {
+    file: File,
+    fileName?: string,
+    path?: string,
+    metadata?: Record<string, unknown>,
+    bucket?: string
+}
+
+/**
+ * @group Models
+ */
+export interface UploadFileResult {
+    /**
+     * Storage path including the file name where the file was uploaded.
+     */
+    path: string;
+    /**
+     * Bucket where the file was uploaded
+     */
+    bucket: string;
+
+    /**
+     * Fully qualified storage URL for the uploaded file.
+     *
+     * For example: `gs://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 a file, specifying a name and a path
+     * @param file
+     * @param fileName
+     * @param path
+     * @param metadata
+     * @param bucket
+     */
+    uploadFile: ({
+                     file,
+                     fileName,
+                     path,
+                     metadata,
+                     bucket
+                 }: UploadFileProps) => Promise<UploadFileResult>;
+
+    /**
+     * Convert a storage path or URL into a download configuration
+     * @param path
+     * @param bucket
+     */
+    getDownloadURL: (pathOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
+
+    /**
+     * Get a file from a storage path.
+     * It returns null if the file does not exist.
+     * @param props
+     * @param bucket
+     */
+    getFile: (path: string, bucket?: string) => Promise<File | null>;
+
+    /**
+     * Delete a file.
+     * @param path
+     * @param bucket
+     */
+    deleteFile: (path: string, bucket?: string) => Promise<void>;
+
+    /**
+     * List the contents of a path.
+     * @param path
+     * @param options
+     */
+    list: (path: 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 a Google Cloud Storage object. Developers can
+ * upload, download, and delete objects, as well as get/set object metadata.
+ * @public
+ */
+export declare interface StorageReference {
+    /**
+     * Returns a gs:// URL for this object in the form
+     *   `gs://<bucket>/<path>/<to>/<object>`
+     * @returns The gs:// 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/src/index.ts

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

package/src/rebase_context.tsx

@@ -0,0 +1,122 @@
+import {
+    AnalyticsController,
+    AuthController,
+    CustomizationController,
+    DataSource,
+    DialogsController,
+    NavigationController,
+    SideDialogsController,
+    SideEntityController,
+    SnackbarController,
+    StorageSource,
+    UserConfigurationPersistence
+} from "./controllers";
+import { User } from "./users";
+import { UserManagementDelegate, EffectiveRoleController } from "./types";
+
+/**
+ * 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> = {
+
+    /**
+     * Connector to your database, e.g. your Firestore database
+     */
+    dataSource: DataSource;
+
+    /**
+     * 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> & {
+
+    /**
+     * Context that includes the resolved navigation and utility methods and
+     * attributes.
+     * @see useNavigation
+     */
+    navigation?: NavigationController;
+
+    /**
+     * Controller to open the side dialog displaying entity forms
+     * @see useSideEntityController
+     */
+    sideEntityController?: SideEntityController;
+
+    /**
+     * Controller used to open side dialogs
+     * This is the controller used internally by side entity dialogs
+     * or reference dialogs.
+     */
+    sideDialogsController?: SideDialogsController;
+
+    /**
+     * Controller used to open regular dialogs
+     */
+    dialogsController?: DialogsController;
+
+    /**
+     * Used auth controller
+     */
+    authController?: AuthControllerType;
+
+
+
+    /**
+     * This controller holds the customization options for the CMS.
+     */
+    customizationController?: CustomizationController;
+
+    /**
+     * Use this controller to display snackbars
+     */
+    snackbarController?: SnackbarController;
+
+    /**
+     * 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>;
+
+    /**
+     * Controller to simulate different roles when dev mode is active.
+     */
+    effectiveRoleController?: EffectiveRoleController;
+
+};