elements module for the Molecuel framework. Creating and configuring data models and validation for the database persistence layer. New database connections (documentdb + elasticsearch) are in progress. They will be implemented as adapters and it will be possible to save to different databases with one save method and define the population level of the data in a special population level to denormalize the data for aggregation and optimized reading. Elements is able to export all registered Typescript classes as graphql schema which can be used with any graphql server.
To start it, simply import and instantiate it. If you want to make use of molecuel's offered databases (e.g. @molecuel/mongodb), include them in @molecuel/di's bootstrap. Necessary configurations are read on instantiation via @molecuel/core's config functionality or manually via @molecuel/database's methods. Finally initialize the instance. Examples:
import { MlclElements } from "@molecuel/elements";
const elements = new MlclElements();
OR
import { di } from "@molecuel/di";
import { MlclElements } from "@molecuel/elements";
const elements = di.getInstance("MlclElements");
Configuration settings are imported via separate files and a reference path (e.g.: ./config/production.json)
{
"databases": [
{
"layer": "persistence",
"name": "mongodb_pers",
"type": "MlclMongoDb",
"uri": "mongodb://localhost/mongodb_persistence"
},
{
"layer": "population",
"name": "mongodb_popul",
"type": "MlclMongoDb",
"url": "mongodb://localhost/mongodb_population"
}
]
}
process.env.configpath = "./config/";
import { di } from "@molecuel/di";
import { MlclElements } from "@molecuel/elements";
import { MlclMongoDb } from "@molecuel/mongodb";
di.bootstrap(MlclMongoDb);
const elements = di.getInstance("MlclElements");
or via objects and a manual method call
import { di } from "@molecuel/di";
import { MlclElements } from "@molecuel/elements";
import { MlclMongoDb } from "@molecuel/mongodb";
const config = {
databases: [
{
layer: "persistence",
name: "mongodb_pers",
type: "MlclMongoDb",
uri: "mongodb://localhost/mongodb_persistence"
},
{
layer: "population",
name: "mongodb_popul",
type: "MlclMongoDb",
url: "mongodb://localhost/mongodb_population"
}
]
};
di.bootstrap(MlclMongoDb);
const elements = di.getInstance("MlclElements");
elements.dbHandler.addDatabasesFrom(config);
import { di, injectable } from "@molecuel/di";
import { MlclElements } from "@molecuel/elements";
const elements = di.getInstance("MlclElements");
const success = await elements.init();
process.env.configpath = "./config/";
import { di, injectable } from "@molecuel/di";
import {
Collection,
Element,
IsDefined,
MlclElements,
NotForPopulation } from "@molecuel/elements";
import * as D from "@molecuel/elements";
import { MlclMongoDb } from "@molecuel/mongodb";
di.bootstrap(MlclMongoDb);
const elements = di.getInstance("MlclElements");
await elements.init();
@injectable
@Collection("post")
@NotForPopulation()
class Message extends Element {
@IsDefined()
@D.ValidateType([String])
public recipients: string[];
@D.ValidateType()
public sender: string;
@D.ValidateType()
public content: string;
constructor(recipients: string[], sender: string, content: string) {
super(elements);
this.recipients = recipients;
this.sender = sender;
this.content = content;
}
}
let exampleMessage = elements.getInstance("Message", ["you"], "me", "Text snippet.");
await exampleMessage.save();
await elements.find(exampleMessage._id, Message.collection);
const elements = di.getInstance("MlclElements");
// returns schema as string
const schema = elements.renderGraphQL();
We are using npm to build the entire module. During development we use the tsc compiler defined in the task.json for visual studio code cause the incremental compilation is very fast. To start the build and watch process in Visual Studio Code just press CTRL+SHIFT+B. The build console should come up and show you the results of the build process. Any other editor can be used or just use tsc -w -p . on the commandline.
All available npm options:
Executes the linter for the typescript files in the src folder
Executes the linter for the typescript files in the test folder
Runs the Typescript compiler for all files in the src directory
Runs the Typescript compiler for all files in the test directory
Executes thes linter for the files in the src folder and runs the typescript compiler for the files in the src folder.
Executes thes linter for the files in the test folder and runs the typescript compiler for the files in the test folder.
Executes thes linter for the files in the src and test folder and runs the typescript compiler for the files in the src and test folder.
Just executes the local mocha command which relies in the local node_modules directory.
Executes the compilation of the test files and runs the mocha test.
Runs the istanbuld code coverage test and remaps the results to the typescript sources
Remaps the code coverage report to typescript
Remaps the html output of istanbul to the typescript sources
Remaps the lcov reports to the typescript sources
Runs the code coverage reports, the remaps and send the results to the coveralls.io service
Creates the HTML for the API documentation in the docs folder. The docs folder is in .gitignore and not part of the master branch.
Publishes the API documentation to the gh-pages branch.
Shortcut for createdocs and publishdocs
Checks it the package version in package.json is higher than the registered one in npm registry and published the package if the version is higher.