Class ChRISConnection

constructor

• new ChRISConnection(
      config?: ConnectionConfig,
      storageProvider?: IStorageProvider,
  ): ChRISConnection

  Constructs a new ChRISConnection instance.

  Parameters

  • Optionalconfig: ConnectionConfig

    The connection configuration object.

  • OptionalstorageProvider: IStorageProvider

    The storage provider for persistence.

  Returns ChRISConnection

loginProbe

config

• get config(): ConnectionConfig | undefined

  Access the connection configuration.

  Returns ConnectionConfig | undefined

authToken_get

• authToken_get(forceLoad?: boolean): Promise<string | null>

  Retrieves the authentication token.

  Parameters

  • OptionalforceLoad: boolean

    If true, forces loading the token from storage.

  Returns Promise<string | null>

  A Promise resolving to the authentication token or null.

chrisURL_get

• chrisURL_get(): Promise<string | null>

  Retrieves the ChRIS CUBE URL.

  Returns Promise<string | null>

  A Promise resolving to the ChRIS URL or null.

client_get

• client_get(): Promise<Client | null>

  Retrieves the ChRIS API client instance.

  Returns Promise<Client | null>

  A Promise resolving to the Client instance or null.

client_refresh

• client_refresh(): Promise<Client | null>

  Refreshes the ChRIS API client with current token and URL.

  Returns Promise<Client | null>

  A Promise resolving to the refreshed Client instance or null.

connection_connect

• connection_connect(options: ConnectOptions): Promise<string | null>

  Establishes a connection to the ChRIS CUBE and authenticates the user.

  Parameters

  • options: ConnectOptions

    Connection options including user, password, debug flag, and URL.

  Returns Promise<string | null>

  A Promise resolving to the authentication token on success, or null on failure.

connection_connectWithToken

• connection_connectWithToken(
      options: TokenConnectOptions,
  ): Promise<TokenConnectOutcome>

  Establishes a connection from a CUBE token somebody else already minted.

  The password path exchanges a password for a token and saves it. A front that authenticated the operator itself — a login door on a shared host — holds the token and never the password, so it hands the token over as it is. The token is proved against the server BEFORE anything is written: a refused token leaves the saved context and the last-user pointer exactly as they were. Nothing here exits the process, and nothing lands on the error stack; the refusal travels in the outcome, because the caller is a boot that has its own row to write.

  Parameters

  • options: TokenConnectOptions

    The identity the token was minted for, and the token.

  Returns Promise<TokenConnectOutcome>

  Connected, or refused with the server's reason.

connection_isConnected

• connection_isConnected(): boolean

  Checks if the client is currently connected.

  Returns boolean

  True if connected, false otherwise.

connection_logout

• connection_logout(): Promise<void>

  Logs out the user by clearing the authentication token from storage.

  Returns Promise<void>

context_set

• context_set(context: string): Promise<boolean>

  Sets the ChRIS context based on a context string (e.g., user@url?folder=...).

  Parameters

  • context: string

    The context string.

  Returns Promise<boolean>

  A Promise resolving to true on success, false otherwise.

elevation_runWithCredentials

• elevation_runWithCredentials<T>(
      credentials: ElevationCredentials,
      operation: () => Promise<T>,
  ): Promise<T>

  Executes one operation with a non-persistent CUBE client for supplied credentials. The client follows only the nested operation's asynchronous context, so concurrent normal and elevated commands retain their own identities.

  The normal session token, cached client, and token storage remain intact.

  Type Parameters

  • T

  Parameters

  • credentials: ElevationCredentials

    Credentials for the requested CUBE identity.

  • operation: () => Promise<T>

    Work to perform while the temporary client is active.

  Returns Promise<T>

  The operation's result.

  Throws

  When no CUBE URL is available or authentication fails.

init

• init(config: ConnectionConfig, storageProvider: IStorageProvider): void

  Parameters

  • config: ConnectionConfig
  • storageProvider: IStorageProvider

  Returns void

token_check

• token_check(url: string, token: string): Promise<void>

  Proves a token against a CUBE without reading its root, which is the feed list and can outlast the check for an identity that sees thousands of feeds (#1280).

  Parameters

  • url: string

    Base URL of the CUBE API, ending in /.

  • token: string

    The token to prove.

  Returns Promise<void>

  Throws

  chrisapi's error: carrying CUBE's response when it refused, "No server response!" when nothing came back.

user_get

• user_get(): Promise<string | null>

  Retrieves the current authenticated user's username.

  Returns Promise<string | null>

  A Promise resolving to the username string or null if not authenticated.