@grida/fx 0.2.0 → 0.2.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,17 +1,21 @@
1
1
  # @grida/fx
2
2
 
3
- Grida FX for JavaScript and TypeScript: the `grida-fx` command, and an SDK to write workflow
4
- files and to plan, price and run them. Grida FX is a workflow engine for generative asset
3
+ Grida FX for JavaScript and TypeScript: an SDK to write workflow files and to plan, price and
4
+ run them, and the standalone `grida-fx` command. Grida FX is a workflow engine for generative asset
5
5
  pipelines: write a workflow file, and FX plans it, prices it before anything is spent, caches
6
6
  every paid call by its request, and records the run. It works with your own provider keys.
7
7
 
8
- Stable releases start at `0.1.0` and use npm's default `latest` tag. Prereleases use `next`.
8
+ To run FX from a terminal, install the Grida CLI: `npm install -g grida`, then `grida fx --help`.
9
+ It pins this package. Install `@grida/fx` itself for the SDK, or for `grida-fx` on its own (in a
10
+ service you host, say):
9
11
 
10
12
  ```sh
11
13
  npm install @grida/fx # or: npm install -g @grida/fx
12
14
  npx grida-fx --help
13
15
  ```
14
16
 
17
+ Stable releases use npm's default `latest` tag. Prereleases use `next`.
18
+
15
19
  The engine is a native binary. npm installs it with this package, as an optional dependency for
16
20
  your machine:
17
21
 
@@ -26,11 +30,8 @@ your machine:
26
30
  WSL 2, which runs the Linux packages. Linux with musl (Alpine) is not supported either. Node 18 or
27
31
  later.
28
32
 
29
- FX is also the `fx` verb of the npm `grida` command: a `grida` release that pins this package
30
- runs its engine as `grida fx <verb>`. For that host this package exports
31
- its launcher as `@grida/fx/cli` (`launch`, `HOST_CONTRACT`); see
32
- [spec/distribution.md](https://github.com/gridaco/fx/blob/main/spec/distribution.md). The SDK
33
- stays `import … from "@grida/fx"`.
33
+ For the `grida` command, this package exports its launcher as `@grida/fx/cli` (`launch`,
34
+ `HOST_CONTRACT`); see [spec/distribution.md](https://github.com/gridaco/fx/blob/main/spec/distribution.md).
34
35
 
35
36
  `grida-fx` reports what is missing when it finds no engine. If you install with
36
37
  `--omit=optional`, or need a binary of your own, set `GRIDA_FX_BIN` to the path of a `grida-fx`
package/dist/index.d.ts CHANGED
@@ -3,7 +3,7 @@
3
3
  * the engine package for the machine); this package drives it: plan, price and run workflows,
4
4
  * read their runs, and write workflow documents.
5
5
  */
6
- export declare const version = "0.2.0";
6
+ export declare const version = "0.2.1";
7
7
  export { engineVersion, expand, identity, type InspectOptions, inspect, Plan, PlanRefused, plan, price, project, RunFile, RunResult, type RunValue, run, } from "./api.js";
8
8
  export { BINARY_VARIABLE, type BinaryOptions, binary, type Environment } from "./binary.js";
9
9
  export { cancel, type CancelOptions, inspectControl, RunControlError, type RunControlResult } from "./control.js";
package/dist/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * the engine package for the machine); this package drives it: plan, price and run workflows,
4
4
  * read their runs, and write workflow documents.
5
5
  */
6
- export const version = "0.2.0";
6
+ export const version = "0.2.1";
7
7
  export { engineVersion, expand, identity, inspect, Plan, PlanRefused, plan, price, project, RunFile, RunResult, run, } from "./api.js";
8
8
  export { BINARY_VARIABLE, binary } from "./binary.js";
9
9
  export { cancel, inspectControl, RunControlError } from "./control.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@grida/fx",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "Grida FX for JavaScript: the grida-fx command, and an SDK to build workflows and drive the engine.",
5
5
  "keywords": [
6
6
  "grida",
@@ -46,10 +46,10 @@
46
46
  ],
47
47
  "sideEffects": false,
48
48
  "optionalDependencies": {
49
- "@grida/fx-darwin-arm64": "0.2.0",
50
- "@grida/fx-darwin-x64": "0.2.0",
51
- "@grida/fx-linux-arm64-gnu": "0.2.0",
52
- "@grida/fx-linux-x64-gnu": "0.2.0"
49
+ "@grida/fx-darwin-arm64": "0.2.1",
50
+ "@grida/fx-darwin-x64": "0.2.1",
51
+ "@grida/fx-linux-arm64-gnu": "0.2.1",
52
+ "@grida/fx-linux-x64-gnu": "0.2.1"
53
53
  },
54
54
  "publishConfig": {
55
55
  "access": "public",