tally-simple 1.1.1 → 1.8.2

package/src/v5/external-api/api.js

@@ -0,0 +1,21 @@
+/**
+ * tally-simple (v5)
+ *
+ * Public Entry Point:
+ *  Connects the public allowlist (api.json) and domain specification (source.json)
+ *  through the internal-working route and execution engines.
+ */
+
+import source from "../source.json" with { type: "json" };
+import apiPaths from "./api.json" with { type: "json" };
+
+import createRoute from "../internal-working/route/index.js";
+import execute from "../internal-working/execution/index.js";
+
+const tally = createRoute({
+    inApiPaths: apiPaths,
+    inSource: source,
+    inExecutor: execute
+});
+
+export default tally;

package/src/v5/external-api/api.json

@@ -0,0 +1,6 @@
+[
+  "tally.masters.units.fetch",
+  "tally.masters.stockItems.withBatches",
+  "tally.masters.ledgers.withGstDetails",
+  "tally.masters.stockGroup.withParent"
+]

package/src/v5/index.js

@@ -0,0 +1 @@
+export { default } from "./external-api/api.js";

package/src/v5/internal-working/execution/buildXmlBody.js

@@ -0,0 +1,41 @@
+const escapeXml = (value) => value.replace(/[&<>"']/g, (character) => ({
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;"
+}[character]));
+
+const xmlEnvelopeTemplate = `<ENVELOPE>
+<HEADER>
+<VERSION>1</VERSION>
+<TALLYREQUEST>Export</TALLYREQUEST>
+<TYPE>Collection</TYPE>
+<ID>TDLID</ID>
+</HEADER>
+<BODY>
+<DESC>
+<STATICVARIABLES>
+<SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+<SVCURRENTCOMPANY>{company}</SVCURRENTCOMPANY>
+</STATICVARIABLES>
+<TDL>
+<TDLMESSAGE>
+<COLLECTION NAME="TDLID">
+{collectionBody}</COLLECTION>
+</TDLMESSAGE>
+</TDL>
+</DESC>
+</BODY>
+</ENVELOPE>`;
+
+const startFunc = ({ inCompany, inTdl }) => {
+    const localCompany = inCompany;
+    const localTdl = inTdl;
+
+    return xmlEnvelopeTemplate
+        .replace("{company}", escapeXml(localCompany))
+        .replace("{collectionBody}", localTdl?.collection ?? "");
+};
+
+export default startFunc;

package/src/v5/internal-working/execution/getTdl.js

@@ -0,0 +1,12 @@
+const startFunc = ({ inSource, inRoutePath }) => {
+    const localSource = inSource;
+    const localRoutePath = inRoutePath;
+
+    const endpoint = localRoutePath
+        .split(".")
+        .reduce((current, key) => current?.[key], localSource);
+
+    return endpoint?.tdl;
+};
+
+export default startFunc;

package/src/v5/internal-working/execution/index.js

@@ -0,0 +1,30 @@
+import validateCompany from "./validateCompany.js";
+import getTdl from "./getTdl.js";
+import buildXmlBody from "./buildXmlBody.js";
+import postHttp from "./postHttp.js";
+
+const startFunc = async ({ inRoutePath, inCompany, inSource }) => {
+    const localRoutePath = inRoutePath;
+    const localCompany = inCompany;
+    const localSource = inSource;
+
+    const companyName = validateCompany({
+        inCompany: localCompany
+    });
+
+    const tdl = getTdl({
+        inSource: localSource,
+        inRoutePath: localRoutePath
+    });
+
+    const xmlBody = buildXmlBody({
+        inCompany: companyName,
+        inTdl: tdl
+    });
+
+    return await postHttp({
+        inXmlBody: xmlBody
+    });
+};
+
+export default startFunc;

package/src/v5/internal-working/execution/postHttp.js

@@ -0,0 +1,26 @@
+const url = "http://localhost:9000";
+const headers = {
+    "Content-Type": "text/xml"
+};
+
+const startFunc = async ({ inXmlBody }) => {
+    const localXmlBody = inXmlBody;
+
+    const response = await fetch(url, {
+        method: "POST",
+        headers: headers,
+        body: localXmlBody
+    });
+
+    const responseText = await response.text();
+
+    if (!response.ok) {
+        throw new Error(
+            `Tally request failed with HTTP ${response.status}: ${responseText}`
+        );
+    }
+
+    return responseText;
+};
+
+export default startFunc;

package/src/v5/internal-working/execution/validateCompany.js

@@ -0,0 +1,11 @@
+const startFunc = ({ inCompany }) => {
+    const localCompany = inCompany;
+
+    if (typeof localCompany !== "string" || !localCompany.trim()) {
+        throw new TypeError("Company name is required.");
+    }
+
+    return localCompany.trim();
+};
+
+export default startFunc;

package/src/v5/internal-working/route/attachPath.js

@@ -0,0 +1,25 @@
+import createLeafHandler from "./createLeafHandler.js";
+
+const startFunc = ({ inTree, inPath, inSource, inExecutor }) => {
+    const localTree = inTree;
+    const localPath = inPath;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    const parts = localPath.split(".");
+    const leafName = parts.pop();
+
+    let branch = localTree;
+    for (const segment of parts) {
+        branch[segment] ??= {};
+        branch = branch[segment];
+    }
+
+    branch[leafName] = createLeafHandler({
+        inPath: localPath,
+        inSource: localSource,
+        inExecutor: localExecutor
+    });
+};
+
+export default startFunc;

package/src/v5/internal-working/route/createLeafHandler.js

@@ -0,0 +1,17 @@
+const startFunc = ({ inPath, inSource, inExecutor }) => {
+    const localPath = inPath;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    return async (inCompany) => {
+        const localCompany = inCompany;
+
+        return await localExecutor({
+            inRoutePath: localPath,
+            inCompany: localCompany,
+            inSource: localSource
+        });
+    };
+};
+
+export default startFunc;

package/src/v5/internal-working/route/index.js

@@ -0,0 +1,24 @@
+import attachPath from "./attachPath.js";
+
+const startFunc = ({ inApiPaths, inSource, inExecutor }) => {
+    const localApiPaths = inApiPaths;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    const tree = {};
+
+    for (const path of localApiPaths) {
+        attachPath({
+            inTree: tree,
+            inPath: path,
+            inSource: localSource,
+            inExecutor: localExecutor
+        });
+    }
+
+    const rootNamespace = localApiPaths[0]?.split(".")[0];
+
+    return rootNamespace ? tree[rootNamespace] : tree;
+};
+
+export default startFunc;

package/src/{v1 → v5}/source.json

@@ -1,40 +1,38 @@
-{
-    "tally": {
-        "connection": {
-            "url": "http://localhost:9000",
-            "method": "POST",
-            "headers": {
-                "Content-Type": "text/xml"
-            }
-        },
-        "request": {
-            "body": "<ENVELOPE>\n<HEADER>\n<VERSION>1</VERSION>\n<TALLYREQUEST>Export</TALLYREQUEST>\n<TYPE>Collection</TYPE>\n<ID>TDLID</ID>\n</HEADER>\n<BODY>\n<DESC>\n<STATICVARIABLES>\n<SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>\n<SVCURRENTCOMPANY>{company}</SVCURRENTCOMPANY>\n</STATICVARIABLES>\n<TDL>\n<TDLMESSAGE>\n<COLLECTION NAME=\"TDLID\">\n{collectionBody}</COLLECTION>\n</TDLMESSAGE>\n</TDL>\n</DESC>\n</BODY>\n</ENVELOPE>"
-        },
-        "masters": {
-            "units": {
-                "fetch": {
-                    "tdl": {
-                        "collection": "<TYPE>Unit</TYPE>\n<FETCH>$$Alias:Name</FETCH>\n"
-                    },
-                    "action": "fetch"
-                }
-            },
-            "stockItems": {
-                "withBatches": {
-                    "tdl": {
-                        "collection": "<TYPE>StockItem</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>BaseUnits</FETCH><FETCH>BatchAllocations.*</FETCH>"
-                    },
-                    "action": "fetch"
-                }
-            },
-            "ledgers": {
-                "withGstDetails": {
-                    "tdl": {
-                        "collection": "<TYPE>Ledger</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>LEDGSTREGDETAILS.LIST</FETCH>"
-                    },
-                    "action": "fetch"
-                }
-            }
-        }
-    }
-}
+{
+    "tally": {
+        "masters": {
+            "units": {
+                "fetch": {
+                    "tdl": {
+                        "collection": "<TYPE>Unit</TYPE>\n<FETCH>$$Alias:Name</FETCH>\n"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "stockItems": {
+                "withBatches": {
+                    "tdl": {
+                        "collection": "<TYPE>StockItem</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>BaseUnits</FETCH><FETCH>BatchAllocations.*</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "ledgers": {
+                "withGstDetails": {
+                    "tdl": {
+                        "collection": "<TYPE>Ledger</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>LEDGSTREGDETAILS.LIST</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "stockGroup": {
+                "withParent": {
+                    "tdl": {
+                        "collection": "<TYPE>StockGroup</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>Parent</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            }
+        }
+    }
+}

package/src/v6/external-api/api.js

@@ -0,0 +1,21 @@
+/**
+ * tally-simple (v5)
+ *
+ * Public Entry Point:
+ *  Connects the public allowlist (api.json) and domain specification (source.json)
+ *  through the internal-working route and execution engines.
+ */
+
+import source from "../source.json" with { type: "json" };
+import apiPaths from "./api.json" with { type: "json" };
+
+import createRoute from "../internal-working/route/index.js";
+import execute from "../internal-working/execution/index.js";
+
+const tally = createRoute({
+    inApiPaths: apiPaths,
+    inSource: source,
+    inExecutor: execute
+});
+
+export default tally;

package/src/v6/external-api/api.json

@@ -0,0 +1,6 @@
+[
+  "tally.masters.units.fetch",
+  "tally.masters.stockItems.withBatches",
+  "tally.masters.ledgers.withGstDetails",
+  "tally.masters.stockGroup.withParent"
+]

package/src/v6/index.js

@@ -0,0 +1 @@
+export { default } from "./external-api/api.js";

package/src/v6/internal-working/execution/buildXmlBody.js

@@ -0,0 +1,41 @@
+const escapeXml = (value) => value.replace(/[&<>"']/g, (character) => ({
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;"
+}[character]));
+
+const xmlEnvelopeTemplate = `<ENVELOPE>
+<HEADER>
+<VERSION>1</VERSION>
+<TALLYREQUEST>Export</TALLYREQUEST>
+<TYPE>Collection</TYPE>
+<ID>TDLID</ID>
+</HEADER>
+<BODY>
+<DESC>
+<STATICVARIABLES>
+<SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+<SVCURRENTCOMPANY>{company}</SVCURRENTCOMPANY>
+</STATICVARIABLES>
+<TDL>
+<TDLMESSAGE>
+<COLLECTION NAME="TDLID">
+{collectionBody}</COLLECTION>
+</TDLMESSAGE>
+</TDL>
+</DESC>
+</BODY>
+</ENVELOPE>`;
+
+const startFunc = ({ inCompany, inTdl }) => {
+    const localCompany = inCompany;
+    const localTdl = inTdl;
+
+    return xmlEnvelopeTemplate
+        .replace("{company}", escapeXml(localCompany))
+        .replace("{collectionBody}", localTdl?.collection ?? "");
+};
+
+export default startFunc;

package/src/v6/internal-working/execution/getTdl.js

@@ -0,0 +1,12 @@
+const startFunc = ({ inSource, inRoutePath }) => {
+    const localSource = inSource;
+    const localRoutePath = inRoutePath;
+
+    const endpoint = localRoutePath
+        .split(".")
+        .reduce((current, key) => current?.[key], localSource);
+
+    return endpoint?.tdl;
+};
+
+export default startFunc;

package/src/v6/internal-working/execution/index.js

@@ -0,0 +1,30 @@
+import validateCompany from "./validateCompany.js";
+import getTdl from "./getTdl.js";
+import buildXmlBody from "./buildXmlBody.js";
+import postHttp from "./postHttp.js";
+
+const startFunc = async ({ inRoutePath, inCompany, inSource }) => {
+    const localRoutePath = inRoutePath;
+    const localCompany = inCompany;
+    const localSource = inSource;
+
+    const companyName = validateCompany({
+        inCompany: localCompany
+    });
+
+    const tdl = getTdl({
+        inSource: localSource,
+        inRoutePath: localRoutePath
+    });
+
+    const xmlBody = buildXmlBody({
+        inCompany: companyName,
+        inTdl: tdl
+    });
+
+    return await postHttp({
+        inXmlBody: xmlBody
+    });
+};
+
+export default startFunc;

package/src/v6/internal-working/execution/postHttp.js

@@ -0,0 +1,26 @@
+const url = "http://localhost:9000";
+const headers = {
+    "Content-Type": "text/xml"
+};
+
+const startFunc = async ({ inXmlBody }) => {
+    const localXmlBody = inXmlBody;
+
+    const response = await fetch(url, {
+        method: "POST",
+        headers: headers,
+        body: localXmlBody
+    });
+
+    const responseText = await response.text();
+
+    if (!response.ok) {
+        throw new Error(
+            `Tally request failed with HTTP ${response.status}: ${responseText}`
+        );
+    }
+
+    return responseText;
+};
+
+export default startFunc;

package/src/v6/internal-working/execution/validateCompany.js

@@ -0,0 +1,11 @@
+const startFunc = ({ inCompany }) => {
+    const localCompany = inCompany;
+
+    if (typeof localCompany !== "string" || !localCompany.trim()) {
+        throw new TypeError("Company name is required.");
+    }
+
+    return localCompany.trim();
+};
+
+export default startFunc;

package/src/v6/internal-working/route/attachPath.js

@@ -0,0 +1,25 @@
+import createLeafHandler from "./createLeafHandler.js";
+
+const startFunc = ({ inTree, inPath, inSource, inExecutor }) => {
+    const localTree = inTree;
+    const localPath = inPath;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    const parts = localPath.split(".");
+    const leafName = parts.pop();
+
+    let branch = localTree;
+    for (const segment of parts) {
+        branch[segment] ??= {};
+        branch = branch[segment];
+    }
+
+    branch[leafName] = createLeafHandler({
+        inPath: localPath,
+        inSource: localSource,
+        inExecutor: localExecutor
+    });
+};
+
+export default startFunc;

package/src/v6/internal-working/route/createLeafHandler.js

@@ -0,0 +1,17 @@
+const startFunc = ({ inPath, inSource, inExecutor }) => {
+    const localPath = inPath;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    return async (inCompany) => {
+        const localCompany = inCompany;
+
+        return await localExecutor({
+            inRoutePath: localPath,
+            inCompany: localCompany,
+            inSource: localSource
+        });
+    };
+};
+
+export default startFunc;

package/src/v6/internal-working/route/index.js

@@ -0,0 +1,24 @@
+import attachPath from "./attachPath.js";
+
+const startFunc = ({ inApiPaths, inSource, inExecutor }) => {
+    const localApiPaths = inApiPaths;
+    const localSource = inSource;
+    const localExecutor = inExecutor;
+
+    const tree = {};
+
+    for (const path of localApiPaths) {
+        attachPath({
+            inTree: tree,
+            inPath: path,
+            inSource: localSource,
+            inExecutor: localExecutor
+        });
+    }
+
+    const rootNamespace = localApiPaths[0]?.split(".")[0];
+
+    return rootNamespace ? tree[rootNamespace] : tree;
+};
+
+export default startFunc;

package/src/v6/source.json

@@ -0,0 +1,38 @@
+{
+    "tally": {
+        "masters": {
+            "units": {
+                "fetch": {
+                    "tdl": {
+                        "collection": "<TYPE>Unit</TYPE>\n<FETCH>$$Alias:Name</FETCH>\n"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "stockItems": {
+                "withBatches": {
+                    "tdl": {
+                        "collection": "<TYPE>StockItem</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>BaseUnits</FETCH><FETCH>BatchAllocations.*</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "ledgers": {
+                "withGstDetails": {
+                    "tdl": {
+                        "collection": "<TYPE>Ledger</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>LEDGSTREGDETAILS.LIST</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            },
+            "stockGroup": {
+                "withParent": {
+                    "tdl": {
+                        "collection": "<TYPE>StockGroup</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>Parent</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            }
+        }
+    }
+}

package/src/v7/api.json

@@ -0,0 +1,6 @@
+[
+  "tally.masters.units.fetch",
+  "tally.masters.stockItems.withBatches",
+  "tally.masters.ledgers.withGstDetails",
+  "tally.masters.stockGroup.withParent"
+]

package/src/v7/index.js

@@ -0,0 +1,14 @@
+import source from "./source.json" with { type: "json" };
+import apiPaths from "./api.json" with { type: "json" };
+
+import createRoute from "./internal-working/route/index.js";
+import execute from "./internal-working/execution/index.js";
+
+const tally = createRoute({
+    inApiPaths: apiPaths,
+    inSource: source,
+    inExecutor: execute
+});
+
+export default tally;
+

package/src/v7/internal-working/execution/buildXmlBody.js

@@ -0,0 +1,41 @@
+const escapeXml = (value) => value.replace(/[&<>"']/g, (character) => ({
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;"
+}[character]));
+
+const xmlEnvelopeTemplate = `<ENVELOPE>
+<HEADER>
+<VERSION>1</VERSION>
+<TALLYREQUEST>Export</TALLYREQUEST>
+<TYPE>Collection</TYPE>
+<ID>TDLID</ID>
+</HEADER>
+<BODY>
+<DESC>
+<STATICVARIABLES>
+<SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+<SVCURRENTCOMPANY>{company}</SVCURRENTCOMPANY>
+</STATICVARIABLES>
+<TDL>
+<TDLMESSAGE>
+<COLLECTION NAME="TDLID">
+{collectionBody}</COLLECTION>
+</TDLMESSAGE>
+</TDL>
+</DESC>
+</BODY>
+</ENVELOPE>`;
+
+const startFunc = ({ inCompany, inTdl }) => {
+    const localCompany = inCompany;
+    const localTdl = inTdl;
+
+    return xmlEnvelopeTemplate
+        .replace("{company}", escapeXml(localCompany))
+        .replace("{collectionBody}", localTdl?.collection ?? "");
+};
+
+export default startFunc;

package/src/v7/internal-working/execution/getTdl.js

@@ -0,0 +1,12 @@
+const startFunc = ({ inSource, inRoutePath }) => {
+    const localSource = inSource;
+    const localRoutePath = inRoutePath;
+
+    const endpoint = localRoutePath
+        .split(".")
+        .reduce((current, key) => current?.[key], localSource);
+
+    return endpoint?.tdl;
+};
+
+export default startFunc;