@opengeni/artifact-tool 0.2.2

package/dist/document-docx-import.d.ts

@@ -0,0 +1,261 @@
+/**
+ * A dependency-free, browser-safe DOCX reader.
+ *
+ * This module deliberately returns a neutral DTO. The editable document model
+ * can consume that DTO without making the ZIP/XML reader depend on it (or on a
+ * Node-only OOXML library). Unsupported fidelity-bearing content fails closed.
+ */
+import type { DocumentOpaqueContent } from "./document-docx-api.js";
+export type DocxImportLimits = {
+    maxCompressedBytes: number;
+    maxEntries: number;
+    maxEntryCompressedBytes: number;
+    maxEntryUncompressedBytes: number;
+    maxTotalUncompressedBytes: number;
+    maxCompressionRatio: number;
+    maxXmlBytes: number;
+    maxTotalXmlBytes: number;
+    maxRetainedXmlCharacters: number;
+    maxXmlNodes: number;
+    maxXmlDepth: number;
+    maxXmlAttributesPerElement: number;
+    maxRelationshipsPerPart: number;
+    maxTotalRelationships: number;
+    maxBlocks: number;
+    maxTextCharacters: number;
+    maxSections: number;
+    maxProjectedStoryBlocks: number;
+    maxProjectedStoryCharacters: number;
+    maxStyles: number;
+    maxStyleInheritanceDepth: number;
+    maxNumberingDefinitions: number;
+    maxComments: number;
+    maxProjectedCommentWork: number;
+};
+export type DocxImportErrorCode = "invalid_input" | "invalid_zip" | "limit_exceeded" | "invalid_xml" | "invalid_package" | "unsupported_feature" | "unsupported_platform";
+export declare class DocxImportError extends Error {
+    readonly code: DocxImportErrorCode;
+    readonly partName?: string | undefined;
+    readonly name = "DocxImportError";
+    constructor(code: DocxImportErrorCode, message: string, partName?: string | undefined);
+}
+export type ImportedDocument = {
+    format: "docx";
+    schemaVersion: 1;
+    evenAndOddHeaders: boolean;
+    trackRevisions: boolean;
+    blocks: ImportedBlock[];
+    sections: ImportedSection[];
+    styles: ImportedStyle[];
+    lists: ImportedListDefinition[];
+    headers: ImportedHeaderFooter[];
+    footers: ImportedHeaderFooter[];
+    comments: ImportedComment[];
+    trackedChanges: ImportedTrackedChange[];
+    opaqueContent: DocumentOpaqueContent;
+};
+export type ImportedBlock = ImportedParagraph | ImportedTable | ImportedPageBreak;
+export type ImportedParagraph = {
+    kind: "paragraph";
+    id: string;
+    styleId?: string;
+    style: ImportedParagraphStyle;
+    inlines: ImportedInline[];
+    commentAnchors: ImportedCommentAnchor[];
+};
+export type ImportedInline = ImportedRun | ImportedPageBreak;
+export type ImportedRun = {
+    kind: "run";
+    text: string;
+    styleId?: string;
+    style: ImportedRunStyle;
+    changeId?: string;
+};
+export type ImportedPageBreak = {
+    kind: "pageBreak";
+};
+export type ImportedTable = {
+    kind: "table";
+    id: string;
+    styleId?: string;
+    width?: ImportedMeasure;
+    indent?: ImportedMeasure;
+    alignment?: string;
+    layout?: "fixed" | "autofit";
+    cellMargins?: ImportedBoxMeasures;
+    borders?: ImportedTableBorders;
+    gridColumnWidthsPt: number[];
+    rows: ImportedTableRow[];
+};
+export type ImportedTableRow = {
+    header: boolean;
+    cannotSplit: boolean;
+    heightPt?: number;
+    heightRule?: "auto" | "atLeast" | "exact";
+    cells: ImportedTableCell[];
+};
+export type ImportedTableCell = {
+    width?: ImportedMeasure;
+    margins?: ImportedBoxMeasures;
+    columnSpan: number;
+    verticalMerge?: "restart" | "continue";
+    verticalAlignment?: string;
+    fill?: string;
+    blocks: ImportedBlock[];
+};
+export type ImportedMeasure = {
+    value: number;
+    unit: "pt" | "percent" | "auto";
+};
+export type ImportedBoxMeasures = {
+    top?: ImportedMeasure;
+    right?: ImportedMeasure;
+    bottom?: ImportedMeasure;
+    left?: ImportedMeasure;
+    start?: ImportedMeasure;
+    end?: ImportedMeasure;
+};
+export type ImportedBorder = {
+    style: string;
+    color?: string;
+    sizePt?: number;
+    spacePt?: number;
+    shadow?: boolean;
+    frame?: boolean;
+};
+export type ImportedTableBorders = {
+    top?: ImportedBorder;
+    right?: ImportedBorder;
+    bottom?: ImportedBorder;
+    left?: ImportedBorder;
+    insideHorizontal?: ImportedBorder;
+    insideVertical?: ImportedBorder;
+};
+export type ImportedParagraphStyle = {
+    alignment?: string;
+    spaceBeforePt?: number;
+    spaceAfterPt?: number;
+    line?: number;
+    lineRule?: string;
+    indentLeftPt?: number;
+    indentRightPt?: number;
+    firstLinePt?: number;
+    hangingPt?: number;
+    keepNext?: boolean;
+    keepLines?: boolean;
+    pageBreakBefore?: boolean;
+    outlineLevel?: number;
+    bidirectional?: boolean;
+    list?: {
+        numId: string;
+        level: number;
+    };
+};
+export type ImportedRunStyle = {
+    fontFamily?: string;
+    fontSizePt?: number;
+    fontSizeComplexScriptPt?: number;
+    color?: string;
+    bold?: boolean;
+    boldComplexScript?: boolean;
+    italic?: boolean;
+    italicComplexScript?: boolean;
+    underline?: string;
+    strike?: boolean;
+    highlight?: string;
+    verticalAlign?: string;
+    language?: string;
+};
+export type ImportedStyle = {
+    styleId: string;
+    kind: string;
+    name?: string;
+    basedOn?: string;
+    next?: string;
+    isDefault: boolean;
+    paragraph: ImportedParagraphStyle;
+    run: ImportedRunStyle;
+};
+export type ImportedListLevel = {
+    level: number;
+    start: number;
+    restart?: number;
+    legal?: boolean;
+    alignment?: string;
+    format?: string;
+    text?: string;
+    suffix?: string;
+    paragraphStyleId?: string;
+    paragraph: ImportedParagraphStyle;
+    run: ImportedRunStyle;
+};
+export type ImportedListDefinition = {
+    numId: string;
+    abstractNumId: string;
+    levels: ImportedListLevel[];
+    overrides: Array<{
+        level: number;
+        start?: number;
+        definition?: ImportedListLevel;
+    }>;
+};
+export type ImportedSection = {
+    startBlockIndex: number;
+    endBlockIndex: number;
+    type?: string;
+    titlePage: boolean;
+    page: {
+        widthPt: number;
+        heightPt: number;
+        orientation?: string;
+        marginTopPt: number;
+        marginRightPt: number;
+        marginBottomPt: number;
+        marginLeftPt: number;
+        headerPt: number;
+        footerPt: number;
+        gutterPt: number;
+    };
+    headers: ImportedSectionReference[];
+    footers: ImportedSectionReference[];
+};
+export type ImportedSectionReference = {
+    kind: string;
+    relationshipId: string;
+    partName: string;
+};
+export type ImportedHeaderFooter = {
+    kind: "header" | "footer";
+    partName: string;
+    blocks: ImportedBlock[];
+};
+export type ImportedCommentAnchor = {
+    commentId: string;
+    kind: "start" | "end" | "reference";
+    textOffset: number;
+};
+export type ImportedComment = {
+    id: string;
+    parentId?: string;
+    resolved?: boolean;
+    author?: string;
+    initials?: string;
+    createdAt?: string;
+    blocks: ImportedBlock[];
+};
+export type ImportedTrackedChange = {
+    id: string;
+    kind: "insert" | "delete";
+    author?: string;
+    createdAt?: string;
+    blockId: string;
+    startInlineIndex: number;
+    endInlineIndex: number;
+    startTextOffset: number;
+    endTextOffset: number;
+};
+/**
+ * Imports the fidelity-bearing, editable WordprocessingML subset into a neutral
+ * DTO. The function has no Node imports and is suitable for a browser worker.
+ */
+export declare function importDocx(input: Blob | ArrayBuffer, options?: Partial<DocxImportLimits>): Promise<ImportedDocument>;

package/dist/document-docx-packer.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Narrow adapter around the pinned `docx` compiler.
+ *
+ * `docx`'s public Packer hard-codes DEFLATE, which can make valid repetitive
+ * text exceed our secure importer's 100:1 ceiling. Its pinned compiler already
+ * produces a JSZip-compatible archive, so generate those exact OOXML parts as
+ * STORE. If that controlled runtime contract changes, fail closed instead of
+ * silently shipping a second ZIP implementation or masking the incompatibility.
+ */
+export type DocxXmlOverride = {
+    path: string;
+    data: string;
+};
+export declare class DocxExportCompatibilityError extends Error {
+    readonly name = "DocxExportCompatibilityError";
+    readonly code: "incompatible_docx_runtime";
+}
+export declare function packDocxWithBoundedCompression(file: unknown, packer: unknown, overrides?: readonly DocxXmlOverride[]): Promise<Uint8Array>;

package/dist/document-docx-state.d.ts

@@ -0,0 +1,12 @@
+import type { Document } from "./document.js";
+import { type DocumentFidelityIssue, type DocumentLossPreservationEnvelope, type DocumentOpaqueContent } from "./document-docx-api.js";
+export type DocumentLossPreservationState = {
+    sourceBytes: Uint8Array;
+    sourceDigest: string;
+    importedRevision: number;
+    opaqueContent: DocumentOpaqueContent;
+    modelDigest: string;
+};
+export declare const DOCUMENT_LOSS_PRESERVATION: WeakMap<Document, DocumentLossPreservationState>;
+export declare function documentFidelityReport(document: Document): readonly DocumentFidelityIssue[];
+export declare function documentLossPreservationEnvelope(document: Document): DocumentLossPreservationEnvelope | null;

package/dist/document-render.d.ts

@@ -0,0 +1,3 @@
+import { FileBlob } from "./file-blob.js";
+import { Document, type DocumentRenderOptions } from "./document.js";
+export declare function renderDocument(document: Document, options?: DocumentRenderOptions): Promise<FileBlob>;