@bufbuild/protoplugin 0.0.9

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

@@ -0,0 +1,63 @@
+import type { DescEnum, DescFile, DescMessage } from "@bufbuild/protobuf";
+import { CodeGeneratorResponse } from "@bufbuild/protobuf";
+import type { ImportSymbol } from "./import-symbol.js";
+import type { RuntimeImports } from "./runtime-imports";
+/**
+ * All types that can be passed to GeneratedFile.print()
+ */
+declare type Printable = string | number | boolean | bigint | Uint8Array | ImportSymbol | DescMessage | DescEnum | Printable[];
+/**
+ * Represents a JavaScript, TypeScript, or TypeScript declaration file.
+ */
+export interface GeneratedFile {
+    /**
+     * Create a standard preamble the includes comments at the top of the
+     * protobuf source file (like a license header), as well as information
+     * about the code generator and its version.
+     *
+     * The preamble is always placed at the very top of the generated file,
+     * above import statements.
+     */
+    preamble(file: DescFile): void;
+    /**
+     * Add a line of code to the file.
+     *
+     * - string: Prints the string verbatim.
+     * - number or boolean: Prints a literal.
+     * - bigint: Prints an expression using protoInt64.parse().
+     * - Uint8Array: Prints an expression that re-created the array.
+     * - ImportSymbol: Adds an import statement and prints the name of the symbol.
+     * - DescMessage or DescEnum: Imports the type if necessary, and prints the name.
+     */
+    print(...any: Printable[]): void;
+    /**
+     * Reserves an identifier in this file.
+     */
+    export(name: string): ImportSymbol;
+    /**
+     * Import a message or enumeration generated by protoc-gen-es.
+     */
+    import(type: DescMessage | DescEnum): ImportSymbol;
+    /**
+     * Import any symbol from a file or package.
+     *
+     * The import path can point to a package, for example `@foo/bar/baz.js`, or
+     * to a file, for example `./bar/baz.js`.
+     *
+     * Note that while paths to a file begin with a `./`, they must be
+     * relative to the project root. The import path is automatically made
+     * relative to the current file.
+     */
+    import(name: string, from: string): ImportSymbol;
+}
+export interface GenerateFileToResponse {
+    toResponse(res: CodeGeneratorResponse): void;
+}
+declare type CreateTypeImportFn = (desc: DescMessage | DescEnum) => ImportSymbol;
+export declare function createGeneratedFile(name: string, createTypeImport: CreateTypeImportFn, runtimeImports: RuntimeImports, preambleSettings: {
+    pluginName: string;
+    pluginVersion: string;
+    parameter: string | undefined;
+    tsNocheck: boolean;
+}): GeneratedFile & GenerateFileToResponse;
+export {};

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

@@ -0,0 +1,39 @@
+/**
+ * An import symbol represents an ECMAScript import.
+ */
+export declare type ImportSymbol = {
+    readonly kind: "es_symbol";
+    /**
+     * The name to import.
+     */
+    readonly name: string;
+    /**
+     * The import path.
+     *
+     * The path can point to a package, for example `@foo/bar/baz.js`, or
+     * to a file, for example `./bar/baz.js`.
+     *
+     * Note that while paths to a file begin with a `./`, they must be
+     * relative to the project root.
+     */
+    readonly from: string;
+    /**
+     * Whether this is a type-only import - an import that only exists in
+     * TypeScript.
+     */
+    readonly typeOnly: boolean;
+    /**
+     * Create a copy of this import, and make it type-only for TypeScript.
+     */
+    toTypeOnly(): ImportSymbol;
+    /**
+     * The unique ID based on name and from, disregarding typeOnly.
+     */
+    readonly id: EsSymbolId;
+};
+/**
+ * Create a new import symbol.
+ */
+export declare function createImportSymbol(name: string, from: string, typeOnly?: boolean): ImportSymbol;
+declare type EsSymbolId = string;
+export {};

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

@@ -0,0 +1,7 @@
+export { Target } from "./target.js";
+export { Schema } from "./schema.js";
+export { RuntimeImports } from "./runtime-imports.js";
+export { GeneratedFile } from "./generated-file.js";
+export { ImportSymbol } from "./import-symbol.js";
+export declare const localName: typeof import("@bufbuild/protobuf/dist/types/private/names.js").localName;
+export { createJsDocBlock, getFieldExplicitDefaultValue, getFieldIntrinsicDefaultValue, getFieldTyping, makeJsDoc, literalString, } from "./gencommon.js";

package/dist/types/ecmascript/runtime-imports.d.ts

@@ -0,0 +1,21 @@
+import type { ImportSymbol } from "./import-symbol.js";
+export interface RuntimeImports {
+    proto2: ImportSymbol;
+    proto3: ImportSymbol;
+    Message: ImportSymbol;
+    PartialMessage: ImportSymbol;
+    PlainMessage: ImportSymbol;
+    FieldList: ImportSymbol;
+    MessageType: ImportSymbol;
+    BinaryReadOptions: ImportSymbol;
+    BinaryWriteOptions: ImportSymbol;
+    JsonReadOptions: ImportSymbol;
+    JsonWriteOptions: ImportSymbol;
+    JsonValue: ImportSymbol;
+    JsonObject: ImportSymbol;
+    protoInt64: ImportSymbol;
+    ScalarType: ImportSymbol;
+    MethodKind: ImportSymbol;
+    MethodIdempotency: ImportSymbol;
+}
+export declare function createRuntimeImports(bootstrapWkt: boolean): RuntimeImports;

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

@@ -0,0 +1,41 @@
+import type { CodeGeneratorRequest, DescFile } from "@bufbuild/protobuf";
+import { CodeGeneratorResponse } from "@bufbuild/protobuf";
+import type { GeneratedFile } from "./generated-file.js";
+import { RuntimeImports } from "./runtime-imports.js";
+import type { Target } from "./target";
+/**
+ * Schema describes the files and types that the plugin is requested to
+ * generate.
+ */
+export interface Schema {
+    /**
+     * The files we are asked to generate.
+     */
+    readonly files: readonly DescFile[];
+    /**
+     * All files contained in the code generator request.
+     */
+    readonly allFiles: readonly DescFile[];
+    /**
+     * The plugin option `target`. A code generator should support all targets.
+     */
+    readonly targets: readonly Target[];
+    /**
+     * Provides some symbols from the runtime library @bufbuild/protobuf.
+     */
+    readonly runtime: RuntimeImports;
+    /**
+     * Generate a new file with the given name.
+     */
+    generateFile(name: string): GeneratedFile;
+    /**
+     * The original google.protobuf.compiler.CodeGeneratorRequest.
+     */
+    readonly proto: CodeGeneratorRequest;
+}
+interface SchemaController {
+    schema: Schema;
+    toResponse: (res: CodeGeneratorResponse) => void;
+}
+export declare function createSchema(request: CodeGeneratorRequest, targets: Target[], pluginName: string, pluginVersion: string, tsNocheck: boolean, bootstrapWkt: boolean): SchemaController;
+export {};

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

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

package/dist/types/error.d.ts

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

package/dist/types/index.d.ts

@@ -0,0 +1,4 @@
+export { Plugin } from "./plugin.js";
+export { Schema } from "./ecmascript/schema.js";
+export { runNodeJs } from "./run-node.js";
+export { createEcmaScriptPlugin } from "./create-es-plugin.js";

package/dist/types/plugin.d.ts

@@ -0,0 +1,18 @@
+import type { CodeGeneratorRequest, CodeGeneratorResponse } from "@bufbuild/protobuf";
+/**
+ * Represents any code generator plugin.
+ */
+export interface Plugin {
+    /**
+     * Name of this code generator plugin.
+     */
+    name: string;
+    /**
+     * Version of this code generator plugin.
+     */
+    version: string;
+    /**
+     * Run this plugin for the given request.
+     */
+    run(request: CodeGeneratorRequest): CodeGeneratorResponse;
+}

package/dist/types/run-node.d.ts

@@ -0,0 +1,12 @@
+import type { Plugin } from "./plugin.js";
+/**
+ * Run a plugin with Node.js.
+ *
+ * ```
+ * #!/usr/bin/env node
+ * const {runNodeJs} = require("@bufbuild/protoplugin");
+ * const {myPlugin} = require("./protoc-gen-x-plugin.js");
+ * runNodeJs(myPlugin);
+ * ```
+ */
+export declare function runNodeJs(plugin: Plugin): void;

package/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@bufbuild/protoplugin",
+  "version": "0.0.9",
+  "license": "(Apache-2.0 AND BSD-3-Clause)",
+  "description": "Helps to create your own Protocol Buffers code generators.",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bufbuild/protobuf-es.git",
+    "directory": "packages/protoplugin"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "clean": "rm -rf ./dist/cjs/* ./dist/esm/* ./dist/types/*",
+    "build": "npm run build:cjs && npm run build:esm+types",
+    "build:cjs": "npx tsc --project tsconfig.json --module commonjs --outDir ./dist/cjs && echo >./dist/cjs/package.json '{\"type\":\"commonjs\"}'",
+    "build:esm+types": "npx tsc --project tsconfig.json --module ES2015 --outDir ./dist/esm --declaration --declarationDir ./dist/types"
+  },
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/esm/index.js",
+      "require": "./dist/cjs/index.js",
+      "default": "./dist/esm/index.js"
+    },
+    "./ecmascript": {
+      "import": "./dist/esm/ecmascript/index.js",
+      "require": "./dist/cjs/ecmascript/index.js",
+      "default": "./dist/esm/ecmascript/index.js"
+    }
+  },
+  "types": "./dist/types/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "ecmascript": [
+        "./dist/types/ecmascript/index.d.ts"
+      ]
+    }
+  },
+  "dependencies": {
+    "@bufbuild/protobuf": "^0.0.9"
+  },
+  "devDependencies": {
+    "typescript": "^4.7.4"
+  },
+  "files": [
+    "dist/**/"
+  ]
+}