openapi-sync 5.0.3 → 5.0.5

package/README.md

@@ -10,6 +10,12 @@
 
 ## Features
 
+### 🎉 v5.0.5 - Python Support, Auto-Sync & Infinite Queries
+
+- 🐍 **Python Type Generation** - Generate Python `dataclass` definitions alongside TypeScript types.
+- 🔄 **Auto-Sync Capability** - Enhanced OpenAPI sync functionality with real-time auto-sync capability.
+- ⚡ **Infinite Queries & Headers** - Added support for headers configuration and infinite query hooks in API clients.
+
 ### 🎉 v5.0.0 - Enhanced Client Generation & Developer Experience
 
 - 🚀 **Fully-Typed API Client Generation** - Generate type-safe clients for Fetch, Axios, React Query, SWR, and RTK Query with comprehensive inline documentation
@@ -72,11 +78,11 @@ The wizard will guide you through:
 
 ```json
 {
-  "refetchInterval": 5000,
-  "folder": "./src/api",
-  "api": {
-    "petstore": "https://petstore3.swagger.io/api/v3/openapi.json"
-  }
+	"refetchInterval": 5000,
+	"folder": "./src/api",
+	"api": {
+		"petstore": "https://petstore3.swagger.io/api/v3/openapi.json"
+	}
 }
 ```
 
@@ -240,11 +246,11 @@ Supports multiple configuration formats: `openapi.sync.json`, `openapi.sync.ts`,
 
 ```json
 {
-  "refetchInterval": 5000,
-  "folder": "./src/api",
-  "api": {
-    "petstore": "https://petstore3.swagger.io/api/v3/openapi.json"
-  }
+	"refetchInterval": 5000,
+	"folder": "./src/api",
+	"api": {
+		"petstore": "https://petstore3.swagger.io/api/v3/openapi.json"
+	}
 }
 ```
 
@@ -254,18 +260,18 @@ Supports multiple configuration formats: `openapi.sync.json`, `openapi.sync.ts`,
 import { IConfig } from "openapi-sync/types";
 
 const config: IConfig = {
-  refetchInterval: 10000,
-  folder: "./src/api",
-  api: {
-    "main-api": "https://api.example.com/openapi.json",
-  },
-  folderSplit: { byTags: true },
-  types: { name: { prefix: "I", useOperationId: true } },
-  endpoints: {
-    exclude: { tags: ["deprecated"] },
-    doc: { showCurl: true },
-  },
-  validations: { library: "zod" },
+	refetchInterval: 10000,
+	folder: "./src/api",
+	api: {
+		"main-api": "https://api.example.com/openapi.json",
+	},
+	folderSplit: { byTags: true },
+	types: { name: { prefix: "I", useOperationId: true } },
+	endpoints: {
+		exclude: { tags: ["deprecated"] },
+		doc: { showCurl: true },
+	},
+	validations: { library: "zod" },
 };
 
 export default config;
@@ -361,9 +367,9 @@ Alternatively, add an override to your `package.json`:
 
 ```json
 {
-  "overrides": {
-    "esbuild": "0.17.19"
-  }
+	"overrides": {
+		"esbuild": "0.17.19"
+	}
 }
 ```
 
@@ -379,6 +385,17 @@ ISC License - see [LICENSE](LICENSE) file for details.
 
 Contributions welcome! Submit pull requests to our [GitHub repository](https://github.com/akintomiwa-fisayo/openapi-sync).
 
+### Contributors
+
+A special thanks to the following contributors for their valuable work on this project:
+
+<a href="https://github.com/akintomiwa-fisayo">
+  <img src="https://github.com/akintomiwa-fisayo.png" width="50" height="50" alt="Fisayo Akintomiwa" style="border-radius: 50%;" />
+</a>
+<a href="https://github.com/akintomiwaopemipo">
+  <img src="https://github.com/akintomiwaopemipo.png" width="50" height="50" alt="Opemipo Akintomiwa" style="border-radius: 50%;" />
+</a>
+
 ---
 
 ## Support / Donate

package/dist/index.d.mts

@@ -338,6 +338,7 @@ type IConfigClientGeneration = {
  * @public
  */
 type IConfig = {
+    language?: "typescript" | "python";
     refetchInterval?: number;
     folder?: string;
     api: Record<string, string>;
@@ -496,6 +497,7 @@ declare const JSONStringify: (obj: Record<string, any>, indent?: number) => stri
  * Render TypeScript type reference as markdown code block
  *
  * Formats a TypeScript type definition for inclusion in markdown documentation.
+ * Converts multiline/JSDoc comments to single-line comments to prevent breaking outer JSDoc.
  *
  * @param {string} typeRef - TypeScript type definition
  * @param {number} [indent=1] - Indentation level
@@ -553,7 +555,7 @@ declare const extractCustomCode: (fileContent: string, markerText?: string) => E
  *
  * @public
  */
-declare const createCustomCodeMarker: (position: "top" | "bottom", markerText?: string, includeInstructions?: boolean) => string;
+declare const createCustomCodeMarker: (position: "top" | "bottom", markerText?: string, includeInstructions?: boolean, commentPrefix?: "//" | "#") => string;
 /**
  * Merge generated content with preserved custom code
  *
@@ -575,6 +577,7 @@ declare const mergeCustomCode: (generatedContent: string, existingFileContent: s
     position?: "top" | "bottom" | "both";
     markerText?: string;
     includeInstructions?: boolean;
+    commentPrefix?: "//" | "#";
 }) => string;
 
 declare const variableName: RegExp;

package/dist/index.d.ts

@@ -338,6 +338,7 @@ type IConfigClientGeneration = {
  * @public
  */
 type IConfig = {
+    language?: "typescript" | "python";
     refetchInterval?: number;
     folder?: string;
     api: Record<string, string>;
@@ -496,6 +497,7 @@ declare const JSONStringify: (obj: Record<string, any>, indent?: number) => stri
  * Render TypeScript type reference as markdown code block
  *
  * Formats a TypeScript type definition for inclusion in markdown documentation.
+ * Converts multiline/JSDoc comments to single-line comments to prevent breaking outer JSDoc.
  *
  * @param {string} typeRef - TypeScript type definition
  * @param {number} [indent=1] - Indentation level
@@ -553,7 +555,7 @@ declare const extractCustomCode: (fileContent: string, markerText?: string) => E
  *
  * @public
  */
-declare const createCustomCodeMarker: (position: "top" | "bottom", markerText?: string, includeInstructions?: boolean) => string;
+declare const createCustomCodeMarker: (position: "top" | "bottom", markerText?: string, includeInstructions?: boolean, commentPrefix?: "//" | "#") => string;
 /**
  * Merge generated content with preserved custom code
  *
@@ -575,6 +577,7 @@ declare const mergeCustomCode: (generatedContent: string, existingFileContent: s
     position?: "top" | "bottom" | "both";
     markerText?: string;
     includeInstructions?: boolean;
+    commentPrefix?: "//" | "#";
 }) => string;
 
 declare const variableName: RegExp;