@kubb/parser-ts 4.1.4 → 5.0.0-alpha.31

package/package.json

@@ -1,20 +1,18 @@
 {
   "name": "@kubb/parser-ts",
-  "version": "4.1.4",
-  "description": "TypeScript parsing and manipulation utilities for Kubb, enabling code generation with proper TypeScript syntax and formatting.",
+  "version": "5.0.0-alpha.31",
+  "description": "TypeScript and TSX file parser for Kubb, converting generated files to strings using the TypeScript compiler.",
   "keywords": [
     "typescript",
+    "tsx",
     "parser",
-    "ast",
-    "code-generation",
-    "syntax",
-    "formatting",
+    "code-generator",
     "codegen",
     "kubb"
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/kubb-labs/kubb.git",
+    "url": "git+https://github.com/kubb-labs/kubb.git",
     "directory": "packages/parser-ts"
   },
   "license": "MIT",
@@ -26,43 +24,32 @@
       "import": "./dist/index.js",
       "require": "./dist/index.cjs"
     },
-    "./factory": {
-      "import": "./dist/factory.js",
-      "require": "./dist/factory.cjs"
-    },
     "./package.json": "./package.json"
   },
-  "main": "./dist/index.cjs",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.cts",
-  "typesVersions": {
-    "*": {
-      "factory": [
-        "./dist/factory.d.ts"
-      ]
-    }
-  },
+  "types": "./dist/index.d.ts",
   "files": [
     "src",
     "dist",
     "!/**/**.test.**",
-    "!/**/__tests__/**"
+    "!/**/__tests__/**",
+    "!/**/__snapshots__/**"
   ],
   "dependencies": {
-    "prettier": "^3.6.2",
-    "remeda": "^2.32.0",
-    "typescript": "5.9.3"
+    "typescript": "^6.0.2",
+    "@kubb/core": "5.0.0-alpha.31"
   },
   "devDependencies": {
-    "tsdown": "^0.14.2"
+    "@internals/utils": "0.0.0"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
   "scripts": {
     "build": "tsdown",
     "clean": "npx rimraf ./dist",

package/src/index.ts

@@ -1,3 +1,2 @@
-export * as factory from './factory.ts'
-export { format } from './format.ts'
-export { print } from './print.ts'
+export { createExport, createImport, parserTs, print, safePrint, validateNodes } from './parserTs.ts'
+export { parserTsx } from './parserTsx.ts'

package/src/parserTs.ts

@@ -0,0 +1,212 @@
+import { normalize, relative } from 'node:path'
+import type { KubbFile, Parser } from '@kubb/core'
+import { defineParser } from '@kubb/core'
+import ts from 'typescript'
+
+const { factory } = ts
+
+function slash(path: string): string {
+  return normalize(path).replaceAll(/\\/g, '/').replace('../', '')
+}
+
+function getRelativePath(rootDir: string, filePath: string): string {
+  const rel = relative(rootDir, filePath)
+  const slashed = slash(rel)
+  return slashed.startsWith('../') ? slashed : `./${slashed}`
+}
+
+function trimExtName(text: string): string {
+  return text.replace(/\.[^/.]+$/, '')
+}
+
+/**
+ * Validates TypeScript AST nodes before printing.
+ * Throws an error if any node has SyntaxKind.Unknown which would cause the
+ * TypeScript printer to crash.
+ */
+export function validateNodes(...nodes: ts.Node[]): void {
+  for (const node of nodes) {
+    if (!node) {
+      throw new Error('Attempted to print undefined or null TypeScript node')
+    }
+    if (node.kind === ts.SyntaxKind.Unknown) {
+      throw new Error(
+        'Invalid TypeScript AST node detected with SyntaxKind.Unknown. ' +
+          'This typically indicates a schema pattern that could not be properly converted to TypeScript. ' +
+          `Node: ${JSON.stringify(node, null, 2)}`,
+      )
+    }
+  }
+}
+
+/**
+ * Converts TypeScript/TSX AST nodes to a string using the TypeScript printer.
+ */
+export function print(...elements: Array<ts.Node>): string {
+  const sourceFile = ts.createSourceFile('print.tsx', '', ts.ScriptTarget.ES2022, true, ts.ScriptKind.TSX)
+
+  const printer = ts.createPrinter({
+    omitTrailingSemicolon: true,
+    newLine: ts.NewLineKind.LineFeed,
+    removeComments: false,
+    noEmitHelpers: true,
+  })
+
+  const output = printer.printList(ts.ListFormat.MultiLine, factory.createNodeArray(elements.filter(Boolean)), sourceFile)
+
+  return output.replace(/\r\n/g, '\n')
+}
+
+/**
+ * Like `print` but validates nodes first to surface issues early.
+ */
+export function safePrint(...elements: Array<ts.Node>): string {
+  validateNodes(...elements)
+  return print(...elements)
+}
+
+export function createImport({
+  name,
+  path,
+  root,
+  isTypeOnly = false,
+  isNameSpace = false,
+}: {
+  name: string | Array<string | { propertyName: string; name?: string }>
+  path: string
+  root?: string
+  /** @default false */
+  isTypeOnly?: boolean
+  /** @default false */
+  isNameSpace?: boolean
+}): ts.ImportDeclaration {
+  const resolvePath = root ? getRelativePath(root, path) : path
+
+  if (!Array.isArray(name)) {
+    if (isNameSpace) {
+      return factory.createImportDeclaration(
+        undefined,
+        factory.createImportClause(isTypeOnly, undefined, factory.createNamespaceImport(factory.createIdentifier(name))),
+        factory.createStringLiteral(resolvePath),
+        undefined,
+      )
+    }
+
+    return factory.createImportDeclaration(
+      undefined,
+      factory.createImportClause(isTypeOnly, factory.createIdentifier(name), undefined),
+      factory.createStringLiteral(resolvePath),
+      undefined,
+    )
+  }
+
+  const specifiers = name.map((item) => {
+    if (typeof item === 'object') {
+      const { propertyName, name: alias } = item
+      return factory.createImportSpecifier(false, alias ? factory.createIdentifier(propertyName) : undefined, factory.createIdentifier(alias ?? propertyName))
+    }
+    return factory.createImportSpecifier(false, undefined, factory.createIdentifier(item))
+  })
+
+  return factory.createImportDeclaration(
+    undefined,
+    factory.createImportClause(isTypeOnly, undefined, factory.createNamedImports(specifiers)),
+    factory.createStringLiteral(resolvePath),
+    undefined,
+  )
+}
+
+export function createExport({
+  path,
+  asAlias,
+  isTypeOnly = false,
+  name,
+}: {
+  path: string
+  /** @default false */
+  asAlias?: boolean
+  /** @default false */
+  isTypeOnly?: boolean
+  name?: string | Array<ts.Identifier | string>
+}): ts.ExportDeclaration {
+  if (name && !Array.isArray(name) && !asAlias) {
+    console.warn(`When using name as string, asAlias should be true: ${name}`)
+  }
+
+  if (!Array.isArray(name)) {
+    const parsedName = name?.match(/^\d/) ? `_${name?.slice(1)}` : name
+
+    return factory.createExportDeclaration(
+      undefined,
+      isTypeOnly,
+      asAlias && parsedName ? factory.createNamespaceExport(factory.createIdentifier(parsedName)) : undefined,
+      factory.createStringLiteral(path),
+      undefined,
+    )
+  }
+
+  return factory.createExportDeclaration(
+    undefined,
+    isTypeOnly,
+    factory.createNamedExports(
+      name.map((propertyName) =>
+        factory.createExportSpecifier(false, undefined, typeof propertyName === 'string' ? factory.createIdentifier(propertyName) : propertyName),
+      ),
+    ),
+    factory.createStringLiteral(path),
+    undefined,
+  )
+}
+
+/**
+ * Parser that converts `.ts` and `.js` files to strings using the TypeScript
+ * compiler. Handles import/export statement generation from file metadata.
+ *
+ * @default Used automatically when no `parsers` option is set in `defineConfig`.
+ */
+export const parserTs: Parser = defineParser({
+  name: 'typescript',
+  extNames: ['.ts', '.js'],
+  async parse(file, options = { extname: '.ts' }) {
+    const sourceParts: Array<string> = []
+    for (const item of file.sources) {
+      if (item.value) {
+        sourceParts.push(item.value)
+      }
+    }
+    const source = sourceParts.join('\n\n')
+
+    const importNodes: Array<ts.ImportDeclaration> = []
+    for (const item of (file as KubbFile.ResolvedFile).imports) {
+      const importPath = item.root ? getRelativePath(item.root, item.path) : item.path
+      const hasExtname = !!/\.[^/.]+$/.exec(importPath)
+
+      importNodes.push(
+        createImport({
+          name: item.name as string | Array<string | { propertyName: string; name?: string }>,
+          path: options?.extname && hasExtname ? `${trimExtName(importPath)}${options.extname}` : item.root ? trimExtName(importPath) : importPath,
+          isTypeOnly: item.isTypeOnly,
+          isNameSpace: item.isNameSpace,
+        }),
+      )
+    }
+
+    const exportNodes: Array<ts.ExportDeclaration> = []
+    for (const item of (file as KubbFile.ResolvedFile).exports) {
+      const exportPath = item.path
+      const hasExtname = !!/\.[^/.]+$/.exec(exportPath)
+
+      exportNodes.push(
+        createExport({
+          name: item.name as string | Array<ts.Identifier | string> | undefined,
+          path: options?.extname && hasExtname ? `${trimExtName(item.path)}${options.extname}` : trimExtName(item.path),
+          isTypeOnly: item.isTypeOnly,
+          asAlias: item.asAlias,
+        }),
+      )
+    }
+
+    const parts = [file.banner, print(...importNodes, ...exportNodes), source, file.footer].filter((segment): segment is string => segment != null)
+    return parts.join('\n')
+  },
+})

package/src/parserTsx.ts

@@ -0,0 +1,20 @@
+import type { Parser } from '@kubb/core'
+import { defineParser } from '@kubb/core'
+import { parserTs } from './parserTs.ts'
+
+/**
+ * Parser that converts `.tsx` and `.jsx` files to strings.
+ * Delegates to `typescriptParser` since the TypeScript compiler natively
+ * supports JSX/TSX syntax via `ScriptKind.TSX`.
+ *
+ * Add this parser to the `parsers` option in `defineConfig` when generating `.tsx`/`.jsx` files.
+ *
+ * @default extname '.tsx'
+ */
+export const parserTsx: Parser = defineParser({
+  name: 'tsx',
+  extNames: ['.tsx', '.jsx'],
+  async parse(file, options = { extname: '.tsx' }) {
+    return parserTs.parse(file, options)
+  },
+})

package/README.md

@@ -1,54 +0,0 @@
-<div align="center">
-  <h1>Parser TypeScript</h1>
-  <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
-    <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
-  </a>
-
-
-[![npm version][npm-version-src]][npm-version-href]
-[![npm downloads][npm-downloads-src]][npm-downloads-href]
-[![Coverage][coverage-src]][coverage-href]
-[![License][license-src]][license-href]
-[![Sponsors][sponsors-src]][sponsors-href]
-<h4>
-<a href="https://codesandbox.io/s/github/kubb-labs/kubb/tree/main//examples/typescript" target="_blank">View Demo</a>
-<span> · </span>
-<a href="https://kubb.dev/" target="_blank">Documentation</a>
-<span> · </span>
-<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
-<span> · </span>
-<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
-</h4>
-</div>
-
-Typescript Parser
-
-## Supporting Kubb
-
-Kubb uses an MIT-licensed open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
-
-- [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
-
-<p align="center">
-  <a href="https://github.com/sponsors/stijnvanhulle">
-    <img src="https://raw.githubusercontent.com/stijnvanhulle/sponsors/main/sponsors.svg" alt="My sponsors" />
-  </a>
-</p>
-
-
-<!-- Badges -->
-
-[npm-version-src]: https://img.shields.io/npm/v/@kubb/parser-ts?flat&colorA=18181B&colorB=f58517
-[npm-version-href]: https://npmjs.com/package/@kubb/parser-ts
-[npm-downloads-src]: https://img.shields.io/npm/dm/@kubb/parser-ts?flat&colorA=18181B&colorB=f58517
-[npm-downloads-href]: https://npmjs.com/package/@kubb/parser-ts
-[license-src]: https://img.shields.io/github/license/kubb-labs/kubb.svg?flat&colorA=18181B&colorB=f58517
-[license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
-[build-src]: https://img.shields.io/github/actions/workflow/status/kubb-labs/kubb/ci.yaml?style=flat&colorA=18181B&colorB=f58517
-[build-href]: https://www.npmjs.com/package/@kubb/parser-ts
-[minified-src]: https://img.shields.io/bundlephobia/min/@kubb/parser-ts?style=flat&colorA=18181B&colorB=f58517
-[minified-href]: https://www.npmjs.com/package/@kubb/parser-ts
-[coverage-src]: https://img.shields.io/codecov/c/github/kubb-labs/kubb?style=flat&colorA=18181B&colorB=f58517
-[coverage-href]: https://www.npmjs.com/package/@kubb/parser-ts
-[sponsors-src]: https://img.shields.io/github/sponsors/stijnvanhulle?style=flat&colorA=18181B&colorB=f58517
-[sponsors-href]: https://github.com/sponsors/stijnvanhulle/

package/dist/chunk-CTAAG5j7.js

@@ -1,13 +0,0 @@
-//#region rolldown:runtime
-var __defProp = Object.defineProperty;
-var __export = (all) => {
-	let target = {};
-	for (var name in all) __defProp(target, name, {
-		get: all[name],
-		enumerable: true
-	});
-	return target;
-};
-
-//#endregion
-export { __export };

package/dist/factory-BJCGLhSr.d.ts

@@ -1,227 +0,0 @@
-import ts from "typescript";
-
-//#region src/factory.d.ts
-declare const modifiers: {
-  readonly async: ts.ModifierToken<ts.SyntaxKind.AsyncKeyword>;
-  readonly export: ts.ModifierToken<ts.SyntaxKind.ExportKeyword>;
-  readonly const: ts.ModifierToken<ts.SyntaxKind.ConstKeyword>;
-  readonly static: ts.ModifierToken<ts.SyntaxKind.StaticKeyword>;
-};
-declare const syntaxKind: {
-  readonly union: 192;
-};
-declare function createQuestionToken(token?: boolean | ts.QuestionToken): ts.PunctuationToken<ts.SyntaxKind.QuestionToken> | undefined;
-declare function createIntersectionDeclaration({
-  nodes,
-  withParentheses
-}: {
-  nodes: Array<ts.TypeNode>;
-  withParentheses?: boolean;
-}): ts.TypeNode | null;
-/**
- * Minimum nodes length of 2
- * @example `string & number`
- */
-declare function createTupleDeclaration({
-  nodes,
-  withParentheses
-}: {
-  nodes: Array<ts.TypeNode>;
-  withParentheses?: boolean;
-}): ts.TypeNode | null;
-declare function createArrayDeclaration({
-  nodes
-}: {
-  nodes: Array<ts.TypeNode>;
-}): ts.TypeNode | null;
-/**
- * Minimum nodes length of 2
- * @example `string | number`
- */
-declare function createUnionDeclaration({
-  nodes,
-  withParentheses
-}: {
-  nodes: Array<ts.TypeNode>;
-  withParentheses?: boolean;
-}): ts.TypeNode;
-declare function createPropertySignature({
-  readOnly,
-  modifiers,
-  name,
-  questionToken,
-  type
-}: {
-  readOnly?: boolean;
-  modifiers?: Array<ts.Modifier>;
-  name: ts.PropertyName | string;
-  questionToken?: ts.QuestionToken | boolean;
-  type?: ts.TypeNode;
-}): ts.PropertySignature;
-declare function createParameterSignature(name: string | ts.BindingName, {
-  modifiers,
-  dotDotDotToken,
-  questionToken,
-  type,
-  initializer
-}: {
-  decorators?: Array<ts.Decorator>;
-  modifiers?: Array<ts.Modifier>;
-  dotDotDotToken?: ts.DotDotDotToken;
-  questionToken?: ts.QuestionToken | boolean;
-  type?: ts.TypeNode;
-  initializer?: ts.Expression;
-}): ts.ParameterDeclaration;
-declare function createJSDoc({
-  comments
-}: {
-  comments: string[];
-}): ts.JSDoc | null;
-/**
- * @link https://github.com/microsoft/TypeScript/issues/44151
- */
-declare function appendJSDocToNode<TNode extends ts.Node>({
-  node,
-  comments
-}: {
-  node: TNode;
-  comments: Array<string | undefined>;
-}): TNode;
-declare function createIndexSignature(type: ts.TypeNode, {
-  modifiers,
-  indexName,
-  indexType
-}?: {
-  indexName?: string;
-  indexType?: ts.TypeNode;
-  decorators?: Array<ts.Decorator>;
-  modifiers?: Array<ts.Modifier>;
-}): ts.IndexSignatureDeclaration;
-declare function createTypeAliasDeclaration({
-  modifiers,
-  name,
-  typeParameters,
-  type
-}: {
-  modifiers?: Array<ts.Modifier>;
-  name: string | ts.Identifier;
-  typeParameters?: Array<ts.TypeParameterDeclaration>;
-  type: ts.TypeNode;
-}): ts.TypeAliasDeclaration;
-declare function createInterfaceDeclaration({
-  modifiers,
-  name,
-  typeParameters,
-  members
-}: {
-  modifiers?: Array<ts.Modifier>;
-  name: string | ts.Identifier;
-  typeParameters?: Array<ts.TypeParameterDeclaration>;
-  members: Array<ts.TypeElement>;
-}): ts.InterfaceDeclaration;
-declare function createTypeDeclaration({
-  syntax,
-  isExportable,
-  comments,
-  name,
-  type
-}: {
-  syntax: 'type' | 'interface';
-  comments: Array<string | undefined>;
-  isExportable?: boolean;
-  name: string | ts.Identifier;
-  type: ts.TypeNode;
-}): ts.TypeAliasDeclaration | ts.InterfaceDeclaration;
-declare function createNamespaceDeclaration({
-  statements,
-  name
-}: {
-  name: string;
-  statements: ts.Statement[];
-}): ts.ModuleDeclaration;
-/**
- * In { propertyName: string; name?: string } is `name` being used to make the type more unique when multiple same names are used.
- * @example `import { Pet as Cat } from './Pet'`
- */
-declare function createImportDeclaration({
-  name,
-  path,
-  isTypeOnly,
-  isNameSpace
-}: {
-  name: string | Array<string | {
-    propertyName: string;
-    name?: string;
-  }>;
-  path: string;
-  isTypeOnly?: boolean;
-  isNameSpace?: boolean;
-}): ts.ImportDeclaration;
-declare function createExportDeclaration({
-  path,
-  asAlias,
-  isTypeOnly,
-  name
-}: {
-  path: string;
-  asAlias?: boolean;
-  isTypeOnly?: boolean;
-  name?: string | Array<ts.Identifier | string>;
-}): ts.ExportDeclaration;
-declare function createEnumDeclaration({
-  type,
-  name,
-  typeName,
-  enums
-}: {
-  /**
-   * @default `'enum'`
-   */
-  type?: 'enum' | 'asConst' | 'asPascalConst' | 'constEnum' | 'literal';
-  /**
-   * Enum name in camelCase.
-   */
-  name: string;
-  /**
-   * Enum name in PascalCase.
-   */
-  typeName: string;
-  enums: [key: string | number, value: string | number | boolean][];
-}): [name: ts.Node | undefined, type: ts.Node];
-declare function createOmitDeclaration({
-  keys,
-  type,
-  nonNullable
-}: {
-  keys: Array<string> | string;
-  type: ts.TypeNode;
-  nonNullable?: boolean;
-}): ts.TypeReferenceNode;
-declare const keywordTypeNodes: {
-  readonly any: ts.KeywordTypeNode<ts.SyntaxKind.AnyKeyword>;
-  readonly unknown: ts.KeywordTypeNode<ts.SyntaxKind.UnknownKeyword>;
-  readonly void: ts.KeywordTypeNode<ts.SyntaxKind.VoidKeyword>;
-  readonly number: ts.KeywordTypeNode<ts.SyntaxKind.NumberKeyword>;
-  readonly integer: ts.KeywordTypeNode<ts.SyntaxKind.NumberKeyword>;
-  readonly object: ts.KeywordTypeNode<ts.SyntaxKind.ObjectKeyword>;
-  readonly string: ts.KeywordTypeNode<ts.SyntaxKind.StringKeyword>;
-  readonly boolean: ts.KeywordTypeNode<ts.SyntaxKind.BooleanKeyword>;
-  readonly undefined: ts.KeywordTypeNode<ts.SyntaxKind.UndefinedKeyword>;
-  readonly null: ts.LiteralTypeNode;
-};
-declare const createTypeLiteralNode: (members: readonly ts.TypeElement[] | undefined) => ts.TypeLiteralNode;
-declare const createTypeReferenceNode: (typeName: string | ts.EntityName, typeArguments?: readonly ts.TypeNode[]) => ts.TypeReferenceNode;
-declare const createNumericLiteral: (value: string | number, numericLiteralFlags?: ts.TokenFlags) => ts.NumericLiteral;
-declare const createStringLiteral: (text: string, isSingleQuote?: boolean) => ts.StringLiteral;
-declare const createArrayTypeNode: (elementType: ts.TypeNode) => ts.ArrayTypeNode;
-declare const createLiteralTypeNode: (literal: ts.LiteralTypeNode["literal"]) => ts.LiteralTypeNode;
-declare const createNull: () => ts.NullLiteral;
-declare const createIdentifier: (text: string) => ts.Identifier;
-declare const createOptionalTypeNode: (type: ts.TypeNode) => ts.OptionalTypeNode;
-declare const createTupleTypeNode: (elements: readonly (ts.TypeNode | ts.NamedTupleMember)[]) => ts.TupleTypeNode;
-declare const createRestTypeNode: (type: ts.TypeNode) => ts.RestTypeNode;
-declare const createTrue: () => ts.TrueLiteral;
-declare const createFalse: () => ts.FalseLiteral;
-//#endregion
-export { appendJSDocToNode, createArrayDeclaration, createArrayTypeNode, createEnumDeclaration, createExportDeclaration, createFalse, createIdentifier, createImportDeclaration, createIndexSignature, createInterfaceDeclaration, createIntersectionDeclaration, createJSDoc, createLiteralTypeNode, createNamespaceDeclaration, createNull, createNumericLiteral, createOmitDeclaration, createOptionalTypeNode, createParameterSignature, createPropertySignature, createQuestionToken, createRestTypeNode, createStringLiteral, createTrue, createTupleDeclaration, createTupleTypeNode, createTypeAliasDeclaration, createTypeDeclaration, createTypeLiteralNode, createTypeReferenceNode, createUnionDeclaration, factory_d_exports, keywordTypeNodes, modifiers, syntaxKind };
-//# sourceMappingURL=factory-BJCGLhSr.d.ts.map