123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
/// <reference lib="dom" />/* eslint-disable @typescript-eslint/consistent-type-definitions */
/** * Optional Type Util * @public * @typeParam T - whether to support optional types * - undefined: all available * - true: only optional types are supported * - false: optional types are not supported */export type FFFOptionalType<T extends (boolean | undefined), Required, Optional> =  T extends undefined  ? Optional | Required  : T extends true  ? Optional  : Required
/** * Object Image * @public */export type FFFImage = Partial<HTMLImageElement> & {  figcaption?: string  sources?: Partial<HTMLSourceElement>[]}
/** * Object Audio * @public */export type FFFAudio = Partial<HTMLAudioElement> & {  sources?: Partial<HTMLSourceElement>[]}
/** * Object Video * @public */export type FFFVideo = Partial<HTMLVideoElement> & {  sources?: Partial<HTMLSourceElement>[]}
/** * Author * @public */export type FFFAuthor = {  /** the URL for an image for the author. */  avatar?: string  /** the author's name. */  name?: string  /** the URL of a site owned by the author. */  url?: string}
/** * Base Variables * @public * @typeParam T - whether to support optional types * - undefined / true: all available * - false: optional types are not supported */export type FFFBase<T extends (boolean | undefined) = undefined> = {  /**   * categories array, any plain text values you want.   * @remarks optional   */  categories?: T extends false ? never : string[]  /** flags array, any plain text values you want. */  flags?: string[]  /** plain text sentence or two describing the post. */  summary?: string  /** tags array, any plain text values you want. */  tags?: string[]  /** the title of article, non-article posts may omit titles. */  title?: string}
/** * DateTime Vaeriables * @public */export type FFFDateTime = {  /** the created date of the post. */  created?: string  /** datetime the event ends. */  end?: string  /** the published date of the post. */  published?: string  /** datetime the event starts. */  start?: string  /** the updated date of the post. */  updated?: string}
/** * Media Variables * @public * @typeParam T - whether to support optional types * - undefined: all available * - true: only optional types are supported * - false: optional types are not supported */export type FFFMedia<T extends (boolean | undefined) = undefined> = {  /** image alternate text. */  alt?: T extends true ? never : string  /** the main audio for audio post. */  audio?: FFFOptionalType<T, string, FFFAudio>  /** the main image for article or photo post. */  image?: FFFOptionalType<T, string, FFFImage>  /** the image for multi-photo post. */  images?: FFFOptionalType<T, string[], FFFImage[]>  /** the main video for video post. */  video?: FFFOptionalType<T, string, FFFVideo>}
/** * Mention Variables * @public */export type FFFMention = {  /** indicates this post is a bookmark of another URL. */  bookmark_of?: string  /** URL which the post is considered reply to. */  in_reply_to?: string  /** the URL which the post is considered a "like" (favorite, star) of. */  like_of?: string  /** the URL which the post is considered a "repost" of. */  repost_of?: string}
/** * Extra Variables * @public * @typeParam T - whether to support optional types * - undefined / true: all available * - false: optional types are not supported */export type FFFExtra<T extends (boolean | undefined) = undefined> = {  /** specifies one or more post authors. */  authors?: FFFAuthor[]  /** the URL of the venue/location h-card which the h-entry is considered a "checkin" of. */  checkin?: string  /**   * when true, the post is considered a draft.   * @remarks optional   */  draft?: T extends false ? never : boolean  /** the primary language for the post. */  lang?: string  /** location the post was posted from. */  location?: string  /** a reply to an event that says whether the sender is attending. */  rsvp?: 'interested' | 'maybe' | 'no' | 'yes'  /** URL(s) of syndicated copies of this post. */  syndication?: string | string[]  /**   * post visibility, consistent with micropub extensions.   * @remarks optional   */  // eslint-disable-next-line @typescript-eslint/ban-types  visibility?: T extends false ? never : ('private' | 'public' | 'unlisted' | (string & {}))}
/** * Type definition of the {@link https://fff.js.org | FFF Flavored Frontmatter}. * @public * @typeParam T - whether to support optional types * - undefined: all available * - true: only optional types are supported * - false: optional types are not supported */export type FFFFlavoredFrontmatter<T extends (boolean | undefined) = undefined> = FFFBase &  FFFDateTime &  FFFMedia<T> &  FFFMention &  FFFExtra/* eslint-enable @typescript-eslint/consistent-type-definitions */