types.d.ts

// Copyright 2022 the Deno authors. All rights reserved. MIT license.

import type { ConnInfo, VNode } from "./deps.ts";

export interface BlogContext {
  state: BlogState;
  connInfo: ConnInfo;
  next: () => Promise<Response>;
}

export interface BlogMiddleware {
  (req: Request, ctx: BlogContext): Promise<Response>;
}

export interface BlogSettings {
  title?: string;
  description?: string;
  picture?: string;
  author?: string;
  links?: { title: string; url: string; icon?: VNode }[];
  header?: VNode;
  footer?: VNode;
  style?: string;
  background?: string;
  ogImage?: string;
  middlewares?: BlogMiddleware[];
}

export interface BlogState extends BlogSettings {
  directory: string;
}

/** Represents a Post in the Blog. */
export interface Post {
  pathname: string;
  markdown: string;
  title: string;
  publishDate: Date;
  author?: string;
  snippet?: string;
  coverHtml?: string;
  background?: string;
  /** An image URL which is used in the OpenGraph og:image tag. */
  ogImage?: string;
}