# Note: we're intentionally not prefixing this with "compose"
#       due to plans in the (near) future to refactor attachments
#       from system & compose components into one single service

imports:
  - github.com/cortezaproject/corteza/server/compose/types
  - io

labels: &labels
  attachment: "step,workflow"

functions:
  lookup:
    meta:
      short: Attachment lookup
      description: Find specific attachment by ID
    labels:
      <<: *labels
    params:
      attachment:
        meta: { label: Attachment }
        required: true
        types: [ { wf: ID } ]
    results:
      attachment: { wf: Attachment }

  create:
    meta:
      short: Create file and attach it to a resource
    labels:
      <<: *labels
      create: "step"
    params:
      name:
        meta: { label: Name }
        types:
          - { wf: String }

      resource:
        meta: { label: Resource }
        required: true
        types:
          - { wf: ComposeRecord }

      fieldName:
        meta: { label: Field name }
        types:
          - { wf: String }

      content:
        meta: { label: Content }
        required: true
        types:
          - { wf: String, suffix: String }
          - { wf: Reader, suffix: Stream }
          - { wf: Bytes,  suffix: Bytes }

    results:
      attachment: { wf: Attachment }

  delete:
    meta:
      short: Delete attachment
    labels:
      <<: *labels
      delete: "step"
    params:
      attachment:
        meta: { label: Attachment }
        required: true
        types: [ { wf: ID } ]

  openOriginal:
    meta:
      short: Open original attachment
    labels:
      <<: *labels
      original-attachment: "step"
    params:
      attachment:
        meta: { label: Attachment }
        required: true
        types: [ { wf: ID }, { wf: Attachment } ]
    results:
      content: { wf: Reader }

  openPreview:
    meta:
      short: Open attachment preview
    labels:
      <<: *labels
      preview-attachment: "step"
    params:
      attachment:
        meta: { label: Attachment }
        required: true
        types: [ { wf: ID }, { wf: Attachment } ]
    results:
      content: { wf: Reader }