@saasbase-io/core-elements 1.21.1 → 1.22.0

package/dist/components/renderers/_updated/field/_confirm-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { ConfirmFieldContent, ConfirmFieldProps, ConfirmFieldVariant } from './field.types';
+import { ConfirmFieldContent, ConfirmFieldProps, ConfirmFieldValidation, ConfirmFieldVariant } from './field.types';
 /**
  * A self-validating confirm password field for auth widget forms.
  * @element sb-confirm-field
@@ -44,13 +44,11 @@ export declare class SbConfirmField extends LitElement implements ConfirmFieldPr
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -104,6 +102,11 @@ export declare class SbConfirmField extends LitElement implements ConfirmFieldPr
      * When provided, the parent form cannot be submitted without this field.
      */
     required?: boolean;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: ConfirmFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -191,25 +194,16 @@ export declare class SbConfirmField extends LitElement implements ConfirmFieldPr
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
-     */
-    private _validateRequired;
-    /**
-     * Handles the match condition validation, obtaining the paired field's value,
-     * comparing it to the confirm field's value, dispatching and displaying the
-     * match error if the values do not match.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateMatch;
+    private _handleValidateSuccess;
     /**
-     * Resets the `_invalid` and `_error` private props and dispatches the
-     * validate event, indicating a successfully validated and valid confirm.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _doValidateSuccess;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required,
-     * length, and format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_email-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { EmailFieldContent, EmailFieldProps } from './field.types';
+import { EmailFieldContent, EmailFieldProps, EmailFieldValidation } from './field.types';
 /**
  * A self-validating email field for auth widget forms.
  * @element sb-email-field
@@ -45,13 +45,11 @@ export declare class SbEmailField extends LitElement implements EmailFieldProps
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -96,6 +94,11 @@ export declare class SbEmailField extends LitElement implements EmailFieldProps
      * When provided, the parent form cannot be submitted without this field.
      */
     required?: boolean;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: EmailFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -182,20 +185,16 @@ export declare class SbEmailField extends LitElement implements EmailFieldProps
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateRequired;
+    private _handleValidateSuccess;
     /**
-     * Handles the format condition validation with `_PATTERN`, accepting empty
-     * non-required fields and non-empty fields that satisfy the pattern,
-     * otherwise dispatching and displaying the format error.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _validateFormat;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required and
-     * format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_identifier-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { IdentifierFieldAutocomplete, IdentifierFieldContent, IdentifierFieldIdentifier, IdentifierFieldProps } from './field.types';
+import { IdentifierFieldAutocomplete, IdentifierFieldContent, IdentifierFieldIdentifier, IdentifierFieldProps, IdentifierFieldValidation } from './field.types';
 /**
  * A self-validating identifier field for auth widget forms.
  * @element sb-identifier-field
@@ -102,6 +102,11 @@ export declare class SbIdentifierField extends LitElement implements IdentifierF
      * When provided, the parent form cannot be submitted without this field.
      */
     required?: boolean;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: IdentifierFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -194,14 +199,16 @@ export declare class SbIdentifierField extends LitElement implements IdentifierF
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
+     * Clears the invalid state and error, and dispatches a valid validate event.
+     */
+    private _handleValidateSuccess;
+    /**
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _validateRequired;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required
-     * condition is met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_name-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { NameFieldContent, NameFieldProps } from './field.types';
+import { NameFieldContent, NameFieldProps, NameFieldValidation } from './field.types';
 /**
  * A self-validating name field for auth widget forms.
  * @element sb-name-field
@@ -45,13 +45,11 @@ export declare class SbNameField extends LitElement implements NameFieldProps {
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -108,6 +106,11 @@ export declare class SbNameField extends LitElement implements NameFieldProps {
      * The regex pattern for a valid name, used in place of `_PATTERN`.
      */
     pattern?: string;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: NameFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -213,36 +216,16 @@ export declare class SbNameField extends LitElement implements NameFieldProps {
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
-     */
-    private _validateRequired;
-    /**
-     * Handles the minlength condition validation, determining if a valid
-     * `minlength` prop was provided, dispatching and displaying the minlength
-     * error if the value is shorter than accepted.
-     */
-    private _validateMinlength;
-    /**
-     * Handles the maxlength condition validation, determining if a valid
-     * `maxlength` prop was provided, dispatching and displaying the maxlength
-     * error if the value is longer than accepted.
-     */
-    private _validateMaxlength;
-    /**
-     * Handles the format condition validation, testing against `_pattern`, and
-     * dispatching and displaying the format error for an invalid value.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateFormat;
+    private _handleValidateSuccess;
     /**
-     * Resets the `_invalid` and `_error` private props and dispatches the
-     * validate event, indicating a successfully validated and valid name.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _doValidateSuccess;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required,
-     * length, and format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_password-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { PasswordFieldContent, PasswordFieldProps, PasswordFieldRule, PasswordFieldVariant } from './field.types';
+import { PasswordFieldContent, PasswordFieldProps, PasswordFieldRule, PasswordFieldValidation, PasswordFieldVariant } from './field.types';
 /**
  * A self-validating password field for auth widget forms.
  * @element sb-password-field
@@ -45,13 +45,11 @@ export declare class SbPasswordField extends LitElement implements PasswordField
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -114,6 +112,11 @@ export declare class SbPasswordField extends LitElement implements PasswordField
      * each rule, as well as an optional `error` message pairing.
      */
     rules: PasswordFieldRule[];
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: PasswordFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -210,37 +213,16 @@ export declare class SbPasswordField extends LitElement implements PasswordField
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
-     */
-    private _validateRequired;
-    /**
-     * Handles the minlength condition validation, determining if a valid
-     * `minlength` prop was provided, dispatching and displaying the minlength
-     * error if the value is shorter than accepted.
-     */
-    private _validateMinlength;
-    /**
-     * Handles the maxlength condition validation, determining if a valid
-     * `maxlength` prop was provided, dispatching and displaying the maxlength
-     * error if the value is longer than accepted.
-     */
-    private _validateMaxlength;
-    /**
-     * Handles the format condition validation, testing against each of the
-     * `rules` patterns, and dispatching and displaying the relevant or fallback
-     * format error(s) for an invalid value.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateFormat;
+    private _handleValidateSuccess;
     /**
-     * Resets the `_invalid` and `_errors` private props and dispatches the
-     * validate event, indicating a successfully validated and valid password.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _doValidateSuccess;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required,
-     * length, and format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_phone-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { PhoneFieldContent, PhoneFieldProps } from './field.types';
+import { PhoneFieldContent, PhoneFieldProps, PhoneFieldValidation } from './field.types';
 /**
  * A self-validating phone field for auth widget forms.
  * @element sb-phone-field
@@ -45,13 +45,11 @@ export declare class SbPhoneField extends LitElement implements PhoneFieldProps
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -96,6 +94,11 @@ export declare class SbPhoneField extends LitElement implements PhoneFieldProps
      * When provided, the parent form cannot be submitted without this field.
      */
     required?: boolean;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: PhoneFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -181,20 +184,16 @@ export declare class SbPhoneField extends LitElement implements PhoneFieldProps
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateRequired;
+    private _handleValidateSuccess;
     /**
-     * Handles the format condition validation with `_PATTERN`, accepting empty
-     * non-required fields and non-empty fields that satisfy the pattern,
-     * otherwise dispatching and displaying the format error.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _validateFormat;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required and
-     * format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/_username-field.d.ts

@@ -1,5 +1,5 @@
 import { LitElement } from '../../../../../node_modules/lit';
-import { UsernameFieldContent, UsernameFieldProps } from './field.types';
+import { UsernameFieldContent, UsernameFieldProps, UsernameFieldValidation } from './field.types';
 /**
  * A self-validating username field for auth widget forms.
  * @element sb-username-field
@@ -45,13 +45,11 @@ export declare class SbUsernameField extends LitElement implements UsernameField
      */
     static get validateEventName(): string;
     /**
-     * A unique value used as a substring in the generated part/child IDs, when
-     * the `child-id` prop is not provided.
+     * A unique substring for fallback part IDs generated.
      */
     seed: string;
     /**
-     * The `id` value given to the root child/part and used as the base of other
-     * child/part IDs.
+     * The `id` of the root part and the base of sub-part IDs.
      */
     childId?: string;
     /**
@@ -108,6 +106,11 @@ export declare class SbUsernameField extends LitElement implements UsernameField
      * The regex pattern for a valid username, used in place of `_PATTERN`.
      */
     pattern?: string;
+    /**
+     * Controls validation depth: `"default"` applies all rules, while `"simple"`
+     * only enforces the `required` check.
+     */
+    validation: UsernameFieldValidation;
     /**
      * Error message shown when the field is required but empty upon submission.
      */
@@ -213,36 +216,16 @@ export declare class SbUsernameField extends LitElement implements UsernameField
      */
     private _dispatchValidate;
     /**
-     * Handles the required condition validation, accepting empty non-required
-     * fields and non-empty required fields, otherwise dispatching and displaying
-     * the required error.
-     */
-    private _validateRequired;
-    /**
-     * Handles the minlength condition validation, determining if a valid
-     * `minlength` prop was provided, dispatching and displaying the minlength
-     * error if the value is shorter than accepted.
-     */
-    private _validateMinlength;
-    /**
-     * Handles the maxlength condition validation, determining if a valid
-     * `maxlength` prop was provided, dispatching and displaying the maxlength
-     * error if the value is longer than accepted.
-     */
-    private _validateMaxlength;
-    /**
-     * Handles the format condition validation, testing against `_pattern`, and
-     * dispatching and displaying the format error for an invalid value.
+     * Clears the invalid state and error, and dispatches a valid validate event.
      */
-    private _validateFormat;
+    private _handleValidateSuccess;
     /**
-     * Resets the `_invalid` and `_error` private props and dispatches the
-     * validate event, indicating a successfully validated and valid username.
+     * Sets the invalid state and error, and dispatches an invalid validate event.
      */
-    private _doValidateSuccess;
+    private _handleValidateError;
     /**
-     * Handles validation and dispatches the success event if the required,
-     * length, and format conditions are met.
+     * Validates the current value against the applicable rules in sequence,
+     * dispatches the validate event, and returns `true` if the value passes.
      */
     private _validate;
     /**

package/dist/components/renderers/_updated/field/field.types.d.ts

@@ -2,6 +2,7 @@ import { RtgInputAutocomplete, SbAuthIdentifier } from '../../../../types';
 type BaseFieldValidateType = "success" | "required" | "format";
 type BaseFieldValidateTypeWithLength = BaseFieldValidateType | "minlength" | "maxlength";
 type BaseFieldContent = "split" | "group";
+type BaseFieldValidation = "default" | "simple";
 type BaseFieldProps = {
     seed: string;
     childId?: string;
@@ -15,6 +16,7 @@ type BaseFieldProps = {
     caret?: boolean;
     disabled?: boolean;
     required?: boolean;
+    validation: BaseFieldValidation;
     requiredError: string;
     formatError: string;
 };
@@ -26,29 +28,38 @@ type BaseFieldPropsWithLength = BaseFieldProps & {
 };
 export type EmailFieldValidateType = BaseFieldValidateType;
 export type EmailFieldContent = BaseFieldContent;
-export type EmailFieldProps = Omit<BaseFieldProps, "content"> & {
+export type EmailFieldValidation = BaseFieldValidation;
+export type EmailFieldProps = Omit<BaseFieldProps, "content" | "validation"> & {
     content: EmailFieldContent;
+    validation: EmailFieldValidation;
 };
 export type PhoneFieldValidateType = BaseFieldValidateType;
 export type PhoneFieldContent = BaseFieldContent;
-export type PhoneFieldProps = Omit<BaseFieldProps, "content"> & {
+export type PhoneFieldValidation = BaseFieldValidation;
+export type PhoneFieldProps = Omit<BaseFieldProps, "content" | "validation"> & {
     content: PhoneFieldContent;
+    validation: PhoneFieldValidation;
 };
 export type UsernameFieldValidateType = BaseFieldValidateTypeWithLength;
 export type UsernameFieldContent = BaseFieldContent;
-export type UsernameFieldProps = Omit<BaseFieldPropsWithLength, "content"> & {
+export type UsernameFieldValidation = BaseFieldValidation;
+export type UsernameFieldProps = Omit<BaseFieldPropsWithLength, "content" | "validation"> & {
     content: UsernameFieldContent;
     pattern?: string;
+    validation: UsernameFieldValidation;
 };
 export type NameFieldValidateType = BaseFieldValidateTypeWithLength;
 export type NameFieldContent = BaseFieldContent;
-export type NameFieldProps = Omit<BaseFieldPropsWithLength, "content"> & {
+export type NameFieldValidation = BaseFieldValidation;
+export type NameFieldProps = Omit<BaseFieldPropsWithLength, "content" | "validation"> & {
     content: NameFieldContent;
     pattern?: string;
+    validation: NameFieldValidation;
 };
 export type PasswordFieldValidateType = BaseFieldValidateTypeWithLength;
 export type PasswordFieldVariant = "toggle" | "simple";
 export type PasswordFieldContent = BaseFieldContent;
+export type PasswordFieldValidation = BaseFieldValidation;
 export type PasswordFieldRuleName = "uppercase" | "lowercase" | "number" | "special";
 export type PasswordFieldRule = {
     name: PasswordFieldRuleName;
@@ -59,28 +70,33 @@ export type PasswordFieldRule = {
     pattern: string;
     error?: string;
 };
-export type PasswordFieldProps = Omit<BaseFieldPropsWithLength, "content"> & {
+export type PasswordFieldProps = Omit<BaseFieldPropsWithLength, "content" | "validation"> & {
     variant: PasswordFieldVariant;
     content: PasswordFieldContent;
     rules: PasswordFieldRule[];
+    validation: PasswordFieldValidation;
 };
 export type ConfirmFieldValidateType = Exclude<BaseFieldValidateType, "format"> | "match";
 export type ConfirmFieldVariant = PasswordFieldVariant;
 export type ConfirmFieldContent = BaseFieldContent;
-export type ConfirmFieldProps = Omit<BaseFieldProps, "content" | "formatError"> & {
+export type ConfirmFieldValidation = BaseFieldValidation;
+export type ConfirmFieldProps = Omit<BaseFieldProps, "content" | "validation" | "formatError"> & {
     variant: ConfirmFieldVariant;
     content: ConfirmFieldContent;
     pair: string;
+    validation: ConfirmFieldValidation;
     matchError: string;
 };
 export type IdentifierFieldValidateType = Exclude<BaseFieldValidateType, "format">;
 export type IdentifierFieldIdentifier = SbAuthIdentifier;
 export type IdentifierFieldContent = BaseFieldContent;
 export type IdentifierFieldAutocomplete = RtgInputAutocomplete;
-export type IdentifierFieldProps = Omit<BaseFieldProps, "label" | "content" | "formatError"> & {
+export type IdentifierFieldValidation = BaseFieldValidation;
+export type IdentifierFieldProps = Omit<BaseFieldProps, "label" | "content" | "validation" | "formatError"> & {
     label?: string;
     identifiers: IdentifierFieldIdentifier[];
     content: IdentifierFieldContent;
     autocomplete?: IdentifierFieldAutocomplete;
+    validation: IdentifierFieldValidation;
 };
 export {};