@bufbuild/protobuf
Version:
A complete implementation of Protocol Buffers in TypeScript, suitable for web browsers and Node.js.
111 lines (110 loc) • 3.15 kB
JavaScript
;
// Copyright 2021-2025 Buf Technologies, Inc.
//
// 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.
Object.defineProperty(exports, "__esModule", { value: true });
exports.nestedTypes = nestedTypes;
exports.usedTypes = usedTypes;
exports.parentTypes = parentTypes;
/**
* Iterate over all types - enumerations, extensions, services, messages -
* and enumerations, extensions and messages nested in messages.
*/
function* nestedTypes(desc) {
switch (desc.kind) {
case "file":
for (const message of desc.messages) {
yield message;
yield* nestedTypes(message);
}
yield* desc.enums;
yield* desc.services;
yield* desc.extensions;
break;
case "message":
for (const message of desc.nestedMessages) {
yield message;
yield* nestedTypes(message);
}
yield* desc.nestedEnums;
yield* desc.nestedExtensions;
break;
}
}
/**
* Iterate over types referenced by fields of the given message.
*
* For example:
*
* ```proto
* syntax="proto3";
*
* message Example {
* Msg singular = 1;
* repeated Level list = 2;
* }
*
* message Msg {}
*
* enum Level {
* LEVEL_UNSPECIFIED = 0;
* }
* ```
*
* The message Example references the message Msg, and the enum Level.
*/
function usedTypes(descMessage) {
return usedTypesInternal(descMessage, new Set());
}
function* usedTypesInternal(descMessage, seen) {
var _a, _b;
for (const field of descMessage.fields) {
const ref = (_b = (_a = field.enum) !== null && _a !== void 0 ? _a : field.message) !== null && _b !== void 0 ? _b : undefined;
if (!ref || seen.has(ref.typeName)) {
continue;
}
seen.add(ref.typeName);
yield ref;
if (ref.kind == "message") {
yield* usedTypesInternal(ref, seen);
}
}
}
/**
* Returns the ancestors of a given Protobuf element, up to the file.
*/
function parentTypes(desc) {
const parents = [];
while (desc.kind !== "file") {
const p = parent(desc);
desc = p;
parents.push(p);
}
return parents;
}
function parent(desc) {
var _a;
switch (desc.kind) {
case "enum_value":
case "field":
case "oneof":
case "rpc":
return desc.parent;
case "service":
return desc.file;
case "extension":
case "enum":
case "message":
return (_a = desc.parent) !== null && _a !== void 0 ? _a : desc.file;
}
}