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

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

@@ -53,26 +53,26 @@ export type TDynamicComponentsAppTypeMap = {
     };
     ProjectInfoCard: {
         id: number | string;
-        clusterNamePartOfUrl: string;
-        namespacePartOfUrl: string;
+        cluster: string;
+        namespace: string;
         baseApiGroup: string;
         baseApiVersion: string;
         baseProjectApiGroup: string;
         baseProjectVersion: string;
-        projectResourceName: string;
-        mpResourceName: string;
+        projectPlural: string;
+        marketplacePlural: string;
         accessGroups: string[];
         baseprefix?: string;
         showZeroResources?: boolean;
     };
     MarketplaceCard: {
         id: number | string;
-        clusterNamePartOfUrl: string;
-        namespacePartOfUrl: string;
+        cluster: string;
+        namespace: string;
         baseApiGroup: string;
         baseApiVersion: string;
-        mpResourceName: string;
-        mpResourceKind: string;
+        marketplacePlural: string;
+        marketplaceKind: string;
         baseprefix?: string;
         standalone?: boolean;
         forceAddedMode?: boolean;
@@ -104,13 +104,14 @@ export type TDynamicComponentsAppTypeMap = {
         id: number | string;
         fetchUrl?: string;
         k8sResourceToFetch?: {
-            group?: string;
-            version: string;
+            apiGroup?: string;
+            apiVersion: string;
             plural: string;
             namespace?: string;
         };
         pathToItems: string | string[];
-        clusterNamePartOfUrl: string;
+        additionalReqsDataToEachItem?: number[];
+        cluster: string;
         labelSelector?: Record<string, string>;
         labelSelectorFull?: {
             reqIndex: number;
@@ -145,7 +146,7 @@ export type TDynamicComponentsAppTypeMap = {
         type: 'builtin' | 'apis';
         apiGroup?: string;
         apiVersion?: string;
-        typeName: string;
+        plural: string;
         forcedKind?: string;
         prefillValuesRequestIndex: number;
         pathToData?: string | string[];
@@ -313,7 +314,7 @@ export type TDynamicComponentsAppTypeMap = {
     Events: {
         id: number | string;
         baseprefix?: string;
-        clusterNamePartOfUrl: string;
+        cluster: string;
         wsUrl: string;
         pageSize?: number;
         substractHeight?: number;
@@ -329,13 +330,13 @@ export type TDynamicComponentsAppTypeMap = {
         baseFactoryNamespacedBuiltinKey: string;
         baseFactoryClusterSceopedBuiltinKey: string;
         baseNamespaceFactoryKey: string;
-        baseNavigationPluralName: string;
-        baseNavigationSpecificName: string;
+        baseNavigationPlural: string;
+        baseNavigationName: string;
     };
     OwnerRefs: {
         id: number | string;
         baseprefix?: string;
-        clusterNamePartOfUrl: string;
+        cluster: string;
         reqIndex: string;
         errorText: string;
         notArrayErrorText: string;
@@ -344,13 +345,57 @@ export type TDynamicComponentsAppTypeMap = {
         containerStyle?: CSSProperties;
         listFlexProps?: FlexProps;
         jsonPathToArrayOfRefs: string;
+        forcedApiVersion?: {
+            kind: string;
+            apiVersion: string;
+        }[];
+        forcedNamespace?: string;
         keysToForcedLabel?: string | string[];
         forcedRelatedValuePath?: string;
         baseFactoryNamespacedAPIKey: string;
         baseFactoryClusterSceopedAPIKey: string;
         baseFactoryNamespacedBuiltinKey: string;
         baseFactoryClusterSceopedBuiltinKey: string;
-        baseNavigationPluralName: string;
-        baseNavigationSpecificName: string;
+        baseNavigationPlural: string;
+        baseNavigationName: string;
+    };
+    Toggler: {
+        id: number | string;
+        reqIndex: string;
+        jsonPathToValue: string;
+        criteria: {
+            type: 'forSuccess' | 'forError';
+            operator: 'exists' | 'equals';
+            valueToCompare?: string;
+        };
+        notificationSuccessMessage?: string;
+        notificationErrorMessage?: string;
+        notificationSuccessMessageDescription?: string;
+        notificationErrorMessageDescription?: string;
+        containerStyle?: CSSProperties;
+        endpoint: string;
+        pathToValue: string;
+        valueToSubmit: {
+            onValue: any;
+            offValue?: any;
+            toRemoveWhenOff?: boolean;
+        };
+    };
+    TogglerSegmented: {
+        id: number | string;
+        reqIndex: string;
+        jsonPathToValue: string;
+        notificationSuccessMessage?: string;
+        notificationErrorMessage?: string;
+        notificationSuccessMessageDescription?: string;
+        notificationErrorMessageDescription?: string;
+        containerStyle?: CSSProperties;
+        endpoint: string;
+        pathToValue: string;
+        possibleValues: any[];
+        valuesMap?: {
+            value: any;
+            renderedValue: string | number;
+        }[];
     };
 };

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

@@ -1,24 +1,24 @@
 import { TApiResources } from '../localTypes/k8s';
-export declare const useApiResources: ({ clusterName, namespace, apiGroup, apiVersion, typeName, specificName, labels, fields, limit, refetchInterval, isEnabled, }: {
-    clusterName: string;
+export declare const useApiResources: ({ cluster, namespace, apiGroup, apiVersion, plural, name, labels, fields, limit, refetchInterval, isEnabled, }: {
+    cluster: string;
     namespace?: string | undefined;
     apiGroup: string;
     apiVersion: string;
-    typeName: string;
-    specificName?: string | undefined;
+    plural: string;
+    name?: string | undefined;
     labels?: string[] | undefined;
     fields?: string[] | undefined;
     limit: string | null;
     refetchInterval?: number | false | undefined;
     isEnabled?: boolean | undefined;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<TApiResources, Error>;
-export declare const useApiResourceSingle: ({ clusterName, namespace, apiGroup, apiVersion, typeName, entryName, refetchInterval, }: {
-    clusterName: string;
+export declare const useApiResourceSingle: ({ cluster, namespace, apiGroup, apiVersion, plural, name, refetchInterval, }: {
+    cluster: string;
     namespace?: string | undefined;
     apiGroup: string;
     apiVersion: string;
-    typeName: string;
-    entryName: string;
+    plural: string;
+    name: string;
     refetchInterval?: number | false | undefined;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{
     metadata: {

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

@@ -1,5 +1,5 @@
-export declare const useApisResourceTypes: ({ clusterName }: {
-    clusterName: string;
+export declare const useApisResourceTypes: ({ cluster }: {
+    cluster: string;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{
     apiVersion: string;
     kind: string;
@@ -15,8 +15,8 @@ export declare const useApisResourceTypes: ({ clusterName }: {
         };
     }[];
 }, Error>;
-export declare const useApiResourceTypesByGroup: ({ clusterName, apiGroup, apiVersion, }: {
-    clusterName: string;
+export declare const useApiResourceTypesByGroup: ({ cluster, apiGroup, apiVersion, }: {
+    cluster: string;
     apiGroup: string;
     apiVersion: string;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{

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

@@ -1,20 +1,20 @@
 import { TBuiltinResources } from '../localTypes/k8s';
-export declare const useBuiltinResources: ({ clusterName, namespace, typeName, specificName, labels, fields, limit, refetchInterval, isEnabled, }: {
-    clusterName: string;
+export declare const useBuiltinResources: ({ cluster, namespace, plural, name, labels, fields, limit, refetchInterval, isEnabled, }: {
+    cluster: string;
     namespace?: string | undefined;
-    typeName: string;
-    specificName?: string | undefined;
+    plural: string;
+    name?: string | undefined;
     labels?: string[] | undefined;
     fields?: string[] | undefined;
     limit: string | null;
     refetchInterval?: number | false | undefined;
     isEnabled?: boolean | undefined;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<TBuiltinResources, Error>;
-export declare const useBuiltinResourceSingle: ({ clusterName, namespace, typeName, entryName, refetchInterval, }: {
-    clusterName: string;
+export declare const useBuiltinResourceSingle: ({ cluster, namespace, plural, name, refetchInterval, }: {
+    cluster: string;
     namespace?: string | undefined;
-    typeName: string;
-    entryName: string;
+    plural: string;
+    name: string;
     refetchInterval?: number | false | undefined;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{
     metadata: {

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

@@ -1,4 +1,4 @@
 import { TBuiltinResourceTypeList } from '../localTypes/k8s';
-export declare const useBuiltinResourceTypes: ({ clusterName }: {
-    clusterName: string;
+export declare const useBuiltinResourceTypes: ({ cluster }: {
+    cluster: string;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<TBuiltinResourceTypeList, Error>;

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

@@ -1,5 +1,5 @@
-export declare const useCrdData: ({ clusterName, apiExtensionVersion, crdName, }: {
-    clusterName: string;
+export declare const useCrdData: ({ cluster, apiExtensionVersion, crdName, }: {
+    cluster: string;
     apiExtensionVersion: string;
     crdName: string;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{

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

@@ -1,6 +1,6 @@
 import { TJSON } from '../localTypes/JSON';
-export declare const useCrdResources: <T = TJSON[]>({ clusterName, namespace, apiGroup, apiVersion, crdName, refetchInterval, isEnabled, }: {
-    clusterName: string;
+export declare const useCrdResources: <T = TJSON[]>({ cluster, namespace, apiGroup, apiVersion, crdName, refetchInterval, isEnabled, }: {
+    cluster: string;
     namespace?: string | undefined;
     apiGroup: string;
     apiVersion: string;
@@ -19,13 +19,13 @@ export declare const useCrdResources: <T = TJSON[]>({ clusterName, namespace, ap
         reason?: string | undefined;
     } | undefined;
 }, Error>;
-export declare const useCrdResourceSingle: ({ clusterName, namespace, apiGroup, apiVersion, crdName, entryName, refetchInterval, }: {
-    clusterName: string;
+export declare const useCrdResourceSingle: ({ cluster, namespace, apiGroup, apiVersion, crdName, name, refetchInterval, }: {
+    cluster: string;
     namespace?: string | undefined;
     apiGroup: string;
     apiVersion: string;
     crdName: string;
-    entryName: string;
+    name: string;
     refetchInterval?: number | false | undefined;
 }) => import("@tanstack/react-query/build/legacy/types").UseQueryResult<{
     metadata: {

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

@@ -0,0 +1,4 @@
+export { useK8sSmartResource } from './useK8sSmartResource';
+export type { TUseK8sSmartResourceParams } from './useK8sSmartResourceWithoutKinds';
+export { useManyK8sSmartResource } from './useManyK8sSmartResource';
+export { useSmartResourceParams } from './useSmartResourceParams';

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

@@ -0,0 +1,28 @@
+import { type TUseK8sSmartResourceParams } from './useK8sSmartResourceWithoutKinds';
+/**
+ * If T has an `{ items: U[] }` field, we add `kind?: string` and `apiVersion?: string` to each item.
+ * Otherwise T is left unchanged.
+ */
+type TWithKindAndApiVersionOnItems<T> = T extends {
+    items: (infer U)[];
+} ? Omit<T, 'items'> & {
+    items: (U & {
+        kind?: string;
+        apiVersion?: string;
+    })[];
+} : T;
+/**
+ * Same params as useK8sSmartResource.
+ * Returns the same shape as useK8sSmartResource,
+ * but if `data.items` exists, items are enriched with `kind`.
+ */
+export declare const useK8sSmartResource: <T>(params: TUseK8sSmartResourceParams<T>) => {
+    data: TWithKindAndApiVersionOnItems<T> | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error: string | Error | import("axios").AxiosError<unknown, any> | undefined;
+    _meta?: {
+        used: "disabled" | "list" | "watch" | "verbs-loading" | "verbs-error";
+    } | undefined;
+};
+export {};

package/dist/types/hooks/{useK8sSmartResource.d.ts → useK8sSmartResource/useK8sSmartResourceWithoutKinds.d.ts}

@@ -1,9 +1,9 @@
 import { AxiosError } from 'axios';
-import { TSingleResource } from '../localTypes/k8s';
+import { TSingleResource } from '../../localTypes/k8s';
 export type TUseK8sSmartResourceParams<T> = {
     cluster: string;
-    group?: string;
-    version: string;
+    apiGroup?: string;
+    apiVersion: string;
     plural: string;
     namespace?: string;
     fieldSelector?: string;
@@ -25,5 +25,5 @@ type SmartResult<T> = {
         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 declare const useK8sSmartResourceWithoutKinds: <T>({ cluster, apiGroup, apiVersion, plural, namespace, fieldSelector, labelSelector, isEnabled, listRefetchInterval, limit, mapListWatchState, }: TUseK8sSmartResourceParams<T>) => SmartResult<T>;
 export {};

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

@@ -0,0 +1,17 @@
+import type { TUseK8sSmartResourceParams } from './useK8sSmartResourceWithoutKinds';
+export declare const useManyK8sSmartResource: <T>(paramsList: readonly TUseK8sSmartResourceParams<T>[]) => {
+    data: (T extends {
+        items: (infer U)[];
+    } ? Omit<T, "items"> & {
+        items: (U & {
+            kind?: string | undefined;
+            apiVersion?: string | undefined;
+        })[];
+    } : T) | undefined;
+    isLoading: boolean;
+    isError: boolean;
+    error: string | Error | import("axios").AxiosError<unknown, any> | undefined;
+    _meta?: {
+        used: "disabled" | "list" | "watch" | "verbs-loading" | "verbs-error";
+    } | undefined;
+}[];

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

@@ -0,0 +1,9 @@
+import type { TUseK8sSmartResourceParams } from './useK8sSmartResourceWithoutKinds';
+/**
+ * A single hook whose return value is a plain constant array,
+ * safe to pass to `useManyK8sSmartResource`.
+ */
+export declare const useSmartResourceParams: ({ cluster, namespace }: {
+    cluster: string;
+    namespace?: string | undefined;
+}) => TUseK8sSmartResourceParams<unknown>[];

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

@@ -1,7 +1,7 @@
-export declare const usePermissions: ({ clusterName, namespace, group, resource, verb, name, refetchInterval, enabler, }: {
-    clusterName: string;
-    group?: string | undefined;
-    resource: string;
+export declare const usePermissions: ({ cluster, namespace, apiGroup, plural, verb, name, refetchInterval, enabler, }: {
+    cluster: string;
+    apiGroup?: string | undefined;
+    plural: string;
     namespace?: string | undefined;
     name?: string | undefined;
     verb: 'create' | 'delete' | 'patch' | 'update';

package/dist/types/index.d.ts

@@ -26,7 +26,7 @@ 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 { useK8sSmartResource, useManyK8sSmartResource, useSmartResourceParams } 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/dist/types/localTypes/bff/form.d.ts

@@ -5,24 +5,24 @@ import { TFormPrefill } from '../formExtensions';
 export type TPrepareFormReq = {
     data: {
         type: 'builtin';
-        typeName: string;
+        plural: string;
         prefillValuesSchema?: TJSON;
         prefillValueNamespaceOnly?: string;
     } | {
         type: 'apis';
         apiGroup: string;
         apiVersion: string;
-        typeName: string;
+        plural: string;
         prefillValuesSchema?: TJSON;
         prefillValueNamespaceOnly?: string;
     };
-    clusterName: string;
+    cluster: string;
     customizationId?: string;
 };
 export type TPrepareFormRes = {
     result: 'error';
     error: string | undefined;
-    kindName: string | undefined;
+    kind: string | undefined;
     fallbackToManualMode: true;
     isNamespaced: boolean;
 } | {
@@ -35,7 +35,7 @@ export type TPrepareFormRes = {
     expandedPaths: string[][] | undefined;
     persistedPaths: string[][] | undefined;
     sortPaths: string[][] | undefined;
-    kindName: string | undefined;
+    kind: string | undefined;
     isNamespaced: boolean;
     formPrefills?: TFormPrefill;
     namespacesData?: string[];

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

@@ -1,17 +1,17 @@
 import { TApiGroupResourceTypeList, TBuiltinResourceTypeList } from '../k8s';
 export type TCheckIfApiInstanceNamespaceScopedReq = {
-    typeName: string;
+    plural: string;
     apiGroup: string;
     apiVersion: string;
-    clusterName: string;
+    cluster: string;
 };
 export type TCheckIfApiInstanceNamespaceScopedRes = {
     isClusterWide: boolean;
     isNamespaceScoped: boolean;
 };
 export type TCheckIfBuiltInInstanceNamespaceScopedReq = {
-    typeName: string;
-    clusterName: string;
+    plural: string;
+    cluster: string;
 };
 export type TCheckIfBuiltInInstanceNamespaceScopedRes = {
     isClusterWide: boolean;
@@ -22,12 +22,12 @@ export type TFilterIfApiInstanceNamespaceScopedReq = {
     data?: TApiGroupResourceTypeList;
     apiGroup: string;
     apiVersion: string;
-    clusterName: string;
+    cluster: string;
 };
 export type TFilterIfApiInstanceNamespaceScopedRes = TApiGroupResourceTypeList['resources'] | undefined;
 export type TFilterIfBuiltInInstanceNamespaceScopedReq = {
     namespace?: string;
     data?: TBuiltinResourceTypeList;
-    clusterName: string;
+    cluster: string;
 };
 export type TFilterIfBuiltInInstanceNamespaceScopedRes = TBuiltinResourceTypeList['resources'] | undefined;

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

@@ -3,10 +3,10 @@ export type TPrepareTableReq = {
     customizationId?: string;
     tableMappingsReplaceValues?: Record<string, string | undefined>;
     forceDefaultAdditionalPrinterColumns?: TAdditionalPrinterColumns;
-    clusterName: string;
+    cluster: string;
     namespace?: string;
     k8sResource?: {
-        resource: string;
+        plural: string;
         apiGroup?: string;
         apiVersion: string;
     };

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

@@ -19,8 +19,8 @@ export type TPersistedControls = {
     persistedKeys: TFormName[];
 };
 export type TUrlParams = {
-    clusterName?: string;
+    cluster?: string;
     namespace?: string;
     syntheticProject?: string;
-    entryName?: string;
+    name?: string;
 };

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

@@ -5,7 +5,7 @@ export type TMarketPlacePanel = {
     type: 'crd' | 'nonCrd' | 'built-in' | 'direct';
     apiGroup?: string;
     apiVersion?: string;
-    typeName?: string;
+    plural?: string;
     pathToNav?: string;
     tags: string[];
     disabled?: boolean;

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

@@ -1,6 +1,6 @@
 import { TApiGroupList, TBuiltinResourceTypeList } from '../../localTypes/k8s';
-export declare const getGroupsByCategory: ({ clusterName, apiGroupListData, builtinResourceTypesData, namespace, noncrds, }: {
-    clusterName: string;
+export declare const getGroupsByCategory: ({ cluster, apiGroupListData, builtinResourceTypesData, namespace, noncrds, }: {
+    cluster: string;
     namespace?: string | undefined;
     apiGroupListData?: {
         apiVersion: string;

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

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

package/package.json

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