@jant/core 0.3.24 → 0.3.26

package/src/types/entities.ts

@@ -0,0 +1,109 @@
+/**
+ * Entity Types (database-level models)
+ */
+
+import type { Format, Status, SortOrder, NavItemType } from "./constants.js";
+
+export interface Post {
+  id: number;
+  format: Format;
+  status: Status;
+  featured: number; // 0 | 1
+  pinned: number; // 0 | 1
+  path: string | null;
+  title: string | null;
+  url: string | null;
+  body: string | null;
+  bodyHtml: string | null;
+  quoteText: string | null;
+  rating: number | null;
+  collectionId: number | null;
+  replyToId: number | null;
+  threadId: number | null;
+  deletedAt: number | null;
+  publishedAt: number;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface Page {
+  id: number;
+  slug: string;
+  title: string | null;
+  body: string | null;
+  bodyHtml: string | null;
+  status: Status;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface Media {
+  id: string; // UUIDv7
+  postId: number | null;
+  filename: string;
+  originalName: string;
+  mimeType: string;
+  size: number;
+  storageKey: string;
+  provider: string;
+  width: number | null;
+  height: number | null;
+  alt: string | null;
+  position: number;
+  blurhash: string | null;
+  createdAt: number;
+}
+
+export interface MediaAttachment {
+  id: string;
+  url: string;
+  previewUrl: string;
+  alt: string | null;
+  blurhash: string | null;
+  width: number | null;
+  height: number | null;
+  position: number;
+  mimeType: string;
+}
+
+export interface PostWithMedia extends Post {
+  mediaAttachments: MediaAttachment[];
+}
+
+export interface Collection {
+  id: number;
+  slug: string;
+  title: string;
+  description: string | null;
+  icon: string | null;
+  sortOrder: SortOrder;
+  position: number;
+  showDivider: number; // 0 | 1
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface NavItem {
+  id: number;
+  type: NavItemType;
+  label: string;
+  url: string;
+  pageId: number | null;
+  position: number;
+  createdAt: number;
+  updatedAt: number;
+}
+
+export interface Redirect {
+  id: number;
+  fromPath: string;
+  toPath: string;
+  type: 301 | 302;
+  createdAt: number;
+}
+
+export interface Setting {
+  key: string;
+  value: string;
+  updatedAt: number;
+}

package/src/types/operations.ts

@@ -0,0 +1,88 @@
+/**
+ * Operation Types (create/update DTOs)
+ */
+
+import type { Format, Status, SortOrder, NavItemType } from "./constants.js";
+
+export interface CreatePost {
+  format: Format;
+  status?: Status;
+  featured?: boolean;
+  pinned?: boolean;
+  path?: string;
+  title?: string;
+  url?: string;
+  body?: string;
+  quoteText?: string;
+  rating?: number;
+  collectionId?: number;
+  replyToId?: number;
+  publishedAt?: number;
+  mediaIds?: string[];
+}
+
+export interface UpdatePost {
+  format?: Format;
+  status?: Status;
+  featured?: boolean;
+  pinned?: boolean;
+  path?: string | null;
+  title?: string | null;
+  url?: string | null;
+  body?: string | null;
+  quoteText?: string | null;
+  rating?: number | null;
+  collectionId?: number | null;
+  publishedAt?: number;
+  mediaIds?: string[];
+}
+
+export interface CreatePage {
+  slug: string;
+  title?: string;
+  body?: string;
+  status?: Status;
+}
+
+export interface UpdatePage {
+  slug?: string;
+  title?: string | null;
+  body?: string | null;
+  status?: Status;
+}
+
+export interface CreateNavItem {
+  type: NavItemType;
+  label: string;
+  url: string;
+  pageId?: number;
+  position?: number;
+}
+
+export interface UpdateNavItem {
+  type?: NavItemType;
+  label?: string;
+  url?: string;
+  pageId?: number | null;
+  position?: number;
+}
+
+export interface CreateCollection {
+  slug: string;
+  title: string;
+  description?: string;
+  icon?: string;
+  sortOrder?: SortOrder;
+  position?: number;
+  showDivider?: boolean;
+}
+
+export interface UpdateCollection {
+  slug?: string;
+  title?: string;
+  description?: string | null;
+  icon?: string | null;
+  sortOrder?: SortOrder;
+  position?: number;
+  showDivider?: boolean;
+}

package/src/types/props.ts

@@ -0,0 +1,115 @@
+/**
+ * Page-Level Props & Feed Data Types
+ */
+
+import type { Format } from "./constants.js";
+import type { Collection } from "./entities.js";
+import type {
+  PostView,
+  PageView,
+  TimelineItemView,
+  SearchResultView,
+  ArchiveGroup,
+} from "./views.js";
+
+// =============================================================================
+// Page-Level Props
+// =============================================================================
+
+/** Props for the home page component */
+export interface HomePageProps {
+  items: TimelineItemView[];
+  pinnedItems: PostView[];
+  currentPage: number;
+  totalPages: number;
+}
+
+/** Props for the single post page component */
+export interface PostPageProps {
+  post: PostView;
+}
+
+/** Props for the custom page component */
+export interface SinglePageProps {
+  page: PageView;
+}
+
+/** Props for the featured page component */
+export interface FeaturedPageProps {
+  items: TimelineItemView[];
+}
+
+/** Props for the archive page component */
+export interface ArchivePageProps {
+  groups: ArchiveGroup[];
+  hasMore: boolean;
+  nextCursor?: number;
+  format?: Format;
+  featured?: boolean;
+}
+
+/** Props for the search page component */
+export interface SearchPageProps {
+  query: string;
+  results: SearchResultView[];
+  error?: string;
+  hasMore: boolean;
+  page: number;
+}
+
+/** Props for the single collection page component */
+export interface CollectionPageProps {
+  collection: Collection;
+  posts: PostView[];
+  hasMore: boolean;
+  nextCursor?: number;
+}
+
+/** Props for the collections list page component */
+export interface CollectionsPageProps {
+  collections: (Collection & { postCount: number })[];
+}
+
+// =============================================================================
+// Feed Data Types
+// =============================================================================
+
+/** Data passed to RSS/Atom feed renderers */
+export interface FeedData {
+  siteName: string;
+  siteDescription: string;
+  siteUrl: string;
+  siteLanguage: string;
+  posts: PostView[];
+}
+
+/** Data passed to sitemap renderers */
+export interface SitemapData {
+  siteUrl: string;
+  posts: PostView[];
+  pages: PageView[];
+}
+
+// =============================================================================
+// Timeline Types
+// =============================================================================
+
+/** Props for per-type timeline cards */
+export interface TimelineCardProps {
+  post: PostView;
+  compact?: boolean;
+}
+
+/** Props for thread inline preview */
+export interface ThreadPreviewProps {
+  rootPost: PostView;
+  previewReplies: PostView[];
+  totalReplyCount: number;
+}
+
+/** Props for the timeline feed wrapper */
+export interface TimelineFeedProps {
+  items: TimelineItemView[];
+  currentPage?: number;
+  totalPages?: number;
+}

package/src/types/views.ts

@@ -0,0 +1,172 @@
+/**
+ * View Model Types (render-ready, for theme components)
+ */
+
+import type { Format, Status, NavItemType } from "./constants.js";
+import type { Post, Collection } from "./entities.js";
+
+/**
+ * Render-ready post data for theme components.
+ * All fields are pre-computed -- no lib/ imports needed.
+ */
+export interface PostView {
+  // Identity
+  id: number;
+  /** Pre-computed permalink: "/{path}" if path set, otherwise "/p/{sqid}" */
+  permalink: string;
+  /** Custom URL path, if set. Supports multi-level paths (e.g. "2024/my-post") */
+  path?: string;
+
+  // Content
+  title?: string;
+  /** Pre-sanitized HTML */
+  bodyHtml?: string;
+  /** Pre-computed excerpt, max 160 chars */
+  excerpt?: string;
+  /** HTML excerpt for article previews (paragraph-aware, ~500 chars) */
+  summaryHtml?: string;
+  /** Whether summaryHtml was truncated (content continues beyond excerpt) */
+  summaryHasMore?: boolean;
+  /** URL for link/quote formats */
+  url?: string;
+  /** Quoted text for quote format */
+  quoteText?: string;
+
+  // Metadata
+  format: Format;
+  status: Status;
+  featured: boolean;
+  pinned: boolean;
+  rating?: number;
+
+  // Collection
+  collectionId?: number;
+
+  // Time -- pre-formatted
+  /** ISO 8601 string */
+  publishedAt: string;
+  /** Human-readable, e.g. "Feb 1, 2024" */
+  publishedAtFormatted: string;
+  /** 24-hour time, e.g. "23:05" */
+  publishedAtTime: string;
+  /** Short relative time, e.g. "5m", "3h", "2d", "Feb 1" */
+  publishedAtRelative: string;
+  /** ISO 8601 string */
+  updatedAt: string;
+
+  // Media -- URLs pre-computed
+  media: MediaView[];
+
+  // Thread context
+  replyToId?: number;
+  threadRootId?: number;
+
+  // Raw content (for forms/editing, not typical theme use)
+  body?: string;
+}
+
+/**
+ * Render-ready page data for theme components.
+ */
+export interface PageView {
+  id: number;
+  slug: string;
+  title?: string;
+  bodyHtml?: string;
+  status: Status;
+  createdAt: string;
+  updatedAt: string;
+}
+
+/**
+ * Render-ready media data for theme components.
+ * URLs are pre-computed -- no lib/ imports needed.
+ */
+export interface MediaView {
+  id: string;
+  /** Full-size URL, pre-computed */
+  url: string;
+  /** Thumbnail URL, pre-computed */
+  thumbnailUrl: string;
+  mimeType: string;
+  altText?: string;
+  width?: number;
+  height?: number;
+  size?: number;
+}
+
+/**
+ * Render-ready navigation item for theme components.
+ * Active/external state pre-computed.
+ */
+export interface NavItemView {
+  id: number;
+  type: NavItemType;
+  label: string;
+  url: string;
+  pageId?: number;
+  /** Pre-computed based on currentPath */
+  isActive: boolean;
+  /** Pre-computed: starts with http(s):// */
+  isExternal: boolean;
+}
+
+/**
+ * Search result from FTS5
+ */
+export interface SearchResult {
+  post: Post;
+  /** FTS5 rank score (lower is better) */
+  rank: number;
+  /** Highlighted snippet from content */
+  snippet?: string;
+}
+
+/**
+ * Render-ready search result for theme components.
+ */
+export interface SearchResultView {
+  post: PostView;
+  rank: number;
+  snippet?: string;
+}
+
+/**
+ * Render-ready timeline item for theme components.
+ */
+export interface TimelineItemView {
+  post: PostView;
+  threadPreview?: {
+    replies: PostView[];
+    totalReplyCount: number;
+  };
+}
+
+/**
+ * Typed archive group with pre-formatted label.
+ */
+export interface ArchiveGroup {
+  /** e.g. "2024" */
+  year: string;
+  /** e.g. "02" */
+  month: string;
+  /** Pre-formatted, e.g. "February 2024" */
+  label: string;
+  posts: PostView[];
+}
+
+/**
+ * Site Layout Props
+ */
+export interface SiteLayoutProps {
+  siteName: string;
+  siteDescription?: string;
+  links: NavItemView[];
+  currentPath: string;
+  isAuthenticated?: boolean;
+  collections?: Collection[];
+  homeDefaultView?: string;
+  siteAvatarUrl?: string;
+  showHeaderAvatar?: boolean;
+  siteFooterHtml?: string;
+}