@firecms/core 3.0.0-canary.7 → 3.0.0-canary.70

package/dist/util/resolutions.d.ts

@@ -1,23 +1,22 @@
 import { ArrayProperty, CMSType, EntityCollection, EntityCustomView, EntityValues, EnumValueConfig, EnumValues, NumberProperty, PropertiesOrBuilders, PropertyConfig, PropertyOrBuilder, ResolvedArrayProperty, ResolvedEntityCollection, ResolvedNumberProperty, ResolvedProperties, ResolvedProperty, ResolvedStringProperty, StringProperty, UserConfigurationPersistence } from "../types";
-export declare const resolveCollection: <M extends Record<string, any>>({ collection, path, entityId, values, previousValues, userConfigPersistence, fields }: {
-    collection: EntityCollection<M, import("../types").User> | ResolvedEntityCollection<M>;
+export declare const resolveCollection: <M extends Record<string, any>>({ collection, path, entityId, values, previousValues, userConfigPersistence, fields, ignoreMissingFields }: {
+    collection: EntityCollection<M> | ResolvedEntityCollection<M>;
     path: string;
-    entityId?: string | undefined;
-    values?: Partial<M> | undefined;
-    previousValues?: Partial<M> | undefined;
-    userConfigPersistence?: UserConfigurationPersistence | undefined;
-    fields?: Record<string, PropertyConfig> | undefined;
+    entityId?: string;
+    values?: Partial<EntityValues<M>>;
+    previousValues?: Partial<EntityValues<M>>;
+    userConfigPersistence?: UserConfigurationPersistence;
+    fields?: Record<string, PropertyConfig>;
+    ignoreMissingFields?: boolean;
 }) => ResolvedEntityCollection<M>;
 /**
  * Resolve property builders, enums and arrays.
  * @param propertyOrBuilder
  * @param propertyValue
- * @param values
  */
-export declare function resolveProperty<T extends CMSType = CMSType, M extends Record<string, any> = any>({ propertyOrBuilder, propertyValue, fromBuilder, ...props }: {
+export declare function resolveProperty<T extends CMSType = CMSType, M extends Record<string, any> = any>({ propertyOrBuilder, fromBuilder, ignoreMissingFields, ...props }: {
     propertyKey?: string;
     propertyOrBuilder: PropertyOrBuilder<T, M> | ResolvedProperty<T>;
-    propertyValue?: unknown;
     values?: Partial<M>;
     previousValues?: Partial<M>;
     path?: string;
@@ -25,11 +24,11 @@ export declare function resolveProperty<T extends CMSType = CMSType, M extends R
     index?: number;
     fromBuilder?: boolean;
     fields?: Record<string, PropertyConfig<any>>;
+    ignoreMissingFields?: boolean;
 }): ResolvedProperty<T> | null;
-export declare function resolveArrayProperty<T extends any[], M>({ propertyKey, property, propertyValue, ...props }: {
+export declare function resolveArrayProperty<T extends any[], M>({ propertyKey, property, ignoreMissingFields, ...props }: {
     propertyKey?: string;
     property: ArrayProperty<T> | ResolvedArrayProperty<T>;
-    propertyValue: any;
     values?: Partial<M>;
     previousValues?: Partial<M>;
     path?: string;
@@ -37,15 +36,15 @@ export declare function resolveArrayProperty<T extends any[], M>({ propertyKey,
     index?: number;
     fromBuilder?: boolean;
     fields?: Record<string, PropertyConfig>;
+    ignoreMissingFields?: boolean;
 }): ResolvedArrayProperty;
 /**
  * Resolve enums and arrays for properties
  * @param properties
  * @param value
  */
-export declare function resolveProperties<M extends Record<string, any>>({ properties, propertyValue, ...props }: {
+export declare function resolveProperties<M extends Record<string, any>>({ properties, ignoreMissingFields, ...props }: {
     properties: PropertiesOrBuilders<M>;
-    propertyValue: unknown;
     values?: Partial<M>;
     previousValues?: Partial<M>;
     path?: string;
@@ -53,6 +52,7 @@ export declare function resolveProperties<M extends Record<string, any>>({ prope
     index?: number;
     fromBuilder?: boolean;
     fields?: Record<string, PropertyConfig>;
+    ignoreMissingFields?: boolean;
 }): ResolvedProperties<M>;
 /**
  * Resolve enum aliases for a string or number property

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 resolveFilenameString<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

@@ -18,7 +18,7 @@ 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[]>;
     storageSource: StorageSource;

package/dist/util/useTraceUpdate.d.ts

@@ -1 +1,2 @@
+export declare function printChanged(props: any, prev: any, path?: string | undefined, depth?: number | undefined, maxDepth?: number | undefined): void;
 export declare function useTraceUpdate(props: any, maxDepth?: number): void;

package/package.json

@@ -1,122 +1,142 @@
 {
-  "name": "@firecms/core",
-  "type": "module",
-  "version": "3.0.0-canary.7",
-  "description": "Awesome Firebase/Firestore-based headless open-source CMS",
-  "funding": {
-    "url": "https://github.com/sponsors/firecmsco"
-  },
-  "author": "FireCMS",
-  "license": "MIT",
-  "repository": "git@github.com:FireCMSco/firecms.git",
-  "main": "./dist/index.umd.js",
-  "module": "./dist/index.es.js",
-  "types": "./dist/index.d.ts",
-  "source": "src/index.ts",
-  "engines": {
-    "node": ">=14"
-  },
-  "keywords": [
-    "firebase",
-    "cms",
-    "admin",
-    "admin panel",
-    "firebase panel",
-    "firestore",
-    "headless",
-    "headless cms",
-    "content manager"
-  ],
-  "scripts": {
-    "watch": "vite build --watch",
-    "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
-    "prepublishOnly": "run-s build",
-    "createTag": "PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags",
-    "test:lint": "eslint \"src/**\" --quiet",
-    "test": "jest",
-    "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f",
-    "generateIcons": "ts-node --esm src/icons/generateIcons.ts"
-  },
-  "exports": {
-    ".": {
-      "import": "./dist/index.es.js",
-      "require": "./dist/index.umd.js",
-      "types": "./dist/src/index.d.ts"
+    "name": "@firecms/core",
+    "type": "module",
+    "version": "3.0.0-canary.70",
+    "description": "Awesome Firebase/Firestore-based headless open-source CMS",
+    "funding": {
+        "url": "https://github.com/sponsors/firecmsco"
     },
-    "./package.json": "./package.json"
-  },
-  "dependencies": {
-    "@firecms/formex": "^3.0.0-canary.7",
-    "@firecms/ui": "^3.0.0-canary.7",
-    "@fontsource/ibm-plex-mono": "^5.0.8",
-    "@fontsource/roboto": "^5.0.8",
-    "@hello-pangea/dnd": "^16.5.0",
-    "date-fns": "^3.3.1",
-    "history": "^5.3.0",
-    "js-search": "^2.0.1",
-    "markdown-it": "^14.0.0",
-    "notistack": "^3.0.1",
-    "object-hash": "^3.0.0",
-    "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.2.0",
-    "react-dom": "^18.2.0",
-    "react-router": "^6.2.0",
-    "react-router-dom": "^6.2.0"
-  },
-  "eslintConfig": {
-    "extends": [
-      "react-app",
-      "react-app/jest"
-    ]
-  },
-  "devDependencies": {
-    "@jest/globals": "^29.7.0",
-    "@testing-library/jest-dom": "^5.17.0",
-    "@testing-library/react": "^14.2.1",
-    "@testing-library/user-event": "^14.5.2",
-    "@types/jest": "^29.5.12",
-    "@types/node": "^20.11.16",
-    "@types/object-hash": "^3.0.6",
-    "@types/react": "^18.2.54",
-    "@types/react-dom": "^18.2.18",
-    "@types/react-measure": "^2.0.12",
-    "@typescript-eslint/eslint-plugin": "^5.62.0",
-    "@typescript-eslint/parser": "^5.62.0",
-    "@vitejs/plugin-react": "^4.2.1",
-    "cross-env": "^7.0.3",
-    "eslint": "^8.56.0",
-    "eslint-config-standard": "^17.1.0",
-    "eslint-plugin-import": "^2.29.1",
-    "eslint-plugin-n": "^15.7.0",
-    "eslint-plugin-promise": "^6.1.1",
-    "eslint-plugin-react": "^7.33.2",
-    "eslint-plugin-react-hooks": "^4.6.0",
-    "firebase": "^10.8.0",
-    "jest": "^29.7.0",
-    "npm-run-all": "^4.1.5",
-    "react-router": "^6.22.0",
-    "react-router-dom": "^6.22.0",
-    "ts-jest": "^29.1.2",
-    "ts-node": "^10.9.2",
-    "tsd": "^0.30.4",
-    "typescript": "^5.3.3",
-    "vite": "^5.1.1"
-  },
-  "files": [
-    "dist",
-    "src"
-  ],
-  "gitHead": "30ef9b29f5f624fca64e11ffda6001a98f998102",
-  "publishConfig": {
-    "access": "public"
-  }
+    "author": "FireCMS",
+    "license": "MIT",
+    "repository": "git@github.com:FireCMSco/firecms.git",
+    "main": "./dist/index.umd.js",
+    "module": "./dist/index.es.js",
+    "types": "./dist/index.d.ts",
+    "source": "src/index.ts",
+    "engines": {
+        "node": ">=14"
+    },
+    "keywords": [
+        "firebase",
+        "cms",
+        "admin",
+        "admin panel",
+        "firebase panel",
+        "firestore",
+        "headless",
+        "headless cms",
+        "content manager"
+    ],
+    "scripts": {
+        "watch": "vite build --watch",
+        "build": "vite build && tsc --emitDeclarationOnly -p tsconfig.prod.json",
+        "prepublishOnly": "run-s build",
+        "createTag": "PACKAGE_VERSION=$(cat package.json | grep version | head -1 | awk -F: '{ print $2 }' | sed 's/[\",]//g' | tr -d '[[:space:]]') && git tag v$PACKAGE_VERSION && git push --tags",
+        "test:lint": "eslint \"src/**\" --quiet",
+        "test": "jest",
+        "clean": "rm -rf dist && find ./src -name '*.js' -type f | xargs rm -f",
+        "generateIcons": "ts-node --esm src/icons/generateIcons.ts"
+    },
+    "exports": {
+        ".": {
+            "import": "./dist/index.es.js",
+            "require": "./dist/index.umd.js",
+            "types": "./dist/index.d.ts"
+        },
+        "./package.json": "./package.json"
+    },
+    "dependencies": {
+        "@firecms/formex": "^3.0.0-canary.70",
+        "@firecms/ui": "^3.0.0-canary.70",
+        "@fontsource/jetbrains-mono": "^5.0.20",
+        "@hello-pangea/dnd": "^16.6.0",
+        "@radix-ui/react-portal": "^1.0.4",
+        "clsx": "^2.1.1",
+        "date-fns": "^3.6.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"
+    },
+    "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/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",
+        "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",
+        "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",
+        "ts-node": "^10.9.2",
+        "tsd": "^0.31.0",
+        "typescript": "^5.4.5",
+        "vite": "^5.2.12"
+    },
+    "files": [
+        "dist",
+        "src"
+    ],
+    "gitHead": "8782754f770575b610bb23f89d284841bae03bdb",
+    "publishConfig": {
+        "access": "public"
+    },
+    "eslintConfig": {
+        "extends": [
+            "react-app",
+            "react-app/jest"
+        ]
+    },
+    "jest": {
+        "transform": {
+            "^.+\\.tsx?$": "ts-jest"
+        },
+        "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.tsx?$",
+        "moduleFileExtensions": [
+            "ts",
+            "tsx",
+            "js",
+            "jsx",
+            "json",
+            "node"
+        ],
+        "testEnvironment": "node",
+        "moduleNameMapper": {
+            "\\.(css|less)$": "<rootDir>/test/__mocks__/styleMock.js"
+        }
+    }
 }

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.
+ *
+ * @constructor
+ */
+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";