@hardfin/cli 0.1.1-dev.62 → 0.1.1-dev.64

package/README.md

@@ -51,27 +51,47 @@ and the shape of the last segment decide the verb.
 
 Everything an endpoint takes becomes a flag or an argument. No command asks for JSON.
 
-| The document says              | You type                                                               |
-| ------------------------------ | ---------------------------------------------------------------------- |
-| A path parameter               | a positional argument                                                  |
-| A query or body field          | `--field-name`, in kebab case                                          |
-| A field inside a nested object | `--address-city`, the path joined                                      |
-| An array of values             | the flag, repeated                                                     |
-| An array of objects            | the flag, repeated, each carrying that element's fields as `key=value` |
-| A file upload                  | `--file <path>`, sent as multipart                                     |
+| The document says              | You type                                                                |
+| ------------------------------ | ----------------------------------------------------------------------- |
+| A path parameter               | a positional argument                                                   |
+| A query or body field          | `--field-name`, in kebab case                                           |
+| A field inside a nested object | `--address-city`, the path joined                                       |
+| An amount of money             | `--sale-price-value` and `--sale-price-iso-code`, always given together |
+| An array of values             | the flag, repeated                                                      |
+| An array of objects            | the flag, repeated, each carrying that element's fields as `key=value`  |
+| An object inside such an array | a dotted key in that element, `unitPrice.amount=1500.00`                |
+| A list of text inside one      | that key, once per value, `serials=SN-1,serials=SN-2`                   |
+| A file upload                  | `--file <path>`, sent as multipart                                      |
 
 ```sh
 hardfin asset ownership create ast_4f9xk2mq7plr8stz \
-  --customer-id 0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d73 --date 2026-09-23 --sale-price 1500.00
+  --customer-id 0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d73 --date 2026-09-23 \
+  --sale-price-value 1500.00 --sale-price-iso-code USD
 
 hardfin asset move execute create \
   --move assetId=0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d70,originId=0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d71,destinationId=0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d72,shipAt=2026-09-24T10:00:00Z
+
+hardfin project create --name "Denver install" \
+  --line-item itemId=0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d74,quantity=40,transactionType=SERVICE,unitPrice.amount=125.50,unitPrice.isoCode=USD
+
+hardfin shipment ship shp_2wn8kq4lxp7rtz3m --ship-location-id 0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d71 \
+  --shipped-at 2026-10-13T10:00:00Z \
+  --item itemId=0192f7d4-3b6a-7c1e-9f2d-5a8b4c6e7d74,quantity=2,serials=SN-000123,serials=SN-000124
 ```
 
+A list of text inside an element, such as a shipment line's `serials`, is given by naming its
+key once per value. An element field that holds anything larger, such as a line item's
+`milestonePhases`, has no flag spelling. Send that request body with `--input`.
+
 A value is sent as the type the document names. `--useful-life 36` sends the number 36. A
-decimal such as `--salvage-value 1500.00` stays a string, which is how the API takes money
+decimal such as `--salvage-value-value 1500.00` stays a string, which is how the API takes money
 without losing precision.
 
+An amount of money always names its currency. `--salvage-value-value` is refused without
+`--salvage-value-iso-code`, and the reverse, unless the `--input` body already holds the other.
+Inside an element, `unitPrice.amount=` and `unitPrice.isoCode=` are given together the same way.
+To clear an amount, send the object as null, such as `--salvage-value null`.
+
 Inside a `key=value` flag, `=` gives a value as you typed it and `:=` gives it as JSON.
 
 | You type                | Is sent as                                                         |
@@ -230,6 +250,9 @@ Settle it in `surface-overrides.json`, keyed by `operationId`:
 }
 ```
 
+An override also shortens an action on a record. `POST /shipment/{shipmentKey}/ship` generates
+`shipment ship create`, and its override names it `shipment ship`.
+
 An override for an `operationId` the document no longer publishes fails the generator. That
 is deliberate, because a silently dropped override renames a command nobody meant to rename.
 
@@ -538,8 +561,9 @@ asking and ask before anything changes.
 | `hardfin://commands` | The command tree as JSON                                               | Only when the agent reads it |
 
 The server asks the CLI's own parser what a call would run, and places the call by its
-method. A flag whose value is `--help`, or a `--method` given twice, is placed by what the
-command would do.
+method. A flag whose value is `--help` is placed by what the command would do. A `--method`
+given twice runs nothing, because the parser refuses a flag that takes one value when it is
+given again.
 
 | A call is | When                                                                        |
 | --------- | --------------------------------------------------------------------------- |

package/dist/cli.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="32c6ff44-5b5a-5c1d-a718-7808ccc648a2")}catch(e){}}();
+!function(){try{var e="undefined"!=typeof window?window:"undefined"!=typeof global?global:"undefined"!=typeof globalThis?globalThis:"undefined"!=typeof self?self:{},n=(new e.Error).stack;n&&(e._sentryDebugIds=e._sentryDebugIds||{},e._sentryDebugIds[n]="aacd0112-e361-5290-9a4f-2ad41bcf2520")}catch(e){}}();
 import module from "node:module";
 //#region src/cli.ts
 module.enableCompileCache?.();
@@ -14,7 +14,7 @@ process.on("unhandledRejection", (error) => void toCrash(error));
 try {
 	const answer = await toQuickAnswer(process.argv.slice(2));
 	if (answer === void 0) {
-		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-JKHwms47.js");
+		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-Bok0tZ8p.js");
 		try {
 			await toCli().parseAsync(process.argv);
 		} catch (error) {
@@ -33,7 +33,7 @@ async function toCrash(error) {
 	isCrashing = true;
 	const isJSON = process.argv.includes("--json") || !process.stdout.isTTY;
 	try {
-		const { toReported, writeCrash } = await import("./program-JKHwms47.js");
+		const { toReported, writeCrash } = await import("./program-Bok0tZ8p.js");
 		writeCrash(error, isJSON);
 		await toReported(error, isJSON, void 0, "fatal");
 	} catch {
@@ -54,4 +54,4 @@ async function toQuickAnswer(args) {
 export {};
 
 //# sourceMappingURL=cli.js.map
-//# debugId=32c6ff44-5b5a-5c1d-a718-7808ccc648a2
+//# debugId=aacd0112-e361-5290-9a4f-2ad41bcf2520