upstream-corteza/server/system/automation/templates_handler.yaml

imports:
  - github.com/cortezaproject/corteza/server/system/types
  - labelTypes github.com/cortezaproject/corteza/server/pkg/label/types


snippets:
  lookup: &lookup
    meta: { label: Lookup }
    required: true
    types:
      - { wf: ID     }
      - { wf: Handle }
      - { wf: Template,   suffix: res }

  # same as lookup but labeled for the render function where it is the body of the document
  bodyLookup: &bodyLookup
    required: true
    meta:
      label: Body template
      description: Template rendered as the body of the document
    types:
      - { wf: ID     }
      - { wf: Handle }
      - { wf: Template,   suffix: res }

  auxTemplate: &auxTemplate
    types:
      - { wf: ID     }
      - { wf: Handle }
      - { wf: Template,   suffix: res }

  template: &template
    types:
      - { wf: Template }

  rvTemplate: &rvTemplate
    wf: Template

  rvRenderedDocument: &rvRenderedDocument
    wf: RenderedDocument

  rvTotal: &rvTotal
    wf: UnsignedInteger

  rvPageCursor: &rvPageCursor
    wf: String

  filterParams: &filterParams
    handle:
      meta: { label: Handle }
      types:
        - { wf: String }
    type:
      meta: { label: Type }
      types:
        - { wf: String }
    ownerID:
      meta: { label: Owner ID }
      types:
        - { wf: ID }
    partial:
      meta: { label: Partial }
      types:
        - { wf: Boolean }
    labels:
      meta: { label: Labels }
      types:
        - { wf: LabelValue }
    sort:
      meta: { label: Sort }
      types:
        - { wf: String }
    limit:
      meta: { label: Limit }
      types:
        - { wf: UnsignedInteger }
    incTotal:
      meta: { label: Include total }
      types:
        - { wf: Boolean }
    incPageNavigation:
      meta: { label: Include page navigation }
      types:
        - { wf: Boolean }
    pageCursor:
      meta: { label: Page cursor }
      types:
        - { wf: String }

labels: &labels
  templates:  "step,workflow"

functions:
  lookup:
    meta:
      short: Template lookup
      description: Find specific template by ID or handle
    params:
      lookup: *lookup
    labels:
      <<: *labels
    results:
      template: *rvTemplate

  search:
    meta:
      short: Templates search
    params: *filterParams
    labels:
      <<: *labels
    results:
      templates:
        <<: *rvTemplate
        isArray: true
      total: *rvTotal

  each:
    kind: iterator
    meta:
      short: Templates
    params: *filterParams
    labels:
      <<: *labels
    results:
      template:  *rvTemplate
      total: *rvTotal

  create:
    meta:
      short: Template create
    labels:
      <<: *labels
    params:
      template:
        <<: *template
        meta: { label: Template }
        required: true
    results:
      template: *rvTemplate

  update:
    meta:
      short: Template update
    labels:
      <<: *labels
    params:
      template:
        <<: *template
        meta: { label: Template }
        required: true
    results:
      template: *rvTemplate

  delete:
    labels:
      <<: *labels
      delete: "step"
    meta:
      short: Template delete
    params:
      lookup: *lookup

  recover:
    meta:
      short: Template recover
    labels:
      <<: *labels
      recover: "step"
    params:
      lookup: *lookup

  render:
    meta:
      short: Template render
    labels:
      <<: *labels
      render: "step"
    params:
      lookup: *bodyLookup
      headerTemplate:
        <<: *auxTemplate
        meta:
          label: Header template
          description: Overrides the header template set on the body template; used by drivers that support it
      footerTemplate:
        <<: *auxTemplate
        meta:
          label: Footer template
          description: Overrides the footer template set on the body template; used by drivers that support it
      documentName:
        meta: { label: Document name }
        types:
          - { wf: String }
      documentType:
        meta: { label: Document type }
        types:
          - { wf: String }
      variables:
        meta: { label: Variables }
        types:
          - { wf: Vars, go: '*expr.Vars' }
      options:
        meta: { label: Options }
        types:
          - { wf: RenderOptions }
    results:
      document: *rvRenderedDocument