@ory/elements-react 0.0.0-pr.f3c2f07 → 0.0.0-pr.fd92d9ce

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, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, UiContainer, OAuth2ConsentRequest, Session, FlowError, ConfigurationParameters, AccountExperienceConfiguration, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler, FrontendApi } 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';
@@ -53,6 +53,7 @@ type OryNodeImageProps = {
 type FormValues = Record<string, string | boolean | number | undefined>;
 type OryFormRootProps = ComponentPropsWithoutRef<"form"> & {
     onSubmit: FormEventHandler<HTMLFormElement>;
+    "data-testid"?: string;
 };
 type OryNodeInputProps = {
     attributes: UiNodeInputAttributes;
@@ -374,52 +375,15 @@ type DeepPartialTwoLevels<T> = {
 type OryFlowComponentOverrides = DeepPartialTwoLevels<OryFlowComponents>;
 type OryFormProps = PropsWithChildren<{
     onAfterSubmit?: (method: string | number | boolean | undefined) => void;
+    "data-testid"?: string;
 }>;
-declare function OryForm({ children, onAfterSubmit }: OryFormProps): react_jsx_runtime.JSX.Element;
+declare function OryForm({ children, onAfterSubmit, "data-testid": dataTestId, }: OryFormProps): react_jsx_runtime.JSX.Element;
 
 declare function useComponents(): OryFlowComponents;
 declare function useNodeSorter(): (a: UiNode, b: UiNode, ctx: {
     flowType: string;
 }) => number;
 
-type LocaleMap = Record<string, Record<string, string>>;
-declare const OryLocales: LocaleMap;
-
-type Locale = keyof typeof OryLocales;
-type IntlContextProps = {
-    locale: Locale;
-    customTranslations?: Partial<LocaleMap>;
-};
-
-type IntlConfig = IntlContextProps;
-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.
-     */
-    logoUrl?: string;
-    stylesheet?: string;
-    favicon?: string;
-    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;
-    };
-    intl?: IntlConfig;
-};
-
 /**
  * A generic flow container, containing a flowType, the flow itself and the config object
  *
@@ -428,7 +392,6 @@ type OryClientConfiguration = {
 type OryFlow<TFlowType extends FlowType, TFlow> = {
     flowType: TFlowType;
     flow: TFlow;
-    config: OryClientConfiguration;
 };
 /**
  * A flow container for the login flow
@@ -484,6 +447,7 @@ type ConsentFlow = {
     ui: UiContainer;
     consent_request: OAuth2ConsentRequest;
     session: Session;
+    return_to?: string;
 };
 type ConsentFlowContainer = OryFlow<FlowType.OAuth2Consent, ConsentFlow>;
 /**
@@ -491,6 +455,48 @@ type ConsentFlowContainer = OryFlow<FlowType.OAuth2Consent, ConsentFlow>;
  */
 type OryFlowContainer = LoginFlowContainer | RegistrationFlowContainer | RecoveryFlowContainer | VerificationFlowContainer | SettingsFlowContainer | ConsentFlowContainer;
 
+type LocaleMap = Record<string, Record<string, string>>;
+declare const OryLocales: LocaleMap;
+
+type Locale = keyof typeof OryLocales;
+type IntlContextProps = {
+    locale: Locale;
+    customTranslations?: Partial<LocaleMap>;
+};
+
+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 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>;
+    };
+    /**
+     * 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 configuration for the project.
+     */
+    project: AccountExperienceConfiguration;
+};
+
 /**
  * Converts a UiText to a FormattedMessage.
  * The UiText contains the id of the message and the context.
@@ -559,18 +565,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";
@@ -581,6 +592,8 @@ type FormStateAction = {
 } | {
     type: "action_select_method";
     method: UiNodeGroupEnum;
+} | {
+    type: "action_clear_active_method";
 };
 
 /**
@@ -614,7 +627,33 @@ type FlowContextValue = OryFlowContainer & {
 
 type OryProviderProps = {
     components: OryFlowComponents;
+    config: OryClientConfiguration;
 } & OryFlowContainer & PropsWithChildren;
-declare function OryProvider({ children, components: Components, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
+declare function OryProvider({ children, components: Components, config, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
+
+type OryElementsConfiguration = {
+    sdk: OrySDK;
+    project: AccountExperienceConfiguration;
+};
+declare function useOryConfiguration(): OryElementsConfiguration;
+type OrySDK = SDKConfig & {
+    /**
+     * The frontend client for the Ory SDK.
+     * This client is used to interact with the Ory SDK and should be used to make API calls.
+     */
+    frontend: FrontendApi;
+};
+type SDKConfig = {
+    /**
+     * The URL of the Ory SDK.
+     * This URL is used to connect to the Ory SDK and should be set to the base URL of your Ory instance.
+     */
+    url: string;
+    options?: Partial<ConfigurationParameters>;
+};
+declare function OryConfigurationProvider({ children, sdk: initialConfig, project, }: PropsWithChildren<{
+    sdk?: Partial<OryClientConfiguration["sdk"]>;
+    project?: Partial<AccountExperienceConfiguration>;
+}>): 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, OryConfigurationProvider, OryConsentCard, type OryElementsConfiguration, 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, useOryConfiguration, useOryFlow };