@openhps/protobuf 1.0.0

package/LICENSE

@@ -0,0 +1,190 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   Copyright 2019-2023 Maxim Van de Wynckel & Vrije Universiteit Brussel
+
+   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.

package/README.md

@@ -0,0 +1,165 @@
+<h1 align="center">
+  <img alt="OpenHPS" src="https://openhps.org/images/logo_text-512.png" width="40%" /><br />
+  @openhps/protobuf
+</h1>
+<p align="center">
+    <a href="https://github.com/OpenHPS/openhps-protobuf/actions/workflows/main.yml" target="_blank">
+        <img alt="Build Status" src="https://github.com/OpenHPS/openhps-protobuf/actions/workflows/main.yml/badge.svg">
+    </a>
+    <a href="https://codecov.io/gh/OpenHPS/openhps-protobuf">
+        <img src="https://codecov.io/gh/OpenHPS/openhps-protobuf/branch/master/graph/badge.svg?token=U896HUBDCZ"/>
+    </a>
+    <a href="https://codeclimate.com/github/OpenHPS/openhps-protobuf/" target="_blank">
+        <img alt="Maintainability" src="https://img.shields.io/codeclimate/maintainability/OpenHPS/openhps-protobuf">
+    </a>
+    <a href="https://badge.fury.io/js/@openhps%2Fprotobuf">
+        <img src="https://badge.fury.io/js/@openhps%2Fprotobuf.svg" alt="npm version" height="18">
+    </a>
+</p>
+
+<h3 align="center">
+    <a href="https://github.com/OpenHPS/openhps-core">@openhps/core</a> &mdash; <a href="https://openhps.org/docs/protobuf">API</a>
+</h3>
+
+<br />
+
+When serializing data generated by OpenHPS, the framework will use a modified serialization strategy of [TypedJSON](https://github.com/JohnWeisz/TypedJSON/) to convert the data to JSON format. This serialized JSON data can be used for socket, MQTT and REST communication when transmitting data from client to server. In real-time situations, JSON messages might be too large to transmit from embedded devices to a server. 
+
+[Protocol buffers](https://protobuf.dev/) are language-neutral and platform-neutral mechanisms for serializing structured data to lightweight buffers. Instead of encoding the structure of your data within the JSON data that is being serialized, a structured *message type* is defined beforehand that can be used by the serializer and deserializer. This structured *message type* will ensure that the data adheres to a specific structure while also prevent the need to encode this structure within the serialized data, lowering the size of the serialized data drastically.
+
+This OpenHPS module includes the serialization and deserialization engine for Protocol Buffer Messages to OpenHPS classes and object instances. In addition, this module provides a CLI tool for generating protocol message types of all OpenHPS modules installed in your project. Combined, these two features ensure that you do not have to manually create message types and do not manually have to create a custom deserialization strategy for each class you might need to serialize.
+
+## Features
+
+- Automatic protocol buffer message type generator
+- Serialization and deserialization of all serializable OpenHPS classes
+
+## Known Limitations/Workarounds
+
+- JavaScript only uses `Number` as a primitive. Protocol buffers use integers, floats, ... OpenHPS includes the `NumberType` enum option for `SerializableMember` decorators. When no number type is specified a number will be serialized to a string to ensure compatibility.
+- Polymorphism and inheritance is not possible in protocol buffer v3. In order to ensure maintainable messages, any serializable object with known types will be treated as a `google.protobuf.Any` type with an included `type_url` that can be used for deserialization. 
+- Objects that use generic types will also make use of `google.protobuf.Any`. However, generic types that include primitives will be serialized using a primitive wrapper. 
+
+## Usage
+
+### CLI Generator
+This module can generate the protocol files (*.proto) automatically. 
+
+1. Install the module using `npm install @openhps/protobuf@latest`
+2. Open the root directory of your project containing your `package.json` file
+3. Execute the CLI command using `openhps-protobuf`
+
+#### Parameters
+
+`-d <directory>`        Output directory\
+`-v`                    Verbose logging
+
+#### Output Data
+The output directory will include a subdirectory for each OpenHPS package.
+
+### Serialization and Deserialization
+First the protocol buffer serializer has to be initialized with the messages.
+```typescript
+import { ProtobufSerializer } from '@openhps/protobuf';
+
+// Initialize the protocol buffer serializer with the protocol files
+ProtobufSerializer.initialize("/home/openhps/protobuf/");
+
+// Or
+
+// Initialize the protocol buffer serialization by creating protocol messages in the ./tmp directory
+ProtobufSerializer.initialize();
+```
+
+An example protocol buffer message type can be seen below for a `DataObject`. The absolute and relative positions are set to an `Any` type.
+
+```proto
+package openhps.core;
+syntax = "proto3";
+import "google/protobuf/any.proto";
+message DataObject {
+	string displayName = 1;
+	int64 createdTimestamp = 2;
+	string uid = 3;
+	string parentUID = 4;
+	google.protobuf.Any position = 5;
+	repeated google.protobuf.Any relativePositions = 6;
+}
+```
+```proto
+package openhps.core;
+syntax = "proto3";
+import "Velocity.proto";
+import "Orientation.proto";
+import "google/protobuf/any.proto";
+message Absolute3DPosition {
+	string timestamp = 1;
+	Velocity velocity = 2;
+	Orientation orientation = 3;
+	google.protobuf.Any unit = 4;
+	string referenceSpaceUID = 5;
+	google.protobuf.Any accuracy = 6;
+	string probability = 7;
+	double x = 8;
+	double y = 9;
+	double z = 10;
+}
+
+```
+
+### @openhps/socket
+```ts
+ModelBuilder.create()
+	.addService(new SocketServer({
+		srv: server,
+		path: "/api/v1"
+	}))
+	.from(new SocketServerSource({
+		uid: "source",
+		// Override serializer and deserializer with protocol buffer
+		serialize: (obj) => ProtobufSerializer.serialize(obj),
+		deserialize: (obj) => ProtobufSerializer.deserialize(obj)
+	}))
+	.to()
+	.build();
+```
+
+### @openhps/mqtt
+```ts
+ModelBuilder.create()
+	.addService(new MQTTServer({
+		port: 1443,
+	}))
+	.from(new MQTTSourceNode({
+		uid: "source",
+		// Override frame serializer (not the options)
+		serialize: (obj, options) => ({
+			frame: ProtobufSerializer.serialize(obj),
+			options
+		}),
+		deserialize: (obj) => ProtobufSerializer.deserialize(obj.frame)
+	}))
+	.to()
+	.build();
+```
+
+## Getting Started
+If you have [npm installed](https://www.npmjs.com/get-npm), start using @openhps/protobuf with the following command.
+```bash
+npm install @openhps/protobuf --save
+```
+
+## Contributors
+The framework is open source and is mainly developed by PhD Student Maxim Van de Wynckel as part of his research towards *Hybrid Positioning and Implicit Human-Computer Interaction* under the supervision of Prof. Dr. Beat Signer.
+
+## Contributing
+Use of OpenHPS, contributions and feedback is highly appreciated. Please read our [contributing guidelines](CONTRIBUTING.md) for more information.
+
+## License
+Copyright (C) 2019-2024 Maxim Van de Wynckel & Vrije Universiteit Brussel
+
+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
+
+https://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.

package/dist/cjs/InternalProtobufDeserializer.js

@@ -0,0 +1,152 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalProtobufDeserializer = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@openhps/core");
+const protobuf = tslib_1.__importStar(require("protobufjs"));
+const typedjson_1 = require("typedjson");
+class InternalProtobufDeserializer extends core_1.Deserializer {
+    constructor() {
+        super();
+        InternalProtobufDeserializer.primitiveWrapper = new protobuf.Type('PrimitiveWrapperMessage');
+        InternalProtobufDeserializer.primitiveWrapper.add(new protobuf.Field('value', 1, 'string'));
+        this.setDeserializationStrategy(Number, (object) => {
+            if (typeof object === 'number') {
+                return object;
+            }
+            else if (typeof object === 'string') {
+                return Number(object);
+            }
+            else if (object.toNumber) {
+                return object.toNumber();
+            }
+            return object;
+        });
+        this.setDeserializationStrategy(Map, (object, typeDescriptor, knownTypes, memberName, deserializer, memberOptions, serializerOptions) => {
+            const result = new Map();
+            Object.keys(object).forEach((key) => {
+                result.set(key, deserializer.convertSingleValue(object[key], typeDescriptor.valueType, knownTypes, memberName, memberOptions, serializerOptions));
+            });
+            return result;
+        });
+    }
+    convertSingleValue(sourceObject, typeDescriptor, knownTypes, memberName, memberOptions, serializerOptions) {
+        if (this.retrievePreserveNull(memberOptions) && sourceObject === null) {
+            return null;
+        }
+        else if (!core_1.TypedJSON.utils.isValueDefined(sourceObject)) {
+            return;
+        }
+        const deserializer = this.deserializationStrategy.get(typeDescriptor.ctor);
+        if (deserializer !== undefined) {
+            return deserializer(sourceObject, typeDescriptor, knownTypes, memberName, this, memberOptions, serializerOptions);
+        }
+        if (typeof sourceObject === 'object') {
+            return this.convertAsObject(sourceObject, typeDescriptor, knownTypes, memberName, this, memberOptions, serializerOptions);
+        }
+        let error = `Could not deserialize '${memberName}'; don't know how to deserialize type`;
+        if (typeDescriptor.hasFriendlyName()) {
+            error += ` '${typeDescriptor.ctor.name}'`;
+        }
+        this.errorHandler(new TypeError(`${error}.`));
+    }
+    convertAsObject(sourceObject, typeDescriptor, knownTypes, memberName, deserializer, memberOptions, serializerOptions) {
+        let expectedSelfType = typeDescriptor.ctor;
+        let sourceObjectMetadata = typedjson_1.JsonObjectMetadata.getFromConstructor(expectedSelfType);
+        if (sourceObject.hasOwnProperty('_type') && sourceObject._type !== 0) {
+            const enumTypeClassname = sourceObjectMetadata.protobuf.enumMapping.get(sourceObject._type);
+            if (enumTypeClassname) {
+                const enumType = knownTypes.get(enumTypeClassname);
+                if (enumType !== expectedSelfType) {
+                    expectedSelfType = enumType;
+                    sourceObjectMetadata = typedjson_1.JsonObjectMetadata.getFromConstructor(expectedSelfType);
+                }
+            }
+        }
+        else if (sourceObject.type_url && sourceObject.value) {
+            const MessageType = serializerOptions.types.get(sourceObject.type_url);
+            const message = MessageType.decode(sourceObject.value);
+            const data = this.convertAsObject(message, new core_1.ConcreteTypeDescriptor(knownTypes.get(sourceObject.type_url)), knownTypes, memberName, deserializer, memberOptions, serializerOptions);
+            return data;
+        }
+        const sourceMetadata = sourceObjectMetadata;
+        // Strong-typed deserialization available, get to it.
+        // First deserialize properties into a temporary object.
+        const sourceObjectWithDeserializedProperties = {};
+        // Deserialize by expected properties.
+        sourceMetadata.dataMembers.forEach((objMemberMetadata, propKey) => {
+            var _a;
+            const objMemberDebugName = `${core_1.TypedJSON.utils.nameof(sourceMetadata.classType)}.${propKey}`;
+            const objMemberOptions = core_1.TypedJSON.options.mergeOptions(sourceMetadata.options, objMemberMetadata.options);
+            const memberName = (_a = (objMemberOptions && objMemberOptions.protobuf
+                ? objMemberOptions.protobuf.name
+                : objMemberMetadata.name)) !== null && _a !== void 0 ? _a : objMemberMetadata.name;
+            const objMemberValue = sourceObject[memberName];
+            let revivedValue;
+            if (objMemberMetadata.name === 'uid') {
+                if (sourceObject.hasOwnProperty('uid_bytes') && sourceObject['uid_bytes'].byteLength > 0) {
+                    revivedValue = core_1.UUID.fromBuffer(sourceObject['uid_bytes']).toString();
+                }
+                else if (sourceObject.hasOwnProperty('uid_string')) {
+                    revivedValue = sourceObject['uid_string'];
+                }
+                else {
+                    return;
+                }
+            }
+            else if (!sourceObject.hasOwnProperty(memberName) || !objMemberValue) {
+                return;
+            }
+            else if (objMemberMetadata.type() === typedjson_1.AnyT && objMemberValue.type_url) {
+                const MessageType = serializerOptions.types.get(sourceObject[memberName].type_url);
+                if (MessageType) {
+                    const message = MessageType.decode(objMemberValue.value);
+                    revivedValue = deserializer.convertSingleValue(message, new core_1.ConcreteTypeDescriptor(knownTypes.get(objMemberValue.type_url)), knownTypes, objMemberDebugName, objMemberOptions, serializerOptions);
+                }
+                else if (objMemberValue.value) {
+                    const message = InternalProtobufDeserializer.primitiveWrapper.decode(objMemberValue.value);
+                    switch (objMemberValue.type_url) {
+                        case 'Boolean':
+                            revivedValue = Boolean(message.value);
+                            break;
+                        case 'Number':
+                            revivedValue = Number(message.value);
+                            break;
+                        case 'String':
+                        default:
+                            revivedValue = message.value;
+                    }
+                }
+            }
+            else {
+                revivedValue = deserializer.convertSingleValue(objMemberValue, objMemberMetadata.type(), knownTypes, objMemberDebugName, objMemberOptions, serializerOptions);
+            }
+            if (core_1.TypedJSON.utils.isValueDefined(revivedValue)) {
+                sourceObjectWithDeserializedProperties[objMemberMetadata.key] = revivedValue;
+            }
+        });
+        // Next, instantiate target object.
+        const targetObject = deserializer.instantiateType(expectedSelfType);
+        // Finally, assign deserialized properties to target object.
+        Object.assign(targetObject, sourceObjectWithDeserializedProperties);
+        // Call onDeserialized method (if any).
+        const methodName = sourceObjectMetadata.onDeserializedMethodName;
+        if (methodName != null) {
+            if (typeof targetObject[methodName] === 'function') {
+                // check for member first
+                targetObject[methodName]();
+            }
+            else if (typeof targetObject.constructor[methodName] === 'function') {
+                // check for static
+                targetObject.constructor[methodName]();
+            }
+            else {
+                deserializer.getErrorHandler()(new TypeError(`onDeserialized callback` +
+                    `'${core_1.TypedJSON.utils.nameof(sourceObjectMetadata.classType)}.${methodName}' is not a method.`));
+            }
+        }
+        return targetObject;
+    }
+}
+exports.InternalProtobufDeserializer = InternalProtobufDeserializer;
+//# sourceMappingURL=InternalProtobufDeserializer.js.map

package/dist/cjs/InternalProtobufDeserializer.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"InternalProtobufDeserializer.js","sourceRoot":"","sources":["../../src/InternalProtobufDeserializer.ts"],"names":[],"mappings":";;;;AAAA,wCAWuB;AACvB,6DAAuC;AACvC,yCAAqD;AAErD,MAAa,4BAA6B,SAAQ,mBAAY;IAG1D;QACI,KAAK,EAAE,CAAC;QAER,4BAA4B,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAC,IAAI,CAAC,yBAAyB,CAAC,CAAC;QAC7F,4BAA4B,CAAC,gBAAgB,CAAC,GAAG,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,EAAE,QAAQ,CAAC,CAAC,CAAC;QAE5F,IAAI,CAAC,0BAA0B,CAAC,MAAM,EAAE,CAAC,MAAW,EAAE,EAAE;YACpD,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBAC7B,OAAO,MAAM,CAAC;YAClB,CAAC;iBAAM,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;gBACpC,OAAO,MAAM,CAAC,MAAM,CAAC,CAAC;YAC1B,CAAC;iBAAM,IAAI,MAAM,CAAC,QAAQ,EAAE,CAAC;gBACzB,OAAO,MAAM,CAAC,QAAQ,EAAE,CAAC;YAC7B,CAAC;YACD,OAAO,MAAM,CAAC;QAClB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,0BAA0B,CAC3B,GAAG,EACH,CACI,MAAW,EACX,cAAiC,EACjC,UAA0C,EAC1C,UAAkB,EAClB,YAA0B,EAC1B,aAAoC,EACpC,iBAAuB,EACzB,EAAE;YACA,MAAM,MAAM,GAAG,IAAI,GAAG,EAAE,CAAC;YACzB,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,CAAC,GAAG,EAAE,EAAE;gBAChC,MAAM,CAAC,GAAG,CACN,GAAG,EACH,YAAY,CAAC,kBAAkB,CAC3B,MAAM,CAAC,GAAG,CAAC,EACX,cAAc,CAAC,SAAS,EACxB,UAAU,EACV,UAAU,EACV,aAAa,EACb,iBAAiB,CACpB,CACJ,CAAC;YACN,CAAC,CAAC,CAAC;YACH,OAAO,MAAM,CAAC;QAClB,CAAC,CACJ,CAAC;IACN,CAAC;IAED,kBAAkB,CACd,YAAiB,EACjB,cAA8B,EAC9B,UAA0C,EAC1C,UAAmB,EACnB,aAAoC,EACpC,iBAAuB;QAEvB,IAAI,IAAI,CAAC,oBAAoB,CAAC,aAAa,CAAC,IAAI,YAAY,KAAK,IAAI,EAAE,CAAC;YACpE,OAAO,IAAI,CAAC;QAChB,CAAC;aAAM,IAAI,CAAC,gBAAS,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC;YACvD,OAAO;QACX,CAAC;QAED,MAAM,YAAY,GAAG,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,CAAC,CAAC;QAC3E,IAAI,YAAY,KAAK,SAAS,EAAE,CAAC;YAC7B,OAAO,YAAY,CACf,YAAY,EACZ,cAAc,EACd,UAAU,EACV,UAAU,EACV,IAAI,EACJ,aAAa,EACb,iBAAiB,CACpB,CAAC;QACN,CAAC;QAED,IAAI,OAAO,YAAY,KAAK,QAAQ,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,eAAe,CACvB,YAAY,EACZ,cAAc,EACd,UAAU,EACV,UAAU,EACV,IAAI,EACJ,aAAa,EACb,iBAAiB,CACpB,CAAC;QACN,CAAC;QAED,IAAI,KAAK,GAAG,0BAA0B,UAAU,uCAAuC,CAAC;QAExF,IAAI,cAAc,CAAC,eAAe,EAAE,EAAE,CAAC;YACnC,KAAK,IAAI,KAAK,cAAc,CAAC,IAAI,CAAC,IAAI,GAAG,CAAC;QAC9C,CAAC;QAED,IAAI,CAAC,YAAY,CAAC,IAAI,SAAS,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAAC;IAClD,CAAC;IAED,eAAe,CACX,YAA2B,EAC3B,cAAsC,EACtC,UAA0C,EAC1C,UAAkB,EAClB,YAA0C,EAC1C,aAAoC,EACpC,iBAAuB;QAEvB,IAAI,gBAAgB,GAAG,cAAc,CAAC,IAAI,CAAC;QAC3C,IAAI,oBAAoB,GAAmB,8BAAkB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;QACnG,IAAI,YAAY,CAAC,cAAc,CAAC,OAAO,CAAC,IAAI,YAAY,CAAC,KAAK,KAAK,CAAC,EAAE,CAAC;YACnE,MAAM,iBAAiB,GAAG,oBAAoB,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YAC5F,IAAI,iBAAiB,EAAE,CAAC;gBACpB,MAAM,QAAQ,GAAG,UAAU,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;gBACnD,IAAI,QAAQ,KAAK,gBAAgB,EAAE,CAAC;oBAChC,gBAAgB,GAAG,QAAQ,CAAC;oBAC5B,oBAAoB,GAAG,8BAAkB,CAAC,kBAAkB,CAAC,gBAAgB,CAAC,CAAC;gBACnF,CAAC;YACL,CAAC;QACL,CAAC;aAAM,IAAI,YAAY,CAAC,QAAQ,IAAI,YAAY,CAAC,KAAK,EAAE,CAAC;YACrD,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAkB,CAAC;YACxF,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;YACvD,MAAM,IAAI,GAAG,IAAI,CAAC,eAAe,CAC7B,OAAO,EACP,IAAI,6BAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,EACjE,UAAU,EACV,UAAU,EACV,YAAY,EACZ,aAAa,EACb,iBAAiB,CACpB,CAAC;YACF,OAAO,IAAI,CAAC;QAChB,CAAC;QAED,MAAM,cAAc,GAAG,oBAAoB,CAAC;QAC5C,qDAAqD;QACrD,wDAAwD;QACxD,MAAM,sCAAsC,GAAG,EAAmB,CAAC;QAEnE,sCAAsC;QACtC,cAAc,CAAC,WAAW,CAAC,OAAO,CAAC,CAAC,iBAAiB,EAAE,OAAO,EAAE,EAAE;;YAC9D,MAAM,kBAAkB,GAAG,GAAG,gBAAS,CAAC,KAAK,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,CAAC;YAC5F,MAAM,gBAAgB,GAAG,gBAAS,CAAC,OAAO,CAAC,YAAY,CAAC,cAAc,CAAC,OAAO,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;YAC3G,MAAM,UAAU,GACZ,MAAA,CAAC,gBAAgB,IAAI,gBAAgB,CAAC,QAAQ;gBAC1C,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,IAAI;gBAChC,CAAC,CAAC,iBAAiB,CAAC,IAAI,CAAC,mCAAI,iBAAiB,CAAC,IAAI,CAAC;YAC5D,MAAM,cAAc,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC;YAEhD,IAAI,YAAY,CAAC;YACjB,IAAI,iBAAiB,CAAC,IAAI,KAAK,KAAK,EAAE,CAAC;gBACnC,IAAI,YAAY,CAAC,cAAc,CAAC,WAAW,CAAC,IAAI,YAAY,CAAC,WAAW,CAAC,CAAC,UAAU,GAAG,CAAC,EAAE,CAAC;oBACvF,YAAY,GAAG,WAAI,CAAC,UAAU,CAAC,YAAY,CAAC,WAAW,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACzE,CAAC;qBAAM,IAAI,YAAY,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC;oBACnD,YAAY,GAAG,YAAY,CAAC,YAAY,CAAC,CAAC;gBAC9C,CAAC;qBAAM,CAAC;oBACJ,OAAO;gBACX,CAAC;YACL,CAAC;iBAAM,IAAI,CAAC,YAAY,CAAC,cAAc,CAAC,UAAU,CAAC,IAAI,CAAC,cAAc,EAAE,CAAC;gBACrE,OAAO;YACX,CAAC;iBAAM,IAAI,iBAAiB,CAAC,IAAI,EAAE,KAAK,gBAAI,IAAI,cAAc,CAAC,QAAQ,EAAE,CAAC;gBACtE,MAAM,WAAW,GAAG,iBAAiB,CAAC,KAAK,CAAC,GAAG,CAAC,YAAY,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAkB,CAAC;gBACpG,IAAI,WAAW,EAAE,CAAC;oBACd,MAAM,OAAO,GAAG,WAAW,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,CAAC;oBACzD,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAC1C,OAAO,EACP,IAAI,6BAAsB,CAAC,UAAU,CAAC,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,EACnE,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,CACpB,CAAC;gBACN,CAAC;qBAAM,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;oBAC9B,MAAM,OAAO,GAAG,4BAA4B,CAAC,gBAAgB,CAAC,MAAM,CAAC,cAAc,CAAC,KAAK,CAAQ,CAAC;oBAClG,QAAQ,cAAc,CAAC,QAAQ,EAAE,CAAC;wBAC9B,KAAK,SAAS;4BACV,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;4BACtC,MAAM;wBACV,KAAK,QAAQ;4BACT,YAAY,GAAG,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;4BACrC,MAAM;wBACV,KAAK,QAAQ,CAAC;wBACd;4BACI,YAAY,GAAG,OAAO,CAAC,KAAK,CAAC;oBACrC,CAAC;gBACL,CAAC;YACL,CAAC;iBAAM,CAAC;gBACJ,YAAY,GAAG,YAAY,CAAC,kBAAkB,CAC1C,cAAc,EACd,iBAAiB,CAAC,IAAI,EAAE,EACxB,UAAU,EACV,kBAAkB,EAClB,gBAAgB,EAChB,iBAAiB,CACpB,CAAC;YACN,CAAC;YAED,IAAI,gBAAS,CAAC,KAAK,CAAC,cAAc,CAAC,YAAY,CAAC,EAAE,CAAC;gBAC/C,sCAAsC,CAAC,iBAAiB,CAAC,GAAG,CAAC,GAAG,YAAY,CAAC;YACjF,CAAC;QACL,CAAC,CAAC,CAAC;QAEH,mCAAmC;QACnC,MAAM,YAAY,GAAkB,YAAY,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;QAEnF,4DAA4D;QAC5D,MAAM,CAAC,MAAM,CAAC,YAAY,EAAE,sCAAsC,CAAC,CAAC;QAEpE,uCAAuC;QACvC,MAAM,UAAU,GAAG,oBAAoB,CAAC,wBAAwB,CAAC;QACjE,IAAI,UAAU,IAAI,IAAI,EAAE,CAAC;YACrB,IAAI,OAAQ,YAAoB,CAAC,UAAU,CAAC,KAAK,UAAU,EAAE,CAAC;gBAC1D,yBAAyB;gBACxB,YAAoB,CAAC,UAAU,CAAC,EAAE,CAAC;YACxC,CAAC;iBAAM,IAAI,OAAQ,YAAY,CAAC,WAAmB,CAAC,UAAU,CAAC,KAAK,UAAU,EAAE,CAAC;gBAC7E,mBAAmB;gBAClB,YAAY,CAAC,WAAmB,CAAC,UAAU,CAAC,EAAE,CAAC;YACpD,CAAC;iBAAM,CAAC;gBACJ,YAAY,CAAC,eAAe,EAAE,CAC1B,IAAI,SAAS,CACT,yBAAyB;oBACrB,IAAI,gBAAS,CAAC,KAAK,CAAC,MAAM,CACtB,oBAAoB,CAAC,SAAS,CACjC,IAAI,UAAU,oBAAoB,CAC1C,CACJ,CAAC;YACN,CAAC;QACL,CAAC;QAED,OAAO,YAAY,CAAC;IACxB,CAAC;CACJ;AArOD,oEAqOC"}

package/dist/cjs/InternalProtobufSerializer.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InternalProtobufSerializer = void 0;
+const tslib_1 = require("tslib");
+const core_1 = require("@openhps/core");
+const typedjson_1 = require("typedjson");
+const protobuf = tslib_1.__importStar(require("protobufjs"));
+class InternalProtobufSerializer extends core_1.Serializer {
+    constructor() {
+        super();
+        this.setSerializationStrategy(Map, this.convertAsMap.bind(this));
+        InternalProtobufSerializer.primitiveWrapper = new protobuf.Type('PrimitiveWrapperMessage');
+        InternalProtobufSerializer.primitiveWrapper.add(new protobuf.Field('value', 1, 'string'));
+    }
+    convertSingleValue(sourceObject, typeDescriptor, memberName, memberOptions, serializerOptions) {
+        if (!core_1.TypedJSON.utils.isValueDefined(sourceObject)) {
+            return;
+        }
+        if (!core_1.TypedJSON.utils.isInstanceOf(sourceObject, typeDescriptor.ctor)) {
+            const expectedName = core_1.TypedJSON.utils.nameof(typeDescriptor.ctor);
+            const actualName = core_1.TypedJSON.utils.nameof(sourceObject.constructor);
+            this.errorHandler(new TypeError(`Could not serialize '${memberName}': expected '${expectedName}',` + ` got '${actualName}'.`));
+            return;
+        }
+        const serializer = this.serializationStrategy.get(typeDescriptor.ctor);
+        if (serializer !== undefined) {
+            return serializer(sourceObject, typeDescriptor, memberName, this, memberOptions, serializerOptions);
+        }
+        // if not present in the strategy do property by property serialization
+        if (typeof sourceObject === 'object') {
+            return this.convertAsObject(sourceObject, typeDescriptor, memberName, this, memberOptions, serializerOptions);
+        }
+        let error = `Could not serialize '${memberName}'; don't know how to serialize type`;
+        if (typeDescriptor.hasFriendlyName()) {
+            error += ` '${typeDescriptor.ctor.name}'`;
+        }
+        this.errorHandler(new TypeError(`${error}.`));
+    }
+    convertAsObject(sourceObject, typeDescriptor, memberName, serializer, memberOptions, serializerOptions) {
+        const typeMetadata = typedjson_1.JsonObjectMetadata.getFromConstructor(typeDescriptor.ctor);
+        let sourceTypeMetadata = typedjson_1.JsonObjectMetadata.getFromConstructor(sourceObject.constructor);
+        if (!sourceTypeMetadata) {
+            sourceTypeMetadata = typeMetadata;
+        }
+        let targetObject;
+        const sourceMeta = sourceTypeMetadata;
+        targetObject = {};
+        const classOptions = core_1.TypedJSON.options.mergeOptions(serializer.options, sourceMeta.options);
+        sourceMeta.dataMembers.forEach((objMemberMetadata) => {
+            var _a;
+            const objMemberOptions = core_1.TypedJSON.options.mergeOptions(classOptions, objMemberMetadata.options);
+            let serialized;
+            let memberName = (_a = (objMemberOptions && objMemberOptions.protobuf
+                ? objMemberOptions.protobuf.name
+                : objMemberMetadata.name)) !== null && _a !== void 0 ? _a : objMemberMetadata.name;
+            if (sourceObject[objMemberMetadata.key] === undefined) {
+                return;
+            }
+            if (objMemberMetadata.type == null) {
+                throw new TypeError(`Could not serialize ${objMemberMetadata.name}, there is` +
+                    ` no constructor nor serialization function to use.`);
+            }
+            else if (objMemberMetadata.name === 'uid') {
+                const uuid = core_1.UUID.fromString(sourceObject[objMemberMetadata.key]);
+                if (uuid) {
+                    serialized = uuid.toBuffer();
+                    memberName += '_bytes';
+                }
+                else {
+                    serialized = sourceObject[objMemberMetadata.key];
+                    memberName += '_string';
+                }
+            }
+            else {
+                const MessageType = sourceTypeMetadata.protobuf.messageType;
+                const field = MessageType.get(objMemberMetadata.name);
+                serialized = this.convertSingleValue(sourceObject[objMemberMetadata.key], objMemberMetadata.type(), `${core_1.TypedJSON.utils.nameof(sourceMeta.classType)}.${objMemberMetadata.key}`, objMemberOptions, Object.assign(Object.assign({}, serializerOptions), { field }));
+            }
+            if (core_1.TypedJSON.utils.isValueDefined(serialized)) {
+                if (objMemberMetadata.type() === typedjson_1.AnyT) {
+                    const MessageType = serializerOptions.types.get(sourceObject[objMemberMetadata.key].constructor.name);
+                    if (MessageType) {
+                        const message = MessageType.create(serialized);
+                        serialized = {
+                            type_url: sourceObject[objMemberMetadata.key].constructor.name,
+                            value: MessageType.encode(message).finish(),
+                        };
+                    }
+                    else {
+                        const message = InternalProtobufSerializer.primitiveWrapper.create({
+                            value: String(sourceObject[objMemberMetadata.key]),
+                        });
+                        serialized = {
+                            type_url: sourceObject[objMemberMetadata.key].constructor.name,
+                            value: InternalProtobufSerializer.primitiveWrapper.encode(message).finish(),
+                        };
+                    }
+                }
+                targetObject[memberName] = serialized;
+            }
+        });
+        const isAnyField = serializerOptions.field && serializerOptions.field.type === 'google.protobuf.Any';
+        if (!isAnyField && typeMetadata.knownTypes.size > 1) {
+            const MessageType = sourceTypeMetadata.protobuf.messageType;
+            const message = MessageType.create(Object.assign(Object.assign({}, targetObject), { _type: sourceTypeMetadata.protobuf.messageTypeEnum }));
+            targetObject = message;
+        }
+        else if (isAnyField) {
+            const MessageType = sourceTypeMetadata.protobuf.messageType;
+            const message = MessageType.create(targetObject);
+            targetObject = {
+                type_url: sourceObject.constructor.name,
+                value: MessageType.encode(message).finish(),
+            };
+        }
+        return targetObject;
+    }
+    /**
+     * Performs the conversion of a map of typed objects (or primitive values) into an array
+     * of simple javascript objects with `key` and `value` properties.
+     * @param sourceObject
+     * @param typeDescriptor
+     * @param memberName
+     * @param serializer
+     * @param memberOptions
+     * @param serializerOptions
+     */
+    convertAsMap(sourceObject, typeDescriptor, memberName, serializer, memberOptions, serializerOptions) {
+        const result = {};
+        sourceObject.forEach((value, key) => {
+            result[key] = serializer.convertSingleValue(value, typeDescriptor.valueType, memberName, memberOptions, serializerOptions);
+        });
+        return result;
+    }
+}
+exports.InternalProtobufSerializer = InternalProtobufSerializer;
+//# sourceMappingURL=InternalProtobufSerializer.js.map