@bufbuild/protoplugin 1.7.1 → 1.8.0

package/dist/esm/ecmascript/{gencommon.js → legacy-gencommon.js}

@@ -11,67 +11,26 @@
 // 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 { codegenInfo, Edition, LongType, ScalarType, } from "@bufbuild/protobuf";
-const { localName, getUnwrappedFieldType, scalarDefaultValue } = codegenInfo;
-export function makeFilePreamble(file, pluginName, pluginVersion, parameter, tsNoCheck) {
-    const builder = [];
-    const trimSuffix = (str, suffix) => str.endsWith(suffix) ? str.substring(0, str.length - suffix.length) : str;
-    const writeLeadingComments = (comments) => {
-        for (let comment of comments.leadingDetached) {
-            comment = trimSuffix(comment, "\n");
-            for (const line of comment.split("\n")) {
-                builder.push(`//${line}\n`);
-            }
-            builder.push("\n");
-        }
-        if (comments.leading !== undefined) {
-            const comment = trimSuffix(comments.leading, "\n");
-            for (const line of comment.split("\n")) {
-                builder.push(`//${line}\n`);
-            }
-            builder.push("\n");
-        }
-    };
-    writeLeadingComments(file.getSyntaxComments());
-    builder.push(`// @generated by ${pluginName} ${pluginVersion}`);
-    if (parameter !== "") {
-        builder.push(` with parameter "${parameter}"`);
-    }
-    builder.push("\n");
-    builder.push(`// @generated from file ${file.name}.proto (`);
-    if (file.proto.package !== undefined) {
-        builder.push(`package ${file.proto.package}, `);
-    }
-    switch (file.edition) {
-        case Edition.EDITION_PROTO2:
-            builder.push(`syntax proto2)\n`);
-            break;
-        case Edition.EDITION_PROTO3:
-            builder.push(`syntax proto3)\n`);
-            break;
-        default: {
-            const editionString = Edition[file.edition];
-            if (typeof editionString == "string") {
-                const e = editionString.replace("EDITION_", "").toLowerCase();
-                builder.push(`edition ${e})\n`);
-            }
-            else {
-                builder.push(`unknown edition\n`);
-            }
-            break;
-        }
-    }
-    builder.push("/* eslint-disable */\n");
-    if (tsNoCheck) {
-        builder.push("// @ts-nocheck\n");
-    }
-    builder.push("\n");
-    writeLeadingComments(file.getPackageComments());
-    return trimSuffix(builder.join(""), "\n");
+import { codegenInfo, LongType, ScalarType, } from "@bufbuild/protobuf";
+const { localName, getUnwrappedFieldType, scalarZeroValue } = codegenInfo;
+/**
+ * @deprecated Please use GeneratedFile.string() instead
+ */
+export function literalString(value) {
+    return ('"' +
+        value
+            .split("\\")
+            .join("\\\\")
+            .split('"')
+            .join('\\"')
+            .split("\r")
+            .join("\\r")
+            .split("\n")
+            .join("\\n") +
+        '"');
 }
 /**
- * Returns an expression for the TypeScript typing of a field,
- * and whether the property should be optional.
+ * @deprecated
  */
 export function getFieldTyping(field, file) {
     const typing = [];
@@ -133,40 +92,9 @@ export function getFieldTyping(field, file) {
     }
     return { typing, optional };
 }
-export function scalarTypeScriptType(type, longType) {
-    switch (type) {
-        case ScalarType.STRING:
-            return "string";
-        case ScalarType.BOOL:
-            return "boolean";
-        case ScalarType.UINT64:
-        case ScalarType.SFIXED64:
-        case ScalarType.FIXED64:
-        case ScalarType.SINT64:
-        case ScalarType.INT64:
-            if (longType === LongType.STRING) {
-                return "string";
-            }
-            return "bigint";
-        case ScalarType.BYTES:
-            return "Uint8Array";
-        default:
-            return "number";
-    }
-}
-export function literalString(value) {
-    return ('"' +
-        value
-            .split("\\")
-            .join("\\\\")
-            .split('"')
-            .join('\\"')
-            .split("\r")
-            .join("\\r")
-            .split("\n")
-            .join("\\n") +
-        '"');
-}
+/**
+ * @deprecated
+ */
 export function getFieldExplicitDefaultValue(field, protoInt64Symbol) {
     switch (field.fieldKind) {
         case "enum": {
@@ -222,6 +150,9 @@ export function getFieldExplicitDefaultValue(field, protoInt64Symbol) {
     }
     return undefined;
 }
+/**
+ * @deprecated
+ */
 export function getFieldIntrinsicDefaultValue(field) {
     if (field.repeated) {
         return {
@@ -257,8 +188,7 @@ export function getFieldIntrinsicDefaultValue(field) {
                         defaultValue = literalString("");
                     }
                     else {
-                        // eslint-disable-next-line @typescript-eslint/no-unsafe-call,@typescript-eslint/no-unsafe-assignment
-                        defaultValue = scalarDefaultValue(field.scalar, field.longType);
+                        defaultValue = scalarZeroValue(field.scalar, field.longType);
                         if (typeof defaultValue === "string") {
                             defaultValue = literalString(defaultValue);
                         }
@@ -274,3 +204,27 @@ export function getFieldIntrinsicDefaultValue(field) {
         typingInferrable,
     };
 }
+/**
+ * @deprecated
+ */
+function scalarTypeScriptType(type, longType) {
+    switch (type) {
+        case ScalarType.STRING:
+            return "string";
+        case ScalarType.BOOL:
+            return "boolean";
+        case ScalarType.UINT64:
+        case ScalarType.SFIXED64:
+        case ScalarType.FIXED64:
+        case ScalarType.SINT64:
+        case ScalarType.INT64:
+            if (longType === LongType.STRING) {
+                return "string";
+            }
+            return "bigint";
+        case ScalarType.BYTES:
+            return "Uint8Array";
+        default:
+            return "number";
+    }
+}

package/dist/esm/ecmascript/opaque-printables.d.ts

@@ -0,0 +1,26 @@
+import { DescEnum, DescExtension, DescMessage, LongType, ScalarType } from "@bufbuild/protobuf";
+export type LiteralProtoInt64 = {
+    readonly kind: "es_proto_int64";
+    type: ScalarType.INT64 | ScalarType.SINT64 | ScalarType.SFIXED64 | ScalarType.UINT64 | ScalarType.FIXED64;
+    longType: LongType;
+    value: bigint | string;
+};
+export type LiteralString = {
+    readonly kind: "es_string";
+    value: string;
+};
+export type RefDescMessage = {
+    readonly kind: "es_ref_message";
+    type: DescMessage;
+    typeOnly: boolean;
+};
+export type RefDescEnum = {
+    readonly kind: "es_ref_enum";
+    type: DescEnum;
+    typeOnly: boolean;
+};
+export type ExportDeclaration = {
+    readonly kind: "es_export_decl";
+    declaration: string;
+    name: string | DescMessage | DescEnum | DescExtension;
+};

package/dist/{cjs/ecmascript/export-declaration.js → esm/ecmascript/opaque-printables.js}

@@ -1,4 +1,3 @@
-"use strict";
 // Copyright 2021-2024 Buf Technologies, Inc.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
@@ -12,13 +11,4 @@
 // 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.createExportDeclaration = void 0;
-function createExportDeclaration(declaration, name) {
-    return {
-        kind: "es_export_decl",
-        declaration,
-        name,
-    };
-}
-exports.createExportDeclaration = createExportDeclaration;
+export {};

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

@@ -3,7 +3,7 @@ import { FeatureSetDefaults } from "@bufbuild/protobuf";
 import type { FileInfo, GeneratedFile } from "./generated-file.js";
 import { RuntimeImports } from "./runtime-imports.js";
 import type { Target } from "./target.js";
-import { ParsedParameter } from "./parameter";
+import { ParsedParameter } from "./parameter.js";
 /**
  * Schema describes the files and types that the plugin is requested to
  * generate.

package/dist/esm/ecmascript/schema.js

@@ -16,7 +16,7 @@ import { createGeneratedFile } from "./generated-file.js";
 import { createRuntimeImports } from "./runtime-imports.js";
 import { createImportSymbol } from "./import-symbol.js";
 import { deriveImportPath, makeImportPath, rewriteImportPath, } from "./import-path.js";
-import { makeFilePreamble } from "./gencommon";
+import { makeFilePreamble } from "./file-preamble.js";
 export function createSchema(request, parameter, pluginName, pluginVersion, featureSetDefaults) {
     const descriptorSet = createDescriptorSet(request.protoFile, {
         featureSetDefaults,

package/dist/esm/error.d.ts

@@ -1,4 +1,6 @@
 export declare class PluginOptionError extends Error {
+    name: string;
     constructor(option: string, reason?: unknown);
 }
 export declare function reasonToString(reason: unknown): string;
+export declare function isPluginOptionError(arg: unknown): arg is PluginOptionError;

package/dist/esm/error.js

@@ -17,6 +17,7 @@ export class PluginOptionError extends Error {
         super(detail.length > 0
             ? `invalid option "${option}": ${detail}`
             : `invalid option "${option}"`);
+        this.name = "PluginOptionError";
     }
 }
 export function reasonToString(reason) {
@@ -28,3 +29,9 @@ export function reasonToString(reason) {
     }
     return String(reason);
 }
+export function isPluginOptionError(arg) {
+    if (!(arg instanceof Error)) {
+        return false;
+    }
+    return arg.name === "PluginOptionError";
+}

package/dist/esm/run-node.js

@@ -12,7 +12,7 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 import { CodeGeneratorRequest } from "@bufbuild/protobuf";
-import { PluginOptionError, reasonToString } from "./error.js";
+import { isPluginOptionError, reasonToString } from "./error.js";
 /**
  * Run a plugin with Node.js.
  *
@@ -43,7 +43,7 @@ export function runNodeJs(plugin) {
     })
         .then(() => process.exit(0))
         .catch((reason) => {
-        const message = reason instanceof PluginOptionError
+        const message = isPluginOptionError(reason)
             ? reason.message
             : reasonToString(reason);
         process.stderr.write(`${plugin.name}: ${message}\n`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bufbuild/protoplugin",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "license": "(Apache-2.0 AND BSD-3-Clause)",
   "description": "Helps to create your own Protocol Buffers code generators.",
   "repository": {
@@ -10,10 +10,9 @@
   },
   "scripts": {
     "clean": "rm -rf ./dist/*",
-    "build": "npm run build:cjs && npm run build:esm && npm run build:proxy",
+    "build": "npm run build:cjs && npm run build:esm",
     "build:cjs": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs --declaration --declarationDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
     "build:esm": "../../node_modules/typescript/bin/tsc --project tsconfig.json --module ES2015 --outDir ./dist/esm --declaration --declarationDir ./dist/esm",
-    "build:proxy": "node ../../scripts/gen-esm-proxy.mjs . ecmascript",
     "attw": "attw --pack"
   },
   "type": "module",
@@ -21,20 +20,10 @@
   "main": "./dist/cjs/index.js",
   "exports": {
     ".": {
-      "node": {
-        "import": "./dist/proxy/index.js",
-        "require": "./dist/cjs/index.js"
-      },
-      "module": "./dist/esm/index.js",
       "import": "./dist/esm/index.js",
       "require": "./dist/cjs/index.js"
     },
     "./ecmascript": {
-      "node": {
-        "import": "./dist/proxy/ecmascript/index.js",
-        "require": "./dist/cjs/ecmascript/index.js"
-      },
-      "module": "./dist/esm/ecmascript/index.js",
       "import": "./dist/esm/ecmascript/index.js",
       "require": "./dist/cjs/ecmascript/index.js"
     }
@@ -47,7 +36,7 @@
     }
   },
   "dependencies": {
-    "@bufbuild/protobuf": "1.7.1",
+    "@bufbuild/protobuf": "1.8.0",
     "@typescript/vfs": "^1.4.0",
     "typescript": "4.5.2"
   },

package/dist/cjs/ecmascript/export-declaration.d.ts

@@ -1,7 +0,0 @@
-import { DescEnum, DescExtension, DescMessage } from "@bufbuild/protobuf";
-export type ExportDeclaration = {
-    readonly kind: "es_export_decl";
-    declaration: string;
-    name: string | DescMessage | DescEnum | DescExtension;
-};
-export declare function createExportDeclaration(declaration: string, name: ExportDeclaration["name"]): ExportDeclaration;

package/dist/esm/ecmascript/export-declaration.d.ts

@@ -1,7 +0,0 @@
-import { DescEnum, DescExtension, DescMessage } from "@bufbuild/protobuf";
-export type ExportDeclaration = {
-    readonly kind: "es_export_decl";
-    declaration: string;
-    name: string | DescMessage | DescEnum | DescExtension;
-};
-export declare function createExportDeclaration(declaration: string, name: ExportDeclaration["name"]): ExportDeclaration;

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

@@ -1 +0,0 @@
-export * from "../../cjs/ecmascript/index.js";

package/dist/proxy/ecmascript/index.js

@@ -1 +0,0 @@
-export * from "../../cjs/ecmascript/index.js";

package/dist/proxy/index.d.ts

@@ -1 +0,0 @@
-export * from "../cjs/index.js";

package/dist/proxy/index.js

@@ -1 +0,0 @@
-export * from "../cjs/index.js";