@overmap-ai/core 1.0.50-document-attachments.1 → 1.0.50-fix-error-messaging.0

package/README.md

@@ -1,4 +1,4 @@
-# @overmap-ai/core
-
-The `core` package contains core functionality for the Overmap platform. It is a peer dependency of all other overmap
-packages.
+# @overmap-ai/core
+
+The `core` package contains core functionality for the Overmap platform. It is a peer dependency of all other overmap
+packages.

package/dist/overmap-core.js

@@ -217,18 +217,64 @@ class OutboxCoordinator {
     this.requestAttemptCounter[uuid] = (this.requestAttemptCounter[uuid] || 0) + 1;
   }
 }
+const UNKNOWN_ERROR_MESSAGE = "An unknown error occurred";
+const MAX_ERROR_MESSAGE_LENGTH = 500;
+const _SPECIAL_KEYS = ["non_field_errors", "detail"];
+function extractErrorMessage(errorRes, err) {
+  let ret;
+  if (errorRes == null ? void 0 : errorRes.body) {
+    if (typeof errorRes.body === "object") {
+      const responseBody = errorRes.body;
+      if (typeof responseBody.error === "string") {
+        ret = responseBody.error;
+      } else if (typeof responseBody.message === "string") {
+        ret = responseBody.message;
+      } else if (responseBody.body) {
+        try {
+          ret = Object.entries(responseBody.body).map(([key, value]) => {
+            if (typeof value === "string") {
+              if (_SPECIAL_KEYS.includes(key))
+                return value;
+              return `${key}: ${value}`;
+            }
+            if (Array.isArray(value)) {
+              if (_SPECIAL_KEYS.includes(key))
+                return value.join("\n");
+              return value.map((v) => `${key}: ${v}`).join("\n");
+            }
+            return `${key}: ${JSON.stringify(value)}`;
+          }).join("\n");
+        } catch (e) {
+          console.error("Failed to extract error message from response body", e);
+        }
+      }
+    } else if (typeof errorRes.body === "string") {
+      ret = errorRes.body;
+    }
+  } else if (errorRes == null ? void 0 : errorRes.text) {
+    ret = errorRes.text;
+  } else if (err instanceof Error) {
+    ret = err.message;
+  }
+  if (!ret || ret.length > MAX_ERROR_MESSAGE_LENGTH) {
+    return UNKNOWN_ERROR_MESSAGE;
+  }
+  return ret;
+}
 class APIError extends Error {
-  constructor(message, response, options) {
-    super(response == null ? void 0 : response.text);
+  constructor(options) {
+    super(UNKNOWN_ERROR_MESSAGE);
     // NOTE: Needs to conform to NetworkError in @redux-offline/redux-offline, which has `status` and `response`.
     __publicField(this, "status");
-    __publicField(this, "message");
     __publicField(this, "response");
+    __publicField(this, "message");
     __publicField(this, "options");
-    this.message = message;
+    const { response, innerError } = options;
+    this.message = options.message ?? extractErrorMessage(response, innerError) ?? UNKNOWN_ERROR_MESSAGE;
     this.status = (response == null ? void 0 : response.status) ?? 0;
     this.response = response;
-    this.options = options ?? { discard: false };
+    options.discard = options.discard ?? false;
+    this.options = options;
   }
 }
 class DeferredPromise {
@@ -1515,7 +1561,6 @@ const selectHiddenCategoryCount = (state) => {
 };
 const categoryReducer = categorySlice.reducer;
 function setAttachments(state, action) {
-  state.attachments = {};
   for (const attachment of action.payload) {
     state.attachments[attachment.offline_id] = attachment;
   }
@@ -1670,9 +1715,6 @@ const selectAllComponentAttachments = createSelector(
   [selectComponentAttachmentMapping],
   (mapping) => Object.values(mapping)
 );
-const selectComponentAttachment = (attachmentId) => (state) => {
-  return state.componentReducer.attachments[attachmentId];
-};
 const selectAttachmentsOfComponent = restructureCreateSelectorWithArgs(
   createSelector(
     [selectAllComponentAttachments, (_state, componentId) => componentId],
@@ -2356,9 +2398,6 @@ const selectAttachmentsOfIssue = restructureCreateSelectorWithArgs(
     }
   )
 );
-const selectIssueAttachment = (attachmentId) => (root) => {
-  return root.issueReducer.attachments[attachmentId];
-};
 const selectAttachmentsOfIssueByType = restructureCreateSelectorWithArgs(
   createSelector(
     [selectIssueAttachments, (_state, issueId) => issueId],
@@ -3813,8 +3852,7 @@ const selectSortedEmailDomains = (state) => Object.values(state.emailDomainsRedu
 );
 const emailDomainsReducer = emailDomainsSlice.reducer;
 const initialState$1 = {
-  documents: {},
-  attachments: {}
+  documents: {}
 };
 const documentSlice = createSlice({
   name: "documents",
@@ -3951,28 +3989,10 @@ const documentSlice = createSlice({
         }
         delete state.documents[documentId];
       }
-    },
-    setDocumentAttachments: setAttachments,
-    addDocumentAttachment: addAttachment,
-    addDocumentAttachments: addAttachments,
-    updateDocumentAttachment: updateAttachment,
-    removeDocumentAttachment: removeAttachment,
-    removeDocumentAttachments: removeAttachments
+    }
   }
 });
-const {
-  setDocuments,
-  addDocuments,
-  updateDocuments,
-  moveDocument,
-  removeDocuments,
-  setDocumentAttachments,
-  addDocumentAttachment,
-  addDocumentAttachments,
-  updateDocumentAttachment,
-  removeDocumentAttachment,
-  removeDocumentAttachments
-} = documentSlice.actions;
+const { setDocuments, addDocuments, updateDocuments, moveDocument, removeDocuments } = documentSlice.actions;
 const selectDocumentsMapping = (state) => state.documentsReducer.documents;
 const selectDocuments = createSelector(
   [selectDocumentsMapping],
@@ -4002,39 +4022,6 @@ const selectRootDocuments = createSelector(
   [selectDocuments],
   (documents) => documents.filter((document2) => !document2.parent_document)
 );
-const selectDocumentAttachmentMapping = (state) => state.documentsReducer.attachments;
-const selectAllDocumentAttachments = createSelector(
-  [selectDocumentAttachmentMapping],
-  (mapping) => Object.values(mapping)
-);
-const selectDocumentAttachment = (attachmentId) => (state) => {
-  return state.documentsReducer.attachments[attachmentId];
-};
-const selectAttachmentsOfDocument = restructureCreateSelectorWithArgs(
-  createSelector(
-    [selectAllDocumentAttachments, (_state, documentId) => documentId],
-    (attachments, documentId) => {
-      return attachments.filter(({ document: document2 }) => documentId === document2);
-    }
-  )
-);
-const selectAttachmentsOfDocumentByType = restructureCreateSelectorWithArgs(
-  createSelector(
-    [selectAllDocumentAttachments, (_state, documentId) => documentId],
-    (attachments, documentId) => {
-      const attachmentsOfProject = attachments.filter(({ document: document2 }) => documentId === document2);
-      const fileAttachments = attachmentsOfProject.filter(
-        // this null check here is necessary, there are cases where file_type is null or undefined
-        ({ file_type }) => !file_type || !file_type.startsWith("image/")
-      );
-      const imageAttachments = attachmentsOfProject.filter(
-        // this null check here is necessary, there are cases where file_type is null or undefined
-        ({ file_type }) => file_type && file_type.startsWith("image/")
-      );
-      return { fileAttachments, imageAttachments };
-    }
-  )
-);
 const documentsReducer = documentSlice.reducer;
 const initialState = {
   version: 0
@@ -4236,35 +4223,6 @@ function extractResponseFromError(error2) {
   }
   return void 0;
 }
-function extractErrorMessage(errorRes, err) {
-  if (errorRes == null ? void 0 : errorRes.body) {
-    if (typeof errorRes.body === "object") {
-      if (typeof errorRes.body.error === "string")
-        return errorRes.body.error;
-      if (typeof errorRes.body.message === "string")
-        return errorRes.body.message;
-      try {
-        return Object.entries(errorRes.body).map(([key, value]) => {
-          if (typeof value === "string") {
-            return `${key}: ${value}`;
-          }
-          if (Array.isArray(value)) {
-            return value.map((v) => `${key}: ${v}`).join("\n");
-          }
-          return `${key}: ${JSON.stringify(value)}`;
-        }).join("\n");
-      } catch (e) {
-        console.error("Failed to extract error message from response body", e);
-      }
-    } else if (typeof errorRes.body === "string")
-      return errorRes.body;
-  } else if (errorRes == null ? void 0 : errorRes.text) {
-    return errorRes.text;
-  } else if (err instanceof Error) {
-    return err.message;
-  }
-  return void 0;
-}
 async function performRequest(action, client) {
   async function checkToken() {
     if (client.auth.tokenIsExpiringSoon()) {
@@ -4367,19 +4325,29 @@ async function performRequest(action, client) {
           console.warn("No signed-in user to sign out.");
         }
         await client.auth.logout();
-        throw new APIError("You have been signed out due to inactivity.", errorResponse, {
-          discard: true
+        throw new APIError({
+          message: "You have been signed out due to inactivity.",
+          response: errorResponse,
+          discard: true,
+          innerError: error2
+        });
+      }
+      if (state.authReducer.isLoggedIn) {
+        console.debug("Forbidden; renewing tokens and retrying.");
+        await client.auth.renewTokens();
+        console.debug("Successfully renewed tokens; retrying request.");
+        return requestToSend.query(queryParams);
+      } else {
+        console.debug("Forbidden; user is not logged in.");
+        throw new APIError({
+          message: "Incorrect username or password.",
+          response: errorResponse,
+          discard: true,
+          innerError: error2
         });
       }
-      console.debug("Forbidden; renewing tokens and retrying.");
-      await client.auth.renewTokens();
-      console.debug("Successfully renewed tokens; retrying request.");
-      return requestToSend.query(queryParams);
     }
-    const apiErrorMessage = extractErrorMessage(errorResponse, error2) || "An unexpected error occurred.";
-    throw new APIError(apiErrorMessage, errorResponse, {
-      discard: discardStatuses.includes(status)
-    });
+    throw new APIError({ response: errorResponse, innerError: error2, discard: discardStatuses.includes(status) });
   }
 }
 class MiddlewareChainerPrivate {
@@ -4590,18 +4558,29 @@ class BaseApiService {
         if (response) {
           promise.resolve(response.body);
         } else {
-          const error2 = new APIError(
-            "Could not get a response from the server.",
+          const error2 = new APIError({
+            message: "Could not get a response from the server.",
             response,
-            {
-              discard: true
-            }
-          );
+            discard: true
+          });
           promise.reject(error2);
         }
       };
       const errorHandler = (error2) => {
-        error2.options.discard = true;
+        if (error2 instanceof APIError) {
+          error2.options.discard = true;
+        } else {
+          console.error(
+            "Received an unexpected error while processing a request:",
+            error2,
+            "\nConverting error to APIError and discarding."
+          );
+          error2 = new APIError({
+            message: "An error occurred while processing the request.",
+            innerError: error2,
+            discard: true
+          });
+        }
         promise.reject(error2);
       };
       innerPromise.then(successOrUndefinedHandler, errorHandler);
@@ -4623,8 +4602,7 @@ class AttachmentService extends BaseApiService {
       issue_attachments: Object.values(state.issueReducer.attachments),
       component_attachments: Object.values(state.componentReducer.attachments),
       component_type_attachments: Object.values(state.componentTypeReducer.attachments),
-      project_attachments: Object.values(state.projectReducer.attachments),
-      document_attachments: Object.values(state.documentsReducer.attachments)
+      project_attachments: Object.values(state.projectReducer.attachments)
     };
     return [allAttachments, promise];
   }
@@ -4728,8 +4706,8 @@ class AttachmentService extends BaseApiService {
     });
     return [offlineAttachment, promise];
   }
-  async addDocumentAttachment(attachmentPayload) {
-    const { description: description2, document: document2, file_sha1, offline_id } = attachmentPayload;
+  async addProjectAttachment(attachmentPayload) {
+    const { description: description2, project, file_sha1, offline_id } = attachmentPayload;
     if (!attachmentPayload.file.objectURL) {
       throw new Error("Expected attachmentPayload.file.objectURL to be defined.");
     }
@@ -4742,24 +4720,24 @@ class AttachmentService extends BaseApiService {
       created_by: this.client.store.getState().userReducer.currentUser.id
     };
     await this.client.files.addCache(attachmentPayload.file, file_sha1);
-    this.client.store.dispatch(addDocumentAttachment(offlineAttachment));
+    this.client.store.dispatch(addProjectAttachment(offlineAttachment));
     const [fileProps] = await this.client.files.uploadFileToS3(file_sha1);
     const promise = this.enqueueRequest({
       description: "Create attachment",
       method: HttpMethod.POST,
-      url: `/documents/${document2}/attach/`,
-      blocks: [offline_id, document2],
+      url: `/projects/${project}/attach/`,
+      blocks: [offline_id, project.toString()],
       blockers: [file_sha1],
       payload: {
         offline_id,
-        document: document2,
+        project,
         description: description2 ?? "",
         submitted_at: (/* @__PURE__ */ new Date()).toISOString(),
         ...fileProps
       }
     });
     promise.catch((error2) => {
-      this.client.store.dispatch(removeDocumentAttachment(offlineAttachment.offline_id));
+      this.client.store.dispatch(removeProjectAttachment(offlineAttachment.offline_id));
       throw error2;
     });
     return [offlineAttachment, promise];
@@ -4830,7 +4808,7 @@ class AttachmentService extends BaseApiService {
       return photoAttachmentPromise(file);
     });
   }
-  attachFilesToDocument(filesToSubmit, documentId) {
+  attachFilesToProject(filesToSubmit, projectId) {
     return filesToSubmit.map((file) => {
       if (!(file instanceof File)) {
         throw new Error("Expected a File instance.");
@@ -4841,12 +4819,12 @@ class AttachmentService extends BaseApiService {
           file: file2,
           file_name: file2.name,
           file_type: file2.type,
-          document: documentId,
+          project: projectId,
           file_sha1: hash,
           submitted_at: (/* @__PURE__ */ new Date()).toISOString(),
           created_by: this.client.store.getState().userReducer.currentUser.id
         });
-        return this.addDocumentAttachment(attachment);
+        return this.addProjectAttachment(attachment);
       };
       return photoAttachmentPromise(file);
     });
@@ -5026,9 +5004,9 @@ class AttachmentService extends BaseApiService {
     const promise = performRequest2();
     return [offlineAttachment, promise];
   }
-  async replaceDocumentAttachmentFile(attachmentId, newFile) {
+  async replaceProjectAttachmentFile(attachmentId, newFile) {
     const { store } = this.client;
-    const attachment = store.getState().documentsReducer.attachments[attachmentId];
+    const attachment = store.getState().projectReducer.attachments[attachmentId];
     if (!attachment)
       throw new Error(`Attachment ${attachmentId} not found`);
     let oldFile = void 0;
@@ -5042,7 +5020,7 @@ class AttachmentService extends BaseApiService {
         throw new Error(`newFile["objectURL"] is unexpectedly ${newFile.objectURL}`);
       }
       store.dispatch(
-        updateDocumentAttachment({
+        updateProjectAttachment({
           ...attachment,
           file_sha1: newSha1,
           file: URL.createObjectURL(newFile)
@@ -5050,13 +5028,13 @@ class AttachmentService extends BaseApiService {
       );
       await this.client.files.addCache(newFile, newSha1);
       const [fileProps] = await this.client.files.uploadFileToS3(newSha1).catch((e) => {
-        store.dispatch(updateDocumentAttachment(attachment));
+        store.dispatch(updateProjectAttachment(attachment));
         throw e;
       });
       const promise2 = this.enqueueRequest({
         description: "Edit attachment",
         method: HttpMethod.PATCH,
-        url: `/attachments/documents/${attachment.offline_id}/`,
+        url: `/attachments/projects/${attachment.offline_id}/`,
         isResponseBlob: false,
         payload: fileProps,
         blockers: [attachmentId, newSha1],
@@ -5069,7 +5047,7 @@ class AttachmentService extends BaseApiService {
       } catch (e) {
         if (oldFile) {
           store.dispatch(
-            updateDocumentAttachment({
+            updateProjectAttachment({
               ...attachment,
               file_sha1: attachment.file_sha1,
               file: URL.createObjectURL(oldFile)
@@ -5139,20 +5117,20 @@ class AttachmentService extends BaseApiService {
       blocks: [componentTypeAttachmentId]
     });
   }
-  deleteDocumentAttachment(documentAttachmentId) {
+  deleteProjectAttachment(projectAttachmentId) {
     const { store } = this.client;
-    const attachment = store.getState().documentsReducer.attachments[documentAttachmentId];
+    const attachment = selectProjectAttachmentMapping(store.getState())[projectAttachmentId];
     if (!attachment) {
-      throw new Error(`Attachment ${documentAttachmentId} not found`);
+      throw new Error(`Attachment ${projectAttachmentId} not found`);
     }
-    store.dispatch(removeDocumentAttachment(documentAttachmentId));
+    store.dispatch(removeProjectAttachment(projectAttachmentId));
     void this.client.files.removeCache(attachment.file_sha1);
     return this.enqueueRequest({
-      description: "Delete document attachment",
+      description: "Delete attachment",
       method: HttpMethod.DELETE,
-      url: `/attachments/documents/${documentAttachmentId}/`,
-      blockers: [documentAttachmentId],
-      blocks: [documentAttachmentId]
+      url: `/attachments/projects/${projectAttachmentId}/`,
+      blockers: [projectAttachmentId],
+      blocks: [projectAttachmentId]
     });
   }
 }
@@ -5182,24 +5160,23 @@ class AuthService extends BaseApiService {
      */
     __publicField(this, "_getTokenPair", (credentials, logoutOnFailure = true) => {
       const uuid = v4();
-      try {
-        const responsePromise = this.enqueueRequest({
-          uuid,
-          description: "Get token pair",
-          method: HttpMethod.POST,
-          url: "/api/token/",
-          payload: credentials,
-          isAuthNeeded: false,
-          blockers: [],
-          blocks: []
-        });
-        return [responsePromise.then(parseTokens), uuid];
-      } catch (e) {
+      const responsePromise = this.enqueueRequest({
+        uuid,
+        description: "Get token pair",
+        method: HttpMethod.POST,
+        url: "/api/token/",
+        payload: credentials,
+        isAuthNeeded: false,
+        checkAuth: false,
+        blockers: [],
+        blocks: []
+      }).then(parseTokens).catch((e) => {
         if (logoutOnFailure) {
           void this.logout().then();
         }
         throw e;
-      }
+      });
+      return [responsePromise, uuid];
     });
     /**
      * Takes refresh token and gets a new token pair
@@ -5260,7 +5237,7 @@ class AuthService extends BaseApiService {
         timedOut = true;
         store.dispatch(markForDeletion(uuid));
         store.dispatch(markForDeletion(initialDataUuid));
-        reject(new Error(`Request timed out after ${timeout} seconds`));
+        reject(new APIError({ message: `Request timed out after ${timeout} seconds` }));
       }, timeout * 1e3);
     });
     const successPromise = promise.then((tokens) => {
@@ -6390,18 +6367,11 @@ class MainService extends BaseApiService {
     if (currentProjectId) {
       const [_offlineAttachments, promise] = this.client.attachments.fetchAll(currentProjectId);
       void promise.then((result) => {
-        const {
-          issue_attachments,
-          component_type_attachments,
-          component_attachments,
-          project_attachments,
-          document_attachments
-        } = result;
+        const { issue_attachments, component_type_attachments, component_attachments, project_attachments } = result;
         store.dispatch(setIssueAttachments(issue_attachments));
         store.dispatch(setComponentAttachments(component_attachments));
         store.dispatch(setComponentTypeAttachments(component_type_attachments));
         store.dispatch(setProjectAttachments(project_attachments));
-        store.dispatch(setDocumentAttachments(document_attachments));
       });
       void this.client.documents.refreshStore();
       void this.client.issueUpdates.refreshStore();
@@ -7236,8 +7206,7 @@ class OrganizationAccessService extends BaseApiService {
       blockers: [],
       blocks: []
     });
-    const organizationAccesses = result;
-    store.dispatch(setOrganizationAccesses(organizationAccesses));
+    store.dispatch(setOrganizationAccesses(result));
   }
 }
 const cachedRequestPromises = {};
@@ -15662,8 +15631,6 @@ export {
   addComponentTypeAttachment,
   addComponentTypeAttachments,
   addComponentsInBatches,
-  addDocumentAttachment,
-  addDocumentAttachments,
   addDocuments,
   addEmailDomain,
   addFavouriteProjectId,
@@ -15827,8 +15794,6 @@ export {
   removeComponentAttachments,
   removeComponentTypeAttachment,
   removeComponentTypeAttachments,
-  removeDocumentAttachment,
-  removeDocumentAttachments,
   removeDocuments,
   removeEmailDomain,
   removeFavouriteProjectId,
@@ -15876,7 +15841,6 @@ export {
   selectAllAttachments,
   selectAllComponentAttachments,
   selectAllComponentTypeAttachments,
-  selectAllDocumentAttachments,
   selectAllProjectAttachments,
   selectAncestorIdsOfDocument,
   selectAppearance,
@@ -15884,8 +15848,6 @@ export {
   selectAttachmentsOfComponentByType,
   selectAttachmentsOfComponentType,
   selectAttachmentsOfComponentTypeByType,
-  selectAttachmentsOfDocument,
-  selectAttachmentsOfDocumentByType,
   selectAttachmentsOfIssue,
   selectAttachmentsOfIssueByType,
   selectAttachmentsOfProject,
@@ -15901,7 +15863,6 @@ export {
   selectCompletedStageIdsForComponent,
   selectCompletedStages,
   selectComponent,
-  selectComponentAttachment,
   selectComponentAttachmentMapping,
   selectComponentSubmissionMapping,
   selectComponentType,
@@ -15922,8 +15883,6 @@ export {
   selectCurrentUser,
   selectDeletedRequests,
   selectDocument,
-  selectDocumentAttachment,
-  selectDocumentAttachmentMapping,
   selectDocuments,
   selectDocumentsMapping,
   selectEmailDomainsAsMapping,
@@ -15945,7 +15904,6 @@ export {
   selectIsLoading,
   selectIsLoggedIn,
   selectIssue,
-  selectIssueAttachment,
   selectIssueAttachmentMapping,
   selectIssueAttachments,
   selectIssueMapping,
@@ -16039,7 +15997,6 @@ export {
   setComponents,
   setCreateProjectType,
   setCurrentUser,
-  setDocumentAttachments,
   setDocuments,
   setEmailDomains,
   setEnableClustering,
@@ -16094,7 +16051,6 @@ export {
   updateComponent,
   updateComponentAttachment,
   updateComponentTypeAttachment,
-  updateDocumentAttachment,
   updateDocuments,
   updateIssue,
   updateIssueAttachment,