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

package/dist/types/components/molecules/ManageableBreadcrumbs/ManageableBreadcrumbs.d.ts

@@ -7,8 +7,10 @@ export type TManageableBreadcrumbsProps = {
 };
 export declare const ManageableBreadcrumbs: FC<TManageableBreadcrumbsProps>;
 export type TManageableBreadcrumbsWithDataProviderProps = {
-    uri: string;
-    refetchInterval?: number | false;
+    cluster: string;
+    apiGroup: string;
+    apiVersion: string;
+    plural: string;
     isEnabled?: boolean;
     replaceValues: Record<string, string | undefined>;
     pathname: string;

package/dist/types/components/molecules/ManageableBreadcrumbs/utils.d.ts

@@ -1,10 +1,10 @@
 import { BreadcrumbItemType } from 'antd/es/breadcrumb/Breadcrumb';
 import { TLink } from './types';
 export declare const prepareDataForManageableBreadcrumbs: ({ data, replaceValues, idToCompare, }: {
-    data: {
+    data: ({
         id: string;
         breadcrumbItems: TLink[];
-    }[];
+    } | undefined)[];
     replaceValues: Record<string, string | undefined>;
     pathname: string;
     idToCompare: string;

package/dist/types/components/molecules/ManageableSidebar/ManageableSidebar.d.ts

@@ -9,8 +9,10 @@ export type TManageableSidebarProps = {
 };
 export declare const ManageableSidebar: FC<TManageableSidebarProps>;
 export type TManageableSidebarWithDataProviderProps = {
-    uri: string;
-    refetchInterval?: number | false;
+    cluster: string;
+    apiGroup: string;
+    apiVersion: string;
+    plural: string;
     isEnabled?: boolean;
     replaceValues: Record<string, string | undefined>;
     pathname: string;

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

@@ -0,0 +1,29 @@
+import { AxiosError } from 'axios';
+import { TSingleResource } from '../localTypes/k8s';
+type UseK8sSmartResourceParams<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, }: UseK8sSmartResourceParams<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,30 @@
+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;
+};
+export type TServerFrame = TInitialFrame | TPageFrame | TPageErrorFrame | TDeltaFrame;
+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,71 @@
+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;
+    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 {};

package/dist/types/index.d.ts

@@ -23,6 +23,10 @@ export { useBuiltinResourceTypes } from './hooks/useBuiltinResourceTypes';
 export { useCrdData } from './hooks/useCrdData';
 export { useDirectUnknownResource } from './hooks/useDirectUnknownResource';
 export { usePermissions } from './hooks/usePermissions';
+export { useListWatch, useInfiniteSentinel } from './hooks/useListThenWatch';
+export type { TConnStatus, TUseListWatchQuery, TUseListWatchOptions, TUseListWatchReturn, } from './hooks/useListThenWatch';
+export { useK8sVerbs } from './hooks/useK8sVerbs';
+export { useK8sSmartResource } from './hooks/useK8sSmartResource';
 export type { TRequestError } from './localTypes/api';
 export type { TClusterList } from './localTypes/clusterList';
 export type { TItemTypeMap, TRenderableItem, TRendererComponents, TFactoryDataK8s, TFactoryResponse, TFactoryResource, } from './localTypes/dynamicRender';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prorobotech/openapi-k8s-toolkit",
-  "version": "1.0.3",
+  "version": "1.1.0-alpha.2",
   "description": "ProRobotech OpenAPI k8s tools",
   "main": "dist/openapi-k8s-toolkit.cjs.js",
   "module": "dist/openapi-k8s-toolkit.es.js",