@formspec/build 0.1.0-alpha.33 → 0.1.0-alpha.34

package/dist/internals.d.ts

@@ -16,7 +16,7 @@ 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 { analyzeClassToIR, analyzeInterfaceToIR, analyzeTypeAliasToIR, } from "./analyzer/class-analyzer.js";
-export type { IRClassAnalysis, FieldLayoutMetadata, AnalyzeTypeAliasToIRResult, } 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 { generateJsonSchemaFromIR } from "./json-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,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,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"}

package/dist/internals.js

@@ -1653,6 +1653,9 @@ function extractDefaultValueAnnotation(initializer, file = "") {
 function isObjectType(type) {
   return !!(type.flags & ts3.TypeFlags.Object);
 }
+function isIntersectionType(type) {
+  return !!(type.flags & ts3.TypeFlags.Intersection);
+}
 function isTypeReference(type) {
   return !!(type.flags & ts3.TypeFlags.Object) && !!(type.objectFlags & ts3.ObjectFlags.Reference);
 }
@@ -1673,10 +1676,11 @@ function makeParseOptions(extensionRegistry, fieldType, checker, subjectType, ho
     ...hostType !== void 0 && { hostType }
   };
 }
-function createAnalyzerMetadataPolicy(input) {
+function createAnalyzerMetadataPolicy(input, discriminator) {
   return {
     raw: input,
-    normalized: normalizeMetadataPolicy(input)
+    normalized: normalizeMetadataPolicy(input),
+    discriminator
   };
 }
 function resolveNodeMetadata(metadataPolicy, declarationKind, logicalName, node, checker, extensionRegistry, buildContext) {
@@ -1715,8 +1719,11 @@ function resolveNodeMetadata(metadataPolicy, declarationKind, logicalName, node,
   }
   return resolvedMetadata;
 }
-function analyzeClassToIR(classDecl, checker, file = "", extensionRegistry, metadataPolicy) {
-  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(metadataPolicy);
+function analyzeClassToIR(classDecl, checker, file = "", extensionRegistry, metadataPolicy, discriminatorOptions) {
+  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(
+    metadataPolicy,
+    discriminatorOptions
+  );
   const name = classDecl.name?.text ?? "AnonymousClass";
   const fields = [];
   const fieldLayouts = [];
@@ -1797,8 +1804,11 @@ function analyzeClassToIR(classDecl, checker, file = "", extensionRegistry, meta
     staticMethods
   };
 }
-function analyzeInterfaceToIR(interfaceDecl, checker, file = "", extensionRegistry, metadataPolicy) {
-  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(metadataPolicy);
+function analyzeInterfaceToIR(interfaceDecl, checker, file = "", extensionRegistry, metadataPolicy, discriminatorOptions) {
+  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(
+    metadataPolicy,
+    discriminatorOptions
+  );
   const name = interfaceDecl.name.text;
   const fields = [];
   const typeRegistry = {};
@@ -1866,19 +1876,31 @@ function analyzeInterfaceToIR(interfaceDecl, checker, file = "", extensionRegist
     staticMethods: []
   };
 }
-function analyzeTypeAliasToIR(typeAlias, checker, file = "", extensionRegistry, metadataPolicy) {
-  if (!ts3.isTypeLiteralNode(typeAlias.type)) {
+function analyzeTypeAliasToIR(typeAlias, checker, file = "", extensionRegistry, metadataPolicy, discriminatorOptions) {
+  const members = getObjectLikeTypeAliasMembers(typeAlias.type);
+  if (members === null) {
     const sourceFile = typeAlias.getSourceFile();
     const { line } = sourceFile.getLineAndCharacterOfPosition(typeAlias.getStart());
     const kindDesc = ts3.SyntaxKind[typeAlias.type.kind] ?? "unknown";
     return {
       ok: false,
-      error: `Type alias "${typeAlias.name.text}" at line ${String(line + 1)} is not an object type literal (found ${kindDesc})`
+      error: `Type alias "${typeAlias.name.text}" at line ${String(line + 1)} is not an object-like type alias (found ${kindDesc})`
     };
   }
-  const typeLiteral = typeAlias.type;
-  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(metadataPolicy);
+  const normalizedMetadataPolicy = createAnalyzerMetadataPolicy(
+    metadataPolicy,
+    discriminatorOptions
+  );
   const name = typeAlias.name.text;
+  const duplicatePropertyNames = findDuplicateObjectLikeTypeAliasPropertyNames(members);
+  if (duplicatePropertyNames.length > 0) {
+    const sourceFile = typeAlias.getSourceFile();
+    const { line } = sourceFile.getLineAndCharacterOfPosition(typeAlias.getStart());
+    return {
+      ok: false,
+      error: `Type alias "${name}" at line ${String(line + 1)} contains duplicate property names across object-like members: ${duplicatePropertyNames.join(", ")}`
+    };
+  }
   const fields = [];
   const typeRegistry = {};
   const diagnostics = [];
@@ -1891,7 +1913,7 @@ function analyzeTypeAliasToIR(typeAlias, checker, file = "", extensionRegistry,
   const annotations = [...typeAliasDoc.annotations];
   diagnostics.push(...typeAliasDoc.diagnostics);
   const visiting = /* @__PURE__ */ new Set();
-  for (const member of typeLiteral.members) {
+  for (const member of members) {
     if (ts3.isPropertySignature(member)) {
       const fieldNode = analyzeInterfacePropertyToIR(
         member,
@@ -2000,15 +2022,43 @@ function isNullishSemanticType(type) {
   }
   return type.isUnion() && type.types.some((member) => isNullishSemanticType(member));
 }
-function isStringLikeSemanticType(type) {
+function isStringLikeSemanticType(type, checker, seen = /* @__PURE__ */ new Set()) {
+  if (seen.has(type)) {
+    return false;
+  }
+  seen.add(type);
   if (type.flags & ts3.TypeFlags.StringLike) {
     return true;
   }
   if (type.isUnion()) {
-    return type.types.length > 0 && type.types.every((member) => isStringLikeSemanticType(member));
+    return type.types.length > 0 && type.types.every((member) => isStringLikeSemanticType(member, checker, seen));
+  }
+  const baseConstraint = checker.getBaseConstraintOfType(type);
+  if (baseConstraint !== void 0 && baseConstraint !== type) {
+    return isStringLikeSemanticType(baseConstraint, checker, seen);
   }
   return false;
 }
+function getObjectLikeTypeAliasMembers(typeNode) {
+  if (ts3.isParenthesizedTypeNode(typeNode)) {
+    return getObjectLikeTypeAliasMembers(typeNode.type);
+  }
+  if (ts3.isTypeLiteralNode(typeNode)) {
+    return [...typeNode.members];
+  }
+  if (ts3.isIntersectionTypeNode(typeNode)) {
+    const members = [];
+    for (const intersectionMember of typeNode.types) {
+      const resolvedMembers = getObjectLikeTypeAliasMembers(intersectionMember);
+      if (resolvedMembers === null) {
+        return null;
+      }
+      members.push(...resolvedMembers);
+    }
+    return members;
+  }
+  return null;
+}
 function extractDiscriminatorDirective(node, file, diagnostics) {
   const discriminatorTags = getLeadingParsedTags(node).filter(
     (tag) => tag.normalizedTagName === "discriminator"
@@ -2115,7 +2165,7 @@ function validateDiscriminatorDirective(node, checker, file, diagnostics) {
     );
     return null;
   }
-  if (!isStringLikeSemanticType(property.type)) {
+  if (!isStringLikeSemanticType(property.type, checker)) {
     diagnostics.push(
       makeAnalysisDiagnostic(
         "TYPE_MISMATCH",
@@ -2142,8 +2192,8 @@ function getConcreteTypeArgumentForDiscriminator(node, subjectType, checker, typ
   const localTypeParameter = node.typeParameters?.[typeParameterIndex];
   return localTypeParameter === void 0 ? null : checker.getTypeAtLocation(localTypeParameter);
 }
-function resolveLiteralDiscriminatorPropertyValue(boundType, fieldName, checker, provenance, diagnostics) {
-  const propertySymbol = boundType.getProperty(fieldName);
+function resolveLiteralDiscriminatorPropertyValue(boundType, propertyName, checker, provenance, diagnostics) {
+  const propertySymbol = boundType.getProperty(propertyName);
   if (propertySymbol === void 0) {
     return void 0;
   }
@@ -2174,6 +2224,9 @@ function resolveLiteralDiscriminatorPropertyValue(boundType, fieldName, checker,
   }
   return void 0;
 }
+function getDiscriminatorIdentityPropertyNames(fieldName) {
+  return fieldName === "object" ? ["object"] : [fieldName, "object"];
+}
 function resolveDiscriminatorApiName(boundType, checker, metadataPolicy) {
   const declaration = resolveNamedDiscriminatorDeclaration(boundType, checker);
   if (declaration === null) {
@@ -2194,6 +2247,10 @@ function resolveDiscriminatorApiName(boundType, checker, metadataPolicy) {
   );
   return metadata?.apiName;
 }
+function applyDiscriminatorApiNamePrefix(value, discriminatorOptions) {
+  const prefix = discriminatorOptions?.apiNamePrefix;
+  return prefix === void 0 || prefix === "" ? value : `${prefix}${value}`;
+}
 function resolveNamedDiscriminatorDeclaration(type, checker, seen = /* @__PURE__ */ new Set()) {
   if (seen.has(type)) {
     return null;
@@ -2248,22 +2305,27 @@ function resolveDiscriminatorValue(boundType, fieldName, checker, provenance, di
       return null;
     }
   }
-  const literalIdentityValue = resolveLiteralDiscriminatorPropertyValue(
-    boundType,
-    fieldName,
-    checker,
-    provenance,
-    diagnostics
-  );
-  if (literalIdentityValue !== void 0) {
-    return literalIdentityValue;
+  for (const identityPropertyName of getDiscriminatorIdentityPropertyNames(fieldName)) {
+    const literalIdentityValue = resolveLiteralDiscriminatorPropertyValue(
+      boundType,
+      identityPropertyName,
+      checker,
+      provenance,
+      diagnostics
+    );
+    if (literalIdentityValue === null) {
+      return null;
+    }
+    if (literalIdentityValue !== void 0) {
+      return literalIdentityValue;
+    }
   }
   const apiName = resolveDiscriminatorApiName(boundType, checker, metadataPolicy);
   if (apiName?.source === "explicit") {
-    return apiName.value;
+    return applyDiscriminatorApiNamePrefix(apiName.value, metadataPolicy.discriminator);
   }
   if (apiName?.source === "inferred") {
-    return apiName.value;
+    return applyDiscriminatorApiNamePrefix(apiName.value, metadataPolicy.discriminator);
   }
   diagnostics.push(
     makeAnalysisDiagnostic(
@@ -2326,15 +2388,20 @@ function buildInstantiatedReferenceName(baseName, typeArguments, checker) {
   return renderedArguments.length === 0 ? baseName : `${baseName}__${renderedArguments.join("__")}`;
 }
 function extractReferenceTypeArguments(type, checker, file, typeRegistry, visiting, sourceNode, metadataPolicy, extensionRegistry, diagnostics) {
-  const typeNode = sourceNode === void 0 ? void 0 : extractTypeNodeFromSource(sourceNode);
-  if (typeNode === void 0) {
+  const sourceTypeNode = sourceNode === void 0 ? void 0 : extractTypeNodeFromSource(sourceNode);
+  if (sourceTypeNode === void 0) {
     return [];
   }
-  const resolvedTypeNode = resolveAliasedTypeNode(typeNode, checker);
-  if (!ts3.isTypeReferenceNode(resolvedTypeNode) || resolvedTypeNode.typeArguments === void 0) {
+  const unwrapParentheses = (typeNode) => ts3.isParenthesizedTypeNode(typeNode) ? unwrapParentheses(typeNode.type) : typeNode;
+  const directTypeNode = unwrapParentheses(sourceTypeNode);
+  const referenceTypeNode = ts3.isTypeReferenceNode(directTypeNode) ? directTypeNode : (() => {
+    const resolvedTypeNode = resolveAliasedTypeNode(directTypeNode, checker);
+    return ts3.isTypeReferenceNode(resolvedTypeNode) ? resolvedTypeNode : null;
+  })();
+  if (referenceTypeNode?.typeArguments === void 0) {
     return [];
   }
-  return resolvedTypeNode.typeArguments.map((argumentNode) => {
+  return referenceTypeNode.typeArguments.map((argumentNode) => {
     const argumentType = checker.getTypeFromTypeNode(argumentNode);
     return {
       tsType: argumentType,
@@ -2448,10 +2515,10 @@ function analyzeFieldToIR(prop, checker, file, typeRegistry, visiting, diagnosti
   };
 }
 function analyzeInterfacePropertyToIR(prop, checker, file, typeRegistry, visiting, diagnostics, hostType, metadataPolicy, extensionRegistry) {
-  if (!ts3.isIdentifier(prop.name)) {
+  const name = getAnalyzableObjectLikePropertyName(prop.name);
+  if (name === null) {
     return null;
   }
-  const name = prop.name.text;
   const tsType = checker.getTypeAtLocation(prop);
   const optional = prop.questionToken !== void 0;
   const provenance = provenanceForNode(prop, file);
@@ -2507,6 +2574,31 @@ function analyzeInterfacePropertyToIR(prop, checker, file, typeRegistry, visitin
     provenance
   };
 }
+function findDuplicateObjectLikeTypeAliasPropertyNames(members) {
+  const seen = /* @__PURE__ */ new Set();
+  const duplicates = /* @__PURE__ */ new Set();
+  for (const member of members) {
+    if (!ts3.isPropertySignature(member)) {
+      continue;
+    }
+    const name = getAnalyzableObjectLikePropertyName(member.name);
+    if (name === null) {
+      continue;
+    }
+    if (seen.has(name)) {
+      duplicates.add(name);
+      continue;
+    }
+    seen.add(name);
+  }
+  return [...duplicates].sort();
+}
+function getAnalyzableObjectLikePropertyName(name) {
+  if (!ts3.isIdentifier(name)) {
+    return null;
+  }
+  return name.text;
+}
 function applyEnumMemberDisplayNames(type, annotations) {
   if (!annotations.some(
     (annotation) => annotation.annotationKind === "displayName" && annotation.value.trim().startsWith(":")
@@ -2699,6 +2791,23 @@ function resolveTypeNode(type, checker, file, typeRegistry, visiting, sourceNode
       diagnostics
     );
   }
+  if (isIntersectionType(type)) {
+    const sourceTypeNode = sourceNode === void 0 ? void 0 : extractTypeNodeFromSource(sourceNode);
+    const resolvedSourceTypeNode = sourceTypeNode === void 0 ? void 0 : resolveAliasedTypeNode(sourceTypeNode, checker);
+    if (resolvedSourceTypeNode !== void 0 && getObjectLikeTypeAliasMembers(resolvedSourceTypeNode) !== null) {
+      return resolveObjectType(
+        type,
+        checker,
+        file,
+        typeRegistry,
+        visiting,
+        sourceNode,
+        metadataPolicy,
+        extensionRegistry,
+        diagnostics
+      );
+    }
+  }
   if (isObjectType(type)) {
     return resolveObjectType(
       type,
@@ -3078,7 +3187,7 @@ function resolveObjectType(type, checker, file, typeRegistry, visiting, sourceNo
       };
     }
   }
-  const recordNode = tryResolveRecordType(
+  const recordNode = isObjectType(type) ? tryResolveRecordType(
     type,
     checker,
     file,
@@ -3087,7 +3196,7 @@ function resolveObjectType(type, checker, file, typeRegistry, visiting, sourceNo
     metadataPolicy,
     extensionRegistry,
     collectedDiagnostics
-  );
+  ) : null;
   if (recordNode) {
     visiting.delete(type);
     if (registryTypeName !== void 0 && shouldRegisterNamedType) {
@@ -3284,9 +3393,10 @@ function getNamedTypeFieldNodeInfoMap(type, checker, file, typeRegistry, visitin
       );
     }
     const typeAliasDecl = declarations.find(ts3.isTypeAliasDeclaration);
-    if (typeAliasDecl && ts3.isTypeLiteralNode(typeAliasDecl.type)) {
+    const typeAliasMembers = typeAliasDecl === void 0 ? null : getObjectLikeTypeAliasMembers(typeAliasDecl.type);
+    if (typeAliasDecl && typeAliasMembers !== null) {
       return buildFieldNodeInfoMap(
-        typeAliasDecl.type.members,
+        typeAliasMembers,
         checker,
         file,
         typeRegistry,
@@ -3577,7 +3687,7 @@ function findInterfaceByName(sourceFile, interfaceName) {
 function findTypeAliasByName(sourceFile, aliasName) {
   return findNodeByName(sourceFile, aliasName, ts4.isTypeAliasDeclaration, (n) => n.name.text);
 }
-function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensionRegistry, metadataPolicy) {
+function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensionRegistry, metadataPolicy, discriminatorOptions) {
   const analysisFilePath = path.resolve(filePath);
   const classDecl = findClassByName(ctx.sourceFile, typeName);
   if (classDecl !== null) {
@@ -3586,7 +3696,8 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
       ctx.checker,
       analysisFilePath,
       extensionRegistry,
-      metadataPolicy
+      metadataPolicy,
+      discriminatorOptions
     );
   }
   const interfaceDecl = findInterfaceByName(ctx.sourceFile, typeName);
@@ -3596,7 +3707,8 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
       ctx.checker,
       analysisFilePath,
       extensionRegistry,
-      metadataPolicy
+      metadataPolicy,
+      discriminatorOptions
     );
   }
   const typeAlias = findTypeAliasByName(ctx.sourceFile, typeName);
@@ -3606,7 +3718,8 @@ function analyzeNamedTypeToIRFromProgramContext(ctx, filePath, typeName, extensi
       ctx.checker,
       analysisFilePath,
       extensionRegistry,
-      metadataPolicy
+      metadataPolicy,
+      discriminatorOptions
     );
     if (result.ok) {
       return result.analysis;