@firecms/core 3.0.0 → 3.1.0-canary.02232f4

package/dist/types/properties.d.ts

@@ -113,6 +113,27 @@ export interface BaseProperty<T extends CMSType, CustomProps = any> {
      * It defaults to 100, but you can set it to 50 to have two fields in the same row.
      */
     widthPercentage?: number;
+    /**
+     * Declarative conditions for dynamic property behavior using JSON Logic.
+     *
+     * An alternative to PropertyBuilder functions that can be:
+     * - Stored in the database as JSON
+     * - Edited via the collection editor UI
+     * - Evaluated at runtime like property builders
+     *
+     * @see PropertyConditions for available condition options
+     * @see https://jsonlogic.com/ for JSON Logic syntax
+     */
+    conditions?: PropertyConditions;
+    /**
+     * Set this property to true to provide the UX to explicitly set the value to `null`.
+     * Defaults to `false`.
+     */
+    nullable?: boolean;
+    /**
+     * @deprecated Use `nullable` instead.
+     */
+    clearable?: boolean;
 }
 /**
  * @group Entity properties
@@ -136,6 +157,220 @@ export interface PropertyDisabledConfig {
      */
     hidden?: boolean;
 }
+/**
+ * A JSON Logic rule that gets evaluated at runtime.
+ * @see https://jsonlogic.com/
+ *
+ * Common operators:
+ * - Comparison: ==, !=, ===, !==, >, <, >=, <=
+ * - Logic: and, or, !, !!
+ * - Data access: var, missing, missing_some
+ * - Array: in, map, filter, reduce, all, some, none, merge
+ * - String: substr, cat
+ * - Numeric: +, -, *, /, %, min, max
+ *
+ * Custom operators:
+ * - hasRole(roleId) - check if user has role by ID
+ * - hasAnyRole([roleIds]) - check if user has any of the roles
+ * - isToday(timestamp) - check if timestamp is today
+ * - isPast(timestamp) - check if timestamp is in the past
+ * - isFuture(timestamp) - check if timestamp is in the future
+ *
+ * @group Entity properties
+ */
+export type JsonLogicRule = Record<string, any>;
+/**
+ * Conditions for individual enum values within a property.
+ * @group Entity properties
+ */
+export interface EnumValueConditions {
+    /**
+     * Disable this enum option when condition is true.
+     * The option appears grayed out and cannot be selected.
+     */
+    disabled?: JsonLogicRule;
+    /**
+     * Message explaining why this option is disabled.
+     */
+    disabledMessage?: string;
+    /**
+     * Completely hide this enum option when condition is true.
+     * The option is removed from the dropdown/list.
+     */
+    hidden?: JsonLogicRule;
+}
+/**
+ * Declarative conditions for dynamic property behavior.
+ * All conditions are JSON Logic rules evaluated against ConditionContext.
+ *
+ * An alternative to PropertyBuilder functions that can be:
+ * - Stored in the database as JSON
+ * - Edited via the collection editor UI
+ * - Evaluated at runtime like property builders
+ *
+ * @see https://jsonlogic.com/ for JSON Logic syntax
+ * @group Entity properties
+ */
+export interface PropertyConditions {
+    /**
+     * Disable the field when this condition evaluates to true.
+     * The field becomes non-editable but still visible (unless also hidden).
+     *
+     * @example Disable when another field has a specific value
+     * ```json
+     * { "==": [{ "var": "values.status" }, "archived"] }
+     * ```
+     */
+    disabled?: JsonLogicRule;
+    /**
+     * Message to display when the field is disabled by a condition.
+     */
+    disabledMessage?: string;
+    /**
+     * Clear the field's value when it becomes disabled.
+     * @default false
+     */
+    clearOnDisabled?: boolean;
+    /**
+     * Hide the field completely when this condition evaluates to true.
+     * The field is removed from the form (not just visually hidden).
+     */
+    hidden?: JsonLogicRule;
+    /**
+     * Make the field read-only when this condition evaluates to true.
+     * Renders as a preview instead of an input.
+     */
+    readOnly?: JsonLogicRule;
+    /**
+     * Make the field required when this condition evaluates to true.
+     * Overrides the static `validation.required` setting.
+     */
+    required?: JsonLogicRule;
+    /**
+     * Custom message when conditional required validation fails.
+     */
+    requiredMessage?: string;
+    /**
+     * Dynamic minimum value for number/string length.
+     * Should evaluate to a number.
+     */
+    min?: JsonLogicRule;
+    /**
+     * Dynamic maximum value for number/string length.
+     * Should evaluate to a number.
+     */
+    max?: JsonLogicRule;
+    /**
+     * Dynamic default value for new entities.
+     * Should evaluate to a value of the appropriate type for the field.
+     * Only applied when entityId is empty (new entity).
+     */
+    defaultValue?: JsonLogicRule;
+    /**
+     * Conditions for individual enum values.
+     * Keys are the enum value IDs, values are condition configs.
+     *
+     * @example Disable certain enum options based on user role
+     * ```json
+     * {
+     *   "admin": {
+     *     "disabled": { "!": { "hasRole": "admin" } },
+     *     "disabledMessage": "Admin option requires admin role"
+     *   }
+     * }
+     * ```
+     */
+    enumConditions?: Record<string | number, EnumValueConditions>;
+    /**
+     * Filter which enum values are available.
+     * Should evaluate to an array of allowed enum value IDs.
+     */
+    allowedEnumValues?: JsonLogicRule;
+    /**
+     * Exclude specific enum values.
+     * Should evaluate to an array of enum value IDs to exclude.
+     */
+    excludedEnumValues?: JsonLogicRule;
+    /**
+     * Dynamic path for reference properties.
+     * Should evaluate to a collection path string.
+     */
+    referencePath?: JsonLogicRule;
+    /**
+     * Dynamic filter for reference selection.
+     * Should evaluate to a FilterValues object.
+     */
+    referenceFilter?: JsonLogicRule;
+    /**
+     * Can elements be added to the array?
+     */
+    canAddElements?: JsonLogicRule;
+    /**
+     * Can elements be reordered in the array?
+     */
+    sortable?: JsonLogicRule;
+    /**
+     * Dynamic accepted file types.
+     * Should evaluate to an array of MIME types.
+     */
+    acceptedFiles?: JsonLogicRule;
+    /**
+     * Dynamic maximum file size in bytes.
+     * Should evaluate to a number.
+     */
+    maxFileSize?: JsonLogicRule;
+}
+/**
+ * Context available during JSON Logic condition evaluation.
+ * Mirrors PropertyBuilderProps but adapted for JSON serialization.
+ * @group Entity properties
+ */
+export interface ConditionContext {
+    /**
+     * Current form/entity values.
+     * Date values are converted to Unix timestamps (milliseconds).
+     */
+    values: Record<string, any>;
+    /**
+     * Previous values before the current edit session.
+     */
+    previousValues: Record<string, any>;
+    /**
+     * Current value of this property specifically.
+     */
+    propertyValue: any;
+    /**
+     * Collection path (e.g., "products", "users/uid123/orders")
+     */
+    path: string;
+    /**
+     * Entity ID. Undefined for new entities.
+     */
+    entityId?: string;
+    /**
+     * Whether this is a new entity being created.
+     */
+    isNew: boolean;
+    /**
+     * Index of this property (only for array items).
+     */
+    index?: number;
+    /**
+     * Current authenticated user information.
+     */
+    user: {
+        uid: string;
+        email: string | null;
+        displayName: string | null;
+        photoURL: string | null;
+        /** Role IDs the user has (extracted from Role[].id) */
+        roles: string[];
+    };
+    /**
+     * Current timestamp as Unix milliseconds.
+     */
+    now: number;
+}
 /**
  * @group Entity properties
  */
@@ -247,10 +482,6 @@ export interface NumberProperty extends BaseProperty<number> {
      * Rules for validating this property
      */
     validation?: NumberPropertyValidationSchema;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
 }
 /**
  * @group Entity properties
@@ -262,6 +493,25 @@ export interface BooleanProperty extends BaseProperty<boolean> {
      */
     validation?: PropertyValidationSchema;
 }
+/**
+ * Configuration options for the markdown editor.
+ * @group Entity properties
+ */
+export interface MarkdownConfig {
+    /**
+     * Allow HTML input/output. When set to false, HTML tags in pasted content
+     * will be stripped and only markdown-compatible formatting will be preserved.
+     * Defaults to true for backwards compatibility.
+     */
+    html?: boolean;
+    /**
+     * Convert pasted text to markdown format. When enabled, rich text pasted
+     * from external sources (like Google Docs or Word) will be converted to
+     * clean markdown instead of preserving HTML styles.
+     * Defaults to false.
+     */
+    transformPastedText?: boolean;
+}
 /**
  * @group Entity properties
  */
@@ -275,10 +525,13 @@ export interface StringProperty extends BaseProperty<string> {
     multiline?: boolean;
     /**
      * Should this string property be displayed as a markdown field. If true,
-     * the field is rendered as a text editors that supports markdown highlight
+     * the field is rendered as a text editor that supports markdown highlight
      * syntax. It also includes a preview of the result.
+     *
+     * You can also pass a configuration object to customize the markdown editor
+     * behavior, particularly how HTML content is handled during paste operations.
      */
-    markdown?: boolean;
+    markdown?: boolean | MarkdownConfig;
     /**
      * You can use the enum values providing a map of possible
      * exclusive values the property can take, mapped to the label that it is
@@ -321,10 +574,6 @@ export interface StringProperty extends BaseProperty<string> {
      * Rules for validating this property
      */
     validation?: StringPropertyValidationSchema;
-    /**
-     * Add an icon to clear the value and set it to `null`. Defaults to `false`
-     */
-    clearable?: boolean;
     /**
      * You can use this property (a string) to behave as a reference to another
      * collection. The stored value is the ID of the entity in the
@@ -486,6 +735,13 @@ export interface DateProperty extends BaseProperty<Date> {
      * Add an icon to clear the value and set it to `null`. Defaults to `false`
      */
     clearable?: boolean;
+    /**
+     * IANA timezone string (e.g., "America/New_York", "Europe/London").
+     * Used to display and input dates in the specified timezone.
+     * The value stored will always be in UTC.
+     * If not provided, uses the user's local timezone.
+     */
+    timezone?: string;
 }
 /**
  * @group Entity properties
@@ -665,6 +921,15 @@ export type StorageConfig = {
      * - `{path}` - Path of this entity
      */
     storagePath: string | ((context: UploadedFileContext) => string);
+    /**
+     * When set to true, this flag indicates that the bucket name will be
+     * included in the saved storage path.
+     *
+     * E.g. `gs://my-bucket/path/to/file.png` instead of just `path/to/file.png`
+     *
+     * Defaults to false.
+     */
+    includeBucketUrl?: boolean;
     /**
      * When set to true, this flag indicates that the download URL of the file
      * will be saved in the datasource, instead of the storage path.
@@ -755,7 +1020,7 @@ export interface ImageResize {
      * - `contain`: Scale down to fit within bounds, preserving aspect ratio (default)
      * - `cover`: Scale to fill bounds, preserving aspect ratio (may crop)
      */
-    mode?: 'contain' | 'cover';
+    mode?: "contain" | "cover";
     /**
      * Output format for the resized image.
      * - `original`: Keep the original format (default)
@@ -763,7 +1028,7 @@ export interface ImageResize {
      * - `png`: Convert to PNG
      * - `webp`: Convert to WebP
      */
-    format?: 'original' | 'jpeg' | 'png' | 'webp';
+    format?: "original" | "jpeg" | "png" | "webp";
     /**
      * Quality for lossy formats (JPEG, WebP). Number between 0 and 100.
      * Higher is better quality but larger file size. Defaults to 80.

package/dist/types/storage.d.ts

@@ -7,6 +7,7 @@ export interface UploadFileProps {
     path?: string;
     metadata?: any;
     bucket?: string;
+    onProgress?: (progress: number) => void;
 }
 /**
  * @group Models
@@ -20,6 +21,14 @@ export interface UploadFileResult {
      * Bucket where the file was uploaded
      */
     bucket: string;
+    /**
+     * Fully qualified storage URL for the uploaded file.
+     *
+     * For example: `gs://my-bucket/path/to/file.png`.
+     *
+     * This is optional for backwards compatibility.
+     */
+    storageUrl?: string;
 }
 /**
  * @group Models