Merge pull request #6 from TeamHive/fix/register-options

fix(document-service): Fix the register options

Author: Tyler Vander Maas

README.md

@@ -58,7 +58,7 @@ Whenever the API makes a call and runs into a catch block, you will get an error
 }
 ```
 
-### getPreSignedData({ fileName: string, acl: string,  expiration: number }) [GET /api/v1/pre-sign](https://dev-dms.meetmaestro.com:3000/#api-Signing-Pre_Sign_Url)
+### getPreSignedData({ fileName: string, acl: string,  expiration: number }) [GET /api/v1/pre-sign](https://dev-dms.meetmaestro.com/docs/development/index.html#api-Signing-Pre_Sign_Url)
 
 This endpoint is used for creating policies in order to upload content to your S3 bucket Note: You must send the payload to S3 in the order that we send them back.
 
@@ -97,7 +97,7 @@ dms.getPreSignedConfig({
 }
 ```
 
-### getSignedUrl(url: string, expiration: number) [GET /api/v1/sign](https://dev-dms.meetmaestro.com:3000/#api-Signing-Sign_Url)
+### getSignedUrl(url: string, expiration: number) [GET /api/v1/sign](https://dev-dms.meetmaestro.com/docs/development/index.html#api-Signing-Sign_Url)
 This endpoint is used for signing your S3 private content
 
 **Parameters**
@@ -119,6 +119,79 @@ dms.getSignedUrl('https://new-media-test-bucket.s3.amazonaws.com/test.pdf', 2000
 }
 ```
 
+### register(options: DocumentServiceOptions.RegistrationData) [POST /api/v1/register] (https://dev-dms.meetmaestro.com/docs/development/index.html#api-Signing-Sign_Url)
+This endpoint is used to register your content with the document service.
+
+**Parameters**
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|options.title|string|True| The title of the content|
+|options.identity|string|True| The identity that DMS will use for callbacks|
+|options.path|string|True| The location of the content in S3|
+|options.mediaType|MediaType|True| The contents media type used for determining all the registration requirements|
+|options.shouldConvert|boolean|False| If the file should be converted|
+|options.shouldGenerateThumbnail|boolean|False| If a thumbnail should be generated|
+
+**Request Example:**
+```javascript
+dms.register({
+    title: 'Training Intro',
+    identity: 'ad9991a8-ab82-4521-befe-a8f2f956ce12',
+    path: 'https://new-media-test-bucket.s3.amazonaws.com/test.pdf',
+    mediaType: 'PDF',
+    shouldGenerateThumbnail: true
+})
+```
+**Response Example:**
+```
+{
+  "code": "MEDIA_PROCESSING"
+}
+```
+
+### view(options: DocumentServiceOptions.RegistrationData) [POST /api/v1/view] (https://dev-dms.meetmaestro.com/docs/development/index.html#api-Signing-Sign_Url)
+This endpoint is used for generating the information you need to view the content
+
+The payload will be a little dynamic based on the content type
+
+**Parameters**
+
+|Name|Type|Required|Description|
+|---|---|---|---|
+|options.title|string|True| The title of the content|
+|options.identity|string|True| The identity that DMS will use for callbacks|
+|options.path|string|True| The location of the content in S3|
+|options.mediaType|MediaType|True| The contents media type used for determining all the registration requirements|
+
+**Request Example:**
+```javascript
+dms.view({
+    title: 'Training Intro',
+    identity: 'ad9991a8-ab82-4521-befe-a8f2f956ce12',
+    path: 'https://new-media-test-bucket.s3.amazonaws.com/test.pdf',
+    mediaType: 'PDF'
+})
+```
+
+**Response Example:**
+```
+{
+  "url": "https://bucket.s3.amazonaws.com/73aff5ee-a986-4af...",
+  "downloadUrl": "https://bucket.s3.amazonaws.com/73aff5ee-a986-4af...",
+  "expiration": "2017-04-06T14:49:16.267Z",
+  "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2V..", (PDF only - The JWT needed for opening the pdf with PSPDFKit)
+  "documentId": 3 (PDF only - The documentId needed for opening the pdf with PSPDFKit)
+  "convertedContent": {
+    "url": "https://bucket.s3.amazonaws.com/73aff5ee-a986-4af...",
+    "downloadUrl": "https://bucket.s3.amazonaws.com/73aff5ee-a986-4af...",
+    "expiration": "2017-04-06T14:49:16.267Z",
+    "jwt": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2V..", (PDF only - The JWT needed for opening the pdf with PSPDFKit)
+    "documentId": 3 (PDF only - The documentId needed for opening the pdf with PSPDFKit)
+  }
+}
+```
+
 # Contributors
 
 [<img alt="John Pinkster" src="https://avatars1.githubusercontent.com/u/5350861?v=3&s=460" width="117">](https://github.com/jpinkster)|

package.json

@@ -10,7 +10,7 @@
     "watch": "tsc -w",
     "prepublishOnly": "tsc",
     "prepack": "tsc",
-    "postpack": "rm *.d.ts && rm *.js"
+    "postpack": "rm *.d.ts && rm *.js && rm -rf interfaces types"
   },
   "author": "TeamHive",
   "contributors": [

src/document-service.ts

@@ -3,7 +3,7 @@ import * as querystring from 'query-string';
 import * as _ from 'lodash';
 import * as fs from 'fs';
 import * as mime from 'mime';
-import { DocumentServiceOptions } from './index';
+import { DocumentServiceOptions } from './interfaces';
 
 export class DocumentService {
 

src/index.ts

@@ -1,2 +1,3 @@
 export * from './document-service';
-export * from './document-service-options.interface';
+export * from './interfaces';
+export * from './types';

src/document-service-options.interface.ts renamed to src/interfaces/document-service-options.interface.ts

@@ -57,6 +57,10 @@ export namespace DocumentServiceOptions {
         path: string;
         // The contents media type used for determining all the registration requirements
         mediaType: MediaType;
+        // If the file should be converted
+        shouldConvert?: boolean;
+        // If a thumbnail should be generated
+        shouldGenerateThumbnail?: boolean;
     }
 
     export interface RegistrationResponse {

src/interfaces/document-service-response.interface.ts

@@ -0,0 +1,14 @@
+import { MediaProcessingCallbackType, MediaProcessingCallbackStatus } from '../types';
+
+// tslint:disable-next-line:no-namespace
+export namespace DocumentServiceResponse {
+
+    export interface MediaProcessingCallback {
+        type: MediaProcessingCallbackType;
+        status: MediaProcessingCallbackStatus;
+        identity: string;
+        locationUrl?: string;
+        processUrl?: string;
+        errorMessage?: string;
+    }
+}

src/interfaces/index.ts

@@ -0,0 +1,2 @@
+export * from './document-service-options.interface';
+export * from './document-service-response.interface';

src/types/index.ts

@@ -0,0 +1,2 @@
+export * from './media-processing-callback.type';
+export * from './media-processing-callback-status.type';

src/types/media-processing-callback-status.type.ts

@@ -0,0 +1 @@
+export type MediaProcessingCallbackStatus = 'STARTED' | 'FINISHED' | 'FAILED';

src/types/media-processing-callback.type.ts

@@ -0,0 +1 @@
+export type MediaProcessingCallbackType = 'THUMBNAIL' | 'PROCESSING';