@ory/elements-react 0.0.0-pr.4a28a8f → 0.0.0-pr.5cdcf132

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { UiNodeInputAttributes, UiNode, UiNodeAnchorAttributes, UiNodeTextAttributes, UiNodeImageAttributes, UiNodeGroupEnum, UiText, ConfigurationParameters, FlowType, LoginFlow, RegistrationFlow, RecoveryFlow, VerificationFlow, SettingsFlow, FlowError, UpdateLoginFlowBody, UpdateRegistrationFlowBody, UpdateVerificationFlowBody, UpdateRecoveryFlowBody, UpdateSettingsFlowBody, OnRedirectHandler } from '@ory/client-fetch';
+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 { 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,12 +53,18 @@ type OryNodeImageProps = {
 type FormValues = Record<string, string | boolean | number | undefined>;
 type OryFormRootProps = ComponentPropsWithoutRef<"form"> & {
     onSubmit: FormEventHandler<HTMLFormElement>;
+    "data-testid"?: string;
 };
 type OryNodeInputProps = {
     attributes: UiNodeInputAttributes;
     node: UiNode;
     onClick?: MouseEventHandler;
 };
+type OryNodeConsentScopeCheckboxProps = {
+    attributes: UiNodeInputAttributes;
+    node: UiNode;
+    onCheckedChange: (checked: boolean) => void;
+};
 type OryFormSectionContentProps = PropsWithChildren<{
     title?: string;
     description?: string;
@@ -105,6 +111,8 @@ declare function OryCardContent({ children }: OryCardContentProps): react_jsx_ru
 
 declare function OryTwoStepCard(): react_jsx_runtime.JSX.Element;
 
+declare function OryConsentCard(): react_jsx_runtime.JSX.Element;
+
 /**
  * Props type for the Form Group Divider component.
  */
@@ -248,6 +256,10 @@ type OryFlowComponents = {
          * The Captcha component is rendered whenever a "captcha" group is encountered.
          */
         Captcha: ComponentType<OryNodeCaptchaProps>;
+        /**
+         * Special version of the Input component for scopes in OAuth2 flows.
+         */
+        ConsentScopeCheckbox: ComponentType<OryNodeConsentScopeCheckboxProps>;
     };
     Card: {
         /**
@@ -363,8 +375,9 @@ 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: {
@@ -414,7 +427,7 @@ type OryClientConfiguration = {
  *
  * @see OryClientConfiguration
  */
-type OryFlow<TFlowType, TFlow> = {
+type OryFlow<TFlowType extends FlowType, TFlow> = {
     flowType: TFlowType;
     flow: TFlow;
     config: OryClientConfiguration;
@@ -463,10 +476,23 @@ type SettingsFlowContainer = OryFlow<FlowType.Settings, SettingsFlow>;
  *
  */
 type ErrorFlowContainer = OryFlow<FlowType.Error, FlowError>;
+type ConsentFlow = {
+    created_at: Date;
+    expires_at: Date;
+    id: string;
+    issued_at: Date;
+    state: "show_form" | "rejected" | "accepted";
+    active: string;
+    ui: UiContainer;
+    consent_request: OAuth2ConsentRequest;
+    session: Session;
+    return_to?: string;
+};
+type ConsentFlowContainer = OryFlow<FlowType.OAuth2Consent, ConsentFlow>;
 /**
  * A union type of all flow containers
  */
-type OryFlowContainer = LoginFlowContainer | RegistrationFlowContainer | RecoveryFlowContainer | VerificationFlowContainer | SettingsFlowContainer;
+type OryFlowContainer = LoginFlowContainer | RegistrationFlowContainer | RecoveryFlowContainer | VerificationFlowContainer | SettingsFlowContainer | ConsentFlowContainer;
 
 /**
  * Converts a UiText to a FormattedMessage.
@@ -536,18 +562,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";
@@ -594,4 +625,4 @@ type OryProviderProps = {
 } & OryFlowContainer & PropsWithChildren;
 declare function OryProvider({ children, components: Components, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
 
-export { 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, 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 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 };