feat: add requestBuilder (#1107)

Author: kuhe

.changeset/silent-pianos-cheer.md

@@ -0,0 +1,5 @@
+---
+"@smithy/core": minor
+---
+
+add requestBuilder

packages/core/package.json

@@ -27,6 +27,7 @@
     "@smithy/middleware-retry": "workspace:^",
     "@smithy/middleware-serde": "workspace:^",
     "@smithy/protocol-http": "workspace:^",
+    "@smithy/smithy-client": "workspace:^",
     "@smithy/types": "workspace:^",
     "tslib": "^2.5.0"
   },

packages/core/src/index.ts

@@ -3,3 +3,4 @@ export * from "./middleware-http-signing";
 export * from "./util-identity-and-auth";
 export * from "./getSmithyContext";
 export * from "./normalizeProvider";
+export * from "./protocols/requestBuilder";

packages/core/src/protocols/requestBuilder.spec.ts

@@ -0,0 +1,53 @@
+import { HttpRequest } from "@smithy/protocol-http";
+
+import { requestBuilder } from "./requestBuilder";
+
+describe(requestBuilder.name, () => {
+  it("can build requests", async () => {
+    expect(
+      await requestBuilder(
+        {
+          Key: "MyKey",
+          Bucket: "MyBucket",
+        },
+        {
+          endpoint: async () => {
+            return {
+              hostname: "localhost",
+              protocol: "https",
+              port: 8080,
+              path: "/a",
+            };
+          },
+        } as any
+      )
+        .bp("/{Key+}")
+        .p("Bucket", () => "MyBucket", "{Bucket}", false)
+        .p("Key", () => "MyKey", "{Key+}", false)
+        .m("PUT")
+        .h({
+          "my-header": "my-header-value",
+        })
+        .q({
+          "my-query": "my-query-value",
+        })
+        .b("test-body")
+        .build()
+    ).toEqual(
+      new HttpRequest({
+        protocol: "https",
+        hostname: "localhost",
+        port: 8080,
+        method: "PUT",
+        path: "/a/MyKey",
+        query: {
+          "my-query": "my-query-value",
+        },
+        headers: {
+          "my-header": "my-header-value",
+        },
+        body: "test-body",
+      })
+    );
+  });
+});

packages/core/src/protocols/requestBuilder.ts

@@ -0,0 +1,105 @@
+import { HttpRequest } from "@smithy/protocol-http";
+import { resolvedPath } from "@smithy/smithy-client";
+import type { SerdeContext } from "@smithy/types";
+
+/**
+ * @internal
+ * used in code-generated serde.
+ */
+export function requestBuilder(input: any, context: SerdeContext): RequestBuilder {
+  return new RequestBuilder(input, context);
+}
+
+/**
+ * @internal
+ */
+export class RequestBuilder {
+  private query: Record<string, string> = {};
+  private method = "";
+  private headers: Record<string, string> = {};
+  private path = "";
+  private body: any = null;
+  private hostname = "";
+
+  private resolvePathStack: Array<(path: string) => void> = [];
+
+  public constructor(private input: any, private context: SerdeContext) {}
+
+  public async build() {
+    const { hostname, protocol = "https", port, path: basePath } = await this.context.endpoint();
+    this.path = basePath;
+    for (const resolvePath of this.resolvePathStack) {
+      resolvePath(this.path);
+    }
+    return new HttpRequest({
+      protocol,
+      hostname: this.hostname || hostname,
+      port,
+      method: this.method,
+      path: this.path,
+      query: this.query,
+      body: this.body,
+      headers: this.headers,
+    });
+  }
+
+  /**
+   * Brevity setter for "hostname".
+   */
+  public hn(hostname: string) {
+    this.hostname = hostname;
+    return this;
+  }
+
+  /**
+   * Brevity initial builder for "basepath".
+   */
+  public bp(uriLabel: string) {
+    this.resolvePathStack.push((basePath: string) => {
+      this.path = `${basePath?.endsWith("/") ? basePath.slice(0, -1) : basePath || ""}` + uriLabel;
+    });
+    return this;
+  }
+
+  /**
+   * Brevity incremental builder for "path".
+   */
+  public p(memberName: string, labelValueProvider: () => string | undefined, uriLabel: string, isGreedyLabel: boolean) {
+    this.resolvePathStack.push((path: string) => {
+      this.path = resolvedPath(path, this.input, memberName, labelValueProvider, uriLabel, isGreedyLabel);
+    });
+    return this;
+  }
+
+  /**
+   * Brevity setter for "headers".
+   */
+  public h(headers: Record<string, string>) {
+    this.headers = headers;
+    return this;
+  }
+
+  /**
+   * Brevity setter for "query".
+   */
+  public q(query: Record<string, string>) {
+    this.query = query;
+    return this;
+  }
+
+  /**
+   * Brevity setter for "body".
+   */
+  public b(body: any) {
+    this.body = body;
+    return this;
+  }
+
+  /**
+   * Brevity setter for "method".
+   */
+  public m(method: string) {
+    this.method = method;
+    return this;
+  }
+}

turbo.json

@@ -5,7 +5,7 @@
     "build": {
       "dependsOn": ["^build"],
       "inputs": ["src/**/*", "package.json"],
-      "outputs": ["dist-types", "dist-cjs", "dist-es"]
+      "outputs": ["dist-types/**", "dist-cjs/**", "dist-es/**"]
     },
     "test": {
       "dependsOn": ["build"],

yarn.lock

@@ -1779,6 +1779,7 @@ __metadata:
     "@smithy/middleware-retry": "workspace:^"
     "@smithy/middleware-serde": "workspace:^"
     "@smithy/protocol-http": "workspace:^"
+    "@smithy/smithy-client": "workspace:^"
     "@smithy/types": "workspace:^"
     "@tsconfig/recommended": 1.0.1
     concurrently: 7.0.0