@rebasepro/types 0.0.1-canary.0

package/dist/users/roles.d.ts

@@ -0,0 +1,22 @@
+export type Role = {
+    /**
+     * ID of the role
+     */
+    id: string;
+    /**
+     * Name of the role
+     */
+    name: string;
+    /**
+     * If this flag is true, the user can perform any action
+     */
+    isAdmin?: boolean;
+    /**
+     * Permissions related to editing the collections
+     */
+    config?: {
+        createCollections?: boolean;
+        editCollections?: boolean | "own";
+        deleteCollections?: boolean | "own";
+    };
+};

package/dist/users/user.d.ts

@@ -0,0 +1,42 @@
+/**
+ * This interface represents a user.
+ * It has some of the same fields as a Firebase User.
+ * Note that in the default implementation, we simply take the Firebase user
+ * and use it as a Rebase user, so that means that even if they are not mapped
+ * in this interface, it contains all the methods of the former, such as `delete`,
+ * `getIdToken`, etc.
+ *
+ * @group Models
+ */
+export type User = {
+    /**
+     * The user's unique ID, scoped to the project.
+     */
+    readonly uid: string;
+    /**
+     * The display name of the user.
+     */
+    readonly displayName: string | null;
+    /**
+     * The email of the user.
+     */
+    readonly email: string | null;
+    /**
+     * The profile photo URL of the user.
+     */
+    readonly photoURL: string | null;
+    /**
+     * The provider used to authenticate the user.
+     */
+    readonly providerId: string;
+    /**
+     *
+     */
+    readonly isAnonymous: boolean;
+    /**
+     * Role IDs assigned to this user (e.g. ["admin", "editor"]).
+     * These are plain string IDs — use the UserManagementDelegate to look up full Role objects.
+     */
+    roles?: string[];
+    getIdToken?: (forceRefresh?: boolean) => Promise<string>;
+};

package/package.json

@@ -0,0 +1,137 @@
+{
+    "name": "@rebasepro/types",
+    "type": "module",
+    "version": "0.0.1-canary.0",
+    "description": "Awesome Firebase/Firestore-based headless open-source CMS",
+    "funding": {
+        "url": "https://github.com/sponsors/rebaseco"
+    },
+    "author": "Rebase",
+    "license": "MIT",
+    "repository": {
+        "type": "git",
+        "url": "https://github.com/rebaseco/rebase.git",
+        "directory": "packages/types"
+    },
+    "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",
+        "firebase panel",
+        "firestore",
+        "headless",
+        "headless cms",
+        "content manager"
+    ],
+    "scripts": {
+        "watch": "vite build --watch",
+        "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
+        "prepublishOnly": "run-s build",
+        "test:lint": "eslint \"src/**\" --quiet",
+        "test": "jest --passWithNoTests",
+        "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f"
+    },
+    "exports": {
+        ".": {
+            "development": "./src/index.ts",
+            "import": "./dist/index.es.js",
+            "require": "./dist/index.umd.js",
+            "types": "./dist/index.d.ts"
+        },
+        "./package.json": "./package.json"
+    },
+    "dependencies": {
+        "@dnd-kit/core": "^6.3.1",
+        "@dnd-kit/modifiers": "^9.0.0",
+        "@dnd-kit/sortable": "^10.0.0",
+        "@radix-ui/react-portal": "^1.1.5",
+        "@rebasepro/editor": "0.0.1-canary.0",
+        "@rebasepro/formex": "0.0.1-canary.0",
+        "@rebasepro/ui": "0.0.1-canary.0",
+        "clsx": "^2.1.1",
+        "date-fns": "^3.6.0",
+        "fast-equals": "5.3.0",
+        "fuse.js": "^7.1.0",
+        "history": "^5.3.0",
+        "markdown-it": "^14.1.0",
+        "notistack": "^3.0.2",
+        "object-hash": "^3.0.0",
+        "prism-react-renderer": "^2.4.1",
+        "react-dropzone": "^14.3.8",
+        "react-image-file-resizer": "^0.4.8",
+        "react-transition-group": "^4.4.5",
+        "react-use-measure": "^2.1.7",
+        "react-window": "^1.8.11",
+        "yup": "^0.32.11"
+    },
+    "peerDependencies": {
+        "react": ">=19.0.0",
+        "react-dom": ">=19.0.0",
+        "react-router": "^6.28.0",
+        "react-router-dom": "^6.28.0"
+    },
+    "devDependencies": {
+        "@jest/globals": "^29.7.0",
+        "@testing-library/react": "^16.3.0",
+        "@testing-library/user-event": "^14.6.1",
+        "@types/jest": "^29.5.14",
+        "@types/node": "^20.17.14",
+        "@types/object-hash": "^3.0.6",
+        "@types/react": "^19.0.8",
+        "@types/react-dom": "^19.0.3",
+        "@types/react-measure": "^2.0.12",
+        "@vitejs/plugin-react": "^4.3.4",
+        "babel-plugin-react-compiler": "beta",
+        "cross-env": "^7.0.3",
+        "eslint-plugin-react-compiler": "beta",
+        "jest": "^29.7.0",
+        "npm-run-all": "^4.1.5",
+        "react-router": "^7.13.1",
+        "react-router-dom": "^7.13.1",
+        "ts-jest": "^29.3.1",
+        "ts-node": "^10.9.2",
+        "tsd": "^0.31.2",
+        "typescript": "^5.8.3",
+        "vite": "^5.4.17"
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "gitHead": "646afae9c387c3ce02c699d98cd8c7272bdd1929",
+    "publishConfig": {
+        "access": "public"
+    },
+    "eslintConfig": {
+        "extends": [
+            "react-app",
+            "react-app/jest"
+        ]
+    },
+    "jest": {
+        "transform": {
+            "^.+\\.tsx?$": "ts-jest"
+        },
+        "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+        "moduleFileExtensions": [
+            "ts",
+            "tsx",
+            "js",
+            "jsx",
+            "json",
+            "node"
+        ],
+        "testEnvironment": "node",
+        "moduleNameMapper": {
+            "\\.(css|less)$": "<rootDir>/test/__mocks__/styleMock.js"
+        }
+    }
+}

package/src/components/EntityFormActionsProps.tsx

@@ -0,0 +1,18 @@
+import { Entity, EntityCollection, FormContext } from "../types";
+import { FormexController } from "./formex";
+
+export interface EntityFormActionsProps {
+    path: string;
+    collection: EntityCollection;
+    entity?: Entity;
+    layout: "bottom" | "side";
+    savingError?: Error;
+    formex: FormexController<any>;
+    disabled: boolean;
+    status: "new" | "existing" | "copy";
+    pluginActions: React.ReactNode[];
+    openEntityMode: "side_panel" | "full_screen";
+    showDefaultActions?: boolean;
+    navigateBack: () => void;
+    formContext: FormContext
+}

package/src/components/EntityFormProps.tsx

@@ -0,0 +1,52 @@
+import { Entity, EntityCollection, EntityCustomViewParams, EntityStatus, FormContext } from "../types";
+import { FormexController } from "./formex";
+import { EntityFormActionsProps } from "./EntityFormActionsProps";
+
+export type EntityFormProps<M extends Record<string, any>> = {
+    path: string;
+    fullIdPath?: string;
+    collection: EntityCollection<M>;
+    entityId?: string | number;
+    entity?: Entity<M>;
+    databaseId?: string;
+    onIdChange?: (id: string | number) => void;
+    onValuesModified?: (modified: boolean, values: M) => void;
+    onSaved?: (params: OnUpdateParams) => void;
+    initialDirtyValues?: Partial<M>; // dirty cached entity in memory
+    onFormContextReady?: (formContext: FormContext) => void;
+    forceActionsAtTheBottom?: boolean;
+    className?: string;
+    initialStatus: EntityStatus;
+    onStatusChange?: (status: EntityStatus) => void;
+    onEntityChange?: (entity: Entity<M>) => void;
+    formex?: FormexController<M>;
+    openEntityMode?: "side_panel" | "full_screen";
+    /**
+     * If true, the form will be disabled and no actions will be available
+     */
+    disabled?: boolean;
+    /**
+     * Include the copy and delete actions in the form
+     */
+    showDefaultActions?: boolean;
+
+    /**
+     * Display the entity path in the form
+     */
+    showEntityPath?: boolean;
+
+    EntityFormActionsComponent?: React.FC<EntityFormActionsProps>;
+
+    Builder?: React.ComponentType<EntityCustomViewParams<M>>;
+
+    children?: React.ReactNode;
+};
+
+export type OnUpdateParams = {
+    entity: Entity<any>,
+    status: EntityStatus,
+    path: string,
+    entityId?: string | number;
+    selectedTab?: string;
+    collection: EntityCollection<any>
+};

package/src/components/PropertyPreviewProps.tsx

@@ -0,0 +1,61 @@
+import { InferPropertyType, Property } from "../types";
+
+/**
+ * @group Preview components
+ */
+export type PreviewSize = "small" | "medium" | "large";
+
+/**
+ * @group Preview components
+ */
+export interface PropertyPreviewProps<P extends Property, CustomProps = unknown> {
+    /**
+     * Name of the property
+     */
+    propertyKey?: string;
+
+    /**
+     * Current value of the property, inferred from the property schema P
+     */
+    value: InferPropertyType<P>;
+
+    /**
+     * Property this display is related to, now strongly typed to P
+     */
+    property: P;
+
+    /**
+     * Desired size of the preview, depending on the context.
+     */
+    size: PreviewSize;
+
+    /**
+     * Max height assigned to the preview, depending on the context.
+     * It may be undefined if unlimited.
+     */
+    height?: number;
+
+    /**
+     * Max height width to the preview, depending on the context.
+     * It may be undefined if unlimited.
+     */
+    width?: number;
+
+    /**
+     * Additional properties set by the developer
+     */
+    customProps?: CustomProps;
+
+    /**
+     * If the preview should be interactive or not.
+     * This applies only to videos.
+     */
+    interactive?: boolean;
+
+    /**
+     * If true, image previews will fill their container completely.
+     * Only applies to image type properties.
+     */
+    fill?: boolean;
+
+}

package/src/components/formex.tsx

@@ -0,0 +1,46 @@
+import React, { FormEvent } from "react";
+
+// this is duplicated from the formex package
+export type FormexController<T extends object> = {
+    values: T;
+    initialValues: T;
+    setValues: (values: T) => void;
+    setFieldValue: (key: string, value: unknown, shouldValidate?: boolean) => void;
+    touched: Record<string, boolean>;
+    setFieldTouched: (key: string, touched: boolean, shouldValidate?: boolean) => void;
+    setTouched: (touched: Record<string, boolean>) => void;
+    dirty: boolean;
+    setDirty: (dirty: boolean) => void;
+    setSubmitCount: (submitCount: number) => void;
+    errors: Record<string, string>;
+    setFieldError: (key: string, error?: string) => void;
+    handleChange: (event: React.SyntheticEvent) => void,
+    handleBlur: (event: React.FocusEvent) => void,
+    handleSubmit: (event?: FormEvent<HTMLFormElement>) => void;
+    validate: () => void;
+    resetForm: (props?: FormexResetProps<T>) => void;
+    submitCount: number;
+    isSubmitting: boolean;
+    setSubmitting: (isSubmitting: boolean) => void;
+    isValidating: boolean;
+    /**
+     * The version of the form. This is incremented every time the form is reset
+     * or the form is submitted.
+     */
+    version: number;
+
+    debugId?: string;
+
+    undo: () => void;
+    redo: () => void;
+
+    canUndo: boolean;
+    canRedo: boolean;
+}
+
+export type FormexResetProps<T extends object> = {
+    values?: T;
+    submitCount?: number;
+    errors?: Record<string, string>;
+    touched?: Record<string, boolean>;
+};

package/src/components/index.ts

@@ -0,0 +1,3 @@
+export * from "./PropertyPreviewProps";
+export * from "./EntityFormProps";
+export * from "./EntityFormActionsProps";

package/src/controllers/analytics_controller.tsx

@@ -0,0 +1,57 @@
+export type AnalyticsController = {
+
+    /**
+     * Callback used to get analytics events from the CMS
+     */
+    onAnalyticsEvent?: (event: CMSAnalyticsEvent, data?: object) => void;
+
+}
+
+export type CMSAnalyticsEvent =
+    | "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/src/controllers/auth.tsx

@@ -0,0 +1,94 @@
+import { DataSource } from "./datasource";
+import { StorageSource } from "./storage";
+import { Role, User } from "../users";
+
+/**
+ * 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 = any, 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: Role[]) => void;
+
+};
+
+/**
+ * Implement this function to allow access to specific users.
+ * @group Hooks and utilities
+ */
+export type Authenticator<USER extends User = User> = (props: {
+
+    /**
+     * Logged-in user or null
+     */
+    user: USER | null;
+
+    /**
+     * AuthController
+     */
+    authController: AuthController<USER>;
+
+    /**
+     * Connector to your database, e.g. your Firestore database
+     */
+    dataSource: DataSource;
+
+    /**
+     * Used storage implementation
+     */
+    storageSource: StorageSource;
+
+}) => boolean | Promise<boolean>;

package/src/controllers/customization_controller.tsx

@@ -0,0 +1,61 @@
+import React from "react";
+import { EntityAction, EntityCustomView, EntityLinkBuilder, RebasePlugin, Locale, PropertyConfig } from "../types";
+
+export type CustomizationController = {
+
+    /**
+     * Builder for generating utility links for entities
+     */
+    entityLinkBuilder?: EntityLinkBuilder;
+
+    /**
+     * Use plugins to modify the behaviour of the CMS.
+     */
+    plugins?: RebasePlugin[];
+
+    /**
+     * List of additional custom views for entities.
+     * You can use the key to reference the custom view in
+     * the `entityViews` prop of a collection.
+     *
+     * You can also define an entity view from the UI.
+     */
+    entityViews?: EntityCustomView[];
+
+    /**
+     * List of actions that can be performed on entities.
+     * These actions are displayed in the entity view and in the collection view.
+     * You can later reuse these actions in the `entityActions` prop of a collection,
+     * by specifying the `key` of the action.
+     */
+    entityActions?: EntityAction[];
+
+    /**
+     * Format of the dates in the CMS.
+     * Defaults to 'MMMM dd, yyyy, HH:mm:ss'
+     */
+    dateTimeFormat?: string;
+
+    /**
+     * Locale of the CMS, currently only affecting dates
+     */
+    locale?: Locale;
+
+    /**
+     * Record of custom form fields to be used in the CMS.
+     * You can use the key to reference the custom field in
+     * the `propertyConfig` prop of a property in a collection.
+     */
+    propertyConfigs: Record<string, PropertyConfig>;
+
+    components?: {
+
+        /**
+         * Component to render when a reference is missing
+         */
+        missingReference?: React.ComponentType<{
+            path: string,
+        }>;
+
+    };
+}