Merge pull request #126 from moleculerjs/next

Major update: Apollo Server 5 migration with breaking changes

Author: icebob

.codeclimate.yml

@@ -9,20 +9,19 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        # node-version: [10.x, 12.x, 14.x, 15.x]
-        node-version: [10.x, 12.x, 14.x, 16.x, 18.x]
+        node-version: [20.x, 22.x, 24.x]
       fail-fast: false
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Use Node.js ${{ matrix.node-version }}
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
         node-version: ${{ matrix.node-version }}
 
     - name: Cache node modules
-      uses: actions/cache@v2
+      uses: actions/cache@v4
       env:
         cache-name: cache-node-modules
       with:

.eslintrc.js

@@ -0,0 +1,32 @@
+name: TypeScript Type Check
+
+on:
+  push: {}
+  pull_request: {}
+
+jobs:
+  typecheck:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [20.x, 22.x, 24.x]
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v4
+
+    - name: Setup Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v4
+      with:
+        node-version: ${{ matrix.node-version }}
+        cache: 'npm'
+
+    - name: Install dependencies
+      run: npm ci
+
+    - name: Typecheck
+      run: npm run typecheck
+
+    - name: Test TS
+      run: npm run test:ts

.github/workflows/ci.yml

@@ -7,3 +7,5 @@ examples/
 typings
 test/
 CHANGELOG.md
+prettier.config.js
+eslint.config.js

.github/workflows/typecheck.yml

@@ -4,14 +4,23 @@
 	// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 	"version": "0.2.0",
 	"configurations": [
+		{
+			"name": "Attach",
+			"port": 9229,
+			"request": "attach",
+			"skipFiles": [
+				"<node_internals>/**"
+			],
+			"type": "node"
+		},
 		{
 			"type": "node",
 			"request": "launch",
 			"name": "Launch demo",
 			"program": "${workspaceRoot}\\examples\\index.js",
 			"cwd": "${workspaceRoot}",
 			"args": [
-				"full"
+				"simple"
 			]
 		},
 		{

.npmignore

@@ -1,3 +1,37 @@
+<a name="0.4.0"></a>
+# 0.4.0 (2025-09-25)
+
+## Breaking Changes
+- **Apollo Server 5**: Upgraded from Apollo Server 2 to Apollo Server 5
+- **Node.js Requirements**: Now requires Node.js >= 20.x.x (updated from >= 10.x)
+- **File Upload Removal**: Removed GraphQL file upload support because [Apollo Server 3+ no longer supports it](https://www.apollographql.com/docs/apollo-server/v3/migration#file-uploads).
+- **Healthcheck Removal**: Built-in healthcheck endpoint removed because [Apollo Server 4+ no longer supports it](https://www.apollographql.com/docs/apollo-server/migration-from-v3#health-checks).
+- **WebSocket Subscriptions**: Rewritten subscription function from `graphql-subscriptions` to `graphql-ws`.
+- **Move from GraphQL Playground to Apollo Sandbox**: Apollo Server 3+ removes the GraphQL Playground. [It supports Apollo Sandbox.](https://www.apollographql.com/docs/apollo-server/v3/migration#graphql-playground)
+
+## Major Updates
+- **Modern Tooling**: Migrated from legacy ESLint config to flat config format
+- **GitHub Actions**: Updated CI workflow to use latest GitHub Actions (v4) and test on Node.js 20.x, 22.x, 24.x
+- **Dependencies**: Updated all dependencies to latest compatible versions
+- **Configuration**: Replaced `.eslintrc.js` and `.prettierrc.js` with modern `eslint.config.js` and `prettier.config.js`
+- **Async Methods**: Made `makeExecutableSchema` and `generateGraphQLSchema` methods async for better async/await support
+- **Preparation**: Improved GraphQL schema preparation with promise-based mechanism to prevent multiple concurrent preparations
+
+## Removed Features
+- Removed file upload examples and documentation
+- Removed legacy Apollo Server 2/3 configuration options
+
+## Documentation
+- Updated README.md to reflect Apollo Server 5 compatibility
+- Improved examples and removed outdated features
+
+## Typescript types
+- Improved Typescript d.ts file
+- Exported helper interfaces `ApolloServiceSettings`, `ApolloServiceMethods`, `ApolloServiceLocalVars` to support Moleculer 0.15 Service generics.
+- Augmented Moleculer `ActionSchema` with graphql property.
+- Typescript CI tests.
+
+--------------------------------------------------
 <a name="0.3.8"></a>
 # 0.3.8 (2023-04-23)
 

.prettierrc.js

@@ -0,0 +1,56 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Development Commands
+
+- `npm test` - Run Jest tests with coverage
+- `npm run ci` - Run tests in watch mode for development
+- `npm run lint` - Run ESLint on src and test directories
+- `npm run lint:fix` - Auto-fix ESLint issues
+- `npm run dev` - Run development server with examples/index.js (simple example)
+- `npm run dev full` - Run development server with examples/full/index.js (full example)
+- `npm run deps` - Update dependencies interactively using ncu
+- `npm run postdeps` - Automatically run tests after dependency updates
+
+## Project Architecture
+
+This is a **Moleculer mixin** that integrates Apollo GraphQL Server 5 with Moleculer API Gateway. The core architecture consists of:
+
+### Core Components
+- **src/service.js** - Main service mixin factory that returns a Moleculer service schema
+- **src/ApolloServer.js** - Custom ApolloServer class extending @apollo/server
+- **src/gql.js** - GraphQL template literal formatter utility
+- **index.js** - Main module exports
+
+### Key Architectural Patterns
+
+**Service Mixin Pattern**: The library exports a factory function `ApolloService(options)` that returns a Moleculer service schema to be mixed into API Gateway services.
+
+**Auto-Schema Generation**: GraphQL schemas are dynamically generated from:
+- Service action definitions with `graphql` property containing `query`, `mutation`, or `subscription` fields
+- Service-level GraphQL definitions in `settings.graphql` 
+- Global typeDefs and resolvers passed to the mixin
+
+**Action-to-Resolver Mapping**: Moleculer actions automatically become GraphQL resolvers when they include GraphQL definitions. The system creates resolver functions that call `ctx.call(actionName, params)`.
+
+**DataLoader Integration**: Built-in DataLoader support for batch loading with automatic key mapping and caching via resolver configuration.
+
+**WebSocket Subscriptions**: GraphQL subscriptions are handled through WebSocket connections with PubSub pattern integration.
+
+### Testing Structure
+- **test/unit/** - Unit tests for individual components
+- **test/integration/** - Integration tests with full service setup
+- Jest snapshots for schema generation testing
+
+### Examples Structure
+- **examples/simple/** - Basic setup demonstration
+- **examples/full/** - Complete setup with multiple services, DataLoader, and complex resolvers
+
+## Important Development Notes
+
+**Schema Regeneration**: The GraphQL schema is automatically regenerated when services change (`$services.changed` event) unless `autoUpdateSchema: false`.
+
+**TypeScript Support**: Full TypeScript definitions in index.d.ts with comprehensive interfaces for all configuration options.
+
+**Node.js Version**: Requires Node.js >= 20.x.x (specified in package.json engines).

.vscode/launch.json

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 MoleculerJS
+Copyright (c) 2025 MoleculerJS
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal