{"_id":"@osaas/fast-engine-client","_rev":"29-ef4acf5e472789e653cfd3a5a2396fb6","name":"@osaas/fast-engine-client","dist-tags":{"latest":"0.1.5"},"versions":{"0.1.0":{"name":"@osaas/fast-engine-client","version":"0.1.0","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.0","maintainers":[{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"b43b5221df2ff7114df5f70d54542c05e5dbb972","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.0.tgz","fileCount":41,"integrity":"sha512-2kFNiNMzpG+IotNmT3Z/bupwQm5nto/oUNqcUNTvs+3b/6OpcOTS/kH2NwCbHbf0YaHzzc4UeF1m5hV1x0vKEg==","signatures":[{"sig":"MEUCIGfffwEt3fOsxcBFBvnzsOaG1ezBMPcj29eM5ODkkd/DAiEA+a9gDyJNhVekxLQBq/x8STecaR8rrUaz0U0fJOr3aeY=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":97580},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"565949ad65c8b99131434306ade026020eb36209","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.0_1697821113763_0.6533271724959038","host":"s3://npm-registry-packages"}},"0.1.1":{"name":"@osaas/fast-engine-client","version":"0.1.1","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.1","maintainers":[{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"a750f64d2af10d6b045cf4065dcdee01bffc22fe","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.1.tgz","fileCount":41,"integrity":"sha512-om3vlqIRgqMXiNu51a4vmJitVtFiSfk1B71PgCaoo/Ab99GurL89y5H6P13Q5OYTwLsNS5NLPfi/KMvZUrYxhw==","signatures":[{"sig":"MEYCIQD2l75emHLLekAjeBNbqgKa9a+TrjzFC9sPftoBJeEnawIhAPHcFUghkGDeVjtbrhLaJa/D/DZCeNSMeSY5syAftl8w","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":97589},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"b4f70657ebd2217ff0008db13fe643a982eee123","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.1_1697821224925_0.786864706267399","host":"s3://npm-registry-packages"}},"0.1.2":{"name":"@osaas/fast-engine-client","version":"0.1.2","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.2","maintainers":[{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"b6dc68129731af8f4e22557912adacffab8a8e05","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.2.tgz","fileCount":41,"integrity":"sha512-cLehFqEx0FdaNvyVN94ciqsE1AljUcHh8aUilvDSk1YENj3MH0WR3m0wWDyU0jsM8/btGWUVOnB27PiUYGyGMQ==","signatures":[{"sig":"MEQCIDhIhrKL+gpTGiaor8dzoc8ljPYDc+/zsVLCxuo5/qMcAiAVeVI6prSjEG2Xd3pUVpoio2IbbXuL8YyDYx2RfuEySA==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":97590},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"20136567512e7ea2819154b658153c1f4726eb9a","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.2_1697821385607_0.2710262937112531","host":"s3://npm-registry-packages"}},"0.1.3":{"name":"@osaas/fast-engine-client","version":"0.1.3","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.3","maintainers":[{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"a3ea6822cf3bd5c551172d75cec386d3f367fbc6","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.3.tgz","fileCount":3,"integrity":"sha512-6Lu5rFKmO6CSqPfIaWuVvnMFGgvHVzwT951ZtEXMsQy742Ia7wVJsoU7xeXyOrtNRSetfqL19Ch+LncUaiq/uw==","signatures":[{"sig":"MEUCIQC86TbglmLk0z1OhvdwHn8fdWW7txO6H6ZiujFTb+E0/wIgcD8b75hhoA0J50ZQhoRjucSS2HuDydCLn1TsLVr5zeI=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5726},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"808c93237a7ac2d712ddd95d91d559d079d9eb45","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.3_1697822083301_0.0531964726621561","host":"s3://npm-registry-packages"}},"0.1.4":{"name":"@osaas/fast-engine-client","version":"0.1.4","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.4","maintainers":[{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"db25e2a501b4b62e4316a93b9e2e0a83a6e00d97","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.4.tgz","fileCount":3,"integrity":"sha512-wwh1x59hA0fgbr/v0bfzJlDhCH1qHpCllyFutNDpzCzZfUTgz6BKenHuZN1z5BpPxkGbBlCJJxR0X2mYPRqjaA==","signatures":[{"sig":"MEUCIA17uYnqFhORY5tiPc5FfO50BuxzeB2y4LyQluPXwVRZAiEA/64Vyr+5PE+Ii4tMtMTx3zSw33R54ucnSnODcnWTT5g=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":5727},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"520874c8fcc92e742c254953f3e15750a9255f28","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.4_1697822257649_0.9501073356574878","host":"s3://npm-registry-packages"}},"0.1.5":{"name":"@osaas/fast-engine-client","version":"0.1.5","keywords":["channel-engine","sdk","typescript"],"author":{"name":"Eyevinn Technology AB"},"license":"MIT","_id":"@osaas/fast-engine-client@0.1.5","maintainers":[{"name":"jonathanhedin","email":"jonathan.hedin2@gmail.com"},{"name":"bcarlsson","email":"carlsson.benny93@gmail.com"},{"name":"sandramel","email":"sandra.larsson@eyevinn.se"},{"name":"_volcano","email":"franek.kg@gmail.com"},{"name":"ggeyevinn","email":"gustav.grusell@eyevinn.se"},{"name":"bwallberg","email":"me@bwallberg.com"},{"name":"jobi","email":"jonas.birme@eyevinn.se"}],"homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"dist":{"shasum":"4c0f1ff3e24197a8ccbc04318647894975a096c0","tarball":"https://registry.npmjs.org/@osaas/fast-engine-client/-/fast-engine-client-0.1.5.tgz","fileCount":72,"integrity":"sha512-mhXu3JZR4BVPwxsNN0q8hYcwt6v6ANiCLgky1uBSMj3Dr97iH4XbYNu+AiL/XVNn0K5z1MT/1uSn6I42TtPyaQ==","signatures":[{"sig":"MEQCIEqEfnvbV58P48Q+Ci9wRW4CiIMQ9p+fwoOArPhhdtkmAiA/wdGK9TeecG9Hask7DXHwLlJ9kcHJmbWZHOQEKrNXYQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":164769},"main":"./dist/index.js","type":"commonjs","exports":{".":{"types":"./dist/index.d.js","require":"./dist/index.js"}},"gitHead":"bebb32cfc8a1e3d50ab223c0a53d16a297fda2fe","scripts":{"lint":"eslint .","build":"tsc -p tsconfig.json","pretty":"prettier --check --ignore-unknown .","typecheck":"tsc --noEmit -p tsconfig.json","postversion":"git push && git push --tags"},"typings":"./dist/index.d.ts","_npmUser":{"name":"jobi","email":"jonas.birme@eyevinn.se"},"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"_npmVersion":"9.8.1","description":"OSaaS FAST Channel Engine Client Library","directories":{},"_nodeVersion":"18.18.2","dependencies":{"url-parse":"^1.4.3","es6-promise":"^4.2.4","whatwg-fetch":"^3.0.0"},"_hasShrinkwrap":false,"devDependencies":{"eslint":"^8.33.0","prettier":"^2.8.4","typescript":"^4.0","@types/node":"^20.8.7","@types/url-parse":"1.4.4","eslint-config-prettier":"^8.6.0","eslint-plugin-prettier":"^4.2.1","@typescript-eslint/parser":"^5.51.0","@typescript-eslint/eslint-plugin":"^5.51.0"},"_npmOperationalInternal":{"tmp":"tmp/fast-engine-client_0.1.5_1698775045292_0.5924068190995844","host":"s3://npm-registry-packages"}}},"time":{"created":"2023-10-20T16:58:33.762Z","modified":"2026-01-19T18:05:42.894Z","0.1.0":"2023-10-20T16:58:33.969Z","0.1.1":"2023-10-20T17:00:25.121Z","0.1.2":"2023-10-20T17:03:05.812Z","0.1.3":"2023-10-20T17:14:43.475Z","0.1.4":"2023-10-20T17:17:37.884Z","0.1.5":"2023-10-31T17:57:25.512Z"},"bugs":{"url":"https://github.com/Eyevinn/osaas-fast-engine-sdk/issues"},"author":{"name":"Eyevinn Technology AB"},"license":"MIT","homepage":"https://github.com/Eyevinn/osaas-fast-engine-sdk#readme","keywords":["channel-engine","sdk","typescript"],"repository":{"url":"git+https://github.com/Eyevinn/osaas-fast-engine-sdk.git","type":"git"},"description":"OSaaS FAST Channel Engine Client Library","maintainers":[{"email":"jonas.birme@eyevinn.se","name":"jobi"}],"readme":"## Open Source FAST Engine as a Service SDK\n\nThe `@osaas/fast-engine-client` is an SDK for the [hosted version of the open source FAST Engine](https://fast.docs.eyevinn.technology/osaas.html). For access you need a `TOKEN` and to request a token or get more information about the service contact sales@eyevinn.se however if you want to try it out we have a test environment available that you can use.\n\nThe address to the API in the test environment is `https://api-ce.stage.osaas.io/` and here you can generate a trial-token to try this out.\n\n### Installation\n\n```\nnpm install @osaas/fast-engine-client\n```\n\n### Usage\n\n```javascript\nimport {\n  FastEngineOSaaSv1,\n  createConfiguration\n} from '@osaas/fast-engine-client';\n\nconst config = createConfiguration({\n  authMethods: {\n    jwtToken: 'Bearer ' + process.env.TOKEN\n  },\n  apiEndpoint: 'https://api-ce.stage.osaas.io'\n});\nconst client = new FastEngineOSaaSv1(config);\n```\n\n#### Generating a trial token\n\nOnly available in the test environment.\n\n```javascript\nimport {\n  FastEngineOSaaSv1,\n  createConfiguration\n} from '@osaas/fast-engine-client';\n\nconst body: TokenPostRequest = {\n  company: 'YOUR_COMPANY',\n  email: 'YOUR_EMAIL'\n};\n\nconst config = createConfiguration({\n  apiEndpoint: 'https://api-ce.stage.osaas.io'\n});\nconst client = new FastEngineOSaaSv1(config);\nconst trialToken = await client.tokenPost({\n  company: 'YOUR_COMPANY',\n  email: 'YOUR_EMAIL'\n});\n```\n\n#### Launching a new FAST channel\n\n```javascript\nimport {\n  FastEngineOSaaSv1,\n  createConfiguration,\n  ChannelPostRequestTypeEnum,\n  ChannelPostRequest\n} from '@osaas/fast-engine-client';\n\nconst body: ChannelPostRequest = {\n  name: 'sdktest',\n  type: ChannelPostRequestTypeEnum.Playlist,,\n  url: 'https://testcontent.eyevinn.technology/fast/fastdemo.txt',\n  opts: {\n    useDemuxedAudio: false\n  }\n};\n\nconst client = new FastEngineOSaaSv1(config);\nawait client.channelPost(body);\n```\n\n#### Getting all running channels\n\n```javascript\nconst client = new FastEngineOSaaSv1(configuration);\n\nconst channels = await client.channelGet();\nchannels.forEach((ch) => {\n  console.log(`${ch.name}: ${ch.url}`);\n});\n```\n\n#### Stopping and removing a channel\n\n```javascript\nconst client = new FastEngineOSaaSv1(configuration);\n\nawait client.channelIdDelete('CHANNEL_ID');\n```\n\n## License\n\nThis project is licensed under the MIT License, see [LICENSE](LICENSE).\n\n# Support\n\nJoin our [community on Slack](http://slack.streamingtech.se) where you can post any questions regarding any of our open source projects. Eyevinn's consulting business can also offer you:\n\n- Further development of this component\n- Customization and integration of this component into your platform\n- Support and maintenance agreement\n\nContact [sales@eyevinn.se](mailto:sales@eyevinn.se) if you are interested.\n\n# About Eyevinn Technology\n\n[Eyevinn Technology](https://www.eyevinntechnology.se) is an independent consultant firm specialized in video and streaming. Independent in a way that we are not commercially tied to any platform or technology vendor. As our way to innovate and push the industry forward we develop proof-of-concepts and tools. The things we learn and the code we write we share with the industry in [blogs](https://dev.to/video) and by open sourcing the code we have written.\n\nWant to know more about Eyevinn and how it is to work here. Contact us at work@eyevinn.se!\n","readmeFilename":"README.md"}