refactor: change function signature

Author: cabljac

README.md

@@ -8,15 +8,17 @@ This provides a processor class which you can pass to your firestore onWrite cal
 import {
   FirestoreOnWriteProcessor,
   FirestoreOnWriteProcess,
-} from "firebase-extension-utilities/firestore-onwrite-processor";
+} from "../firestore-onwrite-processor";
+
+// this can be async if needed
+const processFn = ({ input }) => {
+  // do stuff here
+  return { output };
+};
 
 const myProcess = new FirestoreOnWriteProcess({
   id: "myProcessId",
   fieldDependencyArray: ["input"],
-  processFn: ({ input }) => {
-    // do stuff here
-    return { output };
-  },
 });
 
 const myProcessor = new FirestoreOnWriteProcessor({
@@ -28,13 +30,6 @@ export const myFunction = functions.firestore
   .onWrite(process);
 ```
 
-### TODO:
-
-- change signature of above, process function should be main argument and then should pass `options` which include optional id etc.
-
 ### Used in:
 
 (nda)
-## distributed-cloud-tasks
-
-**(TODO)**

jest.config.js

@@ -1,7 +1,6 @@
 const packageJson = require("./package.json");
 
 module.exports = {
-  name: packageJson.name,
   displayName: packageJson.name,
   preset: "ts-jest",
   testMatch: ["**/*.test.ts"],

src/firestore-onwrite-processor/index.test.ts

@@ -27,13 +27,14 @@ type WrappedFirebaseFunction = WrappedFunction<
 const firestoreObserver = jest.fn((_x: any) => {});
 let collectionName: string;
 
+const processFn = (data: { input: string }) => {
+  return { output: "foo" };
+};
+
 const processes = [
-  new Process<{ input: string }, { output: string }>({
+  new Process<{ input: string }, { output: string }>(processFn, {
     id: "test",
     fieldDependencyArray: ["input"],
-    processFn: async (data: { input: string }) => {
-      return { output: "foo" };
-    },
   }),
 ];
 

src/firestore-onwrite-processor/process.ts

@@ -4,22 +4,25 @@ export class Process<
   TInput extends Record<string, FirestoreField>,
   TOutput extends Record<string, FirestoreField>,
 > {
+  processFn: (data: TInput) => Promise<TOutput>;
   id: string;
   fieldDependencyArray: string[];
-  processFn: (data: TInput) => Promise<TOutput>;
-  errorFn: (e: unknown) => Promise<string | void>;
+  errorFn?: (e: unknown) => Promise<string | void>;
   shouldProcess?: (oldData: TInput, newData: TInput) => boolean;
 
-  constructor(options: {
-    id: string;
-    fieldDependencyArray: string[];
-    processFn: (data: TInput) => Promise<TOutput>;
-    shouldProcess?: (oldData: TInput, newData: TInput) => boolean;
-    statusField?: string;
-  }) {
+  constructor(
+    processFn: (data: TInput) => TOutput | Promise<TOutput>,
+    options: {
+      id: string;
+      fieldDependencyArray: string[];
+      shouldProcess?: (oldData: TInput, newData: TInput) => boolean;
+      errorFn?: (e: unknown) => Promise<string | void>;
+    },
+  ) {
     this.id = options.id;
     this.fieldDependencyArray = options.fieldDependencyArray;
-    this.processFn = options.processFn;
+    this.processFn = async (data: TInput) => processFn(data);
+    this.errorFn = options.errorFn;
     this.shouldProcess = function (oldData: TInput, newData: TInput) {
       if (options.shouldProcess) {
         if (!options.shouldProcess(oldData, newData)) {