[RAINCATCH 1399] docs fix (#195)

* Simplify and fix docgen command

* Remove old clean:docs command

* Add typedoc plugin

* Add module headers to files

* Update theme and use typedoc external module plugin

* tslint --fix

client/camera/src/Camera.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/camera
+ */
+
 'use strict';
 
 import * as Promise from 'bluebird';

client/camera/src/buildCameraOptions.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/camera
+ */
+
 /**
  * Default options for the cordova camera plugin
  * @param cordovaCamera Apache Cordova's Camera object

client/camera/src/index.ts

@@ -1 +1,5 @@
+/**
+ * @module @raincatcher/camera
+ */
+
 export * from './Camera';

client/datasync-client/src/DataManager.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-client
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as Bluebird from 'bluebird';
 import * as syncApi from 'fh-sync-js';

client/datasync-client/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-client
+ */
+
 import * as sync from 'fh-sync-js';
 
 // Support named import

client/filestore-client/src/CordovaFileSupport.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 import b64ToBlob from 'b64-to-blob';
 import * as Bluebird from 'bluebird';
 import { each } from 'lodash';

client/filestore-client/src/FileManager.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 import * as Bluebird from 'bluebird';
 import * as _ from 'lodash';
 import { CordovaFileSupport } from './CordovaFileSupport';

client/filestore-client/src/FileQueue.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 import * as _ from 'lodash';
 import { FileQueueEntry } from './FileQueueEntry';
 

client/filestore-client/src/FileQueueEntry.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 /**
  * Contains fields required for uploading and downloading a file.
  */

client/filestore-client/src/HttpClient.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 import * as Promise from 'bluebird';
 
 /**

client/filestore-client/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore-client
+ */
+
 export * from './FileManager';
 export * from './FileQueueEntry';
 export * from './HttpClient';

client/wfm/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 export { WorkOrder } from './model/WorkOrder';
 export { WorkFlow } from './model/WorkFlow';
 export { StepResult } from './model/StepResult';

client/wfm/src/model/Step.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 /**
  * A single unit of work, containing its identifier and runtime options for customizing behavior.
  */

client/wfm/src/model/StepResult.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import { STATUS } from '../status';
 import { Step } from './Step';
 

client/wfm/src/model/WorkFlow.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import { Step } from '../model/Step';
 import { WorkOrder } from '../model/WorkOrder';
 

client/wfm/src/model/WorkOrder.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import * as Promise from 'bluebird';
 import { min } from 'lodash';
 import { STATUS } from '../status';

client/wfm/src/service/DataService.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import * as Promise from 'bluebird';
 /**
  * Deifinition for data acess service used by the {@link WfmService}

client/wfm/src/service/UserService.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import * as Promise from 'bluebird';
 export interface UserService {
   readUser(): Promise<{id: string}>;

client/wfm/src/service/WfmService.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 import * as Promise from 'bluebird';
 import * as _ from 'lodash';
 import * as shortid from 'shortid';

client/wfm/src/status.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm
+ */
+
 /**
  * List of available status for {@link WorkOrder}s and their individual {@link Step}s
  */

cloud/auth/src/EndpointSecurity.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/express-auth
+ */
+
 import * as express from 'express';
 import { SessionOptions } from 'express-session';
 

cloud/auth/src/index.ts

@@ -1 +1,5 @@
+/**
+ * @module @raincatcher/express-auth
+ */
+
 export * from './EndpointSecurity';

cloud/datasync/src/SyncApi.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import { Db } from 'mongodb';
 import SyncDatasetOptions from './options/SyncDatasetOptions';
 import SyncOptions from './options/SyncGlobalOptions';

cloud/datasync/src/SyncServer.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import * as sync from 'fh-sync';
 import { Db } from 'mongodb';
 import SyncDataSetOptions from './options/SyncDatasetOptions';

cloud/datasync/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import * as sync from 'fh-sync';
 import SyncServer from './SyncServer';
 

cloud/datasync/src/options/SyncDatasetOptions.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
 
 import { CollisionHandler, HashFunction } from './SyncGlobalOptions';
 /**

cloud/datasync/src/options/SyncGlobalOptions.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import * as sync from 'fh-sync';
 
 /**

cloud/datasync/src/web/SyncMapperMiddleware.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as express from 'express';
 import * as sync from 'fh-sync';

cloud/datasync/src/web/SyncWebExpress.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/datasync-cloud
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as Express from 'express';
 import * as sync from 'fh-sync';

cloud/filestore/src/FileRoutes.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import { promisify } from 'bluebird';
 import { Router } from 'express';

cloud/filestore/src/file-api/FileMetadata.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 /**
  * Interface contains documented fields that can be used by implementation to save and query files.
  * Actual implementation can use any other fields that are required to be saved along with the file.

cloud/filestore/src/file-api/FileStorage.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 import * as Promise from 'bluebird';
 import { Stream } from 'stream';
 import { FileMetadata } from './FileMetadata';

cloud/filestore/src/impl/GridFsStorage.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as Promise from 'bluebird';
 import * as fs from 'fs';

cloud/filestore/src/impl/LocalStorage.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as BlueBird from 'bluebird';
 import { createReadStream } from 'fs';

cloud/filestore/src/impl/S3Storage.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/filestore
+ */
 
 import { getLogger } from '@raincatcher/logger';
 import * as Promise from 'bluebird';

cloud/filestore/src/index.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/filestore
+ */
 
 export * from './FileRoutes';
 

cloud/filestore/src/services/FileService.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/filestore
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as base64 from 'base64-stream';
 import * as Promise from 'bluebird';

cloud/passportauth/src/auth/DefaultStrategies.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
 
 import { UserRepository } from '../user/UserRepository';
 import { UserService } from '../user/UserService';

cloud/passportauth/src/auth/PassportAuth.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import * as express from 'express';
 import * as session from 'express-session';

cloud/passportauth/src/auth/UserSerializer.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
+
 /**
  * Default serialize user function to be used by Passport. Stores the user to the session
  *

cloud/passportauth/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
+
 import * as passport from 'passport';
 
 export * from './user/UserService';

cloud/passportauth/src/user/UserRepository.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
+
 /**
  * User repository interface for retrieving user related data.
  * Implementations can retrieve users from different databases etc.

cloud/passportauth/src/user/UserService.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/auth-passport
+ */
 
 /**
  * User service interface that defines a set of requirements (methods) for mapping particular fields from the

cloud/wfm-demo-data/src/Workflows.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm-demo-data
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import { WorkFlow } from '@raincatcher/wfm';
 import * as Promise from 'bluebird';

cloud/wfm-demo-data/src/Workorders.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm-demo-data
+ */
+
 import { getLogger } from '@raincatcher/logger';
 import { WorkOrder } from '@raincatcher/wfm';
 import * as Promise from 'bluebird';

cloud/wfm-demo-data/src/index.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm-demo-data
+ */
+
 import { Db } from 'mongodb';
 import workflowSetup from './Workflows';
 import workorderSetup from './Workorders';

cloud/wfm-rest-api/src/ApiConfig.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/wfm-rest-api
+ */
 
 /**
  * Module configuration interface

cloud/wfm-rest-api/src/WfmRestApi.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/wfm-rest-api
+ */
 
 import { getLogger } from '@raincatcher/logger';
 import { WorkFlow, WorkOrder } from '@raincatcher/wfm';

cloud/wfm-rest-api/src/data-api/ApiError.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/wfm-rest-api
+ */
 
 /**
  * Interface used to construct standardized response for api error handlers.

cloud/wfm-rest-api/src/data-api/MongoPaginationEngine.ts

@@ -1,3 +1,6 @@
+/**
+ * @module @raincatcher/wfm-rest-api
+ */
 
 import * as Promise from 'bluebird';
 import { Cursor } from 'mongodb';

cloud/wfm-rest-api/src/data-api/PageRequest.ts

@@ -1,3 +1,7 @@
+/**
+ * @module @raincatcher/wfm-rest-api
+ */
+
 /**
  *  Interface for pagination information.
  *  Represents page request (passed from client)