@saasbase-io/core-elements 1.10.0 → 1.12.0

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

@@ -0,0 +1,250 @@
+import { LitElement } from '../../../../../node_modules/lit';
+import { ConfirmFieldContent, ConfirmFieldProps, ConfirmFieldVariant } from './field.types';
+/**
+ * A self-validating confirm password field for auth widget forms.
+ * @element sb-confirm-field
+ *
+ * @part confirm-field (rtg-field)
+ * @part confirm-field-content (rtg-field-content): label + description wrapper
+ * @part confirm-field-label (rtg-field-label)
+ * @part confirm-field-mark (span): decorative marker with text or `"*"` in label
+ * @part confirm-field-description (rtg-field-description)
+ * @part confirm-field-input (rtg-input/rtg-password-input)
+ * @part confirm-field-error (rtg-field-error)
+ *
+ * @fires sb-confirm-field:validate
+ * { id, parentId, name, value, pairSelector, pairValue, valid, type, message }
+ *  - id: inputId
+ *  - parentId: rootId
+ *  - type: "required" | "format" | "success" | "minlength" | "maxlength"
+ */
+export declare class SbConfirmField extends LitElement implements ConfirmFieldProps {
+    private static readonly _ROOT;
+    private static readonly _CONTENT;
+    private static readonly _LABEL;
+    private static readonly _MARK;
+    private static readonly _DESCRIPTION;
+    private static readonly _INPUT;
+    private static readonly _ERROR;
+    /**
+     * The stable CSS part names exposed for external targeting.
+     */
+    static get parts(): {
+        root: string;
+        content: string;
+        label: string;
+        mark: string;
+        description: string;
+        input: string;
+        error: string;
+    };
+    /**
+     * The name of the custom event fired on validate.
+     */
+    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.
+     */
+    seed: string;
+    /**
+     * The `id` value given to the root child/part and used as the base of other
+     * child/part IDs.
+     */
+    childId?: string;
+    /**
+     * The `id` value given to the input child/part to override the auto-generated
+     * input ID, derived from the `rootId`.
+     */
+    fieldId?: string;
+    /**
+     * The `name` prop of the input part, used by the parent form.
+     */
+    name: string;
+    /**
+     * The variant of the confirm field input, where `"toggle"` renders a
+     * hide/show button addon in the input element.
+     */
+    variant: ConfirmFieldVariant;
+    /**
+     * Whether the label and description are grouped together above the input, or
+     * split up with the input in-between them.
+     */
+    content: ConfirmFieldContent;
+    /**
+     * A CSS selector for the paired `sb-password-field`.
+     */
+    pair: string;
+    /**
+     * The text content of the field label.
+     */
+    label: string;
+    /**
+     * The text used as the input placeholder.
+     */
+    placeholder?: string;
+    /**
+     * The text content of the field description.
+     */
+    description?: string;
+    /**
+     * The text rendered in the field label as a custom mark.
+     */
+    mark?: string;
+    /**
+     * When provided with `required`, a caret mark is rendered in the field label.
+     */
+    caret?: boolean;
+    /**
+     * Whether the field is in a disabled state.
+     */
+    disabled?: boolean;
+    /**
+     * When provided, the parent form cannot be submitted without this field.
+     */
+    required?: boolean;
+    /**
+     * Error message shown when the field is required but empty upon submission.
+     */
+    requiredError: string;
+    /**
+     * Error message shown when the confirm value does not match the `pair`
+     * password field's value.
+     */
+    matchError: string;
+    /**
+     * Indicates that the field is in an invalid state.
+     */
+    private _invalid;
+    /**
+     * The error message rendered in field error when in an invalid state.
+     */
+    private _error;
+    /**
+     * The current value of the confirm input.
+     */
+    private _value;
+    /**
+     * Reference to the nearest `form` ancestor.
+     */
+    private _form;
+    /**
+     * Overrides default behavior to render into light DOM.
+     */
+    protected createRenderRoot(): this;
+    /**
+     * The `id` of the root element. Equal to `childId` when provided, otherwise
+     * derived from the component's part name and `seed`.
+     */
+    get rootId(): string;
+    /**
+     * The `id` of the field content element, derived from `rootId` with the
+     * content part name appended.
+     */
+    get contentId(): string;
+    /**
+     * The `id` of the field label element, derived from `rootId` with the label
+     * part name appended.
+     */
+    get labelId(): string;
+    /**
+     * The `id` of the field description element, derived from `rootId` with the
+     * description part name appended.
+     */
+    get descriptionId(): string;
+    /**
+     * The `id` of the mark element, derived from `rootId` with the mark part name
+     * appended.
+     */
+    get markId(): string;
+    /**
+     * The `id` of the input element, equal to `fieldId` when provided, otherwise
+     * derived from `rootId` with the input part name appended.
+     */
+    get inputId(): string;
+    /**
+     * The `id` of the field error element, derived from `rootId` with the error
+     * part name appended.
+     */
+    get errorId(): string;
+    /**
+     * Adds the input, form submit, and form reset event listeners.
+     */
+    connectedCallback(): void;
+    /**
+     * Removes the input, form submit, and form reset event listeners.
+     */
+    disconnectedCallback(): void;
+    /**
+     * The public validate method that calls the private `_validate()` method for
+     * manual, external validation.
+     */
+    validate(): boolean;
+    /**
+     * Returns the paired password field's value or an empty string if the pair
+     * cannot be found.
+     */
+    private _pairValue;
+    /**
+     * Defines and dispatches the validate event.
+     */
+    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.
+     */
+    private _validateMatch;
+    /**
+     * Resets the `_invalid` and `_error` private props and dispatches the
+     * validate event, indicating a successfully validated and valid confirm.
+     */
+    private _doValidateSuccess;
+    /**
+     * Handles validation and dispatches the success event if the required,
+     * length, and format conditions are met.
+     */
+    private _validate;
+    /**
+     * Handles the input event, updating the private `_value` prop.
+     */
+    private _handleInput;
+    /**
+     * Handles the form submit event, running the `_validate()` method and
+     * preventing the default submission behavior if invalid.
+     */
+    private _handleFormSubmit;
+    /**
+     * Handles the form reset event, resetting the input element's `value` as well
+     * as the confirm field's private props: `_value`, `_invalid`, and `_error`.
+     */
+    private _handleFormReset;
+    /**
+     * Conditionally returns the mark template for the field label. When `caret`
+     * and `required` are provided, the mark becomes an asterisk. When `mark` is
+     * provided, its value is rendered inside the element.
+     * If both a caret and custom text mark have their conditions met, the custom
+     * mark will be prioritised and rendered instead of the asterisk.
+     */
+    private _renderMark;
+    /**
+     * Returns the field label template with the label text and optional mark.
+     */
+    private _renderLabel;
+    /**
+     * Returns the field description template if `description` is defined.
+     */
+    private _renderDescription;
+    /**
+     * Returns the field error template with the `_error` message if the
+     * `_invalid` state is `true`.
+     */
+    private _renderError;
+    render(): import('../../../../../node_modules/lit-html').TemplateResult<1>;
+}

package/dist/components/renderers/_updated/field/field.stories/confirm-field.stories.d.ts

@@ -0,0 +1,15 @@
+import { Meta, StoryObj } from '@storybook/web-components-vite';
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj;
+export declare const Basic: Story;
+export declare const Label: Story;
+export declare const Placeholder: Story;
+export declare const Description: Story;
+export declare const Variant: Story;
+export declare const Content: Story;
+export declare const Disabled: Story;
+export declare const Caret: Story;
+export declare const Mark: Story;
+export declare const Validate: Story;
+export declare const Form: Story;

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

@@ -57,4 +57,13 @@ export type PasswordFieldProps = Omit<BaseFieldPropsWithLength, "content"> & {
     content: PasswordFieldContent;
     rules: PasswordFieldRule[];
 };
+export type ConfirmFieldValidateType = Exclude<BaseFieldValidateType, "format"> | "match";
+export type ConfirmFieldVariant = PasswordFieldVariant;
+export type ConfirmFieldContent = BaseFieldContent;
+export type ConfirmFieldProps = Omit<BaseFieldProps, "content" | "formatError"> & {
+    variant: ConfirmFieldVariant;
+    content: ConfirmFieldContent;
+    pair: string;
+    matchError: string;
+};
 export {};

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

@@ -1,13 +1,15 @@
+import { SbConfirmField } from './_confirm-field';
 import { SbEmailField } from './_email-field';
 import { SbPasswordField } from './_password-field';
 import { SbPhoneField } from './_phone-field';
 import { SbUsernameField } from './_username-field';
-export { SbEmailField, SbPasswordField, SbPhoneField, SbUsernameField };
+export { SbConfirmField, SbEmailField, SbPasswordField, SbPhoneField, SbUsernameField, };
 declare global {
     interface HTMLElementTagNameMap {
         "sb-email-field": SbEmailField;
         "sb-phone-field": SbPhoneField;
         "sb-username-field": SbUsernameField;
         "sb-password-field": SbPasswordField;
+        "sb-confirm-field": SbConfirmField;
     }
 }

package/dist/components/renderers/_updated/form/_form-submit.d.ts

@@ -0,0 +1,102 @@
+import { LitElement } from '../../../../../node_modules/lit';
+import { FormSubmitProps, FormSubmitSize, FormSubmitSpinnerAlign, FormSubmitVariant } from './form.types';
+/**
+ * A submit button for auth widget forms.
+ * @element sb-form-submit
+ *
+ * @part form-submit (rtg-button)
+ * @part form-submit-spinner (rtg-spinner): loading indicator
+ *
+ * @fires sb-form-submit:click { id, event }
+ */
+export declare class SbFormSubmit extends LitElement implements FormSubmitProps {
+    private static readonly _ROOT;
+    private static readonly _SPINNER;
+    /**
+     * The stable CSS part names exposed for external targeting.
+     */
+    static get parts(): {
+        root: string;
+        spinner: string;
+    };
+    /**
+     * The name of the custom event fired on click.
+     */
+    static get clickEventName(): string;
+    /**
+     * A unique substring for fallback part IDs generated.
+     */
+    seed: string;
+    /**
+     * The `id` of the root part and the base of sub-part IDs.
+     */
+    childId?: string;
+    /**
+     * The visual variant of the button.
+     */
+    variant: FormSubmitVariant;
+    /**
+     * The size of the button.
+     */
+    size: FormSubmitSize;
+    /**
+     * The text used as the button label.
+     */
+    label: string;
+    /**
+     * Whether the loading spinner should be rendered before or after the label.
+     */
+    spinnerAlign: FormSubmitSpinnerAlign;
+    /**
+     * When provided, the button reflects a disabled state.
+     */
+    disabled?: boolean;
+    /**
+     * When provided, the button reflects a loading state.
+     */
+    loading?: boolean;
+    /**
+     * The event name as defined in the loginflow auth service.
+     */
+    event?: string;
+    /**
+     * Whether the button is in a loading state.
+     */
+    private _loading;
+    /**
+     * Overrides default behavior to render into light DOM.
+     */
+    protected createRenderRoot(): this;
+    /**
+     * The `id` of the root element. Equal to `childId` when provided, otherwise
+     * derived from the component's part name and `seed`.
+     */
+    get rootId(): string;
+    /**
+     * The `id` of the spinner element, derived from `rootId` with the spinner
+     * part name appended.
+     */
+    get spinnerId(): string;
+    /**
+     * The loading state, derived from the private `_loading` and `loading` prop.
+     */
+    get isLoading(): boolean | undefined;
+    /**
+     * Adds the click event listener.
+     */
+    connectedCallback(): void;
+    /**
+     * Removes the click event listener.
+     */
+    disconnectedCallback(): void;
+    /**
+     * Handles the click event, preventing execution when disabled/loading, and
+     * firing the click event.
+     */
+    private _handleClick;
+    /**
+     * Returns the loading spinner template.
+     */
+    private _renderSpinner;
+    render(): import('../../../../../node_modules/lit-html').TemplateResult<1>;
+}

package/dist/components/renderers/_updated/form/form.stories/form-submit.stories.d.ts

@@ -0,0 +1,11 @@
+import { Meta, StoryObj } from '@storybook/web-components-vite';
+declare const meta: Meta;
+export default meta;
+type Story = StoryObj;
+export declare const Basic: Story;
+export declare const Variant: Story;
+export declare const Size: Story;
+export declare const Label: Story;
+export declare const Disabled: Story;
+export declare const Loading: Story;
+export declare const SpinnerAlign: Story;

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

@@ -1,4 +1,18 @@
-import { RtgButtonBasicSize, RtgButtonBasicVariant } from '../../../../types';
+import { IconAlign, RtgButtonBasicSize, RtgButtonBasicVariant } from '../../../../types';
+export type FormSubmitVariant = RtgButtonBasicVariant;
+export type FormSubmitSize = RtgButtonBasicSize;
+export type FormSubmitSpinnerAlign = IconAlign;
+export type FormSubmitProps = {
+    seed: string;
+    childId?: string;
+    variant: FormSubmitVariant;
+    size: FormSubmitSize;
+    label: string;
+    spinnerAlign: FormSubmitSpinnerAlign;
+    disabled?: boolean;
+    loading?: boolean;
+    event?: string;
+};
 export type SbFormSeparatorProps = {
     seed: string;
     childId?: string;

package/dist/components/renderers/_updated/form/index.d.ts

@@ -1,8 +1,10 @@
 import { SbFormSeparator } from './_form-separator';
+import { SbFormSubmit } from './_form-submit';
 import { SbFormSwitch } from './_form-switch';
-export { SbFormSeparator, SbFormSwitch };
+export { SbFormSeparator, SbFormSubmit, SbFormSwitch };
 declare global {
     interface HTMLElementTagNameMap {
+        "sb-form-submit": SbFormSubmit;
         "sb-form-separator": SbFormSeparator;
         "sb-form-switch": SbFormSwitch;
     }

package/dist/components/renderers/_updated/sb-gap.d.ts

@@ -1,4 +1,4 @@
-import { BaseElement } from '../..';
+import { BaseElement } from '../../wrappers/base-element/base-element';
 export declare class SbGap extends BaseElement {
     size: string;
     type: "vertical" | "horizontal";

package/dist/components/wrappers/sb-authenticated/sb-authenticated.d.ts

@@ -10,7 +10,7 @@ export declare class SbAuthenticated extends LitElement {
      * Defaults to environment variable, can be overridden via property.
      */
     redirectUrl: string;
-    env?: EnvConfig;
+    env: EnvConfig | null;
     auth?: AuthState;
     render(): import('../../../../node_modules/lit-html').TemplateResult<1> | typeof nothing;
 }