Revise all type definitions and how they import/export

ChrisMBarr · Jun 12, 2023 · 72bab7a · 72bab7a
1 parent 8562423
commit 72bab7a
Show file tree

Hide file tree

Showing 15 changed files with 947 additions and 920 deletions.
diff --git a/README.md b/README.md
@@ -21,11 +21,10 @@ Simply import `OpenLyricsParser`, then pass the contents of an OpenLyrics XML fi
 ### For TypeScript projects
 ```typescript
 import { readFile } from 'fs';
-import { OpenLyricsParser } from 'openlyrics-parser';
-import { IOpenLyricsSong } from 'openlyrics-parser/dist/main/parser.model';
+import { OpenLyricsParser, IParserRoot } from 'openlyrics-parser';
 
 readFile('example.xml', (contents): void => {
-  const song: IOpenLyricsSong.IRoot = OpenLyricsParser(contents.toString());
+  const song: IParserRoot = OpenLyricsParser(contents.toString());
   console.log(song);
 });
 ```
@@ -49,10 +48,9 @@ Simply import `OpenLyricsBuilder`, then pass the song data to it, and it will re
 
 ### For TypeScript projects
 ```typescript
-import { OpenLyricsBuilder } from 'openlyrics-parser';
-import { INewOpenLyricsSong } from 'openlyrics-parser/dist/main/builder.model';
+import { OpenLyricsBuilder, IBuilderOptions } from 'openlyrics-parser';
 
-const opts: INewOpenLyricsSong.IOptions = {
+const opts: IBuilderOptions = {
   properties: { titles: 'Amazing Grace' },
   verses: [
     {

diff --git a/docs/Builder.md b/docs/Builder.md
diff --git a/docs/Parser.md b/docs/Parser.md
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "openlyrics-parser",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Parses and extracts data from OpenLyrics files, and creates them!",
   "main": "dist/main/index.js",
   "typings": "dist/main/index.d.ts",
@@ -86,7 +86,7 @@
   },
   "devDependencies": {
     "@types/jest": "^29.5.2",
-    "@types/node": "^20.2.6",
+    "@types/node": "^20.3.0",
     "@typescript-eslint/eslint-plugin": "^5.59.9",
     "@typescript-eslint/parser": "^5.59.9",
     "eslint": "^8.42.0",