@typespec/http-specs 0.1.0-alpha.9 → 0.1.0-dev.0

package/specs/type/file/mockapi.ts

@@ -0,0 +1,200 @@
+import { MockRequest, passOnSuccess, ScenarioMockApi, ValidationError } from "@typespec/spec-api";
+import { pngFile } from "../../helper.js";
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+// Helper function to check file content
+function checkFileContent(req: MockRequest, expectedFile: Buffer) {
+  req.expect.rawBodyEquals(expectedFile);
+}
+
+// Body tests - Request with specific content type
+Scenarios.Type_File_Body_uploadFileSpecificContentType = passOnSuccess({
+  uri: "/type/file/body/request/specific-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    req.expect.containsHeader("content-type", "image/png");
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with JSON content type
+Scenarios.Type_File_Body_uploadFileJsonContentType = passOnSuccess({
+  uri: "/type/file/body/request/json-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "application/json",
+      rawContent: JSON.stringify({ message: "test file content" }),
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    req.expect.containsHeader("content-type", "application/json");
+    req.expect.rawBodyEquals(JSON.stringify({ message: "test file content" }));
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with JSON content type
+Scenarios.Type_File_Body_downloadFileJsonContentType = passOnSuccess({
+  uri: "/type/file/body/response/json-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "application/json",
+      rawContent: JSON.stringify({ message: "test file content" }),
+    },
+  },
+  handler(req: MockRequest) {
+    return {
+      status: 200,
+      body: {
+        contentType: "application/json",
+        rawContent: JSON.stringify({ message: "test file content" }),
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with specific content type
+Scenarios.Type_File_Body_downloadFileSpecificContentType = passOnSuccess({
+  uri: "/type/file/body/response/specific-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with multiple content types
+Scenarios.Type_File_Body_uploadFileMultipleContentTypes = passOnSuccess({
+  uri: "/type/file/body/request/multiple-content-types",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    // Client should send image/png (one of the allowed types)
+    const contentType = req.headers["content-type"];
+    if (contentType !== "image/png" && contentType !== "image/jpeg") {
+      throw new ValidationError(
+        "Expected content-type to be image/png or image/jpeg",
+        "image/png or image/jpeg",
+        contentType,
+      );
+    }
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with multiple content types
+Scenarios.Type_File_Body_downloadFileMultipleContentTypes = passOnSuccess({
+  uri: "/type/file/body/response/multiple-content-types",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    // Server returns image/png (one of the allowed types)
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Request with default content type
+Scenarios.Type_File_Body_uploadFileDefaultContentType = passOnSuccess({
+  uri: "/type/file/body/request/default-content-type",
+  method: "post",
+  request: {
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  response: {
+    status: 204,
+  },
+  handler(req: MockRequest) {
+    // File type accepts any content type, but for testing we expect image/png
+    req.expect.containsHeader("content-type", "image/png");
+    checkFileContent(req, pngFile);
+    return { status: 204 };
+  },
+  kind: "MockApiDefinition",
+});
+
+// Body tests - Response with default content type
+Scenarios.Type_File_Body_downloadFileDefaultContentType = passOnSuccess({
+  uri: "/type/file/body/response/default-content-type",
+  method: "get",
+  request: {},
+  response: {
+    status: 200,
+    body: {
+      contentType: "image/png",
+      rawContent: pngFile,
+    },
+  },
+  handler(req: MockRequest) {
+    // File type accepts any content type, but for testing we return image/png
+    return {
+      status: 200,
+      body: {
+        contentType: "image/png",
+        rawContent: pngFile,
+      },
+    };
+  },
+  kind: "MockApiDefinition",
+});

package/specs/type/model/empty/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Empty_putEmpty = passOnSuccess({
   uri: "/type/model/empty/alone",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,
@@ -30,7 +30,7 @@ Scenarios.Type_Model_Empty_postRoundTripEmpty = passOnSuccess({
   uri: "/type/model/empty/round-trip",
   method: "post",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/enum-discriminator/mockapi.ts

@@ -39,7 +39,7 @@ function createGetPutServerTests(uri: string, data: any) {
       uri: uri,
       method: "put",
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,

package/specs/type/model/inheritance/nested-discriminator/mockapi.ts

@@ -78,7 +78,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putModel = passOnSuccess({
   uri: "/type/model/inheritance/nested-discriminator/model",
   method: "put",
   request: {
-    body: validPolymorphicBody,
+    body: json(validPolymorphicBody),
   },
   response: {
     status: 204,
@@ -100,7 +100,7 @@ Scenarios.Type_Model_Inheritance_NestedDiscriminator_putRecursiveModel = passOnS
   uri: "/type/model/inheritance/nested-discriminator/recursivemodel",
   method: "put",
   request: {
-    body: validRecursiveBody,
+    body: json(validRecursiveBody),
   },
   response: {
     status: 204,

package/specs/type/model/inheritance/not-discriminated/mockapi.ts

@@ -8,7 +8,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_postValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "post",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 204,
@@ -29,7 +29,7 @@ Scenarios.Type_Model_Inheritance_NotDiscriminated_putValid = passOnSuccess({
   uri: "/type/model/inheritance/not-discriminated/valid",
   method: "put",
   request: {
-    body: inheritanceValidBody,
+    body: json(inheritanceValidBody),
   },
   response: {
     status: 200,

package/specs/type/model/inheritance/recursive/mockapi.ts

@@ -22,7 +22,7 @@ Scenarios.Type_Model_Inheritance_Recursive_put = passOnSuccess({
   uri: "/type/model/inheritance/recursive",
   method: "put",
   request: {
-    body: body,
+    body: json(body),
   },
   response: {
     status: 204,

package/specs/type/model/inheritance/single-discriminator/mockapi.ts

@@ -40,7 +40,7 @@ Scenarios.Type_Model_Inheritance_SingleDiscriminator_putModel = passOnSuccess({
   uri: "/type/model/inheritance/single-discriminator/model",
   method: "put",
   request: {
-    body: validPolymorphicBody,
+    body: json(validPolymorphicBody),
   },
   response: {
     status: 204,
@@ -62,7 +62,7 @@ Scenarios.Type_Model_Inheritance_SingleDiscriminator_putRecursiveModel = passOnS
   uri: "/type/model/inheritance/single-discriminator/recursivemodel",
   method: "put",
   request: {
-    body: validRecursiveBody,
+    body: json(validRecursiveBody),
   },
   response: {
     status: 204,

package/specs/type/model/usage/mockapi.ts

@@ -8,9 +8,9 @@ Scenarios.Type_Model_Usage_input = passOnSuccess({
   uri: "/type/model/usage/input",
   method: "post",
   request: {
-    body: {
+    body: json({
       requiredProp: "example-value",
-    },
+    }),
   },
   response: {
     status: 204,
@@ -33,9 +33,9 @@ Scenarios.Type_Model_Usage_inputAndOutput = passOnSuccess({
   uri: "/type/model/usage/input-output",
   method: "post",
   request: {
-    body: {
+    body: json({
       requiredProp: "example-value",
-    },
+    }),
   },
   response: {
     status: 200,

package/specs/type/model/visibility/main.tsp

@@ -14,8 +14,10 @@ model VisibilityModel {
   @visibility(Lifecycle.Read)
   readProp: string;
 
+  #suppress "@typespec/http/metadata-ignored" "For test"
   @doc("Required int32, illustrating a query property.")
   @visibility(Lifecycle.Query)
+  @query
   queryProp: int32;
 
   @doc("Required string[], illustrating a create property.")
@@ -38,23 +40,18 @@ model VisibilityModel {
 /** RoundTrip model with readonly optional properties. */
 model ReadOnlyModel {
   /** Optional readonly nullable int list. */
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   optionalNullableIntList?: int32[] | null;
 
   /** Optional readonly string dictionary. */
-  @visibility("read")
+  @visibility(Lifecycle.Read)
   optionalStringRecord?: Record<string>;
 }
 
 @scenario
 @scenarioDoc("""
   Generate and receive output model with readonly properties.
-  Expected input body:
-  ```json
-  {
-    queryProp: 123,
-  }
-  ```
+  Expected no body with `?queryProp=123`.
   
   Expected response body:
   ```json
@@ -64,7 +61,7 @@ model ReadOnlyModel {
   ```
   """)
 @get
-op getModel(@body input: VisibilityModel): {
+op getModel(@bodyRoot input: VisibilityModel): {
   @body
   output: VisibilityModel;
 };
@@ -72,15 +69,10 @@ op getModel(@body input: VisibilityModel): {
 @scenario
 @scenarioDoc("""
   Generate abd send put model with write/create properties.
-  Expected input body:
-  ```json
-  {
-    queryProp: 123,
-  }
-  ```
+  Expected no body with `?queryProp=123`.
   """)
 @head
-op headModel(@body input: VisibilityModel): OkResponse;
+op headModel(@bodyRoot input: VisibilityModel): OkResponse;
 
 @scenario
 @scenarioDoc("""
@@ -106,7 +98,7 @@ op putModel(@body input: VisibilityModel): void;
   }
   ```
   """)
-@patch
+@patch(#{ implicitOptionality: true })
 op patchModel(@body input: VisibilityModel): void;
 
 @scenario

package/specs/type/model/visibility/mockapi.ts

@@ -6,7 +6,6 @@ function genData(keys: string[]): Record<string, any> {
   const ret: Record<string, any> = {};
   const fullData: Record<string, any> = {
     readProp: "abc",
-    queryProp: 123,
     createProp: ["foo", "bar"],
     updateProp: [1, 2],
     deleteProp: true,
@@ -36,7 +35,7 @@ Scenarios.Type_Model_Visibility_headModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "head",
   request: {
-    body: { queryProp: 123 },
+    query: { queryProp: 123 },
   },
   response: {
     status: 200,
@@ -47,7 +46,7 @@ Scenarios.Type_Model_Visibility_getModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "get",
   request: {
-    body: { queryProp: 123 },
+    query: { queryProp: 123 },
   },
   response: {
     status: 200,
@@ -59,10 +58,10 @@ Scenarios.Type_Model_Visibility_putModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "put",
   request: {
-    body: {
+    body: json({
       createProp: ["foo", "bar"],
       updateProp: [1, 2],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -73,9 +72,9 @@ Scenarios.Type_Model_Visibility_patchModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "patch",
   request: {
-    body: {
+    body: json({
       updateProp: [1, 2],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -86,9 +85,9 @@ Scenarios.Type_Model_Visibility_postModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "post",
   request: {
-    body: {
+    body: json({
       createProp: ["foo", "bar"],
-    },
+    }),
   },
   response: {
     status: 204,
@@ -99,7 +98,7 @@ Scenarios.Type_Model_Visibility_deleteModel = passOnSuccess({
   uri: "/type/model/visibility",
   method: "delete",
   request: {
-    body: { deleteProp: true },
+    body: json({ deleteProp: true }),
   },
   response: {
     status: 204,

package/specs/type/property/additional-properties/main.tsp

@@ -463,11 +463,11 @@ interface SpreadRecordUnion
     > {}
 
 // ****************** spread record of discriminated unions **************************
-@discriminator("kind")
-union WidgetData {
-  kind0: WidgetData0,
-  kind1: WidgetData1,
-}
+// @discriminated(#{ envelope: "none" })
+// union WidgetData {
+//   kind0: WidgetData0,
+//   kind1: WidgetData1,
+// }
 
 model WidgetData0 {
   kind: "kind0";
@@ -485,20 +485,20 @@ model WidgetData2 {
   start: string;
 }
 
-@doc("The model spread Record<WidgetData>")
-model SpreadRecordForDiscriminatedUnion {
-  @doc("The name property")
-  name: string;
+// @doc("The model spread Record<WidgetData>")
+// model SpreadRecordForDiscriminatedUnion {
+//   @doc("The name property")
+//   name: string;
 
-  ...Record<WidgetData>;
-}
+//   ...Record<WidgetData>;
+// }
 
-@route("/spreadRecordDiscriminatedUnion")
-interface SpreadRecordDiscriminatedUnion
-  extends ModelOperations<
-      SpreadRecordForDiscriminatedUnion,
-      "{'name': 'abc', 'prop1': {'kind': 'kind0', 'fooProp': 'abc'}, 'prop2': {'kind': 'kind1', 'start': '2021-01-01T00:00:00Z', 'end': '2021-01-02T00:00:00Z'}}"
-    > {}
+// @route("/spreadRecordDiscriminatedUnion")
+// interface SpreadRecordDiscriminatedUnion
+//   extends ModelOperations<
+//       SpreadRecordForDiscriminatedUnion,
+//       "{'name': 'abc', 'prop1': {'kind': 'kind0', 'fooProp': 'abc'}, 'prop2': {'kind': 'kind1', 'start': '2021-01-01T00:00:00Z', 'end': '2021-01-02T00:00:00Z'}}"
+//     > {}
 
 // ****************** spread record of non-discriminated unions but could guess a discriminator **************************
 @doc("The model spread Record<WidgetData0 | WidgetData1>")

package/specs/type/property/additional-properties/mockapi.ts

@@ -98,7 +98,7 @@ const recordNonDiscriminatedUnion3Body = {
     end: "2021-01-02T00:00:00Z",
   },
 };
-function createServerTests(url: string, value: any) {
+function createServerTests(url: string, value: unknown) {
   return {
     get: passOnSuccess({
       uri: url,
@@ -114,7 +114,7 @@ function createServerTests(url: string, value: any) {
       uri: url,
       method: `put`,
       request: {
-        body: value,
+        body: json(value),
       },
       response: {
         status: 204,
@@ -432,14 +432,14 @@ Scenarios.Type_Property_AdditionalProperties_SpreadRecordUnion_get =
 Scenarios.Type_Property_AdditionalProperties_SpreadRecordUnion_put =
   Type_Property_Additional_Properties_Spread_Record_Union.put;
 
-const Type_Property_Additional_Properties_Spread_Record_Discriminated_Union = createServerTests(
-  `/type/property/additionalProperties/spreadRecordDiscriminatedUnion`,
-  recordDiscriminatedUnionBody,
-);
-Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_get =
-  Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.get;
-Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_put =
-  Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.put;
+// const Type_Property_Additional_Properties_Spread_Record_Discriminated_Union = createServerTests(
+//   `/type/property/additionalProperties/spreadRecordDiscriminatedUnion`,
+//   recordDiscriminatedUnionBody,
+// );
+// Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_get =
+//   Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.get;
+// Scenarios.Type_Property_AdditionalProperties_SpreadRecordDiscriminatedUnion_put =
+//   Type_Property_Additional_Properties_Spread_Record_Discriminated_Union.put;
 
 const Type_Property_Additional_Properties_Spread_Record_Non_Discriminated_Union = createServerTests(
   `/type/property/additionalProperties/spreadRecordNonDiscriminatedUnion`,

package/specs/type/property/nullable/mockapi.ts

@@ -7,7 +7,6 @@ function createServerTests(url: string, value: unknown, patchNullableProperty?:
     get: passOnSuccess({
       uri: url,
       method: `get`,
-      request: {},
       response: {
         status: 200,
         body: json(value),
@@ -18,13 +17,13 @@ function createServerTests(url: string, value: unknown, patchNullableProperty?:
       uri: url,
       method: `patch`,
       request: {
-        body: {
-          requiredProperty: "foo",
-          nullableProperty: patchNullableProperty || null,
-        },
-        headers: {
-          "Content-Type": "application/merge-patch+json",
-        },
+        body: json(
+          {
+            requiredProperty: "foo",
+            nullableProperty: patchNullableProperty || null,
+          },
+          "application/merge-patch+json",
+        ),
       },
       response: {
         status: 204,

package/specs/type/property/optionality/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(url: string, value: unknown) {
       uri: url,
       method: `put`,
       request: {
-        body: value,
+        body: json(value),
       },
       response: {
         status: 204,

package/specs/type/property/value-types/mockapi.ts

@@ -18,7 +18,7 @@ function createServerTests(url: string, data: unknown) {
       uri: url,
       method: `put`,
       request: {
-        body: data,
+        body: json(data),
       },
       response: {
         status: 204,
@@ -166,9 +166,9 @@ Scenarios.Type_Property_ValueTypes_Never_put = passOnSuccess({
   uri: `/type/property/value-types/never`,
   method: `put`,
   request: {
-    body: {
+    body: json({
       property: undefined,
-    },
+    }),
   },
   response: {
     status: 204,