@rebasepro/types 0.0.1-canary.0

package/src/types/user_management_delegate.ts

@@ -0,0 +1,98 @@
+import { Role, User } from "../users";
+
+
+/**
+ * Delegate to manage users, roles, and their permissions.
+ * This interface allows the CMS to be completely agnostic of the underlying
+ * authentication provider or backend.
+ * 
+ * @group Models
+ */
+export interface UserManagementDelegate<USER extends User = User> {
+
+    /**
+     * Are the users and roles currently being fetched?
+     */
+    loading: boolean;
+
+    /**
+     * List of users managed by the CMS.
+     */
+    users: USER[];
+
+    /**
+     * Optional error if users failed to load.
+     */
+    usersError?: Error;
+
+    /**
+     * Function to get a user by its uid. This is used to show
+     * user information when assigning ownership of an entity.
+     * @param uid 
+     */
+    getUser: (uid: string) => USER | null;
+
+    /**
+     * Save a user (create or update)
+     * @param user 
+     */
+    saveUser?: (user: USER) => Promise<USER>;
+
+    /**
+     * Delete a user
+     * @param user 
+     */
+    deleteUser?: (user: USER) => Promise<void>;
+
+    /**
+     * List of roles defined in the CMS.
+     */
+    roles?: Role[];
+
+    /**
+     * Optional error if roles failed to load.
+     */
+    rolesError?: Error;
+
+    /**
+     * Save a role (create or update)
+     * @param role 
+     */
+    saveRole?: (role: Role) => Promise<void>;
+
+    /**
+     * Delete a role
+     * @param role 
+     */
+    deleteRole?: (role: Role) => Promise<void>;
+
+    /**
+     * Is the currently logged in user an admin?
+     */
+    isAdmin?: boolean;
+
+    /**
+     * If true, the UI will allow the user to create the default roles (admin, editor, viewer).
+     */
+    allowDefaultRolesCreation?: boolean;
+
+    /**
+     * Should collection config permissions be included?
+     */
+    includeCollectionConfigPermissions?: boolean;
+
+
+
+    /**
+     * Optionally define roles for a given user. This is useful when the roles
+     * are coming from a separate provider than the one issuing the tokens.
+     */
+    defineRolesFor?: (user: USER) => Promise<Role[] | undefined> | Role[] | undefined;
+
+    /**
+     * Optional function to bootstrap an admin user.
+     * Often used when the database is empty.
+     */
+    bootstrapAdmin?: () => Promise<void>;
+
+}

package/src/types/websockets.ts

@@ -0,0 +1,37 @@
+import { Entity } from "./entities";
+
+export interface WebSocketMessage {
+    type: string;
+    payload?: unknown;
+    subscriptionId?: string;
+    requestId?: string;
+    entities?: Entity<Record<string, unknown>>[];
+    entity?: Entity<Record<string, unknown>> | null;
+    error?: string;
+}
+
+export interface CollectionUpdateMessage extends WebSocketMessage {
+    type: "collection_update";
+    subscriptionId: string;
+    entities: Entity<Record<string, unknown>>[];
+}
+
+export interface EntityUpdateMessage extends WebSocketMessage {
+    type: "entity_update";
+    subscriptionId: string;
+    entity: Entity<Record<string, unknown>> | null;
+}
+
+/**
+ * Column metadata returned by table introspection.
+ */
+export interface TableColumnInfo {
+    column_name: string;
+    data_type: string;
+    udt_name: string;
+    is_nullable: string;
+    column_default: string | null;
+    character_maximum_length: number | null;
+    /** Enum values, populated for USER-DEFINED (enum) columns */
+    enum_values?: string[];
+}

package/src/users/index.ts

@@ -0,0 +1,2 @@
+export * from "./user";
+export * from "./roles";

package/src/users/roles.ts

@@ -0,0 +1,33 @@
+
+
+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/src/users/user.ts

@@ -0,0 +1,46 @@
+
+/**
+ * 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>;
+
+};