@combeenation/3d-viewer 7.1.0 → 7.1.2

package/src/api/classes/viewerError.ts

@@ -0,0 +1,63 @@
+/**
+ * Combeenation configurators are explicitly catching and handling some specific errors thrown by the viewer.
+ * We use this custom error class which adds a unique ID to each error so that we can safely distinguish the different
+ * errors without having to look at the thrown text.
+ */
+
+type ViewerErrorData = {
+  /** One of `GlobalViewerErrorIds` */
+  id: string;
+  message: string;
+};
+
+/**
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ * !!! Note: Combeenation viewer ctrl needs to be adjusted, whenever changing existing keys here. !!!
+ * !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+ *
+ * IDs here shall only include "word characters" (`/w` in RegEx) as `GetViewerErrorIdFromMsg` wouldn't work correctly
+ * otherwise.
+ */
+export const ViewerErrorIds = {
+  InvalidParameterValue: 'InvalidParameterValue',
+  UnknownParameterOption: 'UnknownParameterOption',
+  AssetLoadingFailed: 'AssetLoadingFailed',
+};
+
+export class ViewerError extends Error {
+  viewerErrorId: string;
+
+  constructor(data: ViewerErrorData) {
+    // Unfortunately we can't access the custom `viewerErrorId` property when catching global errors in Combeenation so
+    // we also have to add the ID to the message itself.
+    super(`[${data.id}] ${data.message}`);
+    this.viewerErrorId = data.id;
+  }
+
+  /**
+   * Splits the given error message into a known viewer error id and the message itself.
+   *
+   * E.g.:
+   * Message `[InvalidParameterValue] Some error msg` returns `{ id: 'InvalidParameterValue', msg: 'Some error msg' }`
+   *
+   * @param message An error message in the form `[KnownErrorId] Some error msg`
+   * @returns id = The extracted error id (one of `GlobalViewerErrorIds`) or `undefined` if no valid ID has been found
+   *          msg = The error message without the prefixed ID. Returns the whole given `message` if it isn't prefixed
+   *                with a known ID in the correct format.
+   */
+  static SplitViewerErrorMsg(message: string): { id: string | undefined; msg: string } {
+    const knownIds = Object.values(ViewerErrorIds).join('|');
+
+    // RegEx:
+    //   `^`                  = Start of string
+    //   `\\[`                = Literal `[`
+    //   `(?<id>abc|xyz|...)` = Named capture group `id` which looks for one of the existing error ids
+    //   `] `                 = Literal `] `
+    //   `(?<msg>.*)`         = Named capture group `msg` which looks for everything after the matched group id
+    const result = new RegExp('^\\[(?<id>' + knownIds + ')] (?<msg>.*)').exec(message);
+    const id = result?.groups?.id;
+    const msg = result?.groups?.msg || message;
+
+    return { id, msg };
+  }
+}