@necto-react/types 2.3.0 → 2.4.1

package/dist/index.cjs

@@ -0,0 +1 @@
+"use strict";var r=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var s=(o,e,m,t)=>{if(e&&typeof e=="object"||typeof e=="function")for(let p of x(e))!y.call(o,p)&&p!==m&&r(o,p,{get:()=>e[p],enumerable:!(t=f(e,p))||t.enumerable});return o};var n=o=>s(r({},"__esModule",{value:!0}),o);var c={};module.exports=n(c);

package/dist/index.d.cts

@@ -0,0 +1,286 @@
+import { AriaAttributes, DOMAttributes as DOMAttributes$1, AriaRole, CSSProperties, HTMLAttributeAnchorTarget, HTMLAttributeReferrerPolicy, ReactNode, SyntheticEvent, FocusEvent, ForwardedRef } from 'react';
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+
+
+/**
+ * Props for DOM elements that may require an id.
+ */
+interface DOMProps {
+  /** The unique id for the DOM element. */
+  id?: string | undefined;
+}
+
+/**
+ * Props for focusable DOM elements, extending basic DOM props.
+ */
+interface FocusableDOMProps extends DOMProps {
+  /**
+   * Whether the element should be excluded from the tab order.
+   */
+  excludeFromTabOrder?: boolean;
+}
+
+/**
+ * Standard DOM attributes for focusable elements, including ARIA and React DOM attributes.
+ *
+ * @template T The element type, defaults to FocusableElement.
+ */
+interface DOMAttributes<T = FocusableElement>
+  extends AriaAttributes,
+    DOMAttributes$1<T> {
+  /** The unique id for the DOM element. */
+  id?: string | undefined;
+
+  /** The ARIA role for the element. */
+  role?: AriaRole | undefined;
+
+  /** The tab index of the element. */
+  tabIndex?: number | undefined;
+
+  /** Inline CSS styles for the element. */
+  style?: CSSProperties | undefined;
+
+  /** The CSS class name for the element. */
+  className?: string | undefined;
+}
+
+/**
+ * Props for anchor/link elements.
+ */
+interface LinkDOMProps {
+  /** The URL to link to. */
+  href?: string | undefined;
+
+  /** The language of the linked resource. */
+  hrefLang?: string;
+
+  /** The browsing context for the link. */
+  target?: HTMLAttributeAnchorTarget;
+
+  /** The relationship of the linked resource. */
+  rel?: string;
+
+  /** Prompts the user to save the linked URL instead of navigating to it. */
+  download?: boolean | string;
+
+  /** Space-separated list of URLs to notify when the user follows the hyperlink. */
+  ping?: string;
+
+  /** Referrer policy for the link. */
+  referrerPolicy?: HTMLAttributeReferrerPolicy;
+
+  /** Additional router options (type depends on router implementation). */
+  routerOptions?: unknown;
+}
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+
+
+interface StyleRenderProps<T> {
+  /** The CSS [className](https://developer.mozilla.org/en-US/docs/Web/API/Element/className) for the element. A function may be provided to compute the class based on component state. */
+  className?:
+    | string
+    | ((values: T & { defaultClassName: string | undefined }) => string);
+
+  /** The inline [style](https://developer.mozilla.org/en-US/docs/Web/API/HTMLElement/style) for the element. A function may be provided to compute the style based on component state. */
+  style?:
+    | CSSProperties
+    | ((
+        values: T & { defaultStyle: CSSProperties }
+      ) => CSSProperties | undefined);
+}
+
+interface RenderProps<T> extends StyleRenderProps<T> {
+  /** The children of the component. A function may be provided to alter the children based on component state. */
+  children?:
+    | ReactNode
+    | ((values: T | { defaultChildren: ReactNode | undefined }) => ReactNode);
+}
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/**
+ * Flags indicating disabled states for different interaction types.
+ */
+type DisabledFlags = {
+  /** Whether the element is generally disabled. */
+  general?: boolean;
+
+  /** Whether the element is disabled for form interactions. */
+  form?: boolean;
+
+  /** Whether the element is disabled for user interactions (e.g., pointer, keyboard). */
+  interactions?: boolean;
+
+  /** Custom disabled flags for additional types of interactions. */
+  [key: string]: boolean | undefined;
+};
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+
+
+/**
+ * Extended SyntheticEvent with custom propagation control methods.
+ *
+ * @template T The type of the original SyntheticEvent.
+ */
+type BaseEvent<T extends SyntheticEvent> = T & {
+  /**
+   * Use continuePropagation instead.
+   * @deprecated
+   */
+  stopPropagation(): void;
+
+  /**
+   * Continues propagation for the event.
+   */
+  continuePropagation(): void;
+};
+
+/**
+ * Event handlers for hover interactions.
+ */
+interface HoverEvent {
+  /** Called when a hover interaction starts. */
+  onHoverStart?: (event: HoverEvent) => void;
+
+  /** Called when a hover interaction ends. */
+  onHoverEnd?: (event: HoverEvent) => void;
+
+  /** Called when the hover state changes. */
+  onHoverChange?: (isHovering: boolean) => void;
+}
+
+/**
+ * Event handlers for focus interactions.
+ */
+interface FocusEvents<Target = Element> {
+  /** Called when the element receives focus. */
+  onFocus?: (e: FocusEvent<Target>) => void;
+
+  /** Called when the element loses focus. */
+  onBlur?: (e: FocusEvent<Target>) => void;
+
+  /** Called when the focus state changes. */
+  onFocusChange?: (isFocused: boolean) => void;
+}
+
+/**
+ * Event handlers for keyboard interactions.
+ */
+interface KeyboardEvents {
+  /** Called when a key is pressed down. */
+  onKeyDown?: (e: KeyboardEvent) => void;
+
+  /** Called when a key is released. */
+  onKeyUp?: (e: KeyboardEvent) => void;
+}
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+
+
+type SlottedContextValue<T, E = never> =
+  | (T & {
+      slots?: Record<string | symbol, T>;
+      ref?: E extends never ? never : ForwardedRef<E>;
+    })
+  | null
+  | undefined;
+
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/** Selection mode for a collection. */
+type SelectionMode = 'none' | 'single' | 'multiple';
+
+/** Focus strategy when auto-focusing. */
+type FocusStrategy = 'first' | 'last';
+
+/**
+ * Interface for managing selection state in a collection.
+ */
+interface SelectionManager {
+  /** The currently focused key. */
+  readonly focusedKey: (string | number) | null;
+  /** Set the focused key. */
+  setFocusedKey(
+    key: (string | number) | null,
+    childFocus?: FocusStrategy
+  ): void;
+  /** Whether the collection is focused. */
+  readonly isFocused: boolean;
+  /** Set whether the collection is focused. */
+  setFocused(isFocused: boolean): void;
+  /** The set of selected keys. */
+  readonly selectedKeys: Set<string | number>;
+  /** The selection mode. */
+  readonly selectionMode: SelectionMode;
+  /** Replace selection with a single key. */
+  replaceSelection(key: string | number): void;
+  /** Extend selection to include a key. */
+  extendSelection(key: string | number): void;
+  /** Toggle selection of a key. */
+  toggleSelection(key: string | number): void;
+  /** Select all items. */
+  selectAll(): void;
+  /** Clear all selection. */
+  clearSelection(): void;
+  /** Check if a key is selected. */
+  isSelected(key: string | number): boolean;
+  /** Check if a key is disabled. */
+  isDisabled?(key: string | number): boolean;
+  /** Check if a key is a link. */
+  isLink?(key: string | number): boolean;
+  /** Get props for an item. */
+  getItemProps?(
+    key: string | number
+  ): { href?: string; routerOptions?: unknown } | undefined;
+  /** Whether the user can select an item. */
+  canSelectItem?(key: string | number): boolean;
+  /** The first selected key. */
+  readonly firstSelectedKey?: (string | number) | null;
+  /** The last selected key. */
+  readonly lastSelectedKey?: (string | number) | null;
+}
+
+export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusStrategy, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SelectionManager, SelectionMode, SlottedContextValue, StyleRenderProps };

package/dist/index.d.mts

@@ -222,4 +222,65 @@ type SlottedContextValue<T, E = never> =
   | null
   | undefined;
 
-export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SlottedContextValue, StyleRenderProps };
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/** Selection mode for a collection. */
+type SelectionMode = 'none' | 'single' | 'multiple';
+
+/** Focus strategy when auto-focusing. */
+type FocusStrategy = 'first' | 'last';
+
+/**
+ * Interface for managing selection state in a collection.
+ */
+interface SelectionManager {
+  /** The currently focused key. */
+  readonly focusedKey: (string | number) | null;
+  /** Set the focused key. */
+  setFocusedKey(
+    key: (string | number) | null,
+    childFocus?: FocusStrategy
+  ): void;
+  /** Whether the collection is focused. */
+  readonly isFocused: boolean;
+  /** Set whether the collection is focused. */
+  setFocused(isFocused: boolean): void;
+  /** The set of selected keys. */
+  readonly selectedKeys: Set<string | number>;
+  /** The selection mode. */
+  readonly selectionMode: SelectionMode;
+  /** Replace selection with a single key. */
+  replaceSelection(key: string | number): void;
+  /** Extend selection to include a key. */
+  extendSelection(key: string | number): void;
+  /** Toggle selection of a key. */
+  toggleSelection(key: string | number): void;
+  /** Select all items. */
+  selectAll(): void;
+  /** Clear all selection. */
+  clearSelection(): void;
+  /** Check if a key is selected. */
+  isSelected(key: string | number): boolean;
+  /** Check if a key is disabled. */
+  isDisabled?(key: string | number): boolean;
+  /** Check if a key is a link. */
+  isLink?(key: string | number): boolean;
+  /** Get props for an item. */
+  getItemProps?(
+    key: string | number
+  ): { href?: string; routerOptions?: unknown } | undefined;
+  /** Whether the user can select an item. */
+  canSelectItem?(key: string | number): boolean;
+  /** The first selected key. */
+  readonly firstSelectedKey?: (string | number) | null;
+  /** The last selected key. */
+  readonly lastSelectedKey?: (string | number) | null;
+}
+
+export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusStrategy, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SelectionManager, SelectionMode, SlottedContextValue, StyleRenderProps };

package/dist/index.d.ts

@@ -222,4 +222,65 @@ type SlottedContextValue<T, E = never> =
   | null
   | undefined;
 
-export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SlottedContextValue, StyleRenderProps };
+/**
+ * Copyright (c) Corinvo, LLC. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ */
+
+/** Selection mode for a collection. */
+type SelectionMode = 'none' | 'single' | 'multiple';
+
+/** Focus strategy when auto-focusing. */
+type FocusStrategy = 'first' | 'last';
+
+/**
+ * Interface for managing selection state in a collection.
+ */
+interface SelectionManager {
+  /** The currently focused key. */
+  readonly focusedKey: (string | number) | null;
+  /** Set the focused key. */
+  setFocusedKey(
+    key: (string | number) | null,
+    childFocus?: FocusStrategy
+  ): void;
+  /** Whether the collection is focused. */
+  readonly isFocused: boolean;
+  /** Set whether the collection is focused. */
+  setFocused(isFocused: boolean): void;
+  /** The set of selected keys. */
+  readonly selectedKeys: Set<string | number>;
+  /** The selection mode. */
+  readonly selectionMode: SelectionMode;
+  /** Replace selection with a single key. */
+  replaceSelection(key: string | number): void;
+  /** Extend selection to include a key. */
+  extendSelection(key: string | number): void;
+  /** Toggle selection of a key. */
+  toggleSelection(key: string | number): void;
+  /** Select all items. */
+  selectAll(): void;
+  /** Clear all selection. */
+  clearSelection(): void;
+  /** Check if a key is selected. */
+  isSelected(key: string | number): boolean;
+  /** Check if a key is disabled. */
+  isDisabled?(key: string | number): boolean;
+  /** Check if a key is a link. */
+  isLink?(key: string | number): boolean;
+  /** Get props for an item. */
+  getItemProps?(
+    key: string | number
+  ): { href?: string; routerOptions?: unknown } | undefined;
+  /** Whether the user can select an item. */
+  canSelectItem?(key: string | number): boolean;
+  /** The first selected key. */
+  readonly firstSelectedKey?: (string | number) | null;
+  /** The last selected key. */
+  readonly lastSelectedKey?: (string | number) | null;
+}
+
+export type { BaseEvent, DOMAttributes, DOMProps, DisabledFlags, FocusEvents, FocusStrategy, FocusableDOMProps, HoverEvent, KeyboardEvents, LinkDOMProps, RenderProps, SelectionManager, SelectionMode, SlottedContextValue, StyleRenderProps };

package/dist/index.js

@@ -1 +0,0 @@
-"use strict";var r=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var y=Object.prototype.hasOwnProperty;var s=(e,o,m,t)=>{if(o&&typeof o=="object"||typeof o=="function")for(let p of x(o))!y.call(e,p)&&p!==m&&r(e,p,{get:()=>o[p],enumerable:!(t=f(o,p))||t.enumerable});return e};var n=e=>s(r({},"__esModule",{value:!0}),e);var a={};module.exports=n(a);

package/package.json

@@ -1,14 +1,22 @@
 {
   "name": "@necto-react/types",
-  "version": "2.3.0",
+  "version": "2.4.1",
   "description": "",
   "files": [
     "dist",
     "README.md"
   ],
-  "types": "dist/index.d.ts",
-  "main": "./dist/index.js",
-  "module": "./dist/index.mjs",
+  "type": "module",
+  "types": "./dist/index.d.ts",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
   "author": "Corinvo OSS Team",
   "license": "MIT",
   "devDependencies": {