@linloir/limr 0.0.0-stage → 1.0.0

package/dist/core/index.js

@@ -0,0 +1,39 @@
+import {
+  DocumentEngine,
+  annotationReferenceRange,
+  createDocument,
+  defaultHighlight,
+  intersects,
+  mapText,
+  rangeOf,
+  replaceExtension,
+  resolveAnnotationAnchors,
+  safeUrl,
+  sameRange,
+  selectionFromRange,
+  textContent,
+  walk
+} from "../chunk-TTISGBST.js";
+import {
+  LruCache,
+  ResourceCache
+} from "../chunk-6N6TFHEN.js";
+export {
+  DocumentEngine,
+  LruCache,
+  ResourceCache,
+  annotationReferenceRange,
+  createDocument,
+  defaultHighlight,
+  intersects,
+  mapText,
+  rangeOf,
+  replaceExtension,
+  resolveAnnotationAnchors,
+  safeUrl,
+  sameRange,
+  selectionFromRange,
+  textContent,
+  walk
+};
+//# sourceMappingURL=index.js.map

package/dist/core/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/engine-43u8B4yt.d.ts

@@ -0,0 +1,172 @@
+import { Extension } from 'micromark-util-types';
+import { Extension as Extension$1 } from 'mdast-util-from-markdown';
+
+/** UTF-16 offsets into the unmodified input. The end is exclusive. */
+interface SourceRange {
+    start: number;
+    end: number;
+}
+interface SourcePoint {
+    offset: number;
+    line: number;
+    column: number;
+}
+interface SourcePosition {
+    start: SourcePoint;
+    end: SourcePoint;
+}
+/** The portable, serializable tree consumed by LiMR's views. */
+interface MarkdownNode {
+    type: string;
+    position?: SourcePosition;
+    children?: MarkdownNode[];
+    value?: string;
+    name?: string;
+    attributes?: Record<string, string | boolean | number>;
+    /** Source-mapped attribute values, available to custom text renderers. */
+    attributeNodes?: Record<string, MarkdownNode>;
+    inline?: boolean;
+    selection?: 'content' | 'atomic';
+    [key: string]: unknown;
+}
+interface ParseContext {
+    source: string;
+    streaming: boolean;
+    documentId: string;
+}
+interface SyntaxExtension {
+    /** Unique name. Duplicate names are an error unless explicitly replaced. */
+    name: string;
+    micromark?: readonly Extension[];
+    mdast?: readonly Extension$1[];
+    tags?: readonly string[];
+    directives?: readonly string[];
+    selection?: 'content' | 'atomic';
+    transform?: (root: MarkdownNode, context: ParseContext) => void;
+    display?: 'block' | 'inline' | 'auto';
+    /** Transforms default to document scope. Opt into local only when safe. */
+    scope?: 'local' | 'document';
+}
+interface Heading {
+    id: string;
+    text: string;
+    level: number;
+    range: SourceRange;
+    blockId: string;
+}
+interface AnnotationAnchor {
+    id?: string;
+    range: SourceRange;
+    documentId?: string;
+    revision?: number;
+    /** Optional original text used to validate or relocate persisted anchors. */
+    quote?: string;
+}
+interface Annotation<T = unknown> {
+    id: string;
+    type: string;
+    data?: T;
+    /** Shorthand for a single occurrence. */
+    range?: SourceRange;
+    anchors?: readonly AnnotationAnchor[];
+}
+interface AnnotationOccurrence extends AnnotationAnchor {
+    id: string;
+    annotationIds: readonly string[];
+    embedded?: boolean;
+}
+/** Data for the built-in `highlight` annotation type. */
+interface HighlightData {
+    color?: string;
+    style?: 'background' | 'underline' | 'dotted' | 'wavy';
+    hidden?: boolean;
+}
+interface Block {
+    id: string;
+    node: MarkdownNode;
+    range: SourceRange;
+    pending: boolean;
+}
+interface Diagnostic {
+    message: string;
+    offset?: number;
+    extension?: string;
+}
+interface DocumentMetrics {
+    parsedCharacters: number;
+    reusedBlocks: number;
+    parsedBlocks: number;
+    fullParse: boolean;
+    reason: 'initial' | 'append' | 'replace' | 'definitions' | 'extension' | 'finalize';
+}
+interface DocumentSnapshot {
+    id: string;
+    revision: number;
+    source: string;
+    streaming: boolean;
+    blocks: readonly Block[];
+    headings: readonly Heading[];
+    definitions: ReadonlyMap<string, MarkdownNode>;
+    footnotes: ReadonlyMap<string, MarkdownNode>;
+    footnoteOrder: readonly string[];
+    annotations: readonly Annotation[];
+    occurrences: readonly AnnotationOccurrence[];
+    diagnostics: readonly Diagnostic[];
+    metrics: DocumentMetrics;
+}
+interface DocumentOptions {
+    id?: string;
+    extensions?: readonly SyntaxExtension[];
+    streaming?: boolean;
+}
+interface SelectionResult {
+    ranges: readonly SourceRange[];
+    sourceText: string;
+}
+interface SelectionSnapshot {
+    documentId: string;
+    revision: number;
+    text: string;
+    quality: 'exact' | 'atomic' | 'unmapped';
+    raw: SelectionResult;
+    /** Absorb adjacent standard Markdown delimiters independently at each edge. */
+    syntax: SelectionResult;
+    blocks: SelectionResult;
+    /** False while a pointer selection is being adjusted. */
+    settled: boolean;
+}
+interface Rect {
+    x: number;
+    y: number;
+    top: number;
+    right: number;
+    bottom: number;
+    left: number;
+    width: number;
+    height: number;
+}
+
+/** A synchronous, DOM-free document session. React/scroll state never enters it. */
+declare class DocumentEngine {
+    readonly id: string;
+    private extensions;
+    private parse;
+    private snapshot?;
+    private nextBlock;
+    private listeners;
+    private definitionSignature;
+    private recoveryOffset;
+    constructor(source?: string, options?: DocumentOptions);
+    getSnapshot: () => DocumentSnapshot;
+    subscribe: (listener: () => void) => (() => void);
+    setExtensions(extensions: readonly SyntaxExtension[]): void;
+    append(chunk: string): DocumentSnapshot;
+    finish(): DocumentSnapshot;
+    update(source: string, options?: {
+        streaming?: boolean;
+    }, force?: boolean): DocumentSnapshot;
+}
+declare function createDocument(source?: string, options?: DocumentOptions): DocumentEngine;
+declare function replaceExtension<T extends SyntaxExtension>(extensions: readonly T[], replacement: T): T[];
+
+export { type Annotation as A, type Block as B, type Diagnostic as D, type Heading as H, type MarkdownNode as M, type ParseContext as P, type Rect as R, type SelectionResult as S, type AnnotationAnchor as a, type AnnotationOccurrence as b, DocumentEngine as c, type DocumentMetrics as d, type DocumentOptions as e, type DocumentSnapshot as f, type HighlightData as g, type SelectionSnapshot as h, type SourcePoint as i, type SourcePosition as j, type SourceRange as k, type SyntaxExtension as l, createDocument as m, replaceExtension as r };

package/dist/extensions/index.d.ts

@@ -0,0 +1,130 @@
+import { N as NodeRenderer, f as AnnotationType, R as RendererExtension, i as MarkdownProps, S as SelectionAction } from '../translations-DHnYMg4h.js';
+export { n as TranslationMode, o as TranslationsOptions, t as translations } from '../translations-DHnYMg4h.js';
+import { KatexOptions } from 'katex';
+import * as react from 'react';
+import '../engine-43u8B4yt.js';
+import 'micromark-util-types';
+import 'mdast-util-from-markdown';
+
+interface BlockExtensionOptions {
+    name: string;
+    component: NodeRenderer;
+    tags?: readonly string[];
+    directives?: readonly string[];
+    selection?: 'content' | 'atomic';
+}
+/** A tag/directive adapter with original source positions and streaming recovery. */
+declare function defineBlock({ name, component, tags, directives, selection }: BlockExtensionOptions): RendererExtension;
+declare function defineAnnotation<T>(type: AnnotationType<T>): RendererExtension;
+declare function defineExtension(extension: RendererExtension): RendererExtension;
+
+declare function gfm(): RendererExtension;
+
+/** Optional: await before synchronous server rendering to include formula HTML. */
+declare function preloadMath(): Promise<void>;
+interface MathOptions {
+    macros?: Record<string, string>;
+    strict?: KatexOptions['strict'];
+}
+declare function math(options?: MathOptions): RendererExtension;
+
+interface CodeHighlightOptions {
+    languages?: readonly string[];
+    lightTheme?: string;
+    darkTheme?: string;
+    eager?: boolean;
+    maxLength?: number;
+}
+declare function codeHighlight(options?: CodeHighlightOptions): RendererExtension;
+
+interface VideoOptions {
+    component?: NodeRenderer;
+    resolveUrl?: (provider: string, url: string) => string | undefined;
+    /** Load near the viewport by default; click and eager are explicit alternatives. */
+    loading?: 'visible' | 'click' | 'eager';
+}
+declare function video(options?: VideoOptions): RendererExtension;
+
+interface FiguresOptions {
+    minWidth?: number;
+    maxWidth?: number | false;
+    minHeight?: number;
+    maxHeight?: number | false;
+    columns?: number;
+    rows?: number;
+    responsive?: boolean;
+    gap?: number;
+}
+declare function figures(options?: FiguresOptions): RendererExtension;
+
+declare function definition(options?: {
+    component?: NodeRenderer;
+}): RendererExtension;
+declare function question(options?: {
+    component?: NodeRenderer;
+}): RendererExtension;
+declare function extras(options?: {
+    component?: NodeRenderer;
+}): RendererExtension;
+
+interface CitationData {
+    title?: string;
+    url?: string;
+    description?: string;
+    summary?: string;
+}
+declare function AnnotationMarkdown({ source, className, ...props }: MarkdownProps & {
+    source: string;
+}): react.JSX.Element;
+declare function citation(options?: Partial<AnnotationType<CitationData>>): RendererExtension;
+
+/** LiMR's default capabilities. Every item uses the public extension contract. */
+declare function standard(): RendererExtension[];
+
+/** The first five colors match infilearn's reading palette. */
+declare const highlightColors: readonly [{
+    readonly color: "#E57373";
+    readonly label: "Rose";
+    readonly labelZh: "玫瑰";
+}, {
+    readonly color: "#F2C744";
+    readonly label: "Gold";
+    readonly labelZh: "暖黄";
+}, {
+    readonly color: "#81B29A";
+    readonly label: "Sage";
+    readonly labelZh: "鼠尾草";
+}, {
+    readonly color: "#6B9BD2";
+    readonly label: "Blue";
+    readonly labelZh: "雾蓝";
+}, {
+    readonly color: "#B39DDB";
+    readonly label: "Lavender";
+    readonly labelZh: "薰衣草";
+}, {
+    readonly color: "#E5A06E";
+    readonly label: "Apricot";
+    readonly labelZh: "杏橙";
+}, {
+    readonly color: "#61AAA5";
+    readonly label: "Teal";
+    readonly labelZh: "青瓷";
+}];
+declare function copyText(options?: {
+    label?: string;
+    format?: 'text' | 'raw' | 'syntax' | 'blocks';
+}): SelectionAction;
+interface HighlightOptions {
+    colors?: readonly {
+        color: string;
+        label: string;
+        labelZh?: string;
+    }[];
+}
+/** A single swatch owns all style choices; the highlight action never expands. */
+declare function highlightPalette(options?: HighlightOptions): SelectionAction;
+declare function highlightSelection(): SelectionAction;
+declare function deleteAnnotations(): SelectionAction;
+
+export { AnnotationMarkdown, type BlockExtensionOptions, type CitationData, type CodeHighlightOptions, type FiguresOptions, type HighlightOptions, type MathOptions, type VideoOptions, citation, codeHighlight, copyText, defineAnnotation, defineBlock, defineExtension, definition, deleteAnnotations, extras, figures, gfm, highlightColors, highlightPalette, highlightSelection, math, preloadMath, question, standard, video };

package/dist/extensions/index.js

@@ -0,0 +1,50 @@
+import "../chunk-V2OG4Y3F.js";
+import {
+  AnnotationMarkdown,
+  citation,
+  codeHighlight,
+  copyText,
+  defineAnnotation,
+  defineBlock,
+  defineExtension,
+  definition,
+  deleteAnnotations,
+  extras,
+  figures,
+  gfm,
+  highlightColors,
+  highlightPalette,
+  highlightSelection,
+  math,
+  preloadMath,
+  question,
+  standard,
+  translations,
+  video
+} from "../chunk-3ILUZKDB.js";
+import "../chunk-TTISGBST.js";
+import "../chunk-6N6TFHEN.js";
+export {
+  AnnotationMarkdown,
+  citation,
+  codeHighlight,
+  copyText,
+  defineAnnotation,
+  defineBlock,
+  defineExtension,
+  definition,
+  deleteAnnotations,
+  extras,
+  figures,
+  gfm,
+  highlightColors,
+  highlightPalette,
+  highlightSelection,
+  math,
+  preloadMath,
+  question,
+  standard,
+  translations,
+  video
+};
+//# sourceMappingURL=index.js.map

package/dist/extensions/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/fonts/LICENSE.txt

@@ -0,0 +1,93 @@
+Copyright 2022 The Maple Mono Project Authors (https://github.com/subframe7536/maple-font)
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.