Class WebService

src/model/web-service.ts:25–147

}

export default class WebService<T extends WebAPI = WebAPI, P extends object = object> implements Serializable {
  onChangeName: Signal<() => void> = new Signal;
  onChangeAPIParams: Signal<() => void> = new Signal;
  onChangeParams: Signal<() => void> = new Signal;
  onChangeIcon: Signal<() => void> = new Signal;

  name: string;
  api: T;
  icon?: Icon;
  params?: P;

  static deserialize(data: WebServiceData): WebServiceOptions<WebAPI> {
    if (!data ||
        typeof data != 'object' ||
        typeof data.name != 'string' ||
        typeof data.api != 'string') {
      throw new Error(`Unknown WebService : ${JSON.stringify(data)}`);
    }
    const credential = apiManager.getCredentialById(data.api);
    const api = apiManager.createAPIForCredential(credential);
    const options: WebServiceOptions<WebAPI> = {name: data.name, api};
    if (typeof data.icon == 'string')
      options.icon = new Icon({chieURL: data.icon});
    if (typeof data.apiParams == 'object')
      options.apiParams = data.apiParams;
    if (typeof data.params == 'object')
      options.params = data.params;
    return options;
  }

  constructor(options: WebServiceOptions<T, P>) {
    if (!options.name || !options.api)
      throw new Error('Must pass name and api to WebService');
    this.name = options.name;
    this.api = options.api;
    this.icon = options.icon ?? new Icon({name: 'bot'});
    // The params are cloned since they may be used to create other assistants.
    this.api.params = Object.assign({}, options.apiParams);
    this.params = Object.assign({}, options.params);
  }

  serialize() {
    const data: WebServiceData = {
      name: this.name,
      api: this.api.credential.id,
    };
    if (this.icon)
      data.icon = this.icon.getChieURL();
    if (!isEmptyObject(this.api.params))
      data.apiParams = nonNullAssign({}, this.api.params);
    if (!isEmptyObject(this.params))
      data.params = nonNullAssign({}, this.params);
    return data;
  }

  destructor() {
    // Nothing to destructor by default.
  }