@dab-co/jam-sqlite

Installing this module

• npm --registry=https://npm.pkg.github.com adduser
• npm config set @dab-co:registry https://npm.pkg.github.com
• npm install

Testing

• Unit tests are in test folder. If you add new functionality, add the unit test for it there.
• Unit tests can be run via npm test
• Optionally, you can link your unpublished package from a local project via npm link "local path to this package". The version in package.json should match to the local copy's package.json version.

Updating and publishing the package

• Update the version from package.json and run npm install to update package-lock.json. Follow the semantic versioning guidelines.

  • As the website explains it:

    Summary

    Given a version number MAJOR.MINOR.PATCH, increment the:

    • MAJOR version when you make incompatible API changes,
    • MINOR version when you add functionality in a backwards compatible manner, and
    • PATCH version when you make backwards compatible bug fixes.

• Once you are done with changes and all the unit tests pass, you need to use npm publish in order to be able to install it via npm install. This will upload the package to the github registry. If this doesn't work, try running npm login --scope=@github_username --registry=https://npm.pkg.github.com first.

Project Structure

• Every table in the database will have corresponding utility file. They will make use of the databaseWrapper class by aggregating it. By aggregation, we make sure every utility file makes use of the intended database connection.

• Preferably DatabaseWrapper class will be instantiated in a header file to make sure that only one connection is opened. Whenever a utility file is needed, the instantiated databaseWrapper object will be fed into the corresponding class.

Example usage on production:

using InitializeUtils class to initialize all table utils

// initializeUtils.js
const jam_sqlite = require("@dab-co/jam-sqlite");

const Database = jam_sqlite.Database;
const database = new Database(path.join(process.env.db_path));

const utilsInitializer = new jam_sqlite.Utils.UtilsInitializer(database);

module.exports = utilsInitializer;

// some file that uses any one of the utils
const utilsInitializer = require("./initializeUtils.js");
const accountUtils = utilsInitializer.accountUtils();
const userFriendsUtils = utilsInitializer.userFriendsUtils();

Initializing each table util by hand

// initializeDatabase.js
const DatabaseWrapper = require("@dab-co/jam-sqlite").DatabaseWrapper;
const databaseWrapper = new DatabaseWrapper("database.db");
module.exports = databaseWrapper;

// some file that uses any one of the utils
const databaseWrapper = require("./initializeDatabase.js");
const AccountUtils = require("@dab-co/jam-sqlite").Utils.AccountUtils;
const accountUtils = new AccountUtils(databaseWrapper);