@servicetitan/dte-pdf-editor 1.92.4 → 1.93.0

package/src/hooks/useZoom.ts

@@ -1,25 +1,37 @@
 import { useCallback, useState } from 'react';
-import { ZOOM_DEFAULT, ZOOM_MAX, ZOOM_MIN, ZOOM_STEP } from '../constants';
+import { ZOOM_DEFAULT, ZOOM_STEP } from '../constants';
+import { clampZoom } from '../utils';
 
 export interface UseZoomReturn {
     zoom: number;
     zoomIn(): void;
     zoomOut(): void;
     resetZoom(): void;
+    setZoomValue(value: number): void;
+    zoomByFactor(factor: number): void;
 }
 
-const clampZoom = (value: number) =>
-    Math.min(ZOOM_MAX, Math.max(ZOOM_MIN, Math.round(value * 100) / 100));
-
 /**
  * Manages a page zoom factor (1 = 100%), clamped to [ZOOM_MIN, ZOOM_MAX] in ZOOM_STEP increments.
  */
 export const useZoom = (initialZoom: number = ZOOM_DEFAULT): UseZoomReturn => {
     const [zoom, setZoom] = useState<number>(initialZoom);
 
-    const zoomIn = useCallback(() => setZoom(prev => clampZoom(prev + ZOOM_STEP)), []);
-    const zoomOut = useCallback(() => setZoom(prev => clampZoom(prev - ZOOM_STEP)), []);
-    const resetZoom = useCallback(() => setZoom(ZOOM_DEFAULT), []);
+    const zoomIn = useCallback(() => {
+        setZoom(prev => clampZoom(prev + ZOOM_STEP));
+    }, []);
+    const zoomOut = useCallback(() => {
+        setZoom(prev => clampZoom(prev - ZOOM_STEP));
+    }, []);
+    const resetZoom = useCallback(() => {
+        setZoom(ZOOM_DEFAULT);
+    }, []);
+    const setZoomValue = useCallback((value: number) => {
+        setZoom(clampZoom(value));
+    }, []);
+    const zoomByFactor = useCallback((factor: number) => {
+        setZoom(prev => clampZoom(prev * factor));
+    }, []);
 
-    return { zoom, zoomIn, zoomOut, resetZoom };
+    return { resetZoom, setZoomValue, zoom, zoomByFactor, zoomIn, zoomOut };
 };

package/src/index.ts

@@ -1,3 +1,4 @@
 export * from './interface/types';
+export * from './utils/exposes-utils';
 export * from './interface/host-events';
 export * from './components';

package/src/interface/types.ts

@@ -1,3 +1,5 @@
+import { Svg } from '@servicetitan/anvil2';
+
 export enum FieldTypeEnum {
     dataModel = 'dataModel',
     forms = 'forms',
@@ -15,7 +17,7 @@ export enum ESignFieldType {
     fullName = 'fullName',
 }
 
-export type FillableFieldType = 'text' | 'date' | 'checkbox' | 'radio' | 'number';
+export type FillableFieldType = 'text' | 'date' | 'checkbox' | 'radio' | 'number' | 'dropdown';
 
 export type GenericFieldType = 'table' | 'text';
 export type FormFieldType = 'number' | 'text' | 'date';
@@ -86,6 +88,11 @@ export interface ESignDateSignedOffsetSettings {
         | [...ESignDateSignedOffsetSettingsRule[], ESignDateSignedOffsetSettingsFinalRule];
 }
 
+export interface FillableDropdownItem {
+    value: string;
+    label: string;
+}
+
 export type FieldDataType =
     | GenericFieldTableDataType
     | GenericFieldTextDataType
@@ -123,6 +130,33 @@ export interface PdfFieldStyles {
     fontWeight?: 'normal' | 'bold';
 }
 
+/**
+ * Optional author-configured starting value for a fillable field. The `text`/`number`/`checkbox`/
+ * `date`/`today`/`radio` variants mirror the backend's `FillableDefault` discriminated union
+ * (`ByodField.Default`, DTE-4668) one-for-one: same `type` discriminator and `value` shape, so the
+ * JSON round-trips as-is with no FE-side translation.
+ *
+ * `today` and `radio` intentionally carry no `value` - `today` is a sentinel the client resolves
+ * to a calendar date in its own local timezone at render time (never frozen at author time), and
+ * `radio` just marks *this* option field as the group's pre-selected default (the "value" is which
+ * option, i.e. which sibling field carries the flag - there is nothing else to store).
+ *
+ * `dropdown` has no backend counterpart at all (the backend doesn't recognize a `dropdown`
+ * fillable subtype - see `FillableFieldSubTypes`) and is an FE-only extension of this same union:
+ * `value` is one of this field's own `dropdownItems[].value` entries. Unlike `radio`, a dropdown's
+ * options all live on this one field (`dropdownItems`), not on sibling fields, so - same as
+ * text/number/checkbox/date - there is exactly one field to attach the default to, and the value
+ * it points at is meaningful to store here directly.
+ */
+export type FillableDefault =
+    | { type: 'text'; value: string }
+    | { type: 'number'; value: number }
+    | { type: 'checkbox'; value: boolean }
+    | { type: 'date'; value: string }
+    | { type: 'today' }
+    | { type: 'radio' }
+    | { type: 'dropdown'; value: string };
+
 export interface PdfField {
     id: string;
     type: FieldTypeEnum;
@@ -152,6 +186,9 @@ export interface PdfField {
      */
     hideLabel?: boolean;
     styles?: PdfFieldStyles;
+    default?: FillableDefault;
+    /** Manually-authored options for a fillable `dropdown` field. See `FillableDropdownItem`. */
+    dropdownItems?: FillableDropdownItem[];
 }
 
 export type SchemaFieldType = 'number' | 'date';
@@ -164,6 +201,7 @@ export interface FieldTypeOption {
     fieldType?: SchemaFieldType;
     formSnapshot?: FormulaFieldFormSnapshot;
     sampleData?: unknown;
+    icon?: Svg;
 }
 
 export interface DataModelFieldGroup {

package/src/styles/index.css

@@ -11,3 +11,4 @@
 @import './pdf-document-renderer.css';
 @import './inline-editable.css';
 @import './field-config-panel.css';
+@import './pdf-field.css';

package/src/styles/inline-editable.css

@@ -13,6 +13,8 @@
     width: 100%;
     height: inherit;
     cursor: pointer;
+    outline: none;
+    overflow: hidden;
 }
 
 .inline-editable-html-text {

package/src/styles/pdf-canvas.css

@@ -5,14 +5,8 @@
     margin-inline-end: auto;
 }
 
-.dte-pdf-canvas-controls {
-    z-index: 1;
-    position: sticky;
-    top: 0;
-    left: 0;
-    background: var(--bg-color-main, #fafafa);
-    box-shadow: 0 2px 4px rgb(0 0 0 / 15%);
-    padding: var(--spacing-half) var(--spacing-1);
+.dte-pdf-canvas-container {
+    touch-action: pan-x pan-y;
 }
 
 .dte-pdf-zoom-controls-value {
@@ -22,13 +16,96 @@
     user-select: none;
 }
 
-.dte-pdf-zoom-controls,
-.dte-pdf-field-navigation-controls {
-    border-radius: var(--radius-1, 4px);
-    padding: var(--spacing-half);
-    background-color: var(--bg-color-secondary, #eeeeee);
+.dte-pdf-zoom-controls {
+    background-color: var(--bg-color-light, #ffffff);
+    border: 1px solid var(--border-color, #e0e0e0);
+    border-radius: var(--radius-2, 8px);
+    position: absolute;
+    z-index: 2;
+
+    &.--vertical {
+        flex-direction: column;
+    }
+
+    &.--right-center {
+        right: 0;
+        top: 50%;
+        transform: translate(100%, -50%);
+    }
+
+    &.--right-bottom {
+        bottom: 12px;
+        right: 12px;
+    }
+}
+
+.dte-pdf-field-next-controls-button {
+    background-color: #0365dd;
+    cursor: pointer;
+    color: var(--color-neutral-0, #ffffff);
+    border-radius: var(--border-radius-2, 6px);
+    font-size: var(--typescale-1, 12px);
+    font-family: 'Nunito Sans';
+    font-weight: var(--font-weight-semibold, 600);
+    font-stretch: 100%;
+
+    &.--started {
+        &:after {
+            content: '';
+            position: absolute;
+            right: -1em;
+            height: 100%;
+            width: 1.3em;
+            background-color: inherit;
+            clip-path: polygon(0% 0%, 100% 50%, 0% 100%);
+        }
+    }
+
+    &.--disabled {
+        background-color: var(--color-neutral-300, #e0e0e0);
+        cursor: not-allowed;
+    }
+
+    > span {
+        position: relative;
+        padding: 5px var(--spacing-1);
+        display: inline-block;
+    }
+}
+
+.dte-pdf-canvas-controls {
+    z-index: 1;
+    position: sticky;
+    top: 0;
+    left: 0;
+    background: var(--bg-color-highlited, #0265dc);
+    padding: var(--spacing-2, 16px);
+
+    .dte-pdf-field-next-controls-button:after {
+        display: none;
+    }
+}
+
+.dte-pdf-movable-next-button-wrapper {
+    top: 2px;
+    transform: translateX(-100%);
+    transition: top 0.3s ease;
+    position: absolute;
+    z-index: 2;
+}
+
+@media (max-width: 1000px) {
+    .dte-pdf-movable-next-button-wrapper {
+        display: none;
+    }
+
+    .dte-pdf-zoom-controls {
+        display: none !important;
+    }
 }
 
-.dte-pdf-field-view.--eSign:focus {
-    outline: 2px solid var(--border-color-active);
+@media (min-width: 1001px) {
+    .dte-pdf-editor-theme > .dte-pdf-canvas-controls {
+        display: none;
+    }
 }

package/src/styles/pdf-editor.css

@@ -14,6 +14,7 @@
     min-width: 0;
     overflow: auto;
     overscroll-behavior: none;
+    touch-action: pan-x pan-y;
     background-color: var(--bg-color-main, #eeeeee);
     width: 100%;
 

package/src/styles/pdf-field-overlay.css

@@ -5,54 +5,19 @@
     width: 100%;
     height: 100%;
     pointer-events: none;
-}
-
-.dte-pdf-field-overlay.--view-mode {
-    pointer-events: auto;
-}
-
-/* Editor-only chrome. Layout metrics come from getFieldBoundsStyle. */
-.dte-pdf-field-editor {
-    outline: 1px dashed #999;
-    outline-offset: 0;
-    border: none;
-    pointer-events: auto;
-}
-
-.dte-pdf-field-editor.fillable-radio.--edit-mode {
-    overflow: unset !important;
-}
-
-.dte-pdf-field-editor.--selected {
-    outline: 2px solid var(--border-color-active);
-    cursor: move;
-}
-
-.dte-pdf-field-editor.--unselected {
-    cursor: pointer;
-}
 
-.dte-pdf-field-editor.--dragging {
-    opacity: 0.5;
-}
-
-.dte-pdf-field-editor.--colored:not(.--selected) {
-    outline-color: var(--border-color-active) !important;
-    box-shadow: 0 0 2px 0 var(--border-color-active);
-}
-
-.dte-pdf-field-editor.--error {
-    outline-color: var(--danger) !important;
-    box-shadow: 0 0 4px 0 var(--danger);
+    &.--view-mode {
+        pointer-events: auto;
+    }
 }
 
 .dte-pdf-field-error-message {
     top: 100%;
     min-width: 100px;
     position: absolute;
-    margin-top: var(--spacing-half, 4px);
+    margin-top: var(--spacing-1, 8px);
     color: var(--danger);
-    font-size: var(--typescale-1, 12px);
+    font-size: var(--typescale-small, 10px);
 }
 
 .dte-pdf-field-resize-handle {
@@ -65,32 +30,10 @@
     cursor: nwse-resize;
     z-index: 10;
     box-sizing: border-box;
-}
-
-.dte-pdf-field-resize-handle:hover {
-    border-color: var(--border-color-active);
-}
-
-.dte-add-field-button {
-    display: none;
-    position: absolute;
-    bottom: -20px;
-    left: -10px;
-    margin-left: 50%;
-    padding: var(--spacing-0, 0);
-    width: 20px;
-    height: 20px;
-}
 
-.dte-pdf-field-editor:hover .dte-add-field-button {
-    display: block;
-}
-
-.dte-pdf-field-view {
-    border: none;
-    outline: none;
-    cursor: default;
-    pointer-events: auto;
+    &:hover {
+        border-color: var(--border-color-active);
+    }
 }
 
 .dte-pdf-field-content {
@@ -101,18 +44,6 @@
     line-height: 1;
 }
 
-.dte-pdf-field-content input[type='checkbox']:focus,
-.dte-pdf-field-content input[type='checkbox']:active,
-.dte-pdf-field-content input[type='radio']:active,
-.dte-pdf-field-content input[type='radio']:focus {
-    box-shadow:
-        0 0 0 2px var(--border-color-active, #2270ee) inset,
-        0 0 0 3px var(--color-neutral-0, #ffffff) inset;
-}
-
-/*
- * Printed PDF text modes (no ellipsis — hard clip like PdfSharp).
- */
 .dte-pdf-field-text--single-line {
     width: 100%;
     min-width: 0;
@@ -150,37 +81,28 @@
     min-width: 0;
     min-height: 0;
     box-sizing: border-box;
-    background: inherit;
+    background: transparent;
     border: none;
     padding: var(--spacing-0);
     margin: var(--spacing-0);
     line-height: 1;
     font-size: inherit;
-}
-
-.dte-pdf-field-editor .dte-pdf-field-fillable {
-    pointer-events: none;
-}
-
-.dte-pdf-field-view .dte-pdf-field-fillable {
-    pointer-events: auto;
-}
 
-.dte-pdf-field-fillable.dte-pdf-field-text--single-line {
-    white-space: nowrap;
-    overflow: hidden;
-}
+    &.dte-pdf-field-text--single-line {
+        white-space: nowrap;
+        overflow: hidden;
+    }
 
-.dte-pdf-field-fillable.dte-pdf-field-text--multiline {
-    white-space: pre-wrap;
-    overflow-wrap: break-word;
-    overflow: hidden;
-    resize: none;
-}
+    &.dte-pdf-field-text--multiline {
+        white-space: pre-wrap;
+        overflow-wrap: break-word;
+        overflow: hidden;
+        resize: none;
+    }
 
-.dte-pdf-field-fillable:focus {
-    outline: 2px solid var(--border-color-active, #2270ee);
-    outline-offset: 2px;
+    &:focus {
+        outline: none;
+    }
 }
 
 .dte-pdf-field-generic-table {
@@ -189,27 +111,27 @@
     border-spacing: var(--spacing-0, 0);
     width: 100%;
     table-layout: fixed;
-}
 
-.dte-pdf-field-generic-table td {
-    border-top: 1px solid var(--border-color);
-    border-left: 1px solid var(--border-color);
-    padding-inline: var(--spacing-1, 8px);
-}
+    td {
+        border-top: 1px solid var(--border-color);
+        border-left: 1px solid var(--border-color);
+        padding-inline: var(--spacing-1, 8px);
+    }
 
-.dte-pdf-field-generic-table .dte-pdf-field-generic-table-header td {
-    background-color: var(--bg-color);
-    font-weight: bold;
-}
+    .dte-pdf-field-generic-table-header td {
+        background-color: var(--bg-color);
+        font-weight: bold;
+    }
 
-.dte-pdf-field-generic-table tr:not(.dte-pdf-field-generic-table-header) td {
-    background-color: var(--bg-color-light);
-}
+    tr:not(.dte-pdf-field-generic-table-header) td {
+        background-color: var(--bg-color-light);
+    }
 
-.dte-pdf-field-generic-table tr:last-child td {
-    border-bottom: 1px solid var(--border-color);
-}
+    tr:last-child td {
+        border-bottom: 1px solid var(--border-color);
+    }
 
-.dte-pdf-field-generic-table tr td:last-child {
-    border-right: 1px solid var(--border-color);
+    tr td:last-child {
+        border-right: 1px solid var(--border-color);
+    }
 }

package/src/styles/pdf-field.css

@@ -0,0 +1,111 @@
+.dte-pdf-field-container {
+    --pdf-field-color: var(--color-blue-500, #0265dc);
+    --pdf-field-color-dark: var(--color-blue-500, #0265dc);
+    --pdf-field-opacity-color: #3d95ff1f;
+
+    pointer-events: auto;
+    border-radius: 4px;
+
+    &.--edit {
+        color: var(--pdf-field-color);
+        background-color: var(--pdf-field-opacity-color);
+        outline: 1px dashed var(--pdf-field-color);
+    }
+
+    &.--view {
+        &.--fillable,
+        &.--eSign {
+            color: var(--pdf-field-color);
+            background-color: var(--pdf-field-opacity-color);
+            outline: 1px dashed var(--pdf-field-color);
+
+            &:focus-within {
+                box-shadow:
+                    0 0 0 3px white,
+                    0 0 0 5px var(--pdf-field-color-dark) !important;
+            }
+
+            input[type='checkbox'],
+            select {
+                outline: none;
+            }
+
+            &:has(input:disabled),
+            &:has(select:disabled) {
+                --pdf-field-color: #707070 !important;
+                --pdf-field-color-dark: #707070 !important;
+                --pdf-field-opacity-color: #7070701f !important;
+            }
+        }
+    }
+
+    .dte-pdf-field-label {
+        position: absolute;
+        display: flex;
+        align-items: center;
+        gap: var(--spacing-half, 4px);
+        background-color: var(--color-neutral-0, #ffffff);
+        border-radius: 4px;
+        padding: 1px var(--spacing-half, 4px);
+        top: -10px;
+        left: 3px;
+        font-size: var(--typescale-small, 10px);
+        line-height: 1;
+        white-space: nowrap;
+        color: var(--pdf-field-color-dark);
+        border-width: 1px;
+        border-style: solid;
+        border-color: inherit;
+        font-weight: var(--font-weight-bold, 700);
+
+        span {
+            font-weight: var(--font-weight-regular, 400);
+        }
+    }
+
+    input::placeholder,
+    input[type='date'],
+    input[type='date']::-webkit-calendar-picker-indicator {
+        color: var(--pdf-field-color);
+    }
+
+    &.--selected {
+        box-shadow:
+            0 0 0 3px white,
+            0 0 0 5px var(--pdf-field-color-dark);
+        cursor: move;
+    }
+
+    &.--colored:not(.--selected) {
+        box-shadow: 0 0 3px 1px #616e7b;
+    }
+
+    &.--unselected {
+        cursor: pointer;
+    }
+
+    &.--dragging {
+        opacity: 0.5;
+    }
+
+    &.--error {
+        --pdf-field-color: var(--danger, #dc3545) !important;
+        --pdf-field-color-dark: var(--red, #0265dc) !important;
+        --pdf-field-opacity-color: var(--danger-opacity, #dc35451f) !important;
+    }
+
+    .dte-add-field-button {
+        display: none;
+        position: absolute;
+        bottom: -20px;
+        left: -10px;
+        margin-left: 50%;
+        padding: var(--spacing-0, 0);
+        width: 20px;
+        height: 20px;
+    }
+
+    &:hover .dte-add-field-button {
+        display: block;
+    }
+}

package/src/styles/variables.css

@@ -6,6 +6,7 @@
     --menu-hover-color: var(--color-neutral-100, #606162);
 
     /* Typography */
+    --typescale-small: 10px;
     --typescale-0: var(--typescale-1, 12px);
     --typescale-1: var(--typescale-1, 14px);
 
@@ -20,6 +21,7 @@
     --radius-0: 0;
     --radius-1: 4px;
     --radius-2: 8px;
+    --radius-3: 16px;
 
     /* Colors - Neutral */
     --color-neutral-0: var(--color-neutral-0, #ffffff);
@@ -31,6 +33,7 @@
     --color-blue-100: var(--color-blue-100, #fafcff);
 
     /* Background colors */
+    --bg-color-highlited: var(--color-blue-400);
     --bg-color-light: var(--color-neutral-0, #ffffff);
     --bg-color-main: var(--color-neutral-20, #fafafa);
     --bg-color-secondary: var(--color-neutral-50, #eeeeee);
@@ -41,6 +44,7 @@
     /* Colors - Semantic */
     --success: #28a745;
     --danger: #dc3545;
+    --danger-opacity: #dc35451f;
     --green: #28a745;
     --red: #dc3545;
     --white: var(--color-neutral-0, #ffffff);

package/src/utils/data-model/index.ts

@@ -1,2 +1,3 @@
 export * from './extract-fields.utils';
 export * from './resolve-values.utils';
+export * from './resolve-fields-default-values';

package/src/utils/data-model/resolve-fields-default-values.ts

@@ -0,0 +1,19 @@
+import { DataModelValues, PdfField } from '../../interface/types';
+import { getTodayDateInputValue } from '../field';
+
+export const resolveFieldsDefaultValues = (fields: PdfField[]): DataModelValues => {
+    const defaultValues: Record<string, any> = {};
+    for (const field of fields) {
+        if (field.default !== undefined) {
+            if (field.default.type === 'radio') {
+                defaultValues[field.path!] = field.id;
+            } else if (field.default.type === 'today') {
+                defaultValues[field.path!] = getTodayDateInputValue();
+            } else {
+                defaultValues[field.path!] = field.default.value;
+            }
+        }
+    }
+
+    return defaultValues;
+};

package/src/utils/exposes-utils.ts

@@ -0,0 +1 @@
+export * from './data-model/resolve-fields-default-values';

package/src/utils/field/__tests__/field-background-color.utils.test.ts

@@ -1,8 +1,8 @@
-import { getFieldBackgroundColor } from '../field-background-color.utils';
+import { getFieldColor } from '../field-background-color.utils';
 
-describe('getFieldBackgroundColor', () => {
+describe('getFieldColor', () => {
     const subject = (recipient: string | undefined, recipientsColors: Record<string, string>) =>
-        getFieldBackgroundColor(recipient, recipientsColors);
+        getFieldColor(recipient, recipientsColors);
 
     test('returns color for recipient when present in map', () => {
         expect(subject('signer1', { signer1: '#ff0000', signer2: '#00ff00' })).toBe('#ff0000');

package/src/utils/field/__tests__/get-field-bounds-style.utils.test.ts

@@ -34,7 +34,6 @@ describe('getFieldBoundsStyle', () => {
             padding: 4,
             alignItems: 'flex-start',
             justifyContent: 'flex-start',
-            overflow: 'hidden',
             lineHeight: 1,
         });
     });