fix: add better pdf viewer building function (#457)

src/index.ts

@@ -224,6 +224,7 @@ export {
   redirectToSavedUrl,
   buildSignInPath,
   buildPdfViewerLink,
+  buildPdfViewerURL,
   buildItemLinkForBuilder,
 } from './navigation/navigation.js';
 

src/navigation/navigation.test.ts

@@ -5,6 +5,7 @@ import { DEFAULT_PROTOCOL } from './constants.js';
 import {
   buildItemLinkForBuilder,
   buildPdfViewerLink,
+  buildPdfViewerURL,
   buildSignInPath,
   redirect,
   redirectToSavedUrl,
@@ -180,4 +181,33 @@ describe('Navigation Util Tests', () => {
       expect(res).toContain(assetsUrl);
     });
   });
+
+  describe('buildPdfViewerURL', () => {
+    const assetsUrl = 'localhost';
+    const assetsUrlWithProtocol = 'http://localhost';
+    const assetsUrlWithProtocolAndPath = 'http://localhost/assets/';
+
+    it('undefined if url is not provided', () => {
+      const res = buildPdfViewerURL();
+      expect(res).toBeUndefined();
+    });
+    it('undefined if url is empty', () => {
+      const res = buildPdfViewerURL('');
+      expect(res).toBeUndefined();
+    });
+    it('build url with asset url being just a domain', () => {
+      const res = buildPdfViewerURL(assetsUrl);
+      expect(res?.toString()).toMatch(/https:\/\/localhost\/pdf-viewer*/i);
+    });
+    it('build url with asset url containing protocol', () => {
+      const res = buildPdfViewerURL(assetsUrlWithProtocol);
+      expect(res?.toString()).toMatch(/http:\/\/localhost\/pdf-viewer*/i);
+    });
+    it('build url with asset url containing protocol and path', () => {
+      const res = buildPdfViewerURL(assetsUrlWithProtocolAndPath);
+      expect(res?.toString()).toMatch(
+        /http:\/\/localhost\/assets\/pdf-viewer*/i,
+      );
+    });
+  });
 });

src/navigation/navigation.ts

@@ -106,9 +106,34 @@ export const buildItemLinkForBuilder = (args: {
 };
 
 /**
+ * @deprecated Use `buildPdfViewerURL` instead
  * Return a link to display a pdf, embedded in a custom pdf viewer if provided
  * @param assetsUrl assets url where the pdf viewer is hosted
  * @returns embedded link to display a pdf
  */
 export const buildPdfViewerLink = (assetsUrl?: string) =>
   assetsUrl ? `https://${assetsUrl}/pdf-viewer/web/viewer.html?file=` : '';
+
+/**
+ * Returns the URL object of the resource that hosts a pdf viewer
+ * If url contains protocol and path, it needs to end with a trailing
+ * slash otherwise the last segment will be dropped
+ * @param assetsUrl assets url where the pdf viewer is hosted
+ * @returns embedded link to display a pdf
+ */
+export const buildPdfViewerURL = (assetsUrl?: string): URL | undefined => {
+  if (!assetsUrl) {
+    console.debug('No assets url provided');
+    return undefined;
+  }
+
+  let baseUrl = '';
+  // check if input contains protocol
+  try {
+    baseUrl = new URL(assetsUrl).href;
+  } catch {
+    // is not a valid url, so we should append the protocol
+    baseUrl = `https://${assetsUrl}`;
+  }
+  return new URL('pdf-viewer/web/viewer.html', baseUrl);
+};