@teleporthq/teleport-uidl-validator 0.18.0

package/dist/esm/validator/index.js

@@ -0,0 +1,73 @@
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
+};
+import { ProjectValidationError, ComponentValidationError, } from '@teleporthq/teleport-types';
+import { componentUIDLDecoder, rootComponentUIDLDecoder, projectUIDLDecoder } from '../decoders';
+import * as utils from './utils';
+var Validator = /** @class */ (function () {
+    function Validator() {
+    }
+    Validator.prototype.validateComponentSchema = function (input) {
+        try {
+            var cleanedUIDL = utils.validateNulls(input);
+            var uidl = componentUIDLDecoder.runWithException(cleanedUIDL);
+            return { valid: true, errorMsg: '', componentUIDL: uidl };
+        }
+        catch (e) {
+            var errorMsg = utils.formatErrors([{ kind: e.kind, message: e.message, at: e.at }]);
+            throw new ComponentValidationError("Component - " + (input === null || input === void 0 ? void 0 : input.name) + " \n\n      " + errorMsg);
+        }
+    };
+    Validator.prototype.validateRootComponentSchema = function (input) {
+        try {
+            var cleanedUIDL = utils.validateNulls(input);
+            var uidl = rootComponentUIDLDecoder.runWithException(cleanedUIDL);
+            return { valid: true, errorMsg: '', componentUIDL: uidl };
+        }
+        catch (e) {
+            var errorMsg = utils.formatErrors([{ kind: e.kind, message: e.message, at: e.at }]);
+            throw new ComponentValidationError("Component - " + (input === null || input === void 0 ? void 0 : input.name) + "\n\n      " + errorMsg);
+        }
+    };
+    Validator.prototype.validateProjectSchema = function (input) {
+        try {
+            var cleanedUIDL = utils.validateNulls(input);
+            var uidl = projectUIDLDecoder.runWithException(cleanedUIDL);
+            return { valid: true, errorMsg: '', projectUIDL: uidl };
+        }
+        catch (e) {
+            var errorMsg = utils.formatErrors([{ kind: e.kind, message: e.message, at: e.at }]);
+            throw new ProjectValidationError(input.name + "\n\n      " + errorMsg);
+        }
+    };
+    Validator.prototype.validateComponentContent = function (input) {
+        var errorsInDefinitions = utils.checkDynamicDefinitions(input);
+        var errorsWithLocalVariables = utils.checkForLocalVariables(input);
+        utils.checkForDuplicateDefinitions(input);
+        var errors = __spreadArray(__spreadArray([], errorsInDefinitions), errorsWithLocalVariables);
+        if (errors.length > 0) {
+            throw new ComponentValidationError("UIDL Component Content Validation Error. Please check the following: \n" + errors);
+        }
+        return { valid: true, errorMsg: '' };
+    };
+    Validator.prototype.validateProjectContent = function (input) {
+        var errorsOnRouteNode = utils.checkRouteDefinition(input) || [];
+        var allErrors = errorsOnRouteNode;
+        if (errorsOnRouteNode.length === 0) {
+            var errorsInStyleSet = utils.checkProjectStyleSet(input);
+            var errorsInRootComponent = utils.checkRootComponent(input);
+            var errorsWithComponentNaming = utils.checkComponentNaming(input);
+            var errorsWtihComponentExistence = utils.checkComponentExistenceAndReferences(input);
+            allErrors = __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], errorsOnRouteNode), errorsWtihComponentExistence), errorsWithComponentNaming), errorsInRootComponent), errorsInStyleSet);
+        }
+        if (allErrors.length > 0) {
+            throw new ProjectValidationError("UIDL Project Content Validation Error. Please check the following: " + allErrors);
+        }
+        return { valid: true, errorMsg: '' };
+    };
+    return Validator;
+}());
+export default Validator;
+//# sourceMappingURL=index.js.map

package/dist/esm/validator/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/validator/index.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAGL,sBAAsB,EACtB,wBAAwB,GAGzB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAA;AAChG,OAAO,KAAK,KAAK,MAAM,SAAS,CAAA;AAShC;IAAA;IAsFA,CAAC;IArFQ,2CAAuB,GAA9B,UAA+B,KAA8B;QAC3D,IAAI;YACF,IAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC9C,IAAM,IAAI,GAAG,oBAAoB,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;YAE/D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAA;SAC1D;QAAC,OAAO,CAAC,EAAE;YACV,IAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;YACrF,MAAM,IAAI,wBAAwB,CAAC,kBAAe,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,oBAC3D,QAAU,CAAC,CAAA;SACd;IACH,CAAC;IAEM,+CAA2B,GAAlC,UAAmC,KAA8B;QAC/D,IAAI;YACF,IAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC9C,IAAM,IAAI,GAAG,wBAAwB,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;YAEnE,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAA;SAC1D;QAAC,OAAO,CAAC,EAAE;YACV,IAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;YACrF,MAAM,IAAI,wBAAwB,CAAC,kBAAe,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,IAAI,mBAC3D,QAAU,CAAC,CAAA;SACd;IACH,CAAC;IAEM,yCAAqB,GAA5B,UAA6B,KAA8B;QACzD,IAAI;YACF,IAAM,WAAW,GAAG,KAAK,CAAC,aAAa,CAAC,KAAK,CAAC,CAAA;YAC9C,IAAM,IAAI,GAAG,kBAAkB,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAA;YAE7D,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE,CAAA;SACxD;QAAC,OAAO,CAAC,EAAE;YACV,IAAM,QAAQ,GAAG,KAAK,CAAC,YAAY,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAA;YACrF,MAAM,IAAI,sBAAsB,CAAI,KAAK,CAAC,IAAI,kBAC5C,QAAU,CAAC,CAAA;SACd;IACH,CAAC;IAEM,4CAAwB,GAA/B,UAAgC,KAAoB;QAClD,IAAM,mBAAmB,GAAG,KAAK,CAAC,uBAAuB,CACvD,KAA2C,CAC5C,CAAA;QACD,IAAM,wBAAwB,GAAG,KAAK,CAAC,sBAAsB,CAAC,KAAK,CAAC,CAAA;QAEpE,KAAK,CAAC,4BAA4B,CAAC,KAAK,CAAC,CAAA;QACzC,IAAM,MAAM,mCAAO,mBAAmB,GAAK,wBAAwB,CAAC,CAAA;QAEpE,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE;YACrB,MAAM,IAAI,wBAAwB,CAChC,4EAA0E,MAAQ,CACnF,CAAA;SACF;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IACtC,CAAC;IAEM,0CAAsB,GAA7B,UAA8B,KAAkB;QAC9C,IAAM,iBAAiB,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAA;QACjE,IAAI,SAAS,GAAG,iBAAiB,CAAA;QAEjC,IAAI,iBAAiB,CAAC,MAAM,KAAK,CAAC,EAAE;YAClC,IAAM,gBAAgB,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;YAC1D,IAAM,qBAAqB,GAAG,KAAK,CAAC,kBAAkB,CAAC,KAAK,CAAC,CAAA;YAE7D,IAAM,yBAAyB,GAAG,KAAK,CAAC,oBAAoB,CAAC,KAAK,CAAC,CAAA;YACnE,IAAM,4BAA4B,GAAG,KAAK,CAAC,oCAAoC,CAAC,KAAK,CAAC,CAAA;YAEtF,SAAS,6EACJ,iBAAiB,GACjB,4BAA4B,GAC5B,yBAAyB,GACzB,qBAAqB,GACrB,gBAAgB,CACpB,CAAA;SACF;QAED,IAAI,SAAS,CAAC,MAAM,GAAG,CAAC,EAAE;YACxB,MAAM,IAAI,sBAAsB,CAC9B,wEAAsE,SAAW,CAClF,CAAA;SACF;QAED,OAAO,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAA;IACtC,CAAC;IACH,gBAAC;AAAD,CAAC,AAtFD,IAsFC"}

package/dist/esm/validator/utils.d.ts

@@ -0,0 +1,16 @@
+import { ProjectUIDL, ComponentUIDL, UIDLStaticValue, UIDLStyleSetTokenReference } from '@teleporthq/teleport-types';
+export declare const checkForDuplicateDefinitions: (input: ComponentUIDL) => void;
+export declare const checkForLocalVariables: (input: ComponentUIDL) => string[];
+export declare const checkDynamicDefinitions: (input: Record<string, unknown>) => string[];
+export declare const checkRouteDefinition: (input: ProjectUIDL) => string[];
+export declare const checkComponentExistenceAndReferences: (input: ProjectUIDL) => string[];
+export declare const checkComponentNaming: (input: ProjectUIDL) => string[];
+export declare const checkProjectStyleSet: (input: ProjectUIDL) => string[];
+export declare const checStylekContentForErrors: (content: Record<string, UIDLStaticValue | UIDLStyleSetTokenReference>) => string[];
+export declare const checkRootComponent: (input: ProjectUIDL) => string[];
+export declare const formatErrors: (errors: Array<{
+    kind: string;
+    at: string;
+    message: string;
+}>) => string;
+export declare const validateNulls: (uidl: Record<string, unknown>) => any;

package/dist/esm/validator/utils.js

@@ -0,0 +1,359 @@
+var __spreadArray = (this && this.__spreadArray) || function (to, from) {
+    for (var i = 0, il = from.length, j = to.length; i < il; i++, j++)
+        to[j] = from[i];
+    return to;
+};
+import { UIDLUtils } from '@teleporthq/teleport-shared';
+import { ComponentValidationError, } from '@teleporthq/teleport-types';
+// Prop definitions and state definitions should have different keys
+export var checkForDuplicateDefinitions = function (input) {
+    var props = Object.keys(input.propDefinitions || {});
+    var states = Object.keys(input.stateDefinitions || {});
+    var imports = Object.keys(input.importDefinitions || {});
+    props
+        .filter(function (x) { return states.includes(x) || imports.includes(x); })
+        .forEach(function (duplicate) {
+        return console.warn("\n\"" + duplicate + "\" is defined both as a prop and as a state. If you are using VUE Code Generators this can cause bad behavior.");
+    });
+};
+// In "repeat" node:
+// If index is used, "useIndex" must be declared in "meta"
+// If custom local variable is used, it's name must be specified inside "meta" as "iteratorName"
+export var checkForLocalVariables = function (input) {
+    var errors = [];
+    UIDLUtils.traverseRepeats(input.node, function (repeatContent) {
+        UIDLUtils.traverseNodes(repeatContent.node, function (childNode) {
+            if (childNode.type === 'dynamic' && childNode.content.referenceType === 'local') {
+                if (childNode.content.id === 'index') {
+                    if (!repeatContent.meta.useIndex) {
+                        var errorMsg = "\nIndex variable is used but the \"useIndex\" meta information is false.";
+                        errors.push(errorMsg);
+                    }
+                    // we are dealing with local index here
+                    return;
+                }
+                if (!validLocalVariableUsage(childNode.content.id, repeatContent.meta.iteratorName)) {
+                    var errorMsg = "\n\"" + childNode.content.id + "\" is used in the \"repeat\" structure but the iterator name has this value: \"" + repeatContent.meta.iteratorName + "\"";
+                    errors.push(errorMsg);
+                }
+            }
+        });
+    });
+    return errors;
+};
+var validLocalVariableUsage = function (dynamicId, repeatIteratorName) {
+    var iteratorName = repeatIteratorName || 'item';
+    if (!dynamicId.includes('.')) {
+        return dynamicId === iteratorName;
+    }
+    var dynamicIdRoot = dynamicId.split('.')[0];
+    return dynamicIdRoot === iteratorName;
+};
+/* All referenced props, states and importRefs should be previously defined in the
+ "propDefinitions" and "stateDefinitions" and "importDefinitions" sections
+ If props or states are defined and not used, a warning witll be displayed */
+export var checkDynamicDefinitions = function (input) {
+    var _a;
+    var propKeys = Object.keys(input.propDefinitions || {});
+    var stateKeys = Object.keys(input.stateDefinitions || {});
+    var importKeys = Object.keys(input.importDefinitions || {});
+    var componentStyleSetKyes = Object.keys(input.styleSetDefinitions || {});
+    var importDefinitions = ((_a = input === null || input === void 0 ? void 0 : input.importDefinitions) !== null && _a !== void 0 ? _a : {});
+    if (Object.keys(importKeys).length > 0) {
+        importKeys = importKeys.reduce(function (acc, importRef) {
+            var _a, _b;
+            if ((_b = (_a = importDefinitions[importRef]) === null || _a === void 0 ? void 0 : _a.meta) === null || _b === void 0 ? void 0 : _b.importJustPath) {
+                return acc;
+            }
+            acc.push(importRef);
+            return acc;
+        }, []);
+    }
+    var usedPropKeys = [];
+    var usedStateKeys = [];
+    var usedImportKeys = [];
+    var errors = [];
+    UIDLUtils.traverseNodes(input.node, function (node) {
+        var _a, _b, _c, _d;
+        if (node.type === 'element') {
+            Object.keys(((_a = node.content) === null || _a === void 0 ? void 0 : _a.events) || {}).forEach(function (eventKey) {
+                node.content.events[eventKey].forEach(function (event) {
+                    if (event.type === 'stateChange' && !stateKeys.includes(event.modifies)) {
+                        var errorMsg = "\"" + event.modifies + "\" is used in events, but not defined. Please add it in stateDefinitions";
+                        errors.push(errorMsg);
+                        return;
+                    }
+                    if (event.type === 'propCall' && !propKeys.includes(event.calls)) {
+                        errors.push("\"" + event.calls + "\" is used in events, but missing from propDefinitons. Please add it in propDefinitions ");
+                        return;
+                    }
+                });
+            });
+            var dynamicVariants_1 = [];
+            Object.values(((_b = node.content) === null || _b === void 0 ? void 0 : _b.referencedStyles) || {}).forEach(function (styleRef) {
+                if (styleRef.content.mapType === 'component-referenced' &&
+                    styleRef.content.content.type === 'dynamic') {
+                    if (styleRef.content.content.content.referenceType === 'prop') {
+                        var referencedProp = styleRef.content.content.content.id;
+                        if (!dynamicPathExistsInDefinitions(referencedProp, propKeys)) {
+                            var errorMsg = "\"" + referencedProp + "\" is used but not defined. Please add it in propDefinitions";
+                            errors.push(errorMsg);
+                            return;
+                        }
+                        dynamicVariants_1.push(referencedProp);
+                        usedPropKeys.push(referencedProp);
+                    }
+                    if (styleRef.content.content.content.referenceType === 'comp') {
+                        var compStyleRefId = styleRef.content.content.content.id;
+                        if (!componentStyleSetKyes.includes(compStyleRefId)) {
+                            errors.push(compStyleRefId + " is used, but not defined in Component Style Sheet in " + input.name + ". Please add it in StyleSetDefinitions of the component");
+                        }
+                    }
+                }
+            });
+            if (dynamicVariants_1.length > 1) {
+                errors.push("Node " + (((_c = node.content) === null || _c === void 0 ? void 0 : _c.name) || ((_d = node.content) === null || _d === void 0 ? void 0 : _d.key)) + " is using multiple dynamic variants using propDefinitions.\n        We can have only one dynamic variant at once");
+            }
+        }
+        if (node.type === 'dynamic' && node.content.referenceType === 'prop') {
+            if (!dynamicPathExistsInDefinitions(node.content.id, propKeys)) {
+                var errorMsg = "\"" + node.content.id + "\" is used but not defined. Please add it in propDefinitions";
+                errors.push(errorMsg);
+            }
+            // for member expression we check the root
+            // if value has no `.` it will be checked as it is
+            var dynamicIdRoot = node.content.id.split('.')[0];
+            usedPropKeys.push(dynamicIdRoot);
+        }
+        if (node.type === 'dynamic' && node.content.referenceType === 'state') {
+            if (!dynamicPathExistsInDefinitions(node.content.id, stateKeys)) {
+                var errorMsg = "\n\"" + node.content.id + "\" is used but not defined. Please add it in stateDefinitions";
+                errors.push(errorMsg);
+            }
+            // for member expression we check the root
+            // if value has no `.` it will be checked as it is
+            var dynamicIdRoot = node.content.id.split('.')[0];
+            usedStateKeys.push(dynamicIdRoot);
+        }
+        if (node.type === 'import') {
+            if (!dynamicPathExistsInDefinitions(node.content.id, importKeys)) {
+                var errorMsg = "\n\"" + node.content.id + "\" is used but not defined. Please add it in importDefinitions";
+                errors.push(errorMsg);
+            }
+            // for member expression we check the root
+            // if value has no `.` it will be checked as it is
+            var dynamicIdRoot = node.content.id.split('.')[0];
+            usedImportKeys.push(dynamicIdRoot);
+        }
+    });
+    propKeys
+        .filter(function (x) { return !usedPropKeys.includes(x); })
+        .forEach(function (diff) {
+        return console.warn("\"" + diff + "\" is defined in propDefinitions but it is not used in the UIDL.");
+    });
+    stateKeys
+        .filter(function (x) { return !usedStateKeys.includes(x); })
+        .forEach(function (diff) {
+        return console.warn("\"" + diff + "\" is defined in stateDefinitions but it is not used in the UIDL.");
+    });
+    importKeys
+        .filter(function (x) { return !usedImportKeys.includes(x); })
+        .forEach(function (diff) {
+        return console.warn("\"" + diff + "\" is defined in importDefinitions but it is not used in the UIDL.");
+    });
+    return errors;
+};
+var dynamicPathExistsInDefinitions = function (path, defKeys) {
+    if (!path.includes('.')) {
+        // prop/state is a scalar value, not a dot notation
+        return defKeys.includes(path);
+    }
+    // TODO: Expand validation logic to check if the path exists on the prop/state definition
+    // ex: if prop reference is `user.name`, we should check that prop type is object and has a valid field name
+    var rootIdentifier = path.split('.')[0];
+    return defKeys.includes(rootIdentifier);
+};
+// A projectUIDL must contain "route" key
+export var checkRouteDefinition = function (input) {
+    var errors = [];
+    var keys = Object.keys(input.root.stateDefinitions || {});
+    if (!keys.includes('route')) {
+        var errorMsg = 'Route is not defined in stateDefinitions';
+        errors.push(errorMsg);
+    }
+    return errors;
+};
+// All referenced components inside of the projectUIDL should be defined
+// in the components section and all the project-referenced styles and tokens
+export var checkComponentExistenceAndReferences = function (input) {
+    var _a, _b, _c, _d;
+    var errors = [];
+    var components = Object.keys(input.components || {});
+    var styleSetDefinitions = Object.keys(((_a = input.root) === null || _a === void 0 ? void 0 : _a.styleSetDefinitions) || {});
+    var tokens = Object.keys(((_c = (_b = input.root) === null || _b === void 0 ? void 0 : _b.designLanguage) === null || _c === void 0 ? void 0 : _c.tokens) || {});
+    var nodesToParse = __spreadArray([
+        input.root.node
+    ], Object.values(input.components || {}).map(function (component) { return component.node; }));
+    var usedReferencedStyles = [];
+    if ((_d = input.root) === null || _d === void 0 ? void 0 : _d.styleSetDefinitions) {
+        Object.values(input.root.styleSetDefinitions || {}).forEach(function (style) {
+            var content = style.content, _a = style.conditions, conditions = _a === void 0 ? [] : _a;
+            errors.push.apply(errors, checkForTokensInstyles(content, tokens));
+            conditions.forEach(function (condition) {
+                if (condition === null || condition === void 0 ? void 0 : condition.content) {
+                    errors.push.apply(errors, checkForTokensInstyles(condition.content, tokens));
+                }
+            });
+        });
+    }
+    nodesToParse.forEach(function (node) {
+        UIDLUtils.traverseElements(node, function (element) {
+            /* Checking for project-referenced styles */
+            if (element === null || element === void 0 ? void 0 : element.referencedStyles) {
+                var _a = checkForReferencedStylesUsed(element.referencedStyles, styleSetDefinitions, tokens), errorsInRferences = _a.errorsInRferences, usedStyleRefrences = _a.usedStyleRefrences;
+                errors.push.apply(errors, errorsInRferences);
+                usedReferencedStyles = __spreadArray(__spreadArray([], usedReferencedStyles), usedStyleRefrences);
+            }
+            /* Checking for token references used in styles */
+            if (element === null || element === void 0 ? void 0 : element.style) {
+                errors.push.apply(errors, checkForTokensInstyles(element.style, tokens));
+            }
+            if (element.dependency &&
+                element.dependency.type === 'local' &&
+                !components.includes(element.semanticType)) {
+                var errorMsg = "\nThe component \"" + element.semanticType + "\" is not defined in the UIDL's component section.";
+                errors.push(errorMsg);
+            }
+        });
+    });
+    styleSetDefinitions.forEach(function (key) {
+        if (!usedReferencedStyles.includes(key)) {
+            console.warn(key + " styleSet is defined but not used in the project.");
+        }
+    });
+    return errors;
+};
+var checkForReferencedStylesUsed = function (referencedStyles, styleSetDefinitions, tokens) {
+    var errorsInRferences = [];
+    var usedStyleRefrences = [];
+    Object.values(referencedStyles || {}).forEach(function (styleRef) {
+        var mapType = styleRef.content.mapType;
+        if (mapType === 'inlined') {
+            errorsInRferences.push.apply(errorsInRferences, checkForTokensInstyles(styleRef.content.styles, tokens));
+        }
+        if (mapType === 'project-referenced') {
+            var referenceId = styleRef.content.referenceId;
+            usedStyleRefrences.push(referenceId);
+            if (!styleSetDefinitions.includes(referenceId)) {
+                errorsInRferences.push("\n " + referenceId + " is missing from the styleSetDefinitions, please check the reference id.");
+            }
+        }
+    });
+    return {
+        errorsInRferences: errorsInRferences,
+        usedStyleRefrences: usedStyleRefrences,
+    };
+};
+var checkForTokensInstyles = function (styles, tokens) {
+    var errors = [];
+    Object.values(styles || {}).forEach(function (style) {
+        if (style.type === 'dynamic' &&
+            style.content.referenceType === 'token' &&
+            !tokens.includes(style.content.id)) {
+            errors.push("\nToken " + style.content.id + " is missing from the project UIDL.");
+        }
+    });
+    return errors;
+};
+// All components should have the same key as the value of their name key
+// Example:
+//  "components": {
+//     "OneComponent": {
+//       "name": "OneComponent",
+//    ..
+//      }
+//    }
+export var checkComponentNaming = function (input) {
+    var errors = [];
+    var namesUsed = Object.keys(input.components || {});
+    var diffs = namesUsed.filter(function (name) { return input.components[name].name !== name; });
+    if (diffs.length > 0) {
+        var errorMsg = "\nThe following components have different name than their key: " + diffs;
+        errors.push(errorMsg);
+    }
+    return errors;
+};
+export var checkProjectStyleSet = function (input) {
+    var errors = [];
+    var styleSet = input.root.styleSetDefinitions;
+    if (styleSet) {
+        Object.values(styleSet).forEach(function (styleSetObj) {
+            var content = styleSetObj.content, _a = styleSetObj.conditions, conditions = _a === void 0 ? [] : _a;
+            Object.values(conditions).forEach(function (style) {
+                errors.push.apply(errors, checStylekContentForErrors(style.content));
+            });
+            errors.push.apply(errors, checStylekContentForErrors(content));
+        });
+    }
+    return errors;
+};
+export var checStylekContentForErrors = function (content) {
+    var errors = [];
+    Object.values(content).forEach(function (styleContent) {
+        if (styleContent.type === 'dynamic' && styleContent.content.referenceType !== 'token') {
+            errors.push("Dynamic nodes in styleSetDefinitions supports only tokens");
+        }
+        if (styleContent.type === 'static' &&
+            typeof styleContent.content !== 'string' &&
+            typeof styleContent.content !== 'number') {
+            errors.push("Project Style sheet / styleSetDefinitions only support styles with static \n        content and dynamic tokens, received " + styleContent);
+        }
+    });
+    return errors;
+};
+// The "root" node should contain only elements of type "conditional"
+export var checkRootComponent = function (input) {
+    var errors = [];
+    var routeNaming = [];
+    var rootNode = input.root.node.content;
+    rootNode.children.forEach(function (child) {
+        if (child.type !== 'conditional') {
+            var errorMsg = "\nRoot Node contains elements of type \"" + child.type + "\". It should contain only elements of type \"conditional\"";
+            errors.push(errorMsg);
+        }
+        else {
+            routeNaming.push(child.content.value.toString());
+        }
+    });
+    var routeValues = input.root.stateDefinitions.route.values;
+    if (!routeValues || routeValues.length <= 0) {
+        errors.push('\nThe `route` state definition from the root node does not contain the possible route values');
+    }
+    else {
+        input.root.stateDefinitions.route.values
+            .filter(function (route) { return !routeNaming.includes(route.value.toString()); })
+            .forEach(function (route) {
+            var errorMsg = "\nRoot Node contains a route that don't have a specified state: " + route.value + ".";
+            errors.push(errorMsg);
+        });
+    }
+    return errors;
+};
+// The errors should be displayed in a human-readeable way
+export var formatErrors = function (errors) {
+    var listOfErrors = [];
+    errors.forEach(function (error) {
+        var message = "\n - Path " + error.at + ": " + error.message + ". \n is a " + error.kind + " \n";
+        listOfErrors.push(message);
+    });
+    return "UIDL Format Validation Error. Please check the following: " + listOfErrors;
+};
+export var validateNulls = function (uidl) {
+    return JSON.parse(JSON.stringify(uidl), function (key, value) {
+        if (value === undefined || value == null) {
+            throw new ComponentValidationError("Validation error, Received " + value + " at " + key);
+        }
+        return value;
+    });
+};
+//# sourceMappingURL=utils.js.map

package/dist/esm/validator/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/validator/utils.ts"],"names":[],"mappings":";;;;;AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAA;AAEvD,OAAO,EAaL,wBAAwB,GACzB,MAAM,4BAA4B,CAAA;AAEnC,oEAAoE;AACpE,MAAM,CAAC,IAAM,4BAA4B,GAAG,UAAC,KAAoB;IAC/D,IAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC,CAAA;IACtD,IAAM,MAAM,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;IACxD,IAAM,OAAO,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAA;IAE1D,KAAK;SACF,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,MAAM,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAzC,CAAyC,CAAC;SACxD,OAAO,CAAC,UAAC,SAAS;QACjB,OAAA,OAAO,CAAC,IAAI,CACV,SAAM,SAAS,mHAA+G,CAC/H;IAFD,CAEC,CACF,CAAA;AACL,CAAC,CAAA;AAED,oBAAoB;AACpB,0DAA0D;AAC1D,gGAAgG;AAChG,MAAM,CAAC,IAAM,sBAAsB,GAAG,UAAC,KAAoB;IACzD,IAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,SAAS,CAAC,eAAe,CAAC,KAAK,CAAC,IAAI,EAAE,UAAC,aAAa;QAClD,SAAS,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,EAAE,UAAC,SAAS;YACpD,IAAI,SAAS,CAAC,IAAI,KAAK,SAAS,IAAI,SAAS,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO,EAAE;gBAC/E,IAAI,SAAS,CAAC,OAAO,CAAC,EAAE,KAAK,OAAO,EAAE;oBACpC,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,QAAQ,EAAE;wBAChC,IAAM,QAAQ,GAAG,0EAAwE,CAAA;wBACzF,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;qBACtB;oBAED,uCAAuC;oBACvC,OAAM;iBACP;gBAED,IAAI,CAAC,uBAAuB,CAAC,SAAS,CAAC,OAAO,CAAC,EAAE,EAAE,aAAa,CAAC,IAAI,CAAC,YAAY,CAAC,EAAE;oBACnF,IAAM,QAAQ,GAAG,SAAM,SAAS,CAAC,OAAO,CAAC,EAAE,uFAA8E,aAAa,CAAC,IAAI,CAAC,YAAY,OAAG,CAAA;oBAC3J,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;iBACtB;aACF;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,IAAM,uBAAuB,GAAG,UAAC,SAAiB,EAAE,kBAA0B;IAC5E,IAAM,YAAY,GAAG,kBAAkB,IAAI,MAAM,CAAA;IAEjD,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QAC5B,OAAO,SAAS,KAAK,YAAY,CAAA;KAClC;IAED,IAAM,aAAa,GAAG,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IAC7C,OAAO,aAAa,KAAK,YAAY,CAAA;AACvC,CAAC,CAAA;AAED;;6EAE6E;AAC7E,MAAM,CAAC,IAAM,uBAAuB,GAAG,UAAC,KAA8B;;IACpE,IAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,IAAI,EAAE,CAAC,CAAA;IACzD,IAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;IAC3D,IAAI,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,iBAAiB,IAAI,EAAE,CAAC,CAAA;IAC3D,IAAM,qBAAqB,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAA;IAE1E,IAAM,iBAAiB,GAA8C,CAAC,MAAA,KAAK,aAAL,KAAK,uBAAL,KAAK,CAAE,iBAAiB,mCAC5F,EAAE,CAAyD,CAAA;IAE7D,IAAI,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE;QACtC,UAAU,GAAG,UAAU,CAAC,MAAM,CAAC,UAAC,GAAG,EAAE,SAAS;;YAC5C,IAAI,MAAA,MAAA,iBAAiB,CAAC,SAAS,CAAC,0CAAE,IAAI,0CAAE,cAAc,EAAE;gBACtD,OAAO,GAAG,CAAA;aACX;YAED,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACnB,OAAO,GAAG,CAAA;QACZ,CAAC,EAAE,EAAE,CAAC,CAAA;KACP;IAED,IAAM,YAAY,GAAa,EAAE,CAAA;IACjC,IAAM,aAAa,GAAa,EAAE,CAAA;IAClC,IAAM,cAAc,GAAa,EAAE,CAAA;IACnC,IAAM,MAAM,GAAa,EAAE,CAAA;IAE3B,SAAS,CAAC,aAAa,CAAC,KAAK,CAAC,IAAgB,EAAE,UAAC,IAAI;;QACnD,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,EAAE;YAC3B,MAAM,CAAC,IAAI,CAAC,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,MAAM,KAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,QAAQ;gBACvD,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,UAAC,KAAK;oBAC1C,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,QAAQ,CAAC,EAAE;wBACvE,IAAM,QAAQ,GAAG,OAAI,KAAK,CAAC,QAAQ,6EAAyE,CAAA;wBAC5G,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;wBACrB,OAAM;qBACP;oBAED,IAAI,KAAK,CAAC,IAAI,KAAK,UAAU,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,EAAE;wBAChE,MAAM,CAAC,IAAI,CACT,OAAI,KAAK,CAAC,KAAK,6FAAyF,CACzG,CAAA;wBACD,OAAM;qBACP;gBACH,CAAC,CAAC,CAAA;YACJ,CAAC,CAAC,CAAA;YAEF,IAAM,iBAAe,GAAa,EAAE,CAAA;YACpC,MAAM,CAAC,MAAM,CAAC,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,gBAAgB,KAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,QAAQ;gBACnE,IACE,QAAQ,CAAC,OAAO,CAAC,OAAO,KAAK,sBAAsB;oBACnD,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,KAAK,SAAS,EAC3C;oBACA,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,KAAK,MAAM,EAAE;wBAC7D,IAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAA;wBAC1D,IAAI,CAAC,8BAA8B,CAAC,cAAc,EAAE,QAAQ,CAAC,EAAE;4BAC7D,IAAM,QAAQ,GAAG,OAAI,cAAc,iEAA6D,CAAA;4BAChG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;4BACrB,OAAM;yBACP;wBACD,iBAAe,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;wBACpC,YAAY,CAAC,IAAI,CAAC,cAAc,CAAC,CAAA;qBAClC;oBAED,IAAI,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,aAAa,KAAK,MAAM,EAAE;wBAC7D,IAAM,cAAc,GAAG,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAA;wBAE1D,IAAI,CAAC,qBAAqB,CAAC,QAAQ,CAAC,cAAc,CAAC,EAAE;4BACnD,MAAM,CAAC,IAAI,CACN,cAAc,8DAAyD,KAAK,CAAC,IAAI,4DAAyD,CAC9I,CAAA;yBACF;qBACF;iBACF;YACH,CAAC,CAAC,CAAA;YAEF,IAAI,iBAAe,CAAC,MAAM,GAAG,CAAC,EAAE;gBAC9B,MAAM,CAAC,IAAI,CAAC,WACV,CAAA,MAAA,IAAI,CAAC,OAAO,0CAAE,IAAI,MAAI,MAAA,IAAI,CAAC,OAAO,0CAAE,GAAG,CAAA,sHAEI,CAAC,CAAA;aAC/C;SACF;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,MAAM,EAAE;YACpE,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,QAAQ,CAAC,EAAE;gBAC9D,IAAM,QAAQ,GAAG,OAAI,IAAI,CAAC,OAAO,CAAC,EAAE,iEAA6D,CAAA;gBACjG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtB;YAED,0CAA0C;YAC1C,kDAAkD;YAClD,IAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,YAAY,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;SACjC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,SAAS,IAAI,IAAI,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO,EAAE;YACrE,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,SAAS,CAAC,EAAE;gBAC/D,IAAM,QAAQ,GAAG,SAAM,IAAI,CAAC,OAAO,CAAC,EAAE,kEAA8D,CAAA;gBACpG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtB;YAED,0CAA0C;YAC1C,kDAAkD;YAClD,IAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,aAAa,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;SAClC;QAED,IAAI,IAAI,CAAC,IAAI,KAAK,QAAQ,EAAE;YAC1B,IAAI,CAAC,8BAA8B,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,EAAE,UAAU,CAAC,EAAE;gBAChE,IAAM,QAAQ,GAAG,SAAM,IAAI,CAAC,OAAO,CAAC,EAAE,mEAA+D,CAAA;gBACrG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtB;YAED,0CAA0C;YAC1C,kDAAkD;YAClD,IAAM,aAAa,GAAG,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;YACnD,cAAc,CAAC,IAAI,CAAC,aAAa,CAAC,CAAA;SACnC;IACH,CAAC,CAAC,CAAA;IAEF,QAAQ;SACL,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,YAAY,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAzB,CAAyB,CAAC;SACxC,OAAO,CAAC,UAAC,IAAI;QACZ,OAAA,OAAO,CAAC,IAAI,CAAC,OAAI,IAAI,qEAAiE,CAAC;IAAvF,CAAuF,CACxF,CAAA;IAEH,SAAS;SACN,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,aAAa,CAAC,QAAQ,CAAC,CAAC,CAAC,EAA1B,CAA0B,CAAC;SACzC,OAAO,CAAC,UAAC,IAAI;QACZ,OAAA,OAAO,CAAC,IAAI,CAAC,OAAI,IAAI,sEAAkE,CAAC;IAAxF,CAAwF,CACzF,CAAA;IAEH,UAAU;SACP,MAAM,CAAC,UAAC,CAAC,IAAK,OAAA,CAAC,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC,EAA3B,CAA2B,CAAC;SAC1C,OAAO,CAAC,UAAC,IAAI;QACZ,OAAA,OAAO,CAAC,IAAI,CAAC,OAAI,IAAI,uEAAmE,CAAC;IAAzF,CAAyF,CAC1F,CAAA;IAEH,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,IAAM,8BAA8B,GAAG,UAAC,IAAY,EAAE,OAAiB;IACrE,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;QACvB,mDAAmD;QACnD,OAAO,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;KAC9B;IAED,yFAAyF;IACzF,4GAA4G;IAC5G,IAAM,cAAc,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,CAAA;IACzC,OAAO,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;AACzC,CAAC,CAAA;AAED,yCAAyC;AACzC,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAAC,KAAkB;IACrD,IAAM,MAAM,GAAG,EAAE,CAAA;IAEjB,IAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAA;IAC3D,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;QAC3B,IAAM,QAAQ,GAAG,0CAA0C,CAAA;QAC3D,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;KACtB;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,wEAAwE;AACxE,6EAA6E;AAC7E,MAAM,CAAC,IAAM,oCAAoC,GAAG,UAAC,KAAkB;;IACrE,IAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAM,UAAU,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;IACtD,IAAM,mBAAmB,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,mBAAmB,KAAI,EAAE,CAAC,CAAA;IAC9E,IAAM,MAAM,GAAa,MAAM,CAAC,IAAI,CAAC,CAAA,MAAA,MAAA,KAAK,CAAC,IAAI,0CAAE,cAAc,0CAAE,MAAM,KAAI,EAAE,CAAC,CAAA;IAC9E,IAAM,YAAY;QAChB,KAAK,CAAC,IAAI,CAAC,IAAI;OACZ,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAC,SAAS,IAAK,OAAA,SAAS,CAAC,IAAI,EAAd,CAAc,CAAC,CAC5E,CAAA;IACD,IAAI,oBAAoB,GAAa,EAAE,CAAA;IAEvC,IAAI,MAAA,KAAK,CAAC,IAAI,0CAAE,mBAAmB,EAAE;QACnC,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,mBAAmB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,KAAK;YACxD,IAAA,OAAO,GAAsB,KAAK,QAA3B,EAAE,KAAoB,KAAK,WAAV,EAAf,UAAU,mBAAG,EAAE,KAAA,CAAU;YAC1C,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,sBAAsB,CAAC,OAAO,EAAE,MAAM,CAAC,EAAC;YACvD,UAAU,CAAC,OAAO,CAAC,UAAC,SAAS;gBAC3B,IAAI,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAE,OAAO,EAAE;oBACtB,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,sBAAsB,CAAC,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,EAAC;iBAClE;YACH,CAAC,CAAC,CAAA;QACJ,CAAC,CAAC,CAAA;KACH;IAED,YAAY,CAAC,OAAO,CAAC,UAAC,IAAI;QACxB,SAAS,CAAC,gBAAgB,CAAC,IAAI,EAAE,UAAC,OAAO;YACvC,4CAA4C;YAC5C,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,gBAAgB,EAAE;gBACvB,IAAA,KAA4C,4BAA4B,CAC5E,OAAO,CAAC,gBAAgB,EACxB,mBAAmB,EACnB,MAAM,CACP,EAJO,iBAAiB,uBAAA,EAAE,kBAAkB,wBAI5C,CAAA;gBACD,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,iBAAiB,EAAC;gBACjC,oBAAoB,mCAAO,oBAAoB,GAAK,kBAAkB,CAAC,CAAA;aACxE;YAED,kDAAkD;YAClD,IAAI,OAAO,aAAP,OAAO,uBAAP,OAAO,CAAE,KAAK,EAAE;gBAClB,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,sBAAsB,CAAC,OAAO,CAAC,KAAK,EAAE,MAAM,CAAC,EAAC;aAC9D;YAED,IACE,OAAO,CAAC,UAAU;gBAClB,OAAO,CAAC,UAAU,CAAC,IAAI,KAAK,OAAO;gBACnC,CAAC,UAAU,CAAC,QAAQ,CAAC,OAAO,CAAC,YAAY,CAAC,EAC1C;gBACA,IAAM,QAAQ,GAAG,uBAAoB,OAAO,CAAC,YAAY,uDAAmD,CAAA;gBAC5G,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;aACtB;QACH,CAAC,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,mBAAmB,CAAC,OAAO,CAAC,UAAC,GAAG;QAC9B,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE;YACvC,OAAO,CAAC,IAAI,CAAI,GAAG,sDAAmD,CAAC,CAAA;SACxE;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,IAAM,4BAA4B,GAAG,UACnC,gBAAsC,EACtC,mBAA6B,EAC7B,MAAgB;IAEhB,IAAM,iBAAiB,GAAa,EAAE,CAAA;IACtC,IAAM,kBAAkB,GAAa,EAAE,CAAA;IACvC,MAAM,CAAC,MAAM,CAAC,gBAAgB,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,QAAQ;QAC7C,IAAA,OAAO,GAAK,QAAQ,CAAC,OAAO,QAArB,CAAqB;QAEpC,IAAI,OAAO,KAAK,SAAS,EAAE;YACzB,iBAAiB,CAAC,IAAI,OAAtB,iBAAiB,EACZ,sBAAsB,CACtB,QAAiD,CAAC,OAAO,CAAC,MAAM,EACjE,MAAM,CACP,EACF;SACF;QAED,IAAI,OAAO,KAAK,oBAAoB,EAAE;YAC5B,IAAA,WAAW,GAAM,QAAkD,CAAC,OAAO,YAAhE,CAAgE;YACnF,kBAAkB,CAAC,IAAI,CAAC,WAAW,CAAC,CAAA;YACpC,IAAI,CAAC,mBAAmB,CAAC,QAAQ,CAAC,WAAW,CAAC,EAAE;gBAC9C,iBAAiB,CAAC,IAAI,CACpB,QAAM,WAAW,6EAA0E,CAC5F,CAAA;aACF;SACF;IACH,CAAC,CAAC,CAAA;IACF,OAAO;QACL,iBAAiB,mBAAA;QACjB,kBAAkB,oBAAA;KACnB,CAAA;AACH,CAAC,CAAA;AAED,IAAM,sBAAsB,GAAG,UAAC,MAAsC,EAAE,MAAgB;IACtF,IAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,MAAM,CAAC,MAAM,CAAC,MAAM,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAC,KAAqB;QACxD,IACE,KAAK,CAAC,IAAI,KAAK,SAAS;YACxB,KAAK,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO;YACvC,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC,EAClC;YACA,MAAM,CAAC,IAAI,CAAC,aAAW,KAAK,CAAC,OAAO,CAAC,EAAE,uCAAoC,CAAC,CAAA;SAC7E;IACH,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,yEAAyE;AACzE,WAAW;AACX,mBAAmB;AACnB,wBAAwB;AACxB,gCAAgC;AAChC,QAAQ;AACR,SAAS;AACT,OAAO;AACP,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAAC,KAAkB;IACrD,IAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,IAAI,EAAE,CAAC,CAAA;IAErD,IAAM,KAAK,GAAG,SAAS,CAAC,MAAM,CAAC,UAAC,IAAI,IAAK,OAAA,KAAK,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,IAAI,KAAK,IAAI,EAApC,CAAoC,CAAC,CAAA;IAE9E,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE;QACpB,IAAM,QAAQ,GAAG,oEAAkE,KAAO,CAAA;QAC1F,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;KACtB;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,oBAAoB,GAAG,UAAC,KAAkB;IACrD,IAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,IAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,mBAAmB,CAAA;IAC/C,IAAI,QAAQ,EAAE;QACZ,MAAM,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,UAAC,WAAmC;YAC1D,IAAA,OAAO,GAAsB,WAAW,QAAjC,EAAE,KAAoB,WAAW,WAAhB,EAAf,UAAU,mBAAG,EAAE,KAAA,CAAgB;YAEhD,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,OAAO,CAAC,UAAC,KAAK;gBACtC,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,0BAA0B,CAAC,KAAK,CAAC,OAAO,CAAC,EAAC;YAC3D,CAAC,CAAC,CAAA;YAEF,MAAM,CAAC,IAAI,OAAX,MAAM,EAAS,0BAA0B,CAAC,OAAO,CAAC,EAAC;QACrD,CAAC,CAAC,CAAA;KACH;IACD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,0BAA0B,GAAG,UACxC,OAAqE;IAErE,IAAM,MAAM,GAAa,EAAE,CAAA;IAC3B,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,UAAC,YAAY;QAC1C,IAAI,YAAY,CAAC,IAAI,KAAK,SAAS,IAAI,YAAY,CAAC,OAAO,CAAC,aAAa,KAAK,OAAO,EAAE;YACrF,MAAM,CAAC,IAAI,CAAC,2DAA2D,CAAC,CAAA;SACzE;QAED,IACE,YAAY,CAAC,IAAI,KAAK,QAAQ;YAC9B,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ;YACxC,OAAO,YAAY,CAAC,OAAO,KAAK,QAAQ,EACxC;YACA,MAAM,CAAC,IAAI,CACT,8HACuC,YAAc,CACtD,CAAA;SACF;IACH,CAAC,CAAC,CAAA;IACF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,qEAAqE;AACrE,MAAM,CAAC,IAAM,kBAAkB,GAAG,UAAC,KAAkB;IACnD,IAAM,MAAM,GAAG,EAAE,CAAA;IACjB,IAAM,WAAW,GAAa,EAAE,CAAA;IAChC,IAAM,QAAQ,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,OAAsB,CAAA;IACvD,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,UAAC,KAAK;QAC9B,IAAI,KAAK,CAAC,IAAI,KAAK,aAAa,EAAE;YAChC,IAAM,QAAQ,GAAG,6CAA0C,KAAK,CAAC,IAAI,gEAA0D,CAAA;YAC/H,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;SACtB;aAAM;YACL,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAA;SACjD;IACH,CAAC,CAAC,CAAA;IAEF,IAAM,WAAW,GAAG,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM,CAAA;IAC5D,IAAI,CAAC,WAAW,IAAI,WAAW,CAAC,MAAM,IAAI,CAAC,EAAE;QAC3C,MAAM,CAAC,IAAI,CACT,8FAA8F,CAC/F,CAAA;KACF;SAAM;QACL,KAAK,CAAC,IAAI,CAAC,gBAAgB,CAAC,KAAK,CAAC,MAAM;aACrC,MAAM,CAAC,UAAC,KAAK,IAAK,OAAA,CAAC,WAAW,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,CAAC,EAA7C,CAA6C,CAAC;aAChE,OAAO,CAAC,UAAC,KAAK;YACb,IAAM,QAAQ,GAAG,qEAAmE,KAAK,CAAC,KAAK,MAAG,CAAA;YAClG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QACvB,CAAC,CAAC,CAAA;KACL;IAED,OAAO,MAAM,CAAA;AACf,CAAC,CAAA;AAED,0DAA0D;AAC1D,MAAM,CAAC,IAAM,YAAY,GAAG,UAAC,MAA4D;IACvF,IAAM,YAAY,GAAa,EAAE,CAAA;IACjC,MAAM,CAAC,OAAO,CAAC,UAAC,KAAK;QACnB,IAAM,OAAO,GAAG,eAAa,KAAK,CAAC,EAAE,UAAK,KAAK,CAAC,OAAO,kBAAa,KAAK,CAAC,IAAI,QAAK,CAAA;QACnF,YAAY,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;IAC5B,CAAC,CAAC,CAAA;IAEF,OAAO,+DAA6D,YAAc,CAAA;AACpF,CAAC,CAAA;AAED,MAAM,CAAC,IAAM,aAAa,GAAG,UAAC,IAA6B;IACzD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,UAAC,GAAG,EAAE,KAAK;QACjD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,IAAI,IAAI,EAAE;YACxC,MAAM,IAAI,wBAAwB,CAAC,gCAA8B,KAAK,YAAO,GAAK,CAAC,CAAA;SACpF;QACD,OAAO,KAAK,CAAA;IACd,CAAC,CAAC,CAAA;AACJ,CAAC,CAAA"}

package/package.json

@@ -0,0 +1,32 @@
+{
+  "name": "@teleporthq/teleport-uidl-validator",
+  "version": "0.18.0",
+  "description": "A module that offers validation and parsing for non-standard UIDL structures",
+  "author": "teleportHQ",
+  "license": "MIT",
+  "homepage": "https://teleporthq.io/",
+  "main": "dist/cjs/index.js",
+  "module": "dist/esm/index.js",
+  "types": "dist/cjs/index.d.ts",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/teleporthq/teleport-code-generators.git"
+  },
+  "bugs": {
+    "url": "https://github.com/teleporthq/teleport-code-generators/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.json --module commonjs --outDir dist/cjs"
+  },
+  "dependencies": {
+    "@mojotech/json-type-validation": "^3.1.0",
+    "@teleporthq/teleport-shared": "^0.18.0",
+    "@teleporthq/teleport-types": "^0.18.0"
+  },
+  "gitHead": "7b47f013bf1889e19b31875a8f3abdc43b22615a"
+}

package/src/decoders/component-decoder.ts

@@ -0,0 +1,48 @@
+import {
+  object,
+  string,
+  dict,
+  withDefault,
+  Decoder,
+  optional,
+} from '@mojotech/json-type-validation'
+import { VComponentUIDL, VRootComponentUIDL } from '@teleporthq/teleport-types'
+import {
+  styleSetDefinitionDecoder,
+  propDefinitionsDecoder,
+  stateDefinitionsDecoder,
+  outputOptionsDecoder,
+  elementNodeDecoder,
+  componentSeoDecoder,
+  externaldependencyDecoder,
+  peerDependencyDecoder,
+  designTokensDecoder,
+} from './utils'
+
+export const componentUIDLDecoder: Decoder<VComponentUIDL> = object({
+  name: withDefault('MyComponent', string()),
+  node: elementNodeDecoder,
+  stateDefinitions: optional(dict(stateDefinitionsDecoder)),
+  propDefinitions: optional(dict(propDefinitionsDecoder)),
+  styleSetDefinitions: optional(dict(styleSetDefinitionDecoder)),
+  importDefinitions: optional(dict(externaldependencyDecoder)),
+  outputOptions: optional(outputOptionsDecoder),
+  seo: optional(componentSeoDecoder),
+})
+
+export const rootComponentUIDLDecoder: Decoder<VRootComponentUIDL> = object({
+  name: withDefault('App', string()),
+  node: elementNodeDecoder,
+  stateDefinitions: dict(stateDefinitionsDecoder),
+  propDefinitions: optional(dict(propDefinitionsDecoder)),
+  importDefinitions: optional(dict(externaldependencyDecoder)),
+  peerDefinitions: optional(dict(peerDependencyDecoder)),
+  styleSetDefinitions: optional(dict(styleSetDefinitionDecoder)),
+  outputOptions: optional(outputOptionsDecoder),
+  seo: optional(componentSeoDecoder),
+  designLanguage: optional(
+    object({
+      tokens: optional(designTokensDecoder),
+    })
+  ),
+})

package/src/decoders/custom-combinators.ts

@@ -0,0 +1,59 @@
+/* tslint:disable member-ordering */
+import { Result, DecoderError } from '@mojotech/json-type-validation'
+
+/* These are some custom combinators that comes in handy for us,
+instead of parsing and cross-checking regex again. The combinators,
+can used inside a existing Decoder, since we did not implement any run()
+runWithException() etc */
+
+type DecodeResult<A> = Result.Result<A, Partial<DecoderError>>
+export class CustomCombinators<A> {
+  // @ts-ignore
+  private constructor(private decode: (json: string) => DecodeResult<A>) {}
+
+  static isValidComponentName(): CustomCombinators<string> {
+    return new CustomCombinators<string>((json: string) => {
+      const componentNameRegex = new RegExp('^[A-Z]+[a-zA-Z0-9]*$')
+      if (json && typeof json === 'string' && componentNameRegex.test(json)) {
+        return Result.ok(json)
+      } else if (json.length === 0) {
+        throw new Error(`Component Name cannot be empty`)
+      }
+      throw new Error(`Invalid Component name, got ${json}`)
+    })
+  }
+
+  static isValidNavLink(): CustomCombinators<string> {
+    return new CustomCombinators<string>((json: string) => {
+      const navLinkRegex = new RegExp('/[a-zA-Z0-9-_]*$')
+      if (json && typeof json === 'string' && navLinkRegex.test(json)) {
+        return Result.ok(json)
+      }
+      throw new Error(`Invalid link attribute, received ${json}`)
+    })
+  }
+
+  static isValidFileName(): CustomCombinators<string> {
+    return new CustomCombinators<string>((json: string) => {
+      const fileNameRegex = new RegExp('^[a-zA-Z0-9-_.]*$')
+      if (json && typeof json === 'string' && fileNameRegex.test(json)) {
+        return Result.ok(json)
+      } else if (json.length === 0) {
+        throw new Error(`File Name cannot be empty`)
+      }
+      throw new Error(`Invalid File name, received ${json}`)
+    })
+  }
+
+  static isValidElementName(): CustomCombinators<string> {
+    return new CustomCombinators<string>((json: string) => {
+      const fileNameRegex = new RegExp('^[a-zA-Z]+[a-zA-Z0-9-_]*$')
+      if (json && typeof json === 'string' && fileNameRegex.test(json)) {
+        return Result.ok(json)
+      } else if (json.length === 0) {
+        throw new Error(`Name attribute cannot be empty`)
+      }
+      throw new Error(`Invalid name attribute, received ${json}`)
+    })
+  }
+}

package/src/decoders/index.ts

@@ -0,0 +1,2 @@
+export { componentUIDLDecoder, rootComponentUIDLDecoder } from './component-decoder'
+export { projectUIDLDecoder } from './project-decoder'