@versionzero/schema 1.1.0 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versionzero/schema",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "description": "A composable schema library that supports asynchronous processing",
   "license": "Apache-2.0",
   "publishConfig": {

package/src/compiled-schema.js

@@ -1256,7 +1256,7 @@ export class CompiledSchema
    */
   _process(input, target, options = {}) {
     const location = options?.location ?? new SchemaLocation(this);
-    const context = (options.context instanceof TraversalContext) ? options.context : new TraversalContext(location, {strict: options?.strict, deep: options?.deep, debug: options?.debug});
+    const context = (options.context instanceof TraversalContext) ? options.context : new TraversalContext(location, {strict: options?.strict, deep: options?.deep, debug: options?.debug, stats: options?.stats});
 
     const executors = [];
 

package/src/traversal/traversal-context.js

@@ -13,6 +13,7 @@ import { SchemaError } from '../errors.js';
  * @property {boolean} [strict]
  * @property {boolean} [deep]
  * @property {boolean} [debug]
+ * @property {object} [stats]
  */
 
 /** @typedef {TraversalContextStandardOptions & {[key:string]:any}} TraversalContextOptions */
@@ -28,7 +29,7 @@ export class TraversalContext
     this.root = (root instanceof CompiledSchema)? new SchemaLocation(root) : root;
     this._final = false;
 
-    this._options = {...options, deep: options.deep ?? false, strict: options.strict ?? true, debug: options.debug ?? false}
+    this._options = {...options, deep: options.deep ?? false, strict: options.strict ?? true, debug: options.debug ?? false, stats: options.stats ?? {}}
 
     this.traversals = 0;
     this.counter = 0;
@@ -52,6 +53,10 @@ export class TraversalContext
     return this._options.strict;
   }
 
+  get stats() {
+    return this._options.stats;
+  }
+
   update() {
     this.counter++;
     this.final = false;
@@ -192,6 +197,11 @@ export class TraversalContext
     let done = false;
 
     const updateDone = (counter) => {
+      this.traversals++;
+
+      this.stats.traversals = this.traversals;
+      this.stats.updates = this.counter;
+
       if (this.isComplete) {
         done = true;
       }
@@ -222,7 +232,6 @@ export class TraversalContext
           );
         }
         updateDone(counter);
-        this.traversals++;
       }
       return result;
     }

package/types/traversal/traversal-context.d.ts

@@ -3,6 +3,7 @@
  * @property {boolean} [strict]
  * @property {boolean} [deep]
  * @property {boolean} [debug]
+ * @property {object} [stats]
  */
 /** @typedef {TraversalContextStandardOptions & {[key:string]:any}} TraversalContextOptions */
 export class TraversalContext {
@@ -17,6 +18,7 @@ export class TraversalContext {
         deep: boolean;
         strict: boolean;
         debug: boolean;
+        stats: any;
     };
     traversals: number;
     counter: number;
@@ -28,9 +30,11 @@ export class TraversalContext {
         deep: boolean;
         strict: boolean;
         debug: boolean;
+        stats: any;
     };
     get deep(): boolean;
     get strict(): boolean;
+    get stats(): any;
     update(): void;
     set final(finalize: boolean);
     get final(): boolean;
@@ -58,6 +62,7 @@ export type TraversalContextStandardOptions = {
     strict?: boolean | undefined;
     deep?: boolean | undefined;
     debug?: boolean | undefined;
+    stats?: object;
 };
 export type TraversalContextOptions = TraversalContextStandardOptions & {
     [key: string]: any;