@typespec/http-specs 0.1.0-alpha.3-dev.6 → 0.1.0-alpha.30-dev.0

package/specs/payload/multipart/mockapi.ts

@@ -1,5 +1,6 @@
 import {
   MockRequest,
+  multipart,
   passOnSuccess,
   ScenarioMockApi,
   ValidationError,
@@ -29,7 +30,7 @@ function checkFile(
   fileName: string | undefined = undefined,
   mustCheckContentType: boolean = true,
 ) {
-  // cadl-ranch depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
+  // server depends on multer, which sets the mimetype to "text/plain" if this part has no content-type header
   if (mustCheckContentType || file.mimetype !== "text/plain") {
     req.expect.deepEqual(file.mimetype, contentType);
   }
@@ -185,11 +186,7 @@ Scenarios.Payload_MultiPart_FormData_basic = passOnSuccess({
   uri: "/multipart/form-data/mixed-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[0]],
+    body: multipart({ parts: { id: 123 }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkProfileImage]),
@@ -199,11 +196,10 @@ Scenarios.Payload_MultiPart_FormData_fileArrayAndBasic = passOnSuccess({
   uri: "/multipart/form-data/complex-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" } },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: { id: 123, address: { city: "X" } },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkAddress, checkAllFiles]),
@@ -213,11 +209,7 @@ Scenarios.Payload_MultiPart_FormData_jsonPart = passOnSuccess({
   uri: "/multipart/form-data/json-part",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { address: { city: "X" } },
-    files: [files[0]],
+    body: multipart({ parts: { address: { city: "X" } }, files: [files[0]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkAddress, checkProfileImage]),
@@ -227,11 +219,7 @@ Scenarios.Payload_MultiPart_FormData_binaryArrayParts = passOnSuccess({
   uri: "/multipart/form-data/binary-array-parts",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [files[1], files[1]],
+    body: multipart({ parts: { id: 123 }, files: [files[1], files[1]] }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkPictures]),
@@ -245,10 +233,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0]],
+      body: multipart({
+        files: [files[0]],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -258,10 +245,9 @@ Scenarios.Payload_MultiPart_FormData_multiBinaryParts = withServiceKeys([
     uri: "/multipart/form-data/multi-binary-parts",
     method: "post",
     request: {
-      headers: {
-        "Content-Type": "multipart/form-data",
-      },
-      files: [files[0], { ...files[1], fieldname: "picture" }],
+      body: multipart({
+        files: [files[0], { ...files[1], fieldname: "picture" }],
+      }),
     },
     response: { status: 204 },
     handler: createMultiBinaryPartsHandler,
@@ -272,11 +258,10 @@ Scenarios.Payload_MultiPart_FormData_checkFileNameAndContentType = passOnSuccess
   uri: "/multipart/form-data/check-filename-and-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123 },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      parts: { id: 123 },
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkId, checkFileNameAndContentType]),
@@ -286,10 +271,9 @@ Scenarios.Payload_MultiPart_FormData_anonymousModel = passOnSuccess({
   uri: "/multipart/form-data/anonymous-model",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -299,10 +283,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_imageJpegContentType
   uri: "/multipart/form-data/check-filename-and-specific-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    body: multipart({
+      files: [{ ...files[0], mimetype: "image/jpg", originalname: "hello.jpg" }],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFileNameAndContentType]),
@@ -312,10 +295,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_requiredContentType =
   uri: "/multipart/form-data/check-filename-and-required-content-type-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkProfileImage]),
@@ -325,10 +307,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_ContentType_optionalContentType =
   uri: "/multipart/form-data/file-with-http-part-optional-content-type",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    files: [files[0]],
+    body: multipart({
+      files: [files[0]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkOptionalContentType]),
@@ -338,11 +319,14 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_jsonArrayAndFileArray = passOnSuc
   uri: "/multipart/form-data/complex-parts-with-httppart",
   method: "post",
   request: {
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
-    body: { id: 123, address: { city: "X" }, previousAddresses: [{ city: "Y" }, { city: "Z" }] },
-    files: [files[0], files[1], files[1]],
+    body: multipart({
+      parts: {
+        id: 123,
+        address: { city: "X" },
+        previousAddresses: [{ city: "Y" }, { city: "Z" }],
+      },
+      files: [files[0], files[1], files[1]],
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) =>
@@ -353,10 +337,9 @@ Scenarios.Payload_MultiPart_FormData_HttpParts_NonString_float = passOnSuccess({
   uri: "/multipart/form-data/non-string-float",
   method: "post",
   request: {
-    body: { temperature: 0.5 },
-    headers: {
-      "Content-Type": "multipart/form-data",
-    },
+    body: multipart({
+      parts: { temperature: 0.5 },
+    }),
   },
   response: { status: 204 },
   handler: (req: MockRequest) => createHandler(req, [checkFloat]),

package/specs/payload/pageable/main.tsp

@@ -15,6 +15,11 @@ model Pet {
   name: string;
 }
 
+alias HeaderAndQuery = {
+  @header foo?: string;
+  @query bar?: string;
+};
+
 @route("/server-driven-pagination")
 namespace ServerDrivenPagination {
   @scenario
@@ -30,9 +35,7 @@ namespace ServerDrivenPagination {
         { "id": "1", "name": "dog" },
         { "id": "2", "name": "cat" }
       ],
-      "links": {
-        "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/link/nextPage"
-      }
+      "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/link/nextPage"
     }
     ```
     2. Next page request:
@@ -47,15 +50,467 @@ namespace ServerDrivenPagination {
     ```
     """)
   @route("/link")
+  @list
   op link(): {
     @pageItems
     pets: Pet[];
 
-    links: {
+    @nextLink next?: url;
+  };
+
+  @scenario
+  @scenarioDoc("""
+    Test case for using link as pagination with string nextLink.
+    
+    Two requests need to be tested.
+    1. Initial request:
+    Expected route: /payload/pageable/server-driven-pagination/link-string
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "1", "name": "dog" },
+        { "id": "2", "name": "cat" }
+      ],
+      "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/link-string/nextPage"
+    }
+    ```
+    2. Next page request:
+    Expected route: /payload/pageable/server-driven-pagination/link-string/nextPage
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "3", "name": "bird" },
+        { "id": "4", "name": "fish" }
+      ]
+    }
+    ```
+    """)
+  @route("/link-string")
+  @list
+  op linkString(): {
+    @pageItems
+    pets: Pet[];
+
+    @nextLink next?: string;
+  };
+
+  @scenario
+  @scenarioDoc("""
+    Test case for using link as pagination with nested structure.
+    
+    Two requests need to be tested.
+    1. Initial request:
+    Expected route: /payload/pageable/server-driven-pagination/nested-link
+    Expected response body:
+    ```json
+    { "nestedItems": {
+        "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+      },
+      "nestedNext": {
+        "next": "http://[host]:[port]/payload/pageable/server-driven-pagination/nested-link/nextPage"
+      }
+    }
+    ```
+    2. Next page request:
+    Expected route: /payload/pageable/server-driven-pagination/nested-link/nextPage
+    Expected response body:
+    ```json
+    { "nestedItems": {
+        "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+    }
+    ```
+    """)
+  @route("/nested-link")
+  @list
+  op nestedLink(): {
+    nestedItems: {
+      @pageItems
+      pets: Pet[];
+    };
+    nestedNext: {
       @nextLink next?: url;
-      @prevLink prev?: url;
-      @firstLink first?: url;
-      @lastLink last?: url;
     };
   };
+
+  @route("/continuationtoken")
+  namespace ContinuationToken {
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request query and response body.
+      
+      Two requests need to be tested.
+      
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ],
+        "nextToken": "page2"
+      }
+      ```
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-body?bar=bar&token=page2
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-query-response-body")
+    @list
+    op requestQueryResponseBody(@continuationToken @query token?: string, ...HeaderAndQuery): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request header and response body.
+      
+      Two requests need to be tested.
+      
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body?bar=bar      
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ],
+        "nextToken": "page2"
+      }
+      ```
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-body?bar=bar
+      
+      Expected request header:
+      token=page2
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-header-response-body")
+    @list
+    op requestHeaderResponseBody(@continuationToken @header token?: string, ...HeaderAndQuery): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request query and response header.
+      
+      Two requests need to be tested.
+      
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+      }
+      ```
+      
+      Expected response header:
+      next-token=page2
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-response-header?bar=bar&token=page2
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-query-response-header")
+    @list
+    op requestQueryResponseHeader(@continuationToken @query token?: string, ...HeaderAndQuery): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken @header nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination. Continuation token is passed in the request header and response header.
+      
+      Two requests need to be tested.
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+      }
+      ```
+      
+      Expected response header:
+      next-token=page2
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-response-header?bar=bar
+      
+      Expected request header:
+      token=page2
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+        ]
+      }
+      ```
+      """)
+    @route("/request-header-response-header")
+    @list
+    op requestHeaderResponseHeader(@continuationToken @header token?: string, ...HeaderAndQuery): {
+      @pageItems
+      pets: Pet[];
+
+      @continuationToken @header nextToken?: string;
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination with nested response structure. Continuation token is passed in the request query and nested within response body.
+      
+      Two requests need to be tested.
+      
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-nested-response-body?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "nestedItems": {
+          "pets": [
+          { "id": "1", "name": "dog" },
+          { "id": "2", "name": "cat" }
+        ]
+        },
+        "nestedNext": {
+          "nextToken": "page2"
+        }
+      }
+      ```
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-query-nested-response-body?bar=bar&token=page2
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "nestedItems": {
+          "pets": [
+          { "id": "3", "name": "bird" },
+          { "id": "4", "name": "fish" }
+          ]
+        }
+      }
+      ```
+      """)
+    @route("/request-query-nested-response-body")
+    @list
+    op requestQueryNestedResponseBody(
+      @continuationToken @query token?: string,
+      ...HeaderAndQuery,
+    ): {
+      nestedItems: {
+        @pageItems
+        pets: Pet[];
+      };
+      nestedNext?: {
+        @continuationToken nextToken?: string;
+      };
+    };
+
+    @scenario
+    @scenarioDoc("""
+      Test case for using continuation token as pagination with nested response structure. Continuation token is passed in the request header and nested within response body.
+      
+      Two requests need to be tested.
+      
+      1. Initial request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-nested-response-body?bar=bar
+      
+      Expected request header:
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "nestedItems": {
+          "pets": [
+            { "id": "1", "name": "dog" },
+            { "id": "2", "name": "cat" }
+          ]
+        },
+        "next": {
+          "nextToken": "page2"
+        }
+      }
+      ```
+      
+      2. Next page request:
+      Expected route: /payload/pageable/server-driven-pagination/continuationtoken/request-header-nested-response-body?bar=bar
+      
+      Expected request header:
+      token=page2
+      foo=foo
+      
+      Expected response body:
+      ```json
+      { "nestedItems": {
+          "pets": [
+            { "id": "3", "name": "bird" },
+            { "id": "4", "name": "fish" }
+          ]
+        }
+      }
+      ```
+      """)
+    @route("/request-header-nested-response-body")
+    @list
+    op requestHeaderNestedResponseBody(
+      @continuationToken @header token?: string,
+      ...HeaderAndQuery,
+    ): {
+      nestedItems: {
+        @pageItems
+        pets: Pet[];
+      };
+      nestedNext?: {
+        @continuationToken nextToken?: string;
+      };
+    };
+  }
+}
+
+@route("/pagesize")
+namespace PageSize {
+  @scenario
+  @scenarioDoc("""
+    Test case for simple pagination without nextlink or continuationToken.
+    
+    Single request:
+    Expected route: /payload/pageable/pagesize/without-continuation
+    
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "1", "name": "dog" },
+        { "id": "2", "name": "cat" },
+        { "id": "3", "name": "bird" },
+        { "id": "4", "name": "fish" }
+      ]
+    }
+    ```
+    """)
+  @route("/without-continuation")
+  @list
+  op listWithoutContinuation(): {
+    @pageItems
+    pets: Pet[];
+  };
+
+  @scenario
+  @scenarioDoc("""
+    Test case for pagination with a regular @pageSize parameter.
+    
+    Two requests need to be tested:
+    1. Request with pageSize=2:
+    Expected route: /payload/pageable/pagesize/list?pageSize=2
+    
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "1", "name": "dog" },
+        { "id": "2", "name": "cat" }
+      ]
+    }
+    ```
+    
+    2. Request with pageSize=4:
+    Expected route: /payload/pageable/pagesize/list?pageSize=4
+    
+    Expected response body:
+    ```json
+    { "pets": [
+        { "id": "1", "name": "dog" },
+        { "id": "2", "name": "cat" },
+        { "id": "3", "name": "bird" },
+        { "id": "4", "name": "fish" }
+      ]
+    }
+    ```
+    """)
+  @route("/list")
+  @list
+  op listWithPageSize(@pageSize @query pageSize?: int32): {
+    @pageItems
+    pets: Pet[];
+  };
 }