@spotinst/spinnaker-deck/app/scripts/modules/core/src/help/helpContents.registry.ts

Spinnaker-Deck service, forked with support to Spotinst

import { FirewallLabels } from 'core/securityGroup/label';

export class HelpContentsRegistry {
  private static helpFields: Map<string, string> = new Map<string, string>();
  private static overrides: Set<string> = new Set<string>();

  /**
   * Returns the configured help value, or null if nothing is configured
   * @param key the key
   * @returns the configured help value, or null
   */
  public static getHelpField(key: string): string {
    let contents = this.helpFields.get(key);
    if (contents) {
      // TODO: remove this if the FirewallLabels feature ever goes away
      contents = contents.replace(/{{(.+?)}}/g, (_ignored, match) => FirewallLabels.get(match));
    }
    return contents || null;
  }

  /**
   * Adds a help field to the registry. This value can be overridden by calling #registerOverride
   * If an override has been configured, this call will *not* change the already-configured value
   * @param key the key
   * @param val the value
   */
  public static register(key: string, val: string): void {
    if (!this.overrides.has(key)) {
      this.helpFields.set(key, val);
    }
  }

  /**
   * Adds a help field to the registry and locks it, preventing subsequent registrations with the same key from
   * replacing its value. Subsequent calls to this method with the same key will have no effect on the value.
   *
   * @param key the key
   * @param val the value
   */
  public static registerOverride(key: string, val: string): void {
    this.register(key, val);
    this.overrides.add(key);
  }
}