Explorar o código

feat(export): export all classes for TS import (#458)

set webpack typings directory to main index.ts
tested in webscript-usage-example project,
can e.g. import and use Cursor, Note, VoiceEntry

index.ts files created via create-ts-index
Simon %!s(int64=6) %!d(string=hai) anos
pai
achega
3364b52289

+ 1 - 1
package.json

@@ -3,7 +3,7 @@
   "version": "0.6.3",
   "description": "An open source JavaScript engine for displaying MusicXML based on VexFlow.",
   "main": "build/opensheetmusicdisplay.min.js",
-  "typings": "build/dist/src/OpenSheetMusicDisplay/OpenSheetMusicDisplay",
+  "typings": "build/dist/src/",
   "scripts": {
     "docs": "typedoc --out ./build/docs --name OpenSheetMusicDisplay --module commonjs --target ES5 --ignoreCompilerErrors --mode file ./src",
     "eslint": "eslint .",

+ 10 - 0
src/Common/DataObjects/index.ts

@@ -0,0 +1,10 @@
+// created from 'create-ts-index'
+
+export * from "./Fraction";
+export * from "./Matrix2D";
+export * from "./MusicSheetErrors";
+export * from "./OSMDColor";
+export * from "./Pitch";
+export * from "./PointF2D";
+export * from "./RectangleF2D";
+export * from "./SizeF2D";

+ 5 - 0
src/Common/Enums/index.ts

@@ -0,0 +1,5 @@
+// created from 'create-ts-index'
+
+export * from "./FontStyles";
+export * from "./Fonts";
+export * from "./TextAlignment";

+ 4 - 0
src/Common/FileIO/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from "./Mxl";
+export * from "./Xml";

+ 3 - 0
src/Common/Strings/index.ts

@@ -0,0 +1,3 @@
+// created from 'create-ts-index'
+
+export * from "./StringUtil";

+ 3 - 0
src/Common/index.ts

@@ -0,0 +1,3 @@
+export * from "./DataObjects/Fraction";
+export * from "./DataObjects/Pitch";
+export * from "./Enums";

+ 22 - 0
src/MusicalScore/Graphical/VexFlow/index.ts

@@ -0,0 +1,22 @@
+// created from 'create-ts-index'
+
+export * from "./CanvasVexFlowBackend";
+export * from "./SvgVexFlowBackend";
+export * from "./VexFlowBackend";
+export * from "./VexFlowContinuousDynamicExpression";
+export * from "./VexFlowConverter";
+export * from "./VexFlowGraphicalNote";
+export * from "./VexFlowGraphicalSymbolFactory";
+export * from "./VexFlowInstantaneousDynamicExpression";
+export * from "./VexFlowInstrumentBrace";
+export * from "./VexFlowInstrumentBracket";
+export * from "./VexFlowMeasure";
+export * from "./VexFlowMusicSheetCalculator";
+export * from "./VexFlowMusicSheetDrawer";
+export * from "./VexFlowMusicSystem";
+export * from "./VexFlowOctaveShift";
+export * from "./VexFlowSlur";
+export * from "./VexFlowStaffEntry";
+export * from "./VexFlowStaffLine";
+export * from "./VexFlowTextMeasurer";
+export * from "./VexFlowVoiceEntry";

+ 51 - 0
src/MusicalScore/Graphical/index.ts

@@ -0,0 +1,51 @@
+// created from 'create-ts-index'
+
+export * from "./AbstractGraphicalExpression";
+export * from "./AbstractGraphicalInstruction";
+export * from "./AccidentalCalculator";
+export * from "./AlignmentManager";
+export * from "./BoundingBox";
+export * from "./Clickable";
+export * from "./DrawingEnums";
+export * from "./DrawingMode";
+export * from "./DrawingParameters";
+export * from "./EngravingRules";
+export * from "./GraphicalChordSymbolContainer";
+export * from "./GraphicalComment";
+export * from "./GraphicalContinuousDynamicExpression";
+export * from "./GraphicalCurve";
+export * from "./GraphicalInstantaneousDynamicExpression";
+export * from "./GraphicalInstantaneousTempoExpression";
+export * from "./GraphicalLabel";
+export * from "./GraphicalLine";
+export * from "./GraphicalLyricEntry";
+export * from "./GraphicalLyricWord";
+export * from "./GraphicalMarkedArea";
+export * from "./GraphicalMeasure";
+export * from "./GraphicalMusicPage";
+export * from "./GraphicalMusicSheet";
+export * from "./GraphicalNote";
+export * from "./GraphicalObject";
+export * from "./GraphicalOctaveShift";
+export * from "./GraphicalRectangle";
+export * from "./GraphicalSlur";
+export * from "./GraphicalStaffEntry";
+export * from "./GraphicalStaffEntryLink";
+export * from "./GraphicalTie";
+export * from "./GraphicalVoiceEntry";
+export * from "./ISqueezable";
+export * from "./MusicSheetCalculator";
+export * from "./MusicSheetDrawer";
+export * from "./MusicSymbol";
+export * from "./MusicSystem";
+export * from "./MusicSystemBuilder";
+export * from "./OctaveShiftParams";
+export * from "./SelectionEndSymbol";
+export * from "./SelectionStartSymbol";
+export * from "./SkyBottomLineCalculator";
+export * from "./StaffLine";
+export * from "./StaffLineActivitySymbol";
+export * from "./SystemLine";
+export * from "./SystemLinePosition";
+export * from "./SystemLinesEnum";
+export * from "./VerticalGraphicalStaffEntryContainer";

+ 8 - 0
src/MusicalScore/Interfaces/index.ts

@@ -0,0 +1,8 @@
+// created from 'create-ts-index'
+
+export * from "./IAfterSheetReadingModule";
+export * from "./IGraphicalSymbolFactory";
+export * from "./IQualityFeedbackTone";
+export * from "./ITextMeasurer";
+export * from "./ITextTranslation";
+export * from "./ITransposeCalculator";

+ 4 - 0
src/MusicalScore/MusicParts/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from "./MusicPartManager";
+export * from "./MusicPartManagerIterator";

+ 6 - 0
src/MusicalScore/MusicSource/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./MappingSourceMusicPart";
+export * from "./PartListEntry";
+export * from "./Repetition";
+export * from "./SourceMusicPart";

+ 9 - 0
src/MusicalScore/ScoreIO/MusicSymbolModules/index.ts

@@ -0,0 +1,9 @@
+// created from 'create-ts-index'
+
+export * from "./ArticulationReader";
+export * from "./ChordSymbolReader";
+export * from "./ExpressionReader";
+export * from "./LyricsReader";
+export * from "./RepetitionCalculator";
+export * from "./RepetitionInstructionReader";
+export * from "./SlurReader";

+ 6 - 0
src/MusicalScore/ScoreIO/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./InstrumentReader";
+export * from "./MusicSheetReader";
+export * from "./MusicSymbolModuleFactory";
+export * from "./VoiceGenerator";

+ 6 - 0
src/MusicalScore/VoiceData/Expressions/ContinuousExpressions/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./ContinuousDynamicExpression";
+export * from "./ContinuousTempoExpression";
+export * from "./OctaveShift";
+export * from "./Slur";

+ 11 - 0
src/MusicalScore/VoiceData/Expressions/index.ts

@@ -0,0 +1,11 @@
+// created from 'create-ts-index'
+
+export * from "./AbstractExpression";
+export * from "./AbstractTempoExpression";
+export * from "./DynamicExpressionSymbolEnum";
+export * from "./InstantaneousDynamicExpression";
+export * from "./InstantaneousTempoExpression";
+export * from "./MoodExpression";
+export * from "./MultiExpression";
+export * from "./MultiTempoExpression";
+export * from "./UnknownExpression";

+ 3 - 0
src/MusicalScore/VoiceData/HelperObjects/index.ts

@@ -0,0 +1,3 @@
+// created from 'create-ts-index'
+
+export * from "./DynamicsContainer";

+ 8 - 0
src/MusicalScore/VoiceData/Instructions/index.ts

@@ -0,0 +1,8 @@
+// created from 'create-ts-index'
+
+export * from "./AbstractNotationInstruction";
+export * from "./ClefInstruction";
+export * from "./KeyInstruction";
+export * from "./RepetitionInstruction";
+export * from "./RhythmInstruction";
+export * from "./TechnicalInstruction";

+ 4 - 0
src/MusicalScore/VoiceData/Lyrics/index.ts

@@ -0,0 +1,4 @@
+// created from 'create-ts-index'
+
+export * from "./LyricsEntry";
+export * from "./LyricsWord";

+ 18 - 0
src/MusicalScore/VoiceData/index.ts

@@ -0,0 +1,18 @@
+// created from 'create-ts-index'
+
+export * from "./Arpeggio";
+export * from "./Beam";
+export * from "./ChordSymbolContainer";
+export * from "./LinkedVoice";
+export * from "./Note";
+export * from "./Notehead";
+export * from "./OrnamentContainer";
+export * from "./SourceMeasure";
+export * from "./SourceStaffEntry";
+export * from "./Staff";
+export * from "./StaffEntryLink";
+export * from "./Tie";
+export * from "./Tuplet";
+export * from "./VerticalSourceStaffEntryContainer";
+export * from "./Voice";
+export * from "./VoiceEntry";

+ 9 - 0
src/MusicalScore/index.ts

@@ -0,0 +1,9 @@
+// created from 'create-ts-index'
+
+export * from "./Exceptions";
+export * from "./Instrument";
+export * from "./InstrumentalGroup";
+export * from "./Label";
+export * from "./MusicSheet";
+export * from "./SubInstrument";
+export * from "./VoiceData";

+ 6 - 0
src/OpenSheetMusicDisplay/index.ts

@@ -0,0 +1,6 @@
+// created from 'create-ts-index'
+
+export * from "./AJAX";
+export * from "./Cursor";
+export * from "./OSMDOptions";
+export * from "./OpenSheetMusicDisplay";

+ 5 - 0
src/Util/index.ts

@@ -0,0 +1,5 @@
+// created from 'create-ts-index'
+
+export * from "./BaseIdClass";
+export * from "./CollectionUtil";
+export * from "./PSMath";

+ 4 - 0
src/index.ts

@@ -0,0 +1,4 @@
+export * from "./OpenSheetMusicDisplay";
+export * from "./MusicalScore";
+export * from "./Util";
+export * from "./Common";

+ 2 - 1
webpack.common.js

@@ -4,7 +4,7 @@ var webpack = require('webpack')
 
 module.exports = {
     entry: {
-        'opensheetmusicdisplay': './src/OpenSheetMusicDisplay/OpenSheetMusicDisplay.ts', // Main library
+        'opensheetmusicdisplay': './src/index.ts', // Main index (OpenSheetMusicDisplay and other classes)
         'demo': './demo/index.js' // Demo index
     },
     output: {
@@ -23,6 +23,7 @@ module.exports = {
             {
                 test: /\.ts$/,
                 loader: 'ts-loader',
+                // loader: 'awesome-typescript-loader',
                 exclude: /(node_modules|bower_components)/
             }
         ]