@entur/utils 0.12.4 → 0.12.5

package/dist/ConditionalWrapper.d.ts

@@ -0,0 +1,7 @@
+type ConditionalWrapperType = {
+    condition: boolean;
+    wrapper: any;
+    children: any;
+};
+export declare const ConditionalWrapper: ({ condition, wrapper, children, }: ConditionalWrapperType) => any;
+export {};

package/dist/PolymorphicComponent.d.ts

@@ -0,0 +1,38 @@
+import { default as React } from 'react';
+export type PropsOf<C extends keyof JSX.IntrinsicElements | React.JSXElementConstructor<any>> = JSX.LibraryManagedAttributes<C, React.ComponentPropsWithoutRef<C>>;
+type AsProp<C extends React.ElementType> = {
+    /**
+     * An override of the default HTML tag.
+     * Can also be another React component.
+     */
+    as?: C;
+};
+/**
+ * Allows for extending a set of props (`ExtendedProps`) by an overriding set of props
+ * (`OverrideProps`), ensuring that any duplicates are overridden by the overriding
+ * set of props.
+ */
+export type ExtendableProps<ExtendedProps = Record<string, unknown>, OverrideProps = Record<string, unknown>> = OverrideProps & Omit<ExtendedProps, keyof OverrideProps>;
+/**
+ * Allows for inheriting the props from the specified element type so that
+ * props like children, className & style work, as well as element-specific
+ * attributes like aria roles. The component (`C`) must be passed in.
+ */
+export type InheritableElementProps<C extends React.ElementType, Props = Record<string, unknown>> = ExtendableProps<PropsOf<C>, Props>;
+/**
+ * A more sophisticated version of `InheritableElementProps` where
+ * the passed in `as` prop will determine which props can be included
+ */
+export type PolymorphicComponentProps<C extends React.ElementType, Props = Record<string, unknown>> = InheritableElementProps<C, Props & AsProp<C>>;
+/**
+ * Utility type to extract the `ref` prop from a polymorphic component
+ */
+export type PolymorphicRef<C extends React.ElementType> = React.ComponentPropsWithRef<C>['ref'];
+/**
+ * A wrapper of `PolymorphicComponentProps` that also includes the `ref`
+ * prop for the polymorphic component
+ */
+export type PolymorphicComponentPropsWithRef<C extends React.ElementType, Props = Record<string, unknown>> = PolymorphicComponentProps<C, Props> & {
+    ref?: PolymorphicRef<C>;
+};
+export {};

package/dist/getNodeText.d.ts

@@ -0,0 +1 @@
+export declare const getNodeText: (node: React.ReactNode | string | number | string[] | number[]) => string;

package/dist/index.d.ts

@@ -1,82 +1,13 @@
-import { default as default_2 } from 'react';
-
-declare type AsProp<C extends default_2.ElementType> = {
-    /**
-     * An override of the default HTML tag.
-     * Can also be another React component.
-     */
-    as?: C;
-};
-
-export declare const ConditionalWrapper: ({ condition, wrapper, children, }: ConditionalWrapperType) => any;
-
-declare type ConditionalWrapperType = {
-    condition: boolean;
-    wrapper: any;
-    children: any;
-};
-
-/**
- * Allows for extending a set of props (`ExtendedProps`) by an overriding set of props
- * (`OverrideProps`), ensuring that any duplicates are overridden by the overriding
- * set of props.
- */
-export declare type ExtendableProps<ExtendedProps = Record<string, unknown>, OverrideProps = Record<string, unknown>> = OverrideProps & Omit<ExtendedProps, keyof OverrideProps>;
-
-export declare const getNodeText: (node: React.ReactNode | string | number | string[] | number[]) => string;
-
-/**
- * Allows for inheriting the props from the specified element type so that
- * props like children, className & style work, as well as element-specific
- * attributes like aria roles. The component (`C`) must be passed in.
- */
-export declare type InheritableElementProps<C extends default_2.ElementType, Props = Record<string, unknown>> = ExtendableProps<PropsOf<C>, Props>;
-
-export declare const mergeRefs: <T extends HTMLElement>(...refs: (React.MutableRefObject<T> | React.ForwardedRef<T> | ((node: T | null) => void) | undefined)[]) => (node: T) => void;
-
-/**
- * A more sophisticated version of `InheritableElementProps` where
- * the passed in `as` prop will determine which props can be included
- */
-export declare type PolymorphicComponentProps<C extends default_2.ElementType, Props = Record<string, unknown>> = InheritableElementProps<C, Props & AsProp<C>>;
-
-/**
- * A wrapper of `PolymorphicComponentProps` that also includes the `ref`
- * prop for the polymorphic component
- */
-export declare type PolymorphicComponentPropsWithRef<C extends default_2.ElementType, Props = Record<string, unknown>> = PolymorphicComponentProps<C, Props> & {
-    ref?: PolymorphicRef<C>;
-};
-
-/**
- * Utility type to extract the `ref` prop from a polymorphic component
- */
-export declare type PolymorphicRef<C extends default_2.ElementType> = default_2.ComponentPropsWithRef<C>['ref'];
-
-export declare type PropsOf<C extends keyof JSX.IntrinsicElements | default_2.JSXElementConstructor<any>> = JSX.LibraryManagedAttributes<C, default_2.ComponentPropsWithoutRef<C>>;
-
-export declare function useDebounce<T extends (...args: any[]) => any>(callBack: T, debounceTime: number): T;
-
-export declare const useForceUpdate: () => () => void;
-
-export declare const useOnClickOutside: (refs: (default_2.RefObject<HTMLElement> | default_2.MutableRefObject<any>)[], handler: () => void) => void;
-
-export declare const useOnEscape: (ref: default_2.RefObject<any> | default_2.MutableRefObject<any>, handler: () => void) => void;
-
-export declare function useOnMount(callback: () => void): void;
-
-export declare const useRandomId: (prefix?: string) => string;
-
-export declare const useWindowDimensions: () => WindowDimensions;
-
-export declare type VariantType = 'success' | 'negative' | 'warning' | 'information';
-
-/** Warns the developer if they have forgotten to include styles */
-export declare function warnAboutMissingStyles(...namespaces: string[]): void;
-
-declare type WindowDimensions = {
-    width: number | undefined;
-    height: number | undefined;
-};
-
-export { }
+export * from './PolymorphicComponent';
+export * from './useDebounce';
+export * from './useRandomId';
+export * from './useOnMount';
+export * from './mergeRefs';
+export * from './useForceUpdate';
+export * from './useOnClickOutside';
+export * from './useOnEscape';
+export * from './useWindowDimensions';
+export * from './ConditionalWrapper';
+export * from './warnAboutMissingStyles';
+export * from './types/variants';
+export * from './getNodeText';

package/dist/mergeRefs.d.ts

@@ -0,0 +1 @@
+export declare const mergeRefs: <T extends HTMLElement>(...refs: (React.MutableRefObject<T> | React.ForwardedRef<T> | ((node: T | null) => void) | undefined)[]) => (node: T) => void;

package/dist/types/variants.d.ts

@@ -0,0 +1 @@
+export type VariantType = 'success' | 'negative' | 'warning' | 'information';

package/dist/useDebounce.d.ts

@@ -0,0 +1 @@
+export declare function useDebounce<T extends (...args: any[]) => any>(callBack: T, debounceTime: number): T;

package/dist/useForceUpdate.d.ts

@@ -0,0 +1 @@
+export declare const useForceUpdate: () => () => void;

package/dist/useOnClickOutside.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const useOnClickOutside: (refs: (React.RefObject<HTMLElement> | React.MutableRefObject<any>)[], handler: () => void) => void;

package/dist/useOnEscape.d.ts

@@ -0,0 +1,2 @@
+import { default as React } from 'react';
+export declare const useOnEscape: (ref: React.RefObject<any> | React.MutableRefObject<any>, handler: () => void) => void;

package/dist/useOnMount.d.ts

@@ -0,0 +1 @@
+export declare function useOnMount(callback: () => void): void;

package/dist/useRandomId.d.ts

@@ -0,0 +1 @@
+export declare const useRandomId: (prefix?: string) => string;

package/dist/useWindowDimensions.d.ts

@@ -0,0 +1,6 @@
+type WindowDimensions = {
+    width: number | undefined;
+    height: number | undefined;
+};
+export declare const useWindowDimensions: () => WindowDimensions;
+export {};

package/dist/warnAboutMissingStyles.d.ts

@@ -0,0 +1,2 @@
+/** Warns the developer if they have forgotten to include styles */
+export declare function warnAboutMissingStyles(...namespaces: string[]): void;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@entur/utils",
-  "version": "0.12.4",
+  "version": "0.12.5",
   "license": "EUPL-1.2",
   "main": "dist/utils.cjs.js",
   "module": "dist/utils.esm.js",
@@ -41,5 +41,5 @@
     "vite": "^7.1.3",
     "vite-plugin-dts": "^4.5.4"
   },
-  "gitHead": "268fb2f3387485206586a7c4c6f2a058f824f5d6"
+  "gitHead": "5dd9d318f1d79f6f522f978de27b551fda1e91cc"
 }