@dovetail-v2/refine 0.4.2-alpha.2 → 0.4.3

package/dist/components/Form/ExtraSubmitFooter.d.ts

@@ -0,0 +1,23 @@
+import React from 'react';
+import { RefineFormConfig } from 'src/types';
+import { type SaveButtonProps } from './FormModal';
+interface UseExtraSubmitFooterOptions {
+    action: 'create' | 'edit';
+    cancelText: React.ReactNode;
+    defaultSubmitText: React.ReactNode;
+    errorText: React.ReactNode;
+    extraSubmitButton?: RefineFormConfig['extraSubmitButton'];
+    fallbackFooter?: React.ReactNode;
+    isYamlMode: boolean;
+    nextStepText: React.ReactNode;
+    prevStepText: React.ReactNode;
+    saveButtonProps: SaveButtonProps;
+    step: number;
+    stepCount: number;
+    onCancel: () => void;
+    onNextStep: () => void;
+    onPrevStep: () => void;
+    onSubmit: (e: React.BaseSyntheticEvent) => void;
+}
+export declare function useExtraSubmitFooter({ action, cancelText, defaultSubmitText, errorText, extraSubmitButton, fallbackFooter, isYamlMode, nextStepText, prevStepText, saveButtonProps, step, stepCount, onCancel, onNextStep, onPrevStep, onSubmit, }: UseExtraSubmitFooterOptions): React.ReactNode;
+export {};

package/dist/components/Form/FormModal.d.ts

@@ -17,7 +17,7 @@ export interface ConfirmModalProps {
 }
 export type FormModalProps = {
     id?: string;
-    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig'>;
+    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig' | 'dataProviderName'>;
     yamlFormProps?: YamlFormProps;
     options?: {
         initialValues?: Record<string, unknown>;

package/dist/components/Form/RawYamlFormModal.d.ts

@@ -4,7 +4,7 @@ import { ResourceConfig } from 'src/types';
 import { YamlFormProps } from './YamlForm';
 type RawYamlFormModalProps = {
     id?: string;
-    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig'>;
+    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig' | 'dataProviderName'>;
     yamlFormProps?: YamlFormProps;
     onSuccess?: (data: UpdateResponse<BaseRecord> | CreateResponse<BaseRecord>) => void;
 };

package/dist/components/Form/RefineFormContainer.d.ts

@@ -7,7 +7,7 @@ import { YamlFormProps } from './YamlForm';
 interface RefineFormContainerProps {
     id: string;
     isYamlMode: boolean;
-    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'basePath' | 'formConfig'>;
+    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'basePath' | 'formConfig' | 'dataProviderName'>;
     step: number;
     formConfig: (RefineFormConfig & CommonFormConfig) | undefined;
     customYamlFormProps?: YamlFormProps;

package/dist/components/Form/useReactHookForm.d.ts

@@ -1,7 +1,6 @@
 import { BaseRecord, HttpError, UseFormProps as UseFormCoreProps, UseFormReturnType as UseFormReturnTypeCore } from '@refinedev/core';
 import React from 'react';
-import { DefaultValues } from 'react-hook-form';
-import { UseFormProps as UseHookFormProps, UseFormReturn, FieldValues } from 'react-hook-form';
+import { DefaultValues, UseFormProps as UseHookFormProps, UseFormReturn, FieldValues } from 'react-hook-form';
 export type UseFormReturnType<TQueryFnData extends BaseRecord = BaseRecord, TError extends HttpError = HttpError, TVariables extends FieldValues = FieldValues, TContext extends object = object, TData extends BaseRecord = TQueryFnData, TResponse extends BaseRecord = TData, TResponseError extends HttpError = TError> = UseFormReturn<TVariables, TContext> & {
     transformedInitValues: TVariables | undefined;
     refineCore: UseFormReturnTypeCore<TQueryFnData, TError, TVariables, TData, TResponse, TResponseError>;

package/dist/components/Form/useRefineForm.d.ts

@@ -9,7 +9,7 @@ interface UseRefineFormOptions {
 export declare const useRefineForm: (props: {
     formConfig?: RefineFormConfig & CommonFormConfig;
     id?: string;
-    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'formConfig'>;
+    resourceConfig: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'formConfig' | 'dataProviderName'>;
     refineProps?: UseFormProps['refineCoreProps'];
     options?: UseRefineFormOptions;
 }) => {

package/dist/hooks/use409Retry.d.ts

@@ -0,0 +1,68 @@
+import { Unstructured } from 'k8s-api-provider';
+import { MutableRefObject, ReactNode } from 'react';
+export type Retry409MetaOptions = {
+    /** 编辑表单打开时捕获的初始版本；通常由本 hook 自动捕获，外部一般不需要手动传入。 */
+    initialResource?: Unstructured;
+    /** provider 判断无法安全重试时抛出的本地化错误文案。 */
+    conflictMessage?: string;
+};
+type MutationMetaWith409Retry = Record<string, unknown> & {
+    /** 传给 k8s-api-provider 的 409 恢复内部参数。 */
+    resourceVersionConflictRetry?: Retry409MetaOptions;
+};
+type Use409RetryOptions = {
+    /** 当前表单动作；只有 edit 动作会启用 409 重试，create 会自动移除重试 meta。 */
+    action?: string;
+    /** 当前表单使用的数据源名称，用于找到对应 GlobalStore 并还原 raw YAML。 */
+    dataProviderName?: string;
+    /** 当前编辑资源的 id；部分调用链 action 不稳定时，用 id 作为 edit 场景的兜底判断。 */
+    id?: unknown;
+    /** 调用方原本要传给 refine useFormCore 的 mutationMeta，本 hook 会保留其它字段并覆盖内部 409 重试参数。 */
+    mutationMeta?: MutationMetaWith409Retry;
+};
+type Use409RetryResult = {
+    /** queryResult 拿到资源后调用，用来捕获打开编辑表单时的初始版本。 */
+    captureInitialResource: (resource?: Unstructured) => void;
+    /** 已合并 409 重试参数的 mutationMeta，应直接传给 refine useFormCore。 */
+    mutationMeta: Record<string, unknown>;
+};
+type InitialResourceRef = MutableRefObject<Unstructured | undefined>;
+type Retry409ProviderProps = {
+    /** 需要共享同一份初始版本的表单内容，例如同一个编辑弹窗内的 FORM 和 YAML 模式。 */
+    children?: ReactNode;
+};
+/**
+ * 为同一个编辑弹窗内的多个表单模式共享 409 重试初始版本。
+ *
+ * 背景：FORM 模式保存失败后，如果用户切换到 YAML 模式，YAML 表单会重新挂载。
+ * 如果每个模式都维护自己的初始版本，YAML 可能捕获到已经变化的服务端版本，
+ * 导致 provider 误以为初始版本和服务端版本一致，从而允许覆盖保存。
+ *
+ * 用法：在表单弹窗层包裹一次，内部所有 `use409Retry` 会共用同一个 ref。
+ *
+ * @param props - Provider 属性。
+ * @param props.children - 需要共享初始版本的子节点。
+ * @returns 包裹后的 React 节点。
+ */
+export declare function Retry409Provider({ children, }: Retry409ProviderProps): import("react").FunctionComponentElement<import("react").ProviderProps<InitialResourceRef | null>>;
+/**
+ * 为 D2 编辑表单接入 Kubernetes PUT 409 自动恢复能力。
+ *
+ * 背景：Kubernetes PUT 保存要求用户保存版本里的 `metadata.resourceVersion`
+ * 与服务端版本一致。如果用户编辑期间只有 status、managedFields 等运行时字段发生变化，
+ * D2 可以把打开表单时的初始版本交给 k8s-api-provider，由 provider 拉取服务端版本、
+ * 判断是否安全，并在安全时替换用户保存版本的 resourceVersion 后重试一次。
+ *
+ * 用法：FORM/YAML 表单在创建 refine useFormCore 前调用本 hook，把返回的 `mutationMeta`
+ * 传给 useFormCore；queryResult 首次拿到资源后调用 `captureInitialResource(data)`。
+ * D2 只负责捕获初始版本和传递本地化错误文案，比较、拉取服务端版本和重试都内聚在 provider。
+ *
+ * @param options - 409 重试接入配置。
+ * @param options.action - 当前表单动作；只有 edit 动作会启用 409 重试。
+ * @param options.dataProviderName - 当前表单使用的数据源名称，用于选择对应 GlobalStore。
+ * @param options.id - 当前编辑资源的 id，用作 edit 场景的兜底判断。
+ * @param options.mutationMeta - 调用方原本的 mutationMeta，本 hook 会保留其它字段并覆盖内部 409 重试参数。
+ * @returns 用于捕获初始版本的方法，以及应传给 useFormCore 的 mutationMeta。
+ */
+export declare function use409Retry({ action, dataProviderName, id, mutationMeta, }: Use409RetryOptions): Use409RetryResult;
+export {};

package/dist/hooks/useOpenForm.d.ts

@@ -2,7 +2,7 @@ import { CreateResponse, UpdateResponse, BaseRecord } from '@refinedev/core';
 import { ResourceConfig } from 'src/types';
 interface OpenFormOptions {
     id?: string;
-    resourceConfig?: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig'>;
+    resourceConfig?: Pick<ResourceConfig, 'name' | 'displayName' | 'kind' | 'initValue' | 'apiVersion' | 'basePath' | 'formConfig' | 'dataProviderName'>;
     resourceName?: string;
     initialValues?: Record<string, unknown>;
     customOptions?: Record<string, unknown>;

package/dist/i18n.d.ts

@@ -22,6 +22,8 @@ export declare const resources: {
             name: string;
             pod: string;
             cancel: string;
+            prev_step: string;
+            next_step: string;
             delete: string;
             create: string;
             confirm_delete_text: string;
@@ -187,6 +189,7 @@ export declare const resources: {
             data_expired: string;
             data_expired_body: string;
             data_expired_note: string;
+            resource_version_conflict: string;
             abandon_edit: string;
             exit_yaml_tip: string;
             value_optional: string;
@@ -298,6 +301,8 @@ export declare const resources: {
             copied: string;
             already_reset: string;
             cancel: string;
+            prev_step: string;
+            next_step: string;
             delete: string;
             create: string;
             delete_resource: string;
@@ -473,6 +478,7 @@ export declare const resources: {
             data_expired: string;
             data_expired_body: string;
             data_expired_note: string;
+            resource_version_conflict: string;
             abandon_edit: string;
             exit_yaml_tip: string;
             form: string;

package/dist/locales/en-US/index.d.ts

@@ -19,6 +19,8 @@ declare const _default: {
         name: string;
         pod: string;
         cancel: string;
+        prev_step: string;
+        next_step: string;
         delete: string;
         create: string;
         confirm_delete_text: string;
@@ -184,6 +186,7 @@ declare const _default: {
         data_expired: string;
         data_expired_body: string;
         data_expired_note: string;
+        resource_version_conflict: string;
         abandon_edit: string;
         exit_yaml_tip: string;
         value_optional: string;

package/dist/locales/zh-CN/index.d.ts

@@ -11,6 +11,8 @@ declare const _default: {
         copied: string;
         already_reset: string;
         cancel: string;
+        prev_step: string;
+        next_step: string;
         delete: string;
         create: string;
         delete_resource: string;
@@ -186,6 +188,7 @@ declare const _default: {
         data_expired: string;
         data_expired_body: string;
         data_expired_note: string;
+        resource_version_conflict: string;
         abandon_edit: string;
         exit_yaml_tip: string;
         form: string;