feat: support exploded syntax in sdk #2896

sdo-1A · 2025-02-24T15:02:15Z

Proposed change

Support of exploded syntax for query and path parameters: https://swagger.io/docs/specification/v3_0/serialization/
This is an alternate solution to the existing PR #2865 to avoid breaking changes.

Related issues

#640

- No issue associated -

nx-cloud · 2025-02-24T15:23:32Z

View your CI Pipeline Execution ↗ for commit a51e001.

Command	Status	Duration	Result
`nx run-many --target=test-int`	✅ Succeeded	8m 5s	View ↗
`nx run-many --target=build --projects=eslint-pl...`	✅ Succeeded	1s	View ↗

☁️ Nx Cloud last updated this comment at 2025-02-27 08:47:09 UTC

codecov · 2025-02-24T15:37:20Z

Codecov Report

Attention: Patch coverage is 81.57895% with 14 lines in your changes missing coverage. Please review.

Project coverage is 69.72%. Comparing base (d2e9a76) to head (a51e001).
Report is 13 commits behind head on main.

✅ All tests successful. No failed tests found.

Files with missing lines	Patch %	Lines
...ges/@ama-sdk/core/src/clients/api-beacon-client.ts	0.00%	6 Missing ⚠️
...ages/@ama-sdk/core/src/clients/api-fetch-client.ts	0.00%	6 Missing ⚠️
packages/@ama-sdk/core/src/fwk/api.helpers.ts	96.87%	2 Missing ⚠️

Additional details and impacted files

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

packages/@ama-sdk/core/src/fwk/api.helpers.ts

packages/@o3r-training/showcase-sdk/package.json

cpaulve-1A · 2025-02-27T16:04:47Z

packages/@ama-sdk/client-angular/src/api-angular-client.ts

+  }
+
+  /** @inheritdoc */
+  public prepareUrl(url: string, data: { [key: string]: string | undefined }): string;


Suggested change

public prepareUrl(url: string, data: { [key: string]: string | undefined }): string;

public prepareUrl(url: string, data?: { [key: string]: string | undefined }): string;

cpaulve-1A · 2025-02-27T16:05:10Z

packages/@ama-sdk/client-angular/src/api-angular-client.ts

+    if (queryParamSerialization) {
+      return prepareUrl(url, data as T, queryParamSerialization);
+    }
+    return prepareUrl(url, data as { [key: string]: string | undefined });


Suggested change

return prepareUrl(url, data as { [key: string]: string | undefined });

return prepareUrl(url, (data || {}) as { [key: string]: string | undefined });

cpaulve-1A · 2025-02-27T16:06:50Z

packages/@ama-sdk/client-angular/src/api-angular-client.ts

+  /** @inheritdoc */
+  public prepareUrl<T extends { [key: string]: any }>(url: string, data?: { [key: string]: string | undefined } | T, queryParamSerialization?: { [K in keyof T]?: ParamSerialization }): string {
+    if (queryParamSerialization) {
+      return prepareUrl(url, data as T, queryParamSerialization);


You could import it with another name to avoid confusion? (prepareUrl as ....)

cpaulve-1A · 2025-02-27T16:07:19Z

packages/@ama-sdk/client-beacon/src/api-beacon-client.ts

+  }
+
+  /** @inheritdoc */
+  public prepareUrl(url: string, data: { [key: string]: string | undefined }): string;


Same comment as for api-angular clients

cpaulve-1A · 2025-02-27T16:07:56Z

packages/@ama-sdk/client-fetch/src/api-fetch-client.ts

@@ -92,8 +94,20 @@ export class ApiFetchClient implements ApiClient {
  }

  /** @inheritdoc */
-  public prepareUrl(url: string, queryParameters: { [key: string]: string | undefined } = {}) {
-    return prepareUrl(url, queryParameters);
+  public serializePathParams<T extends { [key: string]: any }>(data: T, pathParameters: { [K in keyof T]?: ParamSerialization }): { [p in keyof T]: string } {


Same comments as for api angular client

cpaulve-1A · 2025-02-27T16:09:18Z

packages/@ama-sdk/core/src/clients/api-angular-client.ts

+  }
+
+  /** @inheritdoc */
+  public prepareUrl(url: string, data: { [key: string]: string | undefined }): string;


Same comment as the other client angular

cpaulve-1A · 2025-02-27T16:09:27Z

packages/@ama-sdk/core/src/clients/api-beacon-client.ts

-  public prepareUrl(url: string, queryParameters?: { [key: string]: string }): string {
-    return prepareUrl(url, queryParameters);
+  public serializePathParams<T extends { [key: string]: any }>(data: T, pathParameters: { [K in keyof T]?: ParamSerialization }): { [p in keyof T]: string } {
+    return serializePathParams(data, pathParameters);


Same comment as the client angular

cpaulve-1A · 2025-02-27T16:09:45Z

packages/@ama-sdk/core/src/clients/api-fetch-client.ts

@@ -115,8 +117,20 @@ export class ApiFetchClient implements ApiClient {
  }

  /** @inheritdoc */
-  public prepareUrl(url: string, queryParameters: { [key: string]: string | undefined } = {}) {
-    return prepareUrl(url, queryParameters);
+  public serializePathParams<T extends { [key: string]: any }>(data: T, pathParameters: { [K in keyof T]?: ParamSerialization }): { [p in keyof T]: string } {


Same comment as the client angular

cpaulve-1A · 2025-02-27T16:13:01Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+        const queryParamExplode = paramSerialization.explode;
+        const queryParamStyle = paramSerialization.style;
+        const value = (() => {
+          if (Array.isArray(queryParamValue)) {


NB but I would have extracted the logic until line in another function for more readability

cpaulve-1A · 2025-02-27T16:14:31Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

- * prepares the url to be called
- * @param url base url to be used
- * @param queryParameters key value pair with the parameters. If the value is undefined, the key is dropped
+ * Serialize query parameters based on the values of exploded and style


Could be nice to have the reference to the parameter serialization

cpaulve-1A · 2025-02-27T16:29:58Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+        const value = (() => {
+          if (Array.isArray(queryParamValue)) {
+            if (queryParamExplode) {
+              switch (queryParamStyle) {


why a switch case if it is the same logic for everyone?

cpaulve-1A · 2025-02-27T16:31:02Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+      const pathParamValue = data[pathParamName];
+      if (typeof pathParamValue !== 'undefined' && pathParamValue !== null && !!pathParamSerialization) {
+        const value = (() => {
+          if (Array.isArray(pathParamValue)) {


Same remark for the extraction of the code

cpaulve-1A · 2025-02-27T16:34:50Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+ * @param data Query parameters key value pair. If the value is undefined, the key is dropped.
+ * @deprecated use `prepareUrl` with query parameter serialization, will be removed in v14.
+ */
+export function prepareUrl(url: string, data: { [key: string]: string | undefined }): string;


Suggested change

export function prepareUrl(url: string, data: { [key: string]: string | undefined }): string;

export function prepareUrl(url: string, data?: { [key: string]: string | undefined }): string;

cpaulve-1A · 2025-02-27T16:36:33Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts


+  const queryPart = Object.keys(data)


Suggested change

const queryPart = Object.keys(data)

const queryPart = Object.keys(data || {})

cpaulve-1A · 2025-02-27T16:41:35Z

...cript/core/openapi-codegen-typescript/src/main/java/com/amadeus/codegen/ts/LambdaHelper.java

   */
  public static class TokenizedUrlParamReplacerLambda extends CustomLambda {

      public TokenizedUrlParamReplacerLambda() {}

      @Override
      public String formatFragment(String fragment) {
-          return fragment.replaceAll("\\{([\\w_-]+)\\}", "\\${this.piiParamTokens['$1'] || data['$1']}");
+          return fragment.replaceAll("\\{([\\w_-]+)\\}", "\\${this.piiParamTokens['$1'] || pathParams['$1']}");


Why do you need to change that?

cpaulve-1A · 2025-02-27T16:45:09Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+          } else if (typeof queryParamValue === 'object') {
+            if (queryParamStyle === 'form') {
+              return queryParamExplode
+                ? Object.keys(queryParamValue).map((prop) => `${prop}=${queryParamValue[prop]}`).join('&')


Suggested change

? Object.keys(queryParamValue).map((prop) => `${prop}=${queryParamValue[prop]}`).join('&')

? Object.entries(queryParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join('&')

cpaulve-1A · 2025-02-27T16:47:31Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+            if (queryParamStyle === 'form') {
+              return queryParamExplode
+                ? Object.keys(queryParamValue).map((prop) => `${prop}=${queryParamValue[prop]}`).join('&')
+                : `${name}=` + Object.keys(queryParamValue).map((prop) => `${prop},${queryParamValue[prop]}`).join(',');


Suggested change

: `${name}=` + Object.keys(queryParamValue).map((prop) => `${prop},${queryParamValue[prop]}`).join(',');

: `${name}=` + Object.entries(queryParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

cpaulve-1A · 2025-02-27T16:48:11Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+                ? Object.keys(queryParamValue).map((prop) => `${prop}=${queryParamValue[prop]}`).join('&')
+                : `${name}=` + Object.keys(queryParamValue).map((prop) => `${prop},${queryParamValue[prop]}`).join(',');
+            } else {
+              return Object.keys(queryParamValue).map((prop) => `${name}[${prop}]=${queryParamValue[prop]}`).join('&');


Suggested change

return Object.keys(queryParamValue).map((prop) => `${name}[${prop}]=${queryParamValue[prop]}`).join('&');

return Object.entries(queryParamValue).map(([propName, propValue]) => `${name}[${propName}]=${propValue}`).join('&');

cpaulve-1A · 2025-02-27T17:00:32Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+  if (queryParamSerialization) {
+    if (Object.keys(queryParamSerialization).length > 0) {
+      const serializedQueryParams = serializeQueryParams(data as T, queryParamSerialization);
+      return url + paramsPrefix + Object.values(serializedQueryParams).join('&');


If your data is empty (because you don't want to pass parameters) but you have optional parameters in your queryParamSerialization, you will have an extra ?
for example : 'test.com?' instead of 'test.com'

cpaulve-1A · 2025-02-27T17:02:44Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+            switch (pathParamSerialization.style) {
+              case 'simple': {
+                return pathParamSerialization.explode
+                  ? Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(',')


Suggested change

? Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(',')

? Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join(',')

cpaulve-1A · 2025-02-27T17:04:23Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+              case 'simple': {
+                return pathParamSerialization.explode
+                  ? Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(',')
+                  : Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');


Suggested change

: Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');

: Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

cpaulve-1A · 2025-02-27T17:07:03Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+              }
+              case 'label': {
+                return pathParamSerialization.explode
+                  ? '.' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join('.')


Suggested change

? '.' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join('.')

? '.' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join('.')

cpaulve-1A · 2025-02-27T17:08:45Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+              case 'label': {
+                return pathParamSerialization.explode
+                  ? '.' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join('.')
+                  : '.' + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');


Suggested change

: '.' + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');

: '.' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

cpaulve-1A · 2025-02-27T17:09:55Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+              }
+              case 'matrix': {
+                return pathParamSerialization.explode
+                  ? ';' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(';')


Suggested change

? ';' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(';')

? ';' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join(';')

cpaulve-1A · 2025-02-27T17:11:24Z

packages/@ama-sdk/core/src/fwk/api.helpers.ts

+              case 'matrix': {
+                return pathParamSerialization.explode
+                  ? ';' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(';')
+                  : `;${pathParamName}=` + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');


Suggested change

: `;${pathParamName}=` + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');

: `;${pathParamName}=` + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

github-actions bot added enhancement New feature or request project:@ama-sdk/core project:@ama-sdk/schematics project:@ama-sdk/client-fetch project:@ama-sdk/client-angular project:@ama-sdk/client-beacon labels Feb 24, 2025

sdo-1A marked this pull request as ready for review February 25, 2025 08:59

sdo-1A requested a review from a team as a code owner February 25, 2025 08:59

fpaul-1A reviewed Feb 25, 2025

View reviewed changes

packages/@ama-sdk/core/src/fwk/api.helpers.ts Show resolved Hide resolved

sdo-1A force-pushed the feat/sdk-exploded-syntax-try2 branch from d8fe62b to 0868163 Compare February 26, 2025 10:40

github-actions bot added project:@o3r-training/showcase-sdk project:@o3r-training/training-sdk labels Feb 26, 2025

fpaul-1A reviewed Feb 26, 2025

View reviewed changes

packages/@o3r-training/showcase-sdk/package.json Outdated Show resolved Hide resolved

fpaul-1A previously approved these changes Feb 26, 2025

View reviewed changes

feat: support exploded syntax in sdk

a51e001

sdo-1A dismissed fpaul-1A’s stale review via a51e001 February 26, 2025 13:55

sdo-1A force-pushed the feat/sdk-exploded-syntax-try2 branch from 0868163 to a51e001 Compare February 26, 2025 13:55

fpaul-1A approved these changes Feb 26, 2025

View reviewed changes

cpaulve-1A reviewed Feb 27, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: support exploded syntax in sdk #2896

feat: support exploded syntax in sdk #2896

sdo-1A commented Feb 24, 2025

nx-cloud bot commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

cpaulve-1A Feb 27, 2025

	public prepareUrl(url: string, data: { [key: string]: string \| undefined }): string;
	public prepareUrl(url: string, data?: { [key: string]: string \| undefined }): string;

	return prepareUrl(url, data as { [key: string]: string \| undefined });
	return prepareUrl(url, (data \|\| {}) as { [key: string]: string \| undefined });

	export function prepareUrl(url: string, data: { [key: string]: string \| undefined }): string;
	export function prepareUrl(url: string, data?: { [key: string]: string \| undefined }): string;

	const queryPart = Object.keys(data)
	const queryPart = Object.keys(data \|\| {})

	? Object.keys(queryParamValue).map((prop) => `${prop}=${queryParamValue[prop]}`).join('&')
	? Object.entries(queryParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join('&')

	: `${name}=` + Object.keys(queryParamValue).map((prop) => `${prop},${queryParamValue[prop]}`).join(',');
	: `${name}=` + Object.entries(queryParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

	return Object.keys(queryParamValue).map((prop) => `${name}[${prop}]=${queryParamValue[prop]}`).join('&');
	return Object.entries(queryParamValue).map(([propName, propValue]) => `${name}[${propName}]=${propValue}`).join('&');

	? Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(',')
	? Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join(',')

	: Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');
	: Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

	? '.' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join('.')
	? '.' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join('.')

	: '.' + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');
	: '.' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

	? ';' + Object.keys(pathParamValue).map((property) => `${property}=${pathParamValue[property]}`).join(';')
	? ';' + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName}=${propValue}`).join(';')

	: `;${pathParamName}=` + Object.keys(pathParamValue).map((property) => `${property},${pathParamValue[property]}`).join(',');
	: `;${pathParamName}=` + Object.entries(pathParamValue).map(([propName, propValue]) => `${propName},${propValue}`).join(',');

feat: support exploded syntax in sdk #2896

Are you sure you want to change the base?

feat: support exploded syntax in sdk #2896

Conversation

sdo-1A commented Feb 24, 2025

Proposed change

Related issues

nx-cloud bot commented Feb 24, 2025 • edited Loading

codecov bot commented Feb 24, 2025 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nx-cloud bot commented Feb 24, 2025 •

edited

Loading

codecov bot commented Feb 24, 2025 •

edited

Loading