@syncfusion/ej2-office-common 35.1.37 → 35.1.42

package/src/office-common/features/mathml/serialize/omml-writer.d.ts

@@ -0,0 +1,123 @@
+/**
+ * Low-level OMML element builders shared by the Office Math serializer.
+ *
+ * Source: ECMA-376-1 §22.1 (shared-math.xsd). The schema declares `attributeFormDefault="qualified"`,
+ * so `m:val`-style attributes are written in the math namespace, as Word does.
+ */
+import { MathmlConstraintKind } from '../errors';
+import { OpenXmlAttribute, OpenXmlChild, OpenXmlElement } from '../openxml';
+import { MathDocumentAdapter } from '../office-math/adapter';
+import { ExplicitPropertyStore } from '../office-math/property-store';
+/** Options of the Office Math serializer. @public */
+export interface SerializeOfficeMathOptions {
+    /** Math prefix to write. Defaults to the first free entry of `m`, `m1`, `m2`… */
+    readonly prefix?: string;
+    /** Prefixes already claimed in the outer document. */
+    readonly reservedPrefixes?: ReadonlyArray<string>;
+    /**
+     * Forces `m:oMathPara` (true) or a bare `m:oMath` (false). When omitted the root is display when
+     * the paragraph has explicit justification or does not hold exactly one equation.
+     */
+    readonly display?: boolean;
+}
+/** State threaded through one serialization. @private */
+export interface WriteContext {
+    readonly prefix: string;
+    readonly adapter: MathDocumentAdapter | undefined;
+}
+/**
+ * Picks the math prefix for a save.
+ *
+ * @param {SerializeOfficeMathOptions} options The serializer options.
+ * @returns {string} The prefix.
+ * @private
+ */
+export declare function resolveMathPrefix(options?: SerializeOfficeMathOptions): string;
+/**
+ * Creates an `m:` element. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The local name.
+ * @param {ReadonlyArray<OpenXmlChild>} children The children.
+ * @param {ReadonlyArray<OpenXmlAttribute>} attributes The attributes.
+ * @returns {OpenXmlElement} The element.
+ */
+export declare function mathElement(ctx: WriteContext, name: string, children?: ReadonlyArray<OpenXmlChild>, attributes?: ReadonlyArray<OpenXmlAttribute>): OpenXmlElement;
+/**
+ * Creates a namespace-qualified math attribute. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The attribute local name.
+ * @param {string} value The value.
+ * @returns {OpenXmlAttribute} The attribute.
+ */
+export declare function mathAttribute(ctx: WriteContext, name: string, value: string): OpenXmlAttribute;
+/**
+ * Creates `<m:name m:val="value"/>`. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The element local name.
+ * @param {string} value The value.
+ * @returns {OpenXmlElement} The element.
+ */
+export declare function valueElement(ctx: WriteContext, name: string, value: string): OpenXmlElement;
+/**
+ * Creates an on/off element using the canonical `1` / `0`. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The element local name.
+ * @param {boolean} value The value.
+ * @returns {OpenXmlElement} The element.
+ */
+export declare function onOffElement(ctx: WriteContext, name: string, value: boolean): OpenXmlElement;
+/**
+ * Throws a validation error. @private
+ *
+ * @param {string} message The message.
+ * @param {string} path The element path.
+ * @param {MathmlConstraintKind} kind The violated constraint.
+ * @returns {never} Never returns.
+ */
+export declare function invalid(message: string, path: string, kind: MathmlConstraintKind): never;
+/**
+ * Maps an enum value to its OMML token, failing on out-of-range values. @private
+ *
+ * @param {ReadonlyArray<string>} table Tokens indexed by enum value.
+ * @param {number} value The enum value.
+ * @param {string} path The element path.
+ * @param {string} label The schema type name.
+ * @returns {string} The token.
+ */
+export declare function token(table: ReadonlyArray<string>, value: number, path: string, label: string): string;
+/**
+ * Asserts an unsigned integer. @private
+ *
+ * @param {number} value The value.
+ * @param {string} path The element path.
+ * @returns {string} The decimal text.
+ */
+export declare function unsigned(value: number, path: string): string;
+/** An explicit on/off property: store key, element name and current value. @private */
+export declare type FlagEntry = [number, string, boolean];
+/**
+ * Appends an on/off element for every flag that was explicitly set. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {OpenXmlChild[]} out The children being built.
+ * @param {ExplicitPropertyStore} store The owner of the properties.
+ * @param {FlagEntry[]} entries Entries in schema order.
+ * @returns {void}
+ */
+export declare function writeFlags(ctx: WriteContext, out: OpenXmlChild[], store: ExplicitPropertyStore, entries: FlagEntry[]): void;
+/**
+ * Appends a value element when the property was explicitly set. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {OpenXmlChild[]} out The children being built.
+ * @param {ExplicitPropertyStore} store The owner of the property.
+ * @param {number} key The property key.
+ * @param {string} name The element local name.
+ * @param {Function} value Lazily produces the text, so unset properties are never evaluated.
+ * @returns {void}
+ */
+export declare function writeValue(ctx: WriteContext, out: OpenXmlChild[], store: ExplicitPropertyStore, key: number, name: string, value: () => string): void;

package/src/office-common/features/mathml/serialize/omml-writer.js

@@ -0,0 +1,135 @@
+/**
+ * Low-level OMML element builders shared by the Office Math serializer.
+ *
+ * Source: ECMA-376-1 §22.1 (shared-math.xsd). The schema declares `attributeFormDefault="qualified"`,
+ * so `m:val`-style attributes are written in the math namespace, as Word does.
+ */
+import { MATH_NAMESPACE, MATH_PREFIX_FALLBACKS } from '../constants';
+import { MathmlValidationError } from '../errors';
+import { createElement } from '../openxml';
+/**
+ * Picks the math prefix for a save.
+ *
+ * @param {SerializeOfficeMathOptions} options The serializer options.
+ * @returns {string} The prefix.
+ * @private
+ */
+export function resolveMathPrefix(options) {
+    if (options !== undefined && options.prefix !== undefined && options.prefix.length > 0) {
+        return options.prefix;
+    }
+    var reserved = options !== undefined && options.reservedPrefixes !== undefined ? options.reservedPrefixes : [];
+    var free = MATH_PREFIX_FALLBACKS.filter(function (p) { return reserved.indexOf(p) === -1; });
+    return free.length > 0 ? free[0] : 'm999';
+}
+/**
+ * Creates an `m:` element. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The local name.
+ * @param {ReadonlyArray<OpenXmlChild>} children The children.
+ * @param {ReadonlyArray<OpenXmlAttribute>} attributes The attributes.
+ * @returns {OpenXmlElement} The element.
+ */
+export function mathElement(ctx, name, children, attributes) {
+    if (children === void 0) { children = []; }
+    if (attributes === void 0) { attributes = []; }
+    return createElement(MATH_NAMESPACE, name, ctx.prefix, { attributes: attributes, children: children });
+}
+/**
+ * Creates a namespace-qualified math attribute. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The attribute local name.
+ * @param {string} value The value.
+ * @returns {OpenXmlAttribute} The attribute.
+ */
+export function mathAttribute(ctx, name, value) {
+    return { namespaceUri: MATH_NAMESPACE, localName: name, prefix: ctx.prefix, value: value };
+}
+/**
+ * Creates `<m:name m:val="value"/>`. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The element local name.
+ * @param {string} value The value.
+ * @returns {OpenXmlElement} The element.
+ */
+export function valueElement(ctx, name, value) {
+    return mathElement(ctx, name, [], [mathAttribute(ctx, 'val', value)]);
+}
+/**
+ * Creates an on/off element using the canonical `1` / `0`. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {string} name The element local name.
+ * @param {boolean} value The value.
+ * @returns {OpenXmlElement} The element.
+ */
+export function onOffElement(ctx, name, value) {
+    return valueElement(ctx, name, value ? '1' : '0');
+}
+/**
+ * Throws a validation error. @private
+ *
+ * @param {string} message The message.
+ * @param {string} path The element path.
+ * @param {MathmlConstraintKind} kind The violated constraint.
+ * @returns {never} Never returns.
+ */
+export function invalid(message, path, kind) {
+    throw new MathmlValidationError(message, path, kind);
+}
+/**
+ * Maps an enum value to its OMML token, failing on out-of-range values. @private
+ *
+ * @param {ReadonlyArray<string>} table Tokens indexed by enum value.
+ * @param {number} value The enum value.
+ * @param {string} path The element path.
+ * @param {string} label The schema type name.
+ * @returns {string} The token.
+ */
+export function token(table, value, path, label) {
+    var result = table[value];
+    return result !== undefined ? result : invalid('Illegal ' + label + ' value ' + String(value), path, 'enum-value');
+}
+/**
+ * Asserts an unsigned integer. @private
+ *
+ * @param {number} value The value.
+ * @param {string} path The element path.
+ * @returns {string} The decimal text.
+ */
+export function unsigned(value, path) {
+    return Number.isInteger(value) && value >= 0 ? String(value) : invalid('Expected an unsigned integer, got ' + String(value), path, 'value-range');
+}
+/**
+ * Appends an on/off element for every flag that was explicitly set. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {OpenXmlChild[]} out The children being built.
+ * @param {ExplicitPropertyStore} store The owner of the properties.
+ * @param {FlagEntry[]} entries Entries in schema order.
+ * @returns {void}
+ */
+export function writeFlags(ctx, out, store, entries) {
+    entries.forEach(function (e) { if (store.isExplicit(e[0])) {
+        out.push(onOffElement(ctx, e[1], e[2]));
+    } });
+}
+/**
+ * Appends a value element when the property was explicitly set. @private
+ *
+ * @param {WriteContext} ctx The write context.
+ * @param {OpenXmlChild[]} out The children being built.
+ * @param {ExplicitPropertyStore} store The owner of the property.
+ * @param {number} key The property key.
+ * @param {string} name The element local name.
+ * @param {Function} value Lazily produces the text, so unset properties are never evaluated.
+ * @returns {void}
+ */
+export function writeValue(ctx, out, store, key, name, value) {
+    if (store.isExplicit(key)) {
+        out.push(valueElement(ctx, name, value()));
+    }
+}

package/src/office-common/index.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Shared OOXML codecs and domain models for EJ2 Office JavaScript libraries.
+ *
+ * Public surface: MathML (OMML) typed model, parser, serializer, settings, and
+ * LaTeX conversion. Other feature modules (ink, diagrams, smart-art,
+ * encryption) are internal and intentionally not exported yet.
+ *
+ * @packageDocumentation
+ */
+export * from './features/mathml/index';

package/src/office-common/index.js

@@ -0,0 +1,10 @@
+/**
+ * Shared OOXML codecs and domain models for EJ2 Office JavaScript libraries.
+ *
+ * Public surface: MathML (OMML) typed model, parser, serializer, settings, and
+ * LaTeX conversion. Other feature modules (ink, diagrams, smart-art,
+ * encryption) are internal and intentionally not exported yet.
+ *
+ * @packageDocumentation
+ */
+export * from './features/mathml/index';

package/.eslintrc.json

@@ -1,263 +0,0 @@
-{
-    "env": {
-        "browser": true,
-        "es2021": true
-    },
-    "extends": [
-        "eslint:recommended",
-        "plugin:@typescript-eslint/recommended",
-        "plugin:jsdoc/recommended",
-        "plugin:security/recommended"
-    ],
-    "parser": "@typescript-eslint/parser",
-    "parserOptions": {
-        "ecmaFeatures": { "js": true },
-        "ecmaVersion": 2018,
-        "project": "./tsconfig.json",
-        "sourceType": "module"
-    },
-    "ignorePatterns": ["*.d.ts", "*.js"],
-    "plugins": [
-        "@typescript-eslint",
-        "@typescript-eslint/tslint",
-        "eslint-plugin-security",
-        "jsdoc"
-    ],
-    "rules": {
-        "use-isnan": "error",
-        "security/detect-unsafe-regex":"error",
-        "security/detect-buffer-noassert":"error",
-        "security/detect-child-process":"error",
-        "security/detect-disable-mustache-escape":"error",
-        "security/detect-eval-with-expression":"error",
-        "security/detect-no-csrf-before-method-override":"error",
-        "security/detect-non-literal-fs-filename":"error",
-        "security/detect-non-literal-regexp":"error",
-        "security/detect-non-literal-require":"error",
-        "security/detect-object-injection":"error",
-        "security/detect-possible-timing-attacks":"error",
-        "security/detect-pseudoRandomBytes":"error",
-        "security/detect-new-buffer":"error",
-        "security/detect-bidi-characters":"error",
-        "no-prototype-builtins": "warn",
-        "no-extend-native": ["warn"],
-        "@typescript-eslint/no-inferrable-types": "off",
-        "@typescript-eslint/ban-types": ["warn", {
-            "types": {
-                "Object": false,
-                "object": false,
-                "{}": false,
-                "Function": false
-            }
-        }],
-        "jsdoc/check-tag-names": 0,
-        "@typescript-eslint/tslint/config": [
-            "error",
-            {
-                "rules": {
-                    "ban": true,
-                    "chai-vague-errors": true,
-                    "max-func-body-length": [
-                        true,
-                        120,
-                        {
-                            "ignore-parameters-to-function-regex": "describe"
-                        }
-                    ],
-                    "missing-jsdoc": true,
-                    "no-backbone-get-set-outside-model": false,
-                    "no-cookies": false,
-                    "no-delete-expression": false,
-                    "no-disable-auto-sanitization": true,
-                    "no-duplicate-case": true,
-                    "no-duplicate-parameter-names": true,
-                    "no-empty-interfaces": false,
-                    "no-exec-script": true,
-                    "no-function-expression": false,
-                    "no-multiple-var-decl": false,
-                    "no-string-based-set-immediate": false,
-                    "no-string-based-set-interval": false,
-                    "no-unnecessary-bind": false,
-                    "no-unused-imports": true,
-                    "no-with-statement": false,
-                    "prefer-array-literal": false,
-                    "typedef": [
-                        true,
-                        "call-signature",
-                        "parameter",
-                        "property-declaration",
-                        "variable-declaration",
-                        "arrow-parameter",
-                        "member-variable-declaration"
-                    ],
-                    "use-named-parameter": false,
-                    "valid-typeof": true,
-                    "whitespace": [
-                        true,
-                        "check-branch",
-                        "check-decl",
-                        "check-operator",
-                        "check-separator",
-                        "check-type"
-                    ]
-                }
-            }
-        ],
-        "no-control-regex": "error",
-        "no-constant-condition": "error",
-        "no-invalid-regexp": "error",
-        "curly": "error",
-        "eol-last": [
-            "error",
-            "always"
-        ],
-        "guard-for-in": "error",
-        "no-labels": "error",
-        "max-len": [
-            "error",
-            {
-                "code": 140,
-                "tabWidth": 4,
-                "ignoreComments": true,
-                "ignoreStrings": true,
-                "ignoreTemplateLiterals": true,
-                "ignoreRegExpLiterals": true
-            }
-        ],
-        "no-console": [
-            "error",
-            {
-                "allow": [
-                    "warn",
-                    "dir",
-                    "timeLog",
-                    "assert",
-                    "clear",
-                    "count",
-                    "countReset",
-                    "group",
-                    "groupEnd",
-                    "table",
-                    "dirxml",
-                    "error",
-                    "groupCollapsed",
-                    "Console",
-                    "profile",
-                    "profileEnd",
-                    "timeStamp",
-                    "context"
-                ]
-            }
-        ],
-        "no-redeclare": [
-            "error",
-            {
-                "builtinGlobals": true
-            }
-        ],
-        "@typescript-eslint/no-parameter-properties": "error",
-        "@typescript-eslint/indent": [
-            "error",
-            4,
-            {
-                "CallExpression": {
-                    "arguments": "first"
-                },
-                "FunctionDeclaration": {
-                    "parameters": "first"
-                },
-                "FunctionExpression": {
-                    "parameters": "first"
-                }
-            }
-        ],
-        "no-debugger": "error",
-        "no-eval": "error",
-        "no-extra-semi": "error",
-        "no-throw-literal": "error",
-        "no-fallthrough": "error",
-        "comma-dangle": [
-            "error",
-            "never"
-        ],
-        "no-trailing-spaces": "error",
-        "@typescript-eslint/no-unused-expressions": "error",
-        "@typescript-eslint/no-var-requires": "error",
-        "one-var": [
-            "error",
-            "never"
-        ],
-        "@typescript-eslint/no-explicit-any": "warn",
-        "no-cond-assign": [
-            "error",
-            "always"
-        ],
-        "@typescript-eslint/consistent-type-assertions": "off",
-        "jsdoc/check-alignment": "error",
-        "no-empty": "error",
-        "quotes": [
-            "error",
-            "single"
-        ],
-        "semi": [
-            "error",
-            "always"
-        ],
-        "eqeqeq": [
-            "error",
-            "smart"
-        ],
-        "valid-typeof": [
-            "error",
-            {
-                "requireStringLiterals": true
-            }
-        ],
-        "camelcase": [
-            "error",
-            {
-                "properties": "always",
-                "ignoreDestructuring": true,
-                "ignoreImports": true
-            }
-        ],
-        "no-irregular-whitespace": [
-            "error",
-            {
-                "skipStrings": true,
-                "skipComments": true,
-                "skipRegExps": true,
-                "skipTemplates": true
-            }
-        ],
-        "valid-jsdoc": [
-            "error",
-            {
-                "prefer": {
-                    "arg": "param",
-                    "argument": "param",
-                    "class": "constructor",
-                    "return": "returns",
-                    "virtual": "abstract"
-                }
-            }
-        ],
-        "no-var": "error",
-        "radix": "error"
-    },
-    "reportUnusedDisableDirectives": true,
-    "overrides": [
-        {
-            "files": [
-                "node_modules",
-                "dist",
-                "public",
-                "coverage",
-                "test-report"
-            ],
-            "rules": {
-                "no-unused-expressions": "off"
-            }
-        }
-    ]
-}

package/.prettierrc.json

@@ -1,5 +0,0 @@
-{
-  "singleQuote": true,
-  "trailingComma": "all",
-  "printWidth": 100
-}

package/api-extractor.json

@@ -1,35 +0,0 @@
-{
-  "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json",
-  "mainEntryPointFilePath": "<projectFolder>/dist/index.d.ts",
-  "bundledPackages": [],
-  "compiler": {
-    "tsconfigFilePath": "<projectFolder>/tsconfig.build.json"
-  },
-  "apiReport": {
-    "enabled": true,
-    "reportFolder": "<projectFolder>/docs/api",
-    "reportFileName": "@syncfusion/ej2-office-common.api.md"
-  },
-  "docModel": {
-    "enabled": false
-  },
-  "dtsRollup": {
-    "enabled": true,
-    "publicTrimmedFilePath": "<projectFolder>/dist/@syncfusion/ej2-office-common.d.ts"
-  },
-  "tsdocMetadata": {
-    "enabled": false
-  },
-  "messages": {
-    "extractorMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    },
-    "compilerMessageReporting": {
-      "default": {
-        "logLevel": "warning"
-      }
-    }
-  }
-}

package/core.js

@@ -1,4 +0,0 @@
-/**
- * core
- */
-export * from './src/core/index';

package/encryption.js

@@ -1,4 +0,0 @@
-/**
- * encryption
- */
-export * from './src/encryption/index';

package/features.js

@@ -1,4 +0,0 @@
-/**
- * features
- */
-export * from './src/features/index';

package/global.json

@@ -1,6 +0,0 @@
-{
-  "sdk": {
-    "version": "10.0.400",
-    "rollForward": "latestFeature"
-  }
-}

package/nuget.config

@@ -1,7 +0,0 @@
-<?xml version="1.0" encoding="utf-8"?>
-<configuration>
-  <packageSources>
-    <clear />
-    <add key="nuget.org" value="https://api.nuget.org/v3/index.json" protocolVersion="3" />
-  </packageSources>
-</configuration>

package/src/all.d.ts

@@ -1,41 +0,0 @@
-/**
- * All-in entry for consumers who want every public API from @syncfusion/ej2-office-common.
- * Prefer explicit `@syncfusion/ej2-office-common/<feature>` subpaths when bundle size matters.
- *
- * @remarks
- * Re-exports the root surface (ink, mathml, encryption) plus the optional
- * SmartArt (`./smart-art`) module. Diagram feature symbols remain on the
- * `@syncfusion/ej2-office-common/diagrams` subpath only (same dual-export pattern as
- * development). FEATURE_SUBPATHS lists every optional feature export.
- *
- * @packageDocumentation
- */
-export * from './index';
-export { DIAGRAM_COLORS_CONTENT_TYPE, DIAGRAM_COLORS_RELATIONSHIP_TYPE, DIAGRAM_CONTENT_TYPES, DIAGRAM_DATA_CONTENT_TYPE, DIAGRAM_DATA_RELATIONSHIP_TYPE, DIAGRAM_GRAPHIC_DATA_URI, DIAGRAM_LAYOUT_CONTENT_TYPE, DIAGRAM_LAYOUT_RELATIONSHIP_TYPE, DIAGRAM_NAMESPACE, DIAGRAM_QUICK_STYLE_RELATIONSHIP_TYPE, DIAGRAM_RELATIONSHIP_TYPES, DIAGRAM_STYLE_CONTENT_TYPE, DRAWINGML_MAIN_NAMESPACE, OFFICE_DOCUMENT_RELATIONSHIPS_NAMESPACE, OFFICE_IMAGE_RELATIONSHIP_TYPE, DiagramPartError, DiagramPointType, createDiagramInstance, diagramPoint, diagramPointText, enumerateDiagramInstances, findDiagramRelIds, getDiagramInstance, getDiagramPartHandler, listDiagramConnections, listDiagramParts, listDiagramPoints, normalizePartName, parseDiagramColors, parseDiagramData, parseDiagramLayout, parseDiagramRelIds, parseDiagramStyle, registerSmartArtFeature, removeDiagramInstance, serializeDiagramColors, serializeDiagramData, serializeDiagramLayout, serializeDiagramStyle, withDiagramPointText, CreateDiagramInstanceOptions, CreateDiagramInstanceResult, CreateDiagramInstanceSeeds, DiagramColorsPart, DiagramConnection, DiagramDataPart, DiagramGraphicHook, DiagramInstance, DiagramLayoutPart, DiagramPackageGraph, DiagramPackagePart, DiagramPackageRelationship, DiagramPartHandler, DiagramPartNames, DiagramPoint, DiagramRelIds, DiagramStylePart, GetDiagramInstanceOptions, RemoveDiagramInstanceOptions, RemoveDiagramInstanceResult, } from './features/smart-art/index';
-/**
- * Feature subpaths registered for the configurator / bundle matrix.
- * Must stay in sync with `package.json` `exports` feature keys.
- *
- * @remarks
- * Non-feature surfaces such as `./encryption` are omitted here.
- *
- * @public
- */
-export declare const FEATURE_SUBPATHS: string[];
-/**
- * Union of FEATURE_SUBPATHS string literals.
- *
- * @public
- */
-export declare type FeatureSubpath = (typeof FEATURE_SUBPATHS)[number];
-/**
- * Registers every optional feature that installs side-effect handlers in this build.
- *
- * @remarks
- * Invokes registerSmartArtFeature, which installs the four Transitional
- * diagram content-type handlers (idempotent). Ink / diagrams / mathml modules
- * do not expose a matching register hook on this tree.
- *
- * @public
- */
-export declare function registerAllFeatures(): void;