Add TypeScript type definitions for JavaScript modules

package.json

@@ -3,8 +3,9 @@
   "version": "1.3.1-dev.0",
   "description": "Node package helpers for the VIP Go platform",
   "main": "./src/index.js",
+  "types": "./src/index.d.ts",
   "scripts": {
-    "build": "echo \"No build step\"",
+    "build": "tsc",
     "cmd:format": "prettier '**/*.(js|json|jsx|md|ts|tsx|yml|yaml)'",
     "cmd:lint": "eslint --ext 'js,jsx,ts,tsx' --quiet",
     "format": "npm run cmd:format -- --write",
@@ -42,6 +43,7 @@
     "jest": "^30.1.3",
     "prettier": "npm:wp-prettier@2.8.5",
     "supertest": "^6.3.4",
+    "typescript": "^5.9.3",
     "winston-transport": "^4.9.0"
   }
 }

src/index.d.ts

@@ -0,0 +1,6 @@
+import logger = require("./logger/");
+import server = require("./server/");
+import newrelic = require("./newrelic/");
+import redis = require("./redis/");
+export { logger, server, newrelic, redis };
+//# sourceMappingURL=index.d.ts.map

src/logger/index.d.ts

@@ -0,0 +1,8 @@
+declare function _exports(namespace: string, { transport, cluster, silent }?: {
+    transport?: import("winston-transport");
+    cluster?: typeof nodeCluster;
+    silent?: boolean;
+}): import("winston").Logger;
+export = _exports;
+import nodeCluster = require("cluster");
+//# sourceMappingURL=index.d.ts.map

src/logger/index.js

@@ -66,6 +66,15 @@ const prodLoggingFormat = printf( output => {
 	return `${ time } ${ app }:${ type } ${ JSON.stringify( output ) }`;
 } );
 
+/**
+ * Creates a logger instance with custom formatting for VIP Go platform.
+ * @param {string} namespace - The namespace for the logger (e.g., 'my-app:module')
+ * @param {Object} [options] - Logger options
+ * @param {import('winston-transport')} [options.transport] - Custom Winston transport
+ * @param {import('cluster')} [options.cluster] - Node cluster instance
+ * @param {boolean} [options.silent] - Whether to silence logs
+ * @returns {import('winston').Logger} Winston logger instance
+ */
 module.exports = ( namespace, { transport, cluster, silent = DEFAULT_SILENCE_LOGS } = {} ) => {
 	if ( ! namespace ) {
 		throw Error( 'Please include a namespace to initialize your logger.' );

src/newrelic/index.d.ts

@@ -0,0 +1,5 @@
+declare function _exports({ logger }?: {
+    logger?: Console;
+}): any;
+export = _exports;
+//# sourceMappingURL=index.d.ts.map

src/newrelic/index.js

@@ -1,3 +1,9 @@
+/**
+ * Initializes New Relic monitoring for VIP Go applications.
+ * @param {Object} [options] - Configuration options
+ * @param {Console} [options.logger] - Logger instance for output
+ * @returns {any} New Relic instance or undefined if initialization is skipped
+ */
 module.exports = ( { logger = console } = {} ) => {
 	const licenseKey = process.env.NEW_RELIC_LICENSE_KEY;
 	const noConfig = process.env.NEW_RELIC_NO_CONFIG_FILE === 'true';

src/redis/index.d.ts

@@ -0,0 +1,13 @@
+declare function _exports({ logger }?: {
+    logger?: Console;
+}): import("ioredis").Redis | undefined;
+declare namespace _exports {
+    export { getConnectionInfo };
+}
+export = _exports;
+declare function getConnectionInfo(): {
+    host: string;
+    port: string;
+    password: string;
+};
+//# sourceMappingURL=index.d.ts.map

src/redis/index.js

@@ -34,6 +34,12 @@ const getConnectionInfo = () => {
 	return { host, port, password };
 };
 
+/**
+ * Initializes and returns a Redis client instance for VIP Go applications.
+ * @param {Object} [options] - Configuration options
+ * @param {Console} [options.logger] - Logger instance for output
+ * @returns {import('ioredis').Redis | undefined} Redis client instance or undefined on error
+ */
 module.exports = ( { logger = console } = {} ) => {
 	if ( redisClient ) {
 		// Client already defined and initialized

src/server/index.d.ts

@@ -0,0 +1,11 @@
+declare function _exports(app: Function, { PORT, logger }?: {
+    PORT?: number;
+    logger?: Console;
+}): {
+    app: any;
+    server: any;
+    listen: Function;
+    close: Function;
+};
+export = _exports;
+//# sourceMappingURL=index.d.ts.map

src/server/index.js

@@ -23,6 +23,14 @@ const wrapApplication = ( application, { PORT, logger } ) => {
 	};
 };
 
+/**
+ * Creates an HTTP server wrapper with health check endpoint.
+ * @param {Function} app - Express application or custom request handler
+ * @param {Object} [options] - Server options
+ * @param {number} [options.PORT] - Port number for the server
+ * @param {Console} [options.logger] - Logger instance for output
+ * @returns {{app: any, server: any, listen: Function, close: Function}} Server wrapper object
+ */
 module.exports = ( app, { PORT, logger = console } = {} ) => {
 	if ( ! app ) {
 		throw Error( 'Please include a requestHandler' );

tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "allowJs": true,
+    "declaration": true,
+    "declarationMap": true,
+    "emitDeclarationOnly": true,
+    "outDir": "./src",
+    "rootDir": "./src",
+    "moduleResolution": "node",
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "forceConsistentCasingInFileNames": true,
+    "strict": false,
+    "noEmit": false,
+    "target": "ES2020",
+    "module": "commonjs",
+    "lib": ["ES2020"]
+  },
+  "include": [
+    "src/**/*.js"
+  ],
+  "exclude": [
+    "node_modules",
+    "__tests__",
+    "__mocks__",
+    "**/*.d.ts"
+  ]
+}