Releases · vb-consulting/NpgsqlRest

13 Jul 10:12

vbilopav

v2.8.5-client-v1.3.0

3889989

AOT Client v1.3.0 NpgsqlRest v2.8.5 Latest

Latest

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
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. 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).

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

1.3.0

Upgrade System.Text.Json to 8.0.4

New option: NpgsqlRest.UseEnvironmentConnection

NpgsqlRest.UseEnvironmentConnection:

If the connection string is not found, empty, or missing host, port or database, the connection string is created from the environment variables.

See https://www.postgresql.org/docs/current/libpq-envars.html for the list of the environment variables.

Note: Npgsql will use the environment variables by default but only for the small set of the connection string parameters like username and password (see https://www.npgsql.org/doc/connection-string-parameters.html#environment-variables).

Set this option to true to use environment variables for host, port and database as well.

When this option is enabled and these environment variables are set, connection string doesn't have to be defined at all and it will be created from the environment variables.

New option: NpgsqlRest.TsClient.DefaultJsonType

NpgsqlRest.TsClient.DefaultJsonType:

Sets the default TypeScript type for JSON types when generating the TypeScript client.

Version 1.2.8

Upgrade NpgsqlRest to 2.8.5.

Version 1.2.7

Upgrade NpgsqlRest to 2.8.4.
Version from 1.2.4 to 1.2.7 is to sync with the version of the NPM package.
Improvements in external auth:
- The optional third parameter receives JSON with parameters received from an external provider and query string parameters supplied to the original endpoint.
- Login command number of parameters is optional i.e. it can be either select * from auth($1) or select * from auth($1,$2) or select * from auth($1,$2,3) (three is max).
- Calls to external login/auth commands are logged by the same options, same rules, same format and the same logger as all other commands.

Version 1.2.5

Upgrade NpgsqlRest to 2.8.3.
Upgrade NpgsqlRest.TsClient to 1.8.1.

Version 1.2.4

Upgrade NpgsqlRest to 2.8.2.

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

The NpgsqlRest.InstanceIdRequestHeaderName setting allows you to specify the header name that will be used to identify the instance of the application. Header value will be used as the unique running instance ID.

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

Maps a routine function name to a custom claim type. If the request parameter maps to the parameter name defined by the NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings - it will return the matching value of the claim type, regardless of the parameter value.

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

25 Jun 17:02

vbilopav

v2.8.5-client-v1.2.8

603eaaa

AOT Client v1.2.8 NpgsqlRest v2.8.5

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.8

Upgrade NpgsqlRest to 2.8.5.

Version 1.2.7

Upgrade NpgsqlRest to 2.8.4.
Version from 1.2.4 to 1.2.7 is to sync with the version of the NPM package.
Improvements in external auth:
- The optional third parameter receives JSON with parameters received from an external provider and query string parameters supplied to the original endpoint.
- Login command number of parameters is optional i.e. it can be either select * from auth($1) or select * from auth($1,$2) or select * from auth($1,$2,3) (three is max).
- Calls to external login/auth commands are logged by the same options, same rules, same format and the same logger as all other commands.

Version 1.2.5

Upgrade NpgsqlRest to 2.8.3.
Upgrade NpgsqlRest.TsClient to 1.8.1.

Version 1.2.4

Upgrade NpgsqlRest to 2.8.2.

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

22 Jun 12:07

vbilopav

v2.8.4-client-v1.2.7

4eaebb0

AOT Client v1.2.7 NpgsqlRest v2.8.4

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.7

Upgrade NpgsqlRest to 2.8.4.
Version from 1.2.4 to 1.2.7 is to sync with the version of the NPM package.
Improvements in external auth:
- The optional third parameter receives JSON with parameters received from an external provider and query string parameters supplied to the original endpoint.
- Login command number of parameters is optional i.e. it can be either select * from auth($1) or select * from auth($1,$2) or select * from auth($1,$2,3) (three is max).
- Calls to external login/auth commands are logged by the same options, same rules, same format and the same logger as all other commands.

Version 1.2.5

Upgrade NpgsqlRest to 2.8.3.
Upgrade NpgsqlRest.TsClient to 1.8.1.

Version 1.2.4

Upgrade NpgsqlRest to 2.8.2.

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

11 Jun 17:11

vbilopav

v2.8.3-client-v1.2.5

951935c

AOT Client v1.2.5 NpgsqlRest v2.8.3

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.5

Upgrade NpgsqlRest to 2.8.3.
Upgrade NpgsqlRest.TsClient to 1.8.1.

Version 1.2.4

Upgrade NpgsqlRest to 2.8.2.

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

10 Jun 16:17

vbilopav

v2.8.2-client-v1.2.4

8c0f029

AOT Client v1.2.4 NpgsqlRest v2.8.2

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.4

Upgrade NpgsqlRest to 2.8.2.

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

30 May 09:37

vbilopav

v2.8.1-client-v1.2.3

b5fd4bb

AOT Client v1.2.3 NpgsqlRest v2.8.1

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.3

New setting NpgsqlRest.InstanceIdRequestHeaderName:

{
    //
    //...
    //
    "NpgsqlRest": {
        "InstanceIdRequestHeaderName": "X-Instance-Id"
    }
    //
    //...
    //
}

This is useful when you have multiple instances of the application running behind a load balancer, and you want to identify which instance is handling the request.

Default is null (not used).

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

21 May 06:20

vbilopav

v2.8.1-client-v1.2.2

9d7bf85

AOT Client v1.2.2 NpgsqlRest v2.8.1

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To create a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Changelog

Version 1.2.2

New setting NpgsqlRest.AuthenticationOptions.CustomParameterNameToClaimMappings:

{
    //
    //...
    //
    "NpgsqlRest": {
        "AuthenticationOptions": {
            "CustomParameterNameToClaimMappings": {
                "parameter_name": "claim_type_name"
            }
        }
    },
    //
    //...
    //
}

If that parameter is an array, it will have all values in an array of that claim type. If it is a single value, it will have only the first value of that claim type.

Version 1.2.1

New option UseHsts: Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builder.

{
    //
    //...
    //
    "Ssl": {
        "HttpsRedirection": true,
        //
        // Adds middleware for using HSTS, which adds the Strict-Transport-Security header. See https://learn.microsoft.com/en-us/dotnet/api/microsoft.aspnetcore.builderhstsbuilderextensions.usehsts?view=aspnetcore-2.1
        //
        "UseHsts": true
    }
    //
    //...
    //
}

Version 1.2.0

Bugfix with missing dictionary key when using external auth.
New Config section:

"Config": {
    //
    // Expose current configuration to the endpoint for debugging and inspection. Note, the password in the connection string is not exposed.
    //
    "ExposeAsEndpoint": "/config",
    //
    // Add the environment variables to configuration first.
    //
    "AddEnvironmentVariables": false
}

Support for the CustomRequestHeaders option.
Support for the new options in TsClient.

Version 1.1.0

Client application new release with massive improvements.
External auth logins implementation (Google, LinkedIn, GitHub)

Assets 5

10 May 17:23

vbilopav

v2.8.1-client-v1.2.1

64bcafd

AOT Client v1.2.1 NpgsqlRest v2.8.1

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To crate a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Assets 5

02 May 17:33

vbilopav

v2.8.0-client-v1.2.0

4f22e63

AOT Client v1.2.0 NpgsqlRest v2.8.0

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To crate a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Assets 5

30 Apr 12:34

vbilopav

v2.7.1-client-v1.1.0

80bcd8e

AOT Client v1.1.0 NpgsqlRest v2.7.1

There are three files available for download:

appsettings.json: The default configuration file. See the default configuration file.
npgsqlrest-linux64: Linux64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Linux 64x systems.
npgsqlrest-win64.exe: Windows64 build. This is a self-contained ahead-of-time (AOT) compiled to native code executable for the Windows 64x systems.

NPM

Installation is possible via the NPM package manager:

npm install npgsqlrest --save-dev

The NPM package will download on installation the appropriate executable binary for your target operating system. The command will be available with the NPX runner:

$ npx npgsqlrest [arguments]

See usage for more info.

Custom Builds

The client application was built from the NpgsqlRestClient project directory.

To crate a custom build follow these steps:

Make sure that you have .NET8 SDK installed and ready.
Clone NpgsqlRest repository
Navigate to the NpgsqlRestClient project directory.
Make your desired customizations (or not).
Run publish command, for example, dotnet publish -r win-x64 -c Release --output [target dir]

MacOS Builds

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.

Features

Create an Automatic REST API for the PostgreSQL Databases.
Generate TypeScript Code and HTTP files for testing.
Configure security for use the of either encrypted cookies or JWT Bearer tokens or both.
Expose REST API endpoints for the PostgreSQL Databases as Login/Logout.
Use external authentication providers such as Google, LinkedIn or GitHub.
Server static content.
Use and configure built-in Serilog structured logging.
Configure Cross-origin resource sharing (CORS) access, SSL, Server Certificates and more, everything needed for modern Web development.

See the default configuration file with descriptions for more information.

Usage

❯ npgsqlrest --help
Usage:
npgsqlrest                             Run with the default configuration files: appsettings.json (required) and appsettings.Development.json (optional).
npgsqlrest [files...]                  Run with the custom configuration files. All configuration files are required.
npgsqlrest [file1 -o file2...]         Use the -o switch to mark the next configuration file as optional. The first file after the -o switch is optional.
npgsqlrest [file1 --optional file2...] Use --optional switch to mark the next configuration file as optional. The first file after the --optional switch is optional.

npgsqlrest -v, --version               Show version information.
npgsqlrest -h, --help                  Show command line help.

Note:                                  Values in the later file will override the values in the previous one.

Example:                               npgsqlrest appsettings.json appsettings.Development.json
Example:                               npgsqlrest appsettings.json -o appsettings.Development.json

Assets 5

Releases: vb-consulting/NpgsqlRest

AOT Client v1.3.0 NpgsqlRest v2.8.5

NPM

Custom Builds

MacOS Builds

Features

Usage

Changelog

1.3.0

Upgrade System.Text.Json to 8.0.4

New option: NpgsqlRest.UseEnvironmentConnection

New option: NpgsqlRest.TsClient.DefaultJsonType

Version 1.2.8

Version 1.2.7

Version 1.2.5

Version 1.2.4

Version 1.2.3

Version 1.2.2

Version 1.2.1

Version 1.2.0

Version 1.1.0

AOT Client v1.2.8 NpgsqlRest v2.8.5

NPM

Custom Builds

MacOS Builds

Features

Usage

Changelog

Version 1.2.8

Version 1.2.7

Version 1.2.5

Version 1.2.4

Version 1.2.3

Version 1.2.2

Version 1.2.1

Version 1.2.0

Version 1.1.0

AOT Client v1.2.7 NpgsqlRest v2.8.4

NPM

Custom Builds

MacOS Builds

Features

Usage

Changelog

Version 1.2.7

Version 1.2.5

Version 1.2.4

Version 1.2.3

Version 1.2.2

Version 1.2.1

Version 1.2.0

Version 1.1.0

AOT Client v1.2.5 NpgsqlRest v2.8.3

NPM

Custom Builds

MacOS Builds

Features

Usage

Changelog

Version 1.2.5

Version 1.2.4

Version 1.2.3

Version 1.2.2

Version 1.2.1

Version 1.2.0

Version 1.1.0

AOT Client v1.2.4 NpgsqlRest v2.8.2

NPM

Custom Builds

MacOS Builds

Features

Usage

Changelog

Version 1.2.4

Version 1.2.3

Version 1.2.2

Version 1.2.1

Version 1.2.0

Version 1.1.0

AOT Client v1.2.3 NpgsqlRest v2.8.1