@kubb/plugin-ts 3.0.0-alpha.2 → 3.0.0-alpha.21

package/src/components/Type.tsx

@@ -0,0 +1,133 @@
+import { File } from '@kubb/react'
+
+import transformers from '@kubb/core/transformers'
+import { print } from '@kubb/parser-ts'
+import * as factory from '@kubb/parser-ts/factory'
+import { type Schema, SchemaGenerator, schemaKeywords } from '@kubb/plugin-oas'
+import { Fragment, type ReactNode } from 'react'
+import type ts from 'typescript'
+import { parse, typeKeywordMapper } from '../parser/index.ts'
+import type { PluginTs } from '../types.ts'
+
+type Props = {
+  name: string
+  typedName: string
+  tree: Array<Schema>
+  optionalType: PluginTs['resolvedOptions']['optionalType']
+  enumType: PluginTs['resolvedOptions']['enumType']
+  mapper: PluginTs['resolvedOptions']['mapper']
+  description?: string
+  keysToOmit?: string[]
+}
+
+export function Type({ name, typedName, tree, keysToOmit, optionalType, enumType, mapper, description }: Props): ReactNode {
+  const typeNodes: ts.Node[] = []
+
+  if (!tree.length) {
+    return ''
+  }
+
+  const isNullish = tree.some((item) => item.keyword === schemaKeywords.nullish)
+  const isNullable = tree.some((item) => item.keyword === schemaKeywords.nullable)
+  const isOptional = tree.some((item) => item.keyword === schemaKeywords.optional)
+
+  let type =
+    (tree
+      .map((schema) =>
+        parse(undefined, schema, {
+          name,
+          typeName: typedName,
+          description,
+          keysToOmit,
+          optionalType,
+          enumType,
+          mapper,
+        }),
+      )
+      .filter(Boolean)
+      .at(0) as ts.TypeNode) || typeKeywordMapper.undefined()
+
+  if (isNullable) {
+    type = factory.createUnionDeclaration({
+      nodes: [type, factory.keywordTypeNodes.null],
+    }) as ts.TypeNode
+  }
+
+  if (isNullish && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
+    type = factory.createUnionDeclaration({
+      nodes: [type, factory.keywordTypeNodes.undefined],
+    }) as ts.TypeNode
+  }
+
+  if (isOptional && ['undefined', 'questionTokenAndUndefined'].includes(optionalType as string)) {
+    type = factory.createUnionDeclaration({
+      nodes: [type, factory.keywordTypeNodes.undefined],
+    }) as ts.TypeNode
+  }
+
+  const node = factory.createTypeAliasDeclaration({
+    modifiers: [factory.modifiers.export],
+    name,
+    type: keysToOmit?.length
+      ? factory.createOmitDeclaration({
+          keys: keysToOmit,
+          type,
+          nonNullable: true,
+        })
+      : type,
+  })
+
+  const enumSchemas = SchemaGenerator.deepSearch(tree, schemaKeywords.enum)
+
+  const enums = enumSchemas.map((enumSchema) => {
+    const name = enumType === 'asPascalConst' ? transformers.pascalCase(enumSchema.args.name) : transformers.camelCase(enumSchema.args.name)
+    const typeName = enumSchema.args.typeName
+
+    const [nameNode, typeNode] = factory.createEnumDeclaration({
+      name,
+      typeName,
+      enums: enumSchema.args.items
+        .map((item) => (item.value === undefined ? undefined : [transformers.trimQuotes(item.name?.toString()), item.value]))
+        .filter(Boolean) as unknown as [string, string][],
+      type: enumType,
+    })
+
+    return {
+      nameNode,
+      typeNode,
+      name,
+      typeName,
+    }
+  })
+
+  typeNodes.push(
+    factory.appendJSDocToNode({
+      node,
+      comments: [description ? `@description ${transformers.jsStringEscape(description)}` : undefined].filter(Boolean),
+    }),
+  )
+
+  return (
+    <Fragment>
+      {enums.map(({ name, nameNode, typeName, typeNode }, index) => (
+        <Fragment key={[name, nameNode].join('-')}>
+          {nameNode && (
+            <File.Source name={name} isExportable isIndexable>
+              {print([nameNode])}
+            </File.Source>
+          )}
+          {
+            <File.Source name={typeName} isIndexable isExportable={['enum', 'asConst', 'constEnum', 'literal', undefined].includes(enumType)} isTypeOnly>
+              {print([typeNode])}
+            </File.Source>
+          }
+        </Fragment>
+      ))}
+      {enums.every((item) => item.typeName !== name) && (
+        <File.Source name={typedName} isTypeOnly isExportable isIndexable>
+          {print(typeNodes)}
+        </File.Source>
+      )}
+    </Fragment>
+  )
+}

package/src/components/index.ts

@@ -1,3 +1,2 @@
 export { OasType } from './OasType.tsx'
-export { OperationSchema } from './OperationSchema.tsx'
-export { Schema } from './Schema.tsx'
+export { Type } from './Type.tsx'

package/src/generators/__snapshots__/bodyUploadFileApiAssetsPost.ts

@@ -0,0 +1,6 @@
+export type bodyUploadFileApiAssetsPost = {
+    /**
+     * @type string, binary
+    */
+    file: Blob;
+};

package/src/generators/__snapshots__/catTypeAsConst.ts

@@ -0,0 +1,11 @@
+export type cat = {
+    /**
+     * @type string, uuid
+    */
+    id: string;
+    type: "Cat";
+    /**
+     * @type boolean | undefined
+    */
+    meow?: boolean;
+};

package/src/generators/__snapshots__/createPet.ts

@@ -0,0 +1,34 @@
+/**
+ * @description Null response
+*/
+export type CreatePets201 = (error & {
+    name?: errorCode;
+});
+
+ /**
+ * @description unexpected error
+*/
+export type CreatePetsError = error;
+
+ export type CreatePetsMutationRequest = {
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string
+    */
+    tag: string;
+};
+
+ /**
+ * @description Null response
+*/
+export type CreatePetsMutationResponse = (error & {
+    name?: errorCode;
+});
+
+ export type createPetsMutation = {
+    Response: createPetsMutationResponse;
+    Request: createPetsMutationRequest;
+};

package/src/generators/__snapshots__/createPetWithUnknownTypeUnknown.ts

@@ -0,0 +1,34 @@
+/**
+ * @description Null response
+*/
+export type CreatePets201 = (error & {
+    name?: errorCode;
+});
+
+ /**
+ * @description unexpected error
+*/
+export type CreatePetsError = error;
+
+ export type CreatePetsMutationRequest = {
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string
+    */
+    tag: string;
+};
+
+ /**
+ * @description Null response
+*/
+export type CreatePetsMutationResponse = (error & {
+    name?: errorCode;
+});
+
+ export type createPetsMutation = {
+    Response: createPetsMutationResponse;
+    Request: createPetsMutationRequest;
+};

package/src/generators/__snapshots__/deletePet.ts

@@ -0,0 +1,5 @@
+export type DeletePetsPetidMutationResponse = any;
+
+ export type deletePetsPetidMutation = {
+    Response: deletePetsPetidMutationResponse;
+};

package/src/generators/__snapshots__/dogTypeAsConst.ts

@@ -0,0 +1,11 @@
+export type dog = {
+    /**
+     * @type string, uuid
+    */
+    id: string;
+    /**
+     * @type number | undefined
+    */
+    bark?: number;
+    type: "Dog";
+};

package/src/generators/__snapshots__/enumAllOf.ts

@@ -0,0 +1,10 @@
+export const enumAllOfReasonEnum2 = {
+    "created_at": "created_at",
+    "description": "description"
+} as const;
+
+ export type EnumAllOfReasonEnum2 = (typeof enumAllOfReasonEnum2)[keyof typeof enumAllOfReasonEnum2];
+
+ export type enumAllOf = {
+    reason?: EnumAllOfReasonEnum2;
+};

package/src/generators/__snapshots__/enumArray.ts

@@ -0,0 +1,19 @@
+export const enumArrayIdentifierEnum2 = {
+    "NW": "NW",
+    "NE": "NE",
+    "SW": "SW",
+    "SE": "SE"
+} as const;
+
+ export type EnumArrayIdentifierEnum2 = (typeof enumArrayIdentifierEnum2)[keyof typeof enumArrayIdentifierEnum2];
+
+ export type enumArray = {
+    /**
+     * @type array | undefined
+    */
+    identifier?: [
+        number,
+        string,
+        EnumArrayIdentifierEnum2
+    ];
+};

package/src/generators/__snapshots__/enumInObject.ts

@@ -0,0 +1,13 @@
+export const enumInObjectReasonEnum2 = {
+    "created_at": "created_at",
+    "description": "description"
+} as const;
+
+ export type EnumInObjectReasonEnum2 = (typeof enumInObjectReasonEnum2)[keyof typeof enumInObjectReasonEnum2];
+
+ export type enumInObject = {
+    /**
+     * @type string | undefined
+    */
+    reason?: EnumInObjectReasonEnum2;
+};

package/src/generators/__snapshots__/enumItems.ts

@@ -0,0 +1,8 @@
+export const enumItemsEnum2 = {
+    "created_at": "created_at",
+    "description": "description"
+} as const;
+
+ export type EnumItemsEnum2 = (typeof enumItemsEnum2)[keyof typeof enumItemsEnum2];
+
+ export type enumItems = EnumItemsEnum2[];

package/src/generators/__snapshots__/enumNames.ts

@@ -0,0 +1,6 @@
+export enum EnumNamesTypeEnum2 {
+    "Pending" = 0,
+    "Received" = 1
+}
+
+ export type enumNamesType = EnumNamesTypeEnum2;

package/src/generators/__snapshots__/enumNamesConst.ts

@@ -0,0 +1,6 @@
+export const enum EnumNamesTypeEnum2 {
+    "Pending" = 0,
+    "Received" = 1
+}
+
+ export type enumNamesType = EnumNamesTypeEnum2;

package/src/generators/__snapshots__/enumNamesLiteral.ts

@@ -0,0 +1,3 @@
+export type EnumNamesTypeEnum2 = 0 | 1;
+
+ export type enumNamesType = EnumNamesTypeEnum2;

package/src/generators/__snapshots__/enumNamesPascalConst.ts

@@ -0,0 +1,8 @@
+export const EnumNamesTypeEnum2 = {
+    "Pending": 0,
+    "Received": 1
+} as const;
+
+ type EnumNamesTypeEnum2 = (typeof EnumNamesTypeEnum2)[keyof typeof EnumNamesTypeEnum2];
+
+ export type enumNamesType = EnumNamesTypeEnum2;

package/src/generators/__snapshots__/enumNamesType.ts

@@ -0,0 +1,8 @@
+export const enumNamesType = {
+    "Pending": 0,
+    "Received": 1
+} as const;
+
+ export type EnumNamesTypeEnum2 = (typeof enumNamesType)[keyof typeof enumNamesType];
+
+ export type enumNamesType = EnumNamesTypeEnum2;

package/src/generators/__snapshots__/enumNullableMember.ts

@@ -0,0 +1,8 @@
+export const enumNullableMemberEnum2 = {
+    "first": "first",
+    "second": "second"
+} as const;
+
+ export type EnumNullableMemberEnum2 = (typeof enumNullableMemberEnum2)[keyof typeof enumNullableMemberEnum2];
+
+ export type enumNullableMember = EnumNullableMemberEnum2 | null;

package/src/generators/__snapshots__/enumNullableType.ts

@@ -0,0 +1,8 @@
+export const enumNullableTypeEnum2 = {
+    "first": "first",
+    "second": "second"
+} as const;
+
+ export type EnumNullableTypeEnum2 = (typeof enumNullableTypeEnum2)[keyof typeof enumNullableTypeEnum2];
+
+ export type enumNullableType = EnumNullableTypeEnum2 | null;

package/src/generators/__snapshots__/enumString.ts

@@ -0,0 +1,10 @@
+export const enumStringEnum2 = {
+    "created_at": "created_at",
+    "description": "description",
+    "FILE.UPLOADED": "FILE.UPLOADED",
+    "FILE.DOWNLOADED": "FILE.DOWNLOADED"
+} as const;
+
+ export type EnumStringEnum2 = (typeof enumStringEnum2)[keyof typeof enumStringEnum2];
+
+ export type enumString = EnumStringEnum2;

package/src/generators/__snapshots__/enumVarNamesType.ts

@@ -0,0 +1,8 @@
+export const enumVarNamesTypeEnum2 = {
+    "Pending": 0,
+    "Received": 1
+} as const;
+
+ export type EnumVarNamesTypeEnum2 = (typeof enumVarNamesTypeEnum2)[keyof typeof enumVarNamesTypeEnum2];
+
+ export type enumVarNamesType = EnumVarNamesTypeEnum2;

package/src/generators/__snapshots__/getPets.ts

@@ -0,0 +1,27 @@
+export type ListPetsQueryParams = {
+    /**
+     * @description How many items to return at one time (max 100)
+     * @type string | undefined
+    */
+    limit?: string;
+};
+
+ /**
+ * @description A paged array of pets
+*/
+export type ListPets200 = pets;
+
+ /**
+ * @description unexpected error
+*/
+export type ListPetsError = error;
+
+ /**
+ * @description A paged array of pets
+*/
+export type ListPetsQueryResponse = pets;
+
+ export type listPetsQuery = {
+    Response: listPetsQueryResponse;
+    QueryParams: listPetsQueryParams;
+};

package/src/generators/__snapshots__/mixedValueTypeConst.ts

@@ -0,0 +1,9 @@
+/**
+ * @description This probably should fail miserably
+*/
+export type mixedValueTypeConst = {
+    /**
+     * @type number | undefined
+    */
+    foobar?: "foobar";
+};

package/src/generators/__snapshots__/nullConstNull.ts

@@ -0,0 +1,6 @@
+/**
+ * @description The value of this keyword MAY be null. \nUse of this keyword is functionally equivalent to an \"enum\" (Section 6.1.2) with a single value.\nAn instance validates successfully against this keyword if its value is equal to the value of the keyword.\n
+*/
+export type nullConst = {
+    withoutValue?: null;
+};

package/src/generators/__snapshots__/numberValueConst.ts

@@ -0,0 +1,9 @@
+/**
+ * @description its value is equal to the value of the keyword
+*/
+export type numberValueConst = {
+    /**
+     * @type number | undefined
+    */
+    foobar?: 42;
+};

package/src/generators/__snapshots__/petMapper.ts

@@ -0,0 +1,15 @@
+export type pet = {
+    /**
+     * @type integer, int64
+    */
+    id: number;
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string | undefined
+    */
+    tag?: string;
+    category?: string;
+};

package/src/generators/__snapshots__/petQuestionToken.ts

@@ -0,0 +1,15 @@
+export type pet = {
+    /**
+     * @type integer, int64
+    */
+    id: number;
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string | undefined
+    */
+    tag?: string;
+    category?: category;
+};

package/src/generators/__snapshots__/petQuestionTokenAndUndefined.ts

@@ -0,0 +1,15 @@
+export type pet = {
+    /**
+     * @type integer, int64
+    */
+    id: number;
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string | undefined
+    */
+    tag?: string | undefined;
+    category?: category | undefined;
+};

package/src/generators/__snapshots__/petUndefined.ts

@@ -0,0 +1,15 @@
+export type pet = {
+    /**
+     * @type integer, int64
+    */
+    id: number;
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string | undefined
+    */
+    tag: string | undefined;
+    category: category | undefined;
+};

package/src/generators/__snapshots__/pets.ts

@@ -0,0 +1,14 @@
+export type pets = {
+    /**
+     * @type integer, int64
+    */
+    id: number;
+    /**
+     * @type string
+    */
+    name: string;
+    /**
+     * @type string | undefined
+    */
+    tag?: string;
+}[];

package/src/generators/__snapshots__/petsStoreDiscriminator.ts

@@ -0,0 +1,13 @@
+/**
+ * @description A project is an analysis project. It has a name, an id, and has a dataset
+*/
+export type petstore = {
+    /**
+     * @type integer
+    */
+    id: number;
+    /**
+     * @type array | undefined
+    */
+    pets?: (cat | dog)[];
+};

package/src/generators/__snapshots__/petsStoreRef.ts

@@ -0,0 +1 @@
+export type pets = pet[];

package/src/generators/__snapshots__/plainDateDate.ts

@@ -0,0 +1 @@
+export type plainDate = Date;

package/src/generators/__snapshots__/plainDateString.ts

@@ -0,0 +1 @@
+export type plainDate = string;

package/src/generators/__snapshots__/plainEmail.ts

@@ -0,0 +1 @@
+export type plainEmail = string;

package/src/generators/__snapshots__/plainFile.ts

@@ -0,0 +1 @@
+export type plainFile = Blob;

package/src/generators/__snapshots__/plainTimeDate.ts

@@ -0,0 +1 @@
+export type plainTime = Date;

package/src/generators/__snapshots__/plainUuid.ts

@@ -0,0 +1 @@
+export type plainUuid = string;

package/src/generators/__snapshots__/showPetById.ts

@@ -0,0 +1,32 @@
+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;
+
+ /**
+ * @description unexpected error
+*/
+export type ShowPetByIdError = error;
+
+ /**
+ * @description Expected response to a valid request
+*/
+export type ShowPetByIdQueryResponse = pet;
+
+ export type showPetByIdQuery = {
+    Response: showPetByIdQueryResponse;
+    PathParams: showPetByIdPathParams;
+};

package/src/generators/__snapshots__/stringValueConst.ts

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

package/src/generators/index.ts

@@ -0,0 +1,2 @@
+export { typeGenerator } from './typeGenerator.tsx'
+export { oasGenerator } from './oasGenerator.tsx'

package/src/generators/oasGenerator.tsx

@@ -0,0 +1,29 @@
+import { createReactGenerator } from '@kubb/plugin-oas'
+import { useOas } from '@kubb/plugin-oas/hooks'
+import { File, useApp } from '@kubb/react'
+import { OasType } from '../components'
+import type { PluginTs } from '../types.ts'
+
+export const oasGenerator = createReactGenerator<PluginTs>({
+  name: 'oas',
+  Operations() {
+    const {
+      pluginManager,
+      plugin: {
+        options: { output },
+        key: pluginKey,
+      },
+    } = useApp<PluginTs>()
+    const oas = useOas()
+
+    const file = pluginManager.getFile({ name: 'oas', extName: '.ts', pluginKey })
+
+    return (
+      <File baseName={file.baseName} path={file.path} meta={file.meta} banner={output?.banner} footer={output?.footer}>
+        <File.Import name={['Infer']} path="@kubb/oas" isTypeOnly />
+
+        <OasType name={'oas'} typeName={'Oas'} api={oas.api} />
+      </File>
+    )
+  },
+})