Error during installing Nakama Typescript Server Runtime

[Shahariar_Ashik]

I had to write some hooks for our project. That’s why I am trying to setup Nakama typescript server runtime using TypeScript Runtime tutorial. But when I am using the command “npm run build” I am having the below error.

(node:60942) Warning: To load an ES module, set "type": "module" in the package.json or use the .mjs extension.
(Use `node --trace-warnings ...` to show where the warning was created)
[!] RollupError: Node tried to load your configuration file as CommonJS even though it is likely an ES module. To resolve this, change the extension of your configuration to ".mjs", set "type": "module" in your package.json file or pass the "--bundleConfigAsCjs" flag.

Original error: Cannot use import statement outside a module
https://rollupjs.org/guide/en/#--bundleconfigascjs
/home/ashik/ts-project/rollup.config.js:1
import resolve from "@rollup/plugin-node-resolve";

[flavio]

Hello @Shahariar_Ashik,

Could you post the contents of the configuration files mentioned in this section of the documentation?

[Shahariar_Ashik]

package.json

{
  "name": "ts-project",
  "version": "1.0.0",
  "description": "",
  "main": "index.js",
  "scripts": {
    "build": "rollup -c",
    "type-check": "tsc --noEmit"
  },
  "keywords": [],
  "author": "",
  "license": "ISC",
  "devDependencies": {
    "@babel/core": "^7.19.6",
    "@babel/plugin-external-helpers": "^7.18.6",
    "@babel/preset-env": "^7.19.4",
    "@rollup/plugin-babel": "^6.0.2",
    "@rollup/plugin-commonjs": "^23.0.2",
    "@rollup/plugin-json": "^5.0.1",
    "@rollup/plugin-node-resolve": "^15.0.1",
    "@rollup/plugin-typescript": "^9.0.2",
    "rollup": "^3.2.3",
    "tslib": "^2.4.0",
    "typescript": "^4.8.4"
  },
  "dependencies": {
    "nakama-runtime": "github:heroiclabs/nakama-common"
  }
}

[Shahariar_Ashik]

rollup.config.js

import resolve from "@rollup/plugin-node-resolve";
import commonJS from "@rollup/plugin-commonjs";
import json from "@rollup/plugin-json";
import babel from "@rollup/plugin-babel";
import typescript from "@rollup/plugin-typescript";
import pkg from "./package.json";

const extensions = [".mjs", ".js", ".ts", ".json"];

export default {
  input: "./src/main.ts",
  external: ["nakama-runtime"],
  plugins: [
    // Allows node_modules resolution
    resolve({ extensions }),

    // Compile TypeScript
    typescript(),

    json(),

    // Resolve CommonJS modules
    commonJS({ extensions }),

    // Transpile to ES5
    babel({
      extensions,
      babelHelpers: "bundled",
    }),
  ],
  output: {
    file: "build/index.js",
  },
};

[Shahariar_Ashik]

babel.config.json

{
  "presets": ["@babel/env"],
  "plugins": []
}

[Shahariar_Ashik]

tsconfig.json

{
  "compilerOptions": {
    "noImplicitReturns": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "noUnusedLocals": true,
    "removeComments": true,
    "target": "es5",
    "module": "ESNext",
    "strict": false
  },
  "files": ["./node_modules/nakama-runtime/index.d.ts"],
  "include": ["src/**/*"],
  "exclude": ["node_modules", "build"]
}

[Shahariar_Ashik]

main.ts

function InitModule(
  ctx: nkruntime.Context,
  logger: nkruntime.Logger,
  nk: nkruntime.Nakama,
  initializer: nkruntime.Initializer
) {
  logger.info("TypeScript module loaded.");
}

// Reference InitModule to avoid it getting removed on build
!InitModule && InitModule.bind(null);

[Shahariar_Ashik]

local.yml

console:
    max_message_size_bytes: 409600
  logger:
    level: "DEBUG"
  runtime:
    js_entrypoint: "build/index.js"
  session:
    token_expiry_sec: 7200 # 2 hours
  socket:
    max_message_size_bytes: 4096 # reserved buffer
    max_request_size_bytes: 131072

[Shahariar_Ashik]

Dockerfile

FROM node:alpine AS node-builder

WORKDIR /backend

COPY package*.json .
RUN npm install

COPY . .
RUN npm run build

FROM registry.heroiclabs.com/heroiclabs/nakama:3.14.0

COPY --from=node-builder /backend/build/*.js /nakama/data/modules/build/
COPY local.yml /nakama/data/

[Shahariar_Ashik]

docker-compose.yml

version: "3"
services:
  postgres:
    command: postgres -c shared_preload_libraries=pg_stat_statements -c pg_stat_statements.track=all
    environment:
      - POSTGRES_DB=nakama
      - POSTGRES_PASSWORD=localdb
    expose:
      - "8080"
      - "5432"
    image: postgres:12.2-alpine
    ports:
      - "5432:5432"
      - "8080:8080"
    volumes:
      - data:/var/lib/postgresql/data

  nakama:
    build: .
    depends_on:
      - postgres
    entrypoint:
      - "/bin/sh"
      - "-ecx"
      - >
        /nakama/nakama migrate up --database.address postgres:localdb@postgres:5432/nakama &&
        exec /nakama/nakama --config /nakama/data/local.yml --database.address postgres:localdb@postgres:5432/nakama
    expose:
      - "7349"
      - "7350"
      - "7351"
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:7350/"]
      interval: 10s
      timeout: 5s
      retries: 5
    links:
      - "postgres:db"
    ports:
      - "7349:7349"
      - "7350:7350"
      - "7351:7351"
    restart: unless-stopped

volumes:
  data:

[yamlcoder]

Does problem go away if you rename rollup.config.js to the rollup.config.mjs or add "type": "module" to your package.json as error suggests?

[Shahariar_Ashik]

If I convert rollup.config.js to rollup.config.mjs it now gives below error:

[!] TypeError: Unknown file extension ".json" for /home/ashik/ts-project/package.json

[yamlcoder]

OK, I’ll try to reproduce problem using files you provided and let you know.

[Shahariar_Ashik]

okay thanks a lot.

[yamlcoder]

OK, I made it work, with these changes:

1. rename rollup.config.js to rollup.config.mjs
2. remove import pkg from "./package.json"; line from rollup.config.js as it is not used anyway.

Let me know if it fixes for you too, once confirmed we’ll update docs.

[Shahariar_Ashik]

npm run build didn’t give any error this time. But after running “sudo docker compose up” it shows like below:

[Shahariar_Ashik]

Finally it worked. But now I am having one more issue. I can’t register rpc functions.
main.ts

let InitModule: nkruntime.InitModule = function (
  ctx: nkruntime.Context,
  logger: nkruntime.Logger,
  nk: nkruntime.Nakama,
  initializer: nkruntime.Initializer
) {
  initializer.registerRpc("healthcheck", rpcHealthcheck);
  logger.info("My Custom Module initialized.");
};

// Reference InitModule to avoid it getting removed on build
!InitModule && InitModule.bind(null);

healthcheck.ts

function rpcHealthcheck(
  ctx: nkruntime.Context,
  logger: nkruntime.Logger,
  nk: nkruntime.Nakama,
  payload: string
) {
  logger.info("healthcheck rpc called");
  return JSON.stringify({ succeed: true });
}

tsconfig.json

{
  "compilerOptions": {
    "noImplicitReturns": true,
    "moduleResolution": "node",
    "esModuleInterop": true,
    "noUnusedLocals": true,
    "removeComments": true,
    "target": "es5",
    "module": "ESNext",
    "strict": false
  },
  "files": ["./node_modules/nakama-runtime/index.d.ts", "./healthcheck.ts"],
  "include": ["src/**/*"],
  "exclude": ["node_modules", "build"]
}

[KamilDev]

I’m new to Nakama and trying to follow the TypeScript Runtime with Rollup. I have strictly followed the tutorial (except I used CockroachDB setup for docker-compose.yml), unless I made a mistake somewhere.

I had the same issue as OP, and the following steps did fix it:

1. rename rollup.config.js to rollup.config.mjs
2. remove import pkg from "./package.json"; line from rollup.config.js as it is not used anyway.

However, when I run docker compose up, I get an error:

nakama-1  | {"level":"fatal","ts":"2025-01-18T10:51:00.392Z","caller":"server/runtime_javascript.go:640","msg":"Failed to load JavaScript files","error":"SyntaxError: index.js: Line 21:1 Unexpected reserved word"} 

I believe the issue is that the built JavaScript has:

export { main as default };

NakamaBackend/build/index.js

function getDefaultExportFromCjs (x) {
	return x && x.__esModule && Object.prototype.hasOwnProperty.call(x, 'default') ? x['default'] : x;
}

var main$1 = {};

var hasRequiredMain;
function requireMain() {
  if (hasRequiredMain) return main$1;
  hasRequiredMain = 1;
  function InitModule(ctx, logger, nk, initializer) {
    logger.info("TypeScript module loaded.");
  }
  !InitModule && InitModule.bind(null);
  return main$1;
}

var mainExports = requireMain();
var main = /*@__PURE__*/getDefaultExportFromCjs(mainExports);

export { main as default };

Here’s a zip of my files (minus node_modules). Please let me know if I made a mistake somewhere, I can’t figure it out.
https://www.dropbox.com/scl/fi/wjz18imr77ciy9dkwxk77/NakamaBakend.zip?rlkey=r0b916vyihka12a646qb1t913&st=qwy3e0p1&dl=0

[KamilDev]

Solution: The rollup.config.mjs provided in the documentation is not correct or outdated.

Searching the forum, I came across this message:

TypeScript Runtime Setup

Hello @Wobling, If your intent is to use rollup I suggest you work backwards and use our project template with rollup as a baseline and modify the source files with your own source code, as the guide may be a bit outdated at this point. Delete the Go and Lua source files if you’re not using those runtimes. Hope this helps.

If you do not plan on updating this documentation, then please add a disclaimer at the top, and save people the pain of unknowingly getting stuck trying to get an outdated tutorial to work.

If I replace the rollup.config.mjs contents provided by the tutorial with the version found in the GitHub repo:

import resolve from "@rollup/plugin-node-resolve";
import commonjs from "@rollup/plugin-commonjs";
import json from "@rollup/plugin-json";
import babel from "@rollup/plugin-babel";
import typescript from "@rollup/plugin-typescript";

const extensions = [".mjs", ".js", ".ts", ".json"];

export default {
  input: "./src/main.ts",
  external: ["nakama-runtime"],
  plugins: [
    // Compile TS to check types
    typescript(),

    // Allows node_modules resolution
    resolve(),

    json(),

    // Resolve CommonJS modules
    commonjs(),

    // Compile TS and build to ES5
    babel({
      extensions: extensions,
      babelHelpers: "bundled",
    }),
  ],
  output: {
    format: "cjs",
    file: "build/index.js",
  },
};

The built JavaScript is now correct and Nakama starts up correctly:

'use strict';

function InitModule(ctx, logger, nk, initializer) {
  logger.info("TypeScript module loaded.");
}
!InitModule && InitModule.bind(null);

[sesposito]

Hello @KamilDev,

Thanks for your feedback, we’ll take note and update the docs.

cc @HeroicNathan