329 lines
12 KiB
TypeScript
329 lines
12 KiB
TypeScript
import { AppProperties } from "./app-properties/app-properties";
|
|
import { ContentTypes } from "./content-types/content-types";
|
|
import { CoreProperties, IPropertiesOptions } from "./core-properties";
|
|
import { CustomProperties } from "./custom-properties";
|
|
import { DocumentWrapper } from "./document-wrapper";
|
|
import {
|
|
FooterReferenceType,
|
|
HeaderReferenceType,
|
|
IPageSizeAttributes,
|
|
SectionPropertiesOptions,
|
|
} from "./document/body/section-properties";
|
|
import { IPageMarginAttributes } from "./document/body/section-properties/page-margin/page-margin-attributes";
|
|
import { IFileProperties } from "./file-properties";
|
|
import { FooterWrapper, IDocumentFooter } from "./footer-wrapper";
|
|
import { FootnotesWrapper } from "./footnotes-wrapper";
|
|
import { Footer, Header } from "./header";
|
|
import { HeaderWrapper, IDocumentHeader } from "./header-wrapper";
|
|
import { Media } from "./media";
|
|
import { Numbering } from "./numbering";
|
|
import { Paragraph } from "./paragraph";
|
|
import { Relationships } from "./relationships";
|
|
import { Settings } from "./settings";
|
|
import { Styles } from "./styles";
|
|
import { ExternalStylesFactory } from "./styles/external-styles-factory";
|
|
import { DefaultStylesFactory } from "./styles/factory";
|
|
import { Table } from "./table";
|
|
import { TableOfContents } from "./table-of-contents";
|
|
|
|
export interface ISectionOptions {
|
|
readonly headers?: {
|
|
readonly default?: Header;
|
|
readonly first?: Header;
|
|
readonly even?: Header;
|
|
};
|
|
readonly footers?: {
|
|
readonly default?: Footer;
|
|
readonly first?: Footer;
|
|
readonly even?: Footer;
|
|
};
|
|
readonly size?: IPageSizeAttributes;
|
|
readonly margins?: IPageMarginAttributes;
|
|
readonly properties?: SectionPropertiesOptions;
|
|
readonly children: (Paragraph | Table | TableOfContents)[];
|
|
}
|
|
|
|
export class File {
|
|
// tslint:disable-next-line:readonly-keyword
|
|
private currentRelationshipId: number = 1;
|
|
|
|
private readonly documentWrapper: DocumentWrapper;
|
|
private readonly headers: IDocumentHeader[] = [];
|
|
private readonly footers: IDocumentFooter[] = [];
|
|
private readonly coreProperties: CoreProperties;
|
|
private readonly numbering: Numbering;
|
|
private readonly media: Media;
|
|
private readonly fileRelationships: Relationships;
|
|
private readonly footnotesWrapper: FootnotesWrapper;
|
|
private readonly settings: Settings;
|
|
private readonly contentTypes: ContentTypes;
|
|
private readonly customProperties: CustomProperties;
|
|
private readonly appProperties: AppProperties;
|
|
private readonly styles: Styles;
|
|
|
|
constructor(
|
|
options: IPropertiesOptions = {
|
|
creator: "Un-named",
|
|
revision: "1",
|
|
lastModifiedBy: "Un-named",
|
|
},
|
|
fileProperties: IFileProperties = {},
|
|
sections: ISectionOptions[] = [],
|
|
) {
|
|
this.coreProperties = new CoreProperties(options);
|
|
this.numbering = new Numbering(
|
|
options.numbering
|
|
? options.numbering
|
|
: {
|
|
config: [],
|
|
},
|
|
);
|
|
this.fileRelationships = new Relationships();
|
|
this.customProperties = new CustomProperties(options.customProperties ?? []);
|
|
this.appProperties = new AppProperties();
|
|
this.footnotesWrapper = new FootnotesWrapper();
|
|
this.contentTypes = new ContentTypes();
|
|
this.documentWrapper = new DocumentWrapper({ background: options.background || {} });
|
|
this.settings = new Settings({
|
|
compatabilityModeVersion: options.compatabilityModeVersion,
|
|
evenAndOddHeaders: options.evenAndOddHeaderAndFooters ? true : false,
|
|
});
|
|
|
|
this.media = fileProperties.template && fileProperties.template.media ? fileProperties.template.media : new Media();
|
|
|
|
if (fileProperties.template) {
|
|
this.currentRelationshipId = fileProperties.template.currentRelationshipId + 1;
|
|
}
|
|
|
|
// set up styles
|
|
if (fileProperties.template && options.externalStyles) {
|
|
throw Error("can not use both template and external styles");
|
|
}
|
|
if (fileProperties.template) {
|
|
const stylesFactory = new ExternalStylesFactory();
|
|
this.styles = stylesFactory.newInstance(fileProperties.template.styles);
|
|
} else if (options.externalStyles) {
|
|
const stylesFactory = new ExternalStylesFactory();
|
|
this.styles = stylesFactory.newInstance(options.externalStyles);
|
|
} else if (options.styles) {
|
|
const stylesFactory = new DefaultStylesFactory();
|
|
const defaultStyles = stylesFactory.newInstance(options.styles.default);
|
|
this.styles = new Styles({
|
|
...defaultStyles,
|
|
...options.styles,
|
|
});
|
|
} else {
|
|
const stylesFactory = new DefaultStylesFactory();
|
|
this.styles = new Styles(stylesFactory.newInstance());
|
|
}
|
|
|
|
this.addDefaultRelationships();
|
|
|
|
if (fileProperties.template && fileProperties.template.headers) {
|
|
for (const templateHeader of fileProperties.template.headers) {
|
|
this.addHeaderToDocument(templateHeader.header, templateHeader.type);
|
|
}
|
|
}
|
|
|
|
if (fileProperties.template && fileProperties.template.footers) {
|
|
for (const templateFooter of fileProperties.template.footers) {
|
|
this.addFooterToDocument(templateFooter.footer, templateFooter.type);
|
|
}
|
|
}
|
|
|
|
for (const section of sections) {
|
|
this.documentWrapper.View.Body.addSection(section.properties ? section.properties : {});
|
|
|
|
for (const child of section.children) {
|
|
this.documentWrapper.View.add(child);
|
|
}
|
|
}
|
|
|
|
if (options.footnotes) {
|
|
// tslint:disable-next-line: forin
|
|
for (const key in options.footnotes) {
|
|
this.footnotesWrapper.View.createFootNote(parseFloat(key), options.footnotes[key].children);
|
|
}
|
|
}
|
|
|
|
if (options.features) {
|
|
if (options.features.trackRevisions) {
|
|
this.settings.addTrackRevisions();
|
|
}
|
|
}
|
|
}
|
|
|
|
public addSection({
|
|
headers = { default: new Header() },
|
|
footers = { default: new Header() },
|
|
margins = {},
|
|
size = {},
|
|
properties,
|
|
children,
|
|
}: ISectionOptions): void {
|
|
this.documentWrapper.View.Body.addSection({
|
|
...properties,
|
|
headers: {
|
|
default: headers.default ? this.createHeader(headers.default) : this.createHeader(new Header()),
|
|
first: headers.first ? this.createHeader(headers.first) : undefined,
|
|
even: headers.even ? this.createHeader(headers.even) : undefined,
|
|
},
|
|
footers: {
|
|
default: footers.default ? this.createFooter(footers.default) : this.createFooter(new Footer()),
|
|
first: footers.first ? this.createFooter(footers.first) : undefined,
|
|
even: footers.even ? this.createFooter(footers.even) : undefined,
|
|
},
|
|
...margins,
|
|
...size,
|
|
});
|
|
|
|
for (const child of children) {
|
|
this.documentWrapper.View.add(child);
|
|
}
|
|
}
|
|
|
|
public verifyUpdateFields(): void {
|
|
if (this.documentWrapper.View.getTablesOfContents().length) {
|
|
this.settings.addUpdateFields();
|
|
}
|
|
}
|
|
|
|
private createHeader(header: Header): HeaderWrapper {
|
|
const wrapper = new HeaderWrapper(this.media, this.currentRelationshipId++);
|
|
|
|
for (const child of header.options.children) {
|
|
wrapper.add(child);
|
|
}
|
|
|
|
this.addHeaderToDocument(wrapper);
|
|
return wrapper;
|
|
}
|
|
|
|
private createFooter(footer: Footer): FooterWrapper {
|
|
const wrapper = new FooterWrapper(this.media, this.currentRelationshipId++);
|
|
|
|
for (const child of footer.options.children) {
|
|
wrapper.add(child);
|
|
}
|
|
|
|
this.addFooterToDocument(wrapper);
|
|
return wrapper;
|
|
}
|
|
|
|
private addHeaderToDocument(header: HeaderWrapper, type: HeaderReferenceType = HeaderReferenceType.DEFAULT): void {
|
|
this.headers.push({ header, type });
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
header.View.ReferenceId,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/header",
|
|
`header${this.headers.length}.xml`,
|
|
);
|
|
this.contentTypes.addHeader(this.headers.length);
|
|
}
|
|
|
|
private addFooterToDocument(footer: FooterWrapper, type: FooterReferenceType = FooterReferenceType.DEFAULT): void {
|
|
this.footers.push({ footer, type });
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
footer.View.ReferenceId,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/footer",
|
|
`footer${this.footers.length}.xml`,
|
|
);
|
|
this.contentTypes.addFooter(this.footers.length);
|
|
}
|
|
|
|
private addDefaultRelationships(): void {
|
|
this.fileRelationships.createRelationship(
|
|
1,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/officeDocument",
|
|
"word/document.xml",
|
|
);
|
|
this.fileRelationships.createRelationship(
|
|
2,
|
|
"http://schemas.openxmlformats.org/package/2006/relationships/metadata/core-properties",
|
|
"docProps/core.xml",
|
|
);
|
|
this.fileRelationships.createRelationship(
|
|
3,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/extended-properties",
|
|
"docProps/app.xml",
|
|
);
|
|
this.fileRelationships.createRelationship(
|
|
4,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/custom-properties",
|
|
"docProps/custom.xml",
|
|
);
|
|
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
this.currentRelationshipId++,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/styles",
|
|
"styles.xml",
|
|
);
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
this.currentRelationshipId++,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/numbering",
|
|
"numbering.xml",
|
|
);
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
this.currentRelationshipId++,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/footnotes",
|
|
"footnotes.xml",
|
|
);
|
|
this.documentWrapper.Relationships.createRelationship(
|
|
this.currentRelationshipId++,
|
|
"http://schemas.openxmlformats.org/officeDocument/2006/relationships/settings",
|
|
"settings.xml",
|
|
);
|
|
}
|
|
|
|
public get Document(): DocumentWrapper {
|
|
return this.documentWrapper;
|
|
}
|
|
|
|
public get Styles(): Styles {
|
|
return this.styles;
|
|
}
|
|
|
|
public get CoreProperties(): CoreProperties {
|
|
return this.coreProperties;
|
|
}
|
|
|
|
public get Numbering(): Numbering {
|
|
return this.numbering;
|
|
}
|
|
|
|
public get Media(): Media {
|
|
return this.media;
|
|
}
|
|
|
|
public get FileRelationships(): Relationships {
|
|
return this.fileRelationships;
|
|
}
|
|
|
|
public get Headers(): HeaderWrapper[] {
|
|
return this.headers.map((item) => item.header);
|
|
}
|
|
|
|
public get Footers(): FooterWrapper[] {
|
|
return this.footers.map((item) => item.footer);
|
|
}
|
|
|
|
public get ContentTypes(): ContentTypes {
|
|
return this.contentTypes;
|
|
}
|
|
|
|
public get CustomProperties(): CustomProperties {
|
|
return this.customProperties;
|
|
}
|
|
|
|
public get AppProperties(): AppProperties {
|
|
return this.appProperties;
|
|
}
|
|
|
|
public get FootNotes(): FootnotesWrapper {
|
|
return this.footnotesWrapper;
|
|
}
|
|
|
|
public get Settings(): Settings {
|
|
return this.settings;
|
|
}
|
|
}
|