Whats the status on @heroiclabs/nakama-js-protobuf?

elementalcode · September 11, 2023, 12:37am

What is the current status for @heroiclabs/nakama-js-protobuf?

Is it still needed if you want to use protobufs? Currently it’s broken because the isOpen method only exists in the cjs build while the esm build is old.

Is it still needed/supported? What is the intenteded way to use protobufs in js?

my guess is that there is an slight error on the build script:
this seems to be the old build script

github.com

heroiclabs/nakama-js/blob/master/packages/nakama-js-protobuf/build.js#L25


      
          const { execSync } = require("child_process");
          
          function esbuild(args) {
              execSync("npx esbuild --bundle index.ts --target=es6 --global-name=nakamajsprotobuf " + args)
          }
          
          // emit .d.ts files and perform type checking
          execSync("npx typescript --project tsconfig.json", {stdio: 'inherit'})
          
          esbuild(" --format=cjs --outfile=dist/nakama-js-protobuf.cjs.js")
          esbuild(" --format=esm --outfile=dist/nakama-js-protobuf.esm.mjs")
          esbuild(" --format=iife --outfile=dist/nakama-js-protobuf.iife.js")

and this seems to be the new one

github.com

heroiclabs/nakama-js/blob/master/packages/nakama-js-protobuf/build.mjs#L37


      
          await esbuild.build({
            ...config,
            format: 'cjs',
            outfile: 'dist/nakama-js-protobuf.cjs.js'
          });
          
          // Build ESM
          await esbuild.build({
            ...config,
            format: 'esm',
            outfile: 'dist/nakama-js-protobuf.esm.js'
          });
          
          // Build IIFE
          await esbuild.build({
            ...config,
            format: 'iife',
            outfile: 'dist/nakama-js-protobuf.iife.js'
          });

and since the package.json declares the extension mjs as the correct one

github.com

heroiclabs/nakama-js/blob/master/packages/nakama-js-protobuf/package.json#L10


      
          {
              "name": "@heroiclabs/nakama-js-protobuf",
              "version": "1.3.0",
              "description": "Websocket adapter adding protocol buffer support to the Nakama Javascript client.",
              "main": "dist/nakama-js-protobuf.cjs.js",
              "module": "dist/nakama-js-protobuf.esm.mjs",
              "exports": {
                  "./package.json": "./package.json",
                  ".": {
                      "import": "./dist/nakama-js-protobuf.esm.mjs",
                      "require": "./dist/nakama-js-protobuf.cjs.js"
                  }
              },
              "scripts": {
                  "build": "npx tsc && node build.mjs"
              },
              "devDependencies": {
                  "ts-proto": "^1.80.1",
                  "ts-proto-descriptors": "1.2.1"
              },

the new script is not building the esm version to the right file

also, for some reason the typing is also not being referenced in the package.json…

~~I will send a pr soon~~

github.com/heroiclabs/nakama-js

build(protobuf): fix build script and add typing to package.json

heroiclabs:master ← miltoncandelero:protobuf-js-fixes

opened 01:57PM - 11 Sep 23 UTC

miltoncandelero

+4255 -3743

- Fixed build script generating the esm file with the wrong extension - Added `…types` to the package.json file to point to the d.ts file Ref: https://forum.heroiclabs.com/t/nakama-js-protobuf-websocket-adapter-not-working/3727/2?u=elementalcode Ref: https://forum.heroiclabs.com/t/whats-the-status-on-heroiclabs-nakama-js-protobuf/4320?u=elementalcode

Topic		Replies	Views
Protobuf and REST API Local Setup	5	2232	November 25, 2020
Version 2.4.0 published on NPM registry missing nakama-js.cjs.js file Client Libraries sdk-javascript , typescript	2	446	June 6, 2022
Nakama-js-protobuf WebSocket adapter not working Client Libraries sdk-javascript , typescript	7	804	April 4, 2023
Go plugin build error with protobuf Local Setup	17	3534	January 30, 2022
How to authenticate using Javascript SDK? Local Setup getting-started , authentication , typescript	7	577	January 4, 2023

Whats the status on @heroiclabs/nakama-js-protobuf?

Related topics