@openpresentation/opf 0.11.4 → 0.12.1

package/dist/pagination.d.ts

@@ -1,4 +1,4 @@
-import { L as LayoutDiagnostic, C as ComposeSlideOptions, T as TextMeasurement, F as FontSchemeDiagnostic } from './composition-Dl-d9FRj.js';
+import { T as TextMeasurement, C as ComposeSlideOptions, F as FontSchemeDiagnostic, L as LayoutDiagnostic } from './composition-DWbCiMwF.js';
 
 interface PaginationOptions extends ComposeSlideOptions {
     /** Readability floor used while choosing page breaks. Default 24 reference pixels. */

package/dist/pagination.js

@@ -1,5 +1,6 @@
-export { OPFPaginationError, paginatePresentation, paginateSlide } from './chunk-NSVVQ52O.js';
-import './chunk-FDCWQHWO.js';
-import './chunk-3H2U7FDR.js';
-import './chunk-KJKASEPE.js';
-import './chunk-AEUSVEUY.js';
+export { OPFPaginationError, paginatePresentation, paginateSlide } from './chunk-AUM5MXBR.js';
+import './chunk-JKVKYVWL.js';
+import './chunk-HOBSL7AJ.js';
+import './chunk-S5W34SIJ.js';
+import './chunk-E34DJ5LL.js';
+import './chunk-4LAM3N6S.js';

package/dist/patch.d.ts

@@ -0,0 +1,99 @@
+type JsonPointer = string;
+type JsonPatchOperation = {
+    op: "add" | "replace" | "test";
+    path: JsonPointer;
+    value: unknown;
+} | {
+    op: "remove";
+    path: JsonPointer;
+} | {
+    op: "move" | "copy";
+    from: JsonPointer;
+    path: JsonPointer;
+};
+type PatchErrorCode = "invalid-patch" | "invalid-patch-operation" | "unsupported-patch-operation" | "invalid-json-pointer" | "patch-path-missing" | "patch-parent-missing" | "invalid-array-index" | "patch-test-failed" | "patch-invalid-move" | "patch-root-remove" | "patch-invalid-document";
+declare class PatchError extends Error {
+    readonly code: PatchErrorCode;
+    /** The JSON Pointer the failing operation addressed, when known. */
+    path?: string;
+    /** The index of the failing operation within the patch, when known. */
+    index?: number;
+    /** The failing operation, when known. */
+    operation?: unknown;
+    constructor(code: PatchErrorCode, message: string, details?: {
+        path?: string;
+        index?: number;
+        operation?: unknown;
+    });
+}
+/** Thrown when `validate` is requested and the patched document is not a valid OPF presentation. */
+declare class PatchValidationError extends PatchError {
+    readonly validation: PatchValidationResult;
+    constructor(validation: PatchValidationResult);
+}
+interface PatchValidationResult {
+    valid: boolean;
+    errors?: unknown[];
+    warnings?: unknown[];
+    [key: string]: unknown;
+}
+interface ApplyPatchOptions {
+    /**
+     * Validate the whole patched document against the OPF schema (`true`) or a
+     * custom validator. An invalid result throws `PatchValidationError`; the
+     * input is never changed. Intermediate states are not validated.
+     */
+    validate?: boolean | ((document: unknown) => PatchValidationResult);
+    /** With `validate`, also reject warnings. */
+    strict?: boolean;
+}
+interface PatchResult {
+    document: unknown;
+    /** The patch that restores the input from `document`. Applying it to `document` yields the input. */
+    inverse: JsonPatchOperation[];
+    /** The normalised operations that were applied (values cloned, unknown members dropped). */
+    patch: JsonPatchOperation[];
+    validation?: PatchValidationResult;
+}
+/** JSON equality: member order is irrelevant, `-0` equals `0`, arrays compare in order. */
+declare function jsonEqual(a: unknown, b: unknown): boolean;
+declare function escapePointerToken(token: string | number): string;
+declare function unescapePointerToken(token: string): string;
+/** Split a JSON Pointer into unescaped tokens. Throws `invalid-json-pointer`. */
+declare function parsePointer(pointer: unknown): string[];
+/** Join tokens into a JSON Pointer, escaping `~` and `/`. */
+declare function formatPointer(tokens: readonly (string | number)[]): JsonPointer;
+/**
+ * Stable path normalisation. Accepts a JSON Pointer (`/slides/0/title`), an
+ * OPF dotted path (`slides.0.title`) or a segment array, and returns a JSON
+ * Pointer. Use pointers or segment arrays for keys that contain dots.
+ */
+declare function pointerFromPath(path: string | readonly (string | number)[]): JsonPointer;
+/** Parent pointer and final token of a non-root pointer. */
+declare function splitPointer(pointer: JsonPointer): {
+    parent: JsonPointer;
+    token: string;
+};
+/** Read a value without throwing: `found` is false for a missing path (including `-` and bad indices). */
+declare function readPointer(document: unknown, pointer: JsonPointer | readonly string[]): {
+    found: true;
+    value: unknown;
+} | {
+    found: false;
+};
+/** Read a value or throw `patch-path-missing`. */
+declare function getAtPointer(document: unknown, pointer: JsonPointer | readonly string[]): unknown;
+declare const hasPointer: (document: unknown, pointer: JsonPointer | readonly string[]) => boolean;
+/** Normalise and structurally validate a patch (shape only; no document needed). Values are cloned. */
+declare function normalizePatch(patch: unknown): JsonPatchOperation[];
+/**
+ * Apply a patch to a clone of `document` and return the result with its
+ * inverse. Atomic: any failing operation throws and nothing is returned.
+ */
+declare function applyPatchWithInverse(document: unknown, patch: unknown, options?: ApplyPatchOptions): PatchResult;
+/** Apply an RFC 6902 patch to a clone of `document`; the input is never changed. */
+declare function applyPatch(document: unknown, patch: unknown, options?: ApplyPatchOptions): unknown;
+/** The patch that undoes `patch` when applied to the result of `applyPatch(document, patch)`. */
+declare function invertPatch(document: unknown, patch: unknown): JsonPatchOperation[];
+
+export { type ApplyPatchOptions, type JsonPatchOperation, type JsonPointer, PatchError, type PatchErrorCode, type PatchResult, PatchValidationError, type PatchValidationResult, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken };

package/dist/patch.js

@@ -0,0 +1,6 @@
+export { PatchError, PatchValidationError, applyPatch, applyPatchWithInverse, escapePointerToken, formatPointer, getAtPointer, hasPointer, invertPatch, jsonEqual, normalizePatch, parsePointer, pointerFromPath, readPointer, splitPointer, unescapePointerToken } from './chunk-RUC7L5DJ.js';
+import './chunk-JKVKYVWL.js';
+import './chunk-HOBSL7AJ.js';
+import './chunk-S5W34SIJ.js';
+import './chunk-E34DJ5LL.js';
+import './chunk-4LAM3N6S.js';