@vertesia/appgen-docs 1.6.0-dev.20261019.172735Z → 1.7.0-dev.20261120.100641Z
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +7 -5
- package/lib/docs/symbol-index.json +6793 -3949
- package/lib/docs/ui-interfaces.d.ts +81 -9
- package/lib/docs/vertesia-client.d.ts +289 -72
- package/lib/docs/vertesia-common.d.ts +210 -36
- package/package.json +13 -7
|
@@ -57,7 +57,6 @@ export * from './LanguageSwitcher';
|
|
|
57
57
|
export * from './label';
|
|
58
58
|
export * from './MessageBox';
|
|
59
59
|
export * from './modal';
|
|
60
|
-
export * from './overflowTabs';
|
|
61
60
|
export * from './Panel';
|
|
62
61
|
export * from './popover';
|
|
63
62
|
export * from './radioGroup';
|
|
@@ -67,6 +66,7 @@ export * from './separator';
|
|
|
67
66
|
export * from './slider';
|
|
68
67
|
export * from './switch';
|
|
69
68
|
export * from './tabs';
|
|
69
|
+
export * from './tabsRoute';
|
|
70
70
|
export * from './text';
|
|
71
71
|
export * from './textarea';
|
|
72
72
|
export * from './theme/ThemeProvider';
|
|
@@ -183,6 +183,7 @@ interface ModalProps {
|
|
|
183
183
|
onClose: () => void;
|
|
184
184
|
description?: string;
|
|
185
185
|
noCloseButton?: boolean;
|
|
186
|
+
overlayClassName?: string;
|
|
186
187
|
className?: string;
|
|
187
188
|
allowOverflow?: boolean;
|
|
188
189
|
disableCloseOnClickOutside?: boolean;
|
|
@@ -193,7 +194,7 @@ export declare function useIsInModal(): boolean;
|
|
|
193
194
|
export declare function ModalContextProvider({ children }: {
|
|
194
195
|
children: React.ReactNode;
|
|
195
196
|
}): React.JSX.Element;
|
|
196
|
-
export declare function Modal({ className, children, isOpen, onClose, description, noCloseButton, allowOverflow, disableCloseOnClickOutside, size, action, }: ModalProps): React.JSX.Element;
|
|
197
|
+
export declare function Modal({ className, children, isOpen, onClose, description, noCloseButton, overlayClassName, allowOverflow, disableCloseOnClickOutside, size, action, }: ModalProps): React.JSX.Element;
|
|
197
198
|
export declare const ModalTitle: ({ children, show, className, description, showDivider, ...props }: React.HTMLAttributes<HTMLHeadingElement> & {
|
|
198
199
|
show?: boolean;
|
|
199
200
|
description?: string;
|
|
@@ -211,7 +212,9 @@ declare const DialogTrigger: React.ForwardRefExoticComponent<DialogPrimitive.Dia
|
|
|
211
212
|
declare const DialogPortal: React.FC<DialogPrimitive.DialogPortalProps>;
|
|
212
213
|
declare const DialogClose: React.ForwardRefExoticComponent<DialogPrimitive.DialogCloseProps & React.RefAttributes<HTMLButtonElement>>;
|
|
213
214
|
declare const DialogOverlay: React.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogOverlayProps & React.RefAttributes<HTMLDivElement>, "ref"> & React.RefAttributes<HTMLDivElement>>;
|
|
214
|
-
declare const DialogContent: React.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogContentProps & React.RefAttributes<HTMLDivElement>, "ref"> &
|
|
215
|
+
declare const DialogContent: React.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogContentProps & React.RefAttributes<HTMLDivElement>, "ref"> & {
|
|
216
|
+
overlayClassName?: string;
|
|
217
|
+
} & React.RefAttributes<HTMLDivElement>>;
|
|
215
218
|
declare const DialogDescription: React.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogDescriptionProps & React.RefAttributes<HTMLParagraphElement>, "ref"> & React.RefAttributes<HTMLParagraphElement>>;
|
|
216
219
|
declare const DialogTitle: React.ForwardRefExoticComponent<Omit<DialogPrimitive.DialogTitleProps & React.RefAttributes<HTMLHeadingElement>, "ref"> & React.RefAttributes<HTMLHeadingElement>>;
|
|
217
220
|
export { Dialog, DialogClose, DialogContent, DialogDescription, DialogOverlay, DialogPortal, DialogTitle, DialogTrigger, };
|
|
@@ -368,16 +371,80 @@ interface TabsProps {
|
|
|
368
371
|
onTabChange?: (tabName: string) => void;
|
|
369
372
|
responsive?: boolean;
|
|
370
373
|
variant?: 'tabs' | 'pills';
|
|
374
|
+
/**
|
|
375
|
+
* `false` keeps the selected tab out of the URL. Not needed inside an `updatePath` tab: nested tabs
|
|
376
|
+
* already pick the hash (directly inside) or no URL (deeper) by themselves.
|
|
377
|
+
*/
|
|
371
378
|
updateHash?: boolean;
|
|
379
|
+
/**
|
|
380
|
+
* Keep the selected tab in the route parameter `pathParam` (route `/settings/projects/:tab` →
|
|
381
|
+
* `/settings/projects/keys`). When the level already holds an id parameter (`/store/agents/:agentRunnerId`),
|
|
382
|
+
* declare one literal route per tab instead (`/store/agents/configuration`): without a `pathParam` in the
|
|
383
|
+
* route, the tab is the last path segment when it names a tab.
|
|
384
|
+
*
|
|
385
|
+
* Switching replaces that path segment, keeps the query string and clears the hash. It adds a history entry
|
|
386
|
+
* (Back returns to the previous tab) but no breadcrumb (the breadcrumbs lead to other pages). A missing,
|
|
387
|
+
* unknown or not-allowed tab is replaced, without a new history entry, by the tab an old `#tab` link names, else
|
|
388
|
+
* the default one. Tabs directly inside keep their tab in the hash, and tabs deeper than that keep it in
|
|
389
|
+
* component state.
|
|
390
|
+
*
|
|
391
|
+
* Needs a router; without one it falls back to the hash.
|
|
392
|
+
*/
|
|
393
|
+
updatePath?: boolean;
|
|
394
|
+
/** Route parameter read and written by `updatePath`. Defaults to `tab`. */
|
|
395
|
+
pathParam?: string;
|
|
372
396
|
canChangeTab?: CanChangeTab;
|
|
373
397
|
}
|
|
374
|
-
declare const Tabs: ({ orientation, tabs, defaultValue, current, className, fullWidth, fullHeight, children, onTabChange, responsive, variant, updateHash, canChangeTab, }: TabsProps) => React.JSX.Element;
|
|
398
|
+
declare const Tabs: ({ orientation, tabs, defaultValue, current, className, fullWidth, fullHeight, children, onTabChange, responsive, variant, updateHash, updatePath, pathParam, canChangeTab, }: TabsProps) => React.JSX.Element;
|
|
375
399
|
interface TabsBarProps {
|
|
376
400
|
className?: string;
|
|
377
401
|
sticky?: boolean;
|
|
378
402
|
direction?: 'vertical' | 'horizontal';
|
|
403
|
+
/**
|
|
404
|
+
* Collapse the tabs that don't fit into a trailing "More" dropdown instead of letting the row
|
|
405
|
+
* scroll or wrap. Horizontal bars only; it replaces the `responsive` select, since the row
|
|
406
|
+
* already fits any width.
|
|
407
|
+
*/
|
|
408
|
+
overflow?: boolean;
|
|
409
|
+
}
|
|
410
|
+
declare const TabsBar: ({ className, sticky, direction, overflow }: TabsBarProps) => React.JSX.Element | null;
|
|
411
|
+
/** Gap between tab items, in px — must match the `gap-1` used by the rendered rows. */
|
|
412
|
+
export declare const OVERFLOW_TAB_GAP_PX = 4;
|
|
413
|
+
export type OverflowTabsVariant = 'tabs' | 'pills';
|
|
414
|
+
export interface OverflowTabsLayout<T> {
|
|
415
|
+
/** Attach to the element whose width bounds the row; its `clientWidth` is what tabs are fitted into. */
|
|
416
|
+
containerRef: React.RefObject<HTMLDivElement | null>;
|
|
417
|
+
/** Ref callback for the i-th item of the hidden measurement row. */
|
|
418
|
+
setItemRef: (index: number) => (el: HTMLElement | null) => void;
|
|
419
|
+
/** Ref callback for the "More" button of the hidden measurement row. */
|
|
420
|
+
setMoreRef: (el: HTMLElement | null) => void;
|
|
421
|
+
/** Items that fit; when the active item overflowed it is promoted into the last slot. */
|
|
422
|
+
visible: T[];
|
|
423
|
+
/** Items that did not fit and belong in the "More" menu. */
|
|
424
|
+
overflow: T[];
|
|
425
|
+
/** Whether the active item ended up in `overflow` (used to highlight the "More" trigger). */
|
|
426
|
+
activeInOverflow: boolean;
|
|
427
|
+
}
|
|
428
|
+
/**
|
|
429
|
+
* Splits `items` into a visible row and an overflow list, measured from a hidden row that renders
|
|
430
|
+
* every item at its natural width (see `TabsBar overflow` for the expected markup). The active
|
|
431
|
+
* item is promoted into the last visible slot when it would otherwise be hidden in the menu.
|
|
432
|
+
*
|
|
433
|
+
* Callers own the rendering, so the hidden row must use the same classes and content as the visible
|
|
434
|
+
* one — otherwise the measured widths don't describe what is actually laid out.
|
|
435
|
+
*/
|
|
436
|
+
export declare function useOverflowTabs<T>(items: T[], isActive: (item: T) => boolean, gap?: number): OverflowTabsLayout<T>;
|
|
437
|
+
export interface OverflowMoreMenuProps {
|
|
438
|
+
label: ReactNode;
|
|
439
|
+
/** Classes for the trigger button — pass the same tab-item classes the row uses. */
|
|
440
|
+
triggerClassName?: string;
|
|
441
|
+
/** Icon after the label; the hidden measurement row must render the same one. */
|
|
442
|
+
icon?: ReactNode;
|
|
443
|
+
/** The menu entries, normally `DropdownMenuItem`s rendered by the caller. */
|
|
444
|
+
children: ReactNode;
|
|
379
445
|
}
|
|
380
|
-
|
|
446
|
+
/** Trailing "More" dropdown of overflowed tabs; opens on hover, click, or keyboard. */
|
|
447
|
+
export declare function OverflowMoreMenu({ label, triggerClassName, icon, children }: OverflowMoreMenuProps): React.JSX.Element;
|
|
381
448
|
declare const TabsPanel: ({ className }: {
|
|
382
449
|
className?: string;
|
|
383
450
|
}) => React.JSX.Element | null;
|
|
@@ -722,6 +789,7 @@ export * from './useFetch.js';
|
|
|
722
789
|
export * from './useFlag.js';
|
|
723
790
|
export * from './useIntersectionObserver.js';
|
|
724
791
|
export * from './useIsFistRendering.js';
|
|
792
|
+
export { type Polling, type PollingOptions, usePolling } from './usePolling.js';
|
|
725
793
|
export * from './useSafeLayoutEffect.js';
|
|
726
794
|
export * from './useScrollableSearch.js';
|
|
727
795
|
export * from './useSharedValue.js';
|
|
@@ -858,7 +926,7 @@ interface RouterProviderProps {
|
|
|
858
926
|
children?: React.ReactNode;
|
|
859
927
|
fixLinks?: boolean;
|
|
860
928
|
}
|
|
861
|
-
export declare function NestedRouterProvider({ routes, index, children, fixLinks }: RouterProviderProps): React.JSX.Element |
|
|
929
|
+
export declare function NestedRouterProvider({ routes, index, children, fixLinks }: RouterProviderProps): React.JSX.Element | undefined;
|
|
862
930
|
export {};
|
|
863
931
|
|
|
864
932
|
// -----------------------------------------------------------------------------
|
|
@@ -881,8 +949,9 @@ interface NavProps {
|
|
|
881
949
|
*/
|
|
882
950
|
onClick?: (ev: SyntheticEvent) => void;
|
|
883
951
|
/**
|
|
884
|
-
* If true, use replaceState instead of pushState (no new browser history entry).
|
|
885
|
-
*
|
|
952
|
+
* If true, use replaceState instead of pushState (no new browser history entry). Either way the breadcrumbs
|
|
953
|
+
* start over: `Nav` is top-level navigation (the sidebar), so Back returns to the previous page while the
|
|
954
|
+
* breadcrumbs of that page no longer apply.
|
|
886
955
|
*/
|
|
887
956
|
replace?: boolean;
|
|
888
957
|
}
|
|
@@ -914,6 +983,8 @@ export * from './auth/composable';
|
|
|
914
983
|
export { clearCentralAuthRoundTripMarker, isCentralAuthRedirectPending, redirectToCentralAuth, } from './auth/domainRouting';
|
|
915
984
|
export * from './auth/firebase';
|
|
916
985
|
export { isAppOAuthLoginPending, revokeAppOAuthSession, startAppOAuthLogin } from './auth/oauth';
|
|
986
|
+
export { clearOidcSession, completeOidcSignIn, getOidcIdToken, OIDC_CALLBACK_PATH, OidcSignInError, startOidcSignIn, usesOidcSignIn, } from './auth/oidc';
|
|
987
|
+
export { claimOidcAutoStart, clearOidcSignOut, recordOidcSignOut } from './auth/oidcAutoStart';
|
|
917
988
|
export * from './auth/useAuthState';
|
|
918
989
|
export * from './auth/useCurrentTenant';
|
|
919
990
|
export * from './DevSessionProvider';
|
|
@@ -993,6 +1064,7 @@ export * from './facets/index.js';
|
|
|
993
1064
|
export * from './layout/index.js';
|
|
994
1065
|
export * from './magic-pdf/index.js';
|
|
995
1066
|
export * from './media-viewer/index.js';
|
|
1067
|
+
export * from './notifications/index.js';
|
|
996
1068
|
export * from './oauth/index.js';
|
|
997
1069
|
export * from './pdf-viewer/index.js';
|
|
998
1070
|
export * from './permissions/index.js';
|
|
@@ -1145,7 +1217,7 @@ export interface ModernAgentConversationProps extends AgentBudgetRequestOverride
|
|
|
1145
1217
|
/** Hide the internal message input (for apps that render their own) */
|
|
1146
1218
|
hideMessageInput?: boolean;
|
|
1147
1219
|
/** Custom action shown in place of the input box when the run status is FAILED.
|
|
1148
|
-
* When omitted, the default
|
|
1220
|
+
* When omitted, the default failed message box is shown, with a Restart action when `onRestart` is set. */
|
|
1149
1221
|
failedAction?: React.ReactNode;
|
|
1150
1222
|
/** Hide the internal plan panel (for apps that render their own) */
|
|
1151
1223
|
hidePlanPanel?: boolean;
|