README

voltcloud-for-browsers

a simple VoltCloud client library for web browsers

VoltCloud.io is a simple (and reasonably priced) deployment server for web applications with integrated user management and key-value stores for both the application itself and any of its users.

voltcloud-for-browsers is a simple client library for web applications which need access to VoltCloud and its functions. Because of security restrictions due to CORS, it contains a subset of the operations offered by voltcloud-for-nodejs (a similar library for applications and servers based on Node.js) only, but offers a similar API.

VfB-Notes is a simple demonstrator showing voltcloud-for-browsers in action (its source is also available on GitHub).

See below for a "smoke test" which may also serve as an example for how to use this library.

Please note: the author is not affiliated with the NSB Corporation in any way. If you want to blame any of the author's VoltCloud-related tools and libraries for some misbehaviour, it's not the fault of George Henne and his team - it is the author's mistake!

NPM users: please consider the Github README for the latest description of this package (as updating the docs would otherwise always require a new NPM package version)

Just a small note: if you like this module and plan to use it, consider "starring" this repository (you will find the "Star" button on the top right of this page), so that I know which of my repositories to take most care of.

Overview

As a developer, one may sign-up for VoltCloud to create (web-based) applications and give them a name. Then, the actual application may be uploaded to VoltCloud and will from now on be served from a VoltCloud URL which includes the given name.

If desired, VoltCloud applications may support their own "users" (in this document, these users are called "customers" in order to explicitly distinguish them from application "developers").

Users may register themselves for a VoltCloud application by providing their EMail address and a password (which they will need later to log into the application). Upon registration, a "confirmation mail" will be sent to the given address that includes a special link to the application which, when clicked, will allow the application to confirm the given user. Should the confirmation message get lost, it may be resent upon request.

Should a customer forget his/her password, there is also the possibility to initiate a "password reset" process. If triggered, a "password reset email" with a special link to the application will be sent to the customer which, when clicked, should allow the customer to change his/her password. A password reset may be triggered as often as needed.

special note for german customers: for an unknown reason, customer confirmation or password reset message take quite a while (approx. 2 hours) to reach mailboxes hosted by GMX and Web.de - if you need s.th. to test with, try address at Mail.de, those seem to be much faster right now.

It is important to understand, that an application and a customer who registered for it form a unit. As a consequence, the EMail address may be used for multiple applications - and all customers with that address will be completely independent from each other. VoltCloud does not offer any possibility to extend a given registration to other applications.

Once confirmed, a customer may set a first and/or a last name, change his/her password and even configure a new EMail address.

A developer may request a list of all customers which registered for a given application and sees their EMail addresses, their names and whether they have already been confirmed or not - but VoltCloud does not show him/her any customer's password (not even a hash value)

VoltCloud also manages individual key-value stores for an application and each of its customers. Both keys and values have to be strings (keys may be up to 255 characters long, values up to 1048574 characters). As is common practice, new entries may be created at will, existing entries read or deleted and a list of all entries requested from VoltCloud.

Developers may inspect and change both an application's key-value store and the stores of all related customers, while customers themselves may inspect and change their own store, but only inspect (and not change) the store of the application they registered for.

Mandating

Because of how VoltCloud works, voltcloud-for-browsers may run in one of three modes, distinguished by "mandates":

independent of a "mandate" (and even without any), the library always allows to register and confirm new customers, resend confirmation messages and initiate or complete password resets
while logged-in as a developer, the library also allows to create and manage applications and customers and their associated key-value stores
while logged-in as a customer, the library also allows to manage that customer's account and key-value store.

"Mandates" are set using one of the functions actOnBehalfOfDeveloper or actOnBehalfOfCustomer. Before any of these function is called, no "mandate" will be set. Any successful completion of actOnBehalfOfDeveloper or actOnBehalfOfCustomer will change the currently active mandate to that of the given developer or customer, resp.

Mandates may be changed as often as needed and allow voltcloud-for-browsers to be used both for VoltCloud user applications (running with customer mandates) and VoltCloud management tools (running with developer mandates)

Focusing

Because voltcloud-for-browsers may only be used for a specific VoltCloud application (due to CORS restrictions), the library has to be told to "focus" on that application using focusOnApplication. When running with a developer mandate, it is also possible to "focus" on a specific customer (using focusOnCustomer) - when running with a customer mandate or if a new customer is registered (using focusOnNewCustomer), that customer is "focused" automatically.

Normally, all application- or customer-specific functions require such a focus. Only resendConfirmationEMailToCustomer, confirmCustomerUsing, startPasswordResetForCustomer and resetCustomerPasswordUsing may be run without a customer focus by providing (a token or) the email address of the current target customer.

Error Handling

In contrast to Java, it's not very common in JavaScript to throw specific subclasses of Error depending on the type of error that occurred. voltcloud-for-browsers therefore throws "named errors", i.e., instances of Error which contain a name and a message property. The name property distinguishes the various error "types" and may be easily used in a switch statement to perform some type-specific error handling.

Installation

voltcloud-for-browsers may be used as an ECMAScript module (ESM), a CommonJS or AMD module or from a global variable.

You may either install the package into your build environment using NPM with the command

npm install voltcloud-for-browsers

or load the plain script file directly

<script src="https://unpkg.com/voltcloud-for-browsers"></script>

Access

How to access the package depends on the type of module you prefer

ESM (or Svelte): import { actOnBehalfOfDeveloper, ApplicationRecords } from 'voltcloud-for-browsers'
CommonJS: const VoltCloud = require('voltcloud-for-browsers')
AMD: require(['voltcloud-for-browsers'], (VoltCloud) => {...})

Alternatively, you may access the global variable VoltCloud directly.

Note for ECMAScript module users: all module functions and values are exported individually, thus allowing your bundler to perform some "tree-shaking" in order to include actually used functions or values (together with their dependencies) only.

Import Template

If you prefer, you may simply copy the following statement into your source code and remove all unwanted functions:

import {
  actOnBehalfOfDeveloper, actOnBehalfOfCustomer,
  focusOnApplication,
  ApplicationStorage, ApplicationStorageEntry,
  focusOnCustomer, focusOnNewCustomer,
  resendConfirmationEMailToCustomer, confirmCustomerUsing,
  startPasswordResetForCustomer, resetCustomerPasswordUsing,
  CustomerRecord, changeCustomerEMailAddressTo, changeCustomerPasswordTo,
    updateCustomerRecordBy, deleteCustomer,
  CustomerStorage, CustomerStorageEntry, setCustomerStorageEntryTo,
    deleteCustomerStorageEntry, clearCustomerStorage
} from 'voltcloud-for-browsers'

Usage within Svelte

For Svelte, it is recommended to import the package in a module context. From then on, its exports may be used as usual:

<script context="module">
  import { actOnBehalfOfDeveloper, ApplicationRecords } from 'voltcloud-for-browsers'
</script>

<script>
  const EMailAddress = '...'
  const Password     = '...'
  await actOnBehalfOfDeveloper(EMailAddress,Password)
  console.log(await ApplicationRecords())
</script>

Usage as ECMAscript, CommonJS or AMD Module (or as a global Variable)

Let's assume that you already "required" or "imported" (or simply loaded) the module according to your local environment. In that case, you may use it as follows:

  const EMailAddress = '...'
  const Password     = '...'
  await VoltCloud.actOnBehalfOfDeveloper(EMailAddress,Password)
  console.log(await VoltCloud.ApplicationRecords())

API Reference

exported Constants

voltcloud-for-browsers exports the following constants:

const ApplicationNamePattern = /^([a-z0-9]|[a-z0-9][-a-z0-9]*[a-z0-9])$/
defines the regular expression pattern to which each VoltCloud application name must match
const maxApplicationNameLength = 63
defines the maximum length of any VoltCloud application name
const maxEMailAddressLength = 255
defines the maximum length of the email address used to identify developers and customers
const maxNamePartLength = 255
defines the maximum length of the first or last name of any customer
const maxStorageKeyLength = 255
defines the maximum length of any key in a VoltCloud key-value store
const maxStorageValueLength = 1048574
defines the maximum length of any value in a VoltCloud key-value store

exported Types

TypeScript programmers may import the following types in order to benefit from static type checking (JavaScript programmers may simply skip this section):

type VC_ApplicationName = string
application names are strings with 1...maxApplicationNameLength characters matching the regular expression ApplicationNamePattern
type VC_CustomerRecord = { id:string, email:VC_EMailAddress, first_name?:VC_NamePart, last_name?:VC_NamePart, confirmed:boolean, admin:boolean, meta?:any }
instances of this type are returned when details of an already registered user are requested
type VC_CustomerUpdate = { email?:VC_EMailAddress, password?:{ old:string, new:string, confirmation:string }, first_name?:string, last_name?:string }
instances of this type are used when specific details of an already registered user shall be changed
type VC_EMailAddress = string
the EMail addresses used to identify developers and customers are strings with up to maxEMailAddressLength characters
type VC_Password = string
VoltCloud passwords are strings fulfilling the VoltCloud requirements for passwords
type VC_NamePart = string
the first and last names of a customer are strings with up to maxNamePartLength characters
type VC_StorageKey = string
VoltCloud storage keys are strings with up to maxStorageKeyLength characters
type VC_StorageValue = string | undefined
VoltCloud storage values are strings with up to maxStorageValueLength characters. While VoltCloud itself responds with an error when non-existing entries are read, voltcloud-for-applications returns undefined instead
type VC_StorageSet = { [Key:string]:VC_StorageValue }
a VoltCloud storage can be seen as an associative array with literal keys and values

exported Classification and Validation Functions

ValueIsPassword (Value:any):boolean
returns true if the given value may be used as a VoltCloud password (i.e., if it is a string which fulfills the requirements of a VoltCloud password) or false otherwise
allowPassword (Description:string, Argument:any):string
checks if the given Argument (if it exists), may be used as a VoltCloud password (i.e., is a string which fulfills the requirements of a VoltCloud password). If this is the case (or Argument is missing), the function returns the primitive value of the given Argument, otherwise an error with the message "the given ${Description} is no valid VoltCloud password" is thrown, which uses the given Description. Similar to the javascript-interface-library, the variants allowedPassword, expectPassword and expectedPassword exist here as well
ValueIsApplicationName (Value:any):boolean
returns true if the given value may be used as a VoltCloud application name (i.e., if it is a string with 1...maxApplicationNameLength characters matching the regular expression ApplicationNamePattern) or false otherwise
allowApplicationName (Description:string, Argument:any):string
checks if the given Argument (if it exists), may be used as a VoltCloud application name (i.e., is a string with 1...maxApplicationNameLength characters matching the regular expression ApplicationNamePattern). If this is the case (or Argument is missing), the function returns the primitive value of the given Argument, otherwise an error with the message "the given ${Description} is no valid VoltCloud application name" is thrown, which uses the given Description. Similar to the javascript-interface-library, the variants allowedApplicationName, expectApplicationName and expectedApplicationName exist here as well
ValueIsStorageKey (Value:any):boolean
returns true if the given value may be used as a key for a VoltCloud key-value store or false otherwise
expectStorageKey (Description:string, Argument:any):string
checks if the given Argument (if it exists), may be used as a key for a VoltCloud key-value store. If this is the case (or Argument is missing), the function returns the primitive value of the given Argument, otherwise an error with the message "the given ${Description} is no valid VoltCloud storage key" is thrown, which uses the given Description. Similar to the javascript-interface-library, the variants allowedStorageKey, expectStorageKey and expectedStorageKey exist here as well
ValueIsStorageValue (Value:any):boolean
returns true if the given value may be used as a value in a VoltCloud key-value store or false otherwise
expectStorageValue (Description:string, Argument:any):string
checks if the given Argument (if it exists), may be used as a value for a VoltCloud key-value store. If this is the case (or Argument is missing), the function returns the primitive value of the given Argument, otherwise an error with the message "the given ${Description} is no valid VoltCloud storage value" is thrown, which uses the given Description. Similar to the javascript-interface-library, the variants allowedStorageValue, expectStorageValue and expectedStorageValue exist here as well

exported VoltCloud Functions not requiring any Mandate

async function focusOnApplication (ApplicationURL:string, ApplicationId:string):Promise<void>
sets the application given by ApplicationURL and ApplicationId as the target for all following application-specific requests. Both ApplicationURL and ApplicationId must belong to the same (existing) VoltCloud application. Because of CORS restrictions, ApplicationURL must refer to the same host that also serves the current document, or subsequent requests will fail
async function focusOnNewCustomer (EMailAddress:string, Password:string):Promise<void>
registers a new customer with the email address given by EMailAddress, configures the given Password as the initial password and sets him/her as the target for all following (customer-specific) requests. If configured for the current target application, this request will automatically send a customer confirmation email to the given address
async function resendConfirmationEMailToCustomer (EMailAddress:string):Promise<void>
if configured for the current target application, this function will send another customer confirmation email to the address given by EMailAddress
async function confirmCustomerUsing (Token:string):Promise<void>
confirms the email address given for a newly registered customer by providing the Token sent as part of a customer confirmation email. This token internally also specifies the customer to whom it was sent
async function startPasswordResetForCustomer (EMailAddress:string):Promise<void>
if configured for the current target application, this function will send a password reset email to the address given by EMailAddress
async function resetCustomerPasswordUsing (Token:string, Password:string):Promise<void>
sets Password as the new password for a customer by providing the Token sent as part of a password reset email. This token internally also specifies the customer to whom it was sent

exported VoltCloud Functions requiring either a Developer or a Customer Mandate

async function actOnBehalfOfDeveloper (EMailAddress:string, Password:string):Promise<void>
uses the given EMailAddress and Password to request an "access token" from VoltCloud, which is then used to authorize any non-public VoltCloud operation. Note: EMailAddress and Password are kept in memory while the process is running in order to automatically refresh the token upon expiry.
Important: do not run actOnBehalfOfDeveloper or actOnBehalfOfCustomer while any other request is running - or that other request may fail because of a changed mandate
async function actOnBehalfOfCustomer (EMailAddress:string, Password:string):Promise<void>
uses the given EMailAddress and Password to request an "access token" from VoltCloud, which is then used to authorize any non-public VoltCloud operation. This request requires to focus on an application first, since customers are application-specific. Note: EMailAddress and Password are kept in memory while the process is running in order to automatically refresh the token upon expiry.
Important: do not run actOnBehalfOfDeveloper or actOnBehalfOfCustomer while any other request is running - or that other request may fail because of a changed mandate
async function ApplicationStorage ():Promise<VC_StorageSet>
retrieves the complete key-value store for the current target application and delivers it as a JavaScript object
async function ApplicationStorageEntry (StorageKey:VC_StorageKey):Promise<VC_StorageValue | undefined>
retrieves an entry (given by StorageKey) from the key-value store for the current target application and returns its value (as a JavaScript string) - or undefined if the requested entry does not exist
async function deleteCustomer ():Promise<void>
deletes the current target customer
async function CustomerStorage ():Promise<VC_StorageSet>
retrieves the complete key-value store for the current target customer and delivers it as a JavaScript object
async function CustomerStorageEntry (StorageKey:VC_StorageKey):Promise<VC_StorageValue | undefined>
retrieves an entry (given by StorageKey) from the key-value store for the current target customer and returns its value (as a JavaScript string) - or undefined if the requested entry does not exist
async function setCustomerStorageEntryTo (StorageKey:VC_StorageKey, StorageValue:VC_StorageValue):Promise<void>
sets the entry given by StorageKey in the key-value store for the current target customer to the value given by StorageValue (which must be a JavaScript string). If the entry does not yet exist, it will be created
async function deleteCustomerStorageEntry (StorageKey:VC_StorageKey):Promise<void>
removes the entry given by StorageKey from the key-value store for the current target customer. It is ok to "delete" a non-existing entry (this function is "idempotent")
async function clearCustomerStorage ():Promise<void>
removes all entries from the key-value store for the current target customer. It is ok to "clear" an empty store (this function is "idempotent")

exported VoltCloud Functions requiring a Developer Mandate

async function focusOnCustomer (CustomerId:string):Promise<void>
sets the customer given by CustomerId as the target for all following (customer-specific) requests

Note: additionally, developers may also call any functions mentioned in the previous sections, which do either not require any mandate or may be used with developer or customer mandates

exported VoltCloud Functions requiring a Customer Mandate

async function CustomerRecord ():Promise<VC_CustomerRecord>
retrieves a record with all current VoltCloud settings for the current target customer. See above for the internals of the delivered object
async function changeCustomerEMailAddressTo (EMailAddress:string):Promise<void>
changes the EMail address of the currently configured customer to EMailAddress. No customer with that address must currently be registered for the current target application or the function will fail
async function changeCustomerPasswordTo (Password:string):Promise<void>
changes the password of the currently configured customer to Password
async function updateCustomerRecordBy (Settings:VC_CustomerUpdate):Promise<void>
updates the settings for the current target customer given by Settings. See above for the internals of the Settings object

Note: additionally, developers may also call any functions mentioned in the previous sections, which do either not require any mandate or may be used with developer or customer mandates

Smoke Test

This repository contains a small "smoke test" (in a file called "smoke-test.html") which may also serve as an example for how to use voltcloud-for-browsers. It illustrates the "good cases" of all functions offered by this library.

Preparation

Before that test may be run, a few preparational steps have to be taken:

download this repository (either using git in any of its variants or by unpacking a downloaded a ZIP archive containing this repo) - it comes with a ZIP archive containing the smoke test ready to be uploaded to VoltCloud
navigate to the VoltCloud dashboard, sign in and create a new application - you may rename it if desired, but that's not really important
enter /#/confirm/{{token}} as the "Confirm Page" and /#/reset/{{token}} as the "Reset Page" - do not let yourself be fooled by the input field placeholders which show the same text and look as if you would have already entered these values!
click on "Save" to persist your changes
now "Upload" the file smoke-test-archive-for-upload.zip from this repository
finally click on the "Action" named "Storage" first, then on "+ Add" and enter key-1 as the "Key" and value-1 as the "Value" of a new application Storage entry - there is no need to explicitly "Save" theses settings

Execution

To run this test, simply click on the application's "URL" shown in the VoltCloud dashboard.

The whole test will run in four phases. At first, you will have to enter

the EMail address of an application developer (that is you)
the developer's password (the one used to sign into VoltCloud)
the EMail address of a "customer" (different from the developer! choose an address you have access to as you will have to open several incoming EMails)
the VoltCloud id of your smoke test (shown as the "Id" in the VoltCloud dashboard)

Clicking on "Start" will start the first test phase which ends sending a first confirmation message to the EMail address configured for the "customer".

Open that message in the customer's mailbox and click on the link it contains - this will start phase 2 of the test. You will have to enter the developer's password again (which is not saved for security reasons) and click on "Continue". Phase 2 will end with sending another confirmation message to the customer.

Again, open this message and click on the link it contains - this will start phase 3 of the test. Like before, you will have to enter the developer's password and click on "Continue". Phase 3 will end with sending a password reset message to the customer.

Open this message as well and click on the link it contains - this will start the fourth and final phase of the test. Again, you will have to enter the developer's password and click on "Continue"

During all phases, the actual progress will be reported by means of log messages - in the end, a final summary will inform you about what to do next.

Build Instructions

You may easily build this package yourself.

Just install NPM according to the instructions for your platform and follow these steps:

either clone this repository using git or download a ZIP archive with its contents to your disk and unpack it there
open a shell and navigate to the root directory of this repository
run npm install in order to install the complete build environment
execute npm run build to create a new build

If you made some changes to the source code, you may also try

npm run agadoo

in order to check if the result is still tree-shakable.

You may also look into the author's build-configuration-study for a general description of his build environment.

License

MIT License

Usage no npm install needed!