@lifesg/web-frontend-engine 1.0.0-alpha.3 → 1.0.0-alpha.4

package/components/fields/textarea/textarea.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { IGenericFieldProps } from "../../frontend-engine/types";
 import { ITextareaSchema } from "./types";
-export declare const Textarea: (props: IGenericFieldProps<ITextareaSchema>) => JSX.Element;
+export declare const Textarea: (props: IGenericFieldProps<ITextareaSchema>) => import("react/jsx-runtime").JSX.Element;

package/components/fields/time-field/time-field.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="react" />
 import { IGenericFieldProps } from "../../frontend-engine";
 import { ITimeFieldSchema } from "./types";
-export declare const TimeField: (props: IGenericFieldProps<ITimeFieldSchema>) => JSX.Element;
+export declare const TimeField: (props: IGenericFieldProps<ITimeFieldSchema>) => import("react/jsx-runtime").JSX.Element;

package/components/fields/unit-number-field/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./unit-number-field";
+export * from "./types";

package/components/fields/unit-number-field/types.d.ts

@@ -0,0 +1,7 @@
+import { UnitNumberInputProps } from "@lifesg/react-design-system/unit-number";
+import { IFrontendEngineBaseFieldJsonSchema, TComponentOmitProps } from "../../frontend-engine";
+export interface IUnitNumberFieldValidationRule {
+    unitNumberFormat?: boolean | undefined;
+}
+export interface IUnitNumberFieldSchema<V = undefined> extends IFrontendEngineBaseFieldJsonSchema<"unit-number-field", V, IUnitNumberFieldValidationRule>, TComponentOmitProps<UnitNumberInputProps> {
+}

package/components/fields/unit-number-field/unit-number-field.d.ts

@@ -0,0 +1,3 @@
+import { IGenericFieldProps } from "../../frontend-engine";
+import { IUnitNumberFieldSchema } from "./types";
+export declare const UnitNumberField: (props: IGenericFieldProps<IUnitNumberFieldSchema>) => import("react/jsx-runtime").JSX.Element;

package/components/frontend-engine/types.d.ts

@@ -1,8 +1,9 @@
-import { ControllerFieldState, ControllerRenderProps, UseFormSetValue, ValidationMode } from "react-hook-form";
+import { ControllerFieldState, ControllerRenderProps, UseFormReset, UseFormSetValue, ValidationMode } from "react-hook-form";
+import { IFilterSchema } from "../custom/filter/filter/types";
 import { IAlertSchema, ITextSchema } from "../elements";
 import { ISectionSchema } from "../elements/section";
 import { IWrapperSchema } from "../elements/wrapper";
-import { ICheckboxGroupSchema, IChipsSchema, IContactFieldSchema, IDateFieldSchema, IEmailFieldSchema, IMultiSelectSchema, INumericFieldSchema, IRadioButtonGroupSchema, ISelectSchema, ISubmitButtonSchema, ITextFieldSchema, ITextareaSchema, ITimeFieldSchema } from "../fields";
+import { ICheckboxGroupSchema, IChipsSchema, IContactFieldSchema, IDateFieldSchema, IEmailFieldSchema, IMultiSelectSchema, INumericFieldSchema, IRadioButtonGroupSchema, IResetButtonSchema, ISelectSchema, ISubmitButtonSchema, ITextFieldSchema, ITextareaSchema, ITimeFieldSchema, IUnitNumberFieldSchema } from "../fields";
 import { IYupValidationRule, TRenderRules, TYupSchemaType } from "./yup";
 export type { IYupValidationRule } from "./yup";
 export interface IFrontendEngineProps<V = undefined> {
@@ -35,7 +36,7 @@ export interface IFrontendEngineData<V = undefined> {
     /** Validation strategy before a user submits the form (onSubmit event) */
     validationMode?: TValidationMode | undefined;
 }
-export type TFrontendEngineFieldSchema<V = undefined> = ITextareaSchema<V> | ITextFieldSchema<V> | IEmailFieldSchema<V> | INumericFieldSchema<V> | ISubmitButtonSchema | ISelectSchema<V> | IMultiSelectSchema<V> | ICheckboxGroupSchema<V> | IDateFieldSchema<V> | IWrapperSchema | IContactFieldSchema<V> | IRadioButtonGroupSchema<V> | ITimeFieldSchema<V> | IChipsSchema<V> | IAlertSchema | ITextSchema | ICustomComponentJsonSchema;
+export type TFrontendEngineFieldSchema<V = undefined> = ITextareaSchema<V> | ITextFieldSchema<V> | IEmailFieldSchema<V> | INumericFieldSchema<V> | ISubmitButtonSchema | ISelectSchema<V> | IMultiSelectSchema<V> | ICheckboxGroupSchema<V> | IDateFieldSchema<V> | IWrapperSchema | IContactFieldSchema<V> | IRadioButtonGroupSchema<V> | ITimeFieldSchema<V> | IChipsSchema<V> | IUnitNumberFieldSchema<V> | IAlertSchema | ITextSchema | IResetButtonSchema | IFilterSchema | ICustomComponentJsonSchema<V>;
 export type TFrontendEngineValues<T = any> = Record<keyof T, T[keyof T]>;
 export type TRevalidationMode = Exclude<keyof ValidationMode, "onTouched" | "all">;
 export type TValidationMode = keyof ValidationMode;
@@ -54,6 +55,8 @@ export interface IFrontendEngineRef extends HTMLFormElement {
     addCustomValidation: (type: TYupSchemaType | "mixed", name: string, fn: (value: unknown, arg: unknown) => boolean) => void;
     /** allows setting of custom errors thrown by endpoints */
     setErrors: (errors: TErrorPayload) => void;
+    /** resets the form to the default state */
+    reset: UseFormReset<TFrontendEngineValues>;
 }
 export interface IFrontendEngineBaseFieldJsonSchema<T, V = undefined, U = undefined> {
     /** defines what kind of component to be rendered */
@@ -72,11 +75,17 @@ export interface IFrontendEngineBaseFieldJsonSchema<T, V = undefined, U = undefi
 /**
  * to support custom components from other form / frontend engines
  */
-export interface ICustomComponentJsonSchema {
-    referenceKey: string;
-    [otherOptions: string]: unknown;
+export interface ICustomComponentJsonSchema<T> {
+    referenceKey: T;
     uiType?: never | undefined;
 }
+export interface ICustomFieldJsonSchema<T, V = undefined, U = undefined> extends ICustomComponentJsonSchema<T> {
+    validation?: (V | U | IYupValidationRule)[];
+    /** render conditions
+     * - need to fulfil at least 1 object in array (OR condition)
+     * - in order for an object to be valid, need to fulfil all conditions in that object (AND condition) */
+    showIf?: TRenderRules[] | undefined;
+}
 /**
  * JSON keys to omit from field schema when extending from other interfaces
  * - keys already defined in `IFrontendEngineBaseFieldJsonSchema` to prevent collision
@@ -107,7 +116,9 @@ export declare enum EFieldType {
     "CONTACT-FIELD" = "ContactField",
     RADIO = "RadioButtonGroup",
     "TIME-FIELD" = "TimeField",
-    CHIPS = "Chips"
+    CHIPS = "Chips",
+    RESET = "ResetButton",
+    "UNIT-NUMBER-FIELD" = "UnitNumberField"
 }
 /**
  * Non-field types
@@ -140,6 +151,17 @@ export declare enum EElementType {
     H6 = "Wrapper",
     P = "Wrapper"
 }
+/**
+ * Custom element types
+ * - components that do not have uiType and have specific schema to render
+ */
+export declare enum ECustomElementType {
+    FILTER = "Filter",
+    "FILTER-ITEM" = "FilterItem"
+}
+export declare enum ECustomFieldType {
+    "FILTER-CHECKBOX" = "FilterCheckbox"
+}
 export interface IGenericFieldProps<T = TFrontendEngineFieldSchema> extends Partial<ControllerFieldState>, Partial<ControllerRenderProps> {
     id: string;
     schema: T;

package/components/frontend-engine/yup/context-provider.d.ts

@@ -8,5 +8,5 @@ interface IProps {
     children: ReactElement;
 }
 export declare const YupContext: React.Context<IYupContext>;
-export declare const YupProvider: ({ children }: IProps) => JSX.Element;
+export declare const YupProvider: ({ children }: IProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/components/shared/chip/chip.d.ts

@@ -2,5 +2,5 @@ import React from "react";
 import { IChipButtonProps } from "./types";
 interface IProps extends React.ButtonHTMLAttributes<HTMLButtonElement>, IChipButtonProps {
 }
-export declare const Chip: ({ children, ...otherProps }: IProps) => JSX.Element;
+export declare const Chip: ({ children, ...otherProps }: IProps) => import("react/jsx-runtime").JSX.Element;
 export {};

package/components/shared/error-messages.d.ts

@@ -18,6 +18,9 @@ export declare const ERROR_MESSAGES: {
         MAX_DATE: (date: string) => string;
         INVALID: string;
     };
+    UNIT_NUMBER: {
+        INVALID: string;
+    };
     GENERIC: {
         INVALID: string;
         UNSUPPORTED: string;

package/components/shared/sanitize/sanitize.d.ts

@@ -3,5 +3,5 @@ interface IProps {
     id?: string;
     children: string | React.ReactNode;
 }
-export declare const Sanitize: (props: IProps) => JSX.Element;
+export declare const Sanitize: (props: IProps) => import("react/jsx-runtime").JSX.Element;
 export {};