@formio/appserver 1.1.0 → 1.1.2

package/README.md

@@ -16,7 +16,7 @@ const app = express();
 const { Server } = require('@formio/appserver');
 (async function bootup() {
     // Create the server.
-    const server = await new Server();
+    const server = new Server();
 
     // Initialize the server.
     await server.init();
@@ -50,6 +50,33 @@ Now, within the ```.env``` file, modify all of the environment variables to be t
 node index
 ```
 
+### Environment Variables
+This library uses environment variables to configure the configurations required to run the server. These are as follows.
+
+| Variable Name         | Required | Description | Example |
+|--------------|:-----:|-----------:|
+| MONGO | yes | Your MongoDB Connection string to use the default DB. | mongodb://localhost:27017/appserver |
+| PROJECT_ENDPOINT | yes | The endpoint for your deployed Form.io Enterprise project. | https://mydeployment.com/myproject |
+| PROJECT_KEY | yes | The API Key for your deployed Form.io Enterprise Project. | abc123 |
+| LICENSE_KEY | yes | Your License Key for this AppServer deployment. | <LONG LICENSE KEY> |
+| PORT | no | The port that your server will run on. Default 3005 | 3005 |
+| JWT_SECRET | yes | The key used to protect your JWT authentication tokens. | YOUR_SECRET_KEY |
+| JWT_EXPIRE_TIME | no | The number of minutes to expire your JWT token. | 240 |
+| PORTAL_SECRET | no | Provides the ability to connect to the AppServer via the Remote Environment Connection within your Developer Portal. | YOUR_SECRET_KEY |
+| PROJECT_CACHE | no | Disables the cache for project resources (such as Project template, Project Settings, and Access Settings). Default "true" | true |
+| MONGO_CONFIG | no | Additional configurations to add to the DB connection string | {} |
+
+### Developer Portal Connection
+Once you have the AppServer running within your own environment, and connected to your own database, you can now deploy your new changes to your forms, resources, project settings, etc. To accomplish this, you must first run the AppServer using the ```PORTAL_SECRET``` described above.
+
+Once you have this set, you can then log into your Developer Portal, and then navigate to your Project.
+
+Once there, you will then go to your **Staging | Connect Environment**.  Here you will put your AppServer endpoint and the PORTAL_SECRET value. You will then want to set the **Project Path Type** to use **Subdirectory**. Then click **Continue**. 
+
+You will then see the next page, where you will select your Stage in the dropdown. You should see it since the AppServer connects to the project on bootup.
+
+Once you are connected, any changes you make within the Developer portal will now be directly reflected within your AppServer deployment.
+
 ### Custom Configuration
 The AppServer is very extensible, and many things can be altered and modified as well as custom implementations of different components are possible using configurations.
 
@@ -64,7 +91,7 @@ const { CustomAuth } = require('./customAuth');
 const { CustomAction } = require('./actions/custom');
 (async function bootup() {
     // Create the server.
-    const server = await new Server({
+    const server = new Server({
         /**
          * The "db" configuration provides a way to use a Custom database implementation.
          * 

package/lib/db.d.ts

@@ -6,14 +6,16 @@ export declare class Database implements ServerDB {
     currentCollectionName: string;
     currentCollection: Collection<Document> | null;
     defaultCollection: Collection<Document> | null;
+    prefix: string;
     constructor(config: DBConfig);
     ObjectId(id: any): any;
+    collectionName(name: string): string;
     /**
      * Connect to the database.
      * @param {*} scope
      * @returns
      */
-    connect(): Promise<void>;
+    connect(prefix?: string): Promise<void>;
     save(collectionName: string, item: any): Promise<import("mongodb").WithId<import("bson").Document> | null>;
     load(collectionName: string): Promise<import("mongodb").WithId<import("bson").Document> | null | undefined>;
     remove(collectionName: string): Promise<number | null>;

package/lib/db.js

@@ -21,6 +21,7 @@ const error = require('debug')('formio:error');
 class Database {
     constructor(config) {
         this.config = config;
+        this.prefix = '';
         this.db = null;
         this.currentCollectionName = 'submissions';
         this.currentCollection = null;
@@ -37,21 +38,25 @@ class Database {
             return id;
         }
     }
+    collectionName(name) {
+        return `${this.prefix}${name}`;
+    }
     /**
      * Connect to the database.
      * @param {*} scope
      * @returns
      */
-    connect() {
+    connect(prefix = '') {
         return __awaiter(this, void 0, void 0, function* () {
+            this.prefix = prefix ? `${prefix}.` : '';
             try {
                 debug('db.connect()');
                 const config = this.config.config ? JSON.parse(this.config.config) : {};
                 const client = new mongodb_1.MongoClient(this.config.url, config);
                 yield client.connect();
                 this.db = yield client.db();
-                this.addIndex(this.db.collection('project'), 'name');
-                this.defaultCollection = this.db.collection('submissions');
+                this.addIndex(this.db.collection(this.collectionName('project')), 'name');
+                this.defaultCollection = this.db.collection(this.collectionName('submissions'));
                 yield this.setupIndexes(this.defaultCollection);
                 debug('Connected to database');
             }
@@ -67,7 +72,7 @@ class Database {
             if (!this.db) {
                 return null;
             }
-            const collection = this.db.collection(collectionName);
+            const collection = this.db.collection(`${this.prefix}${collectionName}`);
             let result;
             try {
                 debug('db.save()', collectionName);
@@ -86,7 +91,7 @@ class Database {
                 return null;
             }
             debug('db.load()', collectionName);
-            const collection = this.db.collection(collectionName);
+            const collection = this.db.collection(this.collectionName(collectionName));
             let item;
             try {
                 item = yield collection.findOne({});
@@ -104,7 +109,7 @@ class Database {
                 return null;
             }
             debug('db.remove()', collectionName);
-            const collection = this.db.collection(collectionName);
+            const collection = this.db.collection(this.collectionName(collectionName));
             let result;
             try {
                 result = yield collection.deleteOne({});
@@ -129,14 +134,14 @@ class Database {
                 let collection = null;
                 try {
                     debug('db.createCollection()', scope.form.settings.collection);
-                    yield this.db.createCollection(scope.form.settings.collection);
-                    collection = this.db.collection(scope.form.settings.collection);
+                    yield this.db.createCollection(this.collectionName(scope.form.settings.collection));
+                    collection = this.db.collection(this.collectionName(scope.form.settings.collection));
                     this.setupIndexes(collection, scope);
                 }
                 catch (err) {
                     error(err.message);
                 }
-                this.currentCollection = collection || this.db.collection(scope.form.settings.collection);
+                this.currentCollection = collection || this.db.collection(this.collectionName(scope.form.settings.collection));
                 this.currentCollectionName = scope.form.settings.collection;
                 return this.currentCollection;
             }

package/lib/index.js

@@ -77,7 +77,8 @@ class Server extends appserver_core_1.Server {
                     url: (0, get_1.default)(process.env, 'PROJECT_ENDPOINT', ''),
                     key: (0, get_1.default)(process.env, 'PROJECT_KEY', '')
                 }
-            })
+            }),
+            hooks: config.hooks || {}
         });
     }
 }

package/lib/types/server.d.ts

@@ -41,7 +41,7 @@ export interface DBConfig {
 }
 export interface ServerDB {
     config: DBConfig;
-    connect: () => Promise<void>;
+    connect: (prefix?: string) => Promise<void>;
     save: (collection: string, doc: any) => Promise<any>;
     load: (collection: string) => Promise<any>;
     remove: (collection: string) => Promise<any>;
@@ -100,4 +100,5 @@ export interface AppServerScope {
     processors?: Array<(scope: ProcessScope) => Promise<any[]>>;
     preppers?: Preppers;
     actions?: any;
+    hooks?: any;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@formio/appserver",
-  "version": "1.1.0",
+  "version": "1.1.2",
   "description": "A highly performant and extensible Application Server for Form.io Multi-Tenant Deployments.",
   "main": "server.js",
   "scripts": {
@@ -25,7 +25,7 @@
   ],
   "homepage": "https://github.com/formio/appserver#readme",
   "dependencies": {
-    "@formio/appserver-core": "^1.3.3",
+    "@formio/appserver-core": "^1.3.4",
     "@formio/appserver-types": "^1.2.1",
     "async": "^3.2.4",
     "bcryptjs": "^2.4.3",