Class ProviderAbstract

constructor

• new Provider(): Provider

• Returns Provider

delToken

getToken

getTokens

Readonly Abstract id

Readonly preferGetClaimsPage

putToken

Abstract authenticate

• authenticate(timeout?): AsyncGenerator<ProviderAuthenticateRequest, IdentityId, unknown>

• Authenticates to an identity id, acquiring the token This token must be stored on the token database. This is a generator that only has 1 step. This is because we require the caller to perform an authorisation action. The final return value is the identity ID.

  Parameters

  • Optional timeout: number

  Returns AsyncGenerator<ProviderAuthenticateRequest, IdentityId, unknown>

checkToken

• checkToken(providerToken, identityId?): Promise<ProviderToken>

• Checks that the token is still valid If the access token has expired, and there is no refresh token then this will throw the ErrorProviderUnauthenticated exception If the refresh token exists but has expired then this will throw the ErrorProviderUnauthenticated exception If the refresh token exists, and is still valid, then it will attempt to refresh the token. If you pass in identityId, expect that the new token will be persisted. If either providerToken.accessTokenExpiresIn or providerToken.refreshTokenExpiresIn is set to 0, their related tokens will be treated as never-expiring.

  Parameters

  • providerToken: ProviderToken

  • Optional identityId: IdentityId

  Returns Promise<ProviderToken>

Abstract getAuthIdentityIds

• getAuthIdentityIds(): Promise<IdentityId[]>

• Gets an array of authenticated identity ids

  Returns Promise<IdentityId[]>

Abstract getClaim

• getClaim(authIdentityId, claimId): Promise<undefined | IdentitySignedClaim>

• Gets the identity claim given the claim's ID on the provider

  Parameters

  • authIdentityId: IdentityId

  • claimId: ProviderIdentityClaimId

  Returns Promise<undefined | IdentitySignedClaim>

getClaimIds

• getClaimIds(authIdentityId, identityId): AsyncGenerator<ProviderIdentityClaimId, any, unknown>

• Stream identity claimIds from an identity

  Parameters

  • authIdentityId: IdentityId

  • identityId: IdentityId

  Returns AsyncGenerator<ProviderIdentityClaimId, any, unknown>

Abstract getClaimIdsPage

• getClaimIdsPage(authIdentityId, identityId, paginationToken?): AsyncGenerator<{
      claimId: ProviderIdentityClaimId;
      nextPaginationToken?: ProviderPaginationToken;
  }, any, unknown>

• Stream a page of identity claimIds from an identity

  Parameters

  • authIdentityId: IdentityId

  • identityId: IdentityId

  • Optional paginationToken: ProviderPaginationToken

  Returns AsyncGenerator<{
      claimId: ProviderIdentityClaimId;
      nextPaginationToken?: ProviderPaginationToken;
  }, any, unknown>

getClaims

• getClaims(authIdentityId, identityId): AsyncGenerator<IdentitySignedClaim, any, unknown>

• Stream identity claims from an identity

  Parameters

  • authIdentityId: IdentityId

  • identityId: IdentityId

  Returns AsyncGenerator<IdentitySignedClaim, any, unknown>

getClaimsPage

• getClaimsPage(authIdentityId, identityId, paginationToken?): AsyncGenerator<{
      claim: IdentitySignedClaim;
      nextPaginationToken?: ProviderPaginationToken;
  }, any, unknown>

• Stream a page of identity claims from an identity

  Parameters

  • authIdentityId: IdentityId

  • identityId: IdentityId

  • Optional paginationToken: ProviderPaginationToken

  Returns AsyncGenerator<{
      claim: IdentitySignedClaim;
      nextPaginationToken?: ProviderPaginationToken;
  }, any, unknown>

Abstract getConnectedIdentityDatas

• getConnectedIdentityDatas(authIdentityId, searchTerms?): AsyncGenerator<IdentityData, any, unknown>

• Stream connected identity infos to a particular identity This is intended to find "friends", "followers", "contacts"... etc Some social providers do not have this concept In such a case, one stream other random identities that exist on the network Search terms are provider-implementation specific

  Parameters

  • authIdentityId: IdentityId

  • Optional searchTerms: string[]

  Returns AsyncGenerator<IdentityData, any, unknown>

Abstract getIdentityData

• getIdentityData(authIdentityId, identityId, options?): Promise<undefined | IdentityData>

• Gets the identity data for a given identity

  Parameters

  • authIdentityId: IdentityId

  • identityId: IdentityId

  • Optional options: {
        signal?: AbortSignal;
    }

    • Optional signal?: AbortSignal

  Returns Promise<undefined | IdentityData>

Abstract getIdentityId

• getIdentityId(providerToken): Promise<IdentityId>

• Gets the corresponding identity ID to a token key

  Parameters

  • providerToken: ProviderToken

  Returns Promise<IdentityId>

parseClaim

• parseClaim(signedClaimEncodedJSON): undefined | SignedClaim<ClaimLinkIdentity>

• This verifies that the claim's JSON data fits our schema This does not verify whether the signature is correct

  Parameters

  • signedClaimEncodedJSON: string

  Returns undefined | SignedClaim<ClaimLinkIdentity>

Abstract publishClaim

• publishClaim(authIdentityId, identityClaim): Promise<IdentitySignedClaim>

• Publishes an identity claim on the authenticated identity. Returns an IdentitySignedClaim, wrapping the SignedClaim itself with extra metadata from the published claim (e.g. URL, claim ID on provider)

  Parameters

  • authIdentityId: IdentityId

  • identityClaim: SignedClaim<ClaimLinkIdentity>

  Returns Promise<IdentitySignedClaim>

Abstract refreshToken

• refreshToken(providerToken, identityId?): Promise<ProviderToken>

• Refreshes the token If identity is passed in, this function should update the token db

  Parameters

  • providerToken: ProviderToken

  • Optional identityId: IdentityId

  Returns Promise<ProviderToken>

setTokenDb

• setTokenDb(getTokens, getToken, putToken, delToken): void

• Setting up token database functions This must be called before the provider starts to be used

  Parameters

  • getTokens: GetTokens

  • getToken: GetToken

  • putToken: PutToken

  • delToken: DelToken

  Returns void