@graphistry/js-upload-api
Version:
Graphistry upload client for reuse by node and browser clients
291 lines • 18.6 kB
JavaScript
"use strict";
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __assign = (this && this.__assign) || function () {
__assign = Object.assign || function(t) {
for (var s, i = 1, n = arguments.length; i < n; i++) {
s = arguments[i];
for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
t[p] = s[p];
}
return t;
};
return __assign.apply(this, arguments);
};
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.ClientPKey = void 0;
var AbstractClient_js_1 = require("./AbstractClient.js");
var AUTH_API_ENDPOINT = 'api/v2/auth/pkey/jwt/';
/**
* # Client examples
*
* Authenticate against a Graphistry server using a personal key id and secret, and manage communications with it.
*
* Different authentication modes may be desirable depending on the type of Graphistry server.
*
* <br>
*
* ---
*
* <br>
*
* @example **Authenticate against Graphistry Hub for a personal account**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client('my_personal_key_id', 'my_personal_key_secret');
* ```
*
* <br>
*
* @example **Authenticate against an org in Graphistry Hub**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client('my_personal_key_id', 'my_personal_key_secret', 'my_org');
* ```
*
* <br>
*
* @example **Authenticate against a private Graphistry server**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client('my_personal_key_id', 'my_personal_key_secret', '', 'http', 'my-ec2.aws.com:8080');
* ```
*
* <br>
*
* @example **Upload via internal IP but publish urls via a public domain**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client(
* 'my_personal_key_id', 'my_personal_key_secret', '',
* 'http', '10.20.0.1:8080',
* 'https://www.my-site.com'
* );
* ```
*
* <br>
*
* @example **Upload through the local docker network but publish urls via a public domain**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client(
* 'my_personal_key_id', 'my_personal_key_secret', '',
* 'http', 'nginx',
* 'https://www.my-site.com'
* );
* ```
*
* <br>
*
* @example **Create a client with an externally-provided JWT token**
* ```javascript
* import { Client } from '@graphistry/node-api';
* const client = new Client();
* client.setToken('Bearer 123abc');
* ```
*/
var ClientPKey = /** @class */ (function (_super) {
__extends(ClientPKey, _super);
/**
*
* See examples at top of file
*
* @param personalKeyId The personal key id to authenticate with.
* @param personalKeySecret The personal key secret to authenticate with.
* @param org The organization to use (optional)
* @param protocol The protocol to use for the server during uploads: 'http' or 'https'.
* @param host The hostname of the server during uploads: defaults to 'hub.graphistry.com'
* @param clientProtocolHostname Base path to use inside the browser and when sharing public URLs: defaults to '{protocol}://{host}'
* @param fetch The fetch implementation to use
* @param version The version of the client library
* @param agent The agent name to use when communicating with the server
*/
function ClientPKey(personalKeyId, personalKeySecret, org, protocol, host, clientProtocolHostname, fetch, version, agent) {
if (protocol === void 0) { protocol = 'https'; }
if (host === void 0) { host = 'hub.graphistry.com'; }
if (agent === void 0) { agent = '@graphistry/js-upload-api'; }
var _this = _super.call(this, org, protocol, host, clientProtocolHostname, fetch, version, agent) || this;
_this.personalKeyId = personalKeyId;
_this._personalKeySecret = personalKeySecret;
if (_this.isServerConfigured()) {
_this._getAuthTokenPromise = _this.getAuthToken();
}
return _this;
}
ClientPKey.prototype.isServerConfigured = function () {
return (this.personalKeyId || '') !== '' && (this._personalKeySecret || '') !== '' && (this.host || '') !== '';
};
ClientPKey.prototype.checkStale = function (personalKeyId, personalKeySecret, protocol, host, clientProtocolHostname) {
// personalKeyId changed
if (this.personalKeyId !== personalKeyId) {
return true;
}
// personalKeySecret changed
if (this._personalKeySecret !== personalKeySecret) {
return true;
}
// protocol changed
if (this.protocol !== protocol) {
return true;
}
// host changed
if (this.host !== host) {
return true;
}
// clientProtocolHostname changed
if (this.clientProtocolHostname !== clientProtocolHostname) {
return true;
}
return false;
};
ClientPKey.prototype.getPKeyString = function (id, secret) {
return "PersonalKey ".concat(id, ":").concat(secret);
};
/**
* Get the authentication token for the current user.
* By default, reuses current token if available.
*
* @param force If true, forces a new token to be generated; defaults to false
*
* @returns The authentication token
*
*/
ClientPKey.prototype.getAuthToken = function (force) {
if (force === void 0) { force = false; }
return __awaiter(this, void 0, void 0, function () {
var response, tok;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!force && this.authTokenValid()) {
return [2 /*return*/, this._token || '']; // workaround ts not recognizing that _token is set
}
//Throw exception if invalid personalKeyId or personalKeySecret
if (!this.isServerConfigured()) {
throw new Error('Invalid personalKeyId or personalKeySecret');
}
if (!(!force && this._getAuthTokenPromise)) return [3 /*break*/, 2];
return [4 /*yield*/, this._getAuthTokenPromise];
case 1:
// reusing outstanding auth promise
return [2 /*return*/, _a.sent()];
case 2: return [4 /*yield*/, this.postToApi(AUTH_API_ENDPOINT, __assign({}, (this.org ? { org_name: this.org } : {})), __assign({ "Authorization": this.getPKeyString(this.personalKeyId, this._personalKeySecret) }, this.getBaseHeaders()))];
case 3:
response = _a.sent();
if (!(response.status === 405)) return [3 /*break*/, 5];
if (this.org) {
console.warn('Host does not support org auth via PKey, use username/password auth instead');
}
return [4 /*yield*/, this.getToApi(AUTH_API_ENDPOINT, {
"Authorization": this.getPKeyString(this.personalKeyId, this._personalKeySecret),
})];
case 4:
response = _a.sent();
_a.label = 5;
case 5: return [4 /*yield*/, response.json()];
case 6:
response = _a.sent();
tok = response.token;
this._token = tok;
if (!this.authTokenValid()) {
console.error('auth token failure', { response: response, personalKeyId: this.personalKeyId, host: this.host });
throw new Error(__assign({ 'error': 'Auth token failure' }, (response || {})));
}
return [2 /*return*/, tok];
}
});
});
};
/**
*
* @param personalKeyId
* @param personalKeySecret
* @param org
* @param protocol
* @param host
* @returns Promise for the authentication token
*
* Helper to fetch a token for a given user
*
*/
ClientPKey.prototype.fetchToken = function (personalKeyId, personalKeySecret, org, protocol, host) {
if (protocol === void 0) { protocol = 'https'; }
if (host === void 0) { host = 'hub.graphistry.com'; }
return __awaiter(this, void 0, void 0, function () {
var response;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.postToApi(AUTH_API_ENDPOINT, __assign({}, (org ? { org_name: org } : {})), __assign({ "Authorization": this.getPKeyString(personalKeyId, personalKeySecret) }, this.getBaseHeaders()), "".concat(protocol, "://").concat(host, "/"))];
case 1:
response = _a.sent();
if (!(response.status === 405)) return [3 /*break*/, 3];
if (org) {
console.warn('Host does not support org auth via PKey, use username/password auth instead');
}
return [4 /*yield*/, this.getToApi(AUTH_API_ENDPOINT, {
"Authorization": this.getPKeyString(personalKeyId, personalKeySecret),
}, "".concat(protocol, "://").concat(host, "/"))];
case 2:
response = _a.sent();
_a.label = 3;
case 3: return [4 /*yield*/, response.json()];
case 4:
response = _a.sent();
return [2 /*return*/, response.token];
}
});
});
};
return ClientPKey;
}(AbstractClient_js_1.AbstractClient));
exports.ClientPKey = ClientPKey;
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiQ2xpZW50UEtleS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9DbGllbnRQS2V5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7O0FBQUEseURBQXFEO0FBR3JELElBQU0saUJBQWlCLEdBQUcsdUJBQXVCLENBQUM7QUFFbEQ7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FtRUc7QUFFSDtJQUFnQyw4QkFBYztJQUsxQzs7Ozs7Ozs7Ozs7OztPQWFHO0lBQ0gsb0JBQ0ksYUFBcUIsRUFBRSxpQkFBeUIsRUFBRSxHQUFZLEVBQzlELFFBQWtCLEVBQUUsSUFBMkIsRUFDL0Msc0JBQStCLEVBQy9CLEtBQVcsRUFDWCxPQUFnQixFQUNoQixLQUFtQztRQUpuQyx5QkFBQSxFQUFBLGtCQUFrQjtRQUFFLHFCQUFBLEVBQUEsMkJBQTJCO1FBSS9DLHNCQUFBLEVBQUEsbUNBQW1DO1FBTnZDLFlBUUksa0JBQU0sR0FBRyxFQUFFLFFBQVEsRUFBRSxJQUFJLEVBQUUsc0JBQXNCLEVBQUUsS0FBSyxFQUFFLE9BQU8sRUFBRSxLQUFLLENBQUMsU0FRNUU7UUFORyxLQUFJLENBQUMsYUFBYSxHQUFHLGFBQWEsQ0FBQztRQUNuQyxLQUFJLENBQUMsa0JBQWtCLEdBQUcsaUJBQWlCLENBQUM7UUFFNUMsSUFBSSxLQUFJLENBQUMsa0JBQWtCLEVBQUUsRUFBRTtZQUMzQixLQUFJLENBQUMsb0JBQW9CLEdBQUcsS0FBSSxDQUFDLFlBQVksRUFBRSxDQUFDO1NBQ25EOztJQUNMLENBQUM7SUFFTSx1Q0FBa0IsR0FBekI7UUFDSSxPQUFPLENBQUMsSUFBSSxDQUFDLGFBQWEsSUFBSSxFQUFFLENBQUMsS0FBSyxFQUFFLElBQUksQ0FBQyxJQUFJLENBQUMsa0JBQWtCLElBQUksRUFBRSxDQUFDLEtBQUssRUFBRSxJQUFJLENBQUMsSUFBSSxDQUFDLElBQUksSUFBSSxFQUFFLENBQUMsS0FBSyxFQUFFLENBQUM7SUFDbkgsQ0FBQztJQUVNLCtCQUFVLEdBQWpCLFVBQWtCLGFBQXFCLEVBQUUsaUJBQXlCLEVBQUUsUUFBZ0IsRUFBRSxJQUFZLEVBQUUsc0JBQStCO1FBQy9ILHdCQUF3QjtRQUN4QixJQUFJLElBQUksQ0FBQyxhQUFhLEtBQUssYUFBYSxFQUFFO1lBQ3RDLE9BQU8sSUFBSSxDQUFDO1NBQ2Y7UUFDRCw0QkFBNEI7UUFDNUIsSUFBSSxJQUFJLENBQUMsa0JBQWtCLEtBQUssaUJBQWlCLEVBQUU7WUFDL0MsT0FBTyxJQUFJLENBQUM7U0FDZjtRQUNELG1CQUFtQjtRQUNuQixJQUFJLElBQUksQ0FBQyxRQUFRLEtBQUssUUFBUSxFQUFFO1lBQzVCLE9BQU8sSUFBSSxDQUFDO1NBQ2Y7UUFDRCxlQUFlO1FBQ2YsSUFBSSxJQUFJLENBQUMsSUFBSSxLQUFLLElBQUksRUFBRTtZQUNwQixPQUFPLElBQUksQ0FBQztTQUNmO1FBQ0QsaUNBQWlDO1FBQ2pDLElBQUksSUFBSSxDQUFDLHNCQUFzQixLQUFLLHNCQUFzQixFQUFFO1lBQ3hELE9BQU8sSUFBSSxDQUFDO1NBQ2Y7UUFDRCxPQUFPLEtBQUssQ0FBQztJQUNqQixDQUFDO0lBRU8sa0NBQWEsR0FBckIsVUFBc0IsRUFBVSxFQUFFLE1BQWM7UUFDNUMsT0FBTyxzQkFBZSxFQUFFLGNBQUksTUFBTSxDQUFFLENBQUM7SUFDekMsQ0FBQztJQUVEOzs7Ozs7OztPQVFHO0lBQ2EsaUNBQVksR0FBNUIsVUFBNkIsS0FBYTtRQUFiLHNCQUFBLEVBQUEsYUFBYTs7Ozs7O3dCQUN0QyxJQUFJLENBQUMsS0FBSyxJQUFJLElBQUksQ0FBQyxjQUFjLEVBQUUsRUFBRTs0QkFDakMsc0JBQU8sSUFBSSxDQUFDLE1BQU0sSUFBSSxFQUFFLEVBQUMsQ0FBRSxtREFBbUQ7eUJBQ2pGO3dCQUVELCtEQUErRDt3QkFDL0QsSUFBSSxDQUFDLElBQUksQ0FBQyxrQkFBa0IsRUFBRSxFQUFFOzRCQUM1QixNQUFNLElBQUksS0FBSyxDQUFDLDRDQUE0QyxDQUFDLENBQUM7eUJBQ2pFOzZCQUVHLENBQUEsQ0FBQyxLQUFLLElBQUksSUFBSSxDQUFDLG9CQUFvQixDQUFBLEVBQW5DLHdCQUFtQzt3QkFFNUIscUJBQU0sSUFBSSxDQUFDLG9CQUFvQixFQUFBOztvQkFEdEMsbUNBQW1DO29CQUNuQyxzQkFBTyxTQUErQixFQUFDOzRCQUc1QixxQkFBTSxJQUFJLENBQUMsU0FBUyxDQUMvQixpQkFBaUIsZUFFVixDQUFDLElBQUksQ0FBQyxHQUFHLENBQUMsQ0FBQyxDQUFDLEVBQUMsUUFBUSxFQUFFLElBQUksQ0FBQyxHQUFHLEVBQUMsQ0FBQyxDQUFDLENBQUMsRUFBRSxDQUFDLGNBR3pDLGVBQWUsRUFBRSxJQUFJLENBQUMsYUFBYSxDQUFDLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxDQUFDLGtCQUFrQixDQUFDLElBQzdFLElBQUksQ0FBQyxjQUFjLEVBQUUsRUFFL0IsRUFBQTs7d0JBVEcsUUFBUSxHQUFHLFNBU2Q7NkJBRUUsQ0FBQSxRQUFRLENBQUMsTUFBTSxLQUFLLEdBQUcsQ0FBQSxFQUF2Qix3QkFBdUI7d0JBQ3RCLElBQUcsSUFBSSxDQUFDLEdBQUcsRUFBRTs0QkFDVCxPQUFPLENBQUMsSUFBSSxDQUFDLDZFQUE2RSxDQUFDLENBQUM7eUJBQy9GO3dCQUNVLHFCQUFNLElBQUksQ0FBQyxRQUFRLENBQzFCLGlCQUFpQixFQUNqQjtnQ0FDSSxlQUFlLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxJQUFJLENBQUMsYUFBYSxFQUFFLElBQUksQ0FBQyxrQkFBa0IsQ0FBQzs2QkFDbkYsQ0FDSixFQUFBOzt3QkFMRCxRQUFRLEdBQUcsU0FLVixDQUFDOzs0QkFFSyxxQkFBTSxRQUFRLENBQUMsSUFBSSxFQUFFLEVBQUE7O3dCQUFoQyxRQUFRLEdBQUcsU0FBcUIsQ0FBQzt3QkFFM0IsR0FBRyxHQUFZLFFBQVEsQ0FBQyxLQUFLLENBQUM7d0JBQ3BDLElBQUksQ0FBQyxNQUFNLEdBQUcsR0FBRyxDQUFDO3dCQUVsQixJQUFJLENBQUMsSUFBSSxDQUFDLGNBQWMsRUFBRSxFQUFFOzRCQUN4QixPQUFPLENBQUMsS0FBSyxDQUFDLG9CQUFvQixFQUFFLEVBQUMsUUFBUSxVQUFBLEVBQUUsYUFBYSxFQUFFLElBQUksQ0FBQyxhQUFhLEVBQUUsSUFBSSxFQUFFLElBQUksQ0FBQyxJQUFJLEVBQUMsQ0FBQyxDQUFDOzRCQUNwRyxNQUFNLElBQUksS0FBSyxZQUFFLE9BQU8sRUFBRSxvQkFBb0IsSUFBSyxDQUFDLFFBQVEsSUFBRSxFQUFFLENBQUMsRUFBRSxDQUFDO3lCQUN2RTt3QkFFRCxzQkFBTyxHQUFHLEVBQUM7Ozs7S0FDZDtJQUVEOzs7Ozs7Ozs7OztPQVdHO0lBQ1UsK0JBQVUsR0FBdkIsVUFDSSxhQUFxQixFQUFFLGlCQUF5QixFQUFFLEdBQVksRUFBRSxRQUFrQixFQUFFLElBQTJCO1FBQS9DLHlCQUFBLEVBQUEsa0JBQWtCO1FBQUUscUJBQUEsRUFBQSwyQkFBMkI7Ozs7OzRCQUVoRyxxQkFBTSxJQUFJLENBQUMsU0FBUyxDQUMvQixpQkFBaUIsZUFFVixDQUFDLEdBQUcsQ0FBQyxDQUFDLENBQUMsRUFBQyxRQUFRLEVBQUUsR0FBRyxFQUFDLENBQUMsQ0FBQyxDQUFDLEVBQUUsQ0FBQyxjQUcvQixlQUFlLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxhQUFhLEVBQUUsaUJBQWlCLENBQUMsSUFDbEUsSUFBSSxDQUFDLGNBQWMsRUFBRSxHQUU1QixVQUFHLFFBQVEsZ0JBQU0sSUFBSSxNQUFHLENBQzNCLEVBQUE7O3dCQVZHLFFBQVEsR0FBRyxTQVVkOzZCQUVFLENBQUEsUUFBUSxDQUFDLE1BQU0sS0FBSyxHQUFHLENBQUEsRUFBdkIsd0JBQXVCO3dCQUN0QixJQUFHLEdBQUcsRUFBRTs0QkFDSixPQUFPLENBQUMsSUFBSSxDQUFDLDZFQUE2RSxDQUFDLENBQUM7eUJBQy9GO3dCQUNVLHFCQUFNLElBQUksQ0FBQyxRQUFRLENBQzFCLGlCQUFpQixFQUNqQjtnQ0FDSSxlQUFlLEVBQUUsSUFBSSxDQUFDLGFBQWEsQ0FBQyxhQUFhLEVBQUUsaUJBQWlCLENBQUM7NkJBQ3hFLEVBQ0QsVUFBRyxRQUFRLGdCQUFNLElBQUksTUFBRyxDQUMzQixFQUFBOzt3QkFORCxRQUFRLEdBQUcsU0FNVixDQUFDOzs0QkFFSyxxQkFBTSxRQUFRLENBQUMsSUFBSSxFQUFFLEVBQUE7O3dCQUFoQyxRQUFRLEdBQUcsU0FBcUIsQ0FBQzt3QkFFakMsc0JBQU8sUUFBUSxDQUFDLEtBQUssRUFBQzs7OztLQUN6QjtJQUNMLGlCQUFDO0FBQUQsQ0FBQyxBQTNLRCxDQUFnQyxrQ0FBYyxHQTJLN0M7QUEzS1ksZ0NBQVUifQ==