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

package/dist/specs/payload/pageable/mockapi.js

@@ -1,10 +1,213 @@
-import { json, passOnSuccess } from "@typespec/spec-api";
+import { dyn, dynItem, json, passOnSuccess, ValidationError, xml, } from "@typespec/spec-api";
 export const Scenarios = {};
+const FirstPage = [
+    { id: "1", name: "dog" },
+    { id: "2", name: "cat" },
+];
+const SecondPage = [
+    { id: "3", name: "bird" },
+    { id: "4", name: "fish" },
+];
+const FirstResponseTokenInBody = {
+    status: 200,
+    body: json({
+        pets: FirstPage,
+        nextToken: "page2",
+    }),
+};
+const SecondResponse = {
+    status: 200,
+    body: json({
+        pets: SecondPage,
+    }),
+};
+const FirstResponseTokenInHeader = {
+    status: 200,
+    body: json({
+        pets: FirstPage,
+    }),
+    headers: {
+        "next-token": "page2",
+        foo: "foo",
+    },
+};
+const RequestTokenInQuery = {
+    query: { token: "page2", bar: "bar" },
+    headers: { foo: "foo" },
+};
+const RequestTokenInHeader = { headers: { token: "page2", foo: "foo" }, query: { bar: "bar" } };
+function createTests(reqInfo, resInfo) {
+    const uri = `/payload/pageable/server-driven-pagination/continuationtoken/request-${reqInfo}-response-${resInfo}`;
+    function createHandler() {
+        return (req) => {
+            req.expect.containsHeader("foo", "foo");
+            req.expect.containsQueryParam("bar", "bar");
+            const token = reqInfo === "header" ? req.headers?.token : req.query?.token;
+            switch (token) {
+                case undefined:
+                    return resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody;
+                case "page2":
+                    return SecondResponse;
+                default:
+                    throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+            }
+        };
+    }
+    return passOnSuccess([
+        {
+            uri: uri,
+            method: "get",
+            request: { headers: { foo: "foo" }, query: { bar: "bar" } },
+            response: resInfo === "header" ? FirstResponseTokenInHeader : FirstResponseTokenInBody,
+            handler: createHandler(),
+            kind: "MockApiDefinition",
+        },
+        {
+            uri: uri,
+            method: "get",
+            request: reqInfo === "header" ? RequestTokenInHeader : RequestTokenInQuery,
+            response: SecondResponse,
+            handler: createHandler(),
+            kind: "MockApiDefinition",
+        },
+    ]);
+}
 Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
     {
         uri: "/payload/pageable/server-driven-pagination/link",
         method: "get",
         request: {},
+        response: {
+            status: 200,
+            body: json({
+                pets: FirstPage,
+                next: dyn `${dynItem("baseUrl")}/payload/pageable/server-driven-pagination/link/nextPage`,
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/server-driven-pagination/link/nextPage",
+        method: "get",
+        request: {},
+        response: SecondResponse,
+        kind: "MockApiDefinition",
+    },
+]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_linkString = passOnSuccess([
+    {
+        uri: "/payload/pageable/server-driven-pagination/link-string",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: json({
+                pets: FirstPage,
+                next: dyn `${dynItem("baseUrl")}/payload/pageable/server-driven-pagination/link-string/nextPage`,
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/server-driven-pagination/link-string/nextPage",
+        method: "get",
+        request: {},
+        response: SecondResponse,
+        kind: "MockApiDefinition",
+    },
+]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_nestedLink = passOnSuccess([
+    {
+        uri: "/payload/pageable/server-driven-pagination/nested-link",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: json({
+                nestedItems: {
+                    pets: FirstPage,
+                },
+                nestedNext: {
+                    next: dyn `${dynItem("baseUrl")}/payload/pageable/server-driven-pagination/nested-link/nextPage`,
+                },
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/server-driven-pagination/nested-link/nextPage",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: json({
+                nestedItems: {
+                    pets: SecondPage,
+                },
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+]);
+// POST-THEN-GET LINK PAGINATION
+Scenarios.Payload_Pageable_ServerDrivenPagination_AlternateInitialVerb_post = passOnSuccess([
+    {
+        uri: "/payload/pageable/server-driven-pagination/link/initial-post",
+        method: "post",
+        request: {
+            body: json({ filter: "foo eq bar" }),
+        },
+        response: {
+            status: 200,
+            body: json({
+                pets: FirstPage,
+                next: dyn `${dynItem("baseUrl")}/payload/pageable/server-driven-pagination/link/initial-post/nextPage?token=abc`,
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/server-driven-pagination/link/initial-post/nextPage",
+        method: "get",
+        request: {
+            query: { token: "abc" },
+        },
+        response: SecondResponse,
+        kind: "MockApiDefinition",
+    },
+]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseBody =
+    createTests("query", "body");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseBody =
+    createTests("header", "body");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryResponseHeader =
+    createTests("query", "header");
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderResponseHeader =
+    createTests("header", "header");
+Scenarios.Payload_Pageable_PageSize_listWithoutContinuation = passOnSuccess([
+    {
+        uri: "/payload/pageable/pagesize/without-continuation",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: json({
+                pets: [
+                    { id: "1", name: "dog" },
+                    { id: "2", name: "cat" },
+                    { id: "3", name: "bird" },
+                    { id: "4", name: "fish" },
+                ],
+            }),
+        },
+        kind: "MockApiDefinition",
+    },
+]);
+Scenarios.Payload_Pageable_PageSize_listWithPageSize = passOnSuccess([
+    {
+        uri: "/payload/pageable/pagesize/list",
+        method: "get",
+        request: { query: { pageSize: "2" } },
         response: {
             status: 200,
             body: json({
@@ -12,36 +215,445 @@ Scenarios.Payload_Pageable_ServerDrivenPagination_link = passOnSuccess([
                     { id: "1", name: "dog" },
                     { id: "2", name: "cat" },
                 ],
-                next: "/payload/pageable/server-driven-pagination/link/nextPage",
             }),
         },
         handler: (req) => {
-            return {
-                status: 200,
-                body: json({
-                    pets: [
-                        { id: "1", name: "dog" },
-                        { id: "2", name: "cat" },
-                    ],
-                    next: `${req.baseUrl}/payload/pageable/server-driven-pagination/link/nextPage`,
-                }),
-            };
+            const pageSize = req.query?.pageSize;
+            switch (pageSize) {
+                case "2":
+                    return {
+                        status: 200,
+                        body: json({
+                            pets: [
+                                { id: "1", name: "dog" },
+                                { id: "2", name: "cat" },
+                            ],
+                        }),
+                    };
+                case "4":
+                    return {
+                        status: 200,
+                        body: json({
+                            pets: [
+                                { id: "1", name: "dog" },
+                                { id: "2", name: "cat" },
+                                { id: "3", name: "bird" },
+                                { id: "4", name: "fish" },
+                            ],
+                        }),
+                    };
+                default:
+                    throw new ValidationError("Unsupported page size", `"2" | "4"`, pageSize);
+            }
         },
         kind: "MockApiDefinition",
     },
     {
-        uri: "/payload/pageable/server-driven-pagination/link/nextPage",
+        uri: "/payload/pageable/pagesize/list",
         method: "get",
-        request: {},
+        request: { query: { pageSize: "4" } },
         response: {
             status: 200,
             body: json({
                 pets: [
+                    { id: "1", name: "dog" },
+                    { id: "2", name: "cat" },
                     { id: "3", name: "bird" },
                     { id: "4", name: "fish" },
                 ],
             }),
         },
+        handler: (req) => {
+            const pageSize = req.query?.pageSize;
+            switch (pageSize) {
+                case "2":
+                    return {
+                        status: 200,
+                        body: json({
+                            pets: [
+                                { id: "1", name: "dog" },
+                                { id: "2", name: "cat" },
+                            ],
+                        }),
+                    };
+                case "4":
+                    return {
+                        status: 200,
+                        body: json({
+                            pets: [
+                                { id: "1", name: "dog" },
+                                { id: "2", name: "cat" },
+                                { id: "3", name: "bird" },
+                                { id: "4", name: "fish" },
+                            ],
+                        }),
+                    };
+                default:
+                    throw new ValidationError("Unsupported page size", `"2" | "4"`, pageSize);
+            }
+        },
+        kind: "MockApiDefinition",
+    },
+]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestQueryNestedResponseBody =
+    passOnSuccess([
+        {
+            uri: "/payload/pageable/server-driven-pagination/continuationtoken/request-query-nested-response-body",
+            method: "get",
+            request: { headers: { foo: "foo" }, query: { bar: "bar" } },
+            response: {
+                status: 200,
+                body: json({
+                    nestedItems: {
+                        pets: FirstPage,
+                    },
+                    nestedNext: {
+                        nextToken: "page2",
+                    },
+                }),
+            },
+            handler: (req) => {
+                req.expect.containsHeader("foo", "foo");
+                req.expect.containsQueryParam("bar", "bar");
+                const token = req.query?.token;
+                switch (token) {
+                    case undefined:
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: FirstPage,
+                                },
+                                nestedNext: {
+                                    nextToken: "page2",
+                                },
+                            }),
+                        };
+                    case "page2":
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: SecondPage,
+                                },
+                            }),
+                        };
+                    default:
+                        throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+                }
+            },
+            kind: "MockApiDefinition",
+        },
+        {
+            uri: "/payload/pageable/server-driven-pagination/continuationtoken/request-query-nested-response-body",
+            method: "get",
+            request: RequestTokenInQuery,
+            response: {
+                status: 200,
+                body: json({
+                    nestedItems: {
+                        pets: SecondPage,
+                    },
+                }),
+            },
+            handler: (req) => {
+                req.expect.containsHeader("foo", "foo");
+                req.expect.containsQueryParam("bar", "bar");
+                const token = req.query?.token;
+                switch (token) {
+                    case undefined:
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: FirstPage,
+                                },
+                                nestedNext: {
+                                    nextToken: "page2",
+                                },
+                            }),
+                        };
+                    case "page2":
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: SecondPage,
+                                },
+                            }),
+                        };
+                    default:
+                        throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+                }
+            },
+            kind: "MockApiDefinition",
+        },
+    ]);
+Scenarios.Payload_Pageable_ServerDrivenPagination_ContinuationToken_requestHeaderNestedResponseBody =
+    passOnSuccess([
+        {
+            uri: "/payload/pageable/server-driven-pagination/continuationtoken/request-header-nested-response-body",
+            method: "get",
+            request: { headers: { foo: "foo" }, query: { bar: "bar" } },
+            response: {
+                status: 200,
+                body: json({
+                    nestedItems: {
+                        pets: FirstPage,
+                    },
+                    nestedNext: {
+                        nextToken: "page2",
+                    },
+                }),
+            },
+            handler: (req) => {
+                req.expect.containsHeader("foo", "foo");
+                req.expect.containsQueryParam("bar", "bar");
+                const token = req.headers?.token;
+                switch (token) {
+                    case undefined:
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: FirstPage,
+                                },
+                                nestedNext: {
+                                    nextToken: "page2",
+                                },
+                            }),
+                        };
+                    case "page2":
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: SecondPage,
+                                },
+                            }),
+                        };
+                    default:
+                        throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+                }
+            },
+            kind: "MockApiDefinition",
+        },
+        {
+            uri: "/payload/pageable/server-driven-pagination/continuationtoken/request-header-nested-response-body",
+            method: "get",
+            request: RequestTokenInHeader,
+            response: {
+                status: 200,
+                body: json({
+                    nestedItems: {
+                        pets: SecondPage,
+                    },
+                }),
+            },
+            handler: (req) => {
+                req.expect.containsHeader("foo", "foo");
+                req.expect.containsQueryParam("bar", "bar");
+                const token = req.headers?.token;
+                switch (token) {
+                    case undefined:
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: FirstPage,
+                                },
+                                nestedNext: {
+                                    nextToken: "page2",
+                                },
+                            }),
+                        };
+                    case "page2":
+                        return {
+                            status: 200,
+                            body: json({
+                                nestedItems: {
+                                    pets: SecondPage,
+                                },
+                            }),
+                        };
+                    default:
+                        throw new ValidationError("Unsupported continuation token", `"undefined" | "page2"`, token);
+                }
+            },
+            kind: "MockApiDefinition",
+        },
+    ]);
+const XmlContTokenFirstPage = `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>1</Id>
+      <Name>dog</Name>
+    </Pet>
+    <Pet>
+      <Id>2</Id>
+      <Name>cat</Name>
+    </Pet>
+  </Pets>
+  <NextMarker>page2</NextMarker>
+</PetListResult>
+`;
+const XmlContTokenSecondPage = `
+<PetListResult>
+  <Pets>
+    <Pet>
+      <Id>3</Id>
+      <Name>bird</Name>
+    </Pet>
+    <Pet>
+      <Id>4</Id>
+      <Name>fish</Name>
+    </Pet>
+  </Pets>
+</PetListResult>
+`;
+Scenarios.Payload_Pageable_XmlPagination_listWithContinuation = passOnSuccess([
+    {
+        uri: "/payload/pageable/xml/list-with-continuation",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: xml(XmlContTokenFirstPage),
+            headers: {
+                "content-type": "application/xml; charset=utf-8",
+            },
+        },
+        handler: (req) => {
+            const marker = req.query?.marker;
+            switch (marker) {
+                case undefined:
+                    return {
+                        status: 200,
+                        body: xml(XmlContTokenFirstPage),
+                        headers: {
+                            "content-type": "application/xml",
+                        },
+                    };
+                case "page2":
+                    return {
+                        status: 200,
+                        body: xml(XmlContTokenSecondPage),
+                        headers: {
+                            "content-type": "application/xml",
+                        },
+                    };
+                default:
+                    throw new ValidationError("Unsupported marker", `"undefined" | "page2"`, marker);
+            }
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/xml/list-with-continuation",
+        method: "get",
+        request: { query: { marker: "page2" } },
+        response: {
+            status: 200,
+            body: xml(XmlContTokenSecondPage),
+            headers: {
+                "content-type": "application/xml; charset=utf-8",
+            },
+        },
+        handler: (req) => {
+            const marker = req.query?.marker;
+            switch (marker) {
+                case undefined:
+                    return {
+                        status: 200,
+                        body: xml(XmlContTokenFirstPage),
+                        headers: {
+                            "content-type": "application/xml",
+                        },
+                    };
+                case "page2":
+                    return {
+                        status: 200,
+                        body: xml(XmlContTokenSecondPage),
+                        headers: {
+                            "content-type": "application/xml",
+                        },
+                    };
+                default:
+                    throw new ValidationError("Unsupported marker", `"undefined" | "page2"`, marker);
+            }
+        },
+        kind: "MockApiDefinition",
+    },
+]);
+const xmlNextLinkFirstPage = (baseUrl) => `
+<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>
+    <Pet>
+      <Id>3</Id>
+      <Name>bird</Name>
+    </Pet>
+    <Pet>
+      <Id>4</Id>
+      <Name>fish</Name>
+    </Pet>
+  </Pets>
+</PetListResult>
+`;
+Scenarios.Payload_Pageable_XmlPagination_listWithNextLink = passOnSuccess([
+    {
+        uri: "/payload/pageable/xml/list-with-next-link",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: {
+                contentType: "application/xml",
+                rawContent: {
+                    serialize: (config) => `<?xml version='1.0' encoding='UTF-8'?>` + xmlNextLinkFirstPage(config.baseUrl),
+                },
+            },
+            headers: {
+                "content-type": "application/xml; charset=utf-8",
+            },
+        },
+        handler: (req) => {
+            return {
+                status: 200,
+                body: xml(xmlNextLinkFirstPage(req.baseUrl)),
+                headers: {
+                    "content-type": "application/xml",
+                },
+            };
+        },
+        kind: "MockApiDefinition",
+    },
+    {
+        uri: "/payload/pageable/xml/list-with-next-link/nextPage",
+        method: "get",
+        request: {},
+        response: {
+            status: 200,
+            body: xml(XmlNextLinkSecondPage),
+            headers: {
+                "content-type": "application/xml; charset=utf-8",
+            },
+        },
         kind: "MockApiDefinition",
     },
 ]);