@kubb/plugin-ts 3.1.0 → 3.3.0

package/src/generators/__snapshots__/showPetById.ts

@@ -1,31 +1,30 @@
+export type ShowPetByIdPathParams = {
+  /**
+   * @description The id of the pet to retrieve
+   * @type string
+   */
+  petId: string
+  /**
+   * @description The id of the pet to retrieve
+   * @type string
+   */
+  testId: string
+}
 
- export type ShowPetByIdPathParams = {
-    /**
-     * @description The id of the pet to retrieve
-     * @type string
-    */
-    petId: string;
-    /**
-     * @description The id of the pet to retrieve
-     * @type string
-    */
-    testId: string;
-};
-
- /**
+/**
  * @description Expected response to a valid request
-*/
-export type ShowPetById200 = pet;
+ */
+export type ShowPetById200 = pet
 
- /**
+/**
  * @description unexpected error
-*/
-export type ShowPetByIdError = error;
+ */
+export type ShowPetByIdError = error
 
- export type ShowPetByIdQueryResponse = showPetById200;
+export type ShowPetByIdQueryResponse = showPetById200
 
- export type showPetByIdQuery = {
-    Response: showPetById200;
-    PathParams: showPetByIdPathParams;
-    Errors: any;
-};
+export type showPetByIdQuery = {
+  Response: showPetById200
+  PathParams: showPetByIdPathParams
+  Errors: any
+}

package/src/generators/__snapshots__/stringValueConst.ts

@@ -1,9 +1,9 @@
 /**
  * @description its value is equal to the value of the keyword
-*/
+ */
 export type stringValueConst = {
-    /**
-     * @type string | undefined
-    */
-    foobar?: "foobar";
-};
+  /**
+   * @type string | undefined
+   */
+  foobar?: 'foobar'
+}

package/src/generators/typeGenerator.tsx

@@ -104,7 +104,7 @@ function printCombinedSchema({ name, schemas, pluginManager }: { name: string; s
 export const typeGenerator = createReactGenerator<PluginTs>({
   name: 'typescript',
   Operation({ operation, options }) {
-    const { mapper, enumType, optionalType } = options
+    const { mapper, enumType, syntaxType, optionalType } = options
 
     const { plugin, pluginManager, mode } = useApp<PluginTs>()
     const oas = useOas()
@@ -150,6 +150,7 @@ export const typeGenerator = createReactGenerator<PluginTs>({
             enumType={enumType}
             optionalType={optionalType}
             keysToOmit={keysToOmit}
+            syntaxType={syntaxType}
           />
         </Oas.Schema>
       )
@@ -166,7 +167,7 @@ export const typeGenerator = createReactGenerator<PluginTs>({
     )
   },
   Schema({ schema, options }) {
-    const { mapper, enumType, optionalType } = options
+    const { mapper, enumType, syntaxType, optionalType } = options
     const {
       mode,
       plugin: {
@@ -198,6 +199,7 @@ export const typeGenerator = createReactGenerator<PluginTs>({
           mapper={mapper}
           enumType={enumType}
           optionalType={optionalType}
+          syntaxType={syntaxType}
         />
       </File>
     )

package/src/parser/index.ts

@@ -121,7 +121,7 @@ export const typeKeywordMapper = {
 
 type ParserOptions = {
   name: string
-  typeName?: string
+  typedName?: string
   description?: string
   /**
    * @default `'questionToken'`
@@ -132,6 +132,7 @@ type ParserOptions = {
    * asPascalConst is deprecated
    */
   enumType: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal'
+  syntaxType: 'type' | 'interface'
   keysToOmit?: string[]
   mapper?: Record<string, ts.PropertySignature>
 }

package/src/plugin.ts

@@ -23,6 +23,7 @@ export const pluginTs = createPlugin<PluginTs>((options) => {
     dateType = 'string',
     unknownType = 'any',
     optionalType = 'questionToken',
+    syntaxType = 'type',
     transformers = {},
     oasType = false,
     mapper = {},
@@ -42,6 +43,7 @@ export const pluginTs = createPlugin<PluginTs>((options) => {
       // keep the used enumnames between SchemaGenerator and OperationGenerator per plugin(pluginKey)
       usedEnumNames: {},
       unknownType,
+      syntaxType,
       group,
       override,
       mapper,

package/src/types.ts

@@ -30,6 +30,11 @@ export type Options = {
    * asPascalConst is deprecated
    */
   enumType?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal'
+  /**
+   * Switch between type or interface for creating TypeScript types
+   * @default 'type'
+   */
+  syntaxType?: 'type' | 'interface'
   /**
    * Set a suffix for the generated enums.
    * @default 'enum'
@@ -91,6 +96,7 @@ type ResolvedOptions = {
   optionalType: NonNullable<Options['optionalType']>
   transformers: NonNullable<Options['transformers']>
   oasType: NonNullable<Options['oasType']>
+  syntaxType: NonNullable<Options['syntaxType']>
   usedEnumNames: Record<string, number>
   mapper: Record<string, any>
 }