@typespec/http-specs 0.1.0-alpha.0

package/specs/encode/bytes/mockapi.ts

@@ -0,0 +1,297 @@
+import { resolvePath } from "@typespec/compiler";
+import {
+  CollectionFormat,
+  json,
+  MockRequest,
+  passOnSuccess,
+  ScenarioMockApi,
+} from "@typespec/spec-api";
+import { readFileSync } from "fs";
+import { fileURLToPath } from "url";
+
+const root = resolvePath(fileURLToPath(import.meta.url), "../../../../../");
+
+const pngFile = readFileSync(resolvePath(root, "assets/image.png"));
+
+export const Scenarios: Record<string, ScenarioMockApi> = {};
+
+function createQueryServerTests(
+  uri: string,
+  data: any,
+  value: any,
+  collectionFormat?: CollectionFormat,
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      params: data,
+    },
+    response: {
+      status: 204,
+    },
+    handler: (req: MockRequest) => {
+      req.expect.containsQueryParam("value", value, collectionFormat);
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Query_default = createQueryServerTests(
+  "/encode/bytes/query/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Query_base64 = createQueryServerTests(
+  "/encode/bytes/query/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Query_base64url = createQueryServerTests(
+  "/encode/bytes/query/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Query_base64urlArray = createQueryServerTests(
+  "/encode/bytes/query/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"].join(","),
+  },
+  ["dGVzdA", "dGVzdA"],
+  "csv",
+);
+function createPropertyServerTests(uri: string, data: any, value: any) {
+  return passOnSuccess({
+    uri,
+    method: "post",
+    request: {
+      body: data,
+    },
+    response: {
+      status: 200,
+      body: json({ value: value }),
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Property_default = createPropertyServerTests(
+  "/encode/bytes/property/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Property_base64 = createPropertyServerTests(
+  "/encode/bytes/property/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Property_base64url = createPropertyServerTests(
+  "/encode/bytes/property/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Property_base64urlArray = createPropertyServerTests(
+  "/encode/bytes/property/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"],
+  },
+  ["dGVzdA", "dGVzdA"],
+);
+function createHeaderServerTests(uri: string, data: any, value: any) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      headers: data,
+    },
+    response: {
+      status: 204,
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_Header_default = createHeaderServerTests(
+  "/encode/bytes/header/default",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Header_base64 = createHeaderServerTests(
+  "/encode/bytes/header/base64",
+  {
+    value: "dGVzdA==",
+  },
+  "dGVzdA==",
+);
+Scenarios.Encode_Bytes_Header_base64url = createHeaderServerTests(
+  "/encode/bytes/header/base64url",
+  {
+    value: "dGVzdA",
+  },
+  "dGVzdA",
+);
+Scenarios.Encode_Bytes_Header_base64urlArray = createHeaderServerTests(
+  "/encode/bytes/header/base64url-array",
+  {
+    value: ["dGVzdA", "dGVzdA"].join(","),
+  },
+  ["dGVzdA", "dGVzdA"].join(","),
+);
+function createRequestBodyServerTests(
+  uri: string,
+  data: any,
+  headersData: any,
+  value: any,
+  contentType: string = "application/json",
+) {
+  return passOnSuccess({
+    uri,
+    method: "post",
+    request: {
+      body: data,
+      headers: headersData,
+    },
+    response: {
+      status: 204,
+    },
+    handler(req: MockRequest) {
+      req.expect.containsHeader("content-type", contentType);
+      req.expect.rawBodyEquals(value);
+      return {
+        status: 204,
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_RequestBody_default = createRequestBodyServerTests(
+  "/encode/bytes/body/request/default",
+  '"dGVzdA=="',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA=="',
+);
+Scenarios.Encode_Bytes_RequestBody_base64 = createRequestBodyServerTests(
+  "/encode/bytes/body/request/base64",
+  '"dGVzdA=="',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA=="',
+);
+Scenarios.Encode_Bytes_RequestBody_base64url = createRequestBodyServerTests(
+  "/encode/bytes/body/request/base64url",
+  '"dGVzdA"',
+  {
+    "Content-Type": "application/json",
+  },
+  '"dGVzdA"',
+);
+
+Scenarios.Encode_Bytes_RequestBody_customContentType = createRequestBodyServerTests(
+  "/encode/bytes/body/request/custom-content-type",
+  pngFile,
+  {
+    "Content-Type": "image/png",
+  },
+  pngFile,
+  "image/png",
+);
+Scenarios.Encode_Bytes_RequestBody_octetStream = createRequestBodyServerTests(
+  "/encode/bytes/body/request/octet-stream",
+  pngFile,
+  {
+    "Content-Type": "application/octet-stream",
+  },
+  pngFile,
+  "application/octet-stream",
+);
+function createResponseBodyServerTests(
+  uri: string,
+  data: any,
+  headerData: any,
+  value: any,
+  contentType: string = "application/json",
+) {
+  return passOnSuccess({
+    uri,
+    method: "get",
+    request: {
+      headers: headerData,
+    },
+    response: {
+      status: 200,
+      body: {
+        contentType: contentType,
+        rawContent: data,
+      },
+    },
+    handler(req: MockRequest) {
+      return {
+        status: 200,
+        body: {
+          contentType: contentType,
+          rawContent: value,
+        },
+      };
+    },
+    kind: "MockApiDefinition",
+  });
+}
+Scenarios.Encode_Bytes_ResponseBody_default = createResponseBodyServerTests(
+  "/encode/bytes/body/response/default",
+  JSON.stringify("dGVzdA=="),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA=="),
+);
+Scenarios.Encode_Bytes_ResponseBody_base64 = createResponseBodyServerTests(
+  "/encode/bytes/body/response/base64",
+  JSON.stringify("dGVzdA=="),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA=="),
+);
+Scenarios.Encode_Bytes_ResponseBody_base64url = createResponseBodyServerTests(
+  "/encode/bytes/body/response/base64url",
+  JSON.stringify("dGVzdA"),
+  {
+    "Content-Type": "application/json",
+  },
+  JSON.stringify("dGVzdA"),
+);
+Scenarios.Encode_Bytes_ResponseBody_customContentType = createResponseBodyServerTests(
+  "/encode/bytes/body/response/custom-content-type",
+  pngFile,
+  {
+    "Content-Type": "image/png",
+  },
+  pngFile,
+  "image/png",
+);
+Scenarios.Encode_Bytes_ResponseBody_octetStream = createResponseBodyServerTests(
+  "/encode/bytes/body/response/octet-stream",
+  pngFile,
+  {
+    "Content-Type": "application/octet-stream",
+  },
+  pngFile,
+  "application/octet-stream",
+);

package/specs/encode/datetime/main.tsp

@@ -0,0 +1,339 @@
+import "@typespec/http";
+import "@typespec/spector";
+
+using Http;
+using Spector;
+
+@doc("Test for encode decorator on datetime.")
+@scenarioService("/encode/datetime")
+namespace Encode.Datetime;
+
+@encode(DateTimeKnownEncoding.unixTimestamp, int64)
+scalar unixTimestampDatetime extends utcDateTime;
+
+@route("/query")
+namespace Query {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc3339) for datetime query parameter.
+    Expected query parameter:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op default(
+    @query
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime query parameter.
+    Expected query parameter:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(
+    @query
+    @encode(DateTimeKnownEncoding.rfc3339)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime query parameter.
+    Expected query parameter:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(
+    @query
+    @encode(DateTimeKnownEncoding.rfc7231)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime query parameter.
+    Expected query parameter:
+    value=1686566864
+    """)
+  op unixTimestamp(
+    @query
+    @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime array query parameter.
+    Expected query parameter:
+    value=1686566864, 1686734256
+    """)
+  op unixTimestampArray(
+    #suppress "deprecated" "Deprecated in next release"
+    @query({
+      format: "csv",
+    })
+    value: unixTimestampDatetime[],
+  ): NoContentResponse;
+}
+
+model DefaultDatetimeProperty {
+  value: utcDateTime;
+}
+
+model Rfc3339DatetimeProperty {
+  @encode(DateTimeKnownEncoding.rfc3339)
+  value: utcDateTime;
+}
+
+model Rfc7231DatetimeProperty {
+  @encode(DateTimeKnownEncoding.rfc7231)
+  value: utcDateTime;
+}
+
+model UnixTimestampDatetimeProperty {
+  @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+  value: utcDateTime;
+}
+
+model UnixTimestampArrayDatetimeProperty {
+  value: unixTimestampDatetime[];
+}
+
+@route("/property")
+namespace Property {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with default encode (rfc3339).
+    Expected request body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    """)
+  @post
+  op default(@body body: DefaultDatetimeProperty): DefaultDatetimeProperty;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with rfc3339 encode.
+    Expected request body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "2022-08-26T18:38:00.000Z"
+    }
+    ```
+    """)
+  @post
+  op rfc3339(@body body: Rfc3339DatetimeProperty): Rfc3339DatetimeProperty;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with rfc7231 encode.
+    Expected request body:
+    ```json
+    {
+      "value": "Fri, 26 Aug 2022 14:38:00 GMT"
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": "Fri, 26 Aug 2022 14:38:00 GMT"
+    }
+    ```
+    """)
+  @post
+  op rfc7231(@body body: Rfc7231DatetimeProperty): Rfc7231DatetimeProperty;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime property with unixTimestamp encode.
+    Expected request body:
+    ```json
+    {
+      "value": 1686566864
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": 1686566864
+    }
+    ```
+    """)
+  @post
+  op unixTimestamp(@body body: UnixTimestampDatetimeProperty): UnixTimestampDatetimeProperty;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test operation with request and response model contains datetime array property with unixTimestamp encode.
+    Expected request body:f
+    ```json
+    {
+      "value": [1686566864, 1686734256]
+    }
+    ```
+    Expected response body:
+    ```json
+    {
+      "value": [1686566864, 1686734256]
+    }
+    ```
+    """)
+  @post
+  op unixTimestampArray(
+    @body body: UnixTimestampArrayDatetimeProperty,
+  ): UnixTimestampArrayDatetimeProperty;
+}
+
+@route("/header")
+namespace Header {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc7231) for datetime header.
+    Expected header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op default(
+    @header
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime header.
+    Expected header:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(
+    @header
+    @encode(DateTimeKnownEncoding.rfc3339)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime header.
+    Expected header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(
+    @header
+    @encode(DateTimeKnownEncoding.rfc7231)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime header.
+    Expected header:
+    value=1686566864
+    """)
+  op unixTimestamp(
+    @header
+    @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+    value: utcDateTime,
+  ): NoContentResponse;
+
+  @route("/unix-timestamp-array")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime array header.
+    Expected header:
+    value=1686566864,1686734256
+    """)
+  op unixTimestampArray(
+    @header({
+      format: "csv",
+    })
+    value: unixTimestampDatetime[],
+  ): NoContentResponse;
+}
+
+model DefaultDatetimeHeader {
+  @header
+  value: utcDateTime;
+}
+
+model Rfc3339DatetimeHeader {
+  @encode(DateTimeKnownEncoding.rfc3339)
+  @header
+  value: utcDateTime;
+}
+
+model Rfc7231DatetimeHeader {
+  @encode(DateTimeKnownEncoding.rfc7231)
+  @header
+  value: utcDateTime;
+}
+
+model UnixTimestampDatetimeHeader {
+  @encode(DateTimeKnownEncoding.unixTimestamp, int64)
+  @header
+  value: utcDateTime;
+}
+
+@route("/responseheader")
+namespace ResponseHeader {
+  @route("/default")
+  @scenario
+  @scenarioDoc("""
+    Test default encode (rfc7231) for datetime header.
+    Expected response header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op default(): NoContentResponse & DefaultDatetimeHeader;
+
+  @route("/rfc3339")
+  @scenario
+  @scenarioDoc("""
+    Test rfc3339 encode for datetime header.
+    Expected response header:
+    value=2022-08-26T18:38:00.000Z
+    """)
+  op rfc3339(): NoContentResponse & Rfc3339DatetimeHeader;
+
+  @route("/rfc7231")
+  @scenario
+  @scenarioDoc("""
+    Test rfc7231 encode for datetime header.
+    Expected response header:
+    value=Fri, 26 Aug 2022 14:38:00 GMT
+    """)
+  op rfc7231(): NoContentResponse & Rfc7231DatetimeHeader;
+
+  @route("/unix-timestamp")
+  @scenario
+  @scenarioDoc("""
+    Test unixTimestamp encode for datetime header.
+    Expected response header:
+    value=1686566864
+    """)
+  op unixTimestamp(): NoContentResponse & UnixTimestampDatetimeHeader;
+}