@syncfusion/ej2-office-common 35.1.37

package/src/features/smart-art/namespaces.d.ts

@@ -0,0 +1,153 @@
+/**
+ * DrawingML diagram (SmartArt) package constants — Transitional Office Open XML.
+ *
+ * @remarks
+ * Values are taken from the local standards corpus only. Do not invent content
+ * types, relationship URIs, or namespaces.
+ *
+ * Citations:
+ * - Content types: ECMA-376 Part 1 §14.2.3–14.2.6
+ * - Root NS + relationship types: ECMA-376 Part 4 §12.2.3–12.2.6
+ * - GraphicData URI → `relIds`: [MS-OE376] diagram URI table; [MS-ODRAWXML] §3.7.1
+ *
+ * @see docs/ooxml-mapping/smart-art.md
+ *
+ * @packageDocumentation
+ */
+/**
+ * Transitional DrawingML diagram namespace (typical prefix `dgm`).
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.3–12.2.6 list this URI as the root namespace for the
+ * Diagram Colors, Data, Layout Definition, and Style parts.
+ *
+ * @public
+ */
+export declare const DIAGRAM_NAMESPACE = "http://schemas.openxmlformats.org/drawingml/2006/diagram";
+/**
+ * DrawingML main namespace (typical prefix `a`) for `a:graphic` / `a:graphicData`.
+ *
+ * @remarks
+ * Used when identifying diagram hooks: `a:graphicData@uri` equals
+ * {@link DIAGRAM_GRAPHIC_DATA_URI} ([MS-OE376], [MS-ODRAWXML] §3.7.1).
+ *
+ * @public
+ */
+export declare const DRAWINGML_MAIN_NAMESPACE = "http://schemas.openxmlformats.org/drawingml/2006/main";
+/**
+ * Office document relationships namespace (typical prefix `r`).
+ *
+ * @remarks
+ * `CT_RelIds` attributes `r:dm` / `r:lo` / `r:qs` / `r:cs` are in this namespace
+ * (`shared-relationshipReference.xsd`).
+ *
+ * @public
+ */
+export declare const OFFICE_DOCUMENT_RELATIONSHIPS_NAMESPACE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships";
+/**
+ * `a:graphicData@uri` value that identifies a diagram (`dgm:relIds`) payload.
+ *
+ * @remarks
+ * Same URI as {@link DIAGRAM_NAMESPACE}. Cited in [MS-OE376] (URI → `relIds`)
+ * and [MS-ODRAWXML] §3.7.1 sample markup.
+ *
+ * @public
+ */
+export declare const DIAGRAM_GRAPHIC_DATA_URI = "http://schemas.openxmlformats.org/drawingml/2006/diagram";
+/**
+ * Content type for a Diagram Colors part (`colorsDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.3.
+ *
+ * @public
+ */
+export declare const DIAGRAM_COLORS_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.drawingml.diagramColors+xml";
+/**
+ * Content type for a Diagram Data part (`dataModel` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.4.
+ *
+ * @public
+ */
+export declare const DIAGRAM_DATA_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml";
+/**
+ * Content type for a Diagram Layout Definition part (`layoutDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.5. Layout parts are not shared across diagrams.
+ *
+ * @public
+ */
+export declare const DIAGRAM_LAYOUT_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.drawingml.diagramLayout+xml";
+/**
+ * Content type for a Diagram Style (quick style) part (`styleDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.6.
+ *
+ * @public
+ */
+export declare const DIAGRAM_STYLE_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.drawingml.diagramStyle+xml";
+/**
+ * Relationship type targeting a Diagram Colors part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.3 (Transitional source URI).
+ *
+ * @public
+ */
+export declare const DIAGRAM_COLORS_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramColors";
+/**
+ * Relationship type targeting a Diagram Data part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.4 (Transitional source URI).
+ *
+ * @public
+ */
+export declare const DIAGRAM_DATA_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramData";
+/**
+ * Relationship type targeting a Diagram Layout Definition part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.5 (Transitional source URI).
+ *
+ * @public
+ */
+export declare const DIAGRAM_LAYOUT_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramLayout";
+/**
+ * Relationship type targeting a Diagram Style (quick style) part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.6 (Transitional source URI `diagramQuickStyle`).
+ *
+ * @public
+ */
+export declare const DIAGRAM_QUICK_STYLE_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramQuickStyle";
+/**
+ * Relationship type targeting an Image part (office document package).
+ *
+ * @remarks
+ * ECMA-376 Part 4 Transitional source URI table (`relationships/image`).
+ * Diagram Data parts may reference images (Part 1 §14.2.4); remove uses this
+ * type when reference-counting exclusive vs shared image parts.
+ *
+ * @public
+ */
+export declare const OFFICE_IMAGE_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/image";
+/**
+ * All four diagram part content types (Transitional), in package-scan order.
+ *
+ * @public
+ */
+export declare const DIAGRAM_CONTENT_TYPES: ReadonlyArray<string>;
+/**
+ * All four diagram relationship type URIs (Transitional), matching
+ * `dgm:relIds` roles `cs` / `dm` / `lo` / `qs` respectively when ordered as
+ * colors, data, layout, quick style.
+ *
+ * @public
+ */
+export declare const DIAGRAM_RELATIONSHIP_TYPES: ReadonlyArray<string>;

package/src/features/smart-art/namespaces.js

@@ -0,0 +1,163 @@
+/**
+ * DrawingML diagram (SmartArt) package constants — Transitional Office Open XML.
+ *
+ * @remarks
+ * Values are taken from the local standards corpus only. Do not invent content
+ * types, relationship URIs, or namespaces.
+ *
+ * Citations:
+ * - Content types: ECMA-376 Part 1 §14.2.3–14.2.6
+ * - Root NS + relationship types: ECMA-376 Part 4 §12.2.3–12.2.6
+ * - GraphicData URI → `relIds`: [MS-OE376] diagram URI table; [MS-ODRAWXML] §3.7.1
+ *
+ * @see docs/ooxml-mapping/smart-art.md
+ *
+ * @packageDocumentation
+ */
+/**
+ * Transitional DrawingML diagram namespace (typical prefix `dgm`).
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.3–12.2.6 list this URI as the root namespace for the
+ * Diagram Colors, Data, Layout Definition, and Style parts.
+ *
+ * @public
+ */
+export var DIAGRAM_NAMESPACE = 'http://schemas.openxmlformats.org/drawingml/2006/diagram';
+/**
+ * DrawingML main namespace (typical prefix `a`) for `a:graphic` / `a:graphicData`.
+ *
+ * @remarks
+ * Used when identifying diagram hooks: `a:graphicData@uri` equals
+ * {@link DIAGRAM_GRAPHIC_DATA_URI} ([MS-OE376], [MS-ODRAWXML] §3.7.1).
+ *
+ * @public
+ */
+export var DRAWINGML_MAIN_NAMESPACE = 'http://schemas.openxmlformats.org/drawingml/2006/main';
+/**
+ * Office document relationships namespace (typical prefix `r`).
+ *
+ * @remarks
+ * `CT_RelIds` attributes `r:dm` / `r:lo` / `r:qs` / `r:cs` are in this namespace
+ * (`shared-relationshipReference.xsd`).
+ *
+ * @public
+ */
+export var OFFICE_DOCUMENT_RELATIONSHIPS_NAMESPACE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships';
+/**
+ * `a:graphicData@uri` value that identifies a diagram (`dgm:relIds`) payload.
+ *
+ * @remarks
+ * Same URI as {@link DIAGRAM_NAMESPACE}. Cited in [MS-OE376] (URI → `relIds`)
+ * and [MS-ODRAWXML] §3.7.1 sample markup.
+ *
+ * @public
+ */
+export var DIAGRAM_GRAPHIC_DATA_URI = DIAGRAM_NAMESPACE;
+/**
+ * Content type for a Diagram Colors part (`colorsDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.3.
+ *
+ * @public
+ */
+export var DIAGRAM_COLORS_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.diagramColors+xml';
+/**
+ * Content type for a Diagram Data part (`dataModel` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.4.
+ *
+ * @public
+ */
+export var DIAGRAM_DATA_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.diagramData+xml';
+/**
+ * Content type for a Diagram Layout Definition part (`layoutDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.5. Layout parts are not shared across diagrams.
+ *
+ * @public
+ */
+export var DIAGRAM_LAYOUT_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.diagramLayout+xml';
+/**
+ * Content type for a Diagram Style (quick style) part (`styleDef` root).
+ *
+ * @remarks
+ * ECMA-376 Part 1 §14.2.6.
+ *
+ * @public
+ */
+export var DIAGRAM_STYLE_CONTENT_TYPE = 'application/vnd.openxmlformats-officedocument.drawingml.diagramStyle+xml';
+/**
+ * Relationship type targeting a Diagram Colors part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.3 (Transitional source URI).
+ *
+ * @public
+ */
+export var DIAGRAM_COLORS_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramColors';
+/**
+ * Relationship type targeting a Diagram Data part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.4 (Transitional source URI).
+ *
+ * @public
+ */
+export var DIAGRAM_DATA_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramData';
+/**
+ * Relationship type targeting a Diagram Layout Definition part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.5 (Transitional source URI).
+ *
+ * @public
+ */
+export var DIAGRAM_LAYOUT_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramLayout';
+/**
+ * Relationship type targeting a Diagram Style (quick style) part.
+ *
+ * @remarks
+ * ECMA-376 Part 4 §12.2.6 (Transitional source URI `diagramQuickStyle`).
+ *
+ * @public
+ */
+export var DIAGRAM_QUICK_STYLE_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/diagramQuickStyle';
+/**
+ * Relationship type targeting an Image part (office document package).
+ *
+ * @remarks
+ * ECMA-376 Part 4 Transitional source URI table (`relationships/image`).
+ * Diagram Data parts may reference images (Part 1 §14.2.4); remove uses this
+ * type when reference-counting exclusive vs shared image parts.
+ *
+ * @public
+ */
+export var OFFICE_IMAGE_RELATIONSHIP_TYPE = 'http://schemas.openxmlformats.org/officeDocument/2006/relationships/image';
+/**
+ * All four diagram part content types (Transitional), in package-scan order.
+ *
+ * @public
+ */
+export var DIAGRAM_CONTENT_TYPES = Object.freeze([
+    DIAGRAM_COLORS_CONTENT_TYPE,
+    DIAGRAM_DATA_CONTENT_TYPE,
+    DIAGRAM_LAYOUT_CONTENT_TYPE,
+    DIAGRAM_STYLE_CONTENT_TYPE,
+]);
+/**
+ * All four diagram relationship type URIs (Transitional), matching
+ * `dgm:relIds` roles `cs` / `dm` / `lo` / `qs` respectively when ordered as
+ * colors, data, layout, quick style.
+ *
+ * @public
+ */
+export var DIAGRAM_RELATIONSHIP_TYPES = Object.freeze([
+    DIAGRAM_COLORS_RELATIONSHIP_TYPE,
+    DIAGRAM_DATA_RELATIONSHIP_TYPE,
+    DIAGRAM_LAYOUT_RELATIONSHIP_TYPE,
+    DIAGRAM_QUICK_STYLE_RELATIONSHIP_TYPE,
+]);

package/src/features/smart-art/package-graph.d.ts

@@ -0,0 +1,61 @@
+/**
+ * Host-neutral discovery of DrawingML diagram instances from a package graph.
+ *
+ * @remarks
+ * Locates the four diagram parts (content types / relationship types from
+ * ECMA-376 Part 1 §14.2.3–14.2.6 and Part 4 §12.2.3–12.2.6) and binds them via
+ * `dgm:relIds` (`CT_RelIds`) and/or outbound diagram relationships from a common
+ * source part. Layout parts are never shared across instances (§14.2.5).
+ *
+ * This module does not import PPT/Word/Excel product types. Callers supply a
+ * {@link DiagramPackageGraph} (parts + relationships).
+ *
+ * @public
+ */
+import { DiagramInstance, DiagramPackageGraph, DiagramPackagePart, GetDiagramInstanceOptions } from './types';
+/** Normalize package part names for map keys (leading `/`, no trailing `/`). */
+export declare function normalizePartName(name: string): string;
+/**
+ * Lists diagram instances discoverable from the package graph.
+ *
+ * @remarks
+ * Discovery order:
+ * 1. Complete `dgm:relIds` hooks in part XML (incomplete hooks skipped —
+ *    preserve-on-load).
+ * 2. Source parts with exactly one outbound relationship of each diagram type
+ *    (when not already covered by a relIds binding).
+ *
+ * Layout part names used by more than one instance violate Part 1 §14.2.5;
+ * each binding is still returned so callers can detect the clash.
+ *
+ * Partial graphs (missing target part, wrong content type, incomplete relIds)
+ * do not throw; they simply omit that candidate. Explicit {@link parseDiagramRelIds}
+ * and mutate APIs throw instead.
+ *
+ * @param graph - Host-neutral parts + relationships.
+ * @returns Instances in stable order (first by source part name, then data part name).
+ *
+ * @public
+ */
+export declare function enumerateDiagramInstances(graph: DiagramPackageGraph): ReadonlyArray<DiagramInstance>;
+/**
+ * Resolves a single diagram instance from the package graph.
+ *
+ * @param graph - Host-neutral parts + relationships.
+ * @param options - Match by {@link GetDiagramInstanceOptions.id} and/or
+ * `dataPartName` (normalized). At least one matcher is required.
+ * @returns The instance, or `undefined` when not found.
+ * @throws {DiagramPartError} When no matcher is provided.
+ *
+ * @public
+ */
+export declare function getDiagramInstance(graph: DiagramPackageGraph, options: GetDiagramInstanceOptions): DiagramInstance | undefined;
+/**
+ * Lists package parts whose content type is one of the four diagram types.
+ *
+ * @param graph - Host-neutral package graph.
+ * @returns Matching parts in input order (names normalized on the returned copies).
+ *
+ * @public
+ */
+export declare function listDiagramParts(graph: DiagramPackageGraph): ReadonlyArray<DiagramPackagePart>;