README

NPM Cribbound Types Package

This project contains the Types Definitions for our system. it also contains the database queries/actions against the database.

The types are based on our DB Schema. If we ever add a column or change something on the database schema, we need to come here and change it here as well, publish it to NPM and update the version from wherever we are using it.

For each entity (table) there is a folder with:

• api.ts
• types.ts
• index.ts

types.ts

Here you define the actual Type (type Job). But we also define the Inputs for all the operations we want to do against Job (create Job Input, find Job input, search Jobs input, etc...) Potentially in the future we will have to create also the Output types if neccessary. We also need to define transformators functions here (see jobs example)

api.ts

Here we define all the operations for an entity (table). For Jobs for example, at the moment we have this operations:

• findJob
• existsJob
• searchJobs
• employerJobs
• createJob The database queries are also defined here

index.ts

Exports the types and the api

You can use this Package from another project (services) installing it like this: npm install @cribbound/types (see cribbound-services for an example)

DB Access and Connection

The file db.ts is very important. It exports DBConnection, which is a class that reperesents a database connection to an actual deployed database and you can run queries from an inside methos. This class is used from all the APIs.

It also exports a getDB(config) method, which is used from the services to retrieve a valid DBConnection. The configuration of the DB Client is passed from the services. In this way, in the future, we can have different databases deployed and deal with the connection from the services using different environments/stages

Publish NPM Package

npm run build npm publish --access public

To make it work locally link it, (remember to unlink it when we finish testing it locally) npm link @cribbound/types npm unlink @cribbound/types