protobufjs 8.6.1 → 8.6.2

package/ext/README.md

@@ -1,70 +1,70 @@
-# protobuf.js Extensions
-
-## descriptor
-
-Optional `descriptor.proto` support for converting reflected protobuf.js roots and objects to and from descriptor messages.
-
-```js
-import protobuf from "protobufjs";
-import descriptor from "protobufjs/ext/descriptor.js";
-
-// Convert an existing root to a FileDescriptorSet message.
-const root = ...;
-const set = root.toDescriptor("proto2");
-
-// Encode descriptor buffers.
-const buffer = descriptor.FileDescriptorSet.encode(set).finish();
-
-// Convert a FileDescriptorSet message or buffer back to a root.
-const decodedRoot = protobuf.Root.fromDescriptor(buffer);
-```
-
-The extension requires reflection metadata and also works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
-
-Importing the extension adds `.fromDescriptor(descriptor[, editionOrContext])` and `#toDescriptor([syntaxOrEdition])` methods to reflection objects and exports the bundled descriptor types from `google.protobuf`. Descriptor inputs can be decoded messages, readers, or buffers of the corresponding descriptor messages. Direct object descriptor imports accept either an edition string or a descriptor context with `edition`, `features` and `keepCase`.
-
-The conversion covers descriptor messages that correspond to protobuf.js reflection objects: files and file sets, messages, fields and map fields, oneofs, enums, services and methods. Descriptor-only metadata such as source locations, generated-code annotations and uninterpreted options remains available through the exported descriptor message types, but is not mapped onto reflection objects. File names are inferred when generating descriptors because roots do not retain exact file/package boundaries.
-
-## protojson
-
-Optional ProtoJSON support for reflected message types.
-
-> [!NOTE]
-> Specialized code generation for the `pbjs` static-module target is a potential future extension. If you need this for high-throughput JSON transcoding or REST fallbacks in production, consider getting in touch and supporting the codegen and conformance work.
-
-```js
-import protobuf from "protobufjs";
-import protojson from "protobufjs/ext/protojson.js";
-
-const root = ...;
-const MyType = root.lookupType("MyType");
-const message = protojson.fromJson(MyType, { value: 1 });
-const json = protojson.toJson(MyType, message);
-```
-
-```js
-const messageFromString = protojson.fromJsonString(MyType, '{"value":1}');
-const jsonString = protojson.toJsonString(MyType, messageFromString);
-```
-
-Importing the extension has no prototype side effects. Calling `protojson.install()` installs `fromJson`, `fromJsonString`, `toJson` and `toJsonString` convenience methods on `protobuf.Type.prototype`. It works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
-
-Unknown fields can be ignored while parsing by passing `{ ignoreUnknownFields: true }` to `fromJson` or `fromJsonString`.
-
-## textformat
-
-Optional Text Format support for reflected message types.
-
-```js
-import protobuf from "protobufjs";
-import textformat from "protobufjs/ext/textformat.js";
-
-const root = ...;
-const MyType = root.lookupType("MyType");
-const message = textformat.fromText(MyType, "value: 1");
-const text = textformat.toText(MyType, message);
-```
-
-Importing the extension has no prototype side effects. Calling `textformat.install()` installs `fromText` and `toText` convenience methods on `protobuf.Type.prototype`. It works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
-
-Unknown fields can be printed with numeric field names by passing `{ unknowns: true }` to `toText`.
+# protobuf.js Extensions
+
+## descriptor
+
+Optional `descriptor.proto` support for converting reflected protobuf.js roots and objects to and from descriptor messages.
+
+```js
+import protobuf from "protobufjs";
+import descriptor from "protobufjs/ext/descriptor.js";
+
+// Convert an existing root to a FileDescriptorSet message.
+const root = ...;
+const set = root.toDescriptor("proto2");
+
+// Encode descriptor buffers.
+const buffer = descriptor.FileDescriptorSet.encode(set).finish();
+
+// Convert a FileDescriptorSet message or buffer back to a root.
+const decodedRoot = protobuf.Root.fromDescriptor(buffer);
+```
+
+The extension requires reflection metadata and also works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
+
+Importing the extension adds `.fromDescriptor(descriptor[, editionOrContext])` and `#toDescriptor([syntaxOrEdition])` methods to reflection objects and exports the bundled descriptor types from `google.protobuf`. Descriptor inputs can be decoded messages, readers, or buffers of the corresponding descriptor messages. Direct object descriptor imports accept either an edition string or a descriptor context with `edition`, `features` and `keepCase`.
+
+The conversion covers descriptor messages that correspond to protobuf.js reflection objects: files and file sets, messages, fields and map fields, oneofs, enums, services and methods. Descriptor-only metadata such as source locations, generated-code annotations and uninterpreted options remains available through the exported descriptor message types, but is not mapped onto reflection objects. File names are inferred when generating descriptors because roots do not retain exact file/package boundaries.
+
+## protojson
+
+Optional ProtoJSON support for reflected message types.
+
+> [!NOTE]
+> Specialized code generation for the `pbjs` static-module target is a potential future extension. If you need this for high-throughput JSON transcoding or REST fallbacks in production, consider getting in touch and supporting the codegen and conformance work.
+
+```js
+import protobuf from "protobufjs";
+import protojson from "protobufjs/ext/protojson.js";
+
+const root = ...;
+const MyType = root.lookupType("MyType");
+const message = protojson.fromJson(MyType, { value: 1 });
+const json = protojson.toJson(MyType, message);
+```
+
+```js
+const messageFromString = protojson.fromJsonString(MyType, '{"value":1}');
+const jsonString = protojson.toJsonString(MyType, messageFromString);
+```
+
+Importing the extension has no prototype side effects. Calling `protojson.install()` installs `fromJson`, `fromJsonString`, `toJson` and `toJsonString` convenience methods on `protobuf.Type.prototype`. It works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
+
+Unknown fields can be ignored while parsing by passing `{ ignoreUnknownFields: true }` to `fromJson` or `fromJsonString`.
+
+## textformat
+
+Optional Text Format support for reflected message types.
+
+```js
+import protobuf from "protobufjs";
+import textformat from "protobufjs/ext/textformat.js";
+
+const root = ...;
+const MyType = root.lookupType("MyType");
+const message = textformat.fromText(MyType, "value: 1");
+const text = textformat.toText(MyType, message);
+```
+
+Importing the extension has no prototype side effects. Calling `textformat.install()` installs `fromText` and `toText` convenience methods on `protobuf.Type.prototype`. It works with `protobufjs/light.js` when schemas are loaded from JSON or otherwise provided as reflection objects.
+
+Unknown fields can be printed with numeric field names by passing `{ unknowns: true }` to `toText`.

package/ext/debug/README.md

@@ -1,4 +1,4 @@
-protobufjs/ext/debug
-=========================
-
-Experimental debugging extension.
+protobufjs/ext/debug
+=========================
+
+Experimental debugging extension.

package/ext/debug/index.js

@@ -1,71 +1,71 @@
-"use strict";
-var protobuf = require("../..");
-
-/**
- * Debugging utility functions. Only present in debug builds.
- * @namespace
- */
-var debug = protobuf.debug = module.exports = {};
-
-var codegen = protobuf.util.codegen;
-
-var debugFnRe = /function ([^(]+)\(([^)]*)\) {/g;
-
-// Counts number of calls to any generated function
-function codegen_debug() {
-    codegen_debug.supported = codegen.supported;
-    codegen_debug.verbose = codegen.verbose;
-    var gen = codegen.apply(null, Array.prototype.slice.call(arguments));
-    gen.str = (function(str) { return function str_debug() {
-        return str.apply(null, Array.prototype.slice.call(arguments)).replace(debugFnRe, "function $1($2) {\n\t$1.calls=($1.calls|0)+1");
-    };})(gen.str);
-    return gen;
-}
-
-/**
- * Returns a list of unused types within the specified root.
- * @param {NamespaceBase} ns Namespace to search
- * @returns {Type[]} Unused types
- */
-debug.unusedTypes = function unusedTypes(ns) {
-
-    /* istanbul ignore if */
-    if (!(ns instanceof protobuf.Namespace))
-        throw TypeError("ns must be a Namespace");
-
-    /* istanbul ignore if */
-    if (!ns.nested)
-        return [];
-
-    var unused = [];
-    for (var names = Object.keys(ns.nested), i = 0; i < names.length; ++i) {
-        var nested = ns.nested[names[i]];
-        if (nested instanceof protobuf.Type) {
-            var calls = (nested.encode.calls|0)
-                      + (nested.decode.calls|0)
-                      + (nested.verify.calls|0)
-                      + (nested.toObject.calls|0)
-                      + (nested.fromObject.calls|0);
-            if (!calls)
-                unused.push(nested);
-        } else if (nested instanceof protobuf.Namespace)
-            Array.prototype.push.apply(unused, unusedTypes(nested));
-    }
-    return unused;
-};
-
-/**
- * Enables debugging extensions.
- * @returns {undefined}
- */
-debug.enable = function enable() {
-    protobuf.util.codegen = codegen_debug;
-};
-
-/**
- * Disables debugging extensions.
- * @returns {undefined}
- */
-debug.disable = function disable() {
-    protobuf.util.codegen = codegen;
-};
+"use strict";
+var protobuf = require("../..");
+
+/**
+ * Debugging utility functions. Only present in debug builds.
+ * @namespace
+ */
+var debug = protobuf.debug = module.exports = {};
+
+var codegen = protobuf.util.codegen;
+
+var debugFnRe = /function ([^(]+)\(([^)]*)\) {/g;
+
+// Counts number of calls to any generated function
+function codegen_debug() {
+    codegen_debug.supported = codegen.supported;
+    codegen_debug.verbose = codegen.verbose;
+    var gen = codegen.apply(null, Array.prototype.slice.call(arguments));
+    gen.str = (function(str) { return function str_debug() {
+        return str.apply(null, Array.prototype.slice.call(arguments)).replace(debugFnRe, "function $1($2) {\n\t$1.calls=($1.calls|0)+1");
+    };})(gen.str);
+    return gen;
+}
+
+/**
+ * Returns a list of unused types within the specified root.
+ * @param {NamespaceBase} ns Namespace to search
+ * @returns {Type[]} Unused types
+ */
+debug.unusedTypes = function unusedTypes(ns) {
+
+    /* istanbul ignore if */
+    if (!(ns instanceof protobuf.Namespace))
+        throw TypeError("ns must be a Namespace");
+
+    /* istanbul ignore if */
+    if (!ns.nested)
+        return [];
+
+    var unused = [];
+    for (var names = Object.keys(ns.nested), i = 0; i < names.length; ++i) {
+        var nested = ns.nested[names[i]];
+        if (nested instanceof protobuf.Type) {
+            var calls = (nested.encode.calls|0)
+                      + (nested.decode.calls|0)
+                      + (nested.verify.calls|0)
+                      + (nested.toObject.calls|0)
+                      + (nested.fromObject.calls|0);
+            if (!calls)
+                unused.push(nested);
+        } else if (nested instanceof protobuf.Namespace)
+            Array.prototype.push.apply(unused, unusedTypes(nested));
+    }
+    return unused;
+};
+
+/**
+ * Enables debugging extensions.
+ * @returns {undefined}
+ */
+debug.enable = function enable() {
+    protobuf.util.codegen = codegen_debug;
+};
+
+/**
+ * Disables debugging extensions.
+ * @returns {undefined}
+ */
+debug.disable = function disable() {
+    protobuf.util.codegen = codegen;
+};

package/ext/descriptor/README.md

@@ -1,5 +1,5 @@
-# protobufjs/ext/descriptor
-
-This directory is kept as a backwards-compatible shim for `protobufjs/ext/descriptor` and may be removed in a future major release.
-
-The descriptor extension documentation now lives in [../README.md](../README.md#descriptor).
+# protobufjs/ext/descriptor
+
+This directory is kept as a backwards-compatible shim for `protobufjs/ext/descriptor` and may be removed in a future major release.
+
+The descriptor extension documentation now lives in [../README.md](../README.md#descriptor).

package/ext/descriptor/index.d.ts

@@ -1,2 +1,2 @@
-import * as $protobuf from "../..";
-import Long = require("long");
+import * as $protobuf from "../..";
+import Long = require("long");

package/ext/descriptor/index.js

@@ -1,2 +1,2 @@
-"use strict";
-module.exports = require("../descriptor");
+"use strict";
+module.exports = require("../descriptor");

package/ext/descriptor.d.ts

@@ -1,87 +1,87 @@
-import * as $protobuf from "..";
-import {
-    IDescriptorProto,
-    IDescriptorContext,
-    IEnumDescriptorProto,
-    IFieldDescriptorProto,
-    IFileDescriptorSet,
-    IMethodDescriptorProto,
-    IOneofDescriptorProto,
-    IServiceDescriptorProto
-} from "./descriptor.generated";
-
-export * from "./descriptor.generated";
-
-type DescriptorInput<T> = T | $protobuf.Reader | Uint8Array;
-
-declare module ".." {
-    namespace Root {
-        /** Creates a root from a descriptor set. */
-        function fromDescriptor(descriptor: DescriptorInput<IFileDescriptorSet>, options?: { keepCase?: boolean }): $protobuf.Root;
-    }
-
-    interface Root {
-        /** Converts this root to a descriptor set. */
-        toDescriptor(edition?: string): $protobuf.Message<IFileDescriptorSet> & IFileDescriptorSet;
-    }
-
-    namespace Type {
-        /** Creates a type from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Type;
-    }
-
-    interface Type {
-        /** Converts this type to a descriptor. */
-        toDescriptor(edition?: string): $protobuf.Message<IDescriptorProto> & IDescriptorProto;
-    }
-
-    namespace Field {
-        /** Creates a field from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IFieldDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Field;
-    }
-
-    interface Field {
-        /** Converts this field to a descriptor. */
-        toDescriptor(edition?: string): $protobuf.Message<IFieldDescriptorProto> & IFieldDescriptorProto;
-    }
-
-    namespace Enum {
-        /** Creates an enum from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IEnumDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Enum;
-    }
-
-    interface Enum {
-        /** Converts this enum to a descriptor. */
-        toDescriptor(): $protobuf.Message<IEnumDescriptorProto> & IEnumDescriptorProto;
-    }
-
-    namespace OneOf {
-        /** Creates a oneof from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IOneofDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.OneOf;
-    }
-
-    interface OneOf {
-        /** Converts this oneof to a descriptor. */
-        toDescriptor(): $protobuf.Message<IOneofDescriptorProto> & IOneofDescriptorProto;
-    }
-
-    namespace Service {
-        /** Creates a service from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IServiceDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Service;
-    }
-
-    interface Service {
-        /** Converts this service to a descriptor. */
-        toDescriptor(): $protobuf.Message<IServiceDescriptorProto> & IServiceDescriptorProto;
-    }
-
-    namespace Method {
-        /** Creates a method from a descriptor. */
-        function fromDescriptor(descriptor: DescriptorInput<IMethodDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Method;
-    }
-
-    interface Method {
-        /** Converts this method to a descriptor. */
-        toDescriptor(): $protobuf.Message<IMethodDescriptorProto> & IMethodDescriptorProto;
-    }
-}
+import * as $protobuf from "..";
+import {
+    IDescriptorProto,
+    IDescriptorContext,
+    IEnumDescriptorProto,
+    IFieldDescriptorProto,
+    IFileDescriptorSet,
+    IMethodDescriptorProto,
+    IOneofDescriptorProto,
+    IServiceDescriptorProto
+} from "./descriptor.generated";
+
+export * from "./descriptor.generated";
+
+type DescriptorInput<T> = T | $protobuf.Reader | Uint8Array;
+
+declare module ".." {
+    namespace Root {
+        /** Creates a root from a descriptor set. */
+        function fromDescriptor(descriptor: DescriptorInput<IFileDescriptorSet>, options?: { keepCase?: boolean }): $protobuf.Root;
+    }
+
+    interface Root {
+        /** Converts this root to a descriptor set. */
+        toDescriptor(edition?: string): $protobuf.Message<IFileDescriptorSet> & IFileDescriptorSet;
+    }
+
+    namespace Type {
+        /** Creates a type from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Type;
+    }
+
+    interface Type {
+        /** Converts this type to a descriptor. */
+        toDescriptor(edition?: string): $protobuf.Message<IDescriptorProto> & IDescriptorProto;
+    }
+
+    namespace Field {
+        /** Creates a field from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IFieldDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Field;
+    }
+
+    interface Field {
+        /** Converts this field to a descriptor. */
+        toDescriptor(edition?: string): $protobuf.Message<IFieldDescriptorProto> & IFieldDescriptorProto;
+    }
+
+    namespace Enum {
+        /** Creates an enum from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IEnumDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Enum;
+    }
+
+    interface Enum {
+        /** Converts this enum to a descriptor. */
+        toDescriptor(): $protobuf.Message<IEnumDescriptorProto> & IEnumDescriptorProto;
+    }
+
+    namespace OneOf {
+        /** Creates a oneof from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IOneofDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.OneOf;
+    }
+
+    interface OneOf {
+        /** Converts this oneof to a descriptor. */
+        toDescriptor(): $protobuf.Message<IOneofDescriptorProto> & IOneofDescriptorProto;
+    }
+
+    namespace Service {
+        /** Creates a service from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IServiceDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Service;
+    }
+
+    interface Service {
+        /** Converts this service to a descriptor. */
+        toDescriptor(): $protobuf.Message<IServiceDescriptorProto> & IServiceDescriptorProto;
+    }
+
+    namespace Method {
+        /** Creates a method from a descriptor. */
+        function fromDescriptor(descriptor: DescriptorInput<IMethodDescriptorProto>, editionOrContext?: string | IDescriptorContext): $protobuf.Method;
+    }
+
+    interface Method {
+        /** Converts this method to a descriptor. */
+        toDescriptor(): $protobuf.Message<IMethodDescriptorProto> & IMethodDescriptorProto;
+    }
+}