Merge pull request #1896 from hey-api/feat/typescript-read-write-only

feat: support read-only and write-only properties

Author: mrlubos

.changeset/lemon-spies-hammer.md

@@ -0,0 +1,23 @@
+---
+'@hey-api/openapi-ts': minor
+---
+
+feat: support read-only and write-only properties
+
+### Read-only and write-only fields
+
+Starting with v0.66.0, `@hey-api/typescript` will generate separate types for payloads and responses if it detects any read-only or write-only fields. To preserve the previous behavior and generate a single type regardless, set `readOnlyWriteOnlyBehavior` to `off`.
+
+```js
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      name: '@hey-api/typescript',
+      readOnlyWriteOnlyBehavior: 'off', // [!code ++]
+    },
+  ],
+};
+```

docs/openapi-ts/migrating.md

@@ -27,6 +27,26 @@ This config option is deprecated and will be removed in favor of [clients](./cli
 
 This config option is deprecated and will be removed.
 
+## v0.66.0
+
+### Read-only and write-only fields
+
+Starting with v0.66.0, `@hey-api/typescript` will generate separate types for payloads and responses if it detects any read-only or write-only fields. To preserve the previous behavior and generate a single type regardless, set `readOnlyWriteOnlyBehavior` to `off`.
+
+```js
+export default {
+  input: 'https://get.heyapi.dev/hey-api/backend',
+  output: 'src/client',
+  plugins: [
+    // ...other plugins
+    {
+      name: '@hey-api/typescript',
+      readOnlyWriteOnlyBehavior: 'off', // [!code ++]
+    },
+  ],
+};
+```
+
 ## v0.64.0
 
 ### Added `ClientOptions` interface

packages/openapi-ts-tests/test/2.0.x.test.ts

@@ -211,6 +211,14 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles form data',
     },
+    {
+      config: createConfig({
+        input: 'read-write-only.yaml',
+        output: 'read-write-only',
+        plugins: ['@hey-api/client-fetch', '@hey-api/typescript'],
+      }),
+      description: 'handles read-only and write-only types',
+    },
     {
       config: createConfig({
         input: 'schema-unknown.yaml',

packages/openapi-ts-tests/test/3.0.x.test.ts

@@ -420,6 +420,14 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles non-exploded array query parameters (Axios)',
     },
+    {
+      config: createConfig({
+        input: 'read-write-only.yaml',
+        output: 'read-write-only',
+        plugins: ['@hey-api/client-fetch', '@hey-api/typescript'],
+      }),
+      description: 'handles read-only and write-only types',
+    },
     {
       config: createConfig({
         input: 'security-api-key.json',

packages/openapi-ts-tests/test/3.1.x.test.ts

@@ -466,6 +466,14 @@ describe(`OpenAPI ${version}`, () => {
       }),
       description: 'handles non-exploded array query parameters (Axios)',
     },
+    {
+      config: createConfig({
+        input: 'read-write-only.yaml',
+        output: 'read-write-only',
+        plugins: ['@hey-api/client-fetch', '@hey-api/typescript'],
+      }),
+      description: 'handles read-only and write-only types',
+    },
     {
       config: createConfig({
         input: 'required-all-of-ref.json',

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

@@ -267,8 +267,15 @@ export type ModelWithNestedEnums = {
 /**
  * This is a model with one property containing a reference
  */
-export type ModelWithReference = {
-    prop?: ModelWithProperties;
+export type ModelWithReferenceReadable = {
+    prop?: ModelWithPropertiesReadable;
+};
+
+/**
+ * This is a model with one property containing a reference
+ */
+export type ModelWithReferenceWritable = {
+    prop?: ModelWithPropertiesWritable;
 };
 
 /**
@@ -299,7 +306,7 @@ export type ModelWithCircularReference = {
 /**
  * This is a model with one nested property
  */
-export type ModelWithProperties = {
+export type ModelWithPropertiesReadable = {
     required: string;
     readonly requiredAndReadOnly: string;
     string?: string;
@@ -316,7 +323,21 @@ export type ModelWithProperties = {
 /**
  * This is a model with one nested property
  */
-export type ModelWithNestedProperties = {
+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 with one nested property
+ */
+export type ModelWithNestedPropertiesReadable = {
     readonly first: {
         readonly second: {
             readonly third: string;
@@ -372,7 +393,7 @@ export type Default = {
 /**
  * This is a model that contains a some patterns
  */
-export type ModelWithPattern = {
+export type ModelWithPatternReadable = {
     key: string;
     name: string;
     readonly enabled?: boolean;
@@ -384,6 +405,19 @@ export type ModelWithPattern = {
     patternWithBacktick?: 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 ParameterActivityParams = {
     description?: string;
     graduate_id?: number;

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

@@ -267,8 +267,15 @@ export type ModelWithNestedEnums = {
 /**
  * This is a model with one property containing a reference
  */
-export type ModelWithReference = {
-    prop?: ModelWithProperties;
+export type ModelWithReferenceReadable = {
+    prop?: ModelWithPropertiesReadable;
+};
+
+/**
+ * This is a model with one property containing a reference
+ */
+export type ModelWithReferenceWritable = {
+    prop?: ModelWithPropertiesWritable;
 };
 
 /**
@@ -299,7 +306,7 @@ export type ModelWithCircularReference = {
 /**
  * This is a model with one nested property
  */
-export type ModelWithProperties = {
+export type ModelWithPropertiesReadable = {
     required: string;
     readonly requiredAndReadOnly: string;
     string?: string;
@@ -316,7 +323,21 @@ export type ModelWithProperties = {
 /**
  * This is a model with one nested property
  */
-export type ModelWithNestedProperties = {
+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 with one nested property
+ */
+export type ModelWithNestedPropertiesReadable = {
     readonly first: {
         readonly second: {
             readonly third: string;
@@ -372,7 +393,7 @@ export type Default = {
 /**
  * This is a model that contains a some patterns
  */
-export type ModelWithPattern = {
+export type ModelWithPatternReadable = {
     key: string;
     name: string;
     readonly enabled?: boolean;
@@ -384,6 +405,19 @@ export type ModelWithPattern = {
     patternWithBacktick?: 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 ParameterActivityParams = {
     description?: string;
     graduate_id?: number;

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

@@ -0,0 +1,16 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+import type { ClientOptions } from './types.gen';
+import { type Config, type ClientOptions as DefaultClientOptions, createClient, createConfig } from '@hey-api/client-fetch';
+
+/**
+ * The `createClientConfig()` function will be called on client initialization
+ * and the returned object will become the client's initial configuration.
+ *
+ * You may want to initialize your client this way instead of calling
+ * `setConfig()`. This is useful for example if you're using Next.js
+ * to ensure your client always has the correct values.
+ */
+export type CreateClientConfig<T extends DefaultClientOptions = ClientOptions> = (override?: Config<DefaultClientOptions & T>) => Config<Required<DefaultClientOptions> & T>;
+
+export const client = createClient(createConfig<ClientOptions>());

packages/openapi-ts-tests/test/__snapshots__/2.0.x/plugins/@hey-api/typescript/read-write-only-custom-name/index.ts

@@ -0,0 +1,2 @@
+// This file is auto-generated by @hey-api/openapi-ts
+export * from './types.gen';

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

@@ -0,0 +1,37 @@
+// This file is auto-generated by @hey-api/openapi-ts
+
+export type ReadableFooRead = ReadableBarRead & {
+    readonly foo?: string;
+};
+
+export type WritableFooRead = WritableBarRead;
+
+export type ReadableBarRead = Baz & {
+    readonly bar?: string;
+};
+
+export type WritableBarRead = Baz;
+
+export type Baz = {
+    baz?: string;
+};
+
+export type PostFooReadData = {
+    body: WritableFooRead;
+    path?: never;
+    query?: never;
+    url: '/foo-read';
+};
+
+export type PostFooReadResponses = {
+    /**
+     * OK
+     */
+    200: ReadableFooRead;
+};
+
+export type PostFooReadResponse = PostFooReadResponses[keyof PostFooReadResponses];
+
+export type ClientOptions = {
+    baseUrl: string;
+};