@player-tools/xlr-sdk 0.9.0 → 0.9.1--canary.196.4186

package/dist/index.legacy-esm.js

@@ -73,10 +73,24 @@ import {
   resolveReferenceNode,
   computeEffectiveObject
 } from "@player-tools/xlr-utils";
+
+// ../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/xlr/sdk/src/types.ts
+var ValidationSeverity = /* @__PURE__ */ ((ValidationSeverity2) => {
+  ValidationSeverity2[ValidationSeverity2["Error"] = 1] = "Error";
+  ValidationSeverity2[ValidationSeverity2["Warning"] = 2] = "Warning";
+  ValidationSeverity2[ValidationSeverity2["Info"] = 3] = "Info";
+  ValidationSeverity2[ValidationSeverity2["Trace"] = 4] = "Trace";
+  return ValidationSeverity2;
+})(ValidationSeverity || {});
+
+// ../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/xlr/sdk/src/validator.ts
+var MAX_VALID_SHOWN = 20;
 var XLRValidator = class {
+  config;
   resolveType;
   regexCache;
-  constructor(resolveType) {
+  constructor(resolveType, config) {
+    this.config = config || {};
     this.resolveType = resolveType;
     this.regexCache = /* @__PURE__ */ new Map();
   }
@@ -90,7 +104,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "type",
           node: rootNode,
-          message: `Expected an object but got an "${rootNode.type}"`
+          message: `Expected an object but got an "${rootNode.type}"`,
+          severity: 1 /* Error */
         });
       }
     } else if (xlrNode.type === "array") {
@@ -100,7 +115,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "type",
           node: rootNode,
-          message: `Expected an array but got an "${rootNode.type}"`
+          message: `Expected an array but got an "${rootNode.type}"`,
+          severity: 1 /* Error */
         });
       }
     } else if (xlrNode.type === "template") {
@@ -109,25 +125,45 @@ var XLRValidator = class {
         validationIssues.push(error);
       }
     } else if (xlrNode.type === "or") {
+      const potentialTypeErrors = [];
       for (const potentialType of xlrNode.or) {
         const potentialErrors = this.validateType(rootNode, potentialType);
         if (potentialErrors.length === 0) {
           return validationIssues;
         }
+        potentialTypeErrors.push({
+          type: potentialType,
+          errors: potentialErrors
+        });
       }
       let message;
+      const expectedTypes = xlrNode.or.map((node) => node.name ?? node.title ?? node.type ?? "<unnamed type>").join(" | ");
       if (xlrNode.name) {
         message = `Does not match any of the expected types for type: '${xlrNode.name}'`;
       } else if (xlrNode.title) {
         message = `Does not match any of the expected types for property: '${xlrNode.title}'`;
       } else {
-        message = `Does not match any of the types ${xlrNode.or.map((node) => node.name ?? node.title ?? "<unnamed type>").join(" | ")}`;
+        message = `Does not match any of the types: ${expectedTypes}`;
       }
+      const { infoMessage } = this.generateNestedTypesInfo(
+        potentialTypeErrors,
+        xlrNode,
+        rootNode
+      );
       validationIssues.push({
         type: "value",
         node: rootNode,
-        message
+        message: message.trim(),
+        severity: 1 /* Error */
       });
+      if (infoMessage) {
+        validationIssues.push({
+          type: "value",
+          node: rootNode,
+          message: infoMessage,
+          severity: 3 /* Info */
+        });
+      }
     } else if (xlrNode.type === "and") {
       const effectiveType = {
         ...this.computeIntersectionType(xlrNode.and),
@@ -149,7 +185,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "unknown",
           node: rootNode,
-          message: `Type "${xlrNode.ref}" is not defined in provided bundles`
+          message: `Type "${xlrNode.ref}" is not defined in provided bundles`,
+          severity: 1 /* Error */
         });
       } else {
         validationIssues.push(
@@ -162,13 +199,17 @@ var XLRValidator = class {
           validationIssues.push({
             type: "type",
             node: rootNode.parent,
-            message: `Expected "${xlrNode.const}" but got "${rootNode.value}"`
+            message: `Expected "${xlrNode.const}" but got "${rootNode.value}"`,
+            expected: xlrNode.const,
+            severity: 1 /* Error */
           });
         } else {
           validationIssues.push({
             type: "type",
             node: rootNode.parent,
-            message: `Expected type "${xlrNode.type}" but got "${rootNode.type}"`
+            message: `Expected type "${xlrNode.type}" but got "${rootNode.type}"`,
+            expected: xlrNode.type,
+            severity: 1 /* Error */
           });
         }
       }
@@ -201,12 +242,45 @@ var XLRValidator = class {
     }
     return validationIssues;
   }
+  generateNestedTypesInfo(potentialTypeErrors, xlrNode, rootNode) {
+    const nestedTypes = /* @__PURE__ */ new Set();
+    potentialTypeErrors.forEach((typeError) => {
+      if (typeError.type.type !== "template") {
+        typeError.errors.forEach((error) => {
+          if (error.type === "type" && error.expected) {
+            String(error.expected).split(" | ").forEach((val) => nestedTypes.add(val.trim()));
+          }
+        });
+      }
+    });
+    if (nestedTypes.size === 0) {
+      xlrNode.or.forEach((type) => {
+        const typeName = type.name ?? type.title ?? type.type ?? "<unnamed type>";
+        nestedTypes.add(typeName);
+      });
+    }
+    const nestedTypesArray = [...nestedTypes];
+    let nestedTypesList = nestedTypesArray.slice(0, MAX_VALID_SHOWN).join(" | ") + (nestedTypesArray.length > MAX_VALID_SHOWN ? ` | +${nestedTypesArray.length - MAX_VALID_SHOWN} ... ${nestedTypesArray.pop()}` : "");
+    const docsURL = this.config.urlMapping;
+    if (docsURL && xlrNode.name && docsURL[xlrNode.name]) {
+      nestedTypesList = docsURL[xlrNode.name];
+    }
+    let infoMessage;
+    if (rootNode.value !== void 0) {
+      infoMessage = `Got: ${rootNode.value} and expected: ${nestedTypesList}`;
+    } else if (nestedTypesList) {
+      infoMessage = `Expected: ${nestedTypesList}`;
+    }
+    return { nestedTypesList, infoMessage };
+  }
   validateTemplate(node, xlrNode) {
     if (node.type !== "string") {
       return {
         type: "type",
         node: node.parent,
-        message: `Expected type "${xlrNode.type}" but got "${typeof node}"`
+        message: `Expected type "${xlrNode.type}" but got "${typeof node}"`,
+        expected: xlrNode.type,
+        severity: 1 /* Error */
       };
     }
     const regex = this.getRegex(xlrNode.format);
@@ -215,7 +289,9 @@ var XLRValidator = class {
       return {
         type: "value",
         node: node.parent,
-        message: `Does not match expected format: ${xlrNode.format}`
+        message: `Does not match expected format: ${xlrNode.format}`,
+        expected: xlrNode.format,
+        severity: 1 /* Error */
       };
     }
   }
@@ -236,7 +312,8 @@ var XLRValidator = class {
         issues.push({
           type: "missing",
           node,
-          message: `Property "${prop}" missing from type "${xlrNode.name}"`
+          message: `Property "${prop}" missing from type "${xlrNode.name}"`,
+          severity: 1 /* Error */
         });
       }
       if (valueNode) {
@@ -254,7 +331,8 @@ var XLRValidator = class {
         node,
         message: `Unexpected properties on "${xlrNode.name}": ${extraKeys.join(
           ", "
-        )}`
+        )}`,
+        severity: 1 /* Error */
       });
     } else {
       issues.push(
@@ -321,6 +399,7 @@ var XLRValidator = class {
   computeIntersectionType(types) {
     let firstElement = types[0];
     let effectiveType;
+    const topLevelTypeName = types[0].name;
     if (firstElement.type === "ref") {
       firstElement = this.getRefType(firstElement);
     }
@@ -360,18 +439,32 @@ var XLRValidator = class {
         } else {
           effectiveType = {
             ...effectiveType,
-            or: effectiveType.or.map(
-              (y) => this.computeIntersectionType([y, typeToApply])
-            )
+            or: effectiveType.or.map((y) => {
+              const intersectedType = this.computeIntersectionType([
+                y,
+                typeToApply
+              ]);
+              if (!intersectedType.name && topLevelTypeName) {
+                intersectedType.name = topLevelTypeName;
+              }
+              return intersectedType;
+            })
           };
         }
       } else if (typeToApply.type === "or") {
         if (effectiveType.type === "object") {
           effectiveType = {
             ...typeToApply,
-            or: typeToApply.or.map(
-              (y) => this.computeIntersectionType([y, effectiveType])
-            )
+            or: typeToApply.or.map((y) => {
+              const intersectedType = this.computeIntersectionType([
+                y,
+                effectiveType
+              ]);
+              if (!intersectedType.name && topLevelTypeName) {
+                intersectedType.name = topLevelTypeName;
+              }
+              return intersectedType;
+            })
           };
         } else {
           throw new Error("unimplemented operation or x or projection");
@@ -382,6 +475,9 @@ var XLRValidator = class {
         );
       }
     });
+    if (effectiveType.type === "or" && !effectiveType.name && topLevelTypeName) {
+      effectiveType.name = topLevelTypeName;
+    }
     return effectiveType;
   }
 };
@@ -855,6 +951,7 @@ ${nodeText}`;
 };
 export {
   BasicXLRRegistry,
+  ValidationSeverity,
   XLRSDK,
   simpleTransformGenerator,
   xlrTransformWalker

package/dist/index.mjs

@@ -73,10 +73,24 @@ import {
   resolveReferenceNode,
   computeEffectiveObject
 } from "@player-tools/xlr-utils";
+
+// ../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/xlr/sdk/src/types.ts
+var ValidationSeverity = /* @__PURE__ */ ((ValidationSeverity2) => {
+  ValidationSeverity2[ValidationSeverity2["Error"] = 1] = "Error";
+  ValidationSeverity2[ValidationSeverity2["Warning"] = 2] = "Warning";
+  ValidationSeverity2[ValidationSeverity2["Info"] = 3] = "Info";
+  ValidationSeverity2[ValidationSeverity2["Trace"] = 4] = "Trace";
+  return ValidationSeverity2;
+})(ValidationSeverity || {});
+
+// ../../../../../../../../../../execroot/_main/bazel-out/k8-fastbuild/bin/xlr/sdk/src/validator.ts
+var MAX_VALID_SHOWN = 20;
 var XLRValidator = class {
+  config;
   resolveType;
   regexCache;
-  constructor(resolveType) {
+  constructor(resolveType, config) {
+    this.config = config || {};
     this.resolveType = resolveType;
     this.regexCache = /* @__PURE__ */ new Map();
   }
@@ -90,7 +104,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "type",
           node: rootNode,
-          message: `Expected an object but got an "${rootNode.type}"`
+          message: `Expected an object but got an "${rootNode.type}"`,
+          severity: 1 /* Error */
         });
       }
     } else if (xlrNode.type === "array") {
@@ -100,7 +115,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "type",
           node: rootNode,
-          message: `Expected an array but got an "${rootNode.type}"`
+          message: `Expected an array but got an "${rootNode.type}"`,
+          severity: 1 /* Error */
         });
       }
     } else if (xlrNode.type === "template") {
@@ -109,25 +125,45 @@ var XLRValidator = class {
         validationIssues.push(error);
       }
     } else if (xlrNode.type === "or") {
+      const potentialTypeErrors = [];
       for (const potentialType of xlrNode.or) {
         const potentialErrors = this.validateType(rootNode, potentialType);
         if (potentialErrors.length === 0) {
           return validationIssues;
         }
+        potentialTypeErrors.push({
+          type: potentialType,
+          errors: potentialErrors
+        });
       }
       let message;
+      const expectedTypes = xlrNode.or.map((node) => node.name ?? node.title ?? node.type ?? "<unnamed type>").join(" | ");
       if (xlrNode.name) {
         message = `Does not match any of the expected types for type: '${xlrNode.name}'`;
       } else if (xlrNode.title) {
         message = `Does not match any of the expected types for property: '${xlrNode.title}'`;
       } else {
-        message = `Does not match any of the types ${xlrNode.or.map((node) => node.name ?? node.title ?? "<unnamed type>").join(" | ")}`;
+        message = `Does not match any of the types: ${expectedTypes}`;
       }
+      const { infoMessage } = this.generateNestedTypesInfo(
+        potentialTypeErrors,
+        xlrNode,
+        rootNode
+      );
       validationIssues.push({
         type: "value",
         node: rootNode,
-        message
+        message: message.trim(),
+        severity: 1 /* Error */
       });
+      if (infoMessage) {
+        validationIssues.push({
+          type: "value",
+          node: rootNode,
+          message: infoMessage,
+          severity: 3 /* Info */
+        });
+      }
     } else if (xlrNode.type === "and") {
       const effectiveType = {
         ...this.computeIntersectionType(xlrNode.and),
@@ -149,7 +185,8 @@ var XLRValidator = class {
         validationIssues.push({
           type: "unknown",
           node: rootNode,
-          message: `Type "${xlrNode.ref}" is not defined in provided bundles`
+          message: `Type "${xlrNode.ref}" is not defined in provided bundles`,
+          severity: 1 /* Error */
         });
       } else {
         validationIssues.push(
@@ -162,13 +199,17 @@ var XLRValidator = class {
           validationIssues.push({
             type: "type",
             node: rootNode.parent,
-            message: `Expected "${xlrNode.const}" but got "${rootNode.value}"`
+            message: `Expected "${xlrNode.const}" but got "${rootNode.value}"`,
+            expected: xlrNode.const,
+            severity: 1 /* Error */
           });
         } else {
           validationIssues.push({
             type: "type",
             node: rootNode.parent,
-            message: `Expected type "${xlrNode.type}" but got "${rootNode.type}"`
+            message: `Expected type "${xlrNode.type}" but got "${rootNode.type}"`,
+            expected: xlrNode.type,
+            severity: 1 /* Error */
           });
         }
       }
@@ -201,12 +242,45 @@ var XLRValidator = class {
     }
     return validationIssues;
   }
+  generateNestedTypesInfo(potentialTypeErrors, xlrNode, rootNode) {
+    const nestedTypes = /* @__PURE__ */ new Set();
+    potentialTypeErrors.forEach((typeError) => {
+      if (typeError.type.type !== "template") {
+        typeError.errors.forEach((error) => {
+          if (error.type === "type" && error.expected) {
+            String(error.expected).split(" | ").forEach((val) => nestedTypes.add(val.trim()));
+          }
+        });
+      }
+    });
+    if (nestedTypes.size === 0) {
+      xlrNode.or.forEach((type) => {
+        const typeName = type.name ?? type.title ?? type.type ?? "<unnamed type>";
+        nestedTypes.add(typeName);
+      });
+    }
+    const nestedTypesArray = [...nestedTypes];
+    let nestedTypesList = nestedTypesArray.slice(0, MAX_VALID_SHOWN).join(" | ") + (nestedTypesArray.length > MAX_VALID_SHOWN ? ` | +${nestedTypesArray.length - MAX_VALID_SHOWN} ... ${nestedTypesArray.pop()}` : "");
+    const docsURL = this.config.urlMapping;
+    if (docsURL && xlrNode.name && docsURL[xlrNode.name]) {
+      nestedTypesList = docsURL[xlrNode.name];
+    }
+    let infoMessage;
+    if (rootNode.value !== void 0) {
+      infoMessage = `Got: ${rootNode.value} and expected: ${nestedTypesList}`;
+    } else if (nestedTypesList) {
+      infoMessage = `Expected: ${nestedTypesList}`;
+    }
+    return { nestedTypesList, infoMessage };
+  }
   validateTemplate(node, xlrNode) {
     if (node.type !== "string") {
       return {
         type: "type",
         node: node.parent,
-        message: `Expected type "${xlrNode.type}" but got "${typeof node}"`
+        message: `Expected type "${xlrNode.type}" but got "${typeof node}"`,
+        expected: xlrNode.type,
+        severity: 1 /* Error */
       };
     }
     const regex = this.getRegex(xlrNode.format);
@@ -215,7 +289,9 @@ var XLRValidator = class {
       return {
         type: "value",
         node: node.parent,
-        message: `Does not match expected format: ${xlrNode.format}`
+        message: `Does not match expected format: ${xlrNode.format}`,
+        expected: xlrNode.format,
+        severity: 1 /* Error */
       };
     }
   }
@@ -236,7 +312,8 @@ var XLRValidator = class {
         issues.push({
           type: "missing",
           node,
-          message: `Property "${prop}" missing from type "${xlrNode.name}"`
+          message: `Property "${prop}" missing from type "${xlrNode.name}"`,
+          severity: 1 /* Error */
         });
       }
       if (valueNode) {
@@ -254,7 +331,8 @@ var XLRValidator = class {
         node,
         message: `Unexpected properties on "${xlrNode.name}": ${extraKeys.join(
           ", "
-        )}`
+        )}`,
+        severity: 1 /* Error */
       });
     } else {
       issues.push(
@@ -321,6 +399,7 @@ var XLRValidator = class {
   computeIntersectionType(types) {
     let firstElement = types[0];
     let effectiveType;
+    const topLevelTypeName = types[0].name;
     if (firstElement.type === "ref") {
       firstElement = this.getRefType(firstElement);
     }
@@ -360,18 +439,32 @@ var XLRValidator = class {
         } else {
           effectiveType = {
             ...effectiveType,
-            or: effectiveType.or.map(
-              (y) => this.computeIntersectionType([y, typeToApply])
-            )
+            or: effectiveType.or.map((y) => {
+              const intersectedType = this.computeIntersectionType([
+                y,
+                typeToApply
+              ]);
+              if (!intersectedType.name && topLevelTypeName) {
+                intersectedType.name = topLevelTypeName;
+              }
+              return intersectedType;
+            })
           };
         }
       } else if (typeToApply.type === "or") {
         if (effectiveType.type === "object") {
           effectiveType = {
             ...typeToApply,
-            or: typeToApply.or.map(
-              (y) => this.computeIntersectionType([y, effectiveType])
-            )
+            or: typeToApply.or.map((y) => {
+              const intersectedType = this.computeIntersectionType([
+                y,
+                effectiveType
+              ]);
+              if (!intersectedType.name && topLevelTypeName) {
+                intersectedType.name = topLevelTypeName;
+              }
+              return intersectedType;
+            })
           };
         } else {
           throw new Error("unimplemented operation or x or projection");
@@ -382,6 +475,9 @@ var XLRValidator = class {
         );
       }
     });
+    if (effectiveType.type === "or" && !effectiveType.name && topLevelTypeName) {
+      effectiveType.name = topLevelTypeName;
+    }
     return effectiveType;
   }
 };
@@ -855,6 +951,7 @@ ${nodeText}`;
 };
 export {
   BasicXLRRegistry,
+  ValidationSeverity,
   XLRSDK,
   simpleTransformGenerator,
   xlrTransformWalker