123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602 |
- "use strict";
- Object.defineProperty(exports, "__esModule", {
- value: true
- });
- exports.default = void 0;
- var _CoreManager = _interopRequireDefault(require("./CoreManager"));
- function _interopRequireDefault(obj) {
- return obj && obj.__esModule ? obj : {
- default: obj
- };
- }
- /**
- * Copyright (c) 2015-present, Parse, LLC.
- * All rights reserved.
- *
- * This source code is licensed under the BSD-style license found in the
- * LICENSE file in the root directory of this source tree. An additional grant
- * of patent rights can be found in the PATENTS file in the same directory.
- *
- * @flow
- */
- const FIELD_TYPES = ['String', 'Number', 'Boolean', 'Date', 'File', 'GeoPoint', 'Polygon', 'Array', 'Object', 'Pointer', 'Relation'];
- /**
- * A Parse.Schema object is for handling schema data from Parse.
- * <p>All the schemas methods require MasterKey.
- *
- * <pre>
- * const schema = new Parse.Schema('MyClass');
- * schema.addString('field');
- * schema.addIndex('index_name', {'field', 1});
- * schema.save();
- * </pre>
- * </p>
- * @alias Parse.Schema
- */
- class ParseSchema {
- /*:: className: string;*/
- /*:: _fields: { [key: string]: mixed };*/
- /*:: _indexes: { [key: string]: mixed };*/
- /**
- * @param {String} className Parse Class string.
- */
- constructor(className
- /*: string*/
- ) {
- if (typeof className === 'string') {
- if (className === 'User' && _CoreManager.default.get('PERFORM_USER_REWRITE')) {
- this.className = '_User';
- } else {
- this.className = className;
- }
- }
- this._fields = {};
- this._indexes = {};
- }
- /**
- * Static method to get all schemas
- *
- * @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.
- * </ul>
- *
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- static all(options
- /*: FullOptions*/
- ) {
- options = options || {};
- const controller = _CoreManager.default.getSchemaController();
- return controller.get('', options).then(response => {
- if (response.results.length === 0) {
- throw new Error('Schema not found.');
- }
- return response.results;
- });
- }
- /**
- * Get the Schema from Parse
- *
- * @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.
- * </ul>
- *
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- get(options
- /*: FullOptions*/
- ) {
- this.assertClassName();
- options = options || {};
- const controller = _CoreManager.default.getSchemaController();
- return controller.get(this.className, options).then(response => {
- if (!response) {
- throw new Error('Schema not found.');
- }
- return response;
- });
- }
- /**
- * Create a new Schema on Parse
- *
- * @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.
- * </ul>
- *
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- save(options
- /*: FullOptions*/
- ) {
- this.assertClassName();
- options = options || {};
- const controller = _CoreManager.default.getSchemaController();
- const params = {
- className: this.className,
- fields: this._fields,
- indexes: this._indexes
- };
- return controller.create(this.className, params, options).then(response => {
- return response;
- });
- }
- /**
- * Update a Schema on Parse
- *
- * @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.
- * </ul>
- *
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- update(options
- /*: FullOptions*/
- ) {
- this.assertClassName();
- options = options || {};
- const controller = _CoreManager.default.getSchemaController();
- const params = {
- className: this.className,
- fields: this._fields,
- indexes: this._indexes
- };
- this._fields = {};
- this._indexes = {};
- return controller.update(this.className, params, options).then(response => {
- return response;
- });
- }
- /**
- * Removing a Schema from Parse
- * Can only be used on Schema without objects
- *
- * @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.
- * </ul>
- *
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- delete(options
- /*: FullOptions*/
- ) {
- this.assertClassName();
- options = options || {};
- const controller = _CoreManager.default.getSchemaController();
- return controller.delete(this.className, options).then(response => {
- return response;
- });
- }
- /**
- * Removes all objects from a Schema (class) in Parse.
- * EXERCISE CAUTION, running this will delete all objects for this schema and cannot be reversed
- * @return {Promise} A promise that is resolved with the result when
- * the query completes.
- */
- purge() {
- this.assertClassName();
- const controller = _CoreManager.default.getSchemaController();
- return controller.purge(this.className).then(response => {
- return response;
- });
- }
- /**
- * Assert if ClassName has been filled
- * @private
- */
- assertClassName() {
- if (!this.className) {
- throw new Error('You must set a Class Name before making any request.');
- }
- }
- /**
- * Adding a Field to Create / Update a Schema
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} type TheCan be a (String|Number|Boolean|Date|Parse.File|Parse.GeoPoint|Array|Object|Pointer|Parse.Relation)
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addField(name
- /*: string*/
- , type
- /*: string*/
- ) {
- type = type || 'String';
- if (!name) {
- throw new Error('field name may not be null.');
- }
- if (FIELD_TYPES.indexOf(type) === -1) {
- throw new Error(`${type} is not a valid type.`);
- }
- this._fields[name] = {
- type
- };
- return this;
- }
- /**
- * Adding an Index to Create / Update a Schema
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} type Can be a (String|Number|Boolean|Date|Parse.File|Parse.GeoPoint|Array|Object|Pointer|Parse.Relation)
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addIndex(name
- /*: string*/
- , index
- /*: any*/
- ) {
- if (!name) {
- throw new Error('index name may not be null.');
- }
- if (!index) {
- throw new Error('index may not be null.');
- }
- this._indexes[name] = index;
- return this;
- }
- /**
- * Adding String Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addString(name
- /*: string*/
- ) {
- return this.addField(name, 'String');
- }
- /**
- * Adding Number Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addNumber(name
- /*: string*/
- ) {
- return this.addField(name, 'Number');
- }
- /**
- * Adding Boolean Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addBoolean(name
- /*: string*/
- ) {
- return this.addField(name, 'Boolean');
- }
- /**
- * Adding Date Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addDate(name
- /*: string*/
- ) {
- return this.addField(name, 'Date');
- }
- /**
- * Adding File Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addFile(name
- /*: string*/
- ) {
- return this.addField(name, 'File');
- }
- /**
- * Adding GeoPoint Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addGeoPoint(name
- /*: string*/
- ) {
- return this.addField(name, 'GeoPoint');
- }
- /**
- * Adding Polygon Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addPolygon(name
- /*: string*/
- ) {
- return this.addField(name, 'Polygon');
- }
- /**
- * Adding Array Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addArray(name
- /*: string*/
- ) {
- return this.addField(name, 'Array');
- }
- /**
- * Adding Object Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addObject(name
- /*: string*/
- ) {
- return this.addField(name, 'Object');
- }
- /**
- * Adding Pointer Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} targetClass Name of the target Pointer Class
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addPointer(name
- /*: string*/
- , targetClass
- /*: string*/
- ) {
- if (!name) {
- throw new Error('field name may not be null.');
- }
- if (!targetClass) {
- throw new Error('You need to set the targetClass of the Pointer.');
- }
- this._fields[name] = {
- type: 'Pointer',
- targetClass
- };
- return this;
- }
- /**
- * Adding Relation Field
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} targetClass Name of the target Pointer Class
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- addRelation(name
- /*: string*/
- , targetClass
- /*: string*/
- ) {
- if (!name) {
- throw new Error('field name may not be null.');
- }
- if (!targetClass) {
- throw new Error('You need to set the targetClass of the Relation.');
- }
- this._fields[name] = {
- type: 'Relation',
- targetClass
- };
- return this;
- }
- /**
- * Deleting a Field to Update on a Schema
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} targetClass Name of the target Pointer Class
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- deleteField(name
- /*: string*/
- ) {
- this._fields[name] = {
- __op: 'Delete'
- };
- }
- /**
- * Deleting an Index to Update on a Schema
- *
- * @param {String} name Name of the field that will be created on Parse
- * @param {String} targetClass Name of the target Pointer Class
- * @return {Parse.Schema} Returns the schema, so you can chain this call.
- */
- deleteIndex(name
- /*: string*/
- ) {
- this._indexes[name] = {
- __op: 'Delete'
- };
- }
- }
- const DefaultController = {
- send(className
- /*: string*/
- , method
- /*: string*/
- , params
- /*: any*/
- , options
- /*: RequestOptions*/
- )
- /*: Promise*/
- {
- const RESTController = _CoreManager.default.getRESTController();
- const requestOptions = {
- useMasterKey: true
- };
- if (options.hasOwnProperty('sessionToken')) {
- requestOptions.sessionToken = options.sessionToken;
- }
- return RESTController.request(method, `schemas/${className}`, params, requestOptions);
- },
- get(className
- /*: string*/
- , options
- /*: RequestOptions*/
- )
- /*: Promise*/
- {
- return this.send(className, 'GET', {}, options);
- },
- create(className
- /*: string*/
- , params
- /*: any*/
- , options
- /*: RequestOptions*/
- )
- /*: Promise*/
- {
- return this.send(className, 'POST', params, options);
- },
- update(className
- /*: string*/
- , params
- /*: any*/
- , options
- /*: RequestOptions*/
- )
- /*: Promise*/
- {
- return this.send(className, 'PUT', params, options);
- },
- delete(className
- /*: string*/
- , options
- /*: RequestOptions*/
- )
- /*: Promise*/
- {
- return this.send(className, 'DELETE', {}, options);
- },
- purge(className
- /*: string*/
- )
- /*: Promise*/
- {
- const RESTController = _CoreManager.default.getRESTController();
- return RESTController.request('DELETE', `purge/${className}`, {}, {
- useMasterKey: true
- });
- }
- };
- _CoreManager.default.setSchemaController(DefaultController);
- var _default = ParseSchema;
- exports.default = _default;
|