Bennie and the AI Jets Shared Mongoose Models

This repository contains shared Mongoose models used across all Bennie and the AI Jets Node.js applications.

Contents

• Models:
  • Run
  • JobStatus
  • LanguageObject

Usage in Other Applications

To use these models in your application, follow these steps:

1. Install the package:

   npm install ben-ai-models-registry

2. Import the models:

   import { Run, JobStatus, LanguageObject } from 'ben-ai-models-registry';

Modifying the Model Locally for Another Project

If you need to adapt the models for a specific project without immediately publishing changes to the ben-ai-models-registry package, you can modify them locally:

1. Navigate to the ben-ai-models-registry folder within your project's node_modules directory:

   <your_project>\node_modules\ben-ai-models-registry

2. Make your changes directly in the local files of the ben-ai-models-registry package.

3. To ensure your project uses the locally modified version, update the package.json file in your project (located at <your_project>\package.json) by specifying a local file dependency:

   "dependencies": {
       "ben-ai-models-registry": "file:../ben-ai-models-registry"
   }

   Note: Adjust the relative path (../ben-ai-models-registry) based on the location of the ben-ai-models-registry folder relative to your project.

4. Run npm install in your project directory to apply the changes and link the local version of the package.

Publishing Changes to the ben-ai-models-registry Package:

1. Clone the repository

2. Make your changes.

3. Update the version number in package.json to the next version.

4. Login to npm:

   npm login

5. Publish the updated package to npm:

   npm publish

Note: You must have publishing access to the npm package to publish changes.

Feel free to contribute to the repository by submitting pull requests with your improvements and suggestions.