@firecms/core 3.0.0-alpha.8 → 3.0.0-alpha.80

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.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.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.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;
+}

package/src/types/storage.ts

@@ -0,0 +1,96 @@
+/**
+ * @group Models
+ */
+export interface UploadFileProps {
+    file: File,
+    fileName?: string,
+    path?: string,
+    metadata?: any,
+}
+
+/**
+ * @group Models
+ */
+export interface UploadFileResult {
+    /**
+     * Storage path including the file name where the file was uploaded.
+     */
+    path: string;
+}
+
+/**
+ * @group Models
+ */
+export interface DownloadConfig {
+    /**
+     * Temporal url that can be used to download the file
+     */
+    url: string | null;
+
+    metadata?: DownloadMetadata;
+
+    fileNotFound?: boolean;
+}
+
+/**
+ * The full set of object metadata, including read-only properties.
+ * @public
+ */
+export declare interface DownloadMetadata {
+    /**
+     * The bucket this object is contained in.
+     */
+    bucket: string;
+    /**
+     * The full path of this object.
+     */
+    fullPath: string;
+    /**
+     * The short name of this object, which is the last component of the full path.
+     * For example, if fullPath is 'full/path/image.png', name is 'image.png'.
+     */
+    name: string;
+    /**
+     * The size of this object, in bytes.
+     */
+    size: number;
+    /**
+     * Type of the uploaded file
+     * e.g. "image/jpeg"
+     */
+    contentType: string;
+
+    customMetadata: Record<string, unknown>;
+}
+
+/**
+ * @group Models
+ */
+export interface StorageSource {
+    /**
+     * Upload a file, specifying a name and a path
+     * @param file
+     * @param fileName
+     * @param path
+     * @param metadata
+     */
+    uploadFile: ({
+                     file,
+                     fileName,
+                     path,
+                     metadata
+                 }: UploadFileProps) => Promise<UploadFileResult>;
+
+    /**
+     * Convert a storage path or URL into a download configuration
+     * @param path
+     */
+    getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>;
+
+    /**
+     * Get a file from a storage path.
+     * It returns null if the file does not exist.
+     * @param props
+     */
+    getFile: (path:string) => Promise<File | null>;
+}

package/src/types/user.ts

@@ -0,0 +1,37 @@
+/**
+ * This interface represents a user.
+ * It has some of the same fields as a Firebase User.
+ * Note that in the default implementation, we simply take the Firebase user
+ * and use it as a FireCMS user, so that means that even if they are not mapped
+ * in this interface, it contains all the methods of the former, such as `delete`,
+ * `getIdToken`, etc.
+ *
+ * @group Models
+ */
+export type User = {
+    /**
+     * The user's unique ID, scoped to the project.
+     */
+    readonly uid: string;
+    /**
+     * The display name of the user.
+     */
+    readonly displayName: string | null;
+    /**
+     * The email of the user.
+     */
+    readonly email: string | null;
+    /**
+     * The profile photo URL of the user.
+     */
+    readonly photoURL: string | null;
+    /**
+     * The provider used to authenticate the user.
+     */
+    readonly providerId: string;
+    /**
+     *
+     */
+    readonly isAnonymous: boolean;
+
+};

package/src/util/arrays.ts

@@ -0,0 +1,3 @@
+export function toArray<T>(input?: T | T[]): T[] {
+    return Array.isArray(input) ? input : (input ? [input] : []);
+}

package/src/util/builders.ts

@@ -0,0 +1,139 @@
+import {
+    AdditionalFieldDelegate,
+    ArrayProperty,
+    BooleanProperty,
+    CMSType,
+    DateProperty,
+    EntityCallbacks,
+    EntityCollection,
+    EnumValueConfig,
+    EnumValues,
+    GeopointProperty,
+    MapProperty,
+    NumberProperty,
+    PropertiesOrBuilders,
+    PropertyBuilder,
+    PropertyConfig,
+    PropertyOrBuilder,
+    ReferenceProperty,
+    StringProperty,
+    User
+} from "../types";
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * collection views with all its properties
+ * @param collection
+ * @group Builder
+ */
+export function buildCollection<M extends Record<string, any> = any,
+    UserType extends User = User>(
+    collection: EntityCollection<M, UserType>
+): EntityCollection<M, UserType> {
+    return collection;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the property keys.
+ * @param property
+ * @group Builder
+ */
+export function buildProperty<T extends CMSType = CMSType, P extends PropertyOrBuilder<T> = PropertyOrBuilder<T>, M extends Record<string, any> = Record<string, any>>(
+    property: P
+):
+    P extends StringProperty ? StringProperty :
+        P extends NumberProperty ? NumberProperty :
+            P extends BooleanProperty ? BooleanProperty :
+                P extends DateProperty ? DateProperty :
+                    P extends GeopointProperty ? GeopointProperty :
+                        P extends ReferenceProperty ? ReferenceProperty :
+                            P extends ArrayProperty ? ArrayProperty :
+                                P extends MapProperty ? MapProperty :
+                                    P extends PropertyBuilder<T, M> ? PropertyBuilder<T, M> : never {
+    return property as any;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param properties
+ * @group Builder
+ */
+export function buildProperties<M extends Record<string, any>>(
+    properties: PropertiesOrBuilders<M>
+): PropertiesOrBuilders<M> {
+    return properties;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param propertiesOrBuilder
+ * @group Builder
+ */
+export function buildPropertiesOrBuilder<M extends Record<string, any>>(
+    propertiesOrBuilder: PropertiesOrBuilders<M>
+): PropertiesOrBuilders<M> {
+    return propertiesOrBuilder;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValues
+ * @group Builder
+ */
+export function buildEnumValues(
+    enumValues: EnumValues
+): EnumValues {
+    return enumValues;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param enumValueConfig
+ * @group Builder
+ */
+export function buildEnumValueConfig(
+    enumValueConfig: EnumValueConfig
+): EnumValueConfig {
+    return enumValueConfig;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and preserve
+ * the properties keys.
+ * @param callbacks
+ * @group Builder
+ */
+export function buildEntityCallbacks<M extends Record<string, any> = any>(
+    callbacks: EntityCallbacks<M>
+): EntityCallbacks<M> {
+    return callbacks;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param additionalFieldDelegate
+ * @group Builder
+ */
+export function buildAdditionalFieldDelegate<M extends Record<string, any>, UserType extends User = User>(
+    additionalFieldDelegate: AdditionalFieldDelegate<M, UserType>
+): AdditionalFieldDelegate<M, UserType> {
+    return additionalFieldDelegate;
+}
+
+/**
+ * Identity function we use to defeat the type system of Typescript and build
+ * additional field delegates views with all its properties
+ * @param propertyConfig
+ * @group Builder
+ */
+export function buildFieldConfig<T extends CMSType = CMSType>(
+    propertyConfig: PropertyConfig<T>
+): PropertyConfig<T> {
+    return propertyConfig;
+}