Modules

A module represents a collection in the database.

It consists of three configurations:

Schema
Layout
Definitions

Modules are a basic building blocks of JMS. They are written as JavaScript Objects and reside in setup directory.

Any change to setup and it's modules requires a redeploy to Firestore, which is achieved by running:

cd setup
ts-node setup.ts

Interface#

interface Module {
  id: string;
  createdOn: number;
  name: string;
  order: number;
  description: string;
  schema: JSONSchema;
  layout?: ModuleLayout;
  definitions?: ModuleDefinitions;
  authorization?: ModuleAuthorization;
  metadata?: ModuleMetadata;
  subCollectionPath?: string;
  collectionGroup?: boolean;
}

JSONSchema ModuleLayout ModuleDefinitions