feat: support typescript

README.md

@@ -1,2 +1,38 @@
+<p align="center">
+  <a href="https://npmjs.com/package/webrtc-streamer-helper"><img src="https://badgen.net/npm/v/webrtc-streamer-helper" alt="npm package"></a>
+  <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/webrtc-streamer-helper">
+  <img alt="GitHub" src="https://img.shields.io/github/license/zhensherlock/webrtc-streamer-helper">
+</p>
+
 # webrtc-streamer-helper
-webrtc streamer helper
+
+> This is a webrtc streamer helper.
+
+## Installing
+
+```bash
+# or pnpm or yarn
+npm install webrtc-streamer-helper
+```
+
+## Usage
+
+```ts
+import { WebRTCStreamer } from 'webrtc-streamer-helper'
+
+const webRtcServer = new WebRTCStreamer({
+  url: 'http://10.57.2.244:8000',
+  element: 'div-1'
+})
+
+webRtcServer.connect(
+  videoUrl,
+  audioUrl,
+  'rtptransport=tcp&timeout=60&width=320&height=0',
+  null
+)()
+```
+
+## License
+
+[MIT](LICENSE).

package.json

@@ -4,7 +4,8 @@
   "description": "webrtc streamer helper",
   "scripts": {
     "dev": "concurrently \"npm run src:dev\"",
-    "src:dev": "rollup -c --watch --bundleConfigAsCjs"
+    "src:dev": "rollup -c --watch --bundleConfigAsCjs",
+    "build": "rollup -c --bundleConfigAsCjs --environment NODE_ENV:production"
   },
   "repository": {
     "type": "git",
@@ -16,6 +17,15 @@
     "url": "https://github.com/zhensherlock/webrtc-streamer-helper/issues"
   },
   "homepage": "https://github.com/zhensherlock/webrtc-streamer-helper#readme",
+  "keywords": [
+    "webrtc-streamer",
+    "webrtc-streamer-helper"
+  ],
+  "main": "dist/index.cjs.js",
+  "module": "dist/index.esm.js",
+  "browser": "dist/index.browser.js",
+  "unpkg": "",
+  "types": "dist/types/main.d.ts",
   "devDependencies": {
     "@rollup/plugin-babel": "^6.0.3",
     "@rollup/plugin-eslint": "^9.0.3",

rollup.config.js

@@ -13,35 +13,49 @@ import cssnano from 'cssnano'
 const output = [
   {
     format: 'esm',
-    file: 'dist/webrtc-streamer-helper.esm.js'
+    file: 'dist/index.esm.js',
+    sourcemap: true
   },
   {
     format: 'umd',
     name: 'WebrtcStreamerHelper',
-    file: 'dist/webrtc-streamer-helper.umd.js'
+    file: 'dist/index.umd.js',
+    sourcemap: true
   },
   {
     format: 'iife',
     name: 'WebrtcStreamerHelper',
-    file: 'dist/webrtc-streamer-helper.browser.js'
+    file: 'dist/index.browser.js',
+    sourcemap: true
   },
+  {
+    format: 'cjs',
+    file: 'dist/index.cjs.js',
+    sourcemap: true
+  },
+  // min
   {
     format: 'esm',
-    file: 'dist/webrtc-streamer-helper.esm.min.js',
+    file: 'dist/index.esm.min.js',
     plugins: [terser()]
   },
   {
     format: 'umd',
     name: 'WebrtcStreamerHelper',
-    file: 'dist/webrtc-streamer-helper.umd.min.js',
+    file: 'dist/index.umd.min.js',
     plugins: [terser()]
   },
   {
     format: 'iife',
     name: 'WebrtcStreamerHelper',
-    file: 'dist/webrtc-streamer-helper.browser.min.js',
+    file: 'dist/index.browser.min.js',
     plugins: [terser()]
-  }
+  },
+  {
+    format: 'cjs',
+    file: 'dist/index.cjs.min.js',
+    plugins: [terser()]
+  },
 ]
 
 export default [

src/core/webRTCStreamer.ts

@@ -1,6 +1,9 @@
 import { WebRTCStreamerOptions } from '../types'
 import { initialOptions } from '../utils/initialization'
 
+/**
+ * Interface with WebRTC-streamer API
+ */
 export default class WebRTCStreamer {
   private element?: Element
   private options: WebRTCStreamerOptions
@@ -12,8 +15,16 @@ export default class WebRTCStreamer {
   private earlyCandidates: RTCIceCandidate[] = []
   private srcObject: any
 
+  /**
+   * Instantiate object
+   * @constructor
+   * @param args
+   */
   constructor (args: Partial<WebRTCStreamerOptions> = {}) {
     this.options = Object.assign({}, initialOptions, args)
+    if (!this.options.url) {
+      this.options.url = `${window.location.protocol}//${window.location.hostname}:${window.location.port}`
+    }
     this.changeElement(this.options.element)
   }
 

src/main.ts

@@ -1,4 +1,6 @@
 import WebRTCStreamer from './core/webRTCStreamer'
 import './style'
 
-export default WebRTCStreamer
+export {
+  WebRTCStreamer
+}

src/types/index.ts

@@ -1,4 +1,10 @@
 export interface WebRTCStreamerOptions {
+  /**
+   * id of the video element tag
+   */
   element: Element | string;
+  /**
+   * url of webrtc-streamer (default is current location)
+   */
   url: string;
 }

src/utils/initialization.ts

@@ -2,5 +2,5 @@ import type { WebRTCStreamerOptions } from '../types'
 
 export const initialOptions: WebRTCStreamerOptions = {
   element: '',
-  url: `${location.protocol}//${location.hostname}:${location.port}`
+  url: ''
 }

tsconfig.json

@@ -4,7 +4,7 @@
     "target": "es5",
     "declaration": true,
     "emitDeclarationOnly": true,
-    "outDir": "./dist",
+    "outDir": "./dist/types",
     "moduleResolution": "node",
     "esModuleInterop": true,
     "strict": true,