@versionzero/schema 1.0.0 → 1.0.1

package/README.md

@@ -227,7 +227,7 @@ You can think of it like having a toolkit for composing rich runtime-enforced in
 with reflection; embracing the dynamic nature of JavaScript, rather than pretending it has
 static types.
 
-_Read more about this [in the full documentation](https://docs.v0.net/schema/rationale)._
+_Read more about this [in the full documentation](https://docs.v0.net/schema/guide/rationale)._
 
 ## License
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@versionzero/schema",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "A composable schema library that supports asynchronous processing",
   "license": "Apache-2.0",
   "publishConfig": {
@@ -63,7 +63,7 @@
     "test:browser": "playwright test",
     "test:all": "npm test && npm run test:browser",
     "clean": "rm -rf types docs-output* processors-output* .mdrun .c8 .nyc_output",
-    "release:dry": "npx -p semantic-release@24 -p @semantic-release/exec@7 semantic-release --dry-run --no-ci"
+    "release:dry": "npx -p semantic-release@24 -p @semantic-release/exec@7 -p @semantic-release/changelog@6 -p @semantic-release/git@10 semantic-release --dry-run --no-ci"
   },
   "devDependencies": {
     "@playwright/test": "^1.60.0",

package/src/compiled-schema.js

@@ -144,16 +144,16 @@ export class CompiledSchema
   }
 
   /**
-   * Handlers are associated with asynchronous value processors.
+   * Handlers are associated with value processors.
    *
-   * The "friendly" handler definitions from the source Schema are each compiled into asynchronous functions
-   * that run as a pipeline.
+   * The "friendly" handler definitions from the source Schema are each compiled into an array
+   * of functions (sync or async) that run as a pipeline.
    *
-   * All handlers have the same async signature, receiving:
+   * All value processors have the same signature, receiving:
    *   1. a value to be processed by the current schema
-   *   2. a reference to the top-level aggregate target being built or processed by the entire schema hierarchy
-   *   3. a location defining the current schema and the traversal path to where it was encountered
-   *   5. any (unmanaged / developer defined) options passed to whatever invoked the handler processing
+   *   2. the top-level aggregate target value being built or processed by the entire schema hierarchy
+   *   3. a location cursor referencing the associated schema and the traversal path to where it was encountered
+   *   4. any (unmanaged / developer defined) options passed to whatever invoked the handler processing
    *
    * The compiled handlers may vary in their return types and exception handling behavior.
    *
@@ -617,7 +617,7 @@ export class CompiledSchema
 
   /**
    * Use the registered discriminator to return a matching union schema, or undefined if the union cannot be resolved.
-   * Discriminator functions must return either one of the unionSchema members, a unionSchema key, or undefined.
+   * Discriminator functions must return either a unionSchema key or (compiled) member reference, or undefined.
    *
    * (This is an executor function that may return synchronous or asynchronous results.)
    *
@@ -668,7 +668,7 @@ export class CompiledSchema
   }
   /**
    * Use the registered discriminator to return a matching union schema, or undefined if the union cannot be resolved.
-   * Discriminator functions must return either one of the unionSchema members, a unionSchema key, or undefined.
+   * Discriminator functions must return either a unionSchema key or (compiled) member reference, or undefined.
    *
    * (This an async wrapper around the internal `_discriminateUnion` executor function.)
    *
@@ -899,7 +899,7 @@ export class CompiledSchema
    * Finalize a transformed input value by running any necessary post-processing steps.
    *
    * Runs all finalizer value processors in a pipeline until one returns undefined or throws an error.
-   * - The input to the pipeline is be assumed to be transformed.
+   * - The input to the pipeline is assumed to be transformed.
    * - Finalizers are generally only required for incremental schemas that need to check child values.
    * - A finalizer on the root schema (or that checks for the root path, if the root schema is shared)
    *   can act as an "entire output" finalizer.
@@ -950,7 +950,7 @@ export class CompiledSchema
    * Finalize a transformed input value by running any necessary post-processing steps.
    *
    * Runs all finalizer value processors in a pipeline until one returns undefined or throws an error.
-   * - The input to the pipeline is be assumed to be transformed.
+   * - The input to the pipeline is assumed to be transformed.
    * - Finalizers are generally only required for incremental schemas that need to check child values.
    * - A finalizer on the root schema (or that checks for the root path, if the root schema is shared)
    *   can act as an "entire output" finalizer.

package/src/schema.js

@@ -459,7 +459,7 @@ export class Schema
   }
 
   /**
-   * The discriminator handler returns the key or schema of the union member that should be used
+   * The discriminator handler returns the key or schema of the union member that should be used.
    * This function appends a single value processor to the handler pipeline.
    *
    * @param {ValueProcessorSpec} spec
@@ -470,7 +470,7 @@ export class Schema
   }
 
   /**
-   * The discriminator handler returns the key or schema of the union member that should be used
+   * The discriminator handler returns the key or schema of the union member that should be used.
    * This function applies multiple value processors to the handler pipeline.
    * (Note that it would be highly unusual to want more than one!)
    *

package/types/compiled-schema.d.ts

@@ -71,16 +71,16 @@ export class CompiledSchema {
      */
     get propertyEntries(): IteratorObject<[string, CompiledSchema]>;
     /**
-     * Handlers are associated with asynchronous value processors.
+     * Handlers are associated with value processors.
      *
-     * The "friendly" handler definitions from the source Schema are each compiled into asynchronous functions
-     * that run as a pipeline.
+     * The "friendly" handler definitions from the source Schema are each compiled into an array
+     * of functions (sync or async) that run as a pipeline.
      *
-     * All handlers have the same async signature, receiving:
+     * All value processors have the same signature, receiving:
      *   1. a value to be processed by the current schema
-     *   2. a reference to the top-level aggregate target being built or processed by the entire schema hierarchy
-     *   3. a location defining the current schema and the traversal path to where it was encountered
-     *   5. any (unmanaged / developer defined) options passed to whatever invoked the handler processing
+     *   2. the top-level aggregate target value being built or processed by the entire schema hierarchy
+     *   3. a location cursor referencing the associated schema and the traversal path to where it was encountered
+     *   4. any (unmanaged / developer defined) options passed to whatever invoked the handler processing
      *
      * The compiled handlers may vary in their return types and exception handling behavior.
      *
@@ -386,7 +386,7 @@ export class CompiledSchema {
     _checkValue(value: any, ErrorClass: any): any;
     /**
      * Use the registered discriminator to return a matching union schema, or undefined if the union cannot be resolved.
-     * Discriminator functions must return either one of the unionSchema members, a unionSchema key, or undefined.
+     * Discriminator functions must return either a unionSchema key or (compiled) member reference, or undefined.
      *
      * (This is an executor function that may return synchronous or asynchronous results.)
      *
@@ -400,7 +400,7 @@ export class CompiledSchema {
     _discriminateUnion(value: any, target?: any, location?: SchemaLocation, options?: object): CompiledSchema | undefined | Promise<CompiledSchema | undefined>;
     /**
      * Use the registered discriminator to return a matching union schema, or undefined if the union cannot be resolved.
-     * Discriminator functions must return either one of the unionSchema members, a unionSchema key, or undefined.
+     * Discriminator functions must return either a unionSchema key or (compiled) member reference, or undefined.
      *
      * (This an async wrapper around the internal `_discriminateUnion` executor function.)
      *
@@ -526,7 +526,7 @@ export class CompiledSchema {
      * Finalize a transformed input value by running any necessary post-processing steps.
      *
      * Runs all finalizer value processors in a pipeline until one returns undefined or throws an error.
-     * - The input to the pipeline is be assumed to be transformed.
+     * - The input to the pipeline is assumed to be transformed.
      * - Finalizers are generally only required for incremental schemas that need to check child values.
      * - A finalizer on the root schema (or that checks for the root path, if the root schema is shared)
      *   can act as an "entire output" finalizer.
@@ -545,7 +545,7 @@ export class CompiledSchema {
      * Finalize a transformed input value by running any necessary post-processing steps.
      *
      * Runs all finalizer value processors in a pipeline until one returns undefined or throws an error.
-     * - The input to the pipeline is be assumed to be transformed.
+     * - The input to the pipeline is assumed to be transformed.
      * - Finalizers are generally only required for incremental schemas that need to check child values.
      * - A finalizer on the root schema (or that checks for the root path, if the root schema is shared)
      *   can act as an "entire output" finalizer.

package/types/schema.d.ts

@@ -234,7 +234,7 @@ export class Schema {
      */
     addMetadata(metadata: object, policy?: symbol): Schema;
     /**
-     * The discriminator handler returns the key or schema of the union member that should be used
+     * The discriminator handler returns the key or schema of the union member that should be used.
      * This function appends a single value processor to the handler pipeline.
      *
      * @param {ValueProcessorSpec} spec
@@ -242,7 +242,7 @@ export class Schema {
      */
     unionDiscriminator(spec: ValueProcessorSpec): Schema;
     /**
-     * The discriminator handler returns the key or schema of the union member that should be used
+     * The discriminator handler returns the key or schema of the union member that should be used.
      * This function applies multiple value processors to the handler pipeline.
      * (Note that it would be highly unusual to want more than one!)
      *