@prorobotech/openapi-k8s-toolkit 1.0.3 → 1.1.0-alpha.10

package/dist/types/components/organisms/DynamicComponents/molecules/MultiQuery/index.d.ts

@@ -1 +1 @@
-export * from './MultiQuery';
+export { MultiQuery } from './MultiQuery';

package/dist/types/components/organisms/DynamicComponents/molecules/NodeTerminal/index.d.ts

@@ -1 +1 @@
-export * from './NodeTerminal';
+export { NodeTerminal } from './NodeTerminal';

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/OwnerRefs.d.ts

@@ -0,0 +1,6 @@
+import { FC } from 'react';
+import { TDynamicComponentsAppTypeMap } from '../../types';
+export declare const OwnerRefs: FC<{
+    data: TDynamicComponentsAppTypeMap['OwnerRefs'];
+    children?: any;
+}>;

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/guard.d.ts

@@ -0,0 +1,2 @@
+import { TOwnerReference } from './types';
+export declare const isOwnerReference: (value: unknown) => value is TOwnerReference;

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/index.d.ts

@@ -0,0 +1 @@
+export { OwnerRefs } from './OwnerRefs';

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/RefsList.d.ts

@@ -0,0 +1,22 @@
+import { FC } from 'react';
+import { FlexProps } from 'antd';
+import { TOwnerReference } from '../../types';
+export type TRefsListProps = {
+    theme: 'dark' | 'light';
+    baseprefix?: string;
+    cluster: string;
+    refsArr: TOwnerReference[];
+    keysToForcedLabel?: string | string[];
+    forcedRelatedValuePath?: string;
+    rawObjectToFindLabel?: any;
+    jsonPathToArrayOfRefs: string;
+    forcedNamespace?: string;
+    baseFactoryNamespacedAPIKey: string;
+    baseFactoryClusterSceopedAPIKey: string;
+    baseFactoryNamespacedBuiltinKey: string;
+    baseFactoryClusterSceopedBuiltinKey: string;
+    baseNavigationPluralName: string;
+    baseNavigationSpecificName: string;
+    listFlexProps?: FlexProps;
+};
+export declare const RefsList: FC<TRefsListProps>;

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/index.d.ts

@@ -0,0 +1 @@
+export { RefsList } from './RefsList';

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/molecules/RefElement/RefElement.d.ts

@@ -0,0 +1,21 @@
+import { FC } from 'react';
+import { TOwnerReference } from '../../../../types';
+type TRefElementProps = {
+    reference: TOwnerReference;
+    keysToForcedLabel?: string | string[];
+    forcedRelatedValuePath?: string;
+    rawObjectToFindLabel?: any;
+    jsonPathToArrayOfRefs: string;
+    forcedNamespace?: string;
+    theme: 'dark' | 'light';
+    baseprefix?: string;
+    cluster: string;
+    getPlural?: (kind: string, apiVersion?: string) => string | undefined;
+    baseFactoryNamespacedAPIKey: string;
+    baseFactoryClusterSceopedAPIKey: string;
+    baseFactoryNamespacedBuiltinKey: string;
+    baseFactoryClusterSceopedBuiltinKey: string;
+    baseFactoriesMapping?: Record<string, string>;
+};
+export declare const RefElement: FC<TRefElementProps>;
+export {};

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/molecules/RefElement/index.d.ts

@@ -0,0 +1 @@
+export { RefElement } from './RefElement';

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/molecules/RefElement/utils.d.ts

@@ -0,0 +1,5 @@
+import { TOwnerReference } from '../../../../types';
+type PathSeg = string | number;
+export declare const findOwnerReferencePath: (rawObject: any, jsonPathToArrayOfRefs: string, reference: TOwnerReference) => PathSeg[] | undefined;
+export declare const resolveFormPath: (pathInput: string | string[] | undefined, basePathForRelative: PathSeg[]) => PathSeg[];
+export {};

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/organsisms/RefsList/molecules/index.d.ts

@@ -0,0 +1 @@
+export { RefElement } from './RefElement';

package/dist/types/components/organisms/DynamicComponents/molecules/OwnerRefs/types.d.ts

@@ -0,0 +1,6 @@
+export type TOwnerReference = {
+    apiVersion: string;
+    kind: string;
+    name: string;
+    namespace?: string;
+};

package/dist/types/components/organisms/DynamicComponents/molecules/ParsedText/index.d.ts

@@ -1 +1 @@
-export * from './ParsedText';
+export { ParsedText } from './ParsedText';

package/dist/types/components/organisms/DynamicComponents/molecules/PartsOfUrl/index.d.ts

@@ -1 +1 @@
-export * from './PartsOfUrl';
+export { PartsOfUrl } from './PartsOfUrl';

package/dist/types/components/organisms/DynamicComponents/molecules/PodLogs/index.d.ts

@@ -1 +1 @@
-export * from './PodLogs';
+export { PodLogs } from './PodLogs';

package/dist/types/components/organisms/DynamicComponents/molecules/PodTerminal/index.d.ts

@@ -1 +1 @@
-export * from './PodTerminal';
+export { PodTerminal } from './PodTerminal';

package/dist/types/components/organisms/DynamicComponents/molecules/ProjectInfoCard/index.d.ts

@@ -1 +1 @@
-export * from './ProjectInfoCard';
+export { ProjectInfoCard } from './ProjectInfoCard';

package/dist/types/components/organisms/DynamicComponents/molecules/ResourceBadge/index.d.ts

@@ -1 +1 @@
-export * from './ResourceBadge';
+export { ResourceBadge } from './ResourceBadge';

package/dist/types/components/organisms/DynamicComponents/molecules/SecretBase64Plain/index.d.ts

@@ -1 +1 @@
-export * from './SecretBase64Plain';
+export { SecretBase64Plain } from './SecretBase64Plain';

package/dist/types/components/organisms/DynamicComponents/molecules/SidebarProvider/index.d.ts

@@ -1 +1 @@
-export * from './SidebarProvider';
+export { SidebarProvider } from './SidebarProvider';

package/dist/types/components/organisms/DynamicComponents/molecules/Spacer/index.d.ts

@@ -1 +1 @@
-export * from './Spacer';
+export { Spacer } from './Spacer';

package/dist/types/components/organisms/DynamicComponents/molecules/StatusText/index.d.ts

@@ -1 +1 @@
-export * from './StatusText';
+export { StatusText } from './StatusText';

package/dist/types/components/organisms/DynamicComponents/molecules/Taints/index.d.ts

@@ -1 +1 @@
-export * from './Taints';
+export { Taints } from './Taints';

package/dist/types/components/organisms/DynamicComponents/molecules/Taints/molecules/EditModal/index.d.ts

@@ -1 +1 @@
-export * from './EditModal';
+export { EditModal } from './EditModal';

package/dist/types/components/organisms/DynamicComponents/molecules/Taints/molecules/index.d.ts

@@ -1 +1 @@
-export * from './EditModal';
+export { EditModal } from './EditModal';

package/dist/types/components/organisms/DynamicComponents/molecules/Tolerations/index.d.ts

@@ -1 +1 @@
-export * from './Tolerations';
+export { Tolerations } from './Tolerations';

package/dist/types/components/organisms/DynamicComponents/molecules/Tolerations/molecules/EditModal/index.d.ts

@@ -1 +1 @@
-export * from './EditModal';
+export { EditModal } from './EditModal';

package/dist/types/components/organisms/DynamicComponents/molecules/Tolerations/molecules/index.d.ts

@@ -1 +1 @@
-export * from './EditModal';
+export { EditModal } from './EditModal';

package/dist/types/components/organisms/DynamicComponents/molecules/VisibilityContainer/index.d.ts

@@ -1 +1 @@
-export * from './VisibilityContainer';
+export { VisibilityContainer } from './VisibilityContainer';

package/dist/types/components/organisms/DynamicComponents/molecules/YamlEditorSingleton/index.d.ts

@@ -1 +1 @@
-export * from './YamlEditorSingleton';
+export { YamlEditorSingleton } from './YamlEditorSingleton';

package/dist/types/components/organisms/DynamicComponents/molecules/YamlEditorSingleton/utils.d.ts

@@ -0,0 +1,10 @@
+export declare const getDataByPath: ({ prefillValuesRaw, pathToData, }: {
+    prefillValuesRaw: unknown;
+    pathToData: string | string[];
+}) => any;
+export declare const getPrefillValuesWithForces: ({ prefillValues, forcedKind, apiGroup, apiVersion, }: {
+    prefillValues: any;
+    forcedKind?: string | undefined;
+    apiVersion?: string | undefined;
+    apiGroup?: string | undefined;
+}) => any;

package/dist/types/components/organisms/DynamicComponents/molecules/index.d.ts

@@ -1,36 +1,37 @@
-export * from './AntdText';
-export * from './AntdLink';
-export * from './AntdCard';
-export * from './AntdFlex';
-export * from './AntdRow';
-export * from './AntdCol';
-export * from './AntdTabs';
-export * from './AntdButton';
-export * from './PartsOfUrl';
-export * from './MultiQuery';
-export * from './ParsedText';
-export * from './ProjectInfoCard';
-export * from './MarketplaceCard';
-export * from './ContentCard';
-export * from './Spacer';
-export * from './DefaultDiv';
-export * from './StatusText';
-export * from './SidebarProvider';
-export * from './EnrichedTable';
-export * from './PodTerminal';
-export * from './NodeTerminal';
-export * from './PodLogs';
-export * from './YamlEditorSingleton';
-export * from './VisibilityContainer';
-export * from './ArrayOfObjectsToKeyValues';
-export * from './ItemCounter';
-export * from './KeyCounter';
-export * from './Labels';
-export * from './LabelsToSearchParams';
-export * from './Taints';
-export * from './Tolerations';
-export * from './Annotations';
-export * from './ConverterBytes';
-export * from './SecretBase64Plain';
-export * from './ResourceBadge';
-export * from './Events';
+export { AntdText } from './AntdText';
+export { AntdLink } from './AntdLink';
+export { AntdCard } from './AntdCard';
+export { AntdFlex } from './AntdFlex';
+export { AntdRow } from './AntdRow';
+export { AntdCol } from './AntdCol';
+export { AntdTabs } from './AntdTabs';
+export { AntdButton } from './AntdButton';
+export { PartsOfUrl } from './PartsOfUrl';
+export { MultiQuery } from './MultiQuery';
+export { ParsedText } from './ParsedText';
+export { ProjectInfoCard } from './ProjectInfoCard';
+export { MarketplaceCard } from './MarketplaceCard';
+export { ContentCard } from './ContentCard';
+export { Spacer } from './Spacer';
+export { DefaultDiv } from './DefaultDiv';
+export { StatusText } from './StatusText';
+export { SidebarProvider } from './SidebarProvider';
+export { EnrichedTable } from './EnrichedTable';
+export { PodTerminal } from './PodTerminal';
+export { NodeTerminal } from './NodeTerminal';
+export { PodLogs } from './PodLogs';
+export { YamlEditorSingleton } from './YamlEditorSingleton';
+export { VisibilityContainer } from './VisibilityContainer';
+export { ArrayOfObjectsToKeyValues } from './ArrayOfObjectsToKeyValues';
+export { ItemCounter } from './ItemCounter';
+export { KeyCounter } from './KeyCounter';
+export { Labels } from './Labels';
+export { LabelsToSearchParams } from './LabelsToSearchParams';
+export { Taints } from './Taints';
+export { Tolerations } from './Tolerations';
+export { Annotations } from './Annotations';
+export { ConverterBytes } from './ConverterBytes';
+export { SecretBase64Plain } from './SecretBase64Plain';
+export { ResourceBadge } from './ResourceBadge';
+export { Events } from './Events';
+export { OwnerRefs } from './OwnerRefs';

package/dist/types/components/organisms/DynamicComponents/types.d.ts

@@ -2,9 +2,9 @@ import { CSSProperties } from 'react';
 import { CardProps, FlexProps, RowProps, ColProps, ButtonProps, TabsProps, SelectProps } from 'antd';
 import type { TextProps } from 'antd/es/typography/Text';
 import type { LinkProps } from 'antd/es/typography/Link';
-import { TContentCardProps, TSpacerProps } from '../../atoms';
-import { TManageableSidebarWithDataProviderProps, TEnrichedTableProviderProps } from '../../molecules';
-import { TUnitInput } from './molecules/ConverterBytes/types';
+import type { TContentCardProps, TSpacerProps } from '../../atoms';
+import type { TManageableSidebarProviderProps, TEnrichedTableProviderProps } from '../../molecules';
+import type { TUnitInput } from './molecules/ConverterBytes/types';
 export type TDynamicComponentsAppTypeMap = {
     DefaultDiv: {
         id: number | string;
@@ -99,10 +99,16 @@ export type TDynamicComponentsAppTypeMap = {
     } & Omit<TextProps, 'id' | 'children'>;
     SidebarProvider: {
         id: number | string;
-    } & Omit<TManageableSidebarWithDataProviderProps, 'replaceValues'>;
+    } & Omit<TManageableSidebarProviderProps, 'replaceValues'>;
     EnrichedTable: {
         id: number | string;
-        fetchUrl: string;
+        fetchUrl?: string;
+        k8sResourceToFetch?: {
+            group?: string;
+            version: string;
+            plural: string;
+            namespace?: string;
+        };
         pathToItems: string | string[];
         clusterNamePartOfUrl: string;
         labelSelector?: Record<string, string>;
@@ -140,7 +146,9 @@ export type TDynamicComponentsAppTypeMap = {
         apiGroup?: string;
         apiVersion?: string;
         typeName: string;
+        forcedKind?: string;
         prefillValuesRequestIndex: number;
+        pathToData?: string | string[];
         substractHeight?: number;
         readOnly?: boolean;
     };
@@ -321,5 +329,29 @@ export type TDynamicComponentsAppTypeMap = {
         baseFactoryNamespacedBuiltinKey: string;
         baseFactoryClusterSceopedBuiltinKey: string;
         baseNamespaceFactoryKey: string;
+        baseNavigationPluralName: string;
+        baseNavigationSpecificName: string;
+    };
+    OwnerRefs: {
+        id: number | string;
+        baseprefix?: string;
+        clusterNamePartOfUrl: string;
+        reqIndex: string;
+        errorText: string;
+        notArrayErrorText: string;
+        emptyArrayErrorText: string;
+        isNotRefsArrayErrorText: string;
+        containerStyle?: CSSProperties;
+        listFlexProps?: FlexProps;
+        jsonPathToArrayOfRefs: string;
+        forcedNamespace?: string;
+        keysToForcedLabel?: string | string[];
+        forcedRelatedValuePath?: string;
+        baseFactoryNamespacedAPIKey: string;
+        baseFactoryClusterSceopedAPIKey: string;
+        baseFactoryNamespacedBuiltinKey: string;
+        baseFactoryClusterSceopedBuiltinKey: string;
+        baseNavigationPluralName: string;
+        baseNavigationSpecificName: string;
     };
 };

package/dist/types/components/organisms/DynamicRendererWithProviders/DynamicRendererWithProviders.d.ts

@@ -1,8 +1,9 @@
 import { ReactElement } from 'react';
 import { TItemTypeMap } from '../../../localTypes/dynamicRender';
+import { TUseK8sSmartResourceParams } from '../../../hooks/useK8sSmartResource';
 import { TDynamicRendererProps } from '../DynamicRenderer';
 export declare const DynamicRendererWithProviders: <T extends TItemTypeMap>(props: TDynamicRendererProps<T> & {
-    urlsToFetch: string[];
+    urlsToFetch: (string | TUseK8sSmartResourceParams<any>)[];
     dataToApplyToContext?: unknown;
     theme: 'dark' | 'light';
     nodeTerminalDefaultProfile?: string | undefined;

package/dist/types/components/organisms/DynamicRendererWithProviders/hybridDataProvider.d.ts

@@ -0,0 +1,22 @@
+import { FC, ReactNode } from 'react';
+import { AxiosError } from 'axios';
+import { TUseK8sSmartResourceParams } from '../../../hooks/useK8sSmartResource';
+type DataMap = Record<string, unknown>;
+type MultiQueryContextValue = {
+    data: DataMap;
+    isLoading: boolean;
+    isError: boolean;
+    errors: ReadonlyArray<AxiosError | Error | string | null>;
+};
+type MultiQueryProviderProps = {
+    /** Mixed array: first (any number of) K8s resources, then (any number of) URL strings */
+    items: ReadonlyArray<string | TUseK8sSmartResourceParams<unknown>>;
+    /** Optional short-circuit to set data.req0 directly */
+    dataToApplyToContext?: unknown;
+    children: ReactNode;
+};
+/** ------------------------------ Provider -------------------------------- */
+export declare const MultiQueryProvider: FC<MultiQueryProviderProps>;
+/** Consumer hook */
+export declare const useMultiQuery: () => MultiQueryContextValue;
+export {};

package/dist/types/components/organisms/DynamicRendererWithProviders/multiK8sProvider.d.ts

@@ -0,0 +1,22 @@
+import { FC, ReactNode } from 'react';
+import type { AxiosError } from 'axios';
+import { useK8sSmartResource } from '../../../hooks/useK8sSmartResource';
+/** Reuse your hook's param type */
+export type UseK8sSmartResourceParams<T> = Parameters<typeof useK8sSmartResource<T>>[0];
+type DataMap = Record<string, unknown>;
+type MultiK8sContextValue = {
+    data: DataMap;
+    isLoading: boolean;
+    isError: boolean;
+    errors: ReadonlyArray<AxiosError | Error | string | null>;
+};
+type MultiK8sProviderProps = {
+    resources: ReadonlyArray<UseK8sSmartResourceParams<unknown>>;
+    dataToApplyToContext?: unknown;
+    children: ReactNode;
+};
+/** --- Provider ----------------------------------------------------------- */
+export declare const MultiK8sProvider: FC<MultiK8sProviderProps>;
+/** --- Consumer Hook ------------------------------------------------------ */
+export declare const useMultiK8s: () => MultiK8sContextValue;
+export {};

package/dist/types/components/organisms/index.d.ts

@@ -1,3 +1,5 @@
-export * from './DynamicRenderer';
-export * from './DynamicComponents';
-export * from './DynamicRendererWithProviders';
+export { DynamicRenderer } from './DynamicRenderer';
+export type { TDynamicRendererProps } from './DynamicRenderer';
+export { DynamicComponents } from './DynamicComponents';
+export type { TDynamicComponentsAppTypeMap } from './DynamicComponents';
+export { DynamicRendererWithProviders } from './DynamicRendererWithProviders';

package/dist/types/hooks/useApiResource.d.ts

@@ -24,6 +24,7 @@ export declare const useApiResourceSingle: ({ clusterName, namespace, apiGroup,
     metadata: {
         name: string;
         creationTimestamp: string;
+        uid?: string | undefined;
         namespace?: string | undefined;
         managedFields?: any;
     };

package/dist/types/hooks/useBuiltinResource.d.ts

@@ -20,6 +20,7 @@ export declare const useBuiltinResourceSingle: ({ clusterName, namespace, typeNa
     metadata: {
         name: string;
         creationTimestamp: string;
+        uid?: string | undefined;
         namespace?: string | undefined;
         managedFields?: any;
     };

package/dist/types/hooks/useCrdResource.d.ts

@@ -31,6 +31,7 @@ export declare const useCrdResourceSingle: ({ clusterName, namespace, apiGroup,
     metadata: {
         name: string;
         creationTimestamp: string;
+        uid?: string | undefined;
         namespace?: string | undefined;
         managedFields?: any;
     };

package/dist/types/hooks/useK8sSmartResource.d.ts

@@ -0,0 +1,29 @@
+import { AxiosError } from 'axios';
+import { TSingleResource } from '../localTypes/k8s';
+export type TUseK8sSmartResourceParams<T> = {
+    cluster: string;
+    group?: string;
+    version: string;
+    plural: string;
+    namespace?: string;
+    fieldSelector?: string;
+    labelSelector?: string;
+    limit?: number;
+    isEnabled?: boolean;
+    listRefetchInterval?: number | false;
+    mapListWatchState?: (state: {
+        order: string[];
+        byKey: Record<string, TSingleResource>;
+    }) => T;
+};
+type SmartResult<T> = {
+    data: T | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error: AxiosError | Error | string | undefined;
+    _meta?: {
+        used: 'list' | 'watch' | 'disabled' | 'verbs-loading' | 'verbs-error';
+    };
+};
+export declare const useK8sSmartResource: <T>({ cluster, group, version, plural, namespace, fieldSelector, labelSelector, isEnabled, listRefetchInterval, limit, mapListWatchState, }: TUseK8sSmartResourceParams<T>) => SmartResult<T>;
+export {};

package/dist/types/hooks/useK8sVerbs.d.ts

@@ -0,0 +1,13 @@
+export declare const useK8sVerbs: ({ cluster, group, version, plural, isEnabled, }: {
+    cluster: string;
+    group?: string | undefined;
+    version: string;
+    plural: string;
+    isEnabled?: boolean | undefined;
+}) => {
+    canList: boolean;
+    canWatch: boolean;
+    isError: boolean;
+    isLoading: boolean;
+    error: Error | null;
+};

package/dist/types/hooks/useListThenWatch/index.d.ts

@@ -0,0 +1,3 @@
+export { useListWatch } from './useListWatch';
+export { useInfiniteSentinel } from './useInfiniteSentinel';
+export type { TConnStatus, TUseListWatchQuery, TUseListWatchOptions, TUseListWatchReturn } from './useListWatch';

package/dist/types/hooks/useListThenWatch/reducer.d.ts

@@ -0,0 +1,20 @@
+import { TSingleResource } from '../../localTypes/k8s';
+type TState = {
+    order: string[];
+    byKey: Record<string, TSingleResource>;
+};
+type TAction = {
+    type: 'RESET';
+    items: TSingleResource[];
+} | {
+    type: 'APPEND_PAGE';
+    items: TSingleResource[];
+} | {
+    type: 'UPSERT';
+    item: TSingleResource;
+} | {
+    type: 'REMOVE';
+    key: string;
+};
+export declare const reducer: (state: TState, action: TAction) => TState;
+export {};

package/dist/types/hooks/useListThenWatch/types.d.ts

@@ -0,0 +1,39 @@
+import { TSingleResource } from '../../localTypes/k8s';
+type TWatchPhase = 'ADDED' | 'MODIFIED' | 'DELETED' | 'BOOKMARK';
+type TInitialFrame = {
+    type: 'INITIAL';
+    items: TSingleResource[];
+    continue?: string;
+    remainingItemCount?: number;
+    resourceVersion?: string;
+};
+type TPageFrame = {
+    type: 'PAGE';
+    items: TSingleResource[];
+    continue?: string;
+    remainingItemCount?: number;
+};
+type TPageErrorFrame = {
+    type: 'PAGE_ERROR';
+    error: string;
+};
+type TDeltaFrame = {
+    type: TWatchPhase;
+    item: TSingleResource;
+};
+type TConsoleFrame = {
+    type: 'SERVER_LOG';
+    level: 'info' | 'warn' | 'error';
+    message: string;
+};
+type TInitialError = {
+    type: 'INITIAL_ERROR';
+    message: string;
+};
+export type TServerFrame = TInitialFrame | TPageFrame | TPageErrorFrame | TDeltaFrame | TConsoleFrame | TInitialError;
+export type TScrollMsg = {
+    type: 'SCROLL';
+    continue: string;
+    limit?: number;
+};
+export {};

package/dist/types/hooks/useListThenWatch/useInfiniteSentinel.d.ts

@@ -0,0 +1,2 @@
+import { RefObject } from 'react';
+export declare const useInfiniteSentinel: (sentinelRef: RefObject<HTMLElement>, hasMore: boolean, onNeedMore: () => void) => void;

package/dist/types/hooks/useListThenWatch/useListWatch.d.ts

@@ -0,0 +1,72 @@
+import { TSingleResource } from '../../localTypes/k8s';
+export type TConnStatus = 'connecting' | 'open' | 'closed';
+/**
+ * Parameters that define which resource collection we are listing/watching.
+ * These map to common Kubernetes list params and discovery fields.
+ */
+export type TUseListWatchQuery = {
+    namespace?: string;
+    apiGroup?: string;
+    apiVersion: string;
+    plural: string;
+    fieldSelector?: string;
+    labelSelector?: string;
+    initialLimit?: number;
+    initialContinue?: string;
+};
+/**
+ * Hook configuration flags and callbacks.
+ */
+export type TUseListWatchOptions = {
+    /** Base WebSocket URL or path (http[s] will be auto-upgraded to ws[s]) */
+    wsUrl: string;
+    /** Page size for subsequent SCROLL requests */
+    pageSize?: number;
+    /** Temporarily pause applying ADDED/MODIFIED/DELETED updates */
+    paused?: boolean;
+    /** Skip applying DELETED events when true */
+    ignoreRemove?: boolean;
+    /** Optional connection status observer */
+    onStatus?: (s: TConnStatus) => void;
+    /** Optional error observer */
+    onError?: (msg: string) => void;
+    /** If true, auto-fetch all remaining pages after snapshot */
+    autoDrain?: boolean;
+    /** If false, reset state when URL or query changes */
+    preserveStateOnUrlChange?: boolean;
+    /** Gate the hook on/off. When false, no WebSocket is opened. */
+    isEnabled?: boolean;
+    /** What to list/watch */
+    query: TUseListWatchQuery;
+};
+/**
+ * Values returned from the hook for rendering and control.
+ */
+export type TUseListWatchReturn = {
+    state: {
+        order: string[];
+        byKey: Record<string, TSingleResource>;
+    };
+    total: number;
+    hasMore: boolean;
+    continueToken?: string;
+    status: TConnStatus;
+    lastError?: string;
+    hasInitial: boolean;
+    setPaused: (v: boolean) => void;
+    setIgnoreRemove: (v: boolean) => void;
+    /** Ask the server for the next page (if any) */
+    sendScroll: () => void;
+    /** Drain multiple pages sequentially (client-side pagination helper) */
+    drainAll: (opts?: {
+        maxPages?: number;
+        maxItems?: number;
+    }) => Promise<number>;
+    /** Manually reconnect the socket (cancels any pending auto-reconnect) */
+    reconnect: () => void;
+    /** Change the base WebSocket URL (will reconnect if enabled) */
+    setUrl: (next: string) => void;
+    /** Update the list/watch query (will reconnect if enabled) */
+    setQuery: (q: TUseListWatchQuery) => void;
+};
+export declare const useListWatch: ({ wsUrl, pageSize, paused, ignoreRemove, onStatus, onError, autoDrain, preserveStateOnUrlChange, isEnabled, query, }: TUseListWatchOptions) => TUseListWatchReturn;

package/dist/types/hooks/useListThenWatch/utils.d.ts

@@ -0,0 +1,11 @@
+import { TSingleResource } from '../../localTypes/k8s';
+export declare const eventKey: (e: TSingleResource) => string;
+export declare const compareRV: (a: string, b: string) => number;
+type WithRV = {
+    metadata?: {
+        resourceVersion?: string;
+    };
+};
+export declare const getRV: (item: WithRV) => string | undefined;
+export declare const getMaxRV: <T extends WithRV>(items: readonly T[]) => string | undefined;
+export {};