protoc 1.1.2 → 21.0.0-rc1

package/README.md

@@ -1,34 +1,11 @@
-# Protocol Buffers for Node
-A wrapper in Node for the compiled protoc from https://github.com/protocolbuffers/protobuf.
-
-## Version
-It's currently using Protocol Buffers `v3.20.3`.
-
-## Platforms
-Google only provides binary files for Windows, Linux and OSX in x86_64 and x86_32.
-
-## Examples
-There's currently no documentation. Hopefully this example will help.
-
-```JavaScript
-var protoc = require("protoc");
-
-protoc.library(["path/to/file.proto", "path/to/file2.proto"], function(err, files) {
-  if (err) {
-    console.error(err);
-    return;
-  }
-
-  // Handle the JavaScript Vinyl files.
-  // These files can be used in Google Closure Compiler,
-  // but they require the files in
-  // https://github.com/google/protobuf/tree/master/js
-  
-  // ...
-});
-```
-
-It's also possible to directly call the protoc binary file:
-```
-npx protoc --help
-```
+protoc
+======
+
+This package provides the Protobuf compiler `protoc` <!-- inject: release.tag_name -->v21.0-rc1<!-- end -->.
+
+```shell script
+npm install --save-dev protoc
+npx protoc --version 
+```
+
+This is an unofficial distribution of the protoc binary from https://github.com/protocolbuffers/protobuf/releases.

package/assets.json

@@ -0,0 +1,42 @@
+[
+  {
+    "name": "protoc-21.0-rc-1-linux-aarch_64.zip",
+    "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v21.0-rc1/protoc-21.0-rc-1-linux-aarch_64.zip",
+    "platform": "linux",
+    "arch": "arm64",
+    "dotExe": false,
+    "executable": "protoc-linux-aarch_64"
+  },
+  {
+    "name": "protoc-21.0-rc-1-linux-x86_64.zip",
+    "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v21.0-rc1/protoc-21.0-rc-1-linux-x86_64.zip",
+    "platform": "linux",
+    "arch": "x64",
+    "dotExe": false,
+    "executable": "protoc-linux-x86_64"
+  },
+  {
+    "name": "protoc-21.0-rc-1-osx-aarch_64.zip",
+    "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v21.0-rc1/protoc-21.0-rc-1-osx-aarch_64.zip",
+    "platform": "darwin",
+    "arch": "arm64",
+    "dotExe": false,
+    "executable": "protoc-osx-aarch_64"
+  },
+  {
+    "name": "protoc-21.0-rc-1-osx-x86_64.zip",
+    "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v21.0-rc1/protoc-21.0-rc-1-osx-x86_64.zip",
+    "platform": "darwin",
+    "arch": "x64",
+    "dotExe": false,
+    "executable": "protoc-osx-x86_64"
+  },
+  {
+    "name": "protoc-21.0-rc-1-win64.zip",
+    "browser_download_url": "https://github.com/protocolbuffers/protobuf/releases/download/v21.0-rc1/protoc-21.0-rc-1-win64.zip",
+    "platform": "win32",
+    "arch": "x64",
+    "dotExe": true,
+    "executable": "protoc-win64.exe"
+  }
+]

package/package.json

@@ -1,28 +1,42 @@
 {
   "name": "protoc",
-  "version": "1.1.2",
-  "description": "A tool for converting proto buffers (.proto) files into javascript files usable in Closure Compiler with Closure Library.",
-  "main": "index.js",
+  "version": "21.0.0-rc1",
+  "upstreamVersion": "v21.0-rc1",
+  "description": "Installs the protocol buffer compiler \"protoc\" for you.",
+  "bin": {
+    "protoc": "protoc.cjs"
+  },
+  "engines": {
+    "node": ">=20.0.0"
+  },
   "scripts": {
-    "postinstall": "node scripts/postinstall.js",
-    "test": "node scripts/test.js"
+    "build": "npm run build:protoc && npm run build:tsc",
+    "build:protoc": "esbuild src/protoc.ts --bundle --platform=node --outfile=protoc.cjs",
+    "build:tsc": "tsc --noEmit",
+    "test": "tsx --test src/*.test.ts",
+    "lint": "biome lint",
+    "format": "biome format --write"
   },
-  "bin": {
-    "protoc": "./bin/protoc.js"
+  "type": "commonjs",
+  "publishConfig": {
+    "access": "public"
   },
-  "author": "Jeppe Rune Mortensen <jepperm@gmail.com>",
-  "license": "MIT",
+  "license": "Apache-2.0",
+  "author": "Timo Stamm <ts@timostamm.com>",
+  "homepage": "https://github.com/timostamm/protobuf-npm",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/YePpHa/node-protoc.git"
+    "url": "https://github.com/timostamm/protobuf-npm",
+    "directory": "packages/protoc"
   },
-  "dependencies": {
-    "glob": "^7.2.3",
-    "mkdirp": "^0.5.6",
-    "node-fetch": "^3.2.10",
-    "rimraf": "^3.0.2",
-    "unzipper": "^0.10.11",
-    "uuid": "^9.0.0",
-    "vinyl": "^2.2.1"
+  "keywords": [
+    "Protocol Buffers",
+    "protobuf",
+    "protoc",
+    "installation"
+  ],
+  "devDependencies": {
+    "tsx": "^4.20.3",
+    "fflate": "^0.8.2"
   }
 }

package/protoc.cjs

@@ -0,0 +1,27 @@
+#!/usr/bin/env node
+"use strict";
+
+// src/protoc.ts
+var import_node_path = require("node:path");
+var import_node_child_process = require("node:child_process");
+var import_node_fs = require("node:fs");
+var rootDir = __dirname.endsWith("src") ? (0, import_node_path.dirname)(__dirname) : __dirname;
+var assets = JSON.parse(
+  (0, import_node_fs.readFileSync)((0, import_node_path.join)(rootDir, "assets.json"), "utf-8")
+);
+var asset = assets.find(
+  (asset2) => asset2.arch === process.arch && asset2.platform === process.platform
+);
+if (!asset) {
+  throw new Error(
+    `No protoc executable available for your platform (${process.platform}) and architecture (${process.arch})`
+  );
+}
+var command = (0, import_node_path.join)(rootDir, "bin", asset.executable);
+var p = (0, import_node_child_process.spawnSync)(command, process.argv.slice(2), {
+  stdio: "inherit"
+});
+if (p.error !== void 0) {
+  throw p.error;
+}
+process.exit(p.status ?? 0);

package/bin/protoc.js

@@ -1,19 +0,0 @@
-#!/usr/bin/env node
-
-const { protoc } = require("../");
-
-protoc(process.argv.slice(2), {}, (err, stdout, stderr) => {
-  if (err) {
-    console.error(err);
-    process.exit(1);
-    return;
-  }
-
-  if (stdout) {
-    console.info(stdout);
-  }
-
-  if (stderr) {
-    console.error(stderr);
-  }
-})

package/index.js

@@ -1,130 +0,0 @@
-const path = require("path");
-const cp = require("child_process");
-const fs = require("fs");
-const protoc = require("./protoc.js");
-const Vinyl = require("vinyl");
-const uuid = require("uuid");
-const mkdirp = require("mkdirp");
-const glob = require("glob");
-
-exports.protoc = function(args, options, callback) {
-  cp.execFile(protoc, args, options, callback);
-};
-
-exports.closure = function(files, options, callback) {
-  if (!callback) {
-    callback = options;
-    options = null;
-  }
-
-  options.imports = options.imports || [];
-  options.outputPath = options.outputPath || "./";
-
-  const cwd = process.cwd();
-  const absoluteOutputPath = path.resolve(cwd, options.outputPath);
-  const relative = path.relative(absoluteOutputPath, cwd);
-
-  const args = [
-    "--js_out=one_output_file_per_input_file,binary:."
-  ];
-
-  for (var i = 0; i < options.imports.length; i++) {
-    args.push("-I", path.join(relative, options.imports[i]));
-  }
-
-  for (var i = 0; i < files.length; i++) {
-    args.push(path.join(relative, files[i]));
-  }
-
-  mkdirp(options.outputPath, function(err) {
-    if (err) {
-      callback(err);
-      return;
-    }
-
-    exports.protoc(args, {
-      "cwd": options.outputPath
-    }, callback);
-  });
-};
-
-/**
- * Converts .proto files to .js files that can be used in Google Closure
- * Compiler.
- * The generated .js files require the files in
- * https://github.com/protocolbuffers/protobuf/tree/v3.20.3/js.
- * @param {?Array<string>} files the proto files.
- * @param {?function(?Error, ?Array<Vinyl>)} callback the callback method.
- */
-exports.library = function(files, callback) {
-  var dirpath = "tmp";
-  var filename = uuid.v4();
-  var jsFile = path.join(dirpath, filename);
-  mkdirp("tmp", function(err) {
-    if (err) {
-      callback(err);
-      return;
-    }
-
-    exports.protoc(["--js_out=library=" + jsFile + ",binary:."].concat(files), function(err, stdout, stderr) {
-      if (err) {
-        callback(err);
-        return;
-      }
-
-      if (fs.existsSync(jsFile + ".js")) {
-        fs.readFile(jsFile + ".js", function(err, contents) {
-          if (err) {
-            callback(err);
-            return;
-          }
-
-          fs.unlink(jsFile + ".js", function(err) {
-            if (err) {
-              callback(err);
-              return;
-            }
-
-            fs.rmdir(dirpath, function() {
-              callback(null, [new Vinyl({
-                "cwd": "/",
-                "base": "/",
-                "path": filename + ".js",
-                "contents": contents
-              })]);
-            });
-          });
-        });
-      } else {
-        glob("**/*.js", {
-          "cwd": jsFile
-        }, function(err, matches) {
-          if (err) {
-            callback(err, null);
-            return;
-          }
-
-          var files = matches.map(function(match) {
-            return new Vinyl({
-              "cwd": "/",
-              "base": "/",
-              "path": match,
-              "contents": fs.readFileSync(path.join(jsFile, match))
-            });
-          });
-
-          rimraf(jsFile, function(err) {
-            if (err) {
-              callback(err);
-              return;
-            }
-
-            fs.rmdir(dirpath, function() {
-              callback(null, files);
-            });
-          });
-        });
-      }
-    });
-  });
-};

package/protoc.js

@@ -1,5 +0,0 @@
-const path = require("path");
-
-const protoc_bin = path.join(__dirname, "protoc", "bin");
-
-module.exports = path.join(protoc_bin, "protoc" + (process.platform === "win32" ? ".exe" : ""));

package/scripts/postinstall.js

@@ -1,58 +0,0 @@
-const fs = require("fs");
-const path = require("path");
-const unzip = require("unzipper");
-const mkdirp = require("mkdirp");
-const protoc = require("../protoc.js");
-
-const protoVersion = "3.20.3";
-
-const releases = {
-  "win32_x86_32": `https://github.com/protocolbuffers/protobuf/releases/download/v${protoVersion}/protoc-${protoVersion}-win32.zip`,
-  "win32_x86_64": `https://github.com/protocolbuffers/protobuf/releases/download/v${protoVersion}/protoc-${protoVersion}-win32.zip`,
-  "linux_x86_32": `https://github.com/protocolbuffers/protobuf/releases/download/v${protoVersion}/protoc-${protoVersion}-linux-x86_32.zip`,
-  "linux_x86_64": `https://github.com/protocolbuffers/protobuf/releases/download/v${protoVersion}/protoc-${protoVersion}-linux-x86_64.zip`,
-  "darwin_x86_64": `https://github.com/protocolbuffers/protobuf/releases/download/v${protoVersion}/protoc-${protoVersion}-osx-x86_64.zip`
-};
-
-const platform = process.platform;
-const arch = process.arch === "x64" ? "x86_64" : "x86_32";
-const release = platform + "_" + arch;
-const protocDirectory = path.join(__dirname, "..", "protoc");
-
-(async () => {
-  if (!releases[release]) {
-    throw new Error(`Unsupported platform: ${release}. Was not able to find a proper protoc version.`);
-  }
-
-  fs.rmSync(protocDirectory, { recursive: true, force: true });
-
-  const fetch = await import("node-fetch");
-  const response = await fetch.default(releases[release]);
-  response
-    .body
-    .pipe(unzip.Parse())
-    .on("entry", entry => {
-      const isFile = "File" === entry.type;
-      const isDir = "Directory" === entry.type;
-      const fullpath = path.join(protocDirectory, entry.path);
-      const directory = isDir ? fullpath : path.dirname(fullpath);
-
-      mkdirp(directory, err => {
-        if (err) {
-          throw err;
-        }
-        if (isFile) {
-          entry.pipe(fs.createWriteStream(fullpath))
-          .on("finish", function() {
-            if (protoc === fullpath) {
-              fs.chmod(fullpath, 0o755, function(err) {
-                if (err) {
-                  throw err;
-                }
-              });
-            }
-          });
-        }
-      });
-    });
-})();

package/scripts/test.js

@@ -1,7 +0,0 @@
-const protoc = require("../index.js");
-protoc.library(["protoc/include/google/protobuf/timestamp.proto"], function(err, files) {
-  if (err) {
-    console.error(err);
-    return;
-  }
-});