@firecms/core 3.0.0-canary.8 → 3.0.0-canary.9

package/dist/types/auth.d.ts

@@ -1,4 +1,5 @@
 import { User } from "./user";
+import { Role } from "./roles";
 /**
  * Controller for retrieving the logged user or performing auth related operations.
  * Note that if you are implementing your AuthController, you probably will want
@@ -11,6 +12,10 @@ export type AuthController<UserType extends User = User, ExtraData extends any =
      * The values can be: the user object, null if they skipped login
      */
     user: UserType | null;
+    /**
+     * Roles related to the logged user
+     */
+    roles?: Role[];
     /**
      * 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

package/dist/types/index.d.ts

@@ -22,6 +22,7 @@ export * from "./local_config_persistence";
 export * from "./plugins";
 export * from "./analytics";
 export * from "./firecms";
+export * from "./roles";
 export * from "./appcheck";
 export * from "./export_import";
 export * from "./modify_collections";

package/dist/types/roles.d.ts

@@ -0,0 +1,31 @@
+import { Permissions } from "../index";
+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;
+    /**
+     * Default permissions for all collections for this role.
+     * You can override this values at the collection level using
+     * {@link collectionPermissions}
+     */
+    defaultPermissions?: Permissions;
+    /**
+     * Record of stripped collection ids to their permissions.
+     * @see stripCollectionPath
+     */
+    collectionPermissions?: Record<string, Permissions>;
+    config?: {
+        createCollections?: boolean;
+        editCollections?: boolean | "own";
+        deleteCollections?: boolean | "own";
+    };
+};

package/dist/types/user.d.ts

@@ -1,3 +1,4 @@
+import { Role } from "./roles";
 /**
  * This interface represents a user.
  * It has some of the same fields as a Firebase User.
@@ -33,4 +34,8 @@ export type User = {
      *
      */
     readonly isAnonymous: boolean;
+    /**
+     *
+     */
+    roles?: Role[];
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@firecms/core",
   "type": "module",
-  "version": "3.0.0-canary.8",
+  "version": "3.0.0-canary.9",
   "description": "Awesome Firebase/Firestore-based headless open-source CMS",
   "funding": {
     "url": "https://github.com/sponsors/firecmsco"
@@ -46,8 +46,8 @@
     "./package.json": "./package.json"
   },
   "dependencies": {
-    "@firecms/formex": "^3.0.0-canary.8",
-    "@firecms/ui": "^3.0.0-canary.8",
+    "@firecms/formex": "^3.0.0-canary.9",
+    "@firecms/ui": "^3.0.0-canary.9",
     "@fontsource/ibm-plex-mono": "^5.0.12",
     "@fontsource/roboto": "^5.0.12",
     "@hello-pangea/dnd": "^16.5.0",
@@ -115,7 +115,7 @@
     "dist",
     "src"
   ],
-  "gitHead": "6d3cbe74b9d5ac0fbd7ee9110a92d0188a252f02",
+  "gitHead": "5bd7f971be5956d225835af3b6cbe9f71d3e7e50",
   "publishConfig": {
     "access": "public"
   }

package/src/types/auth.tsx

@@ -1,4 +1,5 @@
 import { User } from "./user";
+import { Role } from "./roles";
 
 /**
  * Controller for retrieving the logged user or performing auth related operations.
@@ -14,6 +15,11 @@ export type AuthController<UserType extends User = User, ExtraData extends any =
      */
     user: UserType | null;
 
+    /**
+     * Roles related to the logged user
+     */
+    roles?: Role[];
+
     /**
      * 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

package/src/types/index.ts

@@ -22,6 +22,7 @@ export * from "./local_config_persistence";
 export * from "./plugins";
 export * from "./analytics";
 export * from "./firecms";
+export * from "./roles";
 export * from "./appcheck";
 export * from "./export_import";
 export * from "./modify_collections";

package/src/types/roles.ts

@@ -0,0 +1,41 @@
+import { Permissions } from "../index";
+
+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;
+
+    /**
+     * Default permissions for all collections for this role.
+     * You can override this values at the collection level using
+     * {@link collectionPermissions}
+     */
+    defaultPermissions?: Permissions;
+
+    /**
+     * Record of stripped collection ids to their permissions.
+     * @see stripCollectionPath
+     */
+    collectionPermissions?: Record<string, Permissions>;
+
+    config?: {
+
+        createCollections?: boolean;
+
+        editCollections?: boolean | "own";
+
+        deleteCollections?: boolean | "own";
+    }
+}

package/src/types/user.ts

@@ -1,3 +1,5 @@
+import { Role } from "./roles";
+
 /**
  * This interface represents a user.
  * It has some of the same fields as a Firebase User.
@@ -34,4 +36,9 @@ export type User = {
      */
     readonly isAnonymous: boolean;
 
+    /**
+     *
+     */
+    roles?: Role[];
+
 };