tally-simple 1.3.1 → 1.8.2

package/src/v7/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/v7/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/v7/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 → v7}/source.json

@@ -1,15 +1,5 @@
 {
     "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": {
@@ -34,6 +24,14 @@
                     },
                     "action": "fetch"
                 }
+            },
+            "stockGroup": {
+                "withParent": {
+                    "tdl": {
+                        "collection": "<TYPE>StockGroup</TYPE><FETCH>$$Alias:Name</FETCH><FETCH>Parent</FETCH>"
+                    },
+                    "action": "fetch"
+                }
             }
         }
     }

package/src/v8/engine/index.js

@@ -0,0 +1,18 @@
+import { call } from "tally-simple-json";
+import transform from "@keshavsoft/json-transformer";
+
+const startFunc = async ({ inRoutePath, inParam, inSource, inLeafSpec }) => {
+    const localRoutePath = inRoutePath;
+    const localParam = inParam;
+    const localSource = inSource;
+    const localLeafSpec = inLeafSpec;
+
+    const rawResponse = await call(localRoutePath,
+        localParam);
+    const jsonNeeded = rawResponse?.ENVELOPE?.BODY?.DATA?.COLLECTION;
+    const transformedResponse = transform(jsonNeeded, localLeafSpec?.transform?.instructions);
+    // console.log("localSource: ", jsonNeeded, localLeafSpec?.transform?.instructions, transformedResponse);
+    return transformedResponse;
+};
+
+export default startFunc;

package/src/v8/engine/parseXml.js

@@ -0,0 +1,11 @@
+import { XMLParser } from "fast-xml-parser";
+
+const parser = new XMLParser({ ignoreAttributes: false });
+
+const startFunc = ({ inXml }) => {
+    const localXml = inXml;
+
+    return parser.parse(localXml);
+};
+
+export default startFunc;

package/src/v8/index.js

@@ -0,0 +1,21 @@
+import apiTree, { createCaller } from "@keshavsoft/api-tree";
+import { source, apiPaths } from "tally-spec";
+
+import execute from "./engine/index.js";
+
+const tree = apiTree(source, apiPaths, execute);
+const app = tree.tally ?? tree;
+
+// Keep the package's historical root API while retaining the explicit
+// `app.tally` form exposed by @keshavsoft/api-tree.
+if (!app.tally) {
+    Object.defineProperty(app, "tally", {
+        value: app,
+        enumerable: false
+    });
+};
+
+const call = createCaller({ inSource: source, inExecutor: execute });
+
+export default app;
+export { app, call };

package/docs/api.html

@@ -1,41 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width,initial-scale=1">
-<title>Api</title>
-<style>
-body{font-family:system-ui,-apple-system,Segoe UI,Arial,sans-serif;max-width:900px;margin:40px auto;padding:0 24px;line-height:1.65;color:#202124}
-nav{padding:12px 16px;margin-bottom:28px;background:#f5f5f5;border-radius:8px}
-nav a{margin-right:16px;text-decoration:none}
-h1{font-size:30px;margin-top:0}
-h2{font-size:22px;margin-top:32px}
-h3{font-size:18px;margin-top:24px}
-pre{background:#f6f8fa;padding:16px;border-radius:8px;overflow:auto}
-code{background:#f1f3f4;padding:2px 5px;border-radius:4px}
-pre code{background:none;padding:0}
-table{border-collapse:collapse;width:100%;margin:16px 0}
-th,td{border:1px solid #ddd;padding:8px;text-align:left}
-th{background:#f6f6f6}
-a{color:#0969da}
-</style>
-</head>
-<body>
-<nav>
-<a href="../README.html">README</a>
-<a href="end-user.html">End User</a>
-<a href="developer.html">Application Developer</a>
-<a href="repo-developer.html">Repository Developer</a>
-<a href="api.html">API</a>
-<a href="architecture.html">Architecture</a>
-</nav>
-<h1>API Reference</h1>
-<p>The public API is generated from <code>src/v1/external-api/api.json</code>.</p>
-<p>Current public paths:</p>
-<pre><code>tally.masters.units.fetch
-tally.masters.stockItems.withBatches</code></pre>
-<p>Example:</p>
-<pre><code>await tally.masters.units.fetch(&quot;Mani9&quot;);</code></pre>
-<p>The exact public surface should be changed through <code>external-api/api.json</code>, followed by declaration generation.</p>
-</body>
-</html>

package/docs/api.md

@@ -1,20 +0,0 @@
-[**View this document as HTML**](./api.html)
-
-# API Reference
-
-The public API is generated from `src/v1/external-api/api.json`.
-
-Current public paths:
-
-```text
-tally.masters.units.fetch
-tally.masters.stockItems.withBatches
-```
-
-Example:
-
-```js
-await tally.masters.units.fetch("Mani9");
-```
-
-The exact public surface should be changed through `external-api/api.json`, followed by declaration generation.

package/docs/developer.html

@@ -1,57 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width,initial-scale=1">
-<title>Developer</title>
-<style>
-body{font-family:system-ui,-apple-system,Segoe UI,Arial,sans-serif;max-width:900px;margin:40px auto;padding:0 24px;line-height:1.65;color:#202124}
-nav{padding:12px 16px;margin-bottom:28px;background:#f5f5f5;border-radius:8px}
-nav a{margin-right:16px;text-decoration:none}
-h1{font-size:30px;margin-top:0}
-h2{font-size:22px;margin-top:32px}
-h3{font-size:18px;margin-top:24px}
-pre{background:#f6f8fa;padding:16px;border-radius:8px;overflow:auto}
-code{background:#f1f3f4;padding:2px 5px;border-radius:4px}
-pre code{background:none;padding:0}
-table{border-collapse:collapse;width:100%;margin:16px 0}
-th,td{border:1px solid #ddd;padding:8px;text-align:left}
-th{background:#f6f6f6}
-a{color:#0969da}
-</style>
-</head>
-<body>
-<nav>
-<a href="../README.html">README</a>
-<a href="end-user.html">End User</a>
-<a href="developer.html">Application Developer</a>
-<a href="repo-developer.html">Repository Developer</a>
-<a href="api.html">API</a>
-<a href="architecture.html">Architecture</a>
-</nav>
-<h1>Application Developer Guide</h1>
-<p>This guide is for developers consuming Tally Public API from another application.</p>
-<h2>Public boundary</h2>
-<p>The consumer sees a tree-shaped JavaScript API:</p>
-<pre><code>const result = await tally.masters.units.fetch(&quot;Mani9&quot;);</code></pre>
-<p>The consumer does not need to know:</p>
-<ul>
-<li>the internal source JSON structure;</li>
-<ul>
-<li>the TDL request template;</li>
-<ul>
-<li>how traversal finds the definition;</li>
-<ul>
-<li>how the HTTP request is constructed.</li>
-<h2>Company name</h2>
-<p>The company is runtime input.</p>
-<pre><code>await tally.masters.units.fetch(&quot;Mani9&quot;);
-await tally.masters.units.fetch(&quot;Another Company&quot;);</code></pre>
-<p>The company should therefore not be permanently embedded in the source definition.</p>
-<h2>CLI / scripting</h2>
-<p>The same public operation can be exposed through a CLI layer without duplicating the Tally definition.</p>
-<h2>Response</h2>
-<p>The package returns the Tally response body. XML parsing and application-specific normalization remain outside this package.</p>
-<p>For the internal architecture, see <a href="repo-developer.md">Repository Developer Guide</a>.</p>
-</body>
-</html>

package/docs/developer.md

@@ -1,41 +0,0 @@
-[**View this document as HTML**](./developer.html)
-
-# Application Developer Guide
-
-This guide is for developers consuming Tally Public API from another application.
-
-## Public boundary
-
-The consumer sees a tree-shaped JavaScript API:
-
-```js
-const result = await tally.masters.units.fetch("Mani9");
-```
-
-The consumer does not need to know:
-
-- the internal source JSON structure;
-- the TDL request template;
-- how traversal finds the definition;
-- how the HTTP request is constructed.
-
-## Company name
-
-The company is runtime input.
-
-```js
-await tally.masters.units.fetch("Mani9");
-await tally.masters.units.fetch("Another Company");
-```
-
-The company should therefore not be permanently embedded in the source definition.
-
-## CLI / scripting
-
-The same public operation can be exposed through a CLI layer without duplicating the Tally definition.
-
-## Response
-
-The package returns the Tally response body. XML parsing and application-specific normalization remain outside this package.
-
-For the internal architecture, see [Repository Developer Guide](repo-developer.md).

package/docs/end-user.html

@@ -1,49 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width,initial-scale=1">
-<title>End User</title>
-<style>
-body{font-family:system-ui,-apple-system,Segoe UI,Arial,sans-serif;max-width:900px;margin:40px auto;padding:0 24px;line-height:1.65;color:#202124}
-nav{padding:12px 16px;margin-bottom:28px;background:#f5f5f5;border-radius:8px}
-nav a{margin-right:16px;text-decoration:none}
-h1{font-size:30px;margin-top:0}
-h2{font-size:22px;margin-top:32px}
-h3{font-size:18px;margin-top:24px}
-pre{background:#f6f8fa;padding:16px;border-radius:8px;overflow:auto}
-code{background:#f1f3f4;padding:2px 5px;border-radius:4px}
-pre code{background:none;padding:0}
-table{border-collapse:collapse;width:100%;margin:16px 0}
-th,td{border:1px solid #ddd;padding:8px;text-align:left}
-th{background:#f6f6f6}
-a{color:#0969da}
-</style>
-</head>
-<body>
-<nav>
-<a href="../README.html">README</a>
-<a href="end-user.html">End User</a>
-<a href="developer.html">Application Developer</a>
-<a href="repo-developer.html">Repository Developer</a>
-<a href="api.html">API</a>
-<a href="architecture.html">Architecture</a>
-</nav>
-<h1>End User Guide</h1>
-<p>This guide is for someone who wants to use the Tally package, not modify it.</p>
-<h2>JavaScript</h2>
-<pre><code>import tally from &quot;./src/index.js&quot;;
-
-const units = await tally.masters.units.fetch(&quot;Mani9&quot;);
-console.log(units);</code></pre>
-<p>The company name is supplied by the caller:</p>
-<pre><code>tally.masters.units.fetch(&quot;My Company&quot;);</code></pre>
-<p>The package builds the Tally request internally.</p>
-<h2>What you receive</h2>
-<p>The Tally response is returned as XML text. This package does not force an XML-to-JSON format on the consumer.</p>
-<p>You can parse or transform the response with the tool you prefer.</p>
-<h2>Public API</h2>
-<p>See <a href="api.md">API Reference</a> for the currently exposed operations.</p>
-<p>If you are integrating this package into a larger application, continue with the <a href="developer.md">Application Developer Guide</a>.</p>
-</body>
-</html>

package/docs/end-user.md

@@ -1,34 +0,0 @@
-[**View this document as HTML**](./end-user.html)
-
-# End User Guide
-
-This guide is for someone who wants to use the Tally package, not modify it.
-
-## JavaScript
-
-```js
-import tally from "./src/index.js";
-
-const units = await tally.masters.units.fetch("Mani9");
-console.log(units);
-```
-
-The company name is supplied by the caller:
-
-```js
-tally.masters.units.fetch("My Company");
-```
-
-The package builds the Tally request internally.
-
-## What you receive
-
-The Tally response is returned as XML text. This package does not force an XML-to-JSON format on the consumer.
-
-You can parse or transform the response with the tool you prefer.
-
-## Public API
-
-See [API Reference](api.md) for the currently exposed operations.
-
-If you are integrating this package into a larger application, continue with the [Application Developer Guide](developer.md).

package/docs/repo-developer.html

@@ -1,91 +0,0 @@
-<!doctype html>
-<html lang="en">
-<head>
-<meta charset="utf-8">
-<meta name="viewport" content="width=device-width,initial-scale=1">
-<title>Repo Developer</title>
-<style>
-body{font-family:system-ui,-apple-system,Segoe UI,Arial,sans-serif;max-width:900px;margin:40px auto;padding:0 24px;line-height:1.65;color:#202124}
-nav{padding:12px 16px;margin-bottom:28px;background:#f5f5f5;border-radius:8px}
-nav a{margin-right:16px;text-decoration:none}
-h1{font-size:30px;margin-top:0}
-h2{font-size:22px;margin-top:32px}
-h3{font-size:18px;margin-top:24px}
-pre{background:#f6f8fa;padding:16px;border-radius:8px;overflow:auto}
-code{background:#f1f3f4;padding:2px 5px;border-radius:4px}
-pre code{background:none;padding:0}
-table{border-collapse:collapse;width:100%;margin:16px 0}
-th,td{border:1px solid #ddd;padding:8px;text-align:left}
-th{background:#f6f6f6}
-a{color:#0969da}
-</style>
-</head>
-<body>
-<nav>
-<a href="../README.html">README</a>
-<a href="end-user.html">End User</a>
-<a href="developer.html">Application Developer</a>
-<a href="repo-developer.html">Repository Developer</a>
-<a href="api.html">API</a>
-<a href="architecture.html">Architecture</a>
-</nav>
-<h1>Repository Developer Guide</h1>
-<p>This guide is for developers who change the repository itself.</p>
-<h2>Source of truth</h2>
-<p>The active version contains the Tally definitions:</p>
-<pre><code>src/
-└── v1/
-    ├── source.json
-    ├── traverse.js
-    ├── traverseObject/
-    ├── external-api/
-    │   ├── api.json
-    │   ├── api.js
-    │   └── index.js
-    └── index.js</code></pre>
-<p><code>source.json</code> contains the internal request definitions.</p>
-<p><code>external-api/api.json</code> contains only the public paths.</p>
-<p>That separation is intentional.</p>
-<h2>Adding a public operation</h2>
-<p>1. Add or change the internal TDL definition in <code>source.json</code>.</p>
-<p>2. Add its public path to <code>external-api/api.json</code>.</p>
-<p>3. Regenerate <code>src/index.d.ts</code>.</p>
-<p>4. Test the public call.</p>
-<p>5. Leave older source versions untouched.</p>
-<h2>Company input</h2>
-<p>Do not hardcode a real company name into the public definition.</p>
-<p>The caller supplies the company:</p>
-<pre><code>tally.masters.units.fetch(&quot;Mani9&quot;);</code></pre>
-<p>The runtime passes that value into the request builder.</p>
-<h2>Traversal</h2>
-<p>Traversal should remain generic.</p>
-<p>Its job is to locate the requested definition.</p>
-<p>The action/request layer interprets the terminal definition and performs the Tally HTTP request.</p>
-<p>Avoid putting endpoint-specific paths directly into the traversal engine.</p>
-<h2>Versioning</h2>
-<p>When a new implementation is required:</p>
-<pre><code>src/v1
-src/v2
-src/v3</code></pre>
-<p>Create the next version and make the root <code>src/index.js</code> point to the highest active version.</p>
-<p>Do not rewrite old versions merely to keep them visually consistent.</p>
-<h2>Declaration generation</h2>
-<p>The generated declaration file represents the public API tree.</p>
-<p>It should be generated from the public API definition rather than manually maintained.</p>
-<pre><code>node generate-dts.js</code></pre>
-<h2>Testing</h2>
-<p>Test both:</p>
-<p>1. the public JavaScript API;</p>
-<p>2. the generated request sent to Tally.</p>
-<p>Keep Tally-specific request definitions in JSON where possible so adding another operation is primarily a data change rather than a new JavaScript module.</p>
-<h2>Design boundary</h2>
-<p>The repository deliberately has three layers:</p>
-<pre><code>public API
-    ↓
-traversal / execution
-    ↓
-source JSON</code></pre>
-<p>The public consumer sees the first layer.</p>
-<p>The repository developer maintains all three.</p>
-</body>
-</html>

package/docs/repo-developer.md

@@ -1,107 +0,0 @@
-[**View this document as HTML**](./repo-developer.html)
-
-# Repository Developer Guide
-
-This guide is for developers who change the repository itself.
-
-## Source of truth
-
-The active version contains the Tally definitions:
-
-```text
-src/
-└── v1/
-    ├── source.json
-    ├── traverse.js
-    ├── traverseObject/
-    ├── external-api/
-    │   ├── api.json
-    │   ├── api.js
-    │   └── index.js
-    └── index.js
-```
-
-`source.json` contains the internal request definitions.
-
-`external-api/api.json` contains only the public paths.
-
-That separation is intentional.
-
-## Adding a public operation
-
-1. Add or change the internal TDL definition in `source.json`.
-2. Add its public path to `external-api/api.json`.
-3. Regenerate `src/index.d.ts`.
-4. Test the public call.
-5. Leave older source versions untouched.
-
-## Company input
-
-Do not hardcode a real company name into the public definition.
-
-The caller supplies the company:
-
-```js
-tally.masters.units.fetch("Mani9");
-```
-
-The runtime passes that value into the request builder.
-
-## Traversal
-
-Traversal should remain generic.
-
-Its job is to locate the requested definition.
-
-The action/request layer interprets the terminal definition and performs the Tally HTTP request.
-
-Avoid putting endpoint-specific paths directly into the traversal engine.
-
-## Versioning
-
-When a new implementation is required:
-
-```text
-src/v1
-src/v2
-src/v3
-```
-
-Create the next version and make the root `src/index.js` point to the highest active version.
-
-Do not rewrite old versions merely to keep them visually consistent.
-
-## Declaration generation
-
-The generated declaration file represents the public API tree.
-
-It should be generated from the public API definition rather than manually maintained.
-
-```bash
-node generate-dts.js
-```
-
-## Testing
-
-Test both:
-
-1. the public JavaScript API;
-2. the generated request sent to Tally.
-
-Keep Tally-specific request definitions in JSON where possible so adding another operation is primarily a data change rather than a new JavaScript module.
-
-## Design boundary
-
-The repository deliberately has three layers:
-
-```text
-public API
-    ↓
-traversal / execution
-    ↓
-source JSON
-```
-
-The public consumer sees the first layer.
-
-The repository developer maintains all three.

package/src/index.d.ts

@@ -1,54 +0,0 @@
-/**
- * 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>;
-        body: string;
-        signal?: unknown;
-    }) => Promise<{
-        ok: boolean;
-        status: number;
-        text: () => Promise<string>;
-    }>;
-}
-
-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>;
-        };
-    };
-};
-
-/** 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;