cesarpachon/ltijs-sequelize

Ltijs Sequelize Database Plugin

Ltijs Sequelize Database Plugin.

Please ⭐️ us on GitHub, it always helps!

Ltijs is LTI® Advantage Complete Certified by IMS

Learning Tools Interoperability® (LTI®) is a trademark of the IMS Global Learning Consortium, Inc. (https://www.imsglobal.org)

V2.2.0

• Added 'state' table to reflect changes made to the latest version of ltijs (5.3.0).
• Added indexes to improve performance. V2.1.0 BREAKING CHANGES
• Some fields were moved from the idtoken to the contexttoken, The roles, endpoint, lis and namesRoles fields change with the launch context, and cannot be treated as static values. They can now be found inside the contexttoken object along with all the other context specific information.
• It is recommended to delete the idtoken and contextoken tables when updating to version 2.1, the schema changes can cause errors on relational databases. These tables are repopulated on every launch, so no relevant information will be lost.

Table of Contents

• Introduction
• Installation
• Usage
• Contributing
• License

---

Introduction

This package allows Ltijs to work with the databases supported by Sequelize.

Tested with:

Database	Tested
MySQL	✔️
PostgreSQL	✔️
MariaDB

Ltijs Compatibility:

Ltijs-sequelize version	Ltijs version
^2.2.0	^5.3.0
2.1.0	5.2.1
1.0.0	5.1.0

---

Installation

$ npm install ltijs-sequelize

---

Usage

Setup the plugin just like you would a Sequelize instance.

• database - Database name.
• user - Database user.
• pass - Database password.
• options - Options as defined in the Sequelize constructor documentation. host and dialect fields are required.
  • host - Database host.
  • dialect - One of mysql, mariadb, postgres, mssql.

const path = require('path')

// Require Provider 
const lti = require('ltijs').Provider
const Database = require('ltijs-sequelize')

// Setup ltijs-sequelize using the same arguments as Sequelize's generic contructor
const db = new Database('database', 'user', 'password', 
  { 
    host: 'localhost',
    dialect: 'mysql',
    logging: false 
  })

// Setup provider
lti.setup('LTIKEY', // Key used to sign cookies and tokens
  { 
    plugin: db // Passing db object to plugin field
  },
  { // Options
    appRoute: '/', loginRoute: '/login', // Optionally, specify some of the reserved routes
    cookies: {
      secure: false, // Set secure to true if the testing platform is in a different domain and https is being used
      sameSite: '' // Set sameSite to 'None' if the testing platform is in a different domain and https is being used
    },
    devMode: false // Set DevMode to true if the testing platform is in a different domain and https is not being used
  }
)

// Set lti launch callback
lti.onConnect((token, req, res) => {
  console.log(token)
  return res.send('It\'s alive!')
})

const setup = async () => {
  // Deploy server and open connection to the database
  await lti.deploy({ port: 3000 }) // Specifying port. Defaults to 3000

  // Register platform
  await lti.registerPlatform({
    url: 'https://platform.url',
    name: 'Platform Name',
    clientId: 'TOOLCLIENTID',
    authenticationEndpoint: 'https://platform.url/auth',
    accesstokenEndpoint: 'https://platform.url/token',
    authConfig: { method: 'JWK_SET', key: 'https://platform.url/keyset' }
  })
}

setup()

---

Contributing

Please ⭐️ us on GitHub, it always helps!

If you find a bug or think that something is hard to understand feel free to open an issue or contact me on twitter @cvmcosta, pull requests are also welcome :)

And if you feel like it, you can donate any amount through paypal, it helps a lot.

Main contributors

Carlos Costa 💻💬 📖 👀 📢

Lucas Terças 📖 🔧

Micael Gomes 🎨

---

Special thanks

I would like to thank the Federal University of Maranhão and UNA-SUS/UFMA for the support throughout the entire development process.

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.

---

License