protobufjs 6.8.4 → 6.8.8

package/ext/descriptor/index.d.ts

@@ -1,5 +1,4 @@
 import * as $protobuf from "../..";
-
 export const FileDescriptorSet: $protobuf.Type;
 
 export const FileDescriptorProto: $protobuf.Type;

package/ext/descriptor/index.js

@@ -96,6 +96,9 @@ Root.fromDescriptor = function fromDescriptor(descriptor) {
             if (fileDescriptor.extension)
                 for (i = 0; i < fileDescriptor.extension.length; ++i)
                     filePackage.add(Field.fromDescriptor(fileDescriptor.extension[i]));
+            if (fileDescriptor.service)
+                for (i = 0; i < fileDescriptor.service.length; ++i)
+                    filePackage.add(Service.fromDescriptor(fileDescriptor.service[i]));
             var opts = fromDescriptorOptions(fileDescriptor.options, exports.FileOptions);
             if (opts) {
                 var ks = Object.keys(opts);

package/index.d.ts

@@ -1,3 +1,5 @@
+// DO NOT EDIT! This is a generated file. Edit the JSDoc in src/*.js instead and run 'npm run types'.
+
 export as namespace protobuf;
 
 /**
@@ -105,6 +107,7 @@ export namespace common {
      * - google/protobuf/any.proto
      * - google/protobuf/duration.proto
      * - google/protobuf/empty.proto
+     * - google/protobuf/field_mask.proto
      * - google/protobuf/struct.proto
      * - google/protobuf/timestamp.proto
      * - google/protobuf/wrappers.proto
@@ -155,8 +158,10 @@ export class Enum extends ReflectionObject {
      * @param name Unique name within its namespace
      * @param [values] Enum values as an object, by name
      * @param [options] Declared options
+     * @param [comment] The comment for this enum
+     * @param [comments] The value comments for this enum
      */
-    constructor(name: string, values?: { [k: string]: number }, options?: { [k: string]: any });
+    constructor(name: string, values?: { [k: string]: number }, options?: { [k: string]: any }, comment?: string, comments?: { [k: string]: string });
 
     /** Enum values by id. */
     public valuesById: { [k: number]: string };
@@ -164,6 +169,9 @@ export class Enum extends ReflectionObject {
     /** Enum values by name. */
     public values: { [k: string]: number };
 
+    /** Enum comment text. */
+    public comment: (string|null);
+
     /** Value comment texts, if any. */
     public comments: { [k: string]: string };
 
@@ -181,9 +189,10 @@ export class Enum extends ReflectionObject {
 
     /**
      * Converts this enum to an enum descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Enum descriptor
      */
-    public toJSON(): IEnum;
+    public toJSON(toJSONOptions?: IToJSONOptions): IEnum;
 
     /**
      * Adds a value to this enum.
@@ -287,8 +296,9 @@ export class FieldBase extends ReflectionObject {
      * @param [rule="optional"] Field rule
      * @param [extend] Extended type if different from parent
      * @param [options] Declared options
+     * @param [comment] Comment associated with this field
      */
-    constructor(name: string, id: number, type: string, rule?: (string|{ [k: string]: any }), extend?: (string|{ [k: string]: any }), options?: { [k: string]: any });
+    constructor(name: string, id: number, type: string, rule?: (string|{ [k: string]: any }), extend?: (string|{ [k: string]: any }), options?: { [k: string]: any }, comment?: string);
 
     /** Field rule, if any. */
     public rule?: string;
@@ -341,11 +351,15 @@ export class FieldBase extends ReflectionObject {
     /** Sister-field within the declaring namespace if an extended field. */
     public declaringField: (Field|null);
 
+    /** Comment for this field. */
+    public comment: (string|null);
+
     /**
      * Converts this field to a field descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Field descriptor
      */
-    public toJSON(): IField;
+    public toJSON(toJSONOptions?: IToJSONOptions): IField;
 
     /**
      * Resolves this field's type references.
@@ -444,8 +458,9 @@ export class MapField extends FieldBase {
      * @param keyType Key type
      * @param type Value type
      * @param [options] Declared options
+     * @param [comment] Comment associated with this field
      */
-    constructor(name: string, id: number, keyType: string, type: string, options?: { [k: string]: any });
+    constructor(name: string, id: number, keyType: string, type: string, options?: { [k: string]: any }, comment?: string);
 
     /** Key type. */
     public keyType: string;
@@ -464,9 +479,10 @@ export class MapField extends FieldBase {
 
     /**
      * Converts this map field to a map field descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Map field descriptor
      */
-    public toJSON(): IMapField;
+    public toJSON(toJSONOptions?: IToJSONOptions): IMapField;
 
     /**
      * Map field decorator (TypeScript).
@@ -493,7 +509,7 @@ export interface IExtensionMapField extends IMapField {
 }
 
 /** Abstract runtime message. */
-export class Message<T extends object> {
+export class Message<T extends object = object> {
 
     /**
      * Constructs a new message instance.
@@ -585,8 +601,9 @@ export class Method extends ReflectionObject {
      * @param [requestStream] Whether the request is streamed
      * @param [responseStream] Whether the response is streamed
      * @param [options] Declared options
+     * @param [comment] The comment for this method
      */
-    constructor(name: string, type: (string|undefined), requestType: string, responseType: string, requestStream?: (boolean|{ [k: string]: any }), responseStream?: (boolean|{ [k: string]: any }), options?: { [k: string]: any });
+    constructor(name: string, type: (string|undefined), requestType: string, responseType: string, requestStream?: (boolean|{ [k: string]: any }), responseStream?: (boolean|{ [k: string]: any }), options?: { [k: string]: any }, comment?: string);
 
     /** Method type. */
     public type: string;
@@ -609,6 +626,9 @@ export class Method extends ReflectionObject {
     /** Resolved response type. */
     public resolvedResponseType: (Type|null);
 
+    /** Comment for this method */
+    public comment: (string|null);
+
     /**
      * Constructs a method from a method descriptor.
      * @param name Method name
@@ -620,9 +640,10 @@ export class Method extends ReflectionObject {
 
     /**
      * Converts this method to a method descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Method descriptor
      */
-    public toJSON(): IMethod;
+    public toJSON(toJSONOptions?: IToJSONOptions): IMethod;
 }
 
 /** Method descriptor. */
@@ -669,9 +690,10 @@ export class Namespace extends NamespaceBase {
     /**
      * Converts an array of reflection objects to JSON.
      * @param array Object array
+     * @param [toJSONOptions] JSON conversion options
      * @returns JSON object or `undefined` when array is empty
      */
-    public static arrayToJSON(array: ReflectionObject[]): ({ [k: string]: any }|undefined);
+    public static arrayToJSON(array: ReflectionObject[], toJSONOptions?: IToJSONOptions): ({ [k: string]: any }|undefined);
 
     /**
      * Tests if the specified id is reserved.
@@ -701,9 +723,10 @@ export abstract class NamespaceBase extends ReflectionObject {
 
     /**
      * Converts this namespace to a namespace descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Namespace descriptor
      */
-    public toJSON(): INamespace;
+    public toJSON(toJSONOptions?: IToJSONOptions): INamespace;
 
     /**
      * Adds nested objects to this namespace from nested object descriptors.
@@ -920,8 +943,9 @@ export class OneOf extends ReflectionObject {
      * @param name Oneof name
      * @param [fieldNames] Field names
      * @param [options] Declared options
+     * @param [comment] Comment associated with this field
      */
-    constructor(name: string, fieldNames?: (string[]|{ [k: string]: any }), options?: { [k: string]: any });
+    constructor(name: string, fieldNames?: (string[]|{ [k: string]: any }), options?: { [k: string]: any }, comment?: string);
 
     /** Field names that belong to this oneof. */
     public oneof: string[];
@@ -929,6 +953,9 @@ export class OneOf extends ReflectionObject {
     /** Fields that belong to this oneof as an array for iteration. */
     public readonly fieldsArray: Field[];
 
+    /** Comment for this field. */
+    public comment: (string|null);
+
     /**
      * Constructs a oneof from a oneof descriptor.
      * @param name Oneof name
@@ -940,9 +967,10 @@ export class OneOf extends ReflectionObject {
 
     /**
      * Converts this oneof to a oneof descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Oneof descriptor
      */
-    public toJSON(): IOneOf;
+    public toJSON(toJSONOptions?: IToJSONOptions): IOneOf;
 
     /**
      * Adds a field to this oneof and removes it from its current parent, if any.
@@ -1015,6 +1043,16 @@ export interface IParseOptions {
 
     /** Keeps field casing instead of converting to camel case */
     keepCase?: boolean;
+
+    /** Recognize double-slash comments in addition to doc-block comments. */
+    alternateCommentMode?: boolean;
+}
+
+/** Options modifying the behavior of JSON serialization. */
+export interface IToJSONOptions {
+
+    /** Serializes comments. */
+    keepComments?: boolean;
 }
 
 /**
@@ -1344,9 +1382,10 @@ export class Service extends NamespaceBase {
 
     /**
      * Converts this service to a service descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Service descriptor
      */
-    public toJSON(): IService;
+    public toJSON(toJSONOptions?: IToJSONOptions): IService;
 
     /** Methods of this service as an array for iteration. */
     public readonly methodsArray: Method[];
@@ -1427,9 +1466,10 @@ export interface ITokenizerHandle {
 /**
  * Tokenizes the given .proto source and returns an object with useful utility functions.
  * @param source Source contents
+ * @param alternateCommentMode Whether we should activate alternate comment parsing mode.
  * @returns Tokenizer handle
  */
-export function tokenize(source: string): ITokenizerHandle;
+export function tokenize(source: string, alternateCommentMode: boolean): ITokenizerHandle;
 
 export namespace tokenize {
 
@@ -1495,9 +1535,10 @@ export class Type extends NamespaceBase {
 
     /**
      * Converts this message type to a message type descriptor.
+     * @param [toJSONOptions] JSON conversion options
      * @returns Message type descriptor
      */
-    public toJSON(): IType;
+    public toJSON(toJSONOptions?: IToJSONOptions): IType;
 
     /**
      * Adds a nested object to this type.