@formspec/build 0.1.0-alpha.16 → 0.1.0-alpha.19

package/dist/browser.js

@@ -20,6 +20,7 @@ function canonicalizeChainDSL(form) {
     kind: "form-ir",
     irVersion: IR_VERSION,
     elements: canonicalizeElements(form.elements),
+    rootAnnotations: [],
     typeRegistry: {},
     provenance: CHAIN_DSL_PROVENANCE
   };
@@ -330,6 +331,9 @@ function generateJsonSchemaFromIR(ir, options) {
   const ctx = makeContext(options);
   for (const [name, typeDef] of Object.entries(ir.typeRegistry)) {
     ctx.defs[name] = generateTypeNode(typeDef.type, ctx);
+    if (typeDef.constraints && typeDef.constraints.length > 0) {
+      applyConstraints(ctx.defs[name], typeDef.constraints, ctx);
+    }
     if (typeDef.annotations && typeDef.annotations.length > 0) {
       applyAnnotations(ctx.defs[name], typeDef.annotations, ctx);
     }
@@ -498,7 +502,9 @@ function generateTypeNode(type, ctx) {
   }
 }
 function generatePrimitiveType(type) {
-  return { type: type.primitiveKind };
+  return {
+    type: type.primitiveKind === "integer" || type.primitiveKind === "bigint" ? "integer" : type.primitiveKind
+  };
 }
 function generateEnumType(type) {
   const hasDisplayNames = type.members.some((m) => m.displayName !== void 0);
@@ -671,7 +677,7 @@ function applyAnnotations(schema, annotations, ctx) {
       case "deprecated":
         schema.deprecated = true;
         if (annotation.message !== void 0 && annotation.message !== "") {
-          schema["x-formspec-deprecation-description"] = annotation.message;
+          schema[`${ctx.vendorPrefix}-deprecation-description`] = annotation.message;
         }
         break;
       case "placeholder":
@@ -704,7 +710,12 @@ function applyCustomConstraint(schema, constraint, ctx) {
       `Cannot generate JSON Schema for custom constraint "${constraint.constraintId}" without a matching extension registration`
     );
   }
-  Object.assign(schema, registration.toJsonSchema(constraint.payload, ctx.vendorPrefix));
+  assignVendorPrefixedExtensionKeywords(
+    schema,
+    registration.toJsonSchema(constraint.payload, ctx.vendorPrefix),
+    ctx.vendorPrefix,
+    `custom constraint "${constraint.constraintId}"`
+  );
 }
 function applyCustomAnnotation(schema, annotation, ctx) {
   const registration = ctx.extensionRegistry?.findAnnotation(annotation.annotationId);
@@ -716,7 +727,22 @@ function applyCustomAnnotation(schema, annotation, ctx) {
   if (registration.toJsonSchema === void 0) {
     return;
   }
-  Object.assign(schema, registration.toJsonSchema(annotation.value, ctx.vendorPrefix));
+  assignVendorPrefixedExtensionKeywords(
+    schema,
+    registration.toJsonSchema(annotation.value, ctx.vendorPrefix),
+    ctx.vendorPrefix,
+    `custom annotation "${annotation.annotationId}"`
+  );
+}
+function assignVendorPrefixedExtensionKeywords(schema, extensionSchema, vendorPrefix, source) {
+  for (const [key, value] of Object.entries(extensionSchema)) {
+    if (!key.startsWith(`${vendorPrefix}-`)) {
+      throw new Error(
+        `Cannot apply ${source}: extension hooks may only emit "${vendorPrefix}-*" JSON Schema keywords`
+      );
+    }
+    schema[key] = value;
+  }
 }
 
 // src/json-schema/generator.ts
@@ -965,7 +991,10 @@ function getSchemaExtension(schema, key) {
 // src/extensions/registry.ts
 function createExtensionRegistry(extensions) {
   const typeMap = /* @__PURE__ */ new Map();
+  const typeNameMap = /* @__PURE__ */ new Map();
   const constraintMap = /* @__PURE__ */ new Map();
+  const constraintTagMap = /* @__PURE__ */ new Map();
+  const builtinBroadeningMap = /* @__PURE__ */ new Map();
   const annotationMap = /* @__PURE__ */ new Map();
   for (const ext of extensions) {
     if (ext.types !== void 0) {
@@ -975,6 +1004,27 @@ function createExtensionRegistry(extensions) {
           throw new Error(`Duplicate custom type ID: "${qualifiedId}"`);
         }
         typeMap.set(qualifiedId, type);
+        for (const sourceTypeName of type.tsTypeNames ?? [type.typeName]) {
+          if (typeNameMap.has(sourceTypeName)) {
+            throw new Error(`Duplicate custom type source name: "${sourceTypeName}"`);
+          }
+          typeNameMap.set(sourceTypeName, {
+            extensionId: ext.extensionId,
+            registration: type
+          });
+        }
+        if (type.builtinConstraintBroadenings !== void 0) {
+          for (const broadening of type.builtinConstraintBroadenings) {
+            const key = `${qualifiedId}:${broadening.tagName}`;
+            if (builtinBroadeningMap.has(key)) {
+              throw new Error(`Duplicate built-in constraint broadening: "${key}"`);
+            }
+            builtinBroadeningMap.set(key, {
+              extensionId: ext.extensionId,
+              registration: broadening
+            });
+          }
+        }
       }
     }
     if (ext.constraints !== void 0) {
@@ -986,6 +1036,17 @@ function createExtensionRegistry(extensions) {
         constraintMap.set(qualifiedId, constraint);
       }
     }
+    if (ext.constraintTags !== void 0) {
+      for (const tag of ext.constraintTags) {
+        if (constraintTagMap.has(tag.tagName)) {
+          throw new Error(`Duplicate custom constraint tag: "@${tag.tagName}"`);
+        }
+        constraintTagMap.set(tag.tagName, {
+          extensionId: ext.extensionId,
+          registration: tag
+        });
+      }
+    }
     if (ext.annotations !== void 0) {
       for (const annotation of ext.annotations) {
         const qualifiedId = `${ext.extensionId}/${annotation.annotationName}`;
@@ -999,7 +1060,10 @@ function createExtensionRegistry(extensions) {
   return {
     extensions,
     findType: (typeId) => typeMap.get(typeId),
+    findTypeByName: (typeName) => typeNameMap.get(typeName),
     findConstraint: (constraintId) => constraintMap.get(constraintId),
+    findConstraintTag: (tagName) => constraintTagMap.get(tagName),
+    findBuiltinConstraintBroadening: (typeId, tagName) => builtinBroadeningMap.get(`${typeId}:${tagName}`),
     findAnnotation: (annotationId) => annotationMap.get(annotationId)
   };
 }
@@ -1067,6 +1131,7 @@ var jsonSchema7Schema = z3.lazy(
 );
 
 // src/validate/constraint-validator.ts
+import { normalizeConstraintTagName } from "@formspec/core";
 function addContradiction(ctx, message, primary, related) {
   ctx.diagnostics.push({
     code: "CONTRADICTING_CONSTRAINTS",
@@ -1112,6 +1177,13 @@ function addConstraintBroadening(ctx, message, primary, related) {
     relatedLocations: [related]
   });
 }
+function getExtensionIdFromConstraintId(constraintId) {
+  const separator = constraintId.lastIndexOf("/");
+  if (separator <= 0) {
+    return null;
+  }
+  return constraintId.slice(0, separator);
+}
 function findNumeric(constraints, constraintKind) {
   return constraints.find((c) => c.constraintKind === constraintKind);
 }
@@ -1282,6 +1354,112 @@ function checkConstraintBroadening(ctx, fieldName, constraints) {
     strongestByKey.set(key, constraint);
   }
 }
+function compareCustomConstraintStrength(current, previous) {
+  const order = current.comparePayloads(current.constraint.payload, previous.constraint.payload);
+  const equalPayloadTiebreaker = order === 0 ? compareSemanticInclusivity(current.role.inclusive, previous.role.inclusive) : order;
+  switch (current.role.bound) {
+    case "lower":
+      return equalPayloadTiebreaker;
+    case "upper":
+      return equalPayloadTiebreaker === 0 ? 0 : -equalPayloadTiebreaker;
+    case "exact":
+      return order === 0 ? 0 : Number.NaN;
+    default: {
+      const _exhaustive = current.role.bound;
+      return _exhaustive;
+    }
+  }
+}
+function compareSemanticInclusivity(currentInclusive, previousInclusive) {
+  if (currentInclusive === previousInclusive) {
+    return 0;
+  }
+  return currentInclusive ? -1 : 1;
+}
+function customConstraintsContradict(lower, upper) {
+  const order = lower.comparePayloads(lower.constraint.payload, upper.constraint.payload);
+  if (order > 0) {
+    return true;
+  }
+  if (order < 0) {
+    return false;
+  }
+  return !lower.role.inclusive || !upper.role.inclusive;
+}
+function describeCustomConstraintTag(constraint) {
+  return constraint.provenance.tagName ?? constraint.constraintId;
+}
+function checkCustomConstraintSemantics(ctx, fieldName, constraints) {
+  if (ctx.extensionRegistry === void 0) {
+    return;
+  }
+  const strongestByKey = /* @__PURE__ */ new Map();
+  const lowerByFamily = /* @__PURE__ */ new Map();
+  const upperByFamily = /* @__PURE__ */ new Map();
+  for (const constraint of constraints) {
+    if (constraint.constraintKind !== "custom") {
+      continue;
+    }
+    const registration = ctx.extensionRegistry.findConstraint(constraint.constraintId);
+    if (registration?.comparePayloads === void 0 || registration.semanticRole === void 0) {
+      continue;
+    }
+    const entry = {
+      constraint,
+      comparePayloads: registration.comparePayloads,
+      role: registration.semanticRole
+    };
+    const familyKey = `${registration.semanticRole.family}:${pathKey(constraint)}`;
+    const boundKey = `${familyKey}:${registration.semanticRole.bound}`;
+    const previous = strongestByKey.get(boundKey);
+    if (previous !== void 0) {
+      const strength = compareCustomConstraintStrength(entry, previous);
+      if (Number.isNaN(strength)) {
+        addContradiction(
+          ctx,
+          `Field "${formatPathTargetFieldName(fieldName, constraint.path?.segments ?? [])}": ${describeCustomConstraintTag(constraint)} conflicts with ${describeCustomConstraintTag(previous.constraint)}`,
+          constraint.provenance,
+          previous.constraint.provenance
+        );
+        continue;
+      }
+      if (strength < 0) {
+        addConstraintBroadening(
+          ctx,
+          `Field "${formatPathTargetFieldName(fieldName, constraint.path?.segments ?? [])}": ${describeCustomConstraintTag(constraint)} is broader than earlier ${describeCustomConstraintTag(previous.constraint)}. Constraints can only narrow.`,
+          constraint.provenance,
+          previous.constraint.provenance
+        );
+        continue;
+      }
+      if (strength > 0) {
+        strongestByKey.set(boundKey, entry);
+      }
+    } else {
+      strongestByKey.set(boundKey, entry);
+    }
+    if (registration.semanticRole.bound === "lower") {
+      lowerByFamily.set(familyKey, strongestByKey.get(boundKey) ?? entry);
+    } else if (registration.semanticRole.bound === "upper") {
+      upperByFamily.set(familyKey, strongestByKey.get(boundKey) ?? entry);
+    }
+  }
+  for (const [familyKey, lower] of lowerByFamily) {
+    const upper = upperByFamily.get(familyKey);
+    if (upper === void 0) {
+      continue;
+    }
+    if (!customConstraintsContradict(lower, upper)) {
+      continue;
+    }
+    addContradiction(
+      ctx,
+      `Field "${formatPathTargetFieldName(fieldName, lower.constraint.path?.segments ?? [])}": ${describeCustomConstraintTag(lower.constraint)} contradicts ${describeCustomConstraintTag(upper.constraint)}`,
+      lower.constraint.provenance,
+      upper.constraint.provenance
+    );
+  }
+}
 function checkNumericContradictions(ctx, fieldName, constraints) {
   const min = findNumeric(constraints, "minimum");
   const max = findNumeric(constraints, "maximum");
@@ -1429,6 +1607,26 @@ function dereferenceType(ctx, type) {
   }
   return current;
 }
+function collectReferencedTypeConstraints(ctx, type) {
+  const collected = [];
+  let current = type;
+  const seen = /* @__PURE__ */ new Set();
+  while (current.kind === "reference") {
+    if (seen.has(current.name)) {
+      break;
+    }
+    seen.add(current.name);
+    const definition = ctx.typeRegistry[current.name];
+    if (definition === void 0) {
+      break;
+    }
+    if (definition.constraints !== void 0) {
+      collected.push(...definition.constraints);
+    }
+    current = definition.type;
+  }
+  return collected;
+}
 function resolvePathTargetType(ctx, type, segments) {
   const effectiveType = dereferenceType(ctx, type);
   if (segments.length === 0) {
@@ -1450,12 +1648,33 @@ function resolvePathTargetType(ctx, type, segments) {
   }
   return { kind: "unresolvable", type: effectiveType };
 }
+function isNullType(type) {
+  return type.kind === "primitive" && type.primitiveKind === "null";
+}
+function collectCustomConstraintCandidateTypes(ctx, type) {
+  const effectiveType = dereferenceType(ctx, type);
+  const candidates = [effectiveType];
+  if (effectiveType.kind === "array") {
+    candidates.push(...collectCustomConstraintCandidateTypes(ctx, effectiveType.items));
+  }
+  if (effectiveType.kind === "union") {
+    const memberTypes = effectiveType.members.map((member) => dereferenceType(ctx, member));
+    const nonNullMembers = memberTypes.filter((member) => !isNullType(member));
+    if (nonNullMembers.length === 1 && nonNullMembers.length < memberTypes.length) {
+      const [nullableMember] = nonNullMembers;
+      if (nullableMember !== void 0) {
+        candidates.push(...collectCustomConstraintCandidateTypes(ctx, nullableMember));
+      }
+    }
+  }
+  return candidates;
+}
 function formatPathTargetFieldName(fieldName, path) {
   return path.length === 0 ? fieldName : `${fieldName}.${path.join(".")}`;
 }
 function checkConstraintOnType(ctx, fieldName, type, constraint) {
   const effectiveType = dereferenceType(ctx, type);
-  const isNumber = effectiveType.kind === "primitive" && effectiveType.primitiveKind === "number";
+  const isNumber = effectiveType.kind === "primitive" && ["number", "integer", "bigint"].includes(effectiveType.primitiveKind);
   const isString = effectiveType.kind === "primitive" && effectiveType.primitiveKind === "string";
   const isArray = effectiveType.kind === "array";
   const isEnum = effectiveType.kind === "enum";
@@ -1513,7 +1732,9 @@ function checkConstraintOnType(ctx, fieldName, type, constraint) {
       break;
     }
     case "const": {
-      const isPrimitiveConstType = effectiveType.kind === "primitive" && ["string", "number", "boolean", "null"].includes(effectiveType.primitiveKind) || effectiveType.kind === "enum";
+      const isPrimitiveConstType = effectiveType.kind === "primitive" && ["string", "number", "integer", "bigint", "boolean", "null"].includes(
+        effectiveType.primitiveKind
+      ) || effectiveType.kind === "enum";
       if (!isPrimitiveConstType) {
         addTypeMismatch(
           ctx,
@@ -1524,7 +1745,8 @@ function checkConstraintOnType(ctx, fieldName, type, constraint) {
       }
       if (effectiveType.kind === "primitive") {
         const valueType = constraint.value === null ? "null" : Array.isArray(constraint.value) ? "array" : typeof constraint.value;
-        if (valueType !== effectiveType.primitiveKind) {
+        const expectedValueType = effectiveType.primitiveKind === "integer" || effectiveType.primitiveKind === "bigint" ? "number" : effectiveType.primitiveKind;
+        if (valueType !== expectedValueType) {
           addTypeMismatch(
             ctx,
             `Field "${fieldName}": @const value type "${valueType}" is incompatible with field type "${effectiveType.primitiveKind}"`,
@@ -1593,8 +1815,37 @@ function checkCustomConstraint(ctx, fieldName, type, constraint) {
     );
     return;
   }
-  if (registration.applicableTypes === null) return;
-  if (!registration.applicableTypes.includes(type.kind)) {
+  const candidateTypes = collectCustomConstraintCandidateTypes(ctx, type);
+  const normalizedTagName = constraint.provenance.tagName === void 0 ? void 0 : normalizeConstraintTagName(constraint.provenance.tagName.replace(/^@/, ""));
+  if (normalizedTagName !== void 0) {
+    const tagRegistration = ctx.extensionRegistry.findConstraintTag(normalizedTagName);
+    const extensionId = getExtensionIdFromConstraintId(constraint.constraintId);
+    if (extensionId !== null && tagRegistration?.extensionId === extensionId && tagRegistration.registration.constraintName === registration.constraintName && !candidateTypes.some(
+      (candidateType) => tagRegistration.registration.isApplicableToType?.(candidateType) !== false
+    )) {
+      addTypeMismatch(
+        ctx,
+        `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
+        constraint.provenance
+      );
+      return;
+    }
+  }
+  if (registration.applicableTypes === null) {
+    if (!candidateTypes.some((candidateType) => registration.isApplicableToType?.(candidateType) !== false)) {
+      addTypeMismatch(
+        ctx,
+        `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
+        constraint.provenance
+      );
+    }
+    return;
+  }
+  const applicableTypes = registration.applicableTypes;
+  const matchesApplicableType = candidateTypes.some(
+    (candidateType) => applicableTypes.includes(candidateType.kind) && registration.isApplicableToType?.(candidateType) !== false
+  );
+  if (!matchesApplicableType) {
     addTypeMismatch(
       ctx,
       `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
@@ -1603,7 +1854,10 @@ function checkCustomConstraint(ctx, fieldName, type, constraint) {
   }
 }
 function validateFieldNode(ctx, field) {
-  validateConstraints(ctx, field.name, field.type, field.constraints);
+  validateConstraints(ctx, field.name, field.type, [
+    ...collectReferencedTypeConstraints(ctx, field.type),
+    ...field.constraints
+  ]);
   if (field.type.kind === "object") {
     for (const prop of field.type.properties) {
       validateObjectProperty(ctx, field.name, prop);
@@ -1612,7 +1866,10 @@ function validateFieldNode(ctx, field) {
 }
 function validateObjectProperty(ctx, parentName, prop) {
   const qualifiedName = `${parentName}.${prop.name}`;
-  validateConstraints(ctx, qualifiedName, prop.type, prop.constraints);
+  validateConstraints(ctx, qualifiedName, prop.type, [
+    ...collectReferencedTypeConstraints(ctx, prop.type),
+    ...prop.constraints
+  ]);
   if (prop.type.kind === "object") {
     for (const nestedProp of prop.type.properties) {
       validateObjectProperty(ctx, qualifiedName, nestedProp);
@@ -1625,6 +1882,7 @@ function validateConstraints(ctx, name, type, constraints) {
   checkAllowedMembersContradiction(ctx, name, constraints);
   checkConstContradictions(ctx, name, constraints);
   checkConstraintBroadening(ctx, name, constraints);
+  checkCustomConstraintSemantics(ctx, name, constraints);
   checkTypeApplicability(ctx, name, type, constraints);
 }
 function validateElement(ctx, element) {