@typespec/protobuf 0.43.0

package/test/scenarios/array-nested/input/main.tsp

@@ -0,0 +1,20 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace com.azure.Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string[][];
+}
+
+model Output {
+  @field(1) testOutputField: int32[];
+  @field(2) secondField: string;
+}

package/test/scenarios/cross package references/input/main.tsp

@@ -0,0 +1,27 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "A",
+})
+namespace A {
+  model Output {
+    @field(1) testOutputField: int32;
+    @field(2) secondField: string;
+  }
+}
+
+@package({
+  name: "B",
+})
+namespace B {
+  @Protobuf.service
+  interface Service {
+    foo(...Input): A.Output;
+  }
+
+  model Input {
+    @field(1) testInputField: string;
+  }
+}

package/test/scenarios/cross package references/output/@typespec/protobuf/A.proto

@@ -0,0 +1,10 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package A;
+
+message Output {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}

package/test/scenarios/cross package references/output/@typespec/protobuf/B.proto

@@ -0,0 +1,15 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package B;
+
+import "A.proto";
+
+message Input {
+  string testInputField = 1;
+}
+
+service Service {
+  rpc Foo(Input) returns (A.Output);
+}

package/test/scenarios/derived-scalar/input/main.tsp

@@ -0,0 +1,24 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.Test",
+})
+namespace Test;
+
+scalar MyInt32 extends int32;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+}
+
+model Output {
+  @field(1) testOutputField: MyInt32;
+  @field(2) secondField: string;
+}

package/test/scenarios/derived-scalar/output/@typespec/protobuf/com/azure/Test.proto

@@ -0,0 +1,18 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package com.azure.Test;
+
+message Input {
+  string testInputField = 1;
+}
+
+message Output {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}
+
+service Service {
+  rpc Foo(Input) returns (Output);
+}

package/test/scenarios/enum/input/main.tsp

@@ -0,0 +1,33 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+  @field(2) type: InputType;
+  @field(3) aliased: InputTypeWithAlias;
+}
+
+enum InputType {
+  FOO: 0,
+  BAR: 1,
+}
+
+enum InputTypeWithAlias {
+  BAZ: 0,
+  QUX: 1,
+  FUZ: 1,
+}
+
+model Output {
+  @field(1) testOutputField: int32;
+  @field(2) secondField: string;
+}

package/test/scenarios/enum/output/@typespec/protobuf/main.proto

@@ -0,0 +1,31 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+enum InputType {
+  FOO = 0;
+  BAR = 1;
+}
+
+enum InputTypeWithAlias {
+  option allow_alias = true;
+
+  BAZ = 0;
+  QUX = 1;
+  FUZ = 1;
+}
+
+message Input {
+  string testInputField = 1;
+  InputType type = 2;
+  InputTypeWithAlias aliased = 3;
+}
+
+message Output {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}
+
+service Service {
+  rpc Foo(Input) returns (Output);
+}

package/test/scenarios/enum-nonintegral/diagnostics.txt

@@ -0,0 +1,4 @@
+/test/main.tsp:18:1 - error @typespec/protobuf/unconvertible-enum: enums must explicitly assign exactly one integer to each member to be used in a Protobuf message
+/test/main.tsp:19:3 - error @typespec/protobuf/unconvertible-enum: the first variant of an enum must be set to zero to be used in a Protobuf message
+/test/main.tsp:23:1 - error @typespec/protobuf/unconvertible-enum: enums must explicitly assign exactly one integer to each member to be used in a Protobuf message
+/test/main.tsp:24:3 - error @typespec/protobuf/unconvertible-enum: the first variant of an enum must be set to zero to be used in a Protobuf message

package/test/scenarios/enum-nonintegral/input/main.tsp

@@ -0,0 +1,31 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+  @field(2) type: InputType;
+}
+
+enum InputType {
+  FOO: 1,
+  BAR: "test",
+}
+
+enum OutputType {
+  FOO,
+  BAR,
+}
+
+model Output {
+  @field(1) testOutputField: OutputType;
+  @field(2) secondField: string;
+}

package/test/scenarios/enum-nozero/diagnostics.txt

@@ -0,0 +1 @@
+/test/main.tsp:19:3 - error @typespec/protobuf/unconvertible-enum: the first variant of an enum must be set to zero to be used in a Protobuf message

package/test/scenarios/enum-nozero/input/main.tsp

@@ -0,0 +1,25 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+  @field(2) type: InputType;
+}
+
+enum InputType {
+  FOO: 1,
+  BAR: 2,
+}
+
+model Output {
+  @field(2) secondField: string;
+}

package/test/scenarios/extern/input/main.tsp

@@ -0,0 +1,17 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...MyExtern): WellKnown.Empty;
+
+  bar(@field(1) empty: WellKnown.Empty): {
+    @field(1) myExtern: MyExtern;
+  };
+}
+
+model MyExtern is Extern<"foo/bar.proto", "foo.Bar">;

package/test/scenarios/extern/output/@typespec/protobuf/main.proto

@@ -0,0 +1,19 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+import "foo/bar.proto";
+import "google/protobuf/empty.proto";
+
+message BarRequest {
+  google.protobuf.Empty empty = 1;
+}
+
+message BarResponse {
+  foo.Bar myExtern = 1;
+}
+
+service Service {
+  rpc Foo(foo.Bar) returns (google.protobuf.Empty);
+  rpc Bar(BarRequest) returns (BarResponse);
+}

package/test/scenarios/illegal field reservations/diagnostics.txt

@@ -0,0 +1,2 @@
+/test/.tsp/lib/lib.tsp:81:1 - error @typespec/protobuf/illegal-reservation: reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a range
+/test/.tsp/lib/lib.tsp:51:1 - error @typespec/protobuf/illegal-reservation: reservation value must be a string literal, uint32 literal, or a tuple of two uint32 literals denoting a range

package/test/scenarios/illegal field reservations/input/main.tsp

@@ -0,0 +1,16 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): {};
+}
+
+@reserve(2, 15, [9, 11], "foo", string, uint32)
+model Input {
+  @field(1) testInputField: string;
+}

package/test/scenarios/inferred-message-names/input/main.tsp

@@ -0,0 +1,16 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.test",
+})
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(@field(1) testInputField: string): {
+    @field(1) testOutputField: int32;
+    @field(2) secondField: string;
+  };
+}

package/test/scenarios/inferred-message-names/output/@typespec/protobuf/com/azure/test.proto

@@ -0,0 +1,18 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package com.azure.test;
+
+message FooRequest {
+  string testInputField = 1;
+}
+
+message FooResponse {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}
+
+service Service {
+  rpc Foo(FooRequest) returns (FooResponse);
+}

package/test/scenarios/intrinsics/input/main.tsp

@@ -0,0 +1,17 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.Test",
+})
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): void;
+}
+
+model Input {
+  @field(1) testInputField: unknown;
+}

package/test/scenarios/intrinsics/output/@typespec/protobuf/com/azure/Test.proto

@@ -0,0 +1,16 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package com.azure.Test;
+
+import "google/protobuf/any.proto";
+import "google/protobuf/empty.proto";
+
+message Input {
+  google.protobuf.Any testInputField = 1;
+}
+
+service Service {
+  rpc Foo(Input) returns (google.protobuf.Empty);
+}

package/test/scenarios/map/input/main.tsp

@@ -0,0 +1,15 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): WellKnown.Empty;
+}
+
+model Input {
+  @field(1) testInputField: Map<sfixed32, string>;
+}

package/test/scenarios/map/output/@typespec/protobuf/main.proto

@@ -0,0 +1,13 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+import "google/protobuf/empty.proto";
+
+message Input {
+  map<sfixed32, string> testInputField = 1;
+}
+
+service Service {
+  rpc Foo(Input) returns (google.protobuf.Empty);
+}

package/test/scenarios/model-no-package/diagnostics.txt

@@ -0,0 +1,2 @@
+/test/main.tsp:14:12 - error @typespec/protobuf/model-not-in-package: model Input is not in a namespace that uses the '@Protobuf.package' decorator
+/test/main.tsp:17:13 - error @typespec/protobuf/model-not-in-package: model Input is not in a namespace that uses the '@Protobuf.package' decorator

package/test/scenarios/model-no-package/input/main.tsp

@@ -0,0 +1,19 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+model Input {
+  @field(1) name: string;
+}
+
+@package
+namespace Test {
+  @Protobuf.service
+  interface Service {
+    // Reference a message type that isn't in this package.
+    example(@field(1) input: Input): WellKnown.Empty;
+
+    // Spread input directly
+    example2(...Input): WellKnown.Any;
+  }
+}

package/test/scenarios/name-collision/input/main.tsp

@@ -0,0 +1,24 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+model ExampleRequest {
+  @field(1) test: uint32;
+}
+
+model ExampleResponse {
+  @field(1) test: string;
+}
+
+@Protobuf.service
+interface Service {
+  // invalid field index
+  example(@field(1) test: string): {
+    @field(1) test: uint32;
+  };
+
+  example2(...ExampleRequest): ExampleResponse;
+}

package/test/scenarios/name-collision/output/@typespec/protobuf/main.proto

@@ -0,0 +1,24 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+message ExampleRequest {
+  uint32 test = 1;
+}
+
+message ExampleResponse {
+  string test = 1;
+}
+
+message ExampleRequest {
+  string test = 1;
+}
+
+message ExampleResponse {
+  uint32 test = 1;
+}
+
+service Service {
+  rpc Example(ExampleRequest) returns (ExampleResponse);
+  rpc Example2(ExampleRequest) returns (ExampleResponse);
+}

package/test/scenarios/options/input/main.tsp

@@ -0,0 +1,25 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.Test",
+  options: {
+    java_package: "com.azure.test",
+  },
+})
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+}
+
+model Output {
+  @field(1) testOutputField: int32;
+  @field(2) secondField: string;
+}

package/test/scenarios/options/output/@typespec/protobuf/com/azure/Test.proto

@@ -0,0 +1,20 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package com.azure.Test;
+
+option java_package = "com.azure.test";
+
+message Input {
+  string testInputField = 1;
+}
+
+message Output {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}
+
+service Service {
+  rpc Foo(Input) returns (Output);
+}

package/test/scenarios/options-invalid/diagnostics.txt

@@ -0,0 +1 @@
+/test/main.tsp:5:10 - error invalid-argument: Argument '(anonymous model)' is not assignable to parameter of type 'TypeSpec.Protobuf.PackageDetails'

package/test/scenarios/options-invalid/input/main.tsp

@@ -0,0 +1,25 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.Test",
+  options: {
+    java_package: {},
+  },
+})
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+}
+
+model Output {
+  @field(1) testOutputField: int32;
+  @field(2) secondField: string;
+}

package/test/scenarios/reserved field collisions/diagnostics.txt

@@ -0,0 +1,5 @@
+/test/main.tsp:15:13 - error @typespec/protobuf/field-name: field name 'foo' was reserved by a call to @reserve on this model
+/test/main.tsp:16:10 - error @typespec/protobuf/field-index: field index 2 was reserved by a call to @reserve on this model
+/test/main.tsp:17:10 - error @typespec/protobuf/field-index: field index 9 falls within a range reserved by a call to @reserve on this model
+/test/main.tsp:18:10 - error @typespec/protobuf/field-index: field index 11 falls within a range reserved by a call to @reserve on this model
+/test/main.tsp:18:14 - error @typespec/protobuf/field-name: field name 'bar' was reserved by a call to @reserve on this model

package/test/scenarios/reserved field collisions/input/main.tsp

@@ -0,0 +1,19 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): {};
+}
+
+@reserve(2, 15, [9, 11], "foo", "bar")
+model Input {
+  @field(1) foo: string;
+  @field(2) field2: int32;
+  @field(9) field9: uint32;
+  @field(11) bar: sint32;
+}

package/test/scenarios/reserved fields/input/main.tsp

@@ -0,0 +1,16 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): {};
+}
+
+@reserve(2, 15, [9, 11], "foo", "bar")
+model Input {
+  @field(1) testInputField: string;
+}

package/test/scenarios/reserved fields/output/@typespec/protobuf/main.proto

@@ -0,0 +1,16 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+message Input {
+  reserved 2, 15, 9 to 11;
+  reserved "foo", "bar";
+
+  string testInputField = 1;
+}
+
+message FooResponse {}
+
+service Service {
+  rpc Foo(Input) returns (FooResponse);
+}

package/test/scenarios/simple/input/main.tsp

@@ -0,0 +1,22 @@
+import "@typespec/protobuf";
+
+using TypeSpec.Protobuf;
+
+@package({
+  name: "com.azure.Test",
+})
+namespace Test;
+
+@Protobuf.service
+interface Service {
+  foo(...Input): Output;
+}
+
+model Input {
+  @field(1) testInputField: string;
+}
+
+model Output {
+  @field(1) testOutputField: int32;
+  @field(2) secondField: string;
+}

package/test/scenarios/simple/output/@typespec/protobuf/com/azure/Test.proto

@@ -0,0 +1,18 @@
+/* Generated by Microsoft TypeSpec */
+
+syntax = "proto3";
+
+package com.azure.Test;
+
+message Input {
+  string testInputField = 1;
+}
+
+message Output {
+  int32 testOutputField = 1;
+  string secondField = 2;
+}
+
+service Service {
+  rpc Foo(Input) returns (Output);
+}