@kubb/react - npm Package Compare versions

Comparing version 2.0.0-canary.20231030T125023 to 2.0.0

dist/components.d.ts

@@ -0,60 +1,34 @@
+import { K as KubbNode, J as JSDoc } from './types-a3eQOXoX.js';
+export { A as AppContextProps } from './types-a3eQOXoX.js';
 import { KubbFile } from '@kubb/core';
 import * as react from 'react';
-import { ReactNode, Key } from 'react';
 
-type AppContextProps<Meta extends Record<string, unknown> = Record<string, unknown>> = {
-    meta: Meta;
+type Props$5 = KubbFile.Import & {
+    /**
+     * When true, it will return the generated import.
+     * When false, it will add the import to a KubbFile instance(see fileManager).
+     */
+    print?: boolean;
 };
+declare function Import({ name, root, path, isTypeOnly, isNameSpace, print }: Props$5): KubbNode;
 
-declare global {
-    namespace JSX {
-        interface IntrinsicElements {
-            'kubb-text': {
-                children?: ReactNode;
-                key?: Key;
-            };
-            'kubb-file': {
-                id?: string;
-                children?: ReactNode;
-                key?: Key;
-                baseName: string;
-                path: string;
-                env?: NodeJS.ProcessEnv;
-                override?: boolean;
-            };
-            'kubb-source': {
-                children?: ReactNode;
-                key?: Key;
-                path?: string;
-                print?: boolean;
-                removeComments?: boolean;
-                noEmitHelpers?: boolean;
-            };
-            'kubb-import': KubbFile.Import & {
-                print?: boolean;
-            };
-            'kubb-export': KubbFile.Export & {
-                print?: boolean;
-            };
-        }
-    }
-}
-type KubbNode = ReactNode;
-
 type Props$4 = KubbFile.Export & {
+    /**
+     * When true, it will return the generated import.
+     * When false, it will add the import to a KubbFile instance(see fileManager)
+     */
     print?: boolean;
 };
-declare function Export({ name, path, isTypeOnly, asAlias, print: printExport }: Props$4): KubbNode;
+declare function Export({ name, path, isTypeOnly, asAlias, print }: Props$4): KubbNode;
 
-type Props$3 = KubbFile.Import & {
-    print?: boolean;
+type BasePropsWithBaseName = {
     /**
-     * When root is set it will get the path with relative getRelativePath(root, path)
+     * 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
      */
-    root?: string;
-};
-declare function Import({ name, root, path, isTypeOnly, print: printImport }: Props$3): KubbNode;
-
-type BasePropsWithBaseName = {
     baseName: KubbFile.BaseName;
+    /**
+     * Path will be full qualified path to a specified file.
+     */
     path: KubbFile.Path;
@@ -64,12 +38,28 @@ };
     baseName?: never;
+    /**
+     * Path will be full qualified path to a specified file.
+     */
     path?: KubbFile.Path;
 };
 type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName;
-type Props$2 = BaseProps & {
-    id?: string;
-    env?: NodeJS.ProcessEnv;
+type Props$3<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase> = BaseProps & {
+    /**
+     * Unique identifier to reuse later.
+     * @default crypto.randomUUID()
+     */
+    id?: KubbFile.File['id'];
+    /**
+     * This will override `process.env[key]` inside the `source`, see `getFileSource`.
+     */
+    env?: KubbFile.File['env'];
+    /**
+     * This will call fileManager.add instead of fileManager.addOrAppend, adding the source when the files already exists.
+     * This will also ignore the combinefiles utils
+     * @default `false`
+     */
+    override?: KubbFile.File['override'];
+    meta?: TMeta;
     children?: KubbNode;
-    override?: boolean;
 };
-declare function File(props: Props$2): KubbNode;
+declare function File<TMeta extends KubbFile.FileMetaBase = KubbFile.FileMetaBase>(props: Props$3<TMeta>): KubbNode;
 declare namespace File {
@@ -82,3 +72,3 @@ var Export: typeof Export;
     /**
-     * When path is set it will copy-paste that file as a string inside the component
+     * When path is set it will copy-paste that file as a string inside the component.
      * Children will then be ignored
@@ -90,3 +80,3 @@ */
     /**
-     * When path is set it will copy-paste that file as a string inside the component
+     * When path is set it will copy-paste that file as a string inside the component.
      * Children will then be ignored
@@ -98,28 +88,58 @@ */
 type FileSourceProps = FileSourceUnionProps & {
+    /**
+     * When true, it will return the generated import.
+     * When false, it will add the import to a KubbFile instance(see fileManager).
+     */
     print?: boolean;
     /**
-     * Removes comments
+     * Removes comments.
      */
     removeComments?: boolean;
+    /**
+     * When set it can override the print of the TypeScript compiler.
+     */
     noEmitHelpers?: boolean;
 };
-declare function FileSource({ path, print, removeComments, children }: FileSourceProps): KubbNode;
+declare function FileSource({ path, print, removeComments, noEmitHelpers, children }: FileSourceProps): KubbNode;
 
-type Props$1 = {
+type Props$2 = {
+    /**
+     * Name of the function.
+     */
     name: string;
+    /**
+     * Parameters/options/props that need to be used.
+     */
+    params?: string;
+    /**
+     * Does this function need to be exported.
+     */
     export?: boolean;
+    /**
+     * Does the function has async/promise behaviour.
+     * This will also add `Promise<returnType>` as the returnType.
+     */
     async?: boolean;
+    /**
+     * Generics that needs to be added for TypeScript.
+     */
     generics?: string | string[];
-    params?: string;
+    /**
+     * ReturnType(see async for adding Promise type).
+     */
     returnType?: string;
+    /**
+     * Options for JSdocs.
+     */
+    JSDoc?: JSDoc;
     children?: KubbNode;
-    JSDoc?: {
-        comments: string[];
-    };
 };
-declare function Function({ name, export: canExport, async, generics, params, returnType, JSDoc, children }: Props$1): KubbNode;
+declare function Function({ name, export: canExport, async, generics, params, returnType, JSDoc, children }: Props$2): KubbNode;
 declare namespace Function {
     var Arrow: typeof ArrowFunction;
 }
-type ArrowFunctionProps = Props$1 & {
+type ArrowFunctionProps = Props$2 & {
+    /**
+     * Create Arrow function in one line
+     */
     singleLine?: boolean;
@@ -129,11 +149,39 @@ };
 
-type Props = {
+type Props$1 = {
+    /**
+     * Change the indent.
+     * @default 0
+     */
+    indentSize?: number;
     children?: KubbNode;
-    indentSize?: number;
 };
-declare function Text({ indentSize, children }: Props): KubbNode;
+declare function Text({ indentSize, children }: Props$1): KubbNode;
 declare namespace Text {
-    var Space: ({ indentSize }: Omit<Props, "children">) => react.ReactNode;
+    var Space: ({ size }: SpaceProps) => react.ReactNode;
 }
+type SpaceProps = {
+    /**
+     * Change the indent
+     * @default 1
+     */
+    size?: number;
+};
 
-export { AppContextProps, Export, File, Function, Import, Text };
+type Props = {
+    /**
+     * Name of the type, this needs to start with a capital letter.
+     */
+    name: string;
+    /**
+     * Does this type need to be exported.
+     */
+    export?: boolean;
+    /**
+     * Options for JSdocs.
+     */
+    JSDoc?: JSDoc;
+    children?: KubbNode;
+};
+declare function Type({ name, export: canExport, JSDoc, children }: Props): KubbNode;
+
+export { File, Function, Text, Type };

dist/hooks.d.ts

@@ -1,27 +0,45 @@
-import { FileManager, PluginManager } from '@kubb/core';
+import { A as AppContextProps, K as KubbNode } from './types-a3eQOXoX.js';
+import { KubbFile, KubbPlugin, FileManager, PluginFactoryOptions, PluginManager, ResolveNameParams, ResolvePathParams } from '@kubb/core';
+import 'react';
 
-type AppContextProps<Meta extends Record<string, unknown> = Record<string, unknown>> = {
-    meta: Meta;
+declare function useApp<Meta extends Record<string, unknown> = Record<string, unknown>>(): AppContextProps<Meta>;
+
+type Props$4<TOptions = object> = {
+    name: string;
+    pluginKey: KubbPlugin['key'];
+    options?: TOptions;
 };
+declare function useFile<TOptions = object>({ name, pluginKey, options }: Props$4<TOptions>): KubbFile.File<{
+    pluginKey: KubbPlugin['key'];
+}>;
 
-declare function useApp<Meta extends Record<string, unknown> = Record<string, unknown>>(): AppContextProps<Meta>;
-
 declare function useFileManager(): FileManager;
 
-type Props$1 = {
+type Props$3 = {
+    /**
+     * Size to use for the indenting
+     */
     size: number;
-    children?: React.ReactNode;
+    children?: KubbNode;
 };
-declare function useIndent({ size, children }: Props$1): React.ReactNode;
+declare function useIndent({ size, children }: Props$3): KubbNode;
 
 declare function useMeta<Meta extends Record<string, unknown> = Record<string, unknown>>(): AppContextProps<Meta>['meta'];
 
-type Props = {
+type Props$2 = {
     dependency: string;
     version: string;
 };
-declare function usePackageVersion({ dependency, version }: Props): boolean;
+declare function usePackageVersion({ dependency, version }: Props$2): boolean;
 
+declare function usePlugin<TOptions extends PluginFactoryOptions = PluginFactoryOptions>(): KubbPlugin<TOptions>;
+
 declare function usePluginManager(): PluginManager;
 
-export { useApp, useFileManager, useIndent, useMeta, usePackageVersion, usePluginManager };
+type Props$1 = ResolveNameParams;
+declare function useResolveName(props: Props$1): string;
+
+type Props = ResolvePathParams;
+declare function useResolvePath(props: Props): KubbFile.OptionalPath;
+
+export { useApp, useFile, useFileManager, useIndent, useMeta, usePackageVersion, usePlugin, usePluginManager, useResolveName, useResolvePath };

dist/index.d.ts

@@ -1,212 +0,15 @@
-import { Logger } from '@kubb/core/utils';
-import { KubbFile, FileManager, PluginManager } from '@kubb/core';
-import * as react from 'react';
-import { ReactNode, Key } from 'react';
+import * as _kubb_core_transformers from '@kubb/core/transformers';
+export { R as RootType, c as createRoot } from './createRoot-bRZ9kv3w.js';
+export { A as AppContextProps, b as DOMElement, a as DOMNode, D as DOMNodeAttribute, E as ElementNames, J as JSDoc, K as KubbNode, N as Node, c as NodeNames, T as TextNode } from './types-a3eQOXoX.js';
+export { File, Function, Text, Type } from './components.js';
+export { useApp, useFile, useFileManager, useIndent, useMeta, usePackageVersion, usePlugin, usePluginManager, useResolveName, useResolvePath } from './hooks.js';
+import '@kubb/core/logger';
+import '@kubb/core';
+import 'react';
 
-declare function createIndent$1(size: number): string;
-
-type AppContextProps<Meta extends Record<string, unknown> = Record<string, unknown>> = {
-    meta: Meta;
-};
-
-type ReactElementNames = 'br';
-declare global {
-    namespace JSX {
-        interface IntrinsicElements {
-            'kubb-text': {
-                children?: ReactNode;
-                key?: Key;
-            };
-            'kubb-file': {
-                id?: string;
-                children?: ReactNode;
-                key?: Key;
-                baseName: string;
-                path: string;
-                env?: NodeJS.ProcessEnv;
-                override?: boolean;
-            };
-            'kubb-source': {
-                children?: ReactNode;
-                key?: Key;
-                path?: string;
-                print?: boolean;
-                removeComments?: boolean;
-                noEmitHelpers?: boolean;
-            };
-            'kubb-import': KubbFile.Import & {
-                print?: boolean;
-            };
-            'kubb-export': KubbFile.Export & {
-                print?: boolean;
-            };
-        }
-    }
-}
-type ElementNames = ReactElementNames | 'kubb-text' | 'kubb-file' | 'kubb-source' | 'kubb-import' | 'kubb-export' | 'kubb-root' | 'kubb-app';
-type Node = {
-    parentNode: DOMElement | undefined;
-    internal_static?: boolean;
-};
-type DOMNodeAttribute = boolean | string | number;
-type TextName = '#text';
-type TextNode = {
-    nodeName: TextName;
-    nodeValue: string;
-} & Node;
-type DOMNode<T = {
-    nodeName: NodeNames;
-}> = T extends {
-    nodeName: infer U;
-} ? U extends '#text' ? TextNode : DOMElement : never;
-type OutputTransformer = (s: string, index: number) => string;
-type DOMElement = {
-    nodeName: ElementNames;
-    attributes: Record<string, DOMNodeAttribute>;
-    childNodes: DOMNode[];
-    internal_transform?: OutputTransformer;
-    isStaticDirty?: boolean;
-    staticNode?: DOMElement;
-    onComputeLayout?: () => void;
-    onRender?: () => void;
-    onImmediateRender?: () => void;
-} & Node;
-type NodeNames = ElementNames | TextName;
-type KubbNode = ReactNode;
-
-type RootType<T = unknown> = {
-    render(children: ReactNode, context?: T): void;
-    unmount(): void;
-    output: string;
-    /**
-     * @deprecated
-     * Use Files instead
-     * File will include all sources combined
-     */
-    file?: KubbFile.File;
-    files: KubbFile.File[];
-    getFile: (id: string) => KubbFile.File | undefined;
-};
-
-type Props$7 = {
-    container?: DOMElement;
-    logger?: Logger;
-};
-declare function createRoot<Context extends AppContextProps = AppContextProps>({ container, logger }?: Props$7): RootType<Context>;
-
-type Props$6 = KubbFile.Export & {
-    print?: boolean;
-};
-declare function Export({ name, path, isTypeOnly, asAlias, print: printExport }: Props$6): KubbNode;
-
-type Props$5 = KubbFile.Import & {
-    print?: boolean;
-    /**
-     * When root is set it will get the path with relative getRelativePath(root, path)
-     */
-    root?: string;
-};
-declare function Import({ name, root, path, isTypeOnly, print: printImport }: Props$5): KubbNode;
-
-type BasePropsWithBaseName = {
-    baseName: KubbFile.BaseName;
-    path: KubbFile.Path;
-};
-type BasePropsWithoutBaseName = {
-    baseName?: never;
-    path?: KubbFile.Path;
-};
-type BaseProps = BasePropsWithBaseName | BasePropsWithoutBaseName;
-type Props$4 = BaseProps & {
-    id?: string;
-    env?: NodeJS.ProcessEnv;
-    children?: KubbNode;
-    override?: boolean;
-};
-declare function File(props: Props$4): KubbNode;
-declare namespace File {
-    var Export: typeof Export;
-    var Import: typeof Import;
-    var Source: typeof FileSource;
-}
-type FileSourceUnionProps = {
-    /**
-     * When path is set it will copy-paste that file as a string inside the component
-     * Children will then be ignored
-     */
-    path?: string;
-    children?: never;
-} | {
-    /**
-     * When path is set it will copy-paste that file as a string inside the component
-     * Children will then be ignored
-     */
-    path?: never;
-    children?: KubbNode;
-};
-type FileSourceProps = FileSourceUnionProps & {
-    print?: boolean;
-    /**
-     * Removes comments
-     */
-    removeComments?: boolean;
-    noEmitHelpers?: boolean;
-};
-declare function FileSource({ path, print, removeComments, children }: FileSourceProps): KubbNode;
-
-type Props$3 = {
-    name: string;
-    export?: boolean;
-    async?: boolean;
-    generics?: string | string[];
-    params?: string;
-    returnType?: string;
-    children?: KubbNode;
-    JSDoc?: {
-        comments: string[];
-    };
-};
-declare function Function({ name, export: canExport, async, generics, params, returnType, JSDoc, children }: Props$3): KubbNode;
-declare namespace Function {
-    var Arrow: typeof ArrowFunction;
-}
-type ArrowFunctionProps = Props$3 & {
-    singleLine?: boolean;
-};
-declare function ArrowFunction({ name, export: canExport, async, generics, params, returnType, JSDoc, singleLine, children }: ArrowFunctionProps): KubbNode;
-
-type Props$2 = {
-    children?: KubbNode;
-    indentSize?: number;
-};
-declare function Text({ indentSize, children }: Props$2): KubbNode;
-declare namespace Text {
-    var Space: ({ indentSize }: Omit<Props$2, "children">) => react.ReactNode;
-}
-
-declare function useApp<Meta extends Record<string, unknown> = Record<string, unknown>>(): AppContextProps<Meta>;
-
-declare function useFileManager(): FileManager;
-
-type Props$1 = {
-    size: number;
-    children?: React.ReactNode;
-};
-declare function useIndent({ size, children }: Props$1): React.ReactNode;
-
-declare function useMeta<Meta extends Record<string, unknown> = Record<string, unknown>>(): AppContextProps<Meta>['meta'];
-
-type Props = {
-    dependency: string;
-    version: string;
-};
-declare function usePackageVersion({ dependency, version }: Props): boolean;
-
-declare function usePluginManager(): PluginManager;
-
 /**
  * @deprecated use `@kubb/core/utils' import instead
  */
-declare const createIndent: typeof createIndent$1;
+declare const createIndent: typeof _kubb_core_transformers.createIndent;
 
-export { AppContextProps, DOMElement, DOMNode, DOMNodeAttribute, ElementNames, Export, File, Function, Import, KubbNode, Node, NodeNames, RootType, Text, TextNode, createIndent, createRoot, useApp, useFileManager, useIndent, useMeta, usePackageVersion, usePluginManager };
+export { createIndent };

dist/jsx-runtime.d.ts

 import { KubbFile } from '@kubb/core';
 import { ReactNode, Key } from 'react';
 
+/**
+ * TODO add for Server Components
+ * import type {} from 'react/experimental'
+ */
 declare global {
@@ -19,2 +23,3 @@ namespace JSX {
                 override?: boolean;
+                meta?: KubbFile.File['meta'];
             };
@@ -41,3 +46,4 @@ 'kubb-source': {
 declare const jsxs: any;
+declare const jsxDEV: any;
 
-export { Fragment, jsx, jsxs };
+export { Fragment, jsx, jsxDEV, jsxs };

package.json

 {
   "name": "@kubb/react",
-  "version": "2.0.0-canary.20231030T125023",
+  "version": "2.0.0",
   "description": "Generator react",
@@ -32,2 +32,7 @@ "keywords": [
     },
+    "./jsx-dev-runtime": {
+      "import": "./dist/jsx-runtime.js",
+      "require": "./dist/jsx-runtime.cjs",
+      "default": "./dist/jsx-runtime.cjs"
+    },
     "./client": {
@@ -49,2 +54,3 @@ "import": "./dist/client/index.js",
   "files": [
+    "src",
     "dist",
@@ -57,15 +63,16 @@ "*.d.ts",
   "dependencies": {
-    "@kubb/core": "canary",
-    "@kubb/parser": "canary"
+    "@kubb/core": "2.0.0",
+    "@kubb/parser": "2.0.0"
   },
   "devDependencies": {
-    "@kubb/eslint-config": "canary",
-    "@kubb/ts-config": "canary",
-    "@kubb/tsup-config": "canary",
-    "@types/react": "^18.2.33",
-    "@types/react-reconciler": "^0.28.6",
-    "eslint": "^8.52.0",
+    "@types/react": "^18.2.42",
+    "@types/react-reconciler": "^0.28.8",
+    "eslint": "^8.55.0",
     "react": "^18.2.0",
     "react-reconciler": "^0.29.0",
-    "tsup": "^7.2.0"
+    "tsup": "^8.0.1",
+    "typescript": "^5.3.3",
+    "@kubb/eslint-config": "1.1.8",
+    "@kubb/ts-config": "0.1.0",
+    "@kubb/tsup-config": "1.1.8"
   },
@@ -88,3 +95,2 @@ "packageManager": "pnpm@8.3.0",
     "release:canary": "bash ../../.github/canary.sh && node ../../scripts/build.js canary && pnpm publish --no-git-check -tag canary",
-    "release:alpha": "bash ../../.github/canary.sh && node ../../scripts/build.js alpha && pnpm publish --no-git-check -tag alpha",
     "start": "tsup --watch",
@@ -91,0 +97,0 @@ "test": "vitest --passWithNoTests",

README.md

@@ -21,3 +21,3 @@ <div align="center">
 <h4>
-    <a href="https://codesandbox.io/s/github/kubb-project/kubb/tree/main/examples/typescript" target="_blank">View Demo</a>
+    <a href="https://codesandbox.io/s/github/kubb-project/kubb/tree/alpha/examples/typescript" target="_blank">View Demo</a>
     <span> · </span>
@@ -24,0 +24,0 @@ <a href="https://kubb.dev/" target="_blank">Documentation</a>

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of package files

103

increased by164.1%

Number of low quality alerts

1

decreased by-50%

Number of low supply chain risk alerts

27

decreased by-64%

Worsened metrics

Total package byte prevSize

5306231

decreased by-69.39%

Dev dependency count

10

increased by11.11%

Lines of code

52799

decreased by-68.65%

Number of medium supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Added@kubb/core@2.0.0(transitive)

• + Added@kubb/parser@2.0.0(transitive)

• + Added@kubb/types@2.0.0(transitive)

• + Addedansi-styles@3.2.1(transitive)

• + Addedarray-back@3.1.04.0.2(transitive)

• + Addedchalk@2.4.2(transitive)

• + Addedcolor-convert@1.9.3(transitive)

• + Addedcolor-name@1.1.3(transitive)

• + Addedcommand-line-args@5.2.1(transitive)

• + Addedcommand-line-usage@6.1.3(transitive)

• + Addeddeep-extend@0.6.0(transitive)

• + Addeddirectory-tree@3.5.2(transitive)

• + Addedescape-string-regexp@1.0.5(transitive)

• + Addedfind-replace@3.0.0(transitive)

• + Addedhas-flag@3.0.0(transitive)

• + Addedjs-runtime@0.0.7(transitive)

• + Addedlodash.camelcase@4.3.0(transitive)

• + Addednatural-orderby@3.0.2(transitive)

• + Addedreduce-flatten@2.0.0(transitive)

• + Addedsupports-color@5.5.0(transitive)

• + Addedtable-layout@1.0.2(transitive)

• + Addedtypical@4.0.05.2.0(transitive)

• + Addedwordwrapjs@4.0.1(transitive)

• - Removed@kubb/core@0.0.0-canary-20241214150347(transitive)

• - Removed@kubb/fs@0.0.0-canary-20241214150347(transitive)

• - Removed@kubb/parser@0.0.0-canary-20240505144441(transitive)

• - Removed@kubb/parser-ts@0.0.0-canary-20241214150347(transitive)

• - Removed@kubb/types@0.0.0-canary-20241214150347(transitive)

• - Removedjs-runtime@0.0.8(transitive)

• - Removednatural-orderby@5.0.0(transitive)

• - Removedobject-hash@3.0.0(transitive)

• - Removedprettier@3.4.2(transitive)

• - Removedremeda@1.61.02.18.0(transitive)

• - Removedtype-fest@4.30.2(transitive)

• Updated@kubb/core@2.0.0

• Updated@kubb/parser@2.0.0