smoosic 1.0.25 → 1.0.26

package/src/application/exports.ts

@@ -309,6 +309,7 @@ export * from '../ui/fileio/xhrLoader';
 export * from '../ui/help';
 export * from '../ui/common';
 export * from '../ui/i18n/language';
+export * from '../ui/i18n/language_en';
 export * from '../ui/i18n/translationEditor';
 export * from '../ui/keyBindings/default/editorKeys';
 export * from '../ui/keyBindings/default/trackerKeys';

package/types/src/application/application.d.ts

@@ -1,102 +1,102 @@
-import { SmoConfiguration, SmoConfigurationParams } from './configuration';
-import { SmoScore } from '../smo/data/score';
-import { UndoBuffer } from '../smo/xform/undo';
-import { SuiRenderState } from '../render/sui/renderState';
-import { SuiScoreViewOperations } from '../render/sui/scoreViewOperations';
-import { SuiTracker } from '../render/sui/tracker';
-import { SuiMenuManager } from '../ui/menus/manager';
-import { BrowserEventSource } from '../ui/eventSource';
-import { RibbonButtons } from '../ui/buttons/ribbon';
-import { SuiKeyCommands } from './keyCommands';
-import { SuiEventHandler } from './eventHandler';
-import { KeyBinding } from './common';
-export interface pairType {
-    [key: string]: string;
-}
-/**
- * Score renderer instance
- * @internal
- */
-export interface SuiRendererInstance {
-    view: SuiScoreViewOperations;
-    eventSource: BrowserEventSource;
-    undoBuffer: UndoBuffer;
-    renderer: SuiRenderState;
-}
-/**
- * Global instance for debugging
- * @internal
- */
-export interface SuiInstance {
-    view: SuiScoreViewOperations;
-    eventSource: BrowserEventSource;
-    undoBuffer: UndoBuffer;
-    tracker: SuiTracker;
-    keyCommands: SuiKeyCommands;
-    menus: SuiMenuManager;
-    eventHandler: SuiEventHandler;
-    ribbon: RibbonButtons;
-}
-/**
- * Parse query string for application
- * @category SuiApplication
- */
-export declare class QueryParser {
-    pairs: pairType[];
-    queryPair(str: string): pairType;
-    constructor();
-}
-/** SuiApplication
- * main entry point of application.  Based on the configuration,
- * either start the default UI, or initialize library mode and
- * await further instructions.
- * @category SuiApplication
- */
-export declare class SuiApplication {
-    scoreLibrary: any;
-    instance: SuiInstance | null;
-    config: SmoConfiguration;
-    score: SmoScore | null;
-    view: SuiScoreViewOperations | null;
-    domElement: HTMLElement;
-    static configure(params: Partial<SmoConfigurationParams>): Promise<SuiApplication>;
-    constructor(config: SmoConfiguration);
-    _getDomContainer(): HTMLElement;
-    static instance: SuiInstance;
-    static initSync(): void;
-    /**
-    // Different applications can create their own key bindings, these are the defaults.
-    // Many editor commands can be reached by a single keystroke.  For more advanced things there
-    // are menus.
-    */
-    static get keyBindingDefaults(): KeyBinding[];
-    /**
-     * Initialize the library according to instruction in config object:
-     * 1.  Try to load a new score
-     * 2.  If in application mode, start the UI.  If in translation mode, start translation
-     * @returns
-     */
-    initialize(): Promise<SuiApplication>;
-    /**
-     * Create the initial score we use to populate the UI etc:
-     * 0. if translation mode, return empty promise, it won't be used anyway
-     * 1. if remoteScore is set in config, try to load from remote
-     * 2. if initialScore is set, use that
-     * 3. if a score is saved locally with quick save (browser local cache), use that
-     * 4. if all else fails, return an 'empty' score.
-     * @returns promise for a remote load.  If a local load, will resolve immediately
-     */
-    createScore(): Promise<SmoScore | null>;
-    _tryParse(scoreJson: string): SmoScore;
-    _startApplication(): void;
-    createView(score: SmoScore): SuiRendererInstance | null;
-    /**
-     * Convenience constructor, take the score and render it in the
-     * configured rendering space.
-     */
-    createUi(): void;
-    static loadMusicFont(face: string, url: string): Promise<void>;
-    static registerFonts(): Promise<void>;
-    _deferCreateTranslator(): void;
-    static _deferLanguageSelection(lang: string): void;
-}
+import { SmoConfiguration, SmoConfigurationParams } from './configuration';
+import { SmoScore } from '../smo/data/score';
+import { UndoBuffer } from '../smo/xform/undo';
+import { SuiRenderState } from '../render/sui/renderState';
+import { SuiScoreViewOperations } from '../render/sui/scoreViewOperations';
+import { SuiTracker } from '../render/sui/tracker';
+import { SuiMenuManager } from '../ui/menus/manager';
+import { BrowserEventSource } from '../ui/eventSource';
+import { RibbonButtons } from '../ui/buttons/ribbon';
+import { SuiKeyCommands } from './keyCommands';
+import { SuiEventHandler } from './eventHandler';
+import { KeyBinding } from './common';
+export interface pairType {
+    [key: string]: string;
+}
+/**
+ * Score renderer instance
+ * @internal
+ */
+export interface SuiRendererInstance {
+    view: SuiScoreViewOperations;
+    eventSource: BrowserEventSource;
+    undoBuffer: UndoBuffer;
+    renderer: SuiRenderState;
+}
+/**
+ * Global instance for debugging
+ * @internal
+ */
+export interface SuiInstance {
+    view: SuiScoreViewOperations;
+    eventSource: BrowserEventSource;
+    undoBuffer: UndoBuffer;
+    tracker: SuiTracker;
+    keyCommands: SuiKeyCommands;
+    menus: SuiMenuManager;
+    eventHandler: SuiEventHandler;
+    ribbon: RibbonButtons;
+}
+/**
+ * Parse query string for application
+ * @category SuiApplication
+ */
+export declare class QueryParser {
+    pairs: pairType[];
+    queryPair(str: string): pairType;
+    constructor();
+}
+/** SuiApplication
+ * main entry point of application.  Based on the configuration,
+ * either start the default UI, or initialize library mode and
+ * await further instructions.
+ * @category SuiApplication
+ */
+export declare class SuiApplication {
+    scoreLibrary: any;
+    instance: SuiInstance | null;
+    config: SmoConfiguration;
+    score: SmoScore | null;
+    view: SuiScoreViewOperations | null;
+    domElement: HTMLElement;
+    static configure(params: Partial<SmoConfigurationParams>): Promise<SuiApplication>;
+    constructor(config: SmoConfiguration);
+    _getDomContainer(): HTMLElement;
+    static instance: SuiInstance;
+    static initSync(): void;
+    /**
+    // Different applications can create their own key bindings, these are the defaults.
+    // Many editor commands can be reached by a single keystroke.  For more advanced things there
+    // are menus.
+    */
+    static get keyBindingDefaults(): KeyBinding[];
+    /**
+     * Initialize the library according to instruction in config object:
+     * 1.  Try to load a new score
+     * 2.  If in application mode, start the UI.  If in translation mode, start translation
+     * @returns
+     */
+    initialize(): Promise<SuiApplication>;
+    /**
+     * Create the initial score we use to populate the UI etc:
+     * 0. if translation mode, return empty promise, it won't be used anyway
+     * 1. if remoteScore is set in config, try to load from remote
+     * 2. if initialScore is set, use that
+     * 3. if a score is saved locally with quick save (browser local cache), use that
+     * 4. if all else fails, return an 'empty' score.
+     * @returns promise for a remote load.  If a local load, will resolve immediately
+     */
+    createScore(): Promise<SmoScore | null>;
+    _tryParse(scoreJson: string): SmoScore;
+    _startApplication(): void;
+    createView(score: SmoScore): SuiRendererInstance | null;
+    /**
+     * Convenience constructor, take the score and render it in the
+     * configured rendering space.
+     */
+    createUi(): void;
+    static loadMusicFont(face: string, url: string): Promise<void>;
+    static registerFonts(): Promise<void>;
+    _deferCreateTranslator(): void;
+    static _deferLanguageSelection(lang: string): void;
+}

package/types/src/application/common.d.ts

@@ -1,74 +1,74 @@
-import { SuiScoreViewOperations } from "../render/sui/scoreViewOperations";
-import { SuiTracker } from "../render/sui/tracker";
-import { CompleteNotifier } from "../ui/common";
-import { ModalComponent } from "../ui/common";
-import { BrowserEventSource, EventHandler } from "../ui/eventSource";
-export type trackerKeyAction = "moveHome" | "moveEnd" | "moveSelectionRight" | "moveSelectionLeft" | "moveSelectionUp" | "moveSelectionDown" | "moveSelectionRightMeasure" | "moveSelectionLeftMeasure" | "advanceModifierSelection" | "growSelectionRight" | "growSelectionLeft" | "growSelectionRightMeasure" | "growSelectionRightMeasure" | "moveSelectionPitchUp" | "moveSelectionPitchDown";
-export declare const trackerKeyActions: string[];
-export type editorKeyAction = "transposeUp" | "transposeDown" | "upOctave" | "downOctave" | "toggleCourtesyAccidental" | "toggleEnharmonic" | "doubleDuration" | "halveDuration" | "dotDuration" | "undotDuration" | "setPitch" | "slashGraceNotes" | "addGraceNote" | "removeGraceNote" | "playScore" | "stopPlayer" | "pausePlayer" | "togglePlayer" | "undo" | "copy" | "paste" | "makeTuplet" | "interval" | "unmakeTuplet" | "addMeasure" | "deleteNote" | "makeRest" | "unbeamSelections" | "beamSelections" | "toggleBeamDirection" | "addRemoveAccent" | "addRemoveTenuto" | "addRemoveStaccato" | "addRemovePizzicato" | "addRemoveMarcato";
-export declare const editorKeyActions: string[];
-export declare function isEditorKeyAction(action: string): boolean;
-export declare function isTrackerKeyAction(action: string): boolean;
-/**
- * A binding of a key to some action performed by a module
- * @category SuiApplication
- */
-export interface KeyBinding {
-    event: string;
-    key: string;
-    ctrlKey: boolean;
-    altKey: boolean;
-    shiftKey: boolean;
-    action: string;
-    module?: string;
-}
-/**
- * parameters for the key handlers
- * @param view
- * @param slashMode indicates that the dreaded 'slash' menus are up
- * @param completeNotifier notified  when modals close
- * @param tracker
- * @param eventSource register for event handlers
- * @category SuiApplication
- */
-export interface KeyCommandParams {
-    view: SuiScoreViewOperations;
-    slashMode: boolean;
-    completeNotifier: CompleteNotifier;
-    tracker: SuiTracker;
-    eventSource: BrowserEventSource;
-}
-/**
- * Shared interface for menus, dialogs, etc that can
- * accept UI events
- * @category SuiApplication
- */
-export declare abstract class ModalEventHandler {
-    abstract mouseMove(ev: any): void;
-    abstract mouseClick(ev: any): Promise<void>;
-    abstract evKey(evdata: any): Promise<void>;
-    abstract keyUp(evdata: any): void;
-}
-export type handler = (ev: any) => void;
-/**
- * Dependency injection, sends events to a proxy object, gets around some
- * cyclic dependencies when bootstrapping the application.
- * @category SuiApplication
- */
-export declare class ModalEventHandlerProxy {
-    _handler: ModalEventHandler | null;
-    eventSource: BrowserEventSource;
-    unbound: boolean;
-    keydownHandler: EventHandler | null;
-    keyupHandler: EventHandler | null;
-    mouseMoveHandler: EventHandler | null;
-    mouseClickHandler: EventHandler | null;
-    constructor(evSource: BrowserEventSource);
-    set handler(value: ModalEventHandler);
-    evKey(ev: any): Promise<void>;
-    keyUp(ev: any): void;
-    mouseMove(ev: any): void;
-    mouseClick(ev: any): Promise<void>;
-    bindEvents(): void;
-    unbindKeyboardForModal(dialog: ModalComponent): void;
-}
+import { SuiScoreViewOperations } from "../render/sui/scoreViewOperations";
+import { SuiTracker } from "../render/sui/tracker";
+import { CompleteNotifier } from "../ui/common";
+import { ModalComponent } from "../ui/common";
+import { BrowserEventSource, EventHandler } from "../ui/eventSource";
+export type trackerKeyAction = "moveHome" | "moveEnd" | "moveSelectionRight" | "moveSelectionLeft" | "moveSelectionUp" | "moveSelectionDown" | "moveSelectionRightMeasure" | "moveSelectionLeftMeasure" | "advanceModifierSelection" | "growSelectionRight" | "growSelectionLeft" | "growSelectionRightMeasure" | "growSelectionRightMeasure" | "moveSelectionPitchUp" | "moveSelectionPitchDown";
+export declare const trackerKeyActions: string[];
+export type editorKeyAction = "transposeUp" | "transposeDown" | "upOctave" | "downOctave" | "toggleCourtesyAccidental" | "toggleEnharmonic" | "doubleDuration" | "halveDuration" | "dotDuration" | "undotDuration" | "setPitch" | "slashGraceNotes" | "addGraceNote" | "removeGraceNote" | "playScore" | "stopPlayer" | "pausePlayer" | "togglePlayer" | "undo" | "copy" | "paste" | "makeTuplet" | "interval" | "unmakeTuplet" | "addMeasure" | "deleteNote" | "makeRest" | "unbeamSelections" | "beamSelections" | "toggleBeamDirection" | "addRemoveAccent" | "addRemoveTenuto" | "addRemoveStaccato" | "addRemovePizzicato" | "addRemoveMarcato";
+export declare const editorKeyActions: string[];
+export declare function isEditorKeyAction(action: string): boolean;
+export declare function isTrackerKeyAction(action: string): boolean;
+/**
+ * A binding of a key to some action performed by a module
+ * @category SuiApplication
+ */
+export interface KeyBinding {
+    event: string;
+    key: string;
+    ctrlKey: boolean;
+    altKey: boolean;
+    shiftKey: boolean;
+    action: string;
+    module?: string;
+}
+/**
+ * parameters for the key handlers
+ * @param view
+ * @param slashMode indicates that the dreaded 'slash' menus are up
+ * @param completeNotifier notified  when modals close
+ * @param tracker
+ * @param eventSource register for event handlers
+ * @category SuiApplication
+ */
+export interface KeyCommandParams {
+    view: SuiScoreViewOperations;
+    slashMode: boolean;
+    completeNotifier: CompleteNotifier;
+    tracker: SuiTracker;
+    eventSource: BrowserEventSource;
+}
+/**
+ * Shared interface for menus, dialogs, etc that can
+ * accept UI events
+ * @category SuiApplication
+ */
+export declare abstract class ModalEventHandler {
+    abstract mouseMove(ev: any): void;
+    abstract mouseClick(ev: any): Promise<void>;
+    abstract evKey(evdata: any): Promise<void>;
+    abstract keyUp(evdata: any): void;
+}
+export type handler = (ev: any) => void;
+/**
+ * Dependency injection, sends events to a proxy object, gets around some
+ * cyclic dependencies when bootstrapping the application.
+ * @category SuiApplication
+ */
+export declare class ModalEventHandlerProxy {
+    _handler: ModalEventHandler | null;
+    eventSource: BrowserEventSource;
+    unbound: boolean;
+    keydownHandler: EventHandler | null;
+    keyupHandler: EventHandler | null;
+    mouseMoveHandler: EventHandler | null;
+    mouseClickHandler: EventHandler | null;
+    constructor(evSource: BrowserEventSource);
+    set handler(value: ModalEventHandler);
+    evKey(ev: any): Promise<void>;
+    keyUp(ev: any): void;
+    mouseMove(ev: any): void;
+    mouseClick(ev: any): Promise<void>;
+    bindEvents(): void;
+    unbindKeyboardForModal(dialog: ModalComponent): void;
+}

package/types/src/application/configuration.d.ts

@@ -1,74 +1,74 @@
-/**
- * Superset of configuration required to initialize Smoosic, either the appliation or library.
- * @module configuration
- */
-import { SmoRenderConfiguration } from "../render/sui/configuration";
-import { SmoScore } from "../smo/data/score";
-import { ModalEventHandler } from "./common";
-import { KeyBindingConfiguration, SmoUiConfiguration } from "../ui/configuration";
-import { RibbonLayout } from "../ui/common";
-import { ButtonDefinition } from "../ui/buttons/button";
-import { SuiAudioAnimationParams } from "../render/audio/musicCursor";
-export type SmoMode = 'library' | 'application' | 'translate';
-export type ConfigurationStringOption = 'language' | 'libraryUrl' | 'remoteScore';
-export type ConfigurationNumberOption = 'demonPollTime' | 'idleRedrawTime';
-export declare var ConfigurationStringOptions: ConfigurationStringOption[];
-export declare var ConfigurationNumberOptions: ConfigurationNumberOption[];
-/**
- * Application configuration parameters, can be referenced by the running application or changed
- * @category SuiApplication
- */
-export interface SmoConfigurationParams {
-    mode: SmoMode;
-    smoPath?: string;
-    language: string;
-    initialScore?: string | SmoScore;
-    remoteScore?: string;
-    domContainer: string | HTMLElement;
-    scoreDomContainer: string | HTMLElement;
-    leftControls?: string | HTMLElement;
-    topControls?: string | HTMLElement;
-    libraryUrl?: string;
-    demonPollTime: number;
-    idleRedrawTime: number;
-    ribbonLayout?: RibbonLayout;
-    buttonDefinition?: ButtonDefinition[];
-    audioAnimation: SuiAudioAnimationParams;
-}
-/**
- * Configures smoosic library or application. It is a union of UI, rendering and application configuration parameters
- * @param mode - score mode `'library' | 'application' | 'translate'`
- *   Library mode starts the view but not the UI.  application mode starts the UI and expects UI parameters.
- *   translation mode is the translation editor, for creating translations for dialog/menu components
- * @param language - startup language
- * @param initialScore? - the library score JSON, if you are loading from a JSON string, or a SmoScore object
- * @param remoteScore? - path to a remote score, if loading from an URL
- * @param scoreDomContainer - the parent of the svg container (required)
- * @param leftControls - the location of the vertical button control, applies if mode is 'application'
- * @param topControls - the location of the horizontal button control, applies if mode is 'application'
- * @param libraryUrl - loader URL for Smo libraries, applies if application mode
- * @param demonPollTime - how often we poll the score to see if it's changed
- * @param idleRedrawTime - how often the entire score re-renders
- * @category SuiApplication
- */
-export declare class SmoConfiguration implements SmoRenderConfiguration, SmoUiConfiguration {
-    mode: SmoMode;
-    language: string;
-    domContainer?: string | HTMLElement;
-    initialScore?: string | SmoScore;
-    remoteScore?: string;
-    leftControls?: string | HTMLElement;
-    topControls?: string | HTMLElement;
-    scoreDomContainer: string | HTMLElement;
-    libraryUrl?: string;
-    demonPollTime: number;
-    idleRedrawTime: number;
-    keys?: KeyBindingConfiguration;
-    eventHandler?: ModalEventHandler;
-    ribbonLayout: RibbonLayout;
-    audioAnimation: SuiAudioAnimationParams;
-    buttonDefinition: ButtonDefinition[];
-    static get defaults(): SmoConfiguration;
-    static get keyBindingDefaults(): KeyBindingConfiguration;
-    constructor(params: Partial<SmoConfigurationParams>);
-}
+/**
+ * Superset of configuration required to initialize Smoosic, either the appliation or library.
+ * @module configuration
+ */
+import { SmoRenderConfiguration } from "../render/sui/configuration";
+import { SmoScore } from "../smo/data/score";
+import { ModalEventHandler } from "./common";
+import { KeyBindingConfiguration, SmoUiConfiguration } from "../ui/configuration";
+import { RibbonLayout } from "../ui/common";
+import { ButtonDefinition } from "../ui/buttons/button";
+import { SuiAudioAnimationParams } from "../render/audio/musicCursor";
+export type SmoMode = 'library' | 'application' | 'translate';
+export type ConfigurationStringOption = 'language' | 'libraryUrl' | 'remoteScore';
+export type ConfigurationNumberOption = 'demonPollTime' | 'idleRedrawTime';
+export declare var ConfigurationStringOptions: ConfigurationStringOption[];
+export declare var ConfigurationNumberOptions: ConfigurationNumberOption[];
+/**
+ * Application configuration parameters, can be referenced by the running application or changed
+ * @category SuiApplication
+ */
+export interface SmoConfigurationParams {
+    mode: SmoMode;
+    smoPath?: string;
+    language: string;
+    initialScore?: string | SmoScore;
+    remoteScore?: string;
+    domContainer: string | HTMLElement;
+    scoreDomContainer: string | HTMLElement;
+    leftControls?: string | HTMLElement;
+    topControls?: string | HTMLElement;
+    libraryUrl?: string;
+    demonPollTime: number;
+    idleRedrawTime: number;
+    ribbonLayout?: RibbonLayout;
+    buttonDefinition?: ButtonDefinition[];
+    audioAnimation: SuiAudioAnimationParams;
+}
+/**
+ * Configures smoosic library or application. It is a union of UI, rendering and application configuration parameters
+ * @param mode - score mode `'library' | 'application' | 'translate'`
+ *   Library mode starts the view but not the UI.  application mode starts the UI and expects UI parameters.
+ *   translation mode is the translation editor, for creating translations for dialog/menu components
+ * @param language - startup language
+ * @param initialScore? - the library score JSON, if you are loading from a JSON string, or a SmoScore object
+ * @param remoteScore? - path to a remote score, if loading from an URL
+ * @param scoreDomContainer - the parent of the svg container (required)
+ * @param leftControls - the location of the vertical button control, applies if mode is 'application'
+ * @param topControls - the location of the horizontal button control, applies if mode is 'application'
+ * @param libraryUrl - loader URL for Smo libraries, applies if application mode
+ * @param demonPollTime - how often we poll the score to see if it's changed
+ * @param idleRedrawTime - how often the entire score re-renders
+ * @category SuiApplication
+ */
+export declare class SmoConfiguration implements SmoRenderConfiguration, SmoUiConfiguration {
+    mode: SmoMode;
+    language: string;
+    domContainer?: string | HTMLElement;
+    initialScore?: string | SmoScore;
+    remoteScore?: string;
+    leftControls?: string | HTMLElement;
+    topControls?: string | HTMLElement;
+    scoreDomContainer: string | HTMLElement;
+    libraryUrl?: string;
+    demonPollTime: number;
+    idleRedrawTime: number;
+    keys?: KeyBindingConfiguration;
+    eventHandler?: ModalEventHandler;
+    ribbonLayout: RibbonLayout;
+    audioAnimation: SuiAudioAnimationParams;
+    buttonDefinition: ButtonDefinition[];
+    static get defaults(): SmoConfiguration;
+    static get keyBindingDefaults(): KeyBindingConfiguration;
+    constructor(params: Partial<SmoConfigurationParams>);
+}

package/types/src/application/dom.d.ts

@@ -1,8 +1,8 @@
-/**
- * Construct the DOM scaffolding for the application
- * @category SuiApplication
- */
-export declare class SuiDom {
-    static get scrollRegionId(): string;
-    static createUiDom(uiDomContainer: HTMLElement | string | undefined): HTMLElement;
-}
+/**
+ * Construct the DOM scaffolding for the application
+ * @category SuiApplication
+ */
+export declare class SuiDom {
+    static get scrollRegionId(): string;
+    static createUiDom(uiDomContainer: HTMLElement | string | undefined): HTMLElement;
+}

package/types/src/application/dynamicInit.d.ts

@@ -1 +1 @@
-export declare const dynamicCtorInit: () => void;
+export declare const dynamicCtorInit: () => void;