agent-banner-library 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### 0.0.4 (2026-02-06)
+
+### Features
+
+- add agent banner library setup and tooling ([560ade7](https://github.com/auronforge/agent-banner-library/commit/560ade74292e492fbd8fb2e2d9c9ed128966937e))
+- add automated release flow with tag validation and PR to main ([586001b](https://github.com/auronforge/agent-banner-library/commit/586001b89019a239aa345a898ef1fd0ad87caf70))
+- add feature branch workflow with auto PR creation ([2e4bdfc](https://github.com/auronforge/agent-banner-library/commit/2e4bdfccd1202870b86131255879c2d7d91d3b22))
+
+### Bug Fixes
+
+- add develop-merged workflow to create PR to main after merge ([af62811](https://github.com/auronforge/agent-banner-library/commit/af62811f986d57ee3d328b0422fac3c0ed39f436))
+- remove incorrect cache-dependency-path and working-directory from workflows ([da969b1](https://github.com/auronforge/agent-banner-library/commit/da969b1350eb81a788d2f704fd683913c6f6c8ed))
+- resolve TypeScript build config module/moduleResolution conflicts ([1ba55b5](https://github.com/auronforge/agent-banner-library/commit/1ba55b5486e167cf102fb638d18fd2df6e41cc89))
+
 ### 0.0.3 (2026-02-06)
 
 ### Features

package/LICENSE

@@ -1,21 +1,85 @@
-MIT License
-
-Copyright (c) 2026 Auronforge
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.
+
+2. Grant of Copyright License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License.
+
+Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.
+
+4. Redistribution.
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:
+
+(a) You must give any other recipients of the Work or Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.
+
+5. Submission of Contributions.
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.
+
+6. Trademarks.
+
+This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty.
+
+Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability.
+
+In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability.
+
+While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+Copyright 2026 Auronforge
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/README.md

@@ -1,141 +1,316 @@
-# agent-banner-library
+# 🚀 agent-banner-library
 
-Reusable Node.js + TypeScript library to standardize startup banner logs for REST API agents.
+[![npm version](https://img.shields.io/npm/v/agent-banner-library)](https://www.npmjs.com/package/agent-banner-library)
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![TypeScript](https://img.shields.io/badge/TypeScript-5.0+-blue)](https://www.typescriptlang.org/)
 
-## Installation
+A beautiful, standardized startup banner logger for REST API agents. Display server information, endpoints, and environment details in a clean, professional format.
+
+## ✨ Features
+
+- 🎨 **Beautiful console output** with customizable width and emojis
+- 🔧 **Framework agnostic** - works with Express, Fastify, Koa, or any Node.js server
+- 📦 **Dual module support** - ESM and CommonJS
+- ⚡ **Zero dependencies** for production
+- 🎯 **TypeScript first** with full type definitions
+- 🧪 **98%+ test coverage** with comprehensive test suite
+- 🔄 **Smart defaults** with flexible configuration
+
+## 📦 Installation
 
 ```bash
 npm install agent-banner-library
 ```
 
-## Usage
+```bash
+yarn add agent-banner-library
+```
 
-### Express
+```bash
+pnpm add agent-banner-library
+```
+
+## 🚀 Quick Start
+
+### Express.js Example
 
 ```ts
 import express from 'express';
 import { printAgentBanner } from 'agent-banner-library';
 
 const app = express();
-const port = 3001;
+const PORT = process.env.PORT || 3000;
+
+app.get('/api/v1/users', (req, res) => {
+  res.json({ message: 'List users' });
+});
+
+app.post('/api/v1/users', (req, res) => {
+  res.json({ message: 'Create user' });
+});
 
-app.listen(port, () => {
+app.listen(PORT, () => {
   printAgentBanner({
-    agentName: 'Backlog Structurer Agent API',
-    baseUrl: `http://localhost:${port}`,
+    agentName: 'User Management API',
+    baseUrl: `http://localhost:${PORT}`,
     prefix: '/api/v1',
     endpoints: [
-      {
-        method: 'POST',
-        path: '/backlog/structure',
-        description: 'Generate structured backlog',
-      },
+      { method: 'GET', path: '/users', description: 'List all users' },
+      { method: 'POST', path: '/users', description: 'Create a new user' },
+      { method: 'GET', path: '/users/:id', description: 'Get user by ID' },
+      { method: 'PUT', path: '/users/:id', description: 'Update user' },
+      { method: 'DELETE', path: '/users/:id', description: 'Delete user' },
     ],
   });
 });
 ```
 
-### Fastify
+**Output:**
+
+```
+════════════════════════════════════════════════════════
+🚀 User Management API - 1.0.0
+════════════════════════════════════════════════════════
+📡 Server running on: http://localhost:3000
+📚 API Documentation: http://localhost:3000/api/v1/docs
+🏥 Health Check: http://localhost:3000/api/v1/health
+📝 Endpoints:
+    - GET - List all users - http://localhost:3000/api/v1/users
+    - POST - Create a new user - http://localhost:3000/api/v1/users
+    - GET - Get user by ID - http://localhost:3000/api/v1/users/:id
+    - PUT - Update user - http://localhost:3000/api/v1/users/:id
+    - DELETE - Delete user - http://localhost:3000/api/v1/users/:id
+════════════════════════════════════════════════════════
+Environment: development
+Timestamp: 2026-02-05T23:45:12.345Z
+════════════════════════════════════════════════════════
+```
+
+### Fastify Example
 
 ```ts
 import Fastify from 'fastify';
-import { renderAgentBanner } from 'agent-banner-library';
+import { printAgentBanner } from 'agent-banner-library';
 
-const app = Fastify();
-const port = 3002;
+const fastify = Fastify({ logger: false });
+const PORT = 3001;
 
-await app.listen({ port });
+fastify.get('/api/v1/products', async (request, reply) => {
+  return { products: [] };
+});
 
-const banner = renderAgentBanner({
-  agentName: 'Capability Mapper',
-  baseUrl: `http://localhost:${port}`,
-  prefix: 'api/v1',
+fastify.post('/api/v1/products', async (request, reply) => {
+  return { message: 'Product created' };
+});
+
+await fastify.listen({ port: PORT });
+
+printAgentBanner({
+  agentName: 'E-commerce API',
+  baseUrl: `http://localhost:${PORT}`,
+  prefix: '/api/v1',
   endpoints: [
-    {
-      method: 'GET',
-      path: 'capabilities',
-      description: 'List capabilities',
-    },
+    { method: 'GET', path: '/products', description: 'List products' },
+    { method: 'POST', path: '/products', description: 'Create product' },
   ],
 });
+```
+
+### Koa Example
+
+```ts
+import Koa from 'koa';
+import Router from '@koa/router';
+import { printAgentBanner } from 'agent-banner-library';
+
+const app = new Koa();
+const router = new Router({ prefix: '/api/v1' });
+const PORT = 3002;
+
+router.get('/orders', (ctx) => {
+  ctx.body = { orders: [] };
+});
+
+app.use(router.routes());
 
-app.log.info(banner);
+app.listen(PORT, () => {
+  printAgentBanner({
+    agentName: 'Order Management API',
+    baseUrl: `http://localhost:${PORT}`,
+    prefix: '/api/v1',
+    endpoints: [{ method: 'GET', path: '/orders', description: 'List orders' }],
+  });
+});
 ```
 
-## Configuration
+## 📖 API Reference
+
+### `printAgentBanner(config: AgentBannerConfig): void`
+
+Prints the banner directly to `console.log()`. Best for simple use cases.
+
+### `renderAgentBanner(config: AgentBannerConfig): string`
+
+Returns the banner as a string. Useful when you want to use custom loggers or process the output.
 
 ```ts
-export interface AgentBannerConfig {
-  agentName: string;
-  packageJsonPath?: string;
-  version?: string;
-  baseUrl: string;
-  prefix: string;
-  docsPath?: string;
-  healthPath?: string;
+import { renderAgentBanner } from 'agent-banner-library';
+import logger from './logger'; // Your custom logger
+
+const banner = renderAgentBanner({
+  agentName: 'My API',
+  baseUrl: 'http://localhost:3000',
+  prefix: '/api',
+});
+
+logger.info(banner);
+```
+
+### Configuration Options
+
+```ts
+interface AgentBannerConfig {
+  // Required
+  agentName: string; // Name of your API/service
+  baseUrl: string; // Base URL (e.g., 'http://localhost:3000')
+  prefix: string; // API prefix (e.g., '/api/v1')
+
+  // Optional
+  packageJsonPath?: string; // Path to package.json (default: process.cwd() + '/package.json')
+  version?: string; // Version override (default: from package.json or '0.0.0')
+  docsPath?: string; // Docs endpoint (default: '/docs')
+  healthPath?: string; // Health endpoint (default: '/health')
+  environment?: string; // Environment name (default: process.env.NODE_ENV)
+  timestamp?: string | Date; // Timestamp (default: new Date())
+  width?: number; // Banner width (default: 48)
+  emoji?: boolean; // Enable emojis (default: true)
+
+  // Endpoints
   endpoints?: Array<{
     method: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE' | 'OPTIONS' | 'HEAD';
     path: string;
     description: string;
   }>;
-  environment?: string;
-  timestamp?: string | Date;
-  width?: number;
-  emoji?: boolean;
 }
 ```
 
-Default behaviors:
+## 🎨 Customization
 
-- `packageJsonPath` defaults to `process.cwd() + "/package.json"`.
-- `version` is read from `package.json` if not provided, or `0.0.0` on failure.
-- `prefix` and `path` are normalized to start with `/` and avoid double slashes.
-- `docsPath` defaults to `/docs` and `healthPath` to `/health`.
-- `environment` defaults to `process.env.NODE_ENV ?? "development"`.
-- `timestamp` defaults to `new Date()` and is always rendered as ISO.
-- `width` defaults to 48 characters.
-- `emoji` defaults to `true`.
+### Custom Version
 
-## Sample Output
+```ts
+printAgentBanner({
+  agentName: 'My API',
+  baseUrl: 'http://localhost:3000',
+  prefix: '/api',
+  version: '2.0.0-beta.1', // Override version
+});
+```
 
+### Custom Paths
+
+```ts
+printAgentBanner({
+  agentName: 'My API',
+  baseUrl: 'http://localhost:3000',
+  prefix: '/api/v2',
+  docsPath: '/swagger', // Custom docs path
+  healthPath: '/status', // Custom health path
+});
 ```
-════════════════════════════════════════════════════════
-🚀 Backlog Structurer Agent API - 1.2.3
-════════════════════════════════════════════════════════
-📡 Server running on: http://localhost:3001
-📚 API Documentation: http://localhost:3001/api/v1/docs
-🏥 Health Check: http://localhost:3001/api/v1/health
-📝 Endpoints:
-    - POST - Generate structured backlog - http://localhost:3001/api/v1/backlog/structure
-════════════════════════════════════════════════════════
-Environment: development
-Timestamp: 2026-02-05T23:49:50.079Z
-════════════════════════════════════════════════════════
+
+### Custom Width and No Emojis
+
+```ts
+printAgentBanner({
+  agentName: 'My API',
+  baseUrl: 'http://localhost:3000',
+  prefix: '/api',
+  width: 60, // Wider banner
+  emoji: false, // Disable emojis
+});
+```
+
+### Production Environment
+
+```ts
+printAgentBanner({
+  agentName: 'My API',
+  baseUrl: 'https://api.myservice.com',
+  prefix: '/api/v1',
+  environment: 'production',
+  endpoints: [{ method: 'GET', path: '/health', description: 'Health check' }],
+});
 ```
 
-## ESM/CJS
+## 🔧 Module Systems
 
-- ESM: `import { renderAgentBanner } from "agent-banner-library"`.
-- CJS: `const { renderAgentBanner } = require("agent-banner-library")`.
+### ESM (Modern)
 
-## TSLint
+```ts
+import { printAgentBanner, renderAgentBanner } from 'agent-banner-library';
+```
+
+### CommonJS (Legacy)
 
-TSLint is deprecated but included for legacy compatibility as required. It is not used by default in CI.
+```js
+const { printAgentBanner, renderAgentBanner } = require('agent-banner-library');
+```
 
-## Development
+## 🧪 Development
 
 ```bash
+# Install dependencies
+npm install
+
+# Run tests
+npm test
+
+# Run tests with coverage
+npm run test:coverage
+
+# Build the library
+npm run build
+
+# Lint code
 npm run lint
+
+# Format code
+npm run format
+
+# Type check
 npm run typecheck
-npm run test:coverage
+
+# Run development script
+npm run dev
 ```
 
-## Tooling Configs
+## 📄 License
+
+Apache-2.0 © [Auronforge](https://github.com/AuronForge)
+
+## 🔗 Links
+
+- [npm Package](https://www.npmjs.com/package/agent-banner-library)
+- [GitHub Repository](https://github.com/AuronForge/agent-banner-library)
+- [Issue Tracker](https://github.com/AuronForge/agent-banner-library/issues)
+
+## 🤝 Contributing
+
+Contributions, issues, and feature requests are welcome! Feel free to check the [issues page](https://github.com/AuronForge/agent-banner-library/issues).
+
+## ⭐ Show your support
+
+Give a ⭐️ if this project helped you!
+
+## 👨‍💻 Author
+
+**José Eduardo Trindade E Marques**
 
-- lint-staged: [.lintstagedrc.cjs](.lintstagedrc.cjs)
-- standard-version: [.versionrc.cjs](.versionrc.cjs) and `npm run release`
+- Company: AuronForge 🚀
+- Email: edu.temarques@gmail.com
+- LinkedIn: [linkedin.com/in/edu-marques29](https://linkedin.com/in/edu-marques29)
 
-## CI/CD
+---
 
-- CI workflow: [.github/workflows/ci.yml](.github/workflows/ci.yml)
-- Release workflow: [.github/workflows/release.yml](.github/workflows/release.yml)
+**Built with ❤️ using Clean Architecture and SOLID principles**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "agent-banner-library",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Standardized startup banner logger for REST API agents.",
   "keywords": [
     "agent",