@oneblink/sdk 0.4.4-beta.1 → 0.4.4-beta.2

package/lib/forms-validation.js

@@ -1,33 +0,0 @@
-// @flow
-'use strict'
-
-const { elementSchema, formSchema } = require('./forms-schema.js')
-
-const Joi = require('joi')
-
-function validateJoiSchema /* :: <T> */ (
-  data /* : mixed */,
-  schema /* : Object */,
-  options /* : ?Object */
-) /* : T */ {
-  const result = Joi.validate(data, schema, options)
-  if (result.error) {
-    throw result.error
-  }
-  return result.value
-}
-
-function validateWithFormSchema (form /* : mixed */) /* : Form */ {
-  const validatedForm = validateJoiSchema(form, formSchema, { stripUnknown: true })
-  return validatedForm
-}
-
-function validateWithElementSchema (element /* : mixed */) /* : FormElement */ {
-  const validatedElement = validateJoiSchema(element, elementSchema, { stripUnknown: true })
-  return validatedElement
-}
-
-module.exports = {
-  validateWithFormSchema,
-  validateWithElementSchema
-}

package/lib/generate-form-element.js

@@ -1,75 +0,0 @@
-// @flow
-'use strict'
-
-const uuid = require('uuid/v4')
-
-const { validateWithElementSchema } = require('../lib/forms-validation.js')
-
-function generateFormElement (
-  formElementGenerationData /* : mixed */
-) /* : FormElement */ {
-  if (!formElementGenerationData) {
-    throw new Error('no form element generation data provided, please provide this data to generate a form element')
-  }
-
-  // initialise empty element object and spread data passed by user
-  const formElement /* : Object */ = { ...formElementGenerationData }
-
-  // element property: id
-  formElement.id = uuid()
-
-  // element property: options
-  if (Array.isArray(formElementGenerationData.options)) {
-    const options = formElementGenerationData.options.map((o, index) => {
-      const option = o || {}
-      return {
-        ...option,
-        id: uuid(),
-        label: option.label || option.value || `Option ${index + 1}`,
-        value: option.value || index.toString()
-      }
-    })
-    formElement.options = options
-  }
-
-  // element property: type || default to: 'text'
-  if (typeof formElementGenerationData.type === 'string') {
-    formElement.type = formElementGenerationData.type
-  } else {
-    formElement.type = 'text'
-  }
-
-  // element property: required || default to: false
-  if (typeof formElementGenerationData.required === 'boolean') {
-    formElement.required = formElementGenerationData.required
-  } else {
-    formElement.required = false
-  }
-
-  // element property: label || default to: {type}
-  if (typeof formElementGenerationData.label === 'string') {
-    formElement.label = formElementGenerationData.label
-  } else {
-    formElement.label = formElement.type
-  }
-
-  // element property: name || default to: {label(without spaces)}
-  if (typeof formElementGenerationData.name !== 'string') {
-    formElement.name = formElement.label.replace(/\s+/g, '_')
-  }
-
-  // element property: conditionallyShow || default: false
-  if (typeof formElementGenerationData.conditionallyShow === 'boolean') {
-    formElement.conditionallyShow = formElementGenerationData.conditionallyShow
-  } else {
-    formElement.conditionallyShow = false
-  }
-
-  // element property: readOnly || default: false
-  formElement.readOnly = formElementGenerationData.readOnly || false
-
-  const validatedFormElement = validateWithElementSchema(formElement)
-  return validatedFormElement
-}
-
-module.exports = generateFormElement

package/lib/generate-form-url.js

@@ -1,29 +0,0 @@
-// @flow
-'use strict'
-
-const querystring = require('querystring')
-
-function generateFormUrl (
-  endpoint /* : string */,
-  formId /* : number */,
-  token /* : string */,
-  externalId /* : mixed */,
-  preFillFormDataId /* : ?string */
-) {
-  if (!formId) {
-    throw new Error('no form id provided, please provide a form id to generate a url')
-  }
-  let searchParams = {
-    access_key: token
-  }
-  if (externalId) {
-    searchParams = Object.assign({}, searchParams, { externalId })
-  }
-  if (preFillFormDataId) {
-    searchParams = Object.assign({}, searchParams, { preFillFormDataId })
-  }
-  const search = querystring.stringify(searchParams)
-  return `${endpoint}/${formId}?${search}`
-}
-
-module.exports = generateFormUrl

package/lib/generate-jwt.js

@@ -1,18 +0,0 @@
-// @flow
-'use strict'
-
-const jwt = require('jsonwebtoken')
-
-function generateJWT (
-  accessKey /* : string */,
-  secretKey /* : string */,
-  expiresInSeconds /* : number */
-) {
-  return jwt.sign({
-    iss: accessKey
-  }, secretKey, {
-    expiresIn: expiresInSeconds
-  })
-}
-
-module.exports = generateJWT

package/lib/one-blink-api-error-handler.js

@@ -1,31 +0,0 @@
-// @flow
-'use strict'
-
-/* ::
-import type {
-  $AxiosError
-} from 'axios'
-*/
-
-function oneBlinkAPIErrorHandler(
-  error /* : $AxiosError<{
-    error: string,
-    message: string,
-    statusCode: number
-  }> */
-) {
-  if (error.response) {
-    // The request was made and the server responded with a status code
-    // that falls out of the range of 2xx
-    error.response.data = error.response.data || {
-      message: 'OneBlink API Internal Server Error'
-    }
-    const err = new Error(error.response.data.message)
-    err.name = 'OneBlinkAPIError'
-    throw err
-  }
-
-  throw error
-}
-
-module.exports = oneBlinkAPIErrorHandler

package/lib/one-blink-api.js

@@ -1,107 +0,0 @@
-// @flow
-'use strict'
-
-/* ::
-import type {
-  Axios,
-  $AxiosError
-} from 'axios'
-*/
-
-const querystring = require('querystring')
-
-const axios = require('axios')
-
-const pkg = require('../package.json')
-const generateJWT = require('./generate-jwt.js')
-const errorHandler = require('./one-blink-api-error-handler.js')
-
-module.exports = class OneBlinkAPI {
-  /* ::
-  oneBlinkAPI: Axios
-  accessKey: string
-  secretKey: string
-  jwtExpiry: number
-  */
-  constructor(
-    apiOrigin /* : mixed */,
-    accessKey /* : mixed */,
-    secretKey /* : mixed */
-  ) {
-    if (!accessKey || typeof accessKey !== 'string') {
-      throw new TypeError('Must supply Access Key as a string')
-    }
-    if (!secretKey || typeof secretKey !== 'string') {
-      throw new TypeError('Must supply Secret Key as a string')
-    }
-
-    this.jwtExpiry = 300
-    this.accessKey = accessKey
-    this.secretKey = secretKey
-    this.oneBlinkAPI = axios.create({
-      baseURL:
-        typeof apiOrigin === 'string' ? apiOrigin : 'https://auth-api.blinkm.io'
-    })
-
-    const userAgentHeader = `Node.js ${pkg.name} / ${pkg.version}`
-
-    this.oneBlinkAPI.defaults.headers.common['User-Agent'] = userAgentHeader
-  }
-
-  get defaultRequestConfig() {
-    return {
-      headers: {
-        Authorization: `Bearer ${generateJWT(
-          this.accessKey,
-          this.secretKey,
-          this.jwtExpiry
-        )}`
-      }
-    }
-  }
-
-  getRequest /* :: <TOut> */(path /* : string */) /* : Promise<TOut> */ {
-    // 5 minute expiry
-    return this.oneBlinkAPI
-      .get(path, this.defaultRequestConfig)
-      .then(response => response.data)
-      .catch(errorHandler)
-  }
-
-  searchRequest /*:: <T, TOut> */(
-    path /* : string */,
-    searchParams /* : ?T */
-  ) /* : Promise<TOut> */ {
-    const search = querystring.stringify(searchParams || {})
-
-    return this.getRequest(`${path}?${search}`)
-  }
-
-  putRequest(path /* : string */, body /* : ?mixed */) /* Promise<Object> */ {
-    // 5 minute expiry
-    return this.oneBlinkAPI
-      .put(path, body, this.defaultRequestConfig)
-      .then(response => response.data)
-      .catch(errorHandler)
-  }
-
-  postRequest /*:: <T, TOut> */(
-    path /* : string */,
-    body /* : ?T */
-  ) /* : Promise<TOut> */ {
-    // 5 minute expiry
-    return this.oneBlinkAPI
-      .post(path, body, this.defaultRequestConfig)
-      .then(response => response.data)
-      .catch(errorHandler)
-  }
-
-  async deleteRequest(path /* : string */) /* : Promise<void> */ {
-    // 5 minute expiry
-    try {
-      await this.oneBlinkAPI.delete(path, this.defaultRequestConfig)
-    } catch (error) {
-      errorHandler(error)
-    }
-  }
-}

package/lib/pre-fill-data.js

@@ -1,33 +0,0 @@
-// @flow
-'use strict'
-
-const AWS = require('aws-sdk')
-
-function setPreFillData (
-  preFillMeta /* : PreFillMeta */,
-  data /* : mixed */
-)/* : Promise<mixed> */ {
-  const s3 = new AWS.S3({
-    region: preFillMeta.s3.region,
-    accessKeyId: preFillMeta.credentials.AccessKeyId,
-    secretAccessKey: preFillMeta.credentials.SecretAccessKey,
-    sessionToken: preFillMeta.credentials.SessionToken
-  })
-
-  const objectMeta = {
-    Bucket: preFillMeta.s3.bucket,
-    Key: preFillMeta.s3.key,
-    Body: Buffer.from(JSON.stringify(data) || '{}', 'UTF-8'),
-    Expires: new Date(new Date().setFullYear(new Date().getFullYear() + 1)), // Max 1 year
-    CacheControl: 'max-age=31536000' // Max 1 year(365 days)
-  }
-  const uploadOptions = {
-    partSize: 5 * 1024 * 1024,
-    queueSize: 1
-  }
-  return s3.upload(objectMeta, uploadOptions)
-    .promise()
-    .then(() => ({}))
-}
-
-module.exports = setPreFillData

package/lib/retrieve-submission-data.js

@@ -1,29 +0,0 @@
-// @flow
-'use strict'
-
-const AWS = require('aws-sdk')
-
-function getSubmissionData (
-  retrievalData /* : FormRetrievalData */
-) /* : Promise<S3SubmissionData> */ {
-  const s3 = new AWS.S3({
-    region: retrievalData.s3.region,
-    accessKeyId: retrievalData.credentials.AccessKeyId,
-    secretAccessKey: retrievalData.credentials.SecretAccessKey,
-    sessionToken: retrievalData.credentials.SessionToken
-  })
-
-  const params = {
-    Bucket: retrievalData.s3.bucket,
-    Key: retrievalData.s3.key
-  }
-  return s3.getObject(params).promise()
-    .then(s3Data => {
-      const formData = s3Data.Body.toString()
-      return JSON.parse(formData)
-    })
-}
-
-module.exports = {
-  getSubmissionData
-}

package/lib/tenant.js

@@ -1,23 +0,0 @@
-// @flow
-'use strict'
-
-const apis = {
-  ONEBLINK: 'https://auth-api.blinkm.io',
-  CIVICPLUS: 'https://auth-api.transform.civicplus.com'
-}
-
-module.exports = (
-  tenant /* : string */ = 'ONEBLINK',
-  apiOrigin /* : mixed */
-) => {
-  if (!!tenant && !Object.keys(apis).includes(tenant.toUpperCase())) {
-    throw new TypeError(
-      ` Must be passed a valid tenant. Valid options are ${Object.keys(
-        apis
-      ).toString()}`
-    )
-  }
-
-  if (apiOrigin) return apiOrigin
-  return apis[tenant.toUpperCase()]
-}