@go-labs-sg/rsvp 0.14.0 → 0.15.0
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 +15 -1
- package/dist/index.js +7 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,6 +2,20 @@
|
|
|
2
2
|
|
|
3
3
|
JSON-first command-line access to Registration organizations, events, guests, check-in, payments, reporting, retention, and administrative operations.
|
|
4
4
|
|
|
5
|
+
## First step: update before use
|
|
6
|
+
|
|
7
|
+
Before starting a task, **update to the latest published release first**, including when an AI agent runs this CLI:
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
bun add --global @go-labs-sg/rsvp@latest
|
|
11
|
+
rsvp version
|
|
12
|
+
rsvp --help
|
|
13
|
+
```
|
|
14
|
+
|
|
15
|
+
Run this sequence once per task, not before every command. Re-read the updated help before choosing commands or flags. If updating fails, stop and report the failure rather than silently using an outdated CLI. If the user explicitly requested a pinned version or a development/staging build, preserve that version instead of replacing it with the public release.
|
|
16
|
+
|
|
17
|
+
New installation? Follow the runtime and installation instructions below to install Bun first, then return to this step.
|
|
18
|
+
|
|
5
19
|
## Runtime and installation
|
|
6
20
|
|
|
7
21
|
The CLI requires [Bun](https://bun.com/docs/installation) 1.4.0 or newer. npm distributes the package, while the installed command runs under Bun.
|
|
@@ -77,7 +91,7 @@ Argument-parsing errors use a safe command label and never echo option values,
|
|
|
77
91
|
including roster JSON passed through `--payload`. Surrounding shell history and
|
|
78
92
|
automation can still record arguments independently of the CLI's error output.
|
|
79
93
|
|
|
80
|
-
Use `rsvp help` for the command catalogue. Every response is a JSON envelope on stdout; errors and diagnostics go to stderr. `rsvp manifest` emits the machine-readable command reference for tooling.
|
|
94
|
+
Use `rsvp help` or `rsvp --help` for the command catalogue. `--help=true` and `--help=1` also show help; `--help=false` and `--help=0` preserve normal command execution. Other inline help values are rejected before command execution, even if a later `--help` flag is valid. Every response is a JSON envelope on stdout; errors and diagnostics go to stderr. `rsvp manifest` emits the machine-readable command reference for tooling.
|
|
81
95
|
|
|
82
96
|
## Public event page and images
|
|
83
97
|
|
package/dist/index.js
CHANGED
|
@@ -6692,6 +6692,7 @@ Object.assign(commands, {
|
|
|
6692
6692
|
"waitlist offer respond": payloadCommand((api, input) => api.waitlist.respondToOffer.mutate(input), "Respond to a waitlist offer (--payload JSON).", ["state-change"])
|
|
6693
6693
|
});
|
|
6694
6694
|
var getCommandManifest = () => ({
|
|
6695
|
+
beforeUse: "First step before each task: update to the latest published release with 'bun add --global @go-labs-sg/rsvp@latest', then run 'rsvp version' and 'rsvp --help' before using commands. Update once per task. If updating fails, stop and report it. Preserve an explicitly requested pinned or development/staging version.",
|
|
6695
6696
|
commands: [
|
|
6696
6697
|
{
|
|
6697
6698
|
effects: [],
|
|
@@ -6730,6 +6731,7 @@ var getCommandManifest = () => ({
|
|
|
6730
6731
|
}))
|
|
6731
6732
|
],
|
|
6732
6733
|
globalOptions: [
|
|
6734
|
+
"--help",
|
|
6733
6735
|
"--api-url <url>",
|
|
6734
6736
|
"--no-browser",
|
|
6735
6737
|
"--organization-id <id>",
|
|
@@ -6792,6 +6794,7 @@ var booleanFlags = new Set([
|
|
|
6792
6794
|
"--allow-external-write",
|
|
6793
6795
|
"--allow-financial-write",
|
|
6794
6796
|
"--allow-state-change",
|
|
6797
|
+
"--help",
|
|
6795
6798
|
"--no-browser"
|
|
6796
6799
|
]);
|
|
6797
6800
|
var valueFlags = new Set([
|
|
@@ -6819,6 +6822,9 @@ var parseArgs = (argv) => {
|
|
|
6819
6822
|
throw new CliUsageError(`Unknown option: ${name}.`);
|
|
6820
6823
|
const inlineValue = equalSignIndex === -1 ? undefined : argument.slice(equalSignIndex + 1);
|
|
6821
6824
|
if (inlineValue !== undefined) {
|
|
6825
|
+
if (name === "--help" && !["true", "false", "1", "0"].includes(inlineValue)) {
|
|
6826
|
+
throw new CliUsageError("--help accepts only true, false, 1, or 0.");
|
|
6827
|
+
}
|
|
6822
6828
|
flags.set(name, inlineValue);
|
|
6823
6829
|
continue;
|
|
6824
6830
|
}
|
|
@@ -6999,7 +7005,7 @@ var runRsvpCli = async (argv, dependencies) => {
|
|
|
6999
7005
|
let command = "unknown";
|
|
7000
7006
|
try {
|
|
7001
7007
|
const parsed = parseArgs(argv);
|
|
7002
|
-
const requestedCommand = parsed.positionals.join(" ") || "help";
|
|
7008
|
+
const requestedCommand = isEnabledFlag(parsed.flags, "--help") ? "help" : parsed.positionals.join(" ") || "help";
|
|
7003
7009
|
if (!knownCommandNames.has(requestedCommand)) {
|
|
7004
7010
|
throw new CliUsageError("Unknown command. Run 'rsvp help' to list commands.");
|
|
7005
7011
|
}
|