123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
import { posix } from "../deps/path.ts";import { documentToString, stringToDocument } from "./utils/dom.ts";
import type { MergeStrategy } from "./utils/merge_data.ts";import type { ProxyComponents } from "./source.ts";import type { Entry } from "./fs.ts";
/** A page of the site */export class Page<D extends Data = Data> {  /** The src info */  src: Src;
  /**   * Used to save the page data   */  data: D = {} as D;
  /**   * Internal data. Used to save arbitrary data by plugins and processors   */  #_data = {};
  /** The page content (string or Uint8Array) */  #content?: Content;
  /** The parsed HTML (only for HTML documents) */  #document?: Document;
  /** Convenient way to create a page dynamically */  static create(data: Partial<Data> & { url: string }): Page {    let { url, ...rest } = data;    const basename = posix.basename(url).replace(/\.[\w.]+$/, "");    const page = new Page();
    if (url.endsWith("/index.html")) {      url = url.slice(0, -10);    }
    page.data = { ...rest, url, page, basename } as Data;    page.content = data.content as Content | undefined;
    return page;  }
  constructor(src?: Partial<Src>) {    this.src = { path: "", ext: "", asset: true, ...src };  }
  /**   * The property _data is to store internal data,   * used by plugins, processors, etc to save arbitrary values   */  set _data(data: Record<string, unknown>) {    this.#_data = data;  }
  get _data() {    return this.#_data;  }
  /** Duplicate this page. */  duplicate(index: number | undefined, data: D): Page<D> {    const page = new Page<D>({ ...this.src });
    if (index !== undefined) {      page.src.path += `[${index}]`;    }
    data.page = page;    page.data = data;
    return page;  }
  /** Returns the output path of this page */  get outputPath(): string {    const url = this.data.url;    return decodeURI(url.endsWith("/") ? url + "index.html" : url);  }
  /** Returns the source path of this page */  get sourcePath(): string {    if (this.src.entry?.flags.has("remote")) {      return this.src.entry.src;    }
    if (!this.src.path) {      return "(generated)";    }
    return this.src.path + this.src.ext;  }
  /** The content of this page */  set content(content: Content | undefined) {    this.#document = undefined;    this.#content = content instanceof Uint8Array      ? content      : content && content.toString();  }
  get content(): Content | undefined {    if (this.#document) {      this.#content = documentToString(this.#document);      this.#document = undefined;    }
    return this.#content;  }
  /** The parsed HTML code from the content */  set document(document: Document | undefined) {    this.#content = undefined;    this.#document = document;  }
  get document(): Document | undefined {    if (this.#document) {      return this.#document;    }
    const url = this.outputPath;
    if (this.#content && url.endsWith(".html")) {      this.#document = stringToDocument(this.#content.toString());    }
    return this.#document;  }}
export interface StaticFile {  /** The Entry instance of the file */  entry: Entry;
  /** The final url destination */  outputPath: string;}
/** The .src property for a Page */export interface Src {  /** If the page was loaded as asset or not */  asset: boolean;
  /** The path to the file (without extension) */  path: string;
  /** The extension of the file */  ext: string;
  /** The original entry instance (empty for pages generated dynamically) */  entry?: Entry;}
/** The .content property for a Page */export type Content = Uint8Array | string;
/** The data of a page declared initially */export interface RawData {  /** List of tags assigned to a page or folder */  tags?: string | string[];
  /** The url of a page */  url?: string | false | ((page: Page) => string | false);
  /** The basename of a page */  basename?: string;
  /** Mark the page as a draft */  draft?: boolean;
  /** The date creation of the page */  date?: Date | string | number;
  /** To configure the rendering order of a page */  renderOrder?: number;
  /** The raw content of a page */  content?: unknown;
  /** The layout used to render a page */  layout?: string;
  /** To configure a different template engine(s) to render a page */  templateEngine?: string | string[];
  /** To configure how some data keys will be merged with the parent */  mergedKeys?: Record<string, MergeStrategy>;
  /** Whether render this page on demand or not */  onDemand?: boolean;
  // deno-lint-ignore no-explicit-any  [index: string]: any;}
/** The data of a page/folder once loaded and processed */export interface Data extends RawData {  /** The title of the page */  title?: string;
  /** The type of the page (used to group pages in collections) */  type?: string;
  /** The id of the page (used to identify a page in a collection) */  id?: string | number;
  /** List of tags assigned to a page or folder */  tags: string[];
  /** The url of a page */  url: string;
  /** The basename of the page */  basename: string;
  /** The date creation of the page */  date: Date;
  /**   * The available components   * @see https://lume.land/docs/core/components/   */  comp: ProxyComponents;
  /** The page reference */  page: Page;
  /** The language of the page */  lang?: string;
  /**   * Unmatched Language URL   * The url for when the user's language doesn't match with any of the site's available languages.   *   * Valid values are:   * - External URL string (http, https), which is language selector page   * - Source path string (/), which is language selector page   * - Language code (en, gl, vi), which is fallback language page   *   * This option is made for x-default feature.   * @see https://developers.google.com/search/docs/specialty/international/localized-versions#xdefault   */  unmatchedLangUrl?: string;
  /**   * Alternate pages (for languages)   * @see https://lume.land/plugins/multilanguage/   */  alternates?: Data[];}