Function createClientStore

  • createClientStore<ActionType extends ActionTypes>(
        param: {
            logger?: {
                changeLevel: (level: LogLevel) => void;
                debug: (...args: LogMessage[]) => void;
                error: (...args: LogMessage[]) => void;
                info: (...args: LogMessage[]) => void;
                warn: (...args: LogMessage[]) => void;
            };
            requestMiddleware?: RequestMiddleware<ActionType, unknown>[];
        },
    ): EnhancedStore<
        {
            oidc: CombinedState<
                {
                    authorizeFetch: MutationDefinition<
                        { url: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        AuthorizeSuccessResponse,
                        "oidc",
                        unknown,
                    >;
                    authorizeIframe: MutationDefinition<
                        { url: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        AuthorizationSuccess,
                        "oidc",
                        unknown,
                    >;
                    endSession: MutationDefinition<
                        { endpoint: string; idToken: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        null,
                        "oidc",
                        unknown,
                    >;
                    exchange: MutationDefinition<
                        {
                            code: string;
                            config: OidcConfig;
                            endpoint: string;
                            verifier?: string;
                        },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        TokenExchangeResponse,
                        "oidc",
                        unknown,
                    >;
                    revoke: MutationDefinition<
                        { accessToken: string; clientId?: string; endpoint: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        object,
                        "oidc",
                        unknown,
                    >;
                    userInfo: MutationDefinition<
                        { accessToken: string; endpoint: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        UserInfoResponse,
                        "oidc",
                        unknown,
                    >;
                },
                never,
                "oidc",
            >;
            wellknown: CombinedState<
                {
                    configuration: QueryDefinition<
                        string,
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        WellknownResponse,
                        "wellknown",
                        unknown,
                    >;
                },
                never,
                "wellknown",
            >;
        },
        UnknownAction,
        Tuple<
            [
                StoreEnhancer<
                    {
                        dispatch: ThunkDispatch<
                            {
                                oidc: CombinedState<
                                    {
                                        authorizeFetch: MutationDefinition<
                                            { url: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            AuthorizeSuccessResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                        authorizeIframe: MutationDefinition<
                                            { url: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            AuthorizationSuccess,
                                            "oidc",
                                            unknown,
                                        >;
                                        endSession: MutationDefinition<
                                            { endpoint: ...; idToken: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            null,
                                            "oidc",
                                            unknown,
                                        >;
                                        exchange: MutationDefinition<
                                            { code: ...; config: ...; endpoint: ...; verifier?: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            TokenExchangeResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                        revoke: MutationDefinition<
                                            { accessToken: ...; clientId?: ...; endpoint: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            object,
                                            "oidc",
                                            unknown,
                                        >;
                                        userInfo: MutationDefinition<
                                            { accessToken: ...; endpoint: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            UserInfoResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                    },
                                    never,
                                    "oidc",
                                >;
                                wellknown: CombinedState<
                                    {
                                        configuration: QueryDefinition<
                                            string,
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            WellknownResponse,
                                            "wellknown",
                                            unknown,
                                        >;
                                    },
                                    never,
                                    "wellknown",
                                >;
                            },
                        >;
                    },
                >,
                StoreEnhancer,
            ],
        >,
    >

    Type Parameters

    Parameters

    • param: {
          logger?: {
              changeLevel: (level: LogLevel) => void;
              debug: (...args: LogMessage[]) => void;
              error: (...args: LogMessage[]) => void;
              info: (...args: LogMessage[]) => void;
              warn: (...args: LogMessage[]) => void;
          };
          requestMiddleware?: RequestMiddleware<ActionType, unknown>[];
      }

      Configuration options for the client store.

      • Optionallogger?: {
            changeLevel: (level: LogLevel) => void;
            debug: (...args: LogMessage[]) => void;
            error: (...args: LogMessage[]) => void;
            info: (...args: LogMessage[]) => void;
            warn: (...args: LogMessage[]) => void;
        }

        An optional logger function for logging messages.

      • OptionalrequestMiddleware?: RequestMiddleware<ActionType, unknown>[]

        An array of request middleware functions to be applied to the store.

    Returns EnhancedStore<
        {
            oidc: CombinedState<
                {
                    authorizeFetch: MutationDefinition<
                        { url: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        AuthorizeSuccessResponse,
                        "oidc",
                        unknown,
                    >;
                    authorizeIframe: MutationDefinition<
                        { url: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        AuthorizationSuccess,
                        "oidc",
                        unknown,
                    >;
                    endSession: MutationDefinition<
                        { endpoint: string; idToken: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        null,
                        "oidc",
                        unknown,
                    >;
                    exchange: MutationDefinition<
                        {
                            code: string;
                            config: OidcConfig;
                            endpoint: string;
                            verifier?: string;
                        },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        TokenExchangeResponse,
                        "oidc",
                        unknown,
                    >;
                    revoke: MutationDefinition<
                        { accessToken: string; clientId?: string; endpoint: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        object,
                        "oidc",
                        unknown,
                    >;
                    userInfo: MutationDefinition<
                        { accessToken: string; endpoint: string },
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        UserInfoResponse,
                        "oidc",
                        unknown,
                    >;
                },
                never,
                "oidc",
            >;
            wellknown: CombinedState<
                {
                    configuration: QueryDefinition<
                        string,
                        BaseQueryFn<
                            string
                            | FetchArgs,
                            unknown,
                            FetchBaseQueryError,
                            {},
                            FetchBaseQueryMeta,
                        >,
                        never,
                        WellknownResponse,
                        "wellknown",
                        unknown,
                    >;
                },
                never,
                "wellknown",
            >;
        },
        UnknownAction,
        Tuple<
            [
                StoreEnhancer<
                    {
                        dispatch: ThunkDispatch<
                            {
                                oidc: CombinedState<
                                    {
                                        authorizeFetch: MutationDefinition<
                                            { url: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            AuthorizeSuccessResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                        authorizeIframe: MutationDefinition<
                                            { url: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            AuthorizationSuccess,
                                            "oidc",
                                            unknown,
                                        >;
                                        endSession: MutationDefinition<
                                            { endpoint: ...; idToken: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            null,
                                            "oidc",
                                            unknown,
                                        >;
                                        exchange: MutationDefinition<
                                            { code: ...; config: ...; endpoint: ...; verifier?: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            TokenExchangeResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                        revoke: MutationDefinition<
                                            { accessToken: ...; clientId?: ...; endpoint: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            object,
                                            "oidc",
                                            unknown,
                                        >;
                                        userInfo: MutationDefinition<
                                            { accessToken: ...; endpoint: ... },
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            UserInfoResponse,
                                            "oidc",
                                            unknown,
                                        >;
                                    },
                                    never,
                                    "oidc",
                                >;
                                wellknown: CombinedState<
                                    {
                                        configuration: QueryDefinition<
                                            string,
                                            BaseQueryFn<(...), (...), (...), (...), (...)>,
                                            never,
                                            WellknownResponse,
                                            "wellknown",
                                            unknown,
                                        >;
                                    },
                                    never,
                                    "wellknown",
                                >;
                            },
                        >;
                    },
                >,
                StoreEnhancer,
            ],
        >,
    >

    • Returns a configured Redux store with OIDC and well-known APIs.

    Function

    createClientStore

    Description

    Creates a Redux store configured with OIDC and well-known APIs.

Settings

Member Visibility