\n\n\n\n> Ltijs Sequelize Database Plugin.\n\n[](https://travis-ci.org/Cvmcosta/ltijs)\n[](https://codecov.io/gh/Cvmcosta/ltijs)\n[](https://www.npmjs.com/package/ltijs)\n[](https://www.npmjs.com/package/ltijs-sequelize)\n[](https://david-dm.org/cvmcosta/ltijs)\n[](https://david-dm.org/cvmcosta/ltijs?type=dev)\n[](https://standardjs.com)\n[](#license)\n[](https://www.buymeacoffee.com/UL5fBsi)\n\n\nPlease ⭐️ us on [GitHub](https://github.com/Cvmcosta/ltijs), it always helps!\n\n> [Ltijs is LTI® Advantage Complete Certified by IMS](https://site.imsglobal.org/certifications/coursekey/ltijs)\n\n> *Learning Tools Interoperability® (LTI®) is a trademark of the IMS Global Learning Consortium, Inc. (https://www.imsglobal.org)*\n\n> V2.4.0\n> - Added support for `authorizationServer` Platform field, introduced on version `5.7.0` of Ltijs.\n> - Added support for automatic migrations. This will greatly increase flexibility.\n\n> V2.3.0\n> - Added support for Dynamic Registration Service, introduced on version `5.5.0` of Ltijs.\n\n## Table of Contents\n\n- [Introduction](#introduction)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Contributing](#contributing)\n- [License](#license)\n\n\n---\n## Introduction\n\nThis package allows [Ltijs](https://cvmcosta.github.io/ltijs) to work with the databases supported by [Sequelize](https://sequelize.org/master/).\n\n#### Tested with:\n\n| Database | Tested |\n| --------- | - |\n| MySQL |
✔️
|\n| PostgreSQL |
✔️
|\n| MariaDB |
|\n\n#### Ltijs Compatibility:\n\n\n| Ltijs-sequelize version | Ltijs version |\n| --------- | --------- |\n| ^2.4.2 | ^5.7.0 |\n| ^2.3.0 | ^5.5.0 |\n| ^2.2.0 | ^5.3.0 |\n\n\n\n---\n\n\n## Installation\n\n```shell\n$ npm install ltijs-sequelize\n```\n\n---\n\n## Usage\n\n> Setup the plugin just like you would a [Sequelize](https://sequelize.org/master/manual/getting-started.html) instance.\n\n- **database** - Database name.\n- **user** - Database user.\n- **pass** - Database password.\n- **options** - Options as defined in the [Sequelize constructor documentation](https://sequelize.org/master/class/lib/sequelize.js~Sequelize.html). **`host` and `dialect`** fields are required.\n - **host** - Database host.\n - **dialect** - One of `mysql`, `mariadb`, `postgres`, `mssql`.\n\n```javascript\nconst path = require('path')\n\n// Require Provider \nconst lti = require('ltijs').Provider\nconst Database = require('ltijs-sequelize')\n\n// Setup ltijs-sequelize using the same arguments as Sequelize's generic contructor\nconst db = new Database('database', 'user', 'password', \n { \n host: 'localhost',\n dialect: 'mysql',\n logging: false \n })\n\n// Setup provider\nlti.setup('LTIKEY', // Key used to sign cookies and tokens\n { \n plugin: db // Passing db object to plugin field\n },\n { // Options\n appRoute: '/', loginRoute: '/login', // Optionally, specify some of the reserved routes\n cookies: {\n secure: false, // Set secure to true if the testing platform is in a different domain and https is being used\n sameSite: '' // Set sameSite to 'None' if the testing platform is in a different domain and https is being used\n },\n devMode: false // Set DevMode to true if the testing platform is in a different domain and https is not being used\n }\n)\n\n// Set lti launch callback\nlti.onConnect((token, req, res) => {\n console.log(token)\n return res.send('It\\'s alive!')\n})\n\nconst setup = async () => {\n // Deploy server and open connection to the database\n await lti.deploy({ port: 3000 }) // Specifying port. Defaults to 3000\n\n // Register platform\n await lti.registerPlatform({\n url: 'https://platform.url',\n name: 'Platform Name',\n clientId: 'TOOLCLIENTID',\n authenticationEndpoint: 'https://platform.url/auth',\n accesstokenEndpoint: 'https://platform.url/token',\n authConfig: { method: 'JWK_SET', key: 'https://platform.url/keyset' }\n })\n}\n\nsetup()\n```\n\n---\n\n\n## Contributing\n\nPlease ⭐️ us on [GitHub](https://github.com/Cvmcosta/ltijs), it always helps!\n\nIf you find a bug or think that something is hard to understand feel free to open an issue or contact me on twitter [@cvmcosta](https://twitter.com/cvmcosta), pull requests are also welcome :)\n\n\nAnd if you feel like it, you can donate any amount through paypal, it helps a lot.\n\n\n\n### Main contributors\n\n
\n\n> I would like to thank the Federal University of Maranhão and UNA-SUS/UFMA for the support throughout the entire development process.\n\n\n\n\n
\n \n\t\n
\n\n> I would like to thank CourseKey for making the Certification process possible and allowing me to be an IMS Member through them, which will contribute immensely to the future of the project.\n\n\n\n---\n\n## License\n\n[](LICENSE)\n\n","readmeFilename":"README.md"}
![](\"https://raw.githubusercontent.com/Cvmcosta/ltijs/master/docs/logo-300.svg\"){kind=logo}
\n ![\"IMS](\"https://www.imsglobal.org/sites/default/files/IMSconformancelogoREG.png\")
\n![\"Buy](\"https://cdn.buymeacoffee.com/buttons/lato-green.png\")
\n\n### Main contributors\n\n![\"Carlos](\"https://avatars2.githubusercontent.com/u/13905368?s=460&v=4\")
![\"Lucas](\"https://avatars1.githubusercontent.com/u/45924589?s=460&v=4\")
![\"Micael](\"https://avatars0.githubusercontent.com/u/23768058?s=460&v=4\")
![](\"https://raw.githubusercontent.com/Cvmcosta/ltijs/master/docs/ufma-logo.png\"){kind=logo}
\n ![](\"https://raw.githubusercontent.com/Cvmcosta/ltijs/master/docs/unasus-logo.png\"){kind=logo}
\n![](\"https://raw.githubusercontent.com/Cvmcosta/ltijs/master/docs/coursekey-logo.png\"){kind=logo}
\n