bare-script 3.8.8 → 3.8.10

package/lib/data.js

@@ -443,7 +443,7 @@ export function aggregateData(data, aggregation) {
 
 // The aggregation model
 export const aggregationTypes = parseSchemaMarkdown(`\
-group "Aggregation"
+group "data"
 
 
 # A data aggregation specification

package/lib/include/args.bare

@@ -6,7 +6,7 @@ include <dataTable.bare>
 
 # The URL arguments model
 argsTypes = schemaParse( \
-    'group "<args.bare>"', \
+    'group "args.bare"', \
     '', \
     '', \
     '# An argument model list', \

package/lib/include/baredoc.bare

@@ -6,7 +6,7 @@ include <schemaDoc.bare>
 
 
 # $function: baredocMain
-# $group: baredocMain.bare
+# $group: baredoc.bare
 # $doc: The BareScript library documentation application main entry point
 # $arg url: The library documentation JSON resource URL
 # $arg title: The library title

package/lib/include/dataLineChart.bare

@@ -4,7 +4,7 @@
 
 # The line chart model
 dataLineChartTypes = schemaParse( \
-    'group "Line Chart"', \
+    'group "data"', \
     '', \
     '', \
     '# A line chart model', \

package/lib/include/dataTable.bare

@@ -4,7 +4,7 @@
 
 # The data table model's Schema Markdown
 dataTableTypes = schemaParse( \
-    'group "<dataTable.bare>"', \
+    'group "dataTable.bare"', \
     '', \
     '', \
     '# A data table model', \

package/lib/include/diff.bare

@@ -4,7 +4,7 @@
 
 # The text line difference model
 diffTypes = schemaParse( \
-    'group "<diff.bare>"', \
+    'group "diff.bare"', \
     '', \
     '', \
     '# A list of text line differences', \

package/lib/include/markdownUp.bare

@@ -441,6 +441,16 @@ endfunction
 #
 
 
+# $function: markdownElements
+# $group: Markdown
+# $doc: Generate an element model from a Markdown model
+# $arg markdownModel: The [Markdown model](https://craigahobbs.github.io/markdown-model/model/#var.vName='Markdown')
+# $arg generic: Optional (default is false). If true, render markdown elements in a generic context.
+# $return: The rendered Markdown [element model](https://github.com/craigahobbs/element-model#readme)
+function markdownElements():
+endfunction
+
+
 # $function: markdownEscape
 # $group: markdownUp.bare: markdown
 # $doc: Escape text for inclusion in Markdown text
@@ -509,35 +519,6 @@ function markdownTitle():
 endfunction
 
 
-#
-# Schema functions
-#
-
-
-# $function: schemaElements
-# $group: markdownUp.bare: schema
-# $doc: Get a schema type's documentation [element model](https://github.com/craigahobbs/element-model#readme).
-# $doc: Render the element model with the [elementModelRender](#var.vName='elementModelRender') function.
-# $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
-# $arg typeName: The type name
-# $arg actionURLs: Optional (default is null). The
-# $arg actionURLs: [action URL overrides](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='ActionURL').
-# $arg actionCustom: Optional (default is false). If true, the action has a custom response.
-# $return: The schema type's documentation [element model](https://github.com/craigahobbs/element-model#readme)
-function schemaElements(types, typeName):
-    userType = objectGet(types, typeName)
-    userTypeKey = arrayGet(objectKeys(userType), 0)
-    if userTypeKey == 'struct' && objectGet(objectGet(userType, 'struct'), 'union'):
-        userTypeKey = 'union'
-    endif
-    return [ \
-        [ \
-            {'html': 'h1', 'elem': {'text': userTypeKey + ' ' + typeName}} \
-        ] \
-    ]
-endfunction
-
-
 #
 # Session storage functions
 #

package/lib/include/pager.bare

@@ -7,7 +7,7 @@ include <args.bare>
 
 # The pager model
 pagerTypes = schemaParse( \
-    'group "<pager.bare>"', \
+    'group "pager.bare"', \
     '', \
     '', \
     '# A pager application model', \

package/lib/include/schemaDoc.bare

@@ -1,16 +1,150 @@
 # Licensed under the MIT License
 # https://github.com/craigahobbs/bare-script/blob/main/LICENSE
 
+include <args.bare>
 include <dataTable.bare>
+include <schemaDoc.bare>
+
+
+# $function: schemaDocMain
+# $group: schemaDoc.bare
+# $doc: The Schema Markdown documentation viewer main entry point
+# $arg url: Optional (default is null). The Schema Markdown text or JSON resource URL. If null, the Schema Markdown type model is displayed.
+# $arg title: Optional. The schema title.
+# $arg hideNoGroup: Optional (default is false). If true, hide types with no group.
+async function schemaDocMain(url, title, hideNoGroup):
+    # Parse arguments
+    args = argsParse(schemaDocArguments)
+    name = objectGet(args, 'name')
+    publish = objectGet(args, 'publish')
+    single = objectGet(args, 'single')
+    url = objectGet(args, 'url', url)
+    title = if(title != null && !objectHas(args, 'url'), title, url)
+
+    # If no URL was provided, use the Schema Markdown type model schema
+    if !url:
+        types = schemaTypeModel()
+        title = 'The Schema Markdown Type Model'
+    else:
+        # Fetch the Schema Markdown resource
+        types = null
+        schemaText = systemFetch(url)
+        if schemaText != null:
+            if stringEndsWith(url, '.json'):
+                schemaJSON = jsonParse(schemaText)
+                if schemaJSON != null:
+                    types = schemaValidateTypeModel(schemaJSON)
+                endif
+            else:
+                types = schemaParse(schemaText)
+            endif
+        endif
+
+        # Error?
+        if types == null:
+            markdownPrint('**Error:** Failed to fetch Schema Markdown resource "' + url + '"')
+            return
+        endif
+    endif
+
+    # Type page?
+    if name:
+        # Set the type page title
+        documentSetTitle(title + ' - ' + name)
+        markdownPrint(argsLink(schemaDocArguments, 'Index', {'name': null}))
+
+        # Type exist?
+        if !objectHas(types, name):
+            markdownPrint('', '**Error:** Unknown type "' + name + '"')
+            return
+        endif
+
+        # Render the type's documentation
+        markdownPrint(schemaDocMarkdown(types, name))
+        return
+    endif
+
+    # Render the index page title
+    documentSetTitle(title)
+    markdownPrint('# ' + markdownEscape(title))
+
+    # Render the single page toggle
+    if !publish:
+        markdownPrint('', argsLink(schemaDocArguments, if(single, 'Multi Page', 'Single Page'), {'single': !single}))
+    endif
+
+    # Group the types
+    groups = {}
+    typeNames = arraySort(objectKeys(types))
+    typeGroups = {'action': 'Actions', 'enum': 'Enums', 'struct': 'Structs', 'typedef': 'Typedefs'}
+    for typeName in typeNames:
+        type = objectGet(types, typeName)
+        group = objectGet(objectGet(type, arrayGet(objectKeys(type), 0)), 'docGroup')
+
+        # No group? Use the type's default group.
+        if group == null:
+            if hideNoGroup:
+                continue
+            endif
+            group = objectGet(typeGroups, arrayGet(objectKeys(type), 0))
+        endif
+
+        # Add the type to the group
+        if !objectHas(groups, group):
+            objectSet(groups, group, [])
+        endif
+        arrayPush(objectGet(groups, group), type)
+    endfor
+    groupNames = arraySort(objectKeys(groups))
+
+    # The table of contents
+    if single:
+        markdownPrint('', '## Table of Contents', '')
+        for groupName in groupNames:
+            markdownPrint('- ' + argsLink(schemaDocArguments, groupName, null, false, groupName))
+        endfor
+    endif
+
+    # Render the index groups
+    for groupName in groupNames:
+        if single:
+            markdownPrint('', '---')
+        endif
+        markdownPrint('', '## ' + markdownEscape(groupName))
+        if single && !publish:
+            markdownPrint('', argsLink(schemaDocArguments, 'Back to top', null, false, '_top'))
+        endif
+
+        # Render the group type links
+        groupTypes = objectGet(groups, groupName)
+        for groupType in groupTypes:
+            groupTypeName = objectGet(objectGet(groupType, arrayGet(objectKeys(groupType), 0)), 'name')
+            if single:
+                markdownPrint('', schemaDocMarkdown(types, groupTypeName, {'headerPrefix': '###', 'hideReferenced': true}))
+            else:
+                markdownPrint('', argsLink(schemaDocArguments, groupTypeName, {'name': groupTypeName}, false, '_top'))
+            endif
+        endfor
+    endfor
+endfunction
+
+
+# The Schema Markdown documentation viewer arguments
+schemaDocArguments = argsValidate([ \
+    {'name': 'name'}, \
+    {'name': 'publish', 'type': 'bool', 'default': false}, \
+    {'name': 'single', 'type': 'bool', 'default': false}, \
+    {'name': 'url', 'global': 'vURL'} \
+])
 
 
 # $function: schemaDocMarkdown
 # $group: schemaDoc.bare
 # $doc: Generate the Schema Markdown user type documentation as an array of Markdown text lines
-# $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+# $arg types: The [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 # $arg typeName: The type name
 # $arg options: Optional (default is null). The options object with optional members:
-# $arg options: - **actionURLs** - The [action URLs](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='ActionURL') override
+# $arg options: - **actionURLs** - The [action URLs](https://craigahobbs.github.io/bare-script/model/#var.vName='ActionURL'&var.vURL='') override
 # $arg options: - **actionCustom** - If true, the action has a custom response (default is false)
 # $arg options: - **headerPrefix** - The top-level header prefix string (default is "#")
 # $arg options: - **hideReferenced** - If true, referenced types are not rendered (default is false)

package/lib/include/unittestMock.bare

@@ -31,6 +31,7 @@ unittestMockState = objectCopy(unittestMockStateDefault)
 # $arg data: Optional (default is null). The map of function name to mock function data.
 # $arg data: The following functions make use of mock data:
 # $arg data: - **documentInputValue** - map of id to return value
+# $arg data: - **markdownElements** - array of return values
 # $arg data: - **markdownParse** - array of return values
 # $arg data: - **markdownTitle** - array of return values
 # $arg data: - **systemFetch** - map of URL to response text
@@ -80,15 +81,13 @@ function unittestMockAll(data):
     unittestMockOne('localStorageSet', unittestMock_localStorageSet)
 
     # Markdown
+    unittestMockOne('markdownElements', systemPartial(unittestMock_markdownElements, if(data != null, objectGet(data, 'markdownElements'))))
     unittestMockOne('markdownEscape', unittestMock_markdownEscape)
     unittestMockOne('markdownHeaderId', unittestMock_markdownHeaderId)
     unittestMockOne('markdownParse', systemPartial(unittestMock_markdownParse, if(data != null, objectGet(data, 'markdownParse'))))
     unittestMockOneGeneric('markdownPrint')
     unittestMockOne('markdownTitle', systemPartial(unittestMock_markdownTitle, if(data != null, objectGet(data, 'markdownTitle'))))
 
-    # Schema
-    unittestMockOne('schemaElements', unittestMock_schemaElements)
-
     # Session Storage
     unittestMockOne('sessionStorageClear', unittestMock_sessionStorageClear)
     unittestMockOne('sessionStorageGet', unittestMock_sessionStorageGet)
@@ -287,6 +286,15 @@ endfunction
 #
 
 
+function unittestMock_markdownElements(data, args...):
+    # Record the mocked function call
+    arrayPush(unittestMockCalls, ['markdownElements', args])
+
+    # Return the mocked markdownElements response
+    return if(data != null, arrayShift(data))
+endfunction
+
+
 function unittestMock_markdownEscape(text):
     return regexReplace(unittestMock_markdownEscapeRegex, text, '\\$1')
 endfunction
@@ -326,25 +334,6 @@ function unittestMock_markdownTitle(data, args...):
 endfunction
 
 
-#
-# Schema functions
-#
-
-
-function unittestMock_schemaElements(types, typeName):
-    userType = objectGet(types, typeName)
-    userTypeKey = arrayGet(objectKeys(userType), 0)
-    if userTypeKey == 'struct' && objectGet(objectGet(userType, 'struct'), 'union'):
-        userTypeKey = 'union'
-    endif
-    return [ \
-        [ \
-            {'html': 'h1', 'elem': {'text': userTypeKey + ' ' + typeName}} \
-        ] \
-    ]
-endfunction
-
-
 #
 # Session Storage functions
 #

package/lib/library.js

@@ -1427,7 +1427,7 @@ function regexMatchGroups(match) {
 
 // The regex match model
 export const regexMatchTypes = parseSchemaMarkdown(`\
-group "RegexMatch"
+group "regex"
 
 
 # A regex match model
@@ -1522,7 +1522,7 @@ const regexSplitArgs = valueArgsModel([
 // $doc: Parse the [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/) text
 // $arg lines...: The [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
 // $arg lines...: text lines (may contain nested arrays of un-split lines)
-// $return: The schema's [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+// $return: The schema's [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 function schemaParse(lines) {
     return parseSchemaMarkdown(lines);
 }
@@ -1533,9 +1533,9 @@ function schemaParse(lines) {
 // $doc: Parse the [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/) text with options
 // $arg lines: The array of [Schema Markdown](https://craigahobbs.github.io/schema-markdown-js/language/)
 // $arg lines: text lines (may contain nested arrays of un-split lines)
-// $arg types: Optional. The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types').
+// $arg types: Optional. The [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='').
 // $arg filename: Optional (default is ""). The file name.
-// $return: The schema's [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+// $return: The schema's [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 function schemaParseEx(args) {
     const [lines, typesArg, filename] = valueArgsValidate(schemaParseExArgs, args);
     const linesType = valueType(lines);
@@ -1556,8 +1556,8 @@ const schemaParseExArgs = valueArgsModel([
 
 // $function: schemaTypeModel
 // $group: schema
-// $doc: Get the [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
-// $return: The [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+// $doc: Get the [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
+// $return: The [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 function schemaTypeModel() {
     return typeModel;
 }
@@ -1566,7 +1566,7 @@ function schemaTypeModel() {
 // $function: schemaValidate
 // $group: schema
 // $doc: Validate an object to a schema type
-// $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+// $arg types: The [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 // $arg typeName: The type name
 // $arg value: The object to validate
 // $return: The validated object or null if validation fails
@@ -1585,9 +1585,9 @@ const schemaValidateArgs = valueArgsModel([
 
 // $function: schemaValidateTypeModel
 // $group: schema
-// $doc: Validate a [Schema Markdown Type Model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
-// $arg types: The [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types') to validate
-// $return: The validated [type model](https://craigahobbs.github.io/schema-markdown-doc/doc/#var.vName='Types')
+// $doc: Validate a [Schema Markdown Type Model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
+// $arg types: The [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='') to validate
+// $return: The validated [type model](https://craigahobbs.github.io/bare-script/model/#var.vName='Types'&var.vURL='')
 function schemaValidateTypeModel(args) {
     const [types] = valueArgsValidate(schemaValidateTypeModelArgs, args);
     return validateTypeModel(types);
@@ -1972,7 +1972,7 @@ async function systemFetch([url = null], options) {
 
 // The aggregation model
 export const systemFetchTypes = parseSchemaMarkdown(`\
-group "SystemFetch"
+group "system"
 
 
 # A fetch request model

package/package.json

@@ -1,7 +1,7 @@
 {
     "type": "module",
     "name": "bare-script",
-    "version": "3.8.8",
+    "version": "3.8.10",
     "description": "BareScript; a lightweight scripting and expression language",
     "keywords": [
         "expression",

package/lib/include/schemaDocApp.bare

@@ -1,149 +0,0 @@
-# Licensed under the MIT License
-# https://github.com/craigahobbs/bare-script/blob/main/LICENSE
-
-include <args.bare>
-include <schemaDoc.bare>
-
-
-# $function: schemaDocAppMain
-# $group: schemaDocApp.bare
-# $doc: The Schema Markdown documentation viewer main entry point
-# $arg url: Optional (default is null). The Schema Markdown text or JSON resource URL. If null, the Schema Markdown type model is displayed.
-# $arg title: Optional. The schema title.
-# $arg hideNoGroup: Optional (default is false). If true, hide types with no group.
-async function schemaDocAppMain(url, title, hideNoGroup):
-    # Parse arguments
-    args = argsParse(schemaDocAppArguments)
-    name = objectGet(args, 'name')
-    url = objectGet(args, 'url', url)
-    title = if(title != null && !objectHas(args, 'url'), title, url)
-
-    # If no URL was provided, use the Schema Markdown type model schema
-    if url == null || url == '':
-        types = schemaTypeModel()
-        title = 'The Schema Markdown Type Model'
-    else:
-        # Fetch the Schema Markdown resource
-        types = null
-        schemaText = systemFetch(url)
-        if schemaText != null:
-            if stringEndsWith(url, '.json'):
-                schemaJSON = jsonParse(schemaText)
-                if schemaJSON != null:
-                    types = schemaValidateTypeModel(schemaJSON)
-                endif
-            else:
-                types = schemaParse(schemaText)
-            endif
-        endif
-
-        # Error?
-        if types == null:
-            markdownPrint('**Error:** Failed to fetch Schema Markdown resource "' + url + '"')
-            return
-        endif
-    endif
-
-    # Render the page
-    if name != null:
-        schemaDocAppTypePage(types, title, name)
-    else:
-        schemaDocAppIndexPage(args, types, title, hideNoGroup)
-    endif
-endfunction
-
-
-# The Schema Markdown documentation viewer arguments
-schemaDocAppArguments = argsValidate([ \
-    {'name': 'name'}, \
-    {'name': 'publish', 'type': 'bool', 'default': false}, \
-    {'name': 'single', 'type': 'bool', 'default': false}, \
-    {'name': 'url', 'global': 'vURL'} \
-])
-
-
-# Render the Schema Markdown documentation viewer index page
-function schemaDocAppIndexPage(args, types, title, hideNoGroup):
-    publish = objectGet(args, 'publish')
-    single = objectGet(args, 'single')
-
-    # Set the page title
-    documentSetTitle(title)
-    markdownPrint('# ' + markdownEscape(title))
-
-    # Render the single page toggle
-    if !publish:
-        markdownPrint('', argsLink(schemaDocAppArguments, if(single, 'Multi Page', 'Single Page'), {'single': !single}))
-    endif
-
-    # Group the types
-    groups = {}
-    typeNames = arraySort(objectKeys(types))
-    typeGroups = {'action': 'Actions', 'enum': 'Enums', 'struct': 'Structs', 'typedef': 'Typedefs'}
-    for typeName in typeNames:
-        type = objectGet(types, typeName)
-        group = objectGet(objectGet(type, arrayGet(objectKeys(type), 0)), 'docGroup')
-
-        # No group? Use the type's default group.
-        if group == null:
-            if hideNoGroup:
-                continue
-            endif
-            group = objectGet(typeGroups, arrayGet(objectKeys(type), 0))
-        endif
-
-        # Add the type to the group
-        if !objectHas(groups, group):
-            objectSet(groups, group, [])
-        endif
-        arrayPush(objectGet(groups, group), type)
-    endfor
-    groupNames = arraySort(objectKeys(groups))
-
-    # The table of contents
-    if single:
-        markdownPrint('', '## Table of Contents', '')
-        for groupName in groupNames:
-            markdownPrint('- ' + argsLink(schemaDocAppArguments, groupName, null, false, groupName))
-        endfor
-    endif
-
-    # Render the index groups
-    for groupName in groupNames:
-        if single:
-            markdownPrint('', '---')
-        endif
-        markdownPrint('', '## ' + markdownEscape(groupName))
-        if single && !publish:
-            markdownPrint('', argsLink(schemaDocAppArguments, 'Back to top', null, false, '_top'))
-        endif
-
-        # Render the group type links
-        groupTypes = objectGet(groups, groupName)
-        for groupType in groupTypes:
-            groupTypeName = objectGet(objectGet(groupType, arrayGet(objectKeys(groupType), 0)), 'name')
-            if single:
-                markdownPrint('', schemaDocMarkdown(types, groupTypeName, {'headerPrefix': '###', 'hideReferenced': true}))
-            else:
-                markdownPrint('', argsLink(schemaDocAppArguments, groupTypeName, {'name': groupTypeName}, false, '_top'))
-            endif
-        endfor
-    endfor
-endfunction
-
-
-# Render the Schema Markdown documentation viewer type page
-function schemaDocAppTypePage(types, title, typeName):
-    # Set the page title
-    documentSetTitle(title + ' - ' + typeName)
-    markdownPrint(argsLink(schemaDocAppArguments, 'Index', {'name': null}))
-
-    # Type exist?
-    if !objectHas(types, typeName):
-        markdownPrint('', '**Error:** Unknown type "' + typeName + '"')
-        return
-    endif
-
-    # Render the type's documentation
-    markdownPrint(schemaDocMarkdown(types, typeName))
-endfunction