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

package/dist/index.cjs

@@ -34,7 +34,9 @@ __export(index_exports, {
   categorizationSchema: () => categorizationSchema,
   categorySchema: () => categorySchema,
   controlSchema: () => controlSchema,
+  createExtensionRegistry: () => createExtensionRegistry,
   generateJsonSchema: () => generateJsonSchema,
+  generateJsonSchemaFromIR: () => generateJsonSchemaFromIR,
   generateSchemas: () => generateSchemas,
   generateSchemasFromClass: () => generateSchemasFromClass,
   generateUiSchema: () => generateUiSchema,
@@ -236,7 +238,7 @@ function canonicalizeArrayField(field) {
   const itemsType = {
     kind: "object",
     properties: itemProperties,
-    additionalProperties: false
+    additionalProperties: true
   };
   const type = { kind: "array", items: itemsType };
   const constraints = [];
@@ -271,7 +273,7 @@ function canonicalizeObjectField(field) {
   const type = {
     kind: "object",
     properties,
-    additionalProperties: false
+    additionalProperties: true
   };
   return buildFieldNode(field.name, type, field.required, buildAnnotations(field.label));
 }
@@ -443,11 +445,21 @@ function wrapInConditional(field, layout, provenance) {
 }
 
 // src/json-schema/ir-generator.ts
-function makeContext() {
-  return { defs: {} };
+function makeContext(options) {
+  const vendorPrefix = options?.vendorPrefix ?? "x-formspec";
+  if (!vendorPrefix.startsWith("x-")) {
+    throw new Error(
+      `Invalid vendorPrefix "${vendorPrefix}". Extension JSON Schema keywords must start with "x-".`
+    );
+  }
+  return {
+    defs: {},
+    extensionRegistry: options?.extensionRegistry,
+    vendorPrefix
+  };
 }
-function generateJsonSchemaFromIR(ir) {
-  const ctx = makeContext();
+function generateJsonSchemaFromIR(ir, options) {
+  const ctx = makeContext(options);
   for (const [name, typeDef] of Object.entries(ir.typeRegistry)) {
     ctx.defs[name] = generateTypeNode(typeDef.type, ctx);
   }
@@ -499,16 +511,16 @@ function generateFieldSchema(field, ctx) {
       directConstraints.push(c);
     }
   }
-  applyConstraints(schema, directConstraints);
-  applyAnnotations(schema, field.annotations);
+  applyConstraints(schema, directConstraints, ctx);
+  applyAnnotations(schema, field.annotations, ctx);
   if (pathConstraints.length === 0) {
     return schema;
   }
-  return applyPathTargetedConstraints(schema, pathConstraints);
+  return applyPathTargetedConstraints(schema, pathConstraints, ctx);
 }
-function applyPathTargetedConstraints(schema, pathConstraints) {
+function applyPathTargetedConstraints(schema, pathConstraints, ctx) {
   if (schema.type === "array" && schema.items) {
-    schema.items = applyPathTargetedConstraints(schema.items, pathConstraints);
+    schema.items = applyPathTargetedConstraints(schema.items, pathConstraints, ctx);
     return schema;
   }
   const byTarget = /* @__PURE__ */ new Map();
@@ -522,7 +534,7 @@ function applyPathTargetedConstraints(schema, pathConstraints) {
   const propertyOverrides = {};
   for (const [target, constraints] of byTarget) {
     const subSchema = {};
-    applyConstraints(subSchema, constraints);
+    applyConstraints(subSchema, constraints, ctx);
     propertyOverrides[target] = subSchema;
   }
   if (schema.$ref) {
@@ -566,6 +578,8 @@ function generateTypeNode(type, ctx) {
       return generateArrayType(type, ctx);
     case "object":
       return generateObjectType(type, ctx);
+    case "record":
+      return generateRecordType(type, ctx);
     case "union":
       return generateUnionType(type, ctx);
     case "reference":
@@ -573,7 +587,7 @@ function generateTypeNode(type, ctx) {
     case "dynamic":
       return generateDynamicType(type);
     case "custom":
-      return generateCustomType(type);
+      return generateCustomType(type, ctx);
     default: {
       const _exhaustive = type;
       return _exhaustive;
@@ -622,16 +636,27 @@ function generateObjectType(type, ctx) {
   }
   return schema;
 }
+function generateRecordType(type, ctx) {
+  return {
+    type: "object",
+    additionalProperties: generateTypeNode(type.valueType, ctx)
+  };
+}
 function generatePropertySchema(prop, ctx) {
   const schema = generateTypeNode(prop.type, ctx);
-  applyConstraints(schema, prop.constraints);
-  applyAnnotations(schema, prop.annotations);
+  applyConstraints(schema, prop.constraints, ctx);
+  applyAnnotations(schema, prop.annotations, ctx);
   return schema;
 }
 function generateUnionType(type, ctx) {
   if (isBooleanUnion(type)) {
     return { type: "boolean" };
   }
+  if (isNullableUnion(type)) {
+    return {
+      oneOf: type.members.map((m) => generateTypeNode(m, ctx))
+    };
+  }
   return {
     anyOf: type.members.map((m) => generateTypeNode(m, ctx))
   };
@@ -641,6 +666,13 @@ function isBooleanUnion(type) {
   const kinds = type.members.map((m) => m.kind);
   return kinds.every((k) => k === "primitive") && type.members.every((m) => m.kind === "primitive" && m.primitiveKind === "boolean");
 }
+function isNullableUnion(type) {
+  if (type.members.length !== 2) return false;
+  const nullCount = type.members.filter(
+    (m) => m.kind === "primitive" && m.primitiveKind === "null"
+  ).length;
+  return nullCount === 1;
+}
 function generateReferenceType(type) {
   return { $ref: `#/$defs/${type.name}` };
 }
@@ -661,10 +693,7 @@ function generateDynamicType(type) {
     "x-formspec-schemaSource": type.sourceKey
   };
 }
-function generateCustomType(_type) {
-  return { type: "object" };
-}
-function applyConstraints(schema, constraints) {
+function applyConstraints(schema, constraints, ctx) {
   for (const constraint of constraints) {
     switch (constraint.constraintKind) {
       case "minimum":
@@ -709,6 +738,7 @@ function applyConstraints(schema, constraints) {
       case "allowedMembers":
         break;
       case "custom":
+        applyCustomConstraint(schema, constraint, ctx);
         break;
       default: {
         const _exhaustive = constraint;
@@ -717,7 +747,7 @@ function applyConstraints(schema, constraints) {
     }
   }
 }
-function applyAnnotations(schema, annotations) {
+function applyAnnotations(schema, annotations, ctx) {
   for (const annotation of annotations) {
     switch (annotation.annotationKind) {
       case "displayName":
@@ -737,6 +767,7 @@ function applyAnnotations(schema, annotations) {
       case "formatHint":
         break;
       case "custom":
+        applyCustomAnnotation(schema, annotation, ctx);
         break;
       default: {
         const _exhaustive = annotation;
@@ -745,11 +776,41 @@ function applyAnnotations(schema, annotations) {
     }
   }
 }
+function generateCustomType(type, ctx) {
+  const registration = ctx.extensionRegistry?.findType(type.typeId);
+  if (registration === void 0) {
+    throw new Error(
+      `Cannot generate JSON Schema for custom type "${type.typeId}" without a matching extension registration`
+    );
+  }
+  return registration.toJsonSchema(type.payload, ctx.vendorPrefix);
+}
+function applyCustomConstraint(schema, constraint, ctx) {
+  const registration = ctx.extensionRegistry?.findConstraint(constraint.constraintId);
+  if (registration === void 0) {
+    throw new Error(
+      `Cannot generate JSON Schema for custom constraint "${constraint.constraintId}" without a matching extension registration`
+    );
+  }
+  Object.assign(schema, registration.toJsonSchema(constraint.payload, ctx.vendorPrefix));
+}
+function applyCustomAnnotation(schema, annotation, ctx) {
+  const registration = ctx.extensionRegistry?.findAnnotation(annotation.annotationId);
+  if (registration === void 0) {
+    throw new Error(
+      `Cannot generate JSON Schema for custom annotation "${annotation.annotationId}" without a matching extension registration`
+    );
+  }
+  if (registration.toJsonSchema === void 0) {
+    return;
+  }
+  Object.assign(schema, registration.toJsonSchema(annotation.value, ctx.vendorPrefix));
+}
 
 // src/json-schema/generator.ts
-function generateJsonSchema(form) {
+function generateJsonSchema(form, options) {
   const ir = canonicalizeChainDSL(form);
-  return generateJsonSchemaFromIR(ir);
+  return generateJsonSchemaFromIR(ir, options);
 }
 
 // src/ui-schema/schema.ts
@@ -983,6 +1044,48 @@ function getSchemaExtension(schema, key) {
   return schema[key];
 }
 
+// src/extensions/registry.ts
+function createExtensionRegistry(extensions) {
+  const typeMap = /* @__PURE__ */ new Map();
+  const constraintMap = /* @__PURE__ */ new Map();
+  const annotationMap = /* @__PURE__ */ new Map();
+  for (const ext of extensions) {
+    if (ext.types !== void 0) {
+      for (const type of ext.types) {
+        const qualifiedId = `${ext.extensionId}/${type.typeName}`;
+        if (typeMap.has(qualifiedId)) {
+          throw new Error(`Duplicate custom type ID: "${qualifiedId}"`);
+        }
+        typeMap.set(qualifiedId, type);
+      }
+    }
+    if (ext.constraints !== void 0) {
+      for (const constraint of ext.constraints) {
+        const qualifiedId = `${ext.extensionId}/${constraint.constraintName}`;
+        if (constraintMap.has(qualifiedId)) {
+          throw new Error(`Duplicate custom constraint ID: "${qualifiedId}"`);
+        }
+        constraintMap.set(qualifiedId, constraint);
+      }
+    }
+    if (ext.annotations !== void 0) {
+      for (const annotation of ext.annotations) {
+        const qualifiedId = `${ext.extensionId}/${annotation.annotationName}`;
+        if (annotationMap.has(qualifiedId)) {
+          throw new Error(`Duplicate custom annotation ID: "${qualifiedId}"`);
+        }
+        annotationMap.set(qualifiedId, annotation);
+      }
+    }
+  }
+  return {
+    extensions,
+    findType: (typeId) => typeMap.get(typeId),
+    findConstraint: (constraintId) => constraintMap.get(constraintId),
+    findAnnotation: (annotationId) => annotationMap.get(annotationId)
+  };
+}
+
 // src/json-schema/schema.ts
 var import_zod3 = require("zod");
 var jsonSchemaTypeSchema = import_zod3.z.enum([
@@ -1122,7 +1225,6 @@ var ts4 = __toESM(require("typescript"), 1);
 
 // src/analyzer/jsdoc-constraints.ts
 var ts3 = __toESM(require("typescript"), 1);
-var import_core4 = require("@formspec/core");
 
 // src/analyzer/tsdoc-parser.ts
 var ts2 = __toESM(require("typescript"), 1);
@@ -1164,6 +1266,15 @@ function createFormSpecTSDocConfig() {
       })
     );
   }
+  for (const tagName of ["displayName", "description"]) {
+    config.addTagDefinition(
+      new import_tsdoc.TSDocTagDefinition({
+        tagName: "@" + tagName,
+        syntaxKind: import_tsdoc.TSDocTagSyntaxKind.BlockTag,
+        allowMultiple: true
+      })
+    );
+  }
   return config;
 }
 var sharedParser;
@@ -1193,6 +1304,27 @@ function parseTSDocTags(node, file = "") {
       const docComment = parserContext.docComment;
       for (const block of docComment.customBlocks) {
         const tagName = (0, import_core3.normalizeConstraintTagName)(block.blockTag.tagName.substring(1));
+        if (tagName === "displayName" || tagName === "description") {
+          const text2 = extractBlockText(block).trim();
+          if (text2 === "") continue;
+          const provenance2 = provenanceForComment(range, sourceFile, file, tagName);
+          if (tagName === "displayName") {
+            annotations.push({
+              kind: "annotation",
+              annotationKind: "displayName",
+              value: text2,
+              provenance: provenance2
+            });
+          } else {
+            annotations.push({
+              kind: "annotation",
+              annotationKind: "description",
+              value: text2,
+              provenance: provenance2
+            });
+          }
+          continue;
+        }
         if (TAGS_REQUIRING_RAW_TEXT.has(tagName)) continue;
         const text = extractBlockText(block).trim();
         if (text === "") continue;
@@ -1224,41 +1356,6 @@ function parseTSDocTags(node, file = "") {
       constraints.push(constraintNode);
     }
   }
-  let displayName;
-  let description;
-  let displayNameTag;
-  let descriptionTag;
-  for (const tag of jsDocTagsAll) {
-    const tagName = tag.tagName.text;
-    const commentText = getTagCommentText(tag);
-    if (commentText === void 0 || commentText.trim() === "") {
-      continue;
-    }
-    const trimmed = commentText.trim();
-    if (tagName === "Field_displayName") {
-      displayName = trimmed;
-      displayNameTag = tag;
-    } else if (tagName === "Field_description") {
-      description = trimmed;
-      descriptionTag = tag;
-    }
-  }
-  if (displayName !== void 0 && displayNameTag) {
-    annotations.push({
-      kind: "annotation",
-      annotationKind: "displayName",
-      value: displayName,
-      provenance: provenanceForJSDocTag(displayNameTag, file)
-    });
-  }
-  if (description !== void 0 && descriptionTag) {
-    annotations.push({
-      kind: "annotation",
-      annotationKind: "description",
-      value: description,
-      provenance: provenanceForJSDocTag(descriptionTag, file)
-    });
-  }
   return { constraints, annotations };
 }
 function extractPathTarget(text) {
@@ -1523,18 +1620,19 @@ function analyzeFieldToIR(prop, checker, file, typeRegistry, visiting) {
   const tsType = checker.getTypeAtLocation(prop);
   const optional = prop.questionToken !== void 0;
   const provenance = provenanceForNode(prop, file);
-  const type = resolveTypeNode(tsType, checker, file, typeRegistry, visiting);
+  let type = resolveTypeNode(tsType, checker, file, typeRegistry, visiting);
   const constraints = [];
   if (prop.type) {
     constraints.push(...extractTypeAliasConstraintNodes(prop.type, checker, file));
   }
   constraints.push(...extractJSDocConstraintNodes(prop, file));
-  const annotations = [];
+  let annotations = [];
   annotations.push(...extractJSDocAnnotationNodes(prop, file));
   const defaultAnnotation = extractDefaultValueAnnotation(prop.initializer, file);
   if (defaultAnnotation) {
     annotations.push(defaultAnnotation);
   }
+  ({ type, annotations } = applyEnumMemberDisplayNames(type, annotations));
   return {
     kind: "field",
     name,
@@ -1553,14 +1651,15 @@ function analyzeInterfacePropertyToIR(prop, checker, file, typeRegistry, visitin
   const tsType = checker.getTypeAtLocation(prop);
   const optional = prop.questionToken !== void 0;
   const provenance = provenanceForNode(prop, file);
-  const type = resolveTypeNode(tsType, checker, file, typeRegistry, visiting);
+  let type = resolveTypeNode(tsType, checker, file, typeRegistry, visiting);
   const constraints = [];
   if (prop.type) {
     constraints.push(...extractTypeAliasConstraintNodes(prop.type, checker, file));
   }
   constraints.push(...extractJSDocConstraintNodes(prop, file));
-  const annotations = [];
+  let annotations = [];
   annotations.push(...extractJSDocAnnotationNodes(prop, file));
+  ({ type, annotations } = applyEnumMemberDisplayNames(type, annotations));
   return {
     kind: "field",
     name,
@@ -1571,6 +1670,68 @@ function analyzeInterfacePropertyToIR(prop, checker, file, typeRegistry, visitin
     provenance
   };
 }
+function applyEnumMemberDisplayNames(type, annotations) {
+  if (!annotations.some(
+    (annotation) => annotation.annotationKind === "displayName" && annotation.value.trim().startsWith(":")
+  )) {
+    return { type, annotations: [...annotations] };
+  }
+  const consumed = /* @__PURE__ */ new Set();
+  const nextType = rewriteEnumDisplayNames(type, annotations, consumed);
+  if (consumed.size === 0) {
+    return { type, annotations: [...annotations] };
+  }
+  return {
+    type: nextType,
+    annotations: annotations.filter((annotation) => !consumed.has(annotation))
+  };
+}
+function rewriteEnumDisplayNames(type, annotations, consumed) {
+  switch (type.kind) {
+    case "enum":
+      return applyEnumMemberDisplayNamesToEnum(type, annotations, consumed);
+    case "union": {
+      return {
+        ...type,
+        members: type.members.map(
+          (member) => rewriteEnumDisplayNames(member, annotations, consumed)
+        )
+      };
+    }
+    default:
+      return type;
+  }
+}
+function applyEnumMemberDisplayNamesToEnum(type, annotations, consumed) {
+  const displayNames = /* @__PURE__ */ new Map();
+  for (const annotation of annotations) {
+    if (annotation.annotationKind !== "displayName") continue;
+    const parsed = parseEnumMemberDisplayName(annotation.value);
+    if (!parsed) continue;
+    consumed.add(annotation);
+    const member = type.members.find((m) => String(m.value) === parsed.value);
+    if (!member) continue;
+    displayNames.set(String(member.value), parsed.label);
+  }
+  if (displayNames.size === 0) {
+    return type;
+  }
+  return {
+    ...type,
+    members: type.members.map((member) => {
+      const displayName = displayNames.get(String(member.value));
+      return displayName !== void 0 ? { ...member, displayName } : member;
+    })
+  };
+}
+function parseEnumMemberDisplayName(value) {
+  const trimmed = value.trim();
+  const match = /^:([^\s]+)\s+([\s\S]+)$/.exec(trimmed);
+  if (!match?.[1] || !match[2]) return null;
+  const label = match[2].trim();
+  if (label === "") return null;
+  return { value: match[1], label };
+}
 function resolveTypeNode(type, checker, file, typeRegistry, visiting) {
   if (type.flags & ts4.TypeFlags.String) {
     return { kind: "primitive", primitiveKind: "string" };
@@ -1681,7 +1842,30 @@ function resolveArrayType(type, checker, file, typeRegistry, visiting) {
   const items = elementType ? resolveTypeNode(elementType, checker, file, typeRegistry, visiting) : { kind: "primitive", primitiveKind: "string" };
   return { kind: "array", items };
 }
+function tryResolveRecordType(type, checker, file, typeRegistry, visiting) {
+  if (type.getProperties().length > 0) {
+    return null;
+  }
+  const indexInfo = checker.getIndexInfoOfType(type, ts4.IndexKind.String);
+  if (!indexInfo) {
+    return null;
+  }
+  if (visiting.has(type)) {
+    return null;
+  }
+  visiting.add(type);
+  try {
+    const valueType = resolveTypeNode(indexInfo.type, checker, file, typeRegistry, visiting);
+    return { kind: "record", valueType };
+  } finally {
+    visiting.delete(type);
+  }
+}
 function resolveObjectType(type, checker, file, typeRegistry, visiting) {
+  const recordNode = tryResolveRecordType(type, checker, file, typeRegistry, visiting);
+  if (recordNode) {
+    return recordNode;
+  }
   if (visiting.has(type)) {
     return { kind: "object", properties: [], additionalProperties: false };
   }
@@ -1713,7 +1897,7 @@ function resolveObjectType(type, checker, file, typeRegistry, visiting) {
   const objectNode = {
     kind: "object",
     properties,
-    additionalProperties: false
+    additionalProperties: true
   };
   if (typeName) {
     typeRegistry[typeName] = {
@@ -1916,15 +2100,19 @@ function generateSchemas(options) {
 }
 
 // src/index.ts
-function buildFormSchemas(form) {
+function buildFormSchemas(form, options) {
   return {
-    jsonSchema: generateJsonSchema(form),
+    jsonSchema: generateJsonSchema(form, options),
     uiSchema: generateUiSchema(form)
   };
 }
 function writeSchemas(form, options) {
-  const { outDir, name = "schema", indent = 2 } = options;
-  const { jsonSchema, uiSchema: uiSchema2 } = buildFormSchemas(form);
+  const { outDir, name = "schema", indent = 2, extensionRegistry, vendorPrefix } = options;
+  const buildOptions = extensionRegistry === void 0 && vendorPrefix === void 0 ? void 0 : {
+    extensionRegistry,
+    vendorPrefix
+  };
+  const { jsonSchema, uiSchema: uiSchema2 } = buildFormSchemas(form, buildOptions);
   if (!fs.existsSync(outDir)) {
     fs.mkdirSync(outDir, { recursive: true });
   }
@@ -1940,7 +2128,9 @@ function writeSchemas(form, options) {
   categorizationSchema,
   categorySchema,
   controlSchema,
+  createExtensionRegistry,
   generateJsonSchema,
+  generateJsonSchemaFromIR,
   generateSchemas,
   generateSchemasFromClass,
   generateUiSchema,