@graphistry/node-api/src/index.ts

Graphistry API client for use with node.js

import { Client as ClientBase, ClientPKey as ClientPKeyBase } from '@graphistry/js-upload-api';
import { version as VERSION } from './version.js';
import fetch from 'node-fetch-commonjs';

export {
    Dataset, File, EdgeFile, NodeFile,
    FileType,
    Privacy, Mode, ModeAction, ModeActionRaw
} from '@graphistry/js-upload-api';

const CLIENT_SUBSCRIPTION_API_VERSION = 1;

//FIXME not generating jsdoc
/**
 * Class wrapping @graphistry/js-upload-api::Client for client->server File and Dataset uploads.
 * @global
 * @extends ClientBase
 */
export class Client extends ClientBase {
    /**
     * Create a Client
     * @constructor
     * @param {string} username - Graphistry server username
     * @param {string} password - Graphistry server password
     * @param {string} [org] - Organization to use (optional)
     * @param {string} [protocol='https'] - 'http' or 'https' for client->server upload communication
     * @param {string} [host='hub.graphistry.com'] - Graphistry server hostname
     * @param {clientProtocolHostname} clientProtocolHostname - 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
     * 
     * @example **Authenticate against Graphistry Hub**
     * ```javascript
     * import { Client } from '@graphistry/client-api';
     * const client = new Client('my_username', 'my_password');
     * ```
    */
    constructor(
        username: string, password: string, org?: string,
        protocol = 'https', host = 'hub.graphistry.com',
        clientProtocolHostname?: string,
        version: string = VERSION
    ) {
        // console.debug('new client', { username }, { password }, { protocol }, { host }, { clientProtocolHostname }, { version });
        super(
            username, password, org,
            protocol, host, clientProtocolHostname,
            fetch,
            version,
            '@graphistry/node-api');
    }
}

/**
 * Class wrapping @graphistry/js-upload-api::ClientPKey for client->server File and Dataset uploads using personal key authentication.
 * @global
 * @extends ClientPKeyBase
 */
export class ClientPKey extends ClientPKeyBase {
    /**
     * Create a Client
     * @constructor
     * @param {string} personalKeyId - Graphistry server personal key ID
     * @param {string} personalKeySecret - Graphistry server personal key secret
     * @param {string} org - Graphistry organization (optional)
     * @param {string} [protocol='https'] - 'http' or 'https' for client->server upload communication
     * @param {string} [host='hub.graphistry.com'] - Graphistry server hostname
     * @param {clientProtocolHostname} clientProtocolHostname - 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
     * 
     * @example **Authenticate against Graphistry Hub**
     * ```javascript
     * import { Client } from '@graphistry/client-api';
     * const client = new Client('my_personal_key_id', 'my_personal_key_secret');
     * ```
    */
    constructor(
        personalKeyId: string, personalKeySecret: string, org?: string,
        protocol = 'https', host = 'hub.graphistry.com',
        clientProtocolHostname?: string,
        version: string = VERSION
    ) {
        // console.debug('new client', { personalKeyId }, { personalKeySecret }, { protocol }, { host }, { clientProtocolHostname }, { version });
        super(
            personalKeyId, personalKeySecret, org,
            protocol, host, clientProtocolHostname,
            fetch,
            version,
            '@graphistry/node-api');
    }
}