@prorobotech/openapi-k8s-toolkit 1.5.0-alpha.1 → 1.5.0-alpha.2

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/BlackholeForm.d.ts

@@ -1,8 +1,8 @@
 import { FC } from 'react';
-import { OpenAPIV2 } from 'openapi-types';
 import { TJSON } from '../../../../../localTypes/JSON';
 import { TUrlParams } from '../../../../../localTypes/form';
 import { TFormPrefill } from '../../../../../localTypes/formExtensions';
+import { TFormSchemaProperties } from '../../../../../localTypes/formSchema';
 export type TBlackholeFormProps = {
     cluster: string;
     theme: 'light' | 'dark';
@@ -12,7 +12,7 @@ export type TBlackholeFormProps = {
         plural?: string;
     };
     formsPrefills?: TFormPrefill;
-    staticProperties: OpenAPIV2.SchemaObject['properties'];
+    staticProperties: TFormSchemaProperties;
     required: string[];
     hiddenPaths?: string[][];
     expandedPaths: string[][];

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/helpers/casts.d.ts

@@ -1,6 +1,6 @@
 import { MutableRefObject } from 'react';
-import { OpenAPIV2 } from 'openapi-types';
 import { TFormName } from '../../../../../../localTypes/form';
+import { TFormSchemaProperties } from '../../../../../../localTypes/formSchema';
 export declare const pathKey: (p: (string | number)[]) => string;
 /**
  * Recursively prunes schema properties that are marked as "additional"
@@ -10,7 +10,7 @@ export declare const pathKey: (p: (string | number)[]) => string;
  * @param values - The actual data values that correspond to the schema.
  * @returns A new pruned copy of the schema `properties`.
  */
-export declare const pruneAdditionalForValues: (props: OpenAPIV2.SchemaObject['properties'], values: Record<string, unknown>, blockedPathsRef: MutableRefObject<Set<string>>) => OpenAPIV2.SchemaObject['properties'];
+export declare const pruneAdditionalForValues: (props: TFormSchemaProperties, values: Record<string, unknown>, blockedPathsRef: MutableRefObject<Set<string>>) => TFormSchemaProperties;
 /**
  * Dynamically materializes (adds) new schema properties from the `values` object
  * whenever those properties correspond to `additionalProperties` in an OpenAPI schema.
@@ -36,8 +36,8 @@ export declare const pruneAdditionalForValues: (props: OpenAPIV2.SchemaObject['p
  *   - `toExpand`: list of field paths that should be expanded (e.g., in a UI)
  *   - `toPersist`: list of field paths that should be persisted (saved)
  */
-export declare const materializeAdditionalFromValues: (props: OpenAPIV2.SchemaObject['properties'], values: Record<string, unknown>, blockedPathsRef: MutableRefObject<Set<string>>) => {
-    props: OpenAPIV2.SchemaObject['properties'];
+export declare const materializeAdditionalFromValues: (props: TFormSchemaProperties, values: Record<string, unknown>, blockedPathsRef: MutableRefObject<Set<string>>) => {
+    props: TFormSchemaProperties;
     toExpand: TFormName[];
     toPersist: TFormName[];
 };

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/helpers/extractDefaultValue.d.ts

@@ -0,0 +1,4 @@
+export declare const extractStringDefault: (value: unknown) => string | undefined;
+export declare const extractNumberDefault: (value: unknown) => number | undefined;
+export declare const extractBooleanDefault: (value: unknown) => boolean | undefined;
+export declare const extractListInputDefault: (value: unknown) => string | string[] | undefined;

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/helpers/extractDefaultValue.test.d.ts

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

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/helpers/getSortedPropertyKeys.d.ts

@@ -1,9 +1,7 @@
-import { OpenAPIV2 } from 'openapi-types';
 import { TFormName } from '../../../../../../localTypes/form';
+import { TFormSchemaProperties } from '../../../../../../localTypes/formSchema';
 export declare const getSortedPropertyKeys: ({ name, sortPaths, properties, }: {
     name: TFormName;
     sortPaths?: string[][] | undefined;
-    properties: {
-        [name: string]: OpenAPIV2.SchemaObject;
-    };
+    properties: TFormSchemaProperties;
 }) => (string | number)[];

package/dist/types/components/molecules/BlackholeForm/organisms/BlackholeForm/utils.d.ts

@@ -1,7 +1,7 @@
-import { OpenAPIV2 } from 'openapi-types';
 import { TListInputCustomProps, TRangeInputCustomProps } from '../../../../../localTypes/formExtensions';
 import { TFormName, TExpandedControls, TNamespaceData, TPersistedControls, TUrlParams } from '../../../../../localTypes/form';
-export declare const getStringFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, namespaceData, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, }: {
+import { TFormSchemaNode, TFormSchemaProperties } from '../../../../../localTypes/formSchema';
+export declare const getStringFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, namespaceData, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, defaultValue, example, nullable, }: {
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -16,8 +16,11 @@ export declare const getStringFormItemFromSwagger: ({ name, arrKey, arrName, per
     }) => void;
     persistedControls: TPersistedControls;
     onRemoveByMinus?: (() => void) | undefined;
+    defaultValue?: string | undefined;
+    example?: string | undefined;
+    nullable?: boolean | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getEnumStringFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, options, persistedControls, onRemoveByMinus, }: {
+export declare const getEnumStringFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, options, persistedControls, onRemoveByMinus, defaultValue, example, nullable, }: {
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -32,8 +35,11 @@ export declare const getEnumStringFormItemFromSwagger: ({ name, arrKey, arrName,
     options: string[];
     persistedControls: TPersistedControls;
     onRemoveByMinus?: (() => void) | undefined;
+    defaultValue?: string | undefined;
+    example?: string | undefined;
+    nullable?: boolean | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getNumberFormItemFromSwagger: ({ isNumber, name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, }: {
+export declare const getNumberFormItemFromSwagger: ({ isNumber, name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, defaultValue, example, nullable, }: {
     isNumber?: boolean | undefined;
     name: TFormName;
     arrKey?: number | undefined;
@@ -48,6 +54,9 @@ export declare const getNumberFormItemFromSwagger: ({ isNumber, name, arrKey, ar
     }) => void;
     persistedControls: TPersistedControls;
     onRemoveByMinus?: (() => void) | undefined;
+    defaultValue?: number | undefined;
+    example?: number | undefined;
+    nullable?: boolean | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
 export declare const getRangeInputFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isEdit, persistedControls, customProps, urlParams, onRemoveByMinus, }: {
     name: TFormName;
@@ -63,7 +72,7 @@ export declare const getRangeInputFormItemFromSwagger: ({ name, arrKey, arrName,
     urlParams: TUrlParams;
     onRemoveByMinus?: (() => void) | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getStringMultilineFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, isBase64, }: {
+export declare const getStringMultilineFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, onRemoveByMinus, isBase64, defaultValue, example, nullable, }: {
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -78,8 +87,11 @@ export declare const getStringMultilineFormItemFromSwagger: ({ name, arrKey, arr
     persistedControls: TPersistedControls;
     onRemoveByMinus?: (() => void) | undefined;
     isBase64?: boolean | undefined;
+    defaultValue?: string | undefined;
+    example?: string | undefined;
+    nullable?: boolean | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getListInputFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, customProps, urlParams, onRemoveByMinus, }: {
+export declare const getListInputFormItemFromSwagger: ({ name, arrKey, arrName, persistName, required, forceNonRequired, description, isAdditionalProperties, removeField, persistedControls, customProps, urlParams, onRemoveByMinus, defaultValue, }: {
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -95,8 +107,9 @@ export declare const getListInputFormItemFromSwagger: ({ name, arrKey, arrName,
     customProps: TListInputCustomProps;
     urlParams: TUrlParams;
     onRemoveByMinus?: (() => void) | undefined;
+    defaultValue?: string | string[] | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getBooleanFormItemFromSwagger: ({ name, arrKey, arrName, description, makeValueUndefined, isAdditionalProperties, removeField, onRemoveByMinus, }: {
+export declare const getBooleanFormItemFromSwagger: ({ name, arrKey, arrName, description, makeValueUndefined, isAdditionalProperties, removeField, onRemoveByMinus, defaultValue, }: {
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -107,9 +120,10 @@ export declare const getBooleanFormItemFromSwagger: ({ name, arrKey, arrName, de
         path: TFormName;
     }) => void;
     onRemoveByMinus?: (() => void) | undefined;
+    defaultValue?: boolean | undefined;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getArrayFormItemFromSwagger: ({ schema, name, arrKey, arrName, expandName, persistName, required, forceNonRequired, description, makeValueUndefined, addField, isAdditionalProperties, removeField, isEdit, expandedControls, persistedControls, sortPaths, urlParams, onRemoveByMinus, }: {
-    schema: OpenAPIV2.SchemaObject;
+export declare const getArrayFormItemFromSwagger: ({ schema, name, arrKey, arrName, expandName, persistName, required, forceNonRequired, description, makeValueUndefined, addField, isAdditionalProperties, removeField, isEdit, expandedControls, persistedControls, objectValidationErrors, sortPaths, urlParams, onRemoveByMinus, }: {
+    schema: TFormSchemaNode;
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -123,10 +137,8 @@ export declare const getArrayFormItemFromSwagger: ({ schema, name, arrKey, arrNa
         path: TFormName;
         name: string;
         type: string;
-        items?: {
-            type: string;
-        } | undefined;
-        nestedProperties?: OpenAPIV2.SchemaObject['properties'];
+        items?: TFormSchemaNode | undefined;
+        nestedProperties?: TFormSchemaProperties | undefined;
         required?: string | undefined;
     }) => void;
     isAdditionalProperties?: boolean | undefined;
@@ -136,14 +148,13 @@ export declare const getArrayFormItemFromSwagger: ({ schema, name, arrKey, arrNa
     isEdit: boolean;
     expandedControls: TExpandedControls;
     persistedControls: TPersistedControls;
+    objectValidationErrors?: Record<string, string[]> | undefined;
     sortPaths?: string[][] | undefined;
     urlParams: TUrlParams;
     onRemoveByMinus?: (() => void) | undefined;
 }) => import("react/jsx-runtime").JSX.Element | null;
-export declare const getObjectFormItemsDraft: ({ properties, name, arrKey, arrName, expandName, persistName, required, forceNonRequired, description, namespaceData, makeValueUndefined, addField, removeField, isEdit, expandedControls, persistedControls, sortPaths, urlParams, }: {
-    properties: {
-        [name: string]: OpenAPIV2.SchemaObject;
-    };
+export declare const getObjectFormItemsDraft: ({ properties, name, arrKey, arrName, expandName, persistName, required, forceNonRequired, description, namespaceData, makeValueUndefined, addField, removeField, isEdit, expandedControls, persistedControls, objectValidationErrors, sortPaths, urlParams, }: {
+    properties: TFormSchemaProperties;
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -158,10 +169,8 @@ export declare const getObjectFormItemsDraft: ({ properties, name, arrKey, arrNa
         path: TFormName;
         name: string;
         type: string;
-        items?: {
-            type: string;
-        } | undefined;
-        nestedProperties?: OpenAPIV2.SchemaObject['properties'];
+        items?: TFormSchemaNode | undefined;
+        nestedProperties?: TFormSchemaProperties | undefined;
         required?: string | undefined;
     }) => void;
     removeField: ({ path }: {
@@ -170,13 +179,14 @@ export declare const getObjectFormItemsDraft: ({ properties, name, arrKey, arrNa
     isEdit: boolean;
     expandedControls: TExpandedControls;
     persistedControls: TPersistedControls;
+    objectValidationErrors?: Record<string, string[]> | undefined;
     sortPaths?: string[][] | undefined;
     urlParams: TUrlParams;
 }) => import("react/jsx-runtime").JSX.Element;
-export declare const getObjectFormItemFromSwagger: ({ properties, name, arrKey, arrName, expandName, persistName, selfRequired, required, forceNonRequired, description, namespaceData, makeValueUndefined, addField, isAdditionalProperties, removeField, isEdit, expandedControls, persistedControls, sortPaths, urlParams, onRemoveByMinus, }: {
-    properties: {
-        [name: string]: OpenAPIV2.SchemaObject;
-    };
+export declare const getObjectFormItemFromSwagger: ({ properties, oneOfRequiredGroups, objectValidationErrors, name, arrKey, arrName, expandName, persistName, selfRequired, required, forceNonRequired, description, namespaceData, makeValueUndefined, addField, isAdditionalProperties, removeField, isEdit, expandedControls, persistedControls, sortPaths, urlParams, onRemoveByMinus, }: {
+    properties: TFormSchemaProperties;
+    oneOfRequiredGroups?: string[][] | undefined;
+    objectValidationErrors?: Record<string, string[]> | undefined;
     name: TFormName;
     arrKey?: number | undefined;
     arrName?: TFormName | undefined;
@@ -192,10 +202,8 @@ export declare const getObjectFormItemFromSwagger: ({ properties, name, arrKey,
         path: TFormName;
         name: string;
         type: string;
-        items?: {
-            type: string;
-        } | undefined;
-        nestedProperties?: OpenAPIV2.SchemaObject['properties'];
+        items?: TFormSchemaNode | undefined;
+        nestedProperties?: TFormSchemaProperties | undefined;
         required?: string | undefined;
     }) => void;
     isAdditionalProperties?: boolean | undefined;

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

@@ -1,7 +1,7 @@
-import { OpenAPIV2 } from 'openapi-types';
 import { TJSON } from '../JSON';
 import { TFormName } from '../form';
 import { TFormPrefill } from '../formExtensions';
+import { TFormSchemaProperties } from '../formSchema';
 export type TPrepareFormReq = {
     data: {
         type: 'builtin';
@@ -30,9 +30,7 @@ export type TPrepareFormRes = {
     isNamespaced: boolean;
 } | {
     result: 'success';
-    properties: {
-        [name: string]: OpenAPIV2.SchemaObject;
-    };
+    properties: TFormSchemaProperties;
     required: string[] | undefined;
     hiddenPaths: string[][] | undefined;
     expandedPaths: string[][] | undefined;
@@ -47,11 +45,11 @@ export type TPrepareFormRes = {
 export type TYamlByValuesReq = {
     values: any;
     persistedKeys: TFormName[];
-    properties: OpenAPIV2.SchemaObject['properties'];
+    properties: TFormSchemaProperties;
 };
 export type TYamlByValuesRes = any;
 export type TValuesByYamlReq = {
     values: Record<string, unknown>;
-    properties: OpenAPIV2.SchemaObject['properties'];
+    properties: TFormSchemaProperties;
 };
 export type TValuesByYamlRes = any;

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

@@ -0,0 +1,27 @@
+export type TFormSchemaKnownType = 'string' | 'number' | 'integer' | 'boolean' | 'array' | 'object' | 'listInput' | 'multilineString' | 'multilineStringBase64' | 'rangeInputCpu' | 'rangeInputMemory';
+type TFormSchemaLooseType = TFormSchemaKnownType | (string & {});
+/**
+ * Mirror of the normalized form-schema contract returned by the BFF.
+ * Toolkit components should consume this type instead of raw OpenAPI v2 types.
+ */
+export interface TFormSchemaNode {
+    type?: TFormSchemaLooseType | TFormSchemaLooseType[];
+    properties?: TFormSchemaProperties;
+    items?: TFormSchemaNode;
+    additionalProperties?: boolean | TFormSchemaNode;
+    required?: string[];
+    enum?: string[];
+    oneOfRequiredGroups?: string[][];
+    default?: unknown;
+    example?: unknown;
+    nullable?: boolean;
+    description?: string;
+    customProps?: unknown;
+    isAdditionalProperties?: boolean;
+    'x-kubernetes-preserve-unknown-fields'?: boolean;
+    'x-kubernetes-int-or-string'?: boolean;
+}
+export interface TFormSchemaProperties {
+    [name: string]: TFormSchemaNode;
+}
+export {};

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

@@ -1,2 +1,2 @@
-import { OpenAPIV2 } from 'openapi-types';
-export declare const normalizeValuesForQuotasToNumber: (object: any, properties: OpenAPIV2.SchemaObject['properties']) => any;
+import { TFormSchemaProperties } from '../../localTypes/formSchema';
+export declare const normalizeValuesForQuotasToNumber: (object: any, properties: TFormSchemaProperties) => any;

package/package.json

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