@progress/kendo-pdfviewer-common 0.3.0-dev.202409251459 → 0.3.0-dev.202410100645

package/dist/npm/annotations/shared/ui_utils.js

@@ -0,0 +1,250 @@
+"use strict";
+/* Copyright 2012 Mozilla Foundation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TextLayerMode = exports.ScrollMode = exports.scrollIntoView = exports.RenderingStates = exports.PresentationModeState = exports.parseQueryString = exports.DEFAULT_SCALE = exports.binarySearchFirstItem = void 0;
+// const DEFAULT_SCALE_VALUE = "auto";
+const DEFAULT_SCALE = 1.0;
+exports.DEFAULT_SCALE = DEFAULT_SCALE;
+// const DEFAULT_SCALE_DELTA = 1.1;
+// const MIN_SCALE = 0.1;
+// const MAX_SCALE = 10.0;
+// const UNKNOWN_SCALE = 0;
+// const MAX_AUTO_SCALE = 1.25;
+// const SCROLLBAR_PADDING = 40;
+// const VERTICAL_PADDING = 5;
+const RenderingStates = {
+    INITIAL: 0,
+    RUNNING: 1,
+    PAUSED: 2,
+    FINISHED: 3,
+};
+exports.RenderingStates = RenderingStates;
+const PresentationModeState = {
+    UNKNOWN: 0,
+    NORMAL: 1,
+    CHANGING: 2,
+    FULLSCREEN: 3,
+};
+exports.PresentationModeState = PresentationModeState;
+// const SidebarView = {
+//   UNKNOWN: -1,
+//   NONE: 0,
+//   THUMBS: 1, // Default value.
+//   OUTLINE: 2,
+//   ATTACHMENTS: 3,
+//   LAYERS: 4,
+// };
+const TextLayerMode = {
+    DISABLE: 0,
+    ENABLE: 1,
+    ENABLE_PERMISSIONS: 2,
+};
+exports.TextLayerMode = TextLayerMode;
+const ScrollMode = {
+    UNKNOWN: -1,
+    VERTICAL: 0, // Default value.
+    HORIZONTAL: 1,
+    WRAPPED: 2,
+    PAGE: 3,
+};
+exports.ScrollMode = ScrollMode;
+// const SpreadMode = {
+//   UNKNOWN: -1,
+//   NONE: 0, // Default value.
+//   ODD: 1,
+//   EVEN: 2,
+// };
+// const CursorTool = {
+//   SELECT: 0, // The default value.
+//   HAND: 1,
+//   ZOOM: 2,
+// };
+// // Used by `PDFViewerApplication`, and by the API unit-tests.
+// const AutoPrintRegExp = /\bprint\s*\(/;
+// /**
+//  * Scale factors for the canvas, necessary with HiDPI displays.
+//  */
+// class OutputScale {
+//   constructor() {
+//     const pixelRatio = window.devicePixelRatio || 1;
+//     /**
+//      * @type {number} Horizontal scale.
+//      */
+//     this.sx = pixelRatio;
+//     /**
+//      * @type {number} Vertical scale.
+//      */
+//     this.sy = pixelRatio;
+//   }
+//   /**
+//    * @type {boolean} Returns `true` when scaling is required, `false` otherwise.
+//    */
+//   get scaled() {
+//     return this.sx !== 1 || this.sy !== 1;
+//   }
+// }
+/**
+ * Scrolls specified element into view of its parent.
+ * @param {HTMLElement} element - The element to be visible.
+ * @param {Object} [spot] - An object with optional top and left properties,
+ *   specifying the offset from the top left edge.
+ * @param {number} [spot.left]
+ * @param {number} [spot.top]
+ * @param {boolean} [scrollMatches] - When scrolling search results into view,
+ *   ignore elements that either: Contains marked content identifiers,
+ *   or have the CSS-rule `overflow: hidden;` set. The default value is `false`.
+ */
+function scrollIntoView(element, spot, scrollMatches = false) {
+    // Assuming offsetParent is available (it's not available when viewer is in
+    // hidden iframe or object). We have to scroll: if the offsetParent is not set
+    // producing the error. See also animationStarted.
+    let parent = element.offsetParent;
+    if (!parent) {
+        console.error("offsetParent is not set -- cannot scroll");
+        return;
+    }
+    let offsetY = element.offsetTop + element.clientTop;
+    let offsetX = element.offsetLeft + element.clientLeft;
+    while ((parent.clientHeight === parent.scrollHeight &&
+        parent.clientWidth === parent.scrollWidth) ||
+        (scrollMatches &&
+            (parent.classList.contains("markedContent") || parent.classList.contains("k-marked-content") ||
+                getComputedStyle(parent).overflow === "hidden"))) {
+        offsetY += parent.offsetTop;
+        offsetX += parent.offsetLeft;
+        parent = parent.offsetParent;
+        if (!parent) {
+            return; // no need to scroll
+        }
+    }
+    if (spot) {
+        if (spot.top !== undefined) {
+            offsetY += spot.top;
+        }
+        if (spot.left !== undefined) {
+            offsetX += spot.left;
+            parent.scrollLeft = offsetX;
+        }
+    }
+    parent.scrollTop = offsetY;
+}
+exports.scrollIntoView = scrollIntoView;
+// /**
+//  * Helper function to start monitoring the scroll event and converting them into
+//  * PDF.js friendly one: with scroll debounce and scroll direction.
+//  */
+// function watchScroll(viewAreaElement, callback, abortSignal = undefined) {
+//   const debounceScroll = function (evt) {
+//     if (rAF) {
+//       return;
+//     }
+//     // schedule an invocation of scroll for next animation frame.
+//     rAF = window.requestAnimationFrame(function viewAreaElementScrolled() {
+//       rAF = null;
+//       const currentX = viewAreaElement.scrollLeft;
+//       const lastX = state.lastX;
+//       if (currentX !== lastX) {
+//         state.right = currentX > lastX;
+//       }
+//       state.lastX = currentX;
+//       const currentY = viewAreaElement.scrollTop;
+//       const lastY = state.lastY;
+//       if (currentY !== lastY) {
+//         state.down = currentY > lastY;
+//       }
+//       state.lastY = currentY;
+//       callback(state);
+//     });
+//   };
+//   const state = {
+//     right: true,
+//     down: true,
+//     lastX: viewAreaElement.scrollLeft,
+//     lastY: viewAreaElement.scrollTop,
+//     _eventHandler: debounceScroll,
+//   };
+//   let rAF = null;
+//   viewAreaElement.addEventListener("scroll", debounceScroll, {
+//     useCapture: true,
+//     signal: abortSignal,
+//   });
+//   abortSignal?.addEventListener(
+//     "abort",
+//     () => window.cancelAnimationFrame(rAF),
+//     { once: true }
+//   );
+//   return state;
+// }
+/**
+ * Helper function to parse query string (e.g. ?param1=value&param2=...).
+ * @param {string} query
+ * @returns {Map}
+ */
+function parseQueryString(query) {
+    const params = new Map();
+    const urlSearchParams = new URLSearchParams(query);
+    for (const [key, value] of urlSearchParams) {
+        // for (const [key, value] of new URLSearchParams(query)) {
+        params.set(key.toLowerCase(), value);
+    }
+    return params;
+}
+exports.parseQueryString = parseQueryString;
+// const InvisibleCharsRegExp = /[\x00-\x1F]/g;
+// /**
+//  * @param {string} str
+//  * @param {boolean} [replaceInvisible]
+//  */
+// function removeNullCharacters(str, replaceInvisible = false) {
+//   if (!InvisibleCharsRegExp.test(str)) {
+//     return str;
+//   }
+//   if (replaceInvisible) {
+//     return str.replaceAll(InvisibleCharsRegExp, m => (m === "\x00" ? "" : " "));
+//   }
+//   return str.replaceAll("\x00", "");
+// }
+/**
+ * Use binary search to find the index of the first item in a given array which
+ * passes a given condition. The items are expected to be sorted in the sense
+ * that if the condition is true for one item in the array, then it is also true
+ * for all following items.
+ *
+ * @returns {number} Index of the first array element to pass the test,
+ *                   or |items.length| if no such element exists.
+ */
+function binarySearchFirstItem(items, condition, start = 0) {
+    let minIndex = start;
+    let maxIndex = items.length - 1;
+    if (maxIndex < 0 || !condition(items[maxIndex])) {
+        return items.length;
+    }
+    if (condition(items[minIndex])) {
+        return minIndex;
+    }
+    while (minIndex < maxIndex) {
+        const currentIndex = (minIndex + maxIndex) >> 1;
+        const currentItem = items[currentIndex];
+        if (condition(currentItem)) {
+            maxIndex = currentIndex;
+        }
+        else {
+            minIndex = currentIndex + 1;
+        }
+    }
+    return minIndex; /* === maxIndex */
+}
+exports.binarySearchFirstItem = binarySearchFirstItem;

package/dist/npm/annotations/shared/utils.d.ts

@@ -0,0 +1,148 @@
+declare const LINE_FACTOR = 1.35;
+declare const LINE_DESCENT_FACTOR = 0.35;
+declare const BASELINE_FACTOR: number;
+/**
+ * Refer to the `WorkerTransport.getRenderingIntent`-method in the API, to see
+ * how these flags are being used:
+ *  - ANY, DISPLAY, and PRINT are the normal rendering intents, note the
+ *    `PDFPageProxy.{render, getOperatorList, getAnnotations}`-methods.
+ *  - SAVE is used, on the worker-thread, when saving modified annotations.
+ *  - ANNOTATIONS_FORMS, ANNOTATIONS_STORAGE, ANNOTATIONS_DISABLE control which
+ *    annotations are rendered onto the canvas (i.e. by being included in the
+ *    operatorList), note the `PDFPageProxy.{render, getOperatorList}`-methods
+ *    and their `annotationMode`-option.
+ *  - IS_EDITING is used when editing is active in the viewer.
+ *  - OPLIST is used with the `PDFPageProxy.getOperatorList`-method, note the
+ *    `OperatorList`-constructor (on the worker-thread).
+ */
+declare const AnnotationMode: {
+    DISABLE: number;
+    ENABLE: number;
+    ENABLE_FORMS: number;
+    ENABLE_STORAGE: number;
+};
+declare const AnnotationEditorPrefix = "pdfjs_internal_editor_";
+declare const AnnotationEditorType: {
+    DISABLE: number;
+    NONE: number;
+    FREETEXT: number;
+    HIGHLIGHT: number;
+    STAMP: number;
+    INK: number;
+};
+declare const AnnotationEditorParamsType: {
+    RESIZE: number;
+    CREATE: number;
+    FREETEXT_SIZE: number;
+    FREETEXT_COLOR: number;
+    FREETEXT_OPACITY: number;
+    INK_COLOR: number;
+    INK_THICKNESS: number;
+    INK_OPACITY: number;
+    HIGHLIGHT_COLOR: number;
+    HIGHLIGHT_DEFAULT_COLOR: number;
+    HIGHLIGHT_THICKNESS: number;
+    HIGHLIGHT_FREE: number;
+    HIGHLIGHT_SHOW_ALL: number;
+};
+declare const AnnotationType: {
+    TEXT: number;
+    LINK: number;
+    FREETEXT: number;
+    LINE: number;
+    SQUARE: number;
+    CIRCLE: number;
+    POLYGON: number;
+    POLYLINE: number;
+    HIGHLIGHT: number;
+    UNDERLINE: number;
+    SQUIGGLY: number;
+    STRIKEOUT: number;
+    STAMP: number;
+    CARET: number;
+    INK: number;
+    POPUP: number;
+    FILEATTACHMENT: number;
+    SOUND: number;
+    MOVIE: number;
+    WIDGET: number;
+    SCREEN: number;
+    PRINTERMARK: number;
+    TRAPNET: number;
+    WATERMARK: number;
+    THREED: number;
+    REDACT: number;
+};
+declare const AnnotationReplyType: {
+    GROUP: string;
+    REPLY: string;
+};
+declare const AnnotationFlag: {
+    INVISIBLE: number;
+    HIDDEN: number;
+    PRINT: number;
+    NOZOOM: number;
+    NOROTATE: number;
+    NOVIEW: number;
+    READONLY: number;
+    LOCKED: number;
+    TOGGLENOVIEW: number;
+    LOCKEDCONTENTS: number;
+};
+declare const AnnotationFieldFlag: {
+    READONLY: number;
+    REQUIRED: number;
+    NOEXPORT: number;
+    MULTILINE: number;
+    PASSWORD: number;
+    NOTOGGLETOOFF: number;
+    RADIO: number;
+    PUSHBUTTON: number;
+    COMBO: number;
+    EDIT: number;
+    SORT: number;
+    FILESELECT: number;
+    MULTISELECT: number;
+    DONOTSPELLCHECK: number;
+    DONOTSCROLL: number;
+    COMB: number;
+    RICHTEXT: number;
+    RADIOSINUNISON: number;
+    COMMITONSELCHANGE: number;
+};
+declare const AnnotationBorderStyleType: {
+    SOLID: number;
+    DASHED: number;
+    BEVELED: number;
+    INSET: number;
+    UNDERLINE: number;
+};
+declare const AnnotationActionEventType: {
+    E: string;
+    X: string;
+    D: string;
+    U: string;
+    Fo: string;
+    Bl: string;
+    PO: string;
+    PC: string;
+    PV: string;
+    PI: string;
+    K: string;
+    F: string;
+    V: string;
+    C: string;
+};
+declare function shadow(obj: any, prop: any, value: any, nonSerializable?: boolean): any;
+declare function bytesToString(bytes: any): any;
+declare function objectFromMap(map: any): any;
+declare class FeatureTest {
+    static get isCSSRoundSupported(): any;
+}
+declare class Util {
+    static makeHexColor(r: any, g: any, b: any): string;
+    static normalizeRect(rect: any): any;
+}
+declare function getUuid(): any;
+declare const AnnotationPrefix = "pdfjs_internal_id_";
+export { AnnotationActionEventType, AnnotationBorderStyleType, AnnotationEditorParamsType, AnnotationEditorPrefix, AnnotationEditorType, AnnotationFieldFlag, AnnotationFlag, AnnotationMode, AnnotationPrefix, AnnotationReplyType, AnnotationType, BASELINE_FACTOR, bytesToString, FeatureTest, getUuid, LINE_DESCENT_FACTOR, LINE_FACTOR, objectFromMap, shadow, Util };