@kubb/fabric-core 0.0.0-canary-20251021185909 → 0.0.0-canary-20251022151827

package/src/parsers/types.ts

@@ -1,12 +1,22 @@
 import type * as KubbFile from '../KubbFile.ts'
+import type { Install } from '../App.ts'
 
 type PrintOptions = {
   extname?: KubbFile.Extname
 }
 
-export type Parser<TMeta extends object = object> = {
+export type Parser<TOptions = any[], TMeta extends object = any> = {
+  name: string
+  type: 'parser'
+  /**
+   * Undefined is being used for the defaultParser
+   */
+  extNames: Array<KubbFile.Extname> | undefined
+  install: Install<TOptions>
   /**
    * Convert a file to string
    */
-  print: (file: KubbFile.ResolvedFile<TMeta>, options: PrintOptions) => Promise<string>
+  parse(file: KubbFile.ResolvedFile<TMeta>, options: PrintOptions): Promise<string>
 }
+
+export type UserParser<TOptions = any[], TMeta extends object = any> = Omit<Parser<TOptions, TMeta>, 'type'>

package/src/parsers/{typescript.ts → typescriptParser.ts}

@@ -1,7 +1,8 @@
 import ts from 'typescript'
-import { getRelativePath, trimExtName } from '../fs.ts'
+import { getRelativePath } from '../utils/getRelativePath.ts'
+import { trimExtName } from '../utils/trimExtName.ts'
 import path from 'node:path'
-import { createFileParser } from './createFileParser.ts'
+import { createParser } from './createParser.ts'
 
 const { factory } = ts
 
@@ -147,8 +148,11 @@ export function createExport({
   )
 }
 
-export const typeScriptParser = createFileParser({
-  async print(file, options = { extname: '.ts' }) {
+export const typescriptParser = createParser({
+  name: 'typescript',
+  extNames: ['.ts', '.js'],
+  install() {},
+  async parse(file, options = { extname: '.ts' }) {
     const source = file.sources.map((item) => item.value).join('\n\n')
 
     const importNodes = file.imports

package/src/plugins/createPlugin.ts

@@ -0,0 +1,10 @@
+import type { Plugin, UserPlugin } from './types.ts'
+
+export function createPlugin<Options = any[], TAppExtension extends Record<string, any> = {}>(
+  plugin: UserPlugin<Options, TAppExtension>,
+): Plugin<Options, TAppExtension> {
+  return {
+    type: 'plugin',
+    ...plugin,
+  }
+}

package/src/plugins/fsPlugin.ts

@@ -0,0 +1,112 @@
+import { createPlugin } from './createPlugin.ts'
+import { switcher } from 'js-runtime'
+import fs from 'fs-extra'
+import { resolve } from 'node:path'
+import type * as KubbFile from '../KubbFile.ts'
+
+type Options = {
+  /**
+   * Optional callback that is invoked whenever a file is written by the plugin.
+   * Useful for tests to observe write operations without spying on internal functions.
+   */
+  onWrite?: (path: string, data: string) => void | Promise<void>
+}
+
+export async function write(path: string, data: string, options: { sanity?: boolean } = {}): Promise<string | undefined> {
+  if (data.trim() === '') {
+    return undefined
+  }
+  return switcher(
+    {
+      node: async (path: string, data: string, { sanity }: { sanity?: boolean }) => {
+        try {
+          const oldContent = await fs.readFile(resolve(path), {
+            encoding: 'utf-8',
+          })
+          if (oldContent?.toString() === data?.toString()) {
+            return
+          }
+        } catch (_err) {
+          /* empty */
+        }
+
+        await fs.outputFile(resolve(path), data, { encoding: 'utf-8' })
+
+        if (sanity) {
+          const savedData = await fs.readFile(resolve(path), {
+            encoding: 'utf-8',
+          })
+
+          if (savedData?.toString() !== data?.toString()) {
+            throw new Error(`Sanity check failed for ${path}\n\nData[${data.length}]:\n${data}\n\nSaved[${savedData.length}]:\n${savedData}\n`)
+          }
+
+          return savedData
+        }
+
+        return data
+      },
+      bun: async (path: string, data: string, { sanity }: { sanity?: boolean }) => {
+        try {
+          await Bun.write(resolve(path), data)
+
+          if (sanity) {
+            const file = Bun.file(resolve(path))
+            const savedData = await file.text()
+
+            if (savedData?.toString() !== data?.toString()) {
+              throw new Error(`Sanity check failed for ${path}\n\nData[${path.length}]:\n${path}\n\nSaved[${savedData.length}]:\n${savedData}\n`)
+            }
+
+            return savedData
+          }
+
+          return data
+        } catch (e) {
+          console.error(e)
+        }
+      },
+    },
+    'node',
+  )(path, data.trim(), options)
+}
+
+type WriteOptions = {
+  extension?: Record<KubbFile.Extname, KubbFile.Extname | ''>
+  dryRun?: boolean
+}
+
+declare module '../index.ts' {
+  interface App {
+    write(options?: WriteOptions): Promise<void>
+  }
+}
+
+export const fsPlugin = createPlugin<Options, { write(options?: WriteOptions): Promise<void> }>({
+  name: 'fs',
+  scope: 'write',
+  async install(_app, context, options) {
+    context.events.on('process:progress', async ({ file, source }) => {
+      if (options?.onWrite) {
+        await options.onWrite(file.path, source)
+      }
+      await write(file.path, source, { sanity: false })
+    })
+  },
+  override(_app, context) {
+    return {
+      async write(
+        options = {
+          extension: { '.ts': '.ts' },
+          dryRun: false,
+        },
+      ) {
+        await context.fileManager.write({
+          extension: options.extension,
+          dryRun: options.dryRun,
+          parsers: context.installedParsers,
+        })
+      },
+    }
+  },
+})

package/src/plugins/index.ts

@@ -0,0 +1,3 @@
+export { createPlugin } from './createPlugin.ts'
+
+export { fsPlugin } from './fsPlugin.ts'

package/src/plugins/types.ts

@@ -0,0 +1,15 @@
+import type { Install, Override } from '../App.ts'
+
+export type Plugin<TOptions = any[], TAppExtension extends Record<string, any> = {}> = {
+  name: string
+  type: 'plugin'
+  scope?: 'write' | 'read' | (string & {})
+  install: Install<TOptions> | Promise<Install<TOptions>>
+  /**
+   * Runtime app overrides or extensions.
+   * Merged into the app instance after install.
+   */
+  override?: Override<TOptions, TAppExtension>
+}
+
+export type UserPlugin<TOptions = any[], TAppExtension extends Record<string, any> = {}> = Omit<Plugin<TOptions, TAppExtension>, 'type'>

package/src/types.ts

@@ -1,2 +1,5 @@
 export * as KubbFile from './KubbFile.ts'
-export type { DefineApp, AppContext, App } from './defineApp.ts'
+export type { DefineApp } from './defineApp.ts'
+export type { AppContext } from './App.ts'
+
+export type { App } from './App.ts'

package/src/utils/AsyncEventEmitter.ts

@@ -0,0 +1,37 @@
+import { EventEmitter as NodeEventEmitter } from 'node:events'
+
+export class AsyncEventEmitter<TEvents extends Record<string, any>> {
+  constructor(maxListener = 100) {
+    this.#emitter.setMaxListeners(maxListener)
+  }
+  #emitter = new NodeEventEmitter()
+
+  async emit<TEventName extends keyof TEvents & string>(eventName: TEventName, ...eventArgs: TEvents[TEventName]): Promise<void> {
+    const listeners = this.#emitter.listeners(eventName) as Array<(...args: TEvents[TEventName]) => any>
+
+    if (listeners.length === 0) {
+      return undefined
+    }
+
+    await Promise.all(
+      listeners.map(async (listener) => {
+        try {
+          return await listener(...eventArgs)
+        } catch (err) {
+          console.error(`Error in async listener for "${eventName}":`, err)
+        }
+      }),
+    )
+  }
+
+  on<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void {
+    this.#emitter.on(eventName, handler as any)
+  }
+
+  off<TEventName extends keyof TEvents & string>(eventName: TEventName, handler: (...eventArg: TEvents[TEventName]) => void): void {
+    this.#emitter.off(eventName, handler as any)
+  }
+  removeAll(): void {
+    this.#emitter.removeAllListeners()
+  }
+}

package/src/utils/getRelativePath.ts

@@ -0,0 +1,32 @@
+import { normalize, relative } from 'node:path'
+
+function slash(path: string, platform: 'windows' | 'mac' | 'linux' = 'linux') {
+  const isWindowsPath = /^\\\\\?\\/.test(path)
+  const normalizedPath = normalize(path)
+
+  if (['linux', 'mac'].includes(platform) && !isWindowsPath) {
+    // linux and mac
+    return normalizedPath.replaceAll(/\\/g, '/').replace('../', '')
+  }
+
+  // windows
+  return normalizedPath.replaceAll(/\\/g, '/').replace('../', '')
+}
+
+export function getRelativePath(rootDir?: string | null, filePath?: string | null, platform: 'windows' | 'mac' | 'linux' = 'linux'): string {
+  if (!rootDir || !filePath) {
+    throw new Error(`Root and file should be filled in when retrieving the relativePath, ${rootDir || ''} ${filePath || ''}`)
+  }
+
+  const relativePath = relative(rootDir, filePath)
+
+  // On Windows, paths are separated with a "\"
+  // However, web browsers use "/" no matter the platform
+  const slashedPath = slash(relativePath, platform)
+
+  if (slashedPath.startsWith('../')) {
+    return slashedPath
+  }
+
+  return `./${slashedPath}`
+}

package/src/utils/trimExtName.ts

@@ -0,0 +1,3 @@
+export function trimExtName(text: string): string {
+  return text.replace(/\.[^/.]+$/, '')
+}

package/dist/KubbFile-BrN7Wwp6.d.cts

@@ -1,119 +0,0 @@
-declare namespace KubbFile_d_exports {
-  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, OptionalPath, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
-}
-type BasePath<T extends string = string> = `${T}/`;
-type Import = {
-  /**
-   * Import name to be used
-   * @example ["useState"]
-   * @example "React"
-   */
-  name: string | Array<string | {
-    propertyName: string;
-    name?: string;
-  }>;
-  /**
-   * Path for the import
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  isNameSpace?: boolean;
-  /**
-   * When root is set it will get the path with relative getRelativePath(root, path).
-   */
-  root?: string;
-};
-type Source = {
-  name?: string;
-  value?: string;
-  isTypeOnly?: boolean;
-  /**
-   * Has const or type 'export'
-   * @default false
-   */
-  isExportable?: boolean;
-  /**
-   * When set, barrel generation will add this
-   * @default false
-   */
-  isIndexable?: boolean;
-};
-type Export = {
-  /**
-   * Export name to be used.
-   * @example ["useState"]
-   * @example "React"
-   */
-  name?: string | Array<string>;
-  /**
-   * Path for the import.
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the export, this will result in: `export type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  /**
-   * Make it possible to override the name, this will result in: `export * as aliasName from './path'`.
-   */
-  asAlias?: boolean;
-};
-type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
-type Mode = 'single' | 'split';
-/**
- * Name to be used to dynamicly create the baseName(based on input.path)
- * Based on UNIX basename
- * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
- */
-type BaseName = `${string}.${string}`;
-/**
- * Path will be full qualified path to a specified file
- */
-type Path = string;
-type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-type OptionalPath = Path | undefined | null;
-type File<TMeta extends object = object> = {
-  /**
-   * Name to be used to create the path
-   * Based on UNIX basename, `${name}.extname`
-   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
-   */
-  baseName: BaseName;
-  /**
-   * Path will be full qualified path to a specified file
-   */
-  path: AdvancedPath<BaseName> | Path;
-  sources: Array<Source>;
-  imports?: Array<Import>;
-  exports?: Array<Export>;
-  /**
-   * Use extra meta, this is getting used to generate the barrel/index files.
-   */
-  meta?: TMeta;
-  banner?: string;
-  footer?: string;
-};
-type ResolvedImport = Import;
-type ResolvedExport = Export;
-type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
-  /**
-   * @default hash
-   */
-  id: string;
-  /**
-   * Contains the first part of the baseName, generated based on baseName
-   * @link  https://nodejs.org/api/path.html#pathformatpathobject
-   */
-  name: string;
-  extname: Extname;
-  imports: Array<ResolvedImport>;
-  exports: Array<ResolvedExport>;
-};
-//#endregion
-export { ResolvedFile as a, Path as i, File as n, KubbFile_d_exports as r, Extname as t };
-//# sourceMappingURL=KubbFile-BrN7Wwp6.d.cts.map

package/dist/KubbFile-BzVkcu9M.d.ts

@@ -1,119 +0,0 @@
-declare namespace KubbFile_d_exports {
-  export { AdvancedPath, BaseName, Export, Extname, File, Import, Mode, OptionalPath, Path, ResolvedExport, ResolvedFile, ResolvedImport, Source };
-}
-type BasePath<T extends string = string> = `${T}/`;
-type Import = {
-  /**
-   * Import name to be used
-   * @example ["useState"]
-   * @example "React"
-   */
-  name: string | Array<string | {
-    propertyName: string;
-    name?: string;
-  }>;
-  /**
-   * Path for the import
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  isNameSpace?: boolean;
-  /**
-   * When root is set it will get the path with relative getRelativePath(root, path).
-   */
-  root?: string;
-};
-type Source = {
-  name?: string;
-  value?: string;
-  isTypeOnly?: boolean;
-  /**
-   * Has const or type 'export'
-   * @default false
-   */
-  isExportable?: boolean;
-  /**
-   * When set, barrel generation will add this
-   * @default false
-   */
-  isIndexable?: boolean;
-};
-type Export = {
-  /**
-   * Export name to be used.
-   * @example ["useState"]
-   * @example "React"
-   */
-  name?: string | Array<string>;
-  /**
-   * Path for the import.
-   * @example '@kubb/core'
-   */
-  path: string;
-  /**
-   * Add `type` prefix to the export, this will result in: `export type { Type } from './path'`.
-   */
-  isTypeOnly?: boolean;
-  /**
-   * Make it possible to override the name, this will result in: `export * as aliasName from './path'`.
-   */
-  asAlias?: boolean;
-};
-type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
-type Mode = 'single' | 'split';
-/**
- * Name to be used to dynamicly create the baseName(based on input.path)
- * Based on UNIX basename
- * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
- */
-type BaseName = `${string}.${string}`;
-/**
- * Path will be full qualified path to a specified file
- */
-type Path = string;
-type AdvancedPath<T extends BaseName = BaseName> = `${BasePath}${T}`;
-type OptionalPath = Path | undefined | null;
-type File<TMeta extends object = object> = {
-  /**
-   * Name to be used to create the path
-   * Based on UNIX basename, `${name}.extname`
-   * @link https://nodejs.org/api/path.html#pathbasenamepath-suffix
-   */
-  baseName: BaseName;
-  /**
-   * Path will be full qualified path to a specified file
-   */
-  path: AdvancedPath<BaseName> | Path;
-  sources: Array<Source>;
-  imports?: Array<Import>;
-  exports?: Array<Export>;
-  /**
-   * Use extra meta, this is getting used to generate the barrel/index files.
-   */
-  meta?: TMeta;
-  banner?: string;
-  footer?: string;
-};
-type ResolvedImport = Import;
-type ResolvedExport = Export;
-type ResolvedFile<TMeta extends object = object> = File<TMeta> & {
-  /**
-   * @default hash
-   */
-  id: string;
-  /**
-   * Contains the first part of the baseName, generated based on baseName
-   * @link  https://nodejs.org/api/path.html#pathformatpathobject
-   */
-  name: string;
-  extname: Extname;
-  imports: Array<ResolvedImport>;
-  exports: Array<ResolvedExport>;
-};
-//#endregion
-export { ResolvedFile as a, Path as i, File as n, KubbFile_d_exports as r, Extname as t };
-//# sourceMappingURL=KubbFile-BzVkcu9M.d.ts.map

package/dist/createFileParser-BD8yn0LT.cjs

@@ -1,14 +0,0 @@
-
-//#region src/parsers/createFileParser.ts
-function createFileParser(parser) {
-	return parser;
-}
-
-//#endregion
-Object.defineProperty(exports, 'createFileParser', {
-  enumerable: true,
-  get: function () {
-    return createFileParser;
-  }
-});
-//# sourceMappingURL=createFileParser-BD8yn0LT.cjs.map

package/dist/createFileParser-BD8yn0LT.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"createFileParser-BD8yn0LT.cjs","names":[],"sources":["../src/parsers/createFileParser.ts"],"sourcesContent":["import type { Parser } from './types.ts'\n\nexport function createFileParser<TMeta extends object = object>(parser: Parser<TMeta>): Parser<TMeta> {\n  return parser\n}\n"],"mappings":";;AAEA,SAAgB,iBAAgD,QAAsC;AACpG,QAAO"}

package/dist/createFileParser-Cix3AMLd.js

@@ -1,8 +0,0 @@
-//#region src/parsers/createFileParser.ts
-function createFileParser(parser) {
-	return parser;
-}
-
-//#endregion
-export { createFileParser as t };
-//# sourceMappingURL=createFileParser-Cix3AMLd.js.map

package/dist/createFileParser-Cix3AMLd.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"createFileParser-Cix3AMLd.js","names":[],"sources":["../src/parsers/createFileParser.ts"],"sourcesContent":["import type { Parser } from './types.ts'\n\nexport function createFileParser<TMeta extends object = object>(parser: Parser<TMeta>): Parser<TMeta> {\n  return parser\n}\n"],"mappings":";AAEA,SAAgB,iBAAgD,QAAsC;AACpG,QAAO"}

package/dist/default-DCpuPmrL.js

@@ -1,10 +0,0 @@
-import { t as createFileParser } from "./createFileParser-Cix3AMLd.js";
-
-//#region src/parsers/default.ts
-const defaultParser = createFileParser({ async print(file) {
-	return file.sources.map((item) => item.value).join("\n\n");
-} });
-
-//#endregion
-export { defaultParser as t };
-//# sourceMappingURL=default-DCpuPmrL.js.map

package/dist/default-DCpuPmrL.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"default-DCpuPmrL.js","names":[],"sources":["../src/parsers/default.ts"],"sourcesContent":["import { createFileParser } from './createFileParser.ts'\n\nexport const defaultParser = createFileParser({\n  async print(file) {\n    return file.sources.map((item) => item.value).join('\\n\\n')\n  },\n})\n"],"mappings":";;;AAEA,MAAa,gBAAgB,iBAAiB,EAC5C,MAAM,MAAM,MAAM;AAChB,QAAO,KAAK,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,KAAK,OAAO;GAE7D,CAAC"}

package/dist/default-DNBu_jsL.cjs

@@ -1,15 +0,0 @@
-const require_createFileParser = require('./createFileParser-BD8yn0LT.cjs');
-
-//#region src/parsers/default.ts
-const defaultParser = require_createFileParser.createFileParser({ async print(file) {
-	return file.sources.map((item) => item.value).join("\n\n");
-} });
-
-//#endregion
-Object.defineProperty(exports, 'defaultParser', {
-  enumerable: true,
-  get: function () {
-    return defaultParser;
-  }
-});
-//# sourceMappingURL=default-DNBu_jsL.cjs.map

package/dist/default-DNBu_jsL.cjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"default-DNBu_jsL.cjs","names":["createFileParser"],"sources":["../src/parsers/default.ts"],"sourcesContent":["import { createFileParser } from './createFileParser.ts'\n\nexport const defaultParser = createFileParser({\n  async print(file) {\n    return file.sources.map((item) => item.value).join('\\n\\n')\n  },\n})\n"],"mappings":";;;AAEA,MAAa,gBAAgBA,0CAAiB,EAC5C,MAAM,MAAM,MAAM;AAChB,QAAO,KAAK,QAAQ,KAAK,SAAS,KAAK,MAAM,CAAC,KAAK,OAAO;GAE7D,CAAC"}