gcg/static-cms
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat: improve cms event types (#769)

Browse Source
This commit is contained in:
Daniel Lautzenheiser
2023-04-26 15:12:17 -04:00
committed by GitHub
parent b967b61e51
commit 4444dd791c
5 changed files with 86 additions and 30 deletions
Download Patch File Download Diff File Expand all files Collapse all files

32
packages/core/src/interface.ts
View File

@ -825,16 +825,32 @@ export interface EventData {
author: { login: string | undefined; name: string };
}
export type EventListenerOptions = Record<string, unknown>;
export type PreSaveEventHandler<O extends Record<string, unknown> = Record<string, unknown>> = (
data: EventData,
options: O,
) => EntryData | undefined | null | void | Promise<EntryData | undefined | null | void>;
export type EventListenerHandler = (
data: EventData | undefined,
options: EventListenerOptions,
) => Promise<EntryData | undefined | null | void>;
export type PostSaveEventHandler<O extends Record<string, unknown> = Record<string, unknown>> = (
data: EventData,
options: O,
) => void | Promise<void>;
export interface EventListener {
name: AllowedEvent;
handler: EventListenerHandler;
export type MountedEventHandler<O extends Record<string, unknown> = Record<string, unknown>> = (
options: O,
) => void | Promise<void>;
export type EventHandlers<O extends Record<string, unknown> = Record<string, unknown>> = {
preSave: PreSaveEventHandler<O>;
postSave: PostSaveEventHandler<O>;
mounted: MountedEventHandler<O>;
};
export interface EventListener<
E extends AllowedEvent = 'mounted',
O extends Record<string, unknown> = Record<string, unknown>,
> {
name: E;
handler: EventHandlers<O>[E];
}
export interface AdditionalLinkOptions {