@graphistry/js-upload-api
Version:
Graphistry upload client for reuse by node and browser clients
169 lines • 9.74 kB
JavaScript
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 };
}
};
var friendlyActionToRaw = {
'view': '10',
'edit': '20',
'share': '30'
};
/**
* # Privacy examples
*
* {@link Privacy} is used to set the privacy mode of an item. By default, items are public,
* meaning world-readable but not listed in any public Graphistry catalogs.
*
* Setting the privacy, by default, makes it private to the user. No notifications are made.
*
* Various options allow sharing with the organization, sharing with specific users,
* and sending notifications. When sharing with others, view or edit permissions may be given.
*
* See all convenience method {@link Dataset.privacy}
*
* <br>
*
* ---
*
* <br>
*
* @example **Set a dataset to private**
* ```javascript
* import { Privacy } from '@graphistry/node-api';
* await (new Privacy('myDatasetID')).upload(client);
* ```
*
* <br>
*
* @example **Set a dataset to public**
* ```javascript
* import { Privacy } from '@graphistry/node-api';
* await (new Privacy('myDatasetID', 'public')).upload(client);
* ```
*
* <br>
*
* @example **Set a dataset to private, and share it with one user with a notification**
* ```javascript
* import { Privacy } from '@graphistry/node-api';
* await (new Privacy(
* 'myDatasetID', undefined, undefined, undefined,
* ['friend@company.com'], true, "Check out my great viz!"
* )).upload(client);
* ```
*
*/
var Privacy = /** @class */ (function () {
/**
*
* See examples at top of file
*
* Create sharing configuration in preperation for uploading.
*
* @param id The id of the item to set privacy on
* @param kind The kind of item to set privacy on, defaults to 'dataset'
* @param mode The privacy mode, 'private', 'public', or 'organization'
* @param modeAction The action to allow, 'view', 'edit', or 'share'
* @param invitedUsers The list of Graphistry user emails to share with
* @param notify Whether to send notifications to the invited users
* @param message The message to send to the invited users
**/
function Privacy(id, kind, mode, modeAction, invitedUsers, notify, message) {
if (kind === void 0) { kind = 'dataset'; }
if (mode === void 0) { mode = 'private'; }
if (invitedUsers === void 0) { invitedUsers = []; }
if (notify === void 0) { notify = false; }
if (message === void 0) { message = ''; }
this.id = id;
this.kind = kind;
this.mode = mode;
this.modeAction =
modeAction ? friendlyActionToRaw[modeAction]
: this.mode === 'private' ? friendlyActionToRaw['edit']
: friendlyActionToRaw['view'];
this.invitedUsers = invitedUsers;
this.notify = notify;
this.message = message;
}
/**
*
* See examples at top of file
*
* Upload the privacy configuration to the server for an item
*
* @param client The client to use to upload the privacy
* @returns The privacy object
* @throws Error if the client is not configured
* @throws Error if the upload fails
*
*/
Privacy.prototype.upload = function (client) {
return __awaiter(this, void 0, void 0, function () {
var opts, resp;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!client) {
throw new Error('No client provided');
}
if (!client.authTokenValid() && !client.isServerConfigured()) {
throw new Error('Client is not configured, set token or creds');
}
opts = {
obj_pk: this.id,
obj_type: this.kind,
mode: this.mode,
notify: this.notify,
invited_users: this.invitedUsers,
mode_action: this.modeAction,
message: this.message
};
console.debug('Privacy.upload', opts, this);
return [4 /*yield*/, client.post('api/v2/share/link/', opts)];
case 1:
resp = _a.sent();
if (resp.status != 'OK') {
console.error("Privacy.upload error: ".concat(resp.message));
throw new Error('Privacy upload failed');
}
//TODO return resp.data instead?
return [2 /*return*/, this];
}
});
});
};
return Privacy;
}());
export { Privacy };
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiUHJpdmFjeS5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3NyYy9Qcml2YWN5LnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiI7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztBQXNDQSxJQUFNLG1CQUFtQixHQUEyQztJQUNoRSxNQUFNLEVBQUUsSUFBSTtJQUNaLE1BQU0sRUFBRSxJQUFJO0lBQ1osT0FBTyxFQUFFLElBQUk7Q0FDaEIsQ0FBQTtBQUVEOzs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7OztHQTRDRztBQUNIO0lBU0k7Ozs7Ozs7Ozs7Ozs7UUFhSTtJQUNKLGlCQUNJLEVBQVUsRUFDVixJQUFzQixFQUN0QixJQUFzQixFQUN0QixVQUF1QixFQUN2QixZQUEyQixFQUMzQixNQUFjLEVBQ2QsT0FBWTtRQUxaLHFCQUFBLEVBQUEsZ0JBQXNCO1FBQ3RCLHFCQUFBLEVBQUEsZ0JBQXNCO1FBRXRCLDZCQUFBLEVBQUEsaUJBQTJCO1FBQzNCLHVCQUFBLEVBQUEsY0FBYztRQUNkLHdCQUFBLEVBQUEsWUFBWTtRQUVaLElBQUksQ0FBQyxFQUFFLEdBQUcsRUFBRSxDQUFDO1FBQ2IsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7UUFDakIsSUFBSSxDQUFDLElBQUksR0FBRyxJQUFJLENBQUM7UUFDakIsSUFBSSxDQUFDLFVBQVU7WUFDWCxVQUFVLENBQUMsQ0FBQyxDQUFDLG1CQUFtQixDQUFDLFVBQVUsQ0FBQztnQkFDNUMsQ0FBQyxDQUFDLElBQUksQ0FBQyxJQUFJLEtBQUssU0FBUyxDQUFDLENBQUMsQ0FBQyxtQkFBbUIsQ0FBQyxNQUFNLENBQUM7b0JBQ3ZELENBQUMsQ0FBQyxtQkFBbUIsQ0FBQyxNQUFNLENBQUMsQ0FDaEM7UUFDRCxJQUFJLENBQUMsWUFBWSxHQUFHLFlBQVksQ0FBQztRQUNqQyxJQUFJLENBQUMsTUFBTSxHQUFHLE1BQU0sQ0FBQztRQUNyQixJQUFJLENBQUMsT0FBTyxHQUFHLE9BQU8sQ0FBQztJQUMzQixDQUFDO0lBRUQ7Ozs7Ozs7Ozs7O09BV0c7SUFDVSx3QkFBTSxHQUFuQixVQUFvQixNQUFrQjs7Ozs7O3dCQUVsQyxJQUFJLENBQUMsTUFBTSxFQUFFOzRCQUNULE1BQU0sSUFBSSxLQUFLLENBQUMsb0JBQW9CLENBQUMsQ0FBQzt5QkFDekM7d0JBQ0QsSUFBSSxDQUFDLE1BQU0sQ0FBQyxjQUFjLEVBQUUsSUFBSSxDQUFDLE1BQU0sQ0FBQyxrQkFBa0IsRUFBRSxFQUFFOzRCQUMxRCxNQUFNLElBQUksS0FBSyxDQUFDLDhDQUE4QyxDQUFDLENBQUM7eUJBQ25FO3dCQUVLLElBQUksR0FBRzs0QkFDVCxNQUFNLEVBQUUsSUFBSSxDQUFDLEVBQUU7NEJBQ2YsUUFBUSxFQUFFLElBQUksQ0FBQyxJQUFJOzRCQUNuQixJQUFJLEVBQUUsSUFBSSxDQUFDLElBQUk7NEJBQ2YsTUFBTSxFQUFFLElBQUksQ0FBQyxNQUFNOzRCQUNuQixhQUFhLEVBQUUsSUFBSSxDQUFDLFlBQVk7NEJBQ2hDLFdBQVcsRUFBRSxJQUFJLENBQUMsVUFBVTs0QkFDNUIsT0FBTyxFQUFFLElBQUksQ0FBQyxPQUFPO3lCQUN4QixDQUFDO3dCQUVGLE9BQU8sQ0FBQyxLQUFLLENBQUMsZ0JBQWdCLEVBQUUsSUFBSSxFQUFFLElBQUksQ0FBQyxDQUFDO3dCQUcvQixxQkFBTSxNQUFNLENBQUMsSUFBSSxDQUFDLG9CQUFvQixFQUFFLElBQUksQ0FBQyxFQUFBOzt3QkFBcEQsSUFBSSxHQUFHLFNBQTZDO3dCQUUxRCxJQUFJLElBQUksQ0FBQyxNQUFNLElBQUksSUFBSSxFQUFFOzRCQUNyQixPQUFPLENBQUMsS0FBSyxDQUFDLGdDQUF5QixJQUFJLENBQUMsT0FBTyxDQUFFLENBQUMsQ0FBQzs0QkFDdkQsTUFBTSxJQUFJLEtBQUssQ0FBQyx1QkFBdUIsQ0FBQyxDQUFDO3lCQUM1Qzt3QkFFRCxnQ0FBZ0M7d0JBRWhDLHNCQUFPLElBQUksRUFBQzs7OztLQUNmO0lBQ0wsY0FBQztBQUFELENBQUMsQUExRkQsSUEwRkMifQ==