feat: Add google.api.http support

.gitignore

@@ -8,6 +8,7 @@ build/
 coverage/
 yarn-error.log
 .DS_Store
+tmp/
 
 # Yarn
 .pnp.*

HTTP.markdown

@@ -0,0 +1,112 @@
+# Http
+
+If we have to following `.proto` file:
+
+```protobuf
+syntax = "proto3";
+
+import "google/api/annotations.proto";
+
+service Messaging {
+  rpc GetMessage(GetMessageRequest) returns (GetMessageResponse) {
+    option (google.api.http) = {
+      get:"/v1/messages/{message_id}"
+    };
+  }
+  rpc CreateMessage(CreateMessageRequest) returns (CreateMessageResponse) {
+    option (google.api.http) = {
+      post:"/v1/messages/{message_id}"
+      body: "message"
+    };
+  }
+  rpc UpdateMessage(CreateMessageRequest) returns (CreateMessageResponse) {
+    option (google.api.http) = {
+      patch:"/v1/messages/{message_id}"
+      body: "*"
+    };
+  }
+}
+
+message GetMessageRequest {
+  string message_id = 1;
+}
+message GetMessageResponse {
+  string message = 1;
+}
+
+message CreateMessageRequest {
+  string message_id = 1;
+  string message = 2; // mapped to the body
+}
+
+message CreateMessageResponse {}
+```
+
+The output will be
+
+```typescript
+// ...
+export interface GetMessageRequest {
+  messageId: string;
+}
+
+export interface GetMessageResponse {
+  message: string;
+}
+
+export interface CreateMessageRequest {
+  messageId: string;
+  /** mapped to the body */
+  message: string;
+}
+
+export interface CreateMessageResponse {}
+
+export const Messaging = {
+  getMessage: {
+    path: "/v1/messages/{message_id}",
+    method: "get",
+    requestType: undefined as GetMessageRequest,
+    responseType: undefined as GetMessageResponse,
+  },
+
+  createMessage: {
+    path: "/v1/messages/{message_id}",
+    method: "post",
+    body: "message",
+    requestType: undefined as CreateMessageRequest,
+    responseType: undefined as CreateMessageResponse,
+  },
+
+  updateMessage: {
+    path: "/v1/messages/{message_id}",
+    method: "patch",
+    body: "*",
+    requestType: undefined as CreateMessageRequest,
+    responseType: undefined as CreateMessageResponse,
+  },
+};
+```
+
+## Client implementation example
+
+```typescript
+// This is just an example, do not use it directly.
+function createApi<T extends { path: string; method: "get"; request?: unknown; response?: unknown }>(config: T) {
+  return function api(payload: T["requestType"]): Promise<T["responseType"]> {
+    const path = config.path.replace("{message_id}", payload.messageId);
+    const method = config.method;
+    const body = method === "get" ? undefined : JSON.stringify({ message: payload.message });
+
+    return fetch(path, { method, body });
+  };
+}
+
+const getMessage = createApi(Messaging.getMessage);
+
+getMessage({
+  messageId: "123",
+}).then((res) => {
+  // ...
+});
+```

Makefile

@@ -0,0 +1,17 @@
+.PHONY: build-vendor
+build-vendor:
+	@rm -rf tmp
+	@mkdir -p tmp/googleapis
+	@cd tmp/googleapis && \
+		git init && \
+		git remote add origin git@github.com:googleapis/googleapis.git && \
+		git fetch origin 47947b2fb9bdde9b02a7dd173a5077a1cc2beb25 && \
+		git checkout FETCH_HEAD && \
+		cd ../..
+	@rm -rf vendor
+	@mkdir vendor
+	@protoc \
+	  --js_out=import_style=commonjs,binary:vendor \
+		-I tmp/googleapis \
+		tmp/googleapis/google/api/http.proto tmp/googleapis/google/api/annotations.proto
+	@rm -rf tmp

README.markdown

@@ -147,8 +147,6 @@ If you'd like an out-of-the-box RPC framework built on top of ts-proto, there ar
 
 (Note for potential contributors, if you develop other frameworks/mini-frameworks, or even blog posts/tutorials, on using `ts-proto`, we're happy to link to them.)
 
-We also don't support clients for `google.api.http`-based [Google Cloud](https://cloud.google.com/endpoints/docs/grpc/transcoding) APIs, see [#948](https://github.com/stephenh/ts-proto/issues/948) if you'd like to submit a PR.
-
 # Example Types
 
 The generated types are "just data", i.e.:
@@ -428,6 +426,10 @@ Generated code will be placed in the Gradle build directory.
 
   Note that `addGrpcMetadata`, `addNestjsRestParameter` and `returnObservable` will still be false.
 
+- With `--ts_proto_opt=http=true`, the defaults will change to generate http friendly types & service metadata that can be used to create your own http client. See the [http readme](HTTP.markdown) for more information and implementation examples.
+
+  Specifically `outputEncodeMethods`, `outputJsonMethods`, and `outputClientImpl` will all be false, `lowerCaseServiceMethods` will be true and `outputServices` will be ignored.
+
 - With `--ts_proto_opt=useDate=false`, fields of type `google.protobuf.Timestamp` will not be mapped to type `Date` in the generated types. See [Timestamp](#timestamp) for more details.
 
 - With `--ts_proto_opt=useMongoObjectId=true`, fields of a type called ObjectId where the message is constructed to have on field called value that is a string will be mapped to type `mongodb.ObjectId` in the generated types. This will require your project to install the mongodb npm package. See [ObjectId](#objectid) for more details.
@@ -702,6 +704,14 @@ The commands below assume you have **Docker** installed. If you are using OS X,
   > - `proto2pbjs` — Generates a reference implementation using `pbjs` for testing compatibility.
 - Run `yarn test`
 
+**Vendor**
+
+To update [vendor](./vendor/) code
+
+1. Install [Code Generator Plugins](https://github.com/grpc/grpc-web?tab=readme-ov-file#code-generator-plugins)
+2. Update the commit id in [Makefile](./Makefile#L8).
+3. Run `make build-vendor`.
+
 **Workflow**
 
 - Add/update an integration test for your use case

integration/http/google/api/annotations.proto

@@ -0,0 +1,31 @@
+// Copyright 2024 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+syntax = "proto3";
+
+package google.api;
+
+import "google/api/http.proto";
+import "google/protobuf/descriptor.proto";
+
+option go_package = "google.golang.org/genproto/googleapis/api/annotations;annotations";
+option java_multiple_files = true;
+option java_outer_classname = "AnnotationsProto";
+option java_package = "com.google.api";
+option objc_class_prefix = "GAPI";
+
+extend google.protobuf.MethodOptions {
+  // See `HttpRule`.
+  HttpRule http = 72295728;
+}

integration/http/google/api/annotations.ts

@@ -0,0 +1,6 @@
+// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
+// source: google/api/annotations.proto
+
+/* eslint-disable */
+
+export const protobufPackage = "google.api";