@kbss-cvut/s-forms 0.7.1-alpha-82d34b0.0 → 0.7.1-alpha-965d1f4.0

package/README.md

@@ -1,7 +1,7 @@
 # SForms
 [![Netlify Status](https://api.netlify.com/api/v1/badges/004d6408-4ff5-4719-905e-5d83d5feef01/deploy-status)](https://app.netlify.com/sites/s-forms-kbss/deploys)
 
-**S**emantic **form** generator and processor for ontology-based smart forms. Besides this core library, there exists also [library of advanced components](https://github.com/kbss-cvut/s-forms-components).
+**S**emantic **form** generator and processor for ontology-based smart forms. Beside this core library, there exists also [library of advanced components](https://github.com/kbss-cvut/s-forms-components).
 
 ## Live Demo
 
@@ -9,15 +9,8 @@ Checkout [live demo using storybook](https://s-forms-kbss.netlify.app).
 
 ## Supported features
 
-- Validation
-- Question comments
-- Navigation to the selected question
-- Emphasizing selected questions
-
-### Components
-
 - Input/Textarea
-- Tree Typeahead
+- Typeahead
 - Datetime picker
 - Select
 - Checkbox
@@ -25,31 +18,19 @@ Checkout [live demo using storybook](https://s-forms-kbss.netlify.app).
 
 ## Representation in JSON-LD
 
-Semantic form is a structure that holds a form (set of questions) and its data (set of answers).
-A conceptual model of Semantic forms is [questions/answers model](https://github.com/kbss-cvut/s-forms-model).
+Semantic form is structure that holds a form (set of questions) as well as its data (set of answers).
+A conceptual model of Semantic forms is [questions/answers model](https://kbss.felk.cvut.cz/gitblit/summary/s-forms-model.git).
 The conceptual model is described in RDF language. This library processes and generates Semantic forms using JSON-LD
-format which is JSON-compatible serialization of the RDF language.
+format which is JSON compatible serialization of the RDF language.
 
 ## Development
 
 Building SForms library can be done using `npm run build:lib`.
 
-### StorybookJS
-
-#### Debugging forms and components with StorybookJS
-
-Storybook is an open-source tool for building UI components and pages in isolation.  Rendering of a form or a specific component can be tested through a story provided in `./src/stories/`. The application can be started by executing npm script through `npm run dev` and then accessing `localhost:6006` from a browser. It renders the forms provided by the file `./src/stories/assets/`. See `./src/stories/SForms/SForms.stories.tsx` for more details.
+### Debugging a form & components with StorybookJS
 
-#### Testing forms with the toolbar
-With the Storybook [toolbar](https://storybook.js.org/docs/essentials/toolbars-and-globals), it is possible to test a set of predefined global variables. The toolbar supports the following features:
-- Icon behavior: Set the behavior for the icons
-- Locale: Set the internationalization locale
-- Debug mode: Show irrelevant questions
-- Navbar position: Set the navigation bar to horizontal/vertical position
-- Timeout: Set time-out for possible values (in ms)
-- Print form specification: Print the form specification in the console
-- Validate form: Triggers the form validation
+Storybook is an open source tool for building UI components and pages in isolation. Rendering of a form or a specific component can be tested through a story provided in `./src/stories/`. The application can be started by executing npm script through `npm run dev` and then accessing `localhost:6006` from a browser. It renders the forms provided by the file `./src/stories/assets/`. See `./src/stories/SForms/SForms.stories.tsx` for more details.
 
-### NPM release workflow
+### NPM release worklow
 
 NPM packages are created automatically for each commit to this repository, see [npm release workflow guide](./docs/npm-release-workflow.md).

package/dist/components/Answer.d.ts

@@ -1,5 +1,5 @@
 export default Answer;
-declare function Answer(props: any): import("react/jsx-runtime").JSX.Element;
+declare function Answer(props: any): import("react/jsx-runtime").JSX.Element | null;
 declare namespace Answer {
     namespace propTypes {
         let answer: PropTypes.Validator<object>;

package/dist/components/DefaultInput.d.ts

@@ -17,6 +17,7 @@ declare class DefaultInput extends React.Component<any, any, any> {
     _renderSelect(): import("react/jsx-runtime").JSX.Element;
     _renderLabel(): import("react/jsx-runtime").JSX.Element | null;
     _renderTextArea(): import("react/jsx-runtime").JSX.Element;
+    _renderHelp(): import("react/jsx-runtime").JSX.Element | null;
     _renderInput(): import("react/jsx-runtime").JSX.Element;
 }
 declare namespace DefaultInput {
@@ -26,8 +27,7 @@ declare namespace DefaultInput {
         let value: PropTypes.Requireable<any>;
         let onChange: PropTypes.Requireable<(...args: any[]) => any>;
         let help: PropTypes.Requireable<string>;
-        let validation: PropTypes.Requireable<object>;
-        let placeholder: PropTypes.Requireable<string>;
+        let validation: PropTypes.Requireable<string>;
     }
     namespace defaultProps {
         let type_1: string;

package/dist/components/FormManager.d.ts

@@ -1,2 +1,23 @@
 export default FormManager;
-declare function FormManager(props: any): import("react/jsx-runtime").JSX.Element;
+declare class FormManager extends React.Component<any, any, any> {
+    constructor(props: any);
+    constructor(props: any, context: any);
+    getFormData: () => {
+        subQuestions: never[];
+    };
+    getFormQuestionsData: () => any;
+    handleStepChange: (question: any, index: any, change: any) => void;
+    renderWizardlessForm: () => import("react/jsx-runtime").JSX.Element;
+    _mapQuestion(question: any, index: any): React.DetailedReactHTMLElement<{
+        key: any;
+        question: any;
+        onChange: (index: any, change: any) => void;
+        index: any;
+    }, HTMLElement>;
+    render(): import("react/jsx-runtime").JSX.Element;
+}
+declare namespace FormManager {
+    export { FormQuestionsContext as contextType };
+}
+import React from "react";
+import { FormQuestionsContext } from "../contexts/FormQuestionsContext";

package/dist/components/IconOverlay.d.ts

@@ -6,15 +6,12 @@ declare namespace IconOverlay {
         let id: PropTypes.Validator<string>;
         let overlayPlacement: PropTypes.Requireable<string>;
         let absolutePosition: PropTypes.Requireable<boolean>;
-        let show: PropTypes.Requireable<boolean>;
     }
     namespace defaultProps {
         export let iconClassContainer: string;
         export let iconClass: string;
         let absolutePosition_1: boolean;
         export { absolutePosition_1 as absolutePosition };
-        let show_1: boolean;
-        export { show_1 as show };
     }
 }
 import PropTypes from "prop-types";

package/dist/components/Question.d.ts

@@ -2,10 +2,10 @@ declare class Question extends React.Component<any, any, any> {
     static _getAnswerClass(question: any, isTextarea: any): string;
     static _getQuestionCategoryClass(question: any): string;
     static getEmphasizedClass(question: any): "" | "bg-warning";
-    static getEmphasizedOnRelevantClass(question: any): "" | "emphasise-on-relevant";
+    static getEmphasizedOnRelevantClass(question: any): "emphasise-on-relevant" | "";
     constructor(props: any);
     state: {
-        validator: {};
+        validator: null;
         expanded: boolean;
         showIcon: boolean;
     };
@@ -27,13 +27,11 @@ declare class Question extends React.Component<any, any, any> {
         question: any;
         onChange: (subQuestionIndex: any, change: any) => void;
         index: number;
-        intl: any;
     }, React.Component<{
         key: string;
         question: any;
         onChange: (subQuestionIndex: any, change: any) => void;
         index: number;
-        intl: any;
     }, any, any>> | null)[])[];
     renderQuestionIcons(): import("react/jsx-runtime").JSX.Element;
     renderAnswerableSection(): import("react/jsx-runtime").JSX.Element;
@@ -57,13 +55,11 @@ declare class Question extends React.Component<any, any, any> {
         question: any;
         onChange: (subQuestionIndex: any, change: any) => void;
         index: number;
-        intl: any;
     }, React.Component<{
         key: string;
         question: any;
         onChange: (subQuestionIndex: any, change: any) => void;
         index: number;
-        intl: any;
     }, any, any>> | null)[];
     _getSubQuestions(): any;
     _getFirstAnswerValue(): any;

package/dist/components/answer/CheckboxAnswer.d.ts

@@ -4,9 +4,10 @@ declare function CheckboxAnswer(props: any): React.DetailedReactHTMLElement<{
     label: any;
     title: any;
     checked: boolean;
-    validation: any;
     onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
     disabled: any;
+    validation: string;
+    help: any;
 }, HTMLElement>;
 declare namespace CheckboxAnswer {
     namespace propTypes {
@@ -16,7 +17,6 @@ declare namespace CheckboxAnswer {
         let value: PropTypes.Requireable<NonNullable<string | boolean | null | undefined>>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
         let mouseHover: PropTypes.Requireable<boolean>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 import React from "react";

package/dist/components/answer/DateTimeAnswer.d.ts

@@ -7,7 +7,6 @@ declare namespace DateTimeAnswer {
         let title: PropTypes.Requireable<string>;
         let value: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 import PropTypes from "prop-types";

package/dist/components/answer/InputAnswer.d.ts

@@ -1,16 +1,15 @@
 export default InputAnswer;
 declare function InputAnswer(props: any): React.DetailedReactHTMLElement<{
-    validation: any;
     label: any;
     title: any;
     value: any;
-    placeholder: any;
-    onKeyPress: (e: React.KeyboardEvent<HTMLInputElement>) => void;
     onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
     onFocus: (e: React.FocusEvent<HTMLInputElement, Element>) => void;
     type: string;
     rows: number;
     disabled: any;
+    validation: string;
+    help: any;
 }, HTMLElement>;
 declare namespace InputAnswer {
     namespace propTypes {
@@ -20,7 +19,6 @@ declare namespace InputAnswer {
         let title: PropTypes.Requireable<string>;
         let value: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 import React from "react";

package/dist/components/answer/MaskedInputAnswer.d.ts

@@ -8,7 +8,6 @@ declare namespace MaskedInputAnswer {
         let title: PropTypes.Requireable<string>;
         let value: PropTypes.Requireable<NonNullable<string | number | null | undefined>>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 import PropTypes from "prop-types";

package/dist/components/answer/SelectAnswer.d.ts

@@ -7,7 +7,6 @@ declare class SelectAnswer extends React.Component<any, any, any> {
         label: any;
         value: any;
         title: any;
-        validation: any;
         onChange: (e: React.ChangeEvent<HTMLInputElement>) => void;
         disabled: any;
     }, HTMLElement>;
@@ -20,7 +19,6 @@ declare namespace SelectAnswer {
         let title: PropTypes.Requireable<string>;
         let value: PropTypes.Requireable<string>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 export default SelectAnswer;

package/dist/components/answer/TypeaheadAnswer.d.ts

@@ -8,7 +8,6 @@ declare namespace TypeaheadAnswer {
         let title: PropTypes.Requireable<string>;
         let value: PropTypes.Requireable<string>;
         let onChange: PropTypes.Validator<(...args: any[]) => any>;
-        let validation: PropTypes.Requireable<object>;
     }
 }
 import PropTypes from "prop-types";

package/dist/components/wizard/WizardStep.d.ts

@@ -1,7 +1,13 @@
-export default WizardStep;
-declare function WizardStep(props: any): import("react/jsx-runtime").JSX.Element;
+declare class WizardStep extends React.Component<any, any, any> {
+    constructor(props: any);
+    onNextStep: () => void;
+    onPreviousStep: () => void;
+    _renderWizardStepButtons: () => import("react/jsx-runtime").JSX.Element;
+    onChange: (index: any, change: any) => void;
+    render(): import("react/jsx-runtime").JSX.Element;
+}
 declare namespace WizardStep {
-    namespace propTypes {
+    export namespace propTypes {
         let options: PropTypes.Validator<object>;
         let question: PropTypes.Validator<object>;
         let index: PropTypes.Validator<number>;
@@ -11,5 +17,9 @@ declare namespace WizardStep {
         let isFirstStep: PropTypes.Requireable<boolean>;
         let isLastStep: PropTypes.Requireable<boolean>;
     }
+    export { FormQuestionsContext as contextType };
 }
+export default WizardStep;
+import React from "react";
 import PropTypes from "prop-types";
+import { FormQuestionsContext } from "../../contexts/FormQuestionsContext";

package/dist/constants/Constants.d.ts

@@ -57,13 +57,9 @@ export default class Constants {
         NON_NEGATIVE_INTEGER: string;
         NON_POSITIVE_INTEGER: string;
         POSITIVE_INTEGER: string;
-        FLOAT: string;
-        POSITIVE_FLOAT: string;
-        NEGATIVE_FLOAT: string;
         BOOLEAN: string;
     };
     static STEP: string;
-    static PATTERN: string;
     static ACCEPTS_ANSWER_VALUE: string;
     static ACCEPTS: string;
     static HAS_DATATYPE: string;
@@ -79,9 +75,10 @@ export default class Constants {
     static HAS_VALIDATION_MESSAGE: string;
     static NEGATIVE_CONDITION: string;
     static REQUIRES_ANSWER: string;
-    static USED_ONLY_FOR_COMPLETENESS: string;
     static REQUIRES_ANSWER_DESCRIPTION_IF: string;
     static REQUIRES_ANSWER_IF: string;
+    static REQUIRES_ANSWER_VALUE: string;
+    static REQUIRES_DESCRIPTION: string;
     static HAS_PRECEDING_QUESTION: string;
     static HAS_PRECEDING_VALUE: string;
     static HAS_MEDIA_CONTENT: string;
@@ -96,18 +93,11 @@ export default class Constants {
     static HAS_COMMENT_VALUE: string;
     static HAS_AUTHOR: string;
     static HAS_TIMESTAMP: string;
-    static TIME_FORMAT: string;
-    static DATE_FORMAT: string;
-    static DATETIME_FORMAT: string;
     static NOT_ANSWERED_QUESTION: string;
     static ANSWERED_QUESTION: string;
-    static HAS_VALIDATION_SEVERITY: string;
     static RDFS_LABEL: any;
     static RDFS_COMMENT: any;
     static DEFAULT_HAS_CHILD: any;
-    static BROADER: string;
-    static HAS_NON_SELECTABLE_VALUE: string;
-    static PROVIDES_DEREFERENCEABLE_ANSWER_VALUES: string;
     static ICONS: {
         QUESTION_COMMENTS: string;
         QUESTION_HELP: string;
@@ -134,22 +124,4 @@ export default class Constants {
             label: string;
         };
     };
-    static VALIDATION: {
-        SEVERITY: {
-            ERROR: string;
-            WARNING: string;
-        };
-        DEFAULT_MESSAGE: {
-            REQUIRED: string;
-            REQUIRED_ONLY_FOR_COMPLETENESS: string;
-            INVALID: string;
-            CHECK: string;
-            LOWER_OR_EQUAL: string;
-            GREATER_OR_EQUAL: string;
-        };
-        CLASSNAME: {
-            ERROR: string;
-            WARNING: string;
-        };
-    };
 }

package/dist/model/FormGenerator.d.ts

@@ -8,13 +8,13 @@ export default class FormGenerator {
      */
     static constructDefaultForm(intl: any): any[];
     /**
-     * Asynchronously generates form definition from the specified data-enriched template.
+     * Generates form definition from the specified data-enriched template.
      *
-     * @param {Object} structure The form structure in JSON-LD
-     * @param {string} intl Preferred language of questions
+     * @param structure The form structure in JSON-LD
+     * @param intl Preferred language of questions
      *
-     * @return {Promise<Object>} Promise with generated form definition and form data
+     * @return Promise with generated form definition and form data
      */
-    static constructForm(structure: Object, intl: string): Promise<Object>;
+    static constructForm(structure: any, intl: any): Promise<any>;
     static _constructFormQuestions(structure: any, intl: any): any[];
 }

package/dist/model/ValidatorFactory.d.ts

@@ -1 +1,5 @@
-export function createValidator(question: any, intl: any): () => {} | undefined;
+export default class ValidatorFactory {
+    static createValidator(question: any, intl: any): (answer: any) => {};
+    static _generateRequiresAnswerValidator(question: any, intl: any): (answer: any) => {};
+    static _generateRequiresAnswerCheckBoxValidator(question: any, intl: any): (answer: any) => {};
+}