score-viewer 1.0.45 → 1.0.46

package/dist/types/main.d.ts

@@ -2,7 +2,11 @@ import { Context as Context_2 } from 'react';
 import { ForwardRefExoticComponent } from 'react';
 import { JSX } from 'react/jsx-runtime';
 import { RefAttributes } from 'react';
-import { StoreApi } from 'zustand';
+
+declare type Action = {
+    type: string;
+    config: LoadConfig | LoadAutoScrollConfig | RenderConfig | RenderAutoScrollConfig;
+};
 
 declare interface Annotation {
     id: string;
@@ -56,6 +60,22 @@ declare class FetchError extends Error {
     constructor(type: string, message: string);
 }
 
+declare type LoadAutoScrollConfig = {
+    height: number;
+    meiStr: string;
+    transposition: string | null;
+};
+
+declare type LoadConfig = {
+    scoreUrl: string;
+    postLoadTransition?: Transition | undefined;
+    meiStr: string;
+    page?: number | undefined;
+    scale: number;
+    transposition: string | null;
+    restorePositionForAchor?: string | undefined;
+};
+
 export declare type LyricItem = {
     title: string;
     text: string | FetchError;
@@ -68,18 +88,38 @@ declare interface Option_2 {
     contentDescription: string | undefined;
 }
 
-export declare type Reconstruction = {
-    staff: string;
-    voiceName: string;
-    reconstructionsForVoice: ReconstructionItem[];
+declare enum PlayingState {
+    PLAYING = 0,
+    PAUSED = 1,
+    STOPPED = 2
+}
+
+declare type RenderAutoScrollConfig = {
+    height: number;
 };
 
-declare type ReconstructionItem = {
-    voice: string;
-    label: string;
-    reconstructionBy: string;
+declare type RenderConfig = {
+    scoreUrl: string;
+    loadedWidth: number;
+    loadedHeight: number;
+    transition?: Transition | undefined;
+    renderPage: number;
+    loadedPagesCount: number;
+    scale: number;
 };
 
+declare interface RenderedData {
+    id: string;
+    scoreUrl: string;
+    scale: number;
+    page: number;
+    timemap: TimeMapEvent[];
+    anchorElement: string | null;
+    width?: number;
+    height?: number;
+    svgHTML?: string;
+}
+
 export declare type Score = {
     url: string;
     title: string;
@@ -98,7 +138,6 @@ export declare type ScoreProperties = {
     composer: string;
     lyricist: string;
     editor: string;
-    reconstructions: Reconstruction[];
     reconstructionBy: string | null;
     sections: {
         label: string;
@@ -152,7 +191,6 @@ export declare interface ScoreViewerConfigSettings {
     showTextSection: boolean;
     showFacsimileSection: boolean;
     showOptions: boolean;
-    showMusicAnalysisByDefault: boolean;
     renderTitlesFromMEI: boolean;
     backgroundColor?: string | undefined;
     basePath: string;
@@ -175,9 +213,107 @@ export declare interface ScoreViewerRef {
     selectScore: (scoreIndex: number | null) => void;
 }
 
+declare class ScoreViewerStoreApi {
+    use: {
+        queuedAction: () => Action | null;
+        setQueuedAction: () => (action: Action | null) => void;
+        pendingAction: () => Action | null;
+        setPendingAction: () => (action: Action | null) => void;
+        score: () => Score | null;
+        showingMei: () => string | null;
+        scoreCache: () => {
+            [index: string]: Score;
+        };
+        textCache: () => TextPartsCache;
+        textComments: () => string | FetchError | null | undefined;
+        textIntroduction: () => string | FetchError | null | undefined;
+        textLyrics: () => LyricItem[] | null | undefined;
+        setScore: () => (score: Score | null) => void;
+        setShowingMei: () => (mei: string | null) => void;
+        setScoreCache: () => (scoreCache: {
+            [index: string]: Score;
+        }) => void;
+        setTextCache: () => (textCache: TextPartsCache, replace: boolean) => void;
+        setTextComments: () => (textComments: string | FetchError | null | undefined) => void;
+        setTextIntroduction: () => (textIntroduction: string | FetchError | null | undefined) => void;
+        setTextLyrics: () => (textLyrics: LyricItem[] | null | undefined, replace: boolean) => void;
+        isLoading: () => boolean;
+        scoreSvg: () => string | null;
+        scale: () => number;
+        reachedEffectiveMaxScale: () => boolean;
+        isSplitView: () => boolean;
+        activeSplitView: () => string;
+        splitViewOrientation: () => "horizontal" | "vertical";
+        activeTab: () => string;
+        setIsLoading: () => (isLoading: boolean) => void;
+        setScoreSvg: () => (svg: string | null) => void;
+        setScale: () => (scale: number) => void;
+        increaseScale: () => () => void;
+        decreaseScale: () => () => void;
+        setReachedEffectiveMaxScale: () => (value: boolean) => void;
+        setIsSplitView: () => (splitView: boolean) => void;
+        setSplitViewOrientation: () => (orientation: "horizontal" | "vertical") => void;
+        setActiveTab: () => (tab: string) => void;
+        setActiveSplitView: () => (view: string) => void;
+        resetUILayout: () => () => void;
+        pageCount: () => number;
+        currentPage: () => number;
+        sectionPageMap: () => Record<string, number>;
+        setScoreLayout: () => (layout: {
+            pageCount: number;
+            sectionPageMap: Record<string, number>;
+            currentPage: number;
+        }) => void;
+        goToPage: () => (page: number) => void;
+        goToNextPage: () => () => void;
+        goToPreviousPage: () => () => void;
+        goToSection: () => (sectionId: string) => void;
+        navigationCommand: () => {
+            type: "section" | "page";
+            target: string | number;
+        } | null;
+        clearNavigationCommand: () => () => void;
+        playingState: () => PlayingState;
+        playingPosition: () => number;
+        seekPosition: () => number;
+        autoScroll: () => boolean;
+        setPlayingState: () => (state: PlayingState) => void;
+        setPlayingPosition: () => (position: number) => void;
+        setSeekPosition: () => (position: number) => void;
+        setAutoScroll: () => (autoScroll: boolean) => void;
+        resetPlayerPosition: () => () => void;
+        showNVerses: () => number;
+        showEditorial: () => boolean;
+        showOriginalClefs: () => boolean;
+        normalizeFicta: () => boolean;
+        showingEditorial: () => string | null;
+        appOptions: () => string[];
+        choiceOptions: () => string[];
+        withoutTransposition: () => boolean;
+        showMusicAnalysis: () => boolean;
+        measureNumberInterval: () => number;
+        setShowNVerses: () => (n: number) => void;
+        setShowEditorial: () => (showEditorial: boolean) => void;
+        setShowOriginalClefs: () => (showOriginalClefs: boolean) => void;
+        setNormalizeFicta: () => (normalizeFicta: boolean) => void;
+        setShowingEditorial: () => (editorial: string | null) => void;
+        setAppOptions: () => (options: string[], replace: boolean) => void;
+        setChoiceOptions: () => (options: string[], replace: boolean) => void;
+        setWithoutTransposition: () => (withoutTransposition: boolean) => void;
+        setShowMusicAnalysis: () => (showMusicAnalysis: boolean) => void;
+        setMeasureNumberInterval: () => (interval: number) => void;
+        resetScoreSettings: () => () => void;
+        renderedSvgData: () => RenderedData | null;
+        setRenderedSvgData: () => (data: RenderedData) => void;
+        pageCache: () => Map<number, RenderedData>;
+        setCachedPage: () => (page: number, data: RenderedData) => void;
+        getCachedPage: () => (page: number) => RenderedData | null;
+        clearPageCache: () => () => void;
+    };
+}
+
 declare interface ScoreViewProps {
     backgroundColor?: string | undefined;
-    showMusicAnalysisByDefault: boolean;
 }
 
 declare type Sources = {
@@ -192,6 +328,25 @@ export declare type TextParts = {
     introduction: string | null;
 };
 
+declare type TextPartsCache = {
+    [url: string]: string | FetchError | null;
+};
+
+declare type TimeMapEvent = {
+    on?: string[] | undefined;
+    off?: string[] | undefined;
+    measureOn?: string | undefined;
+    qstamp: number;
+    tstamp: number;
+    tempo?: number | undefined;
+    stavesOn?: string[] | undefined;
+};
+
+declare enum Transition {
+    FADE_OUT = 0,
+    FADE_IN = 1
+}
+
 declare type Transposition = "" | "P4" | "+P4" | "-P4" | "M3" | "+M3" | "-M3" | "P8" | "+P8" | "-P8";
 
 export declare function useScoreManager({ t, config, normalizeFicta, onScoreAnalyzed, onFetchScoreError }: UseScoreManagerProps): {
@@ -209,7 +364,7 @@ declare interface UseScoreManagerProps {
     onFetchScoreError?: ((url: string, error: Error) => void) | undefined;
 }
 
-export declare const useStore: StoreApi;
+export declare const useStore: ScoreViewerStoreApi;
 
 export declare function useTextParts({ config, }: UseTextPartsProps): {
     fetchTextParts: (scoreIndex: number) => void;
@@ -224,9 +379,6 @@ declare interface UseTextPartsProps {
 
 export declare type VisualizationOptions = {
     showOriginalClefs?: boolean | null | undefined;
-    showReconstructions?: {
-        [staff: string]: string;
-    } | undefined;
 };
 
 export { }

package/package.json

@@ -13,7 +13,7 @@
     "./style.css": "./dist/style.css"
   },
   "private": false,
-  "version": "1.0.45",
+  "version": "1.0.46",
   "type": "module",
   "files": [
     "dist"