dasha 2.0.0 → 2.0.1

package/README.md

@@ -1,23 +1,15 @@
 # Dasha
 
-Dasha is a simple parser for MPD manifests.
-
-## Installing
-
-**Requirements**
-
-- [Node.js](https://nodejs.org) v16 or greater
-- npm v8
+[![npm version](https://img.shields.io/npm/v/dasha)](https://www.npmjs.com/package/dasha)
+[![npm downloads/month](https://img.shields.io/npm/dm/dasha)](https://www.npmjs.com/package/dasha)
+[![npm downloads](https://img.shields.io/npm/dt/dasha)](https://www.npmjs.com/package/dasha)
 
-**Install dependencies**
-
-```bash
-npm i
-```
+Dasha is a simple parser for MPD manifests.
 
-## Usage examples
+## Usage
 
-**Parse manifest and get tracks with selected video height**
+- Install: `npm install dasha`
+- Require: `const { parseManifest } = require('dasha');`
 
 ```javascript
 const { parseManifest } = require('./dasha');
@@ -27,33 +19,31 @@ const rawManifest = `
   <MPD xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     ...
   </MPD>
-`
+`;
 const manifest = parseManifest(rawManifest);
 const targetHeight = 1080;
-const targetAudioLanguages = ['rus']
+const targetAudioLanguages = ['rus'];
 const videoTrack = manifest.getVideoTrack(targetHeight);
 const audioTracks = manifest.getAudioTracks(targetAudioLanguages);
 const tracks = [videoTrack, ...audioTracks];
 ```
 
-**Tracks structure**
-
 ```typescript
 type VideoTrack = {
-  type: "video",
-  segments: { url: string, init: boolean }[],
-  bitrate: number, // Kbps
-  size: number, // MB
-  width: number,
-  height: number,
-  quality: "SD" | "HD" | "Full HD",
-}
+  type: 'video';
+  segments: { url: string; init: boolean }[];
+  bitrate: number; // Kbps
+  size: number; // MB
+  width: number;
+  height: number;
+  quality: 'SD' | 'HD' | 'Full HD' | '4K' : '8K';
+};
 
 type AudioTrack = {
-  type: "audio",
-  segments: { url: string, init: boolean }[],
-  bitrate: number, // Kbps
-  size: number, // MB
-  audioSampleRate: number // kHz
-}
+  type: 'audio';
+  segments: { url: string; init: boolean }[];
+  bitrate: number; // Kbps
+  size: number; // MB
+  audioSampleRate: number; // kHz
+};
 ```

package/lib/utils.js

@@ -35,11 +35,14 @@ const parseDuration = (durationString) => {
 };
 
 const getQualityLabel = (videoHeight) => {
-  let quality = 'SD';
-  if (videoHeight >= 720) quality = 'HD';
-  if (videoHeight >= 1080) quality = 'Full HD';
-  if (videoHeight >= 2016) quality = '4K';
-  return quality;
+  const height = typeof videoHeight === 'number' ? videoHeight : parseInt(videoHeight);
+  if (isNaN(height)) return;
+  let label = 'SD';
+  if (height >= 720) label = 'HD';
+  if (height >= 1080) label = 'Full HD';
+  if (height >= 2160) label = '4K';
+  if (height >= 4320) label = '8K';
+  return label;
 };
 
 module.exports = { parseDuration, getQualityLabel };

package/package.json

@@ -1,12 +1,32 @@
 {
   "name": "dasha",
-  "version": "2.0.0",
+  "version": "2.0.1",
+  "author": "Vitaliy Gashkov <vitnore@gmail.com>",
   "description": "Simple MPEG-DASH MPD parser",
   "license": "Apache-2.0",
-  "author": "vitnore",
+  "keywords": [
+    "mpeg",
+    "dash",
+    "adaptive",
+    "mpd",
+    "manifest"
+  ],
   "main": "dasha.js",
+  "types": "types/dasha.d.ts",
+  "files": [
+    "lib",
+    "types"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vitnore/dasha.git"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/vitnore"
+  },
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
+    "test": "jest",
     "types": "tsc -p tsconfig.json",
     "lint": "eslint \"**/*.js\" --fix",
     "lint:check": "eslint \"**/*.js\"",
@@ -19,6 +39,7 @@
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-import": "^2.25.4",
     "eslint-plugin-prettier": "^4.0.0",
+    "jest": "^27.5.1",
     "prettier": "^2.5.1",
     "typescript": "^4.5.5"
   }

package/types/dasha.d.ts

@@ -0,0 +1,2 @@
+export * from './manifest';
+export * from './constants';

package/types/manifest.d.ts

@@ -3,6 +3,7 @@ import { QualityLabel } from './utils';
 
 declare class Manifest extends ProcessedManifest {
   constructor(manifest: ProcessedManifest);
+
   getVideoTrack(height: number): VideoTrack;
   getAudioTracks(languages: string[]): AudioTrack[];
   getSubtitleTracks(languages: string[]): SubtitleTrack[];

package/.eslintrc.json

@@ -1,9 +0,0 @@
-{
-  "env": { "es2021": true, "node": true },
-  "extends": ["eslint:recommended", "plugin:prettier/recommended"],
-  "parserOptions": { "ecmaVersion": 2021 },
-  "rules": {
-    "arrow-parens": ["error", "always"],
-    "no-unused-vars": "warn"
-  }
-}

package/.prettierrc

@@ -1,7 +0,0 @@
-{
-  "printWidth": 100,
-  "semi": true,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "es5"
-}

package/tsconfig.json

@@ -1,11 +0,0 @@
-{
-  "compilerOptions": {
-    "target": "ESNext",
-    "moduleResolution": "node",
-    "strict": true,
-    "baseUrl": ".",
-    "preserveWatchOutput": true,
-    "skipLibCheck": true
-  },
-  "include": ["types/**/*.ts"]
-}