@firecms/core 3.0.0-canary.2 → 3.0.0-canary.200

package/dist/hooks/useBuildNavigationController.d.ts

@@ -1,10 +1,13 @@
-import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, User, UserConfigurationPersistence } from "../types";
-type BuildNavigationContextProps<EC extends EntityCollection, UserType extends User> = {
+import { AuthController, CMSView, CMSViewsBuilder, DataSourceDelegate, EntityCollection, EntityCollectionsBuilder, NavigationController, PermissionsBuilder, User, UserConfigurationPersistence } from "../types";
+export type BuildNavigationContextProps<EC extends EntityCollection, USER extends User> = {
     basePath?: string;
     baseCollectionPath?: string;
-    authController: AuthController<UserType>;
+    authController: AuthController<USER>;
     collections?: EC[] | EntityCollectionsBuilder<EC>;
+    collectionPermissions?: PermissionsBuilder;
     views?: CMSView[] | CMSViewsBuilder;
+    adminViews?: CMSView[] | CMSViewsBuilder;
+    viewsOrder?: string[];
     userConfigPersistence?: UserConfigurationPersistence;
     dataSourceDelegate: DataSourceDelegate;
     /**
@@ -15,7 +18,9 @@ type BuildNavigationContextProps<EC extends EntityCollection, UserType extends U
      * @param collections
      */
     injectCollections?: (collections: EntityCollection[]) => EntityCollection[];
+    /**
+     * If true, the navigation logic will not be updated until this flag is false
+     */
+    disabled?: boolean;
 };
-export declare function useBuildNavigationController<EC extends EntityCollection, UserType extends User>({ basePath, baseCollectionPath, authController, collections: collectionsProp, views: baseViews, userConfigPersistence, dataSourceDelegate, injectCollections }: BuildNavigationContextProps<EC, UserType>): NavigationController;
-export declare function getSidePanelKey(path: string, entityId?: string): string;
-export {};
+export declare function useBuildNavigationController<EC extends EntityCollection, USER extends User>(props: BuildNavigationContextProps<EC, USER>): NavigationController;

package/dist/hooks/useFireCMSContext.d.ts

@@ -8,4 +8,4 @@ import { AuthController, FireCMSContext, User } from "../types";
  * @see FireCMSContext
  * @group Hooks and utilities
  */
-export declare const useFireCMSContext: <UserType extends User = User, AuthControllerType extends AuthController<UserType> = AuthController<UserType>>() => FireCMSContext<UserType, AuthControllerType>;
+export declare const useFireCMSContext: <USER extends User = User, AuthControllerType extends AuthController<USER> = AuthController<USER>>() => FireCMSContext<USER, AuthControllerType>;

package/dist/hooks/useModeController.d.ts

@@ -4,8 +4,7 @@
  */
 export interface ModeController {
     mode: "light" | "dark";
-    setMode: (mode: "light" | "dark") => void;
-    toggleMode: () => void;
+    setMode: (mode: "light" | "dark" | "system") => void;
 }
 /**
  * Hook to retrieve the current mode ("light" | "dark"), and `setMode`

package/dist/hooks/useProjectLog.d.ts

@@ -1,4 +1,14 @@
-import { AuthController } from "../types";
+import { AuthController, DataSourceDelegate, FireCMSPlugin } from "../types";
 export declare const DEFAULT_SERVER_DEV = "https://api-kdoe6pj3qq-ey.a.run.app";
 export declare const DEFAULT_SERVER = "https://api-drplyi3b6q-ey.a.run.app";
-export declare function useProjectLog(authController: AuthController): void;
+export type AccessResponse = {
+    blocked?: boolean;
+    message?: string;
+};
+export interface UseProjectLogParams {
+    apiKey?: string;
+    authController: AuthController;
+    dataSourceDelegate: DataSourceDelegate;
+    plugins?: FireCMSPlugin<any, any, any>[];
+}
+export declare function useProjectLog({ authController, dataSourceDelegate, plugins, apiKey }: UseProjectLogParams): AccessResponse | null;

package/dist/hooks/useResolvedNavigationFrom.d.ts

@@ -44,9 +44,9 @@ interface ResolvedNavigationEntityCustom<M extends Record<string, any>> {
  * @param context
  * @group Hooks and utilities
  */
-export declare function resolveNavigationFrom<M extends Record<string, any>, UserType extends User>({ path, context }: {
+export declare function resolveNavigationFrom<M extends Record<string, any>, USER extends User>({ path, context }: {
     path: string;
-    context: FireCMSContext<UserType>;
+    context: FireCMSContext<USER>;
 }): Promise<ResolvedNavigationEntry<M>[]>;
 /**
  * @group Hooks and utilities
@@ -68,5 +68,5 @@ export interface NavigationFrom<M extends Record<string, any>> {
  * in any React component that lives under `FireCMS`
  * @group Hooks and utilities
  */
-export declare function useResolvedNavigationFrom<M extends Record<string, any>, UserType extends User>({ path }: NavigationFromProps): NavigationFrom<M>;
+export declare function useResolvedNavigationFrom<M extends Record<string, any>, USER extends User>({ path }: NavigationFromProps): NavigationFrom<M>;
 export {};

package/dist/hooks/useStorageSource.d.ts

@@ -1,6 +1,6 @@
-import { StorageSource } from "../types";
+import { EntityCollection, StorageSource } from "../types";
 /**
  * Use this hook to get the storage source being used
  * @group Hooks and utilities
  */
-export declare const useStorageSource: () => StorageSource;
+export declare const useStorageSource: (collection?: EntityCollection) => StorageSource;

package/dist/hooks/useValidateAuthenticator.d.ts

@@ -0,0 +1,21 @@
+import { AuthController, Authenticator, DataSourceDelegate, StorageSource, User } from "../index";
+/**
+ * This hook is used internally for validating an authenticator.
+ *
+ * @param authController
+ * @param authentication
+ * @param storageSource
+ * @param dataSourceDelegate
+ */
+export declare function useValidateAuthenticator<USER extends User = any>({ disabled, authController, authenticator, storageSource, dataSourceDelegate }: {
+    disabled?: boolean;
+    authController: AuthController<USER>;
+    authenticator?: boolean | Authenticator<USER>;
+    dataSourceDelegate: DataSourceDelegate;
+    storageSource: StorageSource;
+}): {
+    canAccessMainView: boolean;
+    authLoading: boolean;
+    notAllowedError: any;
+    authVerified: boolean;
+};

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 export * from "./core";
+export * from "./app";
 export * from "./types";
 export * from "./form";
 export * from "./preview";