fix: allow empty base types when all props are read- or writeonly

the behaviour has been introduced to address #419 but it seems it's not required with the new implementation fix #453
oazapfts · Aug 14, 2023 · c2de017 · c2de017
1 parent 9e3dabc
commit c2de017
Show file tree

Hide file tree

Showing 7 changed files with 185 additions and 12 deletions.
diff --git a/demo/api.test.ts b/demo/api.test.ts
@@ -108,6 +108,27 @@ describe("ok", () => {
     // @ts-expect-error (writeonly Property)
     type ReadHidden = api.PagedListOfProductRead["items"][number]["hidden"];
   });
+
+  it("handles mixed readonly and writeonly properties", async () => {
+    const base: api.ReadWriteMixed = {};
+    // @ts-expect-error (readonly Property)
+    base.message = "nope";
+    // @ts-expect-error (writeonly Property)
+    base.email = "hi@example.org";
+
+    const write: api.ReadWriteMixedWrite = {
+      email: "hi@example.org",
+      password: "123",
+    };
+    // @ts-expect-error (readonly Property)
+    write.message = "nope";
+
+    const read: api.ReadWriteMixedRead = {
+      message: "hi",
+    };
+    // @ts-expect-error (writeonly Property)
+    read.email = "hi@example.org";
+  });
 });
 
 describe("object query parameters", () => {

diff --git a/demo/api.ts b/demo/api.ts
@@ -100,6 +100,14 @@ export type PagedListOfProductWrite = {
   pageSize: number;
   totalCount: number;
 };
+export type ReadWriteMixed = {};
+export type ReadWriteMixedRead = {
+  message: string;
+};
+export type ReadWriteMixedWrite = {
+  email: string;
+  password: string;
+};
 /**
  * Update an existing pet
  */
@@ -653,7 +661,10 @@ export function productsCreateMany(
   body?: PagedListOfProductWrite | Pet,
   opts?: Oazapfts.RequestOpts,
 ) {
-  return oazapfts.fetchText(
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: {};
+  }>(
     "/issue-446",
     oazapfts.json({
       ...opts,
@@ -662,3 +673,19 @@ export function productsCreateMany(
     }),
   );
 }
+export function readWriteMixed(
+  readWriteMixed?: ReadWriteMixedWrite,
+  opts?: Oazapfts.RequestOpts,
+) {
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: ReadWriteMixedRead;
+  }>(
+    "issue-453",
+    oazapfts.json({
+      ...opts,
+      method: "POST",
+      body: readWriteMixed,
+    }),
+  );
+}
diff --git a/demo/enumApi.ts b/demo/enumApi.ts
@@ -99,6 +99,14 @@ export type PagedListOfProductWrite = {
   pageSize: number;
   totalCount: number;
 };
+export type ReadWriteMixed = {};
+export type ReadWriteMixedRead = {
+  message: string;
+};
+export type ReadWriteMixedWrite = {
+  email: string;
+  password: string;
+};
 /**
  * Update an existing pet
  */
@@ -652,7 +660,10 @@ export function productsCreateMany(
   body?: PagedListOfProductWrite | Pet,
   opts?: Oazapfts.RequestOpts,
 ) {
-  return oazapfts.fetchText(
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: {};
+  }>(
     "/issue-446",
     oazapfts.json({
       ...opts,
@@ -661,6 +672,22 @@ export function productsCreateMany(
     }),
   );
 }
+export function readWriteMixed(
+  readWriteMixed?: ReadWriteMixedWrite,
+  opts?: Oazapfts.RequestOpts,
+) {
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: ReadWriteMixedRead;
+  }>(
+    "issue-453",
+    oazapfts.json({
+      ...opts,
+      method: "POST",
+      body: readWriteMixed,
+    }),
+  );
+}
 export enum Status {
   Available = "available",
   Pending = "pending",

diff --git a/demo/mergedReadWriteApi.ts b/demo/mergedReadWriteApi.ts
@@ -76,6 +76,11 @@ export type PagedListOfProduct = {
   pageSize: number;
   totalCount: number;
 };
+export type ReadWriteMixed = {
+  email: string;
+  password: string;
+  message: string;
+};
 /**
  * Update an existing pet
  */
@@ -630,7 +635,10 @@ export function productsCreateMany(
   body?: PagedListOfProduct | Pet,
   opts?: Oazapfts.RequestOpts,
 ) {
-  return oazapfts.fetchText(
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: {};
+  }>(
     "/issue-446",
     oazapfts.json({
       ...opts,
@@ -639,3 +647,19 @@ export function productsCreateMany(
     }),
   );
 }
+export function readWriteMixed(
+  readWriteMixed?: ReadWriteMixed,
+  opts?: Oazapfts.RequestOpts,
+) {
+  return oazapfts.fetchJson<{
+    status: 200;
+    data: ReadWriteMixed;
+  }>(
+    "issue-453",
+    oazapfts.json({
+      ...opts,
+      method: "POST",
+      body: readWriteMixed,
+    }),
+  );
+}
diff --git a/demo/optimisticApi.ts b/demo/optimisticApi.ts
@@ -100,6 +100,14 @@ export type PagedListOfProductWrite = {
   pageSize: number;
   totalCount: number;
 };
+export type ReadWriteMixed = {};
+export type ReadWriteMixedRead = {
+  message: string;
+};
+export type ReadWriteMixedWrite = {
+  email: string;
+  password: string;
+};
 /**
  * Update an existing pet
  */
@@ -708,7 +716,10 @@ export function productsCreateMany(
   opts?: Oazapfts.RequestOpts,
 ) {
   return oazapfts.ok(
-    oazapfts.fetchText(
+    oazapfts.fetchJson<{
+      status: 200;
+      data: {};
+    }>(
       "/issue-446",
       oazapfts.json({
         ...opts,
@@ -718,3 +729,21 @@ export function productsCreateMany(
     ),
   );
 }
+export function readWriteMixed(
+  readWriteMixed?: ReadWriteMixedWrite,
+  opts?: Oazapfts.RequestOpts,
+) {
+  return oazapfts.ok(
+    oazapfts.fetchJson<{
+      status: 200;
+      data: ReadWriteMixedRead;
+    }>(
+      "issue-453",
+      oazapfts.json({
+        ...opts,
+        method: "POST",
+        body: readWriteMixed,
+      }),
+    ),
+  );
+}
diff --git a/demo/petstore.json b/demo/petstore.json
@@ -1136,7 +1136,6 @@
           }
         }
       },
-
       "post": {
         "operationId": "Products_CreateMany",
         "parameters": [],
@@ -1159,9 +1158,40 @@
         "responses": {
           "200": {
             "description": "A successful response.",
-            "schema": {
-              "type": "object",
-              "properties": {}
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {}
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "issue-453": {
+      "post": {
+        "operationId": "ReadWriteMixed",
+        "parameters": [],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/ReadWriteMixed"
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "A successful response.",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ReadWriteMixed"
+                }
+              }
             }
           }
         }
@@ -1170,6 +1200,24 @@
   },
   "components": {
     "schemas": {
+      "ReadWriteMixed": {
+        "type": "object",
+        "properties": {
+          "email": {
+            "type": "string",
+            "writeOnly": true
+          },
+          "password": {
+            "type": "string",
+            "writeOnly": true
+          },
+          "message": {
+            "type": "string",
+            "readOnly": true
+          }
+        },
+        "required": ["email", "password", "message"]
+      },
       "PagedListOfProduct": {
         "type": "object",
         "additionalProperties": false,

diff --git a/src/codegen/generate.ts b/src/codegen/generate.ts
@@ -753,11 +753,8 @@ export default class ApiGenerator {
           return !isReadOnly && !isWriteOnly;
       }
     });
-    // By filtering by readOnly/writeOnly props, we may have filtered out all props in schemas
-    const hasFilteredAllProps = filteredPropertyNames.length === 0;
-    const names = hasFilteredAllProps ? propertyNames : filteredPropertyNames;
 
-    const members: ts.TypeElement[] = names.map((name) => {
+    const members: ts.TypeElement[] = filteredPropertyNames.map((name) => {
       const schema = props[name];
       const isRequired = required && required.includes(name);
       let type = this.getTypeFromSchema(schema, name, onlyMode);