gerrit/polygerrit-ui/app/elements/shared/gr-js-api-interface/gr-change-reply-js-api.ts

/**
 * @license
 * Copyright (C) 2016 The Android Open Source Project
 *
 * 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 {
  ApiElement,
  GrReplyDialog,
  JsApiService,
} from '../../../services/services/gr-rest-api/gr-rest-api';

// TODO(TS): maybe move interfaces\types to other files when convertion complete
interface LabelsChangedDetail {
  name: string;
  value: string;
}
interface ValueChangedDetail {
  value: string;
}

interface GerritHtmlElementEventMap {
  'value-changed': CustomEvent<ValueChangedDetail>;
  'labels-changed': CustomEvent<LabelsChangedDetail>;
}

interface GerritHtmlElement extends EventTarget {
  addEventListener<K extends keyof GerritHtmlElementEventMap>(
    type: K,
    listener: (
      this: GerritHtmlElement,
      ev: GerritHtmlElementEventMap[K]
    ) => void,
    options?: boolean | AddEventListenerOptions
  ): void;
  addEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | AddEventListenerOptions
  ): void;

  removeEventListener<K extends keyof GerritHtmlElementEventMap>(
    type: K,
    listener: (
      this: GerritHtmlElement,
      ev: GerritHtmlElementEventMap[K]
    ) => void,
    options?: boolean | EventListenerOptions
  ): void;
  removeEventListener(
    type: string,
    listener: EventListenerOrEventListenerObject,
    options?: boolean | EventListenerOptions
  ): void;
}

type HookCallback = (el: {content: GerritHtmlElement}) => void;
type ReplyChangedCallback = (text: string) => void;
type LabelsChangedCallback = (detail: LabelsChangedDetail) => void;

// TODO(TS): remove once Plugin api converted to ts
interface HookApi {
  onAttached(callback: HookCallback): void;
  onDetached(callback: HookCallback): void;
}

// TODO(TS): remove once Plugin api converted to ts
interface PluginApi {
  hook(hookName: string): HookApi;
}

/**
 * GrChangeReplyInterface, provides a set of handy methods on reply dialog.
 */
export class GrChangeReplyInterface {
  constructor(
    readonly plugin: PluginApi,
    readonly sharedApiElement: JsApiService
  ) {}

  get _el(): GrReplyDialog {
    return this.sharedApiElement.getElement(ApiElement.REPLY_DIALOG);
  }

  getLabelValue(label: string) {
    return this._el.getLabelValue(label);
  }

  setLabelValue(label: string, value: string) {
    this._el.setLabelValue(label, value);
  }

  send(includeComments?: boolean) {
    this._el.send(includeComments);
  }

  addReplyTextChangedCallback(handler: ReplyChangedCallback) {
    const hookApi = this.plugin.hook('reply-text');
    const registeredHandler = (e: CustomEvent<ValueChangedDetail>) =>
      handler(e.detail.value);
    hookApi.onAttached(el => {
      if (!el.content) {
        return;
      }
      el.content.addEventListener('value-changed', registeredHandler);
    });
    hookApi.onDetached(el => {
      if (!el.content) {
        return;
      }
      el.content.removeEventListener('value-changed', registeredHandler);
    });
  }

  addLabelValuesChangedCallback(handler: LabelsChangedCallback) {
    const hookApi = this.plugin.hook('reply-label-scores');
    const registeredHandler = (e: CustomEvent<LabelsChangedDetail>) =>
      handler(e.detail);
    hookApi.onAttached(el => {
      if (!el.content) {
        return;
      }
      el.content.addEventListener('labels-changed', registeredHandler);
    });

    hookApi.onDetached(el => {
      if (!el.content) {
        return;
      }
      el.content.removeEventListener('labels-changed', registeredHandler);
    });
  }

  showMessage(message: string) {
    return this._el.setPluginMessage(message);
  }
}