@kubb/core 1.1.7 → 1.1.9

package/README.md

@@ -5,38 +5,45 @@
   
   <p>
    Core utils for other packages.
-  </p>
+  </p>  
+  <img src="https://raw.githubusercontent.com/kubb-project/kubb/main/assets/banner.png" alt="logo"  height="auto" />
 
-<!-- Badges -->
-<p>
-  <a href="https://www.npmjs.com/package/@kubb/core">
+  <!-- Badges -->
+  <p>
+  <a href="https://www.npmjs.com/package/@kubb/core" target="_blank">
     <img alt="npm version" src="https://img.shields.io/npm/v/@kubb/core?style=for-the-badge"/>
   </a>
-  <a href="https://www.npmjs.com/package/@kubb/core">
-    <img alt="npm downloads" src="https://img.shields.io/bundlephobia/min/@kubb/core?style=for-the-badge"/>
-  </a>
-  <a href="https://www.npmjs.com/package/@kubb/core">
+
+  <a href="https://www.npmjs.com/package/@kubb/core" target="_blank">
     <img alt="npm downloads" src="https://img.shields.io/npm/dm/@kubb/core?style=for-the-badge"/>
   </a>
-</p>
+  </p>
+    
+  <p> 
+  <a href="https://www.npmjs.com/package/@kubb/core" target="_blank">
+    <img alt="Minified size" src="https://img.shields.io/bundlephobia/min/@kubb/core?style=for-the-badge"/>
+  </a>
+    
+  <a href="https://www.npmjs.com/package/@kubb/core" target="_blank">
+    <img alt="Coverage" src="https://img.shields.io/codecov/c/github/kubb-project/kubb?style=for-the-badge"/>
+  </a>
+    
+  <a href="https://www.npmjs.com/package/@kubb/core" target="_blank">
+    <img alt="Build status" src="https://img.shields.io/github/actions/workflow/status/kubb-project/kubb/ci.yaml?style=for-the-badge"/>
+  </a>
+  
+  
+  <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+  <!-- ALL-CONTRIBUTORS-BADGE:END -->
+  </p>
    
-<h4>
-    <a href="https://codesandbox.io/s/github/kubb-project/kubb/tree/main/examples/simple">View Demo</a>
-  <span> · </span>
-    <a href="https://kubb.dev/" target="_blank">Documentation</a>
-  <span> · </span>
-    <a href="https://github.com/kubb-project/kubb/issues/">Report Bug</a>
-  <span> · </span>
-    <a href="https://github.com/kubb-project/kubb/issues/">Request Feature</a>
+  <h4>
+    <a href="https://codesandbox.io/s/github/kubb-project/kubb/tree/main/examples/simple" target="_blank">View Demo</a>
+    <span> · </span>
+      <a href="https://kubb.dev/" target="_blank">Documentation</a>
+    <span> · </span>
+      <a href="https://github.com/kubb-project/kubb/issues/" target="_blank">Report Bug</a>
+    <span> · </span>
+      <a href="https://github.com/kubb-project/kubb/issues/" target="_blank">Request Feature</a>
   </h4>
 </div>
-
-<br />
-
-<!-- About the Project 
-## :star2: About the Project
-
-<div align="center"> 
-  <img src="assets/screenshot.jpg" alt="screenshot" />
-</div>
--->

package/dist/index.cjs

@@ -2,9 +2,8 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
-var module$1 = require('module');
 var crypto = require('crypto');
-var fs = require('fs');
+var fs = require('fs-extra');
 var pathParser2 = require('path');
 var changeCase = require('change-case');
 var rimraf = require('rimraf');
@@ -14,10 +13,11 @@ var tsCodegen = require('@kubb/ts-codegen');
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
 var crypto__default = /*#__PURE__*/_interopDefault(crypto);
+var fs__default = /*#__PURE__*/_interopDefault(fs);
 var pathParser2__default = /*#__PURE__*/_interopDefault(pathParser2);
 var dirTree__default = /*#__PURE__*/_interopDefault(dirTree);
 
-module$1.createRequire((typeof document === 'undefined' ? require('u' + 'rl').pathToFileURL(__filename).href : (document.currentScript && document.currentScript.src || new URL('out.js', document.baseURI).href)));
+// src/managers/fileManager/FileManager.ts
 
 // src/utils/isPromise.ts
 function isPromise(result) {
@@ -25,13 +25,13 @@ function isPromise(result) {
 }
 async function safeWriteFileToPath(path, data) {
   const passedPath = pathParser2__default.default.dirname(pathParser2__default.default.resolve(path));
-  await fs.promises.mkdir(passedPath, { recursive: true });
-  return fs.promises.writeFile(pathParser2__default.default.resolve(path), data, { encoding: "utf-8" });
+  await fs__default.default.mkdir(passedPath, { recursive: true });
+  return fs__default.default.writeFile(pathParser2__default.default.resolve(path), data, { encoding: "utf-8" });
 }
 async function write(data, path) {
   try {
-    await fs.promises.stat(path);
-    const oldContent = await fs.promises.readFile(path, { encoding: "utf-8" });
+    await fs__default.default.stat(path);
+    const oldContent = await fs__default.default.readFile(path, { encoding: "utf-8" });
     if (oldContent?.toString() === data) {
       return;
     }
@@ -49,15 +49,17 @@ function createPluginCache(cache) {
     },
     get(id) {
       const item = cache[id];
-      if (!item)
+      if (!item) {
         return null;
+      }
       item[0] = 0;
       return item[1];
     },
     has(id) {
       const item = cache[id];
-      if (!item)
+      if (!item) {
         return false;
+      }
       item[0] = 0;
       return true;
     },
@@ -66,19 +68,19 @@ function createPluginCache(cache) {
     }
   };
 }
-function slash(path) {
-  const isExtendedLengthPath = /^\\\\\?\\/.test(path);
-  if (isExtendedLengthPath) {
-    return path;
+function slash(path, platform = "linux") {
+  const isWindowsPath = /^\\\\\?\\/.test(path);
+  if (["linux", "mac"].includes(platform) && !isWindowsPath) {
+    return path.replaceAll(/\\/g, "/").replace("../", "").trimEnd();
   }
-  return path.replace(/\\/g, "/");
+  return path.replaceAll(/\\/g, "/").replace("../", "").trimEnd();
 }
-function getRelativePath(rootDir, filePath) {
+function getRelativePath(rootDir, filePath, platform = "linux") {
   if (!rootDir || !filePath) {
-    throw new Error(`Root and file should be filled in when retrieving the relativePath, ${rootDir} ${filePath}`);
+    throw new Error(`Root and file should be filled in when retrieving the relativePath, ${rootDir || ""} ${filePath || ""}`);
   }
   const relativePath = pathParser2__default.default.relative(rootDir, filePath);
-  const path = slash(relativePath).replace("../", "").trimEnd();
+  const path = slash(relativePath, platform);
   if (path.startsWith("../")) {
     return path.replace(pathParser2__default.default.basename(path), pathParser2__default.default.basename(path, pathParser2__default.default.extname(filePath)));
   }
@@ -91,12 +93,7 @@ function getPathMode(path) {
   return pathParser2__default.default.extname(path) ? "file" : "directory";
 }
 async function read(path) {
-  try {
-    return fs.promises.readFile(path, { encoding: "utf8" });
-  } catch (err) {
-    console.error(err);
-    throw err;
-  }
+  return fs__default.default.readFile(path, { encoding: "utf8" });
 }
 
 // src/utils/isURL.ts
@@ -184,9 +181,10 @@ var Queue = class {
       this.work();
     });
   }
-  async work() {
-    if (this.workerCount >= this.maxParallel)
+  work() {
+    if (this.workerCount >= this.maxParallel) {
       return;
+    }
     this.workerCount++;
     let entry;
     while (entry = this.queue.shift()) {
@@ -233,10 +231,13 @@ var TreeNode = class {
     return child;
   }
   find(data) {
+    if (!data) {
+      return null;
+    }
     if (data === this.data) {
       return this;
     }
-    if (this.children) {
+    if (this.children?.length) {
       for (let i = 0, { length } = this.children, target = null; i < length; i++) {
         target = this.children[i].find(data);
         if (target) {
@@ -246,23 +247,23 @@ var TreeNode = class {
     }
     return null;
   }
-  leaves() {
+  get leaves() {
     if (!this.children || this.children.length === 0) {
       return [this];
     }
     const leaves = [];
     if (this.children) {
       for (let i = 0, { length } = this.children; i < length; i++) {
-        leaves.push.apply(leaves, this.children[i].leaves());
+        leaves.push.apply(leaves, this.children[i].leaves);
       }
     }
     return leaves;
   }
-  root() {
+  get root() {
     if (!this.parent) {
       return this;
     }
-    return this.parent.root();
+    return this.parent.root;
   }
   forEach(callback) {
     if (typeof callback !== "function") {
@@ -277,21 +278,26 @@ var TreeNode = class {
     return this;
   }
   static build(path, options = {}) {
-    const filteredTree = dirTree__default.default(path, { extensions: options?.extensions, exclude: options.exclude });
-    if (!filteredTree) {
-      return null;
-    }
-    const treeNode = new TreeNode({ name: filteredTree.name, path: filteredTree.path, type: filteredTree.type });
-    const recurse = (node, item) => {
-      const subNode = node.addChild({ name: item.name, path: item.path, type: item.type });
-      if (item.children?.length) {
-        item.children?.forEach((child) => {
-          recurse(subNode, child);
-        });
+    try {
+      const exclude = Array.isArray(options.exclude) ? options.exclude : [options.exclude].filter(Boolean);
+      const filteredTree = dirTree__default.default(path, { extensions: options.extensions, exclude: [/node_modules/, ...exclude] });
+      if (!filteredTree) {
+        return null;
       }
-    };
-    filteredTree.children?.forEach((child) => recurse(treeNode, child));
-    return treeNode;
+      const treeNode = new TreeNode({ name: filteredTree.name, path: filteredTree.path, type: filteredTree.type || getPathMode(filteredTree.path) });
+      const recurse = (node, item) => {
+        const subNode = node.addChild({ name: item.name, path: item.path, type: item.type || getPathMode(item.path) });
+        if (item.children?.length) {
+          item.children?.forEach((child) => {
+            recurse(subNode, child);
+          });
+        }
+      };
+      filteredTree.children?.forEach((child) => recurse(treeNode, child));
+      return treeNode;
+    } catch (e) {
+      throw new Error("Something went wrong with creating index files with the TreehNode class", { cause: e });
+    }
   }
 };
 
@@ -404,6 +410,9 @@ function getStackTrace(belowFn) {
   return v8StackTrace;
 }
 
+// src/utils/uniqueId.ts
+var uniqueId = ((counter) => (str = "") => `${str}${++counter}`)(0);
+
 // src/managers/fileManager/FileManager.ts
 var FileManager = class {
   cache = /* @__PURE__ */ new Map();
@@ -496,18 +505,18 @@ ${file.source}`,
     return read(...params);
   }
 };
-function writeIndexes(root, options) {
+function writeIndexes(root, options = {}) {
   const tree = TreeNode.build(root, { extensions: /\.ts/, ...options });
   if (!tree) {
-    return void 0;
+    return null;
   }
-  const fileReducer = (files2, item) => {
-    if (!item.children) {
+  const fileReducer = (files2, currentTree) => {
+    if (!currentTree.children) {
       return [];
     }
-    if (item.children?.length > 1) {
-      const path = pathParser2__default.default.resolve(item.data.path, "index.ts");
-      const exports = item.children.map((file) => {
+    if (currentTree.children?.length > 1) {
+      const path = pathParser2__default.default.resolve(currentTree.data.path, "index.ts");
+      const exports = currentTree.children.map((file) => {
         if (!file) {
           return void 0;
         }
@@ -524,8 +533,8 @@ function writeIndexes(root, options) {
         exports
       });
     } else {
-      item.children?.forEach((child) => {
-        const path = pathParser2__default.default.resolve(item.data.path, "index.ts");
+      currentTree.children?.forEach((child) => {
+        const path = pathParser2__default.default.resolve(currentTree.data.path, "index.ts");
         const importPath = child.data.type === "directory" ? `./${child.data.name}` : `./${child.data.name.replace(/\.[^.]*$/, "")}`;
         files2.push({
           path,
@@ -535,7 +544,7 @@ function writeIndexes(root, options) {
         });
       });
     }
-    item.children.forEach((childItem) => {
+    currentTree.children.forEach((childItem) => {
       fileReducer(files2, childItem);
     });
     return files2;
@@ -545,9 +554,6 @@ function writeIndexes(root, options) {
 }
 function combineFiles(files) {
   return files.filter(Boolean).reduce((acc, curr) => {
-    if (!curr) {
-      return acc;
-    }
     const prevIndex = acc.findIndex((item) => item.path === curr.path);
     if (prevIndex !== -1) {
       const prev = acc[prevIndex];
@@ -572,19 +578,19 @@ function getFileSource(file) {
   const imports = [];
   const exports = [];
   file.imports?.forEach((curr) => {
-    const exists = imports.find((imp) => imp.path === curr.path);
-    if (!exists) {
+    const existingImport = imports.find((imp) => imp.path === curr.path);
+    if (!existingImport) {
       imports.push({
         ...curr,
         name: Array.isArray(curr.name) ? [...new Set(curr.name)] : curr.name
       });
     }
-    if (exists && !Array.isArray(exists.name) && exists.name !== curr.name) {
+    if (existingImport && !Array.isArray(existingImport.name) && existingImport.name !== curr.name) {
       imports.push(curr);
     }
-    if (exists && Array.isArray(exists.name)) {
+    if (existingImport && Array.isArray(existingImport.name)) {
       if (Array.isArray(curr.name)) {
-        exists.name = [.../* @__PURE__ */ new Set([...exists.name, ...curr.name])];
+        existingImport.name = [.../* @__PURE__ */ new Set([...existingImport.name, ...curr.name])];
       }
     }
   });
@@ -610,7 +616,7 @@ function getFileSource(file) {
   }, []);
   const importSource = tsCodegen.print(importNodes);
   const exportNodes = exports.reduce((prev, curr) => {
-    return [...prev, tsCodegen.createExportDeclaration({ name: curr.name, path: curr.path, asAlias: curr.asAlias })];
+    return [...prev, tsCodegen.createExportDeclaration({ name: curr.name, path: curr.path, isTypeOnly: curr.isTypeOnly, asAlias: curr.asAlias })];
   }, []);
   const exportSource = tsCodegen.print(exportNodes);
   if (importSource) {
@@ -648,10 +654,12 @@ var definePlugin = createPlugin((options) => {
     async addFile(...files) {
       const trace = getStackTrace();
       const plugins = options.config.plugins?.filter((plugin) => trace[1].getFileName()?.includes(plugin.name)).sort((a, b) => {
-        if (a.name.length < b.name.length)
+        if (a.name.length < b.name.length) {
           return 1;
-        if (a.name.length > b.name.length)
+        }
+        if (a.name.length > b.name.length) {
           return -1;
+        }
         return 0;
       });
       const pluginName = plugins?.[0].name;
@@ -823,8 +831,9 @@ var PluginManager = class {
   }) {
     let promise = Promise.resolve(null);
     for (const plugin of this.getSortedPlugins(hookName)) {
-      if (skipped && skipped.has(plugin))
+      if (skipped && skipped.has(plugin)) {
         continue;
+      }
       promise = promise.then(async (parseResult) => {
         if (parseResult?.result != null) {
           return parseResult;
@@ -854,8 +863,9 @@ var PluginManager = class {
   }) {
     let parseResult = null;
     for (const plugin of this.getSortedPlugins(hookName)) {
-      if (skipped && skipped.has(plugin))
+      if (skipped && skipped.has(plugin)) {
         continue;
+      }
       parseResult = {
         result: this.executeSync({
           strategy: "hookFirst",
@@ -1081,7 +1091,7 @@ async function build(options) {
       await read(config.input.path);
     }
   } catch (e) {
-    throw new Error("Cannot read file defined in `input.path` or set with --input in the CLI of your Kubb config", { cause: e });
+    throw new Error("Cannot read file/URL defined in `input.path` or set with --input in the CLI of your Kubb config", { cause: e });
   }
   if (config.output.clean) {
     await clean(config.output.path);
@@ -1197,6 +1207,7 @@ exports.read = read;
 exports.renderTemplate = renderTemplate;
 exports.timeout = timeout;
 exports.transformReservedWord = transformReservedWord;
+exports.uniqueId = uniqueId;
 exports.validatePlugins = validatePlugins;
 exports.write = write;
 exports.writeIndexes = writeIndexes;

package/dist/index.d.ts

@@ -13,7 +13,7 @@ interface Cache<T extends object = object> {
 }
 declare function createPluginCache<T extends Record<string, [number, unknown]>>(cache: T): Cache<T>;
 
-declare function getRelativePath(rootDir?: string | null, filePath?: string | null): string;
+declare function getRelativePath(rootDir?: string | null, filePath?: string | null, platform?: 'windows' | 'mac' | 'linux'): string;
 type PathMode = 'file' | 'directory';
 declare function getPathMode(path: string | undefined | null): PathMode;
 declare function read(path: string): Promise<string>;
@@ -67,9 +67,9 @@ declare class TreeNode<T = unknown> {
     children: Array<TreeNode<T>>;
     constructor(data: T, parent?: TreeNode<T>);
     addChild(data: T): TreeNode<T>;
-    find(data: T): {} | null;
-    leaves(): TreeNode<T>[];
-    root(): TreeNode<T>;
+    find(data?: T): TreeNode<T> | null;
+    get leaves(): TreeNode<T>[];
+    get root(): TreeNode<T>;
     forEach(callback: (treeNode: TreeNode<T>) => void): this;
     static build<T = unknown>(path: string, options?: TreeNodeOptions): TreeNode<T> | null;
 }
@@ -78,6 +78,8 @@ declare function transformReservedWord(word?: string | null): string | null | un
 
 declare function getStackTrace(belowFn?: Function): NodeJS.CallSite[];
 
+declare const uniqueId: (str?: string) => string;
+
 type Import = {
     name: string | string[];
     path: string;
@@ -139,7 +141,7 @@ declare class FileManager {
     read(...params: Parameters<typeof read>): Promise<string>;
 }
 
-declare function writeIndexes(root: string, options: TreeNodeOptions): File[] | undefined;
+declare function writeIndexes(root: string, options?: TreeNodeOptions): File[] | null;
 declare function combineFiles(files: Array<File | null>): File[];
 declare function getFileSource(file: File): string;
 
@@ -553,4 +555,4 @@ declare abstract class SchemaGenerator<TOptions extends object, TInput, TOutput>
     abstract build(schema: TInput, name: string, description?: string): TOutput;
 }
 
-export { Argument0, BuildOutput, CLIOptions, Cache, CacheStore, CorePluginOptions, Executer, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugin, KubbObjectPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, Logger, MaybePromise, OnExecute, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, SafeParseResult, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, TreeNodeOptions, UUID, ValidationPluginError, build, clean, combineFiles, createJSDocBlockText, createPlugin, createPluginCache, build as default, defineConfig, getEncodedText, getFileSource, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, isPromise, isURL, name, nameSorter, objectToParameters, read, renderTemplate, timeout, transformReservedWord, validatePlugins, write, writeIndexes };
+export { Argument0, BuildOutput, CLIOptions, Cache, CacheStore, CorePluginOptions, Executer, File, FileManager, FileName, Generator, KubbConfig, KubbJSONPlugin, KubbObjectPlugin, KubbPlugin, KubbPluginKind, KubbUserConfig, LogLevel, Logger, MaybePromise, OnExecute, OptionalPath, ParallelPluginError, ParseResult, Path, PathMode, PluginContext, PluginError, PluginFactoryOptions, PluginLifecycle, PluginLifecycleHooks, PluginManager, Queue, QueueTask, Register, ResolveNameParams, ResolvePathParams, SafeParseResult, SchemaGenerator, Status, Strategy, TransformResult, TreeNode, TreeNodeOptions, UUID, ValidationPluginError, build, clean, combineFiles, createJSDocBlockText, createPlugin, createPluginCache, build as default, defineConfig, getEncodedText, getFileSource, getPathMode, getRelativePath, getStackTrace, getUniqueName, hooks, isPromise, isURL, name, nameSorter, objectToParameters, read, renderTemplate, timeout, transformReservedWord, uniqueId, validatePlugins, write, writeIndexes };