@bufbuild/protoplugin 1.4.0 → 1.4.2

package/dist/cjs/ecmascript/index.d.ts

@@ -1,8 +1,9 @@
+export { reifyWkt } from "./reify-wkt.js";
 export { Target } from "./target.js";
 export { Schema } from "./schema.js";
 export { RuntimeImports } from "./runtime-imports.js";
 export { GeneratedFile, FileInfo, Printable } from "./generated-file.js";
 export { ImportSymbol } from "./import-symbol.js";
-export declare const localName: typeof import("@bufbuild/protobuf/dist/cjs/private/names.js").localName, reifyWkt: typeof import("@bufbuild/protobuf/dist/cjs/private/reify-wkt.js").reifyWkt;
+export declare const localName: (desc: import("@bufbuild/protobuf").DescEnum | import("@bufbuild/protobuf").DescMessage | import("@bufbuild/protobuf").DescService | import("@bufbuild/protobuf").DescEnumValue | import("@bufbuild/protobuf").DescField | import("@bufbuild/protobuf").DescOneof | import("@bufbuild/protobuf").DescMethod) => string;
 export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";
 export { findCustomScalarOption, findCustomMessageOption, findCustomEnumOption, } from "./custom-options.js";

package/dist/cjs/ecmascript/index.js

@@ -13,9 +13,11 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.findCustomEnumOption = exports.findCustomMessageOption = exports.findCustomScalarOption = exports.literalString = exports.makeJsDoc = exports.getFieldTyping = exports.getFieldIntrinsicDefaultValue = exports.getFieldExplicitDefaultValue = exports.createJsDocBlock = exports.reifyWkt = exports.localName = void 0;
+exports.findCustomEnumOption = exports.findCustomMessageOption = exports.findCustomScalarOption = exports.literalString = exports.makeJsDoc = exports.getFieldTyping = exports.getFieldIntrinsicDefaultValue = exports.getFieldExplicitDefaultValue = exports.createJsDocBlock = exports.localName = exports.reifyWkt = void 0;
 const protobuf_1 = require("@bufbuild/protobuf");
-exports.localName = protobuf_1.codegenInfo.localName, exports.reifyWkt = protobuf_1.codegenInfo.reifyWkt;
+var reify_wkt_js_1 = require("./reify-wkt.js");
+Object.defineProperty(exports, "reifyWkt", { enumerable: true, get: function () { return reify_wkt_js_1.reifyWkt; } });
+exports.localName = protobuf_1.codegenInfo.localName;
 var gencommon_js_1 = require("./gencommon.js");
 Object.defineProperty(exports, "createJsDocBlock", { enumerable: true, get: function () { return gencommon_js_1.createJsDocBlock; } });
 Object.defineProperty(exports, "getFieldExplicitDefaultValue", { enumerable: true, get: function () { return gencommon_js_1.getFieldExplicitDefaultValue; } });

package/dist/cjs/ecmascript/reify-wkt.d.ts

@@ -0,0 +1,100 @@
+import type { DescField, DescMessage, DescOneof } from "@bufbuild/protobuf";
+type DescWkt = {
+    typeName: "google.protobuf.Any";
+    typeUrl: DescField;
+    value: DescField;
+} | {
+    typeName: "google.protobuf.Timestamp";
+    seconds: DescField;
+    nanos: DescField;
+} | {
+    typeName: "google.protobuf.Duration";
+    seconds: DescField;
+    nanos: DescField;
+} | {
+    typeName: "google.protobuf.Struct";
+    fields: DescField & {
+        fieldKind: "map";
+    };
+} | {
+    typeName: "google.protobuf.Value";
+    kind: DescOneof;
+    nullValue: DescField & {
+        fieldKind: "enum";
+    };
+    numberValue: DescField;
+    stringValue: DescField;
+    boolValue: DescField;
+    structValue: DescField & {
+        fieldKind: "message";
+    };
+    listValue: DescField & {
+        fieldKind: "message";
+    };
+} | {
+    typeName: "google.protobuf.ListValue";
+    values: DescField & {
+        fieldKind: "message";
+    };
+} | {
+    typeName: "google.protobuf.FieldMask";
+    paths: DescField;
+} | {
+    typeName: "google.protobuf.DoubleValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.FloatValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.Int64Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.UInt64Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.Int32Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.UInt32Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.BoolValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.StringValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.BytesValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+};
+/**
+ * Reifies a given DescMessage into a more concrete object representing its
+ * respective well-known type.  The returned object will contain properties
+ * representing the WKT's defined fields.
+ *
+ * Useful during code generation when immediate access to a particular field
+ * is needed without having to search the object's typename and DescField list.
+ *
+ * Returns undefined if the WKT cannot be completely constructed via the
+ * DescMessage.
+ */
+export declare function reifyWkt(message: DescMessage): DescWkt | undefined;
+export {};

package/dist/cjs/ecmascript/reify-wkt.js

@@ -0,0 +1,170 @@
+"use strict";
+// Copyright 2021-2023 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.reifyWkt = void 0;
+const protobuf_1 = require("@bufbuild/protobuf");
+/**
+ * Reifies a given DescMessage into a more concrete object representing its
+ * respective well-known type.  The returned object will contain properties
+ * representing the WKT's defined fields.
+ *
+ * Useful during code generation when immediate access to a particular field
+ * is needed without having to search the object's typename and DescField list.
+ *
+ * Returns undefined if the WKT cannot be completely constructed via the
+ * DescMessage.
+ */
+function reifyWkt(message) {
+    switch (message.typeName) {
+        case "google.protobuf.Any": {
+            const typeUrl = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.STRING);
+            const value = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.BYTES);
+            if (typeUrl && value) {
+                return {
+                    typeName: message.typeName,
+                    typeUrl,
+                    value,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Timestamp": {
+            const seconds = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.INT32);
+            if (seconds && nanos) {
+                return {
+                    typeName: message.typeName,
+                    seconds,
+                    nanos,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Duration": {
+            const seconds = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.INT32);
+            if (seconds && nanos) {
+                return {
+                    typeName: message.typeName,
+                    seconds,
+                    nanos,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Struct": {
+            const fields = message.fields.find((f) => f.number == 1 && !f.repeated);
+            if ((fields === null || fields === void 0 ? void 0 : fields.fieldKind) !== "map" ||
+                fields.mapValue.kind !== "message" ||
+                fields.mapValue.message.typeName !== "google.protobuf.Value") {
+                break;
+            }
+            return { typeName: message.typeName, fields };
+        }
+        case "google.protobuf.Value": {
+            const kind = message.oneofs.find((o) => o.name === "kind");
+            const nullValue = message.fields.find((f) => f.number == 1 && f.oneof === kind);
+            if ((nullValue === null || nullValue === void 0 ? void 0 : nullValue.fieldKind) !== "enum" ||
+                nullValue.enum.typeName !== "google.protobuf.NullValue") {
+                return undefined;
+            }
+            const numberValue = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.DOUBLE &&
+                f.oneof === kind);
+            const stringValue = message.fields.find((f) => f.number == 3 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.STRING &&
+                f.oneof === kind);
+            const boolValue = message.fields.find((f) => f.number == 4 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.BOOL &&
+                f.oneof === kind);
+            const structValue = message.fields.find((f) => f.number == 5 && f.oneof === kind);
+            if ((structValue === null || structValue === void 0 ? void 0 : structValue.fieldKind) !== "message" ||
+                structValue.message.typeName !== "google.protobuf.Struct") {
+                return undefined;
+            }
+            const listValue = message.fields.find((f) => f.number == 6 && f.oneof === kind);
+            if ((listValue === null || listValue === void 0 ? void 0 : listValue.fieldKind) !== "message" ||
+                listValue.message.typeName !== "google.protobuf.ListValue") {
+                return undefined;
+            }
+            if (kind && numberValue && stringValue && boolValue) {
+                return {
+                    typeName: message.typeName,
+                    kind,
+                    nullValue,
+                    numberValue,
+                    stringValue,
+                    boolValue,
+                    structValue,
+                    listValue,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.ListValue": {
+            const values = message.fields.find((f) => f.number == 1 && f.repeated);
+            if ((values === null || values === void 0 ? void 0 : values.fieldKind) != "message" ||
+                values.message.typeName !== "google.protobuf.Value") {
+                break;
+            }
+            return { typeName: message.typeName, values };
+        }
+        case "google.protobuf.FieldMask": {
+            const paths = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === protobuf_1.ScalarType.STRING &&
+                f.repeated);
+            if (paths) {
+                return { typeName: message.typeName, paths };
+            }
+            break;
+        }
+        case "google.protobuf.DoubleValue":
+        case "google.protobuf.FloatValue":
+        case "google.protobuf.Int64Value":
+        case "google.protobuf.UInt64Value":
+        case "google.protobuf.Int32Value":
+        case "google.protobuf.UInt32Value":
+        case "google.protobuf.BoolValue":
+        case "google.protobuf.StringValue":
+        case "google.protobuf.BytesValue": {
+            const value = message.fields.find((f) => f.number == 1 && f.name == "value");
+            if (!value) {
+                break;
+            }
+            if (value.fieldKind !== "scalar") {
+                break;
+            }
+            return { typeName: message.typeName, value };
+        }
+    }
+    return undefined;
+}
+exports.reifyWkt = reifyWkt;

package/dist/esm/ecmascript/index.d.ts

@@ -1,8 +1,9 @@
+export { reifyWkt } from "./reify-wkt.js";
 export { Target } from "./target.js";
 export { Schema } from "./schema.js";
 export { RuntimeImports } from "./runtime-imports.js";
 export { GeneratedFile, FileInfo, Printable } from "./generated-file.js";
 export { ImportSymbol } from "./import-symbol.js";
-export declare const localName: typeof import("@bufbuild/protobuf/dist/cjs/private/names.js").localName, reifyWkt: typeof import("@bufbuild/protobuf/dist/cjs/private/reify-wkt.js").reifyWkt;
+export declare const localName: (desc: import("@bufbuild/protobuf").DescEnum | import("@bufbuild/protobuf").DescMessage | import("@bufbuild/protobuf").DescService | import("@bufbuild/protobuf").DescEnumValue | import("@bufbuild/protobuf").DescField | import("@bufbuild/protobuf").DescOneof | import("@bufbuild/protobuf").DescMethod) => string;
 export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";
 export { findCustomScalarOption, findCustomMessageOption, findCustomEnumOption, } from "./custom-options.js";

package/dist/esm/ecmascript/index.js

@@ -12,6 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { codegenInfo } from "@bufbuild/protobuf";
-export const { localName, reifyWkt } = codegenInfo;
+export { reifyWkt } from "./reify-wkt.js";
+export const { localName } = codegenInfo;
 export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";
 export { findCustomScalarOption, findCustomMessageOption, findCustomEnumOption, } from "./custom-options.js";

package/dist/esm/ecmascript/reify-wkt.d.ts

@@ -0,0 +1,100 @@
+import type { DescField, DescMessage, DescOneof } from "@bufbuild/protobuf";
+type DescWkt = {
+    typeName: "google.protobuf.Any";
+    typeUrl: DescField;
+    value: DescField;
+} | {
+    typeName: "google.protobuf.Timestamp";
+    seconds: DescField;
+    nanos: DescField;
+} | {
+    typeName: "google.protobuf.Duration";
+    seconds: DescField;
+    nanos: DescField;
+} | {
+    typeName: "google.protobuf.Struct";
+    fields: DescField & {
+        fieldKind: "map";
+    };
+} | {
+    typeName: "google.protobuf.Value";
+    kind: DescOneof;
+    nullValue: DescField & {
+        fieldKind: "enum";
+    };
+    numberValue: DescField;
+    stringValue: DescField;
+    boolValue: DescField;
+    structValue: DescField & {
+        fieldKind: "message";
+    };
+    listValue: DescField & {
+        fieldKind: "message";
+    };
+} | {
+    typeName: "google.protobuf.ListValue";
+    values: DescField & {
+        fieldKind: "message";
+    };
+} | {
+    typeName: "google.protobuf.FieldMask";
+    paths: DescField;
+} | {
+    typeName: "google.protobuf.DoubleValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.FloatValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.Int64Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.UInt64Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.Int32Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.UInt32Value";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.BoolValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.StringValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+} | {
+    typeName: "google.protobuf.BytesValue";
+    value: DescField & {
+        fieldKind: "scalar";
+    };
+};
+/**
+ * Reifies a given DescMessage into a more concrete object representing its
+ * respective well-known type.  The returned object will contain properties
+ * representing the WKT's defined fields.
+ *
+ * Useful during code generation when immediate access to a particular field
+ * is needed without having to search the object's typename and DescField list.
+ *
+ * Returns undefined if the WKT cannot be completely constructed via the
+ * DescMessage.
+ */
+export declare function reifyWkt(message: DescMessage): DescWkt | undefined;
+export {};

package/dist/esm/ecmascript/reify-wkt.js

@@ -0,0 +1,166 @@
+// Copyright 2021-2023 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.
+import { ScalarType } from "@bufbuild/protobuf";
+/**
+ * Reifies a given DescMessage into a more concrete object representing its
+ * respective well-known type.  The returned object will contain properties
+ * representing the WKT's defined fields.
+ *
+ * Useful during code generation when immediate access to a particular field
+ * is needed without having to search the object's typename and DescField list.
+ *
+ * Returns undefined if the WKT cannot be completely constructed via the
+ * DescMessage.
+ */
+export function reifyWkt(message) {
+    switch (message.typeName) {
+        case "google.protobuf.Any": {
+            const typeUrl = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.STRING);
+            const value = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.BYTES);
+            if (typeUrl && value) {
+                return {
+                    typeName: message.typeName,
+                    typeUrl,
+                    value,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Timestamp": {
+            const seconds = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.INT32);
+            if (seconds && nanos) {
+                return {
+                    typeName: message.typeName,
+                    seconds,
+                    nanos,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Duration": {
+            const seconds = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.INT64);
+            const nanos = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.INT32);
+            if (seconds && nanos) {
+                return {
+                    typeName: message.typeName,
+                    seconds,
+                    nanos,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.Struct": {
+            const fields = message.fields.find((f) => f.number == 1 && !f.repeated);
+            if ((fields === null || fields === void 0 ? void 0 : fields.fieldKind) !== "map" ||
+                fields.mapValue.kind !== "message" ||
+                fields.mapValue.message.typeName !== "google.protobuf.Value") {
+                break;
+            }
+            return { typeName: message.typeName, fields };
+        }
+        case "google.protobuf.Value": {
+            const kind = message.oneofs.find((o) => o.name === "kind");
+            const nullValue = message.fields.find((f) => f.number == 1 && f.oneof === kind);
+            if ((nullValue === null || nullValue === void 0 ? void 0 : nullValue.fieldKind) !== "enum" ||
+                nullValue.enum.typeName !== "google.protobuf.NullValue") {
+                return undefined;
+            }
+            const numberValue = message.fields.find((f) => f.number == 2 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.DOUBLE &&
+                f.oneof === kind);
+            const stringValue = message.fields.find((f) => f.number == 3 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.STRING &&
+                f.oneof === kind);
+            const boolValue = message.fields.find((f) => f.number == 4 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.BOOL &&
+                f.oneof === kind);
+            const structValue = message.fields.find((f) => f.number == 5 && f.oneof === kind);
+            if ((structValue === null || structValue === void 0 ? void 0 : structValue.fieldKind) !== "message" ||
+                structValue.message.typeName !== "google.protobuf.Struct") {
+                return undefined;
+            }
+            const listValue = message.fields.find((f) => f.number == 6 && f.oneof === kind);
+            if ((listValue === null || listValue === void 0 ? void 0 : listValue.fieldKind) !== "message" ||
+                listValue.message.typeName !== "google.protobuf.ListValue") {
+                return undefined;
+            }
+            if (kind && numberValue && stringValue && boolValue) {
+                return {
+                    typeName: message.typeName,
+                    kind,
+                    nullValue,
+                    numberValue,
+                    stringValue,
+                    boolValue,
+                    structValue,
+                    listValue,
+                };
+            }
+            break;
+        }
+        case "google.protobuf.ListValue": {
+            const values = message.fields.find((f) => f.number == 1 && f.repeated);
+            if ((values === null || values === void 0 ? void 0 : values.fieldKind) != "message" ||
+                values.message.typeName !== "google.protobuf.Value") {
+                break;
+            }
+            return { typeName: message.typeName, values };
+        }
+        case "google.protobuf.FieldMask": {
+            const paths = message.fields.find((f) => f.number == 1 &&
+                f.fieldKind == "scalar" &&
+                f.scalar === ScalarType.STRING &&
+                f.repeated);
+            if (paths) {
+                return { typeName: message.typeName, paths };
+            }
+            break;
+        }
+        case "google.protobuf.DoubleValue":
+        case "google.protobuf.FloatValue":
+        case "google.protobuf.Int64Value":
+        case "google.protobuf.UInt64Value":
+        case "google.protobuf.Int32Value":
+        case "google.protobuf.UInt32Value":
+        case "google.protobuf.BoolValue":
+        case "google.protobuf.StringValue":
+        case "google.protobuf.BytesValue": {
+            const value = message.fields.find((f) => f.number == 1 && f.name == "value");
+            if (!value) {
+                break;
+            }
+            if (value.fieldKind !== "scalar") {
+                break;
+            }
+            return { typeName: message.typeName, value };
+        }
+    }
+    return undefined;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "1.4.0",
+  "version": "1.4.2",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "repository": {
@@ -39,7 +39,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "1.4.0",
+    "@bufbuild/protobuf": "1.4.2",
     "@typescript/vfs": "^1.4.0",
     "typescript": "4.5.2"
   },