ap-ssg/types/types.d.ts

Static Site Generator

import { DocumentBaseConfig } from "./pageConfigRequired";
import { ArticleOptions } from "./schemas/article";
import { Software } from "./schemas/software";
import { BlogPostOptions } from "./schemas/blogpost";

interface pageConfigType {
  type?: never;
}

type defaultType = pageConfigType | ArticleOptions | BlogPostOptions | Software;

type pageConfig = DocumentBaseConfig & defaultType;

interface pageOptions {
  /**
   * Array of strings to insert into the head section of the HTML page.
   * @example
   * [
   *   '<link rel="stylesheet" href="styles.css">',
   *   '<script src="script.js"></script>'
   * ]
   */
  insertHead?: string[];

  /**
   * Array of strings to insert into the end of the body section of the HTML page.
   * @example
   * [
   *   '<script src="/assets/js/some_js_file.js"></script>'
   * ]
   */
  insertBodyEnd?: string[];
}

/**
 * Represents the content for the page, which will be a string (e.g., HTML content).
 * @example "<h1>Hello, World!</h1><p>This is a sample page content.</p>"
 */
type PageContentType = string;

export { pageConfig, PageContentType, pageOptions };