@schema-forms-data/renderer 4.0.2 → 4.0.4

package/dist/index.d.ts

@@ -367,7 +367,7 @@ export declare interface FormApi {
     getState: () => FormStateSnapshot;
 }
 
-export declare const FormRenderer: ({ schema, initialValues, initialStep, onSubmitStep, onComplete, template, formTitle, externalData, fieldErrors, uploadFile, cepLookup, resolveTermsUploadUrl, fieldResolvers, validatorMapper, componentMapper, paymentMethodOptions, onValuesChange, className, StepIndicator, }: FormRendererProps) => JSX_2.Element;
+export declare const FormRenderer: ({ schema, initialValues, initialStep, onSubmitStep, onComplete, template, formTitle, externalData, fieldErrors, uploadFile, deleteUploadedFile, cepLookup, resolveTermsUploadUrl, fieldResolvers, validatorMapper, componentMapper, paymentMethodOptions, onValuesChange, className, StepIndicator, }: FormRendererProps) => JSX_2.Element;
 
 export declare interface FormRendererProps {
     schema: FormSchema;
@@ -384,8 +384,34 @@ export declare interface FormRendererProps {
     externalData?: Record<string, unknown>;
     /** Erros de campo vindos do servidor (ex: validação 422) */
     fieldErrors?: Record<string, string>;
+    /**
+     * Função para upload de arquivos (campos FILE).
+     * Recebe o `File`, o nome do campo e um callback opcional de progresso (0–100).
+     * Deve retornar o `uploadId` (string) que será armazenado no formulário.
+     *
+     * Quando não fornecida, o campo exibe apenas aviso de preview.
+     * @see RendererContextValue.uploadFile
+     */
     uploadFile?: RendererContextValue['uploadFile'];
+    /**
+     * Função para deletar um arquivo previamente enviado via `uploadFile`.
+     * Quando fornecida, `DFFileUpload` a chama automaticamente ao substituir um arquivo,
+     * evitando arquivos órfãos no storage. Erros são silenciados.
+     * @see RendererContextValue.deleteUploadedFile
+     */
+    deleteUploadedFile?: RendererContextValue['deleteUploadedFile'];
+    /**
+     * Função de lookup de CEP (8 dígitos sem máscara).
+     * Quando não fornecida, usa a API pública ViaCEP como fallback.
+     * @see RendererContextValue.cepLookup
+     */
     cepLookup?: RendererContextValue['cepLookup'];
+    /**
+     * Função para resolver a URL de preview de um PDF de termos armazenado.
+     * Recebe o `uploadId` e deve retornar uma URL temporária de visualização.
+     * Quando não fornecida, o campo TERMS usa `termoPdfUrl` ou `termoTexto` como fallback.
+     * @see RendererContextValue.resolveTermsUploadUrl
+     */
     resolveTermsUploadUrl?: RendererContextValue['resolveTermsUploadUrl'];
     /**
      * Mapa de resolvers de props de campo para `resolvePropsKey`.
@@ -605,6 +631,16 @@ export declare interface RendererContextValue {
      * Quando não fornecida, usa a API pública https://viacep.com.br (padrão).
      */
     cepLookup?: (cep: string, signal?: AbortSignal) => Promise<CepLookupResult>;
+    /**
+     * Função para deletar um arquivo previamente enviado pelo `uploadFile`.
+     * Recebe o uploadId retornado pelo `uploadFile`.
+     *
+     * Quando fornecida, `DFFileUpload` a chama automaticamente antes de
+     * fazer um novo upload (substituição), evitando arquivos órfãos no storage.
+     *
+     * Erros são silenciados para não bloquear o novo upload.
+     */
+    deleteUploadedFile?: (uploadId: string) => Promise<void>;
     /**
      * Função para resolver a URL de preview de um PDF de termos armazenado.
      * Recebe o uploadId e deve retornar a URL temporária de preview.