feat(release): 1.0.0

src/Storage/Operators/Update/Inc.ts

@@ -0,0 +1,56 @@
+import * as dot from "dot-prop";
+
+import { Document, Filter, UpdateFilter, WithId } from "../../../Types.js";
+import { setPositionalData } from "./Utils.js";
+
+/**
+ * Execute a $inc based operators.
+ *
+ * Supports positional array operator $(update)
+ *
+ * @see https://www.mongodb.com/docs/manual/reference/operator/update/positional
+ *
+ * @param document - Document being updated.
+ * @param filter   - Search filter provided with the operation. Eg. updateOne({ id: "1" })
+ * @param $set     - $set action being executed.
+ */
+export function $inc<TSchema extends Document = Document>(
+  document: WithId<TSchema>,
+  filter: Filter<WithId<TSchema>>,
+  $inc: UpdateFilter<TSchema>["$inc"] = {}
+): boolean {
+  let modified = false;
+  for (const key in $inc) {
+    if (key.includes("$")) {
+      if (
+        setPositionalData(document, filter, key, {
+          object: (data, key, target) => {
+            if (typeof data === "number") {
+              return data + ($inc[key] as number);
+            }
+            const value = dot.getProperty(data, target);
+            if (typeof value !== "number") {
+              return 0;
+            }
+            return value + $inc[key];
+          },
+          value: (data, key) => data + $inc[key]
+        })
+      ) {
+        modified = true;
+      }
+    } else {
+      document = increment(document, key, $inc[key]);
+      modified = true;
+    }
+  }
+  return modified;
+}
+
+function increment<D extends Document>(document: D, key: string, value: number): D {
+  let currentValue = dot.getProperty(document, key) as unknown;
+  if (typeof currentValue !== "number") {
+    currentValue = 0;
+  }
+  return dot.setProperty(document, key, (currentValue as number) + value);
+}