roleypoly/v3
1
0
Fork 0
mirror of https://github.com/roleypoly/roleypoly.git synced 2025-06-15 17:19:10 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(ts-protoc-gen): prettier

Browse source
This commit is contained in:
41666 2020-10-11 18:35:22 -04:00
parent 291ec9576f
commit 783915f057
16 changed files with 1660 additions and 1202 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/ts-protoc-gen/CodePrinter.ts
View file

@ -1,5 +1,5 @@
import {Printer} from "./Printer";
import {generateIndent} from "./util";
import { Printer } from './Printer';
import { generateIndent } from './util';
export class CodePrinter {
private indentation: string;

67
src/ts-protoc-gen/ExportMap.ts
View file

@ -3,52 +3,69 @@ import {
DescriptorProto,
MessageOptions,
EnumOptions,
FieldDescriptorProto
} from "google-protobuf/google/protobuf/descriptor_pb";
FieldDescriptorProto,
} from 'google-protobuf/google/protobuf/descriptor_pb';
import Type = FieldDescriptorProto.Type;
export type ExportMessageEntry = {
pkg: string,
fileName: string,
messageOptions: MessageOptions,
pkg: string;
fileName: string;
messageOptions: MessageOptions;
mapFieldOptions?: {
key: [Type, string],
value: [Type, string],
}
key: [Type, string];
value: [Type, string];
};
};
export type ExportEnumEntry = {
pkg: string,
fileName: string,
enumOptions: EnumOptions,
pkg: string;
fileName: string;
enumOptions: EnumOptions;
};
export class ExportMap {
messageMap: {[key: string]: ExportMessageEntry} = {};
enumMap: {[key: string]: ExportEnumEntry} = {};
messageMap: { [key: string]: ExportMessageEntry } = {};
enumMap: { [key: string]: ExportEnumEntry } = {};
exportNested(scope: string, fileDescriptor: FileDescriptorProto, message: DescriptorProto) {
exportNested(
scope: string,
fileDescriptor: FileDescriptorProto,
message: DescriptorProto
) {
const messageEntry: ExportMessageEntry = {
pkg: fileDescriptor.getPackage(),
fileName: fileDescriptor.getName(),
messageOptions: message.getOptions(),
mapFieldOptions: message.getOptions() && message.getOptions().getMapEntry() ? {
key: [message.getFieldList()[0].getType(), message.getFieldList()[0].getTypeName().slice(1)],
value: [message.getFieldList()[1].getType(), message.getFieldList()[1].getTypeName().slice(1)],
} : undefined,
mapFieldOptions:
message.getOptions() && message.getOptions().getMapEntry()
? {
key: [
message.getFieldList()[0].getType(),
message.getFieldList()[0].getTypeName().slice(1),
],
value: [
message.getFieldList()[1].getType(),
message.getFieldList()[1].getTypeName().slice(1),
],
}
: undefined,
};
const packagePrefix = scope ? scope + "." : "";
const packagePrefix = scope ? scope + '.' : '';
const entryName = `${packagePrefix}${message.getName()}`;
this.messageMap[entryName] = messageEntry;
message.getNestedTypeList().forEach(nested => {
this.exportNested(`${packagePrefix}${message.getName()}`, fileDescriptor, nested);
message.getNestedTypeList().forEach((nested) => {
this.exportNested(
`${packagePrefix}${message.getName()}`,
fileDescriptor,
nested
);
});
message.getEnumTypeList().forEach(enumType => {
message.getEnumTypeList().forEach((enumType) => {
const identifier = `${packagePrefix}${message.getName()}.${enumType.getName()}`;
this.enumMap[identifier] = {
pkg: fileDescriptor.getPackage(),
@ -60,12 +77,12 @@ export class ExportMap {
addFileDescriptor(fileDescriptor: FileDescriptorProto) {
const scope = fileDescriptor.getPackage();
fileDescriptor.getMessageTypeList().forEach(messageType => {
fileDescriptor.getMessageTypeList().forEach((messageType) => {
this.exportNested(scope, fileDescriptor, messageType);
});
fileDescriptor.getEnumTypeList().forEach(enumType => {
const packagePrefix = scope ? scope + "." : "";
fileDescriptor.getEnumTypeList().forEach((enumType) => {
const packagePrefix = scope ? scope + '.' : '';
this.enumMap[packagePrefix + enumType.getName()] = {
pkg: fileDescriptor.getPackage(),
fileName: fileDescriptor.getName(),

10
src/ts-protoc-gen/Printer.ts
View file

@ -1,15 +1,15 @@
import {generateIndent} from "./util";
import { generateIndent } from './util';
export class Printer {
indentStr: string;
output: string = "";
output: string = '';
constructor(indentLevel: number) {
this.indentStr = generateIndent(indentLevel);
}
printLn(str: string) {
this.output += this.indentStr + str + "\n";
this.output += this.indentStr + str + '\n';
}
print(str: string) {
@ -17,11 +17,11 @@ export class Printer {
}
printEmptyLn() {
this.output += "\n";
this.output += '\n';
}
printIndentedLn(str: string) {
this.output += this.indentStr + " " + str + "\n";
this.output += this.indentStr + ' ' + str + '\n';
}
getOutput(): string {

28
src/ts-protoc-gen/WellKnown.ts
View file

@ -1,14 +1,16 @@
export const WellKnownTypesMap: {[key: string]: string} = {
"google/protobuf/compiler/plugin.proto": "google-protobuf/google/protobuf/compiler/plugin_pb",
"google/protobuf/any.proto": "google-protobuf/google/protobuf/any_pb",
"google/protobuf/api.proto": "google-protobuf/google/protobuf/api_pb",
"google/protobuf/descriptor.proto": "google-protobuf/google/protobuf/descriptor_pb",
"google/protobuf/duration.proto": "google-protobuf/google/protobuf/duration_pb",
"google/protobuf/empty.proto": "google-protobuf/google/protobuf/empty_pb",
"google/protobuf/field_mask.proto": "google-protobuf/google/protobuf/field_mask_pb",
"google/protobuf/source_context.proto": "google-protobuf/google/protobuf/source_context_pb",
"google/protobuf/struct.proto": "google-protobuf/google/protobuf/struct_pb",
"google/protobuf/timestamp.proto": "google-protobuf/google/protobuf/timestamp_pb",
"google/protobuf/type.proto": "google-protobuf/google/protobuf/type_pb",
"google/protobuf/wrappers.proto": "google-protobuf/google/protobuf/wrappers_pb"
export const WellKnownTypesMap: { [key: string]: string } = {
'google/protobuf/compiler/plugin.proto':
'google-protobuf/google/protobuf/compiler/plugin_pb',
'google/protobuf/any.proto': 'google-protobuf/google/protobuf/any_pb',
'google/protobuf/api.proto': 'google-protobuf/google/protobuf/api_pb',
'google/protobuf/descriptor.proto': 'google-protobuf/google/protobuf/descriptor_pb',
'google/protobuf/duration.proto': 'google-protobuf/google/protobuf/duration_pb',
'google/protobuf/empty.proto': 'google-protobuf/google/protobuf/empty_pb',
'google/protobuf/field_mask.proto': 'google-protobuf/google/protobuf/field_mask_pb',
'google/protobuf/source_context.proto':
'google-protobuf/google/protobuf/source_context_pb',
'google/protobuf/struct.proto': 'google-protobuf/google/protobuf/struct_pb',
'google/protobuf/timestamp.proto': 'google-protobuf/google/protobuf/timestamp_pb',
'google/protobuf/type.proto': 'google-protobuf/google/protobuf/type_pb',
'google/protobuf/wrappers.proto': 'google-protobuf/google/protobuf/wrappers_pb',
};

49
src/ts-protoc-gen/index.ts
View file

@ -1,11 +1,14 @@
import {printFileDescriptorTSD} from "./ts/fileDescriptorTSD";
import {ExportMap} from "./ExportMap";
import {replaceProtoSuffix, withAllStdIn, getParameterEnums} from "./util";
import {CodeGeneratorRequest, CodeGeneratorResponse} from "google-protobuf/google/protobuf/compiler/plugin_pb";
import {FileDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {generateGrpcWebService} from "./service/grpcweb";
import {generateGrpcNodeService} from "./service/grpcnode";
import {ServiceParameter} from "./parameters";
import { printFileDescriptorTSD } from './ts/fileDescriptorTSD';
import { ExportMap } from './ExportMap';
import { replaceProtoSuffix, withAllStdIn, getParameterEnums } from './util';
import {
CodeGeneratorRequest,
CodeGeneratorResponse,
} from 'google-protobuf/google/protobuf/compiler/plugin_pb';
import { FileDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { generateGrpcWebService } from './service/grpcweb';
import { generateGrpcNodeService } from './service/grpcnode';
import { ServiceParameter } from './parameters';
/**
* This is the ProtoC compiler plugin.
@ -24,38 +27,48 @@ withAllStdIn((inputBuff: Buffer) => {
const codeGenRequest = CodeGeneratorRequest.deserializeBinary(typedInputBuff);
const codeGenResponse = new CodeGeneratorResponse();
const exportMap = new ExportMap();
const fileNameToDescriptor: {[key: string]: FileDescriptorProto} = {};
const fileNameToDescriptor: { [key: string]: FileDescriptorProto } = {};
const parameter = codeGenRequest.getParameter();
const {service, mode} = getParameterEnums(parameter);
const { service, mode } = getParameterEnums(parameter);
const generateGrpcWebServices = service === ServiceParameter.GrpcWeb;
const generateGrpcNodeServices = service === ServiceParameter.GrpcNode;
codeGenRequest.getProtoFileList().forEach(protoFileDescriptor => {
codeGenRequest.getProtoFileList().forEach((protoFileDescriptor) => {
fileNameToDescriptor[protoFileDescriptor.getName()] = protoFileDescriptor;
exportMap.addFileDescriptor(protoFileDescriptor);
});
codeGenRequest.getFileToGenerateList().forEach(fileName => {
codeGenRequest.getFileToGenerateList().forEach((fileName) => {
const outputFileName = replaceProtoSuffix(fileName);
const thisFile = new CodeGeneratorResponse.File();
thisFile.setName(outputFileName + ".d.ts");
thisFile.setContent(printFileDescriptorTSD(fileNameToDescriptor[fileName], exportMap));
thisFile.setName(outputFileName + '.d.ts');
thisFile.setContent(
printFileDescriptorTSD(fileNameToDescriptor[fileName], exportMap)
);
codeGenResponse.addFile(thisFile);
if (generateGrpcWebServices) {
generateGrpcWebService(outputFileName, fileNameToDescriptor[fileName], exportMap)
.forEach(file => codeGenResponse.addFile(file));
generateGrpcWebService(
outputFileName,
fileNameToDescriptor[fileName],
exportMap
).forEach((file) => codeGenResponse.addFile(file));
} else if (generateGrpcNodeServices) {
const file = generateGrpcNodeService(outputFileName, fileNameToDescriptor[fileName], exportMap, mode);
const file = generateGrpcNodeService(
outputFileName,
fileNameToDescriptor[fileName],
exportMap,
mode
);
codeGenResponse.addFile(file);
}
});
process.stdout.write(Buffer.from(codeGenResponse.serializeBinary()));
} catch (err) {
console.error("protoc-gen-ts error: " + err.stack + "\n");
console.error('protoc-gen-ts error: ' + err.stack + '\n');
process.exit(1);
}
});

4
src/ts-protoc-gen/parameters.ts
View file

@ -1,10 +1,10 @@
export enum ServiceParameter {
None,
GrpcWeb,
GrpcNode
GrpcNode,
}
export enum ModeParameter {
None,
GrpcJs
GrpcJs,
}

115
src/ts-protoc-gen/service/common.ts
View file

@ -1,9 +1,18 @@
import {CodeGeneratorResponse} from "google-protobuf/google/protobuf/compiler/plugin_pb";
import {FileDescriptorProto, MethodDescriptorProto, ServiceDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {ExportMap} from "../ExportMap";
import {WellKnownTypesMap} from "../WellKnown";
import {getFieldType, MESSAGE_TYPE} from "../ts/FieldTypes";
import {filePathToPseudoNamespace, replaceProtoSuffix, getPathToRoot, normaliseFieldObjectName} from "../util";
import { CodeGeneratorResponse } from 'google-protobuf/google/protobuf/compiler/plugin_pb';
import {
FileDescriptorProto,
MethodDescriptorProto,
ServiceDescriptorProto,
} from 'google-protobuf/google/protobuf/descriptor_pb';
import { ExportMap } from '../ExportMap';
import { WellKnownTypesMap } from '../WellKnown';
import { getFieldType, MESSAGE_TYPE } from '../ts/FieldTypes';
import {
filePathToPseudoNamespace,
replaceProtoSuffix,
getPathToRoot,
normaliseFieldObjectName,
} from '../util';
export function createFile(output: string, filename: string): CodeGeneratorResponse.File {
const file = new CodeGeneratorResponse.File();
@ -13,22 +22,39 @@ export function createFile(output: string, filename: string): CodeGeneratorRespo
}
type CallingTypes = {
requestType: string
responseType: string
requestType: string;
responseType: string;
};
function getCallingTypes(method: MethodDescriptorProto, exportMap: ExportMap): CallingTypes {
function getCallingTypes(
method: MethodDescriptorProto,
exportMap: ExportMap
): CallingTypes {
return {
requestType: getFieldType(MESSAGE_TYPE, method.getInputType().slice(1), "", exportMap),
responseType: getFieldType(MESSAGE_TYPE, method.getOutputType().slice(1), "", exportMap),
requestType: getFieldType(
MESSAGE_TYPE,
method.getInputType().slice(1),
'',
exportMap
),
responseType: getFieldType(
MESSAGE_TYPE,
method.getOutputType().slice(1),
'',
exportMap
),
};
}
function isUsed(fileDescriptor: FileDescriptorProto, pseudoNamespace: string, exportMap: ExportMap) {
return fileDescriptor.getServiceList().some(service => {
return service.getMethodList().some(method => {
function isUsed(
fileDescriptor: FileDescriptorProto,
pseudoNamespace: string,
exportMap: ExportMap
) {
return fileDescriptor.getServiceList().some((service) => {
return service.getMethodList().some((method) => {
const callingTypes = getCallingTypes(method, exportMap);
const namespacePackage = pseudoNamespace + ".";
const namespacePackage = pseudoNamespace + '.';
return (
callingTypes.requestType.indexOf(namespacePackage) === 0 ||
callingTypes.responseType.indexOf(namespacePackage) === 0
@ -38,19 +64,19 @@ function isUsed(fileDescriptor: FileDescriptorProto, pseudoNamespace: string, ex
}
export type ImportDescriptor = {
readonly namespace: string
readonly path: string
readonly namespace: string;
readonly path: string;
};
export type RPCMethodDescriptor = {
readonly nameAsPascalCase: string,
readonly nameAsCamelCase: string,
readonly functionName: string,
readonly serviceName: string,
readonly requestStream: boolean
readonly responseStream: boolean
readonly requestType: string
readonly responseType: string
readonly nameAsPascalCase: string;
readonly nameAsCamelCase: string;
readonly functionName: string;
readonly serviceName: string;
readonly requestStream: boolean;
readonly responseStream: boolean;
readonly requestType: string;
readonly responseType: string;
};
export class RPCDescriptor {
@ -58,7 +84,11 @@ export class RPCDescriptor {
private readonly protoService: ServiceDescriptorProto;
private readonly exportMap: ExportMap;
constructor(grpcService: GrpcServiceDescriptor, protoService: ServiceDescriptorProto, exportMap: ExportMap) {
constructor(
grpcService: GrpcServiceDescriptor,
protoService: ServiceDescriptorProto,
exportMap: ExportMap
) {
this.grpcService = grpcService;
this.protoService = protoService;
this.exportMap = exportMap;
@ -68,14 +98,17 @@ export class RPCDescriptor {
}
get qualifiedName(): string {
return (this.grpcService.packageName ? `${this.grpcService.packageName}.` : "") + this.name;
return (
(this.grpcService.packageName ? `${this.grpcService.packageName}.` : '') +
this.name
);
}
get methods(): RPCMethodDescriptor[] {
return this.protoService.getMethodList()
.map(method => {
return this.protoService.getMethodList().map((method) => {
const callingTypes = getCallingTypes(method, this.exportMap);
const nameAsCamelCase = method.getName()[0].toLowerCase() + method.getName().substr(1);
const nameAsCamelCase =
method.getName()[0].toLowerCase() + method.getName().substr(1);
return {
nameAsPascalCase: method.getName(),
nameAsCamelCase,
@ -110,9 +143,16 @@ export class GrpcServiceDescriptor {
}
get imports(): ImportDescriptor[] {
const dependencies = this.fileDescriptor.getDependencyList()
.filter(dependency => isUsed(this.fileDescriptor, filePathToPseudoNamespace(dependency), this.exportMap))
.map(dependency => {
const dependencies = this.fileDescriptor
.getDependencyList()
.filter((dependency) =>
isUsed(
this.fileDescriptor,
filePathToPseudoNamespace(dependency),
this.exportMap
)
)
.map((dependency) => {
const namespace = filePathToPseudoNamespace(dependency);
if (dependency in WellKnownTypesMap) {
return {
@ -122,7 +162,9 @@ export class GrpcServiceDescriptor {
} else {
return {
namespace,
path: `${this.pathToRoot}${replaceProtoSuffix(replaceProtoSuffix(dependency))}`
path: `${this.pathToRoot}${replaceProtoSuffix(
replaceProtoSuffix(dependency)
)}`,
};
}
});
@ -130,12 +172,11 @@ export class GrpcServiceDescriptor {
namespace: filePathToPseudoNamespace(this.filename),
path: `${this.pathToRoot}${replaceProtoSuffix(this.filename)}`,
};
return [ hostProto ].concat(dependencies);
return [hostProto].concat(dependencies);
}
get services(): RPCDescriptor[] {
return this.fileDescriptor.getServiceList()
.map(service => {
return this.fileDescriptor.getServiceList().map((service) => {
return new RPCDescriptor(this, service, this.exportMap);
});
}

115
src/ts-protoc-gen/service/grpcnode.ts
View file

@ -1,16 +1,33 @@
import {ExportMap} from "../ExportMap";
import {Printer} from "../Printer";
import {FileDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {CodeGeneratorResponse} from "google-protobuf/google/protobuf/compiler/plugin_pb";
import {createFile, RPCDescriptor, GrpcServiceDescriptor, RPCMethodDescriptor} from "./common";
import { ModeParameter } from "../parameters";
import { ExportMap } from '../ExportMap';
import { Printer } from '../Printer';
import { FileDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { CodeGeneratorResponse } from 'google-protobuf/google/protobuf/compiler/plugin_pb';
import {
createFile,
RPCDescriptor,
GrpcServiceDescriptor,
RPCMethodDescriptor,
} from './common';
import { ModeParameter } from '../parameters';
export function generateGrpcNodeService(filename: string, descriptor: FileDescriptorProto, exportMap: ExportMap, modeParameter: ModeParameter): CodeGeneratorResponse.File {
const definitionFilename = filename.replace(/_pb$/, "_grpc_pb.d.ts");
return createFile(generateTypeScriptDefinition(descriptor, exportMap, modeParameter), definitionFilename);
export function generateGrpcNodeService(
filename: string,
descriptor: FileDescriptorProto,
exportMap: ExportMap,
modeParameter: ModeParameter
): CodeGeneratorResponse.File {
const definitionFilename = filename.replace(/_pb$/, '_grpc_pb.d.ts');
return createFile(
generateTypeScriptDefinition(descriptor, exportMap, modeParameter),
definitionFilename
);
}
function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, exportMap: ExportMap, modeParameter: ModeParameter): string {
function generateTypeScriptDefinition(
fileDescriptor: FileDescriptorProto,
exportMap: ExportMap,
modeParameter: ModeParameter
): string {
const serviceDescriptor = new GrpcServiceDescriptor(fileDescriptor, exportMap);
const printer = new Printer(0);
@ -18,10 +35,10 @@ function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, expor
// Header.
if (hasServices) {
printer.printLn("// GENERATED CODE -- DO NOT EDIT!");
printer.printLn('// GENERATED CODE -- DO NOT EDIT!');
printer.printEmptyLn();
} else {
printer.printLn("// GENERATED CODE -- NO SERVICES IN PROTO");
printer.printLn('// GENERATED CODE -- NO SERVICES IN PROTO');
return printer.getOutput();
}
@ -30,16 +47,17 @@ function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, expor
printer.printEmptyLn();
// Import statements.
serviceDescriptor.imports
.forEach(importDescriptor => {
printer.printLn(`import * as ${importDescriptor.namespace} from "${importDescriptor.path}";`);
serviceDescriptor.imports.forEach((importDescriptor) => {
printer.printLn(
`import * as ${importDescriptor.namespace} from "${importDescriptor.path}";`
);
});
const importPackage = modeParameter === ModeParameter.GrpcJs ? "@grpc/grpc-js" : "grpc";
const importPackage =
modeParameter === ModeParameter.GrpcJs ? '@grpc/grpc-js' : 'grpc';
printer.printLn(`import * as grpc from "${importPackage}";`);
// Services.
serviceDescriptor.services
.forEach(service => {
serviceDescriptor.services.forEach((service) => {
printer.printEmptyLn();
printService(printer, service);
printer.printEmptyLn();
@ -51,22 +69,24 @@ function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, expor
function printService(printer: Printer, service: RPCDescriptor) {
const serviceName = `${service.name}Service`;
printer.printLn(`interface I${serviceName} extends grpc.ServiceDefinition<grpc.UntypedServiceImplementation> {`);
service.methods
.forEach(method => {
printer.printLn(
`interface I${serviceName} extends grpc.ServiceDefinition<grpc.UntypedServiceImplementation> {`
);
service.methods.forEach((method) => {
const methodType = `grpc.MethodDefinition<${method.requestType}, ${method.responseType}>`;
printer.printIndentedLn(`${method.nameAsCamelCase}: ${methodType};`);
});
printer.printLn("}");
printer.printLn('}');
printer.printEmptyLn();
printer.printLn(`export const ${serviceName}: I${serviceName};`);
}
function printClient(printer: Printer, service: RPCDescriptor) {
printer.printLn(`export class ${service.name}Client extends grpc.Client {`);
printer.printIndentedLn("constructor(address: string, credentials: grpc.ChannelCredentials, options?: object);");
service.methods
.forEach(method => {
printer.printIndentedLn(
'constructor(address: string, credentials: grpc.ChannelCredentials, options?: object);'
);
service.methods.forEach((method) => {
if (!method.requestStream && !method.responseStream) {
printUnaryRequestMethod(printer, method);
} else if (!method.requestStream) {
@ -77,26 +97,31 @@ function printClient(printer: Printer, service: RPCDescriptor) {
printBidiStreamRequest(printer, method);
}
});
printer.printLn("}");
printer.printLn('}');
}
const metadata = "metadata: grpc.Metadata | null";
const options = "options: grpc.CallOptions | null";
const metadataOrOptions = "metadataOrOptions: grpc.Metadata | grpc.CallOptions | null";
const metadata = 'metadata: grpc.Metadata | null';
const options = 'options: grpc.CallOptions | null';
const metadataOrOptions = 'metadataOrOptions: grpc.Metadata | grpc.CallOptions | null';
const optionalMetadata = "metadata?: grpc.Metadata | null";
const optionalOptions = "options?: grpc.CallOptions | null";
const optionalMetadataOrOptions = "metadataOrOptions?: grpc.Metadata | grpc.CallOptions | null";
const optionalMetadata = 'metadata?: grpc.Metadata | null';
const optionalOptions = 'options?: grpc.CallOptions | null';
const optionalMetadataOrOptions =
'metadataOrOptions?: grpc.Metadata | grpc.CallOptions | null';
function printUnaryRequestMethod(printer: Printer, method: RPCMethodDescriptor) {
const name = method.nameAsCamelCase;
const argument = `argument: ${method.requestType}`;
const callback = `callback: grpc.requestCallback<${method.responseType}>`;
const returnType = "grpc.ClientUnaryCall";
const returnType = 'grpc.ClientUnaryCall';
printer.printIndentedLn(`${name}(${argument}, ${callback}): ${returnType};`);
printer.printIndentedLn(`${name}(${argument}, ${metadataOrOptions}, ${callback}): ${returnType};`);
printer.printIndentedLn(`${name}(${argument}, ${metadata}, ${options}, ${callback}): ${returnType};`);
printer.printIndentedLn(
`${name}(${argument}, ${metadataOrOptions}, ${callback}): ${returnType};`
);
printer.printIndentedLn(
`${name}(${argument}, ${metadata}, ${options}, ${callback}): ${returnType};`
);
}
function printServerStreamRequestMethod(printer: Printer, method: RPCMethodDescriptor) {
@ -104,8 +129,12 @@ function printServerStreamRequestMethod(printer: Printer, method: RPCMethodDescr
const argument = `argument: ${method.requestType}`;
const returnType = `grpc.ClientReadableStream<${method.responseType}>`;
printer.printIndentedLn(`${name}(${argument}, ${optionalMetadataOrOptions}): ${returnType};`);
printer.printIndentedLn(`${name}(${argument}, ${optionalMetadata}, ${optionalOptions}): ${returnType};`);
printer.printIndentedLn(
`${name}(${argument}, ${optionalMetadataOrOptions}): ${returnType};`
);
printer.printIndentedLn(
`${name}(${argument}, ${optionalMetadata}, ${optionalOptions}): ${returnType};`
);
}
function printClientStreamRequestMethod(printer: Printer, method: RPCMethodDescriptor) {
@ -113,9 +142,13 @@ function printClientStreamRequestMethod(printer: Printer, method: RPCMethodDescr
const callback = `callback: grpc.requestCallback<${method.responseType}>`;
const returnType = `grpc.ClientWritableStream<${method.requestType}>`;
printer.printIndentedLn(`${name}(${callback}): grpc.ClientWritableStream<${method.requestType}>;`);
printer.printIndentedLn(
`${name}(${callback}): grpc.ClientWritableStream<${method.requestType}>;`
);
printer.printIndentedLn(`${name}(${metadataOrOptions}, ${callback}): ${returnType};`);
printer.printIndentedLn(`${name}(${metadata}, ${options}, ${callback}): ${returnType};`);
printer.printIndentedLn(
`${name}(${metadata}, ${options}, ${callback}): ${returnType};`
);
}
function printBidiStreamRequest(printer: Printer, method: RPCMethodDescriptor) {
@ -123,5 +156,7 @@ function printBidiStreamRequest(printer: Printer, method: RPCMethodDescriptor) {
const returnType = `grpc.ClientDuplexStream<${method.requestType}, ${method.responseType}>`;
printer.printIndentedLn(`${name}(${optionalMetadataOrOptions}): ${returnType};`);
printer.printIndentedLn(`${name}(${optionalMetadata}, ${optionalOptions}): ${returnType};`);
printer.printIndentedLn(
`${name}(${optionalMetadata}, ${optionalOptions}): ${returnType};`
);
}

493
src/ts-protoc-gen/service/grpcweb.ts
View file

@ -1,18 +1,33 @@
import {ExportMap} from "../ExportMap";
import {Printer} from "../Printer";
import {CodePrinter} from "../CodePrinter";
import {FileDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {CodeGeneratorResponse} from "google-protobuf/google/protobuf/compiler/plugin_pb";
import {createFile, RPCMethodDescriptor, RPCDescriptor, GrpcServiceDescriptor} from "./common";
import { ExportMap } from '../ExportMap';
import { Printer } from '../Printer';
import { CodePrinter } from '../CodePrinter';
import { FileDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { CodeGeneratorResponse } from 'google-protobuf/google/protobuf/compiler/plugin_pb';
import {
createFile,
RPCMethodDescriptor,
RPCDescriptor,
GrpcServiceDescriptor,
} from './common';
export function generateGrpcWebService(filename: string, descriptor: FileDescriptorProto, exportMap: ExportMap): CodeGeneratorResponse.File[] {
export function generateGrpcWebService(
filename: string,
descriptor: FileDescriptorProto,
exportMap: ExportMap
): CodeGeneratorResponse.File[] {
return [
createFile(generateTypeScriptDefinition(descriptor, exportMap), `${filename}_service.d.ts`),
createFile(
generateTypeScriptDefinition(descriptor, exportMap),
`${filename}_service.d.ts`
),
createFile(generateJavaScript(descriptor, exportMap), `${filename}_service.js`),
];
}
function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, exportMap: ExportMap): string {
function generateTypeScriptDefinition(
fileDescriptor: FileDescriptorProto,
exportMap: ExportMap
): string {
const serviceDescriptor = new GrpcServiceDescriptor(fileDescriptor, exportMap);
const printer = new Printer(0);
@ -26,73 +41,95 @@ function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, expor
}
// Import statements.
serviceDescriptor.imports
.forEach(importDescriptor => {
printer.printLn(`import * as ${importDescriptor.namespace} from "${importDescriptor.path}";`);
serviceDescriptor.imports.forEach((importDescriptor) => {
printer.printLn(
`import * as ${importDescriptor.namespace} from "${importDescriptor.path}";`
);
});
printer.printLn(`import {grpc} from "@improbable-eng/grpc-web";`);
printer.printEmptyLn();
// Services.
serviceDescriptor.services
.forEach(service => {
serviceDescriptor.services.forEach((service) => {
// Method Type Definitions
service.methods.forEach(method => {
service.methods.forEach((method) => {
printer.printLn(`type ${method.serviceName}${method.nameAsPascalCase} = {`);
printer.printIndentedLn(`readonly methodName: string;`);
printer.printIndentedLn(`readonly service: typeof ${method.serviceName};`);
printer.printIndentedLn(`readonly requestStream: ${method.requestStream};`);
printer.printIndentedLn(`readonly responseStream: ${method.responseStream};`);
printer.printIndentedLn(`readonly requestType: typeof ${method.requestType};`);
printer.printIndentedLn(`readonly responseType: typeof ${method.responseType};`);
printer.printIndentedLn(
`readonly requestType: typeof ${method.requestType};`
);
printer.printIndentedLn(
`readonly responseType: typeof ${method.responseType};`
);
printer.printLn(`};`);
printer.printEmptyLn();
});
printer.printLn(`export class ${service.name} {`);
printer.printIndentedLn(`static readonly serviceName: string;`);
service.methods.forEach(method => {
printer.printIndentedLn(`static readonly ${method.nameAsPascalCase}: ${method.serviceName}${method.nameAsPascalCase};`);
service.methods.forEach((method) => {
printer.printIndentedLn(
`static readonly ${method.nameAsPascalCase}: ${method.serviceName}${method.nameAsPascalCase};`
);
});
printer.printLn(`}`);
printer.printEmptyLn();
});
printer.printLn(`export type ServiceError = { message: string, code: number; metadata: grpc.Metadata }`);
printer.printLn(`export type Status = { details: string, code: number; metadata: grpc.Metadata }`);
printer.printLn(
`export type ServiceError = { message: string, code: number; metadata: grpc.Metadata }`
);
printer.printLn(
`export type Status = { details: string, code: number; metadata: grpc.Metadata }`
);
printer.printEmptyLn();
printer.printLn("interface UnaryResponse {");
printer.printIndentedLn("cancel(): void;");
printer.printLn("}");
printer.printLn('interface UnaryResponse {');
printer.printIndentedLn('cancel(): void;');
printer.printLn('}');
printer.printLn(`interface ResponseStream<T> {`);
printer.printIndentedLn(`cancel(): void;`);
printer.printIndentedLn(`on(type: 'data', handler: (message: T) => void): ResponseStream<T>;`);
printer.printIndentedLn(`on(type: 'end', handler: (status?: Status) => void): ResponseStream<T>;`);
printer.printIndentedLn(`on(type: 'status', handler: (status: Status) => void): ResponseStream<T>;`);
printer.printIndentedLn(
`on(type: 'data', handler: (message: T) => void): ResponseStream<T>;`
);
printer.printIndentedLn(
`on(type: 'end', handler: (status?: Status) => void): ResponseStream<T>;`
);
printer.printIndentedLn(
`on(type: 'status', handler: (status: Status) => void): ResponseStream<T>;`
);
printer.printLn(`}`);
printer.printLn(`interface RequestStream<T> {`);
printer.printIndentedLn(`write(message: T): RequestStream<T>;`);
printer.printIndentedLn(`end(): void;`);
printer.printIndentedLn(`cancel(): void;`);
printer.printIndentedLn(`on(type: 'end', handler: (status?: Status) => void): RequestStream<T>;`);
printer.printIndentedLn(`on(type: 'status', handler: (status: Status) => void): RequestStream<T>;`);
printer.printIndentedLn(
`on(type: 'end', handler: (status?: Status) => void): RequestStream<T>;`
);
printer.printIndentedLn(
`on(type: 'status', handler: (status: Status) => void): RequestStream<T>;`
);
printer.printLn(`}`);
printer.printLn(`interface BidirectionalStream<ReqT, ResT> {`);
printer.printIndentedLn(`write(message: ReqT): BidirectionalStream<ReqT, ResT>;`);
printer.printIndentedLn(`end(): void;`);
printer.printIndentedLn(`cancel(): void;`);
printer.printIndentedLn(`on(type: 'data', handler: (message: ResT) => void): BidirectionalStream<ReqT, ResT>;`);
printer.printIndentedLn(`on(type: 'end', handler: (status?: Status) => void): BidirectionalStream<ReqT, ResT>;`);
printer.printIndentedLn(`on(type: 'status', handler: (status: Status) => void): BidirectionalStream<ReqT, ResT>;`);
printer.printIndentedLn(
`on(type: 'data', handler: (message: ResT) => void): BidirectionalStream<ReqT, ResT>;`
);
printer.printIndentedLn(
`on(type: 'end', handler: (status?: Status) => void): BidirectionalStream<ReqT, ResT>;`
);
printer.printIndentedLn(
`on(type: 'status', handler: (status: Status) => void): BidirectionalStream<ReqT, ResT>;`
);
printer.printLn(`}`);
printer.printEmptyLn();
// Add a client stub that talks with the @improbable-eng/grpc-web library
serviceDescriptor.services
.forEach(service => {
serviceDescriptor.services.forEach((service) => {
printServiceStubTypes(printer, service);
printer.printEmptyLn();
});
@ -100,7 +137,10 @@ function generateTypeScriptDefinition(fileDescriptor: FileDescriptorProto, expor
return printer.getOutput();
}
function generateJavaScript(fileDescriptor: FileDescriptorProto, exportMap: ExportMap): string {
function generateJavaScript(
fileDescriptor: FileDescriptorProto,
exportMap: ExportMap
): string {
const serviceDescriptor = new GrpcServiceDescriptor(fileDescriptor, exportMap);
const printer = new Printer(0);
@ -114,25 +154,26 @@ function generateJavaScript(fileDescriptor: FileDescriptorProto, exportMap: Expo
}
// Import Statements
serviceDescriptor.imports
.forEach(importDescriptor => {
printer.printLn(`var ${importDescriptor.namespace} = require("${importDescriptor.path}");`);
serviceDescriptor.imports.forEach((importDescriptor) => {
printer.printLn(
`var ${importDescriptor.namespace} = require("${importDescriptor.path}");`
);
});
printer.printLn(`var grpc = require("@improbable-eng/grpc-web").grpc;`);
printer.printEmptyLn();
// Services.
serviceDescriptor.services
.forEach(service => {
serviceDescriptor.services.forEach((service) => {
printer.printLn(`var ${service.name} = (function () {`);
printer.printIndentedLn(`function ${service.name}() {}`);
printer.printIndentedLn(`${service.name}.serviceName = "${service.qualifiedName}";`);
printer.printIndentedLn(
`${service.name}.serviceName = "${service.qualifiedName}";`
);
printer.printIndentedLn(`return ${service.name};`);
printer.printLn(`}());`);
printer.printEmptyLn();
service.methods
.forEach(method => {
service.methods.forEach((method) => {
printer.printLn(`${method.serviceName}.${method.nameAsPascalCase} = {`);
printer.printIndentedLn(`methodName: "${method.nameAsPascalCase}",`);
printer.printIndentedLn(`service: ${method.serviceName},`);
@ -160,9 +201,11 @@ function printServiceStub(methodPrinter: Printer, service: RPCDescriptor) {
printer
.printLn(`function ${service.name}Client(serviceHost, options) {`)
.indent().printLn(`this.serviceHost = serviceHost;`)
.indent()
.printLn(`this.serviceHost = serviceHost;`)
.printLn(`this.options = options || {};`)
.dedent().printLn(`}`)
.dedent()
.printLn(`}`)
.printEmptyLn();
service.methods.forEach((method: RPCMethodDescriptor) => {
@ -182,170 +225,276 @@ function printServiceStub(methodPrinter: Printer, service: RPCDescriptor) {
function printUnaryStubMethod(printer: CodePrinter, method: RPCMethodDescriptor) {
printer
.printLn(`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(requestMessage, metadata, callback) {`)
.indent().printLn(`if (arguments.length === 2) {`)
.indent().printLn(`callback = arguments[1];`)
.dedent().printLn("}")
.printLn(`var client = grpc.unary(${method.serviceName}.${method.nameAsPascalCase}, {`)
.indent().printLn(`request: requestMessage,`)
.printLn(
`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(requestMessage, metadata, callback) {`
)
.indent()
.printLn(`if (arguments.length === 2) {`)
.indent()
.printLn(`callback = arguments[1];`)
.dedent()
.printLn('}')
.printLn(
`var client = grpc.unary(${method.serviceName}.${method.nameAsPascalCase}, {`
)
.indent()
.printLn(`request: requestMessage,`)
.printLn(`host: this.serviceHost,`)
.printLn(`metadata: metadata,`)
.printLn(`transport: this.options.transport,`)
.printLn(`debug: this.options.debug,`)
.printLn(`onEnd: function (response) {`)
.indent().printLn(`if (callback) {`)
.indent().printLn(`if (response.status !== grpc.Code.OK) {`)
.indent().printLn(`var err = new Error(response.statusMessage);`)
.indent()
.printLn(`if (callback) {`)
.indent()
.printLn(`if (response.status !== grpc.Code.OK) {`)
.indent()
.printLn(`var err = new Error(response.statusMessage);`)
.printLn(`err.code = response.status;`)
.printLn(`err.metadata = response.trailers;`)
.printLn(`callback(err, null);`)
.dedent().printLn(`} else {`)
.indent().printLn(`callback(null, response.message);`)
.dedent().printLn(`}`)
.dedent().printLn(`}`)
.dedent().printLn(`}`)
.dedent().printLn(`});`)
.dedent()
.printLn(`} else {`)
.indent()
.printLn(`callback(null, response.message);`)
.dedent()
.printLn(`}`)
.dedent()
.printLn(`}`)
.dedent()
.printLn(`}`)
.dedent()
.printLn(`});`)
.printLn(`return {`)
.indent().printLn(`cancel: function () {`)
.indent().printLn(`callback = null;`)
.indent()
.printLn(`cancel: function () {`)
.indent()
.printLn(`callback = null;`)
.printLn(`client.close();`)
.dedent().printLn(`}`)
.dedent().printLn(`};`)
.dedent().printLn(`};`);
.dedent()
.printLn(`}`)
.dedent()
.printLn(`};`)
.dedent()
.printLn(`};`);
}
function printServerStreamStubMethod(printer: CodePrinter, method: RPCMethodDescriptor) {
printer
.printLn(`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(requestMessage, metadata) {`)
.indent().printLn(`var listeners = {`)
.indent().printLn(`data: [],`)
.printLn(
`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(requestMessage, metadata) {`
)
.indent()
.printLn(`var listeners = {`)
.indent()
.printLn(`data: [],`)
.printLn(`end: [],`)
.printLn(`status: []`)
.dedent().printLn(`};`)
.printLn(`var client = grpc.invoke(${method.serviceName}.${method.nameAsPascalCase}, {`)
.indent().printLn(`request: requestMessage,`)
.dedent()
.printLn(`};`)
.printLn(
`var client = grpc.invoke(${method.serviceName}.${method.nameAsPascalCase}, {`
)
.indent()
.printLn(`request: requestMessage,`)
.printLn(`host: this.serviceHost,`)
.printLn(`metadata: metadata,`)
.printLn(`transport: this.options.transport,`)
.printLn(`debug: this.options.debug,`)
.printLn(`onMessage: function (responseMessage) {`)
.indent().printLn(`listeners.data.forEach(function (handler) {`)
.indent().printLn(`handler(responseMessage);`)
.dedent().printLn(`});`)
.dedent().printLn(`},`)
.indent()
.printLn(`listeners.data.forEach(function (handler) {`)
.indent()
.printLn(`handler(responseMessage);`)
.dedent()
.printLn(`});`)
.dedent()
.printLn(`},`)
.printLn(`onEnd: function (status, statusMessage, trailers) {`)
.indent().printLn(`listeners.status.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`listeners.status.forEach(function (handler) {`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners.end.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners = null;`)
.dedent().printLn(`}`)
.dedent().printLn(`});`)
.dedent()
.printLn(`}`)
.dedent()
.printLn(`});`)
.printLn(`return {`)
.indent().printLn(`on: function (type, handler) {`)
.indent().printLn(`listeners[type].push(handler);`)
.indent()
.printLn(`on: function (type, handler) {`)
.indent()
.printLn(`listeners[type].push(handler);`)
.printLn(`return this;`)
.dedent().printLn(`},`)
.dedent()
.printLn(`},`)
.printLn(`cancel: function () {`)
.indent().printLn(`listeners = null;`)
.indent()
.printLn(`listeners = null;`)
.printLn(`client.close();`)
.dedent().printLn(`}`)
.dedent().printLn(`};`)
.dedent().printLn(`};`);
.dedent()
.printLn(`}`)
.dedent()
.printLn(`};`)
.dedent()
.printLn(`};`);
}
function printClientStreamStubMethod(printer: CodePrinter, method: RPCMethodDescriptor) {
printer
.printLn(`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(metadata) {`)
.indent().printLn(`var listeners = {`)
.indent().printLn(`end: [],`)
.printLn(
`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(metadata) {`
)
.indent()
.printLn(`var listeners = {`)
.indent()
.printLn(`end: [],`)
.printLn(`status: []`)
.dedent().printLn(`};`)
.printLn(`var client = grpc.client(${method.serviceName}.${method.nameAsPascalCase}, {`)
.indent().printLn(`host: this.serviceHost,`)
.dedent()
.printLn(`};`)
.printLn(
`var client = grpc.client(${method.serviceName}.${method.nameAsPascalCase}, {`
)
.indent()
.printLn(`host: this.serviceHost,`)
.printLn(`metadata: metadata,`)
.printLn(`transport: this.options.transport`)
.dedent().printLn(`});`)
.dedent()
.printLn(`});`)
.printLn(`client.onEnd(function (status, statusMessage, trailers) {`)
.indent().printLn(`listeners.status.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`listeners.status.forEach(function (handler) {`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners.end.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners = null;`)
.dedent().printLn(`});`)
.dedent()
.printLn(`});`)
.printLn(`return {`)
.indent().printLn(`on: function (type, handler) {`)
.indent().printLn(`listeners[type].push(handler);`)
.indent()
.printLn(`on: function (type, handler) {`)
.indent()
.printLn(`listeners[type].push(handler);`)
.printLn(`return this;`)
.dedent().printLn(`},`)
.dedent()
.printLn(`},`)
.printLn(`write: function (requestMessage) {`)
.indent().printLn(`if (!client.started) {`)
.indent().printLn(`client.start(metadata);`)
.dedent().printLn(`}`)
.indent()
.printLn(`if (!client.started) {`)
.indent()
.printLn(`client.start(metadata);`)
.dedent()
.printLn(`}`)
.printLn(`client.send(requestMessage);`)
.printLn(`return this;`)
.dedent().printLn(`},`)
.dedent()
.printLn(`},`)
.printLn(`end: function () {`)
.indent().printLn(`client.finishSend();`)
.dedent().printLn(`},`)
.indent()
.printLn(`client.finishSend();`)
.dedent()
.printLn(`},`)
.printLn(`cancel: function () {`)
.indent().printLn(`listeners = null;`)
.indent()
.printLn(`listeners = null;`)
.printLn(`client.close();`)
.dedent().printLn(`}`)
.dedent().printLn(`};`)
.dedent().printLn(`};`);
.dedent()
.printLn(`}`)
.dedent()
.printLn(`};`)
.dedent()
.printLn(`};`);
}
function printBidirectionalStubMethod(printer: CodePrinter, method: RPCMethodDescriptor) {
printer
.printLn(`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(metadata) {`)
.indent().printLn(`var listeners = {`)
.indent().printLn(`data: [],`)
.printLn(
`${method.serviceName}Client.prototype.${method.nameAsCamelCase} = function ${method.functionName}(metadata) {`
)
.indent()
.printLn(`var listeners = {`)
.indent()
.printLn(`data: [],`)
.printLn(`end: [],`)
.printLn(`status: []`)
.dedent().printLn(`};`)
.printLn(`var client = grpc.client(${method.serviceName}.${method.nameAsPascalCase}, {`)
.indent().printLn(`host: this.serviceHost,`)
.dedent()
.printLn(`};`)
.printLn(
`var client = grpc.client(${method.serviceName}.${method.nameAsPascalCase}, {`
)
.indent()
.printLn(`host: this.serviceHost,`)
.printLn(`metadata: metadata,`)
.printLn(`transport: this.options.transport`)
.dedent().printLn(`});`)
.dedent()
.printLn(`});`)
.printLn(`client.onEnd(function (status, statusMessage, trailers) {`)
.indent().printLn(`listeners.status.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`listeners.status.forEach(function (handler) {`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners.end.forEach(function (handler) {`)
.indent().printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent().printLn(`});`)
.indent()
.printLn(`handler({ code: status, details: statusMessage, metadata: trailers });`)
.dedent()
.printLn(`});`)
.printLn(`listeners = null;`)
.dedent().printLn(`});`)
.dedent()
.printLn(`});`)
.printLn(`client.onMessage(function (message) {`)
.indent().printLn(`listeners.data.forEach(function (handler) {`)
.indent().printLn(`handler(message);`)
.dedent().printLn(`})`)
.dedent().printLn(`});`)
.indent()
.printLn(`listeners.data.forEach(function (handler) {`)
.indent()
.printLn(`handler(message);`)
.dedent()
.printLn(`})`)
.dedent()
.printLn(`});`)
.printLn(`client.start(metadata);`)
.printLn(`return {`)
.indent().printLn(`on: function (type, handler) {`)
.indent().printLn(`listeners[type].push(handler);`)
.indent()
.printLn(`on: function (type, handler) {`)
.indent()
.printLn(`listeners[type].push(handler);`)
.printLn(`return this;`)
.dedent().printLn(`},`)
.dedent()
.printLn(`},`)
.printLn(`write: function (requestMessage) {`)
.indent().printLn(`client.send(requestMessage);`)
.indent()
.printLn(`client.send(requestMessage);`)
.printLn(`return this;`)
.dedent().printLn(`},`)
.dedent()
.printLn(`},`)
.printLn(`end: function () {`)
.indent().printLn(`client.finishSend();`)
.dedent().printLn(`},`)
.indent()
.printLn(`client.finishSend();`)
.dedent()
.printLn(`},`)
.printLn(`cancel: function () {`)
.indent().printLn(`listeners = null;`)
.indent()
.printLn(`listeners = null;`)
.printLn(`client.close();`)
.dedent().printLn(`}`)
.dedent().printLn(`};`)
.dedent().printLn(`};`);
.dedent()
.printLn(`}`)
.dedent()
.printLn(`};`)
.dedent()
.printLn(`};`);
}
function printServiceStubTypes(methodPrinter: Printer, service: RPCDescriptor) {
@ -353,7 +502,8 @@ function printServiceStubTypes(methodPrinter: Printer, service: RPCDescriptor) {
printer
.printLn(`export class ${service.name}Client {`)
.indent().printLn(`readonly serviceHost: string;`)
.indent()
.printLn(`readonly serviceHost: string;`)
.printEmptyLn()
.printLn(`constructor(serviceHost: string, options?: grpc.RpcOptions);`);
@ -368,30 +518,53 @@ function printServiceStubTypes(methodPrinter: Printer, service: RPCDescriptor) {
printUnaryStubMethodTypes(printer, method);
}
});
printer.dedent().printLn("}");
printer.dedent().printLn('}');
}
function printUnaryStubMethodTypes(printer: CodePrinter, method: RPCMethodDescriptor) {
printer
.printLn(`${method.nameAsCamelCase}(`)
.indent().printLn(`requestMessage: ${method.requestType},`)
.indent()
.printLn(`requestMessage: ${method.requestType},`)
.printLn(`metadata: grpc.Metadata,`)
.printLn(`callback: (error: ServiceError|null, responseMessage: ${method.responseType}|null) => void`)
.dedent().printLn(`): UnaryResponse;`)
.printLn(
`callback: (error: ServiceError|null, responseMessage: ${method.responseType}|null) => void`
)
.dedent()
.printLn(`): UnaryResponse;`)
.printLn(`${method.nameAsCamelCase}(`)
.indent().printLn(`requestMessage: ${method.requestType},`)
.printLn(`callback: (error: ServiceError|null, responseMessage: ${method.responseType}|null) => void`)
.dedent().printLn(`): UnaryResponse;`);
.indent()
.printLn(`requestMessage: ${method.requestType},`)
.printLn(
`callback: (error: ServiceError|null, responseMessage: ${method.responseType}|null) => void`
)
.dedent()
.printLn(`): UnaryResponse;`);
}
function printServerStreamStubMethodTypes(printer: CodePrinter, method: RPCMethodDescriptor) {
printer.printLn(`${method.nameAsCamelCase}(requestMessage: ${method.requestType}, metadata?: grpc.Metadata): ResponseStream<${method.responseType}>;`);
function printServerStreamStubMethodTypes(
printer: CodePrinter,
method: RPCMethodDescriptor
) {
printer.printLn(
`${method.nameAsCamelCase}(requestMessage: ${method.requestType}, metadata?: grpc.Metadata): ResponseStream<${method.responseType}>;`
);
}
function printClientStreamStubMethodTypes(printer: CodePrinter, method: RPCMethodDescriptor) {
printer.printLn(`${method.nameAsCamelCase}(metadata?: grpc.Metadata): RequestStream<${method.requestType}>;`);
function printClientStreamStubMethodTypes(
printer: CodePrinter,
method: RPCMethodDescriptor
) {
printer.printLn(
`${method.nameAsCamelCase}(metadata?: grpc.Metadata): RequestStream<${method.requestType}>;`
);
}
function printBidirectionalStubMethodTypes(printer: CodePrinter, method: RPCMethodDescriptor) {
printer.printLn(`${method.nameAsCamelCase}(metadata?: grpc.Metadata): BidirectionalStream<${method.requestType}, ${method.responseType}>;`);
function printBidirectionalStubMethodTypes(
printer: CodePrinter,
method: RPCMethodDescriptor
) {
printer.printLn(
`${method.nameAsCamelCase}(metadata?: grpc.Metadata): BidirectionalStream<${method.requestType}, ${method.responseType}>;`
);
}

59
src/ts-protoc-gen/ts/FieldTypes.ts
View file

@ -1,57 +1,62 @@
import {filePathToPseudoNamespace, withinNamespaceFromExportEntry} from "../util";
import {ExportMap} from "../ExportMap";
import {FieldDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import { filePathToPseudoNamespace, withinNamespaceFromExportEntry } from '../util';
import { ExportMap } from '../ExportMap';
import { FieldDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
export const MESSAGE_TYPE = 11;
export const BYTES_TYPE = 12;
export const ENUM_TYPE = 14;
const TypeNumToTypeString: {[key: number]: string} = {};
TypeNumToTypeString[1] = "number"; // TYPE_DOUBLE
TypeNumToTypeString[2] = "number"; // TYPE_FLOAT
TypeNumToTypeString[3] = "number"; // TYPE_INT64
TypeNumToTypeString[4] = "number"; // TYPE_UINT64
TypeNumToTypeString[5] = "number"; // TYPE_INT32
TypeNumToTypeString[6] = "number"; // TYPE_FIXED64
TypeNumToTypeString[7] = "number"; // TYPE_FIXED32
TypeNumToTypeString[8] = "boolean"; // TYPE_BOOL
TypeNumToTypeString[9] = "string"; // TYPE_STRING
TypeNumToTypeString[10] = "Object"; // TYPE_GROUP
TypeNumToTypeString[MESSAGE_TYPE] = "Object"; // TYPE_MESSAGE - Length-delimited aggregate.
TypeNumToTypeString[BYTES_TYPE] = "Uint8Array"; // TYPE_BYTES
TypeNumToTypeString[13] = "number"; // TYPE_UINT32
TypeNumToTypeString[ENUM_TYPE] = "number"; // TYPE_ENUM
TypeNumToTypeString[15] = "number"; // TYPE_SFIXED32
TypeNumToTypeString[16] = "number"; // TYPE_SFIXED64
TypeNumToTypeString[17] = "number"; // TYPE_SINT32 - Uses ZigZag encoding.
TypeNumToTypeString[18] = "number"; // TYPE_SINT64 - Uses ZigZag encoding.
const TypeNumToTypeString: { [key: number]: string } = {};
TypeNumToTypeString[1] = 'number'; // TYPE_DOUBLE
TypeNumToTypeString[2] = 'number'; // TYPE_FLOAT
TypeNumToTypeString[3] = 'number'; // TYPE_INT64
TypeNumToTypeString[4] = 'number'; // TYPE_UINT64
TypeNumToTypeString[5] = 'number'; // TYPE_INT32
TypeNumToTypeString[6] = 'number'; // TYPE_FIXED64
TypeNumToTypeString[7] = 'number'; // TYPE_FIXED32
TypeNumToTypeString[8] = 'boolean'; // TYPE_BOOL
TypeNumToTypeString[9] = 'string'; // TYPE_STRING
TypeNumToTypeString[10] = 'Object'; // TYPE_GROUP
TypeNumToTypeString[MESSAGE_TYPE] = 'Object'; // TYPE_MESSAGE - Length-delimited aggregate.
TypeNumToTypeString[BYTES_TYPE] = 'Uint8Array'; // TYPE_BYTES
TypeNumToTypeString[13] = 'number'; // TYPE_UINT32
TypeNumToTypeString[ENUM_TYPE] = 'number'; // TYPE_ENUM
TypeNumToTypeString[15] = 'number'; // TYPE_SFIXED32
TypeNumToTypeString[16] = 'number'; // TYPE_SFIXED64
TypeNumToTypeString[17] = 'number'; // TYPE_SINT32 - Uses ZigZag encoding.
TypeNumToTypeString[18] = 'number'; // TYPE_SINT64 - Uses ZigZag encoding.
export function getTypeName(fieldTypeNum: number): string {
return TypeNumToTypeString[fieldTypeNum];
}
export function getFieldType(type: FieldDescriptorProto.Type, typeName: string, currentFileName: string, exportMap: ExportMap): string {
export function getFieldType(
type: FieldDescriptorProto.Type,
typeName: string,
currentFileName: string,
exportMap: ExportMap
): string {
if (type === MESSAGE_TYPE) {
const fromExport = exportMap.getMessage(typeName);
if (!fromExport) {
throw new Error("Could not getFieldType for message: " + typeName);
throw new Error('Could not getFieldType for message: ' + typeName);
}
const withinNamespace = withinNamespaceFromExportEntry(typeName, fromExport);
if (fromExport.fileName === currentFileName) {
return withinNamespace;
} else {
return filePathToPseudoNamespace(fromExport.fileName) + "." + withinNamespace;
return filePathToPseudoNamespace(fromExport.fileName) + '.' + withinNamespace;
}
} else if (type === ENUM_TYPE) {
const fromExport = exportMap.getEnum(typeName);
if (!fromExport) {
throw new Error("Could not getFieldType for enum: " + typeName);
throw new Error('Could not getFieldType for enum: ' + typeName);
}
const withinNamespace = withinNamespaceFromExportEntry(typeName, fromExport);
if (fromExport.fileName === currentFileName) {
return `${withinNamespace}Map`;
} else {
return filePathToPseudoNamespace(fromExport.fileName) + "." + withinNamespace;
return filePathToPseudoNamespace(fromExport.fileName) + '.' + withinNamespace;
}
} else {
return TypeNumToTypeString[type];

10
src/ts-protoc-gen/ts/enum.ts
View file

@ -1,13 +1,15 @@
import {EnumDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {Printer} from "../Printer";
import { EnumDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { Printer } from '../Printer';
export function printEnum(enumDescriptor: EnumDescriptorProto, indentLevel: number) {
const printer = new Printer(indentLevel);
const enumInterfaceName = `${enumDescriptor.getName()}Map`;
printer.printEmptyLn();
printer.printLn(`export interface ${enumInterfaceName} {`);
enumDescriptor.getValueList().forEach(value => {
printer.printIndentedLn(`${value.getName().toUpperCase()}: ${value.getNumber()};`);
enumDescriptor.getValueList().forEach((value) => {
printer.printIndentedLn(
`${value.getName().toUpperCase()}: ${value.getNumber()};`
);
});
printer.printLn(`}`);
printer.printEmptyLn();

28
src/ts-protoc-gen/ts/extensions.ts
View file

@ -1,14 +1,26 @@
import {Printer} from "../Printer";
import {ExportMap} from "../ExportMap";
import {FieldDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {snakeToCamel} from "../util";
import {getFieldType} from "./FieldTypes";
import { Printer } from '../Printer';
import { ExportMap } from '../ExportMap';
import { FieldDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { snakeToCamel } from '../util';
import { getFieldType } from './FieldTypes';
export function printExtension(fileName: string, exportMap: ExportMap, extension: FieldDescriptorProto, indentLevel: number): string {
export function printExtension(
fileName: string,
exportMap: ExportMap,
extension: FieldDescriptorProto,
indentLevel: number
): string {
const printer = new Printer(indentLevel + 1);
printer.printEmptyLn();
const extensionName = snakeToCamel(extension.getName());
const fieldType = getFieldType(extension.getType(), extension.getTypeName().slice(1), fileName, exportMap);
printer.printLn(`export const ${extensionName}: jspb.ExtensionFieldInfo<${fieldType}>;`);
const fieldType = getFieldType(
extension.getType(),
extension.getTypeName().slice(1),
fileName,
exportMap
);
printer.printLn(
`export const ${extensionName}: jspb.ExtensionFieldInfo<${fieldType}>;`
);
return printer.output;
}

35
src/ts-protoc-gen/ts/fileDescriptorTSD.ts
View file

@ -1,13 +1,16 @@
import {filePathToPseudoNamespace, replaceProtoSuffix, getPathToRoot} from "../util";
import {ExportMap} from "../ExportMap";
import {Printer} from "../Printer";
import {FileDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {WellKnownTypesMap} from "../WellKnown";
import {printMessage} from "./message";
import {printEnum} from "./enum";
import {printExtension} from "./extensions";
import { filePathToPseudoNamespace, replaceProtoSuffix, getPathToRoot } from '../util';
import { ExportMap } from '../ExportMap';
import { Printer } from '../Printer';
import { FileDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { WellKnownTypesMap } from '../WellKnown';
import { printMessage } from './message';
import { printEnum } from './enum';
import { printExtension } from './extensions';
export function printFileDescriptorTSD(fileDescriptor: FileDescriptorProto, exportMap: ExportMap) {
export function printFileDescriptorTSD(
fileDescriptor: FileDescriptorProto,
exportMap: ExportMap
) {
const fileName = fileDescriptor.getName();
const packageName = fileDescriptor.getPackage();
@ -24,22 +27,26 @@ export function printFileDescriptorTSD(fileDescriptor: FileDescriptorProto, expo
fileDescriptor.getDependencyList().forEach((dependency: string) => {
const pseudoNamespace = filePathToPseudoNamespace(dependency);
if (dependency in WellKnownTypesMap) {
printer.printLn(`import * as ${pseudoNamespace} from "${WellKnownTypesMap[dependency]}";`);
printer.printLn(
`import * as ${pseudoNamespace} from "${WellKnownTypesMap[dependency]}";`
);
} else {
const filePath = replaceProtoSuffix(dependency);
printer.printLn(`import * as ${pseudoNamespace} from "${upToRoot}${filePath}";`);
printer.printLn(
`import * as ${pseudoNamespace} from "${upToRoot}${filePath}";`
);
}
});
fileDescriptor.getMessageTypeList().forEach(enumType => {
fileDescriptor.getMessageTypeList().forEach((enumType) => {
printer.print(printMessage(fileName, exportMap, enumType, 0, fileDescriptor));
});
fileDescriptor.getExtensionList().forEach(extension => {
fileDescriptor.getExtensionList().forEach((extension) => {
printer.print(printExtension(fileName, exportMap, extension, 0));
});
fileDescriptor.getEnumTypeList().forEach(enumType => {
fileDescriptor.getEnumTypeList().forEach((enumType) => {
printer.print(printEnum(enumType, 0));
});

254
src/ts-protoc-gen/ts/message.ts
View file

@ -1,20 +1,37 @@
import {
filePathToPseudoNamespace, snakeToCamel, uppercaseFirst, oneOfName, isProto2,
withinNamespaceFromExportEntry, normaliseFieldObjectName, stripPrefix
} from "../util";
import {ExportMap} from "../ExportMap";
filePathToPseudoNamespace,
snakeToCamel,
uppercaseFirst,
oneOfName,
isProto2,
withinNamespaceFromExportEntry,
normaliseFieldObjectName,
stripPrefix,
} from '../util';
import { ExportMap } from '../ExportMap';
import {
FieldDescriptorProto, FileDescriptorProto, DescriptorProto,
FieldOptions
} from "google-protobuf/google/protobuf/descriptor_pb";
import {MESSAGE_TYPE, BYTES_TYPE, ENUM_TYPE, getFieldType, getTypeName} from "./FieldTypes";
import {Printer} from "../Printer";
import {printEnum} from "./enum";
import {printOneOfDecl} from "./oneof";
import {printExtension} from "./extensions";
FieldDescriptorProto,
FileDescriptorProto,
DescriptorProto,
FieldOptions,
} from 'google-protobuf/google/protobuf/descriptor_pb';
import {
MESSAGE_TYPE,
BYTES_TYPE,
ENUM_TYPE,
getFieldType,
getTypeName,
} from './FieldTypes';
import { Printer } from '../Printer';
import { printEnum } from './enum';
import { printOneOfDecl } from './oneof';
import { printExtension } from './extensions';
import JSType = FieldOptions.JSType;
function hasFieldPresence(field: FieldDescriptorProto, fileDescriptor: FileDescriptorProto): boolean {
function hasFieldPresence(
field: FieldDescriptorProto,
fileDescriptor: FileDescriptorProto
): boolean {
if (field.getLabel() === FieldDescriptorProto.Label.LABEL_REPEATED) {
return false;
}
@ -34,12 +51,18 @@ function hasFieldPresence(field: FieldDescriptorProto, fileDescriptor: FileDescr
return false;
}
export function printMessage(fileName: string, exportMap: ExportMap, messageDescriptor: DescriptorProto, indentLevel: number, fileDescriptor: FileDescriptorProto) {
export function printMessage(
fileName: string,
exportMap: ExportMap,
messageDescriptor: DescriptorProto,
indentLevel: number,
fileDescriptor: FileDescriptorProto
) {
const messageName = messageDescriptor.getName();
const messageOptions = messageDescriptor.getOptions();
if (messageOptions !== undefined && messageOptions.getMapEntry()) {
// this message type is the entry tuple for a map - don't output it
return "";
return '';
}
const objectTypeName = `AsObject`;
@ -52,7 +75,7 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
const oneOfGroups: Array<Array<FieldDescriptorProto>> = [];
messageDescriptor.getFieldList().forEach(field => {
messageDescriptor.getFieldList().forEach((field) => {
if (field.hasOneofIndex()) {
const oneOfIndex = field.getOneofIndex();
let existing = oneOfGroups[oneOfIndex];
@ -62,7 +85,7 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
}
existing.push(field);
}
const snakeCaseName = stripPrefix(field.getName().toLowerCase(), "_");
const snakeCaseName = stripPrefix(field.getName().toLowerCase(), '_');
const camelCaseName = snakeToCamel(snakeCaseName);
const withUppercase = uppercaseFirst(camelCaseName);
const type = field.getType();
@ -72,53 +95,86 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
if (type === MESSAGE_TYPE) {
const fieldMessageType = exportMap.getMessage(fullTypeName);
if (fieldMessageType === undefined) {
throw new Error("No message export for: " + fullTypeName);
throw new Error('No message export for: ' + fullTypeName);
}
if (fieldMessageType.messageOptions !== undefined && fieldMessageType.messageOptions.getMapEntry()) {
if (
fieldMessageType.messageOptions !== undefined &&
fieldMessageType.messageOptions.getMapEntry()
) {
// This field is a map
const keyTuple = fieldMessageType.mapFieldOptions!.key;
const keyType = keyTuple[0];
const keyTypeName = getFieldType(keyType, keyTuple[1], fileName, exportMap);
const keyTypeName = getFieldType(
keyType,
keyTuple[1],
fileName,
exportMap
);
const valueTuple = fieldMessageType.mapFieldOptions!.value;
const valueType = valueTuple[0];
let valueTypeName = getFieldType(valueType, valueTuple[1], fileName, exportMap);
let valueTypeName = getFieldType(
valueType,
valueTuple[1],
fileName,
exportMap
);
if (valueType === BYTES_TYPE) {
valueTypeName = "Uint8Array | string";
valueTypeName = 'Uint8Array | string';
}
if (valueType === ENUM_TYPE) {
valueTypeName = `${valueTypeName}[keyof ${valueTypeName}]`;
}
printer.printIndentedLn(`get${withUppercase}Map(): jspb.Map<${keyTypeName}, ${valueTypeName}>;`);
printer.printIndentedLn(
`get${withUppercase}Map(): jspb.Map<${keyTypeName}, ${valueTypeName}>;`
);
printer.printIndentedLn(`clear${withUppercase}Map(): void;`);
toObjectType.printIndentedLn(`${camelCaseName}Map: Array<[${keyTypeName}${keyType === MESSAGE_TYPE ? ".AsObject" : ""}, ${valueTypeName}${valueType === MESSAGE_TYPE ? ".AsObject" : ""}]>,`);
toObjectType.printIndentedLn(
`${camelCaseName}Map: Array<[${keyTypeName}${
keyType === MESSAGE_TYPE ? '.AsObject' : ''
}, ${valueTypeName}${
valueType === MESSAGE_TYPE ? '.AsObject' : ''
}]>,`
);
return;
}
const withinNamespace = withinNamespaceFromExportEntry(fullTypeName, fieldMessageType);
const withinNamespace = withinNamespaceFromExportEntry(
fullTypeName,
fieldMessageType
);
if (fieldMessageType.fileName === fileName) {
exportType = withinNamespace;
} else {
exportType = filePathToPseudoNamespace(fieldMessageType.fileName) + "." + withinNamespace;
exportType =
filePathToPseudoNamespace(fieldMessageType.fileName) +
'.' +
withinNamespace;
}
} else if (type === ENUM_TYPE) {
const fieldEnumType = exportMap.getEnum(fullTypeName);
if (fieldEnumType === undefined) {
throw new Error("No enum export for: " + fullTypeName);
throw new Error('No enum export for: ' + fullTypeName);
}
const withinNamespace = withinNamespaceFromExportEntry(fullTypeName, fieldEnumType);
const withinNamespace = withinNamespaceFromExportEntry(
fullTypeName,
fieldEnumType
);
if (fieldEnumType.fileName === fileName) {
exportType = withinNamespace;
} else {
exportType = filePathToPseudoNamespace(fieldEnumType.fileName) + "." + withinNamespace;
exportType =
filePathToPseudoNamespace(fieldEnumType.fileName) +
'.' +
withinNamespace;
}
exportType = `${exportType}Map[keyof ${exportType}Map]`;
} else {
if (field.getOptions() && field.getOptions().hasJstype()) {
switch (field.getOptions().getJstype()) {
case JSType.JS_NUMBER:
exportType = "number";
exportType = 'number';
break;
case JSType.JS_STRING:
exportType = "string";
exportType = 'string';
break;
default:
exportType = getTypeName(type);
@ -132,7 +188,13 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
function printClearIfNotPresent() {
if (!hasClearMethod) {
hasClearMethod = true;
printer.printIndentedLn(`clear${withUppercase}${field.getLabel() === FieldDescriptorProto.Label.LABEL_REPEATED ? "List" : ""}(): void;`);
printer.printIndentedLn(
`clear${withUppercase}${
field.getLabel() === FieldDescriptorProto.Label.LABEL_REPEATED
? 'List'
: ''
}(): void;`
);
}
}
@ -143,22 +205,45 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
function printRepeatedAddMethod(valueType: string) {
const optionalValue = field.getType() === MESSAGE_TYPE;
printer.printIndentedLn(`add${withUppercase}(value${optionalValue ? "?" : ""}: ${valueType}, index?: number): ${valueType};`);
printer.printIndentedLn(
`add${withUppercase}(value${
optionalValue ? '?' : ''
}: ${valueType}, index?: number): ${valueType};`
);
}
if (field.getLabel() === FieldDescriptorProto.Label.LABEL_REPEATED) {// is repeated
if (field.getLabel() === FieldDescriptorProto.Label.LABEL_REPEATED) {
// is repeated
printClearIfNotPresent();
if (type === BYTES_TYPE) {
toObjectType.printIndentedLn(`${camelCaseName}List: Array<Uint8Array | string>,`);
printer.printIndentedLn(`get${withUppercase}List(): Array<Uint8Array | string>;`);
printer.printIndentedLn(`get${withUppercase}List_asU8(): Array<Uint8Array>;`);
printer.printIndentedLn(`get${withUppercase}List_asB64(): Array<string>;`);
printer.printIndentedLn(`set${withUppercase}List(value: Array<Uint8Array | string>): void;`);
printRepeatedAddMethod("Uint8Array | string");
toObjectType.printIndentedLn(
`${camelCaseName}List: Array<Uint8Array | string>,`
);
printer.printIndentedLn(
`get${withUppercase}List(): Array<Uint8Array | string>;`
);
printer.printIndentedLn(
`get${withUppercase}List_asU8(): Array<Uint8Array>;`
);
printer.printIndentedLn(
`get${withUppercase}List_asB64(): Array<string>;`
);
printer.printIndentedLn(
`set${withUppercase}List(value: Array<Uint8Array | string>): void;`
);
printRepeatedAddMethod('Uint8Array | string');
} else {
toObjectType.printIndentedLn(`${camelCaseName}List: Array<${exportType}${type === MESSAGE_TYPE ? ".AsObject" : ""}>,`);
printer.printIndentedLn(`get${withUppercase}List(): Array<${exportType}>;`);
printer.printIndentedLn(`set${withUppercase}List(value: Array<${exportType}>): void;`);
toObjectType.printIndentedLn(
`${camelCaseName}List: Array<${exportType}${
type === MESSAGE_TYPE ? '.AsObject' : ''
}>,`
);
printer.printIndentedLn(
`get${withUppercase}List(): Array<${exportType}>;`
);
printer.printIndentedLn(
`set${withUppercase}List(value: Array<${exportType}>): void;`
);
printRepeatedAddMethod(exportType);
}
} else {
@ -167,13 +252,18 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
printer.printIndentedLn(`get${withUppercase}(): Uint8Array | string;`);
printer.printIndentedLn(`get${withUppercase}_asU8(): Uint8Array;`);
printer.printIndentedLn(`get${withUppercase}_asB64(): string;`);
printer.printIndentedLn(`set${withUppercase}(value: Uint8Array | string): void;`);
printer.printIndentedLn(
`set${withUppercase}(value: Uint8Array | string): void;`
);
} else {
let fieldObjectType = exportType;
let canBeUndefined = false;
if (type === MESSAGE_TYPE) {
fieldObjectType += ".AsObject";
if (!isProto2(fileDescriptor) || (field.getLabel() === FieldDescriptorProto.Label.LABEL_OPTIONAL)) {
fieldObjectType += '.AsObject';
if (
!isProto2(fileDescriptor) ||
field.getLabel() === FieldDescriptorProto.Label.LABEL_OPTIONAL
) {
canBeUndefined = true;
}
} else {
@ -182,9 +272,19 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
}
}
const fieldObjectName = normaliseFieldObjectName(camelCaseName);
toObjectType.printIndentedLn(`${fieldObjectName}${canBeUndefined ? "?" : ""}: ${fieldObjectType},`);
printer.printIndentedLn(`get${withUppercase}(): ${exportType}${canBeUndefined ? " | undefined" : ""};`);
printer.printIndentedLn(`set${withUppercase}(value${type === MESSAGE_TYPE ? "?" : ""}: ${exportType}): void;`);
toObjectType.printIndentedLn(
`${fieldObjectName}${canBeUndefined ? '?' : ''}: ${fieldObjectType},`
);
printer.printIndentedLn(
`get${withUppercase}(): ${exportType}${
canBeUndefined ? ' | undefined' : ''
};`
);
printer.printIndentedLn(
`set${withUppercase}(value${
type === MESSAGE_TYPE ? '?' : ''
}: ${exportType}): void;`
);
}
}
printer.printEmptyLn();
@ -192,18 +292,36 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
toObjectType.printLn(`}`);
messageDescriptor.getOneofDeclList().forEach(oneOfDecl => {
printer.printIndentedLn(`get${oneOfName(oneOfDecl.getName())}Case(): ${messageName}.${oneOfName(oneOfDecl.getName())}Case;`);
messageDescriptor.getOneofDeclList().forEach((oneOfDecl) => {
printer.printIndentedLn(
`get${oneOfName(oneOfDecl.getName())}Case(): ${messageName}.${oneOfName(
oneOfDecl.getName()
)}Case;`
);
});
printer.printIndentedLn(`serializeBinary(): Uint8Array;`);
printer.printIndentedLn(`toObject(includeInstance?: boolean): ${messageName}.${objectTypeName};`);
printer.printIndentedLn(`static toObject(includeInstance: boolean, msg: ${messageName}): ${messageName}.${objectTypeName};`);
printer.printIndentedLn(`static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};`);
printer.printIndentedLn(`static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};`);
printer.printIndentedLn(`static serializeBinaryToWriter(message: ${messageName}, writer: jspb.BinaryWriter): void;`);
printer.printIndentedLn(`static deserializeBinary(bytes: Uint8Array): ${messageName};`);
printer.printIndentedLn(`static deserializeBinaryFromReader(message: ${messageName}, reader: jspb.BinaryReader): ${messageName};`);
printer.printIndentedLn(
`toObject(includeInstance?: boolean): ${messageName}.${objectTypeName};`
);
printer.printIndentedLn(
`static toObject(includeInstance: boolean, msg: ${messageName}): ${messageName}.${objectTypeName};`
);
printer.printIndentedLn(
`static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};`
);
printer.printIndentedLn(
`static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};`
);
printer.printIndentedLn(
`static serializeBinaryToWriter(message: ${messageName}, writer: jspb.BinaryWriter): void;`
);
printer.printIndentedLn(
`static deserializeBinary(bytes: Uint8Array): ${messageName};`
);
printer.printIndentedLn(
`static deserializeBinaryFromReader(message: ${messageName}, reader: jspb.BinaryReader): ${messageName};`
);
printer.printLn(`}`);
printer.printEmptyLn();
@ -212,20 +330,28 @@ export function printMessage(fileName: string, exportMap: ExportMap, messageDesc
printer.print(toObjectType.getOutput());
messageDescriptor.getNestedTypeList().forEach(nested => {
const msgOutput = printMessage(fileName, exportMap, nested, indentLevel + 1, fileDescriptor);
if (msgOutput !== "") {
messageDescriptor.getNestedTypeList().forEach((nested) => {
const msgOutput = printMessage(
fileName,
exportMap,
nested,
indentLevel + 1,
fileDescriptor
);
if (msgOutput !== '') {
// If the message class is a Map entry then it isn't output, so don't print the namespace block
printer.print(msgOutput);
}
});
messageDescriptor.getEnumTypeList().forEach(enumType => {
messageDescriptor.getEnumTypeList().forEach((enumType) => {
printer.print(`${printEnum(enumType, indentLevel + 1)}`);
});
messageDescriptor.getOneofDeclList().forEach((oneOfDecl, index) => {
printer.print(`${printOneOfDecl(oneOfDecl, oneOfGroups[index] || [], indentLevel + 1)}`);
printer.print(
`${printOneOfDecl(oneOfDecl, oneOfGroups[index] || [], indentLevel + 1)}`
);
});
messageDescriptor.getExtensionList().forEach(extension => {
messageDescriptor.getExtensionList().forEach((extension) => {
printer.print(printExtension(fileName, exportMap, extension, indentLevel + 1));
});

23
src/ts-protoc-gen/ts/oneof.ts
View file

@ -1,16 +1,25 @@
import {Printer} from "../Printer";
import {OneofDescriptorProto, FieldDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {oneOfName} from "../util";
import { Printer } from '../Printer';
import {
OneofDescriptorProto,
FieldDescriptorProto,
} from 'google-protobuf/google/protobuf/descriptor_pb';
import { oneOfName } from '../util';
export function printOneOfDecl(oneOfDecl: OneofDescriptorProto, oneOfFields: Array<FieldDescriptorProto>, indentLevel: number) {
export function printOneOfDecl(
oneOfDecl: OneofDescriptorProto,
oneOfFields: Array<FieldDescriptorProto>,
indentLevel: number
) {
const printer = new Printer(indentLevel);
printer.printEmptyLn();
printer.printLn(`export enum ${oneOfName(oneOfDecl.getName())}Case {`);
printer.printIndentedLn(`${oneOfDecl.getName().toUpperCase()}_NOT_SET = 0,`);
oneOfFields.forEach(field => {
printer.printIndentedLn(`${field.getName().toUpperCase()} = ${field.getNumber()},`);
oneOfFields.forEach((field) => {
printer.printIndentedLn(
`${field.getName().toUpperCase()} = ${field.getNumber()},`
);
});
printer.printLn("}");
printer.printLn('}');
return printer.output;
}

190
src/ts-protoc-gen/util.ts
View file

@ -1,9 +1,15 @@
import {parse} from "querystring";
import {FileDescriptorProto} from "google-protobuf/google/protobuf/descriptor_pb";
import {ExportEnumEntry, ExportMessageEntry} from "./ExportMap";
import {ServiceParameter, ModeParameter} from "./parameters";
import { parse } from 'querystring';
import { FileDescriptorProto } from 'google-protobuf/google/protobuf/descriptor_pb';
import { ExportEnumEntry, ExportMessageEntry } from './ExportMap';
import { ServiceParameter, ModeParameter } from './parameters';
export function filePathToPseudoNamespace(filePath: string): string {
return filePath.replace(".proto", "").replace(/\//g, "_").replace(/\./g, "_").replace(/\-/g, "_") + "_pb";
return (
filePath
.replace('.proto', '')
.replace(/\//g, '_')
.replace(/\./g, '_')
.replace(/\-/g, '_') + '_pb'
);
}
export function stripPrefix(str: string, prefix: string) {
@ -14,7 +20,7 @@ export function stripPrefix(str: string, prefix: string) {
}
export function snakeToCamel(str: string): string {
return str.replace(/(\_\w)/g, function(m) {
return str.replace(/(\_\w)/g, function (m) {
return m[1].toUpperCase();
});
}
@ -23,10 +29,12 @@ export function uppercaseFirst(str: string): string {
return str.charAt(0).toUpperCase() + str.slice(1);
}
const PROTO2_SYNTAX = "proto2";
const PROTO2_SYNTAX = 'proto2';
export function isProto2(fileDescriptor: FileDescriptorProto): boolean {
// Empty syntax defaults to proto2
return (fileDescriptor.getSyntax() === "" || fileDescriptor.getSyntax() === PROTO2_SYNTAX);
return (
fileDescriptor.getSyntax() === '' || fileDescriptor.getSyntax() === PROTO2_SYNTAX
);
}
export function oneOfName(name: string) {
@ -34,27 +42,31 @@ export function oneOfName(name: string) {
}
export function generateIndent(indentLevel: number): string {
let indent = "";
let indent = '';
for (let i = 0; i < indentLevel; i++) {
indent += " ";
indent += ' ';
}
return indent;
}
export function getPathToRoot(fileName: string) {
const depth = fileName.split("/").length;
return depth === 1 ? "./" : new Array(depth).join("../");
const depth = fileName.split('/').length;
return depth === 1 ? './' : new Array(depth).join('../');
}
export function withinNamespaceFromExportEntry(name: string, exportEntry: ExportMessageEntry | ExportEnumEntry) {
export function withinNamespaceFromExportEntry(
name: string,
exportEntry: ExportMessageEntry | ExportEnumEntry
) {
return exportEntry.pkg ? name.substring(exportEntry.pkg.length + 1) : name;
}
export function replaceProtoSuffix(protoFilePath: string): string {
const suffix = ".proto";
const hasProtoSuffix = protoFilePath.slice(protoFilePath.length - suffix.length) === suffix;
const suffix = '.proto';
const hasProtoSuffix =
protoFilePath.slice(protoFilePath.length - suffix.length) === suffix;
return hasProtoSuffix
? protoFilePath.slice(0, -suffix.length) + "_pb"
? protoFilePath.slice(0, -suffix.length) + '_pb'
: protoFilePath;
}
@ -63,17 +75,17 @@ export function withAllStdIn(callback: (buffer: Buffer) => void): void {
let len = 0;
const stdin = process.stdin;
stdin.on("readable", function () {
stdin.on('readable', function () {
let chunk;
while ((chunk = stdin.read())) {
if (!(chunk instanceof Buffer)) throw new Error("Did not receive buffer");
if (!(chunk instanceof Buffer)) throw new Error('Did not receive buffer');
ret.push(chunk);
len += chunk.length;
}
});
stdin.on("end", function () {
stdin.on('end', function () {
callback(Buffer.concat(ret, len));
});
}
@ -82,64 +94,64 @@ export function withAllStdIn(callback: (buffer: Buffer) => void): void {
// to match the logic found in `protobuf/compiler/js/js_generator.cc`. See: https://goo.gl/tX1dPQ
export function normaliseFieldObjectName(name: string): string {
switch (name) {
case "abstract":
case "boolean":
case "break":
case "byte":
case "case":
case "catch":
case "char":
case "class":
case "const":
case "continue":
case "debugger":
case "default":
case "delete":
case "do":
case "double":
case "else":
case "enum":
case "export":
case "extends":
case "false":
case "final":
case "finally":
case "float":
case "for":
case "function":
case "goto":
case "if":
case "implements":
case "import":
case "in":
case "instanceof":
case "int":
case "interface":
case "long":
case "native":
case "new":
case "null":
case "package":
case "private":
case "protected":
case "public":
case "return":
case "short":
case "static":
case "super":
case "switch":
case "synchronized":
case "this":
case "throw":
case "throws":
case "transient":
case "try":
case "typeof":
case "var":
case "void":
case "volatile":
case "while":
case "with":
case 'abstract':
case 'boolean':
case 'break':
case 'byte':
case 'case':
case 'catch':
case 'char':
case 'class':
case 'const':
case 'continue':
case 'debugger':
case 'default':
case 'delete':
case 'do':
case 'double':
case 'else':
case 'enum':
case 'export':
case 'extends':
case 'false':
case 'final':
case 'finally':
case 'float':
case 'for':
case 'function':
case 'goto':
case 'if':
case 'implements':
case 'import':
case 'in':
case 'instanceof':
case 'int':
case 'interface':
case 'long':
case 'native':
case 'new':
case 'null':
case 'package':
case 'private':
case 'protected':
case 'public':
case 'return':
case 'short':
case 'static':
case 'super':
case 'switch':
case 'synchronized':
case 'this':
case 'throw':
case 'throws':
case 'transient':
case 'try':
case 'typeof':
case 'var':
case 'void':
case 'volatile':
case 'while':
case 'with':
return `pb_${name}`;
}
return name;
@ -147,12 +159,14 @@ export function normaliseFieldObjectName(name: string): string {
export function getServiceParameter(service?: string): ServiceParameter {
switch (service) {
case "true":
console.warn("protoc-gen-ts warning: The service=true parameter has been deprecated. Use service=grpc-web instead.");
case 'true':
console.warn(
'protoc-gen-ts warning: The service=true parameter has been deprecated. Use service=grpc-web instead.'
);
return ServiceParameter.GrpcWeb;
case "grpc-web":
case 'grpc-web':
return ServiceParameter.GrpcWeb;
case "grpc-node":
case 'grpc-node':
return ServiceParameter.GrpcNode;
case undefined:
return ServiceParameter.None;
@ -163,7 +177,7 @@ export function getServiceParameter(service?: string): ServiceParameter {
export function getModeParameter(mode?: string): ModeParameter {
switch (mode) {
case "grpc-js":
case 'grpc-js':
return ModeParameter.GrpcJs;
case undefined:
return ModeParameter.None;
@ -172,13 +186,15 @@ export function getModeParameter(mode?: string): ModeParameter {
}
}
export function getParameterEnums(parameter: string): {
service: ServiceParameter,
mode: ModeParameter
export function getParameterEnums(
parameter: string
): {
service: ServiceParameter;
mode: ModeParameter;
} {
const {service, mode} = parse(parameter, ",");
const { service, mode } = parse(parameter, ',');
return {
service: getServiceParameter(service),
mode: getModeParameter(mode)
mode: getModeParameter(mode),
};
}