{"_id":"@carbyne/sip.js","_rev":"8-aab940684e4b3d509ac8ce0f93fa76f3","name":"@carbyne/sip.js","dist-tags":{"latest":"0.21.2-2"},"versions":{"0.21.2":{"name":"@carbyne/sip.js","version":"0.21.2","keywords":["sip","webrtc","library","websocket","javascript","typescript"],"author":{"url":"https://sipjs.com/aboutus/","name":"OnSIP","email":"developer@onsip.com"},"license":"MIT","_id":"@carbyne/sip.js@0.21.2","maintainers":[{"name":"netanelb_carbyne.com","email":"netanelb@carbyne.com"},{"name":"slavikb","email":"slavikb@carbyne.com"}],"contributors":[{"url":"https://github.com/onsip/SIP.js/blob/master/THANKS.md","name":"Contributors"}],"homepage":"https://sipjs.com","bugs":{"url":"https://github.com/onsip/SIP.js/issues"},"dist":{"shasum":"c354a49af41a1d226d81290ed5fcc3cf9458bd66","tarball":"https://registry.npmjs.org/@carbyne/sip.js/-/sip.js-0.21.2.tgz","fileCount":389,"integrity":"sha512-q/xKGytYQRhQMceJbXh0ePtSyqfAUmgXzbZkrUsZaujgpr+svgZLasF74MVQuKa19SX05M65cM7UYzZcrUqhoA==","signatures":[{"sig":"MEUCIH5T2DrX4Zzu3iKUoQhPpoVw51ttWSqG+yGqtpdd470fAiEA9rIUKaCd8h0nRCSc3pqGG3tBPSXKBxvf55I1unMIZsk=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1276898},"main":"./lib/index.js","type":"module","title":"SIP.js","types":"./lib/index.d.ts","module":"./lib/index.js","engines":{"node":">=10.0"},"gitHead":"81aaaf331baee5265f1f1a1f2df3aab24943c6a8","scripts":{"lint":"eslint --ext .ts .","test":"npm run build-test && karma start karma.conf.cjs --reporters mocha --browsers ChromeHeadlessFakeMediaStream --single-run","build":"npm run generate-grammar && npm run build-lib","version":"sed -i '' \"s/LIBRARY_VERSION = .*/LIBRARY_VERSION = \\\"$npm_package_version\\\";/\" src/version.ts","lint-fix":"eslint --ext .ts --fix .","prebuild":"npm run lint","build-lib":"tsc -p src","build-demo":"npm run build && webpack --progress --config demo/webpack.config.cjs","build-docs":"npm run build-lib && npm run build-docs-api && npm run build-docs-core && npm run build-docs-session-description-handler && npm run build-docs-session-manager && npm run build-docs-simple-user && npm run build-docs-transport","build-test":"tsc -p test","extract-api":"api-extractor run --local --verbose --config src/api/api-extractor.json","document-api":"api-documenter markdown --input-folder ./temp/api --output-folder ./temp/docs/api","extract-core":"api-extractor run --local --verbose --config src/core/api-extractor.json","test-browser":"npm run build-test && sleep 2 && (open http://localhost:9876/debug.html &) && karma start karma.conf.cjs --reporters kjhtml --no-single-run","build-bundles":"npm run build-reg-bundle && npm run build-min-bundle && npm run copy-dist-files","document-core":"api-documenter markdown --input-folder ./temp/core --output-folder ./temp/docs/core","build-and-test":"npm run build && npm run test","build-docs-api":"npm run extract-api && npm run document-api && npm run document-copy-api","build-docs-core":"npm run extract-core && npm run document-core && npm run document-copy-core","copy-dist-files":"cp dist/sip.js dist/sip-$npm_package_version.js && cp dist/sip.min.js dist/sip-$npm_package_version.min.js","build-min-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=min","build-reg-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=reg","generate-grammar":"node build/grammarGenerator.cjs","document-copy-api":"rm -rf ./docs/api/sip.js.* && cp ./temp/docs/api/* ./docs/api","extract-transport":"api-extractor run --local --verbose --config src/platform/web/transport/api-extractor.json","document-copy-core":"rm -rf ./docs/core/sip.js.* && cp ./temp/docs/core/* ./docs/core","document-transport":"api-documenter markdown --input-folder ./temp/transport --output-folder ./temp/docs/transport","extract-simple-user":"api-extractor run --local --verbose --config src/platform/web/simple-user/api-extractor.json","build-docs-transport":"npm run extract-transport && npm run document-transport && npm run document-copy-transport","document-simple-user":"api-documenter markdown --input-folder ./temp/simple-user --output-folder ./temp/docs/simple-user","build-and-test-browser":"npm run build && npm run test-browser","build-docs-simple-user":"npm run extract-simple-user && npm run document-simple-user && npm run document-copy-simple-user","document-copy-transport":"rm -rf ./docs/transport/sip.js.* && cp ./temp/docs/transport/* ./docs/transport","extract-session-manager":"api-extractor run --local --verbose --config src/platform/web/session-manager/api-extractor.json","document-session-manager":"api-documenter markdown --input-folder ./temp/session-manager --output-folder ./temp/docs/session-manager","document-copy-simple-user":"rm -rf ./docs/simple-user/sip.js.* && cp ./temp/docs/simple-user/* ./docs/simple-user","build-docs-session-manager":"npm run extract-session-manager && npm run document-session-manager && npm run document-copy-session-manager","document-copy-session-manager":"rm -rf ./docs/session-manager/sip.js.* && cp ./temp/docs/session-manager/* ./docs/session-manager","extract-session-description-handler":"api-extractor run --local --verbose --config src/platform/web/session-description-handler/api-extractor.json","document-session-description-handler":"api-documenter markdown --input-folder ./temp/session-description-handler --output-folder ./temp/docs/session-description-handler","build-docs-session-description-handler":"npm run extract-session-description-handler && npm run document-session-description-handler && npm run document-copy-session-description-handler","document-copy-session-description-handler":"rm -rf ./docs/session-description-handler/sip.js.* && cp ./temp/docs/session-description-handler/* ./docs/session-description-handler"},"_npmUser":{"name":"slavikb","email":"slavikb@carbyne.com"},"repository":{"url":"git+https://github.com/onsip/SIP.js.git","type":"git"},"_npmVersion":"8.19.3","description":"A SIP library for JavaScript","directories":{},"sideEffects":false,"_nodeVersion":"16.19.1","_hasShrinkwrap":false,"devDependencies":{"karma":"^6.4.1","peggy":"^1.2.0","eslint":"^8.25.0","webpack":"^5.74.0","prettier":"^2.7.1","ts-pegjs":"^1.2.2","karma-cli":"^2.0.0","ts-loader":"^9.4.1","typescript":"^4.8.4","mock-socket":"^9.1.5","webpack-cli":"^4.10.0","jasmine-core":"^4.4.0","karma-jasmine":"^5.1.0","karma-webpack":"^5.0.0","@types/jasmine":"^4.3.0","karma-mocha-reporter":"^2.2.5","karma-chrome-launcher":"^3.1.1","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","karma-sourcemap-loader":"^0.3.8","@microsoft/api-extractor":"7.7.11","@microsoft/api-documenter":"^7.19.22","@typescript-eslint/parser":"^5.40.1","circular-dependency-plugin":"^5.2.2","eslint-plugin-tree-shaking":"^1.10.0","karma-jasmine-html-reporter":"^2.0.0","@typescript-eslint/eslint-plugin":"^5.40.1"},"_npmOperationalInternal":{"tmp":"tmp/sip.js_0.21.2_1700993978681_0.5938634602037174","host":"s3://npm-registry-packages"}},"0.21.2-1":{"name":"@carbyne/sip.js","version":"0.21.2-1","keywords":["sip","webrtc","library","websocket","javascript","typescript"],"author":{"url":"https://sipjs.com/aboutus/","name":"OnSIP","email":"developer@onsip.com"},"license":"MIT","_id":"@carbyne/sip.js@0.21.2-1","contributors":[{"url":"https://github.com/onsip/SIP.js/blob/master/THANKS.md","name":"Contributors"}],"homepage":"https://sipjs.com","bugs":{"url":"https://github.com/onsip/SIP.js/issues"},"dist":{"shasum":"e3f86315b1e16a7db8cb808faed81c8b4e7425d4","tarball":"https://registry.npmjs.org/@carbyne/sip.js/-/sip.js-0.21.2-1.tgz","fileCount":389,"integrity":"sha512-Xv7kmMGI3v8apmcb/8LDaAT6g9tAKz1pOF3oVPkdc8DMeC5iaGq3yw/Z32jWIe8NBe/hIJ/drP5LYMoGqdTosQ==","signatures":[{"sig":"MEUCIQCr0iwsoPEet7i3muVL0JgDfo0C0CzdW3qK62ZaB80jQgIgexbxQCghxyqzbW9LpH3hLJOIlmU7gFikfZ5vaOZ062E=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1277808},"main":"./lib/index.js","type":"module","title":"SIP.js","types":"./lib/index.d.ts","module":"./lib/index.js","engines":{"node":">=10.0"},"gitHead":"b27dbac85cd868ae7f8e6fb858ad5dd4deb2e821","scripts":{"lint":"eslint --ext .ts .","test":"npm run build-test && karma start karma.conf.cjs --reporters mocha --browsers ChromeHeadlessFakeMediaStream --single-run","build":"npm run generate-grammar && npm run build-lib","version":"sed -i '' \"s/LIBRARY_VERSION = .*/LIBRARY_VERSION = \\\"$npm_package_version\\\";/\" src/version.ts","co:login":"aws codeartifact login --tool npm --repository carbyne --domain carbyne --domain-owner 366789379256 --region eu-west-1 --namespace @carbyne","lint-fix":"eslint --ext .ts --fix .","prebuild":"npm run lint","build-lib":"tsc -p src","build-demo":"npm run build && webpack --progress --config demo/webpack.config.cjs","build-docs":"npm run build-lib && npm run build-docs-api && npm run build-docs-core && npm run build-docs-session-description-handler && npm run build-docs-session-manager && npm run build-docs-simple-user && npm run build-docs-transport","build-test":"tsc -p test","extract-api":"api-extractor run --local --verbose --config src/api/api-extractor.json","document-api":"api-documenter markdown --input-folder ./temp/api --output-folder ./temp/docs/api","extract-core":"api-extractor run --local --verbose --config src/core/api-extractor.json","test-browser":"npm run build-test && sleep 2 && (open http://localhost:9876/debug.html &) && karma start karma.conf.cjs --reporters kjhtml --no-single-run","build-bundles":"npm run build-reg-bundle && npm run build-min-bundle && npm run copy-dist-files","document-core":"api-documenter markdown --input-folder ./temp/core --output-folder ./temp/docs/core","build-and-test":"npm run build && npm run test","build-docs-api":"npm run extract-api && npm run document-api && npm run document-copy-api","login-saml2aws":"npm run saml2aws-carbyne-stage && aws --profile carbyne-stage codeartifact login --tool npm --repository carbyne --domain carbyne --domain-owner 366789379256 --region eu-west-1 --namespace @carbyne","build-docs-core":"npm run extract-core && npm run document-core && npm run document-copy-core","copy-dist-files":"cp dist/sip.js dist/sip-$npm_package_version.js && cp dist/sip.min.js dist/sip-$npm_package_version.min.js","build-min-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=min","build-reg-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=reg","generate-grammar":"node build/grammarGenerator.cjs","document-copy-api":"rm -rf ./docs/api/sip.js.* && cp ./temp/docs/api/* ./docs/api","extract-transport":"api-extractor run --local --verbose --config src/platform/web/transport/api-extractor.json","document-copy-core":"rm -rf ./docs/core/sip.js.* && cp ./temp/docs/core/* ./docs/core","document-transport":"api-documenter markdown --input-folder ./temp/transport --output-folder ./temp/docs/transport","extract-simple-user":"api-extractor run --local --verbose --config src/platform/web/simple-user/api-extractor.json","build-docs-transport":"npm run extract-transport && npm run document-transport && npm run document-copy-transport","document-simple-user":"api-documenter markdown --input-folder ./temp/simple-user --output-folder ./temp/docs/simple-user","build-and-test-browser":"npm run build && npm run test-browser","build-docs-simple-user":"npm run extract-simple-user && npm run document-simple-user && npm run document-copy-simple-user","saml2aws-carbyne-stage":"saml2aws login -a carbyne-stage --client-id=815042732b740f9a6c0a581b99e9f8cb0c61d6787d00a24a00c75fa4ac5b5515 --client-secret=0ce1f089eb949e3ff23059760f8fadbaf62f997b11a2035ef1c058875c4a586a","document-copy-transport":"rm -rf ./docs/transport/sip.js.* && cp ./temp/docs/transport/* ./docs/transport","extract-session-manager":"api-extractor run --local --verbose --config src/platform/web/session-manager/api-extractor.json","document-session-manager":"api-documenter markdown --input-folder ./temp/session-manager --output-folder ./temp/docs/session-manager","document-copy-simple-user":"rm -rf ./docs/simple-user/sip.js.* && cp ./temp/docs/simple-user/* ./docs/simple-user","build-docs-session-manager":"npm run extract-session-manager && npm run document-session-manager && npm run document-copy-session-manager","document-copy-session-manager":"rm -rf ./docs/session-manager/sip.js.* && cp ./temp/docs/session-manager/* ./docs/session-manager","extract-session-description-handler":"api-extractor run --local --verbose --config src/platform/web/session-description-handler/api-extractor.json","document-session-description-handler":"api-documenter markdown --input-folder ./temp/session-description-handler --output-folder ./temp/docs/session-description-handler","build-docs-session-description-handler":"npm run extract-session-description-handler && npm run document-session-description-handler && npm run document-copy-session-description-handler","document-copy-session-description-handler":"rm -rf ./docs/session-description-handler/sip.js.* && cp ./temp/docs/session-description-handler/* ./docs/session-description-handler"},"_npmUser":{"name":"slavikb","email":"slavikb@carbyne.com"},"repository":{"url":"git+https://github.com/onsip/SIP.js.git","type":"git"},"_npmVersion":"10.2.3","description":"A SIP library for JavaScript","directories":{},"sideEffects":false,"_nodeVersion":"18.19.0","_hasShrinkwrap":false,"devDependencies":{"karma":"^6.4.1","peggy":"^1.2.0","eslint":"^8.25.0","webpack":"^5.74.0","prettier":"^2.7.1","ts-pegjs":"^1.2.2","karma-cli":"^2.0.0","ts-loader":"^9.4.1","typescript":"^4.8.4","mock-socket":"^9.1.5","webpack-cli":"^4.10.0","jasmine-core":"^4.4.0","karma-jasmine":"^5.1.0","karma-webpack":"^5.0.0","@types/jasmine":"^4.3.0","karma-mocha-reporter":"^2.2.5","karma-chrome-launcher":"^3.1.1","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","karma-sourcemap-loader":"^0.3.8","@microsoft/api-extractor":"7.7.11","@microsoft/api-documenter":"^7.19.22","@typescript-eslint/parser":"^5.40.1","circular-dependency-plugin":"^5.2.2","eslint-plugin-tree-shaking":"^1.10.0","karma-jasmine-html-reporter":"^2.0.0","@typescript-eslint/eslint-plugin":"^5.40.1"},"_npmOperationalInternal":{"tmp":"tmp/sip.js_0.21.2-1_1719912287073_0.12463021086453696","host":"s3://npm-registry-packages"}},"0.21.2-2":{"name":"@carbyne/sip.js","version":"0.21.2-2","keywords":["sip","webrtc","library","websocket","javascript","typescript"],"author":{"url":"https://sipjs.com/aboutus/","name":"OnSIP","email":"developer@onsip.com"},"license":"MIT","_id":"@carbyne/sip.js@0.21.2-2","maintainers":[{"name":"tajamulm","email":"tajamulm@carbyne.com"},{"name":"romanmalih","email":"roman@carbyne.com"},{"name":"manisht","email":"manisht@carbyne.com"},{"name":"matzov","email":"gil@carbyne.com"},{"name":"netaneld","email":"netaneld@carbyne.com"},{"name":"noam-carbyne","email":"noam@carbyne.com"},{"name":"netanelb_carbyne.com","email":"netanelb@carbyne.com"},{"name":"slavikb","email":"slavikb@carbyne.com"}],"contributors":[{"url":"https://github.com/onsip/SIP.js/blob/master/THANKS.md","name":"Contributors"}],"homepage":"https://sipjs.com","bugs":{"url":"https://github.com/onsip/SIP.js/issues"},"dist":{"shasum":"20be916d58e7ffe826f8543df9167693b007cbd4","tarball":"https://registry.npmjs.org/@carbyne/sip.js/-/sip.js-0.21.2-2.tgz","fileCount":389,"integrity":"sha512-t0avBW3VlvfQEeRlKUrLaCn2bjz7dI3c6Mi0lls9ZGPEH/T4BOZfpnls4YlTUW3hkUTapEjRy7vNW11c2kTLrQ==","signatures":[{"sig":"MEYCIQDrdCWqM2n4gkc1CWCboaeD2eYWmFC/fytp4MudtTBhuAIhAM2cvZrOqygbwLZwr25eC4kRRP/kjuqwZ6SNQJN3yXi6","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":1277342},"main":"./lib/index.js","type":"module","title":"SIP.js","types":"./lib/index.d.ts","module":"./lib/index.js","engines":{"node":">=10.0"},"gitHead":"a70b0fbc39c06a1b2ccead8864f9cb87ca3491b9","scripts":{"lint":"eslint --ext .ts .","test":"npm run build-test && karma start karma.conf.cjs --reporters mocha --browsers ChromeHeadlessFakeMediaStream --single-run","build":"npm run generate-grammar && npm run build-lib","version":"sed -i '' \"s/LIBRARY_VERSION = .*/LIBRARY_VERSION = \\\"$npm_package_version\\\";/\" src/version.ts","lint-fix":"eslint --ext .ts --fix .","prebuild":"npm run lint","build-lib":"tsc -p src","build-demo":"npm run build && webpack --progress --config demo/webpack.config.cjs","build-docs":"npm run build-lib && npm run build-docs-api && npm run build-docs-core && npm run build-docs-session-description-handler && npm run build-docs-session-manager && npm run build-docs-simple-user && npm run build-docs-transport","build-test":"tsc -p test","extract-api":"api-extractor run --local --verbose --config src/api/api-extractor.json","document-api":"api-documenter markdown --input-folder ./temp/api --output-folder ./temp/docs/api","extract-core":"api-extractor run --local --verbose --config src/core/api-extractor.json","test-browser":"npm run build-test && sleep 2 && (open http://localhost:9876/debug.html &) && karma start karma.conf.cjs --reporters kjhtml --no-single-run","build-bundles":"npm run build-reg-bundle && npm run build-min-bundle && npm run copy-dist-files","document-core":"api-documenter markdown --input-folder ./temp/core --output-folder ./temp/docs/core","build-and-test":"npm run build && npm run test","build-docs-api":"npm run extract-api && npm run document-api && npm run document-copy-api","build-docs-core":"npm run extract-core && npm run document-core && npm run document-copy-core","copy-dist-files":"cp dist/sip.js dist/sip-$npm_package_version.js && cp dist/sip.min.js dist/sip-$npm_package_version.min.js","build-min-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=min","build-reg-bundle":"webpack --progress --config build/webpack.config.cjs --env buildType=reg","generate-grammar":"node build/grammarGenerator.cjs","document-copy-api":"rm -rf ./docs/api/sip.js.* && cp ./temp/docs/api/* ./docs/api","extract-transport":"api-extractor run --local --verbose --config src/platform/web/transport/api-extractor.json","document-copy-core":"rm -rf ./docs/core/sip.js.* && cp ./temp/docs/core/* ./docs/core","document-transport":"api-documenter markdown --input-folder ./temp/transport --output-folder ./temp/docs/transport","extract-simple-user":"api-extractor run --local --verbose --config src/platform/web/simple-user/api-extractor.json","build-docs-transport":"npm run extract-transport && npm run document-transport && npm run document-copy-transport","document-simple-user":"api-documenter markdown --input-folder ./temp/simple-user --output-folder ./temp/docs/simple-user","build-and-test-browser":"npm run build && npm run test-browser","build-docs-simple-user":"npm run extract-simple-user && npm run document-simple-user && npm run document-copy-simple-user","document-copy-transport":"rm -rf ./docs/transport/sip.js.* && cp ./temp/docs/transport/* ./docs/transport","extract-session-manager":"api-extractor run --local --verbose --config src/platform/web/session-manager/api-extractor.json","document-session-manager":"api-documenter markdown --input-folder ./temp/session-manager --output-folder ./temp/docs/session-manager","document-copy-simple-user":"rm -rf ./docs/simple-user/sip.js.* && cp ./temp/docs/simple-user/* ./docs/simple-user","build-docs-session-manager":"npm run extract-session-manager && npm run document-session-manager && npm run document-copy-session-manager","document-copy-session-manager":"rm -rf ./docs/session-manager/sip.js.* && cp ./temp/docs/session-manager/* ./docs/session-manager","extract-session-description-handler":"api-extractor run --local --verbose --config src/platform/web/session-description-handler/api-extractor.json","document-session-description-handler":"api-documenter markdown --input-folder ./temp/session-description-handler --output-folder ./temp/docs/session-description-handler","build-docs-session-description-handler":"npm run extract-session-description-handler && npm run document-session-description-handler && npm run document-copy-session-description-handler","document-copy-session-description-handler":"rm -rf ./docs/session-description-handler/sip.js.* && cp ./temp/docs/session-description-handler/* ./docs/session-description-handler"},"_npmUser":{"name":"slavikb","email":"slavikb@carbyne.com"},"repository":{"url":"git+https://github.com/onsip/SIP.js.git","type":"git"},"_npmVersion":"10.2.3","description":"A SIP library for JavaScript","directories":{},"sideEffects":false,"_nodeVersion":"18.19.0","_hasShrinkwrap":false,"devDependencies":{"karma":"^6.4.1","peggy":"^1.2.0","eslint":"^8.25.0","webpack":"^5.74.0","prettier":"^2.7.1","ts-pegjs":"^1.2.2","karma-cli":"^2.0.0","ts-loader":"^9.4.1","typescript":"^4.8.4","mock-socket":"^9.1.5","webpack-cli":"^4.10.0","jasmine-core":"^4.4.0","karma-jasmine":"^5.1.0","karma-webpack":"^5.0.0","@types/jasmine":"^4.3.0","karma-mocha-reporter":"^2.2.5","karma-chrome-launcher":"^3.1.1","eslint-config-prettier":"^8.5.0","eslint-plugin-prettier":"^4.2.1","karma-sourcemap-loader":"^0.3.8","@microsoft/api-extractor":"7.7.11","@microsoft/api-documenter":"^7.19.22","@typescript-eslint/parser":"^5.40.1","circular-dependency-plugin":"^5.2.2","eslint-plugin-tree-shaking":"^1.10.0","karma-jasmine-html-reporter":"^2.0.0","@typescript-eslint/eslint-plugin":"^5.40.1"},"_npmOperationalInternal":{"tmp":"tmp/sip.js_0.21.2-2_1727099194103_0.3872733038778857","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-11-26T10:19:38.602Z","modified":"2024-09-23T18:38:53.533Z","0.21.2":"2023-11-26T10:19:38.952Z","0.21.2-1":"2024-07-02T09:24:47.310Z","0.21.2-2":"2024-09-23T13:46:34.340Z"},"bugs":{"url":"https://github.com/onsip/SIP.js/issues"},"author":{"url":"https://sipjs.com/aboutus/","name":"OnSIP","email":"developer@onsip.com"},"license":"MIT","homepage":"https://sipjs.com","keywords":["sip","webrtc","library","websocket","javascript","typescript"],"repository":{"url":"git+https://github.com/onsip/SIP.js.git","type":"git"},"description":"A SIP library for JavaScript","contributors":[{"url":"https://github.com/onsip/SIP.js/blob/master/THANKS.md","name":"Contributors"}],"maintainers":[{"email":"nirh@carbyne.com","name":"nirharoosh"},{"email":"bhanuchandar@carbyne.com","name":"bhanuchandar-carbyne"},{"email":"tajamulm@carbyne.com","name":"tajamulm"},{"email":"roman@carbyne.com","name":"romanmalih"},{"email":"manisht@carbyne.com","name":"manisht"},{"email":"gil@carbyne.com","name":"matzov"},{"email":"netaneld@carbyne.com","name":"netaneld"},{"email":"noam@carbyne.com","name":"noam-carbyne"},{"email":"netanelb@carbyne.com","name":"netanelb_carbyne.com"},{"email":"slavikb@carbyne.com","name":"slavikb"}],"readme":"![SIP.js Logo](https://sipjs.com/shared/img/logo.png \"SIP.js\")\r\n\r\n![Build Status](https://github.com/onsip/SIP.js/actions/workflows/node.js.yml/badge.svg)\r\n[![npm version](https://badge.fury.io/js/sip.js.svg)](https://badge.fury.io/js/sip.js)\r\n\r\n# SIP Library for JavaScript\r\n\r\n- Create real-time peer-to-peer audio and video sessions via [WebRTC](https://webrtc.org/)\r\n- Utilize SIP in your web application via [SIP over WebSocket](https://tools.ietf.org/html/rfc7118) \r\n- Send instant messages and view presence\r\n- Support early media, hold and transfers\r\n- Send DTMF RFC 2833 or SIP INFO\r\n- Share your screen or desktop\r\n- Written in TypeScript\r\n- Runs in all major web browsers\r\n- Compatible with standards compliant servers including [Asterisk](https://www.asterisk.org/) and [FreeSWITCH](https://freeswitch.com/)\r\n\r\n## Demo\r\n\r\nWant see it in action? The project website, [sipjs.com](https://sipjs.com), has a [live demo](https://sipjs.com).\r\n\r\nLooking for code to get started with? This repository includes [demonstrations](./demo/README.md) which run in a web browser.\r\n\r\n## Usage\r\n\r\nTo place a SIP call, either utilize the [`SimpleUser` class](docs/simple-user.md)...\r\n\r\n```ts\r\nimport { Web } from \"sip.js\";\r\n\r\n// Helper function to get an HTML audio element\r\nfunction getAudioElement(id: string): HTMLAudioElement {\r\n  const el = document.getElementById(id);\r\n  if (!(el instanceof HTMLAudioElement)) {\r\n    throw new Error(`Element \"${id}\" not found or not an audio element.`);\r\n  }\r\n  return el;\r\n}\r\n\r\n// Options for SimpleUser\r\nconst options: Web.SimpleUserOptions = {\r\n  aor: \"sip:alice@example.com\", // caller\r\n  media: {\r\n    constraints: { audio: true, video: false }, // audio only call\r\n    remote: { audio: getAudioElement(\"remoteAudio\") } // play remote audio\r\n  }\r\n};\r\n\r\n// WebSocket server to connect with\r\nconst server = \"wss://sip.example.com\";\r\n\r\n// Construct a SimpleUser instance\r\nconst simpleUser = new Web.SimpleUser(server, options);\r\n\r\n// Connect to server and place call\r\nsimpleUser.connect()\r\n  .then(() => simpleUser.call(\"sip:bob@example.com\"))\r\n  .catch((error: Error) => {\r\n    // Call failed\r\n  });\r\n```\r\n\r\nOr, alternatively, use the full [API framework](docs/api.md)...\r\n\r\n```ts\r\nimport { Inviter, SessionState, UserAgent } from \"sip.js\";\r\n\r\n// Create user agent instance (caller)\r\nconst userAgent = new UserAgent({\r\n  uri: UserAgent.makeURI(\"sip:alice@example.com\"),\r\n  transportOptions: {\r\n    server: \"wss://sip.example.com\"\r\n  },\r\n});\r\n\r\n// Connect the user agent\r\nuserAgent.start().then(() => {\r\n\r\n  // Set target destination (callee)\r\n  const target = UserAgent.makeURI(\"sip:bob@example.com\");\r\n  if (!target) {\r\n    throw new Error(\"Failed to create target URI.\");\r\n  }\r\n\r\n  // Create a user agent client to establish a session\r\n  const inviter = new Inviter(userAgent, target, {\r\n    sessionDescriptionHandlerOptions: {\r\n      constraints: { audio: true, video: false }\r\n    }\r\n  });\r\n\r\n  // Handle outgoing session state changes\r\n  inviter.stateChange.addListener((newState) => {\r\n    switch (newState) {\r\n      case SessionState.Establishing:\r\n        // Session is establishing\r\n        break;\r\n      case SessionState.Established:\r\n        // Session has been established\r\n        break;\r\n      case SessionState.Terminated:\r\n        // Session has terminated\r\n        break;\r\n      default:\r\n        break;\r\n    }\r\n  });\r\n\r\n  // Send initial INVITE request\r\n  inviter.invite()\r\n    .then(() => {\r\n      // INVITE sent\r\n    })\r\n    .catch((error: Error) => {\r\n      // INVITE did not send\r\n    });\r\n\r\n});\r\n```\r\n## Installation\r\n\r\nNode module\r\n```sh\r\nnpm install sip.js\r\n```\r\n\r\n UMD bundle\r\n- Download [sipjs.com/download](https://sipjs.com/download)\r\n- CDN [jsDelivr.com](https://www.jsdelivr.com/package/npm/sip.js)\r\n\r\n## Building, Development and Testing\r\n\r\nClone this repository, then...\r\n\r\n```sh\r\nnpm install\r\nnpm run build-and-test\r\n```\r\n\r\nFor more info please see the [Documentation](./docs/README.md).\r\n\r\n## Support\r\n\r\n* For migration guides and API reference please see the [Documentation](./docs/README.md).\r\n* For bug reports and feature requests please open a [GitHub Issue](https://github.com/onsip/sip.js/issues).\r\n* For questions or usage problems please use the [Google Group](https://groups.google.com/forum/#!forum/sip_js).\r\n* For more information see the project website at [SIPjs.com](https://sipjs.com).\r\n","readmeFilename":"README.md"}