odf.js 1.1.0 → 1.3.0

package/dist/index.d.cts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { Alignment, AlignmentSchema, Box, Color, LayoutMetadata, Margins, PageSize } from "document-content-model";
 //#region src/model/node.d.ts
 declare const AttributeSchema: z.ZodObject<{
   name: z.ZodString;
@@ -348,6 +349,7 @@ declare function txt(value: string): XmlText;
 //#endregion
 //#region src/xml/entities.d.ts
 declare function encodeXmlText(value: string): string;
+declare function decodeXmlText(value: string): string;
 //#endregion
 //#region src/manifest.d.ts
 declare const ManifestEntrySchema: z.ZodObject<{
@@ -386,4 +388,140 @@ declare function syncManifest(pkg: Package, options?: BuildManifestOptions): voi
 declare function validateManifest(pkg: Package): ManifestProblem[];
 declare function setDocumentMediaType(pkg: Package, mediaType: string, version?: string): void;
 //#endregion
-export { type Attribute, AttributeSchema, type BinaryPart, BinaryPartSchema, type BuildManifestOptions, type ImageFormat, MANIFEST_PART, MIMETYPE_PART, type Manifest, type ManifestEntry, ManifestEntrySchema, type ManifestProblem, ManifestProblemSchema, ManifestSchema, ODF_MEDIA_TYPES, ODF_NAMESPACES, type OdfExtension, type OdfNamespacePrefix, type Package, PackageSchema, type Part, PartSchema, type XmlCdata, XmlCdataSchema, type XmlComment, XmlCommentSchema, type XmlDeclaration, XmlDeclarationSchema, type XmlElement, XmlElementSchema, type XmlNode, XmlNodeSchema, type XmlPart, XmlPartSchema, type XmlPi, XmlPiSchema, type XmlText, XmlTextSchema, type ZipEntry, base64ToBytes, buildManifest, buildXml, bytesToBase64, decodePackage, el, encodePackage, encodeXmlText, isXmlNode, mediaTypeForExtension, packageCodec, parsePackage, parseXml, readManifest, readMimetype, serializePackage, setDocumentMediaType, sniffImageFormat, syncManifest, txt, unzipPackage, validateManifest, writeManifest, writeMimetype, xmlCodec, xmlnsAttributes, zipPackage };
+//#region src/typed/shared/units.d.ts
+type LengthUnit = 'cm' | 'mm' | 'in' | 'pt' | 'pc' | 'px';
+declare function parseOdfLength(value: string): number | undefined;
+declare function formatOdfLength(pt: number, unit?: LengthUnit): string;
+//#endregion
+//#region src/styles/properties.d.ts
+declare const StylePropertiesSchema: z.ZodObject<{
+  bold: z.ZodOptional<z.ZodBoolean>;
+  italic: z.ZodOptional<z.ZodBoolean>;
+  underline: z.ZodOptional<z.ZodBoolean>;
+  strike: z.ZodOptional<z.ZodBoolean>;
+  fontFamily: z.ZodOptional<z.ZodString>;
+  sizePt: z.ZodOptional<z.ZodNumber>;
+  color: z.ZodOptional<z.ZodObject<{
+    r: z.ZodNumber;
+    g: z.ZodNumber;
+    b: z.ZodNumber;
+  }, z.core.$strip>>;
+  alignment: z.ZodOptional<z.ZodEnum<{
+    left: "left";
+    center: "center";
+    right: "right";
+    justify: "justify";
+  }>>;
+  spacingBeforePt: z.ZodOptional<z.ZodNumber>;
+  spacingAfterPt: z.ZodOptional<z.ZodNumber>;
+  lineSpacing: z.ZodOptional<z.ZodNumber>;
+  indentLeftPt: z.ZodOptional<z.ZodNumber>;
+  indentFirstLinePt: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type StyleProperties = z.infer<typeof StylePropertiesSchema>;
+interface ParsedProperties {
+  properties: Partial<StyleProperties>;
+  hasUnknown: boolean;
+}
+declare const parseLength: typeof parseOdfLength;
+declare function formatPt(valuePt: number): string;
+declare function formatPercentageMultiplier(multiplier: number): string;
+declare function parseTextProperties(element: XmlElement): ParsedProperties;
+declare function parseParagraphProperties(element: XmlElement): ParsedProperties;
+declare function parseStyleElementProperties(styleElement: XmlElement): {
+  properties: StyleProperties;
+  hasUnknown: boolean;
+};
+declare function textPropertiesToAttributes(properties: StyleProperties): Attribute[];
+declare function paragraphPropertiesToAttributes(properties: StyleProperties): Attribute[];
+//#endregion
+//#region src/styles/serialize.d.ts
+declare function buildStylePropertyElements(properties: StyleProperties): XmlElement[];
+declare function canonicalPropertiesString(properties: StyleProperties): string;
+//#endregion
+//#region src/styles/registry.d.ts
+declare const STYLE_FAMILIES: readonly ["paragraph", "text", "table", "table-column", "table-row", "table-cell", "graphic"];
+type StyleFamily = (typeof STYLE_FAMILIES)[number];
+declare function isStyleFamily(value: string): value is StyleFamily;
+interface InternRequest {
+  properties: StyleProperties;
+  family: StyleFamily;
+  parentStyleName?: string;
+}
+interface OtherPartRef {
+  pkg: Package;
+  partPath: string;
+}
+interface StyleRegistryOptions {
+  otherPart?: OtherPartRef;
+  additionalReservedNames?: readonly string[];
+}
+declare class StyleRegistry {
+  private readonly automaticStyles;
+  private readonly prefixes;
+  private readonly reservedByFamily;
+  private readonly knownStyles;
+  private readonly fingerprintToName;
+  private readonly nameToFingerprint;
+  private readonly familyCounters;
+  private constructor();
+  static forPart(pkg: Package, partPath: string, options?: StyleRegistryOptions): StyleRegistry;
+  fingerprint(request: InternRequest): string;
+  intern(request: InternRequest): string;
+  private mintName;
+  names(): readonly string[];
+  gc(referenced: ReadonlySet<string>): number;
+}
+//#endregion
+//#region src/styles/span.d.ts
+declare function ensureSpan(paragraph: XmlElement, start: number, end: number, styleName: string): XmlElement;
+//#endregion
+//#region src/xml/query.d.ts
+declare function rootElement(nodes: readonly XmlNode[]): XmlElement | undefined;
+declare function findChildElement(nodes: readonly XmlNode[], tag: string): XmlElement | undefined;
+declare function childrenWithTag(element: XmlElement, tag: string): XmlElement[];
+declare function attrValue(element: XmlElement, name: string): string | undefined;
+//#endregion
+//#region src/typed/shared/a1.d.ts
+declare function columnIndexToLetters(index: number): string;
+declare function cellReference(columnIndex: number, rowIndex: number): string;
+declare class TableCursor {
+  private columnCursor;
+  private rowCursor;
+  get columnIndex(): number;
+  get rowIndex(): number;
+  nextCell(repeatCount?: number): string;
+  nextRow(repeatCount?: number): void;
+}
+//#endregion
+//#region src/typed/shared/color.d.ts
+declare function parseOdfColor(value: string): Color | undefined;
+declare function formatOdfColor(color: Color): string;
+//#endregion
+//#region src/typed/shared/geometry.d.ts
+declare function parsePageSize(pageLayoutProperties: XmlElement): PageSize | undefined;
+declare function parseMargins(pageLayoutProperties: XmlElement): Margins | undefined;
+declare function parseBox(element: XmlElement): Box | undefined;
+//#endregion
+//#region src/typed/shared/text.d.ts
+declare function getOdfSpaceCount(element: XmlElement): number;
+declare function measureOdfNodeLength(node: XmlNode): number;
+declare function sumOdfNodeLength(nodes: readonly XmlNode[]): number;
+declare function decodeOdfText(container: XmlElement): string;
+//#endregion
+//#region src/typed/shared/cascade.d.ts
+interface CascadeDiagnostic {
+  severity: 'warning';
+  message: string;
+}
+interface StyleCascadeResult {
+  properties: StyleProperties;
+  diagnostics: CascadeDiagnostic[];
+}
+declare function resolveStyle(styleName: string | undefined, family: StyleFamily, pkg: Package): StyleCascadeResult;
+//#endregion
+//#region src/typed/shared/metadata.d.ts
+declare const META_PART = "meta.xml";
+declare function readOdfMetadata(pkg: Package): LayoutMetadata;
+//#endregion
+export { type Alignment, AlignmentSchema, type Attribute, AttributeSchema, type BinaryPart, BinaryPartSchema, type BuildManifestOptions, type CascadeDiagnostic, type ImageFormat, type InternRequest, type LengthUnit, MANIFEST_PART, META_PART, MIMETYPE_PART, type Manifest, type ManifestEntry, ManifestEntrySchema, type ManifestProblem, ManifestProblemSchema, ManifestSchema, ODF_MEDIA_TYPES, ODF_NAMESPACES, type OdfExtension, type OdfNamespacePrefix, type OtherPartRef, type Package, PackageSchema, type ParsedProperties, type Part, PartSchema, STYLE_FAMILIES, type StyleCascadeResult, type StyleFamily, type StyleProperties, StylePropertiesSchema, StyleRegistry, type StyleRegistryOptions, TableCursor, type XmlCdata, XmlCdataSchema, type XmlComment, XmlCommentSchema, type XmlDeclaration, XmlDeclarationSchema, type XmlElement, XmlElementSchema, type XmlNode, XmlNodeSchema, type XmlPart, XmlPartSchema, type XmlPi, XmlPiSchema, type XmlText, XmlTextSchema, type ZipEntry, attrValue, base64ToBytes, buildManifest, buildStylePropertyElements, buildXml, bytesToBase64, canonicalPropertiesString, cellReference, childrenWithTag, columnIndexToLetters, decodeOdfText, decodePackage, decodeXmlText, el, encodePackage, encodeXmlText, ensureSpan, findChildElement, formatOdfColor, formatOdfLength, formatPercentageMultiplier, formatPt, getOdfSpaceCount, isStyleFamily, isXmlNode, measureOdfNodeLength, mediaTypeForExtension, packageCodec, paragraphPropertiesToAttributes, parseBox, parseLength, parseMargins, parseOdfColor, parseOdfLength, parsePackage, parsePageSize, parseParagraphProperties, parseStyleElementProperties, parseTextProperties, parseXml, readManifest, readMimetype, readOdfMetadata, resolveStyle, rootElement, serializePackage, setDocumentMediaType, sniffImageFormat, sumOdfNodeLength, syncManifest, textPropertiesToAttributes, txt, unzipPackage, validateManifest, writeManifest, writeMimetype, xmlCodec, xmlnsAttributes, zipPackage };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from "zod";
+import { Alignment, AlignmentSchema, Box, Color, LayoutMetadata, Margins, PageSize } from "document-content-model";
 //#region src/model/node.d.ts
 declare const AttributeSchema: z.ZodObject<{
   name: z.ZodString;
@@ -348,6 +349,7 @@ declare function txt(value: string): XmlText;
 //#endregion
 //#region src/xml/entities.d.ts
 declare function encodeXmlText(value: string): string;
+declare function decodeXmlText(value: string): string;
 //#endregion
 //#region src/manifest.d.ts
 declare const ManifestEntrySchema: z.ZodObject<{
@@ -386,4 +388,140 @@ declare function syncManifest(pkg: Package, options?: BuildManifestOptions): voi
 declare function validateManifest(pkg: Package): ManifestProblem[];
 declare function setDocumentMediaType(pkg: Package, mediaType: string, version?: string): void;
 //#endregion
-export { type Attribute, AttributeSchema, type BinaryPart, BinaryPartSchema, type BuildManifestOptions, type ImageFormat, MANIFEST_PART, MIMETYPE_PART, type Manifest, type ManifestEntry, ManifestEntrySchema, type ManifestProblem, ManifestProblemSchema, ManifestSchema, ODF_MEDIA_TYPES, ODF_NAMESPACES, type OdfExtension, type OdfNamespacePrefix, type Package, PackageSchema, type Part, PartSchema, type XmlCdata, XmlCdataSchema, type XmlComment, XmlCommentSchema, type XmlDeclaration, XmlDeclarationSchema, type XmlElement, XmlElementSchema, type XmlNode, XmlNodeSchema, type XmlPart, XmlPartSchema, type XmlPi, XmlPiSchema, type XmlText, XmlTextSchema, type ZipEntry, base64ToBytes, buildManifest, buildXml, bytesToBase64, decodePackage, el, encodePackage, encodeXmlText, isXmlNode, mediaTypeForExtension, packageCodec, parsePackage, parseXml, readManifest, readMimetype, serializePackage, setDocumentMediaType, sniffImageFormat, syncManifest, txt, unzipPackage, validateManifest, writeManifest, writeMimetype, xmlCodec, xmlnsAttributes, zipPackage };
+//#region src/typed/shared/units.d.ts
+type LengthUnit = 'cm' | 'mm' | 'in' | 'pt' | 'pc' | 'px';
+declare function parseOdfLength(value: string): number | undefined;
+declare function formatOdfLength(pt: number, unit?: LengthUnit): string;
+//#endregion
+//#region src/styles/properties.d.ts
+declare const StylePropertiesSchema: z.ZodObject<{
+  bold: z.ZodOptional<z.ZodBoolean>;
+  italic: z.ZodOptional<z.ZodBoolean>;
+  underline: z.ZodOptional<z.ZodBoolean>;
+  strike: z.ZodOptional<z.ZodBoolean>;
+  fontFamily: z.ZodOptional<z.ZodString>;
+  sizePt: z.ZodOptional<z.ZodNumber>;
+  color: z.ZodOptional<z.ZodObject<{
+    r: z.ZodNumber;
+    g: z.ZodNumber;
+    b: z.ZodNumber;
+  }, z.core.$strip>>;
+  alignment: z.ZodOptional<z.ZodEnum<{
+    left: "left";
+    center: "center";
+    right: "right";
+    justify: "justify";
+  }>>;
+  spacingBeforePt: z.ZodOptional<z.ZodNumber>;
+  spacingAfterPt: z.ZodOptional<z.ZodNumber>;
+  lineSpacing: z.ZodOptional<z.ZodNumber>;
+  indentLeftPt: z.ZodOptional<z.ZodNumber>;
+  indentFirstLinePt: z.ZodOptional<z.ZodNumber>;
+}, z.core.$strip>;
+type StyleProperties = z.infer<typeof StylePropertiesSchema>;
+interface ParsedProperties {
+  properties: Partial<StyleProperties>;
+  hasUnknown: boolean;
+}
+declare const parseLength: typeof parseOdfLength;
+declare function formatPt(valuePt: number): string;
+declare function formatPercentageMultiplier(multiplier: number): string;
+declare function parseTextProperties(element: XmlElement): ParsedProperties;
+declare function parseParagraphProperties(element: XmlElement): ParsedProperties;
+declare function parseStyleElementProperties(styleElement: XmlElement): {
+  properties: StyleProperties;
+  hasUnknown: boolean;
+};
+declare function textPropertiesToAttributes(properties: StyleProperties): Attribute[];
+declare function paragraphPropertiesToAttributes(properties: StyleProperties): Attribute[];
+//#endregion
+//#region src/styles/serialize.d.ts
+declare function buildStylePropertyElements(properties: StyleProperties): XmlElement[];
+declare function canonicalPropertiesString(properties: StyleProperties): string;
+//#endregion
+//#region src/styles/registry.d.ts
+declare const STYLE_FAMILIES: readonly ["paragraph", "text", "table", "table-column", "table-row", "table-cell", "graphic"];
+type StyleFamily = (typeof STYLE_FAMILIES)[number];
+declare function isStyleFamily(value: string): value is StyleFamily;
+interface InternRequest {
+  properties: StyleProperties;
+  family: StyleFamily;
+  parentStyleName?: string;
+}
+interface OtherPartRef {
+  pkg: Package;
+  partPath: string;
+}
+interface StyleRegistryOptions {
+  otherPart?: OtherPartRef;
+  additionalReservedNames?: readonly string[];
+}
+declare class StyleRegistry {
+  private readonly automaticStyles;
+  private readonly prefixes;
+  private readonly reservedByFamily;
+  private readonly knownStyles;
+  private readonly fingerprintToName;
+  private readonly nameToFingerprint;
+  private readonly familyCounters;
+  private constructor();
+  static forPart(pkg: Package, partPath: string, options?: StyleRegistryOptions): StyleRegistry;
+  fingerprint(request: InternRequest): string;
+  intern(request: InternRequest): string;
+  private mintName;
+  names(): readonly string[];
+  gc(referenced: ReadonlySet<string>): number;
+}
+//#endregion
+//#region src/styles/span.d.ts
+declare function ensureSpan(paragraph: XmlElement, start: number, end: number, styleName: string): XmlElement;
+//#endregion
+//#region src/xml/query.d.ts
+declare function rootElement(nodes: readonly XmlNode[]): XmlElement | undefined;
+declare function findChildElement(nodes: readonly XmlNode[], tag: string): XmlElement | undefined;
+declare function childrenWithTag(element: XmlElement, tag: string): XmlElement[];
+declare function attrValue(element: XmlElement, name: string): string | undefined;
+//#endregion
+//#region src/typed/shared/a1.d.ts
+declare function columnIndexToLetters(index: number): string;
+declare function cellReference(columnIndex: number, rowIndex: number): string;
+declare class TableCursor {
+  private columnCursor;
+  private rowCursor;
+  get columnIndex(): number;
+  get rowIndex(): number;
+  nextCell(repeatCount?: number): string;
+  nextRow(repeatCount?: number): void;
+}
+//#endregion
+//#region src/typed/shared/color.d.ts
+declare function parseOdfColor(value: string): Color | undefined;
+declare function formatOdfColor(color: Color): string;
+//#endregion
+//#region src/typed/shared/geometry.d.ts
+declare function parsePageSize(pageLayoutProperties: XmlElement): PageSize | undefined;
+declare function parseMargins(pageLayoutProperties: XmlElement): Margins | undefined;
+declare function parseBox(element: XmlElement): Box | undefined;
+//#endregion
+//#region src/typed/shared/text.d.ts
+declare function getOdfSpaceCount(element: XmlElement): number;
+declare function measureOdfNodeLength(node: XmlNode): number;
+declare function sumOdfNodeLength(nodes: readonly XmlNode[]): number;
+declare function decodeOdfText(container: XmlElement): string;
+//#endregion
+//#region src/typed/shared/cascade.d.ts
+interface CascadeDiagnostic {
+  severity: 'warning';
+  message: string;
+}
+interface StyleCascadeResult {
+  properties: StyleProperties;
+  diagnostics: CascadeDiagnostic[];
+}
+declare function resolveStyle(styleName: string | undefined, family: StyleFamily, pkg: Package): StyleCascadeResult;
+//#endregion
+//#region src/typed/shared/metadata.d.ts
+declare const META_PART = "meta.xml";
+declare function readOdfMetadata(pkg: Package): LayoutMetadata;
+//#endregion
+export { type Alignment, AlignmentSchema, type Attribute, AttributeSchema, type BinaryPart, BinaryPartSchema, type BuildManifestOptions, type CascadeDiagnostic, type ImageFormat, type InternRequest, type LengthUnit, MANIFEST_PART, META_PART, MIMETYPE_PART, type Manifest, type ManifestEntry, ManifestEntrySchema, type ManifestProblem, ManifestProblemSchema, ManifestSchema, ODF_MEDIA_TYPES, ODF_NAMESPACES, type OdfExtension, type OdfNamespacePrefix, type OtherPartRef, type Package, PackageSchema, type ParsedProperties, type Part, PartSchema, STYLE_FAMILIES, type StyleCascadeResult, type StyleFamily, type StyleProperties, StylePropertiesSchema, StyleRegistry, type StyleRegistryOptions, TableCursor, type XmlCdata, XmlCdataSchema, type XmlComment, XmlCommentSchema, type XmlDeclaration, XmlDeclarationSchema, type XmlElement, XmlElementSchema, type XmlNode, XmlNodeSchema, type XmlPart, XmlPartSchema, type XmlPi, XmlPiSchema, type XmlText, XmlTextSchema, type ZipEntry, attrValue, base64ToBytes, buildManifest, buildStylePropertyElements, buildXml, bytesToBase64, canonicalPropertiesString, cellReference, childrenWithTag, columnIndexToLetters, decodeOdfText, decodePackage, decodeXmlText, el, encodePackage, encodeXmlText, ensureSpan, findChildElement, formatOdfColor, formatOdfLength, formatPercentageMultiplier, formatPt, getOdfSpaceCount, isStyleFamily, isXmlNode, measureOdfNodeLength, mediaTypeForExtension, packageCodec, paragraphPropertiesToAttributes, parseBox, parseLength, parseMargins, parseOdfColor, parseOdfLength, parsePackage, parsePageSize, parseParagraphProperties, parseStyleElementProperties, parseTextProperties, parseXml, readManifest, readMimetype, readOdfMetadata, resolveStyle, rootElement, serializePackage, setDocumentMediaType, sniffImageFormat, sumOdfNodeLength, syncManifest, textPropertiesToAttributes, txt, unzipPackage, validateManifest, writeManifest, writeMimetype, xmlCodec, xmlnsAttributes, zipPackage };