Source: client/parser/type-parsers.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 ObjectParser from './object-parser';
  30. import {wellKnownParsers} from './well-known-parsers';
  32. /**
  33.  * The registry of parsers for known Protobuf types.
  34.  *
  35.  * <p>Parsers for {@link wellKnownParsers standard} Protobuf types are provided by the Spine Web
  36.  * and automatically registered.
  37.  *
  38.  * <p>Other parsers are generated by the Protobuf plugin for Javascript and should be registered
  39.  * by the users of the class.
  40.  */
  41. export default class TypeParsers {
  43.   constructor() {
  44.     throw new Error('TypeParsers is not supposed to be instantiated.');
  45.   }
  47.   /**
  48.    * Registers the parser for a type.
  49.    *
  50.    * @param {!ObjectParser} parser the parser instance to register
  51.    * @param {!string} typeUrl the URL of the type to register the parser for
  52.    */
  53.   static register(parser, typeUrl) {
  54.     this._checkParser(parser, typeUrl);
  55.     if (!parsers.has(typeUrl)) {
  56.       parsers.set(typeUrl, parser);
  57.     }
  58.   }
  60.   /**
  61.    * Obtains a parser by the specified type URL.
  62.    *
  63.    * @param {!string} typeUrl the type URL to get the parser
  64.    * @returns {!ObjectParser} the parser instance for the type
  65.    */
  66.   static parserFor(typeUrl) {
  67.     const parser = parsers.get(typeUrl);
  68.     if (parser === undefined) {
  69.       throw new Error(`The parser for ${typeUrl} was not found.`);
  70.     }
  71.     return parser;
  72.   }
  74.   static _checkParser(parser, typeUrl) {
  75.     if (!ObjectParser.isParser(parser)) {
  76.       throw new Error(`Unable to register parser for ${typeUrl}. Should extend ObjectParser.`);
  77.     }
  78.   }
  79. }
  81. /**
  82.  * Register parsers for standard Protobuf types.
  83.  */
  84. function registerWellKnownParsers() {
  85.   for (let [typeUrl, parser] of wellKnownParsers) {
  86.     TypeParsers.register(parser, typeUrl);
  87.   }
  88. }
  90. /**
  91.  * The map of all Protobuf parsers known to the application.
  92.  *
  93.  * <p>It is intended to be a static variable, but ES6 doesn't provide an easy way to do it.
  94.  *
  95.  * @type {Map<String, ObjectParser>}
  96.  * @private
  97.  */
  98. const parsers = new Map();
  100. registerWellKnownParsers();