feat: normalize docID to valid URI (#236)

* chore(cd): ensure we update package-lock.json on release

* feat: normalize docID to valid URI

package.json

@@ -15,7 +15,8 @@
     "axios": "^1.2.0",
     "dayjs": "^1.10.4",
     "exponential-backoff": "^3.1.0",
-    "isomorphic-fetch": "^3.0.0"
+    "isomorphic-fetch": "^3.0.0",
+    "zod": "^3.20.2"
   },
   "devDependencies": {
     "@coveo/push-api-client": "file:.",

src/documentBuilder.spec.ts

@@ -15,8 +15,14 @@ describe('DocumentBuilder', () => {
     expect(docBuilder.marshal().title).toBe('title');
   });
 
-  it('should marshal uri to documentId', () => {
-    expect(docBuilder.marshal().documentId).toBe('uri');
+  it('should uri marshal to documentID (path->uri)', () => {
+    expect(docBuilder.marshal().documentId).toMatch(/file:\/\/.*\/uri/);
+  });
+
+  it('should uri marshal to documentID (uri->uri)', () => {
+    expect(
+      new DocumentBuilder('foo://bar.biz', 'aaa').marshal().documentId
+    ).toBe('foo://bar.biz');
   });
 
   it('should marshal data', () => {

src/documentBuilder.ts

@@ -8,6 +8,8 @@ import {
   BuiltInTransformers,
   Transformer,
 } from './validation/transformers/transformer';
+import {z} from 'zod';
+import {pathToFileURL} from 'url';
 /**
  * Utility class to build a {@link Document}.
  */
@@ -255,11 +257,19 @@ export class DocumentBuilder {
       ...this.marshalMetadata(),
       ...this.marshalCompressedBinaryData(),
       ...this.marshalPermissions(),
-      documentId: uri,
+      ...this.marshalDocumentId(),
     };
     return out;
   }
 
+  private marshalDocumentId() {
+    return {
+      documentId: z.string().url().safeParse(this.uri).success
+        ? this.uri
+        : pathToFileURL(this.uri).toString(),
+    };
+  }
+
   private marshalMetadata() {
     if (!this.doc.metadata) {
       return {};