@luomus/laji-form 14.3.6

package/CHANGELOG.md

@@ -0,0 +1,215 @@
+## 14.3.2
+* `SortArrayField`: add `multisort` option (defaults to `false`)
+
+## 14.3.1
+* `SortArrayField`: add `columns[*].tooltip` & `excludeSortableColumns` options
+
+## 14.1.0
+* Add bootstrap 5 theme
+
+## 14.0.0
+### BREAKING CHANGES:
+* `react-jsonschema-form` updated to version `5`. Read more: https://react-jsonschema-form.readthedocs.io/en/latest/5.x%20upgrade%20guide/
+
+## 13.0.0
+### BREAKING CHANGES:
+* Support for JSON Schema `enum` & `enumNames` properties dropped since they aren't JSON Schema. Instead, enums should be in format `{const: string, title: string}[]`.
+
+## 12.5.0
+* add `lajiGeoServerAddress` option
+
+## 12.4.0
+* Add `showButtons.same` option for `DateTimeWidget`
+
+## 12.3.0
+* Parameterize `AutosuggestField` `toggleable` default `toggle` status, `tooltip` and `placeholder`
+
+## 12.2.0
+* Add `jsonPointer` operator to `computeUiSchema` (used by e.g. `MultiArrayField`, `ConditionalUiSchemaField`)
+
+## 12.1.0
+* MultiArrayField can persist by parent id
+* ConditionalUiSchemaField rules "isEdit" and "isAdmin" can be given as {"rule": "isEdit"}, so that it can leverage e.g. {"complement": true}
+* SelectWidget selects focused with tab
+* AutosuggestWidget toggler moved to left side of input
+
+## 12.0.4
+* Checkbox widget hides label of nonactive button if has no custom labels. If a button for undefined isn't shown, click either button toggles the value.
+
+## 12.0.0
+### BREAKING CHANGES:
+* Buttons don't use `primary` variant by default & not strong text.
+
+## 11.0.0
+* TS declarations files included in `lib`
+
+### BREAKING CHANGES:
+* `lib/app` moved to `lib/index`
+
+## 10.0.0
+* Style framework agnostic, bootstrap 3 dependency is optional. More in README.
+* Improved app wrapper
+
+### BREAKING CHANGES:
+* `react-bootstrap@0.33.1` must be installed separately
+* LajiForm component can't be accessed anymore through `LajiForm.app.refs.lajiform`. Use `LajiForm.lajiForm` instead.
+
+## 9.0.1
+* Add `allowOnlyYear` option for `DateTimeWidget` & `DateWidget`
+
+## 9.0.0
+### BREAKING CHANGES:
+* Revert "Buttons don't use `primary` bs role by default & not strong text"
+
+## 8.1.0
+* Replace boolean switches with radio buttons
+
+## 8.0.0
+* add `activeHeightOffset` to `SingleActiveArrayField` table
+
+### BREAKING CHANGES:
+* Buttons don't use `primary` bs role by default & not strong text
+
+## 7.2.0
+* Add `submitOnlySchemaValidations`
+
+## 7.1.0
+* Add `mediaMetadata` prop, which replaces `defaultImageMetadata` in settings (breaking change! Accidentally released as feature release)
+
+## 7.0.0
+* Globally interpreted `[test].injections` moved to `ui:injections`
+
+## 6.1.0
+* Add `tag` option to `PlainTextWidget`
+
+## 6.0.0
+* Exclude TypeScript declarations in `lib`
+* Export tests to npm package
+
+### BREAKING CHANGES:
+* Doesn't include typescript declarations anymore
+
+## 5.8.0
+* Include TypeScript declarations in `lib`
+
+## 5.7.3
+* `InjectField` `fields` must begin with "/" if they are to be handled as JSON pointers properly
+
+## 5.7.0
+* `FakePropertyField`: add `skipIfEmpty` to field options
+* `URLWidget`: add `template` option
+
+## 5.6.0
+* add `NumberWidget`
+
+## 5.5.0
+* `AutosuggestField`: added `suggestionValueParse` & `suggestionReceivers` support fallback field to use
+
+## 5.4.0
+* remove `getTaxonAutocompleteHTMLString` method from ApiClient
+
+## 5.3.0
+* add `getTaxonAutocompleteHTMLString` method for ApiClient
+
+## 5.2.0
+* Add named place removal
+
+## 5.1.2
+* Use upstream react-jsonschema-form instead of private fork
+
+## 5.1.0
+* Add `onValidationError` prop
+
+## 5.0.0
+### BREAKING CHANGES:
+* Remove `ConditionalAdditionalItemsArrayField` (can be implemented with `MultiArrayField`).
+* Remove `SingleActiveArrayField` `split` renderer (can be implemented with `MultiArrayField`).
+
+## 4.9.0
+* Add `ToggleAdditionalArrayFieldsField`
+
+## 4.8.0
+* Add `InjectTaxonCensusFilterField`
+* Add `MultiAnyToBooleanField`
+
+## 4.7.0
+* `ScopeField` doesn't remove props from `schema`, but hides them with `uiSchema`
+* `LocationChooserField` allows JSON pointer for `geometryField`
+
+## 4.6.0
+* Add `FilterArrayField`
+* uiSchema option `rules` allows `complement` option
+
+## 4.5.0
+* Add `FilterArrayField`
+* uiSchema components that use `rules` allow `complement` option, which complements the rule result
+
+## 4.4.0
+* Add `AudioArrayField`
+
+## 4.3.0
+* add `autoFocus` root uiSchema option
+
+## 4.2.0
+* Add SectionArrayField & MultiArrayField
+
+## 4.1.0
+* Add `FakePropertyField`
+* add `data` option to `MapField`
+* InjectField works with proper JSON pointers
+
+## 4.0.0
+### BREAKING CHANGES:
+* `src/validation.js` default export function doesn't take in `liveErrors` or `liveWarnings` parameters any more
+
+## 3.0.1
+* add deprecation warning about utils `getUpdateObjectFromJSONPath` and `updateSafelyWithJSONPath` (renamed to 'JSONPointer')
+
+## 3.0.0
+### BREAKING CHANGES:
+* `validate()` signature has changed
+* `onSubmit()` signature has changed, uses `formData` from `state`
+* `submit()` signature has changed
+
+## 2.2.0
+* Label can be overridden through `fields` prop
+
+## 2.1.2
+* Upgrade RJSF to 2.0.0-alpha (got rid of private fork finally!), fixes computing array defaults etc
+
+## 2.1.1
+* Schema of type `number` or `integer` aren't rendered as number inputs
+
+## 2.1.0
+* Add showID option for person AutosuggestWidget (for admin only)
+* Pass `formContext` from props to RJSF
+
+## 2.0.9
+* Add `sideEffects` options for ImageArrayField
+
+## 2.0.5
+* Pass `fields` and `widgets` from props to RJSF
+* don't `src` in npm package
+
+## 2.0.0
+### BREAKING CHANGES:
+* Remove `TemplateArrayField`
+
+## 1.2.6
+* `lib` keeps src folder structure & doesn't include styles
+
+## 1.2.5
+* include `src` in npm package
+
+## 1.2.4
+* Fix 'main' in package.json
+
+## 1.2.0
+* Background jobs can be retried
+* ImageArrayField sends DELETE request to API when image is removed
+
+## 1.1.0
+* Listen to keyboard events on HTML document level
+
+## 1.0.0
+* Started using semver

package/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Dan Abramov
+
+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.

package/README.md

@@ -0,0 +1,180 @@
+# README
+
+LajiForm is a dynamic form built on React. It can be used as a standalone library or as a React component. LajiForm is a wrapper for [react-jsonschema-form](https://github.com/mozilla-services/react-jsonschema-form).
+
+# Installing
+
+```
+npm install @luomus/laji-form --save
+```
+
+If you are going to use the bootstrap 3 theme, you need to install also `react-bootstrap`:
+
+```
+npm install react-bootstrap@0.33.1 --save
+```
+
+# Usage as a library
+
+LajiForm passes all its properties to react-jsonschema-form. Read the documentation for react-jsonschema-form.
+
+## Usage as a standalone library
+
+```
+import LajiForm from "laji-form";
+
+new LajiForm({
+  schema: schema,
+  uiSchema: uiSchema, formData: formData,
+  rootElem: document.getElementById("app")
+});
+```
+
+You can update the properties with ```setState(props)```. You need to pass only the properties that you are changing, since it just calls the React component's ```setState(props)```.
+
+You can unmount the component with ```unmount()```.
+
+## Usage as a React component
+
+```
+import React from "react";
+import { render } from "react-dom";
+import LajiForm from "laji-form/lib/components/LajiForm";
+
+render(<LajiForm
+    schema={...}
+    uiSchema={...}
+    formData={...} />,
+  document.getElementById("app"));
+```
+
+## API Client
+
+In addition to properties you would pass to &lt;Form /&gt;, you must pass an api client implementation, if you need to use fields that use lajitest.api.fi. The api client implementation must have ```fetch()``` -method, which **returns a Promise**.
+
+```fetch(path, query, options)``` parameters are as follows:
+
+* **path:** URL path for GET.
+* **query:** Object, where keys are param names and values are param values.
+* **options:** Object containing options for request.
+
+See the example implementation in [src/playground/ApiClientImplementation.js](https://bitbucket.org/luomus/laji-form.js/src/HEAD/playground/ApiClientImplementation.js).
+
+Pass the implementation to LajiForm like so:
+
+```
+<LajiForm apiClient={new ApiClientImplementation()} ... />
+```
+
+## Themes
+
+### Bootstrap 3
+LajiForm provides bootstrap 3 theme. To use it, you need to install `react-bootstrap@0.33.1` and provide the built-in bootstrap 3 theme it as a prop:
+
+```
+import bs3 from "laji-form/lib/themes/bs3";
+
+<LajiForm theme={bs3} ... />
+```
+
+### Bootstrap 5
+
+To use bootstrap 5 theme, you need to install following packages:
+```
+npm install --save react-bootstrap-5@npm:react-bootstrap@2.5.0
+mpn install --save @fortawesome/fontawesome-svg-core@6.2.0
+npm install --save @fortawesome/free-solid-svg-icons@6.2.0
+npm install --save @fortawesome/react-fontawesome@0.2.0
+```
+
+Then it can be used by providing the theme to the form:
+
+```
+import bs5 from "laji-form/lib/themes/bs5";
+
+<LajiForm theme={bs5} ... />
+```
+
+You can also use a custom theme and provide it the same way. There is a theme interface `themes/theme.ts` which the theme must implement.
+
+## Notifications
+
+LajiForm expects a notification implementation as a paratemer `notifier`. The `notifier` object must implement the interface below:
+
+```
+{
+	success: message => (),
+	warning: message => (),
+	info: message => (),
+	error: message => (),
+}
+```
+
+## Styles
+
+Styles can be found at  ```dist/styles.css```.
+
+# Development
+
+Run `npm ci` to install the dependencies and `npm start` to start the app.
+
+Before running, you'll need to configure your personal apitest.laji.fi access token. Get the key to your email:
+
+```
+curl -X POST --header "Content-Type: application/json" --header "Accept: application/json" -d "{\
+  \"email\": \"<YOUR EMAIL ADDRESS>\"\
+  }" "http://apitest.laji.fi/v0/api-token"
+```
+
+Copy settings template file:
+
+```
+cp properties.json.example properties.json
+```
+
+Then put the API access token you got in your email to ```properties.json```. Put also your user access token & user ID there. Google API key is needed only for using the reverse geo location for foreign locations.
+
+Try to keep the code style consistent - ```npm run lint``` should pass without errors.
+
+## Developing different forms
+
+Start the server and navigate to the local playground http://localhost:8083?id={form_id}
+
+### Playground query parameters
+
+Option        | Default | Description
+--------------|---------|-----------------------------------------------------------------------------------------------
+id            | -       | Form id to use. If empty, `playground/schemas.json` will be used for form schemas.
+local         | `false` | Use local schemas under `forms/` instead of fetching from apitest.laji.fi.
+localFormData | `false` | Use local formData under `forms/${id}.formData.json` instead of form's `prepopulatedDocument`.
+settings      | `true`  | Use local settings defined in `playground/schemas`.
+lang          | `fi`    | Language of the form. Doesn't affect local forms.
+readonly      | `false` | Sets the form readonly.
+
+### Examples
+
+http://localhost:8083?id=JX.519 Trip report form with empty `formData`.
+
+http://localhost:8083?id=MHL.1&localFormData=true Line transect form with local `formData`.
+
+## Tests
+
+You need to update the webdriver before testing: 
+
+```
+webdriver-manager update
+```
+
+The playground server must be running before running the tests.
+
+Run the tests with `npm test`.
+
+### Test parameters
+
+Parameters are given as envirnment variables, i.e. `TEST_BROWSER=chrome npm test`
+
+Option         | Default | Description
+---------------|---------|-----------------------------------------------------------------------------------------------
+TEST_BROWSER   | -       | `chrome` or `firefox`. Tests are run for both by default.
+HEADLESS       | `true`  | Run the tests in a visible browser window if `true`.
+THREADS        | 4       | How many browser instances to use for parallel testing.

package/cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}