@eventzerohuddle/centralised_modals

Centralised Mongoose Models for EventZero applications.

Description

This package contains all the shared Mongoose models used across EventZero applications. It provides a centralized location for database schema definitions, ensuring consistency across different services and applications.

Installation

npm install @eventzerohuddle/centralised_modals

Usage

import {
  AccommodationModal,
  EventModal,
  OrganizationModal,
  FlightModal,
  CventBudgetItemsModal,
  CventSyncModal,
} from "@eventzerohuddle/centralised_modals";

// Use the models in your application
const events = await EventModal.find({});
const organizations = await OrganizationModal.find({});

Available Models

• AccommodationModal - Hotel accommodation data
• EventModal - Event information and details
• OrganizationModal - Organization data and settings
• FlightModal - Flight travel information
• CventBudgetItemsModal - Cvent budget items for food and beverages
• CventSyncModal - Cvent synchronization configuration

Types and Constants

The package also exports TypeScript types and constants:

import {
  IEvent,
  IOrganization,
  IFlight,
  IAccommodation,
  ICventBudgetItem,
  ICventSync,
  SCHEME_EVENT,
  SCHEME_ORGANIZATION,
  // ... other constants
} from "@eventzerohuddle/centralised_modals";

Development

Prerequisites

• Node.js 20+
• npm

Setup

npm install

Build

npm run build

Lint

npm run lint

Development Mode

npm run dev

Publishing

This package is automatically published to GitHub Packages when changes are pushed to the main branch or when manually triggered through GitHub Actions.

License

ISC