Class ESPRMNeoUser

constructor

• new ESPRMNeoUser(tokens: UserTokensData): ESPRMNeoUser

  Initializes the ESPRMNeoUser instance and persists the tokens to storage.

  Parameters

  • tokens: UserTokensData

    Object containing the access token, id token, and refresh token.

  Returns ESPRMNeoUser

eventCallbacks

eventTeardowns

assumeRole

• assumeRole(
      accessKey: string,
      secretKey: string,
      sessionToken: string,
      options?: AssumeRoleOptions,
  ): Promise<AWSCredentials>

  Exchanges identity (temporary) credentials for role-based credentials.

  Two modes — chosen by whether options.services is set:

  1. Default (no options.services): POST /v1/assumed-roles. Returns IoT/MQTT credentials scoped to the user's group/subgroup membership. Used for MQTT WebSocket auth.
  2. Per-node services (options.services with nodeId): Same route, with services and node_id in the body. Returns credentials scoped to that single node for the listed services (currently s3 and/or kvs). The response contains only the requested service permissions — no IoT/MQTT statements.

  Parameters

  • accessKey: string

    AWS access key from getTemporaryAWSCredentials.
  • secretKey: string

    AWS secret key from getTemporaryAWSCredentials.
  • sessionToken: string

    AWS session token from getTemporaryAWSCredentials.
  • Optionaloptions: AssumeRoleOptions

    Optional. To request per-node service credentials, pass services and nodeId.

  Returns Promise<AWSCredentials>

  A promise that resolves to AWSCredentials.

  Throws

  Error if services is set without nodeId, or if the API call fails.

connectMQTT

• connectMQTT(): Promise<boolean>

  Connects to MQTT websocket.

  Client ID format: user:<email|phone>:<session> — required by the assume-role IoT policy which scopes iot:Connect to that prefix.

  Returns Promise<boolean>

  A promise that resolves to true if connection was successful.

  Throws

  Error if connection fails or AWS credentials are not set

createESPDevice

• createESPDevice(
      name: string,
      transport: ESPTransport,
      security?: ESPSecurity,
      proofOfPossession?: string,
      softAPPassword?: string,
      username?: string,
  ): Promise<ESPDevice>

  Creates an ESP device with the given parameters.

  Parameters

  • name: string

    The name of the device.
  • transport: ESPTransport

    The transport type to use.
  • Optionalsecurity: ESPSecurity

    The security type to use (optional).
  • OptionalproofOfPossession: string

    The proof of possession string (optional).
  • OptionalsoftAPPassword: string

    The SoftAP password (optional).
  • Optionalusername: string

    The username (optional).

  Returns Promise<ESPDevice>

  A promise that resolves to an ESPDevice instance.

createGroup

• createGroup(groupName: string): Promise<ESPRMNeoGroup>

  Creates a new group.

  Calls POST /v1/groups.

  Parameters

  • groupName: string

    Name of the group

  Returns Promise<ESPRMNeoGroup>

  A promise that resolves to the created ESPRMNeoGroup

disconnectMQTT

• disconnectMQTT(): Promise<void>

  Disconnects the MQTT websocket connection if one is active. No-op when MQTT was never initialized or is already disconnected.

  Returns Promise<void>

  Throws

  Error if disconnection fails.

getAccessToken

• getAccessToken(): Promise<string>

  Returns a valid Cognito access token from storage. Refreshes the session when the stored access token is expired.

  Returns Promise<string>

  Throws

  When no access/refresh token is stored, or refresh fails.

getGroups

• getGroups(): Promise<ESPRMNeoGroup[]>

  Retrieves the list of groups associated with the user.

  Calls GET /v1/groups.

  Returns Promise<ESPRMNeoGroup[]>

  A promise that resolves to an array of ESPRMNeoGroup instances

getIdToken

• getIdToken(): Promise<string>

  Returns a valid Cognito ID token from storage. Refreshes the session when the stored ID token is expired.

  Returns Promise<string>

  Throws

  When no ID/refresh token is stored, or refresh fails.

getRefreshToken

• getRefreshToken(): Promise<string>

  Returns the current Cognito refresh token from storage.

  Returns Promise<string>

  Throws

  When no refresh token is stored (not logged in).

getTemporaryAWSCredentials

• getTemporaryAWSCredentials(): Promise<ESPAWSCredentials>

  Gets temporary AWS credentials for the authenticated user.

  Calls POST /v1/user/credentials with the Cognito ID token as Bearer auth. Refreshes the session (refresh token → new tokens) when the ID token is expired locally, or when the API returns 401 with an expired-token message, then retries. Delegates to fetchTemporaryAWSCredentials.

  Returns Promise<ESPAWSCredentials>

  Temporary AWS credentials (access key, secret key, session token, expiration).

  Throws

  If the user is not logged in (missing ID/refresh token).

  Throws

  If a network error occurs or the API request fails.

getUserInfo

• getUserInfo(): Promise<ESPRMNeoUserInfo>

  Retrieves user information from GET /v1/users/me.

  Returns Promise<ESPRMNeoUserInfo>

  A promise that resolves to an ESPRMNeoUserInfo object containing the user information.

listIntegrations

• listIntegrations(): Promise<IntegrationInfo[]>

  Lists the configured integrations available to the calling user (SigV4-signed GET /v1/integrations). This is the non-admin counterpart of the admin listing and exposes only integration_id / integration_type — no credentials or other configuration.

  Use the returned integration_id when registering a delivery endpoint via ESPRMNeoUser.registerIntegrationEndpoint.

  Returns Promise<IntegrationInfo[]>

  A promise that resolves to the list of configured integrations.

listSharingRequests

• listSharingRequests(): Promise<ESPRMNeoSharingRequest[]>

  Retrieves sharing requests received by the current user.

  Calls GET /v1/sharing-requests/received.

  Returns Promise<ESPRMNeoSharingRequest[]>

  A promise that resolves to an array of ESPRMNeoSharingRequest instances

logout

• logout(): Promise<boolean>

  Logs out the user by invalidating the server session (best-effort), disconnecting MQTT, clearing tokens/credentials, and resetting local state.

  Returns Promise<boolean>

  A promise that resolves to true if local cleanup completed, false if an unexpected error occurred.

registerIntegrationEndpoint

• registerIntegrationEndpoint(
      integrationId: string,
      appToken: string,
      locale?: string,
  ): Promise<string>

  Registers a delivery endpoint for the calling user on the given integration (SigV4-signed PUT /v1/integrations/{integrationId}/endpoints). The server derives an endpoint_id per integration type and returns it.

  Callers must persist the returned endpoint_id to later address the endpoint (e.g. for ESPRMNeoUser.unregisterIntegrationEndpoint).

  Parameters

  • integrationId: string

    Target integration id (from ESPRMNeoUser.listIntegrations).
  • appToken: string

    Delivery credential (delivery_credentials.app_token), e.g. the push token.
  • Optionallocale: string

    Optional locale (e.g. en_US).

  Returns Promise<string>

  The endpoint_id derived and returned by the server.

removeAllCallbacks

• removeAllCallbacks(event?: string): void

  Clears one event, or every event when event is omitted.

  Parameters

  • Optionalevent: string

  Returns void

searchESPDevices

• searchESPDevices(
      devicePrefix: string,
      transport: ESPTransport,
  ): Promise<ESPDevice[]>

  Searches for ESP devices with the given prefix.

  Parameters

  • devicePrefix: string

    The prefix of the device name to search for.
  • transport: ESPTransport

    The transport type (BLE or SoftAP).

  Returns Promise<ESPDevice[]>

  A promise that resolves to an array of ESPDevice instances.

subscribe

• subscribe(
      event: string,
      callback: ESPEventCallback,
      discoveryConfig?: DiscoveryParamsInterface,
  ): void

  Subscribes a callback to an event (replaces any existing one).

  • ESPRMNeoEventType.localDiscovery: starts LAN discovery; each hit is delivered as ESPDiscoveredNodeData.
  • ESPRMNeoEventType.nodeUpdates: forwards process-wide node param updates.
  • Custom string event + discoveryConfig: starts discovery with that config and forwards raw results unchanged.

  Parameters

  • event: string
  • callback: ESPEventCallback
  • OptionaldiscoveryConfig: DiscoveryParamsInterface

  Returns void

trigger

• trigger(event: string, arg: unknown): void

  Invokes the registered callback for event (if any) with arg.

  Parameters

  • event: string
  • arg: unknown

  Returns void

unregisterIntegrationEndpoint

• unregisterIntegrationEndpoint(
      integrationId: string,
      endpointId: string,
  ): Promise<SuccessResponse>

  Unregisters one specific delivery endpoint for the calling user on the given integration (SigV4-signed DELETE /v1/integrations/{integrationId}/endpoints/{endpointId}), cleaning up the underlying delivery registration.

  Parameters

  • integrationId: string

    Integration the endpoint was registered on.
  • endpointId: string

    The endpoint_id returned by ESPRMNeoUser.registerIntegrationEndpoint.

  Returns Promise<SuccessResponse>

  API success payload (optional { message } on success).

unsubscribe

• unsubscribe(event: string): void

  Removes the callback and stops any backing source for the event.

  Parameters

  • event: string

  Returns void

StaticextendSession

• extendSession(refreshToken: string): Promise<void>

  Extends the current session using a refresh token.

  Parameters

  • refreshToken: string

  Returns Promise<void>