@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/custom-xml/index.d.ts

@@ -0,0 +1,236 @@
+import { WordDocument } from '../document/document';
+import { FeatureBlock } from '../document/feature-block';
+import { FeatureInline } from '../document/feature-inline';
+import { FeatureMultiPackagePart } from '../document/feature-multi-package-part';
+import { BlockContent, Paragraph } from '../document/paragraph';
+import { FeatureInlineParagraphItem, ParagraphItem, TextRange } from '../document/text-range';
+import { FeatureInlineContent } from '../../core/registry/inline-handlers';
+import { OpcPackage } from '../../core/opc/package';
+import { PartName } from '../../core/opc/part-name';
+import { OpenXmlElement } from '../../core/xml/index';
+/**
+ * @private
+ * Transitional custom XML datastore relationship (ECMA-376-1 §15.2.5). */
+export declare const CUSTOM_XML_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXml";
+/**
+ * @private
+ * Strict custom XML datastore relationship. */
+export declare const STRICT_CUSTOM_XML_RELATIONSHIP_TYPE = "http://purl.oclc.org/ooxml/officeDocument/relationships/customXml";
+/**
+ * @private
+ * Transitional custom XML properties relationship (ECMA-376-1 §15.2.6). */
+export declare const CUSTOM_XML_PROPS_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/customXmlProps";
+/**
+ * @private
+ * Strict custom XML properties relationship. */
+export declare const STRICT_CUSTOM_XML_PROPS_RELATIONSHIP_TYPE = "http://purl.oclc.org/ooxml/officeDocument/relationships/customXmlProps";
+/**
+ * @private
+ * Custom XML Data Storage Properties part content type. */
+export declare const CUSTOM_XML_PROPS_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.customXmlProperties+xml";
+/**
+ * @private
+ * Custom XML Data Storage part content type (ECMA-376-1 §15.2.5). */
+export declare const CUSTOM_XML_DATA_CONTENT_TYPE = "application/xml";
+/**
+ * @private
+ * Root namespace for custom XML properties parts. */
+export declare const CUSTOM_XML_PROPS_NAMESPACE = "http://schemas.openxmlformats.org/officeDocument/2006/customXml";
+/**
+ * Custom XML property attribute from `w:customXmlPr/w:attr`.
+ * Preserve-only; not part of the supported public surface.
+ *
+ * @private
+ */
+export interface CustomXmlAttribute {
+    /**
+     * @private
+   * Attribute namespace URI, when present. */
+    readonly uri: string | undefined;
+    /**
+     * @private
+   * Attribute local name (`w:name`). */
+    readonly name: string;
+    /**
+     * @private
+   * Attribute value (`w:val`). */
+    readonly val: string;
+}
+/**
+ * Custom XML wrapper properties read from `w:customXmlPr`.
+ * Preserve-only; not part of the supported public surface.
+ *
+ * @private
+ */
+export declare class CustomXmlProperties {
+    /**
+     * @private
+   * Placeholder text from `w:placeholder/@w:val`, when present. */
+    readonly placeholder: string | undefined;
+    /**
+     * @private
+   * `w:attr` entries under `w:customXmlPr`. */
+    readonly attributes: ReadonlyArray<CustomXmlAttribute>;
+    /**
+     * @private
+     */
+    constructor(placeholder: string | undefined, attributes: ReadonlyArray<CustomXmlAttribute>);
+}
+declare type CustomXmlInlineItem = {
+    readonly type: 'textRange';
+    readonly run: TextRange;
+} | {
+    readonly type: 'opaque';
+    readonly xml: OpenXmlElement;
+} | FeatureInlineContent;
+/**
+ * Preserve-only in-body custom XML wrapper (`w:customXml`) at block or run level.
+ * Markup and children round-trip; bindings are never resolved. No schema
+ * validation, data-source mutation, or binding-editor API is provided.
+ *
+ * @private
+ */
+export declare class CustomXmlMarkup implements FeatureInline, FeatureBlock {
+    /**
+     * @private
+   * `w:element` attribute value. */
+    readonly elementName: string;
+    /**
+     * @private
+   * `w:uri` attribute value, when present. */
+    readonly uri: string | undefined;
+    /**
+     * @private
+   * Parsed `w:customXmlPr`, when present. */
+    readonly properties: CustomXmlProperties | undefined;
+    private readonly customXmlPr;
+    private readonly blocks;
+    private readonly inlines;
+    private readonly preservedXml;
+    /**
+     * @private
+     */
+    constructor(elementName: string, uri: string | undefined, properties: CustomXmlProperties | undefined, customXmlPr: OpenXmlElement | undefined, blocks: BlockContent[] | undefined, inlines: CustomXmlInlineItem[] | undefined, preservedXml: OpenXmlElement | undefined);
+    /**
+     * @private
+   * Block-level inner content, when loaded from a body block. */
+    readonly blockContent: ReadonlyArray<BlockContent> | undefined;
+    /**
+     * @private
+   * Run-level inner content, when loaded from a paragraph inline. */
+    readonly inlineContent: ReadonlyArray<CustomXmlInlineItem> | undefined;
+    /**
+     * @private
+   * Visible paragraph text inside a block wrapper, when present. */
+    readonly firstParagraphText: string | undefined;
+    /**
+     * @private
+     */
+    releaseContent(): void;
+    /**
+     * @private
+   * Serialize to `w:customXml` (or preserved original element). */
+    toOpenXml(): OpenXmlElement;
+}
+/**
+ * One Custom XML item part plus optional properties part.
+ * Preserve-only; not part of the supported public surface.
+ *
+ * @private
+ */
+export declare class CustomXmlStorageItem {
+    /**
+     * @private
+   * Item part name in the package. */
+    readonly partName: PartName;
+    /**
+     * @private
+   * Opaque item payload bytes. */
+    readonly data: Uint8Array;
+    /**
+     * @private
+   * Part content type. */
+    readonly contentType: string;
+    /**
+     * @private
+   * `itemID` from the properties part, when present. */
+    readonly itemId: string | undefined;
+    /**
+     * @private
+   * Linked custom XML properties part name, when present. */
+    readonly propertiesPartName: PartName | undefined;
+    /**
+     * @private
+   * Opaque properties-part bytes, when present. */
+    readonly propertiesData: Uint8Array | undefined;
+    /**
+     * @private
+   * Properties-part content type, when present. */
+    readonly propertiesContentType: string | undefined;
+    /**
+     * @private
+     */
+    constructor(partNameValue: PartName, data: Uint8Array, contentType: string, itemId: string | undefined, propertiesPartName: PartName | undefined, propertiesData: Uint8Array | undefined, propertiesContentType: string | undefined);
+}
+/**
+ * Preserve-only Custom XML datastore catalog linked from the Main Document.
+ * Items round-trip as opaque bytes; no mutation or binding API is provided.
+ * Not part of the supported public surface.
+ *
+ * @private
+ */
+export declare class CustomXmlDatastore implements FeatureMultiPackagePart {
+    private readonly storageItems;
+    /**
+     * @private
+     */
+    constructor(storageItems: ReadonlyArray<CustomXmlStorageItem>);
+    /**
+     * @private
+   * Loaded datastore items in relationship order. */
+    readonly items: ReadonlyArray<CustomXmlStorageItem>;
+    /**
+     * @private
+     */
+    isDirty(): boolean;
+    /**
+     * @private
+     */
+    applyToPackage(pkg: OpcPackage, mainPartName: PartName): OpcPackage;
+}
+/**
+ * @private
+ * Test hook */
+export declare function resetCustomXmlFeatureForTests(): void;
+/**
+ * @private
+ * Register custom XML markup and datastore handlers. Idempotent. */
+export declare function registerCustomXmlFeature(): void;
+/**
+ * Custom XML datastore linked from the Main Document.
+ * Returns the preserve-only catalog; not part of the supported public surface.
+ *
+ * @private
+ */
+export declare function customXmlDatastore(document: WordDocument): CustomXmlDatastore;
+/**
+ * Block-level custom XML wrappers in a block list, in document order.
+ *
+ * @private
+ */
+export declare function customXmlMarkupInBlocks(blocks: ReadonlyArray<BlockContent>): ReadonlyArray<CustomXmlMarkup>;
+/**
+ * Run-level custom XML wrappers in a paragraph, in document order.
+ *
+ * @private
+ */
+export declare function customXmlMarkupInParagraph(paragraph: Paragraph): ReadonlyArray<CustomXmlMarkup>;
+/**
+ * Whether inline content is modeled custom XML from this module.
+ *
+ * @private
+ */
+export declare function isCustomXmlMarkupInline(inline: ParagraphItem): inline is FeatureInlineParagraphItem & {
+    value: CustomXmlMarkup;
+};
+export {};