ci: regenerated with OpenAPI Doc 0.3.0, Speakeay CLI 1.11.0

Author: speakeasybot

README.md

@@ -26,11 +26,10 @@ import {
 
 import { AxiosError } from "axios";
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
-
 const sdk = new Speakeasy({
   security: {
     apiKey: "YOUR_API_KEY_HERE",
-  }
+  },
 });
 
 const req: GetApisRequest = {

RELEASES.md

@@ -190,4 +190,12 @@ Based on:
 - OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
 - Speakeasy CLI 1.9.2 https://github.com/speakeasy-api/speakeasy
 ### Releases
-- [NPM v1.9.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.9.1 - .
+- [NPM v1.9.1] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.9.1 - .
+
+## 2023-03-15 00:11:13
+### Changes
+Based on:
+- OpenAPI Doc 0.3.0 https://docs.speakeasyapi.dev/openapi.yaml
+- Speakeasy CLI 1.11.0 https://github.com/speakeasy-api/speakeasy
+### Releases
+- [NPM v1.10.0] https://www.npmjs.com/package/@speakeasy-api/speakeasy-client-sdk-typescript/v/1.10.0 - .

USAGE.md

@@ -7,11 +7,10 @@ import {
 
 import { AxiosError } from "axios";
 import { Speakeasy } from "@speakeasy-api/speakeasy-client-sdk-typescript";
-
 const sdk = new Speakeasy({
   security: {
     apiKey: "YOUR_API_KEY_HERE",
-  }
+  },
 });
 
 const req: GetApisRequest = {

gen.yaml

@@ -2,12 +2,12 @@ configVersion: 1.0.0
 management:
   docChecksum: 2bba3b8f9d211b02569b3f9aff0d34b4
   docVersion: 0.3.0
-  speakeasyVersion: 1.9.2
+  speakeasyVersion: 1.11.0
 generation:
   telemetryEnabled: true
   sdkClassName: speakeasy
   sdkFlattening: true
 typescript:
-  version: 1.9.1
+  version: 1.10.0
   author: Speakeasy
   packageName: '@speakeasy-api/speakeasy-client-sdk-typescript'

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@speakeasy-api/speakeasy-client-sdk-typescript",
-  "version": "1.9.1",
+  "version": "1.10.0",
   "author": "Speakeasy",
   "scripts": {
     "prepare": "tsc --build"

package.json

@@ -1,18 +1,24 @@
-import { ParamDecorator } from "./utils";
 import {
   convertIfDateObjectToISOString,
   encodeAndConvertPrimitiveVal,
   parseParamDecorator,
+  populateFromGlobals,
 } from "./utils";
 
+import { ParamDecorator } from "./utils";
+
 export const qpMetadataKey = "queryParam";
 const queryStringPrefix = "?";
 
-export function serializeQueryParams(queryParams: any): string {
+export function serializeQueryParams(queryParams: any, globals?: any): string {
   let queryStringParts: string[] = [];
   if (!queryParams) return queryStringParts.join("&");
 
-  const fieldNames: string[] = Object.getOwnPropertyNames(queryParams);
+  const fieldNames: string[] =
+    "__props__" in queryParams
+      ? queryParams["__props__"].map((prop: any) => prop.key)
+      : Object.getOwnPropertyNames(queryParams);
+
   fieldNames.forEach((fname) => {
     const qpAnn: string = Reflect.getMetadata(
       qpMetadataKey,
@@ -31,38 +37,35 @@ export function serializeQueryParams(queryParams: any): string {
 
     if (!qpDecorator) return;
 
+    let value = queryParams[fname];
+    value = populateFromGlobals(value, fname, "queryParam", globals);
+
     if (qpDecorator.Serialization === "json")
-      queryStringParts.push(jsonSerializer({ [fname]: queryParams[fname] }));
+      queryStringParts.push(jsonSerializer({ [fname]: value }));
     else {
       switch (qpDecorator.Style) {
         case "deepObject":
           queryStringParts.push(
-            deepObjectSerializer(
-              { [fname]: queryParams[fname] },
-              qpDecorator.DateTimeFormat
-            )
+            deepObjectSerializer({ [fname]: value }, qpDecorator.DateTimeFormat)
           );
           return;
         case "form":
           if (!qpDecorator.Explode)
             queryStringParts.push(
-              formSerializer(
-                { [fname]: queryParams[fname] },
-                qpDecorator.DateTimeFormat
-              )
+              formSerializer({ [fname]: value }, qpDecorator.DateTimeFormat)
             );
           else
             queryStringParts.push(
               formSerializerExplode(
-                { [fname]: queryParams[fname] },
+                { [fname]: value },
                 qpDecorator.DateTimeFormat
               )
             );
           return;
         default:
           queryStringParts.push(
             formSerializerExplode(
-              { [fname]: queryParams[fname] },
+              { [fname]: value },
               qpDecorator.DateTimeFormat
             )
           );
@@ -182,7 +185,6 @@ function formSerializerExplode(
       query.push(
         Object.getOwnPropertyNames(value)
           .map((paramKey: string) => {
-
             const qpAnn: string = Reflect.getMetadata(
               qpMetadataKey,
               value,
@@ -238,7 +240,6 @@ function deepObjectSerializer(
       query.push(
         Object.getOwnPropertyNames(value)
           .map((paramKey: string) => {
-
             const qpAnn: string = Reflect.getMetadata(
               qpMetadataKey,
               value,

src/internal/utils/queryparams.ts

@@ -1,9 +1,10 @@
 import "reflect-metadata";
 
 import { getSimplePathParams, ppMetadataKey } from "./pathparams";
+
 import { plainToInstance } from "class-transformer";
 
-interface propInfo {
+export interface PropInfo {
   key: string | symbol;
   type: any;
   elemType: any;
@@ -61,7 +62,7 @@ function handleObject(value: any, elemType: any, elemDepth: number): any {
 
 export class SpeakeasyBase {
   constructor(payload?: Record<string | symbol, unknown>) {
-    const props: propInfo[] = (this as any)["__props__"];
+    const props: PropInfo[] = (this as any)["__props__"];
     if (props) {
       for (const prop of props) {
         if (payload && payload.hasOwnProperty(prop.key)) {
@@ -132,7 +133,7 @@ export function SpeakeasyMetadata<
       }
     }
 
-    let props: propInfo[];
+    let props: PropInfo[];
     if (target.hasOwnProperty("__props__")) {
       props = (target as any)["__props__"];
     } else {
@@ -142,7 +143,7 @@ export function SpeakeasyMetadata<
     const prop = {
       key: propertyKey,
       type: Reflect.getMetadata("design:type", target, propertyKey),
-    } as propInfo;
+    } as PropInfo;
 
     if (params?.elemType) {
       prop.elemType = params.elemType;
@@ -168,11 +169,16 @@ export function templateUrl(
 export function generateURL(
   serverURL: string,
   path: string,
-  pathParams: any
+  pathParams: any,
+  globals?: any
 ): string {
   const url: string = serverURL.replace(/\/$/, "") + path;
   const parsedParameters: Record<string, string> = {};
-  const fieldNames: string[] = Object.getOwnPropertyNames(pathParams);
+
+  const fieldNames: string[] =
+    "__props__" in pathParams
+      ? pathParams["__props__"].map((prop: any) => prop.key)
+      : Object.getOwnPropertyNames(pathParams);
   fieldNames.forEach((fname) => {
     const ppAnn: string = Reflect.getMetadata(ppMetadataKey, pathParams, fname);
     if (ppAnn == null) return;
@@ -183,11 +189,15 @@ export function generateURL(
       false
     );
     if (ppDecorator == null) return;
+
+    let value = pathParams[fname];
+    value = populateFromGlobals(value, fname, "pathParam", globals);
+
     switch (ppDecorator.Style) {
       case "simple":
         const simpleParams: Map<string, string> = getSimplePathParams(
           ppDecorator.ParamName,
-          pathParams[fname],
+          value,
           ppDecorator.Explode,
           ppDecorator.DateTimeFormat
         );
@@ -306,29 +316,37 @@ export function encodeAndConvertPrimitiveVal(
 export function deserializeJSONResponse<T>(
   value: T,
   klass?: any,
-  elemDepth: number = 0): any {
-
+  elemDepth: number = 0
+): any {
   if (value !== Object(value)) {
     return value;
   }
 
   if (elemDepth === 0 && klass != null) {
-    return plainToInstance(klass, value, { excludeExtraneousValues: true }) as typeof klass;
+    return plainToInstance(klass, value, {
+      excludeExtraneousValues: true,
+    }) as typeof klass;
   }
 
   if (Array.isArray(value)) {
-    return value.map((v) => deserializeJSONResponse(v, klass, elemDepth-1));
+    return value.map((v) => deserializeJSONResponse(v, klass, elemDepth - 1));
   }
 
-  if (typeof value === 'object' && value != null) {
+  if (typeof value === "object" && value != null) {
     let copiedRecord: Record<string, any> = {};
     for (const key in value) {
-      copiedRecord[key] = deserializeJSONResponse(value[key], klass, elemDepth-1);
+      copiedRecord[key] = deserializeJSONResponse(
+        value[key],
+        klass,
+        elemDepth - 1
+      );
     }
     return copiedRecord;
   }
 
-  return plainToInstance(klass, value, { excludeExtraneousValues: true }) as typeof klass;
+  return plainToInstance(klass, value, {
+    excludeExtraneousValues: true,
+  }) as typeof klass;
 }
 
 export function getResFieldDepth(res: any): number {
@@ -353,3 +371,21 @@ export function getResFieldDepth(res: any): number {
 
   return resFieldDepth;
 }
+
+export function populateFromGlobals(
+  value: any,
+  fieldName: string,
+  paramType: string,
+  globals: any
+): any {
+  if (globals && value === undefined) {
+    if ("parameters" in globals && paramType in globals.parameters) {
+      let globalValue = globals.parameters[paramType][fieldName];
+      if (globalValue !== undefined) {
+        value = globalValue;
+      }
+    }
+  }
+
+  return value;
+}