@fvlab/postgresqlconfigurationstore

PostgreSQLConfigurationStore

Simple application settings or document storage using PostgreSQL. Global configurations will be stored under /internal/global/ and user-specific configurations will be stored under /internal/user/<userId>. The paths can be configured by passing optional arguments to the constructor.

NPM Package

Usage

Building

To build the project run the command below.

npm run build

Testing

Testing is done via test.ts which is currently a scratchpad for various operations.

npm run test

Initialization

Before anything can be read or written to PostgreSQL the library must be initialized. This is a necessary step to setup the Firebase configuration. There are two types of initialization available.

Initialize with Options

The first type of initialization available allows the library to be initialized with connection information. The bare minimum to include is

{
	host: "localhost", // PostgreSQL host.
	port: 5432, // PostgreSQL host.
	database: "config_store", // PostgreSQL database to store configuration.
	user: "username", // Username to connect with.
	password: "password" // Password to connect with.
}

If you'd like to overwrite the default table the configuration is written to, config, supply the tableName property with the configuration.

Connections are made with pg, for more options see their documentation.

public init(config?: PostgreSqlConfiguration): this

Initialize with a JSON File

Coming Soon

The second type of initialization available allows the library to be initialized with an preexisting JSON file that contains the configuration. The format is the same as a above,

{
	"host": "localhost", // PostgreSQL host.
	"port": 5432, // PostgreSQL host.
	"database": "config_store", // PostgreSQL database to store configuration.
	"user": "username", // Username to connect with.
	"password": "password" // Password to connect with.
}

If you'd like to overwrite the default table the configuration is written to, config, supply the tableName property with the configuration.

Connections are made with pg, for more options see their documentation.

public init(): this

Create and initialize the object.

const currentUserId = '1234';
const settings = new PostgreSqlConfigurationStore(
	currentUserId,
	'/custom/pathToGlobalConfig/',
	'/custom/pathToUserConfig'
);
return settings.init();

Retrieve values by key or get it's default value if a value doesn't exist for the key.

return settings.getGlobalData('someKey', 'default value')
.then(globalValue => ...);

return settings.getUserData('someOtherKey', 'default value')
.then(userValue => ...);

Set the key-value pair.

return settings.setGlobalData('someKey', 'some value')
.then(globalValue => ...);

return settings.setUserData('someOtherKey', 'some value')
.then(userValue => ...);

Update the Data Stored in the Specified Path

return settings.updateGlobalData('somePath', 'some value')
.then(globalValue => ...);

return settings.updateGlobalData('someOtherPath', 'some value')
.then(userValue => ...);

Supported operations

1. Forward-slash separated path

   return settings.setGlobalData('some/other/path', 'some value')
   .then(globalValue => ...);

2. Object / Array value

   return settings
    .updateGlobalData('somePath', { child1: "value1", child2: 42})
    .then(globalValue => ...);

   return settings
    .setGlobalData('somePath', [4, 2])
    .then(globalValue => ...);

3. set operations only create. update operations overwrite existing data at the path.

   // Current Config Store
   "apiKeys": {
     "someService": "some-api-key"
   }

   settings.updateGlobalData('apiKeys', { someOtherService: 'some-other-api-key' });
   
   // Expected Config Store
   "apiKeys": {
     "someService": "some-api-key",
     "someOtherService": "some-other-api-key"
   }

   settings.setGlobalData('apiKeys', { anotherService: 'another-api-key' });
   
   // Expected Config Store
   "apiKeys": {
     "anotherService": "another-api-key"
   }