@botonic/plugin-contentful/src/contentful/contents/handoff.ts

Botonic Plugin Contentful is one of the **[available](https://github.com/hubtype/botonic/tree/master/packages)** plugins for Botonic. **[Contentful](http://www.contentful.com)** is a CMS (Content Management System) which manages contents of a great variet

import * as contentful from 'contentful'

import * as cms from '../../cms'
import {
  CmsException,
  ContentType,
  HandoffAgent,
  HandoffAgentEmail,
  HandoffAgentId,
  OnFinish,
} from '../../cms'
import { DeliveryApi } from '../delivery-api'
import {
  addCustomFields,
  CommonEntryFields,
  ContentfulEntryUtils,
} from '../delivery-utils'
import { CallbackTarget, getTargetCallback } from './callback-delivery'
import { QueueDelivery, QueueFields } from './queue'
import { DeliveryWithReference } from './reference'
import { TextDelivery, TextFields } from './text'

export class HandoffDelivery extends DeliveryWithReference {
  static REFERENCES_INCLUDE = QueueDelivery.REFERENCES_INCLUDE + 3
  constructor(
    delivery: DeliveryApi,
    private readonly queueDelivery: QueueDelivery,
    private readonly textDelivery: TextDelivery,
    resumeErrors: boolean
  ) {
    super(ContentType.HANDOFF, delivery, resumeErrors)
  }

  async handoff(id: string, context: cms.Context): Promise<cms.Handoff> {
    const entry: contentful.Entry<HandoffFields> = await this.getEntry(
      id,
      context,
      { include: HandoffDelivery.REFERENCES_INCLUDE }
    )
    return this.fromEntry(entry, context)
  }

  private onFinish(
    entry: contentful.Entry<HandoffFields>,
    context: cms.Context
  ): OnFinish {
    if (!entry.fields.onFinish) {
      throw new CmsException(`Handoff ${this.entryId(entry)} has no onFinish`)
    }
    return getTargetCallback(entry.fields.onFinish, context)
  }

  private async queue(
    entry: contentful.Entry<HandoffFields>,
    context: cms.Context
  ): Promise<cms.Queue | undefined> {
    if (!entry.fields.queue) return undefined
    return this.queueDelivery.fromEntry(
      entry.fields.queue as contentful.Entry<QueueFields>,
      context
    )
  }

  private agent(
    entry: contentful.Entry<HandoffFields>
  ): HandoffAgent | undefined {
    if (!entry.fields.agent) return undefined
    const AGENT_EMAIL_TYPE = 'agentEmail'
    const AGENT_ID_TYPE = 'agentId'
    const model = ContentfulEntryUtils.getContentModel(
      entry.fields.agent
    ) as string
    switch (model) {
      case AGENT_EMAIL_TYPE: {
        const agent = entry.fields.agent as contentful.Entry<AgentEmailFields>
        return new HandoffAgentEmail(agent.fields.agentEmail)
      }
      case AGENT_ID_TYPE: {
        const agent = entry.fields.agent as contentful.Entry<AgentIdFields>
        return new HandoffAgentId(agent.fields.agentId)
      }
    }
    return undefined
  }

  private async message(
    entry: contentful.Entry<HandoffFields>,
    context: cms.Context
  ): Promise<cms.Text | string | undefined> {
    if (!entry.fields.message) return undefined
    return typeof entry.fields.message === 'string'
      ? entry.fields.message
      : await this.textDelivery.fromEntry(
          entry.fields.message as contentful.Entry<TextFields>,
          context
        )
  }

  private async failMessage(
    entry: contentful.Entry<HandoffFields>,
    context: cms.Context
  ): Promise<cms.Text | string | undefined> {
    if (!entry.fields.failMessage) return undefined
    return typeof entry.fields.failMessage === 'string'
      ? entry.fields.failMessage
      : await this.textDelivery.fromEntry(
          entry.fields.failMessage as contentful.Entry<TextFields>,
          context
        )
  }

  async fromEntry(
    entry: contentful.Entry<HandoffFields>,
    context: cms.Context
  ): Promise<cms.Handoff> {
    const fields = entry.fields
    const common = ContentfulEntryUtils.commonFieldsFromEntry(entry)
    const referenceDelivery = {
      delivery: this.reference!,
      context,
    }
    return addCustomFields(
      new cms.Handoff(
        common,
        this.onFinish(entry, context),
        await this.message(entry, context),
        await this.failMessage(entry, context),
        await this.queue(entry, context),
        this.agent(entry),
        fields.shadowing
      ),
      fields,
      referenceDelivery,
      ['onFinish', 'agent', 'queue']
    )
  }
}

export interface AgentEmailFields {
  agentEmail: string
}

export interface AgentIdFields {
  agentId: string
}

type AgentTarget = contentful.Entry<AgentEmailFields | AgentIdFields>

export interface HandoffFields extends CommonEntryFields {
  message?: contentful.Entry<TextFields>
  failMessage?: contentful.Entry<TextFields>
  onFinish: CallbackTarget
  queue?: contentful.Entry<QueueFields>
  agent?: AgentTarget
  shadowing?: boolean
}