@kubb/core 2.0.0-alpha.5 → 2.0.0-alpha.7

package/dist/index.d.cts

@@ -477,14 +477,41 @@ type TransformResult = string | null;
 type BasePath<T extends string = string> = `${T}/`;
 declare namespace KubbFile {
     type Import = {
+        /**
+         * Import name to be used
+         * @example ["useState"]
+         * @examples "React"
+         */
         name: string | Array<string>;
+        /**
+         * Path for the import
+         * @xample '@kubb/core'
+         */
         path: string;
+        /**
+         * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`
+         */
         isTypeOnly?: boolean;
     };
     type Export = {
+        /**
+         * Export name to be used
+         * @example ["useState"]
+         * @examples "React"
+         */
         name?: string | Array<string>;
+        /**
+         * Path for the import
+         * @xample '@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;
     };
     const dataTagSymbol: unique symbol;
@@ -495,7 +522,15 @@ declare namespace KubbFile {
     type Source = string;
     type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
     type Mode = 'file' | 'directory';
+    /**
+     * 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}${Extname}`;
+    /**
+     * 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;
@@ -527,11 +562,17 @@ declare namespace KubbFile {
          * @default `false`
          */
         override?: boolean;
+        /**
+         * Use extra meta, this is getting used to generate the barrel/index files.
+         */
         meta?: TMeta;
         /**
          * This will override `process.env[key]` inside the `source`, see `getFileSource`.
          */
         env?: NodeJS.ProcessEnv;
+        /**
+         * @deprecated
+         */
         validate?: boolean;
     };
     type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = KubbFile.File<TMeta, TBaseName> & {
@@ -646,10 +687,10 @@ declare class PackageManager {
     getPackageJSON(): Promise<PackageJSON | undefined>;
     getPackageJSONSync(): PackageJSON | undefined;
     static setVersion(dependency: DependencyName, version: DependencyVersion): void;
-    getVersion(dependency: DependencyName): Promise<DependencyVersion | undefined>;
-    getVersionSync(dependency: DependencyName): DependencyVersion | undefined;
-    isValid(dependency: DependencyName, version: DependencyVersion): Promise<boolean>;
-    isValidSync(dependency: DependencyName, version: DependencyVersion): boolean;
+    getVersion(dependency: DependencyName | RegExp): Promise<DependencyVersion | undefined>;
+    getVersionSync(dependency: DependencyName | RegExp): DependencyVersion | undefined;
+    isValid(dependency: DependencyName | RegExp, version: DependencyVersion): Promise<boolean>;
+    isValidSync(dependency: DependencyName | RegExp, version: DependencyVersion): boolean;
 }
 
 type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => KubbUserPluginWithLifeCycle<T>;

package/dist/index.d.ts

@@ -477,14 +477,41 @@ type TransformResult = string | null;
 type BasePath<T extends string = string> = `${T}/`;
 declare namespace KubbFile {
     type Import = {
+        /**
+         * Import name to be used
+         * @example ["useState"]
+         * @examples "React"
+         */
         name: string | Array<string>;
+        /**
+         * Path for the import
+         * @xample '@kubb/core'
+         */
         path: string;
+        /**
+         * Add `type` prefix to the import, this will result in: `import type { Type } from './path'`
+         */
         isTypeOnly?: boolean;
     };
     type Export = {
+        /**
+         * Export name to be used
+         * @example ["useState"]
+         * @examples "React"
+         */
         name?: string | Array<string>;
+        /**
+         * Path for the import
+         * @xample '@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;
     };
     const dataTagSymbol: unique symbol;
@@ -495,7 +522,15 @@ declare namespace KubbFile {
     type Source = string;
     type Extname = '.ts' | '.js' | '.tsx' | '.json' | `.${string}`;
     type Mode = 'file' | 'directory';
+    /**
+     * 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}${Extname}`;
+    /**
+     * 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;
@@ -527,11 +562,17 @@ declare namespace KubbFile {
          * @default `false`
          */
         override?: boolean;
+        /**
+         * Use extra meta, this is getting used to generate the barrel/index files.
+         */
         meta?: TMeta;
         /**
          * This will override `process.env[key]` inside the `source`, see `getFileSource`.
          */
         env?: NodeJS.ProcessEnv;
+        /**
+         * @deprecated
+         */
         validate?: boolean;
     };
     type ResolvedFile<TMeta extends FileMetaBase = FileMetaBase, TBaseName extends BaseName = BaseName> = KubbFile.File<TMeta, TBaseName> & {
@@ -646,10 +687,10 @@ declare class PackageManager {
     getPackageJSON(): Promise<PackageJSON | undefined>;
     getPackageJSONSync(): PackageJSON | undefined;
     static setVersion(dependency: DependencyName, version: DependencyVersion): void;
-    getVersion(dependency: DependencyName): Promise<DependencyVersion | undefined>;
-    getVersionSync(dependency: DependencyName): DependencyVersion | undefined;
-    isValid(dependency: DependencyName, version: DependencyVersion): Promise<boolean>;
-    isValidSync(dependency: DependencyName, version: DependencyVersion): boolean;
+    getVersion(dependency: DependencyName | RegExp): Promise<DependencyVersion | undefined>;
+    getVersionSync(dependency: DependencyName | RegExp): DependencyVersion | undefined;
+    isValid(dependency: DependencyName | RegExp, version: DependencyVersion): Promise<boolean>;
+    isValidSync(dependency: DependencyName | RegExp, version: DependencyVersion): boolean;
 }
 
 type KubbPluginFactory<T extends PluginFactoryOptions = PluginFactoryOptions> = (options: T['options']) => KubbUserPluginWithLifeCycle<T>;

package/dist/index.js

@@ -198,10 +198,13 @@ var URLPath = class {
       params: this.getParams()
     };
     if (stringify) {
-      if (type !== "template") {
-        throw new Error("Type should be `template` when using stringiyf");
+      if (type === "template") {
+        return JSON.stringify(object).replaceAll("'", "").replaceAll(`"`, "");
       }
-      return JSON.stringify(object).replaceAll("'", "").replaceAll(`"`, "");
+      if (object.params) {
+        return `{ url: '${object.url}', params: ${JSON.stringify(object.params).replaceAll("'", "").replaceAll(`"`, "")} }`;
+      }
+      return `{ url: '${object.url}' }`;
     }
     return object;
   }
@@ -1804,9 +1807,10 @@ var Generator = class {
 };
 _options3 = new WeakMap();
 _context = new WeakMap();
-var _cache2, _cwd, _SLASHES;
+var _cache2, _cwd, _SLASHES, _match, match_fn;
 var _PackageManager = class _PackageManager {
   constructor(workspace) {
+    __privateAdd(this, _match);
     __privateAdd(this, _cwd, void 0);
     __privateAdd(this, _SLASHES, /* @__PURE__ */ new Set(["/", "\\"]));
     if (workspace) {
@@ -1869,24 +1873,24 @@ var _PackageManager = class _PackageManager {
     __privateGet(_PackageManager, _cache2)[dependency] = version;
   }
   async getVersion(dependency) {
-    if (__privateGet(_PackageManager, _cache2)[dependency]) {
+    if (typeof dependency === "string" && __privateGet(_PackageManager, _cache2)[dependency]) {
       return __privateGet(_PackageManager, _cache2)[dependency];
     }
     const packageJSON = await this.getPackageJSON();
     if (!packageJSON) {
       return void 0;
     }
-    return packageJSON["dependencies"]?.[dependency] || packageJSON["devDependencies"]?.[dependency];
+    return __privateMethod(this, _match, match_fn).call(this, packageJSON, dependency);
   }
   getVersionSync(dependency) {
-    if (__privateGet(_PackageManager, _cache2)[dependency]) {
+    if (typeof dependency === "string" && __privateGet(_PackageManager, _cache2)[dependency]) {
       return __privateGet(_PackageManager, _cache2)[dependency];
     }
     const packageJSON = this.getPackageJSONSync();
     if (!packageJSON) {
       return void 0;
     }
-    return packageJSON["dependencies"]?.[dependency] || packageJSON["devDependencies"]?.[dependency];
+    return __privateMethod(this, _match, match_fn).call(this, packageJSON, dependency);
   }
   async isValid(dependency, version) {
     const packageVersion = await this.getVersion(dependency);
@@ -1917,6 +1921,18 @@ var _PackageManager = class _PackageManager {
 _cache2 = new WeakMap();
 _cwd = new WeakMap();
 _SLASHES = new WeakMap();
+_match = new WeakSet();
+match_fn = function(packageJSON, dependency) {
+  const dependencies = {
+    ...packageJSON["dependencies"] || {},
+    ...packageJSON["devDependencies"] || {}
+  };
+  if (typeof dependency === "string" && dependencies[dependency]) {
+    return dependencies[dependency];
+  }
+  const matchedDependency = Object.keys(dependencies).find((dep) => dep.match(dependency));
+  return matchedDependency ? dependencies[matchedDependency] : void 0;
+};
 __privateAdd(_PackageManager, _cache2, {});
 var PackageManager = _PackageManager;