npgsqlrest 1.1.5 → 1.1.7

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/package.json +1 -1
  2. package/readme.md +61 -5
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "npgsqlrest",
3
- "version": "1.1.5",
3
+ "version": "1.1.7",
4
4
  "description": "Automatic REST API for PostgreSQL Databases Client Build",
5
5
  "scripts": {
6
6
  "postinstall": "node postinstall.js",
package/readme.md CHANGED
@@ -25,6 +25,36 @@ NpgsqlRest Client Web App is a command line utility that runs as a configurable
25
25
 
26
26
  See the [default configuration file](https://vb-consulting.github.io/npgsqlrest/config/) with descriptions for more information.
27
27
 
28
+ ## Notes Before Installation
29
+
30
+ 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/).
31
+
32
+ Currently, only the Windows-64 and Linux-64 builds are supported.
33
+
34
+ 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.
35
+
36
+ If you try to install this package on MacOS, or any other unsupported OS, installation will report: `Unsupported OS detected: [OS Type]`.
37
+
38
+ To see how you can create your own custom build follow these instructions:
39
+
40
+ - The client application was built from the [`NpgsqlRestClient` project directory](https://github.com/vb-consulting/NpgsqlRest/tree/master/NpgsqlRestClient/).
41
+
42
+ Steps:
43
+
44
+ 1) Make sure that you have .NET8 SDK installed and ready.
45
+ 2) Clone [NpgsqlRest repository](https://github.com/vb-consulting/NpgsqlRest/tree/master/NpgsqlRest)
46
+ 3) Navigate to the [`NpgsqlRestClient` project directory](https://github.com/vb-consulting/NpgsqlRest/tree/master/NpgsqlRestClient/).
47
+ 4) Make your desired customizations (or not).
48
+ 5) Run publish command, for example, `dotnet publish -r win-x64 -c Release --output [target dir]`
49
+
50
+ ## Installation
51
+
52
+ Install `npgsqlrest` using npm:
53
+
54
+ ```console
55
+ npm install npgsqlrest --save-dev
56
+ ```
57
+
28
58
  ## Usage
29
59
 
30
60
  ```console
@@ -44,16 +74,44 @@ Example: npgsqlrest appsettings.json appsettings.D
44
74
  Example: npgsqlrest appsettings.json -o appsettings.Development.json
45
75
  ```
46
76
 
47
- ## Installation
77
+ - Use the `npgsqlrest-config-copy` command to copy the default config to the current directory (or, optionally, directory from the first argument).
48
78
 
49
- Install `npgsqlrest` using npm:
79
+ ```console
80
+ $ npx npgsqlrest-config-copy
81
+ Copied appsettings.json to /home/vbilopav/npgsqlrest-npm-test/appsettings.json
82
+ ```
83
+
84
+ - Running with supplied configuration:
50
85
 
51
86
  ```console
52
- npm install npgsqlrest --save-dev
87
+ $ npx npgsqlrest appsettings.json project-config.json
88
+ [11:29:06.551 INF] ----> Starting with configuration(s): ["EnvironmentVariablesConfigurationProvider", "JsonConfigurationProvider for 'appsettings.json' (Required)", "JsonConfigurationProvider for 'project-config.json' (Required)"] [Program]
89
+ [11:29:06.552 INF] Using connection: Host=127.0.0.1;Port=5432;Database=test;Username=postgres;Application Name=MyProject [Program]
90
+ [11:29:06.553 INF] Using Cookie Authentication with scheme Cookies. Cookie expires in 14 days. [Program]
91
+ [11:29:06.553 INF] Using Bearer Token Authentication with scheme BearerToken. Token expires in 1 hours and refresh token expires in 14 days. [Program]
92
+ [11:29:06.560 INF] Serving static files from /home/vbilopav/npgsqlrest-npm-test/wwwroot [Program]
93
+ [11:29:07.083 INF] Created endpoint POST /api/case-return-long-table1 [NpgsqlRest]
94
+ [11:29:07.083 INF] Created HTTP file: /home/vbilopav/npgsqlrest-npm-test/test_public.http [NpgsqlRest.HttpFiles]
95
+ [11:29:07.100 INF] Started in 00:00:00.5527040 [Program]
96
+ [11:29:07.100 INF] Listening on ["http://localhost:5001"] [Program]
97
+ ^C
98
+ $
53
99
  ```
54
100
 
55
101
  ## Changelog
56
102
 
103
+ ### 1.1.7
104
+
105
+ Update readme.
106
+
107
+ ### 1.1.6
108
+ ### 1.1.5
109
+ ### 1.1.4
110
+ ### 1.1.3
111
+ ### 1.1.2
112
+
113
+ Fixing the issue with the local .bin directory.
114
+
57
115
  ### 1.1.1
58
116
 
59
117
  - Move the download bin directory from share `/node_modules/.bin/` to package local `/node_modules/npgsqlrest/.bin/`
@@ -67,5 +125,3 @@ Client Build 1.1.0.0
67
125
  Npgsql 2.7.1.0
68
126
  NpgsqlRest.HttpFiles 1.0.2.0
69
127
  NpgsqlRest.TsClient 1.6.0.0
70
-
71
- https://github.com/vb-consulting/NpgsqlRest/releases/tag/v2.7.1-client-v1.1.0