apm-optima 1.0.0 → 1.0.1

package/CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing to Optima APM
+
+Thank you for your interest in contributing to **Optima APM**! We welcome bug fixes, feature proposals, documentation updates, and performance improvements.
+
+This document provides a set of guidelines and instructions for setting up your local development environment and contributing to the project.
+
+---
+
+## Table of Contents
+
+- [Code of Conduct](#code-of-conduct)
+- [Monorepo Architecture](#monorepo-architecture)
+- [Prerequisites](#prerequisites)
+- [Local Development Setup](#local-development-setup)
+- [Project Workflow & Commands](#project-workflow--commands)
+- [Development Guidelines](#development-guidelines)
+- [Submitting a Pull Request](#submitting-a-pull-request)
+
+---
+
+## Code of Conduct
+
+Please be respectful, constructive, and collaborative in all communications, issues, and Pull Requests.
+
+---
+
+## Monorepo Architecture
+
+This project is structured as a **Monorepo** using **npm workspaces**:
+
+```
+├── packages/
+│   └── core/          # Telemetry engine, interceptors, and WebSocket adapters (apm-optima/core)
+│   └── dashboard/     # Next.js React Dashboard (exported statically into apm-optima/core)
+├── apps/              # Integration & demo application (Express & NestJS)
+```
+
+- **`apm-optima/core`**: The published npm package containing the telemetry engine.
+- **`packages/dashboard`**: A Next.js application that gets exported statically (`output: 'export'`) and bundled into `apm-optima/core`.
+- **`apps`**: A local environment used to test `apm-optima/core` changes in real time.
+
+---
+
+## Prerequisites
+
+Ensure you have the following installed locally:
+
+- **Node.js**: `>= 20.0.0` (LTS version recommended)
+- **npm**: `>= 10.0.0` (Native support for npm workspaces)
+- **Git**: `>= 2.x`
+
+---
+
+## Local Development Setup
+
+Follow these steps to clone and run the repository locally:
+
+### 1. Clone the Repository
+
+```bash
+git clone https://github.com/Nosalis1/Optima.git
+cd Optima
+```
+
+### 2. Install Dependencies
+
+Install all dependencies across the entire monorepo with a single command from the root directory:
+```bash
+npm install
+```
+
+### 3. Build the Packages
+
+Build all packages in order (this compiles the Next.js static dashboard and builds `apm-optima/core`):
+```bash
+npm run build
+```
+
+---
+
+## Project Workflow & Commands
+
+You can run workspace tasks from the root directory using central npm scripts:
+
+### Build Commands
+
+| Command | Description |
+| :--- | :--- |
+| `npm run build` | Builds the Dashboard first, then compiles `apm-optima/core`. |
+| `npm run build:dashboard` | Statically exports the Next.js Dashboard into `apps/dashboard/out`. |
+| `npm run build:core` | Compiles TypeScript code for `apm-optima/core`. |
+| `npm run clean` | Cleans `dist`, `.next`, and build artifacts across all packages. |
+
+### Development Commands
+
+| Command | Description |
+| :--- | :--- |
+| `npm run dev:dashboard` | Runs Next.js Dashboard in dev/watch mode (`localhost:3001`). |
+| `npm run dev:core` | Runs TypeScript watch mode for `apm-optima/core`. |
+| `npm run dev:express` | Launches the Express integration demo. |
+| `npm run dev:nest` | Launches the NestJS integration demo. |
+| `npm test` | Runs test suites inside `apm-optima/core`. |
+
+---
+
+## Development Guidelines
+
+**Working with Core and Dashboard**
+
+1. **Dashboard Changes:** Any UI changes inside `packages/dashboard` need to be statically exported before being served via `apm-optima/core`.
+2. **Local Linking:** Thanks to `npm workspaces`, `example-app` automatically links to `apm-optima/core` in real time without needing `npm link`.
+3. **TypeScript:** Ensure all packages compile without errors (`npm run build`) before submitting changes.
+
+---
+
+## Submitting a Pull Request
+
+1. **Fork & Branch:** Create a fork of the repository and create a new feature branch:
+```bash
+git checkout -b feat/your-feature-name
+```
+2. **Commit Changes:** Write clear, concise commit messages following conventions:
+- `feat`: New features
+- `fix`: Bug fixes
+- `docs`: Documentation changes
+- `refactor`: Code improvements without functional changes
+3. **Push & Open PR:** Push your branch to GitHub and open a Pull Request against the `main` branch. Provide a clear summary of your changes in the PR description.
+
+---
+
+## Need Help?
+
+If you run into issues or have questions, feel free to open a [GitHub Issue](https://github.com/Nosalis1/Optima/issues) or reach out through discussions.

package/README.md

@@ -6,7 +6,7 @@
 
 <p><b>Lightweight, real-time Telemetry & Application Performance Monitoring for Node.js</b></p>
 
-[![npm version](https://img.shields.io/npm/v/@optima/core.svg?style=flat-square&color=fc6c26)](https://www.npmjs.com/package/@optima/core)
+[![npm version](https://img.shields.io/npm/v/@optima/core.svg?style=flat-square&color=fc6c26)](https://www.npmjs.com/package/apm-optima)
 [![license](https://img.shields.io/github/license/Nosalis1/Optima?style=flat-square&color=8A897C)](https://github.com/Nosalis1/Optima/blob/main/LICENSE)
 [![node version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen?style=flat-square)](https://nodejs.org)
 [![npm version](https://img.shields.io/badge/npm-%3E%3D10.0.0-red?style=flat-square)](https://www.npmjs.com/)
@@ -45,7 +45,6 @@
 
 ## Dashboard Preview
 
-<!-- ZAMENI SA STVARNOM SLIKOM KADA JE DODATNA U REPOZITORIJUM -->
 <div align="center">
   <table border="0">
     <tr>
@@ -66,8 +65,8 @@ Optima is structured as a **Monorepo** managed with `npm workspaces`:
 
 ```
 ├── packages/
-│   └── core/          # Telemetry engine, interceptors, and WebSocket adapters (@optima-apm/core)
-│   └── dashboard/     # Next.js React Dashboard (exported statically into @optima-apm/core)
+│   └── core/          # Telemetry engine, interceptors, and WebSocket adapters (apm-optima/core)
+│   └── dashboard/     # Next.js React Dashboard (exported statically into apm-optima/core)
 ├── apps/              # Integration & demo application (Express & NestJS)
 ```
 
@@ -78,11 +77,11 @@ Optima is structured as a **Monorepo** managed with `npm workspaces`:
 ### Installation
 
 ```bash
-npm install @optima-apm/core
+npm i apm-optima
 # or
-pnpm add @optima-apm/core
+pnpm add apm-optima
 # or
-yarn add @optima-apm/core
+yarn add apm-optima
 ```
 
 ### Express.js Integration
@@ -90,7 +89,7 @@ yarn add @optima-apm/core
 Attach Optima using setupOptima and hook the HTTP server instance:
 ```ts
 const express = require('express');
-const { setupOptima } = require('@optima-apm/core/express');
+const { setupOptima } = require('apm-optima/express');
 
 const app = express();
 app.use(express.json());
@@ -121,7 +120,7 @@ const stopMetrics = optima.attachServer(server);
 Import MetricsModule into your root application module:
 ```ts
 import { Module } from '@nestjs/common';
-import { MetricsModule } from '@optima-apm/core/nest';
+import { MetricsModule } from 'apm-optima/nest';
 
 @Module({
   imports: [

package/docs/assets/optima-icon.svg

@@ -0,0 +1,39 @@
+<svg
+            width="64"
+            height="64"
+            viewBox="0 0 200 200"
+            fill="none"
+            xmlns="http://www.w3.org/2000/svg"
+        >
+            <circle
+                cx="100"
+                cy="100"
+                r="75"
+                stroke="white"
+                strokeWidth="7"
+                strokeOpacity="0.25"
+            />
+
+            <path
+                d="M 45 135 A 65 65 0 1 1 155 135"
+                stroke="white"
+                strokeWidth="10"
+                strokeLinecap="round"
+            />
+
+            <circle cx="50" cy="130" r="4" fill="white" />
+            <circle cx="100" cy="42" r="4" fill="white" />
+            <circle cx="150" cy="130" r="4" fill="white" />
+
+            <rect x="78" y="130" width="7" height="18" rx="3.5" fill="white" fillOpacity="0.5" />
+            <rect x="92" y="118" width="7" height="30" rx="3.5" fill="white" fillOpacity="0.9" />
+            <rect x="106" y="124" width="7" height="24" rx="3.5" fill="white" fillOpacity="0.6" />
+
+            <path
+                d="M 100 100 L 132 68"
+                stroke="white"
+                strokeWidth="8"
+                strokeLinecap="round"
+            />
+            <circle cx="100" cy="100" r="8" fill="white" />
+        </svg>

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "apm-optima",
-    "version": "1.0.0",
+    "version": "1.0.1",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "publishConfig": {
@@ -34,6 +34,9 @@
     "files": [
         "dist",
         "README.md",
+        "LICENSE",
+        "CONTRIBUTING.md",
+        "docs",
         "package.json"
     ],
     "scripts": {
@@ -68,4 +71,4 @@
         "ts-jest": "^29.0.0",
         "typescript": "^5.0.0"
     }
-}
+}