formbuilder-lhcforms 9.7.3 → 9.7.5

package/README.md

@@ -1,31 +1,83 @@
-### Installation 
-1. Install **nodejs** package globally on your system.
+## What is NLM Form Builder?
+[NLM Form Builder](https://formbuilder.nlm.nih.gov) is an open source web application to create and edit a
+[FHIR Questionnaire](https://hl7.org/fhir/questionnaire.html) resource. The application
+creates input forms supporting medical terminologies such as
+[LOINC](https://loinc.org) and [SNOMED](https://www.snomed.org). This tool is
+written in the Angular framework and is developed by the [Lister Hill National Center
+for Biomedical Communications (LHNCBC)](https://lhbcbc.nlm.nih.gov), [National
+Library of Medicine (NLM)](https://www.nlm.nih.gov), part of the [National
+Institutes of Health (NIH)](https://www.nih.gov). It includes a preview of the
+generated form using [LHC-Forms](https://lhncbc.github.io/lforms/)
+widget.
 
-2. Clone git repository of formbuilder-lhcforms.
+## Licensing and Copyright Notice
+See [LICENSE.md](LICENSE.md).
 
-        $ git clone https://github.com/lhncbc/formbuilder-lhcforms.git
+## Customizing and Contributing
+If you wish to revise this package, the following steps will allow you install
+and to make changes and test them.
 
-3. Build the project.
-   * To build the project, change to formbuilder-lhcforms directory. Edit bashrc.formbuilder file to suit your development environment. Make sure that ./node_modules/.bin is in your path for the rest of the installation.
+### Installation
 
-          $ cd formbuilder-lhcforms
-          $ source bashrc.formbuilder
-          $ npm ci && npm run build
-          $ npm test ## Optional
+**Note**: The application is developed on a Linux platform. Therefore, the following
+instructions are for those who are familiar with Linux systems.
 
-### Running the application
-* To deploy on a production webserver:
+1. **Install Node.js**:
+  - Ensure that you install a version of Node.js that is compatible with the application. You can check the required version in the `bashrc.formbuilder` file included in the root of the project folder.
+  - You can use a version manager like `nvm` (Node Version Manager) to install Node.js:
+    ```bash
+    curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash
+    source ~/.bashrc
+    nvm install <version>
+    nvm use <version>
+    ```
 
-        $ cp dist/formbuilder-lhcforms {webserver docs location}
+2. **Clone the repository**:
+  - Clone the repository from GitHub and navigate to its directory:
+    ```bash
+    git clone https://github.com/LHNCBC/formbuilder-lhcforms.git
+    cd formbuilder-lhcforms
+    ```
 
-* To start dev server locally:
+3. **Install dependencies**:
+  - Run the following command to install the necessary dependencies:
+    ```bash
+    npm ci
+    ```
 
-        $ npm start
-  Point the browser at http://localhost:9030
+4. **Build the application**:
+  - Run the build command to create the build files in the `./dist` folder:
+    ```bash
+    npm run build
+    ```
 
-### Application Programming Interface (API)
+5. **Start the development server**:
+  - To start the development server, run:
+    ```bash
+    npm run start
+    ```
+  - Navigate to the provided local development server URL (this is usually `http://localhost:9030`).
+
+    **OR**
+
+  - If you need to access the dev server from a different machine, use:
+    ```bash
+    npm run start-public
+    ```
+
+6. **Run tests**:
+  - To run the unit tests and end-to-end (e2e) tests, use the following command:
+    ```bash
+    npm run test
+    ```
+
+## **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.
+
+If you encounter any issues during the installation or setup process, consult the project's documentation or reach out to the maintainers for further assistance.
+## Application Programming Interface (API)
 The form builder is an application. However, it is possible to control it via
-JavaScript from another web page. Refer to <a href="API.md">API.md</a>
+JavaScript from another web page. Refer to [API.md](API.md)
 for documentation.
         
 

package/dist/formbuilder-lhcforms/3rdpartylicenses.txt

@@ -776,6 +776,31 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
 
 
+async-function
+MIT
+MIT License
+
+Copyright (c) 2016 EduardoRFS
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+
 available-typed-arrays
 MIT
 MIT License

package/dist/formbuilder-lhcforms/assets/items-layout.json5

@@ -16,6 +16,7 @@
           { "field": "answerOption", "title": "Answer choices", "col": 12 },
           { "field": "__$itemControl", "col": 12 },
           { "field": "__$itemControlGroup", "col": 12 },
+          { "field": "__$itemControlDisplay", "col": 12 },          
           { "field": "__$units", "col": 12 }
         ]
       },

package/dist/formbuilder-lhcforms/assets/ngx-item.schema.json5

@@ -1128,10 +1128,75 @@
         "id": "item-control",
         "labelPosition": "left",
         "labelClasses": "col-2 ps-0 pe-1",
-        "controlClasses": "col-9 btn-group btn-group-sm p-0",
+        "controlClasses": "col-10 btn-group btn-group-sm p-0",
         "note": "(1) - not supported by LHC-Forms preview."
       }
     },
+    "__$itemControlDisplay": {
+      // Proxy for item control extension.
+      "description": "Choose the type of control for the 'Display' data type. Some item controls are not supported by the LHC-Forms preview, as indicated by the asterisk (1) symbol.",
+      "title": "Display Item Control",
+      "oneOf": [
+        {
+          'enum': ["inline"],
+          'display': 'In-line',
+          'description': 'The display item is rendered as a paragraph positioned sequentially among its sibling items (default behavior).',
+          'support': true
+        },
+        {
+          'enum': ["prompt"],
+          'display': 'Prompt',
+            'description': 'Text is shown directly below or within the answer-entry area of the containing question item, usually as a guide for what to enter.',
+          'support': false,
+          'deprecated': true
+        },
+        {
+          'enum': ["unit"],
+          'display': 'Unit',
+            'description': 'The display item is shown next to the answer area of the parent question, usually to indicate a unit of measure.',
+          'support': false,
+          'deprecated': true
+        },
+        {
+          'enum': ["lower"],
+          'display': 'Lower-bound',
+            'description': 'The display item is rendered to the left of the answer choices or a scaling control for the parent question, indicating the meaning of the \'lower\' bound, e.g., \'Strongly disagree\'.',
+          'support': false
+        },
+        {
+          'enum': ["upper"],
+          'display': 'Upper-bound',
+          'description': 'The display item is rendered to the right of the answer choices or a scaling control for the parent question item, indicating the meaning of the \'upper\' bound, e.g., \'Strongly agree\'.',
+          'support': false
+        },
+        {
+          'enum': ["flyover"],
+          'display': 'Fly-over',
+          'description': 'The display item appears temporarily when the mouse hovers over the text of the containing item.',
+          'support': false
+        },
+        {
+          'enum': ["legal"],
+          'display': 'Legal-Button',
+          'description': 'The display item is shown in a dialog box or similar control when a button or other UI element is used to request legal information for a question, group, or the entire questionnaire, depending on where the display item is nested.',
+          'support': false
+        }
+      ],
+      "default": "inline",
+      "type": "string",
+      "visibleIf": {
+        "type": ["$EXP$ target.value == 'display'"]
+      },
+      "widget": {
+        "id": "item-control",
+        "labelPosition": "left",
+        "labelClasses": "col-2 ps-0 pe-1",
+        "controlClasses": "col-10 btn-group btn-group-sm p-0",
+        "note": "(1) - not supported by LHC-Forms preview.",
+        "deprecatedNote": "* '${deprecatedItemControl}' item control is deprecated and is not presented in this list of item controls." 
+      }
+    },
+
     "__$terminologyServer": {
       "description": "Enter url for preferred terminology server.",
       "title": "Terminology server",
@@ -1816,6 +1881,17 @@
         }
       ]
     },
+    {
+      "fields": [
+        "__$itemControlDisplay"
+      ],
+      "showFields": [
+        {
+          "field": "__$itemControlDisplay",
+          "col": 12
+        }
+      ]
+    },    
     {
       "fields": [
         "__$terminologyServer"

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

@@ -1 +1 @@
-{"version": "9.7.3"}
+{"version": "9.7.5"}

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.451db9930bcccb8c.js" type="module"></script><script src="polyfills.ef59bbccd462f5ac.js" type="module"></script><script src="scripts.5c83cbb4dbb11a83.js" defer></script><script src="main.3731d110a39a76dc.js" type="module"></script></body>
+<script src="runtime.451db9930bcccb8c.js" type="module"></script><script src="polyfills.ef59bbccd462f5ac.js" type="module"></script><script src="scripts.5c83cbb4dbb11a83.js" defer></script><script src="main.82e5df166dcc08d1.js" type="module"></script></body>
 </html>