harperdb 4.4.17 → 4.5.0-alpha.1

package/npm-shrinkwrap.json

@@ -1,12 +1,12 @@
 {
 	"name": "harperdb",
-	"version": "4.4.17",
+	"version": "4.5.0-alpha.1",
 	"lockfileVersion": 3,
 	"requires": true,
 	"packages": {
 		"": {
 			"name": "harperdb",
-			"version": "4.4.17",
+			"version": "4.5.0-alpha.1",
 			"hasInstallScript": true,
 			"license": "SEE LICENSE IN LICENSE",
 			"dependencies": {
@@ -27,6 +27,7 @@
 				"@turf/helpers": "6.5.0",
 				"@turf/length": "6.5.0",
 				"alasql": "4.1.10",
+				"argon2": "0.41.1",
 				"cbor-x": "1.6.0",
 				"chalk": "4.1.2",
 				"cli-progress": "3.12.0",
@@ -45,7 +46,7 @@
 				"json2csv": "5.0.7",
 				"jsonata": "1.8.7",
 				"jsonwebtoken": "9.0.2",
-				"lmdb": "3.2.2",
+				"lmdb": "3.2.3",
 				"lodash": "4.17.21",
 				"mathjs": "11.12.0",
 				"minimist": "1.2.8",
@@ -1555,9 +1556,9 @@
 			}
 		},
 		"node_modules/@lmdb/lmdb-darwin-arm64": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-darwin-arm64/-/lmdb-darwin-arm64-3.2.2.tgz",
-			"integrity": "sha512-WBSJT9Z7DTol5viq+DZD2TapeWOw7mlwXxiSBHgAzqVwsaVb0h/ekMD9iu/jDD8MUA20tO9N0WEdnT06fsUp+g==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-darwin-arm64/-/lmdb-darwin-arm64-3.2.3.tgz",
+			"integrity": "sha512-SwC7ypweTtdyCv8zjuwLuTN7qLjin/zUihIENl1CyM25dLWYnsGOzvqoXzOgfE+PwQ9ZQP5q+Xz9kTXWQEjmXw==",
 			"cpu": [
 				"arm64"
 			],
@@ -1568,9 +1569,9 @@
 			]
 		},
 		"node_modules/@lmdb/lmdb-darwin-x64": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-darwin-x64/-/lmdb-darwin-x64-3.2.2.tgz",
-			"integrity": "sha512-4S13kUtR7c/j/MzkTIBJCXv52hQ41LG2ukeaqw4Eng9K0pNKLFjo1sDSz96/yKhwykxrWDb13ddJ/ZqD3rAhUA==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-darwin-x64/-/lmdb-darwin-x64-3.2.3.tgz",
+			"integrity": "sha512-pQcqWu602nFkAXyNFodCY1OAi3he0JIMm1YSXu49+rVD29ybLjipyJqDcWMRFQWfb/RNquNmT77iqxXVIvvshQ==",
 			"cpu": [
 				"x64"
 			],
@@ -1581,9 +1582,9 @@
 			]
 		},
 		"node_modules/@lmdb/lmdb-linux-arm": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-arm/-/lmdb-linux-arm-3.2.2.tgz",
-			"integrity": "sha512-uW31JmfuPAaLUYW7NsEU8gzwgDAzpGPwjvkxnKlcWd8iDutoPKDJi8Wk9lFmPEZRxVSB0j1/wDQ7N2qliR9UFA==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-arm/-/lmdb-linux-arm-3.2.3.tgz",
+			"integrity": "sha512-cdPrQ0lWNaauK4M4z61K6W7y04/5Vm3ATi9Xk+3FZeaIpnUE86BjtU9dD5MXYJpGcxY2qt1tcjDoaf28dShMOw==",
 			"cpu": [
 				"arm"
 			],
@@ -1594,9 +1595,9 @@
 			]
 		},
 		"node_modules/@lmdb/lmdb-linux-arm64": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-arm64/-/lmdb-linux-arm64-3.2.2.tgz",
-			"integrity": "sha512-4hdgZtWI1idQlWRp+eleWXD9KLvObgboRaVoBj2POdPEYvsKANllvMW0El8tEQwtw74yB9NT6P8ENBB5UJf5+g==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-arm64/-/lmdb-linux-arm64-3.2.3.tgz",
+			"integrity": "sha512-RR4iwZpJGO5u+1p+bYAnb46X2DKMD5KMJlubO/q42zDvzUqnTHNeRfFy+1oqeCE3t1BBNy7+vssKRuGG4oUsIQ==",
 			"cpu": [
 				"arm64"
 			],
@@ -1607,9 +1608,9 @@
 			]
 		},
 		"node_modules/@lmdb/lmdb-linux-x64": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-x64/-/lmdb-linux-x64-3.2.2.tgz",
-			"integrity": "sha512-A0zjf4a2vM4B4GAx78ncuOTZ8Ka1DbTaG1Axf1e00Sa7f5coqlWiLg1PX7Gxvyibc2YqtqB+8tg1KKrE8guZVw==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-linux-x64/-/lmdb-linux-x64-3.2.3.tgz",
+			"integrity": "sha512-hty5uZqSa1+P6GyLdm+iWvJd4QkFez2+/AC0333+ql77eSOUeShU3a/9zFXDH8OTyTmrmsNuW7vuugu4D9uM1w==",
 			"cpu": [
 				"x64"
 			],
@@ -1620,9 +1621,9 @@
 			]
 		},
 		"node_modules/@lmdb/lmdb-win32-x64": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-win32-x64/-/lmdb-win32-x64-3.2.2.tgz",
-			"integrity": "sha512-Y0qoSCAja+xZE7QQ0LCHoYAuyI1n9ZqukQJa8lv9X3yCvWahFF7OYHAgVH1ejp43XWstj3U89/PAAzcowgF/uQ==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/@lmdb/lmdb-win32-x64/-/lmdb-win32-x64-3.2.3.tgz",
+			"integrity": "sha512-yO70BL6tfbS6k1Iwbu8EuCHv3Mg41k3QPk2AyufzAzmghjEyo5jk9UNOeUnL2Wiq1adtpdcI7tmjSlb3APczOA==",
 			"cpu": [
 				"x64"
 			],
@@ -1754,6 +1755,15 @@
 				"node": ">= 8"
 			}
 		},
+		"node_modules/@phc/format": {
+			"version": "1.0.0",
+			"resolved": "https://registry.npmjs.org/@phc/format/-/format-1.0.0.tgz",
+			"integrity": "sha512-m7X9U6BG2+J+R1lSOdCiITLLrxm+cWlNI3HUFA92oLO77ObGNzaKdh8pMLqdZcshtkKuV84olNNXDfMc4FezBQ==",
+			"license": "MIT",
+			"engines": {
+				"node": ">=10"
+			}
+		},
 		"node_modules/@pkgjs/parseargs": {
 			"version": "0.11.0",
 			"resolved": "https://registry.npmjs.org/@pkgjs/parseargs/-/parseargs-0.11.0.tgz",
@@ -2975,9 +2985,9 @@
 			"license": "MIT"
 		},
 		"node_modules/@types/node": {
-			"version": "22.12.0",
-			"resolved": "https://registry.npmjs.org/@types/node/-/node-22.12.0.tgz",
-			"integrity": "sha512-Fll2FZ1riMjNmlmJOdAyY5pUbkftXslB5DgEzlIuNaiWhXd00FhWxVC/r4yV/4wBb9JfImTu+jiSvXTkJ7F/gA==",
+			"version": "22.13.1",
+			"resolved": "https://registry.npmjs.org/@types/node/-/node-22.13.1.tgz",
+			"integrity": "sha512-jK8uzQlrvXqEU91UxiK5J7pKHyzgnI1Qnl0QDHIgVGuolJhRb9EEl28Cj9b3rGR8B2lhFCtvIm5os8lFnO/1Ew==",
 			"license": "MIT",
 			"dependencies": {
 				"undici-types": "~6.20.0"
@@ -3167,6 +3177,21 @@
 				"node": ">= 8"
 			}
 		},
+		"node_modules/argon2": {
+			"version": "0.41.1",
+			"resolved": "https://registry.npmjs.org/argon2/-/argon2-0.41.1.tgz",
+			"integrity": "sha512-dqCW8kJXke8Ik+McUcMDltrbuAWETPyU6iq+4AhxqKphWi7pChB/Zgd/Tp/o8xRLbg8ksMj46F/vph9wnxpTzQ==",
+			"hasInstallScript": true,
+			"license": "MIT",
+			"dependencies": {
+				"@phc/format": "^1.0.0",
+				"node-addon-api": "^8.1.0",
+				"node-gyp-build": "^4.8.1"
+			},
+			"engines": {
+				"node": ">=16.17.0"
+			}
+		},
 		"node_modules/argparse": {
 			"version": "2.0.1",
 			"resolved": "https://registry.npmjs.org/argparse/-/argparse-2.0.1.tgz",
@@ -3259,9 +3284,9 @@
 			}
 		},
 		"node_modules/bare-stream": {
-			"version": "2.6.4",
-			"resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.6.4.tgz",
-			"integrity": "sha512-G6i3A74FjNq4nVrrSTUz5h3vgXzBJnjmWAVlBWaZETkgu+LgKd7AiyOml3EDJY1AHlIbBHKDXE+TUT53Ff8OaA==",
+			"version": "2.6.5",
+			"resolved": "https://registry.npmjs.org/bare-stream/-/bare-stream-2.6.5.tgz",
+			"integrity": "sha512-jSmxKJNJmHySi6hC42zlZnq00rga4jjxcgNZjY9N5WlOe/iOoGRtdwGsHzQv2RlH2KOYMwGUXhf2zXd32BA9RA==",
 			"license": "Apache-2.0",
 			"optional": true,
 			"dependencies": {
@@ -4506,9 +4531,9 @@
 			}
 		},
 		"node_modules/fastq": {
-			"version": "1.18.0",
-			"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.18.0.tgz",
-			"integrity": "sha512-QKHXPW0hD8g4UET03SdOdunzSouc9N4AuHdsX8XNcTsuz+yYFILVNIX4l9yHABMhiEI9Db0JTTIpu0wB+Y1QQw==",
+			"version": "1.19.0",
+			"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.19.0.tgz",
+			"integrity": "sha512-7SFSRCNjBQIZH/xZR3iy5iQYR8aGBE0h3VG6/cwlbrpdciNYBMotQav8c1XI3HjHH+NikUpP53nPdlZSdWmFzA==",
 			"license": "ISC",
 			"dependencies": {
 				"reusify": "^1.0.4"
@@ -5524,9 +5549,9 @@
 			}
 		},
 		"node_modules/lmdb": {
-			"version": "3.2.2",
-			"resolved": "https://registry.npmjs.org/lmdb/-/lmdb-3.2.2.tgz",
-			"integrity": "sha512-LriG93la4PbmPMwI7Hbv8W+0ncLK7549w4sbZSi4QGDjnnxnmNMgxUkaQTEMzH8TpwsfFvgEjpLX7V8B/I9e3g==",
+			"version": "3.2.3",
+			"resolved": "https://registry.npmjs.org/lmdb/-/lmdb-3.2.3.tgz",
+			"integrity": "sha512-HPiEJ5mkhT19BFZjB82HWH4dgvy/IAvpwrZJ77EBsJ9YfZMwK8qWKZX6PutujR3vEgwUTYp9ayX6zuRHJNEDuw==",
 			"hasInstallScript": true,
 			"license": "MIT",
 			"dependencies": {
@@ -5540,14 +5565,20 @@
 				"download-lmdb-prebuilds": "bin/download-prebuilds.js"
 			},
 			"optionalDependencies": {
-				"@lmdb/lmdb-darwin-arm64": "3.2.2",
-				"@lmdb/lmdb-darwin-x64": "3.2.2",
-				"@lmdb/lmdb-linux-arm": "3.2.2",
-				"@lmdb/lmdb-linux-arm64": "3.2.2",
-				"@lmdb/lmdb-linux-x64": "3.2.2",
-				"@lmdb/lmdb-win32-x64": "3.2.2"
+				"@lmdb/lmdb-darwin-arm64": "3.2.3",
+				"@lmdb/lmdb-darwin-x64": "3.2.3",
+				"@lmdb/lmdb-linux-arm": "3.2.3",
+				"@lmdb/lmdb-linux-arm64": "3.2.3",
+				"@lmdb/lmdb-linux-x64": "3.2.3",
+				"@lmdb/lmdb-win32-x64": "3.2.3"
 			}
 		},
+		"node_modules/lmdb/node_modules/node-addon-api": {
+			"version": "6.1.0",
+			"resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-6.1.0.tgz",
+			"integrity": "sha512-+eawOlIgy680F0kBzPUNFhMZGtJ1YmqM6l4+Crf4IkImjYrO/mqPwRMh352g23uIaQKFItcQ64I7KMaJxHgAVA==",
+			"license": "MIT"
+		},
 		"node_modules/lmdb/node_modules/node-gyp-build-optional-packages": {
 			"version": "5.2.2",
 			"resolved": "https://registry.npmjs.org/node-gyp-build-optional-packages/-/node-gyp-build-optional-packages-5.2.2.tgz",
@@ -5951,10 +5982,13 @@
 			}
 		},
 		"node_modules/node-addon-api": {
-			"version": "6.1.0",
-			"resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-6.1.0.tgz",
-			"integrity": "sha512-+eawOlIgy680F0kBzPUNFhMZGtJ1YmqM6l4+Crf4IkImjYrO/mqPwRMh352g23uIaQKFItcQ64I7KMaJxHgAVA==",
-			"license": "MIT"
+			"version": "8.3.0",
+			"resolved": "https://registry.npmjs.org/node-addon-api/-/node-addon-api-8.3.0.tgz",
+			"integrity": "sha512-8VOpLHFrOQlAH+qA0ZzuGRlALRA6/LVh8QJldbrC4DY0hXoMP0l4Acq8TzFC018HztWiRqyCEj2aTWY2UvnJUg==",
+			"license": "MIT",
+			"engines": {
+				"node": "^18 || ^20 || >= 21"
+			}
 		},
 		"node_modules/node-fetch": {
 			"version": "2.7.0",
@@ -5990,7 +6024,6 @@
 			"resolved": "https://registry.npmjs.org/node-gyp-build/-/node-gyp-build-4.8.4.tgz",
 			"integrity": "sha512-LA4ZjwlnUblHVgq0oBF3Jl/6h/Nvs5fzBLwdEF4nuxnFdsfajde4WfxtJr3CaiH+F6ewcIB/q4jQ4UzPyid+CQ==",
 			"license": "MIT",
-			"optional": true,
 			"bin": {
 				"node-gyp-build": "bin.js",
 				"node-gyp-build-optional": "optional.js",

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "harperdb",
-	"version": "4.4.17",
+	"version": "4.5.0-alpha.1",
 	"description": "HarperDB is a distributed database, caching service, streaming broker, and application development platform focused on performance and ease of use.",
 	"keywords": [
 		"database",
@@ -60,6 +60,7 @@
 		"@turf/helpers": "6.5.0",
 		"@turf/length": "6.5.0",
 		"alasql": "4.1.10",
+		"argon2": "0.41.1",
 		"cbor-x": "1.6.0",
 		"chalk": "4.1.2",
 		"cli-progress": "3.12.0",
@@ -78,7 +79,7 @@
 		"json2csv": "5.0.7",
 		"jsonata": "1.8.7",
 		"jsonwebtoken": "9.0.2",
-		"lmdb": "3.2.2",
+		"lmdb": "3.2.3",
 		"lodash": "4.17.21",
 		"mathjs": "11.12.0",
 		"minimist": "1.2.8",

package/resources/RecordEncoder.d.ts

@@ -5,6 +5,7 @@
  * patches the primary store to properly get the metadata and assign it to the entries.
  */
 import { Encoder } from 'msgpackr';
+import './blob';
 export declare const TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const LAST_TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
 export declare const PREVIOUS_TIMESTAMP_PLACEHOLDER: Uint8Array<ArrayBuffer>;
@@ -24,4 +25,5 @@ export declare class RecordEncoder extends Encoder {
     decode(buffer: any, options: any): any;
 }
 export declare function handleLocalTimeForGets(store: any): any;
-export declare function getUpdateRecord(store: any, table_id: any, audit_store: any): (id: any, record: any, existing_entry: any, new_version: any, assign_metadata?: number, audit?: boolean, options?: any, type?: string, resolve_record?: boolean, audit_record?: any) => any;
+export declare function recordUpdater(store: any, table_id: any, audit_store: any): (id: any, record: any, existing_entry: any, new_version: any, assign_metadata?: number, audit?: boolean, options?: any, type?: string, resolve_record?: boolean, audit_record?: any) => any;
+export declare function removeEntry(store: any, entry: any, existing_version?: number): any;

package/resources/analytics.d.ts

@@ -1,9 +1,123 @@
-export declare function setAnalyticsEnabled(enabled: any): void;
+type ActionCallback = (action: Action) => void;
+export type Value = number | boolean | ActionCallback;
+interface Action {
+    total?: number;
+    values?: Float32Array;
+    count?: number;
+    callback?: ActionCallback;
+    description?: {
+        metric: string;
+        path: string;
+        method: string;
+        type: string;
+    };
+}
+export declare function setAnalyticsEnabled(enabled: boolean): void;
 /**
  * Record an action for analytics (like an HTTP request, replication, MQTT message)
- * @param path
  * @param value
+ * @param metric
+ * @param path
+ * @param method
+ * @param type
  */
-export declare function recordAction(value: any, metric: any, path?: any, method?: any, type?: any): void;
+export declare function recordAction(value: Value, metric: string, path?: string, method?: string, type?: string): void;
 export declare function recordActionBinary(value: any, metric: any, path?: any, method?: any, type?: any): void;
 export declare function addAnalyticsListener(callback: any): void;
+interface ResourceUsage extends Partial<NodeJS.ResourceUsage> {
+    time?: number;
+    period?: number;
+    cpuUtilization?: number;
+}
+/** calculateCPUUtilization takes a ResourceUsage with at least userCPUTime & systemCPUTime set
+ *  with millisecond values (NB: Node's process.resourceUsage returns values in microseconds for
+ *  these fields so divide them by 1000 to get milliseconds) and a time period in milliseconds
+ *  and returns the percentage of that time the CPU was being utilized as a decimal value
+ *  between 0 and 1. So for example, 50% utilization will be returned as 0.5.
+ */
+export declare function calculateCPUUtilization(resourceUsage: ResourceUsage, period: number): number;
+/** diffResourceUsage takes a ResourceUsage representing the last time we stored them and a new
+ *  process.resourceUsage() return value and normalizes and diffs the two values to return the
+ *  new values for this time period.
+ */
+export declare function diffResourceUsage(lastResourceUsage: ResourceUsage, resourceUsage: NodeJS.ResourceUsage): ResourceUsage;
+export {};
+/**
+ * This section contains a possible/experimental approach to bucketing values as they come instead of pushing all into an array and sorting.
+ *
+const BUCKET_COUNT = 100;
+function addToBucket(action, value) {
+    if (!action.buckets) {
+        action.buckets = newBuckets();
+    }
+    const { counts, values, totalCount } = action.buckets;
+    let jump = BUCKET_COUNT >> 1; // amount to jump with each iteration
+    let position = jump; // start at halfway point
+    while ((jump = jump >> 1) > 0) {
+        const bucket_value = values[position];
+        if (bucket_value === 0) {
+            // unused slot, immediately put our value in
+            counts[position] = 1;
+            values[position] = value;
+        }
+        if (value > bucket_value) {
+            position += jump;
+        } else {
+            position -= jump;
+        }
+    }
+    const count = counts[position] + 1;
+    if (position === BUCKET_COUNT) {
+        // if we go beyond the last item, increase the bucket (max) value
+        position--;
+        values[position] = value;
+    }
+    if (count > threshold) {
+        rebalance(action.buckets, false);
+    } else {
+        counts[position] = count;
+    }
+}
+
+function newBuckets() {
+    const ab = new ArrayBuffer(8 * BUCKET_COUNT);
+    return {
+        values: new Float32Array(ab, 0, BUCKET_COUNT),
+        counts: new Uint32Array(ab, BUCKET_COUNT * 4, BUCKET_COUNT),
+        totalCount: 0,
+    };
+}
+
+let balancing_buckets;
+
+ /**
+ * Rebalance the buckets, we can reset the counts at the same time, if this occurred after a delivery
+ * @param param
+ * @param reset_counts
+ *
+function rebalance({ counts, values, totalCount }, reset_counts: boolean) {
+    const count_per_bucket = totalCount / BUCKET_COUNT;
+    let target_position = 0;
+    let target_count = 0;
+    let last_target_value = 0;
+    const { values: target_values, counts: target_counts } = balancing_buckets || (balancing_buckets = newBuckets());
+    for (let i = 0; i < BUCKET_COUNT; i++) {
+        // iterate through the existing buckets, filling up the target buckets in a balanced way
+        let count = counts[i];
+        while ((count_per_bucket - target_count) < count) {
+            const value = values[i];
+            last_target_value = ((count_per_bucket - target_count) / count) * (value - last_target_value) + last_target_value;
+            target_values[target_position] = last_target_value;
+            target_counts[target_position] = count_per_bucket;
+            count -= count_per_bucket;
+            target_position++;
+            target_count = 0;
+        }
+        target_count += count;
+    }
+    // now copy the balanced buckets back into the original buckets
+    values.set(target_values);
+    if (reset_counts) counts.fill(0);
+    else counts.set(target_counts);
+}
+*/

package/resources/auditStore.d.ts

@@ -13,12 +13,15 @@ export declare function openAuditStore(root_store: any): any;
 export declare function removeAuditEntry(audit_store: any, key: number, value: any): Promise<void>;
 export declare function getLastRemoved(audit_store: any): number;
 export declare function setAuditRetention(retention_time: any, default_delay?: number): void;
+export declare const ACTION_32_BIT = 14;
+export declare const ACTION_64_BIT = 15;
 /** Used to indicate we have received a remote local time update */
 export declare const REMOTE_SEQUENCE_UPDATE = 11;
 export declare const HAS_CURRENT_RESIDENCY_ID = 512;
 export declare const HAS_PREVIOUS_RESIDENCY_ID = 1024;
 export declare const HAS_ORIGINATING_OPERATION = 2048;
 export declare const HAS_EXPIRATION_EXTENDED_TYPE = 4096;
+export declare const HAS_BLOBS = 8192;
 /**
  * Creates a binary audit entry
  * @param txn_time

package/resources/blob.d.ts

@@ -0,0 +1,83 @@
+/**
+ * This module provides a Blob class that can be used to store binary data in the database, and can be used to store large binary data in a file
+ * on the server. The Blob class is a subclass of the global Blob class, and can be used in the same way.
+ * The Blob-backed files begin with an 8-byte header:
+ * - The first 2 bytes indicate the type of storage:
+ * 		- 0: Uncompressed
+ * 		- 1: Compressed with deflate
+ * - The next 6 bytes are the size of the content
+ *   - While the file is being written, 0xffffffffffff is used as a placeholder to indicate that the file is not finished being written (this nicely matches the logic that if the written content size is less than the indicated content size, it is not finished)
+ *   - Note that for compressed data, the size is the uncompressed size, and the compressed size in the file
+ */
+export declare const Blob: {
+    new (blobParts?: BlobPart[], options?: BlobPropertyBag): Blob;
+    prototype: Blob;
+} | {
+    new (contents: Buffer[]): {
+        content: Buffer;
+        stream(): ReadableStream<any>;
+        text(): Promise<string>;
+        arrayBuffer(): Promise<ArrayBufferLike>;
+        readonly size: number;
+        slice(): void;
+        bytes(): Promise<Buffer>;
+        readonly type: string;
+    };
+};
+export declare let blobsWereEncoded: boolean;
+/**
+ * A blob that is backed by a file, and can be saved to the database as a reference
+ */
+declare class FileBackedBlob extends Blob {
+    finished: Promise<void>;
+    onError: ((error: Error) => void)[];
+    constructor(options?: FilePropertyBag);
+    on(type: string, callback: (error: Error) => void): void;
+    toJSON(): {
+        description: string;
+    };
+    text(): Promise<string>;
+    bytes(): Promise<Buffer>;
+    arrayBuffer(): Promise<ArrayBuffer>;
+    stream(): ReadableStream;
+    get size(): number;
+    slice(): void;
+    get type(): string;
+}
+/**
+ * Delete the file for the blob
+ * @param blob
+ */
+export declare function deleteBlob(blob: Blob): Promise<void>;
+export declare function setDeletionDelay(delay: number): void;
+export type BlobCreationOptions = {
+    compress?: boolean;
+    flush?: boolean;
+    size?: number;
+    forBlob: (blob: Blob) => any;
+};
+export declare function getFileId(blob: Blob): string;
+export declare function getFilePathForBlob(blob: FileBackedBlob): string;
+/**
+ * Encode blobs with file paths, so that they can be saved to the database
+ * @param callback
+ * @param encodingId
+ * @param objectToClear
+ */
+export declare function encodeBlobsWithFilePath<T>(callback: () => T, encodingId: number): T;
+/**
+ * Decode blobs, creating local storage to hold the blogs and returning a promise that resolves when all the blobs are written to disk
+ * @param callback
+ */
+export declare function decodeBlobsWithWrites(callback: () => void, blobCallback?: (blob: Blob) => void): void | Promise<void> | Promise<void[]>;
+/**
+ * Decode with a callback for when blobs are encountered, allowing for detecting of blobs
+ * @param callback
+ */
+export declare function decodeWithBlobCallback(callback: () => void, blobCallback: (blob: Blob) => void): void;
+/**
+ * Delete blobs in an object, recursively searching for blobs
+ * @param object
+ */
+export declare function deleteBlobsInObject(object: any): void;
+export {};

package/server/Server.d.ts

@@ -1,4 +1,5 @@
 import { Socket } from 'net';
+import type { Value } from '../resources/analytics';
 /**
  * This is the central interface by which we define entry points for different server protocol plugins to listen for
  * incoming connections and requests.
@@ -11,6 +12,7 @@ interface Server {
     contentTypes: Map<string, ContentTypeHandler>;
     getUser(username: string, password: string | null, request: Request): any;
     operation(operation: any, context: any, authorize?: boolean): Promise<any>;
+    recordAnalytics(value: Value, metric: string, path?: string, method?: string, type?: string): void;
 }
 interface ServerOptions {
     port?: number;