@sigma-studio/viewer 0.188.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kimura Atsushi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,117 @@
+# @sigma-studio/viewer
+
+SigmaDoc教材をReactアプリ内で安全に表示する、閲覧専用の軽量Viewerです。
+
+## パッケージの選び方
+
+| 用途 | パッケージ |
+| --- | --- |
+| 教材を表示する | `@sigma-studio/viewer` |
+| 教材をWeb上で編集する | `@sigma-studio/editor` |
+
+Viewerには編集UI、保存、認証、AI、Electron API、外部assetの取得は含まれません。ホストアプリがSigmaDocの取得と状態管理を担当します。
+
+## インストール
+
+```sh
+npm install @sigma-studio/viewer
+```
+
+## 基本的な使い方
+
+```tsx
+import { SigmaDocViewer, type SigmaDocument } from "@sigma-studio/viewer";
+import "@sigma-studio/viewer/styles.css";
+
+export function MaterialPage({ document }: { document: SigmaDocument }) {
+  return (
+    <SigmaDocViewer
+      document={document}
+      onError={(error) => console.error(error)}
+    />
+  );
+}
+```
+
+ホストが新しい`document`オブジェクトを渡すと、ViewerはSigmaDocを再検証して表示を更新します。Viewer自身はfetch、polling、保存を行いません。
+
+## API
+
+### `SigmaDocViewer`
+
+```ts
+interface SigmaDocViewerProps {
+  document: SigmaDocument;
+  visibleParts?: readonly ("problem" | "solution" | "comments")[];
+  hideProblemNumbers?: boolean;
+  maxHeightPx?: number;
+  className?: string;
+  style?: React.CSSProperties;
+  onError?: (error: SigmaDocViewerError) => void;
+}
+```
+
+本文は選択・コピーできます。URL形式の本文も自動リンク化せず、通常の文字列として表示します。オーバーレイは表示専用で、編集ハンドルやツールバーは描画されません。問題の問題文、解答、ヒント、解説はすべて表示し、制作コメントは表示しません。
+
+`visibleParts`を指定すると、problem外の本文を除外して、次の問題領域だけを組み合わせて表示できます。未指定時は従来どおり全内容を表示します。
+
+- `problem`: 導入文と問題文 (`lead` / `prompt`)
+- `solution`: 解答 (`solution`)。短い正答の`answer`は含みません
+- `comments`: 編集画面上の問題内コメント (`hints`)
+
+```tsx
+<SigmaDocViewer document={document} visibleParts={["problem"]} />
+<SigmaDocViewer document={document} visibleParts={["solution"]} />
+<SigmaDocViewer document={document} visibleParts={["problem", "solution"]} />
+<SigmaDocViewer document={document} visibleParts={["comments"]} />
+```
+
+`hideProblemNumbers`はSigmaDocの採番設定より優先して問題番号を非表示にします。`maxHeightPx`に正のpx値を指定すると、その高さを超えた場合だけ下端をフェードし、「すべて表示」ボタンを表示します。このボタンは表示範囲を広げるだけで、SigmaDocを変更しません。
+
+### Validation
+
+`parseSigmaDocument`は外部から取得したunknown値をSigmaDoc v2として検証・正規化します。
+
+```ts
+const document = parseSigmaDocument(await response.json());
+```
+
+## 画像の扱い
+
+画像assetの`props.src`には次のdata URLだけを使用できます。
+
+- `data:image/png`
+- `data:image/jpeg`
+- `data:image/webp`
+- `data:image/svg+xml`
+
+PNG、JPEG、WebPはbase64形式と実ファイル署名を検証します。SVGはbase64またはpercent-encoded UTF-8を受け付け、script、event属性、外部resource参照を含まない自己完結した内容だけを表示します。SVG文字列はDOMへ展開せず、SVGの`<image>`として描画します。位置、寸法、crop、回転、透明度、前景・背景、anchorをSigmaDocの指定どおり再現します。
+
+外部URL、`blob:`、`sigma-doc-storage://`、空のsource、存在しないassetは取得しません。同じ画像枠にplaceholderを表示し、`onError`へ`unsupported-asset`を通知します。
+
+## 互換性
+
+- React / React DOM: `>=18.2.0 <20`
+- SigmaDoc: `version: "2.0"`
+- CSS: `@sigma-studio/viewer/styles.css`
+
+パッケージのバージョンはSigma Studio本体と揃えて公開します。
+
+## 開発
+
+以下はこのリポジトリの開発者向けコマンドです。リポジトリルートで実行します。
+
+
+```sh
+npm run viewer:typecheck
+npm run viewer:test
+npm run viewer:build
+npm run viewer:pack
+npm run viewer:example
+```
+
+`npm run viewer:pack`は公開せず、npm packageの内容だけを確認します。
+
+## ライセンス
+
+MIT

package/THIRD_PARTY_NOTICES.md

@@ -0,0 +1,23 @@
+# Third-party notices
+
+`@sigma-studio/viewer` bundles display CSS and font assets from the following MIT-licensed projects.
+
+## KaTeX
+
+Copyright (c) 2013-2020 Khan Academy and other contributors
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+## MathLive
+
+Copyright (c) 2017-present Arno Gourdol. All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/dist/SigmaDocViewer.d.ts

@@ -0,0 +1,39 @@
+import { type CSSProperties } from "react";
+import type { SigmaDocument } from "./types";
+declare const VIEWER_PARTS: readonly ["problem", "solution", "comments"];
+export type SigmaDocViewerPart = (typeof VIEWER_PARTS)[number];
+export interface SigmaDocViewerProps {
+    document: SigmaDocument;
+    visibleParts?: readonly SigmaDocViewerPart[];
+    hideProblemNumbers?: boolean;
+    maxHeightPx?: number;
+    className?: string;
+    style?: CSSProperties;
+    onError?: (error: SigmaDocViewerError) => void;
+}
+export type SigmaDocViewerError = {
+    code: "invalid-document";
+    message: string;
+    issues: readonly string[];
+} | {
+    code: "unsupported-asset";
+    message: string;
+    assetId: string;
+} | {
+    code: "render-failed";
+    message: string;
+};
+export declare class SigmaDocParseError extends Error {
+    readonly issues: readonly string[];
+    constructor(issues: readonly string[], options?: {
+        cause?: unknown;
+    });
+}
+/**
+ * Validate and normalize an unknown value as the canonical SigmaDoc v2 model.
+ * The implementation is shared with Sigma Studio so migrations and defaults do
+ * not drift between the authoring app and the viewer.
+ */
+export declare function parseSigmaDocument(input: unknown): SigmaDocument;
+export declare function SigmaDocViewer({ document, visibleParts, hideProblemNumbers, maxHeightPx, className, style, onError, }: SigmaDocViewerProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { SigmaDocParseError, SigmaDocViewer, parseSigmaDocument, type SigmaDocViewerError, type SigmaDocViewerPart, type SigmaDocViewerProps, } from "./SigmaDocViewer";
+export type * from "./types";
+export type * from "./overlay-types";