@versionzero/schema 1.0.0

package/LICENSE

@@ -0,0 +1,177 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+

package/README.md

@@ -0,0 +1,246 @@
+# Schema
+
+A composition-oriented schema system for processing, extracting, and validating data. 
+
+- Focused on enabling decoupled contracts between systems.  
+- All behavior is composed rather than hard-coded, even fundamental types.
+- Supports unions, conditionals, cross-references, recursion, async value processing, 
+  dynamic resolution, and more.
+
+For full documentation, see <https://docs.v0.net/schema>.
+
+## Requirements
+
+- Node.js 19+ or any modern browser
+- ESM only
+
+## Basic Usage
+
+Core schema and value processor availability vary by platform.
+
+### Node
+```bash
+npm install --save @versionzero/schema
+```
+Includes support for `Buffer` and processors for file system access.
+### Browsers
+```html
+<script type="module">
+  import { Schema, SchemaResolver } from '@versionzero/schema';
+  // ...
+</script>
+```
+Works in browsers as raw ESM — no build step required.
+
+### Examples
+(Source can be found in the [examples directory](https://github.com/argh/schema/tree/main/examples))
+
+#### Simple String Schema
+Here's a trivial schema that just enforces a capitalized greeting:
+```javascript title="basics.js"
+import { Schema, SchemaResolver } from '@versionzero/schema';
+
+const resolver = new SchemaResolver();
+
+const helloSchema = resolver.compile(
+  new Schema('string')
+    .normalizer('$title-case')
+    .validator({$matches: /^Hello.+/})
+);
+
+// Value processing runs all handlers, so this will be normalized: 
+const greeting = await helloSchema.process('hello world');
+console.log(greeting);  // Hello World 
+
+// Validation requires the input to already be correct.  This is valid...
+await helloSchema.validate('Hello Friend');
+
+// but this will throw a ValidationError (wrong case)
+await helloSchema.validate('hello world');
+```
+
+#### More complex...
+This schema defines the data structure of a meeting.  (Note how `ends` depends on `starts`!)
+```javascript title="basics.js"
+import crypto from 'node:crypto';
+import { Schema, SchemaResolver } from '@versionzero/schema';
+
+const resolver = new SchemaResolver();
+
+// you can define a schema to reference inline in multiple places...
+const meetingTextFieldSchema = new Schema('string')
+  .normalizer('$trim')
+  .validator({$length: {min: 1, max: 1024}});
+
+// or you can register it to the resolver to reference by name
+resolver.registerSchema('meeting-text', meetingTextFieldSchema);
+
+const meetingSchema = resolver.compile(
+  new Schema('object')
+    .property('id', new Schema('string')
+      .required()
+      .default(() => crypto.randomUUID())
+      .normalizer(['$trim', '$lowercase'])
+      .validator('$uuid')
+    )
+    .property('title', new Schema(meetingTextFieldSchema)    // extend a schema instance
+      .required()
+      .default('Untitled Meeting')
+    )
+    .property('description', new Schema('meeting-text'))     // or extend a named schema
+    .property('starts', new Schema('date').required())
+    .property('ends', new Schema('date')
+        .required()
+        .validator({'$date-range': {min: {$reference: '^starts'}}})
+    )                                        
+    .property('attendees', new Schema('array')
+      .required()
+      .validator({$length: {min: 1}})
+      .property('*', new Schema('object')
+        .property('email', new Schema('string')
+          .required()
+          .validator('$email')
+        )
+        .property('response', new Schema('string')
+          .default('pending')
+          .validator({$in: ['accepted', 'declined', 'tentative', 'pending']})
+        )
+      )
+    )
+)
+```
+The meeting schema is usable both for validation (checking if data matches the schema rules):
+```javascript
+const meeting = {
+  id: '123e4567-e89b-12d3-a456-426614174000',
+  title: 'Weekly Team Meeting',
+  description: 'Weekly team meeting to discuss progress and upcoming projects.',
+  starts: new Date('2026-09-01T10:00:00'),
+  ends: new Date('2026-09-01T11:00:00'),
+  attendees: [
+    { email: 'john.doe@example.com', response: 'accepted' },
+    { email: 'jane.smith@example.com', response: 'declined' },
+    { email: 'ted.richards@example.com' },
+    { email: 'alice.johnson@example.com', response: 'tentative' }
+  ]
+}
+
+const validatedMeeting = await meetingSchema.validate(meeting);  // valid!
+```
+
+as well as processing (attempt to convert input data to the valid format):
+
+```javascript
+const minimal = {
+  starts: '2027-01-01T10:00:00',
+  ends: '2027-01-01T11:00:00',
+  attendees: [ { email: 'john.doe@example.com' } ]
+}
+
+// would not validate as-is, but...
+const processedMeeting = await meetingSchema.process(minimal);
+
+/* Result is now valid - populated with defaults, date strings converted to Dates:
+{
+  id: '1f721f55-c075-485c-994c-96dbb30b035d',
+  title: 'Untitled Meeting',  
+  starts: 2027-01-01T18:00:00.000Z,
+  ends: 2027-01-01T19:00:00.000Z,
+  attendees: [ { email: 'john.doe@example.com', response: 'pending' } ]
+}
+ */
+```
+
+See the full [documentation](https://docs.v0.net/schema) for details.
+
+Also see the [examples directory](https://github.com/argh/schema/tree/main/examples) for more advanced usage patterns.
+
+## Key Features
+
+### Definition via Fluent API (or Data)
+
+Define your data structure declaratively using composable `Schema` objects.  The fluent API makes 
+complex nested and variant structures intuitive to build.  Or use a simple object definition, enabling 
+schemas to be exported by data consumers without introducing dependencies.
+
+### "Batteries Included"
+
+Get started quickly with pre-built schemas corresponding to fundamental types, and a rich processor 
+library of operators and constraints (`$positive`, `$alphanum`, `$directory`, etc.). 
+As your needs grow, create or import libraries of reusable custom schemas and value processors to compose 
+complex processing pipelines.  You have complete control over all phases of processing; normalization,
+transformation, finalization, validation.
+
+(The system is expressive enough that it self-hosts - schemas are defined by a "schema schema"!)
+
+### Union Types, Selectors, and Conditionals
+
+Easily handle scenarios where your output data structure varies at runtime.  Union schemas let you define 
+alternative schemas and multiple discrimination strategies.  Selectors and Conditionals provide
+different approaches to activating or deactivating schemas within a schema hierarchy.
+
+### Dynamic/Late Resolution
+
+Compose without coupling, verify without sharing types.  Schemas can be built declaratively with only
+named references to other schemas or processors.  Or provide dynamic values to ensure the validation process
+calls back to your code.  You can even add async processors without special fanfare; the library automatically
+handles deferred results, while optimizing any synchronous call graphs to incur no async overhead.
+Multi-pass processing enables complex mixtures of dynamic resolution and cross-referenced values. 
+
+### Schema as a Decoupled Contract
+
+Use schemas as an impartial bridge between data producers and data consumers.  This prevents the 
+architectural and maintenance headaches of validation logic being split across tiers, or implementation 
+details leaking between subsystems.  The data consumer uses the schema to advertise its requirements 
+in a way that upstream producers can enforce, enabling a decoupled contract.
+
+In modular applications, you can aggregate schemas exported from multiple subsystems to create a composite
+schema that acts as a canonical definition for configuration.  This application schema can then be 
+introspected, enabling automatic construction of interfaces for loading inputs (CLIs, editors, etc.)
+
+### Designed for Extension and Integration
+
+The pre-built schema types and value processors that are provided with the library are deliberately 
+not "special", and are all built using the public developer APIs.  This empowers you to easily 
+create your own libraries, where your custom definitions participate as first-class citizens,
+indistinguishable from the "fundamental" behaviors.   
+
+This library was originally created as the core of the [`Configurator`](https://github.com/argh/configurator) (`@versionzero/configurator`)
+system, which focuses on configuring applications using composed lists of configuration data sources
+(command line, environment, files, etc).  The `Configurator` is then embedded inside the 
+[`ModuleManager`](https://github.com/argh/module-manager) (`@versionzero/module-manager`) package, which extends application configuration
+with dependency injection and lifecycle management.
+
+**This project does not have a cute name, because you don't name your plumbing.**
+
+## Rationale
+
+Most schema libraries optimize for one of two things: runtime validation (Joi, Ajv)
+or compile-time type integration (Zod, Valibot). Both are useful, and if you're
+building a single application in TypeScript with a shared type definition between
+producer and consumer, Zod is probably what you want.
+
+This library optimizes for something different: **expressive runtime contracts between
+subsystems that don't know about each other.**  
+
+You can think of it like having a toolkit for composing rich runtime-enforced interfaces
+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)._
+
+## License
+
+Copyright 2026 Version Zero | github.com/argh
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this library except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@versionzero/schema",
+  "version": "1.0.0",
+  "description": "A composable schema library that supports asynchronous processing",
+  "license": "Apache-2.0",
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
+  },
+  "author": "Jolly Roger <argh@v0.net> (https://github.com/argh)",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/argh/schema.git"
+  },
+  "keywords": [
+    "schema",
+    "argh",
+    "versionzero",
+    "v0"
+  ],
+  "type": "module",
+  "engines": {
+    "node": ">=19",
+    "tsc": ">=5.5"
+  },
+  "sideEffects": [
+    "./src/core-library/**",
+    "./src/core-library-node/**"
+  ],
+  "main": "./src/index.js",
+  "files": [
+    "src/**",
+    "types/**",
+    "LICENSE",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "default": "./src/index.js",
+      "types": "./types/index.d.ts"
+    },
+    "./helpers": {
+      "default": "./src/helpers/index.js",
+      "types": "./types/helpers/index.d.ts"
+    },
+    "./errors": {
+      "default": "./src/errors.js",
+      "types": "./types/errors/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build:types": "tsc --declaration --emitDeclarationOnly",
+    "test": "mocha",
+    "test:bail": "mocha -b",
+    "test:coverage": "c8 mocha --ignore 'test/99-*.test.js'",
+    "docs:api": "typedoc",
+    "docs:api:json": "typedoc --json docs-output/api.json",
+    "docs:api:contributors": "typedoc --excludeInternal false --excludePrivate false --out docs-output-contributors",
+    "docs:api:contributors:json": "typedoc --excludeInternal false --excludePrivate false --json docs-output-contributors/api.json",
+    "docs:api:md": "typedoc --options typedoc-md.json",
+    "docs:api:md:contributors": "typedoc --options typedoc-md.json --excludeInternal false --excludePrivate false --out docs-output-md-contributors",
+    "docs:processors": "node scripts/extract-processor-docs.js",
+    "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"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.60.0",
+    "@stylistic/eslint-plugin": "^5.6.1",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.19.10",
+    "c8": "^8.0.1",
+    "eslint": "^9.39.1",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsdoc": "^62.5.4",
+    "mocha": "^11.7.4",
+    "serve": "^14.2.6",
+    "typedoc": "^0.28.16",
+    "typedoc-plugin-markdown": "^4.9.0",
+    "typedoc-plugin-missing-exports": "^4.1.2",
+    "typescript": "~5.8"
+  }
+}

package/src/compilation/handler-compilation.js

@@ -0,0 +1,28 @@
+import { CompiledSchema } from "../compiled-schema.js";
+import { SchemaCompiler } from "../schema-compiler.js";
+import { SchemaLocation } from "../schema-location.js";
+import { isEmpty } from '../helpers/object.js';
+
+/**
+ *
+ * @param {CompiledSchema} cs
+ * @param {any} _
+ * @param {SchemaLocation} location
+ * @param {object} transformOptions
+ * @returns {CompiledSchema}
+ * @this {SchemaCompiler}
+ */
+export function compileHandlers(cs, _, location, transformOptions) {
+  const compiler = this;
+  for (const handler of Object.keys(cs.handlers)) {
+    const h = cs.handlers[handler];
+    if (!isEmpty(h)) {
+      cs._setValueProcessor(handler,
+        this.resolver.compileValueProcessorSpec(
+          compiler,
+          h.length === 1? h[0] : {$pipeline: h},
+          true));
+    }
+  }
+  return cs;
+}

package/src/compilation/metadata-compilation.js

@@ -0,0 +1,35 @@
+import { CompiledSchema } from "../compiled-schema.js";
+import { formatArgumentType, formatValue } from '../helpers/format.js';
+
+/**
+ * @param {CompiledSchema} schema
+ * @returns {CompiledSchema}
+ */
+export function populateMetadata(schema) {
+  if (!schema.metadata.validatorDescription && schema.handlers.validators?.length) {
+    const descriptions = schema.handlers.validators.map(vd => vd.description ?? '').filter(Boolean);
+    // this is used below in formatArgumentType...
+    schema.metadata.validatorDescription = descriptions.length > 1
+                                           ? descriptions.map(d => (d.includes('|') || d.includes('&')) ? `(${d})` : d).join(' >> ')
+                                           : descriptions[0];
+  }
+
+  if (!schema.metadata.valueDescription) {
+    const valueDescription = formatArgumentType(schema);
+    schema.metadata.valueDescription = schema.required ? `<${valueDescription}>` : `[${valueDescription}]`;
+  }
+  if (!schema.metadata.valueName) {
+    schema.metadata.valueName = schema.metadata.parserTypeHint ?? 'value';
+  }
+
+  if (schema.options.default !== undefined && schema.metadata.defaultValueDescription === undefined) {
+    if (typeof schema.options.default === 'function') {
+      // by default, suppress this.
+      schema.metadata.defaultValueDescription = '';
+    }
+    else {
+      schema.metadata.defaultValueDescription = formatValue(schema.options.default);
+    }
+  }
+  return schema;
+}