schema-markdown 1.3.1 → 1.3.2

package/lib/encode.js

@@ -106,6 +106,8 @@ export function decodeQueryString(paramStr) {
                 if (obj === null) {
                     obj = {};
                     parent[keyParent] = obj;
+                } else if (typeof obj !== 'object') {
+                    throw new Error(`Invalid key '${keyFqn.slice(0, 100)}'`);
                 }
 
                 // Create the index for this key - check own properties only, and define "__proto__"

package/lib/parser.js

@@ -97,6 +97,9 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
         lines.push(...text.split(rLineSplit));
     } else {
         for (const textPart of text) {
+            if (typeof textPart !== 'string') {
+                throw new TypeError(`Invalid Schema Markdown text ${JSON.stringify(textPart)}`.slice(0, 100));
+            }
             lines.push(...textPart.split(rLineSplit));
         }
     }
@@ -109,66 +112,66 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
 
         // Line continuation?
         const linePartNoContinuation = linePart.includes('\\') ? linePart.replace(rLineCont, '') : linePart;
-        if (lineContinuation.length || linePartNoContinuation !== linePart) {
-            lineContinuation.push(linePartNoContinuation);
-        }
-        if (linePartNoContinuation !== linePart) {
-            continue;
-        }
         let line;
-        if (lineContinuation.length) {
+        if (linePartNoContinuation === linePart && !lineContinuation.length) {
+            line = linePart;
+        } else {
+            lineContinuation.push(linePartNoContinuation);
+            if (linePartNoContinuation !== linePart) {
+                continue;
+            }
             line = lineContinuation.join('');
             lineContinuation.length = 0;
-        } else {
-            line = linePart;
         }
 
         // Match syntax - each regex is guarded by a cheap string test that only skips it when it cannot match
-        const lineIndented = rIndent.test(line);
         const lineTrimmed = line.trim();
         let matchName = 'comment';
         let match = (lineTrimmed === '' || lineTrimmed.startsWith('#')) ? line.match(rComment) : null;
+
+        // Not a comment or blank line? Try the remaining syntax
         if (match === null) {
+            const lineIndented = rIndent.test(line);
             matchName = 'group';
             match = line.startsWith('group') ? line.match(rGroup) : null;
-        }
-        if (match === null) {
-            matchName = 'action';
-            match = line.startsWith('action') ? line.match(rAction) : null;
-        }
-        if (match === null) {
-            matchName = 'definition';
-            match = (line.startsWith('struct') || line.startsWith('union') || line.startsWith('enum')) ? line.match(rDefinition) : null;
-        }
-        if (match === null && action !== null && lineIndented) {
-            matchName = 'section';
-            match = line.match(rSection);
-        }
-        if (match === null && action !== null && lineIndented) {
-            matchName = 'sectionPlain';
-            match = line.match(rSectionPlain);
-        }
-        if (match === null && userType !== null && 'enum' in userType && lineIndented) {
-            matchName = 'value';
-            match = line.match(rValue);
             if (match === null) {
-                match = line.match(rValueQuoted);
+                matchName = 'action';
+                match = line.startsWith('action') ? line.match(rAction) : null;
+            }
+            if (match === null) {
+                matchName = 'definition';
+                match = (line.startsWith('struct') || line.startsWith('union') || line.startsWith('enum')) ? line.match(rDefinition) : null;
+            }
+            if (match === null && action !== null && lineIndented) {
+                matchName = 'section';
+                match = line.match(rSection);
+            }
+            if (match === null && action !== null && lineIndented) {
+                matchName = 'sectionPlain';
+                match = line.match(rSectionPlain);
+            }
+            if (match === null && userType !== null && 'enum' in userType && lineIndented) {
+                matchName = 'value';
+                match = line.match(rValue);
+                if (match === null) {
+                    match = line.match(rValueQuoted);
+                }
+            }
+            if (match === null && userType !== null && 'struct' in userType && lineIndented) {
+                matchName = 'member';
+                match = line.match(rMember);
+            }
+            if (match === null && urls !== null && lineIndented) {
+                matchName = 'urls';
+                match = line.match(rURL);
+            }
+            if (match === null) {
+                matchName = 'typedef';
+                match = line.startsWith('typedef') ? line.match(rTypedef) : null;
+            }
+            if (match === null) {
+                matchName = null;
             }
-        }
-        if (match === null && userType !== null && 'struct' in userType && lineIndented) {
-            matchName = 'member';
-            match = line.match(rMember);
-        }
-        if (match === null && urls !== null && lineIndented) {
-            matchName = 'urls';
-            match = line.match(rURL);
-        }
-        if (match === null) {
-            matchName = 'typedef';
-            match = line.startsWith('typedef') ? line.match(rTypedef) : null;
-        }
-        if (match === null) {
-            matchName = null;
         }
 
         // Comment?
@@ -178,39 +181,36 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
                 doc.push(!docString.startsWith(' ') ? docString : docString.slice(1));
             }
 
-        // Documentation group?
-        } else if (matchName === 'group') {
-            docGroup = match.groups.group;
-            if (typeof docGroup !== 'undefined') {
-                docGroup = docGroup.trim();
-            } else {
-                docGroup = null;
-            }
-
-        // Action?
-        } else if (matchName === 'action') {
-            const actionId = match.groups.id;
+        // Struct member?
+        } else if (matchName === 'member') {
+            const optional = typeof match.groups.optional !== 'undefined';
+            const memberName = match.groups.id;
 
-            // Action already defined?
-            if (Object.hasOwn(types, actionId)) {
-                addError(`Redefinition of action '${actionId}'`, filename, linenum);
+            // Add the member
+            const {struct} = userType;
+            if (!('members' in struct)) {
+                struct.members = [];
             }
-
-            // Clear parser state
-            urls = null;
-            userType = null;
-            const actionDoc = getDoc();
-
-            // Create the new action
-            action = {'name': actionId};
-            types[actionId] = {'action': action};
-            if (actionDoc !== null) {
-                action.doc = actionDoc;
+            const [memberType, memberAttr] = parseTypedef(match);
+            const memberDoc = getDoc();
+            const member = {
+                'name': memberName,
+                'type': memberType
+            };
+            struct.members.push(member);
+            if (memberAttr !== null) {
+                member.attr = memberAttr;
             }
-            if (docGroup !== null) {
-                action.docGroup = docGroup;
+            if (memberDoc !== null) {
+                member.doc = memberDoc;
+            }
+            if (optional) {
+                member.optional = true;
             }
 
+            // Record the definition's line number
+            filepos[`${struct.name}.${memberName}`] = linenum;
+
         // Definition?
         } else if (matchName === 'definition') {
             const definitionString = match.groups.type;
@@ -267,6 +267,93 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
             // Record the definition's line number
             filepos[definitionId] = linenum;
 
+        // Enum value?
+        } else if (matchName === 'value') {
+            const valueString = match.groups.id;
+
+            // Add the enum value
+            const enum_ = userType.enum;
+            if (!('values' in enum_)) {
+                enum_.values = [];
+            }
+            const enumValue = {'name': valueString};
+            enum_.values.push(enumValue);
+            const enumValueDoc = getDoc();
+            if (enumValueDoc !== null) {
+                enumValue.doc = enumValueDoc;
+            }
+
+            // Record the definition's line number
+            filepos[`${enum_.name}.${valueString}`] = linenum;
+
+        // Typedef?
+        } else if (matchName === 'typedef') {
+            const definitionId = match.groups.id;
+
+            // Type already defined?
+            if (builtinTypes.has(definitionId) || Object.hasOwn(builtinDeprecated, definitionId) || Object.hasOwn(types, definitionId)) {
+                addError(`Redefinition of type '${definitionId}'`, filename, linenum);
+            }
+
+            // Clear parser state
+            action = null;
+            urls = null;
+            userType = null;
+            const typedefDoc = getDoc();
+
+            // Create the typedef
+            const [typedefType, typedefAttr] = parseTypedef(match);
+            const typedef = {
+                'name': definitionId,
+                'type': typedefType
+            };
+            types[definitionId] = {'typedef': typedef};
+            if (typedefAttr !== null) {
+                typedef.attr = typedefAttr;
+            }
+            if (typedefDoc !== null) {
+                typedef.doc = typedefDoc;
+            }
+            if (docGroup !== null) {
+                typedef.docGroup = docGroup;
+            }
+
+            // Record the definition's line number
+            filepos[definitionId] = linenum;
+
+        // Documentation group?
+        } else if (matchName === 'group') {
+            docGroup = match.groups.group;
+            if (typeof docGroup !== 'undefined') {
+                docGroup = docGroup.trim();
+            } else {
+                docGroup = null;
+            }
+
+        // Action?
+        } else if (matchName === 'action') {
+            const actionId = match.groups.id;
+
+            // Action already defined?
+            if (Object.hasOwn(types, actionId)) {
+                addError(`Redefinition of action '${actionId}'`, filename, linenum);
+            }
+
+            // Clear parser state
+            urls = null;
+            userType = null;
+            const actionDoc = getDoc();
+
+            // Create the new action
+            action = {'name': actionId};
+            types[actionId] = {'action': action};
+            if (actionDoc !== null) {
+                action.doc = actionDoc;
+            }
+            if (docGroup !== null) {
+                action.docGroup = docGroup;
+            }
+
         // Action section?
         } else if (matchName === 'section') {
             const sectionString = match.groups.type;
@@ -321,55 +408,6 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
                 action[sectionString] = urls;
             }
 
-        // Enum value?
-        } else if (matchName === 'value') {
-            const valueString = match.groups.id;
-
-            // Add the enum value
-            const enum_ = userType.enum;
-            if (!('values' in enum_)) {
-                enum_.values = [];
-            }
-            const enumValue = {'name': valueString};
-            enum_.values.push(enumValue);
-            const enumValueDoc = getDoc();
-            if (enumValueDoc !== null) {
-                enumValue.doc = enumValueDoc;
-            }
-
-            // Record the definition's line number
-            filepos[`${enum_.name}.${valueString}`] = linenum;
-
-        // Struct member?
-        } else if (matchName === 'member') {
-            const optional = typeof match.groups.optional !== 'undefined';
-            const memberName = match.groups.id;
-
-            // Add the member
-            const {struct} = userType;
-            if (!('members' in struct)) {
-                struct.members = [];
-            }
-            const [memberType, memberAttr] = parseTypedef(match);
-            const memberDoc = getDoc();
-            const member = {
-                'name': memberName,
-                'type': memberType
-            };
-            struct.members.push(member);
-            if (memberAttr !== null) {
-                member.attr = memberAttr;
-            }
-            if (memberDoc !== null) {
-                member.doc = memberDoc;
-            }
-            if (optional) {
-                member.optional = true;
-            }
-
-            // Record the definition's line number
-            filepos[`${struct.name}.${memberName}`] = linenum;
-
         // URL?
         } else if (matchName === 'urls') {
             const {method, path} = match.groups;
@@ -392,41 +430,6 @@ export function parseSchemaMarkdown(text, {types = {}, filename = '', validate =
             // Add the URL
             urls.push(actionUrl);
 
-        // Typedef?
-        } else if (matchName === 'typedef') {
-            const definitionId = match.groups.id;
-
-            // Type already defined?
-            if (builtinTypes.has(definitionId) || Object.hasOwn(builtinDeprecated, definitionId) || Object.hasOwn(types, definitionId)) {
-                addError(`Redefinition of type '${definitionId}'`, filename, linenum);
-            }
-
-            // Clear parser state
-            action = null;
-            urls = null;
-            userType = null;
-            const typedefDoc = getDoc();
-
-            // Create the typedef
-            const [typedefType, typedefAttr] = parseTypedef(match);
-            const typedef = {
-                'name': definitionId,
-                'type': typedefType
-            };
-            types[definitionId] = {'typedef': typedef};
-            if (typedefAttr !== null) {
-                typedef.attr = typedefAttr;
-            }
-            if (typedefDoc !== null) {
-                typedef.doc = typedefDoc;
-            }
-            if (docGroup !== null) {
-                typedef.docGroup = docGroup;
-            }
-
-            // Record the definition's line number
-            filepos[definitionId] = linenum;
-
         // Unrecognized line syntax
         } else {
             addError('Syntax error', filename, linenum);

package/lib/schema.js

@@ -187,10 +187,10 @@ function validateTypeHelper(types, type, value, memberFqn) {
         } else if (builtin === 'int' || builtin === 'float') {
             // Convert string?
             if (typeof value === 'string') {
-                if (isNaN(value)) {
+                valueNew = parseFloat(value);
+                if (isNaN(value) || !Number.isFinite(valueNew)) {
                     throwMemberError(type, value, memberFqn);
                 }
-                valueNew = parseFloat(value);
 
             // Not a number?
             } else if (typeof value !== 'number') {
@@ -277,91 +277,6 @@ function validateTypeHelper(types, type, value, memberFqn) {
             }
         }
 
-    // array?
-    } else if ('array' in type) {
-        // Valid value type?
-        const {array} = type;
-        const arrayType = array.type;
-        const arrayAttr = 'attr' in array ? array.attr : null;
-        if (value === '') {
-            valueNew = [];
-        } else if (!Array.isArray(value)) {
-            throwMemberError(type, value, memberFqn);
-        }
-
-        // Validate the list contents
-        const valueCopy = [];
-        const arrayValueNullable = arrayAttr !== null && 'nullable' in arrayAttr && arrayAttr.nullable;
-        for (let ixArrayValue = 0; ixArrayValue < valueNew.length; ixArrayValue++) {
-            const memberFqnValue = [memberFqn, ixArrayValue];
-            let arrayValue = valueNew[ixArrayValue];
-            if (arrayValueNullable && (arrayValue === null || arrayValue === 'null')) {
-                arrayValue = null;
-            } else {
-                arrayValue = validateTypeHelper(types, arrayType, arrayValue, memberFqnValue);
-                if (arrayAttr !== null) {
-                    validateAttr(arrayType, arrayAttr, arrayValue, memberFqnValue);
-                }
-            }
-            valueCopy.push(arrayValue);
-        }
-
-        // Return the validated, transformed copy
-        valueNew = valueCopy;
-
-    // dict?
-    } else if ('dict' in type) {
-        // Valid value type?
-        const {dict} = type;
-        const dictType = dict.type;
-        const dictAttr = 'attr' in dict ? dict.attr : null;
-        const dictKeyType = 'keyType' in dict ? dict.keyType : defaultDictKeyType;
-        const dictKeyAttr = 'keyAttr' in dict ? dict.keyAttr : null;
-        if (value === '') {
-            valueNew = {};
-        } else if (value === null || typeof value !== 'object' || Array.isArray(value)) {
-            throwMemberError(type, value, memberFqn);
-        }
-
-        // Validate the dict key/value pairs
-        const isMap = valueNew instanceof Map;
-        const valueCopy = isMap ? new Map() : {};
-        const dictKeyNullable = dictKeyAttr !== null && 'nullable' in dictKeyAttr && dictKeyAttr.nullable;
-        const dictValueNullable = dictAttr !== null && 'nullable' in dictAttr && dictAttr.nullable;
-        for (let [dictKey, dictValue] of (isMap ? valueNew.entries() : Object.entries(valueNew))) {
-            const memberFqnKey = [memberFqn, dictKey];
-
-            // Validate the key
-            if (dictKeyNullable && (dictKey === null || dictKey === 'null')) {
-                dictKey = null;
-            } else {
-                dictKey = validateTypeHelper(types, dictKeyType, dictKey, memberFqn);
-                if (dictKeyAttr !== null) {
-                    validateAttr(dictKeyType, dictKeyAttr, dictKey, memberFqn);
-                }
-            }
-
-            // Validate the value
-            if (dictValueNullable && (dictValue === null || dictValue === 'null')) {
-                dictValue = null;
-            } else {
-                dictValue = validateTypeHelper(types, dictType, dictValue, memberFqnKey);
-                if (dictAttr !== null) {
-                    validateAttr(dictType, dictAttr, dictValue, memberFqnKey);
-                }
-            }
-
-            // Copy the key/value
-            if (isMap) {
-                valueCopy.set(dictKey, dictValue);
-            } else {
-                setValue(valueCopy, dictKey, dictValue);
-            }
-        }
-
-        // Return the validated, transformed copy
-        valueNew = valueCopy;
-
     // User type?
     } else if ('user' in type) {
         const userType = getUserType(types, type.user);
@@ -423,7 +338,6 @@ function validateTypeHelper(types, type, value, memberFqn) {
                 const memberFqnMember = [memberFqn, memberName];
                 const memberOptional = 'optional' in member && member.optional;
                 const memberAttr = 'attr' in member ? member.attr : null;
-                const memberNullable = memberAttr !== null && 'nullable' in memberAttr && memberAttr.nullable;
 
                 // Missing non-optional member? Check own properties only - "in" matches inherited
                 // Object.prototype properties for member names like "constructor"
@@ -434,13 +348,18 @@ function validateTypeHelper(types, type, value, memberFqn) {
                 } else {
                     // Validate the member value
                     let memberValue = isMap ? valueNew.get(memberName) : valueNew[memberName];
-                    if (memberNullable && (memberValue === null || memberValue === 'null')) {
+
+                    // No member attributes? Validate the member value directly
+                    if (memberAttr === null) {
+                        memberValue = validateTypeHelper(types, member.type, memberValue, memberFqnMember);
+
+                    // Nullable null?
+                    } else if ('nullable' in memberAttr && memberAttr.nullable &&
+                               (memberValue === null || memberValue === 'null')) {
                         memberValue = null;
                     } else {
                         memberValue = validateTypeHelper(types, member.type, memberValue, memberFqnMember);
-                        if (memberAttr !== null) {
-                            validateAttr(member.type, memberAttr, memberValue, memberFqnMember);
-                        }
+                        validateAttr(member.type, memberAttr, memberValue, memberFqnMember);
                     }
 
                     // Copy the validated member
@@ -466,6 +385,91 @@ function validateTypeHelper(types, type, value, memberFqn) {
             // Return the validated, transformed copy
             valueNew = valueCopy;
         }
+
+    // array?
+    } else if ('array' in type) {
+        // Valid value type?
+        const {array} = type;
+        const arrayType = array.type;
+        const arrayAttr = 'attr' in array ? array.attr : null;
+        if (value === '') {
+            valueNew = [];
+        } else if (!Array.isArray(value)) {
+            throwMemberError(type, value, memberFqn);
+        }
+
+        // Validate the list contents
+        const valueCopy = [];
+        const arrayValueNullable = arrayAttr !== null && 'nullable' in arrayAttr && arrayAttr.nullable;
+        for (let ixArrayValue = 0; ixArrayValue < valueNew.length; ixArrayValue++) {
+            const memberFqnValue = [memberFqn, ixArrayValue];
+            let arrayValue = valueNew[ixArrayValue];
+            if (arrayValueNullable && (arrayValue === null || arrayValue === 'null')) {
+                arrayValue = null;
+            } else {
+                arrayValue = validateTypeHelper(types, arrayType, arrayValue, memberFqnValue);
+                if (arrayAttr !== null) {
+                    validateAttr(arrayType, arrayAttr, arrayValue, memberFqnValue);
+                }
+            }
+            valueCopy.push(arrayValue);
+        }
+
+        // Return the validated, transformed copy
+        valueNew = valueCopy;
+
+    // dict?
+    } else if ('dict' in type) {
+        // Valid value type?
+        const {dict} = type;
+        const dictType = dict.type;
+        const dictAttr = 'attr' in dict ? dict.attr : null;
+        const dictKeyType = 'keyType' in dict ? dict.keyType : defaultDictKeyType;
+        const dictKeyAttr = 'keyAttr' in dict ? dict.keyAttr : null;
+        if (value === '') {
+            valueNew = {};
+        } else if (value === null || typeof value !== 'object' || Array.isArray(value)) {
+            throwMemberError(type, value, memberFqn);
+        }
+
+        // Validate the dict key/value pairs
+        const isMap = valueNew instanceof Map;
+        const valueCopy = isMap ? new Map() : {};
+        const dictKeyNullable = dictKeyAttr !== null && 'nullable' in dictKeyAttr && dictKeyAttr.nullable;
+        const dictValueNullable = dictAttr !== null && 'nullable' in dictAttr && dictAttr.nullable;
+        for (let [dictKey, dictValue] of (isMap ? valueNew.entries() : Object.entries(valueNew))) {
+            const memberFqnKey = [memberFqn, dictKey];
+
+            // Validate the key
+            if (dictKeyNullable && (dictKey === null || dictKey === 'null')) {
+                dictKey = null;
+            } else {
+                dictKey = validateTypeHelper(types, dictKeyType, dictKey, memberFqn);
+                if (dictKeyAttr !== null) {
+                    validateAttr(dictKeyType, dictKeyAttr, dictKey, memberFqn);
+                }
+            }
+
+            // Validate the value
+            if (dictValueNullable && (dictValue === null || dictValue === 'null')) {
+                dictValue = null;
+            } else {
+                dictValue = validateTypeHelper(types, dictType, dictValue, memberFqnKey);
+                if (dictAttr !== null) {
+                    validateAttr(dictType, dictAttr, dictValue, memberFqnKey);
+                }
+            }
+
+            // Copy the key/value
+            if (isMap) {
+                valueCopy.set(dictKey, dictValue);
+            } else {
+                setValue(valueCopy, dictKey, dictValue);
+            }
+        }
+
+        // Return the validated, transformed copy
+        valueNew = valueCopy;
     }
 
     return valueNew;

package/lib/schemaUtil.js

@@ -106,6 +106,23 @@ export function validateTypeModelErrors(types) {
                 errors.push([typeName, null, `Inconsistent type name "${typedef.name}" for "${typeName}"`]);
             }
 
+            // Circular typedef?
+            const visited = new Set([typeName]);
+            let typedefType = typedef.type;
+            while ('user' in typedefType) {
+                const typedefUserName = typedefType.user;
+                const typedefUserType = Object.hasOwn(types, typedefUserName) ? types[typedefUserName] : null;
+                if (typedefUserType === null || !('typedef' in typedefUserType)) {
+                    break;
+                }
+                if (visited.has(typedefUserName)) {
+                    errors.push([typeName, null, `Circular typedef detected for type "${typeName}"`]);
+                    break;
+                }
+                visited.add(typedefUserName);
+                typedefType = typedefUserType.typedef.type;
+            }
+
             // Check the type and its attributes
             validateTypeModelType(errors, types, typedef.type, 'attr' in typedef ? typedef.attr : null, typeName, null);
 
@@ -170,11 +187,12 @@ export function validateTypeModelErrors(types) {
 }
 
 
-function getEffectiveType(types, type) {
-    if ('user' in type && Object.hasOwn(types, type.user)) {
+function getEffectiveType(types, type, visited = new Set()) {
+    if ('user' in type && Object.hasOwn(types, type.user) && !visited.has(type.user)) {
         const userType = types[type.user];
         if ('typedef' in userType) {
-            return getEffectiveType(types, userType.typedef.type);
+            visited.add(type.user);
+            return getEffectiveType(types, userType.typedef.type, visited);
         }
     }
     return type;

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "schema-markdown",
-    "version": "1.3.1",
+    "version": "1.3.2",
     "description": "A schema definition and validation library",
     "keywords": [
         "schema",