Merge pull request #8 from freestylejs/refactor/add-gen-type-description

[refactor] add gen type description

Author: danpacho

packages/create_freestyle_fetch/src/__tests__/__mocks__/.gen/e_commerse/api.ts

@@ -11,12 +11,32 @@ export const createClient = (config: { baseUrl?: string, auth?: AuthConfig } = {
         baseUrl: config.baseUrl || 'https://{environment}.example.com/v{version}',
         middleware
     }, {
+/**
+ * Product catalog operations
+ *
+ * Endpoints for managing products in the store.
+ */
 'products': {
+/**
+ * List products
+ *
+ * Retrieve a paginated list of products with filtering options.
+ */
 'GET': f.builder().def_json().def_searchparams(z.object({ category: z.enum(['electronics', 'clothing', 'books']).optional(), priceRange: z.array(z.number()).optional(), page: z.number().int().min(1).optional(), limit: z.number().int().min(1).max(100).optional(), sort: z.record(z.string(), z.enum(['asc', 'desc'])).optional() }).parse).def_response(async ({ json }) => z.array(Model.Product).parse(await json())),
+/**
+ * Create a new product
+ *
+ * Add a new product to the catalog. Supports different product types via polymorphism.
+ */
 'POST': f.builder().def_json().def_body(Model.Product.parse).def_response(async ({ json }) => Model.Product.parse(await json()))
 },
 'orders': {
 '$orderId': {
+/**
+ * Get order details
+ *
+ * Retrieve details of a specific order.
+ */
 'GET': f.builder().def_json().def_response(async ({ json }) => Model.Order.parse(await json()))
 }
 }

packages/create_freestyle_fetch/src/__tests__/__mocks__/.gen/e_commerse_2/api.ts

@@ -11,16 +11,35 @@ export const createClient = (config: { baseUrl?: string, auth?: AuthConfig } = {
         baseUrl: config.baseUrl || 'https://{environment}.example-commerce.com/api/v2',
         middleware
     }, {
+/**
+ * Product Collection
+ *
+ * Endpoint for searching and creating products.
+ */
 'products': {
+/**
+ * Search and filter products
+ */
 'GET': f.builder().def_json().def_searchparams(z.object({ searchQuery: z.string().optional(), tags: z.array(z.string()).optional(), page: z.number().int().min(1).optional() }).parse).def_response(async ({ json }) => Model.PaginatedProductResponse.parse(await json())),
+/**
+ * Add a new product with an image
+ */
 'POST': f.builder().def_json().def_body(z.instanceof(FormData).parse).def_response(async ({ json }) => Model.Product.parse(await json())),
 '$productId': {
+/**
+ * Get a single product by its ID
+ */
 'GET': f.builder().def_json().def_response(async ({ json }) => Model.Product.parse(await json()))
 }
 },
 'orders': {
 '$orderId': {
 'process': {
+/**
+ * Process an order asynchronously
+ *
+ * Begins processing an order. A callback URL is invoked upon completion.
+ */
 'POST': f.builder().def_json()
 }
 }

packages/create_freestyle_fetch/src/__tests__/__mocks__/.gen/simple/api.ts

@@ -12,9 +12,18 @@ export const createClient = (config: { baseUrl?: string, auth?: AuthConfig } = {
         middleware
     }, {
 'books': {
+/**
+ * Get a list of books
+ */
 'GET': f.builder().def_json().def_response(async ({ json }) => z.array(Model.Book).parse(await json())),
+/**
+ * Create a new book
+ */
 'POST': f.builder().def_json().def_body(Model.BookRequest.parse).def_response(async ({ json }) => Model.Book.parse(await json())),
 '$id': {
+/**
+ * Get a book by ID
+ */
 'GET': f.builder().def_json().def_response(async ({ json }) => Model.Book.parse(await json()))
 }
 }