@sigma-studio/viewer 0.188.0

package/dist/types.d.ts

@@ -0,0 +1,461 @@
+import type { OverlaySnapshot } from "./overlay-types";
+export type SigmaDocVersion = "2.0";
+export type OutputProfileName = "student" | "teacher" | "answerBook";
+export type PageSizePreset = "A4" | "A3" | "B5" | "B4" | "custom";
+export type PageOrientation = "portrait" | "landscape";
+export interface SigmaDocument {
+    version: SigmaDocVersion;
+    docId: string;
+    metadata: SigmaMetadata;
+    content: SigmaBlock[];
+    outputProfiles: Record<OutputProfileName, OutputProfile>;
+    comments?: SigmaCommentThread[];
+    pageLayout?: PageLayout;
+    updatedAt?: string;
+}
+export interface PageLayout {
+    preset: PageSizePreset;
+    orientation: PageOrientation;
+    pageSize: {
+        widthMm: number;
+        heightMm: number;
+    };
+    marginsMm: {
+        top: number;
+        right: number;
+        bottom: number;
+        left: number;
+    };
+    flow: {
+        type: "columns";
+        columnCount: number;
+        columnGapMm: number;
+    };
+    header?: PageRunningRegion;
+    footer?: PageRunningRegion;
+    /** Single continuous overlay for the whole document (figures resolve their page from block anchors). */
+    overlay?: PageOverlay;
+}
+export interface PageRunningRegion {
+    enabled: boolean;
+    heightMm: number;
+    offsetMm: number;
+    showOnFirstPage: boolean;
+    /** Free-form header/footer body. This is the canonical repeated text content. */
+    blocks: RichBlock[];
+    /** Repeated overlay for figures, images, graphs, and free-positioned text inside this region. */
+    overlay?: PageOverlay;
+}
+export interface PageOverlay {
+    overlaySnapshot?: OverlaySnapshot;
+    previewSvg?: string;
+    updatedAt?: string;
+}
+export interface SigmaMetadata {
+    title: string;
+    source?: SigmaDocumentSourceMetadata;
+    styleUnits?: SigmaDocumentStyleUnits;
+    mathFractionSizing?: MathFractionSizing;
+}
+export type MathFractionSizing = "uniform" | "texDefault";
+export interface SigmaDocumentSourceMetadata {
+    format?: "studyaid-prt";
+    layoutMode?: "fixedOverlay";
+    printFlowContent?: boolean;
+}
+export interface SigmaDocumentStyleUnits {
+    fontSize?: "pt";
+}
+export interface OutputProfile {
+    showSolutions?: boolean;
+    showHints?: boolean;
+    includeAnswers?: boolean;
+    onlySolutions?: boolean;
+    includeComments?: boolean;
+}
+export interface SigmaCommentThread {
+    id: string;
+    anchor: SigmaCommentAnchor;
+    messages: SigmaCommentMessage[];
+    /** Thread-level reactions are displayed on the first message. */
+    reactions?: SigmaCommentReaction[];
+    resolved?: boolean;
+    color?: string;
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface SigmaCommentMessage {
+    id: string;
+    authorName?: string;
+    body: InlineNode[];
+    reactions?: SigmaCommentReaction[];
+    createdAt: string;
+    updatedAt?: string;
+}
+export interface SigmaCommentReaction {
+    id: string;
+    emoji: string;
+    authorName?: string;
+    createdAt: string;
+}
+export type SigmaCommentAnchor = SigmaTextRangeCommentAnchor | SigmaInlineMathCommentAnchor | SigmaBlockCommentAnchor | SigmaOverlayShapeCommentAnchor | SigmaOverlayMathCommentAnchor;
+export interface SigmaTextRangeCommentAnchor {
+    type: "textRange";
+    start: SigmaCommentTextPosition;
+    end: SigmaCommentTextPosition;
+    quote: string;
+    mathInlineIds?: string[];
+    mathTex?: string[];
+}
+export interface SigmaCommentTextPosition {
+    blockId: string;
+    offset: number;
+}
+export interface SigmaInlineMathCommentAnchor {
+    type: "inlineMath";
+    blockId: string;
+    mathInlineId: string;
+    quote?: string;
+    tex?: string;
+}
+export interface SigmaBlockCommentAnchor {
+    type: "block";
+    blockId: string;
+    quote?: string;
+}
+export interface SigmaOverlayShapeCommentAnchor {
+    type: "overlayShape";
+    shapeIds: string[];
+    quote?: string;
+}
+export interface SigmaOverlayMathCommentAnchor {
+    type: "overlayMath";
+    shapeId?: string;
+    mathInlineId?: string;
+    quote?: string;
+    tex?: string;
+}
+export type SigmaBlock = SectionNode | HeadingNode | ParagraphNode | ListNode | ProblemNode | LayoutSectionNode | BoxBlockNode;
+export type RichBlock = HeadingNode | ParagraphNode | ListNode;
+export type ProblemAreaBlock = RichBlock | LayoutSectionNode;
+export type LayoutSectionChildBlock = SectionNode | HeadingNode | ParagraphNode | ListNode | BoxBlockNode;
+export type BoxBlockChildBlock = LayoutSectionChildBlock | LayoutSectionNode;
+export interface BaseNode {
+    type: string;
+    id: string;
+    pageBreak?: PageBreakHints;
+}
+export interface PageBreakHints {
+    avoidInside?: boolean;
+    keepWithNext?: boolean;
+    breakBefore?: "auto" | "always";
+    breakAfter?: "auto" | "always";
+}
+export interface SectionNode extends BaseNode {
+    type: "section";
+    title: string;
+    align?: TextAlign;
+    lineHeight?: LineHeight;
+}
+export interface HeadingNode extends BaseNode {
+    type: "heading";
+    level: 1 | 2 | 3;
+    children: InlineNode[];
+    align?: TextAlign;
+    lineHeight?: LineHeight;
+}
+export interface ParagraphNode extends BaseNode {
+    type: "paragraph";
+    children: InlineNode[];
+    align?: TextAlign;
+    lineHeight?: LineHeight;
+}
+export interface ListNode extends BaseNode {
+    type: "list";
+    listType: "bullet" | "ordered";
+    start?: number;
+    items: ListItemNode[];
+}
+export interface ListItemNode {
+    type: "listItem";
+    id: string;
+    children: InlineNode[];
+    nested?: ListNode[];
+}
+export type TextAlign = "left" | "center" | "right" | "justify";
+/** Unitless CSS line-height multiplier, normalized by `normalizeLineHeight`. */
+export type LineHeight = string;
+export interface ProblemNode extends BaseNode {
+    type: "problem";
+    tags: string[];
+    lead: ProblemAreaBlock[];
+    prompt: ProblemAreaBlock[];
+    answer?: AnswerDefinition;
+    solution: ProblemAreaBlock[];
+    hints: ProblemAreaBlock[];
+    areaLayout?: Partial<Record<ProblemAreaKind, ProblemAreaLayout>>;
+    numbering?: ProblemNumbering;
+    frame?: ProblemFrame;
+}
+export type ProblemAreaKind = "lead" | "prompt" | "solution" | "hints";
+export type ProblemAreaColumnSpan = "column" | "full";
+export interface ProblemAreaLayout {
+    minHeightMm?: number;
+    columnSpan?: ProblemAreaColumnSpan;
+}
+export interface ProblemNumbering {
+    enabled?: boolean;
+    fontSize?: number;
+    value?: number;
+}
+export interface ProblemFrame {
+    enabled?: boolean;
+    styleId?: string;
+}
+export interface LayoutSectionNode extends BaseNode {
+    type: "layoutSection";
+    layout: LayoutSectionLayout;
+    children: LayoutSectionChildBlock[];
+}
+export interface LayoutSectionLayout {
+    columnCount: number;
+    columnGapMm?: number;
+}
+export interface BoxBlockNode extends BaseNode {
+    type: "boxBlock";
+    /** Built-in or user-defined style identifier such as `fancybox` or `doublebox`. */
+    styleId: string;
+    title?: InlineNode[];
+    blocks: BoxBlockChildBlock[];
+    frame?: BoxFrameSpec;
+}
+export interface BoxFrameSpec {
+    borderWidthPx?: number;
+    borderColor?: string;
+    borderStyle?: "solid" | "dashed" | "dotted" | "double" | "none";
+    backgroundColor?: string;
+    titleBackgroundColor?: string;
+    titleColor?: string;
+    titleAlign?: TextAlign;
+    titleFontWeight?: "normal" | "bold";
+    titleFontFamily?: string;
+    titleFontSizePx?: number;
+    titleLineHeight?: string;
+    bodyColor?: string;
+    bodyAlign?: TextAlign;
+    bodyFontFamily?: string;
+    bodyFontSizePx?: number;
+    bodyLineHeight?: string;
+    cornerStyle?: "sharp" | "round";
+    radiusPx?: number;
+    paddingPx?: BoxSpacingPx;
+    decorations?: BoxDecorationSpec[];
+}
+export interface BoxSpacingPx {
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+}
+export type BoxDecorationSpec = {
+    type: "cornerSquares";
+    sizePx: number;
+    color: string;
+} | {
+    type: "doubleRule";
+    offsetPx: number;
+    widthPx?: number;
+    color?: string;
+} | {
+    type: "titleDoubleRule";
+    ruleWidthPx?: number;
+    ruleColor?: string;
+    guideColor?: string;
+} | {
+    type: "titleBand";
+    heightPx?: number;
+    backgroundColor?: string;
+} | {
+    type: "titlePlate";
+    borderColor?: string;
+    radiusPx?: number;
+    paddingPx?: BoxSpacingPx;
+} | {
+    type: "leftBar";
+    widthPx: number;
+    color: string;
+} | {
+    type: "shadow";
+    offsetXPx: number;
+    offsetYPx: number;
+    blurPx?: number;
+    spreadPx?: number;
+    color: string;
+} | {
+    type: "horizontalRules";
+    widthPx?: number;
+    color?: string;
+} | {
+    type: "notebookRules";
+    baseBodyWidthPx?: number;
+    frameLeftPx?: number;
+    frameHeightPx?: number;
+    frameStrokeOpacity?: number;
+    lineColor?: string;
+    lineGapPx?: number;
+    lineWidthPx?: number;
+    lineOffsetPx?: number;
+    bindingColor?: string;
+    bindingWidthPx?: number;
+    bindingXPx?: number;
+    bindingStrokeOpacity?: number;
+    ringColor?: string;
+    ringWidthPx?: number;
+    ringHeightPx?: number;
+    ringStrokePx?: number;
+    ringGapPx?: number;
+    ringTopPx?: number;
+    ringCount?: number;
+    ringLeftOverhangPx?: number;
+    minHeightPx?: number;
+};
+export type Graph2DKind = "cartesian" | "numberLine";
+export type GraphTickMode = "number" | "pi";
+export type GraphCurveMode = "yOfX" | "xOfY" | "parametric" | "implicit";
+export type GraphCurveDash = "solid" | "dashed" | "dotted";
+export type GraphRenderStyle = "default" | "studyaid";
+export type GraphFillPattern = "solid" | "diagonal" | "diagonalBack" | "cross" | "horizontal" | "vertical" | "dots";
+export interface Graph2DSpec {
+    kind: Graph2DKind;
+    title: string;
+    width: number;
+    height: number;
+    viewBox: GraphViewBox;
+    graphViewBox?: GraphViewBox;
+    axes: GraphAxes;
+    curves: GraphCurve[];
+    points?: GraphPoint[];
+    annotations?: GraphAnnotation[];
+    fills?: GraphFillRegion[];
+    showFormulaLabels?: boolean;
+}
+export interface GraphViewBox {
+    xMin: string;
+    xMax: string;
+    yMin: string;
+    yMax: string;
+}
+export interface GraphAxes {
+    grid: boolean;
+    showX?: boolean;
+    showY?: boolean;
+    showTicks?: boolean;
+    renderStyle?: GraphRenderStyle;
+    axisDash?: GraphCurveDash;
+    axisColor?: string;
+    axisStrokeWidth?: number;
+    xLabel?: string;
+    yLabel?: string;
+    originLabel?: string;
+    /** Tick label font size in points. */
+    tickFontSize?: number;
+    xTickStep?: string;
+    yTickStep?: string;
+    xTickMode?: GraphTickMode;
+    yTickMode?: GraphTickMode;
+}
+export interface GraphCurve {
+    id: string;
+    /** `yOfX`: y=f(x), `xOfY`: x=f(y), `parametric`: x=f(t), `implicit`: F(x,y)=0. 評価用の正規化済み式 (正本)。 */
+    expr: string;
+    /** Used only when `mode` is `"parametric"`: y=g(t). */
+    yExpr?: string;
+    /** ユーザーが入力した TeX (表示・再編集用の投影)。無ければ `expr` から導出する。 */
+    exprTex?: string;
+    /** `yExpr` に対応する入力 TeX。 */
+    yExprTex?: string;
+    label?: string;
+    color: string;
+    mode?: GraphCurveMode;
+    dash?: GraphCurveDash;
+    strokeWidth?: number;
+    domain?: {
+        min?: string;
+        max?: string;
+    };
+    samples?: number;
+}
+/** 点ラベルを置く方位 (8方位)。未指定なら曲線・軸・他の点/ラベルを避けて自動配置する。 */
+export type GraphPointLabelPlacement = "n" | "ne" | "e" | "se" | "s" | "sw" | "w" | "nw";
+export interface GraphPoint {
+    id: string;
+    x: string;
+    y: string;
+    /** ユーザーが入力した座標 TeX (表示・再編集用の投影)。無ければ `x`/`y` から導出する。 */
+    xTex?: string;
+    yTex?: string;
+    label?: string;
+    /** ラベルを置く方位。省略時は曲線・軸・他要素と重ならない位置を自動選択する。 */
+    labelPlacement?: GraphPointLabelPlacement;
+    color?: string;
+    fill?: "solid" | "none";
+    radius?: number;
+    showXProjection?: boolean;
+    showYProjection?: boolean;
+}
+export interface GraphAnnotation {
+    id: string;
+    x: string;
+    y: string;
+    text: string;
+}
+export interface GraphFillRegion {
+    id: string;
+    x: string;
+    y: string;
+    color?: string;
+    opacity?: number;
+    pattern?: GraphFillPattern;
+}
+export interface AnswerDefinition {
+    type: "math" | "text";
+    expected: string;
+}
+export type InlineNode = TextInlineNode | MathInlineNode;
+export interface TextInlineNode {
+    type: "text";
+    text: string;
+    marks?: TextMark[];
+    color?: string;
+    backgroundColor?: string;
+    fontFamily?: string;
+    fontSize?: number;
+    boxedPaddingY?: number;
+    boxedVariant?: BoxedVariant;
+    boxedTone?: BoxedTone;
+}
+export type TextMark = "bold" | "italic" | "underline" | "boxed";
+/**
+ * Visual style of a boxed run, modeled after common TeX box commands:
+ * `frame` (\fbox), `thick`, `double`, `oval` (\ovalbox), and `shade` (\tcolorbox / \itembox).
+ * Absent means `frame`, so existing boxed runs keep their thin-border look.
+ */
+export type BoxedVariant = "frame" | "thick" | "double" | "oval" | "shade";
+/** Fill colour preset for `shade` boxes. Absent means `gray`. */
+export type BoxedTone = "gray" | "blue" | "green" | "red" | "yellow";
+export interface MathInlineNode {
+    type: "mathInline";
+    id: string;
+    tex: string;
+    display: "inline";
+    marks?: Array<Extract<TextMark, "underline" | "boxed">>;
+    color?: string;
+    backgroundColor?: string;
+    fontFamily?: string;
+    fontSize?: number;
+    boxedPaddingY?: number;
+    boxedVariant?: BoxedVariant;
+    boxedTone?: BoxedTone;
+    semanticRole?: "expression" | "equation" | "variable";
+    altText?: string;
+}

package/dist/viewer-safety.d.ts

@@ -0,0 +1,19 @@
+import type { SigmaDocument } from "./types";
+export declare class ViewerSafetyValidationError extends Error {
+    readonly issues: readonly string[];
+    constructor(issues: readonly string[]);
+}
+export interface ValidatedImageDataUrl {
+    src: string;
+    mimeType: "image/png" | "image/jpeg" | "image/webp" | "image/svg+xml";
+}
+export type ImageDataUrlValidation = {
+    ok: true;
+    value: ValidatedImageDataUrl;
+} | {
+    ok: false;
+    reason: string;
+};
+export declare function assertViewerSafeDocument(document: SigmaDocument): void;
+export declare function getViewerSafetyIssues(document: SigmaDocument): string[];
+export declare function validateImageDataUrl(source: string): ImageDataUrlValidation;

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "@sigma-studio/viewer",
+  "version": "0.188.0",
+  "description": "Read-only React renderer for SigmaDoc teaching materials.",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Atsu-Taiyo/ai-math-editor.git",
+    "directory": "packages/viewer"
+  },
+  "bugs": {
+    "url": "https://github.com/Atsu-Taiyo/ai-math-editor/issues"
+  },
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./styles.css": "./dist/styles.css",
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "dist",
+    "LICENSE",
+    "README.md",
+    "THIRD_PARTY_NOTICES.md"
+  ],
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "node ./scripts/clean.mjs",
+    "build": "npm run clean && node ./scripts/build.mjs && tsc -p tsconfig.build.json",
+    "typecheck": "tsc --noEmit -p tsconfig.json",
+    "test": "vitest run",
+    "prepack": "npm run build"
+  },
+  "peerDependencies": {
+    "react": ">=18.2.0 <20",
+    "react-dom": ">=18.2.0 <20"
+  },
+  "dependencies": {
+    "katex": "^0.16.45",
+    "mathlive": "^0.109.2",
+    "zod": "^4.4.3"
+  },
+  "devDependencies": {
+    "@types/react": "^19.2.14",
+    "@types/react-dom": "^19.2.3",
+    "esbuild": "^0.24.0",
+    "happy-dom": "^20.11.0",
+    "postcss": "^8.5.14",
+    "react": "^19.2.6",
+    "react-dom": "^19.2.6",
+    "typescript": "^5.9.3",
+    "vitest": "^3.2.4"
+  }
+}