clyops-jobs 0.2.0 → 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Dan VerWeire
+
+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 whom the Software is
+furnished 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

@@ -6,9 +6,13 @@ artifacts, and each run gets a job record. A small in-memory queue runs jobs wit
 limit, for servers that hand out job ids. Built on [clyops-tools](../tools).
 
 ```sh
-npm install clyops-jobs
+pnpm add clyops-jobs
 ```
 
+**Single file.** `clyops-jobs.cjs` (in this package, and on npm) is the whole library as one dependency-free
+CommonJS file: copy or link it into a project and `require()` it on Node 20+, with no build step
+and no `node_modules`. It includes clyops-tools. `require('clyops-jobs')` loads it; `import` loads the ESM build. It is generated from the sources and checked in CI.
+
 ## Function config
 
 ```json
@@ -26,7 +30,8 @@ npm install clyops-jobs
 - `functions.NAME.script` is the tool, relative to a script root.
 - `key` names the options block (default: the function name). Options are
   `deepMerge(defaults[key], config[key])`, keyed like the tool's options (`out_dir`, `out-dir`)
-  and mapped onto its command line through `--help-json-schema` ([spec §13](../../spec/SPEC.md#13-json-input-toargv)).
+  and mapped onto its command line through `--help-json-schema` ([spec §13](https://github.com/wankdanker/clyops/blob/main/spec/SPEC.md#13-json-input-toargv)).
+- `positionals_order` (optional) is `first` (default) or `last`, for wrappers needing a specific order. `--` is only emitted for positional values starting with `-`.
 - `positionals` (optional) lists the tool's positional arguments explicitly; otherwise they're
   options keyed by argument name.
 - String values may use `${dot.path}` or `{{dot.path}}` templates against a context you build
@@ -84,3 +89,13 @@ queue.get(job.record.job_id)?.cancel();
 ```
 
 ESM only, Node 20+.
+
+A missing or unreadable configured stdin file rejects `runScriptFunction()`
+with its input-file error. It fails that job and stops its tool; the host worker
+stays alive.
+
+## Documentation
+
+Read the [Node guide](https://clyops.io/node-tools.html) and
+[complete public API reference](https://clyops.io/reference/node/index.html).
+Type declarations and documentation comments are included in the package.