@firecms/user_management 3.0.0-3.0.0-beta.4.pre.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 FireCMS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,157 @@
+<p align="center">
+  <a href="https://firecms.co">
+    <img src="https://firecms.co/img/logo_small.png" width="240px" alt="FireCMS logo" />
+  </a>
+</p>
+
+<h1 align="center">FireCMS</h1>
+<h3 align="center">Awesome Firebase/Firestore-based headless CMS</h3>
+<p align="center"><a href="https://demo.firecms.co">Live demo</a></p>
+
+<br />
+
+
+[![NPM](https://img.shields.io/npm/v/firecms.svg)](https://www.npmjs.com/package/firecms) [![License: MIT](https://img.shields.io/badge/license-MIT-purple.svg)](https://opensource.org/licenses/MIT)
+
+FireCMS is a headless CMS and admin panel
+that seamlessly integrates with **Firebase and Firestore** by default, but is
+also compatible with any backend.
+
+Effortlessly generate **CRUD views** based on your configuration. FireCMS is
+simple to set up for standard cases and easy to extend and customize for more specific
+needs.
+
+Built to produce collection and form views that naturally align with the
+collection/document model, FireCMS covers a wide range of basic and advanced use
+cases. With extensibility in mind, it's easy to create your own views or modify
+existing ones.
+
+FireCMS does **not impose any data structure** restrictions, ensuring a smooth,
+out-of-the-box experience for any project.
+
+### Core technologies
+
+FireCMS is based on this great technologies:
+
+- Typescript
+- Tailwind CSS
+- Firebase SDK 10
+- React + React Router 6
+
+### Demo
+
+Check the demo with all the core functionalities.
+
+https://demo.firecms.co
+
+> You can modify the data, but it gets periodically restored.
+
+### Getting started
+
+The easies way to get started is through [FireCMS Cloud](https://app.firecms.co/).
+Bring your project or create a new one in seconds.
+
+It will allow you to get started without writing a single line of code. Create collections
+and entities, and start editing your data.
+
+Later on, if you need to customize the CMS, you can build and compile your own views, form fields
+and other components, and upload them to your project.
+
+## Features
+
+FireCMS has been meticulously crafted to make it incredibly easy for developers
+to build a CMS/admin tool while offering an excellent data editing experience
+and a user-friendly interface for marketers and content managers.
+
+### 🏓 Exceptional Spreadsheet View
+
+We've developed a highly efficient windowed **spreadsheet view** for
+collections, allowing inline editing for most common fields, as well as popup
+views for other cases and your custom field implementations.
+
+Featuring **real-time** support, FireCMS is perfect for apps that require
+constant updates. It also supports **text search** (through an external provider
+like Algolia, if using Firestore), **filtering and sorting**, and **exporting**
+data.
+
+### 📥📤 Data import and export
+
+FireCMS supports importing and exporting data in CSV format as well as JSON.
+Bring your data from other sources or export it to use it in other systems.
+
+We offer a robust and flexible system for defining the import and export
+configuration, allowing you to define the fields to be imported/exported, the
+format, and the mapping between the fields in the file and the fields in the
+collection.
+
+### ✨ Robust Forms
+
+![fields](https://firecms.co/img/form_editing.webp)
+
+When editing an entity, FireCMS offers a nested system of side dialogs for
+navigating through **subcollections** and accessing custom views (such as custom
+forms or blog previews). This functionality can also be accessed
+programmatically using the `useSideEntityController` hook.
+
+FireCMS includes **over 15 built-in fields** with numerous customization and
+validation options. The components have been carefully designed for an
+outstanding user experience, including advanced features like **references** to
+other collections, **markdown**, and **array reordering**.
+
+For unsupported use cases, create your own **custom field** as a React
+component.
+
+FireCMS also supports **conditional fields** in forms, allowing you to define
+rules for active fields based on your logic.
+
+### 👮 Authentication, Permissions, and Role System
+
+Define which navigation views users can see and the operations (create, edit,
+delete) they can perform based on your role system. You can even configure this
+on a per-entity or collection level.
+
+By default, FireCMS supports all Firebase authorization mechanisms, but you can
+implement your own.
+
+### 🏹 Relational Support
+
+Define references to entities in other collections and benefit from the
+integrated reference fields and shortcuts.
+
+You can also define subcollections at the entity level for nesting data in a
+collection/document/collection model.
+
+### 🆒 Real-Time Data
+
+Every view in the CMS supports real-time data, making it suitable for displaying
+constantly updated information.
+
+Forms also support this feature, with any modified value in the database being
+updated in any open form view as long as it hasn't been touched by the user.
+This enables advanced cases where a Cloud Function is triggered after saving an
+entity, modifying some values, and requiring real-time updates.
+
+### 🗂️ File Storage
+
+FireCMS supports uploading files to Firebase Storage out of the box and provides
+specific fields for handling single and multiple file uploads, as well as
+reordering.
+
+You can replace the Firebase Storage implementation with your own.
+
+## Contact and support
+
+If you need general support, you can open a [GitHub issue](https://github.com/firecmsco/firecms/issues) or join
+our [Discord channel](https://discord.gg/fxy7xsQm3m).
+
+Do you need consulting setting up your Firestore-based CMS in no time? We are
+happy to help!
+`hello@firecms.co`
+
+## Changelog
+
+https://firecms.co/docs/changelog
+
+## License
+
+MIT © [FireCMS](https://github.com/FireCMSco)

package/dist/UserManagementProvider.d.ts

@@ -0,0 +1,7 @@
+import React, { PropsWithChildren } from "react";
+import { UserManagement, UserWithRoles } from "./types";
+export declare const UserManagementContext: React.Context<UserManagement<any>>;
+export interface UserManagementProviderProps<U extends UserWithRoles = UserWithRoles> {
+    userManagement: UserManagement<U>;
+}
+export declare function UserManagementProvider<U extends UserWithRoles = UserWithRoles>({ children, userManagement }: PropsWithChildren<UserManagementProviderProps<U>>): import("react/jsx-runtime").JSX.Element;

package/dist/admin_views.d.ts

@@ -0,0 +1,2 @@
+import { CMSView } from "@firecms/core";
+export declare const userManagementAdminViews: CMSView[];

package/dist/components/index.d.ts

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

package/dist/components/roles/RoleChip.d.ts

@@ -0,0 +1,5 @@
+import { Role } from "../../types";
+export type RoleChipProps = {
+    role: Role;
+};
+export declare function RoleChip({ role }: RoleChipProps): import("react/jsx-runtime").JSX.Element;

package/dist/components/roles/RolesDetailsForm.d.ts

@@ -0,0 +1,20 @@
+import * as Yup from "yup";
+import { EntityCollection } from "@firecms/core";
+import { Role } from "../../types";
+export declare const RoleYupSchema: Yup.ObjectSchema<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    id: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    name: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+}>, import("yup/lib/object").AnyObject, import("yup/lib/object").TypeOfShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    id: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    name: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+}>>, import("yup/lib/object").AssertsShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    id: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    name: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+}>>>;
+export declare function RolesDetailsForm({ open, role, editable, handleClose, collections }: {
+    open: boolean;
+    editable?: boolean;
+    role?: Role;
+    handleClose: () => void;
+    collections?: EntityCollection[];
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/roles/RolesTable.d.ts

@@ -0,0 +1,5 @@
+import { Role } from "../../types";
+export declare function RolesTable({ onRoleClicked, editable }: {
+    onRoleClicked: (role: Role) => void;
+    editable: boolean;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/roles/RolesView.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export declare const RolesView: React.NamedExoticComponent<{
+    children?: React.ReactNode;
+}>;

package/dist/components/roles/default_roles.d.ts

@@ -0,0 +1,2 @@
+import { Role } from "../../types";
+export declare const DEFAULT_ROLES: Role[];

package/dist/components/roles/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./RoleChip";
+export * from "./RolesDetailsForm";
+export * from "./RolesTable";
+export * from "./RolesView";

package/dist/components/users/UserDetailsForm.d.ts

@@ -0,0 +1,20 @@
+import * as Yup from "yup";
+import { UserWithRoles } from "../../types";
+export declare const UserYupSchema: Yup.ObjectSchema<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    displayName: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    email: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    roles: import("yup/lib/array").OptionalArraySchema<Yup.AnySchema, import("yup/lib/types").AnyObject, any[] | undefined>;
+}>, import("yup/lib/object").AnyObject, import("yup/lib/object").TypeOfShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    displayName: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    email: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    roles: import("yup/lib/array").OptionalArraySchema<Yup.AnySchema, import("yup/lib/types").AnyObject, any[] | undefined>;
+}>>, import("yup/lib/object").AssertsShape<import("yup/lib/object").Assign<import("yup/lib/object").ObjectShape, {
+    displayName: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    email: import("yup/lib/string").RequiredStringSchema<string | undefined, import("yup/lib/types").AnyObject>;
+    roles: import("yup/lib/array").OptionalArraySchema<Yup.AnySchema, import("yup/lib/types").AnyObject, any[] | undefined>;
+}>>>;
+export declare function UserDetailsForm({ open, user: userProp, handleClose }: {
+    open: boolean;
+    user?: UserWithRoles;
+    handleClose: () => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/users/UsersTable.d.ts

@@ -0,0 +1,4 @@
+import { UserWithRoles } from "../../types";
+export declare function UsersTable({ onUserClicked }: {
+    onUserClicked: (user: UserWithRoles) => void;
+}): import("react/jsx-runtime").JSX.Element;

package/dist/components/users/UsersView.d.ts

@@ -0,0 +1,4 @@
+import React from "react";
+export declare const UsersView: ({ children }: {
+    children?: React.ReactNode;
+}) => import("react/jsx-runtime").JSX.Element;

package/dist/components/users/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./UserDetailsForm";
+export * from "./UsersTable";
+export * from "./UsersView";

package/dist/hooks/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./useBuildFirestoreUserManagement";
+export * from "./useUserManagement";

package/dist/hooks/useBuildFirestoreUserManagement.d.ts

@@ -0,0 +1,44 @@
+import { FirebaseApp } from "firebase/app";
+import { UserManagement } from "../types";
+import { AuthController } from "@firecms/core";
+export interface UserManagementParams {
+    /**
+     * The Firebase app to use for the user management. The config will be saved in the Firestore
+     * collection indicated by `configPath`.
+     */
+    firebaseApp?: FirebaseApp;
+    /**
+     * Path where the plugin users configuration is stored.
+     * Default: __FIRECMS/config/users
+     * You can specify a different path if you want to store the user management configuration in a different place.
+     * Please keep in mind that the FireCMS users are not necessarily the same as the Firebase users (but they can be).
+     * The path should be relative to the root of the Firestore database, and should always have an odd number of segments.
+     */
+    usersPath?: string;
+    /**
+     * Path where the plugin roles configuration is stored.
+     * Default: __FIRECMS/config/roles
+     */
+    rolesPath?: string;
+    usersLimit?: number;
+    canEditRoles?: boolean;
+    authController: AuthController;
+    /**
+     * If there are no roles in the database, provide a button to create the default roles.
+     */
+    allowDefaultRolesCreation?: boolean;
+    /**
+     * Include the collection config permissions in the user management system.
+     */
+    includeCollectionConfigPermissions?: boolean;
+}
+/**
+ * This hook is used to build a user management object that can be used to
+ * manage users and roles in a Firestore backend.
+ * @param backendFirebaseApp
+ * @param usersPath
+ * @param rolesPath
+ * @param usersLimit
+ * @param canEditRoles
+ */
+export declare function useBuildFirestoreUserManagement({ firebaseApp, usersPath, rolesPath, usersLimit, canEditRoles, authController, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementParams): UserManagement;

package/dist/hooks/useUserManagement.d.ts

@@ -0,0 +1,2 @@
+import { UserManagement } from "../types/user_management";
+export declare const useUserManagement: () => UserManagement;

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+export * from "./hooks";
+export * from "./components";
+export * from "./types";
+export * from "./utils";
+export * from "./useUserManagementPlugin";
+export * from "./UserManagementProvider";
+export * from "./admin_views";