@shevky/core 0.0.2 → 0.0.4

package/lib/contentBody.js

@@ -0,0 +1,12 @@
+export class ContentBody {
+  /**
+   * @param {string} content
+   */
+  constructor(content) {
+    this._content = content;
+  }
+
+  get content() {
+    return this._content;
+  }
+}

package/lib/contentFile.js

@@ -0,0 +1,170 @@
+import { ContentBody } from "./contentBody.js";
+import { ContentHeader } from "./contentHeader.js";
+
+export class ContentFile {
+  /**
+   *
+   * @param {Record<string, unknown>} frontMatter
+   * @param {string} content
+   * @param {string} filePath
+   * @param {boolean} isValid
+   */
+  constructor(frontMatter, content, filePath, isValid) {
+    this._header = new ContentHeader(frontMatter);
+    this._body = new ContentBody(content);
+    this._filePath = filePath;
+    this._isValid = isValid;
+  }
+
+  get header() {
+    return this._header;
+  }
+
+  get body() {
+    return this._body;
+  }
+
+  get isValid() {
+    return this._isValid;
+  }
+
+  get sourcePath() {
+    return this._filePath;
+  }
+
+  get content() {
+    return this._body.content;
+  }
+
+  get status() {
+    return this._header.status;
+  }
+
+  get id() {
+    return this._header.id;
+  }
+
+  get lang() {
+    return this._header.lang;
+  }
+
+  get slug() {
+    return this._header.slug;
+  }
+
+  get canonical() {
+    return this._header.canonical;
+  }
+
+  get title() {
+    return this._header.title;
+  }
+
+  get template() {
+    return this._header.template;
+  }
+
+  get isFeatured() {
+    return this._header.isFeatured;
+  }
+
+  get category() {
+    return this._header.category;
+  }
+
+  get tags() {
+    return this._header.tags;
+  }
+
+  get keywords() {
+    return this._header.keywords;
+  }
+
+  get series() {
+    return this._header.series;
+  }
+
+  get collectionType() {
+    return this._header.collectionType;
+  }
+
+  get isCollectionPage() {
+    return this._header.isCollectionPage;
+  }
+
+  get isPolicy() {
+    return this._header.isPolicy;
+  }
+
+  get isAboutPage() {
+    return this._header.isAboutPage;
+  }
+
+  get isContactPage() {
+    return this._header.isContactPage;
+  }
+
+  get date() {
+    return this._header.date;
+  }
+
+  get updated() {
+    return this._header.updated;
+  }
+
+  get dateDisplay() {
+    return this._header.dateDisplay;
+  }
+
+  get description() {
+    return this._header.description;
+  }
+
+  get cover() {
+    return this._header.cover;
+  }
+
+  get coverAlt() {
+    return this._header.coverAlt;
+  }
+
+  get coverCaption() {
+    return this._header.coverCaption;
+  }
+
+  get readingTime() {
+    return this._header.readingTime;
+  }
+
+  get seriesTitle() {
+    return this._header.seriesTitle;
+  }
+
+  get menuLabel() {
+    return this._header.menuLabel;
+  }
+
+  get isHiddenOnMenu() {
+    return this._header.isHiddenOnMenu;
+  }
+
+  get menuOrder() {
+    return this._header.menuOrder;
+  }
+
+  get layout() {
+    return this._header.layout;
+  }
+
+  get isPublished() {
+    return this.status === "published";
+  }
+
+  get isDraft() {
+    return this.status === "draft";
+  }
+
+  get isPostTemplate() {
+    return this.template === "post";
+  }
+}

package/lib/contentHeader.js

@@ -0,0 +1,295 @@
+import { format as _fmt, config as _cfg } from "@shevky/base";
+
+export class ContentHeader {
+  /**
+   * @param {Record<string, unknown>} frontMatter
+   */
+  constructor(frontMatter) {
+    this._frontMatter = frontMatter ?? {};
+  }
+
+  get raw() {
+    return this._frontMatter;
+  }
+
+  get status() {
+    return typeof this._frontMatter.status === "string"
+      ? this._frontMatter.status.trim().toLowerCase()
+      : "";
+  }
+
+  get id() {
+    return typeof this._frontMatter.id === "string"
+      ? this._frontMatter.id.trim()
+      : "";
+  }
+
+  get lang() {
+    return typeof this._frontMatter.lang === "string"
+      ? this._frontMatter.lang
+      : "";
+  }
+
+  get slug() {
+    return typeof this._frontMatter.slug === "string"
+      ? this._frontMatter.slug
+      : "";
+  }
+
+  get canonical() {
+    return typeof this._frontMatter.canonical === "string"
+      ? this._frontMatter.canonical
+      : "";
+  }
+
+  get alternate() {
+    const value = this._frontMatter.alternate;
+    if (typeof value === "string") {
+      return value.trim();
+    }
+    if (value && typeof value === "object") {
+      return value;
+    }
+    return "";
+  }
+
+  get pair() {
+    return typeof this._frontMatter.pair === "string"
+      ? this._frontMatter.pair.trim()
+      : "";
+  }
+
+  get title() {
+    return typeof this._frontMatter.title === "string"
+      ? this._frontMatter.title
+      : "";
+  }
+
+  get template() {
+    return typeof this._frontMatter.template === "string"
+      ? this._frontMatter.template.trim()
+      : "page";
+  }
+
+  get listKey() {
+    return typeof this._frontMatter.listKey === "string"
+      ? this._frontMatter.listKey.trim()
+      : "";
+  }
+
+  get listHeading() {
+    return typeof this._frontMatter.listHeading === "string"
+      ? this._frontMatter.listHeading.trim()
+      : "";
+  }
+
+  get listingEmpty() {
+    const value = this._frontMatter.listingEmpty;
+    return value ?? "";
+  }
+
+  get listType() {
+    return typeof this._frontMatter.listType === "string"
+      ? this._frontMatter.listType.trim()
+      : "";
+  }
+
+  get type() {
+    return typeof this._frontMatter.type === "string"
+      ? this._frontMatter.type.trim()
+      : "";
+  }
+
+  get related() {
+    return Array.isArray(this._frontMatter.related)
+      ? this._frontMatter.related
+      : [];
+  }
+
+  get isFeatured() {
+    return _fmt.boolean(this._frontMatter.featured);
+  }
+
+  get category() {
+    return _fmt.slugify(
+      typeof this._frontMatter.category === "string"
+        ? this._frontMatter.category
+        : "",
+    );
+  }
+
+  get tags() {
+    const tags = _fmt.normalizeStringArray(this._frontMatter.tags);
+    return tags.map((t) => {
+      return _fmt.slugify(t);
+    });
+  }
+
+  get keywords() {
+    const keywords = _fmt.normalizeStringArray(this._frontMatter.keywords);
+    return keywords.filter((item) => item && item.trim().length > 0);
+  }
+
+  get series() {
+    return _fmt.slugify(
+      typeof this._frontMatter.series === "string"
+        ? this._frontMatter.series
+        : "",
+    );
+  }
+
+  get collectionType() {
+    return typeof this._frontMatter.collectionType === "string"
+      ? this._frontMatter.collectionType.trim()
+      : "";
+  }
+
+  get isCollectionPage() {
+    const type = this.collectionType;
+    return type === "tag" || type === "category" || type === "series";
+  }
+
+  get isPolicy() {
+    const category =
+      typeof this._frontMatter.category === "string"
+        ? this._frontMatter.category.trim()
+        : "";
+    return _fmt.boolean(category === "policy");
+  }
+
+  get isAboutPage() {
+    const type =
+      typeof this._frontMatter.type === "string"
+        ? this._frontMatter.type.trim()
+        : "";
+    return _fmt.boolean(type === "about");
+  }
+
+  get isContactPage() {
+    const type =
+      typeof this._frontMatter.type === "string"
+        ? this._frontMatter.type.trim()
+        : "";
+    return _fmt.boolean(type === "contact");
+  }
+
+  get date() {
+    return this._frontMatter.date instanceof Date ||
+      typeof this._frontMatter.date === "string" ||
+      typeof this._frontMatter.date === "number"
+      ? this._frontMatter.date
+      : "";
+  }
+
+  get updated() {
+    return this._frontMatter.updated instanceof Date ||
+      typeof this._frontMatter.updated === "string" ||
+      typeof this._frontMatter.updated === "number"
+      ? this._frontMatter.updated
+      : "";
+  }
+
+  get dateDisplay() {
+    const dateValue =
+      this._frontMatter.date instanceof Date
+        ? this._frontMatter.date
+        : typeof this._frontMatter.date === "string" ||
+            typeof this._frontMatter.date === "number"
+          ? this._frontMatter.date
+          : null;
+    const langValue =
+      typeof this._frontMatter.lang === "string"
+        ? this._frontMatter.lang
+        : undefined;
+    return dateValue ? _fmt.date(dateValue, langValue) : null;
+  }
+
+  get description() {
+    return typeof this._frontMatter.description === "string"
+      ? this._frontMatter.description
+      : "";
+  }
+
+  get cover() {
+    return typeof this._frontMatter.cover === "string" &&
+      this._frontMatter.cover.trim().length > 0
+      ? this._frontMatter.cover
+      : _cfg.seo.defaultImage;
+  }
+
+  get coverAlt() {
+    return typeof this._frontMatter.coverAlt === "string"
+      ? this._frontMatter.coverAlt
+      : "";
+  }
+
+  get coverCaption() {
+    return typeof this._frontMatter.coverCaption === "string"
+      ? this._frontMatter.coverCaption
+      : "";
+  }
+
+  get readingTime() {
+    const value =
+      typeof this._frontMatter.readingTime === "number" ||
+      typeof this._frontMatter.readingTime === "string"
+        ? this._frontMatter.readingTime
+        : 0;
+    return _fmt.readingTime(value);
+  }
+
+  get seriesTitle() {
+    if (!this._frontMatter.series) {
+      return "";
+    }
+
+    const rawTitle =
+      typeof this._frontMatter.seriesTitle === "string"
+        ? this._frontMatter.seriesTitle.trim()
+        : "";
+    if (rawTitle.length > 0) {
+      return rawTitle;
+    }
+
+    return typeof this._frontMatter.series === "string"
+      ? this._frontMatter.series
+      : "";
+  }
+
+  get menuLabel() {
+    const fallbackKey =
+      (typeof this._frontMatter.id === "string" &&
+        this._frontMatter.id.trim()) ||
+      (typeof this._frontMatter.slug === "string" &&
+        this._frontMatter.slug.trim()) ||
+      "";
+    return (
+      (typeof this._frontMatter.menu === "string" &&
+      this._frontMatter.menu.trim().length > 0
+        ? this._frontMatter.menu.trim()
+        : typeof this._frontMatter.title === "string" &&
+            this._frontMatter.title.trim().length > 0
+          ? this._frontMatter.title.trim()
+          : fallbackKey) ?? fallbackKey
+    );
+  }
+
+  get isHiddenOnMenu() {
+    return !_fmt.boolean(this._frontMatter.show);
+  }
+
+  get menuOrder() {
+    const value =
+      typeof this._frontMatter.order === "number" ||
+      typeof this._frontMatter.order === "string"
+        ? this._frontMatter.order
+        : 0;
+    return _fmt.order(value);
+  }
+
+  get layout() {
+    return typeof this._frontMatter.layout === "string"
+      ? this._frontMatter.layout.trim()
+      : "default";
+  }
+}

package/lib/contentSummary.js

@@ -0,0 +1,85 @@
+import { ContentFile } from "./contentFile.js";
+
+export class ContentSummary {
+  /**
+   * @param {ContentFile} file
+   */
+  constructor(file) {
+    this._file = file;
+  }
+
+  get id() {
+    return this._file.id;
+  }
+
+  get title() {
+    return this._file.title;
+  }
+
+  get date() {
+    return this._file.date;
+  }
+
+  get description() {
+    return this._file.description;
+  }
+
+  get cover() {
+    return this._file.cover;
+  }
+
+  get coverAlt() {
+    return this._file.coverAlt;
+  }
+
+  get coverCaption() {
+    return this._file.coverCaption;
+  }
+
+  get readingTime() {
+    return this._file.readingTime;
+  }
+
+  get dateDisplay() {
+    return this._file.dateDisplay;
+  }
+
+  get slug() {
+    return this._file.slug;
+  }
+
+  get lang() {
+    return this._file.lang;
+  }
+
+  get canonical() {
+    return this._file.canonical;
+  }
+
+  get updated() {
+    return this._file.updated;
+  }
+
+  get seriesTitle() {
+    return this._file.seriesTitle;
+  }
+
+  toObject() {
+    return {
+      id: this.id,
+      title: this.title,
+      slug: this.slug,
+      lang: this.lang,
+      canonical: this.canonical,
+      date: this.date,
+      updated: this.updated,
+      description: this.description,
+      cover: this.cover,
+      coverAlt: this.coverAlt,
+      coverCaption: this.coverCaption,
+      readingTime: this.readingTime,
+      dateDisplay: this.dateDisplay,
+      seriesTitle: this.seriesTitle,
+    };
+  }
+}

package/lib/menuItem.js

@@ -0,0 +1,51 @@
+import { ContentFile } from "./contentFile.js";
+
+export class MenuItem {
+  /**
+   * @param {ContentFile} file
+   */
+  constructor(file) {
+    this._file = file;
+  }
+
+  get key() {
+    return this._file.id;
+  }
+
+  get label() {
+    return this._file.menuLabel;
+  }
+
+  get url() {
+    return this._file.canonical;
+  }
+
+  get slug() {
+    return this._file.slug;
+  }
+
+  get order() {
+    return typeof this._file.menuOrder === "number" ? this._file.menuOrder : 0;
+  }
+
+  get lang() {
+    return this._file.lang;
+  }
+
+  get isEligable() {
+    return (
+      this._file.isValid &&
+      !this._file.isDraft &&
+      this._file.isPublished &&
+      !this._file.isHiddenOnMenu
+    );
+  }
+
+  toObject() {
+    return {
+      key: this.key,
+      label: this.label,
+      order: this.order,
+    };
+  }
+}

package/lib/page.js

@@ -0,0 +1,103 @@
+/**
+ * @typedef {{
+ *  kind?: string,
+ *  type?: string,
+ *  lang?: string,
+ *  slug?: string,
+ *  canonical?: string,
+ *  layout?: string,
+ *  template?: string,
+ *  front?: Record<string, unknown>,
+ *  view?: Record<string, unknown>,
+ *  html?: string,
+ *  sourcePath?: string,
+ *  outputPath?: string,
+ *  writeMeta?: Record<string, unknown>,
+ *  isDynamic?: boolean,
+ *  isCollection?: boolean,
+ *  isStatic?: boolean,
+ * }} PageInput
+ */
+
+export class Page {
+  /**
+   * @param {PageInput} input
+   */
+  constructor(input) {
+    this._input = input ?? {};
+  }
+
+  get kind() {
+    return typeof this._input.kind === "string" ? this._input.kind : "";
+  }
+
+  get type() {
+    return typeof this._input.type === "string" ? this._input.type : "";
+  }
+
+  get lang() {
+    return typeof this._input.lang === "string" ? this._input.lang : "";
+  }
+
+  get slug() {
+    return typeof this._input.slug === "string" ? this._input.slug : "";
+  }
+
+  get canonical() {
+    return typeof this._input.canonical === "string"
+      ? this._input.canonical
+      : "";
+  }
+
+  get layout() {
+    return typeof this._input.layout === "string" ? this._input.layout : "";
+  }
+
+  get template() {
+    return typeof this._input.template === "string" ? this._input.template : "";
+  }
+
+  get front() {
+    return this._input.front ?? {};
+  }
+
+  get view() {
+    return this._input.view ?? {};
+  }
+
+  get html() {
+    return typeof this._input.html === "string" ? this._input.html : "";
+  }
+
+  get sourcePath() {
+    return typeof this._input.sourcePath === "string"
+      ? this._input.sourcePath
+      : "";
+  }
+
+  get outputPath() {
+    return typeof this._input.outputPath === "string"
+      ? this._input.outputPath
+      : "";
+  }
+
+  get writeMeta() {
+    return this._input.writeMeta ?? {};
+  }
+
+  get isDynamic() {
+    return Boolean(this._input.isDynamic);
+  }
+
+  get isCollection() {
+    return Boolean(this._input.isCollection);
+  }
+
+  get isStatic() {
+    return Boolean(this._input.isStatic);
+  }
+
+  toObject() {
+    return { ...this._input };
+  }
+}