# @embedpdf/engine-core — ./public ANNOTATION_DEFAULTS [VariableDeclaration] (from packages/engine/core/src/annotation/defaults.ts): ANNOTATION_DEFAULTS ={ square: STROKE, circle: STROKE, line:{ ...STROKE, lineEndings: NO_ENDINGS, captionEnabled: false, captionPosition: 'inline'} , polygon: STROKE, polyline:{ ...STROKE, lineEndings: NO_ENDINGS} , ink: STROKE, highlight:{ ...BASE, blendMode: 'multiply', color: YELLOW, opacity: 1} , underline: MARKUP, squiggly: MARKUP, strikeout: MARKUP, caret:{ ...BASE, color: RED, opacity: 1} , 'free-text':{ ...BASE, contents: '', intent: 'free-text', fontFamily: 'helvetica', fontSize: 12, textAlign: 'left', verticalAlign: 'top', color: BLACK, fontColor: BLACK, opacity: 1, strokeWidth: 1, borderStyle: 'solid', } , text:{ ...BASE, icon: 'note', open: false, color: YELLOW, opacity: 1} , 'file-attachment':{ ...BASE, icon: 'paperclip', color: YELLOW, opacity: 1} , link: BASE, redact:{ ...BASE, quadPoints: [], color: RED, opacity: 1, repeat: false, fontFamily: 'helvetica', fontSize: 12, fontColor: BLACK, textAlign: 'left', } , stamp:{ ...BASE, fit: 'contain', opacity: 1} , widget:{ ...BASE, strokeWidth: 1, borderStyle: 'solid', textAlign: 'left'} , popup:{ ...BASE, print: false, open: false} , } satisfies{ readonly [S in WritableSubtype]: AnnotationDefaults} AbortError [ClassDeclaration] (from packages/engine/core/src/promise/AbortError.ts): export class AbortError extends EngineError{ override readonly name: string = 'AbortError'; readonly reason: unknown; constructor(reason?: unknown){ super(EngineErrorCode.Aborted, reasonMessage(reason)); this.reason = reason; } } AbortablePromise [ClassDeclaration] (from packages/engine/core/src/promise/AbortablePromise.ts): export class AbortablePromise extends Promise{ static override get [Symbol.species](): PromiseConstructor{ return Promise; } readonly signal: AbortSignal; private readonly _ctrl: AbortController; private readonly _progressCbs: Set<(p: P) => void>; private readonly _state:{ settled: boolean} ; private readonly _internalReject: (reason: unknown) => void; constructor(executor: AbortableExecutor){ const ctrl = new AbortController(); const progressCbs = new Set<(p: P) => void>(); const state ={ settled: false} ; let capturedReject!: (reason: unknown) => void; super((resolve, reject) =>{ capturedReject = reject; const wrappedResolve = (value: T | PromiseLike) =>{ if (state.settled) return; state.settled = true; resolve(value); } ; const wrappedReject = (reason: unknown) =>{ if (state.settled) return; state.settled = true; reject(reason); } ; const progress = (p: P) =>{ if (state.settled) return; for (const cb of progressCbs){ try{ cb(p); } catch{ } } } ; executor(wrappedResolve, wrappedReject, progress, ctrl.signal); } ); this._ctrl = ctrl; this.signal = ctrl.signal; this._progressCbs = progressCbs; this._state = state; this._internalReject = capturedReject; } abort(reason?: unknown): void{ if (this._state.settled) return; if (this._ctrl.signal.aborted) return; const err = reason instanceof AbortError ? reason : new AbortError(reason); this._state.settled = true; this._ctrl.abort(err); this._internalReject(err); } abortWith(signal: AbortSignal): this{ if (signal.aborted){ this.abort(signal.reason); return this; } const onAbort = () => this.abort(signal.reason); signal.addEventListener('abort', onAbort, { once: true} ); const detach = () => signal.removeEventListener('abort', onAbort); Promise.prototype.then.call(this, detach, detach); return this; } onProgress(cb: (p: P) => void): () => void{ this._progressCbs.add(cb); return () =>{ this._progressCbs.delete(cb); } ; } static resolveValue(value: T | PromiseLike): AbortablePromise{ return new AbortablePromise((resolve) => resolve(value)); } static rejectReason(reason: unknown): AbortablePromise{ return new AbortablePromise((_resolve, reject) => reject(reason)); } static run( fn: (signal: AbortSignal, progress: (p: P) => void) => Promise, ): AbortablePromise{ return new AbortablePromise((resolve, reject, progress, signal) =>{ fn(signal, progress).then(resolve, reject); } ); } } Annotation [TypeAliasDeclaration] (from packages/engine/core/src/annotation/kinds/declarations.ts): export type Annotation = ReadOf; AnnotationBundle [InterfaceDeclaration] (from packages/engine/core/src/transfer/AnnotationBundle.ts): export interface AnnotationBundle{ readonly format: 'embedpdf/annotations'; readonly version: 1; readonly pages: readonly BundlePage[]; readonly items: readonly AnnotationBundleItem[]; readonly resources: Readonly>; } AnnotationCopyOptions [InterfaceDeclaration] (from packages/engine/core/src/transfer/annotationCopy.ts): export interface AnnotationCopyOptions extends WriteOptions, AnnotationCopyPlacement{ readonly objectNumbers?: readonly number[]; } AnnotationCopyResult [InterfaceDeclaration] (from packages/engine/core/src/transfer/annotationCopy.ts): export interface AnnotationCopyResult{ annotations: Annotation[]; refMap: Array<{ from: AnnotationRef; to: AnnotationRef} >; dropped: AnnotationImportDrop[]; meta: AnnotationListMutationMeta; } AnnotationCreateOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface AnnotationCreateOptions extends WriteOptions{ readonly resources?: AnnotationResources; readonly objectNumber?: number; } AnnotationCreateResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/AnnotationMutationResults.ts): export interface AnnotationCreateResult{ annotation: Annotation; meta: AnnotationListMutationMeta; } AnnotationDefaults [TypeAliasDeclaration] (from packages/engine/core/src/annotation/defaults.ts): export type AnnotationDefaults = DefaultsOf< Extract >; AnnotationDeleteResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/AnnotationMutationResults.ts): export interface AnnotationDeleteResult{ meta: AnnotationListMutationMeta; } AnnotationDraft [TypeAliasDeclaration] (from packages/engine/core/src/annotation/kinds/declarations.ts): export type AnnotationDraft = CreateOf< WritableAnnotationDeclaration, C >; AnnotationImportResult [InterfaceDeclaration] (from packages/engine/core/src/transfer/annotationImport.ts): export interface AnnotationImportResult{ annotations: Annotation[]; refMap: Array<{ from: AnnotationRef; to: AnnotationRef} >; dropped: AnnotationImportDrop[]; meta: AnnotationListMutationMeta; } AnnotationList [InterfaceDeclaration] (from packages/engine/core/src/annotation/AnnotationList.ts): export interface AnnotationList{ annotations: Annotation[]; pages: PageRef[]; auditHead?: number; } AnnotationListOptions [InterfaceDeclaration] (from packages/engine/core/src/annotation/AnnotationList.ts): export interface AnnotationListOptions{ pages?: readonly PageRef[]; } AnnotationPatch [TypeAliasDeclaration] (from packages/engine/core/src/annotation/kinds/declarations.ts): export type AnnotationPatch = UpdateOf< WritableAnnotationDeclaration, C >; AnnotationPosition [TypeAliasDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export type AnnotationPosition = ListPosition; AnnotationRef [TypeAliasDeclaration] (from packages/engine/core/src/identity/AnnotationRef.ts): export type AnnotationRef = |{ kind: 'objectNumber'; page: PageRef; objectNumber: number; } |{ kind: 'baseIndex'; page: PageRef; baseIndex: number; } ; AnnotationReorderResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/AnnotationMutationResults.ts): export interface AnnotationReorderResult{ order: AnnotationRef[]; meta: AnnotationListMutationMeta; } AnnotationSubtype [TypeAliasDeclaration] (from packages/engine/core/src/annotation/subtype.ts): export type AnnotationSubtype = (typeof ANNOTATION_SUBTYPES)[number]; AnnotationTransfer [VariableDeclaration] (from packages/engine/core/src/transfer/AnnotationTransfer.ts): AnnotationTransfer = bundleCodec({ kind: 'annotation', keys: ANNOTATION_BUNDLE_KEYS, assertManifest: assertAnnotationBundleManifest, } ) AnnotationUpdateOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface AnnotationUpdateOptions extends WriteOptions{ readonly resources?: AnnotationResources; } AnnotationUpdateResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/AnnotationMutationResults.ts): export interface AnnotationUpdateResult{ annotation: Annotation; appearance: AppearanceOutcome; meta: AnnotationListMutationMeta; } AreaUnit [TypeAliasDeclaration] (from packages/engine/core/src/measure/units.ts): export type AreaUnit = `${ LengthUnit} 2` | 'ha' | 'acre'; Attachment [InterfaceDeclaration] (from packages/engine/core/src/dto/Attachment.ts): export interface Attachment extends AttachmentFileInfo{ ref: AttachmentRef; index: number; } AttachmentList [InterfaceDeclaration] (from packages/engine/core/src/dto/Attachment.ts): export interface AttachmentList{ attachments: Attachment[]; } AttachmentRef [TypeAliasDeclaration] (from packages/engine/core/src/dto/Attachment.ts): export type AttachmentRef ={ kind: 'key'; key: string} ; CallFacts [InterfaceDeclaration] (from packages/engine/core/src/scheduling/facts.ts): export interface CallFacts{ readonly priority?: CallPriority; readonly view?: string; } CallPriority [TypeAliasDeclaration] (from packages/engine/core/src/scheduling/facts.ts): export type CallPriority = 'high' | 'auto' | 'low'; Change [TypeAliasDeclaration] (from packages/engine/core/src/mutation/Change.ts): export type Change = |{ readonly ops: readonly ChangeOp[]} |{ readonly undoOf: string} ; ChangeItem [TypeAliasDeclaration] (from packages/engine/core/src/mutation/Change.ts): export type ChangeItem = | ({ type: 'annotations.create'; page: PageRef} & AnnotationCreateResult) | ({ type: 'annotations.update'; page: PageRef; skipped?: readonly string[]; } & AnnotationUpdateResult) | ({ type: 'annotations.delete'; page: PageRef} & AnnotationDeleteResult) | ({ type: 'annotations.reorder'; page: PageRef} & AnnotationReorderResult) | ({ type: 'annotations.copy'} & AnnotationCopyResult) | ({ type: 'annotations.import'} & AnnotationImportResult) | ({ type: 'forms.import'} & FormImportResult) | ({ type: 'forms.importValues'} & FormValuesImportResult) |{ type: 'annotations.restore'; page: PageRef; annotations: Annotation[]; meta: AnnotationListMutationMeta; } | ({ type: 'forms.setValue'} & FormSetValueResult) | ({ type: 'forms.setDisplay'} & FormFieldUpdateResult) | ({ type: 'forms.setAppearanceText'} & FormFieldUpdateResult) | ({ type: 'forms.reset'; skipped?: readonly string[]; } & FormResetResult) | ({ type: 'forms.create'} & FormFieldCreateResult) | ({ type: 'forms.copy'} & FormCopyResult) | ({ type: 'forms.update'; skipped?: readonly string[]; } & FormFieldUpdateResult) | ({ type: 'forms.delete'} & FormFieldDeleteResult) |{ type: 'forms.restore'; field: FormField; widgets: WidgetAnnotation[]; meta: FormMutationMeta; } | ({ type: 'forms.setSignatureAppearance'} & FormFieldUpdateResult) | ({ type: 'forms.addWidget'} & FormWidgetLinkResult) | ({ type: 'forms.removeWidget'} & FormWidgetLinkResult) | ({ type: 'forms.deleteWidget'} & FormWidgetDeleteResult) | ({ type: 'forms.restoreWidget'} & FormWidgetRestoreResult) | ({ type: 'forms.reorderWidgets'} & FormWidgetsReorderResult) | ({ type: 'forms.reorderCalculations'} & FormCalculationsReorderResult) | ({ type: 'forms.updateWidget'; skipped?: readonly string[]; } & FormWidgetUpdateResult) | ({ type: 'metadata.update'; skipped?: readonly string[]; } & MetadataUpdateResult) | ({ type: 'metadata.updateCustom'; skipped?: readonly string[]; } & CustomMetadataUpdateResult) | ({ type: 'outline.create'} & OutlineCreateResult) | ({ type: 'outline.update'; skipped?: readonly string[]; } & OutlineUpdateResult) | ({ type: 'outline.move'} & OutlineMoveResult) | ({ type: 'outline.delete'} & OutlineDeleteResult) | ({ type: 'outline.restore'} & OutlineRestoreResult) | ({ type: 'pages.rotate'; pages: PageRef[]; rotation: PdfRotation; } & PageRotateResult) | ({ type: 'pages.setScale'; pages: PageRef[]; measure: PdfMeasure | null; } & PageScaleResult) | ({ type: 'pages.reorder'} & PageReorderResult) | ({ type: 'pages.delete'; pages: PageRef[]; } & PageDeleteResult) | ({ type: 'pages.insertBlank'} & PageInsertResult) | ({ type: 'pages.insert'} & PageInsertResult) | ({ type: 'pages.copy'} & PageInsertResult) | ({ type: 'pages.restore'} & PageRestoreResult) | ({ type: 'attachments.create'} & AttachmentCreateResult) | ({ type: 'attachments.delete'} & AttachmentDeleteResult) | ({ type: 'attachments.restore'} & AttachmentRestoreResult) | SkippedChangeItem; ChangeItemType [TypeAliasDeclaration] (from packages/engine/core/src/mutation/Change.ts): export type ChangeItemType = | RecordedOp['type'] | 'annotations.restore' | 'forms.restore' | 'forms.restoreWidget' | 'outline.restore' | 'pages.restore' | 'attachments.restore'; ChangeOp [TypeAliasDeclaration] (from packages/engine/core/src/mutation/Change.ts): export type ChangeOp = |{ readonly type: 'annotations.create'; readonly page: PageRef; readonly data: AnnotationDraft; readonly objectNumber?: number; readonly resources?: R; } |{ readonly type: 'annotations.update'; readonly ref: AnnotationRef; readonly patch: AnnotationPatch; readonly resources?: R; readonly expect?: AnnotationPatch; } |{ readonly type: 'annotations.delete'; readonly ref: AnnotationRef; readonly expect?: AnnotationPatch; } |{ readonly type: 'annotations.reorder'; readonly page: PageRef; readonly refs: readonly AnnotationRef[]; readonly position: AnnotationPosition; } |{ readonly type: 'annotations.copy'; readonly refs: readonly AnnotationRef[]; readonly page?: PageRef; readonly offset?:{ readonly x: number; readonly y: number} ; readonly objectNumbers?: readonly number[]; } |{ readonly type: 'forms.setValue'; readonly field: FormFieldRef; readonly value: FormFieldValue; readonly expect?: FormFieldValue; } |{ readonly type: 'forms.setDisplay'; readonly field: FormFieldRef; readonly display: FormFieldDisplay; } |{ readonly type: 'forms.setAppearanceText'; readonly field: FormFieldRef; readonly text: string; } |{ readonly type: 'forms.reset'; readonly fields?: readonly FormFieldRef[]; } |{ readonly type: 'forms.create'; readonly draft: FormFieldDraft; readonly objectNumber?: number; readonly widgetObjectNumbers?: readonly number[]; } |{ readonly type: 'forms.copy'; readonly fields: readonly FormFieldRef[]; readonly widgets?: readonly AnnotationRef[]; readonly page?: PageRef; readonly offset?:{ readonly x: number; readonly y: number} ; readonly values?: boolean; readonly objectNumbers?: readonly number[]; } |{ readonly type: 'forms.update'; readonly field: FormFieldRef; readonly patch: FormFieldPatch; readonly expect?: FormFieldPatch; } |{ readonly type: 'forms.delete'; readonly field: FormFieldRef; readonly expect?: FormFieldPatch; } |{ readonly type: 'forms.addWidget'; readonly field: FormFieldRef; readonly placement: WidgetPlacement; readonly objectNumber?: number; readonly splitObjectNumber?: number; } |{ readonly type: 'forms.removeWidget'; readonly field: FormFieldRef; readonly widget: AnnotationRef; } |{ readonly type: 'forms.deleteWidget'; readonly widget: AnnotationRef; readonly expect?: WidgetPatch; } |{ readonly type: 'forms.reorderCalculations'; readonly fields: readonly FormFieldRef[]; readonly position: FieldPosition; } |{ readonly type: 'forms.reorderWidgets'; readonly page: PageRef; readonly widgets: readonly AnnotationRef[]; readonly position: AnnotationPosition; } |{ readonly type: 'forms.updateWidget'; readonly widget: AnnotationRef; readonly patch: WidgetPatch; readonly expect?: WidgetPatch; } |{ readonly type: 'forms.setSignatureAppearance'; readonly field: FormFieldRef; readonly appearance: SignatureAppearanceInput; } |{ readonly type: 'metadata.update'; readonly patch: MetadataPatch; readonly expect?: MetadataPatch; } |{ readonly type: 'metadata.updateCustom'; readonly patch: CustomMetadataPatch; } |{ readonly type: 'outline.create'; readonly parent: OutlineItemRef | null; readonly position?: OutlinePosition; readonly data: OutlineItemDraft; readonly objectNumber?: number; } |{ readonly type: 'outline.update'; readonly ref: OutlineItemRef; readonly patch: OutlineItemPatch; readonly expect?: OutlineItemPatch; } |{ readonly type: 'outline.move'; readonly refs: readonly OutlineItemRef[]; readonly parent: OutlineItemRef | null; readonly position: OutlinePosition; } |{ readonly type: 'outline.delete'; readonly ref: OutlineItemRef; readonly expect?: OutlineItemPatch; } |{ readonly type: 'pages.rotate'; readonly pages: readonly PageRef[]; readonly rotation: PdfRotation; } |{ readonly type: 'pages.setScale'; readonly pages: readonly PageRef[]; readonly measure: PdfMeasure | null; } |{ readonly type: 'pages.reorder'; readonly pages: readonly PageRef[]; readonly position: PagePosition; } |{ readonly type: 'pages.delete'; readonly pages: readonly PageRef[]; } |{ readonly type: 'pages.insertBlank'; readonly spec: PageInsertBlankSpec; readonly position?: PagePosition; readonly objectNumbers?: readonly number[]; } |{ readonly type: 'pages.insert'; readonly source: Uint8Array; readonly position?: PagePosition; readonly objectNumbers?: readonly number[]; } |{ readonly type: 'pages.copy'; readonly pages: readonly PageRef[]; readonly position?: PagePosition; readonly objectNumbers?: readonly number[]; } |{ readonly type: 'attachments.create'; readonly file: AttachmentFileBase; readonly resources: R; } |{ readonly type: 'attachments.delete'; readonly ref: AttachmentRef} ; ChangeResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/Change.ts): export interface ChangeResult{ items: ChangeItem[]; meta: MutationMeta; } CodePointRange [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface CodePointRange{ start: number; count: number; } CommentThread [InterfaceDeclaration] (from packages/engine/core/src/annotation/comments.ts): export interface CommentThread{ root: T; page: PageRef; replies: T[]; groupedParts: T[]; review: CommentThreadReview; } CustomMetadataService [InterfaceDeclaration] (from packages/engine/core/src/engine/CustomMetadataService.ts): export interface CustomMetadataService{ get(): AbortablePromise; update( patch: CustomMetadataPatch, options?: WriteOptions, ): AbortablePromise; } DocCapability [TypeAliasDeclaration] (from packages/engine/core/src/auth/scope/types.ts): export type DocCapability = | 'doc.open' | 'doc.render' | 'doc.text.copy' | 'doc.text.search' | 'doc.content.copy' | 'doc.download' | 'doc.download.flattened' | 'doc.print' | 'doc.print.high' | 'doc.pages.modify' | 'doc.pages.assemble' | 'doc.forms.read' | 'doc.forms.fill' | 'doc.forms.modify' | 'doc.forms.import' | 'doc.forms.script' | 'doc.forms.submit' | 'doc.annotate.read' | 'doc.annotate.modify' | 'doc.annotate.import' | 'doc.metadata.modify' | 'doc.attachments.modify' | 'doc.outline.modify' | 'doc.redact' | 'doc.sign' | 'doc.sign.certify'; DocumentAccessInfo [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentSecurityService.ts): export interface DocumentAccessInfo{ readonly cdn: CdnAccessInfo; readonly passwordGrant: string | null; readonly pdfPermissions: PdfPermissionInfo | null; readonly scope: string[]; readonly effectiveScope: string[]; readonly protection: DocumentProtection | null; readonly identity: Identity; readonly originPasswordPolicy:{ readonly mode: 'not-needed' | 'client-retry' | 'server-session'; } ; readonly expiresAt: IsoDateTime; readonly renderPolicy?:{ readonly fullPage:{ readonly widths: readonly number[]} ; readonly tiles?:{ readonly tileSizes: readonly number[]; readonly scales: readonly number[]; } ; readonly appearances?:{ readonly scales: readonly number[]} ; readonly maxRenderPixels?: number; readonly formats: readonly ('webp' | 'png')[]; readonly background: 'white'; readonly enforced: boolean; } ; readonly bundleLimits: BundleLimits; readonly edit?: EditSessionAccess; } DocumentAnnotationsService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentAnnotationsService.ts): export interface DocumentAnnotationsService{ list(options?: AnnotationListOptions): AbortablePromise; export(selection?: AnnotationExportSelection): AbortablePromise; import( bundle: AnnotationBundle, options?: AnnotationImportOptions, ): AbortablePromise; copy( refs: readonly AnnotationRef[], options?: AnnotationCopyOptions, ): AbortablePromise; } DocumentEvent [TypeAliasDeclaration] (from packages/engine/core/src/events/DocumentEvent.ts): export type DocumentEvent = | ({ type: 'pages.scaleSet'; origin: EventOrigin; pages: PageRef[]; measure: PdfMeasure | null; } & PageScaleResult) | ({ type: 'annotations.created'; page: PageRef; origin: EventOrigin; } & AnnotationCreateResult) | ({ type: 'annotations.updated'; page: PageRef; origin: EventOrigin; } & AnnotationUpdateResult) | ({ type: 'annotations.deleted'; page: PageRef; origin: EventOrigin; deleted: AnnotationRef[]; } & AnnotationDeleteResult) | ({ type: 'annotations.reordered'; page: PageRef; origin: EventOrigin; } & AnnotationReorderResult) |{ type: 'annotations.restored'; page: PageRef; origin: EventOrigin; annotations: Annotation[]; meta: AnnotationListMutationMeta; } | ({ type: 'annotations.flattened'; origin: EventOrigin; } & AnnotationFlattenResult) | ({ type: 'pages.reordered'; origin: EventOrigin} & PageReorderResult) | ({ type: 'pages.rotated'; pages: PageRef[]; rotation: PdfRotation; origin: EventOrigin; } & PageRotateResult) | ({ type: 'pages.deleted'; pages: PageRef[]; origin: EventOrigin; } & PageDeleteResult) | ({ type: 'pages.inserted'; origin: EventOrigin} & PageInsertResult) | ({ type: 'pages.restored'; origin: EventOrigin} & PageRestoreResult) | ({ type: 'pages.named'; name: string; page: PageRef | null; origin: EventOrigin; } & PageNameResult) | ({ type: 'attachments.created'; origin: EventOrigin} & AttachmentCreateResult) | ({ type: 'attachments.deleted'; origin: EventOrigin; deleted: AttachmentRef | null; } & AttachmentDeleteResult) |{ type: 'fonts.changed'; origin: EventOrigin; } | ({ type: 'attachments.restored'; origin: EventOrigin} & AttachmentRestoreResult) | ({ type: 'metadata.updated'; origin: EventOrigin} & MetadataUpdateResult) | ({ type: 'metadata.customUpdated'; origin: EventOrigin} & CustomMetadataUpdateResult) | ({ type: 'outline.created'; origin: EventOrigin} & OutlineCreateResult) | ({ type: 'outline.updated'; origin: EventOrigin} & OutlineUpdateResult) | ({ type: 'outline.moved'; origin: EventOrigin} & OutlineMoveResult) | ({ type: 'outline.deleted'; origin: EventOrigin; deleted: OutlineItemRef[]; } & OutlineDeleteResult) | ({ type: 'outline.restored'; origin: EventOrigin; } & OutlineRestoreResult) | ({ type: 'forms.valueSet'; origin: EventOrigin} & FormSetValueResult) | ({ type: 'forms.repaired'; origin: EventOrigin} & FormRepairResult) | ({ type: 'forms.created'; origin: EventOrigin} & FormFieldCreateResult) | ({ type: 'forms.updated'; origin: EventOrigin} & FormFieldUpdateResult) | ({ type: 'forms.deleted'; origin: EventOrigin; deleted: FormFieldRef | null; } & FormFieldDeleteResult) |{ type: 'forms.restored'; origin: EventOrigin; field: FormField; widgets: WidgetAnnotation[]; meta: FormMutationMeta; } | ({ type: 'forms.widgetAdded'; origin: EventOrigin} & FormWidgetLinkResult) | ({ type: 'forms.widgetRemoved'; origin: EventOrigin} & FormWidgetLinkResult) | ({ type: 'forms.widgetDeleted'; origin: EventOrigin} & FormWidgetDeleteResult) | ({ type: 'forms.widgetRestored'; origin: EventOrigin; } & FormWidgetRestoreResult) | ({ type: 'forms.widgetUpdated'; origin: EventOrigin} & FormWidgetUpdateResult) | ({ type: 'forms.widgetsReordered'; origin: EventOrigin; } & FormWidgetsReorderResult) | ({ type: 'forms.calculationsReordered'; origin: EventOrigin; } & FormCalculationsReorderResult) | ({ type: 'pages.flattened'; pages: PageRef[]; usage: PageFlattenUsage; origin: EventOrigin; } & PageFlattenResult) | ({ type: 'redaction.applied'; origin: EventOrigin; } & RedactionApplyResult) | ({ type: 'signatures.prepared'; field: FormFieldRef; origin: EventOrigin; } & SignaturePrepared) | ({ type: 'signatures.completed'; signingId: string; origin: EventOrigin; } & SignatureCompleteResult) |{ type: 'signatures.cancelled'; signingId: string; origin: EventOrigin; } | ({ type: 'signatures.validationInfoAdded'; origin: EventOrigin; } & ValidationInfoAddResult) |{ type: 'document.versioned'; version: BaseVersionInfo; origin: EventOrigin; } |{ type: 'stream.desynced'; reason: 'backlog-overflow' | 'unknown-change'; at: string; } ; DocumentEventOf [TypeAliasDeclaration] (from packages/engine/core/src/events/DocumentEvent.ts): export type DocumentEventOf = Extract; DocumentEventType [TypeAliasDeclaration] (from packages/engine/core/src/events/DocumentEvent.ts): export type DocumentEventType = DocumentEvent['type']; DocumentFontsService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentFontsService.ts): export interface DocumentFontsService{ list(): AbortablePromise; resolve(request: FontResolveRequest): AbortablePromise; getProgram(displaySha256: string): AbortablePromise; downloadProgram(displaySha256: string): AbortablePromise; } DocumentGrant [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentHandle.ts): export interface DocumentGrant{ readonly layerMode: 'shared' | 'per-visitor'; readonly keep: boolean; readonly identityRequest: VisitorIdentityRequest | null; identify(answers: VisitorAnswers): AbortablePromise; onIdentityRequested(listener: (request: VisitorIdentityRequest) => void): () => void; decline(): void; readonly openRequest: GrantOpenRequest | null; onOpenRequested(listener: (request: GrantOpenRequest) => void): () => void; resume(given:{ readonly passphrase?: string; readonly visitorIdentity?: VisitorAnswers; } ): AbortablePromise; } DocumentHandle [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentHandle.ts): export interface DocumentHandle{ readonly id: string; readonly security: DocumentSecurityService; readonly metadata: MetadataService; readonly annotations: DocumentAnnotationsService; readonly actions: DocumentActionsService; readonly attachments: DocumentAttachmentsService; readonly forms: DocumentFormsService; readonly fonts: DocumentFontsService; readonly outline: DocumentOutlineService; readonly search: DocumentSearchService; readonly render: DocumentRenderService; readonly pages: DocumentPagesService; readonly redaction: DocumentRedactionService; readonly signatures: DocumentSignaturesService; readonly events: DocumentEventStream; readonly objectNumbers: ObjectNumberPool; readonly grant?: DocumentGrant; page(ref: PageRef): PageHandle; apply(change: Change, options?: WriteOptions): AbortablePromise; with(facts: CallFacts): DocumentHandle; setWorkingSet(view: string, pages: readonly WorkingSetPage[]): void; download(options?: DownloadOptions): AbortablePromise; close(): AbortablePromise; } DocumentOutline [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface DocumentOutline{ items: OutlineItem[]; incomplete: boolean; } DocumentOutlineService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentOutlineService.ts): export interface DocumentOutlineService{ get(): AbortablePromise; create( data: OutlineItemDraft, options?: OutlineCreateOptions, ): AbortablePromise; update( ref: OutlineItemRef, patch: OutlineItemPatch, options?: WriteOptions, ): AbortablePromise; move( refs: readonly OutlineItemRef[], parent: OutlineItemRef | null, position: OutlinePosition, options?: WriteOptions, ): AbortablePromise; delete(ref: OutlineItemRef, options?: WriteOptions): AbortablePromise; } DocumentPagesService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentPagesService.ts): export interface DocumentPagesService{ list(): AbortablePromise; reorder( pages: PageRef[], position: PagePosition, options?: WriteOptions, ): AbortablePromise; rotate( pages: PageRef[], rotation: PdfRotation, options?: WriteOptions, ): AbortablePromise; setScale( pages: PageRef[], measure: PdfMeasure | null, options?: WriteOptions, ): AbortablePromise; delete(pages: PageRef[], options?: WriteOptions): AbortablePromise; setName(input: PageNameInput, options?: WriteOptions): AbortablePromise; removeName(input: PageRemoveNameInput, options?: WriteOptions): AbortablePromise; flatten(pages: PageRef[], options?: FlattenWriteOptions): AbortablePromise; extract(pages: PageRef[], options?: PageExtractOptions): AbortablePromise; insert( bytes: Uint8Array | ArrayBuffer, position?: PagePosition, options?: PageInsertOptions, ): AbortablePromise; insertBlank( spec: PageInsertBlankSpec, position?: PagePosition, options?: PageInsertOptions, ): AbortablePromise; copy( pages: PageRef[], position?: PagePosition, options?: PageInsertOptions, ): AbortablePromise; } DocumentSecurityService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentSecurityService.ts): export interface DocumentSecurityService{ readonly state: DocumentSecurityState; readonly scope: ReadonlyArray; allows(capability: DocCapability | PluginPermission): boolean; allowsAnnotation(action: 'create'): boolean; allowsAnnotation(action: 'update' | 'delete', annotation: AnnotationOwner): boolean; allowsAnnotation(action: 'set-group', target:{ groupId: string} ): boolean; allowsField(action: 'fill' | 'sign', field:{ groupId: string | null} ): boolean; allowsField(action: 'set-group', target:{ groupId: string} ): boolean; fieldRights(): FieldRights; readonly identity: Identity | null; readonly passwordPrompt: import('./passwordPrompt').PasswordPrompt; unlock(input: DocumentUnlockInput): AbortablePromise; } DocumentSecurityState [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentSecurityService.ts): export interface DocumentSecurityState{ readonly encryption:{ readonly state: DocumentEncryptionState; readonly requiresPassword: boolean | null; } ; readonly permissions:{ readonly known: boolean; readonly flags: PdfPermissionFlags | null; readonly allAllowed: boolean | null; readonly openedAs: DocumentOpenMode | null; readonly securityHandlerRevision: number | null; readonly canUpgradeToOwner: boolean; } ; readonly access:{ readonly required: boolean; readonly reasons: DocumentAccessReason[]; readonly endpoint?: string; } ; } DocumentUnlockInput [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentSecurityService.ts): export interface DocumentUnlockInput{ readonly password: string; readonly mode?: 'any' | 'owner'; } DocumentUnlockResult [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentSecurityService.ts): export interface DocumentUnlockResult{ readonly security: DocumentSecurityState; readonly access?: DocumentAccessInfo; } DownloadOptions [InterfaceDeclaration] (from packages/engine/core/src/dto/PdfSaveMode.ts): export interface DownloadOptions{ mode?: PdfSaveMode; } DraftAttribution [TypeAliasDeclaration] (from packages/engine/core/src/annotation/resolve/annotationOfDraft.ts): export type DraftAttribution = Readonly< Partial< Record<'author' | 'userId' | 'createdBy' | 'modifiedBy' | 'createdAt' | 'modifiedAt', string> > >; DraftContext [InterfaceDeclaration] (from packages/engine/core/src/annotation/resolve/annotationOfDraft.ts): export interface DraftContext{ readonly ref: AnnotationRef; readonly nm?: string; readonly attribution?: DraftAttribution; readonly rect?: Box; readonly describeFont?: DescribeFont; } Engine [InterfaceDeclaration] (from packages/engine/core/src/engine/Engine.ts): export interface Engine{ readonly canOpenFiles: boolean; open(input: OpenInput, options?: OpenOptions): AbortablePromise; destroy(): AbortablePromise; } EngineError [ClassDeclaration] (from packages/engine/core/src/errors/EngineError.ts): export class EngineError extends Error{ override readonly name: string = 'EngineError'; readonly code: EngineErrorCode; readonly details?: Record; constructor(code: EngineErrorCode, message?: string, options: EngineErrorOptions ={ } ){ super(message ?? code, options.cause === undefined ? undefined :{ cause: options.cause} ); this.code = code; this.details = options.details; } static is(value: unknown, code?: EngineErrorCode): value is EngineError{ if ( !(value instanceof EngineError) && (value as{ name?: string} | null)?.name !== 'EngineError' ){ return false; } if (code === undefined) return true; return (value as EngineError).code === code; } toJSON(): SerializedEngineError{ return{ code: this.code, message: this.message, details: this.details, } ; } } EngineErrorCode [VariableDeclaration] (from packages/engine/core/src/errors/EngineErrorCode.ts): EngineErrorCode ={ Unknown: 'Unknown', InvalidArg: 'InvalidArg', DocNotOpen: 'DocNotOpen', DocOpenFailed: 'DocOpenFailed', DocPasswordRequired: 'DocPasswordRequired', DocPasswordIncorrect: 'DocPasswordIncorrect', GrantPassphraseRequired: 'GrantPassphraseRequired', Aborted: 'Aborted', Network: 'Network', Unauthenticated: 'Unauthenticated', Forbidden: 'Forbidden', NotFound: 'NotFound', WireFormat: 'WireFormat', RuntimeUnavailable: 'RuntimeUnavailable', LayerVersionConflict: 'LayerVersionConflict', NotImplemented: 'NotImplemented', MalformedPdf: 'MalformedPdf', SigningPending: 'SigningPending', SigningExpired: 'SigningExpired', SigningVersionMismatch: 'SigningVersionMismatch', SignatureRefused: 'SignatureRefused', ProtectedDocument: 'ProtectedDocument', PayloadTooLarge: 'PayloadTooLarge', ObjectNumberUnavailable: 'ObjectNumberUnavailable', LayerFull: 'LayerFull', ChangeConflict: 'ChangeConflict', UndoUnavailable: 'UndoUnavailable', IdempotencyKeyReused: 'IdempotencyKeyReused', LayerDeleted: 'LayerDeleted', VisitorIdentityRequired: 'VisitorIdentityRequired', Conflict: 'Conflict', EngineBusy: 'EngineBusy', EngineRestarting: 'EngineRestarting', DocumentQuarantined: 'DocumentQuarantined', ThumbnailNotReady: 'ThumbnailNotReady', TooManyRequests: 'TooManyRequests', GrantExpired: 'GrantExpired', OriginRequired: 'OriginRequired', OriginNotAllowed: 'OriginNotAllowed', FeatureNotEnabled: 'FeatureNotEnabled', FeatureStopped: 'FeatureStopped', LicenseInvalid: 'LicenseInvalid', LicenseUsageLimit: 'LicenseUsageLimit', UpstreamError: 'UpstreamError', } as const EngineFactory [TypeAliasDeclaration] (from packages/engine/core/src/engine/Engine.ts): export type EngineFactory = () => Engine; EventOrigin [InterfaceDeclaration] (from packages/engine/core/src/events/DocumentEvent.ts): export interface EventOrigin{ kind: 'local' | 'remote'; sessionId: string; subject: string | null; at: string; serverSequence: number | null; transaction?:{ id: string; index: number; count: number} ; undoOf?: string; } FlattenOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/PageFlattenResult.ts): export interface FlattenOptions{ usage?: PageFlattenUsage; } FlattenWriteOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface FlattenWriteOptions extends FlattenOptions, WriteOptions{ } Font [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface Font{ name: FontName; source: FontSource; builtIn: boolean; familyName: string; weight: number; italic: boolean; postScriptName: string | null; canChoose: boolean; restrictions: FontRestriction[]; programs: FontProgram[]; } FontEmbeddingPolicy [TypeAliasDeclaration] (from packages/engine/core/src/engine/DocumentFontsService.ts): export type FontEmbeddingPolicy = 'default' | 'subset' | 'full'; FontFormat [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export type FontFormat = 'truetype' | 'opentype' | 'cff' | 'type1' | 'type3'; FontList [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface FontList{ fonts: Font[]; fallbacks: FontName[]; lastResort: FontProgram; } FontName [TypeAliasDeclaration] (from packages/engine/core/src/annotation/primitives.ts): export type FontName = StandardFont | (string &{ } ); FontProgram [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface FontProgram{ displaySha256: string | null; sourceSha256: string | null; embedded: 'whole' | 'subset' | 'none'; format: FontFormat | null; embeddingPermission: FontEmbeddingPermission | null; canDownload: boolean; } FontProgramInfo [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface FontProgramInfo extends FontProgram{ covers: CodePointRange[]; ascent: number; descent: number; } FontResolution [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface FontResolution{ runs: ResolvedFontRun[]; missingCharacters: string[]; } FontResolveRequest [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface FontResolveRequest{ annotation?: AnnotationRef; runs: FontResolveRun[]; } FontResolveRun [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export type FontResolveRun = |{ text: string; fontFamily: FontName} |{ text: string; family: string; weight: number; italic: boolean} ; FontRestriction [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export type FontRestriction = | 'subset' | 'not-embedded' | 'preview-and-print' | 'unsupported-format' | 'no-unicode-map' | 'not-served'; FontSource [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export type FontSource = 'standard' | 'engine' | 'document'; FormBundle [InterfaceDeclaration] (from packages/engine/core/src/transfer/FormBundle.ts): export interface FormBundle{ readonly format: 'embedpdf/form'; readonly version: 1; readonly pages: readonly BundlePage[]; readonly fields: readonly FormBundleField[]; readonly widgets: readonly FormBundleWidget[]; readonly calculationOrder: readonly FormFieldRef[]; readonly resources: Readonly>; } FormCopyOptions [InterfaceDeclaration] (from packages/engine/core/src/transfer/formCopy.ts): export interface FormCopyOptions extends WriteOptions, FormCopyPlacement{ readonly widgets?: readonly AnnotationRef[]; readonly values?: boolean; readonly objectNumbers?: readonly number[]; } FormCopyResult [InterfaceDeclaration] (from packages/engine/core/src/transfer/formCopy.ts): export interface FormCopyResult{ fields: FormField[]; widgets: WidgetAnnotation[]; refMap: Array<{ from: FormFieldRef; to: FormFieldRef} >; dropped: FormImportDrop[]; calculationOrder?: FormFieldRef[]; meta: FormMutationMeta; } FormField [TypeAliasDeclaration] (from packages/engine/core/src/forms/field.ts): export type FormField = | TextField | CheckboxField | RadioField | ComboBoxField | ListBoxField | PushButtonField | SignatureField | UnknownField; FormFieldCreateOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface FormFieldCreateOptions extends WriteOptions{ readonly objectNumber?: number; readonly widgetObjectNumbers?: readonly number[]; } FormFieldRef [TypeAliasDeclaration] (from packages/engine/core/src/identity/FormFieldRef.ts): export type FormFieldRef = |{ kind: 'objectNumber'; objectNumber: number} |{ kind: 'fqn'; name: string} ; FormImportResult [InterfaceDeclaration] (from packages/engine/core/src/transfer/formImport.ts): export interface FormImportResult{ fields: FormField[]; widgets: WidgetAnnotation[]; refMap: Array<{ from: FormFieldRef; to: FormFieldRef} >; dropped: FormImportDrop[]; calculationOrder?: FormFieldRef[]; meta: FormMutationMeta; } FormTransfer [VariableDeclaration] (from packages/engine/core/src/transfer/FormTransfer.ts): FormTransfer = bundleCodec({ kind: 'form', keys: FORM_BUNDLE_KEYS, assertManifest: assertFormBundleManifest, } ) FormValuesImportResult [InterfaceDeclaration] (from packages/engine/core/src/transfer/formImport.ts): export interface FormValuesImportResult{ fields: FormField[]; widgets: WidgetAnnotation[]; dropped: FormValuesImportDrop[]; meta: FormMutationMeta; } FormWidgetAddOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface FormWidgetAddOptions extends WriteOptions{ readonly objectNumber?: number; readonly splitObjectNumber?: number; } GrantOpenRequest [TypeAliasDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export type GrantOpenRequest = |{ readonly kind: 'passphrase'; readonly passphraseProvided: boolean} |{ readonly kind: 'identity'; readonly request: VisitorIdentityRequest} ; Identity [InterfaceDeclaration] (from packages/engine/core/src/auth/scope/types.ts): export interface Identity{ readonly userId?: string; readonly displayName?: string; readonly email?: string; readonly title?: string; readonly organization?: string; readonly organizationalUnit?: string; readonly groupId?: string; } ImageSource [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface ImageSource{ objectUrl(): AbortablePromise; blob(): AbortablePromise; } LengthUnit [TypeAliasDeclaration] (from packages/engine/core/src/measure/units.ts): export type LengthUnit = keyof typeof METRES; ListPosition [TypeAliasDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export type ListPosition = |{ readonly before: Ref} |{ readonly after: Ref} | 'start' | 'end'; LocalDocumentFontsService [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentFontsService.ts): export interface LocalDocumentFontsService extends DocumentFontsService{ setEmbeddingPolicy(policy: FontEmbeddingPolicy): AbortablePromise; setTypographicFeatures(enabled: boolean): AbortablePromise; } LocalDocumentHandle [InterfaceDeclaration] (from packages/engine/core/src/engine/LocalDocumentHandle.ts): export interface LocalDocumentHandle extends DocumentHandle{ readonly fonts: LocalDocumentFontsService; readonly pieceInfo: PieceInfoService; page(ref: PageRef): LocalPageHandle; with(facts: CallFacts): LocalDocumentHandle; downloadToFile(path: string, options?: DownloadOptions): AbortablePromise; version(): AbortablePromise; downloadLayer(): AbortablePromise; } LocalEngine [InterfaceDeclaration] (from packages/engine/core/src/engine/LocalEngine.ts): export interface LocalEngine extends Engine{ open(input: OpenInput, options?: OpenOptions): AbortablePromise; warmup(): void; readonly fonts: FontService; } LocalPageAnnotationsService [InterfaceDeclaration] (from packages/engine/core/src/engine/PageAnnotationsService.ts): export interface LocalPageAnnotationsService extends PageAnnotationsService{ renderAppearancesRaw( options?: AnnotationAppearanceRenderOptions, ): AbortablePromise; } LocalPageHandle [InterfaceDeclaration] (from packages/engine/core/src/engine/LocalPageHandle.ts): export interface LocalPageHandle extends PageHandle{ readonly annotations: LocalPageAnnotationsService; readonly forms: LocalPageFormsService; readonly render: RawPageRenderService; readonly pieceInfo: PieceInfoService; } MeasureFromRatioOptions [InterfaceDeclaration] (from packages/engine/core/src/measure/calibrate.ts): export interface MeasureFromRatioOptions extends MeasurementFormatOptions{ userUnit?: number; } MeasurementFormatOptions [InterfaceDeclaration] (from packages/engine/core/src/measure/calibrate.ts): export interface MeasurementFormatOptions{ precision?: number; fixed?: boolean; areaUnit?: AreaUnit; imperialFeetInches?: boolean; fractionalPrecision?: number; } MetadataService [InterfaceDeclaration] (from packages/engine/core/src/engine/MetadataService.ts): export interface MetadataService{ get(): AbortablePromise; update(patch: MetadataPatch, options?: WriteOptions): AbortablePromise; readonly custom: CustomMetadataService; } OBJECT_NUMBER_CEILING [VariableDeclaration] (from packages/engine/core/src/identity/ObjectNumbers.ts): OBJECT_NUMBER_CEILING = 8_388_607 ObjectNumberPool [InterfaceDeclaration] (from packages/engine/core/src/identity/ObjectNumbers.ts): export interface ObjectNumberPool{ take(): number | null; readonly held: number; reserve(count: number): AbortablePromise; onLost(listener: (lost: ObjectNumbersLost) => void): () => void; } ObjectNumberRange [InterfaceDeclaration] (from packages/engine/core/src/identity/ObjectNumbers.ts): export interface ObjectNumberRange{ readonly first: number; readonly count: number; } ObjectNumbersLost [InterfaceDeclaration] (from packages/engine/core/src/identity/ObjectNumbers.ts): export interface ObjectNumbersLost{ readonly numbers: readonly number[]; readonly reason: 'reclaimed' | 'versioned'; } OpenInput [TypeAliasDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export type OpenInput = | OpenInputBytes | OpenInputLayerBytes | OpenInputLayerFile | OpenInputById | OpenInputToken | OpenInputGrant; OpenInputById [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputById{ kind: 'id'; id: string; layerName?: string; token?: TokenSource; } OpenInputBytes [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputBytes{ kind: 'bytes'; id?: string; bytes: Uint8Array | ArrayBuffer; } OpenInputGrant [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputGrant{ kind: 'grant'; grant: string; passphrase?: string; restart?: boolean; } OpenInputLayerBytes [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputLayerBytes{ kind: 'layerBytes'; id?: string; baseKey?: string; baseBytes: Uint8Array | ArrayBuffer; layer?: OpenInputLayerSource; } OpenInputLayerFile [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputLayerFile{ kind: 'layerFile'; id?: string; baseKey?: string; basePath: string; baseSha256?: string; layer?: OpenInputLayerFileSource; } OpenInputToken [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenInputToken{ kind: 'token'; token: TokenSource; } OpenOptions [InterfaceDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export interface OpenOptions{ password?: string; scope?: ReadonlyArray; identity?: Identity; } OutlineCreateOptions [InterfaceDeclaration] (from packages/engine/core/src/engine/DocumentOutlineService.ts): export interface OutlineCreateOptions extends WriteOptions{ parent?: OutlineItemRef | null; position?: OutlinePosition; objectNumber?: number; } OutlineCreateResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineCreateResult{ item: OutlineItem; order: OutlineOrder; meta: OutlineMutationMeta; } OutlineDeleteResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineDeleteResult{ meta: OutlineMutationMeta; } OutlineItem [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface OutlineItem{ ref: OutlineItemRef; parent: OutlineItemRef | null; title: string; target: PdfLinkTarget | null; action: PdfActionTree | null; open: boolean; color: string | null; bold: boolean; italic: boolean; } OutlineItemDraft [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export interface OutlineItemDraft{ title: string; target?: PdfLinkTargetWritable | null; color?: string | null; bold?: boolean; italic?: boolean; } OutlineItemPatch [TypeAliasDeclaration] (from packages/engine/core/src/dto/DocumentOutline.ts): export type OutlineItemPatch = Partial> &{ open?: boolean; } ; OutlineItemRef [TypeAliasDeclaration] (from packages/engine/core/src/identity/OutlineItemRef.ts): export type OutlineItemRef ={ kind: 'objectNumber'; objectNumber: number} ; OutlineMoveResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineMoveResult{ orders: OutlineOrder[]; meta: OutlineMutationMeta; } OutlineMutationMeta [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineMutationMeta extends MutationMeta{ changedRefs: OutlineItemRef[]; } OutlineOrder [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineOrder{ parent: OutlineItemRef | null; children: OutlineItemRef[]; } OutlinePosition [TypeAliasDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export type OutlinePosition = ListPosition; OutlineRestoreResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineRestoreResult{ items: OutlineItem[]; order: OutlineOrder; meta: OutlineMutationMeta; } OutlineUpdateResult [InterfaceDeclaration] (from packages/engine/core/src/mutation/OutlineMutationResults.ts): export interface OutlineUpdateResult{ item: OutlineItem; meta: OutlineMutationMeta; } PageAnnotationsService [InterfaceDeclaration] (from packages/engine/core/src/engine/PageAnnotationsService.ts): export interface PageAnnotationsService{ list(): AbortablePromise; renderAppearances( options?: AnnotationAppearanceImageOptions, ): AbortablePromise; downloadResource(ref: AnnotationRef, role: AnnotationResourceRole): AbortablePromise; create( data: AnnotationDraft, options?: AnnotationCreateOptions, ): AbortablePromise; update( ref: AnnotationRef, patch: AnnotationPatch, options?: AnnotationUpdateOptions, ): AbortablePromise; delete(ref: AnnotationRef, options?: WriteOptions): AbortablePromise; reorder( refs: AnnotationRef[], position: AnnotationPosition, options?: WriteOptions, ): AbortablePromise; flatten( refs: AnnotationRef[], options?: FlattenWriteOptions, ): AbortablePromise; exportAppearance(refs: AnnotationRef[]): AbortablePromise; } PageDestination [TypeAliasDeclaration] (from packages/engine/core/src/dto/PdfDestination.ts): export type PageDestination = |{ kind: 'xyz'; page: PageRef; x: number | null; y: number | null; zoom: number | null} |{ kind: 'fit'; page: PageRef} |{ kind: 'fitH'; page: PageRef; y: number | null} |{ kind: 'fitV'; page: PageRef; x: number | null} |{ kind: 'fitR'; page: PageRef; x: number; y: number; width: number; height: number} |{ kind: 'fitB'; page: PageRef} |{ kind: 'fitBH'; page: PageRef; y: number | null} |{ kind: 'fitBV'; page: PageRef; x: number | null} ; PageGeometryRun [TypeAliasDeclaration] (from packages/engine/core/src/dto/PageGeometrySnapshot.ts): export type PageGeometryRun = | UprightGeometryRun | RotatedGeometryRun; PageHandle [InterfaceDeclaration] (from packages/engine/core/src/engine/PageHandle.ts): export interface PageHandle{ readonly ref: PageRef; readonly annotations: PageAnnotationsService; readonly forms: PageFormsService; readonly text: PageTextService; readonly render: PageRenderService; readonly measure: PageMeasureService; } PageImageHandle [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageImageHandle extends PageImageResult, ImageSource{ } PageImageOptions [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageImageOptions< C extends Coordinates = PageCoordinates, > extends PageRenderOptions{ format?: PageRenderEncodedFormat; quality?: number; } PageInsertOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface PageInsertOptions extends WriteOptions{ readonly objectNumbers?: readonly number[]; } PageLayout [InterfaceDeclaration] (from packages/engine/core/src/dto/PageLayout.ts): export interface PageLayout{ index: number; ref: PageRef; label: string | null; size: PdfSize; rotation: PdfRotation; userUnit: number; tabOrder: PageTabOrder | null; boxes: PageBoxes; pdfCropBox: PdfRect; actions?: PdfPageActions; viewports?: PageMeasurementViewport[]; } PageListSnapshot [InterfaceDeclaration] (from packages/engine/core/src/dto/PageListSnapshot.ts): export interface PageListSnapshot{ pageCount: number; pages: PageLayout[]; labels: PageLabelSection[]; namedPages: NamedPageEntry[]; } PagePosition [TypeAliasDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export type PagePosition = ListPosition; PageRaster [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageRaster{ width: number; height: number; stride: number; color: 'rgba8'; premultipliedAlpha: false; data: ArrayBuffer; } PageRef [TypeAliasDeclaration] (from packages/engine/core/src/identity/PageRef.ts): export type PageRef ={ kind: 'objectNumber'; objectNumber: PageObjectNumber} ; PageRenderImage [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageRenderImage extends PageImageHandle{ transform: PageRenderTransform; } PageRenderMatrix [TypeAliasDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export type PageRenderMatrix = readonly [ a: number, b: number, c: number, d: number, e: number, f: number, ]; PageRenderOptions [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageRenderOptions{ target?: PageRenderTarget; viewport?: PageRenderViewport; rotation?: PdfRotation; background?: PageRenderBackground; includeAnnotations?: boolean; includeFormFields?: boolean; usage?: PageFlattenUsage; maxOutputPixels?: number; } PageRenderRaster [InterfaceDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export interface PageRenderRaster extends PageRaster{ transform: PageRenderTransform; } PageRenderService [InterfaceDeclaration] (from packages/engine/core/src/engine/PageRenderService.ts): export interface PageRenderService{ image(options?: PageImageOptions): AbortablePromise; } PageRenderTransform [InterfaceDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export interface PageRenderTransform{ readonly width: number; readonly height: number; readonly matrix: PageRenderMatrix; pageToPixels(quad: PageQuad): PixelQuad; pageToPixels(box: PageBox): PixelBox; pageToPixels(point: PagePoint): PixelPoint; pixelsToPage(box: PixelBox): PageBox; pixelsToPage(point: PixelPoint): PagePoint; } PageTabOrder [TypeAliasDeclaration] (from packages/engine/core/src/dto/PageLayout.ts): export type PageTabOrder = 'rows' | 'columns' | 'structure' | 'annotations' | 'widgets'; PageTextRange [InterfaceDeclaration] (from packages/engine/core/src/text/TextRange.ts): export interface PageTextRange extends TextRange{ page: PageRef; } PageTextService [InterfaceDeclaration] (from packages/engine/core/src/engine/PageTextService.ts): export interface PageTextService{ get(): AbortablePromise; slice(range: TextRange): AbortablePromise; layout(): AbortablePromise; } PageTextSnapshot [InterfaceDeclaration] (from packages/engine/core/src/dto/PageTextSnapshot.ts): export interface PageTextSnapshot{ text: string; charCount: number; charMap?: ReadonlyArray; } PageTransformOptions [InterfaceDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export interface PageTransformOptions{ viewport?: PageRenderViewport; rotation?: PdfRotation; target?: PageRenderTarget; } PdfDestination [TypeAliasDeclaration] (from packages/engine/core/src/dto/PdfDestination.ts): export type PdfDestination = |{ kind: 'xyz'; page: PageRef; left: number | null; top: number | null; zoom: number | null; } |{ kind: 'fit'; page: PageRef} |{ kind: 'fitH'; page: PageRef; top: number | null} |{ kind: 'fitV'; page: PageRef; left: number | null} |{ kind: 'fitR'; page: PageRef; left: number; bottom: number; right: number; top: number; } |{ kind: 'fitB'; page: PageRef} |{ kind: 'fitBH'; page: PageRef; top: number | null} |{ kind: 'fitBV'; page: PageRef; left: number | null} ; PdfMeasure [InterfaceDeclaration] (from packages/engine/core/src/dto/Measure.ts): export interface PdfMeasure{ subtype: 'rectilinear'; ratio?: string; x: PdfNumberFormat[]; y?: PdfNumberFormat[]; distance: PdfNumberFormat[]; area: PdfNumberFormat[]; angle?: PdfNumberFormat[]; slope?: PdfNumberFormat[]; origin?: PdfPoint; cyx?: number; } PdfMeasurement [TypeAliasDeclaration] (from packages/engine/core/src/dto/Measure.ts): export type PdfMeasurement = PdfMeasure | PdfForeignMeasure; PdfNumberFormat [InterfaceDeclaration] (from packages/engine/core/src/dto/Measure.ts): export interface PdfNumberFormat{ unit: string; conversion?: number; fraction?: MeasureFraction; precision?: number; fixed?: boolean; thousands?: string; decimal?: string; prefixSpacing?: string; suffixSpacing?: string; labelPosition?: 'suffix' | 'prefix'; } PdfPoint [InterfaceDeclaration] (from packages/engine/core/src/geometry/primitives.ts): export interface PdfPoint{ x: number; y: number; } PdfQuad [InterfaceDeclaration] (from packages/engine/core/src/geometry/primitives.ts): export interface PdfQuad{ upperLeft: PdfPoint; upperRight: PdfPoint; lowerLeft: PdfPoint; lowerRight: PdfPoint; } PdfRect [InterfaceDeclaration] (from packages/engine/core/src/geometry/primitives.ts): export interface PdfRect{ left: number; bottom: number; right: number; top: number; } PdfRotation [TypeAliasDeclaration] (from packages/engine/core/src/geometry/primitives.ts): export type PdfRotation = 0 | 90 | 180 | 270; PdfSaveMode [TypeAliasDeclaration] (from packages/engine/core/src/dto/PdfSaveMode.ts): export type PdfSaveMode = 'incremental' | 'rewrite'; PdfTextSegment [InterfaceDeclaration] (from packages/engine/core/src/text/layout.ts): export interface PdfTextSegment{ quad: C['quad']; rect: C['box']; advance: 1 | -1; } PixelBox [InterfaceDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export interface PixelBox{ x: number; y: number; width: number; height: number; } PixelPoint [InterfaceDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export interface PixelPoint{ x: number; y: number; } PixelQuad [InterfaceDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export interface PixelQuad{ upperLeft: PixelPoint; upperRight: PixelPoint; lowerLeft: PixelPoint; lowerRight: PixelPoint; } PrintDpi [TypeAliasDeclaration] (from packages/engine/core/src/dto/PageRender.ts): export type PrintDpi = 150 | 300; RawPageRenderService [InterfaceDeclaration] (from packages/engine/core/src/engine/PageRenderService.ts): export interface RawPageRenderService extends PageRenderService{ raw(options?: PageRenderOptions): AbortablePromise; } ResolvedFontRun [InterfaceDeclaration] (from packages/engine/core/src/dto/DocumentFonts.ts): export interface ResolvedFontRun{ font: FontName; weight: number; italic: boolean; substituted: boolean; program: string | null; fallbacks: string[]; } SearchLimit [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchLimit{ matches?: number; pages?: number; } SearchMatch [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchMatch extends PageTextRange{ segments: PdfTextSegment[]; snippet?: SearchSnippet; } SearchQuery [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchQuery{ text: string; regex?: boolean; matchCase?: boolean; wholeWord?: boolean; matchDiacritics?: boolean; ignoreWhitespace?: boolean; } SearchRequest [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchRequest extends SearchQuery{ snippets?: boolean; from?: PageRef; cursor?: string; limit?: SearchLimit; } SearchSlice [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchSlice{ matches: SearchMatch[]; nextCursor: string | null; pagesSearched: number; pageCount: number; } SearchSnippet [InterfaceDeclaration] (from packages/engine/core/src/search/types.ts): export interface SearchSnippet{ before: string; match: string; after: string; } SkippedChangeItem [InterfaceDeclaration] (from packages/engine/core/src/mutation/Change.ts): export interface SkippedChangeItem{ type: 'skipped'; op: ChangeItemType; meta: MutationMeta; } TabOrderItem [InterfaceDeclaration] (from packages/engine/core/src/pages/tabOrder.ts): export interface TabOrderItem{ readonly subtype: string; readonly page:{ readonly objectNumber: number} ; readonly rect:{ readonly x: number; readonly y: number; readonly width: number; readonly height: number; } ; readonly structurePosition: readonly number[] | null; } TabOrderPage [InterfaceDeclaration] (from packages/engine/core/src/pages/tabOrder.ts): export interface TabOrderPage{ readonly ref:{ readonly objectNumber: number} ; readonly tabOrder: PageTabOrder | null; } TextLayout [InterfaceDeclaration] (from packages/engine/core/src/text/layout.ts): export interface TextLayout{ readonly charCount: number; readonly runs: readonly PageGeometryRun[]; charAt(point: C['point']): number | null; wordAt(at: C['point'] | number): TextRange | null; lineAt(at: C['point'] | number): TextRange | null; segments(range: TextRange): PdfTextSegment[]; charQuad(index: number): C['quad'] | null; } TextRange [InterfaceDeclaration] (from packages/engine/core/src/text/TextRange.ts): export interface TextRange{ start: number; count: number; } TokenSource [TypeAliasDeclaration] (from packages/engine/core/src/dto/OpenInput.ts): export type TokenSource = string | (() => string | Promise); VisitorAnswers [TypeAliasDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export type VisitorAnswers = Partial>; VisitorIdentityField [TypeAliasDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export type VisitorIdentityField = | 'displayName' | 'email' | 'title' | 'organization' | 'organizationalUnit'; VisitorIdentityRequest [InterfaceDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export interface VisitorIdentityRequest{ readonly fields: Partial>; readonly missing: readonly VisitorIdentityField[]; readonly invalid: readonly VisitorIdentityField[]; readonly purpose?: string; readonly privacyUrl?: string; } WorkingSetPage [InterfaceDeclaration] (from packages/engine/core/src/scheduling/facts.ts): export interface WorkingSetPage{ readonly page: PageRef; readonly role: 'visible' | 'near'; readonly visible?: PageBox; readonly pixels: number; } WriteOptions [InterfaceDeclaration] (from packages/engine/core/src/mutation/WriteOptions.ts): export interface WriteOptions{ readonly opId?: string; } anchorOf [FunctionDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export function anchorOf(position: ListPosition): Ref | null{ if (position === 'start' || position === 'end') return null; return 'before' in position ? position.before : position.after; } annotationKey [FunctionDeclaration] (from packages/engine/core/src/identity/annotationKey.ts): export function annotationKey(ref: AnnotationRef): string{ switch (ref.kind){ case 'objectNumber': return `obj:${ ref.objectNumber} `; case 'baseIndex': return `base:${ ref.page.objectNumber} :${ ref.baseIndex} `; } } annotationOfDraft [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function annotationOfDraft( draft: AnnotationDraft, context: DraftContext, ): Annotation{ return annotationOfResolvedDraft( resolveAnnotationDraft(draft, { describeFont: context.describeFont} ), context, ); } appearanceTurnOf [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function appearanceTurnOf(annotation:{ subtype: string; rect: PageBox; box?: PageBox | null; rotation?: number | null; intent?: string | null; } ): number | null{ return pdfAppearanceTurnOf({ ...annotation, rect: mirroredRect(annotation.rect), box: annotation.box ? mirroredRect(annotation.box) : annotation.box, } ); } applyAnnotationPatch [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function applyAnnotationPatch( current: A, patch: AnnotationPatch, options: ResolveOptions ={ } , ): A{ return applyResolvedPatch(current, resolveAnnotationPatch(current, patch, options)); } buildCommentThreads [FunctionDeclaration] (from packages/engine/core/src/annotation/comments.ts): export function buildCommentThreads( annotations: readonly Annotation[], options: BuildCommentThreadsOptions ={ } , ): CommentThread[]{ const eligible = annotations.filter((a) => !EXCLUDED_SUBTYPES.has(a.subtype)); const byKey = new Map(eligible.map((a) => [annotationKey(a.ref), a])); const zOrder = new Map(eligible.map((a, at) => [annotationKey(a.ref), at])); const chronological = chronologicalIn(zOrder); const children = new Map(); for (const a of eligible){ if (!a.reply) continue; const parent = byKey.get(annotationKey(a.reply.to)); if (!parent) continue; const parentKey = annotationKey(parent.ref); const list = children.get(parentKey); if (list) list.push(a); else children.set(parentKey, [a]); } const visited = new Set(); const threads: CommentThread[] = []; const walk = (root: Annotation): void =>{ const replies: Annotation[] = []; const groupedParts: Annotation[] = []; const states: Annotation[] = []; visited.add(annotationKey(root.ref)); const stack = [...(children.get(annotationKey(root.ref)) ?? [])]; while (stack.length > 0){ const a = stack.pop()!; const key = annotationKey(a.ref); if (visited.has(key)) continue; visited.add(key); if (isStateAnnotation(a)) states.push(a); else if (classifyRelation(a) === 'grouped-subordinate') groupedParts.push(a); else replies.push(a); stack.push(...(children.get(key) ?? [])); } replies.sort(chronological); states.sort(chronological); threads.push({ root, page: root.page, replies, groupedParts, review: computeReview(states, options), } ); } ; for (const a of eligible){ if (!a.reply && !isStateAnnotation(a)) walk(a); } for (const a of eligible){ if (visited.has(annotationKey(a.ref))) continue; if (isStateAnnotation(a)) continue; walk(a); } return threads; } caps [VariableDeclaration] (from packages/engine/core/src/auth/scope/builders.ts): caps ={ doc:{ open: () => 'doc.open' as const, render: Object.assign(() => 'doc.render' as const, { thumbnail: () => 'doc.render.thumbnail' as const, } ), text:{ select: () => 'doc.text.select' as const, copy: () => 'doc.text.copy' as const, search: () => 'doc.text.search' as const, } , content:{ copy: () => 'doc.content.copy' as const, } , download: Object.assign(() => 'doc.download' as const, { flattened: () => 'doc.download.flattened' as const, } ), print: Object.assign(() => 'doc.print' as const, { high: () => 'doc.print.high' as const, } ), pages:{ modify: () => 'doc.pages.modify' as const, assemble: () => 'doc.pages.assemble' as const, } , forms:{ read: () => 'doc.forms.read' as const, fill: () => 'doc.forms.fill' as const, modify: () => 'doc.forms.modify' as const, import: () => 'doc.forms.import' as const, script: () => 'doc.forms.script' as const, submit: () => 'doc.forms.submit' as const, } , annotate:{ read: () => 'doc.annotate.read' as const, modify: () => 'doc.annotate.modify' as const, import: () => 'doc.annotate.import' as const, } , metadata:{ modify: () => 'doc.metadata.modify' as const, } , attachments:{ modify: () => 'doc.attachments.modify' as const, } , outline:{ modify: () => 'doc.outline.modify' as const, } , redact: () => 'doc.redact' as const, sign: Object.assign(() => 'doc.sign' as const, { certify: () => 'doc.sign.certify' as const, } ), } , } as const charRangeForTextOffsets [FunctionDeclaration] (from packages/engine/core/src/text/charmap.ts): export function charRangeForTextOffsets(snapshot: PageTextSnapshot, offsets: TextRange): TextRange{ const startOffset = offsets.start; const endOffset = offsets.start + offsets.count; if (endOffset <= startOffset){ return{ start: charBoundaryAtTextOffset(snapshot, startOffset, 'end'), count: 0} ; } const start = charBoundaryAtTextOffset(snapshot, startOffset, 'start'); return{ start, count: charBoundaryAtTextOffset(snapshot, endOffset, 'end') - start} ; } collab [VariableDeclaration] (from packages/engine/core/src/auth/scope/builders.ts): collab ={ annotations:{ create: makeFilterBuilder('annotations', 'create'), update: makeFilterBuilder('annotations', 'update'), delete: makeFilterBuilder('annotations', 'delete'), setGroup: makeGroupFilterBuilder('annotations', 'set-group'), all: makeFilterBuilder('annotations', '*'), } , fields:{ fill: makeGroupFilterBuilder('fields', 'fill'), sign: makeGroupFilterBuilder('fields', 'sign'), setGroup: makeGroupFilterBuilder('fields', 'set-group'), all: makeGroupFilterBuilder('fields', '*'), } , } as const compareStructurePositions [FunctionDeclaration] (from packages/engine/core/src/pages/tabOrder.ts): export function compareStructurePositions( left: readonly number[], right: readonly number[], ): number{ for (let i = 0; i < Math.min(left.length, right.length); i++){ if (left[i] !== right[i]) return left[i]! - right[i]!; } return left.length - right.length; } drawnPointsOf [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function drawnPointsOf(annotation: Annotation): PagePoint[][] | null{ const flip = (points: readonly PagePoint[]) => points.map(mirroredPoint); let mirrored: object; switch (annotation.subtype){ case 'line': mirrored ={ subtype: 'line', rotation: annotation.rotation, linePoints:{ start: mirroredPoint(annotation.linePoints.start), end: mirroredPoint(annotation.linePoints.end), } , } ; break; case 'polyline': case 'polygon': mirrored ={ subtype: annotation.subtype, rotation: annotation.rotation, vertices: flip(annotation.vertices), } ; break; case 'ink': mirrored ={ subtype: 'ink', rotation: annotation.rotation, inkList: annotation.inkList.map(flip), } ; break; default: return null; } const sets = pdfDrawnPointsOf(mirrored as Annotation); return sets && sets.map((set) => set.map(unmirroredPoint)); } formatMeasurement [FunctionDeclaration] (from packages/engine/core/src/measure/format.ts): export function formatMeasurement(value: number, formats: readonly PdfNumberFormat[]): string{ if (!Number.isFinite(value) || !formats.length || !formats.every(validNumberFormat)){ throw new EngineError( EngineErrorCode.InvalidArg, 'Measurement requires a finite value and valid number formats', ); } let remainder = Math.abs(value); const parts: string[] = []; for (const [index, nf] of formats.entries()){ remainder *= Math.fround(nf.conversion!); if (!Number.isFinite(remainder)) throw new EngineError(EngineErrorCode.InvalidArg, 'Measurement overflow'); const whole = Math.floor(remainder); const fraction = remainder - whole; const final = index === formats.length - 1; const terminal = final || fraction === 0; const number = final ? last(remainder, nf) : group(String(whole), nf.thousands ?? ', '); const prefix = nf.labelPosition === 'prefix'; const ps = nf.prefixSpacing ?? (prefix && index === 0 ? '' : ' '); const ss = nf.suffixSpacing ?? (!prefix && terminal ? '' : ' '); const label = ps + nf.unit + ss; parts.push(prefix ? label + number : number + label); if (terminal) break; remainder = fraction; } return (value < 0 ? '-' : '') + parts.join(''); } grantOpenRequestOf [FunctionDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export function grantOpenRequestOf( error: unknown, passphraseProvided: boolean, ): GrantOpenRequest | null{ if (EngineError.is(error, EngineErrorCode.GrantPassphraseRequired)){ return{ kind: 'passphrase', passphraseProvided} ; } const request = visitorIdentityRequestOf(error); return request ?{ kind: 'identity', request} : null; } isAbortError [FunctionDeclaration] (from packages/engine/core/src/promise/AbortError.ts): export function isAbortError(value: unknown): value is AbortError{ return value instanceof AbortError || (value as{ name?: string} | null)?.name === 'AbortError'; } isLocalDocument [FunctionDeclaration] (from packages/engine/core/src/engine/LocalDocumentHandle.ts): export function isLocalDocument(doc: DocumentHandle): doc is LocalDocumentHandle{ return hasLocalEngineBrand(doc); } isLocalEngine [FunctionDeclaration] (from packages/engine/core/src/engine/LocalEngine.ts): export function isLocalEngine(engine: Engine): engine is LocalEngine{ return hasLocalEngineBrand(engine); } isLocalPage [FunctionDeclaration] (from packages/engine/core/src/engine/LocalPageHandle.ts): export function isLocalPage(page: PageHandle): page is LocalPageHandle{ return hasLocalEngineBrand(page); } isRotatedGeometryRun [FunctionDeclaration] (from packages/engine/core/src/dto/PageGeometrySnapshot.ts): export function isRotatedGeometryRun( run: PageGeometryRun, ): run is RotatedGeometryRun{ return 'rotation' in run; } measureFromKnownLength [FunctionDeclaration] (from packages/engine/core/src/measure/calibrate.ts): export function measureFromKnownLength( userSpaceLength: number, real:{ value: number; unit: LengthUnit} , format: MeasurementFormatOptions ={ } , ): PdfMeasure{ positive(userSpaceLength); positive(real.value); const perPoint = real.value / userSpaceLength; return build( perPoint, real.unit, `1 in = ${ Number((perPoint * 72).toPrecision(8))} ${ real.unit} `, format, ); } measureFromRatio [FunctionDeclaration] (from packages/engine/core/src/measure/calibrate.ts): export function measureFromRatio( paper: number, real: number, unit: LengthUnit, options: MeasureFromRatioOptions ={ } , ): PdfMeasure{ const{ userUnit = 1, ...format} = options; positive(paper); positive(real); positive(userUnit); return build( ((userUnit / 72) * 0.0254 * (real / paper)) / METRES[unit], unit, `${ paper} :${ real} `, format, ); } measurementReadout [FunctionDeclaration] (from packages/engine/core/src/measure/derive.ts): export function measurementReadout( dto: DimensionInput, ): MeasurementReadout | MeasurementUnavailable{ if (!isDimension(dto)) return{ unavailable: 'not-dimension'} ; if (!dto.measure) return{ unavailable: 'no-measure'} ; if (dto.measure.subtype !== 'rectilinear') return{ unavailable: 'foreign-measure'} ; const m = dto.measure, scale = scaleOf(m); if (!scale) return{ unavailable: 'no-scale'} ; const points = dto.subtype === 'line' ? dto.linePoints ? [dto.linePoints.start, dto.linePoints.end] : [] : (dto.vertices ?? []); if ( points.length < (dto.subtype === 'polygon' ? 3 : 2) || points.some((p) => !Number.isFinite(Math.fround(p.x)) || !Number.isFinite(Math.fround(p.y))) ){ return{ unavailable: 'invalid-geometry'} ; } const area = dto.subtype === 'polygon'; if (area && !validAreaBoundary(points)) return{ unavailable: 'invalid-geometry'} ; const formats = area ? m.area : m.distance; if (!formats.length) return{ unavailable: area ? 'no-area-format' : 'no-distance-format'} ; if (!formats.every(validNumberFormat)) return{ unavailable: 'invalid-format'} ; const value = area ? polygonArea(points, scale) : pathLength(points, false, scale); try{ return{ kind: area ? 'area' : dto.subtype === 'line' ? 'distance' : 'perimeter', value: value * Math.fround(formats[0].conversion!), label: formatMeasurement(value, formats), ...(area && m.distance.length && m.distance.every(validNumberFormat) ?{ perimeter: formatMeasurement(pathLength(points, true, scale), m.distance)} :{ } ), } ; } catch{ return{ unavailable: 'invalid-format'} ; } } outlineItemRefsEqual [FunctionDeclaration] (from packages/engine/core/src/identity/OutlineItemRef.ts): export function outlineItemRefsEqual(a: OutlineItemRef, b: OutlineItemRef): boolean{ return a.kind === b.kind && a.objectNumber === b.objectNumber; } pageBoxOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pageBoxOf(rect: PdfRect, visible: PdfRect): PageBox{ return{ x: rect.left - visible.left, y: visible.top - rect.top, width: rect.right - rect.left, height: rect.top - rect.bottom, } ; } pageDestinationOf [FunctionDeclaration] (from packages/engine/core/src/pageSpace/destinations.ts): export function pageDestinationOf( destination: PdfDestination, box: DestinationBox, ): PageDestination{ const{ left: boxLeft, top: boxTop} = boxFor(destination.page, box); const x = (left: Axis) => across(left, (value) => value - boxLeft); const y = (top: Axis) => across(top, (value) => boxTop - value); switch (destination.kind){ case 'xyz':{ const{ left, top, ...rest} = destination; return{ ...rest, x: x(left), y: y(top)} ; } case 'fitH': case 'fitBH':{ const{ top, ...rest} = destination; return{ ...rest, y: y(top)} ; } case 'fitV': case 'fitBV':{ const{ left, ...rest} = destination; return{ ...rest, x: x(left)} ; } case 'fitR':{ const{ left, bottom, right, top, ...rest} = destination; const lower = Math.min(bottom, top); const upper = Math.max(bottom, top); return{ ...rest, x: Math.min(left, right) - boxLeft, y: boxTop - upper, width: Math.abs(right - left), height: upper - lower, } ; } case 'fit': case 'fitB': return destination; } } pagePointOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pagePointOf(point: PdfPoint, visible: PdfRect): PagePoint{ return{ x: point.x - visible.left, y: visible.top - point.y} ; } pageQuadOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pageQuadOf(quad: PdfQuad, visible: PdfRect): PageQuad{ return{ upperLeft: pagePointOf(quad.upperLeft, visible), upperRight: pagePointOf(quad.upperRight, visible), lowerLeft: pagePointOf(quad.lowerLeft, visible), lowerRight: pagePointOf(quad.lowerRight, visible), } ; } pageRefsEqual [FunctionDeclaration] (from packages/engine/core/src/identity/PageRef.ts): export function pageRefsEqual(a: PageRef, b: PageRef): boolean{ return a.kind === b.kind && a.objectNumber === b.objectNumber; } pageTransform [FunctionDeclaration] (from packages/engine/core/src/geometry/pageTransform.ts): export function pageTransform( page:{ size: PdfSize} , options: PageTransformOptions ={ } , ): PageRenderTransform{ const target = options.target; return renderAreaTransform( target?.kind === 'rect' ? renderTargetArea(target.rect) :{ x: 0, y: 0, width: page.size.width, height: page.size.height} , options, ); } pdfDestinationOf [FunctionDeclaration] (from packages/engine/core/src/pageSpace/destinations.ts): export function pdfDestinationOf( destination: PageDestination, box: DestinationBox, ): PdfDestination{ const{ left: boxLeft, top: boxTop} = boxFor(destination.page, box); const left = (x: Axis) => across(x, (value) => value + boxLeft); const top = (y: Axis) => across(y, (value) => boxTop - value); switch (destination.kind){ case 'xyz':{ const{ x, y, ...rest} = destination; return{ ...rest, left: left(x), top: top(y)} ; } case 'fitH': case 'fitBH':{ const{ y, ...rest} = destination; return{ ...rest, top: top(y)} ; } case 'fitV': case 'fitBV':{ const{ x, ...rest} = destination; return{ ...rest, left: left(x)} ; } case 'fitR':{ const{ x, y, width, height, ...rest} = destination; const upper = boxTop - y; return{ ...rest, left: x + boxLeft, bottom: upper - height, right: x + boxLeft + width, top: upper, } ; } case 'fit': case 'fitB': return destination; } } pdfPointOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pdfPointOf(point: PagePoint, visible: PdfRect): PdfPoint{ return{ x: point.x + visible.left, y: visible.top - point.y} ; } pdfQuadOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pdfQuadOf(quad: PageQuad, visible: PdfRect): PdfQuad{ return{ upperLeft: pdfPointOf(quad.upperLeft, visible), upperRight: pdfPointOf(quad.upperRight, visible), lowerLeft: pdfPointOf(quad.lowerLeft, visible), lowerRight: pdfPointOf(quad.lowerRight, visible), } ; } pdfRectOf [FunctionDeclaration] (from packages/engine/core/src/geometry/pageSpace.ts): export function pdfRectOf(box: PageBox, visible: PdfRect): PdfRect{ const left = box.x + visible.left; const top = visible.top - box.y; return{ left, right: left + box.width, bottom: top - box.height, top} ; } reorderedList [FunctionDeclaration] (from packages/engine/core/src/mutation/ListPosition.ts): export function reorderedList( order: readonly Ref[], moved: readonly Ref[], position: ListPosition, keyOf: (ref: Ref) => string, ): Ref[]{ const movedKeys = new Set(moved.map(keyOf)); if (movedKeys.size !== moved.length){ throw new EngineError(EngineErrorCode.InvalidArg, 'a row is named twice', { details:{ field: 'refs'} , } ); } const present = new Set(order.map(keyOf)); const missing = moved.find((ref) => !present.has(keyOf(ref))); if (missing !== undefined){ throw new EngineError(EngineErrorCode.NotFound, `no row ${ keyOf(missing)} in the list`, { details:{ field: 'refs'} , } ); } const anchor = anchorOf(position); if (anchor !== null && movedKeys.has(keyOf(anchor))){ throw new EngineError( EngineErrorCode.InvalidArg, `the neighbour ${ keyOf(anchor)} is one of the rows that move`, { details:{ field: 'position'} } , ); } const staying = order.filter((ref) => !movedKeys.has(keyOf(ref))); const at = positionIndex(staying, position, keyOf); return [...staying.slice(0, at), ...moved, ...staying.slice(at)]; } resolveAnnotationDraft [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function resolveAnnotationDraft( draft: AnnotationDraft, options: DraftResolveOptions ={ } , ): AnnotationDraft{ const resolved = pdfPredictAnnotationDraft( pdfAnnotationDraftOf(draft, MIRROR, mirrorEveryPage), options, ); const back = pageAnnotationDraftOf(resolved, MIRROR, mirrorEveryPage) as Record; const given = draft as Record; for (const name of Object.keys(back)){ if (given[name] !== undefined && semanticEqual(back[name], given[name])) back[name] = given[name]; } return back as AnnotationDraft; } resolveAnnotationPatch [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function resolveAnnotationPatch( current: Annotation, patch: AnnotationPatch, options: ResolveOptions ={ } , ): AnnotationPatch{ const resolved = pdfPredictAnnotationPatch( pdfAnnotationOf(current, MIRROR, mirrorEveryPage), pdfAnnotationPatchOf({ ...patch, subtype: patch.subtype ?? current.subtype} as AnnotationPatch, MIRROR, mirrorEveryPage, ), options, ); const back = pageAnnotationPatchOf(resolved, MIRROR, mirrorEveryPage) as Record; const given = patch as Record; for (const name of Object.keys(back)){ if (given[name] !== undefined && semanticEqual(back[name], given[name])) back[name] = given[name]; } return back as AnnotationPatch; } shapeForRect [FunctionDeclaration] (from packages/engine/core/src/pageSpace/helpers.ts): export function shapeForRect(annotation: A, rect: PageBox): Partial{ if (!DRAWN_RECT_KINDS.has(annotation.subtype)) return{ rect} as Partial; const read = annotation as unknown as Record; const shape = Object.fromEntries( ['subtype', 'rect', ...shapeFieldsOf(annotation.subtype)] .filter((name) => read[name] !== undefined) .map((name) => [name, read[name]]), ); const mirrored = pdfAnnotationOf(shape as Annotation, MIRROR, noOtherPage); const placed = pdfShapeForRect(mirrored, mirroredRect(rect)); const{ subtype: _kind, ...fields} = pageAnnotationPatchOf({ subtype: annotation.subtype, ...placed} as never, MIRROR, noOtherPage, ); return fields as unknown as Partial; } shownAppearances [FunctionDeclaration] (from packages/engine/core/src/dto/AnnotationRender.ts): export function shownAppearances< Appearance extends{ readonly ref: AnnotationRef; readonly mode: AnnotationAppearanceMode; readonly state: string | null; } , >( appearances: readonly Appearance[], annotations: readonly{ readonly ref: AnnotationRef; readonly appearanceState: string | null} [], ): Appearance[]{ const shownState = new Map(); for (const annotation of annotations){ shownState.set(annotationKey(annotation.ref), annotation.appearanceState ?? 'Off'); } return appearances.filter( (appearance) => appearance.mode === 'normal' && (appearance.state === null || appearance.state === (shownState.get(annotationKey(appearance.ref)) ?? 'Off')), ); } snapFullPageViewport [FunctionDeclaration] (from packages/engine/core/src/engine/DocumentRenderService.ts): export function snapFullPageViewport( policy: EngineRenderPolicy, viewport: PageRenderViewport, options?:{ pageWidth?: number} , ): PageRenderViewport{ if (policy.kind === 'continuous') return viewport; if (viewport.kind === 'dpi' || viewport.kind === 'thumbnail') return viewport; if (policy.fullPage.widths.length === 0){ throw new EngineError(EngineErrorCode.InvalidArg, 'render policy has an empty width ladder'); } const widths = [...policy.fullPage.widths].sort((a, b) => a - b); let requested: number; if (viewport.kind === 'width'){ requested = viewport.width; } else{ const pageWidth = options?.pageWidth; if (pageWidth === undefined || pageWidth <= 0){ throw new EngineError( EngineErrorCode.InvalidArg, 'snapping a scale viewport to a width lattice requires opts.pageWidth', ); } requested = (viewport.scale ?? 1) * pageWidth; } const snapped = widths.find((width) => width >= requested) ?? widths[widths.length - 1]!; return{ kind: 'width', width: snapped} ; } tabOrderOf [FunctionDeclaration] (from packages/engine/core/src/pages/tabOrder.ts): export function tabOrderOf( annotations: readonly T[], pages: readonly TabOrderPage[], ): T[]{ const byPage = new Map(); for (const annotation of annotations){ const onPage = byPage.get(annotation.page.objectNumber); if (onPage) onPage.push(annotation); else byPage.set(annotation.page.objectNumber, [annotation]); } return pages.flatMap((page) =>{ const onPage = byPage.get(page.ref.objectNumber) ?? []; switch (page.tabOrder){ case 'rows': return inLines(onPage, 'y', 'x'); case 'columns': return inLines(onPage, 'x', 'y'); case 'structure': return byStructure(onPage); case 'widgets': return [ ...onPage.filter((annotation) => annotation.subtype === 'widget'), ...onPage.filter((annotation) => annotation.subtype !== 'widget'), ]; default: return onPage; } } ); } toAttachmentRef [FunctionDeclaration] (from packages/engine/core/src/dto/Attachment.ts): export function toAttachmentRef(key: string): AttachmentRef{ return{ kind: 'key', key} ; } toFieldRef [FunctionDeclaration] (from packages/engine/core/src/identity/FormFieldRef.ts): export function toFieldRef(name: string): FormFieldRef{ return{ kind: 'fqn', name} ; } toOutlineItemRef [FunctionDeclaration] (from packages/engine/core/src/identity/OutlineItemRef.ts): export function toOutlineItemRef(objectNumber: number): OutlineItemRef{ return{ kind: 'objectNumber', objectNumber} ; } toPageRef [FunctionDeclaration] (from packages/engine/core/src/identity/PageRef.ts): export function toPageRef(pageObjectNumber: PageObjectNumber): PageRef{ return{ kind: 'objectNumber', objectNumber: pageObjectNumber} ; } validateSearchQuery [FunctionDeclaration] (from packages/engine/core/src/search/regex.ts): export function validateSearchQuery(query: SearchQuery): SearchQueryValidation{ if (!query.regex) return{ ok: true} ; if (query.matchDiacritics){ return{ ok: false, issue: 'diacritics-with-regex', message: 'Diacritic-sensitive matching is not available for regex patterns (regex runs on the raw text plane).', } ; } if (query.ignoreWhitespace){ return{ ok: false, issue: 'ignore-whitespace-with-regex', message: 'Whitespace-insensitive matching is not available for regex patterns (regex runs on the raw text plane; use \\s* in the pattern).', } ; } return validateSearchRegex(query.text); } viewportForPoint [FunctionDeclaration] (from packages/engine/core/src/measure/viewport.ts): export function viewportForPoint( viewports: readonly T[], point: PagePoint, ): T | undefined{ return [...viewports] .reverse() .find( ({ bbox: b} ) => point.x >= b.x && point.x <= b.x + b.width && point.y >= b.y && point.y <= b.y + b.height, ); } visitorIdentityRequestOf [FunctionDeclaration] (from packages/engine/core/src/dto/GrantVisitor.ts): export function visitorIdentityRequestOf(error: unknown): VisitorIdentityRequest | null{ if (!EngineError.is(error, EngineErrorCode.VisitorIdentityRequired)) return null; const request = error.details as Partial | undefined; return request && typeof request.fields === 'object' && Array.isArray(request.missing) ?{ fields: request.fields, missing: request.missing, invalid: Array.isArray(request.invalid) ? request.invalid : [], ...(typeof request.purpose === 'string' ?{ purpose: request.purpose} :{ } ), ...(typeof request.privacyUrl === 'string' ?{ privacyUrl: request.privacyUrl} :{ } ), } : null; }