feat: export parse function (#148)

https://coveord.atlassian.net/browse/CDX-990

src/help/function.ts

@@ -0,0 +1 @@
+export const noop = () => {};

src/index.ts

@@ -18,3 +18,5 @@ export {DocumentBuilder} from './documentBuilder';
 export * from './securityIdentityBuilder';
 export {PlatformEnvironment, Region, PlatformUrlOptions} from './environment';
 export {SourceVisibility} from '@coveord/platform-client';
+
+export {parseAndGetDocumentBuilderFromJSONDocument} from './validation/parseFile';

src/interfaces.ts

@@ -1,4 +1,5 @@
 import type {AxiosResponse} from 'axios';
+import {PathLike} from 'fs';
 import type {DocumentBuilder} from './documentBuilder';
 import type {Transformer} from './validation/transformers/transformer';
 // Used for Documentation.
@@ -45,6 +46,10 @@ export interface ParseDocumentOptions {
    * @default BuiltInTransformers.identity
    */
   fieldNameTransformer?: Transformer;
+  /**
+   * Callback to execute everytime a new {@link DocumentBuilder} is created
+   */
+  callback?: (docBuilder: DocumentBuilder, documentPath: PathLike) => void;
 }
 export interface ConcurrentProcessing {
   /**

src/source/documentUploader.ts

@@ -3,6 +3,7 @@ import axios, {AxiosRequestConfig, AxiosResponse} from 'axios';
 import {FieldAnalyser} from '..';
 import {DocumentBuilder} from '../documentBuilder';
 import {createFieldsFromReport} from '../fieldAnalyser/fieldUtils';
+import {noop} from '../help/function';
 import {
   BatchUpdateDocuments,
   BatchUpdateDocumentsFromFiles,
@@ -19,6 +20,7 @@ const defaultBatchFromFileOptions: Required<BatchUpdateDocumentsFromFiles> = {
   ...defaultBatchOptions,
   fieldNameTransformer: BuiltInTransformers.identity,
   maxConcurrent: 10,
+  callback: noop,
 };
 
 export async function uploadDocument(

src/validation/parseFile.ts

@@ -27,17 +27,27 @@ import {ParseDocumentOptions} from '../interfaces';
 export const parseAndGetDocumentBuilderFromJSONDocument = (
   documentPath: PathLike,
   options?: ParseDocumentOptions
-) => {
+): DocumentBuilder[] => {
   ensureFileIntegrity(documentPath);
 
   const fileContent = safeJSONParse(documentPath);
 
+  const executeCallback = (docBuilder: DocumentBuilder) => {
+    if (options?.callback) {
+      options?.callback(docBuilder, documentPath);
+    }
+  };
+
   if (Array.isArray(fileContent)) {
-    return fileContent.map((doc) =>
-      processDocument(doc, documentPath, options)
-    );
+    return fileContent.map((doc) => {
+      const docBuilder = processDocument(doc, documentPath, options);
+      executeCallback(docBuilder);
+      return docBuilder;
+    });
   } else {
-    return [processDocument(fileContent, documentPath, options)];
+    const docBuilder = processDocument(fileContent, documentPath, options);
+    executeCallback(docBuilder);
+    return [docBuilder];
   }
 };