@ory/elements-react 1.0.0-next.1 → 1.0.0-next.11

package/api-report/temp/elements-react.api.md

@@ -0,0 +1,331 @@
+## API Report File for "@ory/elements-react"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ComponentPropsWithoutRef } from 'react';
+import { ComponentType } from 'react';
+import { ConfigurationParameters } from '@ory/client-fetch';
+import { DetailedHTMLProps } from 'react';
+import { Dispatch } from 'react';
+import { FlowError } from '@ory/client-fetch';
+import { FlowType } from '@ory/client-fetch';
+import { FormEventHandler } from 'react';
+import { HTMLAttributes } from 'react';
+import { IntlShape } from 'react-intl';
+import { LoginFlow } from '@ory/client-fetch';
+import { MouseEventHandler } from 'react';
+import { OnRedirectHandler } from '@ory/client-fetch';
+import { PropsWithChildren } from 'react';
+import * as react_jsx_runtime from 'react/jsx-runtime';
+import { RecoveryFlow } from '@ory/client-fetch';
+import { RegistrationFlow } from '@ory/client-fetch';
+import { Session } from '@ory/client-fetch';
+import { SettingsFlow } from '@ory/client-fetch';
+import { UiNode } from '@ory/client-fetch';
+import { UiNodeAnchorAttributes } from '@ory/client-fetch';
+import { UiNodeGroupEnum } from '@ory/client-fetch';
+import { UiNodeImageAttributes } from '@ory/client-fetch';
+import { UiNodeInputAttributes } from '@ory/client-fetch';
+import { UiNodeTextAttributes } from '@ory/client-fetch';
+import { UiText } from '@ory/client-fetch';
+import { UpdateLoginFlowBody } from '@ory/client-fetch';
+import { UpdateRecoveryFlowBody } from '@ory/client-fetch';
+import { UpdateRegistrationFlowBody } from '@ory/client-fetch';
+import { UpdateSettingsFlowBody } from '@ory/client-fetch';
+import { UpdateVerificationFlowBody } from '@ory/client-fetch';
+import { VerificationFlow } from '@ory/client-fetch';
+
+// Warning: (ae-forgotten-export) The symbol "OryFlow" needs to be exported by the entry point index.d.ts
+//
+// @public
+export type ErrorFlowContainer = OryFlow<FlowType.Error, FlowError>;
+
+// @public
+export type FlowContainerSetter = Dispatch<Partial<OryFlowContainer>>;
+
+// @public
+export type FlowContextValue = OryFlowContainer & {
+    setFlowContainer: FlowContainerSetter;
+};
+
+// @public
+export type FormValues = Record<string, string | boolean | number | undefined>;
+
+// Warning: (ae-forgotten-export) The symbol "IntlContextProps" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type IntlConfig = IntlContextProps;
+
+// @public
+export type LoginFlowContainer = OryFlow<FlowType.Login, LoginFlow>;
+
+// @public
+export function messageTestId(message: UiText): {
+    "data-testid": string;
+};
+
+// @public
+export type OnSubmitHandlerProps<T extends UpdateLoginFlowBody | UpdateRegistrationFlowBody | UpdateVerificationFlowBody | UpdateRecoveryFlowBody | UpdateSettingsFlowBody> = {
+    setFlowContainer: (flowContainer: OryFlowContainer) => void;
+    body: T;
+    onRedirect: OnRedirectHandler;
+};
+
+// @public
+export function OryCard({ children }: PropsWithChildren): react_jsx_runtime.JSX.Element;
+
+// @public
+export type OryCardAuthMethodListItemProps = {
+    onClick: () => void;
+    group: string;
+};
+
+// @public
+export function OryCardContent({ children }: OryCardContentProps): react_jsx_runtime.JSX.Element;
+
+// @public
+export type OryCardContentProps = PropsWithChildren;
+
+// @public
+export type OryCardDividerProps = Record<string, never>;
+
+// @public (undocumented)
+export function OryCardFooter(): react_jsx_runtime.JSX.Element;
+
+// @public (undocumented)
+export type OryCardFooterProps = Record<string, never>;
+
+// @public (undocumented)
+export function OryCardHeader(): react_jsx_runtime.JSX.Element;
+
+// @public (undocumented)
+export type OryCardHeaderProps = Record<string, never>;
+
+// @public (undocumented)
+export type OryCardLogoProps = Record<string, never>;
+
+// @public (undocumented)
+export type OryCardProps = PropsWithChildren;
+
+// @public (undocumented)
+export function OryCardValidationMessages({ ...props }: OryMessageRootProps): react_jsx_runtime.JSX.Element | null;
+
+// @public (undocumented)
+export type OryClientConfiguration = {
+    name: string;
+    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;
+    };
+    intl?: IntlConfig;
+};
+
+// @public (undocumented)
+export type OryCurrentIdentifierProps = {
+    attributes: UiNodeInputAttributes;
+    node: UiNode;
+    onClick?: () => void;
+    href?: string;
+} & Omit<ComponentPropsWithoutRef<"button">, "children" | "onClick">;
+
+// Warning: (ae-forgotten-export) The symbol "DeepPartialTwoLevels" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export type OryFlowComponentOverrides = DeepPartialTwoLevels<OryFlowComponents>;
+
+// @public
+export type OryFlowComponents = {
+    Node: {
+        Button: ComponentType<OryNodeButtonProps>;
+        OidcButton: ComponentType<OryNodeOidcButtonProps>;
+        CurrentIdentifierButton: ComponentType<OryCurrentIdentifierProps>;
+        Anchor: ComponentType<OryNodeAnchorProps>;
+        Input: ComponentType<OryNodeInputProps>;
+        CodeInput: ComponentType<OryNodeInputProps>;
+        Image: ComponentType<OryNodeImageProps>;
+        Label: ComponentType<OryNodeLabelProps>;
+        Checkbox: ComponentType<OryNodeInputProps>;
+        Text: ComponentType<OryNodeTextProps>;
+    };
+    Card: {
+        Root: ComponentType<OryCardProps>;
+        Footer: ComponentType<OryCardFooterProps>;
+        Header: ComponentType<OryCardProps>;
+        Content: ComponentType<OryCardContentProps>;
+        Logo: ComponentType<OryCardLogoProps>;
+        Divider: ComponentType<OryCardDividerProps>;
+        AuthMethodListItem: ComponentType<OryCardAuthMethodListItemProps>;
+    };
+    Form: {
+        Root: ComponentType<OryFormRootProps>;
+        OidcRoot: ComponentType<OryFormOidcRootProps>;
+        Group: ComponentType<OryFormGroupProps>;
+    };
+    Message: {
+        Root: ComponentType<OryMessageRootProps>;
+        Content: ComponentType<OryMessageContentProps>;
+    };
+};
+
+// @public
+export type OryFlowContainer = LoginFlowContainer | RegistrationFlowContainer | RecoveryFlowContainer | VerificationFlowContainer | SettingsFlowContainer;
+
+// @public (undocumented)
+export function OryForm({ children }: OryFormProps): string | react_jsx_runtime.JSX.Element;
+
+// @public
+export function OryFormGroupDivider(): react_jsx_runtime.JSX.Element | null;
+
+// @public (undocumented)
+export type OryFormGroupProps = PropsWithChildren;
+
+// @public (undocumented)
+export function OryFormGroups({ children, groups }: OryFormGroupsProps): react_jsx_runtime.JSX.Element;
+
+// @public (undocumented)
+export type OryFormGroupsProps = PropsWithChildren<{
+    groups: UiNodeGroupEnum[];
+}>;
+
+// @public (undocumented)
+export function OryFormOidcButtons({ children, hideDivider, }: OryFormOidcButtonsProps): react_jsx_runtime.JSX.Element | null;
+
+// @public (undocumented)
+export type OryFormOidcButtonsProps = PropsWithChildren<{
+    hideDivider?: boolean;
+}>;
+
+// @public (undocumented)
+export type OryFormOidcRootProps = PropsWithChildren<{
+    nodes: UiNode[];
+}>;
+
+// @public (undocumented)
+export type OryFormProps = PropsWithChildren;
+
+// @public (undocumented)
+export type OryFormRootProps = ComponentPropsWithoutRef<"form"> & {
+    onSubmit: FormEventHandler<HTMLFormElement>;
+};
+
+// @public (undocumented)
+export function OryFormSocialButtonsForm(): react_jsx_runtime.JSX.Element | null;
+
+// Warning: (ae-forgotten-export) The symbol "LocaleMap" needs to be exported by the entry point index.d.ts
+//
+// @public (undocumented)
+export const OryLocales: LocaleMap;
+
+// @public (undocumented)
+export type OryMessageContentProps = {
+    message: UiText;
+};
+
+// @public (undocumented)
+export type OryMessageRootProps = DetailedHTMLProps<HTMLAttributes<HTMLDivElement>, HTMLDivElement>;
+
+// @public (undocumented)
+export type OryNodeAnchorProps = {
+    attributes: UiNodeAnchorAttributes;
+    node: UiNode;
+} & Omit<ComponentPropsWithoutRef<"a">, "children">;
+
+// @public (undocumented)
+export type OryNodeButtonProps = {
+    attributes: UiNodeInputAttributes;
+    node: UiNode;
+} & Omit<ComponentPropsWithoutRef<"button">, "children">;
+
+// @public (undocumented)
+export type OryNodeImageProps = {
+    attributes: UiNodeImageAttributes;
+    node: UiNode;
+};
+
+// @public (undocumented)
+export type OryNodeInputProps = {
+    attributes: UiNodeInputAttributes;
+    node: UiNode;
+    onClick?: MouseEventHandler;
+};
+
+// @public (undocumented)
+export type OryNodeLabelProps = {
+    attributes: UiNodeInputAttributes;
+    node: UiNode;
+} & ComponentPropsWithoutRef<"label">;
+
+// @public (undocumented)
+export type OryNodeOidcButtonProps = {
+    node: UiNode;
+    attributes: UiNodeInputAttributes;
+    onClick?: () => void;
+};
+
+// @public (undocumented)
+export type OryNodeTextProps = {
+    attributes: UiNodeTextAttributes;
+    node: UiNode;
+};
+
+// @public (undocumented)
+export function OryProvider({ children, components: Components, ...oryFlowProps }: OryProviderProps): react_jsx_runtime.JSX.Element;
+
+// @public (undocumented)
+export type OryProviderProps = {
+    components: OryFlowComponents;
+} & OryFlowContainer & PropsWithChildren;
+
+// @public (undocumented)
+export function OryTwoStepCard(): react_jsx_runtime.JSX.Element;
+
+// @public
+export type RecoveryFlowContainer = OryFlow<FlowType.Recovery, RecoveryFlow>;
+
+// @public
+export type RegistrationFlowContainer = OryFlow<FlowType.Registration, RegistrationFlow>;
+
+// @public
+export type SettingsFlowContainer = OryFlow<FlowType.Settings, SettingsFlow>;
+
+// @public
+export const uiTextToFormattedMessage: ({ id, context, text }: Omit<UiText, "type">, intl: IntlShape) => string;
+
+// @public (undocumented)
+export function useComponents(): OryFlowComponents;
+
+// @public (undocumented)
+export function useNodeSorter(): (a: UiNode, b: UiNode, ctx: {
+    flowType: string;
+}) => number;
+
+// @public
+export function useOryFlow(): FlowContextValue;
+
+// @public
+export const useSession: () => {
+    session: Session | undefined;
+    error: string | undefined;
+    isLoading: boolean;
+};
+
+// @public
+export type VerificationFlowContainer = OryFlow<FlowType.Verification, VerificationFlow>;
+
+// (No @packageDocumentation comment for this package)
+
+```