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

package/README.md

@@ -1,3 +1,49 @@
-# Temporary Holding Version
+# @fluid-app/fluid-cli-channels
 
-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 sales channels: connect TikTok Shop, Meta (Facebook and
+Instagram catalogs), or Google Merchant Center to a Fluid company, choose which
+products to list, check how they synced, and disconnect.
+
+```bash
+npm install -g @fluid-app/fluid-cli @fluid-app/fluid-cli-channels
+fluid login
+
+fluid channels walk tiktok                           # interactive: connect, pick products, fix issues
+fluid channels list                                  # which channels are connected
+fluid channels connect tiktok --open                 # print (and open) the sign-in URL
+fluid channels status tiktok                         # connection + listing counts
+fluid channels warehouse tiktok 7301234567 --yes     # TikTok only: the warehouse to publish from
+fluid channels catalog tiktok --all --yes            # every active product not already listed
+fluid channels catalog tiktok --all --collection 12 --yes
+fluid channels catalog tiktok --add 101,102 --yes    # only these products
+fluid channels catalog tiktok --remove 102 --yes
+fluid channels catalog tiktok                        # list the listings
+fluid channels issues tiktok                         # failed or rejected listings, with fixes
+fluid channels issues tiktok --retry --yes           # retry the failed publishes
+fluid channels catalog tiktok --remove-all --yes     # take every product off the channel
+fluid channels disconnect tiktok --yes
+```
+
+Channels: `tiktok`, `meta`, `google`.
+
+`walk` is the interactive way through a whole setup in a terminal. It picks
+the channel (showing which are connected), prints and opens the sign-in link
+and checks the connection once you've approved, sets TikTok's warehouse,
+offers the whole catalog, whole collections, or products picked from a
+searchable list, and retries failed publishes. Type `<` to go back, `>` to
+skip a stage, and `?` for the menu; every change asks before it runs. Scripts
+and agents use the other commands instead.
+
+- Connecting needs a person in a browser: `connect` prints the channel's
+  sign-in URL (`--open` opens it). After they approve, the channel sends them
+  back to Fluid, which saves the connection. Check it with `status`.
+- `--all` adds the active products that exist now. Products you create later
+  aren't added automatically; run it again to add them. It skips products you
+  removed earlier unless you pass `--include-removed`.
+- Disconnecting doesn't take products off the channel. Run
+  `catalog <channel> --remove-all --yes` first if you want them gone.
+
+Every command prints JSON; failures print a JSON `error` on stderr and exit
+non-zero. Commands that change live configuration ask for confirmation unless
+you pass `--yes`. The walkthroughs are the guided setups at
+https://docs.fluid.app/setup/overview.

package/dist/index.d.mts

@@ -0,0 +1,30 @@
+import { CommandContext, FluidPlugin } from "@fluid-app/fluid-cli";
+import { Command } from "commander";
+
+//#region src/index.d.ts
+/**
+ * Changes to a live channel 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, so scripts and
+ *  agents can read it the same way as a success. */
+declare function fail(err: unknown): void;
+/** Product, listing, or collection IDs from repeatable, comma-separated flags. */
+declare function parseIds(values: string[], flag: string): number[];
+interface CatalogOptions {
+  all: boolean;
+  collection: string[];
+  includeRemoved: boolean;
+  add: string[];
+  remove: string[];
+  removeAll: boolean;
+  yes: boolean;
+}
+/** Exactly one catalog change per run, or none to list the listings. */
+declare function catalogMode(opts: CatalogOptions): "list" | "all" | "add" | "remove" | "remove-all";
+declare function registerChannelCommands(parent: Command, ctx: CommandContext): void;
+declare const plugin: FluidPlugin;
+//#endregion
+export { catalogMode, confirmChange, plugin as default, fail, parseIds, registerChannelCommands };
+//# 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":";;;;;;AA6CA;;iBAAsB,aAAA,CACpB,QAAA,UACA,GAAA,WACA,WAAA,aACC,OAAA;;;iBAwCa,IAAA,CAAK,GAAA;;iBA0BL,QAAA,CAAS,MAAA,YAAkB,IAAA;AAAA,UAiBjC,cAAA;EACR,GAAA;EACA,UAAA;EACA,cAAA;EACA,GAAA;EACA,MAAA;EACA,SAAA;EACA,GAAA;AAAA;;iBAIc,WAAA,CACd,IAAA,EAAM,cAAA;AAAA,iBA+DQ,uBAAA,CACd,MAAA,EAAQ,OAAA,EACR,GAAA,EAAK,cAAA;AAAA,cAgTD,MAAA,EAAQ,WAAA"}