@formspec/build 0.1.0-alpha.15 → 0.1.0-alpha.17

package/dist/browser.cjs

@@ -380,6 +380,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.annotations && typeDef.annotations.length > 0) {
+      applyAnnotations(ctx.defs[name], typeDef.annotations, ctx);
+    }
   }
   const properties = {};
   const required = [];
@@ -391,6 +394,9 @@ function generateJsonSchemaFromIR(ir, options) {
     properties,
     ...uniqueRequired.length > 0 && { required: uniqueRequired }
   };
+  if (ir.annotations && ir.annotations.length > 0) {
+    applyAnnotations(result, ir.annotations, ctx);
+  }
   if (Object.keys(ctx.defs).length > 0) {
     result.$defs = ctx.defs;
   }
@@ -420,22 +426,51 @@ function collectFields(elements, properties, required, ctx) {
 }
 function generateFieldSchema(field, ctx) {
   const schema = generateTypeNode(field.type, ctx);
+  const itemStringSchema = schema.type === "array" && schema.items?.type === "string" ? schema.items : void 0;
   const directConstraints = [];
+  const itemConstraints = [];
   const pathConstraints = [];
   for (const c of field.constraints) {
     if (c.path) {
       pathConstraints.push(c);
+    } else if (itemStringSchema !== void 0 && isStringItemConstraint(c)) {
+      itemConstraints.push(c);
     } else {
       directConstraints.push(c);
     }
   }
   applyConstraints(schema, directConstraints, ctx);
-  applyAnnotations(schema, field.annotations, ctx);
+  if (itemStringSchema !== void 0) {
+    applyConstraints(itemStringSchema, itemConstraints, ctx);
+  }
+  const rootAnnotations = [];
+  const itemAnnotations = [];
+  for (const annotation of field.annotations) {
+    if (itemStringSchema !== void 0 && annotation.annotationKind === "format") {
+      itemAnnotations.push(annotation);
+    } else {
+      rootAnnotations.push(annotation);
+    }
+  }
+  applyAnnotations(schema, rootAnnotations, ctx);
+  if (itemStringSchema !== void 0) {
+    applyAnnotations(itemStringSchema, itemAnnotations, ctx);
+  }
   if (pathConstraints.length === 0) {
     return schema;
   }
   return applyPathTargetedConstraints(schema, pathConstraints, ctx);
 }
+function isStringItemConstraint(constraint) {
+  switch (constraint.constraintKind) {
+    case "minLength":
+    case "maxLength":
+    case "pattern":
+      return true;
+    default:
+      return false;
+  }
+}
 function applyPathTargetedConstraints(schema, pathConstraints, ctx) {
   if (schema.type === "array" && schema.items) {
     schema.items = applyPathTargetedConstraints(schema.items, pathConstraints, ctx);
@@ -653,6 +688,9 @@ function applyConstraints(schema, constraints, ctx) {
       case "uniqueItems":
         schema.uniqueItems = constraint.value;
         break;
+      case "const":
+        schema.const = constraint.value;
+        break;
       case "allowedMembers":
         break;
       case "custom":
@@ -677,8 +715,14 @@ function applyAnnotations(schema, annotations, ctx) {
       case "defaultValue":
         schema.default = annotation.value;
         break;
+      case "format":
+        schema.format = annotation.value;
+        break;
       case "deprecated":
         schema.deprecated = true;
+        if (annotation.message !== void 0 && annotation.message !== "") {
+          schema["x-formspec-deprecation-description"] = annotation.message;
+        }
         break;
       case "placeholder":
         break;
@@ -710,7 +754,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);
@@ -722,7 +771,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
@@ -866,25 +930,31 @@ function createShowRule(fieldName, value) {
     }
   };
 }
+function flattenConditionSchema(scope, schema) {
+  if (schema.allOf === void 0) {
+    if (scope === "#") {
+      return [schema];
+    }
+    const fieldName = scope.replace("#/properties/", "");
+    return [
+      {
+        properties: {
+          [fieldName]: schema
+        }
+      }
+    ];
+  }
+  return schema.allOf.flatMap((member) => flattenConditionSchema(scope, member));
+}
 function combineRules(parentRule, childRule) {
-  const parentCondition = parentRule.condition;
-  const childCondition = childRule.condition;
   return {
     effect: "SHOW",
     condition: {
       scope: "#",
       schema: {
         allOf: [
-          {
-            properties: {
-              [parentCondition.scope.replace("#/properties/", "")]: parentCondition.schema
-            }
-          },
-          {
-            properties: {
-              [childCondition.scope.replace("#/properties/", "")]: childCondition.schema
-            }
-          }
+          ...flattenConditionSchema(parentRule.condition.scope, parentRule.condition.schema),
+          ...flattenConditionSchema(childRule.condition.scope, childRule.condition.schema)
         ]
       }
     }
@@ -892,10 +962,14 @@ function combineRules(parentRule, childRule) {
 }
 function fieldNodeToControl(field, parentRule) {
   const displayNameAnnotation = field.annotations.find((a) => a.annotationKind === "displayName");
+  const placeholderAnnotation = field.annotations.find((a) => a.annotationKind === "placeholder");
   const control = {
     type: "Control",
     scope: fieldToScope(field.name),
     ...displayNameAnnotation !== void 0 && { label: displayNameAnnotation.value },
+    ...placeholderAnnotation !== void 0 && {
+      options: { placeholder: placeholderAnnotation.value }
+    },
     ...parentRule !== void 0 && { rule: parentRule }
   };
   return control;
@@ -961,7 +1035,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) {
@@ -971,6 +1048,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) {
@@ -982,6 +1080,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}`;
@@ -995,7 +1104,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)
   };
 }
@@ -1063,6 +1175,7 @@ var jsonSchema7Schema = import_zod3.z.lazy(
 );
 
 // src/validate/constraint-validator.ts
+var import_core3 = require("@formspec/core");
 function addContradiction(ctx, message, primary, related) {
   ctx.diagnostics.push({
     code: "CONTRADICTING_CONSTRAINTS",
@@ -1090,6 +1203,15 @@ function addUnknownExtension(ctx, message, primary) {
     relatedLocations: []
   });
 }
+function addUnknownPathTarget(ctx, message, primary) {
+  ctx.diagnostics.push({
+    code: "UNKNOWN_PATH_TARGET",
+    message,
+    severity: "error",
+    primaryLocation: primary,
+    relatedLocations: []
+  });
+}
 function addConstraintBroadening(ctx, message, primary, related) {
   ctx.diagnostics.push({
     code: "CONSTRAINT_BROADENING",
@@ -1099,6 +1221,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);
 }
@@ -1110,6 +1239,45 @@ function findAllowedMembers(constraints) {
     (c) => c.constraintKind === "allowedMembers"
   );
 }
+function findConstConstraints(constraints) {
+  return constraints.filter(
+    (c) => c.constraintKind === "const"
+  );
+}
+function jsonValueEquals(left, right) {
+  if (left === right) {
+    return true;
+  }
+  if (Array.isArray(left) || Array.isArray(right)) {
+    if (!Array.isArray(left) || !Array.isArray(right) || left.length !== right.length) {
+      return false;
+    }
+    return left.every((item, index) => jsonValueEquals(item, right[index]));
+  }
+  if (isJsonObject(left) || isJsonObject(right)) {
+    if (!isJsonObject(left) || !isJsonObject(right)) {
+      return false;
+    }
+    const leftKeys = Object.keys(left).sort();
+    const rightKeys = Object.keys(right).sort();
+    if (leftKeys.length !== rightKeys.length) {
+      return false;
+    }
+    return leftKeys.every((key, index) => {
+      const rightKey = rightKeys[index];
+      if (rightKey !== key) {
+        return false;
+      }
+      const leftValue = left[key];
+      const rightValue = right[rightKey];
+      return leftValue !== void 0 && rightValue !== void 0 && jsonValueEquals(leftValue, rightValue);
+    });
+  }
+  return false;
+}
+function isJsonObject(value) {
+  return typeof value === "object" && value !== null && !Array.isArray(value);
+}
 function isOrderedBoundConstraint(constraint) {
   return constraint.constraintKind === "minimum" || constraint.constraintKind === "exclusiveMinimum" || constraint.constraintKind === "minLength" || constraint.constraintKind === "minItems" || constraint.constraintKind === "maximum" || constraint.constraintKind === "exclusiveMaximum" || constraint.constraintKind === "maxLength" || constraint.constraintKind === "maxItems";
 }
@@ -1230,6 +1398,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");
@@ -1316,6 +1590,25 @@ function checkAllowedMembersContradiction(ctx, fieldName, constraints) {
     }
   }
 }
+function checkConstContradictions(ctx, fieldName, constraints) {
+  const constConstraints = findConstConstraints(constraints);
+  if (constConstraints.length < 2) return;
+  const first = constConstraints[0];
+  if (first === void 0) return;
+  for (let i = 1; i < constConstraints.length; i++) {
+    const current = constConstraints[i];
+    if (current === void 0) continue;
+    if (jsonValueEquals(first.value, current.value)) {
+      continue;
+    }
+    addContradiction(
+      ctx,
+      `Field "${fieldName}": conflicting @const constraints require both ${JSON.stringify(first.value)} and ${JSON.stringify(current.value)}`,
+      first.provenance,
+      current.provenance
+    );
+  }
+}
 function typeLabel(type) {
   switch (type.kind) {
     case "primitive":
@@ -1388,6 +1681,8 @@ function checkConstraintOnType(ctx, fieldName, type, constraint) {
   const isString = effectiveType.kind === "primitive" && effectiveType.primitiveKind === "string";
   const isArray = effectiveType.kind === "array";
   const isEnum = effectiveType.kind === "enum";
+  const arrayItemType = effectiveType.kind === "array" ? dereferenceType(ctx, effectiveType.items) : void 0;
+  const isStringArray = arrayItemType?.kind === "primitive" && arrayItemType.primitiveKind === "string";
   const label = typeLabel(effectiveType);
   const ck = constraint.constraintKind;
   switch (ck) {
@@ -1408,10 +1703,10 @@ function checkConstraintOnType(ctx, fieldName, type, constraint) {
     case "minLength":
     case "maxLength":
     case "pattern": {
-      if (!isString) {
+      if (!isString && !isStringArray) {
         addTypeMismatch(
           ctx,
-          `Field "${fieldName}": constraint "${ck}" is only valid on string fields, but field type is "${label}"`,
+          `Field "${fieldName}": constraint "${ck}" is only valid on string fields or string array items, but field type is "${label}"`,
           constraint.provenance
         );
       }
@@ -1439,6 +1734,37 @@ function checkConstraintOnType(ctx, fieldName, type, constraint) {
       }
       break;
     }
+    case "const": {
+      const isPrimitiveConstType = effectiveType.kind === "primitive" && ["string", "number", "boolean", "null"].includes(effectiveType.primitiveKind) || effectiveType.kind === "enum";
+      if (!isPrimitiveConstType) {
+        addTypeMismatch(
+          ctx,
+          `Field "${fieldName}": constraint "const" is only valid on primitive or enum fields, but field type is "${label}"`,
+          constraint.provenance
+        );
+        break;
+      }
+      if (effectiveType.kind === "primitive") {
+        const valueType = constraint.value === null ? "null" : Array.isArray(constraint.value) ? "array" : typeof constraint.value;
+        if (valueType !== effectiveType.primitiveKind) {
+          addTypeMismatch(
+            ctx,
+            `Field "${fieldName}": @const value type "${valueType}" is incompatible with field type "${effectiveType.primitiveKind}"`,
+            constraint.provenance
+          );
+        }
+        break;
+      }
+      const memberValues = effectiveType.members.map((member) => member.value);
+      if (!memberValues.some((member) => jsonValueEquals(member, constraint.value))) {
+        addTypeMismatch(
+          ctx,
+          `Field "${fieldName}": @const value ${JSON.stringify(constraint.value)} is not one of the enum members`,
+          constraint.provenance
+        );
+      }
+      break;
+    }
     case "custom": {
       checkCustomConstraint(ctx, fieldName, effectiveType, constraint);
       break;
@@ -1457,9 +1783,9 @@ function checkTypeApplicability(ctx, fieldName, type, constraints) {
       const resolution = resolvePathTargetType(ctx, type, constraint.path.segments);
       const targetFieldName = formatPathTargetFieldName(fieldName, constraint.path.segments);
       if (resolution.kind === "missing-property") {
-        addTypeMismatch(
+        addUnknownPathTarget(
           ctx,
-          `Field "${fieldName}": path-targeted constraint "${constraint.constraintKind}" references unknown path segment "${resolution.segment}"`,
+          `Field "${targetFieldName}": path-targeted constraint "${constraint.constraintKind}" references unknown path segment "${resolution.segment}"`,
           constraint.provenance
         );
         continue;
@@ -1489,8 +1815,30 @@ function checkCustomConstraint(ctx, fieldName, type, constraint) {
     );
     return;
   }
-  if (registration.applicableTypes === null) return;
-  if (!registration.applicableTypes.includes(type.kind)) {
+  const normalizedTagName = constraint.provenance.tagName === void 0 ? void 0 : (0, import_core3.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 && tagRegistration.registration.isApplicableToType?.(type) === false) {
+      addTypeMismatch(
+        ctx,
+        `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
+        constraint.provenance
+      );
+      return;
+    }
+  }
+  if (registration.applicableTypes === null) {
+    if (registration.isApplicableToType?.(type) === false) {
+      addTypeMismatch(
+        ctx,
+        `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
+        constraint.provenance
+      );
+    }
+    return;
+  }
+  if (!registration.applicableTypes.includes(type.kind) || registration.isApplicableToType?.(type) === false) {
     addTypeMismatch(
       ctx,
       `Field "${fieldName}": custom constraint "${constraint.constraintId}" is not applicable to type "${typeLabel(type)}"`,
@@ -1519,7 +1867,9 @@ function validateConstraints(ctx, name, type, constraints) {
   checkNumericContradictions(ctx, name, constraints);
   checkLengthContradictions(ctx, name, 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) {