@firecms/collection_editor 3.0.0-alpha.21 → 3.0.0-alpha.25

package/dist/types/collection_editor_controller.d.ts

@@ -0,0 +1,33 @@
+import { CollectionEditorPermissionsBuilder } from "./config_permissions";
+import { EntityCollection, Property } from "@firecms/core";
+/**
+ * Controller to open the collection editor dialog.
+ * @category Hooks and utilities
+ */
+export interface CollectionEditorController {
+    editCollection: (props: {
+        path?: string;
+        fullPath?: string;
+        parentPathSegments: string[];
+        parentCollection?: EntityCollection<any, any, any>;
+    }) => void;
+    createCollection: (props: {
+        initialValues?: {
+            group?: string;
+            path?: string;
+            name?: string;
+        };
+        parentPathSegments: string[];
+        parentCollection?: EntityCollection<any, any, any>;
+        redirect: boolean;
+    }) => void;
+    editProperty: (props: {
+        propertyKey?: string;
+        property?: Property;
+        currentPropertiesOrder?: string[];
+        editedCollectionPath: string;
+        parentPathSegments: string[];
+    }) => void;
+    configPermissions: CollectionEditorPermissionsBuilder;
+    rootPathSuggestions?: string[];
+}

package/dist/types/collection_inference.d.ts

@@ -0,0 +1,2 @@
+import { EntityCollection } from "@firecms/core";
+export type CollectionInference = (path: string, collectionGroup: boolean, parentPathSegments: string[]) => Promise<EntityCollection | null>;

package/dist/types/config_controller.d.ts

@@ -0,0 +1,33 @@
+import { CMSType, Property } from "@firecms/core";
+import { PersistedCollection } from "./persisted_collection";
+/**
+ * Use this controller to access the configuration that is stored externally,
+ * and not defined in code.
+ */
+export interface CollectionsConfigController {
+    loading: boolean;
+    collections?: PersistedCollection[];
+    saveCollection: <M extends {
+        [Key: string]: CMSType;
+    }>(params: SaveCollectionParams<M>) => Promise<void>;
+    saveProperty: (params: SavePropertyParams) => Promise<void>;
+    deleteCollection: (props: DeleteCollectionParams) => Promise<void>;
+}
+export type SaveCollectionParams<M extends Record<string, any>> = {
+    path: string;
+    collectionData: PersistedCollection<M>;
+    previousPath?: string;
+    parentPathSegments?: string[];
+};
+export type SavePropertyParams = {
+    path: string;
+    propertyKey: string;
+    namespace?: string;
+    newPropertiesOrder?: string[];
+    property: Property;
+    parentPathSegments?: string[];
+};
+export type DeleteCollectionParams = {
+    path: string;
+    parentPathSegments?: string[];
+};

package/dist/types/config_permissions.d.ts

@@ -0,0 +1,19 @@
+import { EntityCollection } from "@firecms/core";
+export type CollectionEditorPermissionsBuilder<UserType = any, EC extends EntityCollection = EntityCollection> = (params: {
+    user: UserType | null;
+    collection?: EC;
+}) => CollectionEditorPermissions;
+export type CollectionEditorPermissions = {
+    /**
+     * Is the user allowed to create new collections.
+     */
+    createCollections: boolean;
+    /**
+     * Is the user allowed to modify this collection
+     */
+    editCollections: boolean;
+    /**
+     * Is the user allowed to delete this collection
+     */
+    deleteCollections: boolean;
+};

package/dist/types/persisted_collection.d.ts

@@ -0,0 +1,6 @@
+import { EntityCollection, Properties, User } from "@firecms/core";
+export type PersistedCollection<M extends Record<string, any> = any, AdditionalKey extends string = string, UserType extends User = User> = Omit<EntityCollection<M, AdditionalKey, UserType>, "properties" | "subcollections"> & {
+    properties: Properties<M>;
+    ownerId: string;
+    subcollections?: PersistedCollection<any, any>[];
+};

package/dist/useCollectionEditorController.d.ts

@@ -0,0 +1,6 @@
+import { CollectionEditorController } from "./types/collection_editor_controller";
+/**
+ * Hook to access the collection editor controller.
+ * The methods in this controller can be used to open the collection editor dialog.
+ */
+export declare const useCollectionEditorController: () => CollectionEditorController;

package/dist/useCollectionEditorPlugin.d.ts

@@ -0,0 +1,44 @@
+import React from "react";
+import { FireCMSPlugin, User } from "@firecms/core";
+import { CollectionEditorPermissionsBuilder } from "./types/config_permissions";
+import { PersistedCollection } from "./types/persisted_collection";
+import { CollectionInference } from "./types/collection_inference";
+import { CollectionsConfigController } from "./types/config_controller";
+export interface CollectionConfigControllerProps<EC extends PersistedCollection = PersistedCollection, UserType extends User = User> {
+    /**
+     * Firebase app where the configuration is saved.
+     */
+    collectionConfigController: CollectionsConfigController;
+    /**
+     * Define what actions can be performed on the configuration.
+     */
+    configPermissions?: CollectionEditorPermissionsBuilder<UserType, EC>;
+    /**
+     * The words you define here will not be allowed to be used as group
+     * names when creating collections.
+     * e.g. ["admin"]
+     */
+    reservedGroups: string[];
+    extraView?: {
+        View: React.ComponentType<{
+            path: string;
+        }>;
+        icon: React.ReactNode;
+    };
+    pathSuggestions?: (path: string) => Promise<string[]>;
+    collectionInference?: CollectionInference;
+    getData?: (path: string) => Promise<object[]>;
+    getUser: (uid: string) => UserType | null;
+}
+/**
+ * Use this hook to initialise the Collection Editor plugin.
+ * This is likely the only hook you will need to use.
+ * @param firebaseApp Firebase app where your project data lives.
+ * @param configPermissions
+ * @param reservedGroups
+ * @param extraView
+ * @param pathSuggestions
+ * @param getUser
+ * @param collectionInference
+ */
+export declare function useCollectionEditorPlugin<EC extends PersistedCollection = PersistedCollection, UserType extends User = User>({ collectionConfigController, configPermissions, reservedGroups, extraView, pathSuggestions, getUser, collectionInference, getData }: CollectionConfigControllerProps<EC, UserType>): FireCMSPlugin;

package/dist/useCollectionsConfigController.d.ts

@@ -0,0 +1,6 @@
+import { CollectionsConfigController } from "./types/config_controller";
+/**
+ * Use this hook to access the configuration controller.
+ * You can use it to get the list of collections, and to save/delete collections.
+ */
+export declare const useCollectionsConfigController: () => CollectionsConfigController;

package/dist/utils/arrays.d.ts

@@ -0,0 +1 @@
+export declare function toArray<T>(input?: T | T[]): T[];

package/dist/utils/entities.d.ts

@@ -0,0 +1,3 @@
+import { Properties, PropertiesOrBuilders, PropertyOrBuilder } from "@firecms/core";
+export declare function editableProperty(property: PropertyOrBuilder | PropertyOrBuilder): boolean;
+export declare function removeNonEditableProperties(properties: PropertiesOrBuilders<any>): Properties;

package/dist/utils/icons.d.ts

@@ -0,0 +1 @@
+export declare const iconsSearch: any;

package/dist/utils/join_collections.d.ts

@@ -0,0 +1,13 @@
+import { EntityCollection } from "@firecms/core";
+/**
+ *
+ * @param storedCollections
+ * @param codedCollections
+ */
+export declare function joinCollectionLists(storedCollections: EntityCollection[], codedCollections: EntityCollection[] | undefined): EntityCollection[];
+/**
+ *
+ * @param target
+ * @param source
+ */
+export declare function mergeCollection(target: EntityCollection, source: EntityCollection): EntityCollection;