justair-library

Overview

The justair-library is an NPM package that is installed on all backend and AWS Lambda services within the JustAir ecosystem. It provides essential utilities and shared functionality used across various JustAir services.

Prerequisites

To access and install the justair-library, you must be a part of the JustAir organization on npmjs.org. Ensure you have the following:

1. NPM - Node Package Manager
2. Access Token - Obtain your access token from the JustAir organization on npmjs.org

Installation

To install the justair-library, use the following command:

npm install @justair/justair-library

Ensure you have authenticated with npmjs.org using your access token:

npm login
# Follow the prompts to authenticate

Alternatively, you can set your token directly in your NPM configuration:

npm set //registry.npmjs.org/:_authToken=YOUR_ACCESS_TOKEN

Usage

After installation, you can import and use the library in your project:

const justair = require("@justair/justair-library");

// Example usage
justair.someUtilityFunction();

Upgrading Versions

To upgrade to a newer version of the justair-library, run:

npm update @justair/justair-library

Ensure you review the release notes and any potential breaking changes before upgrading.

Publishing a New Version

Testing Locally Before Publishing

Before publishing to npm, it's recommended to test your package locally:

1. Build and pack the library locally:

   npm run build  # If you have a build step
   npm pack

   This creates a .tgz file (e.g., justair-justair-library-1.0.0.tgz)

2. Install in a test project:

   In your test project directory:

   npm install /path/to/justair-library/justair-justair-library-1.0.0.tgz

   Or using npm link for development:

   # In the justair-library directory
   npm link
   
   # In your test project directory
   npm link @justair/justair-library

3. Test your changes:

   Import and test the library in your test project to ensure everything works as expected.

4. Unlink when done (if using npm link):

   # In your test project directory
   npm unlink @justair/justair-library
   
   # In the justair-library directory
   npm unlink

Publishing to npm

Once you've tested locally and are ready to publish:

1. Update the version number:

   Modify the version field in package.json according to semantic versioning guidelines.

2. Build the package (if applicable):

   Ensure any build steps are completed:

   npm run build

3. Login to npm:

   Ensure you are authenticated with the JustAir organization on npmjs.org:

   npm login
   # Follow the prompts to authenticate

4. Publish the package:

   Run the following command to publish the updated package:

   npm publish --access public

Contributing

If you would like to contribute to this project, please fork the repository and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

For any inquiries or support, please contact the development team.