Correct import when refs are using . syntax(creating subfolders) (#796)

* fix: remove use of ts namespace

* chore: update examples

* fix: A schema name with `pet.Pets` will be moved inside of the folder `src/gen/pet/pets/ts` instead of `src/gen/petPets.ts`

* chore: update examples

* chore: fix examples

* chore: fix plugin zod

.changeset/perfect-trees-juggle.md

@@ -0,0 +1,6 @@
+---
+"@kubb/swagger-ts": patch
+"@kubb/core": patch
+---
+
+A schema name with `pet.Pets` will be moved inside of the folder `src/gen/pet/pets/ts` instead of `src/gen/petPets.ts`

examples/advanced/petStore.yaml

@@ -810,7 +810,7 @@ components:
           example: 1
       xml:
         name: user
-    Tag:
+    tag.Tag:
       type: object
       properties:
         id:
@@ -851,7 +851,7 @@ components:
           xml:
             wrapped: true
           items:
-            $ref: "#/components/schemas/Tag"
+            $ref: "#/components/schemas/tag.Tag"
         status:
           type: string
           description: pet status in the store
@@ -889,7 +889,7 @@ components:
           xml:
             wrapped: true
           items:
-            $ref: "#/components/schemas/Tag"
+            $ref: "#/components/schemas/tag.Tag"
         status:
           type: string
           description: pet status in the store

examples/advanced/src/gen/mocks/createAddPetRequest.ts

@@ -1,5 +1,5 @@
 import { createCategory } from './createCategory'
-import { createTag } from './createTag'
+import { createTagTag } from './tag/createTag'
 import { faker } from '@faker-js/faker'
 import type { AddPetRequest } from '../models/ts/AddPetRequest'
 
@@ -9,7 +9,7 @@ export function createAddPetRequest(): NonNullable<AddPetRequest> {
     'name': faker.string.alpha(),
     'category': createCategory(),
     'photoUrls': faker.helpers.arrayElements([faker.string.alpha()]) as any,
-    'tags': faker.helpers.arrayElements([createTag()]) as any,
+    'tags': faker.helpers.arrayElements([createTagTag()]) as any,
     'status': faker.helpers.arrayElement<any>([`available`, `pending`, `sold`]),
   }
 }

examples/advanced/src/gen/mocks/createPet.ts

@@ -1,5 +1,5 @@
 import { createCategory } from './createCategory'
-import { createTag } from './createTag'
+import { createTagTag } from './tag/createTag'
 import { faker } from '@faker-js/faker'
 import type { Pet } from '../models/ts/Pet'
 
@@ -9,7 +9,7 @@ export function createPet(): NonNullable<Pet> {
     'name': faker.string.alpha(),
     'category': createCategory(),
     'photoUrls': faker.helpers.arrayElements([faker.string.alpha()]) as any,
-    'tags': faker.helpers.arrayElements([createTag()]) as any,
+    'tags': faker.helpers.arrayElements([createTagTag()]) as any,
     'status': faker.helpers.arrayElement<any>([`available`, `pending`, `sold`]),
   }
 }

examples/advanced/src/gen/mocks/index.ts

@@ -6,9 +6,9 @@ export * from './createCustomer'
 export * from './createOrder'
 export * from './createPet'
 export * from './createPetNotFound'
-export * from './createTag'
 export * from './createUser'
 export * from './createUserArray'
+export * from './tag/index'
 export * as petsMocks from './petsController/index'
 export * as petMocks from './petController/index'
 export * as userMocks from './userController/index'

examples/advanced/src/gen/mocks/createTag.ts → examples/advanced/src/gen/mocks/tag/createTag.ts

@@ -1,6 +1,6 @@
 import { faker } from '@faker-js/faker'
-import type { Tag } from '../models/ts/Tag'
+import type { TagTag } from '../../models/ts/tag/Tag'
 
-export function createTag(): NonNullable<Tag> {
+export function createTagTag(): NonNullable<TagTag> {
   return { 'id': faker.number.float({}), 'name': faker.string.alpha() }
 }

examples/advanced/src/gen/mocks/tag/index.ts

@@ -0,0 +1 @@
+export * from './createTag'

examples/advanced/src/gen/models/ts/AddPetRequest.ts

@@ -1,5 +1,5 @@
 import type { Category } from './Category'
-import type { Tag } from './Tag'
+import type { TagTag } from './tag/Tag'
 
 export const AddPetRequestStatus = {
   'available': 'available',
@@ -26,7 +26,7 @@ export type AddPetRequest = {
   /**
    * @type array | undefined
    */
-  tags?: Tag[]
+  tags?: TagTag[]
   /**
    * @description pet status in the store
    * @type string | undefined

examples/advanced/src/gen/models/ts/Pet.ts

@@ -1,5 +1,5 @@
 import type { Category } from './Category'
-import type { Tag } from './Tag'
+import type { TagTag } from './tag/Tag'
 
 export const PetStatus = {
   'available': 'available',
@@ -26,7 +26,7 @@ export type Pet = {
   /**
    * @type array | undefined
    */
-  tags?: Tag[]
+  tags?: TagTag[]
   /**
    * @description pet status in the store
    * @type string | undefined

examples/advanced/src/gen/models/ts/index.ts

@@ -9,7 +9,7 @@ export * from './petController/index.js'
 export * from './PetNotFound.js'
 export * from './petsController/index.js'
 export * from './storeController/index.js'
-export * from './Tag.js'
+export * from './tag/index.js'
 export * from './User.js'
 export * from './UserArray.js'
 export * from './userController/index.js'

examples/advanced/src/gen/models/ts/Tag.ts → examples/advanced/src/gen/models/ts/tag/Tag.ts

@@ -1,4 +1,4 @@
-export type Tag = {
+export type TagTag = {
   /**
    * @type integer | undefined int64
    */

examples/advanced/src/gen/models/ts/tag/index.ts

@@ -0,0 +1 @@
+export * from './Tag.js'

examples/advanced/src/gen/schemas/AddPetRequest.json

@@ -18,7 +18,7 @@
         "type": "object",
         "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
         "xml": { "name": "tag" },
-        "x-readme-ref-name": "Tag"
+        "x-readme-ref-name": "tag.Tag"
       }
     },
     "status": { "type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"] }

examples/advanced/src/gen/schemas/Pet.json

@@ -18,7 +18,7 @@
         "type": "object",
         "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
         "xml": { "name": "tag" },
-        "x-readme-ref-name": "Tag"
+        "x-readme-ref-name": "tag.Tag"
       }
     },
     "status": { "type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"] }

examples/advanced/src/gen/schemas/Tag.json → examples/advanced/src/gen/schemas/tag.Tag.json

@@ -2,5 +2,5 @@
   "type": "object",
   "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
   "xml": { "name": "tag" },
-  "x-readme-ref-name": "Tag"
+  "x-readme-ref-name": "tag.Tag"
 }

examples/advanced/src/gen/schemas2/AddPetRequest.json

@@ -18,7 +18,7 @@
         "type": "object",
         "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
         "xml": { "name": "tag" },
-        "x-readme-ref-name": "Tag"
+        "x-readme-ref-name": "tag.Tag"
       }
     },
     "status": { "type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"] }

examples/advanced/src/gen/schemas2/Pet.json

@@ -18,7 +18,7 @@
         "type": "object",
         "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
         "xml": { "name": "tag" },
-        "x-readme-ref-name": "Tag"
+        "x-readme-ref-name": "tag.Tag"
       }
     },
     "status": { "type": "string", "description": "pet status in the store", "enum": ["available", "pending", "sold"] }

examples/advanced/src/gen/schemas2/Tag.json → examples/advanced/src/gen/schemas2/tag.Tag.json

@@ -2,5 +2,5 @@
   "type": "object",
   "properties": { "id": { "type": "integer", "format": "int64" }, "name": { "type": "string" } },
   "xml": { "name": "tag" },
-  "x-readme-ref-name": "Tag"
+  "x-readme-ref-name": "tag.Tag"
 }

examples/advanced/src/gen/zod/addPetRequestSchema.ts

@@ -1,5 +1,5 @@
 import { categorySchema } from './categorySchema'
-import { tagSchema } from './tagSchema'
+import { tagTagSchema } from './tag/tagSchema'
 import { z } from 'zod'
 import type { AddPetRequest } from '../models/ts/AddPetRequest'
 
@@ -8,6 +8,6 @@ export const addPetRequestSchema: z.ZodType<AddPetRequest> = z.object({
   'name': z.string(),
   'category': z.lazy(() => categorySchema).optional(),
   'photoUrls': z.array(z.string()),
-  'tags': z.array(z.lazy(() => tagSchema)).optional(),
+  'tags': z.array(z.lazy(() => tagTagSchema)).optional(),
   'status': z.enum([`available`, `pending`, `sold`]).describe(`pet status in the store`).optional(),
 })

examples/advanced/src/gen/zod/index.ts

@@ -8,7 +8,7 @@ export * as petSchemas from './petController/index'
 export * from './petNotFoundSchema'
 export * from './petSchema'
 export * as petsSchemas from './petsController/index'
-export * from './tagSchema'
+export * from './tag/index'
 export * from './userArraySchema'
 export * as userSchemas from './userController/index'
 export * from './userSchema'

examples/advanced/src/gen/zod/petSchema.ts

@@ -1,5 +1,5 @@
 import { categorySchema } from './categorySchema'
-import { tagSchema } from './tagSchema'
+import { tagTagSchema } from './tag/tagSchema'
 import { z } from 'zod'
 import type { Pet } from '../models/ts/Pet'
 
@@ -8,6 +8,6 @@ export const petSchema: z.ZodType<Pet> = z.object({
   'name': z.string(),
   'category': z.lazy(() => categorySchema).optional(),
   'photoUrls': z.array(z.string()),
-  'tags': z.array(z.lazy(() => tagSchema)).optional(),
+  'tags': z.array(z.lazy(() => tagTagSchema)).optional(),
   'status': z.enum([`available`, `pending`, `sold`]).describe(`pet status in the store`).optional(),
 })

examples/advanced/src/gen/zod/tag/index.ts

@@ -0,0 +1 @@
+export * from './tagSchema'

examples/advanced/src/gen/zod/tag/tagSchema.ts

@@ -0,0 +1,4 @@
+import { z } from 'zod'
+import type { TagTag } from '../../models/ts/tag/Tag'
+
+export const tagTagSchema: z.ZodType<TagTag> = z.object({ 'id': z.number().optional(), 'name': z.string().optional() })

packages/core/src/transformers/casing.test.ts

@@ -0,0 +1,26 @@
+import { camelCase, pascalCase, pathCase } from './casing.ts'
+
+describe('casing', () => {
+  test('camelCase', () => {
+    expect(camelCase('pet pet')).toBe('petPet')
+    expect(camelCase('pet.Pet', { isFile: true })).toBe('pet/pet')
+    expect(camelCase('create tag.tag', { isFile: true })).toBe('createTag/tag')
+    expect(camelCase('tag.tag', { isFile: true, prefix: 'create' })).toBe('tag/createTag')
+    expect(camelCase('tag.tag', { isFile: true, suffix: 'schema' })).toBe('tag/tagSchema')
+  })
+  test('pascalCase', () => {
+    expect(pascalCase('pet pet')).toBe('PetPet')
+    expect(pascalCase('pet.Pet', { isFile: true })).toBe('pet/Pet')
+    expect(pascalCase('create tag.tag', { isFile: true })).toBe('createTag/Tag')
+    expect(pascalCase('tag.tag', { isFile: true, prefix: 'create' })).toBe('tag/CreateTag')
+    expect(pascalCase('tag.tag', { isFile: true, suffix: 'schema' })).toBe('tag/TagSchema')
+  })
+
+  test('pathCase', () => {
+    expect(pathCase('pet pet')).toBe('petpet')
+    expect(pathCase('pet.Pet', { isFile: true })).toBe('pet/pet')
+    expect(pathCase('create tag.tag', { isFile: true })).toBe('createTag/tag')
+    expect(pathCase('tag.tag', { isFile: true, prefix: 'create' })).toBe('tag/createtag')
+    expect(pathCase('tag.tag', { isFile: true, suffix: 'schema' })).toBe('tag/tagschema')
+  })
+})

packages/core/src/transformers/casing.ts

@@ -1,9 +1,37 @@
-import { camelCase as changeCaseCamel, pascalCase as changePascalCase } from 'change-case'
+import { camelCase as changeCamelCase, pascalCase as changePascalCase, pathCase as changePathCase } from 'change-case'
 
-export function camelCase(text: string): string {
-  return changeCaseCamel(text, { delimiter: '', mergeAmbiguousCharacters: true })
+type Options = {
+  /**
+   * When set it will replace all `.` with `/`.
+   */
+  isFile?: boolean
+  prefix?: string
+  suffix?: string
 }
 
-export function pascalCase(text: string): string {
-  return changePascalCase(text, { delimiter: '', mergeAmbiguousCharacters: true })
+export function camelCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {
+  if (isFile) {
+    const splitArray = text.split('.')
+    return splitArray.map((item, i) => i === splitArray.length - 1 ? camelCase(item, { prefix, suffix }) : camelCase(item)).join('/')
+  }
+
+  return changeCamelCase(`${prefix} ${text} ${suffix}`, { delimiter: '', mergeAmbiguousCharacters: true })
+}
+
+export function pascalCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {
+  if (isFile) {
+    const splitArray = text.split('.')
+    return splitArray.map((item, i) => i === splitArray.length - 1 ? pascalCase(item, { prefix, suffix }) : camelCase(item)).join('/')
+  }
+
+  return changePascalCase(`${prefix} ${text} ${suffix}`, { delimiter: '', mergeAmbiguousCharacters: true })
+}
+
+export function pathCase(text: string, { isFile, prefix = '', suffix = '' }: Options = {}): string {
+  if (isFile) {
+    const splitArray = text.split('.')
+    return splitArray.map((item, i) => i === splitArray.length - 1 ? pathCase(item, { prefix, suffix }) : camelCase(item)).join('/')
+  }
+
+  return changePathCase(`${prefix} ${text} ${suffix}`, { delimiter: '' })
 }

packages/core/src/transformers/index.ts

@@ -1,4 +1,4 @@
-import { camelCase, pascalCase } from './casing.ts'
+import { camelCase, pascalCase, pathCase } from './casing.ts'
 import { combineCodes } from './combineCodes.ts'
 import { createJSDocBlockText } from './createJSDocBlockText.ts'
 import { escape, jsStringEscape } from './escape.ts'
@@ -8,7 +8,7 @@ import { searchAndReplace } from './searchAndReplace.ts'
 import { transformReservedWord } from './transformReservedWord.ts'
 import { trim, trimExtName } from './trim.ts'
 
-export { camelCase, pascalCase } from './casing.ts'
+export { camelCase, pascalCase, pathCase } from './casing.ts'
 export { combineCodes } from './combineCodes.ts'
 export { createJSDocBlockText } from './createJSDocBlockText.ts'
 export { escape, jsStringEscape } from './escape.ts'
@@ -33,4 +33,5 @@ export default {
   },
   camelCase,
   pascalCase,
+  pathCase,
 } as const

packages/swagger-client/src/plugin.ts

@@ -68,7 +68,7 @@ export const definePlugin = createPlugin<PluginOptions>((options) => {
       return path.resolve(root, output.path, baseName)
     },
     resolveName(name, type) {
-      const resolvedName = camelCase(name)
+      const resolvedName = camelCase(name, { isFile: type === 'file' })
 
       if (type) {
         return transformers?.name?.(resolvedName, type) || resolvedName

packages/swagger-faker/src/FakerGenerator.ts

@@ -62,21 +62,25 @@ export class FakerGenerator extends Generator<PluginOptions['resolvedOptions'],
     })
     // hack to add typescript imports
     if (typeName) {
-      const ref = {
-        propertyName: typeName,
-        originalName: baseName,
-      }
-      const path = this.context.pluginManager.resolvePath({
-        baseName: operationName || typeName,
+      const typeFileName = this.context.pluginManager.resolveName({ name: baseName, pluginKey: swaggerTypeScriptPluginKey, type: 'file' })
+
+      const typePath = this.context.pluginManager.resolvePath({
+        baseName: operationName || typeFileName,
         pluginKey: swaggerTypeScriptPluginKey,
         options: { tag: operation?.getTags()[0]?.name },
       })
 
-      this.imports.push({
-        ref,
-        path: path || '',
-        isTypeOnly: true,
-      })
+      if (typePath) {
+        this.imports.push({
+          ref: {
+            propertyName: typeName,
+            originalName: baseName,
+            pluginKey: swaggerTypeScriptPluginKey,
+          },
+          path: typePath,
+          isTypeOnly: true,
+        })
+      }
     }
 
     texts.push(fakerOutput)
@@ -141,13 +145,14 @@ export class FakerGenerator extends Generator<PluginOptions['resolvedOptions'],
     const originalName = getUniqueName($ref.replace(/.+\//, ''), this.#usedAliasNames)
     const propertyName = this.context.pluginManager.resolveName({ name: originalName, pluginKey, type: 'function' })
 
+    const fileName = this.context.pluginManager.resolveName({ name: originalName, pluginKey, type: 'file' })
+    const path = this.context.pluginManager.resolvePath({ baseName: fileName, pluginKey })
+
     ref = this.refs[$ref] = {
       propertyName,
       originalName,
     }
 
-    const path = this.context.pluginManager.resolvePath({ baseName: propertyName, pluginKey })
-
     this.imports.push({
       ref,
       path: path || '',