@envoy/envoy-integrations-sdk 2.0.1-beta.5 → 2.0.2

package/envoyapi.md

@@ -1,150 +0,0 @@
----
-description: Makes calls to the Envoy API.
----
-
-# EnvoyAPI
-
-Note that there are many API calls not covered by this class. Please add to this class as necessary!
-
-## Constructor
-
-#### const api = new EnvoyAPI\(token\)
-
-| Param | Type |
-| :--- | :--- |
-| token | `string` |
-
-## Properties and Methods
-
-* _instance_
-  * .flows\(locationId\) ⇒ `Promise.<Array.<EnvoyObject>>`
-  * .signInPage\(flowId\) ⇒ `Promise.<EnvoyObject>`
-  * .signInFields\(pageId\) ⇒ `Promise.<Array.<EnvoyObject>>`
-  * .createNotificationEvent\(event\) ⇒ `Promise.<EnvoyObject>`
-  * .updateJob\(jobId, updates\) ⇒ `Promise.<EnvoyObject>`
-  * .storagePipeline\(commands, \[installId\]\) ⇒ `Promise.<Array.<PluginStorageItem>>`
-* _static_
-  * .login\(\[id\], \[secret\]\)
-
-#### envoyAPI.flows\(locationId\) ⇒ `Promise.<Array.<EnvoyObject>>`
-
-Fetches the visitor types for this location.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type |
-| :--- | :--- |
-| locationId | `string` \| `number` |
-
-#### envoyAPI.signInPage\(flowId\) ⇒ `Promise.<EnvoyObject>`
-
-Fetches the sign-in page details for this flow.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type |
-| :--- | :--- |
-| flowId | `string` \| `number` |
-
-#### envoyAPI.signInFields\(pageId\) ⇒ `Promise.<Array.<EnvoyObject>>`
-
-Fetches the sign-in fields for this page.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type |
-| :--- | :--- |
-| pageId | `string` \| `number` |
-
-#### envoyAPI.createNotificationEvent\(event\) ⇒ `Promise.<EnvoyObject>`
-
-Creates a notification event.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type |
-| :--- | :--- |
-| event | `Object` |
-
-#### envoyAPI.updateJob\(jobId, updates\) ⇒ `Promise.<EnvoyObject>`
-
-Updates the job.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type |
-| :--- | :--- |
-| jobId | `string` \| `uuid` |
-| updates | `JobUpdate` |
-
-#### envoyAPI.storagePipeline\(commands, \[installId\]\) ⇒ `Promise.<Array.<PluginStorageItem>>`
-
-Runs the storage pipeline.
-
-**Kind**: instance method of `EnvoyAPI`
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| commands | `Array.<Command>` |  |
-| \[installId\] | `string` \| `uuid` \| `number` | `null` |
-
-#### EnvoyAPI.login\(\[id\], \[secret\]\)
-
-Gets an access token using client\_credentials as the grant type.
-
-**Kind**: static method of `EnvoyAPI`
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| \[id\] | `string` | `process.env.ENVOY_CLIENT_ID` |
-| \[secret\] | `string` | `process.env.ENVOY_CLIENT_SECRET` |
-
-## Related Classes
-
-### EnvoyObject : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| id | `string` \| `number` \| `uuid` | the ID of the object |
-| attributes | `Object` | the object's attributes, in dash-case. |
-
-### Attachment : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| type | `string` | only "password" supported :\( |
-| label | `string` | the label to display in Garaje |
-| value | `string` | the value to display in Garaje |
-
-### JobUpdate : `Object`
-
-**Properties**
-
-| Name | Type |
-| :--- | :--- |
-| \[status\] | `string` |
-| \[status\_message\] | `string` |
-| \[failure\_reason\] | `string` |
-| \[attachments\] | `Array.<Attachment>` |
-
-### PluginStorageItem : `Object`
-
-**Properties**
-
-| Name | Type |
-| :--- | :--- |
-| key | `string` |
-| value |  |
-
-### Command : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| action | `string` | the type of command to run |
-| key | `string` | the key to operate on |

package/envoyjwt.md

@@ -1,46 +0,0 @@
----
-description: Encodes/decodes JWTs
----
-
-# EnvoyJWT
-
-## Constructor
-
-#### const jwt = new EnvoyJWT\(\[secret\], \[algorithm\]\)
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| \[secret\] | `string` | `process.env.JWT_SECRET` |
-| \[algorithm\] | `string` | `"HS256"` |
-
-## Properties and Methods
-
-* _instance_
-  * .encode\(subject, expiresIn, \[payload\]\) ⇒ `Promise.<string>`
-  * .decode\(token, \[options\]\) ⇒ `Promise.<{}>`
-
-#### envoyJWT.encode\(subject, expiresIn, \[payload\]\) ⇒ `Promise.<string>`
-
-Creates a JWT.
-
-**Kind**: instance method of `EnvoyJWT`
-
-| Param | Type | Description |
-| :--- | :--- | :--- |
-| subject | `string` \| `number` \| `null` |  |
-| expiresIn | `string` \| `number` \| `null` | seconds or string like: [https://github.com/zeit/ms](https://github.com/zeit/ms) |
-| \[payload\] | `Object` |  |
-
-#### envoyJWT.decode\(token, \[options\]\) ⇒ `Promise.<{}>`
-
-**Kind**: instance method of `EnvoyJWT`
-
-| Param | Type |
-| :--- | :--- |
-| token | `string` |
-| \[options\] | `JWTOptions` |
-
-### JWTOptions : `Object`
-
-[https://www.npmjs.com/package/jsonwebtoken\#jwtverifytoken-secretorpublickey-options-callback](https://www.npmjs.com/package/jsonwebtoken#jwtverifytoken-secretorpublickey-options-callback)
-

package/envoypluginjob.md

@@ -1,106 +0,0 @@
----
-description: 'Updates jobs by updating statuses, adding attachments, etc.'
----
-
-# EnvoyPluginJob
-
-## Constructor
-
-#### const job = new EnvoyPluginJob\(pluginAPI, jobId\)
-
-| Param | Type |
-| :--- | :--- |
-| pluginAPI | `EnvoyAPI` |
-| jobId | `string` \| `uuid` |
-
-## Properties and Methods
-
-* _instance_
-  * .api : `EnvoyAPI`
-  * .id : `string` \| `uuid`
-  * .execute\(status, message, \[reason\], \[attachments\]\) ⇒ `Promise.<EnvoyObject>`
-  * .attach\(...attachments\) ⇒ `Promise.<EnvoyObject>`
-  * .complete\(message, \[...attachments\]\) ⇒ `Promise.<EnvoyObject>`
-  * .ignore\(message, reason\) ⇒ `Promise.<EnvoyObject>`
-  * .fail\(message, reason\) ⇒ `Promise.<EnvoyObject>`
-  * .update\(message, \[...attachments\]\) ⇒ `Promise.<EnvoyObject>` 
-
-#### envoyPluginJob.execute\(status, message, \[reason\], \[attachments\]\) ⇒ `Promise.<EnvoyObject>`
-
-Updates a job.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| status | `string` \| `null` |
-| message | `string` \| `null` |
-| \[reason\] | `string` \| `null` |
-| \[attachments\] | `Array.<Attachment>` \| `null` |
-
-#### envoyPluginJob.attach\(...attachments\) ⇒ `Promise.<EnvoyObject>`
-
-Attaches items to an in-progress job.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| ...attachments | `Attachment` |
-
-#### envoyPluginJob.complete\(message, \[...attachments\]\) ⇒ `Promise.<EnvoyObject>`
-
-Completes the job.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| message | `string` |
-| \[...attachments\] | `Attachment` |
-
-#### envoyPluginJob.ignore\(message, reason\) ⇒ `Promise.<EnvoyObject>`
-
-Ignores the job.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| message | `string` |
-| reason | `string` |
-
-#### envoyPluginJob.fail\(message, reason\) ⇒ `Promise.<EnvoyObject>`
-
-Fails the job.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| message | `string` |
-| reason | `string` |
-
-#### envoyPluginJob.update\(message, \[...attachments\]\) ⇒ `Promise.<EnvoyObject>`
-
-Updates the job's message, with optional attachments. Useful for multi-step jobs.
-
-**Kind**: instance method of `EnvoyPluginJob`
-
-| Param | Type |
-| :--- | :--- |
-| message |  |
-| \[...attachments\] | `Attachment` |
-
-## Related Classes
-
-### Attachment : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| \[type\] | `string` | only "password" supported :\( |
-| label | `string` | the label to display in Garaje |
-| value | `string` | the value to display in Garaje |
-

package/envoypluginsdk.md

@@ -1,87 +0,0 @@
----
-description: The Envoy SDK. Typically you'd interact with this directly.
----
-
-# EnvoyPluginSDK
-
-## Constructor
-
-#### const envoy = new EnvoyPluginSDK\(body, \[isVerified=false\], \[pluginAccessToken=null\]\)
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| body | `Object` |  |
-| \[isVerified\] | `boolean` | `false` |
-| \[pluginAccessToken\] | `string` | `null` |
-
-## Properties and Methods
-
-* _instance_
-  * .body : `Object`
-    * Comes from `req.body`
-  * .isVerified : `boolean`
-    * If the request is verified to have come from Envoy
-  * .pluginAccessToken : `string`
-    * Access token for use with plugin-scoped endpoints
-  * .meta : `Meta`
-    * Metadata associated with this request
-  * .payload : `EnvoyObject` \| `Object`
-    * The object that the event is about
-  * .userAPI : `EnvoyAPI`
-    * Envoy's API scoped to the installer \(user\)
-    * Applicable only in setup routes
-  * .pluginAPI : `EnvoyAPI`
-    * Envoy's API scoped to the plugin itself
-    * For use with jobs and storage
-  * .installStorage : `EnvoyPluginStorage`
-    * Key/value storage scoped to the current install
-  * .globalStorage : `EnvoyPluginStorage`
-    * Key/value storage scoped across installs
-  * .job : `EnvoyPluginJob`
-    * Represents the current job
-    * Applicable only in workers \(event listeners\)
-  * .jobId : `string` \| `uuid` \| `null`
-    * The current job ID
-    * Applicable only in workers
-  * .jwt : `EnvoyJWT`
-    * Helper to encode and decode JWTs
-  * .getJob\(jobId\) ⇒ `EnvoyPluginJob`
-    * Load a job other than the current
-
-#### envoyPluginSDK.getJob\(jobId\) ⇒ `EnvoyPluginJob`
-
-Returns a job based on an ID.
-
-**Kind**: instance method of `EnvoyPluginSDK`
-
-| Param | Type |
-| :--- | :--- |
-| jobId | `string` \| `uuid` |
-
-## Related Classes
-
-### EnvoyObject : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| id | `string` \| `number` \| `uuid` | the ID of the object |
-| attributes | `Object` | the object's attributes, in dash-case. |
-
-### Meta : `Object`
-
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| event | `string` | the name of the event \(workers only\) |
-| route | `string` | the name of the route \(routes only\) |
-| plugin\_id | `number` | the plugin ID |
-| install\_id | `number` | the plugin install ID |
-| config | `Object` | config data for this install |
-| params | `Object` | The optional URL query params sent in the request \(routes only\) |
-| location | `EnvoyObject` | the location this event happened \(location installs only\) |
-| company | `EnvoyObject` | the company that installed the plugin |
-| auth | `Object` | contains the installer's `access_token` |
-

package/envoypluginstorage.md

@@ -1,95 +0,0 @@
----
-description: Interacts with the key/value storage system.
----
-
-# EnvoyPluginStorage
-
-## Constructor
-
-#### const storage = new EnvoyPluginStorage\(pluginAPI, \[installId\]\)
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| pluginAPI | `EnvoyAPI` |  |
-| \[installId\] | `number` \| `null` |  |
-
-## Properties and Methods
-
-* _instance_
-  * .api : `EnvoyAPI`
-  * .installId : `number` \| `null`
-  * .pipeline\(\) ⇒ `EnvoyPluginStoragePipeline`
-  * .get\(key\) ⇒ `Promise.<(PluginStorageItem|null)>`
-  * .set\(key, value\) ⇒ `Promise.<PluginStorageItem>`
-  * .setUnique\(key, options\) ⇒ `Promise.<PluginStorageItem>`
-  * .unset\(key\) ⇒ `Promise.<(PluginStorageItem|null)>`
-
-#### envoyPluginStorage.pipeline\(\) ⇒ `EnvoyPluginStoragePipeline`
-
-Creates a new pipeline instance.
-
-**Kind**: instance method of `EnvoyPluginStorage`  
-
-
-#### envoyPluginStorage.get\(key\) ⇒ `Promise.<(PluginStorageItem|null)>`
-
-Wrapper for single pipeline get.
-
-**Kind**: instance method of `EnvoyPluginStorage`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-
-#### envoyPluginStorage.set\(key, value\) ⇒ `Promise.<PluginStorageItem>`
-
-Wrapper for single pipeline set.
-
-**Kind**: instance method of `EnvoyPluginStorage`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-| value | `*` |
-
-#### envoyPluginStorage.setUnique\(key, \[options\]\) ⇒ `Promise.<PluginStorageItem>`
-
-Wrapper for single pipeline setUnique.
-
-**Kind**: instance method of `EnvoyPluginStorage`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-| \[options\] | `UniqueOptions` |
-
-#### envoyPluginStorage.unset\(key\) ⇒ `Promise.<(PluginStorageItem|null)>`
-
-Wrapper for single pipeline unset. Returns null if the item did not previously exist.
-
-**Kind**: instance method of `EnvoyPluginStorage`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-
-## Related Classes
-
-### PluginStorageItem : `Object`
-
-**Properties**
-
-| Name | Type |
-| :--- | :--- |
-| key | `string` |
-| value |  |
-
-### UniqueOptions : `Object`
-
-**Properties**
-
-| Name | Type | Default | Description |
-| :--- | :--- | :--- | :--- |
-| chars | `string` | `"0123456789"` | the possible characters to pick from |
-| size | `number` | `12` | the length of the value |
-

package/envoypluginstoragepipeline.md

@@ -1,125 +0,0 @@
----
-description: Interacts with the storage pipeline system.
----
-
-# EnvoyPluginStoragePipeline
-
-## Constructor
-
-#### const storagePipeline = new EnvoyPluginStoragePipeline\(pluginAPI, \[installId\]\)
-
-| Param | Type | Default |
-| :--- | :--- | :--- |
-| pluginAPI | `EnvoyAPI` |  |
-| \[installId\] | `number` \| `null` |  |
-
-## Properties and Methods
-
-* _instance_
-  * .api : `EnvoyAPI`
-  * .installId : `number` \| `null`
-  * .commands : `Array.<Command>`
-  * .execute\(\) ⇒ `Promise.<Array.<(Command|null)>>`
-  * .executeSingle\(\) ⇒ `Promise.<PluginStorageItem>`
-  * .addCommand\(command\) ⇒ `EnvoyPluginStoragePipeline`
-  * .get\(key\) ⇒ `EnvoyPluginStoragePipeline`
-  * .set\(key, value\) ⇒ `EnvoyPluginStoragePipeline`
-  * .setUnique\(key, \[options\]\) ⇒ `EnvoyPluginStoragePipeline`
-  * .unset\(key\) ⇒ `EnvoyPluginStoragePipeline`
-
-#### envoyPluginStoragePipeline.execute\(\) ⇒ `Promise.<Array.<(Command|null)>>`
-
-Executes all the commands in the pipeline.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`  
-
-
-#### envoyPluginStoragePipeline.executeSingle\(\) ⇒ `Promise.<PluginStorageItem>`
-
-Executes the pipeline and returns the first result.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`  
-
-
-#### envoyPluginStoragePipeline.addCommand\(command\) ⇒ `EnvoyPluginStoragePipeline`
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`
-
-| Param | Type |
-| :--- | :--- |
-| command | `Command` |
-
-#### envoyPluginStoragePipeline.get\(key\) ⇒ `EnvoyPluginStoragePipeline`
-
-Gets a storage item.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-
-#### envoyPluginStoragePipeline.set\(key, value\) ⇒ `EnvoyPluginStoragePipeline`
-
-Sets a value for a storage item, and returns that item.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-| value |  |
-
-#### envoyPluginStoragePipeline.setUnique\(key, \[options\]\) ⇒ `EnvoyPluginStoragePipeline`
-
-Sets a unique value for a storage item, and returns that item.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-| \[options\] | `UniqueOptions` |
-
-#### envoyPluginStoragePipeline.unset\(key\) ⇒ `EnvoyPluginStoragePipeline`
-
-Unsets a storage item.
-
-**Kind**: instance method of `EnvoyPluginStoragePipeline`
-
-| Param | Type |
-| :--- | :--- |
-| key | `string` |
-
-## Related Classes
-
-### PluginStorageItem : `Object`
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type |
-| :--- | :--- |
-| key | `string` |
-| value |  |
-
-### Command : `Object`
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Description |
-| :--- | :--- | :--- |
-| action | `string` | the type of command to run |
-| key | `string` | the key to operate on |
-
-### UniqueOptions : `Object`
-
-**Kind**: global typedef  
-**Properties**
-
-| Name | Type | Default | Description |
-| :--- | :--- | :--- | :--- |
-| chars | `string` | `"\"0123456789\""` | the possible characters to pick from |
-| size | `number` | `12` | the length of the value |
-

package/envoysignatureverifier.md

@@ -1,43 +0,0 @@
----
-description: Verifies that request bodies are from Envoy and are meant for your plugin.
----
-
-# EnvoySignatureVerifier
-
-## Constructor
-
-#### const signatureVerifier = new EnvoySignatureVerifier\(\[options\]\)
-
-| Param | Type |
-| :--- | :--- |
-| \[options\] | `SignatureVerifierOptions` |
-
-## Properties and Methods
-
-* _instance_
-  * .verify\(req, rawBody\) ⇒ `boolean`
-
-#### envoySignatureVerifier.verify\(req, rawBody\) ⇒ `boolean`
-
-Verifies that the signature provided matches the request body.
-
-**Kind**: instance method of `EnvoySignatureVerifier`
-
-| Param | Type |
-| :--- | :--- |
-| req |  |
-| rawBody | `Buffer` |
-
-## Related Classes
-
-### SignatureVerifierOptions : `Object`
-
-**Properties**
-
-| Name | Type | Default |
-| :--- | :--- | :--- |
-| algorithm | `string` | `"sha256"` |
-| encoding | `string` | `"base64"` |
-| secret | `string` | `process.env.ENVOY_CLIENT_SECRET` |
-| header | `string` | `"x-envoy-signature"` |
-

package/errormiddleware.md

@@ -1,41 +0,0 @@
----
-description: Use this middleware to safely catch and serialize unexpected errors.
----
-
-# errorMiddleware
-
-## Example
-
-```javascript
-const express = require('express');
-const { middleware, errorMiddleware } = require('envoy-integrations-sdk-nodejs');
-
-const app = express();
-app.use(middleware());
-// define endpoints here
-app.use(errorMiddleware());
-```
-
-## Functions
-
-### errorMiddleware\(\) ⇒ `expressErrorMiddleware`
-
-Returns an [Express.js error middleware](http://expressjs.com/en/guide/error-handling.html#writing-error-handlers), which serializes unexpected errors.
-
-**Kind**: global function
-
-### Related Functions and Classes
-
-### `expressErrorMiddleware` : `function`
-
-Express/connect middleware.
-
-**Kind**: global typedef
-
-| Param | Type |
-| :--- | :--- |
-| err | `Error` |
-| req | [http://expressjs.com/en/4x/api.html\#req](http://expressjs.com/en/4x/api.html#req) |
-| res | [http://expressjs.com/en/4x/api.html\#res](http://expressjs.com/en/4x/api.html#res) |
-| next | `function` |
-