@firecms/core 3.0.0-beta.7 → 3.0.0-beta.9

package/dist/types/properties.d.ts

@@ -8,7 +8,7 @@ import { ChipColorKey, ChipColorScheme } from "@firecms/ui";
 /**
  * @group Entity properties
  */
-export type DataType<T extends CMSType = CMSType> = T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends Date ? "date" : T extends GeoPoint ? "geopoint" : T extends Vector ? "vector" : T extends EntityReference ? "reference" : T extends Array<CMSType> ? "array" : T extends Record<string, any> ? "map" : never;
+export type DataType<T extends CMSType = CMSType> = T extends string ? "string" : T extends number ? "number" : T extends boolean ? "boolean" : T extends Date ? "date" : T extends GeoPoint ? "geopoint" : T extends Vector ? "vector" : T extends EntityReference ? "reference" : T extends Array<any> ? "array" : T extends Record<string, any> ? "map" : never;
 /**
  * @group Entity properties
  */
@@ -20,7 +20,7 @@ export type AnyProperty = StringProperty | NumberProperty | BooleanProperty | Da
 /**
  * @group Entity properties
  */
-export type Property<T extends CMSType = CMSType> = T extends string ? StringProperty : T extends number ? NumberProperty : T extends boolean ? BooleanProperty : T extends Date ? DateProperty : T extends GeoPoint ? GeopointProperty : T extends EntityReference ? ReferenceProperty : T extends Array<CMSType> ? ArrayProperty<T> : T extends Record<string, any> ? MapProperty<T> : AnyProperty;
+export type Property<T extends CMSType = any> = T extends string ? StringProperty : T extends number ? NumberProperty : T extends boolean ? BooleanProperty : T extends Date ? DateProperty : T extends GeoPoint ? GeopointProperty : T extends EntityReference ? ReferenceProperty : T extends Array<CMSType> ? ArrayProperty<T> : T extends Record<string, any> ? MapProperty<T> : AnyProperty;
 /**
  * Interface including all common properties of a CMS property
  * @group Entity properties
@@ -97,7 +97,7 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
     /**
      * This value will be set by default for new entities.
      */
-    defaultValue?: T;
+    defaultValue?: T | null;
     /**
      * Should this property be editable. If set to true, the user will be able to modify the property and
      * save the new config. The saved config will then become the source of truth.
@@ -207,7 +207,7 @@ export type PropertyBuilderProps<M extends Record<string, any> = any> = {
  * current value of the property, as well as the path and entity ID.
  * @group Entity properties
  */
-export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, path, entityId }: PropertyBuilderProps<M>) => Property<T> | null;
+export type PropertyBuilder<T extends CMSType = any, M extends Record<string, any> = any> = ({ values, previousValues, propertyValue, index, path, entityId }: PropertyBuilderProps<M>) => Property<T> | null;
 /**
  * @group Entity properties
  */
@@ -306,7 +306,7 @@ export interface StringProperty extends BaseProperty<string> {
 /**
  * @group Entity properties
  */
-export interface ArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSType = CMSType> extends BaseProperty<T> {
+export interface ArrayProperty<T extends ArrayT[] = any[], ArrayT extends CMSType = any> extends BaseProperty<T> {
     dataType: "array";
     /**
      * The property of this array.
@@ -583,13 +583,13 @@ export type StorageConfig = {
      * You can use this prop to customize the uploaded filename.
      * You can use a function as a callback or a string where you
      * specify some placeholders that get replaced with the corresponding values.
-     * - {file} - Full file name
-     * - {file.name} - Name of the file without extension
-     * - {file.ext} - Extension of the file
-     * - {rand} - Random value used to avoid name collisions
-     * - {entityId} - ID of the entity
-     * - {propertyKey} - ID of this property
-     * - {path} - Path of this entity
+     * - `{file}` - Full file name
+     * - `{file.name}` - Name of the file without extension
+     * - `{file.ext}` - Extension of the file
+     * - `{rand}` - Random value used to avoid name collisions
+     * - `{entityId}` - ID of the entity
+     * - `{propertyKey}` - ID of this property
+     * - `{path}` - Path of this entity
      *
      * @param context
      */
@@ -599,13 +599,13 @@ export type StorageConfig = {
      *
      * You can use a function as a callback or a string where you
      * specify some placeholders that get replaced with the corresponding values.
-     * - {file} - Full file name
-     * - {file.name} - Name of the file without extension
-     * - {file.ext} - Extension of the file
-     * - {rand} - Random value used to avoid name collisions
-     * - {entityId} - ID of the entity
-     * - {propertyKey} - ID of this property
-     * - {path} - Path of this entity
+     * - `{file}` - Full file name
+     * - `{file.name}` - Name of the file without extension
+     * - `{file.ext}` - Extension of the file
+     * - `{rand}` - Random value used to avoid name collisions
+     * - `{entityId}` - ID of the entity
+     * - `{propertyKey}` - ID of this property
+     * - `{path}` - Path of this entity
      */
     storagePath: string | ((context: UploadedFileContext) => string);
     /**
@@ -628,6 +628,11 @@ export type StorageConfig = {
      * after it has been resolved.
      */
     postProcess?: (pathOrUrl: string) => Promise<string>;
+    /**
+     * You can use this prop in order to provide a custom preview URL.
+     * Useful when the file's path is different from the original field value
+     */
+    previewUrl?: (fileName: string) => string;
 };
 /**
  * @group Entity properties
@@ -652,7 +657,7 @@ export interface UploadedFileContext {
     /**
      * Entity path. E.g. `products/PID/locales`
      */
-    path: string;
+    path?: string;
     /**
      * Values of the current entity
      */

package/dist/types/side_dialogs_controller.d.ts

@@ -1,3 +1,4 @@
+import React from "react";
 /**
  * Controller to open the side dialog
  * @group Hooks and utilities
@@ -11,6 +12,11 @@ export interface SideDialogsController {
      * List of side panels currently open
      */
     sidePanels: SideDialogPanelProps[];
+    /**
+     * Override the current side panels
+     * @param panels
+     */
+    setSidePanels: (panels: SideDialogPanelProps[]) => void;
     /**
      * Open one or multiple side panels
      * @param props
@@ -54,4 +60,8 @@ export interface SideDialogPanelProps {
      * Callback when the panel is closed
      */
     onClose?: () => void;
+    /**
+     * Use this prop to store additional data in the panel
+     */
+    additional?: any;
 }

package/dist/types/storage.d.ts

@@ -87,4 +87,79 @@ export interface StorageSource {
      * @param bucket
      */
     getFile: (path: string, bucket?: string) => Promise<File | null>;
+    /**
+     * Delete a file.
+     * @param path
+     * @param bucket
+     */
+    deleteFile: (path: string, bucket?: string) => Promise<void>;
+    /**
+     * List the contents of a path.
+     * @param path
+     * @param options
+     */
+    list: (path: string, options?: {
+        bucket?: string;
+        maxResults?: number;
+        pageToken?: string;
+    }) => Promise<StorageListResult>;
+}
+/**
+ * Result returned by list().
+ * @public
+ */
+export declare interface StorageListResult {
+    /**
+     * References to prefixes (sub-folders). You can call list() on them to
+     * get its contents.
+     *
+     * Folders are implicit based on '/' in the object paths.
+     * For example, if a bucket has two objects '/a/b/1' and '/a/b/2', list('/a')
+     * will return '/a/b' as a prefix.
+     */
+    prefixes: StorageReference[];
+    /**
+     * Objects in this directory.
+     * You can call getMetadata() and getDownloadUrl() on them.
+     */
+    items: StorageReference[];
+    /**
+     * If set, there might be more results for this list. Use this token to resume the list.
+     */
+    nextPageToken?: string;
+}
+/**
+ * Represents a reference to a Google Cloud Storage object. Developers can
+ * upload, download, and delete objects, as well as get/set object metadata.
+ * @public
+ */
+export declare interface StorageReference {
+    /**
+     * Returns a gs:// URL for this object in the form
+     *   `gs://<bucket>/<path>/<to>/<object>`
+     * @returns The gs:// URL.
+     */
+    toString(): string;
+    /**
+     * A reference to the root of this object's bucket.
+     */
+    root: StorageReference;
+    /**
+     * The name of the bucket containing this reference's object.
+     */
+    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;
+    /**
+     * A reference pointing to the parent location of this reference, or null if
+     * this reference is the root.
+     */
+    parent: StorageReference | null;
 }

package/dist/util/entities.d.ts

@@ -1,5 +1,5 @@
 import { CMSType, DataType, Entity, EntityReference, EntityStatus, EntityValues, PropertiesOrBuilders, Property, PropertyBuilder, PropertyOrBuilder, ResolvedProperties, ResolvedProperty } from "../types";
-export declare function isReadOnly(property: Property | ResolvedProperty): boolean;
+export declare function isReadOnly(property: Property<any> | ResolvedProperty<any>): boolean;
 export declare function isHidden(property: Property | ResolvedProperty): boolean;
 export declare function isPropertyBuilder<T extends CMSType, M extends Record<string, any>>(propertyOrBuilder?: PropertyOrBuilder<T, M> | Property<T> | ResolvedProperty<T>): propertyOrBuilder is PropertyBuilder<T, M>;
 export declare function getDefaultValuesFor<M extends Record<string, any>>(properties: PropertiesOrBuilders<M> | ResolvedProperties<M>): Partial<EntityValues<M>>;

package/dist/util/icon_list.d.ts

@@ -1 +1,5 @@
-export declare const iconsSearch: any;
+import Fuse from "fuse.js";
+export declare const iconsSearch: Fuse<{
+    key: string;
+    synonyms: any;
+}>;

package/dist/util/icons.d.ts

@@ -8,6 +8,7 @@ export type IconViewProps = {
     icon?: string;
 };
 export declare const IconForView: React.NamedExoticComponent<{
-    collectionOrView?: IconViewProps | undefined;
-    className?: string | undefined;
+    collectionOrView?: IconViewProps;
+    className?: string;
+    size?: "smallest" | "small" | "medium" | "large" | number;
 }>;

package/dist/util/index.d.ts

@@ -21,3 +21,4 @@ export * from "./make_properties_editable";
 export * from "./join_collections";
 export * from "./builders";
 export * from "./useTraceUpdate";
+export * from "./storage";

package/dist/util/plurals.d.ts

@@ -1,7 +1,6 @@
 /**
  * Returns the plural of an English word.
  *
- * @export
  * @param {string} word
  * @param {number} [amount]
  * @returns {string}
@@ -10,7 +9,6 @@ export declare function plural(word: string, amount?: number): string;
 /**
  * Returns the singular of an English word.
  *
- * @export
  * @param {string} word
  * @param {number} [amount]
  * @returns {string}

package/dist/util/property_utils.d.ts

@@ -3,7 +3,7 @@ import { EntityCollection, PropertiesOrBuilders, PropertyConfig, PropertyOrBuild
 export declare function isReferenceProperty(propertyOrBuilder: PropertyOrBuilder, fields: Record<string, PropertyConfig>): boolean | null;
 export declare function getIdIcon(size: "small" | "medium" | "large"): React.ReactNode;
 export declare function getIconForWidget(widget: PropertyConfig | undefined, size: "small" | "medium" | "large"): import("react/jsx-runtime").JSX.Element;
-export declare function getIconForProperty(property: PropertyOrBuilder | ResolvedProperty, size?: "small" | "medium" | "large", fields?: Record<string, PropertyConfig>): React.ReactNode;
+export declare function getIconForProperty(property: PropertyOrBuilder<any> | ResolvedProperty<any>, size?: "small" | "medium" | "large", fields?: Record<string, PropertyConfig>): React.ReactNode;
 export declare function getColorForProperty(property: PropertyOrBuilder, fields: Record<string, PropertyConfig>): string;
 /**
  * Get a property in a property tree from a path like

package/dist/util/resolutions.d.ts

@@ -26,6 +26,19 @@ export declare function resolveProperty<T extends CMSType = CMSType, M extends R
     fields?: Record<string, PropertyConfig<any>>;
     ignoreMissingFields?: boolean;
 }): ResolvedProperty<T> | null;
+export declare function getArrayResolvedProperties<M>({ propertyKey, propertyValue, property, ...props }: {
+    propertyValue: any;
+    propertyKey?: string;
+    property: ArrayProperty<any> | ResolvedArrayProperty<any>;
+    ignoreMissingFields: boolean;
+    values?: Partial<M>;
+    previousValues?: Partial<M>;
+    path?: string;
+    entityId?: string;
+    index?: number;
+    fromBuilder?: boolean;
+    fields?: Record<string, PropertyConfig>;
+}): ResolvedProperty[];
 export declare function resolveArrayProperty<T extends any[], M>({ propertyKey, property, ignoreMissingFields, ...props }: {
     propertyKey?: string;
     property: ArrayProperty<T> | ResolvedArrayProperty<T>;
@@ -43,7 +56,8 @@ export declare function resolveArrayProperty<T extends any[], M>({ propertyKey,
  * @param properties
  * @param value
  */
-export declare function resolveProperties<M extends Record<string, any>>({ properties, ignoreMissingFields, ...props }: {
+export declare function resolveProperties<M extends Record<string, any>>({ propertyKey, properties, ignoreMissingFields, ...props }: {
+    propertyKey?: string;
     properties: PropertiesOrBuilders<M>;
     values?: Partial<M>;
     previousValues?: Partial<M>;

package/dist/util/storage.d.ts

@@ -1,3 +1,24 @@
 import { EntityValues, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig, UploadedFileContext } from "../types";
-export declare function resolveFilenameString<M extends object>(input: string | ((context: UploadedFileContext) => Promise<string> | string), storage: StorageConfig, values: EntityValues<M>, entityId: string, path: string, property: ResolvedStringProperty | ResolvedArrayProperty<string[]>, file: File, propertyKey: string): Promise<string>;
-export declare function resolveStoragePathString<M extends object>(input: string | ((context: UploadedFileContext) => string), storage: StorageConfig, values: EntityValues<M>, entityId: string, path: string, property: ResolvedStringProperty | ResolvedArrayProperty<string[]>, file: File, propertyKey: string): string;
+interface ResolveFilenameStringParams<M extends object> {
+    input: string | ((context: UploadedFileContext) => (Promise<string> | string));
+    storage: StorageConfig;
+    values: EntityValues<M>;
+    entityId: string;
+    path?: string;
+    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    file: File;
+    propertyKey: string;
+}
+export declare function resolveStorageFilenameString<M extends object>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveFilenameStringParams<M>): Promise<string>;
+interface ResolveStoragePathStringParams<M extends object> {
+    input: string | ((context: UploadedFileContext) => string);
+    storage: StorageConfig;
+    values: EntityValues<M>;
+    entityId: string;
+    path?: string;
+    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    file: File;
+    propertyKey: string;
+}
+export declare function resolveStoragePathString<M extends object>({ input, storage, values, entityId, path, property, file, propertyKey }: ResolveStoragePathStringParams<M>): string;
+export {};

package/dist/util/useStorageUploadController.d.ts

@@ -1,4 +1,4 @@
-import { EntityValues, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig, StorageSource } from "../types";
+import { ArrayProperty, EntityValues, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig, StorageSource, StringProperty } from "../types";
 import { PreviewSize } from "../preview";
 /**
  * Internal representation of an item in the storage
@@ -18,9 +18,9 @@ export declare function useStorageUploadController<M extends object>({ entityId,
     entityId: string;
     entityValues: EntityValues<M>;
     value: string | string[] | null;
-    path: string;
+    path?: string;
     propertyKey: string;
-    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    property: StringProperty | ArrayProperty<string[]> | ResolvedStringProperty | ResolvedArrayProperty<string[]>;
     storageSource: StorageSource;
     disabled: boolean;
     onChange: (value: string | string[] | null) => void;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@firecms/core",
     "type": "module",
-    "version": "3.0.0-beta.7",
+    "version": "3.0.0-beta.9",
     "description": "Awesome Firebase/Firestore-based headless open-source CMS",
     "funding": {
         "url": "https://github.com/sponsors/firecmsco"
@@ -46,72 +46,61 @@
         "./package.json": "./package.json"
     },
     "dependencies": {
-        "@firecms/formex": "^3.0.0-beta.7",
-        "@firecms/ui": "^3.0.0-beta.7",
-        "@fontsource/jetbrains-mono": "^5.0.20",
+        "@firecms/editor": "^3.0.0-beta.9",
+        "@firecms/formex": "^3.0.0-beta.9",
+        "@firecms/ui": "^3.0.0-beta.9",
         "@hello-pangea/dnd": "^16.6.0",
-        "@radix-ui/react-portal": "^1.0.4",
+        "@radix-ui/react-portal": "^1.1.1",
         "clsx": "^2.1.1",
         "date-fns": "^3.6.0",
+        "fuse.js": "^7.0.0",
         "history": "^5.3.0",
-        "js-search": "^2.0.1",
         "markdown-it": "^14.1.0",
         "notistack": "^3.0.1",
         "object-hash": "^3.0.0",
         "react-dropzone": "^14.2.3",
         "react-fast-compare": "^3.2.2",
         "react-image-file-resizer": "^0.4.8",
-        "react-markdown-editor-lite": "^1.3.4",
         "react-transition-group": "^4.4.5",
         "react-use-measure": "^2.1.1",
         "react-window": "^1.8.10",
-        "typeface-rubik": "^1.1.13",
         "yup": "^0.32.11"
     },
     "peerDependencies": {
         "firebase": "^10.5.2",
         "react": "^18.3.1",
         "react-dom": "^18.3.1",
-        "react-router": "^6.22.0",
-        "react-router-dom": "^6.22.0"
+        "react-router": "^6.25.1",
+        "react-router-dom": "^6.25.1"
     },
     "devDependencies": {
         "@jest/globals": "^29.7.0",
         "@testing-library/react": "^15.0.7",
         "@testing-library/user-event": "^14.5.2",
         "@types/jest": "^29.5.12",
-        "@types/node": "^20.12.13",
+        "@types/node": "^20.14.12",
         "@types/object-hash": "^3.0.6",
         "@types/react": "^18.3.3",
         "@types/react-dom": "^18.3.0",
         "@types/react-measure": "^2.0.12",
-        "@typescript-eslint/eslint-plugin": "^7.11.0",
-        "@typescript-eslint/parser": "^7.11.0",
-        "@vitejs/plugin-react": "^4.3.0",
+        "@vitejs/plugin-react": "^4.3.1",
         "cross-env": "^7.0.3",
-        "eslint": "^8.57.0",
-        "eslint-config-standard": "^17.1.0",
-        "eslint-plugin-import": "^2.29.1",
-        "eslint-plugin-n": "^16.6.2",
-        "eslint-plugin-promise": "^6.2.0",
-        "eslint-plugin-react": "^7.34.2",
-        "eslint-plugin-react-hooks": "^4.6.2",
-        "firebase": "^10.12.2",
+        "firebase": "^10.12.4",
         "jest": "^29.7.0",
         "npm-run-all": "^4.1.5",
-        "react-router": "^6.23.1",
-        "react-router-dom": "^6.23.1",
-        "ts-jest": "^29.1.4",
+        "react-router": "^6.25.1",
+        "react-router-dom": "^6.25.1",
+        "ts-jest": "^29.2.3",
         "ts-node": "^10.9.2",
-        "tsd": "^0.31.0",
-        "typescript": "^5.4.5",
-        "vite": "^5.2.12"
+        "tsd": "^0.31.1",
+        "typescript": "^5.5.4",
+        "vite": "^5.3.4"
     },
     "files": [
         "dist",
         "src"
     ],
-    "gitHead": "b1f5dbd89d66bd75e8d214a4a6c40e07e371a1d1",
+    "gitHead": "a2fffa74049d185e674aae9f70b462f011edd1c2",
     "publishConfig": {
         "access": "public"
     },

package/src/app/AppBar.tsx

@@ -0,0 +1,18 @@
+import { DefaultAppBar, DefaultAppBarProps } from "../core/DefaultAppBar";
+
+/**
+ * This component renders the main app bar of FireCMS.
+ */
+export function AppBar({
+                           children,
+                           ...props
+                       }: {
+    children?: React.ReactNode,
+    className?: string,
+    style?: React.CSSProperties
+} & DefaultAppBarProps) {
+    const usedChildren = children ?? <DefaultAppBar {...props}/>;
+    return <>{usedChildren}</>;
+}
+
+AppBar.componentType = "AppBar";

package/src/app/Drawer.tsx

@@ -0,0 +1,25 @@
+import { DefaultDrawer } from "../core";
+
+/**
+ * This component is in charge of rendering the drawer.
+ * If you add this component under your {@link Scaffold}, it will be rendered
+ * as a drawer, and the open and close functionality will be handled automatically.
+ * If you want to customise the drawer, you can create your own component and pass it as a child.
+ * For custom drawers, you can use the {@link useApp} to open and close the drawer.
+ *
+
+ */
+export function Drawer({
+                           children,
+                           className,
+                           style
+                       }: {
+    children?: React.ReactNode,
+    className?: string,
+    style?: React.CSSProperties
+}) {
+    const usedChildren = children ?? <DefaultDrawer className={className} style={style}/>;
+    return <>{usedChildren}</>;
+}
+
+Drawer.componentType = "Drawer";