@rimelight/cms 0.0.3 → 0.0.5

package/dist/bylines-Csggkl-g.d.mts

@@ -0,0 +1,405 @@
+//#region src/core/types/inline.d.ts
+type InlineNodeType = "text" | "page_mention" | "user_mention" | "link" | "emoji";
+interface TextInlineNode {
+  type: "text";
+  text: string;
+  marks?: Array<"bold" | "italic" | "underline" | "strikethrough" | "code">;
+}
+interface PageMentionNode {
+  type: "page_mention";
+  pageId: string;
+  pageSlug: string;
+  displayTitle?: string;
+}
+interface LinkInlineNode {
+  type: "link";
+  url: string;
+  children: TextInlineNode[];
+  openInNewTab?: boolean;
+}
+type InlineNode = TextInlineNode | PageMentionNode | LinkInlineNode;
+//#endregion
+//#region src/core/types/media.d.ts
+interface MediaValue {
+  id: string;
+  src: string;
+  alt: string;
+  width?: number;
+  height?: number;
+  format?: string;
+  size?: number;
+  blurhash?: string;
+  previewUrl?: string;
+  provider: "r2" | "external" | "local";
+  meta?: Record<string, unknown>;
+}
+//#endregion
+//#region src/core/types/blocks.d.ts
+type BlockType = "SectionBlock" | "ParagraphBlock" | "CalloutBlock" | "ImageBlock" | "ScriptBlock" | "SceneBlock" | "DialogueBlock" | "CodeBlock" | "TableBlock" | "TabsBlock" | "TabItemBlock" | "StepsBlock" | "StepItemBlock" | "CardsBlock" | "CardBlock" | "FileTreeBlock" | "ComponentShowcaseBlock" | "ApiDocumentationBlock" | "LivePreviewBlock" | (string & {});
+type TimeOfDay = "MORNING" | "NOON" | "AFTERNOON" | "EVENING" | "NIGHT" | "OTHER";
+type Setting = "INTERIOR" | "EXTERIOR" | "OTHER";
+type Transition = "CUT_TO" | "CUT_BACK_TO" | "FADE_TO" | "NONE";
+interface ScriptBlockProps {
+  title: string;
+  synopsis: string;
+  characters: string[];
+  aPlot: string;
+  bPlot: string;
+  cPlot: string;
+  stinger: string;
+}
+interface SceneBlockProps {
+  location: string;
+  timeOfDay: TimeOfDay;
+  setting: Setting;
+  transition: Transition;
+  description: string;
+}
+interface DialogueBlockProps {
+  character: string;
+  parenthetical?: string;
+  line: string;
+}
+interface BaseBlock {
+  /**
+   * Unique UUID v4 identifier
+   */
+  id: string;
+  type: BlockType;
+  /**
+   * Structural Template Lock: If true, this block is a permanent template anchor and can NEVER be
+   * deleted, reordered, or removed.
+   */
+  isTemplated?: boolean;
+  /**
+   * Property Content Lock: Controls whether block prop content can be edited. - boolean true: ALL
+   * properties of this block are locked from editing. - string[]: Specific property keys locked
+   * from editing (e.g. ["title", "disclaimer"]).
+   */
+  templatedProps?: boolean | string[];
+  allowedRoles?: string[];
+  requiredPermission?: string;
+  props: Record<string, any>;
+  children?: BaseBlock[];
+}
+type HeadingLevel = 2 | 3 | 4 | 5 | 6;
+declare const MIN_SECTION_HEADING_LEVEL: HeadingLevel;
+declare const MAX_SECTION_HEADING_LEVEL: HeadingLevel;
+declare const MAX_SECTION_DEPTH = 4;
+declare function calculateHeadingLevel(sectionDepth: number): HeadingLevel;
+type CalloutVariant = "info" | "success" | "warning" | "error" | "commentary" | "ideation" | "source";
+interface SectionBlockProps {
+  title: string;
+  description?: string;
+  level?: HeadingLevel;
+  mainArticleSlug?: string;
+  children: BaseBlock[];
+}
+interface ParagraphBlockProps {
+  /**
+   * Stored as an InlineNode array (structured AST). Fallback: { en: string } or plain string.
+   */
+  text: InlineNode[] | {
+    en: string;
+  } | string;
+}
+interface CalloutBlockProps {
+  variant: CalloutVariant;
+  to?: string;
+  target?: string;
+  children: BaseBlock[];
+}
+interface ImageBlockProps {
+  src: string | MediaValue;
+  alt: string;
+  caption?: string;
+  width?: number;
+  height?: number;
+  aspectRatio?: string;
+}
+interface CodeBlockProps {
+  code: string;
+  language: string;
+  caption?: string;
+  title?: string;
+  filename?: string;
+  showLineNumbers?: boolean;
+  highlightLines?: number[];
+}
+interface TableColumnDef {
+  key: string;
+  header: string;
+  align?: "left" | "center" | "right";
+}
+interface TableBlockProps {
+  columns: TableColumnDef[];
+  rows: Record<string, string>[];
+  caption?: string;
+}
+interface TabItemBlockProps {
+  label: string;
+  value?: string;
+  icon?: string;
+  children: BaseBlock[];
+}
+interface TabsBlockProps {
+  defaultValue?: string;
+  children: BaseBlock[];
+}
+interface StepItemBlockProps {
+  title: string;
+  description?: string;
+  children: BaseBlock[];
+}
+interface StepsBlockProps {
+  children: BaseBlock[];
+}
+interface CardBlockProps {
+  title: string;
+  description?: string;
+  icon?: string;
+  href?: string;
+  badge?: string;
+}
+interface CardsBlockProps {
+  columns?: 1 | 2 | 3 | 4;
+  children: BaseBlock[];
+}
+interface FileTreeNode {
+  name: string;
+  isDir?: boolean;
+  children?: FileTreeNode[];
+  comment?: string;
+}
+interface FileTreeBlockProps {
+  tree: FileTreeNode[];
+}
+interface ComponentShowcaseBlockProps {
+  componentName: string;
+  componentPath: string;
+  framework: "astro" | "vue" | "solid";
+  defaultProps: Record<string, any>;
+  propsConfig: Record<string, string[]>;
+  togglingPattern: "icon" | "select-option" | "tab-segmented" | "pill-toggle";
+  codeExamples: {
+    astro?: string;
+    vue?: string;
+    solid?: string;
+  };
+  playgroundUrl: string | undefined;
+}
+interface ApiDocumentationBlockProps {
+  componentName: string;
+  sections: {
+    props?: boolean;
+    slots?: boolean;
+    emits?: boolean;
+    theme?: boolean;
+    changelog?: boolean;
+  };
+  hide?: string[];
+  show?: string[];
+}
+interface LivePreviewBlockProps {
+  componentCode: string;
+  framework: "astro" | "vue" | "solid";
+  height?: string;
+  width?: string;
+  editable?: boolean;
+}
+interface TypedScriptBlockProps extends ScriptBlockProps {
+  children: BaseBlock[];
+}
+interface TypedSceneBlockProps extends SceneBlockProps {
+  children: BaseBlock[];
+}
+interface SectionBlock extends BaseBlock {
+  type: "SectionBlock";
+  props: SectionBlockProps;
+}
+interface ParagraphBlock extends BaseBlock {
+  type: "ParagraphBlock";
+  props: ParagraphBlockProps;
+}
+interface CalloutBlock extends BaseBlock {
+  type: "CalloutBlock";
+  props: CalloutBlockProps;
+}
+interface ImageBlock extends BaseBlock {
+  type: "ImageBlock";
+  props: ImageBlockProps;
+}
+interface ScriptBlock extends BaseBlock {
+  type: "ScriptBlock";
+  props: TypedScriptBlockProps;
+}
+interface SceneBlock extends BaseBlock {
+  type: "SceneBlock";
+  props: TypedSceneBlockProps;
+}
+interface DialogueBlock extends BaseBlock {
+  type: "DialogueBlock";
+  props: DialogueBlockProps;
+}
+interface CodeBlock extends BaseBlock {
+  type: "CodeBlock";
+  props: CodeBlockProps;
+}
+interface TableBlock extends BaseBlock {
+  type: "TableBlock";
+  props: TableBlockProps;
+}
+interface TabsBlock extends BaseBlock {
+  type: "TabsBlock";
+  props: TabsBlockProps;
+}
+interface TabItemBlock extends BaseBlock {
+  type: "TabItemBlock";
+  props: TabItemBlockProps;
+}
+interface StepsBlock extends BaseBlock {
+  type: "StepsBlock";
+  props: StepsBlockProps;
+}
+interface StepItemBlock extends BaseBlock {
+  type: "StepItemBlock";
+  props: StepItemBlockProps;
+}
+interface CardsBlock extends BaseBlock {
+  type: "CardsBlock";
+  props: CardsBlockProps;
+}
+interface CardBlock extends BaseBlock {
+  type: "CardBlock";
+  props: CardBlockProps;
+}
+interface FileTreeBlock extends BaseBlock {
+  type: "FileTreeBlock";
+  props: FileTreeBlockProps;
+}
+interface ComponentShowcaseBlock extends BaseBlock {
+  type: "ComponentShowcaseBlock";
+  props: ComponentShowcaseBlockProps;
+}
+interface ApiDocumentationBlock extends BaseBlock {
+  type: "ApiDocumentationBlock";
+  props: ApiDocumentationBlockProps;
+}
+interface LivePreviewBlock extends BaseBlock {
+  type: "LivePreviewBlock";
+  props: LivePreviewBlockProps;
+}
+type TypedBlock = SectionBlock | ParagraphBlock | CalloutBlock | ImageBlock | ScriptBlock | SceneBlock | DialogueBlock | CodeBlock | TableBlock | TabsBlock | TabItemBlock | StepsBlock | StepItemBlock | CardsBlock | CardBlock | FileTreeBlock | ComponentShowcaseBlock | ApiDocumentationBlock | LivePreviewBlock;
+declare const ALLOWED_CHILDREN_MAP: Record<string, BlockType[]>;
+//#endregion
+//#region src/core/types/pages.d.ts
+type Localized<T = string> = Record<string, T>;
+type PageType = "wiki" | "article" | "doc" | "announcement" | "landing" | (string & {});
+interface RegisterPageTypes {
+  wiki: Record<string, any>;
+  article: Record<string, any>;
+  doc: Record<string, any>;
+  announcement: Record<string, any>;
+  landing: Record<string, any>;
+  [key: string]: Record<string, any>;
+}
+interface PageMetadata {
+  id: string;
+  slug: string;
+  type: PageType;
+  templateId?: string | null;
+  templateVersion?: number;
+  title: Localized;
+  description?: Localized;
+  tags?: Localized[];
+  authorIds?: string[];
+  publishedVersionId?: string | null;
+  postedAt?: Date | null;
+  createdAt?: Date;
+  updatedAt?: Date;
+  deletedAt?: Date | null;
+}
+interface PageContent<P = Record<string, any>> {
+  blocks: BaseBlock[];
+  properties: P;
+}
+//#endregion
+//#region src/core/types/templates.d.ts
+interface TemplateApprovalRules {
+  minApprovals?: number;
+  allowSelfApproval?: boolean;
+  requiredRolesForApproval?: string[];
+}
+interface TemplateRolePermissions {
+  whoCanCreate?: string[];
+  whoCanEdit?: string[];
+  whoCanReview?: string[];
+  whoCanView?: string[];
+}
+interface PageTemplate {
+  id: string;
+  slug: string;
+  title: Localized;
+  description?: Localized;
+  pageType: PageType;
+  version: number;
+  allowedRoles: string[];
+  rolePermissions?: TemplateRolePermissions;
+  requiredPermission?: string | null;
+  approvalRules: TemplateApprovalRules;
+  defaultProperties: Record<string, any>;
+  initialBlocks: BaseBlock[];
+  createdAt?: Date;
+  updatedAt?: Date;
+}
+//#endregion
+//#region src/core/types/versioning.d.ts
+type PageVersionStatus = "pending" | "approved" | "rejected" | "published";
+interface PageVersion {
+  id: string;
+  pageId: string;
+  versionNumber: number;
+  status: PageVersionStatus;
+  slug: string;
+  type: PageType;
+  title: Localized;
+  description?: Localized;
+  tags?: Localized[];
+  authorIds?: string[];
+  content: {
+    blocks: BaseBlock[];
+    properties: Record<string, any>;
+  };
+  createdBy: string;
+  approvedBy: string[];
+  approvedAt?: Date | null;
+  changeSummary?: string | null;
+  createdAt?: Date;
+}
+interface PageVersionComment {
+  id: string;
+  versionId: string;
+  userId: string;
+  userRole: string;
+  content: string;
+  blockId?: string | null;
+  createdAt?: Date;
+}
+interface PageVersionApproval {
+  id: string;
+  versionId: string;
+  userId: string;
+  userRole: string;
+  approvedAt?: Date;
+}
+//#endregion
+//#region src/core/types/bylines.d.ts
+type BylineRole = "written_by" | "reviewed_by" | "edited_by" | "illustrated_by" | "translated_by" | "curated_by";
+interface BylineCredit {
+  userId: string;
+  role: BylineRole;
+  customTitle?: string;
+  displayOrder?: number;
+}
+//#endregion
+export { StepItemBlock as $, ComponentShowcaseBlockProps as A, LivePreviewBlockProps as B, CardBlock as C, CodeBlock as D, CardsBlockProps as E, FileTreeNode as F, ParagraphBlockProps as G, MAX_SECTION_HEADING_LEVEL as H, HeadingLevel as I, ScriptBlock as J, SceneBlock as K, ImageBlock as L, DialogueBlockProps as M, FileTreeBlock as N, CodeBlockProps as O, FileTreeBlockProps as P, Setting as Q, ImageBlockProps as R, CalloutVariant as S, CardsBlock as T, MIN_SECTION_HEADING_LEVEL as U, MAX_SECTION_DEPTH as V, ParagraphBlock as W, SectionBlock as X, ScriptBlockProps as Y, SectionBlockProps as Z, ApiDocumentationBlockProps as _, InlineNode as _t, PageVersionComment as a, TableBlock as at, CalloutBlock as b, PageMentionNode as bt, TemplateApprovalRules as c, TabsBlock as ct, PageContent as d, Transition as dt, StepItemBlockProps as et, PageMetadata as f, TypedBlock as ft, ApiDocumentationBlock as g, MediaValue as gt, ALLOWED_CHILDREN_MAP as h, calculateHeadingLevel as ht, PageVersionApproval as i, TabItemBlockProps as it, DialogueBlock as j, ComponentShowcaseBlock as k, TemplateRolePermissions as l, TabsBlockProps as lt, RegisterPageTypes as m, TypedScriptBlockProps as mt, BylineRole as n, StepsBlockProps as nt, PageVersionStatus as o, TableBlockProps as ot, PageType as p, TypedSceneBlockProps as pt, SceneBlockProps as q, PageVersion as r, TabItemBlock as rt, PageTemplate as s, TableColumnDef as st, BylineCredit as t, StepsBlock as tt, Localized as u, TimeOfDay as ut, BaseBlock as v, InlineNodeType as vt, CardBlockProps as w, CalloutBlockProps as x, TextInlineNode as xt, BlockType as y, LinkInlineNode as yt, LivePreviewBlock as z };