schema-markdown 1.2.3 → 1.2.5

package/README.md

@@ -3,7 +3,7 @@
 [![npm](https://img.shields.io/npm/v/schema-markdown)](https://www.npmjs.com/package/schema-markdown)
 [![GitHub](https://img.shields.io/github/license/craigahobbs/schema-markdown-js)](https://github.com/craigahobbs/schema-markdown-js/blob/main/LICENSE)
 
-**schema-markdown** is a schema definition and validation library.
+schema-markdown is a schema definition and validation library.
 
 
 ## Links
@@ -21,8 +21,8 @@ which is parsed by the
 [parseSchemaMarkdown](https://craigahobbs.github.io/schema-markdown-js/module-lib_parser.html#.parseSchemaMarkdown)
 function. For example:
 
-``` javascript
-import {parseSchemaMarkdown} from 'schema-markdown/parser.js';
+~~~ javascript
+import {parseSchemaMarkdown} from 'schema-markdown/lib/parser.js';
 
 export const modelTypes = parseSchemaMarkdown(`\
 # An aggregate numerical operation
@@ -39,7 +39,7 @@ enum AggregationFunction
     Average
     Sum
 `);
-```
+~~~
 
 
 ## Validate using a Schema
@@ -48,34 +48,34 @@ To validate an object using the schema, use the
 [validateType](https://craigahobbs.github.io/schema-markdown-js/module-lib_schema.html#.validateType)
 function. For example:
 
-``` javascript
-import {validateType} from 'schema-markdown/schema.js';
+~~~ javascript
+import {validateType} from 'schema-markdown/lib/schema.js';
 
 const obj = validateType(modelTypes, 'Aggregation', {'numbers': [1, 2, '3', 4]});
 console.assert(obj.numbers[2] === 3);
-```
+~~~
 
 Notice that the numerical input '3' above is *type-massaged* to the integer 3 by validation.
 
 Validation fails if the object does not match the schema:
 
-``` javascript
+~~~ javascript
 try {
     validateType(modelTypes, 'Aggregation', {'numbers': [1, 2, 'asdf', 4]});
 } catch ({message}) {
     console.assert(message === "Invalid value \"asdf\" (type 'string') for member 'numbers.2', expected type 'int'", message);
 }
-```
+~~~
 
 Validation also fails if a member constraint is violated:
 
-``` javascript
+~~~ javascript
 try {
     validateType(modelTypes, 'Aggregation', {'numbers': []});
 } catch ({message}) {
     console.assert(message === "Invalid value [] (type 'object') for member 'numbers', expected type 'array' [len > 0]", message);
 }
-```
+~~~
 
 
 ## Document a Schema
@@ -93,9 +93,9 @@ node --input-type=module \
 
 To host locally, start a local static web server:
 
-```
+~~~
 python3 -m http.server
-```
+~~~
 
 
 ## Development
@@ -103,6 +103,6 @@ python3 -m http.server
 This package is developed using [javascript-build](https://github.com/craigahobbs/javascript-build#readme).
 It was started using [javascript-template](https://github.com/craigahobbs/javascript-template#readme) as follows:
 
-```
+~~~
 template-specialize javascript-template/template/ schema-markdown-js/ -k package schema-markdown -k name 'Craig A. Hobbs' -k email 'craigahobbs@gmail.com' -k github 'craigahobbs' -k noapp 1
-```
+~~~

package/lib/encode.js

@@ -128,3 +128,40 @@ export function decodeQueryString(paramStr) {
 
     return result[0] !== null ? result[0] : {};
 }
+
+
+/**
+ * JSON-stringify an object with sorted keys
+ *
+ * @param {Object} obj - The object to stringify
+ * @returns {string}
+ */
+export function jsonStringifySortKeys(value, space) {
+    // JSON-stringify non-objects without creating a key set
+    if (value === null || typeof value !== 'object') {
+        return JSON.stringify(value, null, space);
+    }
+
+    // JSON-stringify with sorted keys
+    const keySet = new Set();
+    getObjectKeys(value, keySet);
+    const sortedKeys = Array.from(keySet.values()).sort();
+    return JSON.stringify(value, sortedKeys, space);
+}
+
+
+// Helper function to get an object keys (deep)
+function getObjectKeys(value, keySet) {
+    if (value !== null && typeof value === 'object') {
+        if (Array.isArray(value)) {
+            for (const subValue of value) {
+                getObjectKeys(subValue, keySet);
+            }
+        } else {
+            for (const [subKey, subValue] of Object.entries(value)) {
+                keySet.add(subKey);
+                getObjectKeys(subValue, keySet);
+            }
+        }
+    }
+}

package/lib/parser.js

@@ -46,7 +46,7 @@ const rTypedef = new RegExp(`^typedef\\s+${rPartTypedef}\\s*$`);
 const rMember = new RegExp(`^\\s+(?<optional>optional\\s+)?${rPartTypedef}\\s*$`);
 const rValue = new RegExp(`^\\s+(?<id>${rPartId})\\s*$`);
 const rValueQuoted = /^\s+"(?<id>.*?)"\s*$/;
-const rURL = /^\s+(?<method>[A-Za-z]+|\*)(?:\s+(?<path>\/[^\s]*))?/;
+const rURL = /^\s+(?<method>[A-Za-z]+|\*)(?:\s+(?<path>\/\S*))?/;
 const rLineSplit = /\r?\n/;
 
 

package/lib/schema.js

@@ -168,9 +168,10 @@ function validateTypeHelper(types, type, value, memberFqn) {
             // Not a number?
             } else if (typeof value !== 'number') {
                 throwMemberError(type, value, memberFqn);
+            }
 
             // Non-int number?
-            } else if (builtin === 'int' && Math.trunc(value) !== value) {
+            if (builtin === 'int' && Math.trunc(valueNew) !== valueNew) {
                 throwMemberError(type, value, memberFqn);
             }
 

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "schema-markdown",
-    "version": "1.2.3",
+    "version": "1.2.5",
     "description": "A schema definition and validation library",
     "keywords": [
         "schema",
@@ -24,10 +24,10 @@
         "test": "ava -v test/"
     },
     "devDependencies": {
-        "ava": "~4.3",
+        "ava": "~5.1",
         "c8": "~7.12",
-        "eslint": "~8.21",
-        "jsdoc": "~3.6",
-        "jsdom": "~20.0"
+        "eslint": "~8.32",
+        "jsdoc": "~4.0",
+        "jsdom": "~21.1"
     }
 }