@feathery/react 2.6.7 → 2.7.1

package/dist/utils/entities/Field.d.ts

@@ -1,130 +1,130 @@
-import { FeatheryFieldTypes } from '../init';
-import { FieldStyles, OptionType } from '../fieldHelperFunctions';
-import { OPERATOR_CODE, ResolvedComparisonRule } from '../logic';
-/**
- * Represents a field in a form.  Part of the SDK coding model.
- * For repeating fields, value is an array.
- *
- * myField.value is the raw value of the field and will either be a single value or an array
- * This enables the following sorts of syntax in rules:
- * myField.value = 'blaa' if it is not repeating
- * myField.value[0] = 'blaa' if it is repeating
- * myField.equals('something')    (non-repeating or repeating)
- * myField.value[0] === 'something'    (repeating)
- * myField.value === ['something','another']    (repeating - all fields)
- *
- * NOTE: I tried to make this a subclass of Array<Field> but that didn't work out.  Extending
- * the builtin array type requires native true ES6 syntax and with webpack it seems to be
- * not supported.  It would have been a much cleaner implementation and cleaner and simpler syntax
- * for working with repeats.
- * The syntax above is a bit more verbose but will have to do for now.
- * SEE: https://stackoverflow.com/questions/35128241/extreme-es6-array-extension-weirdness-it-reverts-to-regular-array-with-webpack
- */
-export default class Field {
-    _fieldKey: string;
-    _formUuid: string;
-    _hiddenField: boolean;
-    _sourceField: any;
-    constructor(fieldKey: string, formUuid: string, hiddenField?: boolean);
-    get id(): string;
-    _runFieldUpdate(): Promise<void>;
-    clear(): void;
-    get value(): FeatheryFieldTypes;
-    set value(val: FeatheryFieldTypes);
-    _getFormSpecificProps(): {
-        type: string;
-        displayText: string;
-        required: boolean;
-        onThisForm: boolean;
-    };
-    _getSourceField(): any;
-    get type(): string;
-    set type(val: string);
-    get displayText(): string;
-    set displayText(val: string);
-    get onThisForm(): boolean;
-    set onThisForm(val: boolean);
-    get isHiddenField(): boolean;
-    set isHiddenField(val: boolean);
-    get required(): boolean;
-    set required(flag: boolean);
-    get options(): OptionType[];
-    set options(newOptions: OptionType[]);
-    setStyles(newStyles: FieldStyles): void;
-    get placeholder(): string;
-    set placeholder(val: string | string[]);
-    get disabled(): boolean;
-    set disabled(flag: boolean);
-    setError(errors: string | {
-        index: number;
-        message: string;
-    }): void;
-    _comparisonRule(comparison: OPERATOR_CODE, values?: ({
-        id: string;
-    } | string)[]): ResolvedComparisonRule;
-    _executeLogic(comparison: OPERATOR_CODE, values?: ({
-        id: string;
-    } | string)[]): boolean;
-    equals(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    notEquals(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    equalsIgnoreCase(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    notEqualsIgnoreCase(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    greaterThan(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    greaterThanOrEqual(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    lessThan(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    lessThanOrEqual(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    isFilled(): boolean;
-    isEmpty(): boolean;
-    isTrue(): boolean;
-    isFalse(): boolean;
-    contains(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    doesNotContain(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    containsIgnoreCase(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    doesNotContainIgnoreCase(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    startsWith(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    doesNotStartWith(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    endsWith(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    doesNotEndWith(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    isNumerical(): boolean;
-    isText(): boolean;
-    selectionsInclude(...values: ({
-        id: string;
-    } | string)[]): boolean;
-    selectionsDoNotInclude(...values: ({
-        id: string;
-    } | string)[]): boolean;
-}
-export declare function parseUserVal(userVal: FeatheryFieldTypes, key: string): FeatheryFieldTypes;
+import { FeatheryFieldTypes } from '../init';
+import { FieldStyles, OptionType } from '../fieldHelperFunctions';
+import { OPERATOR_CODE, ResolvedComparisonRule } from '../logic';
+/**
+ * Represents a field in a form.  Part of the SDK coding model.
+ * For repeating fields, value is an array.
+ *
+ * myField.value is the raw value of the field and will either be a single value or an array
+ * This enables the following sorts of syntax in rules:
+ * myField.value = 'blaa' if it is not repeating
+ * myField.value[0] = 'blaa' if it is repeating
+ * myField.equals('something')    (non-repeating or repeating)
+ * myField.value[0] === 'something'    (repeating)
+ * myField.value === ['something','another']    (repeating - all fields)
+ *
+ * NOTE: I tried to make this a subclass of Array<Field> but that didn't work out.  Extending
+ * the builtin array type requires native true ES6 syntax and with webpack it seems to be
+ * not supported.  It would have been a much cleaner implementation and cleaner and simpler syntax
+ * for working with repeats.
+ * The syntax above is a bit more verbose but will have to do for now.
+ * SEE: https://stackoverflow.com/questions/35128241/extreme-es6-array-extension-weirdness-it-reverts-to-regular-array-with-webpack
+ */
+export default class Field {
+    _fieldKey: string;
+    _formUuid: string;
+    _hiddenField: boolean;
+    _sourceField: any;
+    constructor(fieldKey: string, formUuid: string, hiddenField?: boolean);
+    get id(): string;
+    _runFieldUpdate(): Promise<void>;
+    clear(): void;
+    get value(): FeatheryFieldTypes;
+    set value(val: FeatheryFieldTypes);
+    _getFormSpecificProps(): {
+        type: string;
+        displayText: string;
+        required: boolean;
+        onThisForm: boolean;
+    };
+    _getSourceField(): any;
+    get type(): string;
+    set type(val: string);
+    get displayText(): string;
+    set displayText(val: string);
+    get onThisForm(): boolean;
+    set onThisForm(val: boolean);
+    get isHiddenField(): boolean;
+    set isHiddenField(val: boolean);
+    get required(): boolean;
+    set required(flag: boolean);
+    get options(): OptionType[];
+    set options(newOptions: OptionType[]);
+    setStyles(newStyles: FieldStyles): void;
+    get placeholder(): string;
+    set placeholder(val: string | string[]);
+    get disabled(): boolean;
+    set disabled(flag: boolean);
+    setError(errors: string | {
+        index: number;
+        message: string;
+    }): void;
+    _comparisonRule(comparison: OPERATOR_CODE, values?: ({
+        id: string;
+    } | string)[]): ResolvedComparisonRule;
+    _executeLogic(comparison: OPERATOR_CODE, values?: ({
+        id: string;
+    } | string)[]): boolean;
+    equals(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    notEquals(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    equalsIgnoreCase(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    notEqualsIgnoreCase(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    greaterThan(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    greaterThanOrEqual(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    lessThan(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    lessThanOrEqual(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    isFilled(): boolean;
+    isEmpty(): boolean;
+    isTrue(): boolean;
+    isFalse(): boolean;
+    contains(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    doesNotContain(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    containsIgnoreCase(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    doesNotContainIgnoreCase(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    startsWith(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    doesNotStartWith(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    endsWith(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    doesNotEndWith(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    isNumerical(): boolean;
+    isText(): boolean;
+    selectionsInclude(...values: ({
+        id: string;
+    } | string)[]): boolean;
+    selectionsDoNotInclude(...values: ({
+        id: string;
+    } | string)[]): boolean;
+}
+export declare function parseUserVal(userVal: FeatheryFieldTypes, key: string): FeatheryFieldTypes;
 //# sourceMappingURL=Field.d.ts.map

package/dist/utils/error.d.ts

@@ -1,14 +1,14 @@
-export declare class SDKKeyError extends Error {
-    constructor(message?: string);
-}
-export declare class UserIdError extends Error {
-    constructor();
-}
-export declare class FetchError extends Error {
-    payload: any;
-    constructor(message: any, payload?: any);
-}
-export declare function parseError(err: any): any;
-export declare const setCustomErrorHandler: () => void;
-export declare const removeCustomErrorHandler: () => void;
+export declare class SDKKeyError extends Error {
+    constructor(message?: string);
+}
+export declare class UserIdError extends Error {
+    constructor();
+}
+export declare class FetchError extends Error {
+    payload: any;
+    constructor(message: any, payload?: any);
+}
+export declare function parseError(err: any): any;
+export declare const setCustomErrorHandler: () => void;
+export declare const removeCustomErrorHandler: () => void;
 //# sourceMappingURL=error.d.ts.map

package/dist/utils/featheryClient/index.d.ts

@@ -1,104 +1,104 @@
-import IntegrationClient from './integrationClient';
-import type { DebouncedFunc } from 'lodash';
-import { ExtractionActionOptions, GetConfigParams } from '../internalState';
-export declare const API_URL_OPTIONS: {
-    local: string;
-    staging: string;
-    production: string;
-    productionAU: string;
-    productionEU: string;
-    productionCA: string;
-};
-export declare let API_URL: string;
-export declare let CDN_URL: string;
-export declare let STATIC_URL: string;
-export declare let S3_URL: string;
-export declare const updateRegionApiUrls: (region: string) => void;
-export default class FeatheryClient extends IntegrationClient {
-    /**
-     * Used to aggregate field value updates for successive calls to
-     * submitCustom within the debounce window
-     */
-    pendingCustomFieldUpdates: {
-        [key: string]: any;
-    };
-    /**
-     * Debounced implementation of submitCustom
-     */
-    debouncedSubmitCustom: DebouncedFunc<(override: boolean) => Promise<void>>;
-    customSubmitInFlight: Record<string, any>;
-    constructor(formKey?: string, ignoreNetworkErrors?: any, draft?: boolean, bypassCDN?: boolean);
-    private handleInteraction;
-    destroy(): void;
-    _submitJSONData(servars: any, stepKey: string, noComplete: boolean): Promise<void>;
-    _getFileValue(servar: any): Promise<any>;
-    _submitFileData(servar: any, stepKey: string): Promise<void>;
-    updateUserId(newUserId: string, merge?: boolean): Promise<void | Response>;
-    pollUserData(): Promise<void | Response>;
-    setDefaultFormValues({ steps, additionalValues }: any): void;
-    _loadFormPackages(res: any): void;
-    fetchCacheForm(formLanguage?: string): Promise<any>;
-    fetchForm(initVals: any, language?: string): Promise<any>;
-    fetchSession(formPromise?: null, block?: boolean): Promise<any[]>;
-    submitAuthInfo({ authId, authData, isStytchTemplateKey }: any): Promise<any>;
-    /**
-     * Debounceable function responsible for pinging `/api/panel/custom/submit/<version>`
-     */
-    _debouncedSubmitCustom(override: boolean): Promise<void>;
-    /**
-     * If there is a pending invocation of submitCustom, this method calls it immediately
-     */
-    flushCustomFields(override?: boolean): Promise<void | undefined>;
-    /**
-     * `beforeunload` event handler that flushes the pending submit custom changes
-     * when a user is attempting to exit the page.
-     * Defined via an arrow function so that event handler has a consistent reference
-     * when adding and removing the listener
-     * @param event `BeforeUnloadEvent`
-     * @returns
-     */
-    _flushCustomFieldsBeforeUnload: (event: BeforeUnloadEvent) => "" | undefined;
-    _removeCustomFieldListener(): void;
-    _addCustomFieldListener(): void;
-    getNoSave(): boolean;
-    submitCustom(customKeyValues: {
-        [key: string]: any;
-    }, { override, shouldFlush }?: {
-        override?: boolean;
-        shouldFlush?: boolean;
-    }): Promise<void>;
-    submitStep(servars: any, step: any, hasNext: boolean): Promise<[any, void, void, ...any[]] | undefined>;
-    registerEvent(eventData: any): Promise<any>;
-    runCustomRequest(payload: {
-        name?: string;
-        method?: string;
-        url?: string;
-        data: Record<string, any> | any[];
-        headers: Record<string, string>;
-    }, fieldValues?: {
-        [key: string]: any;
-    } | null): Promise<any>;
-    runServerSideLogicRule(id: string): Promise<any>;
-    AI_CHECK_INTERVAL: number;
-    AI_MAX_TIME: number;
-    runAIExtraction({ extractionId, options, pages, setPollFuserData, onStatusUpdate }: {
-        extractionId: string;
-        options: ExtractionActionOptions | boolean;
-        pages?: number[] | number[][];
-        setPollFuserData?: any;
-        onStatusUpdate?: any;
-    }): Promise<unknown>;
-    getConfig(configParams: GetConfigParams): Promise<any>;
-    verifyCollaborator(email: string): Promise<any>;
-    inviteCollaborator(usersGroups: string[], templateId: string): Promise<any>;
-    rewindCollaboration(templateId: string, rewindEmailKey: string): Promise<any>;
-    setCollaboratorAsCompleted(templateId: string): Promise<any>;
-    generateDocuments({ documentIds, download }: {
-        documentIds: string[];
-        download?: boolean;
-    }): Promise<{
-        files: any;
-    } | undefined>;
-    resetPendingFileUploads(fieldKeys: string[]): Promise<void>;
-}
+import IntegrationClient from './integrationClient';
+import type { DebouncedFunc } from 'lodash';
+import { ExtractionActionOptions, GetConfigParams } from '../internalState';
+export declare const API_URL_OPTIONS: {
+    local: string;
+    staging: string;
+    production: string;
+    productionAU: string;
+    productionEU: string;
+    productionCA: string;
+};
+export declare let API_URL: string;
+export declare let CDN_URL: string;
+export declare let STATIC_URL: string;
+export declare let S3_URL: string;
+export declare const updateRegionApiUrls: (region: string) => void;
+export default class FeatheryClient extends IntegrationClient {
+    /**
+     * Used to aggregate field value updates for successive calls to
+     * submitCustom within the debounce window
+     */
+    pendingCustomFieldUpdates: {
+        [key: string]: any;
+    };
+    /**
+     * Debounced implementation of submitCustom
+     */
+    debouncedSubmitCustom: DebouncedFunc<(override: boolean) => Promise<void>>;
+    customSubmitInFlight: Record<string, any>;
+    constructor(formKey?: string, ignoreNetworkErrors?: any, draft?: boolean, bypassCDN?: boolean);
+    private handleInteraction;
+    destroy(): void;
+    _submitJSONData(servars: any, stepKey: string, noComplete: boolean): Promise<void>;
+    _getFileValue(servar: any): Promise<any>;
+    _submitFileData(servar: any, stepKey: string): Promise<void>;
+    updateUserId(newUserId: string, merge?: boolean): Promise<void | Response>;
+    pollUserData(): Promise<void | Response>;
+    setDefaultFormValues({ steps, additionalValues }: any): void;
+    _loadFormPackages(res: any): void;
+    fetchCacheForm(formLanguage?: string): Promise<any>;
+    fetchForm(initVals: any, language?: string): Promise<any>;
+    fetchSession(formPromise?: null, block?: boolean): Promise<any[]>;
+    submitAuthInfo({ authId, authData, isStytchTemplateKey }: any): Promise<any>;
+    /**
+     * Debounceable function responsible for pinging `/api/panel/custom/submit/<version>`
+     */
+    _debouncedSubmitCustom(override: boolean): Promise<void>;
+    /**
+     * If there is a pending invocation of submitCustom, this method calls it immediately
+     */
+    flushCustomFields(override?: boolean): Promise<void | undefined>;
+    /**
+     * `beforeunload` event handler that flushes the pending submit custom changes
+     * when a user is attempting to exit the page.
+     * Defined via an arrow function so that event handler has a consistent reference
+     * when adding and removing the listener
+     * @param event `BeforeUnloadEvent`
+     * @returns
+     */
+    _flushCustomFieldsBeforeUnload: (event: BeforeUnloadEvent) => "" | undefined;
+    _removeCustomFieldListener(): void;
+    _addCustomFieldListener(): void;
+    getNoSave(): boolean;
+    submitCustom(customKeyValues: {
+        [key: string]: any;
+    }, { override, shouldFlush }?: {
+        override?: boolean;
+        shouldFlush?: boolean;
+    }): Promise<void>;
+    submitStep(servars: any, step: any, hasNext: boolean): Promise<[any, void, void, ...any[]] | undefined>;
+    registerEvent(eventData: any): Promise<any>;
+    runCustomRequest(payload: {
+        name?: string;
+        method?: string;
+        url?: string;
+        data: Record<string, any> | any[];
+        headers: Record<string, string>;
+    }, fieldValues?: {
+        [key: string]: any;
+    } | null): Promise<any>;
+    runServerSideLogicRule(id: string): Promise<any>;
+    AI_CHECK_INTERVAL: number;
+    AI_MAX_TIME: number;
+    runAIExtraction({ extractionId, options, pages, setPollFuserData, onStatusUpdate }: {
+        extractionId: string;
+        options: ExtractionActionOptions | boolean;
+        pages?: number[] | number[][];
+        setPollFuserData?: any;
+        onStatusUpdate?: any;
+    }): Promise<unknown>;
+    getConfig(configParams: GetConfigParams): Promise<any>;
+    verifyCollaborator(email: string): Promise<any>;
+    inviteCollaborator(usersGroups: string[], templateId: string): Promise<any>;
+    rewindCollaboration(templateId: string, rewindEmailKey: string): Promise<any>;
+    setCollaboratorAsCompleted(templateId: string): Promise<any>;
+    generateDocuments({ documentIds, download }: {
+        documentIds: string[];
+        download?: boolean;
+    }): Promise<{
+        files: any;
+    } | undefined>;
+    resetPendingFileUploads(fieldKeys: string[]): Promise<void>;
+}
 //# sourceMappingURL=index.d.ts.map