@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo

Modules

• ac-auth-js/src
• ac-auth-next/src
• ac-auth-next/src/proxy
• ac-auth-next/src/react
• ac-auth-react/src
• ac-auth/src

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src

ac-auth-js/src

@alternatefutures/ac-auth-js

Sign in with Alternate Clouds as an Auth.js provider (next-auth v5, @auth/core, and every framework Auth.js supports: SvelteKit, SolidStart, Express, ...). One line in providers, nothing else:

import NextAuth from 'next-auth'; import AlternateClouds from '@alternatefutures/ac-auth-js';

export const { handlers, auth, signIn, signOut } = NextAuth({ providers: [AlternateClouds({ clientId: process.env.AUTH_ALTERNATE_CLOUDS_ID })], });

The callback URL to register on the client is <origin>/api/auth/callback/alternate-clouds.

What the provider asks Auth.js for, and why:

• type: "oidc": discovery, ID token verification (EdDSA / ES256 through oauth4webapi) and the userinfo fallback come from the issuer document.
• checks: ["pkce", "state", "nonce"]: the issuer requires all three.
• client.token_endpoint_auth_method: none for a public client (no secret), client_secret_basic (the issuer's default) when a secret is given. Auth.js would otherwise assume Basic and the issuer would answer invalid_client for a public client.
• profile(): the Auth.js user is keyed on the wallet DID when the user has a verified wallet, else the subject, the same rule as @alternatefutures/ac-auth (userFromClaims).

Index

Interfaces

• AlternateCloudsOptions

Type Aliases

• AlternateCloudsProfile

Variables

• ALTERNATE_CLOUDS_PROVIDER_ID
• BRAND_COLOR

Functions

• AlternateClouds

References

default

Renames and re-exports AlternateClouds

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src / AlternateClouds

Function: AlternateClouds()

AlternateClouds(options): OIDCConfig<AlternateCloudsProfile>

Parameters

• options: AlternateCloudsOptions = {}

Returns

OIDCConfig<AlternateCloudsProfile>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:51

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src / AlternateCloudsOptions

Interface: AlternateCloudsOptions

Extends

• OIDCUserConfig<AlternateCloudsProfile>

Properties

[customFetch]()?

optional [customFetch]: (input, init?) => Promise<Response>(input, init?) => Promise<Response>

MDN Reference

Parameters

• input: RequestInfo | URL

• init?: RequestInit

Returns

Promise<Response>

Parameters

• input: string | Request | URL

• init?: RequestInit

Returns

Promise<Response>

See

Inherited from

OIDCUserConfig.[customFetch]

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:163

account?

optional account: AccountCallback

Receives the full TokenSet returned by the OAuth provider, and returns a subset. It is used to create the account associated with a user in the database.

:::note You need to adjust your database's Account model to match the returned properties. Check out the documentation of your database adapter for more information. :::

Defaults to: access_token, id_token, refresh_token, expires_at, scope, token_type, session_state

Example

import GitHub from "@auth/core/providers/github"
// ...
GitHub({
  account(account) {
    // https://docs.github.com/en/apps/creating-github-apps/authenticating-with-a-github-app/refreshing-user-access-tokens#refreshing-a-user-access-token-with-a-refresh-token
    const refresh_token_expires_at =
      Math.floor(Date.now() / 1000) + Number(account.refresh_token_expires_in)
    return {
      access_token: account.access_token,
      expires_at: account.expires_at,
      refresh_token: account.refresh_token,
      refresh_token_expires_at
    }
  }
})

See

• Database Adapter: Account model
• https://openid.net/specs/openid-connect-core-1_0.html#TokenResponse
• https://www.ietf.org/rfc/rfc6749.html#section-5.1

Inherited from

OIDCUserConfig.account

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:124

allowDangerousEmailAccountLinking?

optional allowDangerousEmailAccountLinking: boolean

Normally, when you sign in with an OAuth provider and another account with the same email address already exists, the accounts are not linked automatically.

Automatic account linking on sign in is not secure between arbitrary providers and is disabled by default. Learn more in our Security FAQ.

However, it may be desirable to allow automatic account linking if you trust that the provider involved has securely verified the email address associated with the account. Set allowDangerousEmailAccountLinking: true to enable automatic account linking.

Inherited from

OIDCUserConfig.allowDangerousEmailAccountLinking

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:160

authorization?

optional authorization: any

The login process will be initiated by sending the user to this URL.

Authorization endpoint

Inherited from

OIDCUserConfig.authorization

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:77

checks?

optional checks: ("pkce" | "state" | "none" | "nonce")[]

Inherited from

OIDCUserConfig.checks

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:173

client?

optional client: Partial<Client & object>

Pass overrides to the underlying OAuth library. See oauth4webapi client for details.

Inherited from

OIDCUserConfig.client

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:143

clientId?

optional clientId: string

Inherited from

OIDCUserConfig.clientId

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:137

clientSecret?

optional clientSecret: string

Inherited from

OIDCUserConfig.clientSecret

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:138

id?

optional id: string

Identifies the provider when you want to sign in to a specific provider.

Example

signIn('github') // "github" is the provider ID

Inherited from

OIDCUserConfig.id

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:58

idToken?

optional idToken: boolean

If set to false, the userinfo_endpoint will be fetched for the user data.

Note

An id_token is still required to be returned during the authorization flow.

Inherited from

OIDCUserConfig.idToken

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:178

issuer?

optional issuer: string

Issuer identifier. Default the production issuer; use the staging issuer for a staging client.

Overrides

OIDCUserConfig.issuer

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:41

jwks_endpoint

jwks_endpoint: any

Inherited from

OIDCUserConfig.jwks_endpoint

name?

optional name: string

The name of the provider. shown on the default sign in page.

Inherited from

OIDCUserConfig.name

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:60

profile?

optional profile: ProfileCallback<IdTokenClaims>

Receives the full Profile returned by the OAuth provider, and returns a subset. It is used to create the user in the database.

Defaults to: id, email, name, image

See

Database Adapter: User model

Inherited from

OIDCUserConfig.profile

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:89

redirectProxyUrl?

optional redirectProxyUrl: string

Inherited from

OIDCUserConfig.redirectProxyUrl

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:161

scope?

optional scope: string

Space-separated scopes. Default openid profile email. Add wallet and org.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:43

style?

optional style: OAuthProviderButtonStyles

Inherited from

OIDCUserConfig.style

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:146

token?

optional token: any

Inherited from

OIDCUserConfig.token

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:78

userinfo?

optional userinfo: any

Inherited from

OIDCUserConfig.userinfo

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:79

wellKnown?

optional wellKnown: string

OpenID Connect (OIDC) compliant providers can configure this instead of authorize/token/userinfo options without further configuration needed in most cases. You can still use the authorize/token/userinfo options for advanced control.

Authorization Server Metadata

Inherited from

OIDCUserConfig.wellKnown

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@auth/core/providers/oauth.d.ts:70

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src / AlternateCloudsProfile

Type Alias: AlternateCloudsProfile

AlternateCloudsProfile: IdTokenClaims

The claims the issuer puts in the ID token and the userinfo answer.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:37

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src / ALTERNATE_CLOUDS_PROVIDER_ID

Variable: ALTERNATE_CLOUDS_PROVIDER_ID

const ALTERNATE_CLOUDS_PROVIDER_ID: "alternate-clouds" = 'alternate-clouds'

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:46

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-js/src / BRAND_COLOR

Variable: BRAND_COLOR

const BRAND_COLOR: "#a5b2ff" = '#a5b2ff'

The brand accent, for the Auth.js default sign-in page button.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-js/src/index.ts:49

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src

ac-auth-next/src

@alternatefutures/ac-auth-next

Sign in with Alternate Clouds for the Next.js App Router. Create one instance in lib/auth.ts and wire three files:

// lib/auth.ts export const { auth, handlers, signInPath, toClientSession } = createAuth(authConfig);

// app/api/auth/[...auth]/route.ts export const { GET, POST } = handlers;

// proxy.ts (Next.js 16; middleware.ts on 15) export const proxy = createAuthProxy(authConfig); // from '@alternatefutures/ac-auth-next/proxy' export const config = { matcher: [...] }; // a literal: Next.js does not accept an imported constant

Then await auth() in Server Components and Route Handlers, and <AuthProvider> from @alternatefutures/ac-auth-next/react around the client tree.

Index

Classes

• AcAuthCore

Interfaces

• AcAuth
• AcAuthConfig
• ClientSession
• ServerSession
• SessionPayload

Functions

• createAuth
• safeReturnTo
• seal
• unseal

References

AuthProxy

Re-exports AuthProxy

createAuthProxy

Re-exports createAuthProxy

PROXY_MATCHER

Re-exports PROXY_MATCHER

ProxyOptions

Re-exports ProxyOptions

toClientSession

Re-exports toClientSession

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / AcAuthCore

Class: AcAuthCore

Constructors

new AcAuthCore()

new AcAuthCore(config): AcAuthCore

Parameters

• config: AcAuthConfig = {}

Returns

AcAuthCore

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:243

Properties

config

readonly config: ResolvedConfig

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:237

Methods

clearSessionCookie()

clearSessionCookie(request): string

Parameters

• request: Request

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:313

handle()

handle(request): Promise<Response>

Route a request under basePath to the handler for its last segment.

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:573

handleCallback()

handleCallback(request): Promise<Response>

GET <basePath>/callback: finish the flow, seal the session, go to returnTo.

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:406

handleSession()

handleSession(request): Promise<Response>

GET <basePath>/session: the client-safe session.

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:564

handleSignIn()

handleSignIn(request): Promise<Response>

GET <basePath>/signin: start the code + PKCE flow.

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:369

handleSignOut()

handleSignOut(request): Promise<Response>

POST <basePath>/signout (also GET): clear the session, optionally end it at the issuer.

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:522

metadata()

metadata(): Promise<IssuerMetadata>

Returns

Promise<IssuerMetadata>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:260

readSessionCookie()

readSessionCookie(cookieHeader): null | string

The session cookie value of a request, whichever prefix it was set with.

Parameters

• cookieHeader: undefined | null | string

Returns

null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:292

refreshSessionCookie()

refreshSessionCookie(cookieValue): Promise<object | object | object>

Decide what the proxy should do with the incoming session cookie: keep (valid or no session), set (refreshed: write this value), clear (definitively signed out).

Parameters

• cookieValue: undefined | null | string

Returns

Promise<object | object | object>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:494

sealSession()

sealSession(payload): Promise<string>

Parameters

• payload: SessionPayload

Returns

Promise<string>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:300

sessionCookie()

sessionCookie(request, value): string

Parameters

• request: Request

• value: string

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:309

sessionCookieName()

sessionCookieName(request): string

Cookie names carry a browser-enforced prefix over https (OAuth for browser-based apps, BFF cookies): __Host- for the session cookie (Secure, Path=/, no Domain, so no subdomain can set or widen it) and __Secure- for the transaction cookie (its path is the base path, which __Host- forbids). Plain names over http (local development).

Parameters

• request: Request

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:282

sessionFromCookieHeader()

sessionFromCookieHeader(cookieHeader): Promise<null | ServerSession>

The session carried by a Cookie header value.

Parameters

• cookieHeader: undefined | null | string

Returns

Promise<null | ServerSession>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:350

sessionFromPayload()

sessionFromPayload(payload): null | ServerSession

Interpret a sealed payload at now: null when expired past the grace cap.

Parameters

• payload: null | SessionPayload

Returns

null | ServerSession

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:326

signInPath()

signInPath(returnTo?, extra?): string

Parameters

• returnTo?: null | string

• extra?: Record<string, string> = {}

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:356

signOutPath()

signOutPath(): string

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:364

unsealSession()

unsealSession(value): Promise<null | SessionPayload>

Parameters

• value: undefined | null | string

Returns

Promise<null | SessionPayload>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:305

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / createAuth

Function: createAuth()

createAuth(config): AcAuth

Parameters

• config: AcAuthConfig = {}

Returns

AcAuth

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:50

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / safeReturnTo

Function: safeReturnTo()

safeReturnTo(value): string | null

Only same-origin paths may be used as a return target.

Parameters

• value: undefined | null | string

Returns

string | null

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:217

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / seal

Function: seal()

seal(payload, options): Promise<string>

Parameters

• payload: Record<string, unknown>

• options: SealOptions

Returns

Promise<string>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/seal.ts:41

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / unseal

Function: unseal()

unseal<T>(token, options): Promise<T | null>

Null for anything that does not decrypt, is of another purpose, or is expired.

Type Parameters

• T extends Record<string, unknown>

Parameters

• token: undefined | null | string

• options: Omit<SealOptions, "expiresAt">

Returns

Promise<T | null>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/seal.ts:52

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / AcAuth

Interface: AcAuth

Properties

core

core: AcAuthCore

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:35

handlers

handlers: object

Route handlers for app/<basePath>/[...auth]/route.ts.

GET()

GET: (request) => Promise<Response>

Parameters

• request: Request

Returns

Promise<Response>

POST()

POST: (request) => Promise<Response>

Parameters

• request: Request

Returns

Promise<Response>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:39

proxy

proxy: AuthProxy

The proxy that refreshes the session cookie, sharing this instance's refresh coordinator.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:41

toClientSession()

toClientSession: (session) => ClientSession | null

Parameters

• session: null | ServerSession

Returns

ClientSession | null

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:47

Methods

auth()

auth(): Promise<null | ServerSession>

The session for the current request (Server Components, Server Actions, Route Handlers). Never refreshes.

Returns

Promise<null | ServerSession>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:37

createProxy()

createProxy(options?): AuthProxy

Build a proxy with options (protected paths).

Parameters

• options?: ProxyOptions

Returns

AuthProxy

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:43

signInPath()

signInPath(returnTo?): string

<basePath>/signin?returnTo=...

Parameters

• returnTo?: null | string

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:45

signOutPath()

signOutPath(): string

Returns

string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/index.ts:46

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / AcAuthConfig

Interface: AcAuthConfig

Properties

afterSignOutPath?

optional afterSignOutPath: string

Same-origin path to land on after a local sign-out. Default /.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:79

basePath?

optional basePath: string

Where the route handlers are mounted. Default /api/auth.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:71

clientAuthenticationMethod?

optional clientAuthenticationMethod: "client_secret_basic" | "client_secret_post"

How the secret is sent. Default client_secret_basic (the issuer's default for new clients).

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:67

clientId?

optional clientId: string

Default ALTERNATE_CLOUDS_CLIENT_ID.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:63

clientSecret?

optional clientSecret: string

Confidential clients only. Default ALTERNATE_CLOUDS_CLIENT_SECRET. Absent means a public client (PKCE only).

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:65

cookie?

optional cookie: object

domain?

optional domain: string

maxAgeSeconds?

optional maxAgeSeconds: number

Session cookie lifetime. Default 30 days (the refresh token's lifetime).

name?

optional name: string

Default ac_auth.session; the transaction cookie is <name>.txn.

sameSite?

optional sameSite: "lax" | "strict"

secure?

optional secure: boolean

Default: secure when the request is https.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:82

embeddedKeys?

optional embeddedKeys: readonly JWK[]

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:93

env?

optional env: Record<string, undefined | string>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:102

fetch?

optional fetch: FetchLike

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:95

grace?

optional grace: false | Partial<SessionGracePolicy>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:92

issuer?

optional issuer: string

Issuer identifier. Default ALTERNATE_CLOUDS_ISSUER, else the production issuer.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:61

metadata?

optional metadata: IssuerMetadata

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:94

now()?

optional now: () => number

Returns

number

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:100

onWarning()?

optional onWarning: (message, cause?) => void

Parameters

• message: string

• cause?: unknown

Returns

void

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:101

postLogoutRedirectUri?

optional postLogoutRedirectUri: string

Registered post-logout redirect URI. When set, sign-out also ends the issuer session.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:77

redirectUri?

optional redirectUri: string

Absolute redirect URI registered on the client. Default <origin><basePath>/callback of the incoming request.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:75

refreshLeewayMs?

optional refreshLeewayMs: number

Refresh this long before the access token expires. Default 30 s.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:97

revokeOnSignOut?

optional revokeOnSignOut: boolean

Also revoke the refresh token at the issuer on sign-out (disconnects the app on every device). Default false.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:81

scope?

optional scope: string | readonly string[]

Default openid profile email.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:73

secret?

optional secret: string

Seals the cookies. Default AUTH_SECRET. At least 16 characters.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:69

trustHost?

optional trustHost: boolean

Trust x-forwarded-proto / x-forwarded-host to compute the origin. Default true.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:99

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / ClientSession

Interface: ClientSession

What the browser is allowed to see.

Properties

expiresAt

expiresAt: number

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:169

issuedAt

issuedAt: number

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:170

status

status: "active" | "grace"

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:167

user

user: AuthUser

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:168

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / ServerSession

Interface: ServerSession

What auth() returns on the server.

Properties

accessToken

accessToken: string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:160

claims

claims: IdTokenClaims

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:156

expiresAt

expiresAt: number

Epoch ms.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:158

idToken

idToken: null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:161

issuedAt

issuedAt: number

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:159

scope

scope: null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:162

status

status: "active" | "grace"

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:154

user

user: AuthUser

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:155

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src / SessionPayload

Interface: SessionPayload

The sealed session cookie.

Extends

• Record<string, unknown>

Properties

at

at: string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:133

exp_ms

exp_ms: number

Access token expiry, epoch ms.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:137

iat_ms

iat_ms: number

Issued at, epoch ms.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:139

idt

idt: null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:135

rt

rt: null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:134

scope

scope: null | string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:140

v

v: 1

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/core.ts:132

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/proxy

ac-auth-next/src/proxy

Index

Interfaces

• ProxyOptions

Type Aliases

• AuthProxy

Variables

• PROXY_MATCHER

Functions

• createAuthProxy

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/proxy / createAuthProxy

Function: createAuthProxy()

createAuthProxy(configOrCore, options): AuthProxy

Build the proxy from an existing core (shared with createAuth) or a config.

Parameters

• configOrCore: AcAuthConfig | AcAuthCore = {}

• options: ProxyOptions = {}

Returns

AuthProxy

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:39

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/proxy / ProxyOptions

Interface: ProxyOptions

Properties

protect?

optional protect: string[] | (pathname) => boolean

Paths (or a predicate) that require a session. A visitor without one is sent to the sign-in with returnTo set. Default: nothing is protected; pages decide with auth().

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:24

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/proxy / AuthProxy

Type Alias: AuthProxy()

AuthProxy: (request) => Promise<NextResponse>

Parameters

• request: NextRequest

Returns

Promise<NextResponse>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:30

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/proxy / PROXY_MATCHER

Variable: PROXY_MATCHER

const PROXY_MATCHER: string[]

The recommended matcher (skips static assets). Copy its VALUE into proxy.ts: Next.js only accepts a literal there.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/proxy.ts:28

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/react

ac-auth-next/src/react

Index

Interfaces

• AuthProviderProps

Functions

• AuthProvider
• serverAdapter

References

AuthSession

Re-exports AuthSession

AuthSignInOptions

Re-exports AuthSignInOptions

AuthSignOutOptions

Re-exports AuthSignOutOptions

AuthStatus

Re-exports AuthStatus

AuthTheme

Re-exports AuthTheme

Mark

Re-exports Mark

SIGN_IN_LABEL

Re-exports SIGN_IN_LABEL

SignedIn

Re-exports SignedIn

SignedOut

Re-exports SignedOut

SignedProps

Re-exports SignedProps

SignIn

Re-exports SignIn

SignInButton

Re-exports SignInButton

SignInButtonProps

Re-exports SignInButtonProps

SignInMethod

Re-exports SignInMethod

SignInProps

Re-exports SignInProps

useAuth

Re-exports useAuth

useOrganization

Re-exports useOrganization

UserButton

Re-exports UserButton

UserButtonItem

Re-exports UserButtonItem

UserButtonItemProps

Re-exports UserButtonItemProps

UserButtonProps

Re-exports UserButtonProps

useSession

Re-exports useSession

useUser

Re-exports useUser

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/react / AuthProvider

Function: AuthProvider()

AuthProvider(__namedParameters): Element

Parameters

• __namedParameters: AuthProviderProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:98

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/react / serverAdapter

Function: serverAdapter()

serverAdapter(basePath): AuthAdapter

Adapter over the route handlers.

Parameters

• basePath: string = '/api/auth'

Returns

AuthAdapter

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:56

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-next/src/react / AuthProviderProps

Interface: AuthProviderProps

Extends

• Omit<AuthProviderProps, "client" | "adapter">

Properties

basePath?

optional basePath: string

Must match createAuth({ basePath }). Default /api/auth.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:48

children?

optional children: ReactNode

Inherited from

Omit.children

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:95

initialSession?

optional initialSession: null | AuthSession

From toClientSession(await auth()) in a Server Component, so the first paint is right.

Overrides

Omit.initialSession

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-next/src/react.tsx:50

onError()?

optional onError: (error) => void

Parameters

• error: Error

Returns

void

Inherited from

Omit.onError

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:94

onSignedIn()?

optional onSignedIn: (returnTo, session) => void

Client mode: called with the path to continue on after a sign-in completed on this page. Default: history.replaceState.

Parameters

• returnTo: null | string

• session: AuthSession

Returns

void

Inherited from

Omit.onSignedIn

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:93

theme?

optional theme: AuthTheme

dark (default, the Alternate Clouds web app's scheme) or light force a scheme, system follows the OS, inherit sets no variables so the host's own design tokens apply (an app running the web app's stylesheet).

Inherited from

Omit.theme

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:91

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src

ac-auth-react/src

@alternatefutures/ac-auth-react

React components and hooks for Sign in with Alternate Clouds, built from the same shadcn primitives, palette and typography as the Alternate Clouds web app. Import the stylesheet once (@alternatefutures/ac-auth-react/styles.css) unless the app already runs the web app's stylesheet (then pass theme="inherit"), wrap the app in <AuthProvider>, and use the components.

Index

Interfaces

• AuthAdapter
• AuthContextValue
• AuthProviderProps
• AuthSession
• AuthSignInOptions
• AuthSignOutOptions
• MarkProps
• SignedProps
• SignInButtonProps
• SignInProps
• UserButtonItemProps
• UserButtonProps

Type Aliases

• AuthStatus
• AuthTheme
• SignInMethod

Variables

• AUTH_CARD_CLASS
• BRAND_BUTTON_CLASS
• DEFAULT_ACCOUNT_URL
• SIGN_IN_LABEL

Functions

• AuthProvider
• clientAdapter
• Mark
• SignedIn
• SignedOut
• SignIn
• SignInButton
• useAuth
• useOrganization
• UserButton
• UserButtonItem
• useSession
• useUser

References

AuthUser

Re-exports AuthUser

OrganizationClaim

Re-exports OrganizationClaim

Session

Re-exports Session

TokenSet

Re-exports TokenSet

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthProvider

Function: AuthProvider()

AuthProvider(props): Element

Parameters

• props: AuthProviderProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:127

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / Mark

Function: Mark()

Mark(__namedParameters): Element

Parameters

• __namedParameters: MarkProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Mark.tsx:15

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / SignIn

Function: SignIn()

SignIn(__namedParameters): Element

Parameters

• __namedParameters: SignInProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignIn.tsx:58

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / SignInButton

Function: SignInButton()

SignInButton(__namedParameters): Element

Parameters

• __namedParameters: SignInButtonProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/SignInButton.tsx:36

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / SignedIn

Function: SignedIn()

SignedIn(__namedParameters): null | Element

Renders its children only for a signed-in user.

Parameters

• __namedParameters: SignedProps

Returns

null | Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:13

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / SignedOut

Function: SignedOut()

SignedOut(__namedParameters): null | Element

Renders its children only when nobody is signed in.

Parameters

• __namedParameters: SignedProps

Returns

null | Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/Signed.tsx:20

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / UserButton

Function: UserButton()

UserButton(__namedParameters): null | Element

Parameters

• __namedParameters: UserButtonProps

Returns

null | Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:58

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / UserButtonItem

Function: UserButtonItem()

UserButtonItem(__namedParameters): Element

A menu item for <UserButton>: a link when href is given, else a button.

Parameters

• __namedParameters: UserButtonItemProps

Returns

Element

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/components/UserButton.tsx:43

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / clientAdapter

Function: clientAdapter()

clientAdapter(client): AuthAdapter

Wrap an AuthClient as an adapter.

Parameters

• client: AuthClient

Returns

AuthAdapter

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:104

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / useAuth

Function: useAuth()

useAuth(): AuthContextValue

Returns

AuthContextValue

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:236

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / useOrganization

Function: useOrganization()

useOrganization(): object

Returns

object

isLoaded

isLoaded: boolean

organization

organization: OrganizationClaim | null

role

role: string | null

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:252

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / useSession

Function: useSession()

useSession(): object

Returns

object

isLoaded

isLoaded: boolean

refresh()

refresh: () => Promise<AuthSession | null>

Returns

Promise<AuthSession | null>

session

session: AuthSession | null

status

status: AuthStatus

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:247

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / useUser

Function: useUser()

useUser(): object

Returns

object

isLoaded

isLoaded: boolean

isSignedIn

isSignedIn: boolean

user

user: AuthUser | null

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:242

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthAdapter

Interface: AuthAdapter

What the provider needs from a session source. Implemented by auth-next for the server-side session.

Methods

completeCallback()?

optional completeCallback(): Promise<null | object>

Client mode only: finish a sign-in when the current page is the redirect URI. Returns the path to continue on, or null when the page is not a callback.

Returns

Promise<null | object>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:58

getSession()

getSession(): Promise<null | AuthSession>

Returns

Promise<null | AuthSession>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:49

peek()?

optional peek(): null | AuthSession

Synchronous snapshot for the first render, if the adapter has one.

Returns

null | AuthSession

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:48

signIn()

signIn(options?): void | Promise<void>

Parameters

• options?: AuthSignInOptions

Returns

void | Promise<void>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:50

signOut()

signOut(options?): void | Promise<void>

Parameters

• options?: AuthSignOutOptions

Returns

void | Promise<void>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:51

subscribe()?

optional subscribe(listener): () => void

Parameters

• listener

Returns

Function

Returns

void

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:52

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthContextValue

Interface: AuthContextValue

Properties

error

error: null | Error

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:65

isLoaded

isLoaded: boolean

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:66

isSignedIn

isSignedIn: boolean

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:67

session

session: null | AuthSession

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:63

status

status: AuthStatus

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:62

theme

theme: AuthTheme

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:72

user

user: null | AuthUser

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:64

Methods

refresh()

refresh(): Promise<null | AuthSession>

Re-read the session from its source (refreshing tokens when needed).

Returns

Promise<null | AuthSession>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:71

signIn()

signIn(options?): Promise<void>

Parameters

• options?: AuthSignInOptions

Returns

Promise<void>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:68

signOut()

signOut(options?): Promise<void>

Parameters

• options?: AuthSignOutOptions

Returns

Promise<void>

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:69

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthProviderProps

Interface: AuthProviderProps

Properties

adapter?

optional adapter: AuthAdapter

Server-session mode (auth-next) or any custom source.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:83

children?

optional children: ReactNode

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:95

client?

optional client: AuthClient

Browser-only mode: the client does PKCE and holds the tokens.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:81

initialSession?

optional initialSession: null | AuthSession

A session known at render time (from the server) so the first paint is right.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:85

onError()?

optional onError: (error) => void

Parameters

• error: Error

Returns

void

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:94

onSignedIn()?

optional onSignedIn: (returnTo, session) => void

Client mode: called with the path to continue on after a sign-in completed on this page. Default: history.replaceState.

Parameters

• returnTo: null | string

• session: AuthSession

Returns

void

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:93

theme?

optional theme: AuthTheme

dark (default, the Alternate Clouds web app's scheme) or light force a scheme, system follows the OS, inherit sets no variables so the host's own design tokens apply (an app running the web app's stylesheet).

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:91

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthSession

Interface: AuthSession

A session as the React tree sees it. Tokens are present only in client mode.

Properties

expiresAt

expiresAt: number

Epoch ms.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:25

issuedAt

issuedAt: number

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:26

status

status: "active" | "grace"

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:22

tokens?

optional tokens: TokenSet

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:27

user

user: AuthUser

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:23

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthSignInOptions

Interface: AuthSignInOptions

Extended by

• SignInButtonProps
• SignInProps

Properties

loginHint?

optional loginHint: string

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:37

prompt?

optional prompt: "none" | "login" | "consent" | "select_account"

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:36

returnTo?

optional returnTo: string

Where to land after the sign-in completes. Same-origin path.

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:34

scope?

optional scope: string | readonly string[]

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:35

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / AuthSignOutOptions

Interface: AuthSignOutOptions

Extended by

• UserButtonProps

Properties

returnTo?

optional returnTo: string

Where to land after signing out (client mode: the registered post-logout redirect URI is used when set).

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/packages/ac-auth-react/src/context.tsx:42

@alternatefutures/ac-auth-sdk-monorepo • Docs

@alternatefutures/ac-auth-sdk-monorepo / ac-auth-react/src / MarkProps

Interface: MarkProps

Extends

• Omit<React.SVGProps<SVGSVGElement>, "children">

Properties

accentHeight?

optional accentHeight: string | number

Inherited from

Omit.accentHeight

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3718

accumulate?

optional accumulate: "none" | "sum"

Inherited from

Omit.accumulate

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3719

additive?

optional additive: "sum" | "replace"

Inherited from

Omit.additive

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3720

alignmentBaseline?

optional alignmentBaseline: "inherit" | "auto" | "alphabetic" | "hanging" | "ideographic" | "mathematical" | "baseline" | "before-edge" | "text-before-edge" | "middle" | "central" | "after-edge" | "text-after-edge"

Inherited from

Omit.alignmentBaseline

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3721

allowReorder?

optional allowReorder: "yes" | "no"

Inherited from

Omit.allowReorder

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3736

alphabetic?

optional alphabetic: string | number

Inherited from

Omit.alphabetic

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3737

amplitude?

optional amplitude: string | number

Inherited from

Omit.amplitude

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3738

arabicForm?

optional arabicForm: "initial" | "medial" | "terminal" | "isolated"

Inherited from

Omit.arabicForm

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:3739

aria-activedescendant?

optional aria-activedescendant: string

Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.

Inherited from

Omit.aria-activedescendant

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2585

aria-atomic?

optional aria-atomic: Booleanish

Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.

Inherited from

Omit.aria-atomic

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2587

aria-autocomplete?

optional aria-autocomplete: "none" | "list" | "inline" | "both"

Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.

Inherited from

Omit.aria-autocomplete

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2592

aria-braillelabel?

optional aria-braillelabel: string

Defines a string value that labels the current element, which is intended to be converted into Braille.

See

aria-label.

Inherited from

Omit.aria-braillelabel

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2598

aria-brailleroledescription?

optional aria-brailleroledescription: string

Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.

See

aria-roledescription.

Inherited from

Omit.aria-brailleroledescription

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2603

aria-busy?

optional aria-busy: Booleanish

Inherited from

Omit.aria-busy

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2604

aria-checked?

optional aria-checked: boolean | "true" | "false" | "mixed"

Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.

See

• aria-pressed
• aria-selected.

Inherited from

Omit.aria-checked

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2609

aria-colcount?

optional aria-colcount: number

Defines the total number of columns in a table, grid, or treegrid.

See

aria-colindex.

Inherited from

Omit.aria-colcount

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2614

aria-colindex?

optional aria-colindex: number

Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.

See

• aria-colcount
• aria-colspan.

Inherited from

Omit.aria-colindex

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2619

aria-colindextext?

optional aria-colindextext: string

Defines a human readable text alternative of aria-colindex.

See

aria-rowindextext.

Inherited from

Omit.aria-colindextext

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2624

aria-colspan?

optional aria-colspan: number

Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.

See

• aria-colindex
• aria-rowspan.

Inherited from

Omit.aria-colspan

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2629

aria-controls?

optional aria-controls: string

Identifies the element (or elements) whose contents or presence are controlled by the current element.

See

aria-owns.

Inherited from

Omit.aria-controls

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2634

aria-current?

optional aria-current: boolean | "time" | "true" | "false" | "page" | "step" | "location" | "date"

Indicates the element that represents the current item within a container or set of related elements.

Inherited from

Omit.aria-current

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2636

aria-describedby?

optional aria-describedby: string

Identifies the element (or elements) that describes the object.

See

aria-labelledby

Inherited from

Omit.aria-describedby

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2641

aria-description?

optional aria-description: string

Defines a string value that describes or annotates the current element.

See

related aria-describedby.

Inherited from

Omit.aria-description

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2646

aria-details?

optional aria-details: string

Identifies the element that provides a detailed, extended description for the object.

See

aria-describedby.

Inherited from

Omit.aria-details

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2651

aria-disabled?

optional aria-disabled: Booleanish

Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.

See

• aria-hidden
• aria-readonly.

Inherited from

Omit.aria-disabled

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2656

aria-dropeffect?

optional aria-dropeffect: "none" | "link" | "copy" | "execute" | "move" | "popup"

Indicates what functions can be performed when a dragged object is released on the drop target.

Deprecated

in ARIA 1.1

Inherited from

Omit.aria-dropeffect

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2661

aria-errormessage?

optional aria-errormessage: string

Identifies the element that provides an error message for the object.

See

• aria-invalid
• aria-describedby.

Inherited from

Omit.aria-errormessage

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2666

aria-expanded?

optional aria-expanded: Booleanish

Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.

Inherited from

Omit.aria-expanded

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2668

aria-flowto?

optional aria-flowto: string

Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.

Inherited from

Omit.aria-flowto

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2673

aria-grabbed?

optional aria-grabbed: Booleanish

Indicates an element's "grabbed" state in a drag-and-drop operation.

Deprecated

in ARIA 1.1

Inherited from

Omit.aria-grabbed

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2678

aria-haspopup?

optional aria-haspopup: boolean | "dialog" | "menu" | "true" | "false" | "grid" | "listbox" | "tree"

Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.

Inherited from

Omit.aria-haspopup

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2680

aria-hidden?

optional aria-hidden: Booleanish

Indicates whether the element is exposed to an accessibility API.

See

aria-disabled.

Inherited from

Omit.aria-hidden

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2685

aria-invalid?

optional aria-invalid: boolean | "true" | "false" | "grammar" | "spelling"

Indicates the entered value does not conform to the format expected by the application.

See

aria-errormessage.

Inherited from

Omit.aria-invalid

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2690

aria-keyshortcuts?

optional aria-keyshortcuts: string

Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.

Inherited from

Omit.aria-keyshortcuts

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2692

aria-label?

optional aria-label: string

Defines a string value that labels the current element.

See

aria-labelledby.

Inherited from

Omit.aria-label

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2697

aria-labelledby?

optional aria-labelledby: string

Identifies the element (or elements) that labels the current element.

See

aria-describedby.

Inherited from

Omit.aria-labelledby

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2702

aria-level?

optional aria-level: number

Defines the hierarchical level of an element within a structure.

Inherited from

Omit.aria-level

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2704

aria-live?

optional aria-live: "off" | "assertive" | "polite"

Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.

Inherited from

Omit.aria-live

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2706

aria-modal?

optional aria-modal: Booleanish

Indicates whether an element is modal when displayed.

Inherited from

Omit.aria-modal

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2708

aria-multiline?

optional aria-multiline: Booleanish

Indicates whether a text box accepts multiple lines of input or only a single line.

Inherited from

Omit.aria-multiline

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2710

aria-multiselectable?

optional aria-multiselectable: Booleanish

Indicates that the user may select more than one item from the current selectable descendants.

Inherited from

Omit.aria-multiselectable

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2712

aria-orientation?

optional aria-orientation: "horizontal" | "vertical"

Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.

Inherited from

Omit.aria-orientation

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2714

aria-owns?

optional aria-owns: string

Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.

See

aria-controls.

Inherited from

Omit.aria-owns

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2720

aria-placeholder?

optional aria-placeholder: string

Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.

Inherited from

Omit.aria-placeholder

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2725

aria-posinset?

optional aria-posinset: number

Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.

See

aria-setsize.

Inherited from

Omit.aria-posinset

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2730

aria-pressed?

optional aria-pressed: boolean | "true" | "false" | "mixed"

Indicates the current "pressed" state of toggle buttons.

See

• aria-checked
• aria-selected.

Inherited from

Omit.aria-pressed

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2735

aria-readonly?

optional aria-readonly: Booleanish

Indicates that the element is not editable, but is otherwise operable.

See

aria-disabled.

Inherited from

Omit.aria-readonly

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2740

aria-relevant?

optional aria-relevant: "text" | "additions" | "additions removals" | "additions text" | "all" | "removals" | "removals additions" | "removals text" | "text additions" | "text removals"

Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.

See

aria-atomic.

Inherited from

Omit.aria-relevant

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2745

aria-required?

optional aria-required: Booleanish

Indicates that user input is required on the element before a form may be submitted.

Inherited from

Omit.aria-required

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2758

aria-roledescription?

optional aria-roledescription: string

Defines a human-readable, author-localized description for the role of an element.

Inherited from

Omit.aria-roledescription

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2760

aria-rowcount?

optional aria-rowcount: number

Defines the total number of rows in a table, grid, or treegrid.

See

aria-rowindex.

Inherited from

Omit.aria-rowcount

Defined in

work/web-docs.alternatefutures.ai/web-docs.alternatefutures.ai/alternate-auth-sdk/node_modules/@types/react/index.d.ts:2765

aria-rowindex?

optional aria-rowindex: number

Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.

See

• aria-rowcount
• aria-rowspan.

Inherited from

Omit.aria-rowindex

Defined in