@ohos-ports/stacksjs-stx 0.2.287-beta.0

package/dist/composables/index.d.ts

@@ -0,0 +1,417 @@
+/**
+ * STX Composables
+ *
+ * Nuxt-style reactive utilities for browser APIs.
+ * These composables provide a streamlined, reactive interface to common browser features.
+ *
+ * @example
+ * ```ts
+ * import {
+ *   useStorage,
+ *   useCookie,
+ *   useClipboard,
+ *   useMediaQuery,
+ *   useNetwork,
+ *   useWindowSize,
+ * } from '@stacksjs/stx/composables'
+ * ```
+ */
+// Storage. `useLocalStorage` / `useSessionStorage` return a Signal<T> matching
+// the runtime contract and the ambient stx.d.ts; the old StorageRef shape was
+// removed in #1797 as part of the dual-impl unification. Migrate `.value` reads
+// to `s()` and `.value = x` writes to `s.set(x)` (`.set()` is unchanged); for
+// `.remove()` / `.subscribe()` / custom serializers use `useStorage`, which
+// still returns a StorageRef.
+export {
+  useStorage,
+  useLocalStorage,
+  useSessionStorage,
+  clearStorage,
+  getStorageKeys,
+  getStorageSize,
+  type StorageType,
+  type UseStorageOptions,
+  type StorageRef,
+} from './use-storage';
+// Cookies. `useCookie` returns a Signal<string> matching the runtime contract;
+// the old `CookieRef` shape was removed in #1710 as part of the dual-impl
+// unification. Migrate `.value` reads to `c()` and `.value = x` writes to
+// `c.set(x)`; remove via `c.set('')`.
+export {
+  useCookie,
+  useCookies,
+  getCookie,
+  setCookie,
+  removeCookie,
+  parseCookies,
+  clearCookies,
+  type CookieOptions,
+} from './use-cookie';
+// Clipboard
+export {
+  useClipboard,
+  copyToClipboard,
+  type ClipboardRef,
+} from './use-clipboard';
+// Media Queries
+export {
+  useMediaQuery,
+  usePreferredDark,
+  usePreferredLight,
+  usePreferredReducedMotion,
+  usePreferredContrast,
+  useBreakpoint,
+  useIsMobile,
+  useIsTablet,
+  useIsDesktop,
+  breakpoints,
+  type MediaQueryRef,
+} from './use-media-query';
+export { useScrollLock } from './use-scroll-lock';
+// Network
+export {
+  useNetwork,
+  useOnline,
+  type NetworkState,
+  type NetworkRef,
+} from './use-network';
+// Window
+export {
+  useWindowSize,
+  useScroll,
+  useVisibility,
+  useTitle,
+  useFavicon,
+  type WindowSize,
+  type ScrollPosition,
+  type WindowSizeRef,
+  type ScrollRef,
+  type VisibilityRef,
+} from './use-window';
+// Geolocation
+export {
+  useGeolocation,
+  useGeolocationWatch,
+  getCurrentPosition,
+  calculateDistance,
+  type GeolocationCoords,
+  type GeolocationState,
+  type GeolocationOptions,
+  type GeolocationRef,
+} from './use-geolocation';
+// Mouse & Pointer
+export {
+  useMouse,
+  useMouseInElement,
+  usePointer,
+  type MouseState,
+  type MouseOptions,
+  type MouseRef,
+  type ElementMouseState,
+  type ElementMouseRef,
+} from './use-mouse';
+// Keyboard
+export {
+  useKeyboard,
+  useHotkey,
+  useKeyPressed,
+  useKeySequence,
+  shortcuts,
+  type KeyboardState,
+  type KeyboardOptions,
+  type KeyboardRef,
+  type HotkeyOptions,
+} from './use-keyboard';
+// Intersection Observer
+export {
+  useIntersectionObserver,
+  useElementVisibility,
+  useLazyLoad,
+  useInfiniteScroll,
+  useIntersectionObserverMultiple,
+  type IntersectionObserverOptions,
+  type IntersectionState,
+  type IntersectionObserverRef,
+} from './use-intersection-observer';
+// Fetch & Async Data. `useFetch` now returns Signal-shaped state
+// ({ data, loading, error, refetch, ... }) matching the runtime contract;
+// the old Vue-style `{ get, subscribe, refresh, execute, abort }` shape
+// (and the `FetchState` interface that went with it) was removed in
+// #1726 as part of the dual-impl unification.
+export {
+  useFetch,
+  useAsyncData,
+  usePost,
+  clearFetchCache,
+  prefetch,
+  type FetchOptions,
+  type FetchRef,
+} from './use-fetch';
+// Fullscreen
+export {
+  useFullscreen,
+  toggleFullscreen,
+  isInFullscreen,
+  type FullscreenState,
+  type FullscreenOptions,
+  type FullscreenRef,
+} from './use-fullscreen';
+// Notifications
+export {
+  useNotification,
+  notify,
+  canNotify,
+  requestNotificationPermission,
+  notifications,
+  type NotificationPermission,
+  type NotificationState,
+  type NotificationOptions,
+  type NotificationRef,
+} from './use-notification';
+// Share
+export {
+  useShare,
+  share,
+  shareURL,
+  shareText,
+  shareFiles,
+  shareCurrentPage,
+  shareWithFallback,
+  createShareableFile,
+  type ShareData,
+  type ShareResult,
+  type ShareRef,
+} from './use-share';
+// Permissions
+export {
+  usePermission,
+  usePermissions,
+  isPermissionGranted,
+  hasCameraPermission,
+  hasMicrophonePermission,
+  hasGeolocationPermission,
+  hasNotificationPermission,
+  requestMediaPermissions,
+  permissionGroups,
+  type PermissionName,
+  type PermissionState,
+  type PermissionStatus,
+  type PermissionRef,
+  type MultiPermissionRef,
+} from './use-permissions';
+// Resize Observer
+export {
+  useResizeObserver,
+  useResizeObserverMultiple,
+  useElementSize,
+  hasResizeObserver,
+  type ResizeObserverSize,
+  type ResizeObserverState,
+  type ResizeObserverOptions,
+  type ResizeObserverRef,
+} from './use-resize-observer';
+// Battery
+export {
+  useBattery,
+  getBatteryLevel,
+  isCharging,
+  hasBattery,
+  type BatteryState,
+  type BatteryRef,
+} from './use-battery';
+// Speech Recognition & Synthesis
+export {
+  useSpeechRecognition,
+  useSpeechSynthesis,
+  isSpeechRecognitionSupported,
+  isSpeechSynthesisSupported,
+  speak,
+  stopSpeaking,
+  getVoices,
+  type SpeechRecognitionOptions,
+  type SpeechRecognitionState,
+  type SpeechRecognitionResult,
+  type SpeechRecognitionRef,
+  type SpeechSynthesisOptions,
+  type SpeechSynthesisState,
+  type SpeechSynthesisRef,
+} from './use-speech';
+// Broadcast Channel
+export {
+  useBroadcastChannel,
+  broadcast,
+  isBroadcastChannelSupported,
+  type BroadcastChannelState,
+  type BroadcastChannelOptions,
+  type BroadcastChannelRef,
+} from './use-broadcast-channel';
+// WebSocket
+export {
+  useWebSocket,
+  isWebSocketSupported,
+  type WebSocketStatus,
+  type WebSocketState,
+  type WebSocketOptions,
+  type WebSocketRef,
+} from './use-websocket';
+// Broadcasting Channels (ts-broadcasting)
+export {
+  useChannel,
+  type ChannelState,
+  type ChannelOptions,
+  type ChannelRef,
+} from './use-channel';
+// Device Orientation & Motion
+export {
+  useDeviceOrientation,
+  useDeviceMotion,
+  useParallax,
+  isDeviceOrientationSupported,
+  isDeviceMotionSupported,
+  requestOrientationPermission,
+  requestMotionPermission,
+  type DeviceOrientationState,
+  type DeviceMotionState,
+  type DeviceOrientationRef,
+  type DeviceMotionRef,
+} from './use-device-orientation';
+// Mutation Observer
+export {
+  useMutationObserver,
+  useAttributeObserver,
+  useChildListObserver,
+  useTextObserver,
+  isMutationObserverSupported,
+  type MutationObserverState,
+  type MutationObserverOptions,
+  type MutationObserverRef,
+} from './use-mutation-observer';
+// Event Source (SSE)
+export {
+  useEventSource,
+  useSSE,
+  isEventSourceSupported,
+  type EventSourceStatus,
+  type EventSourceState,
+  type EventSourceOptions,
+  type EventSourceRef,
+} from './use-event-source';
+// Idle Detection
+export {
+  useIdle,
+  useIdleState,
+  useLastActive,
+  useAutoLogout,
+  type IdleState,
+  type IdleOptions,
+  type IdleRef,
+} from './use-idle';
+// Text Selection
+export {
+  useTextSelection,
+  useElementTextSelection,
+  useSelectionPopup,
+  useCopySelection,
+  type TextSelectionState,
+  type TextSelectionOptions,
+  type TextSelectionRef,
+} from './use-text-selection';
+// Wake Lock
+export {
+  useWakeLock,
+  useAutoWakeLock,
+  useConditionalWakeLock,
+  isWakeLockSupported,
+  type WakeLockState,
+  type WakeLockRef,
+} from './use-wake-lock';
+// Eye Dropper (Color Picker)
+export {
+  useEyeDropper,
+  useColorHistory,
+  pickColor,
+  hexToRgb,
+  hexToHsl,
+  isEyeDropperSupported,
+  type EyeDropperState,
+  type EyeDropperResult,
+  type EyeDropperOptions,
+  type EyeDropperRef,
+} from './use-eye-dropper';
+// Router / Navigation
+export {
+  navigate,
+  goBack,
+  goForward,
+  useRoute,
+  useSearchParams,
+  type NavigateOptions,
+  type RouteInfo,
+  type SearchParamsCommitOptions,
+  type SearchParamsRef,
+} from './use-router';
+// Data Fetching (Query / Mutation)
+export {
+  type UseQueryOptions,
+  type UseQueryResult,
+  type UseMutationOptions,
+  type UseMutationResult,
+} from './use-query';
+// Event Listener
+export {
+  useEventListener,
+  type UseEventListenerOptions,
+  type EventListenerRef,
+} from './use-event-listener';
+// Meta Tags
+export {
+  useMeta,
+  type UseMetaOptions,
+  type MetaRef,
+} from './use-meta';
+// Timers
+export {
+  useDebounce,
+  useDebouncedValue,
+  useThrottle,
+  useInterval,
+  useTimeout,
+  type DebouncedFn,
+  type ThrottledFn,
+  type DebouncedValueRef,
+  type IntervalOptions,
+  type IntervalRef,
+  type TimeoutRef,
+} from './use-timer';
+// Utilities
+export {
+  useToggle,
+  useCounter,
+  useClickOutside,
+  useFocus,
+  useAsync,
+  type ToggleRef,
+  type CounterOptions,
+  type CounterRef,
+  type ClickOutsideRef,
+  type FocusRef,
+  type AsyncState,
+  type AsyncRef,
+  type AsyncOptions,
+} from './use-utilities';
+// Color Mode
+export {
+  useColorMode,
+  useDark,
+  type ColorMode,
+  type ColorModeOptions,
+  type ColorModeRef,
+  type DarkRef,
+} from './use-color-mode';
+// `defineForm` was reachable from a `<script client>` block (#1846) and listed
+// in SERVER_ONLY_COMPOSABLES, but never re-exported here. That list is checked
+// against this barrel — "exactly the composable exports the runtime does not
+// provide" — so an entry with no export behind it failed the guard, while
+// `framework-composables.ts` needs the entry to know to bundle it. One missing
+// re-export, two contradictory test suites. See #1849.
+export { defineForm, useForm } from './use-form';

package/dist/composables/index.js

@@ -0,0 +1,222 @@
+export {
+  useStorage,
+  useLocalStorage,
+  useSessionStorage,
+  clearStorage,
+  getStorageKeys,
+  getStorageSize
+} from "./use-storage.js";
+export {
+  useCookie,
+  useCookies,
+  getCookie,
+  setCookie,
+  removeCookie,
+  parseCookies,
+  clearCookies
+} from "./use-cookie.js";
+export {
+  useClipboard,
+  copyToClipboard
+} from "./use-clipboard.js";
+export {
+  useMediaQuery,
+  usePreferredDark,
+  usePreferredLight,
+  usePreferredReducedMotion,
+  usePreferredContrast,
+  useBreakpoint,
+  useIsMobile,
+  useIsTablet,
+  useIsDesktop,
+  breakpoints
+} from "./use-media-query.js";
+export { useScrollLock } from "./use-scroll-lock.js";
+export {
+  useNetwork,
+  useOnline
+} from "./use-network.js";
+export {
+  useWindowSize,
+  useScroll,
+  useVisibility,
+  useTitle,
+  useFavicon
+} from "./use-window.js";
+export {
+  useGeolocation,
+  useGeolocationWatch,
+  getCurrentPosition,
+  calculateDistance
+} from "./use-geolocation.js";
+export {
+  useMouse,
+  useMouseInElement,
+  usePointer
+} from "./use-mouse.js";
+export {
+  useKeyboard,
+  useHotkey,
+  useKeyPressed,
+  useKeySequence,
+  shortcuts
+} from "./use-keyboard.js";
+export {
+  useIntersectionObserver,
+  useElementVisibility,
+  useLazyLoad,
+  useInfiniteScroll,
+  useIntersectionObserverMultiple
+} from "./use-intersection-observer.js";
+export {
+  useFetch,
+  useAsyncData,
+  usePost,
+  clearFetchCache,
+  prefetch
+} from "./use-fetch.js";
+export {
+  useFullscreen,
+  toggleFullscreen,
+  isInFullscreen
+} from "./use-fullscreen.js";
+export {
+  useNotification,
+  notify,
+  canNotify,
+  requestNotificationPermission,
+  notifications
+} from "./use-notification.js";
+export {
+  useShare,
+  share,
+  shareURL,
+  shareText,
+  shareFiles,
+  shareCurrentPage,
+  shareWithFallback,
+  createShareableFile
+} from "./use-share.js";
+export {
+  usePermission,
+  usePermissions,
+  isPermissionGranted,
+  hasCameraPermission,
+  hasMicrophonePermission,
+  hasGeolocationPermission,
+  hasNotificationPermission,
+  requestMediaPermissions,
+  permissionGroups
+} from "./use-permissions.js";
+export {
+  useResizeObserver,
+  useResizeObserverMultiple,
+  useElementSize,
+  hasResizeObserver
+} from "./use-resize-observer.js";
+export {
+  useBattery,
+  getBatteryLevel,
+  isCharging,
+  hasBattery
+} from "./use-battery.js";
+export {
+  useSpeechRecognition,
+  useSpeechSynthesis,
+  isSpeechRecognitionSupported,
+  isSpeechSynthesisSupported,
+  speak,
+  stopSpeaking,
+  getVoices
+} from "./use-speech.js";
+export {
+  useBroadcastChannel,
+  broadcast,
+  isBroadcastChannelSupported
+} from "./use-broadcast-channel.js";
+export {
+  useWebSocket,
+  isWebSocketSupported
+} from "./use-websocket.js";
+export {
+  useChannel
+} from "./use-channel.js";
+export {
+  useDeviceOrientation,
+  useDeviceMotion,
+  useParallax,
+  isDeviceOrientationSupported,
+  isDeviceMotionSupported,
+  requestOrientationPermission,
+  requestMotionPermission
+} from "./use-device-orientation.js";
+export {
+  useMutationObserver,
+  useAttributeObserver,
+  useChildListObserver,
+  useTextObserver,
+  isMutationObserverSupported
+} from "./use-mutation-observer.js";
+export {
+  useEventSource,
+  useSSE,
+  isEventSourceSupported
+} from "./use-event-source.js";
+export {
+  useIdle,
+  useIdleState,
+  useLastActive,
+  useAutoLogout
+} from "./use-idle.js";
+export {
+  useTextSelection,
+  useElementTextSelection,
+  useSelectionPopup,
+  useCopySelection
+} from "./use-text-selection.js";
+export {
+  useWakeLock,
+  useAutoWakeLock,
+  useConditionalWakeLock,
+  isWakeLockSupported
+} from "./use-wake-lock.js";
+export {
+  useEyeDropper,
+  useColorHistory,
+  pickColor,
+  hexToRgb,
+  hexToHsl,
+  isEyeDropperSupported
+} from "./use-eye-dropper.js";
+export {
+  navigate,
+  goBack,
+  goForward,
+  useRoute,
+  useSearchParams
+} from "./use-router.js";
+export {
+  useEventListener
+} from "./use-event-listener.js";
+export {
+  useMeta
+} from "./use-meta.js";
+export {
+  useDebounce,
+  useDebouncedValue,
+  useThrottle,
+  useInterval,
+  useTimeout
+} from "./use-timer.js";
+export {
+  useToggle,
+  useCounter,
+  useClickOutside,
+  useFocus,
+  useAsync
+} from "./use-utilities.js";
+export {
+  useColorMode,
+  useDark
+} from "./use-color-mode.js";
+export { defineForm, useForm } from "./use-form.js";

package/dist/composables/use-battery.d.ts

@@ -0,0 +1,46 @@
+/**
+ * Monitor battery status
+ */
+export declare function useBattery(): BatteryRef;
+/**
+ * Get battery level as percentage
+ */
+export declare function getBatteryLevel(): Promise<number | null>;
+/**
+ * Check if device is charging
+ */
+export declare function isCharging(): Promise<boolean | null>;
+/**
+ * Check if Battery API is available
+ */
+export declare function hasBattery(): boolean;
+/**
+ * useBattery - Battery Status API wrapper
+ *
+ * Monitor device battery status reactively.
+ *
+ * @example
+ * ```ts
+ * const battery = useBattery()
+ * battery.subscribe(state => {
+ *   console.log('Battery level:', state.level * 100 + '%')
+ *   console.log('Charging:', state.charging)
+ *   console.log('Time to full:', state.chargingTime)
+ *   console.log('Time to empty:', state.dischargingTime)
+ * })
+ * ```
+ */
+export declare interface BatteryState {
+  charging: boolean
+  chargingTime: number
+  dischargingTime: number
+  level: number
+}
+export declare interface BatteryRef {
+  get: () => BatteryState
+  subscribe: (fn: (state: BatteryState) => void) => () => void
+  isSupported: () => boolean
+  getPercentage: () => number
+  isLow: (threshold?: number) => boolean
+  isCritical: () => boolean
+}