formbuilder-lhcforms 12.9.0 → 12.10.0

package/README.md

@@ -87,6 +87,56 @@ cp .env .env.local
 
 The npm scripts automatically load `.env` plus `.env.local` (when present), with `.env.local` taking precedence.
 
+### Choosing the LHC-Forms version and server
+
+By default, the form builder loads the latest version of LHC-Forms from
+https://lhcforms-static.nlm.nih.gov/lforms-versions/ at run time. To change that, set `source` and/or
+`version` in `assets/lforms-config.json5`. Edit `src/assets/lforms-config.json5` before building, or the copy
+in the `assets` folder of the built application. The file is in [JSON5](https://json5.org/) format, and its
+comments describe both values.
+
+To load a specific version from the NLM server, set only `version`:
+
+```json5
+{
+  source: "",
+  version: "44.1.0"
+}
+```
+
+To use a fixed copy served by your own server instead (for example a version that matches the forms renderer
+of your application), set both values:
+
+```json5
+{
+  // Base URL of the LHC-Forms files.
+  source: "/path/to/lforms-44.1.0",
+  // X.Y.Z version of the LHC-Forms files at source.
+  version: "44.1.0"
+}
+```
+
+`source` is the base URL of the extracted
+[LHC-Forms release](https://lhcforms-static.nlm.nih.gov/lforms-versions/) (or of `dist/lforms` of the
+`lforms` npm package). A relative URL is resolved against the form builder's base URL (`<base href>`), and
+`/` is the root of the server. The base URL must contain `webcomponent/styles.css`,
+`webcomponent/assets/lib/zone.min.js`, `webcomponent/lhc-forms.js` and `fhir/lformsFHIRAll.min.js`. `version`
+must be the `X.Y.Z` version, 37.0.0 or later, of that copy, or of the release on the NLM server if `source` is
+not set; older versions lack features the form builder requires, such as FHIR R5 support. The form builder
+logs a warning in the browser console if the version of the loaded copy differs from `version`. Use a recent
+LHC-Forms version; the form builder is developed and tested with the latest one.
+
+The default behavior applies if the file is missing or empty, or if both values are empty or omitted. It also
+applies if the file cannot be read: on an HTTP error other than 404, the form builder logs a warning in the
+browser console and loads the latest version from the NLM server, even if the file sets `source`. A response
+with the content type `text/html` is treated as a missing file, without a warning, because single-page
+application servers return their HTML page for missing files. Make sure the file is served as-is (for
+example, not behind a login page) if your deployment must not load LHC-Forms from the NLM server. If the
+file is not valid JSON5, has `source` without `version`, or has an invalid `version`, the form builder reports
+an error instead of loading LHC-Forms. It also reports an error, without falling back to another version, if
+the configured version cannot be loaded. Browsers may cache the file, so configure your server to revalidate
+it if you change it after deployment.
+
 ## **Contributing**
   - If you plan to contribute new functionality, it is important to coordinate with the maintainers to ensure proper integration and to avoid duplicating efforts. Reach out to the maintainers for guidance on contributing.
 

package/dist/formbuilder-lhcforms/assets/fl-fields-layout.json5

@@ -23,6 +23,7 @@
           { field:  "identifier", col:  12},
           { field:  "meta", col:  12},
           { field:  "useContext", col:  12},
+          { field:  "jurisdiction", col:  12},
           { field:  "subjectType", "col": 12},
           { field:  "date", col:  12},
           { field:  "publisher", col:  12},
@@ -49,6 +50,11 @@
     '$.properties.meta': 'Meta',
     '$.properties.useContext': 'Usage Context',
     '$.properties.useContext.items.properties.__$valueSummary': 'Value',
+    '$.properties.jurisdiction.items.properties.text': 'Text',
+    '$.properties.jurisdiction.items.properties.coding': 'Coding',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.display': 'Display',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.code': 'Code',
+    '$.properties.jurisdiction.items.properties.coding.items.properties.system': 'System',
     '$.definitions.Meta.properties.versionId': 'Version ID (Read-only)',
     '$.definitions.Meta.properties.lastUpdated': 'Last updated (Read-only)',
     '$.definitions.Meta.properties.source': 'Source',
@@ -64,6 +70,7 @@
     inputBox: 'formStringField',
     textArea: 'formTextareaField',
     inlineTextArea: 'formInlineTextareaField',
+    jurisdictionCoding: 'dialogCodingTable',
     instant: 'formInstantField',
     'positive-integer': 'formPositiveIntegerField',
     'unsigned-integer': 'formUnsignedIntegerField'
@@ -185,6 +192,24 @@
         {"field": "__$valueSummary", "title": "Value", "col": 4, "nolabel": true}
       ]
     },
+    jurisdiction: {
+      "id": "array",
+      "addDefaultItemIfEmpty": false,
+      "labelPosition": "left",
+      "labelClasses": "col-sm-2 ps-0 pe-1",
+      "controlClasses": "col-sm-10",
+      "addButtonLabel": "Add jurisdiction",
+      "noCollapseButton": true
+    },
+    jurisdictionConcept: {
+      "id": "lfb-object",
+      "nolabel": true,
+      "childOffsetClass": "ms-0",
+      "showFields": [
+        {"field": "text", "col": 12},
+        {"field": "coding", "col": 12}
+      ]
+    },
     contained: {
       "id": "contained",
       "addEditAction": true,
@@ -289,9 +314,13 @@
       '$.properties.publisher',
       '$.definitions.Meta.properties.versionId',
       '$.definitions.Meta.properties.lastUpdated',
+      '$.properties.jurisdiction.items.properties.text',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.display',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.code',
     ],
     url: [
       '$.definitions.Meta.properties.source',
+      '$.properties.jurisdiction.items.properties.coding.items.properties.system',
     ],
     inlineTextArea: [
       '$.properties.description',
@@ -328,6 +357,15 @@
     usageContext: [
       '$.properties.useContext'
     ],
+    jurisdiction: [
+      '$.properties.jurisdiction'
+    ],
+    jurisdictionConcept: [
+      '$.properties.jurisdiction.items'
+    ],
+    jurisdictionCoding: [
+      '$.properties.jurisdiction.items.properties.coding'
+    ],
     extension: [
       '$.properties.extension'
     ],

package/dist/formbuilder-lhcforms/assets/lforms-config.json5

@@ -0,0 +1,18 @@
+{
+  // Optional: choose the LHC-Forms version and the server it is loaded from.
+  // - Both values empty (default): the latest version from
+  //   https://lhcforms-static.nlm.nih.gov/lforms-versions/.
+  // - Only version set: that version from the same NLM server.
+  // - Both values set: your own copy of LHC-Forms at source. source requires version.
+  // See "Choosing the LHC-Forms version and server" in README.md.
+
+  // Base URL of the LHC-Forms files, e.g. "/lforms/44.1.0" or "https://example.org/lforms/44.1.0".
+  // A relative URL is resolved against the form builder's base URL (<base href>); "/" is the server
+  // root. It must contain webcomponent/styles.css, webcomponent/assets/lib/zone.min.js,
+  // webcomponent/lhc-forms.js and fhir/lformsFHIRAll.min.js.
+  source: "",
+
+  // X.Y.Z version of LHC-Forms, 37.0.0 or later, e.g. "44.1.0": the version of the files at source,
+  // or, without source, the version to load from the NLM server.
+  version: ""
+}

package/dist/formbuilder-lhcforms/assets/version.json

@@ -1 +1 @@
-{"version": "12.9.0"}
+{"version": "12.10.0"}

package/dist/formbuilder-lhcforms/index.html

@@ -19,6 +19,6 @@
 <body class="bg-secondary">
   <lfb-root></lfb-root>
   <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
-<script src="runtime.821ff28674267dd4.js" type="module"></script><script src="polyfills.741ec81967e9c9c3.js" type="module"></script><script src="scripts.5c83cbb4dbb11a83.js" defer></script><script src="main.dd0ec5f4ab3ef14c.js" type="module"></script></body>
+<script src="runtime.821ff28674267dd4.js" type="module"></script><script src="polyfills.741ec81967e9c9c3.js" type="module"></script><script src="scripts.5c83cbb4dbb11a83.js" defer></script><script src="main.82ff277b674bb593.js" type="module"></script></body>
 </html>