@typespec/http-specs 0.1.0-alpha.35 → 0.1.0-alpha.36-dev.3

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@typespec/http-specs",
   "displayName": "Http Specs",
-  "version": "0.1.0-alpha.35",
+  "version": "0.1.0-alpha.36-dev.3",
   "description": "Spec scenarios and mock apis",
   "main": "dist/index.js",
   "type": "module",
@@ -22,27 +22,27 @@
   },
   "homepage": "https://github.com/microsoft/typespec#readme",
   "dependencies": {
-    "deep-equal": "^2.2.3",
-    "@typespec/spector": "^0.1.0-alpha.24",
-    "@typespec/spec-api": "^0.1.0-alpha.13"
+    "@typespec/spec-api": "^0.1.0-alpha.13 || >= 0.1.0-alpha.14-dev.4",
+    "@typespec/spector": "^0.1.0-alpha.24 || >= 0.1.0-alpha.25-dev.4",
+    "deep-equal": "^2.2.3"
   },
   "devDependencies": {
     "@types/deep-equal": "^1.0.4",
     "@types/multer": "^2.1.0",
     "@types/node": "~25.5.0",
+    "@typespec/json-schema": "^1.10.0 || >= 1.11.0-dev.2",
+    "@typespec/openapi": "^1.10.0 || >= 1.11.0-dev.2",
+    "@typespec/openapi3": "^1.10.0 || >= 1.11.0-dev.4",
     "concurrently": "^9.2.1",
     "rimraf": "~6.1.3",
-    "typescript": "~5.9.3",
-    "@typespec/json-schema": "^1.10.0",
-    "@typespec/openapi": "^1.10.0",
-    "@typespec/openapi3": "^1.10.0"
+    "typescript": "~5.9.3"
   },
   "peerDependencies": {
-    "@typespec/compiler": "^1.10.0",
-    "@typespec/http": "^1.10.0",
-    "@typespec/rest": "^0.80.0",
-    "@typespec/versioning": "^0.80.0",
-    "@typespec/xml": "^0.80.0"
+    "@typespec/compiler": "^1.10.0 || >= 1.11.0-dev.9",
+    "@typespec/http": "^1.10.0 || >= 1.11.0-dev.3",
+    "@typespec/rest": "^0.80.0 || >= 0.81.0-dev.2",
+    "@typespec/versioning": "^0.80.0 || >= 0.81.0-dev.2",
+    "@typespec/xml": "^0.80.0 || >= 0.81.0-dev.2"
   },
   "scripts": {
     "watch": "tsc -p ./tsconfig.build.json --watch",

package/specs/encode/datetime/mockapi.ts

@@ -1,244 +1,149 @@
-import {
-  CollectionFormat,
-  json,
-  MockRequest,
-  passOnSuccess,
-  ScenarioMockApi,
-  validateValueFormat,
-  ValidationError,
-} from "@typespec/spec-api";
+import { json, match, MockRequest, passOnSuccess, ScenarioMockApi } from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
 function createQueryServerTests(
   uri: string,
-  paramData: any,
-  format: "rfc7231" | "rfc3339" | undefined,
   value: any,
-  collectionFormat?: CollectionFormat,
+  format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined,
 ) {
   return passOnSuccess({
     uri,
     method: "get",
     request: {
-      query: paramData,
+      query: { value: format ? match.dateTime[format](value) : value },
     },
     response: {
       status: 204,
     },
-    handler(req: MockRequest) {
-      if (format) {
-        validateValueFormat(req.query["value"] as string, format);
-        if (Date.parse(req.query["value"] as string) !== Date.parse(value)) {
-          throw new ValidationError(`Wrong value`, value, req.query["value"]);
-        }
-      } else {
-        req.expect.containsQueryParam("value", value, collectionFormat);
-      }
-      return {
-        status: 204,
-      };
-    },
     kind: "MockApiDefinition",
   });
 }
 Scenarios.Encode_Datetime_Query_default = createQueryServerTests(
   "/encode/datetime/query/default",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
-  "rfc3339",
   "2022-08-26T18:38:00.000Z",
+  "utcRfc3339",
 );
 Scenarios.Encode_Datetime_Query_rfc3339 = createQueryServerTests(
   "/encode/datetime/query/rfc3339",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
-  "rfc3339",
   "2022-08-26T18:38:00.000Z",
+  "utcRfc3339",
 );
 Scenarios.Encode_Datetime_Query_rfc7231 = createQueryServerTests(
   "/encode/datetime/query/rfc7231",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
-  "rfc7231",
   "Fri, 26 Aug 2022 14:38:00 GMT",
+  "rfc7231",
 );
 Scenarios.Encode_Datetime_Query_unixTimestamp = createQueryServerTests(
   "/encode/datetime/query/unix-timestamp",
-  {
-    value: 1686566864,
-  },
-  undefined,
   "1686566864",
+  undefined,
 );
 Scenarios.Encode_Datetime_Query_unixTimestampArray = createQueryServerTests(
   "/encode/datetime/query/unix-timestamp-array",
-  {
-    value: [1686566864, 1686734256].join(","),
-  },
+  [1686566864, 1686734256].join(","),
   undefined,
-  ["1686566864", "1686734256"],
-  "csv",
 );
 function createPropertyServerTests(
   uri: string,
-  data: any,
-  format: "rfc7231" | "rfc3339" | undefined,
   value: any,
+  format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined,
 ) {
+  const matcherBody = { value: format ? match.dateTime[format](value) : value };
   return passOnSuccess({
     uri,
     method: "post",
     request: {
-      body: json(data),
+      body: json(matcherBody),
     },
     response: {
       status: 200,
-    },
-    handler: (req: MockRequest) => {
-      if (format) {
-        validateValueFormat(req.body["value"], format);
-        if (Date.parse(req.body["value"]) !== Date.parse(value)) {
-          throw new ValidationError(`Wrong value`, value, req.body["value"]);
-        }
-      } else {
-        req.expect.coercedBodyEquals({ value: value });
-      }
-      return {
-        status: 200,
-        body: json({ value: value }),
-      };
+      body: json(matcherBody),
     },
     kind: "MockApiDefinition",
   });
 }
 Scenarios.Encode_Datetime_Property_default = createPropertyServerTests(
   "/encode/datetime/property/default",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
-  "rfc3339",
   "2022-08-26T18:38:00.000Z",
+  "utcRfc3339",
 );
 Scenarios.Encode_Datetime_Property_rfc3339 = createPropertyServerTests(
   "/encode/datetime/property/rfc3339",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
-  "rfc3339",
   "2022-08-26T18:38:00.000Z",
+  "utcRfc3339",
 );
 Scenarios.Encode_Datetime_Property_rfc7231 = createPropertyServerTests(
   "/encode/datetime/property/rfc7231",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
-  "rfc7231",
   "Fri, 26 Aug 2022 14:38:00 GMT",
+  "rfc7231",
 );
 Scenarios.Encode_Datetime_Property_unixTimestamp = createPropertyServerTests(
   "/encode/datetime/property/unix-timestamp",
-  {
-    value: 1686566864,
-  },
-  undefined,
   1686566864,
+  undefined,
 );
 Scenarios.Encode_Datetime_Property_unixTimestampArray = createPropertyServerTests(
   "/encode/datetime/property/unix-timestamp-array",
-  {
-    value: [1686566864, 1686734256],
-  },
-  undefined,
   [1686566864, 1686734256],
+  undefined,
 );
 function createHeaderServerTests(
   uri: string,
-  data: any,
-  format: "rfc7231" | "rfc3339" | undefined,
   value: any,
+  format: "rfc7231" | "rfc3339" | "utcRfc3339" | undefined,
 ) {
+  const matcherHeaders = { value: format ? match.dateTime[format](value) : value };
   return passOnSuccess({
     uri,
     method: "get",
     request: {
-      headers: data,
+      headers: matcherHeaders,
     },
     response: {
       status: 204,
     },
-    handler(req: MockRequest) {
-      if (format) {
-        validateValueFormat(req.headers["value"], format);
-        if (Date.parse(req.headers["value"]) !== Date.parse(value)) {
-          throw new ValidationError(`Wrong value`, value, req.headers["value"]);
-        }
-      } else {
-        req.expect.containsHeader("value", value);
-      }
-      return {
-        status: 204,
-      };
-    },
     kind: "MockApiDefinition",
   });
 }
 Scenarios.Encode_Datetime_Header_default = createHeaderServerTests(
   "/encode/datetime/header/default",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
-  "rfc7231",
   "Fri, 26 Aug 2022 14:38:00 GMT",
+  "rfc7231",
 );
 Scenarios.Encode_Datetime_Header_rfc3339 = createHeaderServerTests(
   "/encode/datetime/header/rfc3339",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
-  "rfc3339",
   "2022-08-26T18:38:00.000Z",
+  "utcRfc3339",
 );
 Scenarios.Encode_Datetime_Header_rfc7231 = createHeaderServerTests(
   "/encode/datetime/header/rfc7231",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
-  "rfc7231",
   "Fri, 26 Aug 2022 14:38:00 GMT",
+  "rfc7231",
 );
 Scenarios.Encode_Datetime_Header_unixTimestamp = createHeaderServerTests(
   "/encode/datetime/header/unix-timestamp",
-  {
-    value: 1686566864,
-  },
+  1686566864,
   undefined,
-  "1686566864",
 );
 Scenarios.Encode_Datetime_Header_unixTimestampArray = createHeaderServerTests(
   "/encode/datetime/header/unix-timestamp-array",
-  {
-    value: [1686566864, 1686734256].join(","),
-  },
+  [1686566864, 1686734256].join(","),
   undefined,
-  "1686566864,1686734256",
 );
-function createResponseHeaderServerTests(uri: string, data: any, value: any) {
+function createResponseHeaderServerTests(uri: string, value: any) {
   return passOnSuccess({
     uri,
     method: "get",
     request: {},
     response: {
       status: 204,
-      headers: data,
+      headers: { value },
     },
     handler: (req: MockRequest) => {
       return {
         status: 204,
-        headers: { value: value },
+        headers: { value },
       };
     },
     kind: "MockApiDefinition",
@@ -246,29 +151,17 @@ function createResponseHeaderServerTests(uri: string, data: any, value: any) {
 }
 Scenarios.Encode_Datetime_ResponseHeader_default = createResponseHeaderServerTests(
   "/encode/datetime/responseheader/default",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
   "Fri, 26 Aug 2022 14:38:00 GMT",
 );
 Scenarios.Encode_Datetime_ResponseHeader_rfc3339 = createResponseHeaderServerTests(
   "/encode/datetime/responseheader/rfc3339",
-  {
-    value: "2022-08-26T18:38:00.000Z",
-  },
   "2022-08-26T18:38:00.000Z",
 );
 Scenarios.Encode_Datetime_ResponseHeader_rfc7231 = createResponseHeaderServerTests(
   "/encode/datetime/responseheader/rfc7231",
-  {
-    value: "Fri, 26 Aug 2022 14:38:00 GMT",
-  },
   "Fri, 26 Aug 2022 14:38:00 GMT",
 );
 Scenarios.Encode_Datetime_ResponseHeader_unixTimestamp = createResponseHeaderServerTests(
   "/encode/datetime/responseheader/unix-timestamp",
-  {
-    value: "1686566864",
-  },
-  1686566864,
+  "1686566864",
 );

package/specs/payload/pageable/mockapi.ts

@@ -2,9 +2,9 @@ import {
   dyn,
   dynItem,
   json,
+  match,
   MockRequest,
   passOnSuccess,
-  ResolverConfig,
   ScenarioMockApi,
   ValidationError,
   xml,
@@ -650,22 +650,6 @@ Scenarios.Payload_Pageable_XmlPagination_listWithContinuation = passOnSuccess([
   },
 ]);
 
-const xmlNextLinkFirstPage = (baseUrl: string) => `
-<PetListResult>
-  <Pets>
-    <Pet>
-      <Id>1</Id>
-      <Name>dog</Name>
-    </Pet>
-    <Pet>
-      <Id>2</Id>
-      <Name>cat</Name>
-    </Pet>
-  </Pets>
-  <NextLink>${baseUrl}/payload/pageable/xml/list-with-next-link/nextPage</NextLink>
-</PetListResult>
-`;
-
 const XmlNextLinkSecondPage = `
 <PetListResult>
   <Pets>
@@ -688,26 +672,25 @@ Scenarios.Payload_Pageable_XmlPagination_listWithNextLink = passOnSuccess([
     request: {},
     response: {
       status: 200,
-      body: {
-        contentType: "application/xml",
-        rawContent: {
-          serialize: (config: ResolverConfig) =>
-            `<?xml version='1.0' encoding='UTF-8'?>` + xmlNextLinkFirstPage(config.baseUrl),
-        },
-      },
+      body: xml`
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>1</Id>
+      <Name>dog</Name>
+    </Pet>
+    <Pet>
+      <Id>2</Id>
+      <Name>cat</Name>
+    </Pet>
+  </Pets>
+  <NextLink>${match.localUrl("/payload/pageable/xml/list-with-next-link/nextPage")}</NextLink>
+</PetListResult>
+`,
       headers: {
         "content-type": "application/xml; charset=utf-8",
       },
     },
-    handler: (req: MockRequest) => {
-      return {
-        status: 200,
-        body: xml(xmlNextLinkFirstPage(req.baseUrl)),
-        headers: {
-          "content-type": "application/xml",
-        },
-      };
-    },
     kind: "MockApiDefinition",
   },
   {

package/specs/payload/xml/mockapi.ts

@@ -1,4 +1,11 @@
-import { MockRequest, passOnCode, passOnSuccess, ScenarioMockApi, xml } from "@typespec/spec-api";
+import {
+  match,
+  type MockBody,
+  passOnCode,
+  passOnSuccess,
+  ScenarioMockApi,
+  xml,
+} from "@typespec/spec-api";
 
 export const Scenarios: Record<string, ScenarioMockApi> = {};
 
@@ -270,22 +277,19 @@ export const modelWithEnum = `
 </ModelWithEnum>
 `;
 
-export const modelWithDatetime = `
+export const modelWithDatetime = xml`
 <ModelWithDatetime>
-  <rfc3339>2022-08-26T18:38:00.000Z</rfc3339>
-  <rfc7231>Fri, 26 Aug 2022 14:38:00 GMT</rfc7231>
+  <rfc3339>${match.dateTime.utcRfc3339("2022-08-26T18:38:00.000Z")}</rfc3339>
+  <rfc7231>${match.dateTime.rfc7231("Fri, 26 Aug 2022 14:38:00 GMT")}</rfc7231>
 </ModelWithDatetime>
 `;
 
-// Some clients serialize UTC datetimes without trailing zero milliseconds. Both
-// "2022-08-26T18:38:00.000Z" and "2022-08-26T18:38:00Z" are valid RFC3339 representations
-// of the same instant; accept either form.
-const modelWithDatetimeNoMs = `
-<ModelWithDatetime>
-  <rfc3339>2022-08-26T18:38:00Z</rfc3339>
-  <rfc7231>Fri, 26 Aug 2022 14:38:00 GMT</rfc7231>
-</ModelWithDatetime>
-`;
+const Payload_Xml_ModelWithDatetime = createServerTests(
+  "/payload/xml/modelWithDatetime",
+  modelWithDatetime,
+);
+Scenarios.Payload_Xml_ModelWithDatetimeValue_get = Payload_Xml_ModelWithDatetime.get;
+Scenarios.Payload_Xml_ModelWithDatetimeValue_put = Payload_Xml_ModelWithDatetime.put;
 
 export const xmlError = `
 <XmlErrorBody>
@@ -298,7 +302,12 @@ export const xmlError = `
 // Scenario registrations
 // ────────────────────────────────────────────────────────────────────────────
 
+function isMockBody(data: any): data is MockBody {
+  return typeof data === "object" && data !== null && "contentType" in data;
+}
+
 function createServerTests(uri: string, data?: any) {
+  const body = isMockBody(data) ? data : xml(data);
   return {
     get: passOnSuccess({
       uri,
@@ -306,7 +315,7 @@ function createServerTests(uri: string, data?: any) {
       request: {},
       response: {
         status: 200,
-        body: xml(data),
+        body,
       },
       kind: "MockApiDefinition",
     }),
@@ -314,14 +323,7 @@ function createServerTests(uri: string, data?: any) {
       uri,
       method: "put",
       request: {
-        body: xml(data),
-      },
-      handler: (req: MockRequest) => {
-        req.expect.containsHeader("content-type", "application/xml");
-        req.expect.xmlBodyEquals(data);
-        return {
-          status: 204,
-        };
+        body,
       },
       response: {
         status: 204,
@@ -522,45 +524,6 @@ const Payload_Xml_ModelWithEnum = createServerTests("/payload/xml/modelWithEnum"
 Scenarios.Payload_Xml_ModelWithEnumValue_get = Payload_Xml_ModelWithEnum.get;
 Scenarios.Payload_Xml_ModelWithEnumValue_put = Payload_Xml_ModelWithEnum.put;
 
-Scenarios.Payload_Xml_ModelWithDatetimeValue_get = passOnSuccess({
-  uri: "/payload/xml/modelWithDatetime",
-  method: "get",
-  request: {},
-  response: {
-    status: 200,
-    body: xml(modelWithDatetime),
-  },
-  kind: "MockApiDefinition",
-});
-
-Scenarios.Payload_Xml_ModelWithDatetimeValue_put = passOnSuccess({
-  uri: "/payload/xml/modelWithDatetime",
-  method: "put",
-  request: {
-    body: xml(modelWithDatetime),
-  },
-  handler: (req: MockRequest) => {
-    req.expect.containsHeader("content-type", "application/xml");
-    // Accept both "2022-08-26T18:38:00.000Z" and "2022-08-26T18:38:00Z" as equivalent UTC datetimes.
-    let firstError: unknown;
-    try {
-      req.expect.xmlBodyEquals(modelWithDatetime);
-    } catch (e) {
-      firstError = e;
-    }
-    if (firstError !== undefined) {
-      req.expect.xmlBodyEquals(modelWithDatetimeNoMs);
-    }
-    return {
-      status: 204,
-    };
-  },
-  response: {
-    status: 204,
-  },
-  kind: "MockApiDefinition",
-});
-
 Scenarios.Payload_Xml_XmlErrorValue_get = passOnCode(400, {
   uri: "/payload/xml/error",
   method: "get",