All files / lib/base-range-input-field base-range-input-field.component.ts

98.68% Statements 452/458
97.77% Branches 88/90
96.15% Functions 25/26
98.68% Lines 452/458

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 4591x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 18145x 18145x 1x 1x 1x 7292x 7292x 7292x 7292x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 18600x 18600x 18600x 61x 61x 90x 90x 90x 66x 66x 24x 24x 24x 90x 90x 61x 61x 61x 2321x 2044x 2044x 277x 277x 277x 2305x 2305x 2305x 2321x 2321x 2321x 2321x 2321x 61x 61x 61x 2161x 2015x 2015x 146x 146x 146x 2161x 2161x 2161x 2161x 2161x 2161x 2161x 2161x 61x 61x 61x 162x 162x 61x 61x 61x 320x 320x 61x 61x 61x 227x 227x 61x 61x 61x 2161x 2161x 2139x 2030x 2030x 2161x 2161x 2141x 2141x 2161x 2161x 2161x 2161x 2161x 2161x 2161x 61x 61x 61x 348x 348x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 61x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 8x 4x 4x 4x 8x 8x 1x 1x     1x 1x 1x 6831x 6831x 1x 1x 1x 4456x 4456x 4456x 4456x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 4322x 4322x 40x 20x 20x 20x 40x 4282x 4282x 4322x 4322x 1x 1x 1x 25x 20x 25x 25x 25x 25x 25x 25x 1x 1x 1x 24x 24x 11x 11x 24x 24x 24x 24x 24x 24x 1x 1x 1x 21x 8x 21x 21x 21x 21x 21x 21x 1x 1x 1x 21x 21x 16x 16x 21x 21x 21x 21x 21x 21x 1x 1x 1x 130x 57x 73x 73x 73x 73x 73x     130x 1x 1x 1x 109x 50x 59x 59x 59x 59x 59x     109x 1x 1x 1x 98x 98x 98x 98x 98x 98x 98x 8x 98x 98x 6x 98x 98x 98x 27x 21x 21x 98x 98x 98x 27x 14x 14x 98x 98x 98x 71x 6x 6x 98x 98x 98x 98x 1x  
/*******************************************************************************
 * Copyright bei
 * Entwicklungs- und Pflegeverbund für das gemeinsame Fachverfahren gefa
 *
 *******************************************************************************/
import { Directive, EventEmitter, Input, Output } from '@angular/core';
 
import {
  FocusableElementOwner,
  FocusableRangeElementOwner,
  FormControlStatus,
  RangeInputSlots,
  WidgetKeySet,
} from '../utils/util.types';
 
export type RangeInputSlotsFull = RangeInputSlots | 'both';
 
export type RangeErrors =
  | {
      start: string;
      end: string;
    }
  | {
      both: string;
    };
 
export type RangeInputSlotsWithStatus = Record<
  RangeInputSlots | 'both',
  FormControlStatus
>;
 
/** check if var of type RangeErrors has common error slot for both input-fields */
export function isBothRangeErrors(val: RangeErrors): val is { both: string } {
  return 'both' in val;
}
 
/** check if var of type RangeErrors has individual error slots for each input-field */
export function isIndividualRangeErrors(
  val: RangeErrors,
): val is { start: string; end: string } {
  return !isBothRangeErrors(val);
}
 
/**
 * Internal base class to implement Range-Input-Field Components within `gc-two-slot-label-container`
 */
@Directive()
export abstract class BaseRangeInputFieldComponent<T>
  implements FocusableElementOwner, FocusableRangeElementOwner
{
  /**
   * Controls the required state of the slots.
   *  - "start === true": sets the start slot as a required a required field
   *  - "end === true":  sets the end slot as a required a required field
   */
  @Input()
  public required: Record<RangeInputSlots, boolean> = {
    start: false,
    end: false,
  };
 
  /**
   * Sets the labels of the slots.
   * - "start": sets the inner label of the start slot
   * - "end": sets the inner label of the end slot
   * - "both": sets the outer label of both slots (whole component)
   */
  @Input()
  public label: Record<RangeInputSlotsFull, string> = {
    both: '',
    start: '',
    end: '',
  };
 
  /**
   * Controls the readonly state of the component.
   */
  @Input()
  public readonly: boolean | Record<RangeInputSlots, boolean> = false;
 
  /**
   * Controls the disabled state of the component.
   */
  @Input()
  public disabled = false;
 
  /**
   * Hint message that appears below the slots.
   */
  @Input()
  public hint = '';
 
  /**
   * Overrides the default text on the start slot which is shown when the control is readonly and empty.
   */
  @Input()
  public startSlotReadonlyEmptyValue = '';
 
  /**
   * Overrides the default text on the end slot which is shown when the control is readonly and empty.
   */
  @Input()
  public endSlotReadonlyEmptyValue = '';
 
  /**
   * Fires on a start slot value change.
   */
  @Output()
  public readonly startSlotValueChange: EventEmitter<T> = new EventEmitter<T>();
 
  /**
   * Fires on an end slot value change.
   */
  @Output()
  public readonly endSlotValueChange: EventEmitter<T> = new EventEmitter<T>();
 
  /**
   * Signals changes of the current (combined) status of the component, e.g. also reports errors triggered by internal
   * validation or input handling.
   */
  @Output()
  public readonly onStatusChange: EventEmitter<RangeInputSlotsWithStatus> =
    new EventEmitter<RangeInputSlotsWithStatus>();
 
  /**
   * Event fired when the control gains focus
   */
  @Output()
  public readonly onFocusEntered: EventEmitter<void> = new EventEmitter<void>();
 
  /**
   * Event fired when the control looses focus
   */
  @Output()
  public readonly onFocusLeft: EventEmitter<void> = new EventEmitter<void>();
 
  /**
   * Event fired when a slot gains focus. Outputs information about focused slot.
   */
  @Output()
  public readonly onSlotFocusEntered: EventEmitter<RangeInputSlots> =
    new EventEmitter<RangeInputSlots>();
 
  /**
   * Event fired when a slot loses focus. Outputs information about the slot that lost focus.
   */
  @Output()
  public readonly onSlotFocusLeft: EventEmitter<RangeInputSlots> =
    new EventEmitter<RangeInputSlots>();
 
  /**
   * Optional error message for the slots.
   *  First option:
   *  - "start": error message that refers to the start slot
   *  - "end": error message that refers to the end slot
   *  Second option:
   *  - "both": error message that refers to both slots
   */
  @Input()
  public get errorMessage(): RangeErrors {
    return this._errors;
  }
 
  public set errorMessage(value: RangeErrors) {
    this._errors = value;
    this.onStatusChange.emit(this.combineAllErrorStatuses());
    if (this._isBothRangeErrors(value)) {
      this.startSlotHasExternalError = value.both.length > 0;
      this.endSlotHasExternalError = value.both.length > 0;
    } else {
      this.startSlotHasExternalError = value.start.length > 0;
      this.endSlotHasExternalError = value.end.length > 0;
    }
  }
 
  /** @ignore */
  protected get startSlotErrorMessageId(): string | undefined {
    if (this._isBothRangeErrors(this.errorMessage)) {
      if (this.errorMessage.both.length > 0) {
        return this.bothSlotErrorsMessageIdString;
      }
    } else if (this.errorMessage.start.length > 0) {
      return this.startErrorMessageIdString;
    }
 
    if (this.startSlotHasInternalError) {
      return this.startErrorMessageIdString;
    }
 
    return undefined;
  }
 
  /** @ignore */
  protected get endSlotErrorMessageId(): string | undefined {
    if (this._isBothRangeErrors(this.errorMessage)) {
      if (this.errorMessage.both.length > 0) {
        return this.bothSlotErrorsMessageIdString;
      }
    } else if (this.errorMessage.end.length > 0) {
      return this.endErrorMessageIdString;
    }
 
    if (this.endSlotHasInternalError) {
      return this.endErrorMessageIdString;
    }
 
    return undefined;
  }
 
  /** @ignore */
  protected get bothSlotErrorsMessageIdString(): string {
    return this._widgetKeys.errorKey + '-both';
  }
 
  /** @ignore */
  protected get startErrorMessageIdString(): string {
    return this._widgetKeys.errorKey + '-start';
  }
 
  /** @ignore */
  protected get endErrorMessageIdString(): string {
    return this._widgetKeys.errorKey + '-end';
  }
 
  /** @ignore */
  protected get actualErrorSlots(): RangeInputSlotsFull | undefined {
    if (
      (this.startSlotHasInternalError && this.endSlotHasInternalError) ||
      (this.startSlotHasExternalError && this.endSlotHasExternalError) ||
      (this.startSlotHasExternalError && this.endSlotHasInternalError) ||
      (this.startSlotHasInternalError && this.endSlotHasExternalError)
    ) {
      return 'both';
    }
    if (this.startSlotHasInternalError || this.startSlotHasExternalError) {
      return 'start';
    }
    if (this.endSlotHasInternalError || this.endSlotHasExternalError) {
      return 'end';
    }
    return undefined;
  }
 
  /** @ignore */
  protected get hintId(): string {
    return this._widgetKeys.widgetKey + '-info-message';
  }
 
  /** @ignore */
  protected startSlotInternalError = '';
 
  /** @ignore */
  protected endSlotInternalError = '';
 
  /** @ignore */
  protected startSlotHasInternalError = false;
 
  /** @ignore */
  protected endSlotHasInternalError = false;
 
  /** @ignore */
  protected focusedSlot?: 'start' | 'end';
 
  /** @ignore */
  private _errors: RangeErrors = { start: '', end: '', both: '' };
 
  /** @ignore */
  private startSlotHasExternalError = false;
 
  /** @ignore */
  private endSlotHasExternalError = false;
 
  /** @ignore */
  private lastFocusedSlot?: RangeInputSlots;
 
  /** @ignore */
  public abstract startSlotValue: T;
 
  /** @ignore */
  public abstract endSlotValue: T;
 
  /** @ignore */
  protected abstract readonly _widgetKeys: WidgetKeySet;
 
  /** @ignore */
  protected abstract startSlotElement: FocusableElementOwner;
 
  /** @ignore */
  protected abstract endSlotElement: FocusableElementOwner;
 
  public focusRangeSlot(slot: 'start' | 'end'): boolean {
    if (slot === 'start') {
      return this.startSlotElement.focusChild();
    } else {
      return this.endSlotElement.focusChild();
    }
  }
 
  public focusChild(): boolean {
    return this.startSlotElement.focusChild();
  }
 
  /** @ignore */
  protected _isBothRangeErrors(val: RangeErrors): val is { both: string } {
    return isBothRangeErrors(val);
  }
 
  /** @ignore */
  protected _isIndividualRangeErrors(
    val: RangeErrors,
  ): val is { start: string; end: string } {
    return isIndividualRangeErrors(val);
  }
 
  /** @ignore */
  protected startSlotStatusHandler(s: FormControlStatus) {
    const error = s.error ? s.error[0] : '';
    this.startSlotInternalError = error;
    this.startSlotHasInternalError = s.error !== undefined;
 
    const errors: RangeInputSlotsWithStatus = this.combineAllErrorStatuses();
    this.onStatusChange.emit(errors);
  }
 
  /** @ignore */
  protected endSlotStatusHandler(s: FormControlStatus) {
    const error = s.error ? s.error[0] : '';
    this.endSlotInternalError = error;
    this.endSlotHasInternalError = s.error !== undefined;
 
    const errors: RangeInputSlotsWithStatus = this.combineAllErrorStatuses();
    this.onStatusChange.emit(errors);
  }
 
  /** @ignore */
  protected isReadonly(slot: RangeInputSlots): boolean {
    if (typeof this.readonly === 'object') {
      switch (slot) {
        case 'start':
          return this.readonly.start;
        case 'end':
          return this.readonly.end;
      }
    } else {
      return this.readonly;
    }
  }
 
  /** @ignore */
  protected handleStartSlotFocusEntered(): void {
    if (this.lastFocusedSlot === undefined) {
      this.onFocusEntered.emit();
    }
 
    this.focusedSlot = 'start';
    this.lastFocusedSlot = 'start';
    this.onSlotFocusEntered.emit('start');
  }
 
  /** @ignore */
  protected handleStartSlotFocusLeft(): void {
    setTimeout(() => {
      if (this.focusedSlot === undefined) {
        this.lastFocusedSlot = undefined;
        this.onFocusLeft.emit();
      }
    });
 
    this.focusedSlot = undefined;
    this.onSlotFocusLeft.emit('start');
  }
 
  /** @ignore */
  protected handleEndSlotFocusEntered(): void {
    if (this.lastFocusedSlot === undefined) {
      this.onFocusEntered.emit();
    }
 
    this.focusedSlot = 'end';
    this.lastFocusedSlot = 'end';
    this.onSlotFocusEntered.emit('end');
  }
 
  /** @ignore */
  protected handleEndSlotFocusLeft(): void {
    setTimeout(() => {
      if (this.focusedSlot === undefined) {
        this.onFocusLeft.emit();
        this.lastFocusedSlot = undefined;
      }
    });
 
    this.focusedSlot = undefined;
    this.onSlotFocusLeft.emit('end');
  }
 
  /** @ignore */
  protected startErrorMessage(): string {
    if (this.startSlotHasInternalError) {
      return this.startSlotInternalError;
    } else if (
      isIndividualRangeErrors(this.errorMessage) &&
      this.errorMessage.start
    ) {
      return this.errorMessage.start;
    }
    return '';
  }
 
  /** @ignore */
  protected endErrorMessage(): string {
    if (this.endSlotHasInternalError) {
      return this.endSlotInternalError;
    } else if (
      isIndividualRangeErrors(this.errorMessage) &&
      this.errorMessage.end
    ) {
      return this.errorMessage.end;
    }
    return '';
  }
 
  /** @ignore */
  private combineAllErrorStatuses(): RangeInputSlotsWithStatus {
    const errors: RangeInputSlotsWithStatus = {
      start: { error: [] },
      end: { error: [] },
      both: { error: [] },
    };
 
    if (this.startSlotInternalError.length > 0) {
      errors.start.error?.push(this.startSlotInternalError);
    }
    if (this.endSlotInternalError.length > 0) {
      errors.end.error?.push(this.endSlotInternalError);
    }
    if (
      this._isIndividualRangeErrors(this.errorMessage) &&
      this.errorMessage.start.length > 0
    ) {
      errors.start.error?.push(this.errorMessage.start);
    }
    if (
      this._isIndividualRangeErrors(this.errorMessage) &&
      this.errorMessage.end.length > 0
    ) {
      errors.end.error?.push(this.errorMessage.end);
    }
    if (
      this._isBothRangeErrors(this.errorMessage) &&
      this.errorMessage.both.length > 0
    ) {
      errors.both.error?.push(this.errorMessage.both);
    }
 
    return errors;
  }
}