Merge pull request #2530 from hey-api/fix(transformer)--Split-schemas-with-readOnly-or-writeOnly-properties

Fix(transformer): Fix readWrite transformer splitting logic

Author: mrlubos

.changeset/tender-files-check.md

@@ -0,0 +1,5 @@
+---
+'@hey-api/openapi-ts': patch
+---
+
+fix(parser): improve `readWrite` transformer splitting logic

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@hey-api/schemas/default/schemas.gen.ts

@@ -668,4 +668,73 @@ export const failure_FailureSchema = {
             type: 'string'
         }
     }
+} as const;
+
+export const ModelWithPropertiesWritableSchema = {
+    description: 'This is a model with one nested property',
+    type: 'object',
+    required: ['required', 'requiredAndReadOnly'],
+    properties: {
+        required: {
+            type: 'string'
+        },
+        string: {
+            type: 'string'
+        },
+        number: {
+            type: 'number'
+        },
+        boolean: {
+            type: 'boolean'
+        },
+        reference: {
+            '$ref': '#/definitions/ModelWithString'
+        },
+        'property with space': {
+            type: 'string'
+        },
+        default: {
+            type: 'string'
+        },
+        try: {
+            type: 'string'
+        }
+    }
+} as const;
+
+export const ModelWithPatternWritableSchema = {
+    description: 'This is a model that contains a some patterns',
+    type: 'object',
+    required: ['key', 'name'],
+    properties: {
+        key: {
+            maxLength: 64,
+            pattern: '^[a-zA-Z0-9_]*$',
+            type: 'string'
+        },
+        name: {
+            maxLength: 255,
+            type: 'string'
+        },
+        id: {
+            type: 'string',
+            pattern: '^\\d{2}-\\d{3}-\\d{4}$'
+        },
+        text: {
+            type: 'string',
+            pattern: '^\\w+$'
+        },
+        patternWithSingleQuotes: {
+            type: 'string',
+            pattern: "^[a-zA-Z0-9']*$"
+        },
+        patternWithNewline: {
+            type: 'string',
+            pattern: 'aaa\\nbbb'
+        },
+        patternWithBacktick: {
+            type: 'string',
+            pattern: 'aaa`bbb'
+        }
+    }
 } as const;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/default/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@hey-api/sdk/throwOnError/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/transforms-read-write-custom-name/types.gen.ts

@@ -1,13 +1,5 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
-export type FooRead = BarRead & {
-    readonly foo?: string;
-};
-
-export type BarRead = Baz & {
-    readonly bar?: string;
-};
-
 export type Baz = {
     baz?: string;
 };
@@ -16,20 +8,40 @@ export type QuxAllRead = {
     readonly baz?: string;
 };
 
-export type Quux = {
+export type ReadableFooRead = ReadableBarRead & {
+    readonly foo?: string;
+};
+
+export type WritableFooRead = WritableBarRead;
+
+export type ReadableBarRead = Baz & {
+    readonly bar?: string;
+};
+
+export type WritableBarRead = Baz;
+
+export type ReadableQuux = {
     baz?: Array<Baz>;
     qux?: QuxAllRead;
 };
 
-export type Corge = {
+export type WritableQuux = {
+    baz?: Array<Baz>;
+};
+
+export type ReadableCorge = {
     foo?: string;
     bar?: {
         readonly baz?: boolean;
     };
 };
 
+export type WritableCorge = {
+    foo?: string;
+};
+
 export type PostFooReadData = {
-    body: FooRead;
+    body: WritableFooRead;
     path?: never;
     query?: never;
     url: '/foo-read';
@@ -39,7 +51,7 @@ export type PostFooReadResponses = {
     /**
      * OK
      */
-    200: FooRead;
+    200: ReadableFooRead;
 };
 
 export type PostFooReadResponse = PostFooReadResponses[keyof PostFooReadResponses];

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@pinia/colada/fetch/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@pinia/colada/group-by-tag/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/axios/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/angular-query-experimental/fetch/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;

packages/openapi-ts-tests/main/test/__snapshots__/2.0.x/plugins/@tanstack/react-query/axios/types.gen.ts

@@ -406,6 +406,33 @@ export type FailureFailure = {
     reference_code?: string;
 };
 
+/**
+ * This is a model with one nested property
+ */
+export type ModelWithPropertiesWritable = {
+    required: string;
+    string?: string;
+    number?: number;
+    boolean?: boolean;
+    reference?: ModelWithString;
+    'property with space'?: string;
+    default?: string;
+    try?: string;
+};
+
+/**
+ * This is a model that contains a some patterns
+ */
+export type ModelWithPatternWritable = {
+    key: string;
+    name: string;
+    id?: string;
+    text?: string;
+    patternWithSingleQuotes?: string;
+    patternWithNewline?: string;
+    patternWithBacktick?: string;
+};
+
 export type ServiceWithEmptyTagData = {
     body?: never;
     path?: never;