bare-script 3.8.9 → 3.8.11

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/baredoc.bare

@@ -90,14 +90,31 @@ async function baredocMain(url, title, menuLinks, groupURLs):
         return
     endif
 
+    # Fetch the group content URLs
+    groupContent = {}
+    if groupURLs != null:
+        # Fetch the content URLs
+        groupURLArray = []
+        groupNames = arraySort(objectKeys(groupURLs))
+        for groupName in groupNames:
+            arrayPush(groupURLArray, objectGet(groupURLs, groupName))
+        endfor
+        groupContentArray = systemFetch(groupURLArray)
+
+        # Assign the group contents
+        for groupName, ixGroupName in groupNames:
+            objectSet(groupContent, groupName, arrayGet(groupContentArray, ixGroupName))
+        endfor
+    endif
+
     # Render the page
     title = if(title != null && !objectHas(args, 'url'), title, url)
     if group != null:
-        baredocGroupPage(args, title, groupURLs, groups, group)
+        baredocGroupPage(args, title, groupURLs, groupContent, groups, group)
     elif single:
-        baredocSinglePage(args, title, menuLinks, groupURLs, groups)
+        baredocSinglePage(args, title, menuLinks, groupURLs, groupContent, groups)
     else:
-        baredocIndexPage(args, title, menuLinks, groupURLs, groups)
+        baredocIndexPage(args, title, menuLinks, groupURLs, groupContent, groups)
     endif
 endfunction
 
@@ -122,7 +139,7 @@ endfunction
 
 
 # Render a library documentation index page
-async function baredocIndexPage(args, title, menuLinks, groupURLs, groups):
+function baredocIndexPage(args, title, menuLinks, groupURLs, groupContent, groups):
     publish = objectGet(args, 'publish')
 
     # Render the menu and title
@@ -139,9 +156,9 @@ async function baredocIndexPage(args, title, menuLinks, groupURLs, groups):
     markdownPrint('# ' + markdownEscape(title))
 
     # Render the index Markdown, if any
-    if groupURLs != null && objectHas(groupURLs, ''):
+    if objectHas(groupContent, ''):
         rootURL = objectGet(groupURLs, '')
-        rootMarkdown = systemFetch(rootURL)
+        rootMarkdown = objectGet(groupContent, '')
         markdownPrint('', if(rootMarkdown != null, rootMarkdown, '**Error:** Failed to load "' + markdownEscape(rootURL) + '"'))
     endif
 
@@ -159,7 +176,7 @@ endfunction
 
 
 # Render the single-page library documentation
-async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
+function baredocSinglePage(args, title, menuLinks, groupURLs, groupContent, groups):
     publish = objectGet(args, 'publish')
 
     # Render the menu and title
@@ -176,9 +193,9 @@ async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
     markdownPrint('# ' + markdownEscape(title))
 
     # Render the index Markdown, if any
-    if groupURLs != null && objectHas(groupURLs, ''):
+    if objectHas(groupContent, ''):
         rootURL = objectGet(groupURLs, '')
-        rootMarkdown = systemFetch(rootURL)
+        rootMarkdown = objectGet(groupContent, '')
         markdownPrint('', if(rootMarkdown != null, rootMarkdown, '**Error:** Failed to load "' + markdownEscape(rootURL) + '"'))
     endif
 
@@ -196,13 +213,13 @@ async function baredocSinglePage(args, title, menuLinks, groupURLs, groups):
     # Render the library function index
     for groupName in arraySort(objectKeys(groups)):
         markdownPrint('', '---', '')
-        baredocGroupPage(args, title, groupURLs, groups, groupName)
+        baredocGroupPage(args, title, groupURLs, groupContent, groups, groupName)
     endfor
 endfunction
 
 
 # Render a library documentation group page
-async function baredocGroupPage(args, title, groupURLs, groups, groupName):
+function baredocGroupPage(args, title, groupURLs, groupContent, groups, groupName):
     publish = objectGet(args, 'publish')
     single = objectGet(args, 'single')
     baseHeader = if(single, '##', '#')
@@ -227,11 +244,10 @@ async function baredocGroupPage(args, title, groupURLs, groups, groupName):
         markdownPrint('', argsLink(baredocArguments, 'Back to top', null, false, '_top'))
     endif
 
-
     # Render the group Markdown, if any
-    if groupURLs != null && objectHas(groupURLs, groupName):
+    if objectHas(groupContent, groupName):
         groupURL = objectGet(groupURLs, groupName)
-        groupMarkdown = systemFetch(groupURL)
+        groupMarkdown = objectGet(groupContent, groupName)
         markdownPrint('', if(groupMarkdown != null, groupMarkdown, '**Error:** Failed to load "' + markdownEscape(groupURL) + '"'))
     endif
 

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/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/schemaDoc.bare

@@ -141,10 +141,10 @@ schemaDocArguments = argsValidate([ \
 # $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.9",
+    "version": "3.8.11",
     "description": "BareScript; a lightweight scripting and expression language",
     "keywords": [
         "expression",