@docuninja/builder2.0 0.0.86 → 0.0.87

package/dist/builder/hooks/use-conditional-visibility.d.ts

@@ -0,0 +1,20 @@
+import { ConditionFieldType, ConditionOperator, OperatorInfo, Rectangle } from '../index';
+export declare function getOperatorsForFieldType(fieldType: ConditionFieldType): OperatorInfo[];
+export declare function operatorNeedsValue(operator: ConditionOperator): boolean;
+export declare function getFieldTypeFromRectangle(rectangle: Rectangle | undefined | null): ConditionFieldType | null;
+export declare function evaluateConditional(rectangle: Rectangle | null | undefined, state: {
+    checkboxes: Record<string, boolean>;
+    inputs: Record<string, string>;
+    dates: Record<string, string>;
+    selects: Record<string, string>;
+    radios: Record<string, string>;
+    multiselects: Record<string, string[]>;
+    numbers: Record<string, string>;
+    initials: Record<string, string>;
+}): boolean;
+/**
+ * Hook to check if a field is effectively required (considering conditional required)
+ */
+export declare function useIsFieldRequired(rectangle: Rectangle | null): boolean;
+export declare function useVisibleRectangles(rectangles: Rectangle[]): Rectangle[];
+export declare function getConditionalTriggerFields(rectangles: Rectangle[]): Rectangle[];

package/dist/builder/index.d.ts

@@ -14,9 +14,12 @@ export type Rectangle = {
     file_id: string;
     signatory_id: string;
     color: string;
+    borderStyle?: "solid" | "dotted" | "hidden";
     required: boolean;
     options?: RectangleOptions;
     show_label?: boolean;
+    conditional?: RectangleConditional;
+    conditionalRequired?: RectangleConditional;
 };
 export type InputType = "signature" | "input" | "date" | "checkbox" | "initial" | "select" | "radio" | "multiselect" | "number";
 export type Rectangles = Record<string, Rectangle[]>;
@@ -29,6 +32,30 @@ export type SelectOption = {
     label: string;
     value: string;
 };
+export type CheckboxOperator = "checked" | "unchecked";
+export type TextOperator = "empty" | "not_empty" | "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with";
+export type NumberOperator = "empty" | "not_empty" | "equals" | "not_equals" | "greater_than" | "less_than" | "greater_than_or_equal" | "less_than_or_equal";
+export type SelectOperator = "empty" | "not_empty" | "equals" | "not_equals";
+export type MultiselectOperator = "empty" | "not_empty" | "contains" | "not_contains" | "contains_all" | "contains_any";
+export type DateOperator = "empty" | "not_empty" | "equals" | "not_equals" | "before" | "after" | "before_or_equal" | "after_or_equal";
+export type ConditionOperator = CheckboxOperator | TextOperator | NumberOperator | SelectOperator | MultiselectOperator | DateOperator;
+export type ConditionFieldType = "checkbox" | "input" | "date" | "select" | "radio" | "multiselect" | "number" | "initial";
+export type OperatorInfo = {
+    value: ConditionOperator;
+    label: string;
+    needsValue?: boolean;
+};
+export type SingleCondition = {
+    fieldId: string;
+    fieldType: ConditionFieldType;
+    operator: ConditionOperator;
+    value?: string | number | string[];
+};
+export type CompoundCondition = {
+    operator: "and" | "or";
+    conditions: SingleCondition[];
+};
+export type RectangleConditional = SingleCondition | CompoundCondition;
 export type RectangleOptions = {
     date?: {
         format: DateFormat;

package/dist/builder/sign/index.d.ts

@@ -33,6 +33,9 @@ export type Sign = {
     };
     styles: Builder["styles"];
     company?: string;
+    translations?: {
+        [key: string]: string | object;
+    };
 };
 export declare const SignContext: import('react').Context<Sign | null>;
 export declare const SignContextPlus: import('react').Context<(Sign & {

package/dist/builder/standalone.d.ts

@@ -4,6 +4,9 @@ type DocuNinjaSignOptions = {
     sig?: string;
     endpoint?: string;
     company?: string;
+    translations?: {
+        [key: string]: string | object;
+    };
 };
 export declare class DocuNinjaSign {
     options: DocuNinjaSignOptions;

package/dist/builder/ui/index.d.ts

@@ -67,6 +67,11 @@ export type Builder = {
         };
     };
     styles: {
+        general?: {
+            backgroundColor?: string;
+            textColor?: string;
+            foregroundColor?: string;
+        };
         frame: React.CSSProperties | undefined;
         border: string | undefined;
         childrenWrapper?: React.CSSProperties;

package/dist/builder.d.ts

@@ -128,6 +128,11 @@ export declare type Builder = {
         };
     };
     styles: {
+        general?: {
+            backgroundColor?: string;
+            textColor?: string;
+            foregroundColor?: string;
+        };
         frame: React.CSSProperties | undefined;
         border: string | undefined;
         childrenWrapper?: React.CSSProperties;
@@ -202,6 +207,8 @@ export declare namespace BuilderTypes {
     }
 }
 
+declare type CheckboxOperator = "checked" | "unchecked";
+
 export declare function checkPdfPassword(file: File, password: string): Promise<boolean>;
 
 export declare interface Client {
@@ -296,6 +303,15 @@ export declare interface CompanyUser {
     deleted_at: string | null;
 }
 
+declare type CompoundCondition = {
+    operator: "and" | "or";
+    conditions: SingleCondition[];
+};
+
+declare type ConditionFieldType = "checkbox" | "input" | "date" | "select" | "radio" | "multiselect" | "number" | "initial";
+
+declare type ConditionOperator = CheckboxOperator | TextOperator | NumberOperator | SelectOperator | MultiselectOperator | DateOperator;
+
 export declare type ConfirmationDialogButtonProps = {
     onClick: () => void;
 };
@@ -387,6 +403,8 @@ export declare type DateInputProps = {
     onChange: (date: string) => void;
 };
 
+declare type DateOperator = "empty" | "not_empty" | "equals" | "not_equals" | "before" | "after" | "before_or_equal" | "after_or_equal";
+
 export declare type DeleteDialogButtonProps = {
     isSubmitting: boolean;
 };
@@ -551,6 +569,8 @@ export declare interface Language {
 
 export declare type MinimizeButtonProps = StartSigningButtonProps;
 
+declare type MultiselectOperator = "empty" | "not_empty" | "contains" | "not_contains" | "contains_all" | "contains_any";
+
 export declare type NavigateButtonProps = {
     onClick: () => void;
     disabled: boolean;
@@ -558,6 +578,8 @@ export declare type NavigateButtonProps = {
 
 declare type NumberFormat = "123456789.567" | "$123,456,789.57" | "123 456 789,57 €" | "£123,456,789.57" | "123,456,789.567" | "123.456.789,567" | "123 456 789,567";
 
+declare type NumberOperator = "empty" | "not_empty" | "equals" | "not_equals" | "greater_than" | "less_than" | "greater_than_or_equal" | "less_than_or_equal";
+
 export declare const pdfjs: typeof lib;
 
 export declare interface Plan {
@@ -588,11 +610,16 @@ export declare type Rectangle = {
     file_id: string;
     signatory_id: string;
     color: string;
+    borderStyle?: "solid" | "dotted" | "hidden";
     required: boolean;
     options?: RectangleOptions;
     show_label?: boolean;
+    conditional?: RectangleConditional;
+    conditionalRequired?: RectangleConditional;
 };
 
+declare type RectangleConditional = SingleCondition | CompoundCondition;
+
 declare type RectangleOptions = {
     date?: {
         format: DateFormat;
@@ -699,6 +726,8 @@ export declare type SaveButtonProps = {
     onClick: () => void;
 };
 
+declare type SelectOperator = "empty" | "not_empty" | "equals" | "not_equals";
+
 declare type SelectOption = {
     value: string;
     label: string;
@@ -765,6 +794,9 @@ export declare type Sign = {
     };
     styles: Builder["styles"];
     company?: string;
+    translations?: {
+        [key: string]: string | object;
+    };
 };
 
 export declare type SignatorySelectorProps = {
@@ -833,6 +865,13 @@ export declare type SignProps = {
     invitation: DocumentInvitation;
 };
 
+declare type SingleCondition = {
+    fieldId: string;
+    fieldType: ConditionFieldType;
+    operator: ConditionOperator;
+    value?: string | number | string[];
+};
+
 export declare type StartSigningButtonProps = {
     onClick: () => void;
 };
@@ -851,6 +890,8 @@ export declare interface Template {
     type_id: number;
 }
 
+declare type TextOperator = "empty" | "not_empty" | "equals" | "not_equals" | "contains" | "not_contains" | "starts_with" | "ends_with";
+
 export declare interface Timezone {
     id: string;
     location: string;