@firecms/user_management 3.0.0-canary.8 → 3.0.0-canary.80

package/LICENSE

@@ -1,21 +1,113 @@
-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.
+Business Source License 1.1
+
+Parameters
+
+Licensor:             Firecms S.L.
+Licensed Work:        Firecms CMS packages: 
+                      cli
+                      collection_editor
+                      collection_editor_firebase
+                      data_enhancement
+                      data_import_export
+                      editor
+                      firecms_cloud
+                      schema_inference
+                      user_management
+
+                      The Licensed Work is (c) 2024 Firecms S.L
+Additional Use Grant: You may make use of the Licensed Work, provided that
+                      you may not use the Licensed Work for a CMS Data Enhancement
+                      Service.
+
+                      A “CMS package” is a commercial offering that
+                      allows third parties (other than your employees and
+                      contractors) to access the functionality of the
+                      Licensed Work by using software to extend the base features of
+                      content management system controlled by such third parties.
+
+Change Date:         Four years from the date the Licensed Work is published.
+
+Change License:      MIT
+
+For information about alternative licensing arrangements for the Software,
+please visit: https://firecms.co
+
+Notice
+
+The Business Source License (this document, or the “License”) is not an Open
+Source license. However, the Licensed Work will eventually be made available
+under an Open Source License, as stated in this License.
+
+License text copyright (c) 2017 MariaDB Corporation Ab, All Rights Reserved.
+“Business Source License” is a trademark of MariaDB Corporation Ab.
+
+-----------------------------------------------------------------------------
+
+Business Source License 1.1
+
+Terms
+
+The Licensor hereby grants you the right to copy, modify, create derivative
+works, redistribute, and make non-production use of the Licensed Work. The
+Licensor may make an Additional Use Grant, above, permitting limited
+production use.
+
+Effective on the Change Date, or the fourth anniversary of the first publicly
+available distribution of a specific version of the Licensed Work under this
+License, whichever comes first, the Licensor hereby grants you rights under
+the terms of the Change License, and the rights granted in the paragraph
+above terminate.
+
+If your use of the Licensed Work does not comply with the requirements
+currently in effect as described in this License, you must purchase a
+commercial license from the Licensor, its affiliated entities, or authorized
+resellers, or you must refrain from using the Licensed Work.
+
+All copies of the original and modified Licensed Work, and derivative works
+of the Licensed Work, are subject to this License. This License applies
+separately for each version of the Licensed Work and the Change Date may vary
+for each version of the Licensed Work released by Licensor.
+
+You must conspicuously display this License on each original or modified copy
+of the Licensed Work. If you receive the Licensed Work in original or
+modified form from a third party, the terms and conditions set forth in this
+License apply to your use of that work.
+
+Any use of the Licensed Work in violation of this License will automatically
+terminate your rights under this License for the current and all other
+versions of the Licensed Work.
+
+This License does not grant you any right in any trademark or logo of
+Licensor or its affiliates (provided that you may use a trademark or logo of
+Licensor as expressly required by this License).
+
+TO THE EXTENT PERMITTED BY APPLICABLE LAW, THE LICENSED WORK IS PROVIDED ON
+AN “AS IS” BASIS. LICENSOR HEREBY DISCLAIMS ALL WARRANTIES AND CONDITIONS,
+EXPRESS OR IMPLIED, INCLUDING (WITHOUT LIMITATION) WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, NON-INFRINGEMENT, AND
+TITLE.
+
+MariaDB hereby grants you permission to use this License’s text to license
+your works, and to refer to it using the trademark “Business Source License”,
+as long as you comply with the Covenants of Licensor below.
+
+Covenants of Licensor
+
+In consideration of the right to use this License’s text and the “Business
+Source License” name and trademark, Licensor covenants to MariaDB, and to all
+other recipients of the licensed work to be provided by Licensor:
+
+1. To specify as the Change License the GPL Version 2.0 or any later version,
+   or a license that is compatible with GPL Version 2.0 or a later version,
+   where “compatible” means that software provided under the Change License can
+   be included in a program with software provided under GPL Version 2.0 or a
+   later version. Licensor may specify additional Change Licenses without
+   limitation.
+
+2. To either: (a) specify an additional grant of rights to use that does not
+   impose any additional restriction on the right granted in this License, as
+   the Additional Use Grant; or (b) insert the text “None”.
+
+3. To specify a Change Date.
+
+4. Not to modify this License in any other way.

package/dist/UserManagementProvider.d.ts

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

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

@@ -1,4 +1,4 @@
-import { Role } from "../../types";
+import { Role } from "@firecms/core";
 export type RoleChipProps = {
     role: Role;
 };

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

@@ -1,6 +1,5 @@
 import * as Yup from "yup";
-import { EntityCollection } from "@firecms/core";
-import { Role } from "../../types";
+import { EntityCollection, Role } from "@firecms/core";
 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>;

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

@@ -1,4 +1,4 @@
-import { Role } from "../../types";
+import { Role } from "@firecms/core";
 export declare function RolesTable({ onRoleClicked, editable }: {
     onRoleClicked: (role: Role) => void;
     editable: boolean;

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

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

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

@@ -1,5 +1,5 @@
 import * as Yup from "yup";
-import { UserWithRoles } from "../../types";
+import { User } from "@firecms/core";
 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>;
@@ -15,6 +15,6 @@ export declare const UserYupSchema: Yup.ObjectSchema<import("yup/lib/object").As
 }>>>;
 export declare function UserDetailsForm({ open, user: userProp, handleClose }: {
     open: boolean;
-    user?: UserWithRoles;
+    user?: User;
     handleClose: () => void;
 }): import("react/jsx-runtime").JSX.Element;

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

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

package/dist/hooks/index.d.ts

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

package/dist/hooks/{useBuildFirestoreUserManagement.d.ts → useFirestoreUserManagement.d.ts}

@@ -1,6 +1,5 @@
-import { FirebaseApp } from "firebase/app";
+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
@@ -20,9 +19,14 @@ export interface UserManagementParams {
      * Default: __FIRECMS/config/roles
      */
     rolesPath?: string;
+    /**
+     * Maximum number of users that can be created.
+     */
     usersLimit?: number;
+    /**
+     * Can the logged user edit roles
+     */
     canEditRoles?: boolean;
-    authController: AuthController;
     /**
      * If there are no roles in the database, provide a button to create the default roles.
      */
@@ -41,4 +45,4 @@ export interface UserManagementParams {
  * @param usersLimit
  * @param canEditRoles
  */
-export declare function useBuildFirestoreUserManagement({ firebaseApp, usersPath, rolesPath, usersLimit, canEditRoles, authController, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementParams): UserManagement;
+export declare function useFirestoreUserManagement({ firebaseApp, usersPath, rolesPath, usersLimit, canEditRoles, allowDefaultRolesCreation, includeCollectionConfigPermissions }: UserManagementParams): UserManagement;

package/dist/hooks/useUserManagement.d.ts

@@ -1,2 +1,3 @@
-import { UserManagement } from "../types/user_management";
-export declare const useUserManagement: () => UserManagement;
+import { UserManagement } from "../types";
+import { User } from "@firecms/core";
+export declare const useUserManagement: <USER extends User>() => UserManagement<USER>;