tally-simple 1.1.1 → 1.3.1

package/docs/development.md

@@ -1,66 +0,0 @@
-# Developer guide
-
-This document explains how Tally Simple is built and how to change it. End-user installation and query examples are kept in the root README.
-
-## The developer story
-
-Tally Simple keeps the TDL request definitions in one internal source and exposes only the queries deliberately selected for users.
-
-~~~text
-source.json
-    │
-    ├── public API list ──> JavaScript client
-    │
-    └── request traversal ──> XML over HTTP ──> Tally
-                         │
-                         └──> CLI stdout
-~~~
-
-The source definitions describe how Tally should answer a query. The public API list is the product boundary: only listed paths become JavaScript methods and CLI commands.
-
-## Repository map
-
-- src/v1/source.json: Tally connection defaults, request envelope, and TDL collections.
-- src/v1/external-api/api.json: public query allowlist.
-- src/v1/external-api/api.js: builds the nested runtime API.
-- src/v1/traverse.js: validates, builds, and sends a request.
-- src/index.d.ts: generated TypeScript declarations.
-- bin/tally-simple.js: command-line entrypoint.
-- test/test.js and test/units.js: offline behavior and CLI tests.
-- test/v1/units.js: manual integration smoke check against a reachable Tally instance; it is not part of npm test.
-
-## Request lifecycle
-
-1. The application or CLI selects a public query path.
-2. The client validates and trims the company name.
-3. The path is resolved in source.json.
-4. The company name is XML-escaped and inserted into the request envelope.
-5. The selected collection body is inserted into the envelope.
-6. The configured fetch implementation sends the request to Tally.
-7. The response body is returned as text; non-2xx responses become errors.
-
-## Adding a query
-
-1. Add or update the TDL definition in src/v1/source.json.
-2. Add its complete path to src/v1/external-api/api.json.
-3. Run npm run generate:dts.
-4. Add or update an offline test.
-5. Run npm run verify.
-
-Do not edit src/index.d.ts by hand. It is generated from the source definition and public path list.
-
-## Client configuration
-
-createTallyClient() is the application boundary for a different URL, method, headers, timeout, or fetch implementation. The default import uses the default connection from source.json.
-
-The fetch option is intentionally injectable so tests can run without a Tally installation or network connection.
-
-## Verification and publishing
-
-~~~bash
-npm install
-npm run verify
-npm pack --dry-run
-~~~
-
-The prepack and prepublishOnly hooks run declaration generation and the offline test suite. The package files allowlist publishes the runtime, CLI, user documentation, and package metadata while excluding tests and development-only scripts.

package/docs/usage.md

@@ -1,73 +0,0 @@
-# Usage
-
-## The shortest library path
-
-~~~js
-import tally from "tally-simple";
-
-const response = await tally.masters.units.fetch("Mani9");
-~~~
-
-Every endpoint takes a company name. Blank names are rejected before a request is sent.
-
-## Configure a client
-
-~~~js
-import { createTallyClient } from "tally-simple";
-
-const tally = createTallyClient({
-    url: "http://localhost:9000",
-    headers: {
-        Authorization: "Bearer example"
-    },
-    timeout: 15_000
-});
-~~~
-
-Options:
-
-- url: Tally HTTP endpoint. The default is http://localhost:9000.
-- method: request method. The default is POST.
-- headers: headers merged with the default Content-Type: text/xml.
-- timeout: optional request timeout in milliseconds.
-- fetch: optional fetch-compatible function, useful for tests or an application adapter.
-
-The endpoint returns the response text. HTTP responses outside the 2xx range throw an error containing the status and response body.
-
-## Test without Tally
-
-~~~js
-import { createTallyClient } from "tally-simple";
-
-const tally = createTallyClient({
-    fetch: async (url, options) => {
-        console.log(url, options.body);
-        return {
-            ok: true,
-            status: 200,
-            text: async () => "<ENVELOPE><STATUS>1</STATUS></ENVELOPE>"
-        };
-    }
-});
-
-const response = await tally.masters.units.fetch("Mani9");
-~~~
-
-The package escapes XML-sensitive characters in the company name before inserting it into the request.
-
-## TypeScript
-
-The package ships declarations generated from the public API definition:
-
-~~~ts
-import { createTallyClient } from "tally-simple";
-
-const tally = createTallyClient();
-const response: Promise<string> = tally.masters.units.fetch("Mani9");
-~~~
-
-Regenerate the declarations after changing an API path:
-
-~~~bash
-npm run generate:dts
-~~~