Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientPKey

Class wrapping @graphistry/js-upload-api::ClientPKey for client->server File and Dataset uploads using personal key authentication.

global

Hierarchy

  • ClientPKey
    • ClientPKey

Index

Methods

Properties

Constructors

Methods

Static isConfigurationValid

  • isConfigurationValid(userId: string, secret: string, host: string): boolean

authTokenValid

  • authTokenValid(): boolean

checkStale

  • checkStale(personalKeyId: string, personalKeySecret: string, protocol: string, host: string, clientProtocolHostname?: string): boolean

  • Parameters

    • personalKeyId: string
    • personalKeySecret: string
    • protocol: string
    • host: string
    • Optional clientProtocolHostname: string

    Returns boolean

fetchToken

  • fetchToken(personalKeyId: string, personalKeySecret: string, org?: string, protocol?: string, host?: string): Promise<string>

  • Parameters

    • personalKeyId: string
    • personalKeySecret: string
    • Optional org: string
    • Optional protocol: string
    • Optional host: string

    Returns Promise<string>

    Promise for the authentication token

    Helper to fetch a token for a given user

isServerConfigured

  • isServerConfigured(): boolean

post

  • post(uri: string, payload: any, baseHeaders?: any): Promise<any>
  • internal

    Internal helper

    Parameters

    • uri: string

      The URI to upload to.

    • payload: any

      The payload to upload.

    • Optional baseHeaders: any

      Optionally override base header object to mix with auth header for the upload.

    Returns Promise<any>

    The response from the server.

setToken

Protected getAuthToken

  • getAuthToken(force?: boolean): Promise<string>

  • Get the authentication token for the current user. By default, reuses current token if available.

    Parameters

    • Optional force: boolean

      If true, forces a new token to be generated; defaults to false

    Returns Promise<string>

    The authentication token

Protected getBaseHeaders

  • getBaseHeaders(): { Accept: string; Content-Type: string }

Protected getBaseUrl

  • getBaseUrl(): string

Protected getToApi

  • getToApi(url: string, headers: any, baseUrl?: string): Promise<any>

Protected postToApi

  • postToApi(url: string, data: any, headers: any, baseUrl?: string): Promise<any>

Properties

Readonly agent

agent: string

Readonly clientProtocolHostname

clientProtocolHostname: string

Readonly host

host: string

Optional Readonly org

org?: string

Readonly personalKeyId

personalKeyId: string

Readonly protocol

protocol: string

Optional Readonly version

version?: string

Protected Optional _getAuthTokenPromise

_getAuthTokenPromise?: Promise<string>

Protected Optional _token

_token?: string

Protected fetch

fetch: any

Constructors

constructor

  • new ClientPKey(personalKeyId: string, personalKeySecret: string, org?: string, protocol?: string, host?: string, clientProtocolHostname?: string, version?: string): ClientPKey

  • Create a Client

    example

    Authenticate against Graphistry Hub

    import { Client } from '@graphistry/client-api';
    const client = new Client('my_personal_key_id', 'my_personal_key_secret');

    Parameters

    • personalKeyId: string

      Graphistry server personal key ID

    • personalKeySecret: string

      Graphistry server personal key secret

    • Optional org: string

      Graphistry organization (optional)

    • protocol: string = 'https'
    • host: string = 'hub.graphistry.com'
    • Optional clientProtocolHostname: string

      Override URL base path shown in browsers. By default uses protocol/host combo, e.g., https://hub.graphistry.com

      For more examples, see @graphistry/node-api and @graphistry/js-upload-api docs

    • version: string = VERSION

    Returns ClientPKey