@octane-xplat/ui 0.2.1 → 0.4.0

package/types/index.d.ts

@@ -6,92 +6,243 @@
 // emit declarations for .tsrx (upstream: tsrx-org/tsrx#136); this file is
 // what `tsc --emitDeclarationOnly` on pure .ts buys us.
 
-import type { UniversalComponent } from 'octane/universal';
+import type { UniversalComponent } from 'octane/universal'
 import type {
 	AnimatedValue,
+	AbsoluteProps,
+	ActivityIndicatorProps,
+	BeforeLoad,
+	BeforeLoadArgs,
 	ColorScheme,
+	DrawerProps,
+	GridProps,
+	HeadingProps,
+	IconGlyph,
+	IconProps,
 	ImageProps,
+	KeyboardAvoidingProps,
+	LayoutChildProps,
+	LinkProps,
 	ListProps,
+	MeterProps,
 	ModalProps,
+	ModalOpenOptions,
+	ModalOpenResult,
+	NavLinkProps,
+	OpenModal,
+	OpenWindowOptions,
+	OverlayProps,
+	PopoverAnchorRef,
+	PopoverPlacement,
+	PopoverProps,
 	PlatformBadgeProps,
 	PressableProps,
+	ReadableStore,
 	Route,
+	RouteContext,
+	RouteHead,
+	RouteHeadExport,
+	RouteManifest,
+	RouteMeta,
+	RichTextProps,
+	RichTextSpanProps,
 	RowProps,
 	ScreenProps,
+	SafeAreaProps,
+	ScreenTable,
 	ScrollViewProps,
+	SliderProps,
+	Store,
+	SpacerProps,
+	StackProps,
 	SwitchProps,
 	TabSpec,
 	TabsProps,
+	TextAreaProps,
 	TextInputProps,
 	TextProps,
+	ToastContent,
+	ToastOptions,
+	ToastPosition,
 	ViewProps,
-} from './props';
+} from './props'
 
 export type {
+	AbsoluteProps,
 	AnimatedValue,
+	ActivityIndicatorProps,
+	BeforeLoad,
+	BeforeLoadArgs,
 	ColorScheme,
+	DrawerProps,
+	GridProps,
+	HeadingProps,
+	IconGlyph,
+	IconProps,
 	ImageProps,
+	KeyboardAvoidingProps,
+	LayoutChildProps,
+	LinkProps,
 	ListProps,
 	ModalProps,
+	ModalOpenOptions,
+	ModalOpenResult,
+	NavLinkProps,
+	OpenModal,
+	OpenWindowOptions,
+	OverlayProps,
+	PopoverAnchorRef,
+	PopoverPlacement,
+	PopoverProps,
 	PanEvent,
 	PlatformBadgeProps,
 	PressableProps,
+	ReadableStore,
 	Route,
+	RouteContext,
+	RouteHead,
+	RouteHeadExport,
+	RouteManifest,
+	RouteMeta,
+	RichTextProps,
+	RichTextSpanProps,
 	RowProps,
 	ScreenProps,
+	SafeAreaProps,
+	ScreenTable,
 	ScrollViewProps,
+	SliderProps,
+	Store,
+	SpacerProps,
+	StackProps,
 	SwipeEvent,
 	SwitchProps,
 	TabSpec,
 	TabsProps,
+	TextAreaProps,
 	TextInputProps,
 	TextProps,
+	ToastContent,
+	ToastOptions,
+	ToastPosition,
 	ViewProps,
-} from './props';
+} from './props'
+
+/** ScrollBox shares ScrollView's public shell props; native renders it inline. */
+export type ScrollBoxProps = ScrollViewProps
 
 // ---------- primitives ----------
 
-export declare const View: UniversalComponent<ViewProps>;
+export declare const View: UniversalComponent<ViewProps>
 /** Column-direction alias of View. */
-export declare const Column: UniversalComponent<ViewProps>;
-export declare const Row: UniversalComponent<RowProps>;
-export declare const Text: UniversalComponent<TextProps>;
-export declare const Pressable: UniversalComponent<PressableProps>;
-export declare const TextInput: UniversalComponent<TextInputProps>;
-export declare const List: UniversalComponent<ListProps>;
-export declare const ScrollView: UniversalComponent<ScrollViewProps>;
-export declare const Image: UniversalComponent<ImageProps>;
-export declare const Screen: UniversalComponent<ScreenProps>;
-export declare const Switch: UniversalComponent<SwitchProps>;
-export declare const PlatformBadge: UniversalComponent<PlatformBadgeProps>;
+export declare const Column: UniversalComponent<ViewProps>
+export declare const Row: UniversalComponent<RowProps>
+export declare const Grid: UniversalComponent<GridProps>
+export declare const Stack: UniversalComponent<StackProps>
+export declare const Absolute: UniversalComponent<AbsoluteProps>
+export declare const Spacer: UniversalComponent<SpacerProps>
+export declare const Text: UniversalComponent<TextProps>
+export declare const RichText: UniversalComponent<RichTextProps>
+export declare const RichTextSpan: UniversalComponent<RichTextSpanProps>
+export declare const Pressable: UniversalComponent<PressableProps>
+export declare const Link: UniversalComponent<LinkProps>
+export declare const NavLink: UniversalComponent<NavLinkProps>
+export declare const TextInput: UniversalComponent<TextInputProps>
+export declare const TextArea: UniversalComponent<TextAreaProps>
+export declare const List: UniversalComponent<ListProps>
+export declare const ScrollBox: UniversalComponent<ScrollBoxProps>
+export declare const ScrollView: UniversalComponent<ScrollViewProps>
+export declare const Image: UniversalComponent<ImageProps>
+export declare const Screen: UniversalComponent<ScreenProps>
+export declare const SafeArea: UniversalComponent<SafeAreaProps>
+export declare const KeyboardAvoiding: UniversalComponent<KeyboardAvoidingProps>
+export declare const Drawer: UniversalComponent<DrawerProps>
+export declare const Switch: UniversalComponent<SwitchProps>
+export declare const ActivityIndicator: UniversalComponent<ActivityIndicatorProps>
+export declare const Meter: UniversalComponent<MeterProps>
+export declare const Slider: UniversalComponent<SliderProps>
+export declare const Icon: UniversalComponent<IconProps>
+export declare const Heading: UniversalComponent<HeadingProps>
+export declare const PlatformBadge: UniversalComponent<PlatformBadgeProps>
+
+export declare function registerIcon(name: string, glyph: IconGlyph): void
+export declare function registerIcons(record: Record<string, IconGlyph>): void
 
 // ---------- overlays / shells ----------
 
-export declare const Modal: UniversalComponent<ModalProps>;
-export declare const Tabs: UniversalComponent<TabsProps>;
+export declare const Modal: UniversalComponent<ModalProps>
+export declare const openModal: OpenModal
+export declare function openWindow(options?: OpenWindowOptions): any
+export declare const Overlay: UniversalComponent<OverlayProps>
+export declare const Popover: UniversalComponent<PopoverProps>
+export declare function showToast(content: ToastContent, options?: ToastOptions): void
+export declare const Tabs: UniversalComponent<TabsProps>
 
 // ---------- stacks (native registry; no-op on web) ----------
 
-export declare function registerStack(name: string, frame: any): void;
-export declare function getStack(name: string): any;
-export declare function stackEntries(): IterableIterator<[string, any]>;
+export declare function registerStack(name: string, frame: any): void
+export declare function getStack(name: string): any
+export declare function stackEntries(): IterableIterator<[string, any]>
+
+// ---------- routes (real on both: URL store on web, Frame stacks on native) ----------
+
+export declare function pushRoute(r: Route): void
+export declare function popRoute(stack?: string): void
+export declare function routeStacks(): string[]
+export declare function layoutsForRoute(name: string): any[]
+export declare function routeFor(stack: string): Route | null
+export declare function currentRoute(): Route | null
+export declare function canGoBack(stack?: string): boolean
+export declare function useCanGoBack(stack?: string): boolean
+export declare function redirect(route: Route): never
+export declare function useRoute(stack: string): Route | null
+/** name → screen table; native pushRoute resolves `route.name` through
+ *  it, web outlets fall back to it via `screenFor`. `manifest` (from
+ *  deriveRouteManifest) enables path-param URL matching on web. Call
+ *  once at boot. */
+export declare function registerScreens(table: ScreenTable, manifest?: RouteMeta[]): void
+/** One-call registration for route-dir apps — screens + URL patterns +
+ *  layouts all come from deriveRouteManifest. */
+export declare function registerRoutes(manifest: RouteManifest): void
+export declare function screenFor(name: string): any
+/** Canonical /<stack>/<path> for a Route — Link's href on web. */
+export declare function hrefFor(r: Route): string
 
-// ---------- routes (web store; no-op on native) ----------
+// ---------- route dir (file → route manifest; docs/navigation-notes.md) ----------
 
-export declare function pushRoute(r: Route): void;
-export declare function routeFor(stack: string): Route | null;
-export declare function currentRoute(): Route | null;
-export declare function useRoute(stack: string): Route | null;
+/** Turn an `import.meta.glob` module map of the route dir into
+ *  {screens, routes, layouts}: `demo/[id].tsrx` → 'demo/:id',
+ *  `_layout.tsrx` → layouts[''], platform suffixes deduped by `prefer`
+ *  rank (web: ['web']; native: ['ios'|'android','native']). */
+export declare function deriveRouteManifest(
+	files: Record<string, any>,
+	prefer: readonly string[],
+	dir?: string,
+): RouteManifest
 
 // ---------- animation / theme ----------
 
-export declare function useAnimation(initial?: number, prop?: string): AnimatedValue;
-export declare function getColorScheme(): ColorScheme;
-export declare function useColorScheme(): ColorScheme;
+export declare function useAnimation(initial?: number, prop?: string): AnimatedValue
+export declare function getColorScheme(): ColorScheme
+export declare function useColorScheme(): ColorScheme
+export interface SafeAreaInsets {
+	top: number
+	right: number
+	bottom: number
+	left: number
+}
+
+export declare function useSafeAreaInsets(): SafeAreaInsets
 
 // ---------- styled ----------
 
 export declare function styled<P extends { className?: any }, V extends Record<string, any>>(
 	Base: (props: P) => any,
 	def: { base?: any; variants?: V },
-): UniversalComponent<P & { [K in keyof V]?: boolean }>;
+): UniversalComponent<P & { [K in keyof V]?: boolean }>
+
+// ---------- stores ----------
+
+export declare function createStore<T>(initial: T): Store<T>
+export declare function useStore<T>(store: ReadableStore<T>): T
+export declare function useStore<T, S>(store: ReadableStore<T>, select: (state: T) => S): S