create-cs-object 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,23 @@
+# Create a local calculation project
+
+Use Node.js 24 or newer and Python 3.11 or newer. After the versioned npm and
+Python dependencies are published:
+
+```sh
+npm create cs-object my-report
+cd my-report
+npm run dev
+```
+
+The initializer creates an owned project template, installs its exact CLI
+dependency, prepares `.venv`, and installs Chromium. It preserves generated
+files after setup failure; run `npm run setup` in the project to retry.
+Existing destinations are never overwritten.
+
+Use `--skip-install` to create files without installing dependencies.
+The generated project contains a synthetic rectangle calculation, an editable
+brief, reference storage, and agent-neutral authoring guidance. The CLI serves
+the browser and report API. The initializer contains no server implementation.
+
+Package tests execute a real npm archive in a temporary consumer. Full runtime
+acceptance belongs to the repository's installed integration checks.

package/dist/cli.js

@@ -0,0 +1,83 @@
+#!/usr/bin/env node
+
+// src/cli.ts
+import { spawnSync } from "child_process";
+import { cpSync, mkdirSync, renameSync, writeFileSync } from "fs";
+import { join, resolve } from "path";
+import { fileURLToPath } from "url";
+var args = process.argv.slice(2);
+var usage = "Usage: npm create cs-object <project-name> [--skip-install]\n";
+var destination;
+try {
+  if (args.length === 1 && ["--help", "-h"].includes(args[0])) {
+    process.stdout.write(usage);
+  } else {
+    const [name, ...options] = args;
+    if (!name || !/^[a-z0-9][a-z0-9._-]*$/.test(name) || name.length > 214 || ["node_modules", "favicon.ico"].includes(name) || options.length > 1 || options.some((option) => option !== "--skip-install"))
+      throw new Error(usage.trim());
+    if (Number(process.versions.node.split(".")[0]) < 24)
+      throw new Error("Node.js 24 or newer is required.");
+    const target = resolve(name);
+    mkdirSync(target);
+    destination = target;
+    cpSync(fileURLToPath(new URL("../template", import.meta.url)), target, {
+      recursive: true,
+      force: false,
+      errorOnExist: true
+    });
+    renameSync(join(target, "gitignore"), join(target, ".gitignore"));
+    writeFileSync(
+      join(target, "package.json"),
+      `${JSON.stringify(
+        {
+          name,
+          version: "0.1.0",
+          private: true,
+          type: "module",
+          engines: { node: ">=24" },
+          scripts: {
+            setup: "npm install && node scripts/setup.ts",
+            dev: "node scripts/dev.ts"
+          },
+          dependencies: { "@cs-object/cli": "0.1.0" }
+        },
+        null,
+        2
+      )}
+`
+    );
+    if (!options.includes("--skip-install")) {
+      const npmPath = process.env.npm_execpath;
+      const result = spawnSync(
+        npmPath ? process.execPath : "npm",
+        [...npmPath ? [npmPath] : [], "run", "setup"],
+        {
+          cwd: target,
+          stdio: "inherit",
+          shell: !npmPath && process.platform === "win32"
+        }
+      );
+      if (result.error || result.status !== 0)
+        throw new Error(result.error?.message ?? "Project setup failed.");
+    }
+    process.stdout.write(
+      `Created ${name}.
+
+cd ${name}
+${options.includes("--skip-install") ? "npm run setup\n" : ""}npm run dev
+`
+    );
+  }
+} catch (error) {
+  process.stderr.write(
+    `${error instanceof Error ? error.message : String(error)}
+`
+  );
+  if (destination)
+    process.stderr.write(
+      `Your project remains at ${destination}.
+Run npm run setup in that directory to retry.
+`
+    );
+  process.exitCode = 1;
+}

package/package.json

@@ -0,0 +1,50 @@
+{
+  "name": "create-cs-object",
+  "version": "0.1.0",
+  "description": "Create a local CalculationSourceObject report project.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "bin": {
+    "create-cs-object": "./dist/cli.js"
+  },
+  "files": [
+    "dist",
+    "template",
+    "README.md",
+    "LICENSE",
+    "NOTICE"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
+  "scripts": {
+    "build": "tsup",
+    "prepack": "npm run build",
+    "pretest": "npm run build",
+    "test": "node --test tests/*.test.ts",
+    "typecheck": "tsc --noEmit --pretty false",
+    "lint": "biome lint src tests template/scripts"
+  },
+  "overrides": {
+    "esbuild": "0.28.2"
+  },
+  "devDependencies": {
+    "@biomejs/biome": "2.5.14",
+    "@types/node": "^26",
+    "tsup": "^8.5.1",
+    "typescript": "^5"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/viktar-b/CalculationSourceObject.git",
+    "directory": "packages/create-cs-object"
+  },
+  "homepage": "https://github.com/viktar-b/CalculationSourceObject#readme",
+  "bugs": {
+    "url": "https://github.com/viktar-b/CalculationSourceObject/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}

package/template/AGENTS.md

@@ -0,0 +1,17 @@
+# Work on this calculation
+
+Before changing formulas, read [brief.md](brief.md) and the relevant material in
+[references](references/README.md). Ask about missing assumptions that change
+the result, units, load case, or acceptance criteria. Record the agreed scope
+in the brief and cite the source of each engineering requirement.
+
+Edit formulas in `calculations/report.cso.py`; the browser edits numeric inputs.
+Read [authoring.md](authoring.md) before changing source or notation. Keep inputs,
+units, assumptions, intermediate steps, references, and outputs inspectable.
+
+Run the calculation with representative inputs and review its rendered report.
+Report source-to-document consistency, independent numerical agreement, and
+human engineering approval separately. Establish expected reference values
+independently of the execution under test. Inspect every PDF page before delivery.
+
+This project runs on localhost. Deployment is outside its calculation workflow.

package/template/README.md

@@ -0,0 +1,27 @@
+# Run your calculation
+
+Use Node.js 24 or newer and Python 3.11 or newer. The initializer installs the
+Node dependencies, creates a private `.venv`, and installs Chromium for PDF output.
+
+```sh
+npm run dev
+```
+
+Open the localhost address printed in the terminal. Edit numeric inputs in the
+browser, calculate, review the report, and download its PDF. Change formulas in
+`calculations/report.cso.py`, then calculate again. If you change the declared
+inputs, reload the browser page to rebuild its form. Existing report downloads
+remain tied to their captured run until that run expires or the server stops.
+
+To choose a port, run `npm run dev -- --port 4173`. Use port `0` to select an
+available port. Stop the server with Ctrl+C and use the same command to restart.
+
+If setup failed or you used `--skip-install`, run `npm run setup`.
+Set `PYTHON` to a Python executable if automatic detection cannot find Python
+3.11 or newer. Setup can be run again without replacing calculation files.
+
+Before replacing the starter, update [the brief](brief.md), collect
+[references](references/README.md), and read [the authoring notes](authoring.md).
+Source-to-document consistency checks that the documented formulas agree with
+the captured calculation. Independent reference checks and engineering approval
+remain separate review steps. No deployment is needed.

package/template/authoring.md

@@ -0,0 +1,18 @@
+# Write scalar calculations
+
+Use constrained Python in `calculations/report.cso.py`. Declare documented inputs
+and assignments with `Annotated[float, symbol(...)]` or
+`Annotated[int, symbol(...)]`. A plain `float` or `int` parameter needs a separate
+documented `given()` assignment.
+Use descriptive names and qualified glyphs such as `A_{rect}`. Define units and
+explain each glyph qualifier. Return a dictionary that selects documented values.
+
+Use finite scalar numbers and arithmetic `+`, `-`, `*`, `/`, and `**`.
+Python booleans are not numeric inputs. Declare `float` for fractional results.
+Exact integers must fit within ±(2**53 - 1). Keep assumptions and references in
+literal `text(id=..., content=...)` calls so they appear in the report.
+
+The [maintained authoring guide](https://github.com/viktar-b/CalculationSourceObject/blob/main/docs/authoring.md)
+describes supported functions, composition, and document content. Unsupported
+Python constructs must be replaced with supported scalar expressions before
+the calculation can pass verification.

package/template/brief.md

@@ -0,0 +1,9 @@
+# Calculation brief
+
+The starter calculates the area of a flat rectangle in square metres.
+Its width and height are positive lengths in metres, with defaults of 2 and 3.
+The sides meet at right angles. The output is the product of those lengths.
+
+Replace this example scope with the purpose, assumptions, input ranges, units,
+required outputs, and acceptance criteria for your calculation. Put supporting
+material in [references](references/README.md).

package/template/calculations/report.cso.py

@@ -0,0 +1,14 @@
+from typing import Annotated
+from cso_python import calculation, section, symbol, text
+
+
+@calculation(id="rectangle-area", title="Rectangle area")
+@section(title="Rectangle", root=True)
+def calculate(
+    width: Annotated[float, symbol(glyph="w_{rect}", description="Rectangle width", unit="m")] = 2.0,
+    height: Annotated[float, symbol(glyph="h_{rect}", description="Rectangle height", unit="m")] = 3.0,
+):
+    text(id="assumptions", content="Assume a flat rectangle with perpendicular sides and positive dimensions. The qualifier rect means rectangle.")
+    text(id="reference", content="Reference: the elementary rectangle relation, area equals width multiplied by height. See brief.md for the project scope.")
+    area: Annotated[float, symbol(glyph="A_{rect}", description="Rectangle area", unit="m^2")] = width * height
+    return {"area": area}

package/template/gitignore

@@ -0,0 +1,8 @@
+node_modules/
+.venv/
+__pycache__/
+_cso_bindings/
+output/
+*.evidence/
+.DS_Store
+.env

package/template/references/README.md

@@ -0,0 +1,5 @@
+# Calculation references
+
+Keep source documents or links here. Record the relevant page or clause, edition,
+and the assumptions each source supports. The starter uses the elementary
+rectangle area relation and has no external engineering reference case.

package/template/requirements.txt

@@ -0,0 +1 @@
+cso-python==0.1.0

package/template/scripts/dev.ts

@@ -0,0 +1,57 @@
+import { spawn } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const project = fileURLToPath(new URL('..', import.meta.url));
+const python = join(
+  project,
+  '.venv',
+  process.platform === 'win32' ? 'Scripts/python.exe' : 'bin/python',
+);
+try {
+  if (!existsSync(python))
+    throw new Error(
+      'Run npm run setup to prepare the project Python environment.',
+    );
+  const require = createRequire(import.meta.url);
+  const cli = join(
+    dirname(require.resolve('@cs-object/cli/package.json')),
+    'dist/cli.js',
+  );
+  const child = spawn(
+    process.execPath,
+    [
+      cli,
+      'dev',
+      'calculations/report.cso.py',
+      '--function',
+      'calculate',
+      ...process.argv.slice(2),
+    ],
+    {
+      cwd: project,
+      env: { ...process.env, PYTHON: python },
+      stdio: 'inherit',
+    },
+  );
+  const interrupt = () => child.kill('SIGINT');
+  const terminate = () => child.kill('SIGTERM');
+  process.on('SIGINT', interrupt);
+  process.on('SIGTERM', terminate);
+  child.once('error', (error) => {
+    process.stderr.write(`${error.message}\n`);
+  });
+  child.once('close', (code, signal) => {
+    process.off('SIGINT', interrupt);
+    process.off('SIGTERM', terminate);
+    process.exitCode =
+      code ?? (signal === 'SIGINT' ? 130 : signal === 'SIGTERM' ? 143 : 1);
+  });
+} catch (error) {
+  process.stderr.write(
+    `${error instanceof Error ? error.message : String(error)}\n`,
+  );
+  process.exitCode = 1;
+}

package/template/scripts/setup.ts

@@ -0,0 +1,74 @@
+import { spawnSync } from 'node:child_process';
+import { existsSync } from 'node:fs';
+import { createRequire } from 'node:module';
+import { dirname, join } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const project = fileURLToPath(new URL('..', import.meta.url));
+const python = join(
+  project,
+  '.venv',
+  process.platform === 'win32' ? 'Scripts/python.exe' : 'bin/python',
+);
+function run(command: string, args: string[]) {
+  const result = spawnSync(command, args, { cwd: project, stdio: 'inherit' });
+  if (result.error || result.status !== 0)
+    throw new Error(
+      result.error?.message ?? `${command} failed with exit ${result.status}.`,
+    );
+}
+function supportedPython(command: string) {
+  return (
+    spawnSync(
+      command,
+      [
+        '-I',
+        '-c',
+        'import sys; sys.exit(0 if sys.version_info >= (3, 11) else 1)',
+      ],
+      { timeout: 10_000, stdio: 'ignore' },
+    ).status === 0
+  );
+}
+try {
+  if (Number(process.versions.node.split('.')[0]) < 24)
+    throw new Error('Node.js 24 or newer is required.');
+  if (!existsSync(python)) {
+    const candidates = process.env.PYTHON
+      ? [process.env.PYTHON]
+      : ['python3', 'python'];
+    const base = candidates.find(supportedPython);
+    if (!base)
+      throw new Error(
+        'Python 3.11 or newer is required. Install it or set PYTHON to its executable.',
+      );
+    run(base, ['-m', 'venv', join(project, '.venv')]);
+  }
+  if (!supportedPython(python))
+    throw new Error(
+      'The project .venv needs Python 3.11 or newer. Recreate .venv with a supported interpreter.',
+    );
+  run(python, [
+    '-m',
+    'pip',
+    'install',
+    '-r',
+    join(project, 'requirements.txt'),
+  ]);
+  const require = createRequire(import.meta.url);
+  const cliRequire = createRequire(
+    require.resolve('@cs-object/cli/package.json'),
+  );
+  const playwright = dirname(cliRequire.resolve('playwright/package.json'));
+  run(process.execPath, [
+    join(playwright, 'cli.js'),
+    'install',
+    'chromium',
+  ]);
+  process.stdout.write('Setup complete. Run npm run dev.\n');
+} catch (error) {
+  process.stderr.write(
+    `${error instanceof Error ? error.message : String(error)}\nFix the error, then run npm run setup again. Your project files are preserved.\n`,
+  );
+  process.exitCode = 1;
+}