tally-http-json 0.0.0-stage → 1.2.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 KeshavSoft
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to do so, subject to the
+following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,77 @@
-# Temporary Holding Version
-
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+# tally-extract
+
+Fast, typed Tally XML & JSON client for Node.js, driven directly by structure specifications.
+
+[![npm version](https://img.shields.io/npm/v/tally-extract.svg)](https://www.npmjs.com/package/tally-extract)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+---
+
+## Features
+
+- **Dual Return Flavor:** Query raw TDL XML responses or automatically parsed JSON objects.
+- **Autocomplete Tree:** Fully typed dot-notation interface with IntelliSense for all endpoints (e.g. `tally.company.fetch()`, `tally.masters.units.all()`).
+- **Direct Route Calls:** Invoke endpoints flexibly with path strings using `call()` or `asJson()`.
+- **Zero Schema Dependencies:** Pure ES Module client with built-in TypeScript declarations.
+
+---
+
+## Installation
+
+```bash
+npm install tally-extract
+```
+
+---
+
+## Usage
+
+Ensure your local Tally instance is running with ODBC / HTTP server enabled (default port `9000`).
+
+### 1. Autocomplete Dot-Notation
+
+```javascript
+import tally from "tally-extract";
+
+// 1. Fetch raw XML string
+const xml = await tally.company.fetch("Company Name");
+console.log(xml);
+
+// 2. Fetch parsed JSON object directly
+const json = await tally.company.fetch.asJson("Company Name");
+console.log(json);
+
+// Master routes
+const units = await tally.masters.units.all.asJson("Company Name");
+const stockItems = await tally.masters.stockItems.withBatches.asJson("Company Name");
+```
+
+### 2. Direct Route Invocation
+
+```javascript
+import { call, asJson, getJson } from "tally-extract";
+
+// Raw XML
+const rawXml = await call("tally.company.fetch", "Company Name");
+
+// Parsed JSON
+const data = await asJson("tally.masters.units.all", "Company Name");
+```
+
+---
+
+## TypeScript Support
+
+Full TypeScript IntelliSense definitions are bundled out of the box:
+
+```typescript
+import tally, { call, asJson } from "tally-extract";
+```
+
+All routes, parameter hints, and method signatures are auto-completed in VS Code and modern IDEs.
+
+---
+
+## License
+
+[MIT](LICENSE) © [KeshavSoft](https://github.com/keshavsoft)

package/package.json

@@ -1,6 +1,49 @@
-{
-  "name": "tally-http-json",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+{
+  "name": "tally-http-json",
+  "version": "1.2.1",
+  "description": "Tally XML client based on structure spec",
+  "type": "module",
+  "main": "./src/index.js",
+  "types": "./src/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.js",
+      "default": "./src/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "files": [
+    "src",
+    "dispatchTally",
+    "README.md",
+    "LICENSE"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/keshavsoft/tally-http-json.git"
+  },
+  "homepage": "https://github.com/keshavsoft/tally-http-json#readme",
+  "bugs": {
+    "url": "https://github.com/keshavsoft/tally-http-json/issues"
+  },
+  "keywords": [
+    "tally",
+    "tally-prime",
+    "tdl",
+    "xml",
+    "extract",
+    "accounting"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "test": "node test/v11/runAll.js"
+  },
+  "devDependencies": {},
+  "dependencies": {
+    "tally-spec": "^1.5.1"
+  }
 }

package/src/index.js

@@ -0,0 +1 @@
+export { default, noCompany } from "./v2/index.js";

package/src/v1/byId/index.js

@@ -0,0 +1,16 @@
+import transport from "../transport.js";
+import reportTemplate from "./template.js";
+
+const report = async ({
+    reportId = "Stock Summary",
+    company = "mani9",
+    explode = true,
+    url = "http://localhost:9000"
+} = {}) => {
+    const inXml = reportTemplate({ reportId, company, explode });
+    console.log("inXml : ", inXml);
+
+    return transport({ inXml, url });
+};
+
+export default report;

package/src/v1/byId/template.js

@@ -0,0 +1,23 @@
+const stockSummaryTemplate = ({ company = "mani9", reportId = "Stock Summary", explode = true } = {}) => `
+<ENVELOPE>
+    <HEADER>
+        <VERSION>1</VERSION>
+        <TALLYREQUEST>Export</TALLYREQUEST>
+        <TYPE>Data</TYPE>
+        <ID>${reportId}</ID>
+    </HEADER>
+    <BODY>
+        <DESC>
+            <STATICVARIABLES>
+                <SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+                <SVCURRENTCOMPANY>${company}</SVCURRENTCOMPANY>
+                   <ITEM>Viaadi Hooks</ITEM>
+                ${explode ? "<EXPLODEFLAG>Yes</EXPLODEFLAG>" : ""}
+            </STATICVARIABLES>
+        </DESC>
+    </BODY>
+</ENVELOPE>
+`;
+
+export default stockSummaryTemplate;
+export { stockSummaryTemplate };

package/src/v1/index.js

@@ -0,0 +1,69 @@
+import tallySpec from "tally-spec";
+import send from "./send/index.js";
+import sendPeriod from "./send/period.js";
+import byId from "./byId/index.js";
+
+/**
+ * Story: Clean Tally XML Client (v12)
+ * 
+ * Directly imports tally-spec for TDL definitions.
+ * Exposes:
+ * 1. companyFilter(inPath, inCompany): Fetches masters/company from Tally given a path and company name.
+ * 2. companyAndPeriodFilter(inPath, inCompany, inFromDate, inToDate): Fetches period vouchers from Tally.
+ * 3. reports(): Fetches reports (e.g. Stock Summary) from Tally.
+ */
+const companyFilter = async (inPath, inCompany) => {
+    const localPath = inPath;
+    const localCompany = inCompany;
+
+    const endpoint = localPath.split(".").reduce((acc, key) => acc?.[key], tallySpec.source);
+
+    if (!endpoint?.tdl) {
+        throw new Error(`Master endpoint not found in structure: ${localPath}`);
+    }
+
+    return await send({
+        inTdlMessage: endpoint.tdl,
+        inCompany: localCompany
+    });
+};
+
+const companyAndPeriodFilter = async (inPath, inCompany, inFromDate, inToDate) => {
+    const localPath = inPath;
+    const localCompany = inCompany;
+    const localFromDate = inFromDate;
+    const localToDate = inToDate;
+
+    const endpoint = localPath.split(".").reduce((acc, key) => acc?.[key], tallySpec.source);
+
+    if (!endpoint?.tdl) {
+        throw new Error(`Master endpoint not found in structure: ${localPath}`);
+    }
+
+    return await sendPeriod({
+        inTdlMessage: endpoint.tdl,
+        inCompany: localCompany,
+        inFromDate: localFromDate,
+        inToDate: localToDate
+    });
+};
+
+const reports = async (inPath, inCompany) => {
+    const localPath = inPath;
+    const localCompany = inCompany;
+
+    const endpoint = localPath.split(".").reduce((acc, key) => acc?.[key], tallySpec.source);
+    // console.log("endpoint : ", endpoint);
+
+    if (!endpoint?.reportId) {
+        throw new Error(`Master endpoint not found in structure: ${localPath}`);
+    };
+
+    return await byId({
+        reportId: endpoint.reportId,
+        company: localCompany
+    });
+};
+
+export default companyFilter;
+export { companyFilter, companyAndPeriodFilter, reports };

package/src/v1/send/index.js

@@ -0,0 +1,31 @@
+import transport from "../transport.js";
+import { variableTemplate } from "./templates.js";
+
+/**
+ * Story: Sending XML Payload to Tally
+ * 
+ * 1. Wraps the TDL message into the Tally XML envelope.
+ * 2. Injects SVCURRENTCOMPANY if a company name is supplied.
+ * 3. Delegates HTTP dispatch to transport.
+ * 4. Returns the raw XML response text.
+ */
+const startFunc = async ({ inTdlMessage, inCompany }) => {
+    const localTdlMessage = inTdlMessage;
+    const localCompany = inCompany;
+
+    let localXml = variableTemplate.replace("{{TDLMESSAGE}}", () => localTdlMessage);
+
+    if (localCompany) {
+        const companyTag = `<SVCURRENTCOMPANY>${localCompany}</SVCURRENTCOMPANY>`;
+        localXml = localXml.replace("{{STATICVARIABLES}}", companyTag);
+    } else {
+        localXml = localXml.replace("{{STATICVARIABLES}}", "");
+    }
+    console.log("localXml : ", localXml);
+
+    return await transport({
+        inXml: localXml
+    });
+};
+
+export default startFunc;

package/src/v1/send/period.js

@@ -0,0 +1,36 @@
+import transport from "../transport.js";
+import { variableTemplate } from "./templates.js";
+
+/**
+ * Story: Sending XML Payload to Tally with Period
+ * 
+ * 1. Wraps the TDL message into the Tally XML envelope.
+ * 2. Injects SVCURRENTCOMPANY and date range into static variables.
+ * 3. Delegates HTTP dispatch to transport.
+ * 4. Returns the raw XML response text.
+ */
+const startFunc = async ({ inTdlMessage, inCompany, inFromDate, inToDate }) => {
+    const localTdlMessage = inTdlMessage?.replaceAll("$$$$", "$$");
+    const localCompany = inCompany;
+    const localFromDate = inFromDate;
+    const localToDate = inToDate;
+
+    let localXml = variableTemplate.replace("{{TDLMESSAGE}}", () => localTdlMessage);
+
+    if (localCompany) {
+        const companyTag = `<SVCURRENTCOMPANY>${localCompany}</SVCURRENTCOMPANY>`;
+        const fromDateTag = `<SVFROMDATE TYPE="Date">${localFromDate}</SVFROMDATE>`;
+        const toDateTag = `<SVTODATE TYPE="Date">${localToDate}</SVTODATE>`;
+        localXml = localXml.replace("{{STATICVARIABLES}}", companyTag + fromDateTag + toDateTag);
+    } else {
+        const fromDateTag = `<SVFROMDATE TYPE="Date">${localFromDate}</SVFROMDATE>`;
+        const toDateTag = `<SVTODATE TYPE="Date">${localToDate}</SVTODATE>`;
+        localXml = localXml.replace("{{STATICVARIABLES}}", fromDateTag + toDateTag);
+    }
+
+    return await transport({
+        inXml: localXml
+    });
+};
+
+export default startFunc;

package/src/v1/send/templates.js

@@ -0,0 +1,90 @@
+const companyTemplate = `<ENVELOPE>
+    <HEADER>
+        <VERSION>1</VERSION>
+        <TALLYREQUEST>Export</TALLYREQUEST>
+        <TYPE>Collection</TYPE>
+        <ID>ks</ID>
+    </HEADER>
+    <BODY>
+        <DESC>
+            <STATICVARIABLES>
+                <SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+            </STATICVARIABLES>
+            <TDL>
+                <TDLMESSAGE>
+                    <COLLECTION NAME="ks">
+                        {{TDLMESSAGE}}
+                    </COLLECTION>
+                </TDLMESSAGE>
+            </TDL>
+        </DESC>
+    </BODY>
+</ENVELOPE>`;
+
+const variableTemplate = `<ENVELOPE>
+    <HEADER>
+        <VERSION>1</VERSION>
+        <TALLYREQUEST>Export</TALLYREQUEST>
+        <TYPE>Collection</TYPE>
+        <ID>ks</ID>
+    </HEADER>
+    <BODY>
+        <DESC>
+            <STATICVARIABLES>
+                <SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+                {{STATICVARIABLES}}
+            </STATICVARIABLES>
+            <TDL>
+                <TDLMESSAGE>
+                    <COLLECTION NAME="ks">
+                        {{TDLMESSAGE}}
+                    </COLLECTION>
+                </TDLMESSAGE>
+            </TDL>
+        </DESC>
+    </BODY>
+</ENVELOPE>`;
+
+const K2 = `<ENVELOPE>
+    <HEADER>
+        <VERSION>1</VERSION>
+        <TALLYREQUEST>Export</TALLYREQUEST>
+        <TYPE>Collection</TYPE>
+        <ID>ks</ID>
+    </HEADER>
+
+    <BODY>
+        <DESC>
+            <STATICVARIABLES>
+                <SVEXPORTFORMAT>$$SysName:XML</SVEXPORTFORMAT>
+
+                <SVFROMDATE TYPE="Date">20260401</SVFROMDATE>
+                <SVTODATE TYPE="Date">20260401</SVTODATE>
+            </STATICVARIABLES>
+
+            <TDL>
+                <TDLMESSAGE>
+
+                    <COLLECTION NAME="ks">
+                        <TYPE>Vouchers:VoucherType</TYPE>
+                        <CHILDOF>$$VchTypeSales</CHILDOF>
+                        <BELONGSTO>Yes</BELONGSTO>
+
+                        <FETCH>
+                            Date,
+                            VoucherNumber,
+                            VoucherTypeName,
+                            PartyLedgerName,
+                            Amount,
+                            AllInventoryEntries,
+                            AllLedgerEntries
+                        </FETCH>
+                    </COLLECTION>
+
+                </TDLMESSAGE>
+            </TDL>
+        </DESC>
+    </BODY>
+</ENVELOPE>`;
+
+export { companyTemplate, variableTemplate, K2 };

package/src/v1/templates/reports/stockSummary.js

@@ -0,0 +1 @@
+export { default, reportTemplate } from "../../send/templates/reports/stockSummary.js";

package/src/v1/transport.js

@@ -0,0 +1,16 @@
+const startFunc = async ({ inXml }) => {
+    const localXml = inXml;
+    const localUrl = "http://localhost:9000";
+
+    const response = await fetch(localUrl, {
+        method: "POST",
+        headers: {
+            "Content-Type": "text/xml"
+        },
+        body: localXml
+    });
+
+    return await response.text();
+};
+
+export default startFunc;

package/src/v2/index.js

@@ -0,0 +1,8 @@
+import noCompanyFromInternal from "./noCompany/index.js";
+
+const noCompany = async (headerId = "") => {
+    return await noCompanyFromInternal({ inHeaderId: headerId });
+};
+
+export default noCompany;
+export { noCompany };

package/src/v2/noCompany/body.json

@@ -0,0 +1,9 @@
+{
+    "static_variables": [
+        {
+            "name": "svExportFormat",
+            "value": "jsonex"
+        }
+    ],
+    "fetch_list": []
+}

package/src/v2/noCompany/index.js

@@ -0,0 +1,18 @@
+import transport from "../transport.js";
+import body from "./body.json" with { type: "json" };
+
+const startFunc = async ({
+    inHeaderId,
+    inUrl = "http://localhost:9000"
+} = {}) => {
+    const localHeaderId = inHeaderId;
+    const localUrl = inUrl;
+
+    return transport({
+        inHeaderId: localHeaderId,
+        inUrl: localUrl,
+        inBodyAsJson: JSON.stringify(body)
+    });
+};
+
+export default startFunc;

package/src/v2/transport.js

@@ -0,0 +1,21 @@
+const startFunc = async ({ inBodyAsJson, inHeaderId, inUrl = "http://localhost:9000" }) => {
+    const localBodyAsJson = inBodyAsJson;
+    const localHeaderId = inHeaderId;
+    const localUrl = inUrl;
+
+    const response = await fetch(localUrl, {
+        method: "POST",
+        headers: {
+            "Content-Type": "application/json",
+            "version": "1",
+            "tallyrequest": "Export",
+            "type": "Collection",
+            "id": localHeaderId
+        },
+        body: localBodyAsJson
+    });
+
+    return await response.json();
+};
+
+export default startFunc;