@ory/elements-react 1.0.0-rc.0 → 1.0.0-rc.2

package/CHANGELOG.md

@@ -1,3 +1,49 @@
+## 1.0.0-rc.2 (2025-04-30)
+
+### 🚀 Features
+
+- method translation for totp, code, webauthn ([#500](https://github.com/ory/elements/pull/500))
+- add all missing stories ([#480](https://github.com/ory/elements/pull/480))
+- preview deployments for example apps ([#488](https://github.com/ory/elements/pull/488))
+- add back button to settings page ([#464](https://github.com/ory/elements/pull/464))
+
+### 🩹 Fixes
+
+- ⚠️  align configuration types to Ory Network APIs ([#423](https://github.com/ory/elements/pull/423))
+- sort captcha before submit button ([#507](https://github.com/ory/elements/pull/507))
+- cors credentials in default client ([#508](https://github.com/ory/elements/pull/508))
+- back button should return to application ([#465](https://github.com/ory/elements/pull/465))
+- adjust design of generic OIDC provider ([#492](https://github.com/ory/elements/pull/492))
+- use proper id for react element arrays ([#495](https://github.com/ory/elements/pull/495))
+- add test id to header messages ([#489](https://github.com/ory/elements/pull/489))
+- re-add missing error message when no methods provided ([#460](https://github.com/ory/elements/pull/460))
+- resend not working for registration ([#468](https://github.com/ory/elements/pull/468))
+- add missing color class to registration footer ([#473](https://github.com/ory/elements/pull/473))
+- resend not working for registration ([#467](https://github.com/ory/elements/pull/467))
+
+### ⚠️  Breaking Changes
+
+- ⚠️  align configuration types to Ory Network APIs ([#423](https://github.com/ory/elements/pull/423))
+
+### ❤️ Thank You
+
+- hackerman @aeneasr
+- Jonas Hungershausen
+
+## 1.0.0-rc.1 (2025-04-21)
+
+### 🩹 Fixes
+
+- re-add missing error message when no methods provided ([#460](https://github.com/ory/elements/pull/460))
+- resend not working for registration ([#468](https://github.com/ory/elements/pull/468))
+- add missing color class to registration footer ([#473](https://github.com/ory/elements/pull/473))
+- resend not working for registration ([#467](https://github.com/ory/elements/pull/467))
+
+### ❤️ Thank You
+
+- hackerman @aeneasr
+- Jonas Hungershausen
+
 ## 1.0.0-rc.0 (2025-04-17)
 
 ### 🚀 Features

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { UiNodeInputAttributes, UiNode, UiNodeAnchorAttributes, UiNodeTextAttributes, UiNodeImageAttributes, UiNodeGroupEnum, UiText, ConfigurationParameters, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, UiContainer, OAuth2ConsentRequest, Session, FlowError, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler } from '@ory/client-fetch';
+import { UiNodeInputAttributes, UiNode, UiNodeAnchorAttributes, UiNodeTextAttributes, UiNodeImageAttributes, UiNodeGroupEnum, UiText, ConfigurationParameters, AccountExperienceConfiguration, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, UiContainer, OAuth2ConsentRequest, Session, FlowError, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler } from '@ory/client-fetch';
 import { ComponentPropsWithoutRef, FormEventHandler, MouseEventHandler, PropsWithChildren, DetailedHTMLProps, HTMLAttributes, ComponentType, Dispatch } from 'react';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
@@ -394,33 +394,60 @@ type IntlContextProps = {
 };
 
 type IntlConfig = IntlContextProps;
+/**
+ * The configuration for Ory Elements.
+ *
+ * This configuration is used to customize the behavior and appearance of Ory Elements.
+ *
+ * By setting UI urls, you can override the default URLs for the login, registration, recovery, and verification flows.
+ *
+ * You can also set the name of the application, the logo URL, and the SDK configuration.
+ * By default, the name and logo are displayed in the card's header.
+ */
 type OryClientConfiguration = {
-    /**
-     * The name of the application the user is logging in to.
-     */
-    name: string;
     /**
      * An optional logo URL to display in the UI instead of the name.
+     * @deprecated Use `project.logo_light_url` instead.
      */
     logoUrl?: string;
-    stylesheet?: string;
-    favicon?: string;
+    /**
+     * The SDK configuration.
+     * This configuration is used to set the URL of the Ory SDK and any additional options used for the SDK client.
+     */
     sdk: {
         url: string;
         options?: Partial<ConfigurationParameters>;
     };
-    project: {
-        registration_enabled: boolean;
-        verification_enabled: boolean;
-        recovery_enabled: boolean;
-        recovery_ui_url: string;
-        registration_ui_url: string;
-        verification_ui_url: string;
-        login_ui_url: string;
-        default_redirect_url?: string;
-    };
+    /**
+     * The internationalization configuration.
+     * This configuration is used to set the locale and any additional options used for the i18n library.
+     * The locale is used to determine the language of the UI.
+     * The default locale is "en".
+     */
     intl?: IntlConfig;
-};
+} & ({
+    /**
+     * The name of the application the user is logging in to.
+     * @deprecated Use `project.name` instead.
+     */
+    name: string;
+    /**
+     * The configuration for the project.
+     */
+    project: Omit<AccountExperienceConfiguration, "name"> & {
+        name?: string;
+    };
+} | {
+    /**
+     * The name of the application the user is logging in to.
+     * @deprecated Use `project.name` instead.
+     */
+    name?: string;
+    /**
+     * The configuration for the project.
+     */
+    project: AccountExperienceConfiguration;
+});
 
 /**
  * A generic flow container, containing a flowType, the flow itself and the config object
@@ -486,6 +513,7 @@ type ConsentFlow = {
     ui: UiContainer;
     consent_request: OAuth2ConsentRequest;
     session: Session;
+    return_to?: string;
 };
 type ConsentFlowContainer = OryFlow<FlowType.OAuth2Consent, ConsentFlow>;
 /**
@@ -561,18 +589,23 @@ type OnSubmitHandlerProps<T extends UpdateLoginFlowBody | UpdateRegistrationFlow
  * @param message - the UiText message to generate a test id for
  * @returns a unique, stable test id for the message
  */
-declare function messageTestId(message: UiText): {
+declare function messageTestId(message: {
+    id: number | string;
+}): {
     "data-testid": string;
 };
 
-type FormState = {
-    current: "provide_identifier";
-} | {
+type FormStateSelectMethod = {
     current: "select_method";
-} | {
+};
+type FormStateProvideIdentifier = {
+    current: "provide_identifier";
+};
+type FormStateMethodActive = {
     current: "method_active";
     method: UiNodeGroupEnum;
-} | {
+};
+type FormState = FormStateSelectMethod | FormStateProvideIdentifier | FormStateMethodActive | {
     current: "success_screen";
 } | {
     current: "settings";
@@ -619,4 +652,4 @@ type OryProviderProps = {
 } & OryFlowContainer & PropsWithChildren;
 declare function OryProvider({ children, components: Components, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
 
-export { type ConsentFlow, type ConsentFlowContainer, type ErrorFlowContainer, type FlowContainerSetter, type FlowContextValue, type FormState, type FormStateAction, type FormValues, HeadlessPageHeader, type IntlConfig, type LoginFlowContainer, type OnSubmitHandlerProps, OryCard, type OryCardAuthMethodListItemProps, OryCardContent, type OryCardContentProps, type OryCardDividerProps, OryCardFooter, type OryCardFooterProps, OryCardHeader, type OryCardHeaderProps, type OryCardLogoProps, type OryCardRootProps as OryCardProps, type OryCardSettingsSectionProps, OryCardValidationMessages, type OryClientConfiguration, OryConsentCard, type OryFlowComponentOverrides, type OryFlowComponents, type OryFlowContainer, OryForm, OryFormGroupDivider, type OryFormGroupProps, OryFormGroups, type OryFormGroupsProps, OryFormOidcButtons, type OryFormOidcRootProps, type OryFormProps, type OryFormRootProps, OryFormSection, type OryFormSectionContentProps, type OryFormSectionFooterProps, type OryFormSectionProps, OryFormSocialButtonsForm, OryLocales, type OryMessageContentProps, type OryMessageRootProps, type OryNodeAnchorProps, type OryNodeButtonProps, type OryNodeCaptchaProps, type OryNodeConsentScopeCheckboxProps, type OryNodeImageProps, type OryNodeInputProps, type OryNodeLabelProps, type OryNodeOidcButtonProps, type OryNodeTextProps, type OryPageHeaderProps, OryProvider, type OryProviderProps, OrySettingsCard, type OrySettingsOidcProps, type OrySettingsPasskeyProps, type OrySettingsRecoveryCodesProps, type OrySettingsTotpProps, type OrySettingsWebauthnProps, OryTwoStepCard, type RecoveryFlowContainer, type RegistrationFlowContainer, type SettingsFlowContainer, type VerificationFlowContainer, messageTestId, uiTextToFormattedMessage, useComponents, useNodeSorter, useOryFlow };
+export { type ConsentFlow, type ConsentFlowContainer, type ErrorFlowContainer, type FlowContainerSetter, type FlowContextValue, type FormState, type FormStateAction, type FormStateMethodActive, type FormStateProvideIdentifier, type FormStateSelectMethod, type FormValues, HeadlessPageHeader, type IntlConfig, type LoginFlowContainer, type OnSubmitHandlerProps, OryCard, type OryCardAuthMethodListItemProps, OryCardContent, type OryCardContentProps, type OryCardDividerProps, OryCardFooter, type OryCardFooterProps, OryCardHeader, type OryCardHeaderProps, type OryCardLogoProps, type OryCardRootProps as OryCardProps, type OryCardSettingsSectionProps, OryCardValidationMessages, type OryClientConfiguration, OryConsentCard, type OryFlowComponentOverrides, type OryFlowComponents, type OryFlowContainer, OryForm, OryFormGroupDivider, type OryFormGroupProps, OryFormGroups, type OryFormGroupsProps, OryFormOidcButtons, type OryFormOidcRootProps, type OryFormProps, type OryFormRootProps, OryFormSection, type OryFormSectionContentProps, type OryFormSectionFooterProps, type OryFormSectionProps, OryFormSocialButtonsForm, OryLocales, type OryMessageContentProps, type OryMessageRootProps, type OryNodeAnchorProps, type OryNodeButtonProps, type OryNodeCaptchaProps, type OryNodeConsentScopeCheckboxProps, type OryNodeImageProps, type OryNodeInputProps, type OryNodeLabelProps, type OryNodeOidcButtonProps, type OryNodeTextProps, type OryPageHeaderProps, OryProvider, type OryProviderProps, OrySettingsCard, type OrySettingsOidcProps, type OrySettingsPasskeyProps, type OrySettingsRecoveryCodesProps, type OrySettingsTotpProps, type OrySettingsWebauthnProps, OryTwoStepCard, type RecoveryFlowContainer, type RegistrationFlowContainer, type SettingsFlowContainer, type VerificationFlowContainer, messageTestId, uiTextToFormattedMessage, useComponents, useNodeSorter, useOryFlow };

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { UiNodeInputAttributes, UiNode, UiNodeAnchorAttributes, UiNodeTextAttributes, UiNodeImageAttributes, UiNodeGroupEnum, UiText, ConfigurationParameters, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, UiContainer, OAuth2ConsentRequest, Session, FlowError, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler } from '@ory/client-fetch';
+import { UiNodeInputAttributes, UiNode, UiNodeAnchorAttributes, UiNodeTextAttributes, UiNodeImageAttributes, UiNodeGroupEnum, UiText, ConfigurationParameters, AccountExperienceConfiguration, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, UiContainer, OAuth2ConsentRequest, Session, FlowError, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler } from '@ory/client-fetch';
 import { ComponentPropsWithoutRef, FormEventHandler, MouseEventHandler, PropsWithChildren, DetailedHTMLProps, HTMLAttributes, ComponentType, Dispatch } from 'react';
 import * as class_variance_authority_types from 'class-variance-authority/types';
 import { VariantProps } from 'class-variance-authority';
@@ -394,33 +394,60 @@ type IntlContextProps = {
 };
 
 type IntlConfig = IntlContextProps;
+/**
+ * The configuration for Ory Elements.
+ *
+ * This configuration is used to customize the behavior and appearance of Ory Elements.
+ *
+ * By setting UI urls, you can override the default URLs for the login, registration, recovery, and verification flows.
+ *
+ * You can also set the name of the application, the logo URL, and the SDK configuration.
+ * By default, the name and logo are displayed in the card's header.
+ */
 type OryClientConfiguration = {
-    /**
-     * The name of the application the user is logging in to.
-     */
-    name: string;
     /**
      * An optional logo URL to display in the UI instead of the name.
+     * @deprecated Use `project.logo_light_url` instead.
      */
     logoUrl?: string;
-    stylesheet?: string;
-    favicon?: string;
+    /**
+     * The SDK configuration.
+     * This configuration is used to set the URL of the Ory SDK and any additional options used for the SDK client.
+     */
     sdk: {
         url: string;
         options?: Partial<ConfigurationParameters>;
     };
-    project: {
-        registration_enabled: boolean;
-        verification_enabled: boolean;
-        recovery_enabled: boolean;
-        recovery_ui_url: string;
-        registration_ui_url: string;
-        verification_ui_url: string;
-        login_ui_url: string;
-        default_redirect_url?: string;
-    };
+    /**
+     * The internationalization configuration.
+     * This configuration is used to set the locale and any additional options used for the i18n library.
+     * The locale is used to determine the language of the UI.
+     * The default locale is "en".
+     */
     intl?: IntlConfig;
-};
+} & ({
+    /**
+     * The name of the application the user is logging in to.
+     * @deprecated Use `project.name` instead.
+     */
+    name: string;
+    /**
+     * The configuration for the project.
+     */
+    project: Omit<AccountExperienceConfiguration, "name"> & {
+        name?: string;
+    };
+} | {
+    /**
+     * The name of the application the user is logging in to.
+     * @deprecated Use `project.name` instead.
+     */
+    name?: string;
+    /**
+     * The configuration for the project.
+     */
+    project: AccountExperienceConfiguration;
+});
 
 /**
  * A generic flow container, containing a flowType, the flow itself and the config object
@@ -486,6 +513,7 @@ type ConsentFlow = {
     ui: UiContainer;
     consent_request: OAuth2ConsentRequest;
     session: Session;
+    return_to?: string;
 };
 type ConsentFlowContainer = OryFlow<FlowType.OAuth2Consent, ConsentFlow>;
 /**
@@ -561,18 +589,23 @@ type OnSubmitHandlerProps<T extends UpdateLoginFlowBody | UpdateRegistrationFlow
  * @param message - the UiText message to generate a test id for
  * @returns a unique, stable test id for the message
  */
-declare function messageTestId(message: UiText): {
+declare function messageTestId(message: {
+    id: number | string;
+}): {
     "data-testid": string;
 };
 
-type FormState = {
-    current: "provide_identifier";
-} | {
+type FormStateSelectMethod = {
     current: "select_method";
-} | {
+};
+type FormStateProvideIdentifier = {
+    current: "provide_identifier";
+};
+type FormStateMethodActive = {
     current: "method_active";
     method: UiNodeGroupEnum;
-} | {
+};
+type FormState = FormStateSelectMethod | FormStateProvideIdentifier | FormStateMethodActive | {
     current: "success_screen";
 } | {
     current: "settings";
@@ -619,4 +652,4 @@ type OryProviderProps = {
 } & OryFlowContainer & PropsWithChildren;
 declare function OryProvider({ children, components: Components, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
 
-export { type ConsentFlow, type ConsentFlowContainer, type ErrorFlowContainer, type FlowContainerSetter, type FlowContextValue, type FormState, type FormStateAction, type FormValues, HeadlessPageHeader, type IntlConfig, type LoginFlowContainer, type OnSubmitHandlerProps, OryCard, type OryCardAuthMethodListItemProps, OryCardContent, type OryCardContentProps, type OryCardDividerProps, OryCardFooter, type OryCardFooterProps, OryCardHeader, type OryCardHeaderProps, type OryCardLogoProps, type OryCardRootProps as OryCardProps, type OryCardSettingsSectionProps, OryCardValidationMessages, type OryClientConfiguration, OryConsentCard, type OryFlowComponentOverrides, type OryFlowComponents, type OryFlowContainer, OryForm, OryFormGroupDivider, type OryFormGroupProps, OryFormGroups, type OryFormGroupsProps, OryFormOidcButtons, type OryFormOidcRootProps, type OryFormProps, type OryFormRootProps, OryFormSection, type OryFormSectionContentProps, type OryFormSectionFooterProps, type OryFormSectionProps, OryFormSocialButtonsForm, OryLocales, type OryMessageContentProps, type OryMessageRootProps, type OryNodeAnchorProps, type OryNodeButtonProps, type OryNodeCaptchaProps, type OryNodeConsentScopeCheckboxProps, type OryNodeImageProps, type OryNodeInputProps, type OryNodeLabelProps, type OryNodeOidcButtonProps, type OryNodeTextProps, type OryPageHeaderProps, OryProvider, type OryProviderProps, OrySettingsCard, type OrySettingsOidcProps, type OrySettingsPasskeyProps, type OrySettingsRecoveryCodesProps, type OrySettingsTotpProps, type OrySettingsWebauthnProps, OryTwoStepCard, type RecoveryFlowContainer, type RegistrationFlowContainer, type SettingsFlowContainer, type VerificationFlowContainer, messageTestId, uiTextToFormattedMessage, useComponents, useNodeSorter, useOryFlow };
+export { type ConsentFlow, type ConsentFlowContainer, type ErrorFlowContainer, type FlowContainerSetter, type FlowContextValue, type FormState, type FormStateAction, type FormStateMethodActive, type FormStateProvideIdentifier, type FormStateSelectMethod, type FormValues, HeadlessPageHeader, type IntlConfig, type LoginFlowContainer, type OnSubmitHandlerProps, OryCard, type OryCardAuthMethodListItemProps, OryCardContent, type OryCardContentProps, type OryCardDividerProps, OryCardFooter, type OryCardFooterProps, OryCardHeader, type OryCardHeaderProps, type OryCardLogoProps, type OryCardRootProps as OryCardProps, type OryCardSettingsSectionProps, OryCardValidationMessages, type OryClientConfiguration, OryConsentCard, type OryFlowComponentOverrides, type OryFlowComponents, type OryFlowContainer, OryForm, OryFormGroupDivider, type OryFormGroupProps, OryFormGroups, type OryFormGroupsProps, OryFormOidcButtons, type OryFormOidcRootProps, type OryFormProps, type OryFormRootProps, OryFormSection, type OryFormSectionContentProps, type OryFormSectionFooterProps, type OryFormSectionProps, OryFormSocialButtonsForm, OryLocales, type OryMessageContentProps, type OryMessageRootProps, type OryNodeAnchorProps, type OryNodeButtonProps, type OryNodeCaptchaProps, type OryNodeConsentScopeCheckboxProps, type OryNodeImageProps, type OryNodeInputProps, type OryNodeLabelProps, type OryNodeOidcButtonProps, type OryNodeTextProps, type OryPageHeaderProps, OryProvider, type OryProviderProps, OrySettingsCard, type OrySettingsOidcProps, type OrySettingsPasskeyProps, type OrySettingsRecoveryCodesProps, type OrySettingsTotpProps, type OrySettingsWebauthnProps, OryTwoStepCard, type RecoveryFlowContainer, type RegistrationFlowContainer, type SettingsFlowContainer, type VerificationFlowContainer, messageTestId, uiTextToFormattedMessage, useComponents, useNodeSorter, useOryFlow };