@formio/js 5.0.0-rc.44 → 5.0.0-rc.46

package/lib/mjs/utils/utils.d.ts

@@ -0,0 +1,377 @@
+/**
+ * Evaluate a method.
+ *
+ * @param func
+ * @param args
+ * @return {*}
+ */
+export function evaluate(func: any, args: any, ret: any, tokenize: any): any;
+export function getRandomComponentId(): string;
+/**
+ * Get a property value of an element.
+ *
+ * @param style
+ * @param prop
+ * @return {number}
+ */
+export function getPropertyValue(style: any, prop: any): number;
+/**
+ * Get an elements bounding rectagle.
+ *
+ * @param element
+ * @return {{x: string, y: string, width: string, height: string}}
+ */
+export function getElementRect(element: any): {
+    x: string;
+    y: string;
+    width: string;
+    height: string;
+};
+/**
+ * Determines the boolean value of a setting.
+ *
+ * @param value
+ * @return {boolean}
+ */
+export function boolValue(value: any): boolean;
+/**
+ * Check to see if an ID is a mongoID.
+ * @param text
+ * @return {Array|{index: number, input: string}|Boolean|*}
+ */
+export function isMongoId(text: any): any[] | {
+    index: number;
+    input: string;
+} | boolean | any;
+/**
+ * Checks the calculated value for a provided component and data.
+ *
+ * @param {Object} component
+ *   The component to check for the calculated value.
+ * @param {Object} submission
+ *   A submission object.
+ * @param data
+ *   The full submission data.
+ */
+export function checkCalculated(component: Object, submission: Object, rowData: any): void;
+/**
+ * Check if a simple conditional evaluates to true.
+ *
+ * @param condition
+ * @param condition
+ * @param row
+ * @param data
+ * @param instance
+ * @returns {boolean}
+ */
+export function checkSimpleConditional(component: any, condition: any, row: any, data: any, instance: any): boolean;
+export function getComponentActualValue(compPath: any, data: any, row: any): any;
+/**
+ * Check custom javascript conditional.
+ *
+ * @param component
+ * @param custom
+ * @param row
+ * @param data
+ * @returns {*}
+ */
+export function checkCustomConditional(component: any, custom: any, row: any, data: any, form: any, variable: any, onError: any, instance: any): any;
+export function checkJsonConditional(component: any, json: any, row: any, data: any, form: any, onError: any): any;
+/**
+ * Checks the conditions for a provided component and data.
+ *
+ * @param component
+ *   The component to check for the condition.
+ * @param row
+ *   The data within a row
+ * @param data
+ *   The full submission data.
+ *
+ * @returns {boolean}
+ */
+export function checkCondition(component: any, row: any, data: any, form: any, instance: any): boolean;
+/**
+ * Test a trigger on a component.
+ *
+ * @param component
+ * @param action
+ * @param data
+ * @param row
+ * @returns {mixed}
+ */
+export function checkTrigger(component: any, trigger: any, row: any, data: any, form: any, instance: any): mixed;
+export function setActionProperty(component: any, action: any, result: any, row: any, data: any, instance: any): any;
+/**
+ * Unescape HTML characters like &lt, &gt, &amp and etc.
+ * @param str
+ * @returns {string}
+ */
+export function unescapeHTML(str: any): string;
+/**
+ * Make HTML element from string
+ * @param str
+ * @param selector
+ * @returns {HTMLElement}
+ */
+export function convertStringToHTMLElement(str: any, selector: any): HTMLElement;
+/**
+ * Make a filename guaranteed to be unique.
+ * @param name
+ * @param template
+ * @param evalContext
+ * @returns {string}
+ */
+export function uniqueName(name: any, template: any, evalContext: any): string;
+export function guid(): string;
+/**
+ * Return a translated date setting.
+ *
+ * @param date
+ * @return {(null|Date)}
+ */
+export function getDateSetting(date: any): (null | Date);
+export function isValidDate(date: any): any;
+/**
+ * Get the current timezone string.
+ *
+ * @return {string}
+ */
+export function currentTimezone(): string;
+/**
+ * Get an offset date provided a date object and timezone object.
+ *
+ * @param date
+ * @param timezone
+ * @return {Date}
+ */
+export function offsetDate(date: any, timezone: any): Date;
+/**
+ * Returns if the zones are loaded.
+ *
+ * @return {boolean}
+ */
+export function zonesLoaded(): boolean;
+/**
+ * Returns if we should load the zones.
+ *
+ * @param timezone
+ * @return {boolean}
+ */
+export function shouldLoadZones(timezone: any): boolean;
+/**
+ * Externally load the timezone data.
+ *
+ * @return {Promise<any> | *}
+ */
+export function loadZones(url: any, timezone: any): Promise<any> | any;
+/**
+ * Get the moment date object for translating dates with timezones.
+ *
+ * @param value
+ * @param format
+ * @param timezone
+ * @return {*}
+ */
+export function momentDate(value: any, format: any, timezone: any): any;
+/**
+ * Format a date provided a value, format, and timezone object.
+ *
+ * @param value
+ * @param format
+ * @param timezone
+ * @return {string}
+ */
+export function formatDate(timezonesUrl: any, value: any, format: any, timezone: any, flatPickrInputFormat: any): string;
+/**
+ * Pass a format function to format within a timezone.
+ *
+ * @param formatFn
+ * @param date
+ * @param format
+ * @param timezone
+ * @return {string}
+ */
+export function formatOffset(timezonesUrl: any, formatFn: any, date: any, format: any, timezone: any): string;
+export function getLocaleDateFormatInfo(locale: any): {
+    dayFirst: boolean;
+};
+/**
+ * Convert the format from the angular-datepicker module to flatpickr format.
+ * @param format
+ * @return {string}
+ */
+export function convertFormatToFlatpickr(format: any): string;
+/**
+ * Convert the format from the angular-datepicker module to moment format.
+ * @param format
+ * @return {string}
+ */
+export function convertFormatToMoment(format: any): string;
+export function convertFormatToMask(format: any): any;
+/**
+ * Returns an input mask that is compatible with the input mask library.
+ * @param {string} mask - The Form.io input mask.
+ * @param {string} placeholderChar - Char which is used as a placeholder.
+ * @returns {Array} - The input mask for the mask library.
+ */
+export function getInputMask(mask: string, placeholderChar: string): any[];
+export function unmaskValue(value: any, mask: any, placeholderChar: any): any;
+export function matchInputMask(value: any, inputMask: any): boolean;
+export function getNumberSeparators(lang?: string): {
+    delimiter: string;
+    decimalSeparator: string;
+};
+export function getNumberDecimalLimit(component: any, defaultLimit: any): any;
+export function getCurrencyAffixes({ currency, decimalLimit, decimalSeparator, lang, }: {
+    currency: any;
+    decimalLimit: any;
+    decimalSeparator: any;
+    lang: any;
+}): {
+    prefix: string;
+    suffix: string;
+};
+/**
+ * Fetch the field data provided a component.
+ *
+ * @param data
+ * @param component
+ * @return {*}
+ */
+export function fieldData(data: any, component: any): any;
+/**
+ * Delays function execution with possibility to execute function synchronously or cancel it.
+ *
+ * @param fn Function to delay
+ * @param delay Delay time
+ * @return {*}
+ */
+export function delay(fn: any, delay?: number, ...args: any[]): any;
+/**
+ * Iterate the given key to make it unique.
+ *
+ * @param {String} key
+ *   Modify the component key to be unique.
+ *
+ * @returns {String}
+ *   The new component key.
+ */
+export function iterateKey(key: string): string;
+/**
+ * Determines a unique key within a map provided the base key.
+ *
+ * @param map
+ * @param base
+ * @return {*}
+ */
+export function uniqueKey(map: any, base: any): any;
+/**
+ * Determines the major version number of bootstrap.
+ *
+ * @return {number}
+ */
+export function bootstrapVersion(options: any): number;
+/**
+ * Retrun provided argument.
+ * If argument is a function, returns the result of a function call.
+ * @param {*} e;
+ *
+ * @return {*}
+ */
+export function unfold(e: any): any;
+export function withSwitch(a: any, b: any): (() => any)[];
+export function observeOverload(callback: any, options?: {}): () => any;
+export function getContextComponents(context: any, excludeNested: any, excludedTypes?: any[]): any[];
+export function getContextButtons(context: any): any[];
+/**
+ * Translates text values in html template.
+ *
+ * @param {String} template
+ * @param {Function} translate
+ *
+ * @returns {String}
+ *   Html template with translated values.
+ */
+export function translateHTMLTemplate(template: string, translate: Function): string;
+/**
+ * Sanitize an html string.
+ *
+ * @param string
+ * @returns {*}
+ */
+export function sanitize(string: any, options: any): any;
+/**
+ * Fast cloneDeep for JSON objects only.
+ */
+export function fastCloneDeep(obj: any): any;
+export function isInputComponent(componentJson: any): any;
+export function getArrayFromComponentPath(pathStr: any): any;
+export function isChildOf(child: any, parent: any): boolean;
+export function getStringFromComponentPath(path: any): any;
+export function round(number: any, precision: any): any;
+/**
+ * Check for Internet Explorer browser version
+ *
+ * @return {(number|null)}
+ */
+export function getIEBrowserVersion(): (number | null);
+/**
+ * Get browser name and version (modified from 'jquery-browser-plugin')
+ *
+ * @return {Object} -- {{browser name, version, isWebkit?}}
+ * Possible browser names: chrome, safari, ie, edge, opera, mozilla, yabrowser
+ */
+export function getBrowserInfo(): Object;
+export function getComponentPathWithoutIndicies(path?: string): string;
+/**
+ * Returns a path to the component which based on its schema
+ * @param {*} component is a component's schema containing link to its parent's schema in the 'parent' property
+ */
+export function getComponentPath(component: any, path?: string): string;
+/**
+ * Returns a parent component of the passed component instance skipping all the Layout components
+ * @param {*} componentInstance
+ * @return {(Component|undefined)}
+ */
+export function getDataParentComponent(componentInstance: any): (Component | undefined);
+/**
+ * Returns whether the value is a promise
+ * @param value
+ * @return {boolean}
+ */
+export function isPromise(value: any): boolean;
+/**
+ * Determines if the component has a scoping parent in tree (a component which scopes its children and manages its
+ * changes by itself, e.g. EditGrid)
+ * @param componentInstance
+ * @param firstPass
+ * @returns {boolean|boolean|*}
+ */
+export function isInsideScopingComponent(componentInstance: any, firstPass?: boolean): boolean | boolean | any;
+export function getFocusableElements(element: any): any;
+export function getComponentSavedTypes(fullSchema: any): string[] | null;
+export function getItemTemplateKeys(template: any): any[];
+export function isSelectResourceWithObjectValue(comp?: {}): any;
+export * from "./formUtils";
+/**
+ * Map values through unfold and return first non-nil value.
+ * @param {Array<T>} collection;
+ *
+ * @return {T}
+ */
+export const firstNonNil: any;
+export namespace componentValueTypes {
+    let number: string;
+    let string: string;
+    let boolean: string;
+    let array: string;
+    let object: string;
+    let date: string;
+    let any: string;
+}
+export function interpolateErrors(component: any, errors: FieldError[], interpolateFn: any): [];
+import jsonLogic from 'json-logic-js';
+import ConditionOperators from './conditionOperators';
+import { Evaluator } from './Evaluator';
+export const interpolate: typeof Evaluator.interpolate;
+export { jsonLogic, ConditionOperators, Evaluator, _ };

package/lib/mjs/utils/utils.js

@@ -7,7 +7,7 @@ import jtz from 'jstimezonedetect';
 import { lodashOperators } from './jsonlogic/operators';
 import dompurify from 'dompurify';
 import { getValue } from './formUtils';
-import Evaluator from './Evaluator';
+import { Evaluator } from './Evaluator';
 import ConditionOperators from './conditionOperators';
 const interpolate = Evaluator.interpolate;
 const { fetch } = fetchPonyfill({

package/lib/mjs/widgets/CalendarWidget.d.ts

@@ -0,0 +1,97 @@
+export default class CalendarWidget extends InputWidget {
+    static get defaultSettings(): {
+        type: string;
+        altInput: boolean;
+        allowInput: boolean;
+        clickOpens: boolean;
+        enableDate: boolean;
+        enableTime: boolean;
+        mode: string;
+        noCalendar: boolean;
+        format: string;
+        dateFormat: string;
+        useLocaleSettings: boolean;
+        language: string;
+        hourIncrement: number;
+        minuteIncrement: number;
+        time_24hr: boolean;
+        saveAs: string;
+        displayInTimezone: string;
+        timezone: string;
+        disable: never[];
+        minDate: string;
+        maxDate: string;
+    };
+    zoneLoading: boolean;
+    timezonesUrl: string;
+    /**
+     * Load the timezones.
+     *
+     * @return {boolean} TRUE if the zones are loading, FALSE otherwise.
+     */
+    loadZones(): boolean;
+    attach(input: any): Promise<any>;
+    defaultFormat: {
+        date: string;
+        time: string;
+    } | undefined;
+    closedOn: number | undefined;
+    valueFormat: any;
+    valueMomentFormat: string | undefined;
+    get disableWeekends(): (date: any) => boolean;
+    get disableWeekdays(): (date: any) => boolean;
+    get disableFunction(): (date: any) => any;
+    get timezone(): any;
+    get defaultSettings(): {
+        type: string;
+        altInput: boolean;
+        allowInput: boolean;
+        clickOpens: boolean;
+        enableDate: boolean;
+        enableTime: boolean;
+        mode: string;
+        noCalendar: boolean;
+        format: string;
+        dateFormat: string;
+        useLocaleSettings: boolean;
+        language: string;
+        hourIncrement: number;
+        minuteIncrement: number;
+        time_24hr: boolean;
+        saveAs: string;
+        displayInTimezone: string;
+        timezone: string;
+        disable: never[];
+        minDate: string;
+        maxDate: string;
+    };
+    addSuffix(suffix: any): any;
+    get disabledDates(): any;
+    get localeFormat(): string;
+    get dateTimeFormat(): string;
+    get dateFormat(): any;
+    /**
+     * Return the date value.
+     *
+     * @param date
+     * @param format
+     * @return {string}
+     */
+    getDateValue(date: any, format: any, useTimezone: any): string;
+    isValueISO8601(value: any): any;
+    /**
+     * Set the selected date value.
+     *
+     * @param value
+     */
+    setValue(value: any): void;
+    getValueAsString(value: any, format: any): string;
+    setErrorClasses(hasErrors: any): void;
+    isCalendarElement(element: any): any;
+    initFlatpickr(Flatpickr: any): void;
+    calendar: any;
+    initShortcutButtonsPlugin(ShortcutButtonsPlugin: any): void;
+    get componentValue(): any;
+    getFlatpickrFormatDate(Flatpickr: any): (date: any, format: any) => any;
+}
+import InputWidget from './InputWidget';

package/lib/mjs/widgets/InputWidget.d.ts

@@ -0,0 +1,24 @@
+export default class InputWidget extends Element {
+    static get defaultSettings(): {
+        type: string;
+    };
+    constructor(settings: any, component: any, instance: any, index: any);
+    valueIndex: any;
+    componentInstance: any;
+    namespace: string;
+    component: any;
+    settings: any;
+    attach(input: any): Promise<void>;
+    _input: any;
+    get defaultSettings(): {};
+    set disabled(disabled: any);
+    get input(): any;
+    getValue(): any;
+    getValueAsString(value: any): any;
+    get validationValue(): any;
+    addPrefix(): null;
+    addSuffix(): null;
+    setValue(value: any): void;
+    evalContext(additional: any): any;
+}
+import Element from '../Element';

package/lib/mjs/widgets/index.d.ts

@@ -0,0 +1,7 @@
+declare namespace _default {
+    export { InputWidget as input };
+    export { CalendarWidget as calendar };
+}
+export default _default;
+import InputWidget from './InputWidget';
+import CalendarWidget from './CalendarWidget';

package/package.json

@@ -1,16 +1,14 @@
 {
   "name": "@formio/js",
-  "version": "5.0.0-rc.44",
+  "version": "5.0.0-rc.46",
   "description": "JavaScript powered Forms with JSON Form Builder",
   "main": "lib/cjs/index.js",
   "exports": {
     ".": {
-      "types": "index.d.ts",
       "import": "./lib/cjs/index.js",
       "require": "./lib/cjs/index.js"
     },
     "./sdk": {
-      "types": "./types/Formio.d.ts",
       "import": "./lib/cjs/Formio.js",
       "require": "./lib/cjs/Formio.js"
     },
@@ -23,7 +21,6 @@
       "require": "./lib/cjs/formio.form.js"
     },
     "./embed": {
-      "types": "./types/Embed.d.ts",
       "import": "./lib/cjs/Embed.js",
       "require": "./lib/cjs/Embed.js"
     },
@@ -31,12 +28,7 @@
   },
   "files": [
     "dist",
-    "lib",
-    "types",
-    "index.d.ts",
-    "embed.d.ts",
-    "sdk.d.ts",
-    "utils.d.ts"
+    "lib"
   ],
   "pre-commit": [
     "lint"
@@ -175,6 +167,7 @@
     "string-replace-loader": "^3.1.0",
     "ts-loader": "^9.4.4",
     "ts-node": "^10.9.1",
+    "tsc": "^2.0.4",
     "typescript": "5.3.2",
     "webpack": "^5.90.3",
     "webpack-bundle-analyzer": "^4.10.2",

package/embed.d.ts

@@ -1 +0,0 @@
-export * from './types/Embed';

package/index.d.ts

@@ -1 +0,0 @@
-export * from './types';

package/sdk.d.ts

@@ -1 +0,0 @@
-export * from './types/formio';

package/types/Embed.d.ts

@@ -1,13 +0,0 @@
-export declare class Formio {
-    static config: any;
-    static icons: string;
-    static setBaseUrl(url: string): void;
-    static setApiUrl(url: string): void;
-    static setAppUrl(url: string): void;
-    static setProjectUrl(url: string): void;
-    static clearCache(): void;
-    static setPathType(type: string): void;
-    static createForm(element: HTMLElement, form: any, options: any): any;
-    static builder(element: HTMLElement, form: any, options: any): any;
-    static use(module: any): void;
-}

package/types/Plugins.d.ts

@@ -1,95 +0,0 @@
-/**
- * The plugin initialization function, which will receive the Formio interface as its first argument.
- */
-export interface PluginInitFunction {
-    /**
-     * @param Formio - The Formio interface class.
-     */
-    (Formio: any): void;
-}
-/**
- * Function that is called when the plugin is deregistered.
- */
-export interface PluginDeregisterFunction {
-    /**
-     * @param Formio The Formio interface class.
-     */
-    (Formio: any): void;
-}
-/**
- * A Formio Plugin interface.
- */
-export interface Plugin {
-    /**
-     * The name of the plugin.
-     */
-    __name: string;
-    /**
-     * The priority of this plugin.
-     */
-    priority: number;
-    /**
-     * An initialization function called when registered with Formio.
-     */
-    init: PluginInitFunction;
-    /**
-     * Called when the plugin is deregistered.
-     */
-    deregister: PluginDeregisterFunction;
-}
-/**
- * The Form.io Plugins allow external systems to "hook" into the default behaviors of the JavaScript SDK.
- */
-export default class Plugins {
-    /**
-     * An array of Form.io Plugins.
-     */
-    static plugins: Array<Plugin>;
-    /**
-     * The Formio class.
-     */
-    static Formio: any;
-    /**
-     * Returns the plugin identity.
-     *
-     * @param value
-     */
-    static identity(value: string): string;
-    /**
-     * De-registers a plugin.
-     * @param plugin The plugin you wish to deregister.
-     */
-    static deregisterPlugin(plugin: (Plugin | string)): boolean;
-    /**
-     * Registers a new plugin.
-     *
-     * @param plugin The Plugin object.
-     * @param name The name of the plugin you wish to register.
-     */
-    static registerPlugin(plugin: Plugin, name: string): void;
-    /**
-     * Returns a plugin provided the name of the plugin.
-     * @param name The name of the plugin you would like to get.
-     */
-    static getPlugin(name: string): Plugin | null;
-    /**
-     * Wait for a plugin function to complete.
-     * @param pluginFn - A function within the plugin.
-     * @param args
-     */
-    static pluginWait(pluginFn: any, ...args: any[]): Promise<any[]>;
-    /**
-     * Gets a value from a Plugin
-     * @param pluginFn
-     * @param args
-     */
-    static pluginGet(pluginFn: any, ...args: any[]): any;
-    /**
-     * Allows a Plugin to alter the behavior of the JavaScript library.
-     *
-     * @param pluginFn
-     * @param value
-     * @param args
-     */
-    static pluginAlter(pluginFn: any, value: any, ...args: any[]): any;
-}

package/types/sdk.d.ts

@@ -1 +0,0 @@
-export * from './formio';

package/utils.d.ts

@@ -1 +0,0 @@
-export * from './types/utils';