tally-simple 1.1.1 → 1.3.1

package/src/v1/traverseObject/index.js

@@ -1,39 +1,39 @@
-import { traverse } from "../traverse.js";
-
-const traverseObject = async (
-    specJson,
-    relativePath,
-    pathToFind,
-    context = {}
-) => {
-    const nextContext = {
-        ...context,
-        connection: specJson.connection ?? context.connection,
-        request: specJson.request ?? context.request
-    };
-
-    for (const [key, value] of Object.entries(specJson)) {
-        if (key === "connection" || key === "request") continue;
-
-        if (typeof value === "object" && value !== null) {
-            const nextPath = relativePath
-                ? `${relativePath}.${key}`
-                : key;
-
-            const result = await traverse(
-                value,
-                nextPath,
-                pathToFind,
-                nextContext
-            );
-
-            if (result !== undefined) {
-                return result;
-            }
-        }
-    }
-
-    return undefined;
-};
-
-export default traverseObject;
+import { traverse } from "../traverse.js";
+
+const traverseObject = async (
+    specJson,
+    relativePath,
+    pathToFind,
+    context = {}
+) => {
+    const nextContext = {
+        ...context,
+        connection: specJson.connection ?? context.connection,
+        request: specJson.request ?? context.request
+    };
+
+    for (const [key, value] of Object.entries(specJson)) {
+        if (key === "connection" || key === "request") continue;
+
+        if (typeof value === "object" && value !== null) {
+            const nextPath = relativePath
+                ? `${relativePath}.${key}`
+                : key;
+
+            const result = await traverse(
+                value,
+                nextPath,
+                pathToFind,
+                nextContext
+            );
+
+            if (result !== undefined) {
+                return result;
+            }
+        }
+    }
+
+    return undefined;
+};
+
+export default traverseObject;

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

@@ -0,0 +1,67 @@
+import source from "../source.json" with { type: "json" };
+import traverse from "../traverse.js";
+import apiPaths from "./api.json" with { type: "json" };
+
+const createApi = (options = {}) => {
+    const connection = {
+        ...source.tally.connection,
+        ...options.connection,
+        ...(options.url ? { url: options.url } : {}),
+        ...(options.method ? { method: options.method } : {}),
+        headers: {
+            ...source.tally.connection.headers,
+            ...options.connection?.headers,
+            ...options.headers
+        }
+    };
+    const request = options.request ?? source.tally.request;
+    const fetchImpl = options.fetch ?? globalThis.fetch;
+    const clientSource = {
+        ...source,
+        tally: {
+            ...source.tally,
+            connection,
+            request
+        }
+    };
+
+    const createFunction = (path) => async (company) => {
+        if (typeof company !== "string" || !company.trim()) {
+            throw new TypeError("Company name is required.");
+        }
+
+        return await traverse(clientSource, "", path, {
+            company: company.trim(),
+            connection,
+            request,
+            fetch: fetchImpl,
+            timeout: options.timeout
+        });
+    };
+
+    const root = {};
+
+    for (const path of apiPaths) {
+        const parts = path.split(".");
+        let current = root;
+
+        parts.forEach((part, index) => {
+            const isLast = index === parts.length - 1;
+
+            if (isLast) {
+                current[part] = createFunction(path);
+                return;
+            }
+
+            current[part] ??= {};
+            current = current[part];
+        });
+    }
+
+    const rootName = apiPaths[0]?.split(".")[0];
+
+    return rootName ? root[rootName] : root;
+};
+
+export { createApi };
+export default createApi();

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

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

package/src/v2/external-api/index.js

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

package/src/v2/index.js

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

package/src/v2/source.json

@@ -0,0 +1,40 @@
+{
+    "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"
+                }
+            }
+        }
+    }
+}

package/src/v2/traverse.js

@@ -0,0 +1,103 @@
+import traverseObject from "./traverseObject/index.js";
+
+const escapeXml = (value) => value.replace(/[&<>"']/g, (character) => ({
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;"
+}[character]));
+
+const buildRequestBody = (requestBody, { company, collection }) => {
+    return requestBody
+        .replace("{company}", escapeXml(company))
+        .replace("{collectionBody}", collection);
+};
+
+const execute = async (connection, xml, fetchImpl, timeout) => {
+    if (typeof fetchImpl !== "function") {
+        throw new Error(
+            "No fetch implementation is available. Use Node.js 20+ or provide fetch to createTallyClient()."
+        );
+    }
+
+    const controller = typeof AbortController === "function"
+        ? new AbortController()
+        : undefined;
+    const timeoutId = Number.isFinite(timeout) && timeout > 0
+        ? setTimeout(() => controller?.abort(), timeout)
+        : undefined;
+
+    let response;
+
+    try {
+        response = await fetchImpl(connection.url, {
+            method: connection.method,
+            headers: connection.headers,
+            body: xml,
+            ...(controller ? { signal: controller.signal } : {})
+        });
+    } catch (error) {
+        if (controller?.signal.aborted) {
+            throw new Error(`Tally request timed out after ${timeout} ms.`, {
+                cause: error
+            });
+        }
+
+        throw error;
+    } finally {
+        if (timeoutId) clearTimeout(timeoutId);
+    }
+
+    const responseText = await response.text();
+
+    if (!response.ok) {
+        throw new Error(
+            `Tally request failed with HTTP ${response.status}: ${responseText}`
+        );
+    }
+
+    return responseText;
+};
+
+const traverse = async (
+    raka,
+    relativePath,
+    pathToFind,
+    context = {}
+) => {
+    if (relativePath === pathToFind) {
+        if (raka?.action === "fetch") {
+            const body = buildRequestBody(
+                context.request.body,
+                {
+                    company: context.company,
+                    collection: raka.tdl.collection
+                }
+            );
+
+            return await execute(
+                context.connection,
+                body,
+                context.fetch,
+                context.timeout
+            );
+        }
+
+        return raka;
+    }
+
+    if (typeof raka === "object" && raka !== null) {
+        return await traverseObject(
+            raka,
+            relativePath,
+            pathToFind,
+            context
+        );
+    }
+
+    return undefined;
+};
+
+export { traverse };
+export default traverse;

package/src/v2/traverseObject/index.js

@@ -0,0 +1,39 @@
+import { traverse } from "../traverse.js";
+
+const traverseObject = async (
+    specJson,
+    relativePath,
+    pathToFind,
+    context = {}
+) => {
+    const nextContext = {
+        ...context,
+        connection: specJson.connection ?? context.connection,
+        request: specJson.request ?? context.request
+    };
+
+    for (const [key, value] of Object.entries(specJson)) {
+        if (key === "connection" || key === "request") continue;
+
+        if (typeof value === "object" && value !== null) {
+            const nextPath = relativePath
+                ? `${relativePath}.${key}`
+                : key;
+
+            const result = await traverse(
+                value,
+                nextPath,
+                pathToFind,
+                nextContext
+            );
+
+            if (result !== undefined) {
+                return result;
+            }
+        }
+    }
+
+    return undefined;
+};
+
+export default traverseObject;

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

@@ -0,0 +1,67 @@
+import source from "../source.json" with { type: "json" };
+import traverse from "../traverse.js";
+import apiPaths from "./api.json" with { type: "json" };
+
+const createApi = (options = {}) => {
+    const connection = {
+        ...source.tally.connection,
+        ...options.connection,
+        ...(options.url ? { url: options.url } : {}),
+        ...(options.method ? { method: options.method } : {}),
+        headers: {
+            ...source.tally.connection.headers,
+            ...options.connection?.headers,
+            ...options.headers
+        }
+    };
+    const request = options.request ?? source.tally.request;
+    const fetchImpl = options.fetch ?? globalThis.fetch;
+    const clientSource = {
+        ...source,
+        tally: {
+            ...source.tally,
+            connection,
+            request
+        }
+    };
+
+    const createFunction = (path) => async (company) => {
+        if (typeof company !== "string" || !company.trim()) {
+            throw new TypeError("Company name is required.");
+        }
+
+        return await traverse(clientSource, "", path, {
+            company: company.trim(),
+            connection,
+            request,
+            fetch: fetchImpl,
+            timeout: options.timeout
+        });
+    };
+
+    const root = {};
+
+    for (const path of apiPaths) {
+        const parts = path.split(".");
+        let current = root;
+
+        parts.forEach((part, index) => {
+            const isLast = index === parts.length - 1;
+
+            if (isLast) {
+                current[part] = createFunction(path);
+                return;
+            }
+
+            current[part] ??= {};
+            current = current[part];
+        });
+    }
+
+    const rootName = apiPaths[0]?.split(".")[0];
+
+    return rootName ? root[rootName] : root;
+};
+
+export { createApi };
+export default createApi();

package/src/v3/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/v3/external-api/index.js

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

package/src/v3/index.js

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

package/src/v3/source.json

@@ -0,0 +1,48 @@
+{
+    "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"
+                }
+            },
+            "stockGroup": {
+                "withParent": {
+                    "tdl": {
+                        "collection": "<TYPE>StockGroup</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>Parent</FETCH>"
+                    },
+                    "action": "fetch"
+                }
+            }
+        }
+    }
+}

package/src/v3/traverse.js

@@ -0,0 +1,103 @@
+import traverseObject from "./traverseObject/index.js";
+
+const escapeXml = (value) => value.replace(/[&<>"']/g, (character) => ({
+    "&": "&amp;",
+    "<": "&lt;",
+    ">": "&gt;",
+    '"': "&quot;",
+    "'": "&apos;"
+}[character]));
+
+const buildRequestBody = (requestBody, { company, collection }) => {
+    return requestBody
+        .replace("{company}", escapeXml(company))
+        .replace("{collectionBody}", collection);
+};
+
+const execute = async (connection, xml, fetchImpl, timeout) => {
+    if (typeof fetchImpl !== "function") {
+        throw new Error(
+            "No fetch implementation is available. Use Node.js 20+ or provide fetch to createTallyClient()."
+        );
+    }
+
+    const controller = typeof AbortController === "function"
+        ? new AbortController()
+        : undefined;
+    const timeoutId = Number.isFinite(timeout) && timeout > 0
+        ? setTimeout(() => controller?.abort(), timeout)
+        : undefined;
+
+    let response;
+
+    try {
+        response = await fetchImpl(connection.url, {
+            method: connection.method,
+            headers: connection.headers,
+            body: xml,
+            ...(controller ? { signal: controller.signal } : {})
+        });
+    } catch (error) {
+        if (controller?.signal.aborted) {
+            throw new Error(`Tally request timed out after ${timeout} ms.`, {
+                cause: error
+            });
+        }
+
+        throw error;
+    } finally {
+        if (timeoutId) clearTimeout(timeoutId);
+    }
+
+    const responseText = await response.text();
+
+    if (!response.ok) {
+        throw new Error(
+            `Tally request failed with HTTP ${response.status}: ${responseText}`
+        );
+    }
+
+    return responseText;
+};
+
+const traverse = async (
+    raka,
+    relativePath,
+    pathToFind,
+    context = {}
+) => {
+    if (relativePath === pathToFind) {
+        if (raka?.action === "fetch") {
+            const body = buildRequestBody(
+                context.request.body,
+                {
+                    company: context.company,
+                    collection: raka.tdl.collection
+                }
+            );
+
+            return await execute(
+                context.connection,
+                body,
+                context.fetch,
+                context.timeout
+            );
+        }
+
+        return raka;
+    }
+
+    if (typeof raka === "object" && raka !== null) {
+        return await traverseObject(
+            raka,
+            relativePath,
+            pathToFind,
+            context
+        );
+    }
+
+    return undefined;
+};
+
+export { traverse };
+export default traverse;

package/src/v3/traverseObject/index.js

@@ -0,0 +1,39 @@
+import { traverse } from "../traverse.js";
+
+const traverseObject = async (
+    specJson,
+    relativePath,
+    pathToFind,
+    context = {}
+) => {
+    const nextContext = {
+        ...context,
+        connection: specJson.connection ?? context.connection,
+        request: specJson.request ?? context.request
+    };
+
+    for (const [key, value] of Object.entries(specJson)) {
+        if (key === "connection" || key === "request") continue;
+
+        if (typeof value === "object" && value !== null) {
+            const nextPath = relativePath
+                ? `${relativePath}.${key}`
+                : key;
+
+            const result = await traverse(
+                value,
+                nextPath,
+                pathToFind,
+                nextContext
+            );
+
+            if (result !== undefined) {
+                return result;
+            }
+        }
+    }
+
+    return undefined;
+};
+
+export default traverseObject;

package/docs/cli.md

@@ -1,32 +0,0 @@
-# CLI reference
-
-The package publishes the tally-simple executable. With npm, use it through npx:
-
-~~~bash
-npx tally-simple <api-path> --company <company>
-~~~
-
-## Options
-
-| Option | Meaning |
-| --- | --- |
-| -c, --company <name> | Company to query. Also reads TALLY_COMPANY. |
-| -u, --url <url> | Tally endpoint. Also reads TALLY_URL. |
-| --header <name:value> | Adds a request header. Repeat it for multiple headers. |
-| --timeout <ms> | Aborts a request after the given number of milliseconds. |
-| -h, --help | Prints command help. |
-| -v, --version | Prints the installed package version. |
-
-The command accepts masters.units.fetch and tally.masters.units.fetch equivalently. The response is written unchanged to stdout; errors and usage help are written to stderr.
-
-Examples:
-
-~~~bash
-npx tally-simple masters.units.fetch --company Mani9
-
-npx tally-simple masters.stockItems.withBatches \
-    --company Mani9 \
-    --header X-Request-Source:nightly
-
-TALLY_COMPANY=Mani9 npx tally-simple masters.units.fetch
-~~~