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

package/dist/util/permissions.d.ts

@@ -0,0 +1,5 @@
+import { AuthController, Entity, EntityCollection, Permissions, User } from "../types";
+export declare function resolvePermissions<M extends Record<string, any>, UserType extends User>(collection: EntityCollection<M>, authController: AuthController<UserType>, pathSegments: string[], entity: Entity<M> | null): Permissions;
+export declare function canEditEntity<M extends Record<string, any>, UserType extends User>(collection: EntityCollection<M>, authController: AuthController<UserType>, paths: string[], entity: Entity<M> | null): boolean;
+export declare function canCreateEntity<M extends Record<string, any>, UserType extends User>(collection: EntityCollection<M>, authController: AuthController<UserType>, paths: string[], entity: Entity<M> | null): boolean;
+export declare function canDeleteEntity<M extends Record<string, any>, UserType extends User>(collection: EntityCollection<M>, authController: AuthController<UserType>, paths: string[], entity: Entity<M> | null): boolean;

package/dist/util/plurals.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Returns the plural of an English word.
+ *
+ * @export
+ * @param {string} word
+ * @param {number} [amount]
+ * @returns {string}
+ */
+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}
+ */
+export declare function singular(word: string, amount?: number): string;

package/dist/util/property_utils.d.ts

@@ -0,0 +1,23 @@
+import React from "react";
+import { EntityCollection, PropertiesOrBuilders, PropertyConfig, PropertyOrBuilder, ResolvedProperty } from "../types";
+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 getColorForProperty(property: PropertyOrBuilder, fields: Record<string, PropertyConfig>): string;
+/**
+ * Get a property in a property tree from a path like
+ * `address.street`
+ * @param properties
+ * @param path
+ */
+export declare function getPropertyInPath<M extends Record<string, any>>(properties: PropertiesOrBuilders<M>, path: string): PropertyOrBuilder<any, M> | undefined;
+export declare function getResolvedPropertyInPath(properties: Record<string, ResolvedProperty>, path: string): ResolvedProperty | undefined;
+export declare function getBracketNotation(path: string): string;
+/**
+ * Get properties exclusively indexed by their order
+ * @param properties
+ * @param propertiesOrder
+ */
+export declare function getPropertiesWithPropertiesOrder<M extends Record<string, any>>(properties: PropertiesOrBuilders<M>, propertiesOrder?: Extract<keyof M, string>[]): PropertiesOrBuilders<M>;
+export declare function getDefaultPropertiesOrder(collection: EntityCollection<any>): string[];

package/dist/util/references.d.ts

@@ -0,0 +1,2 @@
+import { EntityCollection, PropertyConfig } from "../types";
+export declare function getReferencePreviewKeys(targetCollection: EntityCollection<any>, fields: Record<string, PropertyConfig>, previewProperties?: string[], limit?: number): string[];

package/dist/util/regexp.d.ts

@@ -0,0 +1,7 @@
+export declare function serializeRegExp(input: RegExp): string;
+/**
+ * Get a RegExp out of a serialized string
+ * @param input
+ */
+export declare function hydrateRegExp(input?: string): RegExp | undefined;
+export declare function isValidRegExp(input: string): boolean;

package/dist/util/resolutions.d.ts

@@ -0,0 +1,64 @@
+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>;
+    path: string;
+    entityId?: string | undefined;
+    values?: Partial<M> | undefined;
+    previousValues?: Partial<M> | undefined;
+    userConfigPersistence?: UserConfigurationPersistence | undefined;
+    fields?: Record<string, PropertyConfig> | undefined;
+}) => 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 }: {
+    propertyKey?: string;
+    propertyOrBuilder: PropertyOrBuilder<T, M> | ResolvedProperty<T>;
+    propertyValue?: unknown;
+    values?: Partial<M>;
+    previousValues?: Partial<M>;
+    path?: string;
+    entityId?: string;
+    index?: number;
+    fromBuilder?: boolean;
+    fields?: Record<string, PropertyConfig<any>>;
+}): ResolvedProperty<T> | null;
+export declare function resolveArrayProperty<T extends any[], M>({ propertyKey, property, propertyValue, ...props }: {
+    propertyKey?: string;
+    property: ArrayProperty<T> | ResolvedArrayProperty<T>;
+    propertyValue: any;
+    values?: Partial<M>;
+    previousValues?: Partial<M>;
+    path?: string;
+    entityId?: string;
+    index?: number;
+    fromBuilder?: boolean;
+    fields?: Record<string, PropertyConfig>;
+}): ResolvedArrayProperty;
+/**
+ * Resolve enums and arrays for properties
+ * @param properties
+ * @param value
+ */
+export declare function resolveProperties<M extends Record<string, any>>({ properties, propertyValue, ...props }: {
+    properties: PropertiesOrBuilders<M>;
+    propertyValue: unknown;
+    values?: Partial<M>;
+    previousValues?: Partial<M>;
+    path?: string;
+    entityId?: string;
+    index?: number;
+    fromBuilder?: boolean;
+    fields?: Record<string, PropertyConfig>;
+}): ResolvedProperties<M>;
+/**
+ * Resolve enum aliases for a string or number property
+ * @param property
+ * @param fromBuilder
+ */
+export declare function resolvePropertyEnum(property: StringProperty | NumberProperty, fromBuilder?: boolean): ResolvedStringProperty | ResolvedNumberProperty;
+export declare function resolveEnumValues(input: EnumValues): EnumValueConfig[] | undefined;
+export declare function resolveEntityView(entityView: string | EntityCustomView<any>, contextEntityViews?: EntityCustomView<any>[]): EntityCustomView<any> | undefined;

package/dist/util/storage.d.ts

@@ -0,0 +1,3 @@
+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;

package/dist/util/strings.d.ts

@@ -0,0 +1,6 @@
+export declare const toKebabCase: (str: string) => string;
+export declare const toSnakeCase: (str: string) => string;
+export declare function randomString(strLength?: number): string;
+export declare function randomColor(): string;
+export declare function slugify(text?: string, separator?: string, lowercase?: boolean): string;
+export declare function unslugify(slug: string): string;

package/dist/util/useDebounce.d.ts

@@ -0,0 +1 @@
+export declare function useDebounce<T>(value: T, callback: () => void, immediate: boolean, timeoutMs?: number): void;

package/dist/util/useStorageUploadController.d.ts

@@ -0,0 +1,36 @@
+import { EntityValues, ResolvedArrayProperty, ResolvedStringProperty, StorageConfig, StorageSource } from "../types";
+import { PreviewSize } from "../preview";
+/**
+ * Internal representation of an item in the storage
+ * It can have two states, having a storagePathOrDownloadUrl set,
+ * which means the file has been uploaded, and it is rendered as a preview
+ * Or have a pending file being uploaded.
+ */
+export interface StorageFieldItem {
+    id: number;
+    storagePathOrDownloadUrl?: string;
+    file?: File;
+    fileName?: string;
+    metadata?: any;
+    size: PreviewSize;
+}
+export declare function useStorageUploadController<M extends object>({ entityId, entityValues, path, value, property, propertyKey, storageSource, disabled, onChange }: {
+    entityId: string;
+    entityValues: EntityValues<M>;
+    value: string | string[] | null;
+    path: string;
+    propertyKey: string;
+    property: ResolvedStringProperty | ResolvedArrayProperty<string[]>;
+    storageSource: StorageSource;
+    disabled: boolean;
+    onChange: (value: string | string[] | null) => void;
+}): {
+    internalValue: StorageFieldItem[];
+    setInternalValue: import("react").Dispatch<import("react").SetStateAction<StorageFieldItem[]>>;
+    storage: StorageConfig;
+    fileNameBuilder: (file: File) => Promise<string>;
+    storagePathBuilder: (file: File) => string;
+    onFileUploadComplete: (uploadedPath: string, entry: StorageFieldItem, metadata?: any) => Promise<void>;
+    onFilesAdded: (acceptedFiles: File[]) => Promise<void>;
+    multipleFilesSupported: boolean;
+};

package/dist/util/useTraceUpdate.d.ts

@@ -0,0 +1 @@
+export declare function useTraceUpdate(props: any): void;

package/package.json

@@ -1,144 +1,116 @@
 {
-    "name": "@firecms/core",
-    "version": "3.0.0-alpha.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"
-    },
-    "exports": {
-        ".": {
-            "import": "./dist/index.es.js",
-            "require": "./dist/index.umd.js",
-            "types": "./dist/index.d.ts"
-        },
-        "./components": {
-            "import": "./dist/components/index.es.js",
-            "require": "./dist/components/index.umd.js",
-            "types": "./dist/components/index.d.ts"
-        }
-    },
-    "keywords": [
-        "firebase",
-        "cms",
-        "admin",
-        "admin panel",
-        "firebase panel",
-        "firestore",
-        "headless",
-        "headless cms",
-        "content manager"
-    ],
-    "scripts": {
-        "watch": "vite build --watch",
-        "build": "vite build",
-        "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",
-        "generateIcons": "ts-node --esm src/icons/generateIcons.ts"
-    },
-    "dependencies": {
-        "@date-io/date-fns": "^2.16.0",
-        "@fontsource/ibm-plex-mono": "^4.5.13",
-        "@fontsource/roboto": "^5.0.3",
-        "@hello-pangea/dnd": "^16.2.0",
-        "@material-design-icons/font": "latest",
-        "@radix-ui/react-checkbox": "^1.0.4",
-        "@radix-ui/react-collapsible": "^1.0.3",
-        "@radix-ui/react-dialog": "^1.0.4",
-        "@radix-ui/react-dropdown-menu": "^2.0.5",
-        "@radix-ui/react-popover": "^1.0.6",
-        "@radix-ui/react-portal": "^1.0.3",
-        "@radix-ui/react-scroll-area": "^1.0.4",
-        "@radix-ui/react-select": "^1.2.2",
-        "@radix-ui/react-switch": "^1.0.3",
-        "@radix-ui/react-tabs": "^1.0.4",
-        "@radix-ui/react-tooltip": "^1.0.6",
-        "cmdk": "^0.2.0",
-        "date-fns": "^2.30.0",
-        "formik": "^2.4.1",
-        "history": "^5.3.0",
-        "js-search": "^2.0.1",
-        "markdown-it": "^13.0.1",
-        "notistack": "^3.0.1",
-        "object-hash": "^3.0.0",
-        "react-datepicker": "^4.16.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.9",
-        "tailwind-merge": "^1.14.0",
-        "typeface-rubik": "^1.1.13",
-        "yup": "^0.32.11"
-    },
-    "peerDependencies": {
-        "algoliasearch": "^4.13.0",
-        "firebase": "^10.4.0",
-        "react": "^18.0.0",
-        "react-dom": "^18.0.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.16.5",
-        "@testing-library/react": "^14.0.0",
-        "@testing-library/user-event": "^14.4.3",
-        "@types/jest": "^29.5.2",
-        "@types/node": "^18.16.16",
-        "@types/object-hash": "^3.0.2",
-        "@types/react": "^18.2.8",
-        "@types/react-dom": "^18.2.4",
-        "@types/react-measure": "^2.0.8",
-        "@typescript-eslint/eslint-plugin": "^5.59.11",
-        "@typescript-eslint/parser": "^5.59.11",
-        "@vitejs/plugin-react": "^4.0.0",
-        "algoliasearch": "^4.17.1",
-        "cross-env": "^7.0.3",
-        "eslint": "^8.42.0",
-        "eslint-config-standard": "^17.1.0",
-        "eslint-plugin-import": "^2.27.5",
-        "eslint-plugin-n": "^15.7.0",
-        "eslint-plugin-promise": "^6.1.1",
-        "eslint-plugin-react": "^7.32.2",
-        "eslint-plugin-react-hooks": "^4.6.0",
-        "firebase": "^10.4.0",
-        "jest": "^29.7.0",
-        "npm-run-all": "^4.1.5",
-        "react": "^18.2.0",
-        "react-dom": "^18.2.0",
-        "react-router": "^6.12.0",
-        "react-router-dom": "^6.12.0",
-        "ts-jest": "^29.1.1",
-        "ts-node": "^10.9.1",
-        "tsd": "^0.28.1",
-        "typescript": "^5.2.2",
-        "vite": "^4.3.9"
-    },
-    "files": [
-        "dist"
-    ],
-    "gitHead": "b7cc1558378034282eaac7c9cc425853eddf4e5c",
-    "publishConfig": {
-        "access": "public"
-    }
+  "name": "@firecms/core",
+  "type": "module",
+  "version": "3.0.0-alpha.70",
+  "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"
+  },
+  "dependencies": {
+    "@firecms/ui": "^3.0.0-alpha.70",
+    "@fontsource/ibm-plex-mono": "^5.0.8",
+    "@fontsource/roboto": "^5.0.8",
+    "@hello-pangea/dnd": "^16.5.0",
+    "date-fns": "^3.0.6",
+    "formik": "^2.4.5",
+    "history": "^5.3.0",
+    "js-search": "^2.0.1",
+    "markdown-it": "^13.0.2",
+    "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": {
+    "algoliasearch": "^4.13.0",
+    "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.0.0",
+    "@testing-library/user-event": "^14.5.1",
+    "@types/jest": "^29.5.6",
+    "@types/node": "^20.8.9",
+    "@types/object-hash": "^3.0.6",
+    "@types/react": "^18.2.45",
+    "@types/react-dom": "^18.2.17",
+    "@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",
+    "algoliasearch": "^4.22.0",
+    "cross-env": "^7.0.3",
+    "eslint": "^8.55.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.7.1",
+    "jest": "^29.7.0",
+    "npm-run-all": "^4.1.5",
+    "react-router": "^6.21.0",
+    "react-router-dom": "^6.21.0",
+    "ts-jest": "^29.1.1",
+    "ts-node": "^10.9.2",
+    "tsd": "^0.28.1",
+    "typescript": "^5.3.3",
+    "vite": "^4.5.1"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "gitHead": "245fddde8eca08212aa7c83715cad3a4e3f80ed1",
+  "publishConfig": {
+    "access": "public"
+  }
 }