@bufbuild/protoplugin 0.4.0 → 1.0.0

package/README.md

@@ -3,13 +3,13 @@
 This package helps to create your own code generator plugin using the 
 Protobuf-ES plugin framework.
 
-Protobuf-ES is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript, suitable for web browsers and Node.js.  
+**Protobuf-ES** is a complete implementation of [Protocol Buffers](https://developers.google.com/protocol-buffers) in TypeScript, suitable for web browsers and Node.js.  
 
 In addition to a full Protobuf runtime library, it also provides a code generator
-`protoc-gen-es`, which utilizes a plugin framework to generate base types from
+[`protoc-gen-es`](https://www.npmjs.com/package/@bufbuild/protoc-gen-es), which utilizes a plugin framework to generate base types from
 your Protobuf schema.  It is fully compatible with both Buf and protoc compilers.
 
-And now, you can write your own Protobuf-ES compatible plugins using this same
+And now, you can write your own **Protobuf-ES** compatible plugins using this same
 plugin framework with the `@bufbuild/protoplugin` package.
 
 With `@bufbuild/protoplugin`, you can generate your own TypeScript code tailored 
@@ -29,4 +29,6 @@ TypeScript and your own compiler options.
 With `protoplugin`, you have all the tools at your disposal to produce ECMAScript-compliant
 code.  
 
+## Usage
+
 Get started now with our [plugin documentation](https://github.com/bufbuild/protobuf-es/blob/main/docs/writing_plugins.md). 

package/dist/types/create-es-plugin.d.ts

@@ -54,7 +54,7 @@ interface PluginInit {
      */
     transpile?: (files: FileInfo[], transpileJs: boolean, transpileDts: boolean) => FileInfo[];
 }
-declare type PluginOptionParseFn = (key: string, value: string | undefined) => void;
+type PluginOptionParseFn = (key: string, value: string | undefined) => void;
 /**
  * Create a new code generator plugin for ECMAScript.
  * The plugin can generate JavaScript, TypeScript, or TypeScript declaration

package/dist/types/ecmascript/custom-options.d.ts

@@ -28,5 +28,5 @@ export declare function findCustomEnumOption(desc: AnyDesc, extensionNumber: num
 /**
  * ScalarValue is a conditional type that pairs a ScalarType value with its concrete type.
  */
-declare type ScalarValue<T> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? bigint | string : T extends ScalarType.SINT64 ? bigint | string : T extends ScalarType.SFIXED64 ? bigint | string : T extends ScalarType.UINT64 ? bigint | string : T extends ScalarType.FIXED64 ? bigint | string : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
+type ScalarValue<T> = T extends ScalarType.STRING ? string : T extends ScalarType.INT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.UINT32 ? number : T extends ScalarType.SINT32 ? number : T extends ScalarType.FIXED32 ? number : T extends ScalarType.SFIXED32 ? number : T extends ScalarType.FLOAT ? number : T extends ScalarType.DOUBLE ? number : T extends ScalarType.INT64 ? bigint | string : T extends ScalarType.SINT64 ? bigint | string : T extends ScalarType.SFIXED64 ? bigint | string : T extends ScalarType.UINT64 ? bigint | string : T extends ScalarType.FIXED64 ? bigint | string : T extends ScalarType.BOOL ? boolean : T extends ScalarType.BYTES ? Uint8Array : never;
 export {};

package/dist/types/ecmascript/generated-file.d.ts

@@ -4,7 +4,7 @@ import type { RuntimeImports } from "./runtime-imports.js";
 /**
  * All types that can be passed to GeneratedFile.print()
  */
-export declare type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | DescMessage | DescEnum | Printable[];
+export type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | DescMessage | DescEnum | Printable[];
 /**
  * FileInfo represents an intermediate type using for transpiling TypeScript internally.
  */
@@ -66,8 +66,8 @@ export interface GeneratedFile {
 export interface GenerateFileToFileInfo {
     getFileInfo(): FileInfo | undefined;
 }
-declare type CreateTypeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
-declare type RewriteImportPathFn = (path: string) => string;
+type CreateTypeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+type RewriteImportPathFn = (path: string) => string;
 export declare function createGeneratedFile(name: string, importPath: string, rewriteImportPath: RewriteImportPathFn, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
     pluginName: string;
     pluginVersion: string;

package/dist/types/ecmascript/import-path.d.ts

@@ -35,7 +35,7 @@ import { DescFile } from "@bufbuild/protobuf";
  * With the target `@scope/pkg`, the import path `./foo/bar_pb.js` is
  * transformed to `@scope/pkg/foo/bar_pb.js`.
  */
-export declare type RewriteImports = {
+export type RewriteImports = {
     pattern: string;
     target: string;
 }[];

package/dist/types/ecmascript/import-symbol.d.ts

@@ -1,7 +1,7 @@
 /**
  * An import symbol represents an ECMAScript import.
  */
-export declare type ImportSymbol = {
+export type ImportSymbol = {
     readonly kind: "es_symbol";
     /**
      * The name to import.
@@ -35,5 +35,5 @@ export declare type ImportSymbol = {
  * Create a new import symbol.
  */
 export declare function createImportSymbol(name: string, from: string, typeOnly?: boolean): ImportSymbol;
-declare type EsSymbolId = string;
+type EsSymbolId = string;
 export {};

package/dist/types/ecmascript/target.d.ts

@@ -1,4 +1,4 @@
 /**
  * Represents possible values of the plugin option `target`.
  */
-export declare type Target = "js" | "ts" | "dts";
+export type Target = "js" | "ts" | "dts";

package/package.json

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