@formspec/build 0.1.0-alpha.37 → 0.1.0-alpha.39

package/dist/internals.d.ts

@@ -14,11 +14,12 @@
 export { canonicalizeChainDSL } from "./canonicalize/index.js";
 export { canonicalizeTSDoc } from "./canonicalize/index.js";
 export type { TSDocSource } from "./canonicalize/index.js";
-export { createProgramContext, createProgramContextFromProgram, findClassByName, findInterfaceByName, findTypeAliasByName, analyzeNamedTypeToIRFromProgramContext, } from "./analyzer/program.js";
+export { createProgramContext, createProgramContextFromProgram, findClassByName, findInterfaceByName, findTypeAliasByName, analyzeNamedTypeToIRFromProgramContextDetailed, analyzeNamedTypeToIRFromProgramContext, } from "./analyzer/program.js";
 export { analyzeClassToIR, analyzeInterfaceToIR, analyzeTypeAliasToIR, } from "./analyzer/class-analyzer.js";
 export type { DiscriminatorResolutionOptions, IRClassAnalysis, FieldLayoutMetadata, AnalyzeTypeAliasToIRResult, } from "./analyzer/class-analyzer.js";
-export { generateClassSchemas } from "./generators/class-schema.js";
-export type { ClassSchemas } from "./generators/class-schema.js";
+export type { AnalyzeNamedTypeToIRDetailedResult } from "./analyzer/program.js";
+export { generateClassSchemas, generateClassSchemasDetailed } from "./generators/class-schema.js";
+export type { ClassSchemas, DetailedClassSchemasResult } from "./generators/class-schema.js";
 export { generateJsonSchemaFromIR } from "./json-schema/ir-generator.js";
 export type { GenerateJsonSchemaFromIROptions, JsonSchema2020, } from "./json-schema/ir-generator.js";
 export { generateUiSchemaFromIR } from "./ui-schema/ir-generator.js";

package/dist/internals.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"internals.d.ts","sourceRoot":"","sources":["../src/internals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAG/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D,OAAO,EACL,oBAAoB,EACpB,+BAA+B,EAC/B,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,8BAA8B,EAC9B,eAAe,EACf,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,8BAA8B,CAAC;AAGtC,OAAO,EAAE,oBAAoB,EAAE,MAAM,8BAA8B,CAAC;AACpE,YAAY,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAGjE,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,YAAY,EACV,+BAA+B,EAC/B,cAAc,GACf,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EACV,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AACjG,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"internals.d.ts","sourceRoot":"","sources":["../src/internals.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;GAYG;AAGH,OAAO,EAAE,oBAAoB,EAAE,MAAM,yBAAyB,CAAC;AAG/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAC5D,YAAY,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AAG3D,OAAO,EACL,oBAAoB,EACpB,+BAA+B,EAC/B,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,8CAA8C,EAC9C,sCAAsC,GACvC,MAAM,uBAAuB,CAAC;AAG/B,OAAO,EACL,gBAAgB,EAChB,oBAAoB,EACpB,oBAAoB,GACrB,MAAM,8BAA8B,CAAC;AACtC,YAAY,EACV,8BAA8B,EAC9B,eAAe,EACf,mBAAmB,EACnB,0BAA0B,GAC3B,MAAM,8BAA8B,CAAC;AACtC,YAAY,EAAE,kCAAkC,EAAE,MAAM,uBAAuB,CAAC;AAGhF,OAAO,EAAE,oBAAoB,EAAE,4BAA4B,EAAE,MAAM,8BAA8B,CAAC;AAClG,YAAY,EAAE,YAAY,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAG7F,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC;AACzE,YAAY,EACV,+BAA+B,EAC/B,cAAc,GACf,MAAM,+BAA+B,CAAC;AAGvC,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAGrE,OAAO,EAAE,UAAU,EAAE,MAAM,qBAAqB,CAAC;AACjD,YAAY,EACV,oBAAoB,EACpB,gBAAgB,EAChB,iBAAiB,GAClB,MAAM,qBAAqB,CAAC;AAG7B,OAAO,EAAE,uBAAuB,EAAE,MAAM,uBAAuB,CAAC;AAChE,YAAY,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAG/D,OAAO,EAAE,qBAAqB,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AACjG,YAAY,EAAE,qBAAqB,EAAE,aAAa,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/internals.js

@@ -897,6 +897,16 @@ function buildSupportingDeclarations(sourceFile, extensionTypeNames) {
     return true;
   }).map((statement) => statement.getText(sourceFile));
 }
+function pushUniqueCompilerDiagnostics(target, additions) {
+  for (const diagnostic of additions) {
+    if ((diagnostic.code === "UNSUPPORTED_CUSTOM_TYPE_OVERRIDE" || diagnostic.code === "SYNTHETIC_SETUP_FAILURE") && target.some(
+      (existing) => existing.code === diagnostic.code && existing.message === diagnostic.message
+    )) {
+      continue;
+    }
+    target.push(diagnostic);
+  }
+}
 function renderSyntheticArgumentExpression(valueKind, argumentText) {
   const trimmed = argumentText.trim();
   if (trimmed === "") {
@@ -1163,6 +1173,16 @@ function buildCompilerBackedConstraintDiagnostics(node, sourceFile, tagName, par
   if (result.diagnostics.length === 0) {
     return [];
   }
+  const setupDiagnostic = result.diagnostics.find((diagnostic) => diagnostic.kind !== "typescript");
+  if (setupDiagnostic !== void 0) {
+    return [
+      makeDiagnostic(
+        setupDiagnostic.kind === "unsupported-custom-type-override" ? "UNSUPPORTED_CUSTOM_TYPE_OVERRIDE" : "SYNTHETIC_SETUP_FAILURE",
+        setupDiagnostic.message,
+        provenance
+      )
+    ];
+  }
   const expectedLabel = definition.valueKind === null ? "compatible argument" : capabilityLabel(definition.valueKind);
   return [
     makeDiagnostic(
@@ -1328,7 +1348,7 @@ function parseTSDocTags(node, file = "", options) {
           options
         );
         if (compilerDiagnostics.length > 0) {
-          diagnostics.push(...compilerDiagnostics);
+          pushUniqueCompilerDiagnostics(diagnostics, compilerDiagnostics);
           continue;
         }
         const constraintNode = parseConstraintTagValue(
@@ -1415,7 +1435,7 @@ function parseTSDocTags(node, file = "", options) {
         options
       );
       if (compilerDiagnostics.length > 0) {
-        diagnostics.push(...compilerDiagnostics);
+        pushUniqueCompilerDiagnostics(diagnostics, compilerDiagnostics);
         continue;
       }
       const constraintNode = parseConstraintTagValue(
@@ -1449,7 +1469,7 @@ function parseTSDocTags(node, file = "", options) {
         options
       );
       if (compilerDiagnostics.length > 0) {
-        diagnostics.push(...compilerDiagnostics);
+        pushUniqueCompilerDiagnostics(diagnostics, compilerDiagnostics);
         continue;
       }
       const constraintNode = parseConstraintTagValue(
@@ -3862,29 +3882,35 @@ function findFallbackAliasDuplicatePropertyNames(typeNode, checker) {
   }
   return [...duplicates].sort();
 }
-function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensionRegistry, metadataPolicy, discriminatorOptions) {
+function analyzeNamedTypeToIRFromProgramContextDetailed(ctx, filePath, typeName, extensionRegistry, metadataPolicy, discriminatorOptions) {
   const analysisFilePath = path.resolve(filePath);
   const classDecl = findClassByName(ctx.sourceFile, typeName);
   if (classDecl !== null) {
-    return analyzeClassToIR(
-      classDecl,
-      ctx.checker,
-      analysisFilePath,
-      extensionRegistry,
-      metadataPolicy,
-      discriminatorOptions
-    );
+    return {
+      ok: true,
+      analysis: analyzeClassToIR(
+        classDecl,
+        ctx.checker,
+        analysisFilePath,
+        extensionRegistry,
+        metadataPolicy,
+        discriminatorOptions
+      )
+    };
   }
   const interfaceDecl = findInterfaceByName(ctx.sourceFile, typeName);
   if (interfaceDecl !== null) {
-    return analyzeInterfaceToIR(
-      interfaceDecl,
-      ctx.checker,
-      analysisFilePath,
-      extensionRegistry,
-      metadataPolicy,
-      discriminatorOptions
-    );
+    return {
+      ok: true,
+      analysis: analyzeInterfaceToIR(
+        interfaceDecl,
+        ctx.checker,
+        analysisFilePath,
+        extensionRegistry,
+        metadataPolicy,
+        discriminatorOptions
+      )
+    };
   }
   const typeAlias = findTypeAliasByName(ctx.sourceFile, typeName);
   if (typeAlias !== null) {
@@ -3897,11 +3923,20 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
       discriminatorOptions
     );
     if (result.ok) {
-      return result.analysis;
+      return { ok: true, analysis: result.analysis };
     }
     const fallbackEligible = result.kind === "not-object-like" && isResolvableObjectLikeAliasTypeNode(typeAlias.type) && containsTypeReferenceInObjectLikeAlias(typeAlias.type);
     if (!fallbackEligible) {
-      throw new Error(result.error);
+      return {
+        ok: false,
+        diagnostics: [
+          makeProgramDiagnostic(
+            result.kind === "duplicate-properties" ? "DUPLICATE_ROOT_PROPERTIES" : "UNSUPPORTED_ROOT_TYPE",
+            result.error,
+            makeNodeProvenance(typeAlias, analysisFilePath)
+          )
+        ]
+      };
     }
     const duplicatePropertyNames = findFallbackAliasDuplicatePropertyNames(
       typeAlias.type,
@@ -3910,9 +3945,16 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
     if (duplicatePropertyNames.length > 0) {
       const sourceFile = typeAlias.getSourceFile();
       const { line } = sourceFile.getLineAndCharacterOfPosition(typeAlias.getStart());
-      throw new Error(
-        `Type alias "${typeAlias.name.text}" at line ${String(line + 1)} contains duplicate property names across object-like members: ${duplicatePropertyNames.join(", ")}`
-      );
+      return {
+        ok: false,
+        diagnostics: [
+          makeProgramDiagnostic(
+            "DUPLICATE_ROOT_PROPERTIES",
+            `Type alias "${typeAlias.name.text}" at line ${String(line + 1)} contains duplicate property names across object-like members: ${duplicatePropertyNames.join(", ")}`,
+            makeNodeProvenance(typeAlias, analysisFilePath)
+          )
+        ]
+      };
     }
     const rootInfo = analyzeDeclarationRootInfo(
       typeAlias,
@@ -3942,17 +3984,75 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
       diagnostics
     );
     if (fallbackAnalysis !== null) {
-      return fallbackAnalysis;
+      return { ok: true, analysis: fallbackAnalysis };
     }
-    throw new Error(result.error);
+    return {
+      ok: false,
+      diagnostics: [
+        makeProgramDiagnostic(
+          "UNSUPPORTED_ROOT_TYPE",
+          result.error,
+          makeNodeProvenance(typeAlias, analysisFilePath)
+        )
+      ]
+    };
   }
-  throw new Error(
-    `Type "${typeName}" not found as a class, interface, or type alias in ${analysisFilePath}`
+  return {
+    ok: false,
+    diagnostics: [
+      makeProgramDiagnostic(
+        "TYPE_NOT_FOUND",
+        `Type "${typeName}" not found as a class, interface, or type alias in ${analysisFilePath}`,
+        makeFileProvenance(analysisFilePath)
+      )
+    ]
+  };
+}
+function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensionRegistry, metadataPolicy, discriminatorOptions) {
+  const result = analyzeNamedTypeToIRFromProgramContextDetailed(
+    ctx,
+    filePath,
+    typeName,
+    extensionRegistry,
+    metadataPolicy,
+    discriminatorOptions
   );
+  if (result.ok) {
+    return result.analysis;
+  }
+  throw new Error(result.diagnostics.map((diagnostic) => diagnostic.message).join("\n"));
+}
+function makeProgramDiagnostic(code, message, primaryLocation) {
+  return {
+    code,
+    message,
+    severity: "error",
+    primaryLocation,
+    relatedLocations: []
+  };
+}
+function makeNodeProvenance(node, filePath) {
+  const sourceFile = node.getSourceFile();
+  const position = sourceFile.getLineAndCharacterOfPosition(node.getStart());
+  return {
+    surface: "tsdoc",
+    file: filePath,
+    line: position.line + 1,
+    column: position.character,
+    length: node.getWidth()
+  };
+}
+function makeFileProvenance(filePath) {
+  return {
+    surface: "tsdoc",
+    file: filePath,
+    line: 1,
+    column: 0
+  };
 }
 
 // src/generators/class-schema.ts
-import "typescript";
+import * as ts5 from "typescript";
 
 // src/metadata/collision-guards.ts
 function assertUniqueSerializedNames(entries, scope) {
@@ -5016,11 +5116,25 @@ function validateIR(ir, options) {
 
 // src/generators/class-schema.ts
 function generateClassSchemas(analysis, source, options) {
-  const errorDiagnostics = analysis.diagnostics?.filter(
+  const result = generateClassSchemasDetailed(analysis, source, options);
+  if (!result.ok || result.jsonSchema === void 0 || result.uiSchema === void 0) {
+    throw new Error(formatValidationError(result.diagnostics));
+  }
+  return {
+    jsonSchema: result.jsonSchema,
+    uiSchema: result.uiSchema
+  };
+}
+function generateClassSchemasDetailed(analysis, source, options) {
+  const analysisDiagnostics = analysis.diagnostics ?? [];
+  const errorDiagnostics = analysisDiagnostics.filter(
     (diagnostic) => diagnostic.severity === "error"
   );
-  if (errorDiagnostics !== void 0 && errorDiagnostics.length > 0) {
-    throw new Error(formatValidationError(errorDiagnostics));
+  if (errorDiagnostics.length > 0) {
+    return {
+      ok: false,
+      diagnostics: analysisDiagnostics
+    };
   }
   const ir = canonicalizeTSDoc(
     analysis,
@@ -5034,9 +5148,14 @@ function generateClassSchemas(analysis, source, options) {
     ...options?.vendorPrefix !== void 0 && { vendorPrefix: options.vendorPrefix }
   });
   if (!validationResult.valid) {
-    throw new Error(formatValidationError(validationResult.diagnostics));
+    return {
+      ok: false,
+      diagnostics: [...analysisDiagnostics, ...validationResult.diagnostics]
+    };
   }
   return {
+    ok: true,
+    diagnostics: [...analysisDiagnostics, ...validationResult.diagnostics],
     jsonSchema: generateJsonSchemaFromIR(ir, options),
     uiSchema: generateUiSchemaFromIR(ir)
   };
@@ -5321,6 +5440,7 @@ export {
   analyzeClassToIR,
   analyzeInterfaceToIR,
   analyzeNamedTypeToIRFromProgramContext,
+  analyzeNamedTypeToIRFromProgramContextDetailed,
   analyzeTypeAliasToIR,
   canonicalizeChainDSL,
   canonicalizeTSDoc,
@@ -5332,6 +5452,7 @@ export {
   findInterfaceByName,
   findTypeAliasByName,
   generateClassSchemas,
+  generateClassSchemasDetailed,
   generateJsonSchemaFromIR,
   generateMethodSchemas,
   generateUiSchemaFromIR,