@sveltia/cms 0.121.5 → 0.122.1

package/types/public.d.ts

@@ -833,7 +833,7 @@ export type ComplexListField = ListFieldWithSubField | ListFieldWithSubFields |
 /**
  * List field definition.
  */
-export type ListField = SimpleListField | ComplexListField;
+export type ListField = SimpleListField | ListFieldWithSubField | ListFieldWithSubFields | ListFieldWithTypes;
 /**
  * Map field properties.
  */
@@ -2316,6 +2316,119 @@ export type EditorComponentDefinition = {
  * Supported event type.
  */
 export type AppEventType = "prePublish" | "postPublish" | "preUnpublish" | "postUnpublish" | "preSave" | "postSave";
+/**
+ * Author information for an event.
+ */
+export type AppEventAuthor = {
+    /**
+     * Author login name.
+     */
+    login?: string;
+    /**
+     * Author display name.
+     */
+    name?: string;
+};
+/**
+ * Event entry media file data.
+ */
+export type AppEventEntryMedia = {
+    /**
+     * Media file ID.
+     */
+    id: string;
+    /**
+     * Media file path.
+     */
+    path: string;
+    /**
+     * Media file name.
+     */
+    name: string;
+    /**
+     * Media file URL.
+     */
+    url: string;
+    /**
+     * Media file display URL.
+     */
+    displayURL: string;
+    /**
+     * Media file size in bytes.
+     */
+    size: number;
+    /**
+     * Media file object.
+     */
+    file: File;
+};
+/**
+ * Event entry data.
+ */
+export type AppEventEntry = {
+    /**
+     * Entry data for the default locale.
+     */
+    data: Record<string, any>;
+    /**
+     * Entry data for other locales with locale codes as keys.
+     */
+    i18n: Record<string, any>;
+    /**
+     * Entry slug.
+     */
+    slug: string;
+    /**
+     * Entry file path.
+     */
+    path: string;
+    /**
+     * Whether the entry is newly created.
+     */
+    newRecord: boolean;
+    /**
+     * Name of the collection.
+     */
+    collection: string;
+    /**
+     * List of media files associated with the entry.
+     */
+    mediaFiles: AppEventEntryMedia[];
+    /**
+     * Entry meta data.
+     */
+    meta: {
+        path: string;
+    };
+    /**
+     * Unknown. Always `null`.
+     */
+    isModification: null;
+    /**
+     * Unknown. Always `null`.
+     */
+    label: null;
+    /**
+     * Unknown. Always `false`.
+     */
+    partial: boolean;
+    /**
+     * Unknown. Always an empty string.
+     */
+    author: string;
+    /**
+     * Unknown. Always an empty string.
+     */
+    raw: string;
+    /**
+     * Unknown. Always an empty string.
+     */
+    status: string;
+    /**
+     * Unknown. Always an empty string.
+     */
+    updatedOn: string;
+};
 /**
  * Event listener properties.
  */
@@ -2325,15 +2438,14 @@ export type AppEventListener = {
      */
     name: AppEventType;
     /**
-     * Event handler.
+     * Event handler. For
+     * the `preSave` event, the handler can return a modified entry object in Immutable Map format to
+     * change the data before it is saved. For other events, the return value is ignored.
      */
     handler: (args: {
-        entry: Record<string, any>;
-        author?: {
-            login: string;
-            name: string;
-        };
-    }) => any;
+        author: AppEventAuthor;
+        entry: MapOf<AppEventEntry>;
+    }) => void | MapOf<AppEventEntry> | Promise<void> | Promise<MapOf<AppEventEntry>>;
 };
 export type CustomPreviewTemplateProps = {
     entry: Record<string, any>;
@@ -2363,3 +2475,4 @@ export type CustomWidgetSchema = {
     properties: Record<string, any>;
 };
 import type { JSX } from 'react';
+import type { MapOf } from 'immutable';