vault/ui/lib/core/addon/components/ttl-picker2.js

/**
 * @module TtlPicker2
 * TtlPicker2 components are used to enable and select 'time to live' values. Use this TtlPicker2 instead of TtlPicker if you:
 * - Want the TTL to be enabled or disabled
 * - Want to have the time recalculated by default when the unit changes (eg 60s -> 1m)
 *
 * @example
 * ```js
 * <TtlPicker2 @onChange={{handleChange}} @time={{defaultTime}} @unit={{defaultUnit}}/>
 * ```
 * @param onChange {Function} - This function will be passed a TTL object, which includes enabled{bool}, seconds{number}, timeString{string}, goSafeTimeString{string}.
 * @param label="Time to live (TTL)" {String} - Label is the main label that lives next to the toggle.
 * @param helperTextDisabled="Allow tokens to be used indefinitely" {String} - This helper text is shown under the label when the toggle is switched off
 * @param helperTextEnabled="Disable the use of the token after" {String} - This helper text is shown under the label when the toggle is switched on
 * @param description="Longer description about this value, what it does, and why it is useful. Shows up in tooltip next to helpertext"
 * @param time='' {Number} - The time (in the default units) which will be adjustable by the user of the form
 * @param unit="s" {String} - This is the unit key which will show by default on the form. Can be one of `s` (seconds), `m` (minutes), `h` (hours), `d` (days)
 * @param recalculationTimeout=5000 {Number} - This is the time, in milliseconds, that `recalculateSeconds` will be be true after time is updated
 * @param initialValue=null {String} - This is the value set initially (particularly from a string like '30h')
 * @param initialEnabled=null {Boolean} - Set this value if you want the toggle on when component is mounted
 * @param changeOnInit=false {Boolean} - set this value if you'd like the passed onChange function to be called on component initialization
 * @param hideToggle=false {Boolean} - set this value if you'd like to hide the toggle and just leverage the input field
 */

import { computed } from '@ember/object';
import { typeOf } from '@ember/utils';
import Duration from '@icholy/duration';
import TtlForm from './ttl-form';
import layout from '../templates/components/ttl-picker2';

const secondsMap = {
  s: 1,
  m: 60,
  h: 3600,
  d: 86400,
};
const convertFromSeconds = (seconds, unit) => {
  return seconds / secondsMap[unit];
};
const goSafeConvertFromSeconds = (seconds, unit) => {
  // Go only accepts s, m, or h units
  let u = unit === 'd' ? 'h' : unit;
  return convertFromSeconds(seconds, u) + u;
};

export default TtlForm.extend({
  layout,
  enableTTL: false,
  label: 'Time to live (TTL)',
  helperTextDisabled: 'Allow tokens to be used indefinitely',
  helperTextEnabled: 'Disable the use of the token after',
  description: '',
  time: '', // if defaultValue is NOT set, then do not display a defaultValue.
  unit: 's',
  initialValue: null,
  changeOnInit: false,
  hideToggle: false,

  init() {
    this._super(...arguments);
    const value = this.initialValue;
    const enable = this.initialEnabled;
    const changeOnInit = this.changeOnInit;
    // if initial value is unset use params passed in as defaults
    // and if no defaultValue is passed in display no time
    if (!value && value !== 0) {
      return;
    }

    let time = 30;
    let unit = 's';
    let setEnable = this.hideToggle || this.enableTTL;
    if (!!enable || typeOf(enable) === 'boolean') {
      // This allows non-boolean values passed in to be evaluated for truthiness
      setEnable = !!enable;
    }

    if (typeOf(value) === 'number') {
      // if the passed value is a number, assume unit is seconds
      // then check if the value can be converted into a larger unit
      if (value % secondsMap.d === 0) {
        unit = 'd';
      } else if (value % secondsMap.h === 0) {
        unit = 'h';
      } else if (value % secondsMap.m === 0) {
        unit = 'm';
      }
      time = convertFromSeconds(value, unit);
    } else {
      try {
        const seconds = Duration.parse(value).seconds();
        time = seconds;
        // get largest unit with no remainder
        if (seconds % secondsMap.d === 0) {
          unit = 'd';
        } else if (seconds % secondsMap.h === 0) {
          unit = 'h';
        } else if (seconds % secondsMap.m === 0) {
          unit = 'm';
        }

        if (unit !== 's') {
          time = convertFromSeconds(seconds, unit);
        }
      } catch (e) {
        // if parsing fails leave as default 30s
      }
    }

    this.setProperties({
      time,
      unit,
      enableTTL: setEnable,
    });

    if (changeOnInit) {
      this.handleChange();
    }
  },

  unitOptions: computed(function () {
    return [
      { label: 'seconds', value: 's' },
      { label: 'minutes', value: 'm' },
      { label: 'hours', value: 'h' },
      { label: 'days', value: 'd' },
    ];
  }),
  handleChange() {
    let { time, unit, enableTTL, seconds } = this;
    const ttl = {
      enabled: this.hideToggle || enableTTL,
      seconds,
      timeString: time + unit,
      goSafeTimeString: goSafeConvertFromSeconds(seconds, unit),
    };
    this.onChange(ttl);
  },

  helperText: computed(
    'enableTTL',
    'helperTextDisabled',
    'helperTextEnabled',
    'helperTextSet',
    'helperTextUnset',
    'hideToggle',
    function () {
      return this.enableTTL || this.hideToggle ? this.helperTextEnabled : this.helperTextDisabled;
    }
  ),

  recalculateSeconds: false,
  actions: {
    toggleEnabled() {
      this.toggleProperty('enableTTL');
      this.handleChange();
    },
  },
});