@embedpdf/plugin-annotation 2.14.0 → 2.14.2

package/dist/shared/components/annotation-container.d.ts

@@ -26,6 +26,18 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     style?: CSSProperties;
     vertexConfig?: VertexConfig<T>;
     selectionMenu?: AnnotationSelectionMenuRenderFn;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable move/
+     * resize/rotate/delete/property-change items without recomputing flags.
+     */
+    structurallyLocked?: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable content
+     * edit items without recomputing flags.
+     */
+    contentLocked?: boolean;
     /** @deprecated Use `selectionOutline.offset` instead */
     outlineOffset?: number;
     onDoubleClick?: (event: any) => void;
@@ -55,5 +67,5 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
  * When isMultiSelected is true, the container becomes passive - drag/resize
  * is handled by the GroupSelectionBox instead.
  */
-export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
+export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, structurallyLocked, contentLocked, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
 export {};

package/dist/shared/components/types.d.ts

@@ -8,6 +8,18 @@ export interface AnnotationSelectionContext {
     type: 'annotation';
     annotation: TrackedAnnotation;
     pageIndex: number;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Consumers should disable move/resize/rotate/delete/property-change menu items
+     * when this is true.
+     */
+    structurallyLocked: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Consumers should disable content-editing menu items (e.g. FreeText text edit)
+     * when this is true.
+     */
+    contentLocked: boolean;
 }
 export type AnnotationSelectionMenuProps = SelectionMenuPropsBase<AnnotationSelectionContext>;
 export type AnnotationSelectionMenuRenderFn = SelectionMenuRenderFn<AnnotationSelectionContext>;

package/dist/shared-preact/components/annotation-container.d.ts

@@ -26,6 +26,18 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     style?: CSSProperties;
     vertexConfig?: VertexConfig<T>;
     selectionMenu?: AnnotationSelectionMenuRenderFn;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable move/
+     * resize/rotate/delete/property-change items without recomputing flags.
+     */
+    structurallyLocked?: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable content
+     * edit items without recomputing flags.
+     */
+    contentLocked?: boolean;
     /** @deprecated Use `selectionOutline.offset` instead */
     outlineOffset?: number;
     onDoubleClick?: (event: any) => void;
@@ -55,5 +67,5 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
  * When isMultiSelected is true, the container becomes passive - drag/resize
  * is handled by the GroupSelectionBox instead.
  */
-export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
+export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, structurallyLocked, contentLocked, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
 export {};

package/dist/shared-preact/components/types.d.ts

@@ -8,6 +8,18 @@ export interface AnnotationSelectionContext {
     type: 'annotation';
     annotation: TrackedAnnotation;
     pageIndex: number;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Consumers should disable move/resize/rotate/delete/property-change menu items
+     * when this is true.
+     */
+    structurallyLocked: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Consumers should disable content-editing menu items (e.g. FreeText text edit)
+     * when this is true.
+     */
+    contentLocked: boolean;
 }
 export type AnnotationSelectionMenuProps = SelectionMenuPropsBase<AnnotationSelectionContext>;
 export type AnnotationSelectionMenuRenderFn = SelectionMenuRenderFn<AnnotationSelectionContext>;

package/dist/shared-react/components/annotation-container.d.ts

@@ -26,6 +26,18 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     style?: CSSProperties;
     vertexConfig?: VertexConfig<T>;
     selectionMenu?: AnnotationSelectionMenuRenderFn;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable move/
+     * resize/rotate/delete/property-change items without recomputing flags.
+     */
+    structurallyLocked?: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable content
+     * edit items without recomputing flags.
+     */
+    contentLocked?: boolean;
     /** @deprecated Use `selectionOutline.offset` instead */
     outlineOffset?: number;
     onDoubleClick?: (event: any) => void;
@@ -55,5 +67,5 @@ interface AnnotationContainerProps<T extends PdfAnnotationObject> {
  * When isMultiSelected is true, the container becomes passive - drag/resize
  * is handled by the GroupSelectionBox instead.
  */
-export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
+export declare function AnnotationContainer<T extends PdfAnnotationObject>({ scale, documentId, pageIndex, rotation, pageWidth, pageHeight, trackedAnnotation, children, isSelected, isEditing, isMultiSelected, isDraggable, isResizable, isRotatable, lockAspectRatio, style, blendMode, vertexConfig, selectionMenu, structurallyLocked, contentLocked, outlineOffset, onDoubleClick, onSelect, appearance, zIndex, resizeUI, vertexUI, rotationUI, selectionOutlineColor, selectionOutline, customAnnotationRenderer, groupSelectionMenu: _groupSelectionMenu, groupSelectionOutline: _groupSelectionOutline, annotationRenderers: _annotationRenderers, ...props }: AnnotationContainerProps<T>): JSX.Element;
 export {};

package/dist/shared-react/components/types.d.ts

@@ -8,6 +8,18 @@ export interface AnnotationSelectionContext {
     type: 'annotation';
     annotation: TrackedAnnotation;
     pageIndex: number;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Consumers should disable move/resize/rotate/delete/property-change menu items
+     * when this is true.
+     */
+    structurallyLocked: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Consumers should disable content-editing menu items (e.g. FreeText text edit)
+     * when this is true.
+     */
+    contentLocked: boolean;
 }
 export type AnnotationSelectionMenuProps = SelectionMenuPropsBase<AnnotationSelectionContext>;
 export type AnnotationSelectionMenuRenderFn = SelectionMenuRenderFn<AnnotationSelectionContext>;

package/dist/svelte/components/types.d.ts

@@ -30,6 +30,18 @@ export interface AnnotationContainerProps<T extends PdfAnnotationObject> {
     vertexConfig?: VertexConfig<T>;
     selectionMenu?: AnnotationSelectionMenuRenderFn;
     selectionMenuSnippet?: Snippet<[AnnotationSelectionMenuProps]>;
+    /**
+     * Derived: PDF `locked` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable move/
+     * resize/rotate/delete/property-change items without recomputing flags.
+     */
+    structurallyLocked?: boolean;
+    /**
+     * Derived: PDF `lockedContents` flag is set OR the annotation is non-interactive.
+     * Threaded into the selection menu context so custom menus can disable content
+     * edit items without recomputing flags.
+     */
+    contentLocked?: boolean;
     /** @deprecated Use `selectionOutline.offset` instead */
     outlineOffset?: number;
     onDoubleClick?: (event: any) => void;