Source: client/object-to-proto.js

  1. /*
  2.  * Copyright 2023, TeamDev. All rights reserved.
  3.  *
  4.  * Licensed under the Apache License, Version 2.0 (the "License");
  5.  * you may not use this file except in compliance with the License.
  6.  * You may obtain a copy of the License at
  7.  *
  8.  * http://www.apache.org/licenses/LICENSE-2.0
  9.  *
  10.  * Redistribution and use in source and/or binary forms, with or without
  11.  * modification, must retain the above copyright notice and the following
  12.  * disclaimer.
  13.  *
  14.  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  15.  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  16.  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  17.  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  18.  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  19.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  20.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21.  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22.  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23.  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  24.  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25.  */
  27. "use strict";
  29. import {Message} from 'google-protobuf';
  30. import {Observable} from 'rxjs';
  31. import {map} from 'rxjs/operators';
  32. import TypeParsers from './parser/type-parsers';
  33. import KnownTypes from './known-types';
  35. /**
  36.  * A utility which converts the JS object to its Protobuf counterpart.
  37.  */
  38. export default class ObjectToProto {
  40.   constructor() {
  41.     throw new Error('ObjectToProto is not supposed to be instantiated.');
  42.   }
  44.   /**
  45.    * Converts the object to the corresponding Protobuf message.
  46.    *
  47.    * The input object is supposed to be a Protobuf message representation, i.e. all of its attributes should
  48.    * correspond to the fields of the specified message type.
  49.    *
  50.    * @param {!Object} object an object to convert
  51.    * @param {!string} typeUrl a type URL of the corresponding Protobuf message
  52.    */
  53.   static convert(object, typeUrl) {
  54.     if (!KnownTypes.hasType(typeUrl)) {
  55.       throw new Error(`Unable to convert object of unknown type ${typeUrl}`);
  56.     }
  57.     const parser = TypeParsers.parserFor(typeUrl);
  58.     const proto = parser.fromObject(object);
  59.     return proto;
  60.   }
  62.   /**
  63.    * Convert the given observable of objects to the observable of the
  64.    * corresponding Protobuf messages.
  65.    *
  66.    * @param {!Observable<Object>} observable an observable to convert
  67.    * @param {!string} typeUrl a type URL of the corresponding Protobuf message
  68.    * @return {Observable<Message>} an observable of converted Protobuf messages
  69.    */
  70.   static map(observable, typeUrl) {
  71.     return observable.pipe(
  72.       map(object => ObjectToProto.convert(object, typeUrl))
  73.     );
  74.   }
  75. }