tally-simple 1.1.1 → 1.3.1

package/package.json

@@ -1,47 +1,55 @@
-{
-    "name": "tally-simple",
-    "version": "1.1.1",
-    "description": "A small, typed JavaScript client and CLI for querying Tally through TDL definitions.",
-    "type": "module",
-    "exports": {
-        ".": {
-            "types": "./src/index.d.ts",
-            "import": "./src/index.js",
-            "default": "./src/index.js"
-        },
-        "./package.json": "./package.json"
-    },
-    "bin": {
-        "tally-simple": "bin/tally-simple.js"
-    },
-    "main": "./src/index.js",
-    "types": "./src/index.d.ts",
-    "files": [
-        "bin",
-        "src",
-        "docs",
-        "README.md",
-        "CHANGELOG.md",
-        "LICENSE"
-    ],
-    "scripts": {
-        "generate:dts": "node generate-dts.js",
-        "test": "node --test test/test.js test/units.js",
-        "verify": "npm run generate:dts && npm test",
-        "prepack": "npm run verify",
-        "prepublishOnly": "npm run verify"
-    },
-    "keywords": [
-        "tally",
-        "tdl",
-        "api",
-        "accounting"
-    ],
-    "license": "MIT",
-    "engines": {
-        "node": ">=20.10"
-    },
-    "publishConfig": {
-        "access": "public"
-    }
-}
+{
+    "name": "tally-simple",
+    "version": "1.3.1",
+    "description": "A small, typed JavaScript client and CLI for querying Tally through TDL definitions.",
+    "homepage": "https://github.com/keshavsoft/tally-simple#readme",
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/keshavsoft/tally-simple.git"
+    },
+    "bugs": {
+        "url": "https://github.com/keshavsoft/tally-simple/issues"
+    },
+    "type": "module",
+    "exports": {
+        ".": {
+            "types": "./src/index.d.ts",
+            "import": "./src/index.js",
+            "default": "./src/index.js"
+        },
+        "./package.json": "./package.json"
+    },
+    "bin": {
+        "tally-simple": "./bin/tally-simple.js"
+    },
+    "main": "./src/index.js",
+    "types": "./src/index.d.ts",
+    "files": [
+        "bin",
+        "src",
+        "docs",
+        "README.md",
+        "CHANGELOG.md",
+        "LICENSE"
+    ],
+    "scripts": {
+        "generate:dts": "node generate-dts.js",
+        "test": "node --test test/test.js test/units.js",
+        "verify": "npm run generate:dts && npm test",
+        "prepack": "npm run verify",
+        "prepublishOnly": "npm run verify"
+    },
+    "keywords": [
+        "tally",
+        "tdl",
+        "api",
+        "accounting"
+    ],
+    "license": "MIT",
+    "engines": {
+        "node": ">=20.10"
+    },
+    "publishConfig": {
+        "access": "public"
+    }
+}

package/src/index.d.ts

@@ -1,8 +1,17 @@
+/**
+ * Generated from src/v3/external-api/api.json and src/v3/source.json.
+ * Do not edit this file directly. Run npm run generate:dts instead.
+ */
 export interface TallyClientOptions {
+    /** Tally HTTP endpoint. Defaults to http://localhost:9000. */
     url?: string;
+    /** HTTP method used for the Tally request. Defaults to POST. */
     method?: string;
+    /** Additional request headers. */
     headers?: Record<string, string>;
+    /** Abort the request after this many milliseconds. */
     timeout?: number;
+    /** Optional fetch-compatible implementation for tests or adapters. */
     fetch?: (url: string, options: {
         method: string;
         headers: Record<string, string>;
@@ -18,19 +27,28 @@ export interface TallyClientOptions {
 export type TallyApi = {
     masters: {
         units: {
+            /** Runs tally.masters.units.fetch and returns Tally's raw XML response. */
             fetch: (company: string) => Promise<string>;
         };
         stockItems: {
+            /** Runs tally.masters.stockItems.withBatches and returns Tally's raw XML response. */
             withBatches: (company: string) => Promise<string>;
         };
         ledgers: {
+            /** Runs tally.masters.ledgers.withGstDetails and returns Tally's raw XML response. */
             withGstDetails: (company: string) => Promise<string>;
         };
+        stockGroup: {
+            /** Runs tally.masters.stockGroup.withParent and returns Tally's raw XML response. */
+            withParent: (company: string) => Promise<string>;
+        };
     };
 };
 
-declare const tally: TallyApi;
-
+/** Create an independently configured Tally client. */
 export declare const createTallyClient: (options?: TallyClientOptions) => TallyApi;
+
+/** Default Tally client using the package connection defaults. */
 export declare const tally: TallyApi;
+
 export default tally;

package/src/index.js

@@ -1,8 +1,8 @@
-import { createApi } from "./v1/index.js";
-
-const createTallyClient = (options = {}) => createApi(options);
-
-const tally = createTallyClient();
-
-export { createTallyClient, tally };
-export default tally;
+import { createApi } from "./v3/index.js";
+
+const createTallyClient = (options = {}) => createApi(options);
+
+const tally = createTallyClient();
+
+export { createTallyClient, tally };
+export default tally;

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

@@ -1,67 +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();
+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/v1/external-api/api.json

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

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

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

package/src/v1/index.js

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

package/src/v1/source.json

@@ -1,40 +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"
-                }
-            }
-        }
-    }
-}
+{
+    "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/v1/traverse.js

@@ -1,103 +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;
+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;