@rebasepro/common 0.2.3 → 0.2.5

package/dist/util/permissions.d.ts

@@ -1,4 +1,5 @@
 import { AuthController, Entity, EntityCollection, User } from "@rebasepro/types";
+export declare function checkOperation<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authController: AuthController<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>, authController: AuthController<USER>): boolean;
 export declare function canEditEntity<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authController: AuthController<USER>, path: string, entity: Entity<M> | null): boolean;
 export declare function canCreateEntity<M extends Record<string, unknown>, USER extends User>(collection: EntityCollection<M>, authController: AuthController<USER>, path: string, entity: Entity<M> | null): boolean;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@rebasepro/common",
   "type": "module",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "Awesome Firebase/Firestore-based headless open-source CMS",
   "funding": {
     "url": "https://github.com/sponsors/rebaseco"
@@ -41,8 +41,8 @@
   "dependencies": {
     "fast-equals": "6.0.0",
     "json-logic-js": "^2.0.5",
-    "@rebasepro/types": "0.2.3",
-    "@rebasepro/utils": "0.2.3"
+    "@rebasepro/types": "0.2.5",
+    "@rebasepro/utils": "0.2.5"
   },
   "devDependencies": {
     "@jest/globals": "^29.7.0",

package/src/collections/default-collections.ts

@@ -0,0 +1,106 @@
+import type { PostgresCollection } from "@rebasepro/types";
+
+/**
+ * Default users collection.
+ *
+ * Prepended to the developer's collections array by the admin and server.
+ * Slug-based dedup (Map keyed by slug, last-write-wins) lets developers
+ * override by defining their own collection with `slug: "users"`.
+ */
+export const defaultUsersCollection: PostgresCollection = {
+    name: "Users",
+    singularName: "User",
+    slug: "users",
+    table: "users",
+    schema: "rebase",
+    icon: "Users",
+    group: "Settings",
+    openEntityMode: "dialog",
+    disableDefaultActions: ["copy"],
+    sort: ["createdAt", "desc"],
+    properties: {
+        id: {
+            name: "ID",
+            type: "string",
+            isId: "uuid",
+            ui: { readOnly: true }
+        },
+        email: {
+            name: "Email",
+            type: "string",
+            validation: { required: true, unique: true }
+        },
+        displayName: {
+            name: "Name",
+            type: "string",
+            columnName: "display_name",
+            validation: { required: true }
+        },
+        photoURL: {
+            name: "Photo URL",
+            type: "string",
+            columnName: "photo_url",
+            url: "image"
+        },
+        roles: {
+            name: "Roles",
+            type: "array",
+            columnType: "text[]",
+            of: {
+                name: "Role",
+                type: "string",
+                enum: {
+                    admin: "Admin",
+                    editor: "Editor",
+                    viewer: "Viewer"
+                }
+            }
+        },
+        passwordHash: {
+            name: "Password Hash",
+            type: "string",
+            columnName: "password_hash",
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        },
+        emailVerified: {
+            name: "Email Verified",
+            type: "boolean",
+            columnName: "email_verified",
+            defaultValue: false,
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        },
+        emailVerificationToken: {
+            name: "Email Verification Token",
+            type: "string",
+            columnName: "email_verification_token",
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        },
+        emailVerificationSentAt: {
+            name: "Email Verification Sent At",
+            type: "date",
+            columnName: "email_verification_sent_at",
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        },
+        metadata: {
+            name: "Metadata",
+            type: "map",
+            defaultValue: {},
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        },
+        createdAt: {
+            name: "Created At",
+            type: "date",
+            columnName: "created_at",
+            ui: { readOnly: true }
+        },
+        updatedAt: {
+            name: "Updated At",
+            type: "date",
+            columnName: "updated_at",
+            autoValue: "on_update",
+            ui: { hideFromCollection: true, disabled: { hidden: true } }
+        }
+    },
+    listProperties: ["displayName", "email", "roles", "createdAt"],
+    propertiesOrder: ["id", "email", "displayName", "roles", "createdAt"]
+};

package/src/collections/index.ts

@@ -1 +1,2 @@
 export * from "./CollectionRegistry";
+export * from "./default-collections";

package/src/data/buildRebaseData.ts

@@ -190,6 +190,12 @@ values: {} as Record<string, unknown> }
             });
         },
 
+        deleteAll: driver.deleteAll
+            ? async (): Promise<void> => {
+                return driver.deleteAll!(slug);
+            }
+            : undefined,
+
         count: driver.countEntities
             ? async (params?: FindParams): Promise<number> => {
                 return driver.countEntities!({
@@ -238,7 +244,7 @@ values: {} as Record<string, unknown> }
             } : undefined,
 
         // Fluent Query Builder
-        where(column: keyof M & string, operator: any, value: unknown) {
+        where(column: keyof M & string, operator: WhereFilterOp, value: unknown) {
             return new QueryBuilder<M>(accessor).where(column, operator, value);
         },
         orderBy(column: keyof M & string, ascending?: "asc" | "desc") {

package/src/util/permissions.ts

@@ -135,7 +135,7 @@ function evaluateRule<USER extends User, M extends Record<string, unknown>>(rule
     return true;
 }
 
-function checkOperation<M extends Record<string, unknown>, USER extends User>(
+export function checkOperation<M extends Record<string, unknown>, USER extends User>(
     collection: EntityCollection<M>,
     authController: AuthController<USER>,
     entity: Entity<M> | null,