@fluid-app/fluid-cli-payments 0.0.0-stage → 0.1.0

package/README.md

@@ -1,3 +1,69 @@
-# Temporary Holding Version
+# @fluid-app/fluid-cli-payments
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Fluid CLI plugin for payments onboarding: the KYC form at
+**Settings → Onboarding** in the admin. See what's missing, fill in fields and
+documents, and submit the form for review.
+
+```bash
+npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-payments
+fluid login
+fluid payments onboarding show                       # status, steps, and every required field still missing
+fluid payments onboarding fields --required          # keys, types, options, and when each is required
+fluid payments onboarding options mcc-codes          # also business-types (--country US), countries, currencies
+fluid payments onboarding set --yes \
+  --set info.user_has_authority=true --set info.user_is_signatory=true \
+  --set entity.legal_name="Acme Inc" --set entity.country_iso=US \
+  --file entity.business_license=./license.pdf
+fluid payments onboarding set --yes --file owner.government_issued_ids=./passport.jpg --id-type passport
+fluid payments onboarding set --yes --owner new --set owner.full_name="Sam Lee" --set owner.is_beneficial_owner=true
+fluid payments onboarding set --yes --set country.US.currency=USD --set country.US.settlement_currency=USD \
+  --set country.US.entity_legally_registered=true
+fluid payments onboarding remove owner 42 --yes      # or entity, bank, or a country by ISO code
+fluid payments onboarding submit --accept-terms --yes
+```
+
+Prefer answering question by question? `fluid payments onboarding walk` asks
+for each missing field in form order and saves each answer as you go. Type
+`<` to go back, `>` to skip, or `?` for the menu. From the menu you can jump to
+any step, change a saved answer, or submit. Pick lists cover yes/no, countries,
+currencies, MCC codes, and business types. Sensitive answers are hidden as you
+type. `--step <id>` starts at a step. It needs a terminal; scripts and agents
+use `show` and `set`.
+
+`show` and `set` return a `missing` list. Each entry names the step, the
+field, why it's needed, and a `fix`: the `set` flags that resolve it, such as
+`--entity 12 --set entity.website=<value>`. `readyToSubmit: true` means
+`submit` will go through.
+
+Fields go to records:
+
+- `info.*` and `underwriting.*` are the company's answers.
+- `entity.*` goes to the primary legal entity, or `--entity <id|new>`.
+- `bank.*` goes to the primary bank account, or `--bank <id|new>`.
+- `owner.*` goes to the onboarding contact (the person filling in the form),
+  or `--owner <id|new>`.
+- `country.<ISO>.*` adds or updates a country the company sells in.
+
+A record that doesn't exist yet is created. The first legal entity and bank
+account become primary, and the first person becomes the onboarding contact.
+
+Documents upload with `--file key=path`, up to 10 MB each. Multi-file
+documents add to what's there unless you pass `--replace-files`. Policies and
+agreements also take a URL: `--set underwriting.privacy_policy.link=https://...`.
+
+`submit` marks every step complete and accepts Fluid's payments terms for
+the company. That's why it needs `--accept-terms` as well as `--yes`. It
+refuses while anything is missing. The acceptance records the person who
+signed, so it needs a person's sign-in (`fluid login` with email). With a
+company API token, `submit` writes nothing and returns
+`status: "ready_to_submit"` with `submitUrl`, the admin's onboarding form,
+where a person submits.
+
+Tax IDs, account and routing numbers, ID numbers, and dates of birth are
+masked in every output. Uploaded documents are named, never linked. Every
+command prints JSON. Failures print a JSON `error` on stderr and exit
+non-zero. Commands that change data ask for confirmation unless you pass
+`--yes`.
+
+The walkthrough is the payments onboarding guided setup at
+https://docs.fluid.app/setup.

package/dist/index.d.mts

@@ -0,0 +1,20 @@
+import { CommandContext, FluidPlugin } from "@fluid-app/fluid-cli";
+import { Command } from "commander";
+
+//#region src/index.d.ts
+/**
+ * Changes to the onboarding form need an explicit yes. Scripts and agents
+ * pass `--yes`; an interactive terminal is asked. With neither, nothing runs.
+ */
+declare function confirmChange(question: string, yes: boolean, interactive?: boolean): Promise<void>;
+/**
+ * Print a failure as JSON on stderr and exit non-zero. The API's error body
+ * names fields and reasons, never the submitted values, so its `errors` are
+ * passed through as `details`.
+ */
+declare function fail(err: unknown, write?: (text: string) => void): void;
+declare function registerOnboardingCommands(parent: Command, ctx: CommandContext): void;
+declare const plugin: FluidPlugin;
+//#endregion
+export { confirmChange, plugin as default, fail, registerOnboardingCommands };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/index.ts"],"mappings":";;;;;;AA8CA;;iBAAsB,aAAA,CACpB,QAAA,UACA,GAAA,WACA,WAAA,aACC,OAAA;;;;;;iBAkBa,IAAA,CACd,GAAA,WACA,KAAA,IAAQ,IAAA;AAAA,iBAmDM,0BAAA,CACd,MAAA,EAAQ,OAAA,EACR,GAAA,EAAK,cAAA;AAAA,cA4TD,MAAA,EAAQ,WAAA"}