@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/properties/index.d.ts

@@ -0,0 +1,205 @@
+import { WordDocument } from '../document/document';
+import { FeaturePackageLevelPart } from '../document/feature-package-level-part';
+import { RelationshipId } from '../../core/opc/relationships';
+import { PartName } from '../../core/opc/part-name';
+import { OpcPackage } from '../../core/opc/package';
+import { NamespaceDeclaration, OpenXmlAttribute, OpenXmlElement } from '../../core/xml/index';
+/**
+ * @private
+ * Package core properties relationship (ECMA-376-2 §11). */
+export declare const CORE_PROPERTIES_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties";
+/**
+ * @private
+ * Extended properties relationship (ECMA-376-1 §15.2.12.3). */
+export declare const EXTENDED_PROPERTIES_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties";
+/**
+ * @private
+ * Custom properties relationship (ECMA-376-1 §15.2.12.2). */
+export declare const CUSTOM_PROPERTIES_RELATIONSHIP_TYPE = "http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties";
+/**
+ * @private
+ * ECMA-376-2 core properties content type. */
+export declare const CORE_PROPERTIES_CONTENT_TYPE = "application/vnd.openxmlformats-package.core-properties+xml";
+/**
+ * @private
+ * ECMA-376-1 extended properties content type. */
+export declare const EXTENDED_PROPERTIES_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.extended-properties+xml";
+/**
+ * @private
+ * ECMA-376-1 custom properties content type. */
+export declare const CUSTOM_PROPERTIES_CONTENT_TYPE = "application/vnd.openxmlformats-officedocument.custom-properties+xml";
+/**
+ * @private
+ */
+export declare const CORE_PROPERTIES_PART_NAME: PartName;
+/**
+ * @private
+ */
+export declare const EXTENDED_PROPERTIES_PART_NAME: PartName;
+/**
+ * @private
+ */
+export declare const CUSTOM_PROPERTIES_PART_NAME: PartName;
+/**
+ * In-memory core file properties (`docProps/core.xml`).
+ * Package infrastructure used by document-level property helpers; not a public
+ * mutation surface. Prefer `documentTitle` / `setDocumentTitle` and siblings.
+ *
+ * @private
+ */
+export declare class CoreProperties {
+    private readonly rootAttributes;
+    private readonly rootNamespaceDeclarations;
+    private readonly opaque;
+    private titleValue;
+    private creatorValue;
+    private subjectValue;
+    private descriptionValue;
+    private keywordsValue;
+    private dirty;
+    /**
+     * @private
+     */
+    constructor(rootAttributes: ReadonlyArray<OpenXmlAttribute>, rootNamespaceDeclarations: ReadonlyArray<NamespaceDeclaration>, opaque: OpenXmlElement[], title: string | undefined, creator: string | undefined, subject: string | undefined, description: string | undefined, keywords: string | undefined, dirty: boolean);
+    /**
+     * @private
+   * Dublin Core title (`dc:title`), if present. */
+    /**
+    * @private
+    */
+    title: string | undefined;
+    /**
+     * @private
+   * Dublin Core creator (`dc:creator`), if present. */
+    /**
+    * @private
+    */
+    creator: string | undefined;
+    /**
+     * @private
+   * Dublin Core subject (`dc:subject`), if present. */
+    /**
+    * @private
+    */
+    subject: string | undefined;
+    /**
+     * @private
+   * Dublin Core description (`dc:description`), if present. */
+    /**
+    * @private
+    */
+    description: string | undefined;
+    /**
+     * @private
+   * Core keywords (`cp:keywords`), if present. */
+    /**
+    * @private
+    */
+    keywords: string | undefined;
+    /**
+     * @private
+     */
+    isDirty(): boolean;
+    /**
+     * @private
+     */
+    markClean(): void;
+    /**
+     * @private
+     */
+    serialize(): Uint8Array;
+}
+/**
+ * File properties parts for a document package.
+ *
+ * @private
+ */
+export declare class PropertiesParts implements FeaturePackageLevelPart {
+    private coreValue;
+    private corePartName;
+    private coreRelationshipId;
+    private corePendingRelationship;
+    /**
+     * @private
+     */
+    constructor(core: CoreProperties, corePartName: PartName, coreRelationshipId: RelationshipId | undefined);
+    /** Core Dublin Core properties. */
+    readonly core: CoreProperties;
+    /**
+     * @private
+     */
+    isDirty(): boolean;
+    /**
+     * @private
+     */
+    ensureCorePart(pkg: OpcPackage): void;
+    /**
+     * @private
+     */
+    applyToPackage(pkg: OpcPackage): OpcPackage;
+}
+/**
+ * @private
+ * Test hook */
+export declare function resetPropertiesFeatureForTests(): void;
+/**
+ * @private
+ * Register the file properties package-part handler. Idempotent. */
+export declare function registerPropertiesFeature(): void;
+/**
+ * File properties for a document. Requires {@link registerPropertiesFeature}.
+ *
+ * @throws DocxError `UNKNOWN_FEATURE` when the module was not registered before load.
+ * @private
+ */
+export declare function propertiesFor(document: WordDocument): PropertiesParts;
+/**
+ * WordDocument title (`dc:title`).
+ * @private
+ */
+export declare function documentTitle(document: WordDocument): string | undefined;
+/**
+ * Set document title (`dc:title`).
+ * @private
+ */
+export declare function setDocumentTitle(document: WordDocument, title: string | undefined): void;
+/**
+ * WordDocument creator (`dc:creator`).
+ * @private
+ */
+export declare function documentCreator(document: WordDocument): string | undefined;
+/**
+ * Set document creator (`dc:creator`).
+ * @private
+ */
+export declare function setDocumentCreator(document: WordDocument, creator: string | undefined): void;
+/**
+ * WordDocument subject (`dc:subject`).
+ * @private
+ */
+export declare function documentSubject(document: WordDocument): string | undefined;
+/**
+ * Set document subject (`dc:subject`).
+ * @private
+ */
+export declare function setDocumentSubject(document: WordDocument, subject: string | undefined): void;
+/**
+ * WordDocument description (`dc:description`).
+ * @private
+ */
+export declare function documentDescription(document: WordDocument): string | undefined;
+/**
+ * Set document description (`dc:description`).
+ * @private
+ */
+export declare function setDocumentDescription(document: WordDocument, description: string | undefined): void;
+/**
+ * WordDocument keywords (`keywords`).
+ * @private
+ */
+export declare function documentKeywords(document: WordDocument): string | undefined;
+/**
+ * Set document keywords (`keywords`).
+ * @private
+ */
+export declare function setDocumentKeywords(document: WordDocument, keywords: string | undefined): void;