@patrickdk77/office-defuse 0.1.1 → 0.2.0

package/dist/ooxml.d.ts

@@ -1,5 +1,86 @@
 import { type ZipContext } from './context';
+import { type XmlElement } from './xml';
 import { type ZipEntry } from './zip';
+export declare const CONTENT_TYPES_NS = "http://schemas.openxmlformats.org/package/2006/content-types";
+export declare const RELS_NS = "http://schemas.openxmlformats.org/package/2006/relationships";
+/** The relationship types that name an XPS package's FixedDocumentSequence, lowercased. */
+export declare const XPS_MAIN: {
+    xps: string;
+    oxps: string;
+};
+/** The XPS and OpenXPS markup namespaces, lowercased. */
+export declare const XPS_NS: Set<string>;
+/** Relationship types, lowercased, as OPC compares them without regard to case. */
+export declare const REL: {
+    main: Set<string>;
+    hyperlink: Set<string>;
+    template: Set<string>;
+    image: Set<string>;
+    frame: Set<string>;
+    subDocument: Set<string>;
+    workbook: Set<string>;
+};
+/** Content types, lowercased. */
+export declare const TYPE: {
+    vba: Set<string>;
+    macrosheet: Set<string>;
+    ole: Set<string>;
+    control: Set<string>;
+    controlBinary: Set<string>;
+    vml: string;
+    xlsbExternalLink: string;
+};
+/** Whether the rules read a part of this content type as XML. */
+export declare const isXmlType: (ct: string | undefined) => boolean;
+export declare const WORD_NS: Set<string>;
+export declare const SHEET_NS: Set<string>;
+export declare const R_NS: Set<string>;
+export interface Relationship {
+    id: string;
+    type: string;
+    target: string;
+    external: boolean;
+}
+export interface Part {
+    entry: ZipEntry;
+    contentType?: string;
+    /** The AS bits of the relationship types that reach the part. */
+    reachedAs: number;
+    /** A relationship of an ActiveX control part reaches it, so it is that control's binary. */
+    claimed: boolean;
+    /** The parts its own relationships reach. */
+    targets: Set<Part>;
+    ole: boolean;
+}
+/** What the rewrite needs of an OOXML package: its parts, which part each relationships part belongs to, and the roots. */
+export interface OoxmlGraph {
+    contentTypes: ZipEntry;
+    parts: Map<string, Part>;
+    relsOf: Map<string, ZipEntry>;
+    /** The parts the package relationships reach. */
+    roots: Set<Part>;
+    /** The package uses the relationship types of Strict OOXML. */
+    strict: boolean;
+    /** The package is XPS or OpenXPS, whose parts name the parts they use in attributes. */
+    xps: boolean;
+}
+/** The key of the part a relationships part belongs to, '' for the package, or undefined for any other part. */
+export declare const relsSource: (relsName: string) => string | undefined;
+/**
+ * Resolves an internal target against the folder of the part it belongs to, as RFC 3986 resolves a relative
+ * reference: a ".." at the root of the package stays at the root. LibreOffice writes "../customXml/item1.xml" in the
+ * package relationships of workbooks it saves.
+ */
+export declare function resolveTarget(relsName: string, target: string): string;
+/** A reference in an XPS part to another part: an absolute part name, or a path relative to the part's folder. */
+export declare function resolvePartRef(part: string, ref: string): string;
+/**
+ * The resources an XPS element names in its attributes, as the attribute and the URI: a document, page or resource
+ * dictionary's Source, a font's FontUri, an image brush's image and profile, and a ContextColor's profile.
+ */
+export declare function xpsResources(el: XmlElement): Array<[string, string]>;
+/** Reads a relationships part and hands each relationship to `each` as it is read. Ids given twice are reported. */
+export declare function readRelationships(ctx: ZipContext, entry: ZipEntry, each: (r: Relationship) => void): Promise<void>;
 /**
  * Inspects an OOXML package. The package relationships come first, since they name the main part and so the format.
  * Then each part is read in archive order, followed by its relationships, which are reported as they are read and