@prorobotech/openapi-k8s-toolkit 0.0.1-alpha.99 → 1.1.0-alpha.1

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/hooks/usePermissions.d.ts

@@ -1,8 +1,9 @@
-export declare const usePermissions: ({ clusterName, namespace, apiGroup, typeName, verb, refetchInterval, enabler, }: {
+export declare const usePermissions: ({ clusterName, namespace, group, resource, verb, name, refetchInterval, enabler, }: {
     clusterName: string;
-    apiGroup: string;
-    typeName: string;
-    namespace: string;
+    group?: string | undefined;
+    resource: string;
+    namespace?: string | undefined;
+    name?: string | undefined;
     verb: 'create' | 'delete' | 'patch' | 'update';
     refetchInterval?: number | false | undefined;
     enabler?: boolean | undefined;

package/dist/types/index.d.ts

@@ -13,6 +13,7 @@ export { checkPermission } from './api/permissions';
 export { getSwagger } from './api/bff/swagger/getSwagger';
 export { filterIfApiInstanceNamespaceScoped, filterIfBuiltInInstanceNamespaceScoped, } from './api/bff/scopes/filterScopes';
 export { checkIfApiInstanceNamespaceScoped, checkIfBuiltInInstanceNamespaceScoped } from './api/bff/scopes/checkScopes';
+export { getKinds } from './api/bff/search/getKinds';
 export { useClusterList } from './hooks/useClusterList';
 export { useApiResources, useApiResourceSingle } from './hooks/useApiResource';
 export { useBuiltinResources, useBuiltinResourceSingle } from './hooks/useBuiltinResource';
@@ -22,6 +23,8 @@ 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 type { TRequestError } from './localTypes/api';
 export type { TClusterList } from './localTypes/clusterList';
 export type { TItemTypeMap, TRenderableItem, TRendererComponents, TFactoryDataK8s, TFactoryResponse, TFactoryResource, } from './localTypes/dynamicRender';
@@ -32,4 +35,6 @@ export type { TApiGroupList, TApiGroupResourceTypeList, TBuiltinResourceTypeList
 export type { TMarketPlacePanel, TMarketPlacePanelResource, TMarketPlacePanelResponse } from './localTypes/marketplace';
 export type { TAdditionalPrinterColumns, TAdditionalPrinterColumnsUndefinedValues, TAdditionalPrinterColumnsTrimLengths, TAdditionalPrinterColumnsColWidths, } from './localTypes/richTable';
 export type { TFilterIfApiInstanceNamespaceScopedReq, TFilterIfApiInstanceNamespaceScopedRes, TFilterIfBuiltInInstanceNamespaceScopedReq, TFilterIfBuiltInInstanceNamespaceScopedRes, } from './localTypes/bff/scopes';
+export type { TVersionEntry, TKindItem, TKindIndex } from './localTypes/bff/search';
 export type { TGetDerefedSwaggerRes } from './localTypes/bff/swagger';
+export type { TKindWithVersion } from './localTypes/search';

package/dist/types/localTypes/bff/form.d.ts

@@ -34,6 +34,7 @@ export type TPrepareFormRes = {
     hiddenPaths: string[][] | undefined;
     expandedPaths: string[][] | undefined;
     persistedPaths: string[][] | undefined;
+    sortPaths: string[][] | undefined;
     kindName: string | undefined;
     isNamespaced: boolean;
     formPrefills?: TFormPrefill;

package/dist/types/localTypes/bff/search.d.ts

@@ -0,0 +1,20 @@
+export type TVersionEntry = Readonly<{
+    version: string;
+    groupVersion: string;
+    preferred: boolean;
+    namespaced: boolean;
+    resource: string;
+    verbs?: string[];
+}>;
+export type TKindItem = {
+    group: string;
+    kind: string;
+    versions: TVersionEntry[];
+};
+export type TKindIndex = {
+    kind: 'KindIndex';
+    apiVersion: 'v1';
+    generatedAt: string;
+    count: number;
+    items: TKindItem[];
+};

package/dist/types/localTypes/bff/table.d.ts

@@ -1,16 +1,23 @@
-import { TAdditionalPrinterColumns, TAdditionalPrinterColumnsUndefinedValues, TAdditionalPrinterColumnsTrimLengths, TAdditionalPrinterColumnsColWidths } from '../richTable';
+import { TAdditionalPrinterColumns, TAdditionalPrinterColumnsUndefinedValues, TAdditionalPrinterColumnsTrimLengths, TAdditionalPrinterColumnsColWidths, TAdditionalPrinterColumnsKeyTypeProps } from '../richTable';
 export type TPrepareTableReq = {
     customizationId?: string;
     tableMappingsReplaceValues?: Record<string, string | undefined>;
     forceDefaultAdditionalPrinterColumns?: TAdditionalPrinterColumns;
+    namespace?: string;
+    k8sResource?: {
+        resource: string;
+        apiGroup?: string;
+        apiVersion: string;
+    };
 };
 export type TPrepareTableRes = {
     additionalPrinterColumns: TAdditionalPrinterColumns;
     additionalPrinterColumnsUndefinedValues?: TAdditionalPrinterColumnsUndefinedValues;
     additionalPrinterColumnsTrimLengths?: TAdditionalPrinterColumnsTrimLengths;
     additionalPrinterColumnsColWidths?: TAdditionalPrinterColumnsColWidths;
+    additionalPrinterColumnsKeyTypeProps?: TAdditionalPrinterColumnsKeyTypeProps;
     pathToNavigate?: string;
-    recordKeysForNavigation?: string[];
-    recordKeysForNavigationSecond?: string[];
-    recordKeysForNavigationThird?: string[];
+    recordKeysForNavigation?: string | string[];
+    recordKeysForNavigationSecond?: string | string[];
+    recordKeysForNavigationThird?: string | string[];
 };

package/dist/types/localTypes/formExtensions.d.ts

@@ -13,19 +13,19 @@ export type TRangeInputCustomValue = {
 } | {
     type: 'substractResourceValues';
     firstValueUri: string;
-    firstValuesKeysToValue: string[];
+    firstValuesKeysToValue: string | string[];
     secondValueUri: string;
-    secondValuesKeysToValue: string[];
+    secondValuesKeysToValue: string | string[];
 } | {
     type: 'addResourceValues';
     firstValueUri: string;
-    firstValuesKeysToValue: string[];
+    firstValuesKeysToValue: string | string[];
     secondValueUri: string;
-    secondValuesKeysToValue: string[];
+    secondValuesKeysToValue: string | string[];
 } | {
     type: 'resourceValue';
     valueUri: string;
-    keysToValue: string[];
+    keysToValue: string | string[];
 };
 export type TRangeInputCustomValuesBlock = {
     min: TRangeInputCustomValue;
@@ -39,14 +39,14 @@ export type TRangeInputCustomProps = {
 };
 export type TListInputCustomProps = {
     valueUri: string;
-    keysToValue: string[];
-    keysToLabel?: string[];
+    keysToValue: string | string[];
+    keysToLabel?: string | string[];
     mode?: 'multiple' | 'tags';
     criteria?: {
-        keysToValue: string[];
+        keysToValue: string | string[];
         type: 'equals' | 'notEquals';
         value: unknown;
         keepPrefilled?: boolean;
     };
-    relatedValuePath?: string[];
+    relatedValuePath?: string;
 };

package/dist/types/localTypes/richTable.d.ts

@@ -1,7 +1,8 @@
 export type TAdditionalPrinterColumns = {
     name: string;
-    type: string;
-    jsonPath: string;
+    jsonPath?: string;
+    type?: string;
+    customProps?: unknown;
 }[];
 export type TAdditionalPrinterColumnsUndefinedValues = {
     key: string;
@@ -15,3 +16,7 @@ export type TAdditionalPrinterColumnsColWidths = {
     key: string;
     value: string;
 }[];
+export type TAdditionalPrinterColumnsKeyTypeProps = Record<string, {
+    type: string;
+    customProps?: unknown;
+}>;

package/dist/types/localTypes/search.d.ts

@@ -0,0 +1,7 @@
+import { TVersionEntry } from './bff/search';
+export type TKindWithVersion = {
+    group: string;
+    kind: string;
+    version: TVersionEntry;
+    notUnique?: true;
+};

package/dist/types/utils/deepMerge/deepMerge.d.ts

@@ -0,0 +1,7 @@
+type PlainObject = Record<string, any>;
+/**
+ * Deeply merges two objects A and B, returning a new object
+ * whose type is the intersection A & B.
+ */
+export declare const deepMerge: <A extends PlainObject, B extends PlainObject>(a: A, b: B) => A & B;
+export {};

package/dist/types/utils/deepMerge/index.d.ts

@@ -0,0 +1 @@
+export * from './deepMerge';

package/dist/types/utils/getSortedKinds/getSortedKinds.d.ts

@@ -0,0 +1,3 @@
+import { TKindIndex } from '../../localTypes/bff/search';
+import { TKindWithVersion } from '../../localTypes/search';
+export declare const getSortedKinds: (index: TKindIndex) => TKindWithVersion[];

package/dist/types/utils/getSortedKinds/index.d.ts

@@ -0,0 +1 @@
+export * from './getSortedKinds';

package/dist/types/utils/getSortedKindsAll/getSortedKindsAll.d.ts

@@ -0,0 +1,8 @@
+import { TKindIndex } from '../../localTypes/bff/search';
+import { TKindWithVersion } from '../../localTypes/search';
+/**
+ * RETURNS ALL VERSIONS (one row per version).
+ * The first row for each {group, kind} will be the preferred (if any),
+ * otherwise the best-sorted version. Others follow right after.
+ */
+export declare const getSortedKindsAll: (index: TKindIndex) => TKindWithVersion[];

package/dist/types/utils/getSortedKindsAll/index.d.ts

@@ -0,0 +1 @@
+export * from './getSortedKindsAll';

package/dist/types/utils/getUppercase/getUppercase.d.ts

@@ -0,0 +1 @@
+export declare const getUppercase: (s: string) => string;

package/dist/types/utils/getUppercase/index.d.ts

@@ -0,0 +1 @@
+export * from './getUppercase';

package/dist/types/utils/hslFromString/hslFromString.d.ts

@@ -0,0 +1,9 @@
+type Theme = 'light' | 'dark';
+/**
+ * Deterministic, functional mapper from (value, theme) -> HSL string.
+ * - Hue spans full 0..359 based on a stable FNV-1a hash of the string.
+ * - Saturation/Lightness are derived from disjoint hash segments and
+ *   constrained to your specified ranges per theme.
+ */
+export declare const hslFromString: (value: string, theme: Theme) => string;
+export {};

package/dist/types/utils/hslFromString/index.d.ts

@@ -0,0 +1 @@
+export * from './hslFromString';

package/dist/types/utils/index.d.ts

@@ -10,3 +10,13 @@ export * from './groupsToTreeData';
 export * from './getGroupsByCategory';
 export * from './createContextFactory';
 export * from './prepareUrlsToFetchForDynamicRenderer';
+export * from './deepMerge';
+export * from './getSortedKinds';
+export * from './getSortedKindsAll';
+export * from './hslFromString';
+export * from './getUppercase';
+export * from './kindByGvr';
+export * from './pluralByKind';
+export * from './namespacedByGvr';
+export * from './tableLocations';
+export * from './isMultilineString';

package/dist/types/utils/isMultilineString/index.d.ts

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

package/dist/types/utils/isMultilineString/isMultilineString.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Determines if a string should be treated as multiline in YAML
+ * @param value - The string value to check
+ * @returns true if the string should be multiline, false otherwise
+ */
+export declare const isMultilineString: (value: string) => boolean;
+/**
+ * Determines if a string should be treated as multiline based on YAML content
+ * @param yamlContent - The YAML content to analyze
+ * @param fieldPath - The path to the field in the YAML
+ * @returns true if the field should be multiline, false otherwise
+ */
+export declare const isMultilineFromYaml: (yamlContent: string, fieldPath: string[]) => boolean;

package/dist/types/utils/isMultilineString/isMultilineString.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/utils/kindByGvr/index.d.ts

@@ -0,0 +1 @@
+export * from './kindByGvr';

package/dist/types/utils/kindByGvr/kindByGvr.d.ts

@@ -0,0 +1,6 @@
+import { TKindWithVersion } from '../../localTypes/search';
+/**
+ * Build a lookup function: given "group~version~resource" return the unique kind.
+ * Functional, side-effect free, and tolerant of empty group (e.g. "~v1~bindings").
+ */
+export declare const kindByGvr: (entries: readonly TKindWithVersion[]) => (gvr: string) => string | undefined;

package/dist/types/utils/namespacedByGvr/index.d.ts

@@ -0,0 +1 @@
+export * from './namespacedByGvr';

package/dist/types/utils/namespacedByGvr/namespacedByGvr.d.ts

@@ -0,0 +1,6 @@
+import { TKindWithVersion } from '../../localTypes/search';
+/**
+ * Build a lookup function: given "group~version~resource" return the unique namespaced value.
+ * Functional, side-effect free, and tolerant of empty group (e.g. "~v1~bindings").
+ */
+export declare const namespacedByGvr: (entries: readonly TKindWithVersion[]) => (gvr: string) => boolean | undefined;

package/dist/types/utils/pluralByKind/index.d.ts

@@ -0,0 +1 @@
+export * from './pluralByKind';

package/dist/types/utils/pluralByKind/pluralByKind.d.ts

@@ -0,0 +1,10 @@
+import { TKindWithVersion } from '../../localTypes/search';
+type ApiVersion = string;
+/**
+ * Build a lookup function: given (kind, apiVersion?) return the plural resource.
+ * - apiVersion can be "group/version" or just "v1" for core.
+ * - If apiVersion is omitted, we return the plural for the preferred version of that kind.
+ * - Returns undefined if not uniquely determined.
+ */
+export declare const pluralByKind: (entries: readonly TKindWithVersion[]) => (kind: string, apiVersion?: ApiVersion) => string | undefined;
+export {};

package/dist/types/utils/tableLocations/index.d.ts

@@ -0,0 +1 @@
+export * from './tableLocations';

package/dist/types/utils/tableLocations/tableLocations.d.ts

@@ -0,0 +1,36 @@
+export declare const getBackLinkToTable: ({ fullPath }: {
+    fullPath: string;
+}) => string;
+export declare const getLinkToBuiltinForm: ({ cluster, baseprefix, namespace, syntheticProject, typeName, inside, fullPath, }: {
+    cluster: string;
+    baseprefix?: string | undefined;
+    namespace?: string | undefined;
+    syntheticProject?: string | undefined;
+    typeName: string;
+    inside?: boolean | undefined;
+    fullPath: string;
+}) => string;
+export declare const getLinkToApiForm: ({ cluster, baseprefix, namespace, syntheticProject, apiGroup, apiVersion, typeName, inside, fullPath, }: {
+    cluster: string;
+    baseprefix?: string | undefined;
+    namespace?: string | undefined;
+    syntheticProject?: string | undefined;
+    apiGroup?: string | undefined;
+    apiVersion?: string | undefined;
+    typeName: string;
+    inside?: boolean | undefined;
+    fullPath: string;
+    searchMount?: boolean | undefined;
+}) => string;
+export declare const getLinkToForm: ({ apiGroup, ...rest }: {
+    cluster: string;
+    baseprefix?: string | undefined;
+    namespace?: string | undefined;
+    syntheticProject?: string | undefined;
+    apiGroup?: string | undefined;
+    apiVersion?: string | undefined;
+    typeName: string;
+    inside?: boolean | undefined;
+    fullPath: string;
+    searchMount?: boolean | undefined;
+}) => string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@prorobotech/openapi-k8s-toolkit",
-  "version": "0.0.1-alpha.99",
+  "version": "1.1.0-alpha.1",
   "description": "ProRobotech OpenAPI k8s tools",
   "main": "dist/openapi-k8s-toolkit.cjs.js",
   "module": "dist/openapi-k8s-toolkit.es.js",
@@ -47,13 +47,14 @@
     "@xterm/addon-attach": "0.11.0",
     "@xterm/addon-fit": "0.10.0",
     "@xterm/xterm": "5.5.0",
-    "axios": "1.4.0",
+    "axios": "1.12.2",
     "cross-env": "7.0.3",
     "dotenv": "16.4.7",
     "jsonpath": "1.1.1",
     "lodash": "4.17.21",
     "openapi-types": "12.1.3",
     "react-redux": "9.1.2",
+    "spoiled": "0.4.0",
     "styled-components": "6.0.7",
     "typescript": "4.9.5",
     "usehooks-ts": "3.1.1",