Merge branch 'master' into make-v22

CHANGELOG.md

@@ -11,6 +11,11 @@
 
 ## Version 21
 
+### v21.8.0
+
+- Deprecating `jsonEndpoints` from the code generated by `Integration`:
+  - Use the `content-type` header of an actual response instead, [example](#v20212).
+
 ### v21.7.0
 
 - Feature: introducing `EncodedResponse` public interface in the code generated by `Integration`:

example/example.client.ts

@@ -350,6 +350,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = {
   "get /v1/user/retrieve": true,
   "patch /v1/user/:id": true,

src/integration.ts

@@ -39,7 +39,7 @@ import { Routing } from "./routing";
 import { OnEndpoint, walkRouting } from "./routing-walker";
 import { HandlingRules } from "./schema-walker";
 import { zodToTs } from "./zts";
-import { ZTSContext, printNode } from "./zts-helpers";
+import { ZTSContext, printNode, addJsDocComment } from "./zts-helpers";
 import type Prettier from "prettier";
 
 type IOKind = "input" | "response" | ResponseVariant | "encoded";
@@ -116,6 +116,7 @@ export class Integration {
     negResponseInterface: f.createIdentifier("NegativeResponse"),
     encResponseInterface: f.createIdentifier("EncodedResponse"),
     responseInterface: f.createIdentifier("Response"),
+    /** @todo remove in v22 */
     jsonEndpointsConst: f.createIdentifier("jsonEndpoints"),
     endpointTagsConst: f.createIdentifier("endpointTags"),
     implementationType: f.createIdentifier("Implementation"),
@@ -301,10 +302,13 @@ export class Integration {
     if (variant === "types") return;
 
     // export const jsonEndpoints = { "get /v1/user/retrieve": true }
-    const jsonEndpointsConst = makeConst(
-      this.ids.jsonEndpointsConst,
-      f.createObjectLiteralExpression(jsonEndpoints),
-      { expose: true },
+    const jsonEndpointsConst = addJsDocComment(
+      makeConst(
+        this.ids.jsonEndpointsConst,
+        f.createObjectLiteralExpression(jsonEndpoints),
+        { expose: true },
+      ),
+      "@deprecated use content-type header of an actual response",
     );
 
     // export const endpointTags = { "get /v1/user/retrieve": ["users"] }

tests/unit/__snapshots__/integration.spec.ts.snap

@@ -58,6 +58,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = { "post /v1/test-with-dashes": true };
 
 export const endpointTags = { "post /v1/test-with-dashes": [] };
@@ -179,6 +180,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = { "post /v1/test-with-dashes": true };
 
 export const endpointTags = { "post /v1/test-with-dashes": [] };
@@ -300,6 +302,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = { "post /v1/test-with-dashes": true };
 
 export const endpointTags = { "post /v1/test-with-dashes": [] };
@@ -777,6 +780,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = {
   "get /v1/user/retrieve": true,
   "patch /v1/user/:id": true,
@@ -1337,6 +1341,7 @@ export interface Response {
 
 export type MethodPath = keyof Input;
 
+/** @deprecated use content-type header of an actual response */
 export const jsonEndpoints = { "post /v1/test-with-dashes": true };
 
 export const endpointTags = { "post /v1/test-with-dashes": [] };