@player-tools/xlr-sdk 0.4.1 → 0.4.2--canary.63.1250

package/dist/index.cjs.js

@@ -126,7 +126,10 @@ class XLRValidator {
         });
       }
     } else if (xlrNode.type === "template") {
-      this.validateTemplate(rootNode, xlrNode);
+      const error = this.validateTemplate(rootNode, xlrNode);
+      if (error) {
+        validationIssues.push(error);
+      }
     } else if (xlrNode.type === "or") {
       for (const potentialType of xlrNode.or) {
         const potentialErrors = this.validateType(rootNode, potentialType);
@@ -226,34 +229,29 @@ class XLRValidator {
   validateObject(xlrNode, node) {
     const issues = [];
     const objectProps = xlrUtils.makePropertyMap(node);
-    let effectiveXLRNode = xlrNode;
-    if (xlrNode.extends) {
-      const extendedNode = this.getRefType(xlrNode.extends);
-      effectiveXLRNode = xlrUtils.computeEffectiveObject(extendedNode, xlrNode);
-    }
-    for (const prop in effectiveXLRNode.properties) {
-      const expectedType = effectiveXLRNode.properties[prop];
+    for (const prop in xlrNode.properties) {
+      const expectedType = xlrNode.properties[prop];
       const valueNode = objectProps.get(prop);
       if (expectedType.required && valueNode === void 0) {
         issues.push({
           type: "missing",
           node,
-          message: `Property '${prop}' missing from type '${effectiveXLRNode.name}'`
+          message: `Property '${prop}' missing from type '${xlrNode.name}'`
         });
       }
       if (valueNode) {
         issues.push(...this.validateType(valueNode, expectedType.node));
       }
     }
-    const extraKeys = Array.from(objectProps.keys()).filter((key) => effectiveXLRNode.properties[key] === void 0);
-    if (effectiveXLRNode.additionalProperties === false && extraKeys.length > 0) {
+    const extraKeys = Array.from(objectProps.keys()).filter((key) => xlrNode.properties[key] === void 0);
+    if (xlrNode.additionalProperties === false && extraKeys.length > 0) {
       issues.push({
         type: "value",
         node,
-        message: `Unexpected properties on '${effectiveXLRNode.name}': ${extraKeys.join(", ")}`
+        message: `Unexpected properties on '${xlrNode.name}': ${extraKeys.join(", ")}`
       });
     } else {
-      issues.push(...extraKeys.flatMap((key) => this.validateType(objectProps.get(key), effectiveXLRNode.additionalProperties)));
+      issues.push(...extraKeys.flatMap((key) => this.validateType(objectProps.get(key), xlrNode.additionalProperties)));
     }
     return issues;
   }
@@ -518,9 +516,11 @@ class XLRSDK {
     this.registry = customRegistry != null ? customRegistry : new BasicXLRRegistry();
     this.validator = new XLRValidator(this.getType.bind(this));
     this.tsWriter = new xlrConverters.TSWriter();
+    this.computedNodeCache = new Map();
   }
   loadDefinitionsFromDisk(inputPath, filters, transforms) {
     var _a;
+    this.computedNodeCache.clear();
     const manifest = JSON.parse(fs__default["default"].readFileSync(path__default["default"].join(inputPath, "xlr", "manifest.json")).toString(), (key, value) => {
       if (typeof value === "object" && value !== null) {
         if (key === "capabilities") {
@@ -545,6 +545,7 @@ class XLRSDK {
   loadDefinitionsFromModule(manifest, filters, transforms) {
     return __async(this, null, function* () {
       var _a;
+      this.computedNodeCache.clear();
       (_a = Object.keys(manifest.capabilities)) == null ? void 0 : _a.forEach((capabilityName) => {
         if ((filters == null ? void 0 : filters.capabilityFilter) && capabilityName.match(filters == null ? void 0 : filters.capabilityFilter))
           return;
@@ -564,8 +565,12 @@ class XLRSDK {
     if ((options == null ? void 0 : options.getRawType) === true || !type) {
       return type;
     }
-    type = this.resolveType(type);
-    return xlrUtils.fillInGenerics(type);
+    if (this.computedNodeCache.has(id)) {
+      return this.computedNodeCache.get(id);
+    }
+    type = xlrUtils.fillInGenerics(this.resolveType(type));
+    this.computedNodeCache.set(id, type);
+    return type;
   }
   hasType(id) {
     return this.registry.has(id);
@@ -577,7 +582,7 @@ class XLRSDK {
     return this.registry.info(id);
   }
   validateByName(typeName, rootNode) {
-    const xlr = this.getType(typeName, { getRawType: true });
+    const xlr = this.getType(typeName);
     if (!xlr) {
       throw new Error(`Type ${typeName} does not exist in registry, can't validate`);
     }

package/dist/index.d.ts

@@ -61,6 +61,7 @@ declare class XLRSDK {
     private registry;
     private validator;
     private tsWriter;
+    private computedNodeCache;
     constructor(customRegistry?: XLRRegistry);
     /**
      * Loads definitions from a path on the filesystem

package/dist/index.esm.js

@@ -1,4 +1,4 @@
-import { isPrimitiveTypeNode, resolveConditional, makePropertyMap, computeEffectiveObject, resolveReferenceNode, fillInGenerics } from '@player-tools/xlr-utils';
+import { isPrimitiveTypeNode, resolveConditional, makePropertyMap, resolveReferenceNode, computeEffectiveObject, fillInGenerics } from '@player-tools/xlr-utils';
 import { TSWriter } from '@player-tools/xlr-converters';
 import fs from 'fs';
 import path from 'path';
@@ -116,7 +116,10 @@ class XLRValidator {
         });
       }
     } else if (xlrNode.type === "template") {
-      this.validateTemplate(rootNode, xlrNode);
+      const error = this.validateTemplate(rootNode, xlrNode);
+      if (error) {
+        validationIssues.push(error);
+      }
     } else if (xlrNode.type === "or") {
       for (const potentialType of xlrNode.or) {
         const potentialErrors = this.validateType(rootNode, potentialType);
@@ -216,34 +219,29 @@ class XLRValidator {
   validateObject(xlrNode, node) {
     const issues = [];
     const objectProps = makePropertyMap(node);
-    let effectiveXLRNode = xlrNode;
-    if (xlrNode.extends) {
-      const extendedNode = this.getRefType(xlrNode.extends);
-      effectiveXLRNode = computeEffectiveObject(extendedNode, xlrNode);
-    }
-    for (const prop in effectiveXLRNode.properties) {
-      const expectedType = effectiveXLRNode.properties[prop];
+    for (const prop in xlrNode.properties) {
+      const expectedType = xlrNode.properties[prop];
       const valueNode = objectProps.get(prop);
       if (expectedType.required && valueNode === void 0) {
         issues.push({
           type: "missing",
           node,
-          message: `Property '${prop}' missing from type '${effectiveXLRNode.name}'`
+          message: `Property '${prop}' missing from type '${xlrNode.name}'`
         });
       }
       if (valueNode) {
         issues.push(...this.validateType(valueNode, expectedType.node));
       }
     }
-    const extraKeys = Array.from(objectProps.keys()).filter((key) => effectiveXLRNode.properties[key] === void 0);
-    if (effectiveXLRNode.additionalProperties === false && extraKeys.length > 0) {
+    const extraKeys = Array.from(objectProps.keys()).filter((key) => xlrNode.properties[key] === void 0);
+    if (xlrNode.additionalProperties === false && extraKeys.length > 0) {
       issues.push({
         type: "value",
         node,
-        message: `Unexpected properties on '${effectiveXLRNode.name}': ${extraKeys.join(", ")}`
+        message: `Unexpected properties on '${xlrNode.name}': ${extraKeys.join(", ")}`
       });
     } else {
-      issues.push(...extraKeys.flatMap((key) => this.validateType(objectProps.get(key), effectiveXLRNode.additionalProperties)));
+      issues.push(...extraKeys.flatMap((key) => this.validateType(objectProps.get(key), xlrNode.additionalProperties)));
     }
     return issues;
   }
@@ -508,9 +506,11 @@ class XLRSDK {
     this.registry = customRegistry != null ? customRegistry : new BasicXLRRegistry();
     this.validator = new XLRValidator(this.getType.bind(this));
     this.tsWriter = new TSWriter();
+    this.computedNodeCache = new Map();
   }
   loadDefinitionsFromDisk(inputPath, filters, transforms) {
     var _a;
+    this.computedNodeCache.clear();
     const manifest = JSON.parse(fs.readFileSync(path.join(inputPath, "xlr", "manifest.json")).toString(), (key, value) => {
       if (typeof value === "object" && value !== null) {
         if (key === "capabilities") {
@@ -535,6 +535,7 @@ class XLRSDK {
   loadDefinitionsFromModule(manifest, filters, transforms) {
     return __async(this, null, function* () {
       var _a;
+      this.computedNodeCache.clear();
       (_a = Object.keys(manifest.capabilities)) == null ? void 0 : _a.forEach((capabilityName) => {
         if ((filters == null ? void 0 : filters.capabilityFilter) && capabilityName.match(filters == null ? void 0 : filters.capabilityFilter))
           return;
@@ -554,8 +555,12 @@ class XLRSDK {
     if ((options == null ? void 0 : options.getRawType) === true || !type) {
       return type;
     }
-    type = this.resolveType(type);
-    return fillInGenerics(type);
+    if (this.computedNodeCache.has(id)) {
+      return this.computedNodeCache.get(id);
+    }
+    type = fillInGenerics(this.resolveType(type));
+    this.computedNodeCache.set(id, type);
+    return type;
   }
   hasType(id) {
     return this.registry.has(id);
@@ -567,7 +572,7 @@ class XLRSDK {
     return this.registry.info(id);
   }
   validateByName(typeName, rootNode) {
-    const xlr = this.getType(typeName, { getRawType: true });
+    const xlr = this.getType(typeName);
     if (!xlr) {
       throw new Error(`Type ${typeName} does not exist in registry, can't validate`);
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@player-tools/xlr-sdk",
-  "version": "0.4.1",
+  "version": "0.4.2--canary.63.1250",
   "private": false,
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
@@ -9,9 +9,9 @@
     "typescript": "4.8.4"
   },
   "dependencies": {
-    "@player-tools/xlr": "0.4.1",
-    "@player-tools/xlr-utils": "0.4.1",
-    "@player-tools/xlr-converters": "0.4.1",
+    "@player-tools/xlr": "0.4.2--canary.63.1250",
+    "@player-tools/xlr-utils": "0.4.2--canary.63.1250",
+    "@player-tools/xlr-converters": "0.4.2--canary.63.1250",
     "jsonc-parser": "^2.3.1",
     "@types/node": "^16.11.12",
     "@types/fs-extra": "^9.0.13",

package/src/sdk.ts

@@ -36,11 +36,13 @@ export class XLRSDK {
   private registry: XLRRegistry;
   private validator: XLRValidator;
   private tsWriter: TSWriter;
+  private computedNodeCache: Map<string, NodeType>;
 
   constructor(customRegistry?: XLRRegistry) {
     this.registry = customRegistry ?? new BasicXLRRegistry();
     this.validator = new XLRValidator(this.getType.bind(this));
     this.tsWriter = new TSWriter();
+    this.computedNodeCache = new Map();
   }
 
   /**
@@ -55,6 +57,8 @@ export class XLRSDK {
     filters?: Omit<Filters, 'pluginFilter'>,
     transforms?: Array<TransformFunction>
   ) {
+    this.computedNodeCache.clear();
+
     const manifest = JSON.parse(
       fs.readFileSync(path.join(inputPath, 'xlr', 'manifest.json')).toString(),
       (key: unknown, value: unknown) => {
@@ -112,6 +116,8 @@ export class XLRSDK {
     filters?: Omit<Filters, 'pluginFilter'>,
     transforms?: Array<TransformFunction>
   ) {
+    this.computedNodeCache.clear();
+
     Object.keys(manifest.capabilities)?.forEach((capabilityName) => {
       if (
         filters?.capabilityFilter &&
@@ -156,9 +162,15 @@ export class XLRSDK {
       return type;
     }
 
-    type = this.resolveType(type);
+    if (this.computedNodeCache.has(id)) {
+      return this.computedNodeCache.get(id) as NamedType<NodeType> | undefined;
+    }
+
+    type = fillInGenerics(this.resolveType(type)) as NamedType;
+
+    this.computedNodeCache.set(id, type);
 
-    return fillInGenerics(type) as NamedType;
+    return type;
   }
 
   /**
@@ -199,7 +211,7 @@ export class XLRSDK {
    * @returns `Array<ValidationErrors>`
    */
   public validateByName(typeName: string, rootNode: Node) {
-    const xlr = this.getType(typeName, { getRawType: true });
+    const xlr = this.getType(typeName);
     if (!xlr) {
       throw new Error(
         `Type ${typeName} does not exist in registry, can't validate`
@@ -258,7 +270,7 @@ export class XLRSDK {
     throw new Error(`Unknown export format ${exportType}`);
   }
 
-  private resolveType(type: NodeType) {
+  private resolveType(type: NodeType): NamedType {
     return simpleTransformGenerator('object', 'any', (objectNode) => {
       if (objectNode.extends) {
         const refName = objectNode.extends.ref.split('<')[0];

package/src/validator.ts

@@ -57,7 +57,10 @@ export class XLRValidator {
         });
       }
     } else if (xlrNode.type === 'template') {
-      this.validateTemplate(rootNode, xlrNode);
+      const error = this.validateTemplate(rootNode, xlrNode);
+      if (error) {
+        validationIssues.push(error);
+      }
     } else if (xlrNode.type === 'or') {
       // eslint-disable-next-line no-restricted-syntax
       for (const potentialType of xlrNode.or) {
@@ -193,22 +196,15 @@ export class XLRValidator {
     const issues: Array<ValidationError> = [];
     const objectProps = makePropertyMap(node);
 
-    let effectiveXLRNode = xlrNode;
-
-    if (xlrNode.extends) {
-      const extendedNode = this.getRefType(xlrNode.extends) as ObjectType;
-      effectiveXLRNode = computeEffectiveObject(extendedNode, xlrNode);
-    }
-
     // eslint-disable-next-line guard-for-in, no-restricted-syntax
-    for (const prop in effectiveXLRNode.properties) {
-      const expectedType = effectiveXLRNode.properties[prop];
+    for (const prop in xlrNode.properties) {
+      const expectedType = xlrNode.properties[prop];
       const valueNode = objectProps.get(prop);
       if (expectedType.required && valueNode === undefined) {
         issues.push({
           type: 'missing',
           node,
-          message: `Property '${prop}' missing from type '${effectiveXLRNode.name}'`,
+          message: `Property '${prop}' missing from type '${xlrNode.name}'`,
         });
       }
 
@@ -221,25 +217,22 @@ export class XLRValidator {
 
     // Check if unknown keys are allowed and if they are - do the violate the constraint
     const extraKeys = Array.from(objectProps.keys()).filter(
-      (key) => effectiveXLRNode.properties[key] === undefined
+      (key) => xlrNode.properties[key] === undefined
     );
-    if (
-      effectiveXLRNode.additionalProperties === false &&
-      extraKeys.length > 0
-    ) {
+    if (xlrNode.additionalProperties === false && extraKeys.length > 0) {
       issues.push({
         type: 'value',
         node,
-        message: `Unexpected properties on '${
-          effectiveXLRNode.name
-        }': ${extraKeys.join(', ')}`,
+        message: `Unexpected properties on '${xlrNode.name}': ${extraKeys.join(
+          ', '
+        )}`,
       });
     } else {
       issues.push(
         ...extraKeys.flatMap((key) =>
           this.validateType(
             objectProps.get(key) as Node,
-            effectiveXLRNode.additionalProperties as NodeType
+            xlrNode.additionalProperties as NodeType
           )
         )
       );