{"_id":"@ari-tsum/aeolixsdk-node","_rev":"3-f530ac3ee39a9aec3f08eb0d9a7ca578","name":"@ari-tsum/aeolixsdk-node","dist-tags":{"latest":"0.3.6"},"versions":{"0.3.4":{"name":"@ari-tsum/aeolixsdk-node","version":"0.3.4","private":false,"main":"index.js","dependencies":{"es6-promise":"^4.1.1","keypair":"^1.0.1","socket.io-client":"^2.1.0","xmlhttprequest-cookie":"0.9.4"},"engines":{"node":"6.10.x","npm":"3.10.x"},"author":{"name":"Luis Collar"},"license":"GPLv3","contributors":[{"name":"Luis Collar Salas","email":"luis.collar@atos.net"}],"description":"(This repository is part of the AEOLIX platform and contains only the Software Development Toolkit)","_id":"@ari-tsum/aeolixsdk-node@0.3.4","_nodeVersion":"12.22.1","_npmVersion":"6.14.12","dist":{"integrity":"sha512-AxTKyarMlJIxEjU4rB9W1fmLj84ckfKZ0IcLgaoLAZ9L3gYzYhLJrkdPegCHrnHTVVmNHYBNwn/G0w0NC3k64g==","shasum":"10d7c0f05ab8dca537c08f6ef8128b65a2dc538c","tarball":"https://registry.npmjs.org/@ari-tsum/aeolixsdk-node/-/aeolixsdk-node-0.3.4.tgz","fileCount":10,"unpackedSize":71164,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIFcE8hlg8re9KZfdtvXGkG8nUX1GtTycVM0W4Sh4J4EXAiEAlZSs/VgJ6IwNvAZstS87f+G8Cb73I/PFNL6h8yDOcGQ="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJicjpCACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmrM0w/+NwnjHTc2wUMmHQJwRwbsv9QorDov5whp2VikjJhUeeKRmjEE\r\nuGk7GqZSQMm3ryRgd2Cpo0QHJCZf592R6zXHQA8rHa4GJ6EDnvoDrFWuUcgx\r\n9ZHr8VgfCHe/a8W236ZS8OmGmK2KS+y3fiZ3/qFgkJWKyxAt7gQSmAAGqSHj\r\nloYfIwLB2xFeJ3Yn/DMkaKDYSw9AdnOQFS8UaHG3HAHoqRGExSWIDxeNaLge\r\n7/By9bquz3lEhut6k6IzFnnbQ741RasO72Y2QRs/GP/rxu4SA3a+foce7HEN\r\nXifEzl/6Sbj5CvY+0ymk8kuvM5HBfql9UBTicPBqKBhfbIV2a66kqa5yBhEU\r\ncR8Ad/+mM/6v2m5O5IIy+/JTFawJUpXIHlgW5vT7WSxMwkpWPjpxSRWjCMnQ\r\nAQMgT3c6kAg4eGMQ3A85Ek2MSUGoDDNYMkPggJ2j78HWhOzYfnANGE9Idukg\r\nI6kbO5FLesDSJyKWcvi6Uw55ejv4qkk0ZpGnroiOslDkasWVX5+5zLvPqtSC\r\nX8fdtNCt/SVF2XMMfSj5/p6+07unm4gT3RAUu5wkABrRXJNdZI9TNL+8ni1M\r\nOlYebzOe9kOApmQF3LXWqvbATbBUQ3tAM8+vo1cPD08YAZq6F0rlOu+KOfZs\r\n0A+hc98Gp1owp+DK8rWMRZh2RyT3ZzJIzUg=\r\n=oJAV\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alberto_goujon","email":"alberto.goujon@atos.net"},"directories":{},"maintainers":[{"name":"alberto_goujon","email":"alberto.goujon@atos.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aeolixsdk-node_0.3.4_1651653186346_0.27097906130538196"},"_hasShrinkwrap":false},"0.3.5":{"name":"@ari-tsum/aeolixsdk-node","version":"0.3.5","private":false,"main":"index.js","dependencies":{"es6-promise":"^4.1.1","keypair":"^1.0.1","socket.io-client":"^2.1.0","xmlhttprequest-cookie":"0.9.4"},"engines":{"node":"6.10.x","npm":"3.10.x"},"author":{"name":"Alberto Goujon"},"license":"GPLv3","contributors":[{"name":"Alberto Goujon","email":"alberto.goujon@atos.net"},{"name":"Iván Carrillo","email":"ivan.carrillo@atos.net"}],"gitHead":"aea595cec6e413e81f4800360736833597f691d1","description":"(This repository is part of the AEOLIX platform and contains only the Software Development Toolkit)","_id":"@ari-tsum/aeolixsdk-node@0.3.5","_nodeVersion":"18.1.0","_npmVersion":"8.8.0","dist":{"integrity":"sha512-B4pdUH4TujuoQaf4BaI6n1hKCzdAnrU+lFbLIE/IfsLDt7yOURIT1uqKknbSiihL54mUp4GjLhNMmBJtk06soA==","shasum":"0362a01d9f5f3e85a4166cbbd4f92c461a9aaebb","tarball":"https://registry.npmjs.org/@ari-tsum/aeolixsdk-node/-/aeolixsdk-node-0.3.5.tgz","fileCount":10,"unpackedSize":71553,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIH+eqZHLwpG//KRkR8R7NmuxFRT2n5O/wHoqrH5OlarfAiEAurnt50dXMC6gmcnMVl2z3/OGdmauaJ2W/v6dgDpcjzw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJifN6SACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmpWHw//YDTWbqKpNnHNffpAtqLb69+OvLN+bDa/pYuzhKOJULala5g3\r\nRBiJ2VCQy03AFxgj1h2YpVelNGS66Yw4DfgFoyf2MYJaaoU0E7PlYARUsmTE\r\nvT7QuNo0RgOXr3j06+WVgmvGvbuUnkNJ5SJJIS2azh/42t21GIfKdb4U+iGn\r\nDLiTYRVCBnU231DMl/EZ5rJedwpGKnxAGMnBU4rF1qD5YFvwONKlDHs14Nvb\r\n6WYrz0FRLVZNWNgVrK6h/60JQXuIY1xhG5o3Du2ROOZCxV7P+8dWjmhOvUK4\r\n2mm5xwP4DsiXLAifCSzpQzJxM1daNWOh/p3nI6muq7/0bFD0FuYjZUclu1xp\r\nTqpeFBvyEdLFbZx3LjVa+Vpsi8KbvA5BMIz5AeE77rOy2Sb8jSNLUDhpJyRP\r\njoho2fkOKFcSoiGqGN22MxTgGqjjYPrdZB+aZrSasDgeCdRRX+e0mpdeSmPq\r\n84nRqfH+CsKi2Ocag7sdXSv7wLMYR8T9UCtch5+f2M4R3L272X3RQEHtzPA1\r\n53OHt+nEEYXl/WhXylfuG9/ZhsNPNhlvHMPujLBLqnOGm01I64koCT4JzCIE\r\n7rPG7GbZIX/uDbuD9bNnG1D0JO+CeFzwyaq6U0s2xcUxJHjZiwZVr60FVBQw\r\nfXEmTHCelygPY89sAQKoBPc3/pVkP2HaoLE=\r\n=8Hdh\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"icarrilloqueroari","email":"ivan.carrillo@atos.net"},"directories":{},"maintainers":[{"name":"icarrilloqueroari","email":"ivan.carrillo@atos.net"},{"name":"alberto_goujon","email":"alberto.goujon@atos.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aeolixsdk-node_0.3.5_1652350610596_0.9199158986850078"},"_hasShrinkwrap":false},"0.3.6":{"name":"@ari-tsum/aeolixsdk-node","version":"0.3.6","private":false,"main":"index.js","dependencies":{"es6-promise":"^4.1.1","keypair":"^1.0.1","socket.io-client":"^2.1.0","xmlhttprequest-cookie":"0.9.4"},"engines":{"node":"6.10.x","npm":"3.10.x"},"author":{"name":"Alberto Goujon"},"license":"GPLv3","contributors":[{"name":"Alberto Goujon","email":"alberto.goujon@atos.net"},{"name":"Iván Carrillo","email":"ivan.carrillo@atos.net"}],"gitHead":"aea595cec6e413e81f4800360736833597f691d1","description":"(This repository is part of the AEOLIX platform and contains only the Software Development Toolkit)","_id":"@ari-tsum/aeolixsdk-node@0.3.6","_nodeVersion":"18.1.0","_npmVersion":"8.8.0","dist":{"integrity":"sha512-0NbXOR2VExuxpgZRjkg/iHng2KL1LE/14sHD5TMl3lm9Z/4THCpFyqbW4iZfNfc5XW8Ju5EUYxH3buob6o3PHA==","shasum":"3ad08eada9688f87ee8e0e4cf887ecb8ecdb72dc","tarball":"https://registry.npmjs.org/@ari-tsum/aeolixsdk-node/-/aeolixsdk-node-0.3.6.tgz","fileCount":10,"unpackedSize":71947,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIA9jv/ZdyPCo4oPecCWx7ccQeQLHcXg+lDC6ySaZGyhRAiEAmppY6+WRc8tQdkCA0LlTiRQ670NeE6wFAA+drPBq+7w="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJifOBIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoI+g//VemUa42fEMUZUhtm6s1qIkmwuIoe9eaTDNCUc+Lmh/1oRhNR\r\nlnLq0OzAChmasFBBlD8SbkdmnGbotI+ZmMOiXttkR5BYnMgzQsveKlDMT+/U\r\nzua1ithnWfa1Kl1BrxzUtn7aj+Oyqx73R3UwLhfniFlsrI6MrDcerq6Va/Ch\r\nW6PTBsje6QtQLq2ZpdmIIMvMWnXtKwX87n/x7+9il5jcQt63yHaJ12IW+sdY\r\nJUvD9swL5tiPETkYd/aFWfAH3dbUOiamCcA7F7Sieh7X8JbaUKlxbR30HIMZ\r\nPPePNqyYfcbBK5q7NfjXVI1RPDVL6IKcgJIQiu7lVpJit6e/8akW+zSK3EGy\r\nSRgKGimG1vBzTAf5Qym5bIFAqv1girZRZH/xIoiO5JEilhdc+qkoWUlTDPSQ\r\n/88e+n/G/wad8Q7o+EUYITyW1ZNo0ALtSUalSGXRR058RaOLqyF911clgQOZ\r\nkk1AUnHvdtU5DG1cRL6wMjKbHx55bdQgB9aEjT5xDPVAEZepJYedvPvDKr2V\r\ntiJ7epkLByj1KCYIhDXjOd5BuKVod3/neEMfGwSwKr6iBuahHyj+767WrxhR\r\n9z7mPhyCtJwPDYTNskJ2lbb1bJazuRciGuGC8JrhdtYMP80qXio2OtTw9+my\r\nSIw7+E/bWChpwg4jNhhbhTPhGhFxoV8sPSs=\r\n=RdV5\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"icarrilloqueroari","email":"ivan.carrillo@atos.net"},"directories":{},"maintainers":[{"name":"icarrilloqueroari","email":"ivan.carrillo@atos.net"},{"name":"alberto_goujon","email":"alberto.goujon@atos.net"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/aeolixsdk-node_0.3.6_1652351048373_0.7100377191839431"},"_hasShrinkwrap":false}},"time":{"created":"2022-05-04T08:33:06.231Z","0.3.4":"2022-05-04T08:33:06.530Z","modified":"2022-05-12T10:24:08.671Z","0.3.5":"2022-05-12T10:16:50.789Z","0.3.6":"2022-05-12T10:24:08.564Z"},"maintainers":[{"name":"icarrilloqueroari","email":"ivan.carrillo@atos.net"},{"name":"alberto_goujon","email":"alberto.goujon@atos.net"}],"description":"(This repository is part of the AEOLIX platform and contains only the Software Development Toolkit)","contributors":[{"name":"Alberto Goujon","email":"alberto.goujon@atos.net"},{"name":"Iván Carrillo","email":"ivan.carrillo@atos.net"}],"author":{"name":"Alberto Goujon"},"license":"GPLv3","readme":"# SDK for nodeJS version 0.3.Xs\n\n(This repository is part of the AEOLIX platform and contains only the Software Development Toolkit)\n\n## Pre-requisites\n\nInstall the sdk and import it in your project\n\n```\n    npm install @ari-tsum/aeolixsdk-node\n\n    var AeolixSDK = require('aeolixsdk-node');\n```\n\n# Instance the SDK\n\n```\n  var sdk = new AeolixSDK([args]);\n  \n```\n\n### Arguments:\n\n  * args: any\n\nBy default, the SDK will connect to the FENIX production instance. You can set the \"fenixDev\" arg to \nconnect to the FENIX-dev instace instead, or even set a custom URL as shown below:\n\n```\n    {\n      \"autoRefresh\": boolean,\n      \"fenixDev\": boolean, // Connects to fenix-dev instance\n      \"restServerUrl\": string, // Optional, configure a custom AEOLIX rest URL\n      \"socketServerUrl\": string, // Optional, configure a custom AEOLIX socket URL\n\n    }\n```\n\n# Login\n\nThe loging to the AEOLIX platform is made throught the keycloak IDM.\n\n\n## Login throught Keycloak with username and password\n\n```\n  sdk.login(userData, control);\n\n```\n\n### Arguments:\n\n  * userData: any\n\n```\n    {\n      \"username\":\"username\",\n      \"password\":\"pwd\",\n      \"type\":\"user\"\n    }\n```\n\n  * control: function to receive server responses.\n\n# Set Token\n\nLoging to the AEOLIX platform using a token from a previous login.\n\n\n## Login throught Keycloak with access token\n\n```\n  sdk.setToken(accessToken, control);\n\n```\n\n### Arguments:\n\n  * accessToken: token from a previous login response\n  * control: function to receive server responses.\n\n\n# Refresh token\n\nRefresh the token previously generated by login or token exchange throught Keycloak. Version 0.3.2 and higher don't refresh the token automatically\n\n\n## Refres access token throught Keycloak\n\n```\n  sdk.refreshToken(control);\n\n```\n\n### Arguments:\n\n  * control: function to receive server responses.\n\n\n# Publish\n\nThis functionality allows to publish a message. \n\n```\n  sdk.publish(dataSourceID, data, control);\n\n```\n\n### Arguments:\n\n  * dataSourceID: data source granted for publish.\n  * data: String containing the data to be published.\n  * control: function to receive server responses.\n\n# Subscribe\n\nThis functionality allows to subscribe to an specific datasource and receive all the published information.\n\n```\n   sdk.subscribe(dataSourceID, callback, control);\n```\n\n### Arguments:\n\t\n  * DatasourceID: Datasource granted for subscribtion.\t\t\n\t* callback: callback function to receive AEOLIX data messages.\n  * control: function to receive server responses.\n\n\nEach time that a message arrives, the callback will be executed to receive the data message.\n\n\n# Unsubscribe\n\nThis operation will allow to stop receiving data from a subscription.\n\n```\n  sdk.unsubscribe(dataSourceID, control);\n```\n\n### Arguments:\n\t\n  * DatasourceID: Datasource previously subscribed.\t\t\n  * control: function to receive server responses.\n\n\n# Send Service Request\n\nThis functionality allows to publish a service request. \n\n```\n  sdk.sendServiceRequest(serviceID, payload, control);\n\n```\n\n### Arguments:\n\n  * serviceID: service granted for access.\n  * payload: String containing the request payload.\n  * control: function to receive server responses.\n\n# Subscribe to Service Request\n\nThis functionality allows to subscribe to an specific service and receive all the user's requests.\n\n```\n   sdk.subscribe2ServiceRequest(serviceID, callback, control);\n```\n\n### Arguments:\n\t\n  * serviceID: service owned.\t\t\n\t* callback: callback function to receive AEOLIX service requests.\n  * control: function to receive server responses.\n\n\nEach time that a message arrives, the callback will be executed to receive the data message.\n\n\n# Unsubscribe Service Request\n\nThis operation will allow to stop receiving data from a service request subscription.\n\n```\n  sdk.unsubscribeServiceRequest(serviceID, control);\n```\n\n### Arguments:\n\t\n  * serviceID: service previously subscribed.\t\t\n  * control: function to receive server responses.\n\n\n# Send Service Response\n\nThis functionality allows to publish a service response. \n\n```\n  sdk.sendServiceResponse(serviceID, userID, payload, control);\n\n```\n\n### Arguments:\n\n  * serviceID: service owned.\n  * userID: user to send response.\n  * payload: String containing the response payload.\n  * control: function to receive server responses.\n\n# Subscribe to Service Response\n\nThis functionality allows to subscribe to an specific service and receive all the owner responses.\n\n```\n   sdk.subscribe2ServiceResponse(serviceID, callback, control);\n```\n\n### Arguments:\n\t\n  * serviceID: service granted to access.\t\t\n\t* callback: callback function to receive AEOLIX service responses.\n  * control: function to receive server responses.\n\n\nEach time that a message arrives, the callback will be executed to receive the data message.\n\n\n# Unsubscribe Service Response\n\nThis operation will allow to stop receiving data from a service response subscription.\n\n```\n  sdk.unsubscribeServiceResponse(serviceID, control);\n```\n\n### Arguments:\n\t\n  * serviceID: service previously subscribed.\t\t\n  * control: function to receive server responses.\n\n\n# License\n\nDue the interoperability needs of these architectures, MyAEOLIX has been fully\ndesigned considering Free Libre Open Source Software technologies.\nThe project has been designed and implemented by the Transport Systems and Urban Mobility Unit in the Research & Innovation department in ATOS Spain.\n","readmeFilename":"README.md"}