Set deleted placeholder when it's added manually (#131)

* Set deleted placeholder when it's added manually

* bump

Author: Mechazawa

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mapcreator/maps4news",
-  "version": "1.6.36",
+  "version": "1.6.37",
   "description": "Maps4News JavaScript Api",
   "main": "dist/bundle.js",
   "repository": "[email protected]:MapcreatorIO/api-wrapper.git",

src/resources/Job.js

@@ -37,6 +37,7 @@ import JobResult from './JobResult';
 import JobRevision from './JobRevision';
 import RequestParameters from '../RequestParameters';
 import { encodeQueryString } from '../utils/requests';
+import { DeletedState } from '../enums';
 
 export default class Job extends CrudBase {
   /**
@@ -99,7 +100,7 @@ export default class Job extends CrudBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result preview
    */
-  async downloadPreview (deleted = RequestParameters.deleted) {
+  async downloadPreview (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const response = await this.api.axios.get(`${this.previewUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
@@ -112,7 +113,7 @@ export default class Job extends CrudBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result output
    */
-  async downloadOutput (deleted = RequestParameters.deleted) {
+  async downloadOutput (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const response = await this.api.axios.get(`${this.lastArchiveUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
@@ -126,7 +127,7 @@ export default class Job extends CrudBase {
    * @returns {Promise<string>} - The url to the output
    * @throws {ApiError}
    */
-  async getOutputUrl (deleted = RequestParameters.deleted) {
+  async getOutputUrl (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const { data: { data } } = await this.api.axios.get(`${this.url}/output-url?${encodeQueryString({ deleted })}`);
 
     return data.url;

src/resources/JobResult.js

@@ -34,6 +34,7 @@ import DownloadedResource from './base/DownloadedResource';
 import ResourceBase from './base/ResourceBase';
 import RequestParameters from '../RequestParameters';
 import { encodeQueryString } from '../utils/requests';
+import { DeletedState } from '../enums';
 
 export default class JobResult extends ResourceBase {
   static get resourcePath () {
@@ -73,7 +74,7 @@ export default class JobResult extends ResourceBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result output
    */
-  async downloadOutput (deleted = RequestParameters.deleted) {
+  async downloadOutput (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const response = await this.api.axios.get(`${this.outputUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
@@ -95,7 +96,7 @@ export default class JobResult extends ResourceBase {
    * @returns {Promise<string>} - The url to the output
    * @throws {ApiError}
    */
-  async getOutputUrl (deleted = RequestParameters.deleted) {
+  async getOutputUrl (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const { data: { data } } = await this.api.axios.get(`${this.outputUrlUrl}?${encodeQueryString({ deleted })}`);
 
     return data.url;
@@ -114,7 +115,7 @@ export default class JobResult extends ResourceBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - job result log
    */
-  async downloadLog (deleted = RequestParameters.deleted) {
+  async downloadLog (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const response = await this.api.axios.get(`${this.logUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
@@ -135,7 +136,7 @@ export default class JobResult extends ResourceBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @returns {Promise<DownloadedResource>} - Job result preview
    */
-  async downloadPreview (deleted = RequestParameters.deleted) {
+  async downloadPreview (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const response = await this.api.axios.get(`${this.previewUrl}?${encodeQueryString({ deleted })}`, {
       responseType: 'arraybuffer',
     });
@@ -150,7 +151,7 @@ export default class JobResult extends ResourceBase {
    * @param {boolean} [value=true] - What to set the dealt-with value to
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    */
-  async dealWith (value = true, deleted = RequestParameters.deleted) {
+  async dealWith (value = true, deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     value = Boolean(value);
 
     const method = value ? 'POST' : 'DELETE';

src/resources/JobRevision.js

@@ -37,6 +37,7 @@ import JobShare from './JobShare';
 import Layer from './Layer';
 import RequestParameters from '../RequestParameters';
 import { encodeQueryString } from '../utils/requests';
+import { DeletedState } from '../enums';
 
 export default class JobRevision extends CrudBase {
   get baseUrl () {
@@ -69,7 +70,7 @@ export default class JobRevision extends CrudBase {
    * @returns {Promise<JobResult>} - The associated job result
    * @throws {ApiError}
    */
-  async result (deleted = RequestParameters.deleted) {
+  async result (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const { data: { data } } = await this.api.axios.get(`${this.url}/result?${encodeQueryString({ deleted })}`);
 
     data.jobId = this.jobId;
@@ -102,7 +103,7 @@ export default class JobRevision extends CrudBase {
    * @throws {TypeError}
    * @throws {ApiError}
    */
-  async save (object = {}, layers = null, deleted = RequestParameters.deleted) {
+  async save (object = {}, layers = null, deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     if (layers && layers.length > 0) {
       if (isParentOf(Layer, layers[0])) {
         layers = layers.map(layer => layer.id);
@@ -133,7 +134,7 @@ export default class JobRevision extends CrudBase {
    * @throws {ApiError}
    * @todo document object format
    */
-  async object (deleted = RequestParameters.deleted) {
+  async object (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const { data: { data } } = await this.api.axios.get(`${this.url}/object?${encodeQueryString({ deleted })}`);
 
     return data;
@@ -145,15 +146,15 @@ export default class JobRevision extends CrudBase {
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    * @throws {ApiError}
    */
-  async build (callback, deleted = RequestParameters.deleted) {
+  async build (callback, deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     await this.api.axios.post(`${this.url}/build?${encodeQueryString({ deleted })}`, { callback });
   }
 
   /**
    * Cancels a running job
    * @param {String} [deleted=RequestParameters.deleted] - Determines if the resource should be shown if deleted, requires special resource permissions. Possible values: only, none, all
    */
-  async cancel (deleted = RequestParameters.deleted) {
+  async cancel (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     await this.api.axios.post(`${this.url}/cancel?${encodeQueryString({ deleted })}`);
   }
 
@@ -164,7 +165,7 @@ export default class JobRevision extends CrudBase {
    * @returns {Promise<String>} - the share link
    * @throws {ApiError}
    */
-  async share (visibility = JobShare.visibility.PRIVATE, deleted = RequestParameters.deleted) {
+  async share (visibility = JobShare.visibility.PRIVATE, deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     visibility = visibility.toLowerCase();
 
     if (visibility !== JobShare.visibility.ORGANISATION &&
@@ -184,7 +185,7 @@ export default class JobRevision extends CrudBase {
    * @throws {ApiError}
    * @returns {Promise<JobRevision>} - The new job revision, which will be linked to a new job
    */
-  async clone (deleted = RequestParameters.deleted) {
+  async clone (deleted = RequestParameters.deleted ?? DeletedState.NONE) {
     const { data: { data } } = await this.api.axios.post(`${this.url}/clone?${encodeQueryString({ deleted })}`);
 
     return new JobRevision(this.api, data);