@camstack/ui-library 1.2.252 → 1.2.253

package/dist/composites/config-secret-field.d.ts

@@ -1,15 +1,34 @@
-import { ConfigField } from '@camstack/types';
+import { ConfigField, SecretFieldView } from '@camstack/types';
 import { ReactNode } from 'react';
-/** How long a revealed value stays on screen. */
-export declare const SECRET_REVEAL_MS = 10000;
 /** Returns the stored value of a ref (audited by the host). */
 export type SecretRevealFn = (ref: string) => Promise<string>;
+/** How long the System → Secrets page shows a revealed value. */
+export declare const SECRET_REVEAL_MS = 10000;
+/** What an untouched stored secret shows in place of its value. */
+export declare const SECRET_MASK_PLACEHOLDER = "\u2022\u2022\u2022\u2022\u2022\u2022\u2022\u2022";
 export declare function SecretRevealProvider({ reveal, children, }: {
     readonly reveal: SecretRevealFn;
     readonly children: ReactNode;
 }): import("react").JSX.Element;
 /** Does this value belong to the keychain rendering (a view, or "not set")? */
 export declare function isKeychainFieldValue(value: unknown): boolean;
+/**
+ * What the operator has done to the field. `untouched` shows nothing and
+ * sends nothing; `visible` holds text the operator can see — revealed (then
+ * `revealed` is the stored value) or typed.
+ */
+export type SecretEntry = {
+    readonly kind: 'untouched';
+} | {
+    readonly kind: 'visible';
+    readonly text: string;
+    readonly revealed: string | null;
+};
+/**
+ * The value the form sends for an entry. `stored` — something is stored (or
+ * already marked for removal) — is what makes an emptied box a CLEAR.
+ */
+export declare function secretSubmitValue(entry: SecretEntry, original: SecretFieldView | null, stored: boolean): unknown;
 export interface SecretFieldProps {
     readonly field: ConfigField;
     /** The view (or null) the form was hydrated with, or what the operator has done since. */

package/dist/composites/index.d.ts

@@ -55,7 +55,7 @@ export * from './code-block';
 export type { TranslationFn } from './config-form-builder';
 export { ConfigFormBuilder } from './config-form-builder';
 export type { ProbeState } from './config-form-field';
-export { isKeychainFieldValue, SECRET_REVEAL_MS, SecretFieldControl, type SecretFieldProps, type SecretRevealFn, SecretRevealProvider, } from './config-secret-field';
+export { isKeychainFieldValue, SECRET_MASK_PLACEHOLDER, SECRET_REVEAL_MS, type SecretEntry, SecretFieldControl, type SecretFieldProps, secretSubmitValue, type SecretRevealFn, SecretRevealProvider, } from './config-secret-field';
 export { ConfigFormField, isFieldVisible, NodeMultiSelectField, NodeSelectField, } from './config-form-field';
 export type { ConfirmActionButtonProps } from './confirm-action-button';
 export { ConfirmActionButton } from './confirm-action-button';