@cs-object/cli 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/NOTICE

@@ -0,0 +1,4 @@
+CalculationSourceObject
+Copyright 2026 Viktar Beliakou
+
+Third-party components retain their own licenses and attribution notices.

package/README.md

@@ -0,0 +1,195 @@
+# Calculation CLI
+
+`cso verify` captures one Python execution and independently checks its formulas.
+`cso html` and `cso pdf` verify that same execution before preparing a document.
+`cso bindings` generates typed calculation handles. `dev-export` and `dev-render`
+retain the unverified development paths.
+
+## Run
+
+Follow [setup](../../docs/development.md#setup). In the workspace use
+`node packages/cso-cli/dist/cli.js`; an installed consumer uses `cso`.
+`PYTHON` selects the interpreter with the installed `cso-python` wheel.
+
+```sh
+cso bindings examples/two-panel
+cso verify examples/two-panel/estimate.cso.py \
+  --function estimate --input width=2 --reference examples/two-panel/reference.json --format json
+cso html examples/two-panel/estimate.cso.py \
+  --function estimate --input width=2 --out output/panels.html --check-layout --format json
+cso pdf examples/two-panel/estimate.cso.py \
+  --function estimate --input width=2 --reference examples/two-panel/reference.json \
+  --out output/panels.pdf --format json
+```
+
+Use `cso <command> --help` for current options. Source, reference and output paths
+resolve against the invoking directory. Repeat `--input name=value` for distinct
+parameters. Duplicate/unknown inputs and invalid numeric values are usage errors.
+The [argument parser](src/verified-arguments.ts) is authoritative for syntax.
+
+Verified commands write one structured JSON report to stdout and operational
+messages to stderr. Exit 0 means success, 1 means verification/generation failure,
+and 2 means invalid usage. Reports retain known source hashes, function, inputs,
+versions and diagnostics; successful HTML/PDF reports include output path and hash.
+Unknown provenance is not fabricated. See [report schemas](../../packages/cso-core/src/contracts/reports.ts).
+
+## Numerical checks
+
+[verifyExecution](../../packages/cso-core/src/verification/verify.ts) checks inputs,
+constants, formulas, caches and v2 public outputs. It evaluates formulas without
+using cached results as operands and compares them with actual Python observations.
+Hidden documented intermediates remain covered. V1 has no public-output evidence,
+so its output check is not applicable.
+
+The [numeric implementation](../../packages/cso-core/src/verification/numeric.ts)
+uses finite binary64 floats and exact Python integers within the safe integer
+range. New captures retain actual numeric kinds through literals, bindings,
+observations and public outputs. Core propagates kinds independently through
+formulas; division and square roots produce floats. Older captures without kind
+evidence retain the conservative integer-valued range limit. Conditional formulas
+evaluate only their selected branch after checking the complete graph structure.
+The [authoring guide](../../docs/authoring.md#supported-source-and-document-content)
+lists supported functions. The fixed comparison is:
+
+```text
+abs(actual - expected) <= max(1e-9, 1e-12 * max(abs(actual), abs(expected)))
+```
+
+An absolute difference outside the finite binary64 range is reported as
+`absoluteError: "overflow"` and fails agreement. Reference expected values may
+include `numericKind: "float"` for finite values beyond the safe integer range.
+
+Mismatch diagnostics retain compared values, error, tolerances, symbol and
+available source location. The absolute tolerance applies in the declared unit.
+There is no automatic unit conversion or dimensional/capacity assessment.
+Unsupported formulas, invalid intermediate values and `documented_result` cannot
+pass verified generation. Rendering supports more notation than this evaluator.
+
+An explicit `--reference` file supplies independently established expected values.
+[Reference binding](../../packages/cso-core/src/contracts/reference.ts) uses the
+complete source closure, selected function and resolved inputs. Positive and
+negative zero have distinct identities; input-key order does not affect identity.
+A matching case must cover every calculated symbol and match its declared unit.
+No match is `not_applicable`, never a pass. A failed matching reference blocks
+success; absence of a match alone does not block an otherwise consistent PDF.
+
+The CLI captures reference bytes once. Source edits, including numerically
+equivalent edits, invalidate reference bindings until an explicit reviewed
+revision. Never regenerate expected numbers from the execution being verified.
+
+## HTML preview
+
+`cso html` writes a standalone page with embedded CSS and captured images. Open it
+directly in a browser. Its screen layout uses the 190 mm print content width and
+the same prepared document renderer as PDF. It contains the full calculation
+narrative, including formulas, substitutions, units, explanations and results.
+
+Without `--check-layout`, no browser runs. Execution and prepared-document checks
+must pass; `rendering` is `not_applicable` and `visualInspection` is `pending`.
+This mode permits inspection of a layout that needs repair. Image signatures are checked during capture and
+source bindings during document preparation; image decoding, passive SVG policy
+and browser presentation checks require `--check-layout`.
+
+`--check-layout` uses Chromium to check assets, presentation and MathML bounds in
+screen and print media. Failures report `DOCUMENT_LAYOUT_OVERFLOW` with placement,
+selector, bounds, media and overflow distance under `diagnostics[].layout`.
+A failed check preserves existing HTML. Both modes retain evidence by default;
+`--no-evidence` writes only the page. The evidence manifest uses `html` for the
+output binding and records automatic presentation as `not_applicable` when no
+browser check ran. Geometry checks do not certify pagination or visual acceptance.
+
+See the [HTML workflow](../../docs/rendering.md#html-iteration) for development
+and the [check selection](../../docs/rendering.md#choose-verification-by-change)
+for when PDF inspection is needed.
+
+## Document and evidence publication
+
+The [document coordinator](src/document.ts) uses one execution for verification and
+preparation. [Asset capture](src/assets.ts) checks module-relative containment,
+hashes and media signatures. Browser checks for PDF and checked HTML additionally
+require PNG/JPEG decode and passive SVG policy. Symlink escapes and active or
+external SVG content fail those checks. The browser uses captured data URLs,
+waits for fonts/images and checks mathematical descendants against row and sheet
+bounds. [HTML construction](src/prepared-html.ts) and
+[browser inspection](src/pdf-rendering.ts) are shared by both commands.
+
+For output P, [evidence publication](src/evidence.ts) writes `P.evidence/H/`,
+where H hashes the exact manifest bytes. Stderr reports its location/hash.
+Payloads retain raw execution and supplied reference bytes, verification,
+prepared data with captured assets, and a field/disposition mapping. Generated
+JSON preserves negative zero. Source hashes identify captured Python files;
+the bundle does not contain their original source bytes.
+
+The manifest binds payloads, the document and prospective successful stdout bytes. Complete
+evidence is published before the final atomic output replacement. Verification,
+preparation, rendering or evidence-write failure preserves an existing output and
+cleans owned temporary files. A failed final rename can leave an unused complete
+bundle; require an actual successful report and matching output before treating it
+as a receipt. Stdout failure after replacement cannot roll back that commit.
+`--no-evidence` retains verification and atomic replacement but creates no
+sibling evidence bundle.
+
+New document reports leave visual inspection `pending`. Use the
+[delivery guide](../../docs/rendering.md#printing-and-inspection). Keep source consistency, independent
+agreement, content retention, rendering and visual inspection separate.
+Generation and historical source reviews do not establish human approval.
+
+## Check the implementation
+
+[App tests](tests/) cover arguments, reports and evidence behavior.
+[Installed verification](../../tests/integration/installed/verify-consumer.mjs),
+[PDF failures](../../tests/integration/installed/pdf-consumer.mjs) and
+[signed-zero cases](../../tests/integration/installed/signed-zero-consumer.mjs)
+exercise actual packages. See [integration commands](../../tests/integration/README.md)
+for fresh archive/wheel consumers and retained acceptance records.
+
+## Work on a localhost calculation
+
+Start one fixed source path and function with `cso dev calculations/report.cso.py
+--function calculate --port 3000`. Port `0` selects an available port. The server
+prints its `http://127.0.0.1:<port>` address. It uses the installed interpreter
+selected by `PYTHON` and the CLI's Playwright Chromium for PDF output.
+
+The browser builds its input form from the static Python definition. It shows
+verified outputs, an embedded report, a curl request and PDF/evidence downloads.
+Edit formulas in the source file and calculate again to capture the changes.
+Editing browser inputs immediately clears the previous report and download link.
+Reload the page after changing input declarations, names, defaults or metadata.
+
+For a rectangle calculation with `width` and `height` inputs:
+
+```sh
+curl -sS --fail-with-body http://127.0.0.1:3000/api/calculate \
+  -H 'Content-Type: application/json' \
+  -d '{"inputs":{"width":4,"height":3}}'
+```
+
+A successful calculation response contains only named public outputs, such as
+`{"area":12}`. Requests contain exactly one `inputs` object. Inputs may omit
+parameters with defaults. Unknown fields, duplicate JSON keys, booleans,
+nonfinite numbers and invalid integer values fail before execution. Finite
+floating-point inputs may use the full binary64 range. Use a decimal or exponent
+for floats outside the safe integer range; bare unsafe integer tokens are rejected.
+Requests cannot select source paths, functions or server configuration.
+
+`POST /api/runs` accepts the same request and returns an opaque run ID, outputs,
+review checks and report/PDF/evidence URLs. Each run captures execution, assets,
+the prepared document and HTML once. PDF generation uses that exact HTML, including
+its captured CSS, and memoizes the result. Source edits never change an earlier
+run's report or PDF. The PDF response includes `X-CSO-PDF-SHA256`. Its evidence JSON
+binds the retained execution and document to the HTML/PDF hashes and automated
+presentation findings. Browser evidence is an ephemeral download, separate from
+the filesystem evidence bundles published by `cso html` and `cso pdf`.
+
+Missing independent references appear as pending in the UI and report. Matching
+reference failures block success. Human visual inspection remains pending, and
+none of these checks establishes engineering approval. A PDF download succeeds only
+after the maintained automatic presentation checks pass.
+
+The server binds only to IPv4 loopback and rejects foreign Host/Origin headers.
+It executes trusted local calculation sources. Python requests have a 30-second
+deadline and bounded output. Execution is synchronous, so the local server pauses
+while Python runs. One PDF renders at a time, with a 90-second deadline. Retention
+is limited to 10 runs, 128 MiB of serialized report data, and 30 minutes. Expired or evicted
+run URLs return 404. Request bodies are limited to 64 KiB. Stop with Ctrl+C;
+restarting creates a new session and releases earlier run URLs.