schemair 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file 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/README.md

@@ -1,3 +1,137 @@
-# Temporary Holding Version
+# SchemaIR for TypeScript
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The `schemair` package is the TypeScript implementation of SchemaIR. It exports
+model types, definition and payload validators, assignability checks, a type
+expression interpreter, and authoring builders. For the language-independent
+model and evaluation rules, start with the
+[project README](https://github.com/schemair/schemair#readme) and
+[protocol](https://github.com/schemair/schemair/tree/main/spec).
+
+## Install
+
+Once the package is published:
+
+```sh
+pnpm add schemair
+```
+
+Until then, run `pnpm install` in this directory to work with the repository
+copy. The package is configured to publish ESM `.js` files for `import` and
+CJS `.cjs` files for `require`, with matching TypeScript declarations.
+
+## Define and validate a schema
+
+Builders return ordinary serializable objects. You can also write the same
+`SchemaNode` data directly or read it from JSON. Validate untrusted definitions
+before using them.
+
+```ts
+import { record, requiredField, string } from 'schemair/authoring';
+import { validateSchemaNodeDefinition } from 'schemair/definition';
+import { validatePayload } from 'schemair/payload';
+
+const user = record([requiredField('name', string())]);
+const definition = validateSchemaNodeDefinition(user);
+if (!definition.ok) throw new Error(definition.issues[0]?.message);
+
+const result = validatePayload({ name: 'Ada' }, user);
+if (result.status !== 'accepted') console.error(result.issues);
+```
+
+`validateSchemaNodeDefinition` returns `{ ok: true, node, issues: [] }` or
+`{ ok: false, issues }`. Payload validation returns `accepted`, `rejected`, or
+`unknown`. When a schema uses references, semantics, or constraints, pass the
+needed `resolveRef`, `semanticProvider`, or `constraintProvider` in the payload
+context. Missing capabilities can produce `unknown`.
+
+## Compare types
+
+`checkSchemaRelation(source, target)` asks whether values admitted by the
+source can be used where the target is expected.
+
+```ts
+import { string } from 'schemair/authoring';
+import { checkSchemaRelation } from 'schemair/relations';
+
+const relation = checkSchemaRelation(string(), string());
+if (relation.status === 'assignable') {
+  // The source can be connected to the target.
+}
+```
+
+The result is `assignable`, `incompatible`, `unknown`, or `rejected`. Supply
+resolver and provider callbacks in the relation context when comparison needs
+external information.
+
+## Evaluate expressions
+
+The type interpreter calculates authoring-time expressions. An evaluated
+result always has a `term`; it also has `schema` when that term can be
+materialized as a `SchemaNode`.
+
+```ts
+import { arrayOf, string } from 'schemair/authoring';
+import { evaluateExpression } from 'schemair/type-interpreter';
+
+const result = evaluateExpression(arrayOf(string()));
+if (result.status === 'evaluated') {
+  console.log(result.term);
+  console.log(result.schema);
+}
+```
+
+Unbound type variables remain in the evaluated term and appear in
+`unresolvedTypeVars`. Other outcomes are `incomplete` and `rejected`, both
+with structured issues. `checkTypeTermRelation` compares expression terms;
+`solveTypeVariables` infers invocation-local bindings for generic ports.
+
+## Sync and async APIs
+
+Use synchronous calls with in-memory resolvers and providers. For database or
+network-backed capabilities, use the asynchronous companions:
+
+| Synchronous | Asynchronous |
+| --- | --- |
+| `validatePayload` | `validatePayloadAsync` |
+| `checkSchemaRelation` | `checkSchemaRelationAsync` |
+| `evaluateExpression` | `evaluateExpressionAsync` |
+| `checkTypeTermRelation` | `checkTypeTermRelationAsync` |
+| `solveTypeVariables` | `solveTypeVariablesAsync` |
+
+`validateSchemaNodeDefinition` is always synchronous. The async companions
+await caller-provided capabilities and use the same result categories as their
+sync counterparts.
+
+## Package entry points
+
+| Import path | Contents |
+| --- | --- |
+| `schemair` | Combined public API |
+| `schemair/spec` | Wire-model and expression types |
+| `schemair/definition` | Schema definition validation |
+| `schemair/payload` | Payload validation |
+| `schemair/relations` | SchemaNode assignability |
+| `schemair/type-interpreter` | Expression evaluation and type-term relations |
+| `schemair/authoring` | Data-construction helpers |
+
+`src/internal/` is not exported. The package provides no ref registry,
+semantic vocabulary implementation, persistence layer, graph scheduler, or
+target runtime.
+
+## Develop
+
+Run these commands from `typescript/`:
+
+```sh
+pnpm install
+pnpm typecheck
+pnpm test
+pnpm build
+pnpm test:package
+pnpm pack
+```
+
+`pnpm test` reads the shared vectors in `../conformance/` and runs focused API
+tests. `pnpm test:package` checks the built ESM and CJS entry points and their
+declarations. `pnpm pack` builds the package before creating an archive that
+contains `dist/` and package metadata.

package/dist/authoring/index.cjs

@@ -0,0 +1,351 @@
+
+//#region src/authoring/schema.ts
+function primitive(name, metadata) {
+	if (metadata === void 0) return {
+		kind: "primitive",
+		name
+	};
+	return {
+		kind: "primitive",
+		name,
+		...metadata
+	};
+}
+const string = (metadata) => primitive("string", metadata);
+const number = (metadata) => primitive("number", metadata);
+const boolean = () => primitive("boolean");
+const nullValue = () => primitive("null");
+function literal(value) {
+	return {
+		kind: "literal",
+		literal: value
+	};
+}
+function field(key, schema, options) {
+	return options === void 0 ? {
+		key,
+		schema
+	} : {
+		key,
+		schema,
+		...options
+	};
+}
+function requiredField(key, schema, description) {
+	return description === void 0 ? {
+		key,
+		schema,
+		required: true
+	} : {
+		key,
+		schema,
+		required: true,
+		description
+	};
+}
+function optionalField(key, schema, description) {
+	return description === void 0 ? {
+		key,
+		schema
+	} : {
+		key,
+		schema,
+		description
+	};
+}
+function record(fields, options) {
+	return options === void 0 ? {
+		kind: "record",
+		fields
+	} : {
+		kind: "record",
+		fields,
+		...options
+	};
+}
+function array(elementSchema, options) {
+	return options === void 0 ? {
+		kind: "array",
+		elementSchema
+	} : {
+		kind: "array",
+		elementSchema,
+		...options
+	};
+}
+function tuple(elementSchemas) {
+	return {
+		kind: "tuple",
+		elementSchemas
+	};
+}
+function literalUnion(values) {
+	return {
+		kind: "literalUnion",
+		values
+	};
+}
+function nullable(value) {
+	return {
+		kind: "nullable",
+		value
+	};
+}
+function variant(key, schema, options) {
+	return options === void 0 ? {
+		key,
+		schema
+	} : {
+		key,
+		schema,
+		...options
+	};
+}
+function taggedUnion(discriminator, variants) {
+	return {
+		kind: "taggedUnion",
+		discriminator,
+		variants
+	};
+}
+function ref(refPath) {
+	return {
+		kind: "ref",
+		refPath
+	};
+}
+function selfRef() {
+	return { kind: "selfRef" };
+}
+
+//#endregion
+//#region src/authoring/expression.ts
+function typeVar(name, upperBound) {
+	return upperBound === void 0 ? {
+		kind: "typeVar",
+		name
+	} : {
+		kind: "typeVar",
+		name,
+		extends: upperBound
+	};
+}
+function opaqueHostType(hostPath) {
+	return {
+		kind: "opaqueHostType",
+		hostPath
+	};
+}
+function absent() {
+	return { kind: "absent" };
+}
+function never() {
+	return { kind: "never" };
+}
+function unknown() {
+	return { kind: "unknown" };
+}
+function maybeAbsent(value) {
+	return {
+		kind: "maybeAbsent",
+		value
+	};
+}
+function arrayOf(element, constraints) {
+	return constraints === void 0 ? {
+		kind: "arrayOf",
+		element
+	} : {
+		kind: "arrayOf",
+		element,
+		constraints
+	};
+}
+function tupleOf(elements) {
+	return {
+		kind: "tupleOf",
+		elements
+	};
+}
+function recordOf(fields, options) {
+	return options === void 0 ? {
+		kind: "recordOf",
+		fields
+	} : {
+		kind: "recordOf",
+		fields,
+		...options
+	};
+}
+function nullableOf(value) {
+	return {
+		kind: "nullableOf",
+		value
+	};
+}
+function taggedUnionOf(discriminator, variants) {
+	return {
+		kind: "taggedUnionOf",
+		discriminator,
+		variants
+	};
+}
+function elementOf(source) {
+	return {
+		kind: "elementOf",
+		source
+	};
+}
+function valueOf(source) {
+	return {
+		kind: "valueOf",
+		source
+	};
+}
+function elementAt(source, index) {
+	return {
+		kind: "elementAt",
+		source,
+		index
+	};
+}
+function fieldOf(source, key) {
+	return {
+		kind: "fieldOf",
+		source,
+		key
+	};
+}
+function keyOf(source) {
+	return {
+		kind: "keyOf",
+		source
+	};
+}
+function allFields() {
+	return { kind: "all" };
+}
+function selectKeys(keys, onMissing = "error") {
+	return {
+		kind: "keys",
+		keys,
+		onMissing
+	};
+}
+function fieldsOf(source, fields) {
+	return {
+		kind: "fieldsOf",
+		source,
+		fields
+	};
+}
+function pickFields(source, fields) {
+	return {
+		kind: "pickFields",
+		source,
+		fields
+	};
+}
+function omitFields(source, fields) {
+	return {
+		kind: "omitFields",
+		source,
+		fields
+	};
+}
+function partialFields(source, fields) {
+	return {
+		kind: "partialFields",
+		source,
+		fields
+	};
+}
+function requiredFields(source, fields) {
+	return {
+		kind: "requiredFields",
+		source,
+		fields
+	};
+}
+function mergeRecords(sources, conflict) {
+	return {
+		kind: "mergeRecords",
+		sources,
+		conflict
+	};
+}
+function intersect(sources) {
+	return {
+		kind: "intersect",
+		sources
+	};
+}
+function refine(source, fields) {
+	return {
+		kind: "refine",
+		source,
+		fields
+	};
+}
+function excludeVariants(source, variants) {
+	return {
+		kind: "excludeVariants",
+		source,
+		variants
+	};
+}
+function extractVariants(source, variants) {
+	return {
+		kind: "extractVariants",
+		source,
+		variants
+	};
+}
+
+//#endregion
+exports.absent = absent;
+exports.allFields = allFields;
+exports.array = array;
+exports.arrayOf = arrayOf;
+exports.boolean = boolean;
+exports.elementAt = elementAt;
+exports.elementOf = elementOf;
+exports.excludeVariants = excludeVariants;
+exports.extractVariants = extractVariants;
+exports.field = field;
+exports.fieldOf = fieldOf;
+exports.fieldsOf = fieldsOf;
+exports.intersect = intersect;
+exports.keyOf = keyOf;
+exports.literal = literal;
+exports.literalUnion = literalUnion;
+exports.maybeAbsent = maybeAbsent;
+exports.mergeRecords = mergeRecords;
+exports.never = never;
+exports.nullValue = nullValue;
+exports.nullable = nullable;
+exports.nullableOf = nullableOf;
+exports.number = number;
+exports.omitFields = omitFields;
+exports.opaqueHostType = opaqueHostType;
+exports.optionalField = optionalField;
+exports.partialFields = partialFields;
+exports.pickFields = pickFields;
+exports.primitive = primitive;
+exports.record = record;
+exports.recordOf = recordOf;
+exports.ref = ref;
+exports.refine = refine;
+exports.requiredField = requiredField;
+exports.requiredFields = requiredFields;
+exports.selectKeys = selectKeys;
+exports.selfRef = selfRef;
+exports.string = string;
+exports.taggedUnion = taggedUnion;
+exports.taggedUnionOf = taggedUnionOf;
+exports.tuple = tuple;
+exports.tupleOf = tupleOf;
+exports.typeVar = typeVar;
+exports.unknown = unknown;
+exports.valueOf = valueOf;
+exports.variant = variant;