@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

package/src/features/ole-object/relationship.d.ts

@@ -0,0 +1,27 @@
+/**
+ * OLE-object relationship constant shared between the module index and the
+ * package catalog (keeps `catalog.ts` import-clean of the index barrel).
+ *
+ * Transitional relationship type for an embedded/linked OLE object part —
+ * ECMA-376-1 §15.2.10 (Embedded Object Part); cited in
+ * `docs/ooxml-mapping/ole-object.md`.
+ *
+ * @private
+ */
+/**
+ * Transitional relationship type for an embedded/linked OLE object part.
+ *
+ * Source: ECMA-376-1 §15.2.10 relationship vocabulary —
+ * `http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject`.
+ *
+ * @private
+ */
+export declare const OLE_OBJECT_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject";
+/**
+ * Long-path linked OLE relationship variant ([MS-OI29500] product behavior;
+ * Excel `oleObjectLinkLongPath`). Accepted on load as an alias of the
+ * transitional oleObject link relationship; **never emitted** on save.
+ *
+ * @private
+ */
+export declare const OLE_OBJECT_LINK_LONG_PATH_RELATIONSHIP_TYPE = "http://schemas.microsoft.com/office/2019/04/relationships/oleObjectLinkLongPath";

package/src/features/ole-object/relationship.js

@@ -0,0 +1,27 @@
+/**
+ * OLE-object relationship constant shared between the module index and the
+ * package catalog (keeps `catalog.ts` import-clean of the index barrel).
+ *
+ * Transitional relationship type for an embedded/linked OLE object part —
+ * ECMA-376-1 §15.2.10 (Embedded Object Part); cited in
+ * `docs/ooxml-mapping/ole-object.md`.
+ *
+ * @private
+ */
+/**
+ * Transitional relationship type for an embedded/linked OLE object part.
+ *
+ * Source: ECMA-376-1 §15.2.10 relationship vocabulary —
+ * `http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject`.
+ *
+ * @private
+ */
+export var OLE_OBJECT_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/oleObject';
+/**
+ * Long-path linked OLE relationship variant ([MS-OI29500] product behavior;
+ * Excel `oleObjectLinkLongPath`). Accepted on load as an alias of the
+ * transitional oleObject link relationship; **never emitted** on save.
+ *
+ * @private
+ */
+export var OLE_OBJECT_LINK_LONG_PATH_RELATIONSHIP_TYPE = 'http://schemas.microsoft.com/office/2019/04/relationships/oleObjectLinkLongPath';

package/src/features/ole-object/typed-dom.d.ts

@@ -0,0 +1,186 @@
+import { OpenXmlAttribute, OpenXmlElement } from '../../core/xml/index';
+/**
+ * Office namespace for VML Office Drawing / `o:OLEObject`.
+ *
+ * Source: transitional `vml-officeDrawing.xsd` `targetNamespace`
+ * (`urn:schemas-microsoft-com:office:office`).
+ */
+export declare const OFFICE_OLE_NAMESPACE = "urn:schemas-microsoft-com:office:office";
+/**
+ * Kind of OLE object connection (`o:OLEObject/@Type`, `ST_OLEType`:
+ * `Embed` | `Link`; the WML-native form encodes the same choice as
+ * `w:objectEmbed` vs `w:objectLink` element selection).
+ *
+ * @private
+ */
+export declare const OleLinkType: {
+    /** Embedded storage part (`word/embeddings/*.bin`). */
+    Embed: "embed";
+    /** External link target (stored, never fetched). */
+    Link: "link";
+};
+/**
+ * Kind of OLE object connection (see {@link OleLinkType}).
+ *
+ * @private
+ */
+export declare type OleLinkType = (typeof OleLinkType)[keyof typeof OleLinkType];
+/**
+ * Visual representation of the object (`o:OLEObject/@DrawAspect`,
+ * `ST_OLEDrawAspect`: `Content` | `Icon`; WML-native `drawAspect` uses the
+ * lowercase tokens `content` | `icon` — both decode to this enum).
+ *
+ * @private
+ */
+export declare const OleDrawAspect: {
+    /** Render the object's current content. */
+    Content: string;
+    /** Render a placeholder icon. */
+    Icon: string;
+};
+/**
+ * Visual representation of the object (see {@link OleDrawAspect}).
+ *
+ * @private
+ */
+export declare type OleDrawAspect = (typeof OleDrawAspect)[keyof typeof OleDrawAspect];
+/**
+ * Link refresh mode (`o:OLEObject/@UpdateMode`, `ST_OLEUpdateMode`:
+ * `Always` | `OnCall`; WML-native `updateMode`: `always` | `onCall`).
+ * Meaningful for linked objects only.
+ *
+ * @private
+ */
+export declare const OleUpdateMode: {
+    /** Update automatically. */
+    Always: "always";
+    /** Update on caller request. */
+    OnCall: "onCall";
+};
+/**
+ * Link refresh mode (see {@link OleUpdateMode}).
+ *
+ * @private
+ */
+export declare type OleUpdateMode = (typeof OleUpdateMode)[keyof typeof OleUpdateMode];
+/**
+ * Which schema encoding the stored `w:object` carries its OLE reference in.
+ *
+ * Fixed at load; typed edits never convert forms (no corpus evidence Word
+ * reads one encoding as the other within a document).
+ *
+ * @private
+ */
+export declare type OleWireForm = 'office' | 'wml';
+/**
+ * Internal mutable state parsed from (and patched back onto) the stored
+ * `w:object` element. The typed `OleObject` class in `index.ts` delegates
+ * here; this type is not part of the public surface.
+ *
+ * @private
+ */
+export interface OleObjectDomState {
+    /** The stored `w:object` element (byte-preserved outside modeled edits). */
+    element: OpenXmlElement;
+    /** The OLE child element (`o:OLEObject` / `w:objectEmbed` / `w:objectLink`). */
+    oleElement: OpenXmlElement;
+    /** Which encoding `oleElement` uses. */
+    wireForm: OleWireForm;
+}
+/**
+ * Resolve the OLE child of a `w:object` element and its wire form.
+ * Returns `undefined` when no recognized OLE child exists (the element
+ * stays opaque per the TASK-8022 rule).
+ *
+ * @private
+ */
+export declare function resolveOleChild(element: OpenXmlElement): {
+    oleElement: OpenXmlElement;
+    wireForm: OleWireForm;
+} | undefined;
+/** Initial DOM state parsed at load (no mutation). */
+export declare function parseOleObjectDomState(element: OpenXmlElement, oleElement: OpenXmlElement, wireForm: OleWireForm): OleObjectDomState;
+/** Read `@Type` / element choice as a typed link kind. */
+export declare function readLinkType(state: OleObjectDomState): OleLinkType | undefined;
+/** Read `@ProgID` (office) / `@progId` (wml). */
+export declare function readProgId(state: OleObjectDomState): string | undefined;
+/** Read `@ShapeID` (office) / `@shapeId` (wml). */
+export declare function readShapeId(state: OleObjectDomState): string | undefined;
+/** Read `@DrawAspect` / `@drawAspect` in either casing. */
+export declare function readDrawAspect(state: OleObjectDomState): OleDrawAspect | undefined;
+/**
+ * Read `@ObjectID` (office form only; no WML-native counterpart — Office
+ * regenerates it per save and does not support it on linked objects,
+ * [MS-OI29500] §2.1.1834).
+ */
+export declare function readObjectId(state: OleObjectDomState): string | undefined;
+/** Read `@UpdateMode` (office) / required `@updateMode` (wml link). */
+export declare function readUpdateMode(state: OleObjectDomState): OleUpdateMode | undefined;
+/**
+ * Read `o:LockedField` child (office) / `@lockedField` (wml link).
+ * Returns `undefined` when absent or unparseable (residual).
+ */
+export declare function readLockedField(state: OleObjectDomState): boolean | undefined;
+/** Read `o:LinkType` child (office form only; `ST_OLELinkType` is a string). */
+export declare function readLinkTypeDescription(state: OleObjectDomState): string | undefined;
+/** Read `o:FieldCodes` child (office) / `@fieldCodes` (wml). */
+export declare function readFieldCodes(state: OleObjectDomState): string | undefined;
+/**
+ * Read `w:object/@dxaOrig` as points (accepts WML-qualified and unqualified
+ * spellings — the schema declares it unqualified; Word writes `w:`-prefixed
+ * in practice).
+ */
+export declare function readOriginalWidth(state: OleObjectDomState): number | undefined;
+/** Read `w:object/@dyaOrig` as points (qualified/unqualified tolerant). */
+export declare function readOriginalHeight(state: OleObjectDomState): number | undefined;
+/**
+ * Apply a set of modeled mutations in one structural pass.
+ *
+ * Every setter builds a `mutation` describing which modeled member changes;
+ * this function clones the stored tree once and patches exactly those
+ * members, leaving every other attribute/child byte-identical (patch-in-place
+ * serialization rule, TASK-8053 spec).
+ *
+ * @private
+ */
+export interface OleDomMutation {
+    /** `@Type` (office only — the WML form encodes the choice in the element name). */
+    readonly type?: OleLinkType | undefined;
+    /** `@ProgID` / `@progId`. */
+    readonly progId?: string | undefined;
+    /** `@ShapeID` / `@shapeId`. */
+    readonly shapeId?: string | undefined;
+    /** `@DrawAspect` / `@drawAspect` (undefined clears). */
+    readonly drawAspect?: OleDrawAspect | undefined;
+    /** `@ObjectID` (office only; undefined clears). */
+    readonly objectId?: string | undefined;
+    /** `@UpdateMode` / `@updateMode` (undefined clears where the form allows absence). */
+    readonly updateMode?: OleUpdateMode | undefined;
+    /** `o:LockedField` / `@lockedField` (undefined clears). */
+    readonly lockedField?: boolean | undefined;
+    /** `o:LinkType` / (undefined clears; office only). */
+    readonly linkTypeDescription?: string | undefined;
+    /** `o:FieldCodes` / `@fieldCodes` (undefined clears). */
+    readonly fieldCodes?: string | undefined;
+    /** `w:object/@dxaOrig` in points (undefined clears; serialized as twips). */
+    readonly originalWidth?: number | undefined;
+    /** `w:object/@dyaOrig` in points (undefined clears; serialized as twips). */
+    readonly originalHeight?: number | undefined;
+}
+/**
+ * Patch the DOM state with the given mutations and return the next state
+ * (new element + oleElement references; previous tree untouched).
+ *
+ * @private
+ */
+export declare function applyOleDomMutations(state: OleObjectDomState, mutations: OleDomMutation): OleObjectDomState;
+/** Exported for the class: attribute lookup helper (namespace-qualified). */
+export declare function oleAttributeValue(el: OpenXmlElement, namespaceUri: string, localName: string): string | undefined;
+/** Exported for the class: element children helper. */
+export declare function oleElementChildren(el: OpenXmlElement): ReadonlyArray<OpenXmlElement>;
+/** Exported for the class: explicit-false detection for LockedField. */
+export declare function oleIsExplicitFalse(value: string): boolean;
+/**
+ * @private
+ * Re-export attribute type for the class file. */
+export { OpenXmlAttribute };