@bufbuild/protoplugin 1.5.1 → 1.7.0

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

@@ -1,9 +1,9 @@
 import type { CodeGeneratorRequest, DescFile } from "@bufbuild/protobuf";
-import { CodeGeneratorResponse } from "@bufbuild/protobuf";
+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 { RewriteImports } from "./import-path.js";
+import { ParsedParameter } from "./parameter";
 /**
  * Schema describes the files and types that the plugin is requested to
  * generate.
@@ -34,10 +34,9 @@ export interface Schema {
      */
     readonly proto: CodeGeneratorRequest;
 }
-interface SchemaController {
-    schema: Schema;
+interface SchemaController extends Schema {
     getFileInfo: () => FileInfo[];
+    prepareGenerate(target: Target): void;
 }
-export declare function createSchema(request: CodeGeneratorRequest, targets: Target[], tsNocheck: boolean, bootstrapWkt: boolean, rewriteImports: RewriteImports, importExtension: string, keepEmptyFiles: boolean, pluginName: string, pluginVersion: string, pluginParameter: string): SchemaController;
-export declare function toResponse(files: FileInfo[]): CodeGeneratorResponse;
+export declare function createSchema(request: CodeGeneratorRequest, parameter: ParsedParameter, pluginName: string, pluginVersion: string, featureSetDefaults: FeatureSetDefaults | undefined): SchemaController;
 export {};

package/dist/esm/ecmascript/schema.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.
@@ -11,63 +11,51 @@
 // 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 { CodeGeneratorResponse, CodeGeneratorResponse_Feature, codegenInfo, createDescriptorSet, protoInt64, } from "@bufbuild/protobuf";
+import { codegenInfo, createDescriptorSet, } from "@bufbuild/protobuf";
 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";
-export function createSchema(request, targets, tsNocheck, bootstrapWkt, rewriteImports, importExtension, keepEmptyFiles, pluginName, pluginVersion, pluginParameter) {
-    const descriptorSet = createDescriptorSet(request.protoFile);
+import { makeFilePreamble } from "./gencommon";
+export function createSchema(request, parameter, pluginName, pluginVersion, featureSetDefaults) {
+    const descriptorSet = createDescriptorSet(request.protoFile, {
+        featureSetDefaults,
+    });
     const filesToGenerate = findFilesToGenerate(descriptorSet, request);
-    const runtime = createRuntimeImports(bootstrapWkt);
+    const runtime = createRuntimeImports(parameter.bootstrapWkt);
     const createTypeImport = (desc) => {
         const name = codegenInfo.localName(desc);
-        const from = makeImportPath(desc.file, bootstrapWkt, filesToGenerate);
+        const from = makeImportPath(desc.file, parameter.bootstrapWkt, filesToGenerate);
         return createImportSymbol(name, from);
     };
+    const createPreamble = (descFile) => makeFilePreamble(descFile, pluginName, pluginVersion, parameter.sanitizedParameter, parameter.tsNocheck);
+    let target;
     const generatedFiles = [];
-    const schema = {
-        targets,
+    return {
+        targets: parameter.targets,
         runtime,
         proto: request,
         files: filesToGenerate,
         allFiles: descriptorSet.files,
         generateFile(name) {
-            const genFile = createGeneratedFile(name, deriveImportPath(name), (importPath) => rewriteImportPath(importPath, rewriteImports, importExtension), createTypeImport, runtime, {
-                pluginName,
-                pluginVersion,
-                pluginParameter,
-                tsNocheck,
-            }, keepEmptyFiles);
+            if (target === undefined) {
+                throw new Error("prepareGenerate() must be called before generateFile()");
+            }
+            const genFile = createGeneratedFile(name, deriveImportPath(name), target === "js" ? parameter.jsImportStyle : "module", // ts and dts always use import/export, only js may use commonjs
+            (importPath) => rewriteImportPath(importPath, parameter.rewriteImports, parameter.importExtension), createTypeImport, runtime, createPreamble);
             generatedFiles.push(genFile);
             return genFile;
         },
-    };
-    return {
-        schema,
         getFileInfo() {
-            return generatedFiles.flatMap((file) => {
-                const fileInfo = file.getFileInfo();
-                // undefined is returned if the file has no content
-                if (!fileInfo) {
-                    return [];
-                }
-                return [fileInfo];
-            });
+            return generatedFiles
+                .map((f) => f.getFileInfo())
+                .filter((fi) => parameter.keepEmptyFiles || fi.content.length > 0);
+        },
+        prepareGenerate(newTarget) {
+            target = newTarget;
         },
     };
 }
-export function toResponse(files) {
-    return new CodeGeneratorResponse({
-        supportedFeatures: protoInt64.parse(CodeGeneratorResponse_Feature.PROTO3_OPTIONAL),
-        file: files.map((f) => {
-            if (f.preamble !== undefined) {
-                f.content = f.preamble + "\n" + f.content;
-            }
-            return f;
-        }),
-    });
-}
 function findFilesToGenerate(descriptorSet, request) {
     const missing = request.fileToGenerate.filter((fileToGenerate) => descriptorSet.files.every((file) => fileToGenerate !== file.name + ".proto"));
     if (missing.length) {

package/dist/esm/ecmascript/target.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.

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

@@ -1,2 +1,2 @@
 import type { FileInfo } from "./generated-file.js";
-export declare function transpile(files: FileInfo[], transpileJs: boolean, transpileDts: boolean): FileInfo[];
+export declare function transpile(files: FileInfo[], transpileJs: boolean, transpileDts: boolean, jsImportStyle: "module" | "legacy_commonjs"): FileInfo[];

package/dist/esm/ecmascript/transpile.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.
@@ -76,8 +76,11 @@ function createTranspiler(options, files) {
         host: host.compilerHost,
     });
 }
-export function transpile(files, transpileJs, transpileDts) {
+export function transpile(files, transpileJs, transpileDts, jsImportStyle) {
     const options = Object.assign(Object.assign({}, defaultOptions), { declaration: transpileDts, emitDeclarationOnly: transpileDts && !transpileJs });
+    if (jsImportStyle == "legacy_commonjs") {
+        options.module = ts.ModuleKind.CommonJS;
+    }
     // Create the transpiler (a ts.Program object)
     const program = createTranspiler(options, files);
     const results = [];

package/dist/esm/error.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.

package/dist/esm/index.d.ts

@@ -1,4 +1,8 @@
+import { Schema as SchemaInternal } from "./ecmascript/schema.js";
 export { Plugin } from "./plugin.js";
-export { Schema } from "./ecmascript/schema.js";
 export { runNodeJs } from "./run-node.js";
 export { createEcmaScriptPlugin } from "./create-es-plugin.js";
+/**
+ * @deprecated Please use Schema from @bufbuild/protoplugin/ecmascript instead
+ */
+export type Schema = SchemaInternal;

package/dist/esm/index.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.

package/dist/esm/plugin.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.

package/dist/esm/run-node.js

@@ -1,4 +1,4 @@
-// Copyright 2021-2023 Buf Technologies, Inc.
+// Copyright 2021-2024 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.

package/package.json

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