parse
Version:
Parse JavaScript SDK
683 lines (669 loc) • 25 kB
JavaScript
"use strict";
var _Object$keys2 = require("@babel/runtime-corejs3/core-js-stable/object/keys");
var _Object$getOwnPropertySymbols = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-symbols");
var _filterInstanceProperty = require("@babel/runtime-corejs3/core-js-stable/instance/filter");
var _Object$getOwnPropertyDescriptor = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptor");
var _forEachInstanceProperty2 = require("@babel/runtime-corejs3/core-js-stable/instance/for-each");
var _Object$getOwnPropertyDescriptors = require("@babel/runtime-corejs3/core-js-stable/object/get-own-property-descriptors");
var _Object$defineProperties = require("@babel/runtime-corejs3/core-js-stable/object/define-properties");
var _Object$defineProperty = require("@babel/runtime-corejs3/core-js-stable/object/define-property");
var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
_Object$defineProperty(exports, "__esModule", {
value: true
});
exports.b64Digit = b64Digit;
exports.default = void 0;
var _isArray = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/is-array"));
var _slice = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/slice"));
var _keys = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/object/keys"));
var _forEach = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/for-each"));
var _promise = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/promise"));
var _defineProperty2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/defineProperty"));
var _CoreManager = _interopRequireDefault(require("./CoreManager"));
var _ParseError = _interopRequireDefault(require("./ParseError"));
function ownKeys(e, r) {
var t = _Object$keys2(e);
if (_Object$getOwnPropertySymbols) {
var o = _Object$getOwnPropertySymbols(e);
r && (o = _filterInstanceProperty(o).call(o, function (r) {
return _Object$getOwnPropertyDescriptor(e, r).enumerable;
})), t.push.apply(t, o);
}
return t;
}
function _objectSpread(e) {
for (var r = 1; r < arguments.length; r++) {
var _context6, _context7;
var t = null != arguments[r] ? arguments[r] : {};
r % 2 ? _forEachInstanceProperty2(_context6 = ownKeys(Object(t), !0)).call(_context6, function (r) {
(0, _defineProperty2.default)(e, r, t[r]);
}) : _Object$getOwnPropertyDescriptors ? _Object$defineProperties(e, _Object$getOwnPropertyDescriptors(t)) : _forEachInstanceProperty2(_context7 = ownKeys(Object(t))).call(_context7, function (r) {
_Object$defineProperty(e, r, _Object$getOwnPropertyDescriptor(t, r));
});
}
return e;
} /* global Blob */
let NodeReadable;
function b64Digit(number) {
if (number < 26) {
return String.fromCharCode(65 + number);
}
if (number < 52) {
return String.fromCharCode(97 + (number - 26));
}
if (number < 62) {
return String.fromCharCode(48 + (number - 52));
}
if (number === 62) {
return '+';
}
if (number === 63) {
return '/';
}
throw new TypeError('Tried to encode large digit ' + number + ' in base64.');
}
/**
* A Parse.File is a local representation of a file that is saved to the Parse
* cloud.
*
* @alias Parse.File
*/
class ParseFile {
/**
* @param name {String} The file's name. This will be prefixed by a unique
* value once the file has finished saving. The file name must begin with
* an alphanumeric character, and consist of alphanumeric characters,
* periods, spaces, underscores, or dashes.
* @param data {Array} The data for the file, as either:
* 1. an Array of byte value Numbers or Uint8Array.
* 2. an Object like { base64: "..." } with a base64-encoded String.
* 3. an Object like { uri: "..." } with a uri String.
* 4. a File object selected with a file upload control.
* 5. (Node.js only) a Buffer. Uploaded as raw binary data instead of
* base64-encoding, reducing memory usage. Falls back to base64
* JSON encoding if metadata or tags are set.
* 6. (Node.js only) a Readable stream, or a Web ReadableStream.
* Streamed as raw binary data directly into the upload request.
* Throws if metadata or tags are set.
* For example:
* <pre>
* var fileUploadControl = $("#profilePhotoFileUpload")[0];
* if (fileUploadControl.files.length > 0) {
* var file = fileUploadControl.files[0];
* var name = "photo.jpg";
* var parseFile = new Parse.File(name, file);
* parseFile.save().then(function() {
* // The file has been saved to Parse.
* }, function(error) {
* // The file either could not be read, or could not be saved to Parse.
* });
* }</pre>
* @param type {String} Optional Content-Type header to use for the file. If
* this is omitted, the content type will be inferred from the name's
* extension.
* @param metadata {object} Optional key value pairs to be stored with file object
* @param tags {object} Optional key value pairs to be stored with file object
*/
constructor(name, data, type, metadata, tags) {
(0, _defineProperty2.default)(this, "_name", void 0);
(0, _defineProperty2.default)(this, "_url", void 0);
(0, _defineProperty2.default)(this, "_source", void 0);
(0, _defineProperty2.default)(this, "_previousSave", void 0);
(0, _defineProperty2.default)(this, "_data", void 0);
(0, _defineProperty2.default)(this, "_requestTask", void 0);
(0, _defineProperty2.default)(this, "_metadata", void 0);
(0, _defineProperty2.default)(this, "_tags", void 0);
const specifiedType = type || '';
this._name = name;
this._metadata = metadata || {};
this._tags = tags || {};
if (data !== undefined) {
if (typeof Buffer !== 'undefined' && Buffer.isBuffer(data)) {
this._source = {
format: 'buffer',
buffer: data,
type: specifiedType
};
} else if (data !== null && typeof data === 'object' && typeof data.pipe === 'function' && typeof data.read === 'function') {
this._source = {
format: 'stream',
stream: data,
type: specifiedType
};
} else if (typeof ReadableStream !== 'undefined' && data instanceof ReadableStream) {
this._source = {
format: 'stream',
stream: data,
type: specifiedType
};
} else if ((0, _isArray.default)(data) || data instanceof Uint8Array) {
this._data = ParseFile.encodeBase64(data);
this._source = {
format: 'base64',
base64: this._data,
type: specifiedType
};
} else if (typeof Blob !== 'undefined' && data instanceof Blob) {
this._source = {
format: 'file',
file: data,
type: specifiedType
};
} else if (data && typeof data.uri === 'string' && data.uri !== undefined) {
this._source = {
format: 'uri',
uri: data.uri,
type: specifiedType
};
} else if (data && typeof data.base64 === 'string') {
var _context, _context2, _context3;
const base64 = (0, _slice.default)(_context = data.base64.split(',')).call(_context, -1)[0];
const dataType = specifiedType || (0, _slice.default)(_context2 = (0, _slice.default)(_context3 = data.base64.split(';')).call(_context3, 0, 1)[0].split(':')).call(_context2, 1, 2)[0] || 'text/plain';
this._data = base64;
this._source = {
format: 'base64',
base64,
type: dataType
};
} else {
throw new TypeError('Cannot create a Parse.File with that data.');
}
}
}
/**
* Return the data for the file, downloading it if not already present.
* Data is present if initialized with Byte Array, Base64 or Saved with Uri.
* Data is cleared if saved with File object selected with a file upload control
*
* @param {object} options
* @param {function} [options.progress] callback for download progress
* <pre>
* const parseFile = new Parse.File(name, file);
* parseFile.getData({
* progress: (progressValue, loaded, total) => {
* if (progressValue !== null) {
* // Update the UI using progressValue
* }
* }
* });
* </pre>
* @returns {Promise} Promise that is resolve with base64 data
*/
async getData(options) {
var _this$_source;
options = options || {};
if (this._data) {
return this._data;
}
if (((_this$_source = this._source) === null || _this$_source === void 0 ? void 0 : _this$_source.format) === 'buffer') {
this._data = this._source.buffer.toString('base64');
return this._data;
}
if (!this._url) {
throw new Error('Cannot retrieve data for unsaved ParseFile.');
}
options.requestTask = task => this._requestTask = task;
const controller = _CoreManager.default.getFileController();
const result = await controller.download(this._url, options);
this._data = result.base64;
return this._data;
}
/**
* Gets the name of the file. Before save is called, this is the filename
* given by the user. After save is called, that name gets prefixed with a
* unique identifier.
*
* @returns {string}
*/
name() {
return this._name;
}
/**
* Gets the url of the file. It is only available after you save the file or
* after you get the file from a Parse.Object.
*
* @param {object} options An object to specify url options
* @param {boolean} [options.forceSecure] force the url to be secure
* @returns {string | undefined}
*/
url(options) {
options = options || {};
if (!this._url) {
return;
}
if (options.forceSecure) {
return this._url.replace(/^http:\/\//i, 'https://');
} else {
return this._url;
}
}
/**
* Gets the metadata of the file.
*
* @returns {object}
*/
metadata() {
return this._metadata;
}
/**
* Gets the tags of the file.
*
* @returns {object}
*/
tags() {
return this._tags;
}
/**
* Saves the file to the Parse cloud.
*
* In Node.js, files created with Buffer or ReadableStream are uploaded as
* raw binary data, avoiding base64 encoding overhead. If metadata
* or tags are set on a Buffer-backed file, the upload falls back to base64
* JSON encoding (since the binary endpoint does not support metadata).
* Stream-backed files with metadata or tags will throw an error.
*
* @param {object} options
* Valid options are:<ul>
* <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
* be used for this request.
* <li>sessionToken: A valid session token, used for making a request on
* behalf of a specific user.
* <li>progress: callback for upload progress. For example:
* <pre>
* let parseFile = new Parse.File(name, file);
* parseFile.save({
* progress: (progressValue, loaded, total) => {
* if (progressValue !== null) {
* // Update the UI using progressValue
* }
* }
* });
* </pre>
* </ul>
* @returns {Promise | undefined} Promise that is resolved when the save finishes.
*/
save(options) {
options = options || {};
options.requestTask = task => this._requestTask = task;
options.metadata = this._metadata;
options.tags = this._tags;
const controller = _CoreManager.default.getFileController();
if (!this._previousSave) {
if (this._source.format === 'buffer' || this._source.format === 'stream') {
const hasMetadataOrTags = this._metadata && (0, _keys.default)(this._metadata).length > 0 || this._tags && (0, _keys.default)(this._tags).length > 0;
if (this._source.format === 'stream' && hasMetadataOrTags) {
throw new Error('Cannot save a stream-based file with metadata or tags. Use a Buffer instead.');
}
if (this._source.format === 'stream' && !controller.saveBinary) {
throw new Error('Cannot save a stream-based file without saveBinary support on the FileController.');
}
if (!hasMetadataOrTags && controller.saveBinary) {
// Binary upload via ajax
this._previousSave = controller.saveBinary(this._name, this._source, options).then(res => {
this._name = res.name;
this._url = res.url;
this._data = null;
this._requestTask = null;
return this;
});
} else if (this._source.format === 'buffer') {
// Buffer: fall back to base64 JSON encoding (metadata/tags or no saveBinary)
const base64Source = {
format: 'base64',
base64: this._source.buffer.toString('base64'),
type: this._source.type
};
this._previousSave = controller.saveBase64(this._name, base64Source, options).then(res => {
this._name = res.name;
this._url = res.url;
this._requestTask = null;
return this;
});
}
} else if (this._source.format === 'file') {
this._previousSave = controller.saveFile(this._name, this._source, options).then(res => {
this._name = res.name;
this._url = res.url;
this._data = null;
this._requestTask = null;
return this;
});
} else if (this._source.format === 'uri') {
this._previousSave = controller.download(this._source.uri, options).then(result => {
if (!(result && result.base64)) {
return {};
}
const newSource = {
format: 'base64',
base64: result.base64,
type: result.contentType
};
this._data = result.base64;
this._requestTask = null;
return controller.saveBase64(this._name, newSource, options);
}).then(res => {
this._name = res.name;
this._url = res.url;
this._requestTask = null;
return this;
});
} else {
this._previousSave = controller.saveBase64(this._name, this._source, options).then(res => {
this._name = res.name;
this._url = res.url;
this._requestTask = null;
return this;
});
}
}
if (this._previousSave) {
return this._previousSave;
}
}
/**
* Aborts the request if it has already been sent.
*/
cancel() {
if (this._requestTask && typeof this._requestTask.abort === 'function') {
this._requestTask._aborted = true;
this._requestTask.abort();
}
this._requestTask = null;
}
/**
* Deletes the file from the Parse cloud.
* In Cloud Code and Node only with Master Key.
*
* @param {object} options
* Valid options are:<ul>
* <li>useMasterKey: In Cloud Code and Node only, causes the Master Key to
* be used for this request.
* <pre>
* @returns {Promise} Promise that is resolved when the delete finishes.
*/
destroy() {
let options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};
if (!this._name) {
throw new _ParseError.default(_ParseError.default.FILE_DELETE_UNNAMED_ERROR, 'Cannot delete an unnamed file.');
}
const destroyOptions = {
useMasterKey: true
};
if (Object.hasOwn(options, 'useMasterKey')) {
destroyOptions.useMasterKey = !!options.useMasterKey;
}
const controller = _CoreManager.default.getFileController();
return controller.deleteFile(this._name, destroyOptions).then(() => {
this._data = undefined;
this._requestTask = null;
return this;
});
}
toJSON() {
return {
__type: 'File',
name: this._name,
url: this._url
};
}
equals(other) {
if (this === other) {
return true;
}
// Unsaved Files are never equal, since they will be saved to different URLs
return other instanceof ParseFile && this.name() === other.name() && this.url() === other.url() && typeof this.url() !== 'undefined';
}
/**
* Sets metadata to be saved with file object. Overwrites existing metadata
*
* @param {object} metadata Key value pairs to be stored with file object
*/
setMetadata(metadata) {
if (metadata && typeof metadata === 'object') {
var _context4;
(0, _forEach.default)(_context4 = (0, _keys.default)(metadata)).call(_context4, key => {
this.addMetadata(key, metadata[key]);
});
}
}
/**
* Sets metadata to be saved with file object. Adds to existing metadata.
*
* @param {string} key key to store the metadata
* @param {*} value metadata
*/
addMetadata(key, value) {
if (typeof key === 'string') {
this._metadata[key] = value;
}
}
/**
* Sets tags to be saved with file object. Overwrites existing tags
*
* @param {object} tags Key value pairs to be stored with file object
*/
setTags(tags) {
if (tags && typeof tags === 'object') {
var _context5;
(0, _forEach.default)(_context5 = (0, _keys.default)(tags)).call(_context5, key => {
this.addTag(key, tags[key]);
});
}
}
/**
* Sets tags to be saved with file object. Adds to existing tags.
*
* @param {string} key key to store tags
* @param {*} value tag
*/
addTag(key, value) {
if (typeof key === 'string') {
this._tags[key] = value;
}
}
static fromJSON(obj) {
if (obj.__type !== 'File') {
throw new TypeError('JSON object does not represent a ParseFile');
}
const file = new ParseFile(obj.name);
file._url = obj.url;
return file;
}
static encodeBase64(bytes) {
const chunks = [];
chunks.length = Math.ceil(bytes.length / 3);
for (let i = 0; i < chunks.length; i++) {
const b1 = bytes[i * 3];
const b2 = bytes[i * 3 + 1] || 0;
const b3 = bytes[i * 3 + 2] || 0;
const has2 = i * 3 + 1 < bytes.length;
const has3 = i * 3 + 2 < bytes.length;
chunks[i] = [b64Digit(b1 >> 2 & 0x3f), b64Digit(b1 << 4 & 0x30 | b2 >> 4 & 0x0f), has2 ? b64Digit(b2 << 2 & 0x3c | b3 >> 6 & 0x03) : '=', has3 ? b64Digit(b3 & 0x3f) : '='].join('');
}
return chunks.join('');
}
}
const DefaultController = {
saveFile: async function (name, source, options) {
if (source.format !== 'file') {
throw new Error('saveFile can only be used with File-type sources.');
}
const base64Data = await new _promise.default((res, rej) => {
const reader = new FileReader();
reader.onload = () => res(reader.result);
reader.onerror = error => rej(error);
reader.readAsDataURL(source.file);
});
// we only want the data after the comma
// For example: "data:application/pdf;base64,JVBERi0xLjQKJ..." we would only want "JVBERi0xLjQKJ..."
const [first, second] = base64Data.split(',');
// in the event there is no 'data:application/pdf;base64,' at the beginning of the base64 string
// use the entire string instead
const data = second ? second : first;
const newSource = {
format: 'base64',
base64: data,
type: source.type || (source.file ? source.file.type : undefined)
};
return await DefaultController.saveBase64(name, newSource, options);
},
saveBase64: function (name, source) {
let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
if (source.format !== 'base64') {
throw new Error('saveBase64 can only be used with Base64-type sources.');
}
const data = {
base64: source.base64,
fileData: {
metadata: _objectSpread({}, options.metadata),
tags: _objectSpread({}, options.tags)
}
};
delete options.metadata;
delete options.tags;
if (source.type) {
data._ContentType = source.type;
}
return _CoreManager.default.getRESTController().request('POST', 'files/' + name, data, options);
},
saveBinary: async function (name, source) {
let options = arguments.length > 2 && arguments[2] !== undefined ? arguments[2] : {};
if (source.format !== 'buffer' && source.format !== 'stream') {
throw new Error('saveBinary can only be used with Buffer or Stream sources.');
}
const headers = {
'X-Parse-Application-ID': _CoreManager.default.get('APPLICATION_ID'),
'X-Parse-Upload-Mode': 'stream'
};
headers['Content-Type'] = (source.type || 'application/octet-stream').replace(/[\r\n]/g, '');
const jsKey = _CoreManager.default.get('JAVASCRIPT_KEY');
if (jsKey) {
headers['X-Parse-JavaScript-Key'] = jsKey;
}
let useMasterKey = options.useMasterKey;
if (typeof useMasterKey === 'undefined') {
useMasterKey = _CoreManager.default.get('USE_MASTER_KEY');
}
if (useMasterKey) {
if (_CoreManager.default.get('MASTER_KEY')) {
delete headers['X-Parse-JavaScript-Key'];
headers['X-Parse-Master-Key'] = _CoreManager.default.get('MASTER_KEY');
} else {
throw new Error('Cannot use the Master Key, it has not been provided.');
}
}
if (options.sessionToken) {
headers['X-Parse-Session-Token'] = options.sessionToken;
} else {
const userController = _CoreManager.default.getUserController();
if (userController) {
const user = await userController.currentUserAsync();
if (user) {
const token = user.getSessionToken();
if (token) {
headers['X-Parse-Session-Token'] = token;
}
}
}
}
let body;
if (source.format === 'buffer') {
body = source.buffer;
} else if (source.format === 'stream') {
const stream = source.stream;
if (typeof stream.pipe === 'function' && typeof stream.read === 'function') {
body = NodeReadable.toWeb(stream);
} else {
body = stream;
}
}
let url = _CoreManager.default.get('SERVER_URL');
if (url[url.length - 1] !== '/') {
url += '/';
}
url += 'files/' + encodeURIComponent(name);
return _CoreManager.default.getRESTController().ajax('POST', url, body, headers, options).then(_ref => {
let {
response
} = _ref;
return response;
});
},
download: async function (uri, options) {
const controller = new AbortController();
options.requestTask(controller);
const {
signal
} = controller;
try {
const response = await fetch(uri, {
signal
});
const reader = response.body.getReader();
const length = +response.headers.get('Content-Length') || 0;
const contentType = response.headers.get('Content-Type');
if (length === 0) {
var _options$progress;
(_options$progress = options.progress) === null || _options$progress === void 0 || _options$progress.call(options, null, null, null);
return {
base64: '',
contentType
};
}
let recieved = 0;
const chunks = [];
while (true) {
var _options$progress2;
const {
done,
value
} = await reader.read();
if (done) {
break;
}
chunks.push(value);
recieved += (value === null || value === void 0 ? void 0 : value.length) || 0;
(_options$progress2 = options.progress) === null || _options$progress2 === void 0 || _options$progress2.call(options, recieved / length, recieved, length);
}
const body = new Uint8Array(recieved);
let offset = 0;
for (const chunk of chunks) {
body.set(chunk, offset);
offset += chunk.length;
}
return {
base64: ParseFile.encodeBase64(body),
contentType
};
} catch (error) {
if (error.name === 'AbortError') {
return {};
} else {
throw error;
}
}
},
deleteFile: function (name, options) {
const headers = {
'X-Parse-Application-ID': _CoreManager.default.get('APPLICATION_ID')
};
if (options.useMasterKey) {
headers['X-Parse-Master-Key'] = _CoreManager.default.get('MASTER_KEY');
}
let url = _CoreManager.default.get('SERVER_URL');
if (url[url.length - 1] !== '/') {
url += '/';
}
url += 'files/' + name;
return _CoreManager.default.getRESTController().ajax('DELETE', url, '', headers).catch(response => {
// TODO: return JSON object in server
if (!response || response.toString() === 'SyntaxError: Unexpected end of JSON input') {
return _promise.default.resolve();
} else {
return _CoreManager.default.getRESTController().handleError(response);
}
});
}
};
_CoreManager.default.setFileController(DefaultController);
var _default = exports.default = ParseFile;