fixing types

Author: icebob

meta.js

@@ -2,7 +2,6 @@
 
 module.exports = function(values) {
   return {
-        /** @type {Array<import('inquirer').Question>} */
         questions: [
             {
                 type: "confirm",
@@ -126,25 +125,6 @@ module.exports = function(values) {
 
         metalsmith: {
             before(metalsmith) {
-                /**
-                 * @typedef Metadata
-                 * @property {Boolean} apiGW
-                 * @property {Boolean} apiGQL
-                 * @property {Boolean} apiIO
-                 * @property {Boolean} needTransporter
-                 * @property {String} transporter
-                 * @property {Boolean} needCacher
-                 * @property {Boolean} dbService
-                 * @property {Boolean} needChannels
-                 * @property {Boolean} needWorkflows
-                 * @property {String} channels
-                 * @property {Boolean} metrics
-                 * @property {Boolean} tracing
-                 * @property {Boolean} docker
-                 * @property {Boolean} lint
-                 */
-
-                /** @type {Metadata} */
                 const data = metalsmith.metadata();
 
                 data.redis = data.cacher == "Redis" || data.transporter == "Redis" || data.channels == "Redis" || data.needWorkflows;

template/mixins/db.mixin.ts

@@ -13,7 +13,6 @@ export type DbServiceThis = Service & DbServiceMethods;
 export default function (collection: string): DbServiceSchema {
 	const cacheCleanEventName = `cache.clean.${collection}`;
 
-	/** @type {MoleculerDB & ServiceSchema} */
 	const schema: DbServiceSchema = {
 		/**
 		 * Mixins. More info: https://moleculer.services/docs/0.15/services.html#Mixins
@@ -75,7 +74,13 @@ export default function (collection: string): DbServiceSchema {
 			 * @param {Context} ctx
 			 * @param {object} opts
 			 */
-			async entityChanged(type: string, data: object, oldData: object, ctx: Context, opts: object) {
+			async entityChanged(
+				type: string,
+				data: object,
+				oldData: object,
+				ctx: Context,
+				opts: object
+			) {
 				ctx.broadcast(cacheCleanEventName);
 			}
 		},

template/moleculer.config.ts

@@ -1,4 +1,4 @@
-import type { BrokerOptions, MetricRegistry, ServiceBroker } from "moleculer";
+import type { BrokerOptions } from "moleculer";
 import { Errors } from "moleculer";
 
 {{#needChannels}}
@@ -7,7 +7,7 @@ import { Middleware as ChannelMiddleware } from "@moleculer/channels";
 {{/needChannels}}
 
 {{#needWorkflows}}
-import { Middleware as WorkflowsMiddleware } = require("@moleculer/workflows");
+import { Middleware as WorkflowsMiddleware } from "@moleculer/workflows";
 {{/needWorkflows}}
 
 /**
@@ -34,8 +34,6 @@ import { Middleware as WorkflowsMiddleware } = require("@moleculer/workflows");
  *      }
  *    }
  *  }
- *
- * @type {import('moleculer').BrokerOptions}
  */
 const brokerConfig: BrokerOptions = {
 	// Namespace of nodes to segment your nodes on the same network.
@@ -248,4 +246,4 @@ const brokerConfig: BrokerOptions = {
 	}
 };
 
-export = brokerConfig;
+export default brokerConfig;

template/package.json

@@ -2,6 +2,7 @@
   "name": "{{projectName}}",
   "version": "1.0.0",
   "description": "My Moleculer-based microservices project",
+  "type": "module",
   "scripts": {
     "build": "tsc --project tsconfig.build.json",
     "dev": "tsx ./node_modules/moleculer/bin/moleculer-runner.js --config moleculer.config.ts --hot --repl services/**/*.service.ts",

template/services/api.service.ts

@@ -1,5 +1,5 @@
 import type { Context, ServiceSchema } from "moleculer";
-import type { IncomingRequest, ServerResponse } from "http";
+import type { IncomingMessage, ServerResponse } from "http";
 
 import ApiGateway from "moleculer-web";
 import type { ApiSettingsSchema } from "moleculer-web";
@@ -47,7 +47,7 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 		{{/apiGQL}}
 	],
 
-	/** @type {ApiSettingsSchema} More info: https://moleculer.services/docs/0.15/moleculer-web.html */
+	/** More info: https://moleculer.services/docs/0.15/moleculer-web.html */
 	settings: {
 		// Exposed port
 		port: process.env.PORT || 3000,
@@ -88,7 +88,7 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 				onBeforeCall(
 					ctx: Context<unknown, Meta>,
 					route: Route,
-					req: IncomingRequest,
+					req: IncomingMessage,
 					res: GatewayResponse,
 				): void {
 					// Set request headers to context meta
@@ -101,7 +101,7 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 				onAfterCall(
 					ctx: Context,
 					route: Route,
-					req: IncomingRequest,
+					req: IncomingMessage,
 					res: GatewayResponse,
 					data: unknown,
 				): unknown {
@@ -146,7 +146,6 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 			options: {}
 		}
 
-		/** @type {import('moleculer-io').IOSetting} */
 		// io: {},
 	},
 
@@ -164,7 +163,7 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 		authenticate(
 			ctx: Context,
 			route: Route,
-			req: IncomingRequest,
+			req: IncomingMessage,
 		): Record<string, unknown> | null {
 			// Read the token from header
 			const auth = req.headers["authorization"];
@@ -194,7 +193,7 @@ const ApiService: ServiceSchema<ApiSettingsSchema> = {
 		 *
 		 * PLEASE NOTE, IT'S JUST AN EXAMPLE IMPLEMENTATION. DO NOT USE IN PRODUCTION!
 		 */
-		authorize(ctx: Context<null, Meta>, route: Route, req: IncomingRequest) {
+		authorize(ctx: Context<null, Meta>, route: Route, req: IncomingMessage) {
 			// Get the authenticated user.
 			const user = ctx.meta.user;
 

template/services/greeter.service.ts

@@ -25,7 +25,7 @@ const GreeterService: ServiceSchema<GreeterSettings> = {
 	 * Settings. More info: https://moleculer.services/docs/0.15/services.html#Settings
 	 */
 	settings: {
-		defaultName: "Moleculer",
+		defaultName: "Moleculer"
 	},
 
 	/**
@@ -50,7 +50,7 @@ const GreeterService: ServiceSchema<GreeterSettings> = {
 			{{#apiGQL}}graphql: {
 				query: "hello: String"
 			},{{/apiGQL}}
-			async handler(this: GreeterThis/* , ctx: Context */): string {
+			async handler(this: GreeterThis /* , ctx: Context */): Promise<string> {
 				return "Hello Moleculer";
 			}
 		},
@@ -68,8 +68,7 @@ const GreeterService: ServiceSchema<GreeterSettings> = {
 			{{#apiGQL}}graphql: {
 				mutation: "welcome(name: String!): String"
 			},{{/apiGQL}}
-			/** @param {import('moleculer').Context<{name: String}>} ctx */
-			async handler(this: GreeterThis, ctx: Context<ActionHelloParams>): string {
+			async handler(this: GreeterThis, ctx: Context<ActionHelloParams>): Promise<string> {
 				return `Welcome, ${ctx.params.name}`;
 			}
 		}

template/services/products.service.ts

@@ -196,7 +196,6 @@ const ProductsService: ServiceSchema<ProductSettings> & { methods: DbServiceMeth
 			{{#apiGQL}}graphql: {
 				mutation: "decreaseQuantity(id: String!, value: Int!): Product"
 			},{{/apiGQL}}
-			/** @param {Context<{id: String, value: Number}>} ctx */
 			async handler(this: ProductsThis, ctx: Context<ActionQuantityParams>): Promise<object> {
 				// Get current quantity
 				const adapter = await this.getAdapter(ctx);

template/test/integration/api.spec.ts

@@ -1,6 +1,5 @@
 import { afterAll, beforeAll, describe, it, expect, vi } from "vitest";
 
-
 process.env.PORT = 0; // Use random ports during tests
 
 import HTTPrequest from "supertest";
@@ -13,20 +12,20 @@ import { request, gql } from "graphql-request";
 
 import { Context, ServiceBroker } from "moleculer";
 // Load service schemas
-import APISchema from "../../../services/api.service";
-import GreeterSchema from "../../../services/greeter.service";
+import APISchema from "../../services/api.service.js";
+import GreeterSchema from "../../services/greeter.service.js";
 {{#dbService}}
-import ProductsSchema from "../../../services/products.service";
+import ProductsSchema from "../../services/products.service.js";
 {{/dbService}}
 
 describe("Test HTTP API gateway", () => {
-	let broker = new ServiceBroker({ logger: false });
+	const broker = new ServiceBroker({ logger: false });
 	broker.sendToChannel = vi.fn();
 
-	let greeterService = broker.createService(GreeterSchema);
-	let apiService = broker.createService(APISchema);
+	const greeterService = broker.createService(GreeterSchema);
+	const apiService = broker.createService(APISchema);
 	{{#dbService}}
-	let productsService = broker.createService(ProductsSchema);
+	const productsService = broker.createService(ProductsSchema);
 	productsService.seedDB = null; // Disable seeding
 	{{/dbService}}
 

template/test/integration/products.service.spec.ts

@@ -2,7 +2,7 @@ import { afterAll, beforeAll, describe, it, expect, vi } from "vitest";
 import { ServiceBroker } from "moleculer";
 import type { ServiceSchema } from "moleculer";
 import type { ProductEntity } from "../../services/products.service";
-import TestService from "../../services/products.service";
+import TestService from "../../services/products.service.js";
 
 describe("Test 'products' service", () => {
 	describe("Test actions", () => {

template/test/unit/mixins/db.mixin.spec.ts

@@ -1,8 +1,7 @@
 import { afterAll, beforeAll, describe, it, expect, vi } from "vitest";
 
 import { Context, ServiceBroker } from "moleculer";
-import type { Service, ServiceAsyncLifecycleHandler, ServiceEventHandler } from "moleculer";
-import DbMixin from "../../../mixins/db.mixin";
+import DbMixin from "../../../mixins/db.mixin.js";
 
 describe("Test DB mixin", () => {
 	describe("Test schema generator", () => {