@firecms/core 3.0.0-alpha.7 → 3.0.0-alpha.71

package/src/types/property_config.d.ts

@@ -0,0 +1,42 @@
+import React from "react";
+import { CMSType, PropertyOrBuilder } from "./properties";
+/**
+ * This is the configuration object for a property.
+ * These configs are generated by default for the properties defined in your
+ * collections' configuration, but you can define your own to be used.
+ */
+export type PropertyConfig<T extends CMSType = any> = {
+    /**
+     * Key used to identify this property config.
+     */
+    key: string;
+    /**
+     * Name of this field type.
+     * This is not the name of the property.
+     */
+    name: string;
+    /**
+     * Default config for the property.
+     * This property or builder will be used as the base values for the resulting property.
+     * You can also use a builder function to generate the base property.
+     * You can use a builder function to generate the property based on the values or the path.
+     * You can also define a custom Field as a React component to be used for this property.
+     */
+    property: PropertyOrBuilder<T>;
+    /**
+     * Optional icon to be used in the field selector.
+     * Use a 24x24 component, in order not to break the layout.
+     * Any FireCMS icon can be used.
+     */
+    Icon?: React.ComponentType;
+    /**
+     * CSS color, used only in some plugins like the field selector.
+     * e.g. "#2d7ff9"
+     */
+    color?: string;
+    /**
+     * Description of this field type.
+     */
+    description?: string;
+};
+export type FieldConfigId = "text_field" | "multiline" | "markdown" | "url" | "email" | "select" | "multi_select" | "number_input" | "number_select" | "multi_number_select" | "file_upload" | "multi_file_upload" | "group" | "key_value" | "reference" | "multi_references" | "switch" | "date_time" | "repeat" | "custom_array" | "block";

package/src/types/property_config.tsx

@@ -0,0 +1,72 @@
+import React from "react";
+import { CMSType, PropertyOrBuilder } from "./properties";
+
+/**
+ * This is the configuration object for a property.
+ * These configs are generated by default for the properties defined in your
+ * collections' configuration, but you can define your own to be used.
+ */
+export type PropertyConfig<T extends CMSType = any> = {
+
+    /**
+     * Key used to identify this property config.
+     */
+    key: string,
+
+    /**
+     * Name of this field type.
+     * This is not the name of the property.
+     */
+    name: string;
+
+    /**
+     * Default config for the property.
+     * This property or builder will be used as the base values for the resulting property.
+     * You can also use a builder function to generate the base property.
+     * You can use a builder function to generate the property based on the values or the path.
+     * You can also define a custom Field as a React component to be used for this property.
+     */
+    property: PropertyOrBuilder<T>;
+
+    /**
+     * Optional icon to be used in the field selector.
+     * Use a 24x24 component, in order not to break the layout.
+     * Any FireCMS icon can be used.
+     */
+    Icon?: React.ComponentType;
+
+    /**
+     * CSS color, used only in some plugins like the field selector.
+     * e.g. "#2d7ff9"
+     */
+    color?: string;
+
+    /**
+     * Description of this field type.
+     */
+    description?: string;
+
+}
+
+export type FieldConfigId =
+    "text_field" |
+    "multiline" |
+    "markdown" |
+    "url" |
+    "email" |
+    "select" |
+    "multi_select" |
+    "number_input" |
+    "number_select" |
+    "multi_number_select" |
+    "file_upload" |
+    "multi_file_upload" |
+    "group" |
+    "key_value" |
+    "reference" |
+    "multi_references" |
+    "switch" |
+    "date_time" |
+    "repeat" |
+    "custom_array" |
+    "block";

package/src/types/resolved_entities.d.ts

@@ -0,0 +1,98 @@
+import { ArrayProperty, BooleanProperty, CMSType, DateProperty, EnumValueConfig, GeopointProperty, MapProperty, NumberProperty, ReferenceProperty, StringProperty } from "./properties";
+import { EntityReference, GeoPoint } from "./entities";
+import { EntityCollection } from "./collections";
+/**
+ * This is the same entity collection you define, only all the property builders
+ * are resolved to regular `Property` objects.
+ * @group Models
+ */
+export type ResolvedEntityCollection<M extends Record<string, any> = any> = Omit<EntityCollection<M>, "properties"> & {
+    properties: ResolvedProperties<M>;
+    originalCollection: EntityCollection<M>;
+    editable?: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperty<T extends CMSType = CMSType> = T extends string ? ResolvedStringProperty : T extends number ? ResolvedNumberProperty : T extends boolean ? ResolvedBooleanProperty : T extends Date ? ResolvedTimestampProperty : T extends GeoPoint ? ResolvedGeopointProperty : T extends EntityReference ? ResolvedReferenceProperty : T extends CMSType[] ? ResolvedArrayProperty<T> : T extends Record<string, any> ? ResolvedMapProperty<T> : any;
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperties<M extends Record<string, any> = any> = {
+    [k in keyof M]: ResolvedProperty<M[keyof M]>;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedStringProperty = Omit<StringProperty, "enumValues" | "dataType"> & {
+    dataType: "string";
+    resolved: true;
+    enumValues?: EnumValueConfig[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedNumberProperty = Omit<NumberProperty, "enumValues" | "dataType"> & {
+    dataType: "number";
+    resolved: true;
+    enumValues?: EnumValueConfig[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedBooleanProperty = Omit<BooleanProperty, "dataType"> & {
+    dataType: "boolean";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedTimestampProperty = Omit<DateProperty, "dataType"> & {
+    dataType: "date";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedGeopointProperty = Omit<GeopointProperty, "dataType"> & {
+    dataType: "geopoint";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedReferenceProperty = Omit<ReferenceProperty, "dataType"> & {
+    dataType: "reference";
+    resolved: true;
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSType = CMSType> = Omit<ArrayProperty, "of" | "oneOf" | "dataType"> & {
+    dataType: "array";
+    resolved: true;
+    of?: ResolvedProperty<any> | ResolvedProperty<any>[];
+    oneOf?: {
+        properties: ResolvedProperties;
+        typeField?: string;
+        valueField?: string;
+    };
+    resolvedProperties: ResolvedProperty<any>[];
+    fromBuilder: boolean;
+};
+/**
+ * @group Entity properties
+ */
+export type ResolvedMapProperty<T extends Record<string, any> = any> = Omit<MapProperty, "properties" | "dataType" | "propertiesOrder"> & {
+    dataType: "map";
+    resolved: true;
+    properties?: ResolvedProperties<T>;
+    propertiesOrder?: Extract<keyof T, string>[];
+    fromBuilder: boolean;
+};

package/src/types/resolved_entities.ts

@@ -0,0 +1,148 @@
+import {
+    ArrayProperty,
+    BooleanProperty,
+    CMSType,
+    DateProperty,
+    EnumValueConfig,
+    GeopointProperty,
+    MapProperty,
+    NumberProperty,
+    ReferenceProperty,
+    StringProperty
+} from "./properties";
+import { EntityReference, GeoPoint } from "./entities";
+import { EntityCollection } from "./collections";
+
+/**
+ * This is the same entity collection you define, only all the property builders
+ * are resolved to regular `Property` objects.
+ * @group Models
+ */
+export type ResolvedEntityCollection<M extends Record<string, any> = any> =
+    Omit<EntityCollection<M>, "properties">
+    &
+    {
+        properties: ResolvedProperties<M>,
+        originalCollection: EntityCollection<M>,
+        editable?: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperty<T extends CMSType = CMSType> =
+    T extends string ? ResolvedStringProperty :
+        T extends number ? ResolvedNumberProperty :
+            T extends boolean ? ResolvedBooleanProperty :
+                T extends Date ? ResolvedTimestampProperty :
+                    T extends GeoPoint ? ResolvedGeopointProperty :
+                        T extends EntityReference ? ResolvedReferenceProperty :
+                            T extends CMSType[] ? ResolvedArrayProperty<T> :
+                                T extends Record<string, any> ? ResolvedMapProperty<T> : any;
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedProperties<M extends Record<string, any> = any> = {
+    [k in keyof M]: ResolvedProperty<M[keyof M]>;
+};
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedStringProperty =
+    Omit<StringProperty, "enumValues" | "dataType"> &
+    {
+        dataType: "string";
+        resolved: true;
+        enumValues?: EnumValueConfig[];
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedNumberProperty =
+    Omit<NumberProperty, "enumValues" | "dataType"> &
+    {
+        dataType: "number";
+        resolved: true;
+        enumValues?: EnumValueConfig[];
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedBooleanProperty =
+    Omit<BooleanProperty, "dataType"> &
+    {
+        dataType: "boolean";
+        resolved: true;
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedTimestampProperty =
+    Omit<DateProperty, "dataType"> &
+    {
+        dataType: "date";
+        resolved: true;
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedGeopointProperty =
+    Omit<GeopointProperty, "dataType"> &
+    {
+        dataType: "geopoint";
+        resolved: true;
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedReferenceProperty =
+    Omit<ReferenceProperty, "dataType"> &
+    {
+        dataType: "reference";
+        resolved: true;
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSType = CMSType>
+    =
+    Omit<ArrayProperty, "of" | "oneOf" | "dataType"> &
+    {
+        dataType: "array";
+        resolved: true;
+        of?: ResolvedProperty<any> | ResolvedProperty<any>[],
+        oneOf?: {
+            properties: ResolvedProperties
+            typeField?: string;
+            valueField?: string;
+        },
+        resolvedProperties: ResolvedProperty<any>[];
+        fromBuilder: boolean;
+    }
+
+/**
+ * @group Entity properties
+ */
+export type ResolvedMapProperty<T extends Record<string, any> = any> =
+    Omit<MapProperty, "properties" | "dataType" | "propertiesOrder"> &
+    {
+        dataType: "map";
+        resolved: true;
+        properties?: ResolvedProperties<T>;
+        propertiesOrder?: Extract<keyof T, string>[];
+        fromBuilder: boolean;
+    }

package/src/types/side_dialogs_controller.d.ts

@@ -0,0 +1,57 @@
+/**
+ * Controller to open the side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogsController {
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+    /**
+     * List of side panels currently open
+     */
+    sidePanels: SideDialogPanelProps[];
+    /**
+     * Open one or multiple side panels
+     * @param props
+     */
+    open: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+    /**
+     * Replace the last open panel with the given one
+     * @param props
+     */
+    replace: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+}
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogPanelProps {
+    /**
+     * A key that identifies this panel
+     */
+    key: string;
+    /**
+     * The component type that will be rendered
+     */
+    component: React.ReactNode;
+    /**
+     * Optional width of the panel
+     */
+    width?: string;
+    /**
+     * When open, change the URL to this path.
+     * Note that if you want to restore state from a URL you need to add the
+     * logic yourself by listening to URL updates, and probably call `open`.
+     */
+    urlPath?: string;
+    /**
+     * If the navigation stack is empty (you landed in the `urlPath` url), what
+     * url path to change to when the panel gets closed.
+     */
+    parentUrlPath?: string;
+    /**
+     * Callback when the panel is closed
+     */
+    onClose?: () => void;
+}

package/src/types/side_dialogs_controller.tsx

@@ -0,0 +1,68 @@
+/**
+ * Controller to open the side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogsController {
+
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+
+    /**
+     * List of side panels currently open
+     */
+    sidePanels: SideDialogPanelProps[];
+
+    /**
+     * Open one or multiple side panels
+     * @param props
+     */
+    open: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+
+    /**
+     * Replace the last open panel with the given one
+     * @param props
+     */
+    replace: (panelProps: SideDialogPanelProps | SideDialogPanelProps[]) => void;
+}
+
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface SideDialogPanelProps {
+
+    /**
+     * A key that identifies this panel
+     */
+    key: string;
+
+    /**
+     * The component type that will be rendered
+     */
+    component: React.ReactNode;
+
+    /**
+     * Optional width of the panel
+     */
+    width?: string;
+
+    /**
+     * When open, change the URL to this path.
+     * Note that if you want to restore state from a URL you need to add the
+     * logic yourself by listening to URL updates, and probably call `open`.
+     */
+    urlPath?: string;
+
+    /**
+     * If the navigation stack is empty (you landed in the `urlPath` url), what
+     * url path to change to when the panel gets closed.
+     */
+    parentUrlPath?: string;
+
+    /**
+     * Callback when the panel is closed
+     */
+    onClose?: () => void;
+}

package/src/types/side_entity_controller.d.ts

@@ -0,0 +1,83 @@
+import { EntityCollection } from "./collections";
+import { ResolvedEntityCollection } from "./resolved_entities";
+import { Entity } from "./entities";
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface EntitySidePanelProps<M extends Record<string, any> = any> {
+    /**
+     * Absolute path of the entity
+     */
+    path: string;
+    /**
+     * ID of the entity, if not set, it means we are creating a new entity
+     */
+    entityId?: string;
+    /**
+     * Set this flag to true if you want to make a copy of an existing entity
+     */
+    copy?: boolean;
+    /**
+     * Open the entity with a selected sub-collection view. If the panel for this
+     * entity was already open, it is replaced.
+     */
+    selectedSubPath?: string;
+    /**
+     * Use this prop to override the width of the form view.
+     * e.g. "600px"
+     */
+    width?: number | string;
+    /**
+     * Collection representing the entities of this view.
+     * If you leave it blank it will be induced by your navigation
+     */
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
+    /**
+     * Should update the URL when opening the dialog.
+     * Consider that if the collection that you provide is not defined in the base
+     * config of your `FireCMS` component, you will not be able to recreate
+     * the state if copying the URL to a different window.
+     */
+    updateUrl?: boolean;
+    /**
+     * Callback when the entity is updated
+     * @param params
+     */
+    onUpdate?: (params: {
+        entity: Entity<any>;
+    }) => void;
+    /**
+     * Callback when the dialog is closed
+     */
+    onClose?: () => void;
+    /**
+     * Should this panel close when saving
+     */
+    closeOnSave?: boolean;
+}
+/**
+ * Controller to open the side dialog displaying entity forms
+ * @group Hooks and utilities
+ */
+export interface SideEntityController {
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+    /**
+     * Open a new entity sideDialog. By default, the collection and configuration
+     * of the view is fetched from the collections you have specified in the
+     * navigation.
+     * At least you need to pass the path of the entity you would like
+     * to edit. You can set an entityId if you would like to edit and existing one
+     * (or a new one with that id).
+     * @param props
+     */
+    open: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+    /**
+     * Replace the last open entity panel with the given one.
+     * @param props
+     */
+    replace: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+}

package/src/types/side_entity_controller.tsx

@@ -0,0 +1,96 @@
+import { EntityCollection } from "./collections";
+import { ResolvedEntityCollection } from "./resolved_entities";
+import { Entity } from "./entities";
+
+/**
+ * Props used to open a side dialog
+ * @group Hooks and utilities
+ */
+export interface EntitySidePanelProps<M extends Record<string, any> = any> {
+
+    /**
+     * Absolute path of the entity
+     */
+    path: string;
+
+    /**
+     * ID of the entity, if not set, it means we are creating a new entity
+     */
+    entityId?: string;
+
+    /**
+     * Set this flag to true if you want to make a copy of an existing entity
+     */
+    copy?: boolean;
+
+    /**
+     * Open the entity with a selected sub-collection view. If the panel for this
+     * entity was already open, it is replaced.
+     */
+    selectedSubPath?: string;
+
+    /**
+     * Use this prop to override the width of the form view.
+     * e.g. "600px"
+     */
+    width?: number | string;
+
+    /**
+     * Collection representing the entities of this view.
+     * If you leave it blank it will be induced by your navigation
+     */
+    collection?: EntityCollection<M> | ResolvedEntityCollection<M>;
+
+    /**
+     * Should update the URL when opening the dialog.
+     * Consider that if the collection that you provide is not defined in the base
+     * config of your `FireCMS` component, you will not be able to recreate
+     * the state if copying the URL to a different window.
+     */
+    updateUrl?: boolean;
+
+    /**
+     * Callback when the entity is updated
+     * @param params
+     */
+    onUpdate?: (params: { entity: Entity<any> }) => void;
+
+    /**
+     * Callback when the dialog is closed
+     */
+    onClose?: () => void;
+
+    /**
+     * Should this panel close when saving
+     */
+    closeOnSave?: boolean;
+
+}
+
+/**
+ * Controller to open the side dialog displaying entity forms
+ * @group Hooks and utilities
+ */
+export interface SideEntityController {
+    /**
+     * Close the last panel
+     */
+    close: () => void;
+
+    /**
+     * Open a new entity sideDialog. By default, the collection and configuration
+     * of the view is fetched from the collections you have specified in the
+     * navigation.
+     * At least you need to pass the path of the entity you would like
+     * to edit. You can set an entityId if you would like to edit and existing one
+     * (or a new one with that id).
+     * @param props
+     */
+    open: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+
+    /**
+     * Replace the last open entity panel with the given one.
+     * @param props
+     */
+    replace: <M extends Record<string, any> = any>(props: EntitySidePanelProps<M>) => void;
+}