change error handling, add README, and re-add constructors

Author: anuraagnalluri

README.md

@@ -1 +1,46 @@
-# speakeasy-client-sdk-typescript
+# speakeasy-client-sdk-typescript
+
+This is the Speakeasy API Client SDK for Typescript. It is generated from our OpenAPI spec found at https://docs.speakeasyapi.dev/openapi.yaml and used for interacting with the [Speakeasy API](https://docs.speakeasyapi.dev/docs/speakeasy-api/speakeasy-api).
+
+This SDK was generated using Speakeasy's SDK Generator. For more information on how to use the generator to generate your own SDKs, please see the [Speakeasy Client SDK Generator Docs](https://docs.speakeasyapi.dev/docs/using-speakeasy/client-sdks).
+
+## Installation
+
+```bash
+// Coming soon
+npm i --save speakeasy-client-sdk-typescript
+```
+
+## Example usage
+```typescript
+// Replace relative paths below with npm module once it's published 
+import {
+    SDK,
+    WithSecurity,
+} from "../../speakeasy-client-sdk-typescript/src/sdk/sdk";
+import {
+    Security,
+    SchemeApiKey,
+} from "../../speakeasy-client-sdk-typescript/src/sdk/models/shared/security";
+import {
+    GetApisResponse,
+    GetApisRequest,
+    GetApisQueryParams,
+    GetApisOp,
+} from "../../speakeasy-client-sdk-typescript/src/sdk/models/operations";
+import { AxiosError } from "axios";
+
+const serverURL = "https://api.prod.speakeasyapi.dev";
+const security: Security = new Security(new SchemeApiKey("YOUR_API_KEY")); // Replace with your API key from your Speakeasy Workspace
+const sdk: SDK = new SDK(WithSecurity(serverURL, security));
+
+const metadata: Map<string, string[]> = new Map([["label", ["1"]]]);
+const op: GetApisOp = new GetApisOp(true);
+
+const request: GetApisRequest = new GetApisRequest(
+    new GetApisQueryParams(metadata, op)
+);
+sdk.GetApis(request).then((res: GetApisResponse | AxiosError) => {
+    console.log(res);
+});
+```

package.json

@@ -3,6 +3,7 @@
     "lint:fix": "tsc --noemit && eslint \"./src\" --ext .ts,.tsx --fix"
   },
   "dependencies": {
+    "@types/node": "^18.11.5",
     "@types/qs": "^6.9.7",
     "axios": "^1.1.3",
     "form-data": "^4.0.0",

src/internal/utils/contenttype.ts

@@ -2,12 +2,28 @@ export function MatchContentType(
   contentType: string,
   pattern: string
 ): boolean {
-  if (contentType === pattern || pattern === "*" || pattern === "*/*")
-    return true;
-  if (contentType === pattern) return true;
-  const parts: string[] = contentType.split("/");
-  if (parts.length === 2) {
-    if (`${parts[0]}/*` === pattern || `*/${parts[1]}` === pattern) return true;
-  }
-  return false;
+  let res = false;
+  contentType
+    .split(";")
+    .map((ctPart: string) => {
+      return ctPart.trim();
+    })
+    .forEach((ctPart: string) => {
+      if (ctPart === pattern || pattern === "*" || pattern === "*/*") {
+        res = true;
+        return;
+      }
+      if (ctPart === pattern) {
+        res = true;
+        return;
+      }
+      const parts: string[] = ctPart.split("/");
+      if (parts.length === 2) {
+        if (`${parts[0]}/*` === pattern || `*/${parts[1]}` === pattern) {
+          res = true;
+          return;
+        }
+      }
+    });
+  return res;
 }

src/internal/utils/requestbody.ts

@@ -1,4 +1,7 @@
 import FormData from "form-data";
+import { createReadStream, writeFileSync } from "fs";
+import { join } from "path";
+import qs from "qs";
 
 const requestMetadataKey = "request";
 const mpFormMetadataKey = "multipart_form";
@@ -19,14 +22,20 @@ export function SerializeRequestBody(request: any): [object, any] {
       case "multipart/form-data":
       case "multipart/mixed":
         requestBody = EncodeMultipartFormData(request[fname]);
-        requestHeaders = requestBody.getHeaders();
+        requestHeaders = (requestBody as FormData).getHeaders();
+        break;
+      case "application/x-www-form-urlencoded":
+        [requestHeaders, requestBody] = [
+          { "Content-Type": `${requestDecorator.MediaType}` },
+          qs.stringify({ ...request[fname] }),
+        ];
         break;
       case "application/json":
       case "text/json":
       default:
         [requestHeaders, requestBody] = [
           { "Content-Type": `${requestDecorator.MediaType}` },
-          request[fname],
+          { ...request[fname] },
         ];
     }
   });
@@ -48,29 +57,29 @@ function EncodeMultipartFormData(form: any): FormData {
     if (mpFormDecorator.File)
       return EncodeMultipartFormDataFile(formData, form[fname]);
     else if (mpFormDecorator.JSON) {
-      formData.append(mpFormDecorator.Name, JSON.stringify(form[fname]));
+      formData.append(mpFormDecorator.Name, { ...form[fname] });
     } else {
-      // let formData: FormData = new FormData();
-      // const val: unknown = form[fname];
-      // if (Array.isArray(form[fname]))
-      //     formData.append(mpFormDecorator.Name + "[]", val);
-      // else
-      //     formData.append(mpFormDecorator.Name, val)
+      if (Array.isArray(form[fname])) {
+        form[fname].forEach((val: any) => {
+          formData.append(mpFormDecorator.Name + "[]", JSON.stringify(val));
+        });
+      } else {
+        formData.append(mpFormDecorator.Name, JSON.stringify(form[fname]));
+      }
     }
   });
   return formData;
 }
 
-function EncodeMultipartFormDataFile(
-  formData: FormData,
-  file: any
-): FormData | Error {
+function EncodeMultipartFormDataFile(formData: FormData, file: any): FormData {
   if (typeof file !== "object" || Array.isArray(file) || file == null) {
-    return new Error("invalid type for multipart/form-data file");
+    throw new Error("invalid type for multipart/form-data file");
   }
   const fieldNames: string[] = Object.getOwnPropertyNames(file);
-  const content: string | undefined = undefined;
-  let fileName: string | undefined = undefined;
+  let content: any = null;
+  let fileName = "";
+  let mpFormDecoratorName = "";
+
   fieldNames.forEach((fname) => {
     const mpFormAnn: string = Reflect.getMetadata(
       mpFormMetadataKey,
@@ -80,15 +89,23 @@ function EncodeMultipartFormDataFile(
     if (mpFormAnn == null) return;
     const mpFormDecorator: MultipartFormDecorator =
       ParseMultipartFormDecorator(mpFormAnn);
-    let content = "";
     if (!mpFormDecorator.Content && mpFormDecorator.Name == "") return;
     if (mpFormDecorator.Content) content = file[fname];
-    else fileName = file[fname];
+    else {
+      mpFormDecoratorName = mpFormDecorator.Name;
+      fileName = file[fname];
+    }
   });
 
-  if (content == null || fileName == null)
-    return new Error("invalid multipart/form-data file");
-  formData.append(fileName!, content!);
+  if (mpFormDecoratorName === "" || fileName === "" || content == null)
+    throw new Error("invalid multipart/form-data file");
+  writeFileSync(join(__dirname, fileName), content, {
+    flag: "w",
+  });
+  formData.append(
+    mpFormDecoratorName,
+    createReadStream(join(__dirname, fileName))
+  );
   return formData;
 }
 

src/sdk/models/operations/deleteapi.ts

@@ -6,10 +6,19 @@ export class DeleteApiPathParams {
   ApiId: string;
   @Metadata("pathParam, style=simple;explode=false;name=versionID")
   VersionId: string;
+
+  constructor(ApiId: string, VersionId: string) {
+    this.ApiId = ApiId;
+    this.VersionId = VersionId;
+  }
 }
 
 export class DeleteApiRequest {
   PathParams: DeleteApiPathParams;
+
+  constructor(PathParams: DeleteApiPathParams) {
+    this.PathParams = PathParams;
+  }
 }
 
 export class DeleteApiResponse {
@@ -18,4 +27,10 @@ export class DeleteApiResponse {
   Error?: shared.Error;
 
   StatusCode: number;
+
+  constructor(ContentType: string, StatusCode: number, Error?: shared.Error) {
+    this.ContentType = ContentType;
+    this.Error = Error;
+    this.StatusCode = StatusCode;
+  }
 }

src/sdk/models/operations/deleteapiendpoint.ts

@@ -8,10 +8,20 @@ export class DeleteApiEndpointPathParams {
   ApiId: string;
   @Metadata("pathParam, style=simple;explode=false;name=versionID")
   VersionId: string;
+
+  constructor(ApiEndpointId: string, ApiId: string, VersionId: string) {
+    this.ApiEndpointId = ApiEndpointId;
+    this.ApiId = ApiId;
+    this.VersionId = VersionId;
+  }
 }
 
 export class DeleteApiEndpointRequest {
   PathParams: DeleteApiEndpointPathParams;
+
+  constructor(PathParams: DeleteApiEndpointPathParams) {
+    this.PathParams = PathParams;
+  }
 }
 
 export class DeleteApiEndpointResponse {
@@ -20,4 +30,10 @@ export class DeleteApiEndpointResponse {
   Error?: shared.Error;
 
   StatusCode: number;
+
+  constructor(ContentType: string, StatusCode: number, Error?: shared.Error) {
+    this.ContentType = ContentType;
+    this.Error = Error;
+    this.StatusCode = StatusCode;
+  }
 }

src/sdk/models/operations/deleteschema.ts

@@ -8,10 +8,20 @@ export class DeleteSchemaPathParams {
   RevisionId: string;
   @Metadata("pathParam, style=simple;explode=false;name=versionID")
   VersionId: string;
+
+  constructor(ApiId: string, RevisionId: string, VersionId: string) {
+    this.ApiId = ApiId;
+    this.RevisionId = RevisionId;
+    this.VersionId = VersionId;
+  }
 }
 
 export class DeleteSchemaRequest {
   PathParams: DeleteSchemaPathParams;
+
+  constructor(PathParams: DeleteSchemaPathParams) {
+    this.PathParams = PathParams;
+  }
 }
 
 export class DeleteSchemaResponse {
@@ -20,4 +30,10 @@ export class DeleteSchemaResponse {
   Error?: shared.Error;
 
   StatusCode: number;
+
+  constructor(ContentType: string, StatusCode: number, Error?: shared.Error) {
+    this.ContentType = ContentType;
+    this.Error = Error;
+    this.StatusCode = StatusCode;
+  }
 }

src/sdk/models/operations/deleteversionmetadata.ts

@@ -10,10 +10,26 @@ export class DeleteVersionMetadataPathParams {
   MetaValue: string;
   @Metadata("pathParam, style=simple;explode=false;name=versionID")
   VersionId: string;
+
+  constructor(
+    ApiId: string,
+    MetaKey: string,
+    MetaValue: string,
+    VersionId: string
+  ) {
+    this.ApiId = ApiId;
+    this.MetaKey = MetaKey;
+    this.MetaValue = MetaValue;
+    this.VersionId = VersionId;
+  }
 }
 
 export class DeleteVersionMetadataRequest {
   PathParams: DeleteVersionMetadataPathParams;
+
+  constructor(PathParams: DeleteVersionMetadataPathParams) {
+    this.PathParams = PathParams;
+  }
 }
 
 export class DeleteVersionMetadataResponse {
@@ -22,4 +38,10 @@ export class DeleteVersionMetadataResponse {
   Error?: shared.Error;
 
   StatusCode: number;
+
+  constructor(ContentType: string, StatusCode: number, Error?: shared.Error) {
+    this.ContentType = ContentType;
+    this.Error = Error;
+    this.StatusCode = StatusCode;
+  }
 }

src/sdk/models/operations/downloadschema.ts

@@ -6,10 +6,19 @@ export class DownloadSchemaPathParams {
   ApiId: string;
   @Metadata("pathParam, style=simple;explode=false;name=versionID")
   VersionId: string;
+
+  constructor(ApiId: string, VersionId: string) {
+    this.ApiId = ApiId;
+    this.VersionId = VersionId;
+  }
 }
 
 export class DownloadSchemaRequest {
   PathParams: DownloadSchemaPathParams;
+
+  constructor(PathParams: DownloadSchemaPathParams) {
+    this.PathParams = PathParams;
+  }
 }
 
 export class DownloadSchemaResponse {
@@ -20,4 +29,16 @@ export class DownloadSchemaResponse {
   Schema?: string;
 
   StatusCode: number;
+
+  constructor(
+    ContentType: string,
+    StatusCode: number,
+    Error?: shared.Error,
+    Schema?: string
+  ) {
+    this.ContentType = ContentType;
+    this.Error = Error;
+    this.Schema = Schema;
+    this.StatusCode = StatusCode;
+  }
 }