odf.js 1.13.2 → 2.1.0

package/dist/typed/odb/form.cjs

@@ -0,0 +1,85 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_xml_entities = require("../../xml/entities.cjs");
+const require_xml_query = require("../../xml/query.cjs");
+const require_typed_odb_subdocument = require("./subdocument.cjs");
+const require_typed_odt_read = require("../odt/read.cjs");
+const require_typed_odb_read = require("./read.cjs");
+//#region src/typed/odb/form.ts
+const CONTENT_PART = "content.xml";
+const FORM_ELEMENT_TAG = "form:form";
+const FORM_PROPERTIES_TAG = "form:properties";
+const FORM_TAG_PREFIX = "form:";
+function formAttr(element, name) {
+	const raw = require_xml_query.attrValue(element, name);
+	return raw === void 0 ? void 0 : require_xml_entities.decodeXmlText(raw);
+}
+function readControl(element) {
+	const control = {
+		tag: element.tag,
+		controls: readControls(element)
+	};
+	const name = formAttr(element, "form:name");
+	if (name !== void 0) control.name = name;
+	const controlImplementation = formAttr(element, "form:control-implementation");
+	if (controlImplementation !== void 0) control.controlImplementation = controlImplementation;
+	const dataField = formAttr(element, "form:data-field");
+	if (dataField !== void 0) control.dataField = dataField;
+	const id = formAttr(element, "form:id");
+	if (id !== void 0) control.id = id;
+	const label = formAttr(element, "form:label");
+	if (label !== void 0) control.label = label;
+	return control;
+}
+function readControls(container) {
+	const controls = [];
+	for (const child of container.children) {
+		if (child.type !== "element" || !child.tag.startsWith(FORM_TAG_PREFIX)) continue;
+		if (child.tag === FORM_ELEMENT_TAG || child.tag === FORM_PROPERTIES_TAG) continue;
+		controls.push(readControl(child));
+	}
+	return controls;
+}
+function readFormDefinition(element) {
+	const subForms = [];
+	for (const child of element.children) if (child.type === "element" && child.tag === FORM_ELEMENT_TAG) subForms.push(readFormDefinition(child));
+	const definition = {
+		controls: readControls(element),
+		subForms
+	};
+	const name = formAttr(element, "form:name");
+	if (name !== void 0) definition.name = name;
+	const command = formAttr(element, "form:command");
+	if (command !== void 0) definition.command = command;
+	const commandType = formAttr(element, "form:command-type");
+	if (commandType !== void 0) definition.commandType = commandType;
+	const datasource = formAttr(element, "form:datasource");
+	if (datasource !== void 0) definition.datasource = datasource;
+	const filter = formAttr(element, "form:filter");
+	if (filter !== void 0) definition.filter = filter;
+	const order = formAttr(element, "form:order");
+	if (order !== void 0) definition.order = order;
+	return definition;
+}
+function readFormDefinitions(contentRoot) {
+	const body = contentRoot === void 0 ? void 0 : require_xml_query.findChildElement(contentRoot.children, "office:body");
+	const text = body === void 0 ? void 0 : require_xml_query.findChildElement(body.children, "office:text");
+	const forms = text === void 0 ? void 0 : require_xml_query.findChildElement(text.children, "office:forms");
+	if (forms === void 0) return [];
+	const definitions = [];
+	for (const child of forms.children) if (child.type === "element" && child.tag === FORM_ELEMENT_TAG) definitions.push(readFormDefinition(child));
+	return definitions;
+}
+function readOdbForm(pkg, formName) {
+	const component = require_typed_odb_read.resolveOdbComponent(pkg, "form", formName);
+	const subPackage = require_typed_odb_subdocument.subDocumentPackage(pkg, component.href);
+	const contentPart = subPackage.parts[CONTENT_PART];
+	if (contentPart?.kind !== "xml") throw new Error(`readOdbForm: form "${formName}" sub-document ${component.href}/${CONTENT_PART} is not an XML part`);
+	return {
+		name: component.name,
+		href: component.href,
+		document: require_typed_odt_read.readOdt(subPackage),
+		forms: readFormDefinitions(require_xml_query.rootElement(contentPart.nodes))
+	};
+}
+//#endregion
+exports.readOdbForm = readOdbForm;

package/dist/typed/odb/form.d.cts

@@ -0,0 +1,31 @@
+import { Package } from "../../model/package.cjs";
+import { OdtDocument } from "../odt/read.cjs";
+//#region src/typed/odb/form.d.ts
+interface OdbFormControl {
+  tag: string;
+  name?: string;
+  controlImplementation?: string;
+  dataField?: string;
+  id?: string;
+  label?: string;
+  controls: OdbFormControl[];
+}
+interface OdbFormDefinition {
+  name?: string;
+  command?: string;
+  commandType?: string;
+  datasource?: string;
+  filter?: string;
+  order?: string;
+  controls: OdbFormControl[];
+  subForms: OdbFormDefinition[];
+}
+interface OdbForm {
+  name: string;
+  href: string;
+  document: OdtDocument;
+  forms: OdbFormDefinition[];
+}
+declare function readOdbForm(pkg: Package, formName: string): OdbForm;
+//#endregion
+export { OdbForm, OdbFormControl, OdbFormDefinition, readOdbForm };

package/dist/typed/odb/form.d.ts

@@ -0,0 +1,31 @@
+import { Package } from "../../model/package.js";
+import { OdtDocument } from "../odt/read.js";
+//#region src/typed/odb/form.d.ts
+interface OdbFormControl {
+  tag: string;
+  name?: string;
+  controlImplementation?: string;
+  dataField?: string;
+  id?: string;
+  label?: string;
+  controls: OdbFormControl[];
+}
+interface OdbFormDefinition {
+  name?: string;
+  command?: string;
+  commandType?: string;
+  datasource?: string;
+  filter?: string;
+  order?: string;
+  controls: OdbFormControl[];
+  subForms: OdbFormDefinition[];
+}
+interface OdbForm {
+  name: string;
+  href: string;
+  document: OdtDocument;
+  forms: OdbFormDefinition[];
+}
+declare function readOdbForm(pkg: Package, formName: string): OdbForm;
+//#endregion
+export { OdbForm, OdbFormControl, OdbFormDefinition, readOdbForm };

package/dist/typed/odb/form.js

@@ -0,0 +1,84 @@
+import { decodeXmlText } from "../../xml/entities.js";
+import { attrValue, findChildElement, rootElement } from "../../xml/query.js";
+import { subDocumentPackage } from "./subdocument.js";
+import { readOdt } from "../odt/read.js";
+import { resolveOdbComponent } from "./read.js";
+//#region src/typed/odb/form.ts
+const CONTENT_PART = "content.xml";
+const FORM_ELEMENT_TAG = "form:form";
+const FORM_PROPERTIES_TAG = "form:properties";
+const FORM_TAG_PREFIX = "form:";
+function formAttr(element, name) {
+	const raw = attrValue(element, name);
+	return raw === void 0 ? void 0 : decodeXmlText(raw);
+}
+function readControl(element) {
+	const control = {
+		tag: element.tag,
+		controls: readControls(element)
+	};
+	const name = formAttr(element, "form:name");
+	if (name !== void 0) control.name = name;
+	const controlImplementation = formAttr(element, "form:control-implementation");
+	if (controlImplementation !== void 0) control.controlImplementation = controlImplementation;
+	const dataField = formAttr(element, "form:data-field");
+	if (dataField !== void 0) control.dataField = dataField;
+	const id = formAttr(element, "form:id");
+	if (id !== void 0) control.id = id;
+	const label = formAttr(element, "form:label");
+	if (label !== void 0) control.label = label;
+	return control;
+}
+function readControls(container) {
+	const controls = [];
+	for (const child of container.children) {
+		if (child.type !== "element" || !child.tag.startsWith(FORM_TAG_PREFIX)) continue;
+		if (child.tag === FORM_ELEMENT_TAG || child.tag === FORM_PROPERTIES_TAG) continue;
+		controls.push(readControl(child));
+	}
+	return controls;
+}
+function readFormDefinition(element) {
+	const subForms = [];
+	for (const child of element.children) if (child.type === "element" && child.tag === FORM_ELEMENT_TAG) subForms.push(readFormDefinition(child));
+	const definition = {
+		controls: readControls(element),
+		subForms
+	};
+	const name = formAttr(element, "form:name");
+	if (name !== void 0) definition.name = name;
+	const command = formAttr(element, "form:command");
+	if (command !== void 0) definition.command = command;
+	const commandType = formAttr(element, "form:command-type");
+	if (commandType !== void 0) definition.commandType = commandType;
+	const datasource = formAttr(element, "form:datasource");
+	if (datasource !== void 0) definition.datasource = datasource;
+	const filter = formAttr(element, "form:filter");
+	if (filter !== void 0) definition.filter = filter;
+	const order = formAttr(element, "form:order");
+	if (order !== void 0) definition.order = order;
+	return definition;
+}
+function readFormDefinitions(contentRoot) {
+	const body = contentRoot === void 0 ? void 0 : findChildElement(contentRoot.children, "office:body");
+	const text = body === void 0 ? void 0 : findChildElement(body.children, "office:text");
+	const forms = text === void 0 ? void 0 : findChildElement(text.children, "office:forms");
+	if (forms === void 0) return [];
+	const definitions = [];
+	for (const child of forms.children) if (child.type === "element" && child.tag === FORM_ELEMENT_TAG) definitions.push(readFormDefinition(child));
+	return definitions;
+}
+function readOdbForm(pkg, formName) {
+	const component = resolveOdbComponent(pkg, "form", formName);
+	const subPackage = subDocumentPackage(pkg, component.href);
+	const contentPart = subPackage.parts[CONTENT_PART];
+	if (contentPart?.kind !== "xml") throw new Error(`readOdbForm: form "${formName}" sub-document ${component.href}/${CONTENT_PART} is not an XML part`);
+	return {
+		name: component.name,
+		href: component.href,
+		document: readOdt(subPackage),
+		forms: readFormDefinitions(rootElement(contentPart.nodes))
+	};
+}
+//#endregion
+export { readOdbForm };

package/dist/typed/odb/read.cjs

@@ -1,13 +1,9 @@
 Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const require_manifest = require("../../manifest.cjs");
+const require_xml_entities = require("../../xml/entities.cjs");
 const require_xml_query = require("../../xml/query.cjs");
 //#region src/typed/odb/read.ts
 const CONTENT_PART = "content.xml";
 const EMBEDDED_URL_PREFIX = "sdbc:embedded:";
-const SUBDOCUMENT_CONTENT_SUFFIX = "/content.xml";
-function isXmlMediaType(mediaType) {
-	return mediaType === "text/xml" || mediaType === "application/xml" || mediaType.endsWith("+xml");
-}
 function formatServerDatabaseUrl(serverDatabase) {
 	const dbType = require_xml_query.attrValue(serverDatabase, "db:type");
 	if (dbType === void 0) return;
@@ -51,13 +47,24 @@ function readConnectionInfo(databaseElement) {
 		};
 	}
 }
-function collectQueryNames(container, names) {
+function collectQueryDefinitions(container, definitions) {
 	for (const child of container.children) {
 		if (child.type !== "element") continue;
 		if (child.tag === "db:query") {
 			const name = require_xml_query.attrValue(child, "db:name");
-			if (name !== void 0) names.push(name);
-		} else if (child.tag === "db:query-collection") collectQueryNames(child, names);
+			const command = require_xml_query.attrValue(child, "db:command");
+			if (name === void 0 || command === void 0) continue;
+			const decodedCommand = require_xml_entities.decodeXmlText(command);
+			const escapeProcessingRaw = require_xml_query.attrValue(child, "db:escape-processing");
+			definitions.push(escapeProcessingRaw === void 0 ? {
+				name,
+				command: decodedCommand
+			} : {
+				name,
+				command: decodedCommand,
+				escapeProcessing: escapeProcessingRaw === "true"
+			});
+		} else if (child.tag === "db:query-collection") collectQueryDefinitions(child, definitions);
 	}
 }
 function collectTableNames(databaseElement) {
@@ -76,16 +83,47 @@ function collectTableNames(databaseElement) {
 	if (tableDefinitions !== void 0) for (const definition of require_xml_query.childrenWithTag(tableDefinitions, "db:table-definition")) pushName(require_xml_query.attrValue(definition, "db:name"));
 	return names;
 }
-function subdocumentNamesUnderPrefix(entries, prefix) {
-	const names = [];
-	for (const entry of entries) {
-		if (!entry.fullPath.startsWith(prefix) || !entry.fullPath.endsWith(SUBDOCUMENT_CONTENT_SUFFIX) || !isXmlMediaType(entry.mediaType)) continue;
-		const withoutSuffix = entry.fullPath.slice(0, entry.fullPath.length - 12);
-		const lastSlash = withoutSuffix.lastIndexOf("/");
-		const name = lastSlash === -1 ? withoutSuffix.slice(prefix.length) : withoutSuffix.slice(lastSlash + 1);
-		if (name.length > 0) names.push(name);
+function collectComponents(container, components) {
+	for (const child of container.children) {
+		if (child.type !== "element") continue;
+		if (child.tag === "db:component-collection") {
+			collectComponents(child, components);
+			continue;
+		}
+		if (child.tag !== "db:component") continue;
+		const name = require_xml_query.attrValue(child, "db:name");
+		const rawHref = require_xml_query.attrValue(child, "xlink:href");
+		if (name === void 0 || rawHref === void 0) continue;
+		const decodedHref = require_xml_entities.decodeXmlText(rawHref);
+		const href = decodedHref.endsWith("/") ? decodedHref.slice(0, -1) : decodedHref;
+		if (href.length === 0) continue;
+		const asTemplateRaw = require_xml_query.attrValue(child, "db:as-template");
+		components.push(asTemplateRaw === void 0 ? {
+			name: require_xml_entities.decodeXmlText(name),
+			href
+		} : {
+			name: require_xml_entities.decodeXmlText(name),
+			href,
+			asTemplate: asTemplateRaw === "true"
+		});
 	}
-	return names;
+}
+function readComponents(databaseElement, tag) {
+	const container = require_xml_query.findChildElement(databaseElement.children, tag);
+	if (container === void 0) return [];
+	const components = [];
+	collectComponents(container, components);
+	return components;
+}
+function resolveOdbComponent(pkg, kind, name) {
+	const inventory = readOdbInventory(pkg);
+	const components = kind === "form" ? inventory.forms : inventory.reports;
+	const match = components.find((component) => component.name === name);
+	if (match === void 0) {
+		const available = components.map((component) => component.name).join(", ");
+		throw new Error(`resolveOdbComponent: no ${kind} named "${name}" -- available: ${available === "" ? "(none)" : available}`);
+	}
+	return match;
 }
 function readOdbInventory(pkg) {
 	const contentPart = pkg.parts[CONTENT_PART];
@@ -97,16 +135,15 @@ function readOdbInventory(pkg) {
 	const connection = readConnectionInfo(databaseElement);
 	const queries = [];
 	const queriesElement = require_xml_query.findChildElement(databaseElement.children, "db:queries");
-	if (queriesElement !== void 0) collectQueryNames(queriesElement, queries);
-	const tables = collectTableNames(databaseElement);
-	const manifest = require_manifest.readManifest(pkg);
+	if (queriesElement !== void 0) collectQueryDefinitions(queriesElement, queries);
 	return {
 		connection,
-		tables,
+		tables: collectTableNames(databaseElement),
 		queries,
-		forms: subdocumentNamesUnderPrefix(manifest.entries, "forms/"),
-		reports: subdocumentNamesUnderPrefix(manifest.entries, "reports/")
+		forms: readComponents(databaseElement, "db:forms"),
+		reports: readComponents(databaseElement, "db:reports")
 	};
 }
 //#endregion
 exports.readOdbInventory = readOdbInventory;
+exports.resolveOdbComponent = resolveOdbComponent;

package/dist/typed/odb/read.d.cts

@@ -5,13 +5,24 @@ interface OdbConnectionInfo {
   driverClass?: string;
   url?: string;
 }
+interface OdbQueryInfo {
+  name: string;
+  command: string;
+  escapeProcessing?: boolean;
+}
+interface OdbComponentInfo {
+  name: string;
+  href: string;
+  asTemplate?: boolean;
+}
 interface OdbInventory {
   connection: OdbConnectionInfo | undefined;
   tables: string[];
-  queries: string[];
-  forms: string[];
-  reports: string[];
+  queries: OdbQueryInfo[];
+  forms: OdbComponentInfo[];
+  reports: OdbComponentInfo[];
 }
+declare function resolveOdbComponent(pkg: Package, kind: 'form' | 'report', name: string): OdbComponentInfo;
 declare function readOdbInventory(pkg: Package): OdbInventory;
 //#endregion
-export { OdbConnectionInfo, OdbInventory, readOdbInventory };
+export { OdbComponentInfo, OdbConnectionInfo, OdbInventory, OdbQueryInfo, readOdbInventory, resolveOdbComponent };

package/dist/typed/odb/read.d.ts

@@ -5,13 +5,24 @@ interface OdbConnectionInfo {
   driverClass?: string;
   url?: string;
 }
+interface OdbQueryInfo {
+  name: string;
+  command: string;
+  escapeProcessing?: boolean;
+}
+interface OdbComponentInfo {
+  name: string;
+  href: string;
+  asTemplate?: boolean;
+}
 interface OdbInventory {
   connection: OdbConnectionInfo | undefined;
   tables: string[];
-  queries: string[];
-  forms: string[];
-  reports: string[];
+  queries: OdbQueryInfo[];
+  forms: OdbComponentInfo[];
+  reports: OdbComponentInfo[];
 }
+declare function resolveOdbComponent(pkg: Package, kind: 'form' | 'report', name: string): OdbComponentInfo;
 declare function readOdbInventory(pkg: Package): OdbInventory;
 //#endregion
-export { OdbConnectionInfo, OdbInventory, readOdbInventory };
+export { OdbComponentInfo, OdbConnectionInfo, OdbInventory, OdbQueryInfo, readOdbInventory, resolveOdbComponent };

package/dist/typed/odb/read.js

@@ -1,12 +1,8 @@
-import { readManifest } from "../../manifest.js";
+import { decodeXmlText } from "../../xml/entities.js";
 import { attrValue, childrenWithTag, findChildElement, rootElement } from "../../xml/query.js";
 //#region src/typed/odb/read.ts
 const CONTENT_PART = "content.xml";
 const EMBEDDED_URL_PREFIX = "sdbc:embedded:";
-const SUBDOCUMENT_CONTENT_SUFFIX = "/content.xml";
-function isXmlMediaType(mediaType) {
-	return mediaType === "text/xml" || mediaType === "application/xml" || mediaType.endsWith("+xml");
-}
 function formatServerDatabaseUrl(serverDatabase) {
 	const dbType = attrValue(serverDatabase, "db:type");
 	if (dbType === void 0) return;
@@ -50,13 +46,24 @@ function readConnectionInfo(databaseElement) {
 		};
 	}
 }
-function collectQueryNames(container, names) {
+function collectQueryDefinitions(container, definitions) {
 	for (const child of container.children) {
 		if (child.type !== "element") continue;
 		if (child.tag === "db:query") {
 			const name = attrValue(child, "db:name");
-			if (name !== void 0) names.push(name);
-		} else if (child.tag === "db:query-collection") collectQueryNames(child, names);
+			const command = attrValue(child, "db:command");
+			if (name === void 0 || command === void 0) continue;
+			const decodedCommand = decodeXmlText(command);
+			const escapeProcessingRaw = attrValue(child, "db:escape-processing");
+			definitions.push(escapeProcessingRaw === void 0 ? {
+				name,
+				command: decodedCommand
+			} : {
+				name,
+				command: decodedCommand,
+				escapeProcessing: escapeProcessingRaw === "true"
+			});
+		} else if (child.tag === "db:query-collection") collectQueryDefinitions(child, definitions);
 	}
 }
 function collectTableNames(databaseElement) {
@@ -75,16 +82,47 @@ function collectTableNames(databaseElement) {
 	if (tableDefinitions !== void 0) for (const definition of childrenWithTag(tableDefinitions, "db:table-definition")) pushName(attrValue(definition, "db:name"));
 	return names;
 }
-function subdocumentNamesUnderPrefix(entries, prefix) {
-	const names = [];
-	for (const entry of entries) {
-		if (!entry.fullPath.startsWith(prefix) || !entry.fullPath.endsWith(SUBDOCUMENT_CONTENT_SUFFIX) || !isXmlMediaType(entry.mediaType)) continue;
-		const withoutSuffix = entry.fullPath.slice(0, entry.fullPath.length - 12);
-		const lastSlash = withoutSuffix.lastIndexOf("/");
-		const name = lastSlash === -1 ? withoutSuffix.slice(prefix.length) : withoutSuffix.slice(lastSlash + 1);
-		if (name.length > 0) names.push(name);
+function collectComponents(container, components) {
+	for (const child of container.children) {
+		if (child.type !== "element") continue;
+		if (child.tag === "db:component-collection") {
+			collectComponents(child, components);
+			continue;
+		}
+		if (child.tag !== "db:component") continue;
+		const name = attrValue(child, "db:name");
+		const rawHref = attrValue(child, "xlink:href");
+		if (name === void 0 || rawHref === void 0) continue;
+		const decodedHref = decodeXmlText(rawHref);
+		const href = decodedHref.endsWith("/") ? decodedHref.slice(0, -1) : decodedHref;
+		if (href.length === 0) continue;
+		const asTemplateRaw = attrValue(child, "db:as-template");
+		components.push(asTemplateRaw === void 0 ? {
+			name: decodeXmlText(name),
+			href
+		} : {
+			name: decodeXmlText(name),
+			href,
+			asTemplate: asTemplateRaw === "true"
+		});
 	}
-	return names;
+}
+function readComponents(databaseElement, tag) {
+	const container = findChildElement(databaseElement.children, tag);
+	if (container === void 0) return [];
+	const components = [];
+	collectComponents(container, components);
+	return components;
+}
+function resolveOdbComponent(pkg, kind, name) {
+	const inventory = readOdbInventory(pkg);
+	const components = kind === "form" ? inventory.forms : inventory.reports;
+	const match = components.find((component) => component.name === name);
+	if (match === void 0) {
+		const available = components.map((component) => component.name).join(", ");
+		throw new Error(`resolveOdbComponent: no ${kind} named "${name}" -- available: ${available === "" ? "(none)" : available}`);
+	}
+	return match;
 }
 function readOdbInventory(pkg) {
 	const contentPart = pkg.parts[CONTENT_PART];
@@ -96,16 +134,14 @@ function readOdbInventory(pkg) {
 	const connection = readConnectionInfo(databaseElement);
 	const queries = [];
 	const queriesElement = findChildElement(databaseElement.children, "db:queries");
-	if (queriesElement !== void 0) collectQueryNames(queriesElement, queries);
-	const tables = collectTableNames(databaseElement);
-	const manifest = readManifest(pkg);
+	if (queriesElement !== void 0) collectQueryDefinitions(queriesElement, queries);
 	return {
 		connection,
-		tables,
+		tables: collectTableNames(databaseElement),
 		queries,
-		forms: subdocumentNamesUnderPrefix(manifest.entries, "forms/"),
-		reports: subdocumentNamesUnderPrefix(manifest.entries, "reports/")
+		forms: readComponents(databaseElement, "db:forms"),
+		reports: readComponents(databaseElement, "db:reports")
 	};
 }
 //#endregion
-export { readOdbInventory };
+export { readOdbInventory, resolveOdbComponent };