/**
 * Copyright 2020 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

import * as Schema from '../../api/schema'

export class Intent {
  /**
   * Gets the name of the last matched intent.
   *
   * @example
   * ```javascript
   *
   * // Using conv.input.raw
   * app.intent('function name', conv => {
   *  conv.close(`Last match intent: ${conv.intent.name}`)
   * })
   * ```
   *
   * @public
   */
  name: string
  /**
   * Gets the parameters associated with the last matched intent.
   *
   * @example
   * ```javascript
   *
   * // Using conv.input.raw
   * app.intent('function name', conv => {
   *  conv.close(`Last match intent: ${conv.intent.params.paramName.orginal}`)
   *  conv.close(`Last match intent: ${conv.intent.params.paramName.orginal}`)
   * })
   * ```
   *
   * @public
   */
  params: Record<string, Schema.IntentParameterValue>
  query: string

  /** @hidden */
  constructor(input: Schema.Intent = {}) {
    const { name = '', params = {}, query = '' } = input
    this.name = name
    this.query = query
    this.params = params
  }
}