npgsqlrest 1.1.6 → 1.1.8

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "npgsqlrest",
-  "version": "1.1.6",
+  "version": "1.1.8",
   "description": "Automatic REST API for PostgreSQL Databases Client Build",
   "scripts": {
     "postinstall": "node postinstall.js",
+    "uninstall": "node uninstall.js",
     "start": "npx npgsqlrest ./appsettings.json ./npgsqlrest.json"
   },
   "bin": {
-    "npgsqlrest": "./npgsqlrest.js",
+    "npgsqlrest": "node_modules/.bin/npgsqlrest",
     "npgsqlrest-config-copy": "./config-copy.js"
   },
   "repository": {

package/postinstall.js

@@ -1,9 +1,11 @@
+#!/usr/bin/env node
+
 const fs = require("fs");
 const path = require("path");
 const os = require("os");
 const https = require("https");
 
-const downloadDir = "./.bin/";
+const downloadDir = "../.bin/";
 const downloadFrom = "https://github.com/vb-consulting/NpgsqlRest/releases/download/v2.7.1-client-v1.1.0/";
 
 function download(url, to, done) {

package/readme.md

@@ -25,6 +25,28 @@ NpgsqlRest Client Web App is a command line utility that runs as a configurable
 
 See the [default configuration file](https://vb-consulting.github.io/npgsqlrest/config/) with descriptions for more information.
 
+## Notes Before Installation
+
+This package will download an executable file for the target OS on installation (see the postinstall.js script) from the [GitHub release page](https://github.com/vb-consulting/NpgsqlRest/releases/).
+
+Currently, only the Windows-64 and Linux-64 builds are supported.
+
+The Mac OS builds are missing because I don't have a Mac machine. If someone could help me out with this I'd be grateful. 
+
+If you try to install this package on MacOS, or any other unsupported OS, installation will report: `Unsupported OS detected: [OS Type]`.
+
+To see how you can create your own custom build follow these instructions:
+
+Steps:
+
+1) Make sure that you have .NET8 SDK installed and ready.
+2) Clone [NpgsqlRest repository](https://github.com/vb-consulting/NpgsqlRest/tree/master/NpgsqlRest)
+3) Navigate to the [`NpgsqlRestClient` project directory](https://github.com/vb-consulting/NpgsqlRest/tree/master/NpgsqlRestClient/).
+4) Make your desired customizations (or not).
+5) Run publish command, for example, `dotnet publish -r win-x64 -c Release --output [target dir]`
+
+Notes: `win-x64` is the designated target OS for the build. Adjust this parameter appropriately for the target OS. See [https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids](https://learn.microsoft.com/en-us/dotnet/core/rid-catalog#known-rids). The project is already configured for the AOT builds, but you will need to run the publish command from the same flavor OS as the build target OS (Windows for Windows builds, Linux for Linux builds, etc).
+
 ## Installation
 
 Install `npgsqlrest` using npm:
@@ -72,12 +94,22 @@ $ npx npgsqlrest appsettings.json project-config.json
 [11:29:07.083 INF] Created HTTP file: /home/vbilopav/npgsqlrest-npm-test/test_public.http [NpgsqlRest.HttpFiles]
 [11:29:07.100 INF] Started in 00:00:00.5527040 [Program]
 [11:29:07.100 INF] Listening on ["http://localhost:5001"] [Program]
-^C
-$
 ```
 
 ## Changelog
 
+### 1.1.8
+
+Changed the download target from `./node_modules/npgsqlrest/.bin/` to shared bin: `./node_modules/.bin/`.
+
+The reason is that when using the `./node_modules/npgsqlrest/.bin/` directory, I have to use the node spawn process wrapper which slows down the startup time. When the executable is in the `./node_modules/.bin/` it can be invoked directly which is an extremely fast, almost instant startup (a couple of milliseconds).
+
+But now, I have to use the uninstall script too, to ensure the proper cleanup on the install.
+
+### 1.1.7
+
+Update readme.
+
 ### 1.1.6
 ### 1.1.5
 ### 1.1.4
@@ -95,9 +127,9 @@ Fixing the issue with the local .bin directory.
 
 New build versions:
 
+```console
 Client Build         1.1.0.0
 Npgsql               2.7.1.0
 NpgsqlRest.HttpFiles 1.0.2.0
 NpgsqlRest.TsClient  1.6.0.0
-
-https://github.com/vb-consulting/NpgsqlRest/releases/tag/v2.7.1-client-v1.1.0
+```

package/uninstall.js

@@ -0,0 +1,21 @@
+#!/usr/bin/env node
+
+const fs = require("fs");
+const os = require("os");
+
+const downloadDir = "../.bin/";
+const osType = os.type();
+
+var downloadTo;
+
+if (osType === "Windows_NT") {
+    downloadTo = `${downloadDir}npgsqlrest.exe`;
+} else {
+    downloadTo = `${downloadDir}npgsqlrest`;
+}
+
+if (fs.existsSync(downloadTo)) {
+    fs.unlinkSync(downloadTo);
+}
+
+

package/npgsqlrest.js

@@ -1,21 +0,0 @@
-#!/usr/bin/env node
-
-const { spawn } = require("child_process");
-const path = require("path");
-
-// Path to the binary file
-const binaryPath = path.join(__dirname, "./.bin/npgsqlrest");
-
-// Arguments passed to the script
-const args = process.argv.slice(2);
-
-// Spawn a child process to run the binary file
-const child = spawn(binaryPath, args, { stdio: "inherit" });
-
-child.on("error", (error) => {
-    console.error(`Failed to start subprocess.\n${error}`);
-});
-
-child.on("exit", (code) => {
-    process.exit(code);
-});