@olenbetong/appframe-core 2.16.0 → 2.16.1

package/es/index.js

@@ -19,4 +19,4 @@ export { UserSession };
 export { alert, ConfirmButtons, confirm, openAlertDialog, waitForDialog } from "./alert.js";
 export { getSettings, saveSettings } from "./settings.js";
 // oxlint-disable-next-line no-use-before-define -- this is injected build time
-export const version = "2.15.2";
+export const version = "2.16.1";

package/es/report/recordSource.d.ts

@@ -27,4 +27,4 @@ export declare function readElements(xml: string, name: string): string[];
  * Returns `null` for anything that is not a record source, so a missing or
  * empty `RecordSource` column simply means "no lookup".
  */
-export declare function parseRecordSource(xml: string | null | undefined): ReportRecordSource | null;
+export declare function parseRecordSource(document: string | null | undefined): ReportRecordSource | null;

package/es/report/recordSource.js

@@ -80,6 +80,19 @@ function readSelectColumns(xml) {
     }
     return columns;
 }
+/**
+ * The record source a document holds. Parameter lookups store one `<afRecordSource>`; a report
+ * stores its record sources as `<ArrayOfAfReportRecordSource>` with one `<afReportRecordSource>`
+ * per data source, of which the one with the ID `Master` feeds the report (else the first).
+ */
+function pickRecordSource(document) {
+    if (!document)
+        return null;
+    let sources = [...document.matchAll(/<(afRecordSource|afReportRecordSource)(?:\s[^>]*)?>([\s\S]*?)<\/\1>/g)].map((match) => match[2]);
+    if (sources.length === 0)
+        return null;
+    return sources.find((source) => readElement(source, "ID") === "Master") ?? sources[0];
+}
 /**
  * Reads the parts of an `afRecordSource` a web client can act on: the view, the
  * selected columns and the design-time filter.
@@ -87,8 +100,9 @@ function readSelectColumns(xml) {
  * Returns `null` for anything that is not a record source, so a missing or
  * empty `RecordSource` column simply means "no lookup".
  */
-export function parseRecordSource(xml) {
-    if (!xml || !xml.includes("<afRecordSource"))
+export function parseRecordSource(document) {
+    let xml = pickRecordSource(document);
+    if (!xml)
         return null;
     let viewName = readElement(xml, "ViewName");
     if (!viewName)

package/es/report/report.test.js

@@ -36,6 +36,42 @@ describe("parseRecordSource", () => {
         let xml = recordSource.replace("[Level] = 1", "[Name] Like '%a & b%'");
         expect(parseRecordSource(xml)?.filterString).toBe("[Name] Like '%a & b%'");
     });
+    it("reads a report's record sources, taking the master one", () => {
+        let report = `<?xml version="1.0" encoding="utf-16"?>
+<ArrayOfAfReportRecordSource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <afReportRecordSource>
+    <ViewName>aviw_Production_ElementsSub</ViewName>
+    <FilterString />
+    <ID>Sub</ID>
+  </afReportRecordSource>
+  <afReportRecordSource>
+    <IsFilterChanging>false</IsFilterChanging>
+    <ViewName>aviw_Production_ElementsProductionPerCutOffWithPrevious</ViewName>
+    <SelectColumns>
+      <afSelectColumn><Name>ProjectID</Name></afSelectColumn>
+      <afSelectColumn><Name>Area</Name><DataType>Decimal</DataType></afSelectColumn>
+    </SelectColumns>
+    <WhereClause>[Type] = 'Element'</WhereClause>
+    <FilterString>[ProjectID] = 'PT19-1004' AND [Period] = '2021-49'</FilterString>
+    <MaxRecords>0</MaxRecords>
+    <ID>Master</ID>
+  </afReportRecordSource>
+</ArrayOfAfReportRecordSource>`;
+        expect(parseRecordSource(report)).toEqual({
+            viewName: "aviw_Production_ElementsProductionPerCutOffWithPrevious",
+            columns: [
+                { name: "ProjectID", type: "string" },
+                { name: "Area", type: "number" },
+            ],
+            whereClause: "[Type] = 'Element'",
+            filterString: "[ProjectID] = 'PT19-1004' AND [Period] = '2021-49'",
+            maxRecords: null,
+        });
+    });
+    it("takes the first record source when none is the master", () => {
+        let report = `<ArrayOfAfReportRecordSource><afReportRecordSource><ViewName>aviw_A</ViewName></afReportRecordSource><afReportRecordSource><ViewName>aviw_B</ViewName></afReportRecordSource></ArrayOfAfReportRecordSource>`;
+        expect(parseRecordSource(report)?.viewName).toBe("aviw_A");
+    });
     it("returns nothing for anything that is not a record source", () => {
         expect(parseRecordSource(null)).toBeNull();
         expect(parseRecordSource("")).toBeNull();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@olenbetong/appframe-core",
-  "version": "2.16.0",
+  "version": "2.16.1",
   "description": "Javascript libraries to utilize the Appframe framework",
   "type": "module",
   "sideEffects": [
@@ -44,7 +44,7 @@
     "@types/bun": "^1.4.4",
     "chalk": "^6.0.1",
     "typescript": "7.0.2",
-    "vitest": "5.0.5"
+    "vitest": "5.1.0"
   },
   "peerDependencies": {},
   "optionalDependencies": {},

package/src/report/recordSource.ts

@@ -97,6 +97,20 @@ function readSelectColumns(xml: string): ReportRecordSourceColumn[] {
 	return columns;
 }
 
+/**
+ * The record source a document holds. Parameter lookups store one `<afRecordSource>`; a report
+ * stores its record sources as `<ArrayOfAfReportRecordSource>` with one `<afReportRecordSource>`
+ * per data source, of which the one with the ID `Master` feeds the report (else the first).
+ */
+function pickRecordSource(document: string | null | undefined): string | null {
+	if (!document) return null;
+	let sources = [...document.matchAll(/<(afRecordSource|afReportRecordSource)(?:\s[^>]*)?>([\s\S]*?)<\/\1>/g)].map(
+		(match) => match[2],
+	);
+	if (sources.length === 0) return null;
+	return sources.find((source) => readElement(source, "ID") === "Master") ?? sources[0];
+}
+
 /**
  * Reads the parts of an `afRecordSource` a web client can act on: the view, the
  * selected columns and the design-time filter.
@@ -104,8 +118,9 @@ function readSelectColumns(xml: string): ReportRecordSourceColumn[] {
  * Returns `null` for anything that is not a record source, so a missing or
  * empty `RecordSource` column simply means "no lookup".
  */
-export function parseRecordSource(xml: string | null | undefined): ReportRecordSource | null {
-	if (!xml || !xml.includes("<afRecordSource")) return null;
+export function parseRecordSource(document: string | null | undefined): ReportRecordSource | null {
+	let xml = pickRecordSource(document);
+	if (!xml) return null;
 
 	let viewName = readElement(xml, "ViewName");
 	if (!viewName) return null;

package/src/report/report.test.ts

@@ -47,6 +47,45 @@ describe("parseRecordSource", () => {
 		expect(parseRecordSource(xml)?.filterString).toBe("[Name] Like '%a & b%'");
 	});
 
+	it("reads a report's record sources, taking the master one", () => {
+		let report = `<?xml version="1.0" encoding="utf-16"?>
+<ArrayOfAfReportRecordSource xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+  <afReportRecordSource>
+    <ViewName>aviw_Production_ElementsSub</ViewName>
+    <FilterString />
+    <ID>Sub</ID>
+  </afReportRecordSource>
+  <afReportRecordSource>
+    <IsFilterChanging>false</IsFilterChanging>
+    <ViewName>aviw_Production_ElementsProductionPerCutOffWithPrevious</ViewName>
+    <SelectColumns>
+      <afSelectColumn><Name>ProjectID</Name></afSelectColumn>
+      <afSelectColumn><Name>Area</Name><DataType>Decimal</DataType></afSelectColumn>
+    </SelectColumns>
+    <WhereClause>[Type] = 'Element'</WhereClause>
+    <FilterString>[ProjectID] = 'PT19-1004' AND [Period] = '2021-49'</FilterString>
+    <MaxRecords>0</MaxRecords>
+    <ID>Master</ID>
+  </afReportRecordSource>
+</ArrayOfAfReportRecordSource>`;
+
+		expect(parseRecordSource(report)).toEqual({
+			viewName: "aviw_Production_ElementsProductionPerCutOffWithPrevious",
+			columns: [
+				{ name: "ProjectID", type: "string" },
+				{ name: "Area", type: "number" },
+			],
+			whereClause: "[Type] = 'Element'",
+			filterString: "[ProjectID] = 'PT19-1004' AND [Period] = '2021-49'",
+			maxRecords: null,
+		});
+	});
+
+	it("takes the first record source when none is the master", () => {
+		let report = `<ArrayOfAfReportRecordSource><afReportRecordSource><ViewName>aviw_A</ViewName></afReportRecordSource><afReportRecordSource><ViewName>aviw_B</ViewName></afReportRecordSource></ArrayOfAfReportRecordSource>`;
+		expect(parseRecordSource(report)?.viewName).toBe("aviw_A");
+	});
+
 	it("returns nothing for anything that is not a record source", () => {
 		expect(parseRecordSource(null)).toBeNull();
 		expect(parseRecordSource("")).toBeNull();