@hardfin/cli 0.1.1-dev.57 → 0.1.1-dev.58

package/README.md

@@ -79,7 +79,8 @@ Inside a `key=value` flag, `=` gives a value as you typed it and `:=` gives it a
 | `value=36`              | the text "36", because a custom field may hold a serial number     |
 | `value:=36`             | the number 36                                                      |
 | `value:=true`           | the boolean true                                                   |
-| `deliverAt:=null`       | null                                                               |
+| `deliverAt=null`        | null, because the field takes it                                   |
+| `deliverAt="null"`      | the text "null"                                                    |
 | `order=2` or `order:=2` | the number 2, because the document types `order` as a whole number |
 
 A value the field does not take fails locally with exit code 2, such as `order=two`, or
@@ -104,7 +105,18 @@ hardfin location create --input location.json
 echo '{"name": "Dock 4, north side"}' | hardfin location create --input -
 ```
 
-Clear a field with `--unset`, naming the flag:
+The word `null` clears a field the API takes null for. It is read before anything else,
+whatever the field holds, and `"null"` in quotes is the text.
+
+```sh
+hardfin asset accounting update ast_4f9xk2mq7plr8stz --useful-life null     # clears it
+hardfin asset update ast_4f9xk2mq7plr8stz --description '"null"'            # the text null
+```
+
+A field the API does not take null for is sent the word as text. The same holds inside a
+`key=value` flag, as in `deliverAt=null`.
+
+`--unset` clears a field too, naming the flag:
 
 ```sh
 hardfin asset accounting update ast_4f9xk2mq7plr8stz --unset useful-life

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]="1c7d3a24-925a-543e-a2eb-caf5f5968ada")}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]="a7e96225-360e-5093-91ec-0d60c0a9c032")}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-PaNgBWFL.js");
+		const { toCli, toParseExitCode, wasReportAttempted } = await import("./program-C2DP0mVy.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-PaNgBWFL.js");
+		const { toReported, writeCrash } = await import("./program-C2DP0mVy.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=1c7d3a24-925a-543e-a2eb-caf5f5968ada
+//# debugId=a7e96225-360e-5093-91ec-0d60c0a9c032

package/dist/{program-PaNgBWFL.js → program-C2DP0mVy.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]="566d9b65-d8fb-507d-8b0e-a21deb646246")}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]="b26e6779-10c9-5732-b40c-04e75265338c")}catch(e){}}();
 import { a as defineCommand, i as GLOBAL_FLAGS, r as ExitCode, t as toInvocation } from "./scrub-BZ0egWxC.js";
 import { n as toAnswer$1, r as toCompletion, t as PATH_VALUES } from "./completion-tree-DLC6ARLR.js";
 import { createRequire } from "node:module";
@@ -1568,6 +1568,16 @@ function toJSONInput(source) {
 function toEnum(values) {
 	return z.string().transform((value) => values.find((allowed) => allowed.toLowerCase() === value.toLowerCase()) ?? value).pipe(z.enum(values));
 }
+/** The word that clears a field the API takes null for, and the way to send that word as text. */
+const NULL_WORD = "null";
+/**
+* toNullOrText reads the word null before anything else. A field the API takes null for is
+* cleared by it, and "null" in quotes is the text. Any other value comes back as it was.
+*/
+function toNullOrText(value, isNullable) {
+	if (value === "\"null\"") return NULL_WORD;
+	return isNullable && value === "null" ? null : value;
+}
 const UNSET_FLAG = {
 	name: "unset",
 	description: "A field to clear, named as its flag is, repeatable",
@@ -1798,8 +1808,14 @@ function toBody(operation, flags, given) {
 			hasField = true;
 			continue;
 		}
-		const parsed = flag.schema.safeParse(value);
-		set(body, flag.jsonPath, parsed.success ? parsed.data : value);
+		const given = toNullOrText(value, flag.nullable === true);
+		if (given === null) {
+			set(body, flag.jsonPath, null);
+			hasField = true;
+			continue;
+		}
+		const parsed = flag.schema.safeParse(given);
+		set(body, flag.jsonPath, parsed.success ? parsed.data : given);
 		hasField = true;
 	}
 	const cleared = toCleared(operation, flags, body);
@@ -1850,8 +1866,9 @@ const NUMBER = /^-?\d+(\.\d+)?$/;
 * field that takes no text has only one reading, so order=2 is sent as the number.
 */
 function toTyped(text, types) {
+	const given = toNullOrText(text, types?.includes("null") === true);
+	if (given === null || given !== text) return given;
 	if (types === void 0 || types.includes("string")) return text;
-	if (types.includes("null") && text === "null") return null;
 	if ((types.includes("integer") || types.includes("number")) && NUMBER.test(text)) {
 		const value = Number(text);
 		if (types.includes("number") || Number.isInteger(value)) return value;
@@ -4796,6 +4813,7 @@ const commands = [
 							jsonPath: ["depreciationModel"],
 							description: "The method one unit is depreciated by, or null to clear it",
 							valueName: "value",
+							nullable: true,
 							schema: toEnum([
 								"DOUBLE_DECLINING",
 								"STRAIGHT_LINE",
@@ -5161,6 +5179,7 @@ const commands = [
 								jsonPath: ["depreciationModel"],
 								description: "The method one unit is depreciated by, or null to clear it",
 								valueName: "value",
+								nullable: true,
 								schema: toEnum([
 									"DOUBLE_DECLINING",
 									"STRAIGHT_LINE",
@@ -6537,6 +6556,7 @@ const commands = [
 								jsonPath: ["depreciationModel"],
 								description: "The method one unit is depreciated by, or null to clear it",
 								valueName: "value",
+								nullable: true,
 								schema: toEnum([
 									"DOUBLE_DECLINING",
 									"STRAIGHT_LINE",
@@ -6970,6 +6990,7 @@ const commands = [
 							jsonPath: ["type"],
 							description: "SITE for a site, or ZONE for a zone within a site",
 							valueName: "value",
+							nullable: true,
 							schema: toEnum([
 								"SITE",
 								"UNKNOWN",
@@ -7130,6 +7151,7 @@ const commands = [
 							jsonPath: ["type"],
 							description: "SITE for a site, or ZONE for a zone within a site",
 							valueName: "value",
+							nullable: true,
 							schema: toEnum([
 								"SITE",
 								"UNKNOWN",
@@ -7270,7 +7292,9 @@ function toRejectedFlag(command, flags) {
 	for (const flag of command.flags) {
 		const value = flags[toOptionKey(flag.name)];
 		if (value === void 0) continue;
-		if (!flag.schema.safeParse(value).success) return `--${flag.name} does not accept ${JSON.stringify(value)}`;
+		const given = toNullOrText(value, flag.nullable === true);
+		if (given === null) continue;
+		if (!flag.schema.safeParse(given).success) return `--${flag.name} does not accept ${JSON.stringify(value)}`;
 	}
 }
 //#endregion
@@ -7357,5 +7381,5 @@ async function toReported(error, isJSON, resolved, level = "error") {
 //#endregion
 export { toCli, toParseExitCode, toReported, wasReportAttempted, writeCrash };
 
-//# sourceMappingURL=program-PaNgBWFL.js.map
-//# debugId=566d9b65-d8fb-507d-8b0e-a21deb646246
+//# sourceMappingURL=program-C2DP0mVy.js.map
+//# debugId=b26e6779-10c9-5732-b40c-04e75265338c

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hardfin/cli",
-    "version": "0.1.1-dev.57",
+    "version": "0.1.1-dev.58",
     "description": "Command line interface for the Hardfin API",
     "license": "Apache-2.0",
     "author": "Hardfin, Inc.",