Return raw component responses with ESLint updates and test coverage (#7)

* feat: update GetEntitiesTool and GetEntityByRefTool to support JSON API format; refactor response handling

* feat: enhance tool metadata validation and update tools manifest with new tools and parameters

* style: streamline parameter formatting in tools manifest for consistency

* feat: add copyright notice and license information to validate-tool-metadata.ts

chore: update yarn.lock with new dependencies and versions for rollup plugins and related packages

* refactor: update Rollup configuration to improve external dependency handling and prevent CJS/ESM interop issues

* feat: enhance CI/CD workflows by adding Corepack setup for Yarn 4 and improving artifact uploads

* refactor: rename enhanced scripts and update tool metadata for consistency

* chore: update project license from MIT to GPLv3 in README and package.json

* refactor: streamline response formatting in GetEntityByRefTool and GetLocationByRefTool

* refactor: update CI workflow to use a single Node.js version (20.x)

* refactor: simplify CI workflow by removing develop branch and separating Corepack setup steps

* refactor: streamline CI and release workflows by removing node version matrix and consolidating Corepack setup steps

* feat: update tool parameters and response handling

- Made the `type` parameter in `add_location.tool.ts` optional.
- Updated test files for `get_entities`, `get_entities_by_query`, `get_entities_by_refs`, `get_entity_ancestors`, `get_entity_by_ref`, `get_entity_facets`, `get_location_by_entity`, `get_location_by_ref`, `refresh_entity`, `remove_entity_by_uid`, and `remove_location_by_id` to use `ApiStatus` for status checks instead of string literals.
- Changed mock implementations in tests to use `mockResolvedValueOnce` for better isolation of test cases.
- Introduced new constants in `constants.ts` for content types and common field names used in API responses.
- Enhanced tool metadata validation in `tool-validator.ts` and `validate-tool-metadata.ts` to provide better type safety and error handling.
- Updated `tools-manifest.json` to ensure consistent parameter formatting.

* refactor: change mockResponse type to Partial<AxiosResponse> for better flexibility in tests

* refactor: remove yarn cache configuration from CI and release workflows

* fix: correct command for validating build outputs in CI and release workflows

Author: Coderrob

.github/workflows/ci.yml

@@ -1,4 +1,4 @@
-name: CI
+name: Build and Test
 
 on:
   push:
@@ -10,17 +10,14 @@ jobs:
   build:
     runs-on: ubuntu-latest
 
-    strategy:
-      matrix:
-        node-version: [20.x]
-
     steps:
       - uses: actions/checkout@v4
 
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js 20.x
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: 20.x
+          registry-url: "https://registry.npmjs.org"
 
       - name: Enable Corepack
         run: corepack enable
@@ -31,15 +28,76 @@ jobs:
       - name: Install dependencies
         run: yarn install --frozen-lockfile
 
-      - name: Lint
+      - name: Run linting
         run: yarn lint
 
-      - name: Test
+      - name: Run tests
         run: yarn test
 
-      - name: Upload coverage
+      - name: Build the project
+        run: yarn build
+
+      - name: Validate build outputs
+        run: yarn build:validate
+
+      - name: Test global installation (CommonJS)
+        run: |
+          # Test that the built CJS file can execute
+          node dist/index.cjs --help || echo "Expected: needs env vars"
+
+      - name: Test global installation (ESM)
+        run: |
+          # Test that the built ESM file can execute
+          node dist/index.mjs --help || echo "Expected: needs env vars"
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: build-artifacts-node-${{ matrix.node-version }}
+          path: |
+            dist/
+            !dist/**/*.map
+          retention-days: 7
+
+      - name: Upload coverage (if present)
         if: success()
         uses: actions/upload-artifact@v4
         with:
           name: coverage-report
           path: coverage
+
+  # Job to test publishing (dry run)
+  publish-test:
+    runs-on: ubuntu-latest
+    needs: build
+    if: github.event_name == 'pull_request'
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Setup Yarn 4
+        run: corepack prepare yarn@4 --activate
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Build the project
+        run: yarn build
+
+      - name: Test npm pack
+        run: |
+          npm pack --dry-run
+          echo "✅ Package can be packed successfully"
+
+      - name: Verify package contents
+        run: |
+          echo "📦 Package contents that would be published:"
+          npm pack --dry-run 2>/dev/null | grep -E "^\s*[0-9]+" || true

.github/workflows/release.yml

@@ -0,0 +1,70 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  release:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Use Node.js 20.x
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          registry-url: "https://registry.npmjs.org"
+
+      - name: Enable Corepack
+        run: corepack enable
+
+      - name: Setup Yarn 4
+        run: corepack prepare yarn@4 --activate
+
+      - name: Install dependencies
+        run: yarn install --frozen-lockfile
+
+      - name: Run tests
+        run: yarn test
+
+      - name: Build the project
+        run: yarn build
+
+      - name: Validate build
+        run: yarn build:validate
+
+      - name: Publish to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Create GitHub Release
+        uses: actions/create-release@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          tag_name: ${{ github.ref }}
+          release_name: Release ${{ github.ref }}
+          body: |
+            ## Changes in this Release
+
+            - Built with Rollup for optimized dual-format output
+            - CommonJS and ESM bundles available
+            - Global installation support via npm
+
+            ## Installation
+
+            ```bash
+            npm install -g @coderrob/backstage-mcp-server
+            ```
+
+            ## Usage
+
+            ```bash
+            backstage-mcp-server
+            ```
+          draft: false
+          prerelease: false

.gitignore

@@ -129,6 +129,7 @@ dist
 .vscode-test
 
 # yarn v2
+.yarn/sdks
 .yarn/cache
 .yarn/unplugged
 .yarn/build-state.yml

.npmignore

@@ -0,0 +1,26 @@
+# Source files
+src/
+tsconfig*.json
+rollup.config.js
+jest.config.mjs
+eslint.config.js
+
+# Development files
+*.test.ts
+*.spec.ts
+__mocks__/
+coverage/
+.vscode/
+
+# Documentation (except main files)
+planning.md
+TODO.md
+
+# Build artifacts not needed in package
+*.tsbuildinfo
+*.log
+node_modules/
+
+# Git
+.git/
+.gitignore