schema-markdown 1.1.5 → 1.2.1

package/lib/schema.js

@@ -4,23 +4,22 @@
 /** @module lib/schema */
 
 import {typeModel} from './typeModel.js';
-import {validateTypeModelTypesErrors} from './schemaUtil.js';
+import {validateTypeModelErrors} from './schemaUtil.js';
 
 
 /**
  * Get a user type's referenced type model
  *
- * @param {Object} types - The map of user type name to user type model
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
  * @param {string} typeName - The type name
  * @param {Object} [referencedTypes=null] - Optional map of referenced user type name to user type model
- * @returns {Object}
+ * @returns {Object} The referenced [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
  */
 export function getReferencedTypes(types, typeName, referencedTypes = {}) {
     return getReferencedTypesHelper(types, {'user': typeName}, referencedTypes);
 }
 
 
-// eslint-disable-next-line no-unused-vars
 function getReferencedTypesHelper(types, type, referencedTypes) {
     // Array?
     if ('array' in type) {
@@ -105,7 +104,7 @@ export class ValidationError extends Error {
     /**
      * Schema Markdown type model validation error constructor
      *
-     * @param {string} [memberFqn=null] - Optional fully-qualified member name
+     * @param {string} [memberFqn=null] - The fully-qualified member name
      */
     constructor(message, memberFqn = null) {
         super(message);
@@ -118,12 +117,12 @@ export class ValidationError extends Error {
  * Type-validate a value using a user type model. Container values are duplicated since some member types are
  * transformed during validation.
  *
- * @param {Object} types - The map of user type name to user type model
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
  * @param {string} typeName - The type name
  * @param {Object} value - The value object to validate
- * @param {string} [memberFqn=null] - Optional fully-qualified member name
+ * @param {?string} [memberFqn=null] - The fully-qualified member name
  * @returns {Object} The validated, transformed value object
- * @throws {ValidationError} A validation error occurred
+ * @throws [ValidationError]{@link module:lib/schema.ValidationError}
  */
 export function validateType(types, typeName, value, memberFqn = null) {
     if (!(typeName in types)) {
@@ -449,9 +448,10 @@ function validateAttr(type, attr, value, memberFqn) {
 /**
  * Get the struct's members (inherited members first)
  *
- * @param {Object} types - The map of user type name to user type model
- * @param {Object} struct - The struct model
- * @returns {Array<Object>} The array of struct member models
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} struct - The [struct model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Struct'}
+ * @returns {Array<Object>} The array of
+ *     [struct member models]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='StructMember'}
  */
 export function getStructMembers(types, struct) {
     // No base structs?
@@ -481,9 +481,10 @@ export function getStructMembers(types, struct) {
 /**
  * Get the enum's values (inherited values first)
  *
- * @param {Object} types - The map of user type name to user type model
- * @param {Object} enum_ - The enum model
- * @returns {Array<Object>} The array of enum value models
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @param {Object} enum_ - The [enum model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Enum'}
+ * @returns {Array<Object>} The array of
+ *     [enum value models]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='EnumValue'}
  */
 export function getEnumValues(types, enum_) {
     // No base enums?
@@ -513,40 +514,19 @@ export function getEnumValues(types, enum_) {
 /**
  * Validate a type model's types object
  *
- * @param {Object} types - The map of user type name to user type model
- * @returns {Object} The validated, transformed types object
- * @throws {ValidationError} A validation error occurred
+ * @param {Object} types - The [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @returns {Object} The validated [type model]{@link https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types'}
+ * @throws [ValidationError]{@link module:lib/schema.ValidationError}
  */
-export function validateTypeModelTypes(types) {
+export function validateTypeModel(types) {
     // Validate with the type model
-    const validatedTypes = validateType(typeModel.types, 'Types', types);
+    const validatedTypes = validateType(typeModel, 'Types', types);
 
     // Do additional type model validation
-    const errors = validateTypeModelTypesErrors(validatedTypes);
+    const errors = validateTypeModelErrors(validatedTypes);
     if (errors.length) {
         throw new ValidationError(errors.map(([,, message]) => message).join('\n'));
     }
 
     return validatedTypes;
 }
-
-
-/**
- * Validate a user type model
- *
- * @param {Object} userTypeModel - The user type model
- * @returns {Object} The validated, transformed type model
- * @throws {ValidationError} A validation error occurred
- */
-export function validateTypeModel(userTypeModel) {
-    // Validate with the type model
-    const validatedUserTypeModel = validateType(typeModel.types, 'TypeModel', userTypeModel);
-
-    // Do additional type model validation
-    const errors = validateTypeModelTypesErrors(validatedUserTypeModel.types);
-    if (errors.length) {
-        throw new ValidationError(errors.map(([,, message]) => message).join('\n'));
-    }
-
-    return validatedUserTypeModel;
-}

package/lib/schemaUtil.js

@@ -10,7 +10,7 @@
  *
  * @ignore
  */
-export function validateTypeModelTypesErrors(types) {
+export function validateTypeModelErrors(types) {
     const errors = [];
 
     // Check each user type

package/lib/typeModel.js

@@ -3,21 +3,13 @@
 
 /** @module lib/typeModel */
 
-import {SchemaMarkdownParser} from './parser.js';
-
-
-// The Schema Markdown type model defined as Schema Markdown
-const typeModelSmd = `\
-# A type model with a title
-struct TypeModel
-
-    # The type model's title
-    string title
-
-    # The type model
-    Types types
+import {parseSchemaMarkdown} from './parser.js';
 
 
+/**
+ * The Schema Markdown type model
+ */
+export const typeModel = parseSchemaMarkdown(`\
 # Map of user type name to user type model
 typedef UserType{len > 0} Types
 
@@ -250,13 +242,4 @@ struct ActionURL
 
     # The URL path. If not provided, uses the default URL path of "/<actionName>".
     optional string path
-`;
-
-
-/**
- * The Schema Markdown type model
- */
-export const typeModel = {
-    'title': 'The Schema Markdown Type Model',
-    'types': (new SchemaMarkdownParser(typeModelSmd)).types
-};
+`);

package/package.json

@@ -1,8 +1,8 @@
 {
     "type": "module",
     "name": "schema-markdown",
-    "version": "1.1.5",
-    "description": "Human-friendly schema definition language and schema validator",
+    "version": "1.2.1",
+    "description": "A schema definition and validation library",
     "keywords": [
         "schema",
         "definition",
@@ -24,10 +24,10 @@
         "test": "ava -v test/"
     },
     "devDependencies": {
-        "ava": "^4.0.0-rc.1",
-        "c8": "~7.10",
-        "eslint": "~8.4",
+        "ava": "~4.3",
+        "c8": "~7.12",
+        "eslint": "~8.21",
         "jsdoc": "~3.6",
-        "jsdom": "~19.0"
+        "jsdom": "~20.0"
     }
 }