Source: client/known-types.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. /**
  30.  * The map of all Protobuf types known to the application.
  31.  *
  32.  * <p>It is intended to be a static variable, but ES6 doesn't provide an easy way to do it.
  33.  *
  34.  * @type {Map<String, Class>}
  35.  * @private
  36.  */
  37. const types = new Map();
  39. /**
  40.  * All Protobuf types known to the application.
  41.  *
  42.  * <p>This class serves as the registry of types generated by Protobuf complier.
  43.  */
  44. export default class KnownTypes {
  46.   constructor() {
  47.     throw new Error('KnownTypes is not supposed to be instantiated.');
  48.   }
  50.   /**
  51.    * Obtains the type URL for the Protobuf type.
  52.    *
  53.    * @param {!Class} messageClass the class of a Protobuf message or enum
  54.    * @return {!string} the type URL
  55.    * @public
  56.    */
  57.   static typeUrlFor(messageClass) {
  58.     return messageClass.typeUrl();
  59.   }
  61.   /**
  62.    * Obtains JS class for the given Protobuf type URL.
  63.    *
  64.    * @param {!string} typeUrl the type URL
  65.    * @return {!Class} class of this Protobuf type
  66.    * @public
  67.    */
  68.   static classFor(typeUrl) {
  69.     const cls = types.get(typeUrl);
  70.     if (cls === null || cls === undefined) {
  71.       throw new Error(`Class for type URL '${typeUrl}' is not found.`);
  72.     }
  73.     return cls;
  74.   }
  76.   /**
  77.    * Registers the type as a known type.
  78.    *
  79.    * @param {!Class} type the class of a Protobuf message or enum
  80.    * @param {!string} typeUrl the URL of the type
  81.    */
  82.   static register(type, typeUrl) {
  83.     if (!KnownTypes.hasType(typeUrl)) {
  84.       types.set(typeUrl, type);
  85.     }
  86.   }
  88.   /**
  89.    * Tells whether the specified type URL is present among known types.
  90.    *
  91.    * @param {!string} typeUrl the type URL to check
  92.    */
  93.   static hasType(typeUrl) {
  94.     return types.has(typeUrl);
  95.   }
  97.   /**
  98.    * Removes all the types.
  99.    *
  100.    * The method is purposed for the testing.
  101.    */
  102.   static clear() {
  103.     types.clear();
  104.   }
  105. }