@firecms/core 3.0.0-canary.9 → 3.0.0-canary.91

package/dist/types/properties.d.ts

@@ -1,14 +1,14 @@
 import React from "react";
 import { FieldProps } from "./fields";
 import { PropertyPreviewProps } from "../preview";
-import { EntityReference, EntityValues, GeoPoint } from "./entities";
+import { EntityReference, EntityValues, GeoPoint, Vector } from "./entities";
 import { ResolvedArrayProperty, ResolvedStringProperty } from "./resolved_entities";
 import { FilterValues } from "./collections";
 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 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<CMSType> ? "array" : T extends Record<string, any> ? "map" : never;
 /**
  * @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.
@@ -474,6 +474,14 @@ export interface ReferenceProperty extends BaseProperty<EntityReference> {
      * specified values are considered.
      */
     previewProperties?: string[];
+    /**
+     * Should the reference include the ID of the entity. Defaults to `true`
+     */
+    includeId?: boolean;
+    /**
+     * Should the reference include a link to the entity (open the entity details). Defaults to `true`
+     */
+    includeEntityLink?: boolean;
 }
 /**
  * Rules to validate any property. Some properties have specific rules
@@ -620,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
@@ -644,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/storage.d.ts

@@ -6,6 +6,7 @@ export interface UploadFileProps {
     fileName?: string;
     path?: string;
     metadata?: any;
+    bucket?: string;
 }
 /**
  * @group Models
@@ -15,6 +16,10 @@ export interface UploadFileResult {
      * Storage path including the file name where the file was uploaded.
      */
     path: string;
+    /**
+     * Bucket where the file was uploaded
+     */
+    bucket: string;
 }
 /**
  * @group Models
@@ -66,17 +71,20 @@ export interface StorageSource {
      * @param fileName
      * @param path
      * @param metadata
+     * @param bucket
      */
-    uploadFile: ({ file, fileName, path, metadata }: UploadFileProps) => Promise<UploadFileResult>;
+    uploadFile: ({ file, fileName, path, metadata, bucket }: UploadFileProps) => Promise<UploadFileResult>;
     /**
      * Convert a storage path or URL into a download configuration
      * @param path
+     * @param bucket
      */
-    getDownloadURL: (pathOrUrl: string) => Promise<DownloadConfig>;
+    getDownloadURL: (pathOrUrl: string, bucket?: string) => Promise<DownloadConfig>;
     /**
      * Get a file from a storage path.
      * It returns null if the file does not exist.
      * @param props
+     * @param bucket
      */
-    getFile: (path: string) => Promise<File | null>;
+    getFile: (path: string, bucket?: string) => Promise<File | null>;
 }

package/dist/util/collections.d.ts

@@ -8,4 +8,4 @@ export declare function resolveDefaultSelectedView(defaultSelectedView: string |
  * @param collections
  * @param permissionsBuilder
  */
-export declare const applyPermissionsFunctionIfEmpty: (collections: EntityCollection[], permissionsBuilder?: PermissionsBuilder) => EntityCollection[];
+export declare const applyPermissionsFunctionIfEmpty: (collections: EntityCollection[], permissionsBuilder?: PermissionsBuilder<any, any>) => EntityCollection[];

package/dist/util/entities.d.ts

@@ -23,6 +23,6 @@ export declare function updateDateAutoValues<M extends Record<string, any>>({ in
  * @group Datasource
  */
 export declare function sanitizeData<M extends Record<string, any>>(values: EntityValues<M>, properties: ResolvedProperties<M>): any;
-export declare function getReferenceFrom<M extends Record<string, any>>(entity: Entity<M>): EntityReference<M>;
+export declare function getReferenceFrom<M extends Record<string, any>>(entity: Entity<M>): EntityReference;
 export declare function traverseValuesProperties<M extends Record<string, any>>(inputValues: Partial<EntityValues<M>>, properties: ResolvedProperties<M>, operation: (value: any, property: Property) => any): EntityValues<M> | undefined;
 export declare function traverseValueProperty(inputValue: any, property: Property, operation: (value: any, property: Property) => any): any;

package/dist/util/icon_synonyms.d.ts

@@ -1,4 +1,4 @@
-export declare const icon_synonyms: {
+export declare const iconSynonyms: {
     abc: string;
     access_alarm: string;
     access_alarms: string;
@@ -84,7 +84,6 @@ export declare const icon_synonyms: {
     apartment: string;
     api: string;
     app_blocking: string;
-    apple: string;
     app_registration: string;
     approval: string;
     apps: string;
@@ -281,7 +280,6 @@ export declare const icon_synonyms: {
     cast: string;
     cast_connected: string;
     cast_for_education: string;
-    catching_pokemon: string;
     category: string;
     celebration: string;
     cell_tower: string;
@@ -382,10 +380,6 @@ export declare const icon_synonyms: {
     credit_score: string;
     crib: string;
     crop: string;
-    crop_169: string;
-    crop_32: string;
-    crop_54: string;
-    crop_75: string;
     crop_din: string;
     crop_free: string;
     crop_landscape: string;
@@ -420,7 +414,6 @@ export declare const icon_synonyms: {
     delete_forever: string;
     delete_outline: string;
     delete_sweep: string;
-    delivery_dining: string;
     density_large: string;
     density_medium: string;
     density_small: string;
@@ -525,11 +518,6 @@ export declare const icon_synonyms: {
     edit_road: string;
     egg: string;
     egg_alt: string;
-    eighteen_mp: string;
-    eight_k: string;
-    eight_k_plus: string;
-    eight_mp: string;
-    eightteen_mp: string;
     eject: string;
     elderly: string;
     elderly_woman: string;
@@ -542,7 +530,6 @@ export declare const icon_synonyms: {
     electric_rickshaw: string;
     electric_scooter: string;
     elevator: string;
-    eleven_mp: string;
     email: string;
     e_mobiledata: string;
     emoji_emotions: string;
@@ -582,7 +569,6 @@ export declare const icon_synonyms: {
     extension: string;
     extension_off: string;
     face: string;
-    facebook: string;
     face_retouching_natural: string;
     face_retouching_off: string;
     fact_check: string;
@@ -606,7 +592,6 @@ export declare const icon_synonyms: {
     fiber_new: string;
     fiber_pin: string;
     fiber_smart_record: string;
-    fifteen_mp: string;
     file_copy: string;
     file_download: string;
     file_download_done: string;
@@ -643,14 +628,8 @@ export declare const icon_synonyms: {
     fire_extinguisher: string;
     fireplace: string;
     first_page: string;
-    fitbit: string;
     fitness_center: string;
     fit_screen: string;
-    five_g: string;
-    five_k: string;
-    five_k_plus: string;
-    five_mp: string;
-    fivteen_mp: string;
     flag: string;
     flag_circle: string;
     flaky: string;
@@ -719,12 +698,6 @@ export declare const icon_synonyms: {
     forward_5: string;
     forward_to_inbox: string;
     foundation: string;
-    four_g_mobiledata: string;
-    four_g_plus_mobiledata: string;
-    four_k: string;
-    four_k_plus: string;
-    four_mp: string;
-    fourteen_mp: string;
     free_breakfast: string;
     fullscreen: string;
     fullscreen_exit: string;
@@ -740,10 +713,8 @@ export declare const icon_synonyms: {
     gif_box: string;
     girl: string;
     gite: string;
-    git_hub: string;
     g_mobiledata: string;
     golf_course: string;
-    google: string;
     gpp_bad: string;
     gpp_good: string;
     gpp_maybe: string;
@@ -756,8 +727,6 @@ export declare const icon_synonyms: {
     grain: string;
     graphic_eq: string;
     grass: string;
-    grid3x3: string;
-    grid4x4: string;
     grid_goldenratio: string;
     grid_off: string;
     grid_on: string;
@@ -802,7 +771,6 @@ export declare const icon_synonyms: {
     hide_image: string;
     hide_source: string;
     highlight: string;
-    highlight_alt: string;
     highlight_off: string;
     high_quality: string;
     hiking: string;
@@ -862,14 +830,12 @@ export declare const icon_synonyms: {
     insert_page_break: string;
     insert_photo: string;
     insights: string;
-    instagram: string;
     install_desktop: string;
     install_mobile: string;
     integration_instructions: string;
     interests: string;
     interpreter_mode: string;
     inventory: string;
-    inventory2: string;
     invert_colors: string;
     invert_colors_off: string;
     ios_share: string;
@@ -939,7 +905,6 @@ export declare const icon_synonyms: {
     line_weight: string;
     link: string;
     linked_camera: string;
-    linked_in: string;
     link_off: string;
     liquor: string;
     list: string;
@@ -1068,7 +1033,6 @@ export declare const icon_synonyms: {
     monochrome_photos: string;
     mood: string;
     mood_bad: string;
-    moped: string;
     more: string;
     more_horiz: string;
     more_time: string;
@@ -1116,13 +1080,8 @@ export declare const icon_synonyms: {
     nightlight_round: string;
     night_shelter: string;
     nights_stay: string;
-    nine_k: string;
-    nine_k_plus: string;
-    nine_mp: string;
-    nineteen_mp: string;
     no_accounts: string;
     no_backpack: string;
-    no_cell: string;
     no_drinks: string;
     no_encryption: string;
     no_encryption_gmailerrorred: string;
@@ -1160,9 +1119,6 @@ export declare const icon_synonyms: {
     oil_barrel: string;
     ondemand_video: string;
     on_device_training: string;
-    one_k: string;
-    one_kk: string;
-    one_k_plus: string;
     online_prediction: string;
     opacity: string;
     open_in_browser: string;
@@ -1184,13 +1140,9 @@ export declare const icon_synonyms: {
     panorama: string;
     panorama_fish_eye: string;
     panorama_horizontal: string;
-    panorama_horizontal_select: string;
     panorama_photosphere: string;
-    panorama_photosphere_select: string;
     panorama_vertical: string;
-    panorama_vertical_select: string;
     panorama_wide_angle: string;
-    panorama_wide_angle_select: string;
     pan_tool: string;
     paragliding: string;
     park: string;
@@ -1274,16 +1226,11 @@ export declare const icon_synonyms: {
     pin: string;
     pinch: string;
     pin_drop: string;
-    pinterest: string;
     pivot_table_chart: string;
-    pix: string;
     place: string;
     plagiarism: string;
     play_arrow: string;
     play_circle: string;
-    play_circle_filled: string;
-    play_circle_filled_white: string;
-    play_circle_outline: string;
     play_disabled: string;
     play_for_work: string;
     play_lesson: string;
@@ -1356,7 +1303,6 @@ export declare const icon_synonyms: {
     recommend: string;
     record_voice_over: string;
     rectangle: string;
-    reddit: string;
     redeem: string;
     redo: string;
     reduce_capacity: string;
@@ -1499,10 +1445,6 @@ export declare const icon_synonyms: {
     settings_suggest: string;
     settings_system_daydream: string;
     settings_voice: string;
-    seven_k: string;
-    seven_k_plus: string;
-    seven_mp: string;
-    seventeen_mp: string;
     share: string;
     share_location: string;
     shield: string;
@@ -1525,19 +1467,13 @@ export declare const icon_synonyms: {
     signal_cellular_4_bar: string;
     signal_cellular_alt: string;
     signal_cellular_connected_no_internet_0_bar: string;
-    signal_cellular_connected_no_internet_1_bar: string;
-    signal_cellular_connected_no_internet_2_bar: string;
-    signal_cellular_connected_no_internet_3_bar: string;
     signal_cellular_connected_no_internet_4_bar: string;
     signal_cellular_nodata: string;
     signal_cellular_no_sim: string;
     signal_cellular_null: string;
     signal_cellular_off: string;
     signal_wifi_bad: string;
-    signal_wifi_connected_no_internet4: string;
     signal_wifi_off: string;
-    signal_wifi_statusbar4_bar: string;
-    signal_wifi_statusbar_connected_no_internet4: string;
     signal_wifi_statusbar_null: string;
     signpost: string;
     sim_card: string;
@@ -1545,12 +1481,6 @@ export declare const icon_synonyms: {
     sim_card_download: string;
     single_bed: string;
     sip: string;
-    six_k: string;
-    six_k_plus: string;
-    six_mp: string;
-    sixteen_mp: string;
-    sixty_fps: string;
-    sixty_fps_select: string;
     skateboarding: string;
     skip_next: string;
     skip_previous: string;
@@ -1621,10 +1551,8 @@ export declare const icon_synonyms: {
     stairs: string;
     star: string;
     star_border: string;
-    star_border_purple_500: string;
     star_half: string;
     star_outline: string;
-    star_purple_500: string;
     star_rate: string;
     stars: string;
     start: string;
@@ -1712,8 +1640,6 @@ export declare const icon_synonyms: {
     task: string;
     task_alt: string;
     taxi_alert: string;
-    telegram: string;
-    ten_mp: string;
     terminal: string;
     terrain: string;
     text_decrease: string;
@@ -1733,16 +1659,6 @@ export declare const icon_synonyms: {
     theaters: string;
     thermostat: string;
     thermostat_auto: string;
-    thirteen_mp: string;
-    thirty_fps: string;
-    thirty_fps_select: string;
-    three_d_rotation: string;
-    three_g_mobiledata: string;
-    three_k: string;
-    three_k_plus: string;
-    three_mp: string;
-    three_p: string;
-    three_sixty: string;
     thumb_down: string;
     thumb_down_alt: string;
     thumb_down_off_alt: string;
@@ -1758,7 +1674,6 @@ export declare const icon_synonyms: {
     timer_3: string;
     timer_3_select: string;
     timer_off: string;
-    times_one_mobiledata: string;
     time_to_leave: string;
     tips_and_updates: string;
     title: string;
@@ -1802,16 +1717,6 @@ export declare const icon_synonyms: {
     turn_slight_right: string;
     tv: string;
     tv_off: string;
-    twelve_mp: string;
-    twenty_four_mp: string;
-    twenty_one_mp: string;
-    twenty_three_mp: string;
-    twenty_two_mp: string;
-    twenty_zero_mp: string;
-    twitter: string;
-    two_k: string;
-    two_k_plus: string;
-    two_mp: string;
     two_wheeler: string;
     umbrella: string;
     unarchive: string;
@@ -1941,7 +1846,6 @@ export declare const icon_synonyms: {
     wrong_location: string;
     wysiwyg: string;
     yard: string;
-    you_tube: string;
     youtube_searched_for: string;
     zoom_in: string;
     zoom_in_map: string;

package/dist/util/icons.d.ts

@@ -8,6 +8,6 @@ export type IconViewProps = {
     icon?: string;
 };
 export declare const IconForView: React.NamedExoticComponent<{
-    collectionOrView?: IconViewProps | undefined;
-    className?: string | undefined;
+    collectionOrView?: IconViewProps;
+    className?: string;
 }>;

package/dist/util/navigation_utils.d.ts

@@ -8,10 +8,10 @@ export declare function resolveCollectionPathIds(path: string, allCollections: E
 /**
  * Find the corresponding view at any depth for a given path.
  * Note that path or segments of the paths can be collection aliases.
- * @param pathOrAlias
+ * @param pathOrId
  * @param collections
  */
-export declare function getCollectionByPathOrId(pathOrAlias: string, collections: EntityCollection[]): EntityCollection | undefined;
+export declare function getCollectionByPathOrId(pathOrId: string, collections: EntityCollection[]): EntityCollection | undefined;
 /**
  * Get the subcollection combinations from a path:
  * "sites/es/locales" => ["sites/es/locales", "sites"]

package/dist/util/objects.d.ts

@@ -1,6 +1,6 @@
 export declare const pick: <T>(obj: T, ...args: any[]) => T;
 export declare function isObject(item: any): any;
-export declare function mergeDeep<T extends object>(target: T, source: any): T;
+export declare function mergeDeep<T extends Record<any, any>, U extends Record<any, any>>(target: T, source: U): T & U;
 export declare function getValueInPath(o: object | undefined, path: string): any;
 export declare function removeInPath(o: object, path: string): object | undefined;
 export declare function removeFunctions(o: object | undefined): any;

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/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 }: {
+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;