{"_id":"@555platform/555-connection","_rev":"10-c5bd40eb47a1c7a4ee6e7adbb927e482","name":"@555platform/555-connection","dist-tags":{"latest":"1.0.2"},"versions":{"1.0.0":{"name":"@555platform/555-connection","version":"1.0.0","keywords":["555"],"author":{"name":"Comcast"},"license":"Apache-2.0","_id":"@555platform/555-connection@1.0.0","maintainers":[{"name":"colinroberts","email":"colinroberts96@gmail.com"},{"name":"igor-kasriel","email":"Igor_Kasriel@cable.comcast.com"},{"name":"johnmcg5","email":"john_mcguinness2@comcast.com"},{"name":"kdriadon","email":"kevindriadon@outlook.com"},{"name":"robjsliwa","email":"robjsliwa@gmail.com"}],"dist":{"shasum":"49905dd5a655ee779203d4d919a99d176569b503","tarball":"https://registry.npmjs.org/@555platform/555-connection/-/555-connection-1.0.0.tgz","fileCount":44,"integrity":"sha512-pGd+YZhigdrKiv8ljAAsAcHl29QK4hLPd7vFfY4vUNzkwqvL7qxZyIR9yt/rghV6oBlYDaX8s8Aya8MzXH+akw==","signatures":[{"sig":"MEYCIQCeBCHqmAyYCP1LZ0WzoWgpiTBPYiCpiDOb2r0sbhwVXQIhANCqaujYGr/ialsiAD26K1sf1VIvOYD1gXinMRC0BDef","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3858471,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJee6dhCRA9TVsSAnZWagAA5B4P/RVv7rcKY4VmhQsO2Mg6\nQWGqPlbNaxp+5SZjv7FTJQZtKPBbffkkjZXNddpnSbCG0o2szyiwIO7zSRLG\nQyuw4cO/J9AUlHVPUlkZGDIOBPR7NJKdtLO+gwvbvrCzg2Pbm4VEJ2y0qZyf\nD4k+zT3GXucZSda71TRdsMqEEjFCg4JddJpbsGuxupr9YG3E22hrQsFWUKuJ\nBN8ohU2ZY3Gb8CgFmo6e97dRFOMPuxN9xFPdajv1pbAjB7XxSYJKCrNxgwG/\nUinO6oWb06EyEUd4WWUM/u5C3mSP3b2Btk9zwUHtKSHs4EPOcd5mcqo7hglK\nSSgKMPFBK4OZkDUz8gbnyPDXFChWolMK3Z67fe5hoBdFZe7PwIiplL445QAm\nU3d18tfrJROrDaO4b1wFGxqSW2AX2yQ/MtHCHhpGIbhMUViGo4YF1URHy/fs\nHzS4tnqu6iVT8DKH+30PF8CMEV46f/vS0Uvb93btZ3TEh33V2a8WJI+QZfW1\nY35EMh4O4IuZ5NsitnEnDUNW1a6kZn9vv2yeJKcJIu2KggCJ1IN7eC9pAlvx\nYSdu5tB5/P8qD72W6qDTXysE+nxz42abvXsrXGLnAXSUvOtkK3s1S40gui5U\nVZB58l3W5kqr7Kw+m9GCBWBoBs38XPb4ozZKxpVsBC+WID47qDsRfzcStmdX\nSNAW\r\n=ybio\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","gitHead":"6219df42998b97c1e6f19619dfc6da3b70a75030","scripts":{"lint":"tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*/ts'","test":"mocha -r ts-node/register src/test/testCases/*.ts","build":"tsc --module commonjs && typedoc --out docs --target es6 --theme minimal --mode file src","prebuild":"rimraf dist"},"_npmUser":{"name":"robjsliwa","email":"robjsliwa@gmail.com"},"prettier":{"singleQuote":true},"_npmVersion":"6.12.0","description":"JavaScript SDK for 555 Connection","directories":{},"_nodeVersion":"12.13.0","dependencies":{"rxjs":"^6.5.3","ramda":"^0.26.1","ts-toolbelt":"4.7.7","@types/ramda":"^0.26.33","jsonwebtoken":"^8.5.1","@types/jsonwebtoken":"^8.3.5","@555platform/555parser.ts":"^1.2.6"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^24.9.0","mocha":"^4.0.0","rimraf":"^3.0.0","tslint":"^5.20.0","ts-jest":"^24.1.0","ts-node":"^8.4.1","typedoc":"^0.15.0","prettier":"^1.18.2","typescript":"^3.6.3","@types/jest":"^24.0.18","@types/node":"^12.7.8","tslint-config-prettier":"^1.18.0","tslint-config-standard":"^8.0.1"},"_npmOperationalInternal":{"tmp":"tmp/555-connection_1.0.0_1585162080848_0.03877983509150895","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"@555platform/555-connection","version":"1.0.1","keywords":["555"],"author":{"name":"Comcast"},"license":"Apache-2.0","_id":"@555platform/555-connection@1.0.1","maintainers":[{"name":"colinroberts","email":"colinroberts96@gmail.com"},{"name":"igor-kasriel","email":"Igor_Kasriel@cable.comcast.com"},{"name":"johnmcg5","email":"john_mcguinness2@comcast.com"},{"name":"kdriadon","email":"kevindriadon@outlook.com"},{"name":"robjsliwa","email":"robjsliwa@gmail.com"}],"dist":{"shasum":"b159f37211fa3bec86851d86714d8f304c41563c","tarball":"https://registry.npmjs.org/@555platform/555-connection/-/555-connection-1.0.1.tgz","fileCount":44,"integrity":"sha512-4ilLTQ7/pCvmekQaYBRxudnH6e9hL+pkQIiywE/YhGZ9mDPqkrJK9bAmbYnX5T7qGZmNmEj09BkLAeqWZSvPZQ==","signatures":[{"sig":"MEQCIDDAZuvBDNNmlppRLEpQBlkebsqi5BWJnyC7dGJ3ynqJAiBf/DpDwjyIuwVk33ltXuxImVfpVUq+hgAGeLKWQyt2pQ==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3858483,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJeh1StCRA9TVsSAnZWagAAsvUQAJ/wfaiugkCMBOPk+gtX\nAnWoqtpT6lqjTCJbtoesTf35hdJqr3q9uFlVlrV2SRUVrZsM0G/88hWj4o3s\nAL8dAmYvwOXzwt/W6YidpeHicxaulZBE//MyruPmBub8fP4e5lKPHEswlXAa\nxJYk7cUzjMNOE1paDboxPbzLS/Glwq5WZCu1ekeQU6Y57k+7cAd+sTWRtSKE\n4o1yjVnuTxg4+MWTUA5CTI78fzDTS5DLnesxjEqgrzJZNxoqO6bWKhvTGt0u\nOaazRQJBlQ6hD7B3w8OZrRRlqpUYnBkGvrwt2I3r58hYPPb/UHsGZ0Js9stF\n4cuvUhCxxgCnZWRwSFSIkCi48+zWhDYoN0uh8WLsZkXt7/39LEQwoywBmIwg\n6Gj7JzGc3q74fNUY8czlEwA/gxSKYERT7DuEK4ycwzAxVrcPde0P/kwNG5Fb\nyf0iZrQTDMfBKhh6g8VSrYgc74ytVLBwaaICADi5T83/KHKDUKtktl24IbpB\nZA83p6oL7Ii4uRqsTBbkXjK0zJ5rqPrtdywEghpZkvk6SbQzn41t4NJ5VooH\nr+ikTuohSpVPyo05xcyxvPP2C7yePz0rN18SnoVeBIy/4Ndw2vtw1ceuP2AG\nom18unW8GynDoZ9BlkJo+X0ShWcaEkdmsICnvTD9fSg8+tTHTxaI7gzp3i4r\nT0fU\r\n=Njwh\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","gitHead":"3793950688d82ecee6b802d92b09b92fcdd4bd7d","scripts":{"lint":"tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*/ts'","test":"mocha -r ts-node/register src/test/testCases/*.ts","build":"tsc --module commonjs && typedoc --out docs --target es6 --theme minimal --mode file src","prebuild":"rimraf dist"},"_npmUser":{"name":"robjsliwa","email":"robjsliwa@gmail.com"},"prettier":{"singleQuote":true},"_npmVersion":"6.12.0","description":"JavaScript SDK for 555 Connection","directories":{},"_nodeVersion":"12.13.0","dependencies":{"rxjs":"^6.5.3","ramda":"^0.26.1","ts-toolbelt":"4.7.7","@types/ramda":"^0.26.33","jsonwebtoken":"^8.5.1","@types/jsonwebtoken":"^8.3.5","@555platform/555-sdk-parser":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^24.9.0","mocha":"^4.0.0","rimraf":"^3.0.0","tslint":"^5.20.0","ts-jest":"^24.1.0","ts-node":"^8.4.1","typedoc":"^0.15.0","prettier":"^1.18.2","typescript":"^3.6.3","@types/jest":"^24.0.18","@types/node":"^12.7.8","tslint-config-prettier":"^1.18.0","tslint-config-standard":"^8.0.1"},"_npmOperationalInternal":{"tmp":"tmp/555-connection_1.0.1_1585927340522_0.3835754589347349","host":"s3://npm-registry-packages"}},"1.0.2":{"name":"@555platform/555-connection","version":"1.0.2","keywords":["555"],"author":{"name":"Comcast"},"license":"Apache-2.0","_id":"@555platform/555-connection@1.0.2","maintainers":[{"name":"colinroberts","email":"colinroberts96@gmail.com"},{"name":"igor-kasriel","email":"Igor_Kasriel@cable.comcast.com"},{"name":"johnmcg5","email":"john_mcguinness2@comcast.com"},{"name":"kdriadon","email":"kevindriadon@outlook.com"},{"name":"robjsliwa","email":"robjsliwa@gmail.com"}],"dist":{"shasum":"d2df392c73b0a6f0164ec088de690c6e228bc4e4","tarball":"https://registry.npmjs.org/@555platform/555-connection/-/555-connection-1.0.2.tgz","fileCount":44,"integrity":"sha512-3DOGl1eo/xwgWXezkVlVswDHouBxcaz7dVBsf8tlDf8iDOmna7xgJnMTMqmPFfX7yP6oa5W21U917pW+TFlNag==","signatures":[{"sig":"MEQCIGLwTDwdhm16yDgxWObAW1WAhH/B2bdwKXW4CEQsimLKAiBufIyFpxb86cgMDKKtHTMoCDW+O9XhehGHyHgGL18Tng==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":3861603,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJelh7uCRA9TVsSAnZWagAArqkP/38F6jqNONn3fL+UjLP5\n4cYkcc0hrMkd/fI/W6CCFjam2nakr3IAgwWdI2cvc6dWJ+U3f0FBSjcXJO/I\n4omJrIC+/kKNlQh7YDJnZkbpvqr8cW70apHJZucdjPSDkiL3kf/X2+EAGXkI\n0MQcNb5vhim2GEFMMAHI420+yeetTi/k7xjKCyyiPK++Gvev/c71hcRHsbrA\nY3+30c7fR+t6Ojccgh3IJ/wm++a2DhTqHNbZrWIiO6cCdYd8+EEpGHIQOCMi\nBIRELl2x3bpJoi7l1Ixt05+LkPlJUbXtKMBAvYWkkS1SispLHeVoC3UoqfNs\nJBMgzpHN1dEF2wrZQfpOOetV9QaLO3ROM79qr5BFEsGKXqzHxM9TreJJP0Um\nXxpD03UCcHSj2w0294VmQdK1XgDEFmfdtFlenE/VCGE/Uh4Fl6ZeawnPG1Ow\nHahWpARWJN54xAk6egqrsPHyfU4wDDCyFTcxqLXtqffHMqJfp4biV139QSjw\nRPwVUll5qe/eLsDmnlPxFTOP2ucvFjoBl3DRlryl93DhyR0pmH2dXHncfwLE\n6pMG5LSKMFP/bK13jTFxUE3uNxlvfC8g8KWNpneGlHDa4XV2MVdejbc/V6Da\nrydQZlHXrhK6EiyDIYyhxQQMeYlPvHY7hhu10tbpn5Mdnx55NjPrbl59yw5x\nUahZ\r\n=mGm8\r\n-----END PGP SIGNATURE-----\r\n"},"main":"dist/index.js","gitHead":"7985609e184166f4f4e04034473881fc408d2498","scripts":{"lint":"tslint --project tsconfig.json -t codeFrame 'src/**/*.ts' 'test/**/*/ts'","test":"mocha -r ts-node/register src/test/testCases/*.ts","build":"tsc --module commonjs && typedoc --out docs --target es6 --theme minimal --mode file src","prebuild":"rimraf dist"},"_npmUser":{"name":"robjsliwa","email":"robjsliwa@gmail.com"},"prettier":{"singleQuote":true},"_npmVersion":"6.9.0","description":"JavaScript SDK for 555 Connection","directories":{},"_nodeVersion":"12.0.0","dependencies":{"rxjs":"^6.5.3","ramda":"^0.26.1","jwt-decode":"^2.2.0","ts-toolbelt":"4.7.7","@types/ramda":"^0.26.33","jsonwebtoken":"^8.5.1","@types/jsonwebtoken":"^8.3.5","@555platform/555-sdk-parser":"^1.0.0"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^24.9.0","mocha":"^4.0.0","rimraf":"^3.0.0","tslint":"^5.20.0","ts-jest":"^24.1.0","ts-node":"^8.4.1","typedoc":"^0.15.0","prettier":"^1.18.2","typescript":"^3.6.3","@types/jest":"^24.0.18","@types/node":"^12.7.8","tslint-config-prettier":"^1.18.0","tslint-config-standard":"^8.0.1"},"_npmOperationalInternal":{"tmp":"tmp/555-connection_1.0.2_1586896621508_0.5998986991844109","host":"s3://npm-registry-packages"}}},"time":{"created":"2020-03-25T18:48:00.659Z","modified":"2024-09-16T22:07:55.399Z","1.0.0":"2020-03-25T18:48:01.068Z","1.0.1":"2020-04-03T15:22:20.722Z","1.0.2":"2020-04-14T20:37:01.736Z"},"author":{"name":"Comcast"},"license":"Apache-2.0","keywords":["555"],"description":"JavaScript SDK for 555 Connection","maintainers":[{"email":"nijagunamurthy_chandrashekarappa@comcast.com","name":"nijacomcast"},{"email":"nijagunared@gmail.com","name":"nija"}],"readme":"# 555-connection \n\n# 555 JavaScript SDK for connection\n\n555-connection provides simple APIs to make connection with 555 Platform.\n\n\n## Getting started\n  ```sh\n  npm i @555platform/555-connection\n  ```\n  \n## Usage - Examples\n\n```javascript\nimport SDK from '@555platform/555-connection';\n```\n\n1. Make connection using `555token`, `ConnectOptions` and `MessageAdapter`\n  \t\n\t```javascript\n\tconst sdk = SDK.Client.create(\n\t\t    \tuserData.access_token,\n\t\t    \t{\n\t\t\t  url: '',\n\t\t\t  automaticReconnect: true\n\t\t    \t},\n\t\t    \tnew SDK.QueuedMessageAdapter<SDK.MessagePayload>()\n\t\t    );\n\t\t\n\t    \n\tsdk.connect();\n\t```\n\n\n3. Callbacks \n\t \n\t```javascript\t  \n    sdk.onTokenAboutToExpire(() =>\n     // renewToken is a function you need to implement to fetch new token\n     // from application server\n     renewToken(renewedToken => sdk.updateToken(renewedToken));\n    );\n    ```\t\n\n## APIs\n\n## Connect\n\n### Methods\n\n#### &lt;static&gt; create(accessToken, ConnectOptions, messageAdapter)\n\nFactory method to create and initialize Client\n\n**Parameters**\n\nName | Type | Argument | Description\n--- | --- | --- | ---\naccessToken | string | required | 555 Platform access token\noptions | ConnectOptions | required | Options to customize 555 Connection behavior\nmessageAdapter | MessageAdapter | required | Message adapter class conforming to MessageAdapter interface\n\n**Returns**\n\n*Type*\n\n`Client|Error`\n\n#### updateToken(accessToken)\n\nUpdates current token.  Used to update Client with refreshed token.\n\n**Parameters**\n\nName | Type | Argument | Description\n--- | --- | --- | ---\naccessToken | string | required | 555 Platform access token\n\n**Returns**\n\n*Type*\n\n`void`\n\n#### connect()\n\nConnect to platform.\n\n**Parameters**\n\nName | Type | Argument | Description\n--- | --- | --- | ---\noptions | ConnectOptions | optional | Connection options\n\n**Returns**\n\n*Type*\n\n`Promise.<Client|void>`\n\n#### disconnect()\n\nManually disconnect the client.\n\n**Returns**\n\n*Type*\n\n`Promise.<void|Error>`\n\n#### AccessTokenAboutToExpire\n\nTriggered 5 minutes before access token is to expire.\n\n```\nclient.onTokenAboutToExpire(() =>\n  // renewToken is a function you need to implement to fetch new token\n  // from application server\n  renewToken(renewedToken => sdk.updateToken(renewedToken));\n);\n```\n\n### Options\n\n#### ConnectOptions\n\nThese options are parameters for connecting to platform.\n\n*Type*\n\nObject\n\n*Properties*\n\nName | Type | Argument \n--- | --- | --- \nurl | string | required\nprotocol | string[] | optional\nautomaticReconnect | boolean | optional\nreconnectionAttempts | number | optional\nreconnectDelay | number | optional\nreconnectBackoffAlgorithm | BackoffAlgorithm | optional\npollInterval | number | optional\nrequestTimeout | number | optional\nrequestRetries | number | optional\npaginatorDefaultPageSize | number | optional\nnextPingDelay | number | optional\npingWaitDelay | number | optional\n\n\n\n\n","readmeFilename":"README.md"}