@getvitops/utils 8.0.1 → 8.2.0-alpha.0

package/dist/hosting/index.d.mts

@@ -0,0 +1,184 @@
+//#region src/hosting/types.d.ts
+/**
+ * `vitops setup`'s own option surface.
+ *
+ * Structural, not imported from `@getvitops/generator`, for the same reason as
+ * `onboarding/types.ts` and `ads/types.ts`: the generator already depends on this
+ * package, so importing back would be a cycle. `exactOptionalPropertyTypes` is on,
+ * so optional fields are `?: T | undefined` throughout — these describe a *parsed
+ * JSON config*, where an absent key and an explicit `undefined` are the same thing.
+ */
+/** What the operator wants provisioned, derived from the config + CLI flags. */
+interface HostingSetup {
+  platform: 'cloudflare' | 'node';
+  /** Repo name (also the D1/R2 name prefix), derived from `package.json`'s name. */
+  projectName: string;
+  repoVisibility: 'public' | 'private';
+  /** Whether the isolated dev D1 + R2 should be provisioned (cloudflare only). */
+  devResources: boolean;
+  /** GitHub `owner/repo`, once known — absent before `repo` has run. */
+  repoNwo?: string | undefined;
+}
+/** Everything gathered from the live GitHub + Cloudflare state before planning. */
+interface HostingState {
+  wranglerAuthed: boolean;
+  accountId?: string | undefined;
+  d1Present: boolean;
+  d1Id?: string | undefined;
+  r2Present: boolean;
+  ghAuthed: boolean;
+  originRemote?: string | undefined;
+  repoNwo?: string | undefined;
+  branches: string[];
+  defaultBranch?: string | undefined;
+  mainProtected: boolean;
+  /** `production`/`dev` environment names already present on the repo. */
+  environments: string[];
+  /** Repo secret names already set (values are never readable via the API). */
+  secretsPresent: string[];
+}
+/** One domain-consistency observation — read from `wrangler.jsonc` + the config. */
+interface DomainState {
+  wranglerDev: boolean;
+  customDomain?: string | undefined;
+  /** `site.environments.<env>.url`, as configured. */
+  configuredUrl?: string | undefined;
+  /** `site.domains.canonical`, as configured. */
+  canonical?: string | undefined;
+  robots?: string | undefined;
+}
+//#endregion
+//#region src/hosting/plan.d.ts
+type StepAction = 'create' | 'update' | 'skip' | 'blocked';
+interface StepPlan {
+  action: StepAction;
+  detail: string;
+}
+interface HostingPlan {
+  repo: StepPlan;
+  branches: StepPlan;
+  defaultBranch: StepPlan;
+  mainProtection: StepPlan;
+  prodEnvironment: StepPlan;
+  devEnvironment: StepPlan;
+  d1: StepPlan;
+  r2: StepPlan;
+  /** One step per repo secret this command sets. */
+  secrets: Record<string, StepPlan>;
+  notes: string[];
+}
+/** Plan the whole hosting sequence from setup + observed state. */
+export declare function plan(setup: HostingSetup, state: HostingState): HostingPlan;
+/** Any step that isn't a skip — i.e. the live state has drifted from desired. */
+export declare function hasDrift(p: HostingPlan): boolean;
+/** Every blocked step, with a name — what `--check` reports and the CLI surfaces. */
+export declare function blockedSteps(p: HostingPlan): {
+  name: string;
+  detail: string;
+}[];
+/** Render a plan as the block `--dry` and `--check` print. */
+export declare function formatPlan(p: HostingPlan): string;
+/** The outcome of one run, for the summary table. */
+interface HostingResult {
+  step: string;
+  status: 'created' | 'updated' | 'present' | 'blocked' | 'failed';
+  detail: string;
+}
+/** Render the end-of-run summary: one row per step, plus blocked reminders. */
+export declare function formatSummary(results: HostingResult[]): string;
+/**
+ * Plan the domain-consistency check on its own — it has no executor, only an
+ * observation (`wrangler.jsonc` + the config), and it is never applied by this
+ * command. See `SETUP.html`'s "Domain strategy" stage: the actual cutover is a
+ * human, deliberate action.
+ */
+export declare function planDomainConsistency(state: DomainState): StepPlan;
+//#endregion
+//#region src/hosting/wrangler.d.ts
+interface ExecResult {
+  ok: boolean;
+  stdout: string;
+  message?: string | undefined;
+}
+type ExecImpl = (cmd: string, args: string[]) => Promise<ExecResult>;
+/** The real executor — `execFile` with an argv array, never a shell string. */
+export declare const realExec: ExecImpl;
+/** `wrangler whoami` — auth check + the 32-hex account id, from one call. */
+export declare function wranglerWhoami(execImpl?: ExecImpl): Promise<{
+  authed: boolean;
+  accountId?: string;
+}>;
+/**
+ * Find an existing dev D1 database's id by name.
+ *
+ * `d1 create`'s own stdout carries the id, but its format has drifted across
+ * wrangler versions before — a re-list is the one thing guaranteed to still hold
+ * the answer, so both the "does it exist" check and the post-create fallback go
+ * through this.
+ */
+export declare function findD1(name: string, execImpl?: ExecImpl): Promise<string | undefined>;
+/** Create a dev D1 database, then resolve its id via `findD1` (see its docblock). */
+export declare function createD1(name: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  id?: string | undefined;
+  message?: string | undefined;
+}>;
+export declare function findR2Bucket(name: string, execImpl?: ExecImpl): Promise<boolean>;
+export declare function createR2Bucket(name: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+//#endregion
+//#region src/hosting/github.d.ts
+export declare function ghAuthed(execImpl?: ExecImpl): Promise<boolean>;
+export declare function originRemote(execImpl?: ExecImpl): Promise<string | undefined>;
+export declare function repoNwo(execImpl?: ExecImpl): Promise<string | undefined>;
+export declare function branches(execImpl?: ExecImpl): Promise<string[]>;
+export declare function defaultBranch(nwo: string, execImpl?: ExecImpl): Promise<string | undefined>;
+export declare function mainProtected(nwo: string, execImpl?: ExecImpl): Promise<boolean>;
+export declare function environments(nwo: string, execImpl?: ExecImpl): Promise<string[]>;
+export declare function secretsPresent(nwo: string, execImpl?: ExecImpl): Promise<string[]>;
+export declare function createRepo(name: string, visibility: 'public' | 'private', execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+export declare function pushBranches(execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+export declare function setDefaultBranch(nwo: string, branch: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+/**
+ * `PUT .../branches/main/protection`. A 403 on Pro/Team-gated repos is expected.
+ *
+ * Every field goes through `gh api`'s `-f`/`-F` form flags rather than a JSON body
+ * on stdin — `gh api` supports nested keys (`a[b]=c`) and repeated array keys
+ * (`a[]=x`) this way, so no request needs a second I/O channel `ExecImpl` would
+ * have to carry just for this one call.
+ */
+export declare function protectMain(nwo: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+/** The repo's admin collaborators — numeric user ids, which is what the
+ * environment-reviewers API wants (not logins). */
+export declare function adminCollaboratorIds(nwo: string, execImpl?: ExecImpl): Promise<number[]>;
+/** `PUT .../environments/production`, reviewers = current admin collaborators. */
+export declare function createProdEnvironment(nwo: string, reviewerUserIds: number[], execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+/** `PUT .../environments/dev` with no reviewers — deliberately left open. */
+export declare function createDevEnvironment(nwo: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+export declare function setSecret(name: string, value: string, execImpl?: ExecImpl): Promise<{
+  ok: boolean;
+  message?: string | undefined;
+}>;
+//#endregion
+export type { DomainState, ExecImpl, ExecResult, HostingPlan, HostingResult, HostingSetup, HostingState, StepAction, StepPlan };
+//# sourceMappingURL=index.d.mts.map

package/dist/hosting/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","names":[],"sources":["../../src/hosting/types.ts","../../src/hosting/plan.ts","../../src/hosting/wrangler.ts","../../src/hosting/github.ts"],"mappings":";;;;;;;;;;;UAWiB;EACf;;EAEA;EACA;;EAEA;;EAEA;;;UAIe;EACf;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;EACA;;EAEA;;EAEA;;;UAIe;EACf;EACA;;EAEA;;EAEA;EACA;;;;KC1BU;UAEK;EACf,QAAQ;EACR;;UAGe;EACf,MAAM;EACN,UAAU;EACV,eAAe;EACf,gBAAgB;EAChB,iBAAiB;EACjB,gBAAgB;EAChB,IAAI;EACJ,IAAI;;EAEJ,SAAS,eAAe;EACxB;;;wBASc,KAAK,OAAO,cAAc,OAAO,eAAe;;wBA6HhD,SAAS,GAAG;;wBAKZ,aAAa,GAAG;EAAgB;EAAc;;;wBAkB9C,WAAW,GAAG;;UAmBb;EACf;EACA;EACA;;;wBAIc,cAAc,SAAS;;;;;;;wBAevB,sBAAsB,OAAO,cAAc;;;UC/N1C;EACf;EACA;EACA;;KAGU,YAAY,aAAa,mBAAmB,QAAQ;;qBAGnD,UAAU;;wBAeD,eACpB,WAAU,WACT;EAAU;EAAiB;;;;;;;;;;wBAeR,OACpB,cACA,WAAU,WACT;;wBAYmB,SACpB,cACA,WAAU,WACT;EAAU;EAAa;EAAyB;;wBAS7B,aAAa,cAAc,WAAU,WAAsB;wBAM3D,eACpB,cACA,WAAU,WACT;EAAU;EAAa;;;;wBC/EJ,SAAS,WAAU,WAAsB;wBAIzC,aAAa,WAAU,WAAsB;wBAK7C,QAAQ,WAAU,WAAsB;wBAUxC,SAAS,WAAU,WAAsB;wBASzC,cACpB,aACA,WAAU,WACT;wBAWmB,cAAc,aAAa,WAAU,WAAsB;wBAI3D,aAAa,aAAa,WAAU,WAAsB;wBAY1D,eACpB,aACA,WAAU,WACT;wBAcmB,WACpB,cACA,kCACA,WAAU,WACT;EAAU;EAAa;;wBAYJ,aACpB,WAAU,WACT;EAAU;EAAa;;wBAKJ,iBACpB,aACA,gBACA,WAAU,WACT;EAAU;EAAa;;;;;;;;;;wBAaJ,YACpB,aACA,WAAU,WACT;EAAU;EAAa;;;;wBA0BJ,qBACpB,aACA,WAAU,WACT;;wBAWmB,sBACpB,aACA,2BACA,WAAU,WACT;EAAU;EAAa;;;wBAqBJ,qBACpB,aACA,WAAU,WACT;EAAU;EAAa;;wBAKJ,UACpB,cACA,eACA,WAAU,WACT;EAAU;EAAa"}