import { ExternalNavigationPathParams } from '../../public-api';
import { PfeBaseActionConfig } from '../pfe-actions.model';

export const PfeNavigateExternalActionType = 'PFE_NAVIGATE_EXTERNAL';

export interface PfeNavigateExternalActionConfig extends PfeBaseActionConfig {
  /**
   * This action triggers a navigation to an external URL.
   *
   * An example configuration could look like this:
   *
```
onNavigationStartActions: [
  {
    type: 'PFE_NAVIGATE_EXTERNAL',
    url: 'targetPageId',
  },
]
```
   *
   * If a navigation to the error page is in progress, it will not be aborted and no new navigation will be triggered
   * by this action.
   */
  type: typeof PfeNavigateExternalActionType;

  /**
   * The destination url of the triggered navigation
   */
  url: string;

  /**
   * Allow to handle all the navigation path params that are provided.
   * You can use this in 2 different ways, that can be mixed together, in the following examples
   * the final URL its the same.
   * ```json
   * [
   *   onPageEnterActions: [
        {
          type: "PFE_NAVIGATE_EXTERNAL",
          url: "https://example.org/",
          navigationPathParams: [
            {
              name: 'contractNumber',
              value: 'testContractNumber'
            },
            {
              name: 'flowid',
              value: 'testFlowId',
            },
          ]
        } as PfeNavigateExternalActionConfig
  ]
   * ```
   * ```json
   * [
   *   onPageEnterActions: [
        {
          type: "PFE_NAVIGATE_EXTERNAL",
          url: "https://example.org/",
          navigationPathParams: [
            {
              id: 'contractNumber',
              value: 'testContractNumber'
            },
            {
              id: 'flowid',
              value: 'testFlowId',
            },
          ]
        } as PfeNavigateExternalActionConfig
  ]
   * ```
   */
  navigationPathParams?: ExternalNavigationPathParams[];

  /**
   * Propagate forward specified path params from the current route to external navigation.
   * If a path param is not found, it will be ignored.
   * 
   * ```json
   * onPageEnterActions: [
        {
          type: "PFE_NAVIGATE_EXTERNAL",
          url: "https://example.org/",
          pathParamPropagations: ["startImpersonation"]
        } as PfeNavigateExternalActionConfig
      ],
   * ```
   *
   * It is not possible to use JSON Path expressions within the URL if this option is in use.
   * Define them with externalNavigationPathParams instead.
   */
  pathParamPropagations?: string[];
}