@theholocron/cli 5.0.0-alpha.26 → 5.0.0-alpha.261

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/dist/index.d.mts CHANGED
@@ -1,19 +1,22 @@
1
- import { Analytics, Auth, AuthDescription, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, Ci, CiRun, CiRunFilter, CiRunStatus, ConnectionStringOptions, CreateAuthUserInput, DeployFunctionConfig, DeployFunctionResult, DeployScriptConfig, DeployScriptResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, Dns, DnsRecord, DnsRecordType, EnsureResult, Environment, EnvironmentReviewer, Environments, Errors, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, Logs, NormalizedAuthUser, Notifications, PagesConfig, ParseWebhookInput, ProviderApiError, ProviderIdentity, PullRequest, REQUIRED_CAPABILITIES, RepoRef, RepoSettings, ResolvedCapability, Ruleset, SecretScope, Secrets, Source, StatusCategory, Storage, StorageBranch, TeamEntry, TeamPermission, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, WebhookDashboardInfo, WebhookVerificationError, Wiki, WikiDnsRecord, WikiProvisionOpts, WikiProxyConfig, Workers, isMulti } from "./plugin/capabilities.mjs";
1
+ import { $ as Logs, $t as Workers, A as DeploymentProjectSettings, At as RepoSettings, B as EnsureResult, Bt as Storage, C as CreateAuthUserInput, Ct as NotificationsSignedIn, D as DeployScriptResult, Dt as ProviderIdentity, E as DeployScriptConfig, Et as ParseWebhookInput, F as DnsRecord, Ft as ServerInspection, G as Environments, Gt as ToolingDoctorReport, H as EnsuredResource, Ht as TeamEntry, I as DnsRecordRequest, It as Source, J as IssueSearchFilter, Jt as Vault, K as Errors, Kt as TrackerDoctorReport, L as DnsRecordType, Lt as SourceFile, M as DeploymentTarget, Mt as Ruleset, N as DeploymentTrigger, Nt as SecretScope, O as Deployment, Ot as PullRequest, P as Dns, Pt as Secrets, Q as LifecycleSlot, Qt as WikiProxyConfig, R as EnsureRelayInput, Rt as SourceTeamMember, S as ConnectionStringOptions, St as NotificationsSignIn, T as DeployFunctionResult, Tt as PagesConfig, U as Environment, Ut as TeamPermission, V as EnsureWebhookResult, Vt as StorageBranch, W as EnvironmentReviewer, Wt as Tooling, X as LabelDef, Xt as Wiki, Y as Issues, Yt as WebhookDashboardInfo, Z as LifecycleResult, Zt as WikiProvisionOpts, _ as CardinalityFor, _t as NotificationsLinksLayout, a as WebhookVerificationError, at as MonitoringAssertionSource, b as CiRunFilter, bt as NotificationsPinnedLayout, c as Auth, ct as MonitoringHttpMethod, d as AuthEventType, dt as NotificationsAccess, et as Monitoring, f as AuthIdentity, ft as NotificationsApplicationLayout, g as Cardinality, gt as NotificationsLayout, h as CapabilityKey, ht as NotificationsEveryoneLayout, i as REQUIRED_CAPABILITIES, it as MonitoringAssertionComparison, j as DeploymentRecord, jt as ResolvedCapability, k as DeploymentProject, kt as RepoRef, l as AuthDescription, lt as NormalizedAuthUser, m as CapabilityImpls, mt as NotificationsDelivery, n as ElevationRequiredError, nt as MonitoringAlertChannelResult, o as isMulti, ot as MonitoringCheck, p as AuthUser, pt as NotificationsChannelLayout, q as Issue, qt as TrackerUser, r as ProviderApiError, rt as MonitoringAssertion, s as Analytics, st as MonitoringCheckInput, t as CARDINALITY, tt as MonitoringAlertChannelInput, u as AuthEvent, ut as Notifications, v as Ci, vt as NotificationsMember, w as DeployFunctionConfig, wt as NotificationsWelcomeLayout, x as CiRunStatus, xt as NotificationsServerLayout, y as CiRun, yt as NotificationsOnboardingLayout, z as EnsureRelayResult, zt as StatusCategory } from "./index-BD9zG_5Z.mjs";
2
+ import { A as SingleEntry, C as RepoProperties, D as ResolvedProviderEntry, E as ResolvedHolocronConfig, M as TaskEntryConfig, N as TelemetryConfig, O as ResolvedProvidersConfig, P as WorkflowWithConfig, S as RepoConfig, T as RepoVariables, _ as LogConfig, a as ConfigError, b as RawProviderEntry, c as resolvePluginPackage, d as ChromaticProjectConfig, f as DocsConfig, g as HolocronConfig, h as EslintConfig, i as TaskEntry, j as StorybookDeployProject, k as ResolvedTuple, l as AppConfig, m as EnvConfig, n as Capability, o as resolveConfig, p as DoctorConfig, r as ComposedPreset, s as resolveEntry, t as compose, u as CapabilityConfigPackage, v as MultiEntry, w as RepoProtection, x as RawProvidersConfig, y as ProviderOptions } from "./index-CdeSuXXV.mjs";
2
3
  import { AuthError, RequestOptions, ResolveTokenConfig as ResolveTokenConfig$1, ResolveTokenInput, RestClient, RestClientConfig, createRestClient } from "@theholocron/http-client";
4
+ import { PackageJson } from "@theholocron/pkg-utils";
3
5
  import { ConfigFileError } from "@theholocron/datapad";
6
+ import "@theholocron/observability/core";
4
7
  import { WorkspacePackage } from "@theholocron/astromech";
5
- import { LogLevel } from "@theholocron/observability/core";
6
- //#region src/auth/auth-resolver.d.ts
7
8
  type ResolveTokenConfig = Omit<ResolveTokenConfig$1, "getKeyringToken">;
8
- /** Wraps `createResolveToken` from `@theholocron/http` and injects the
9
- * system keyring so plugins stay at a one-liner call site. */
10
- declare function createResolveToken(config: ResolveTokenConfig): (input?: ResolveTokenInput) => string;
11
9
  interface FeatureResolverConfig {
12
10
  /** Env var name for this feature, e.g. `"HOLOCRON_ISSUES_TOKEN"`. */
13
11
  envName: string;
14
12
  /** Keyring account key, e.g. `"github.issues"`. */
15
13
  keyringKey: string;
14
+ /** The vendor named in the "no token" message. Default `GitHub`. */
15
+ vendor?: string;
16
16
  }
17
+ /** Wraps `createResolveToken` from `@theholocron/http` and injects the
18
+ * system keyring so plugins stay at a one-liner call site. */
19
+ export declare function createResolveToken(config: ResolveTokenConfig): (input?: ResolveTokenInput) => string;
17
20
  /**
18
21
  * Build a strict, single-feature token resolver.
19
22
  *
@@ -21,9 +24,7 @@ interface FeatureResolverConfig {
21
24
  * No broad-token fallback — if the feature-specific token is absent the
22
25
  * operation fails with a message naming the exact env var to set.
23
26
  */
24
- declare function createFeatureResolver(config: FeatureResolverConfig): (input?: ResolveTokenInput) => string;
25
- //#endregion
26
- //#region src/auth/keyring.d.ts
27
+ export declare function createFeatureResolver(config: FeatureResolverConfig): (input?: ResolveTokenInput) => string;
27
28
  /**
28
29
  * Keyring-backed bootstrap credential store.
29
30
  *
@@ -46,501 +47,53 @@ declare function createFeatureResolver(config: FeatureResolverConfig): (input?:
46
47
  * Store or overwrite a bootstrap token for a provider. Returns true on
47
48
  * success, false when the underlying keyring is unsupported or errored.
48
49
  */
49
- declare function setToken(provider: string, token: string): boolean;
50
+ export declare function setToken(provider: string, token: string): boolean;
50
51
  /**
51
52
  * Read the bootstrap token for a provider. Returns `null` for both
52
53
  * "not stored" and "keyring unavailable" — callers can treat them the
53
54
  * same way (fall through to env-var precedence).
54
55
  */
55
- declare function getToken(provider: string): string | null;
56
+ export declare function getToken(provider: string): string | null;
56
57
  /**
57
58
  * Delete a stored token. Returns true when a token was removed, false
58
59
  * when there was nothing to delete or the keyring is unavailable.
59
60
  * Distinguishing the two cases isn't worth the surface area — the
60
61
  * command output makes the situation clear either way.
61
62
  */
62
- declare function deleteToken(provider: string): boolean;
63
+ export declare function deleteToken(provider: string): boolean;
63
64
  /**
64
65
  * List provider slugs with a stored token in this service scope.
65
66
  * Uses the library's `findCredentials(service)` — supported on all
66
67
  * platforms the underlying credential store supports.
67
68
  */
68
- declare function listStoredProviders(): string[];
69
- //#endregion
70
- //#region src/config/config.d.ts
71
- /** Structured-logging config. The Axiom **token** never lives here — only in
72
- * env vars or the OS keyring — but the non-secret dataset name may. */
73
- interface LogConfig {
74
- /**
75
- * Default log level. The lowest-priority level source: `--verbose` /
76
- * `--quiet` and `HOLOCRON_LOG_LEVEL` both outrank it.
77
- */
78
- level?: LogLevel;
79
- /**
80
- * Axiom log-shipping. Set `axiom.dataset` to opt local runs into Axiom
81
- * without exporting `HOLOCRON_AXIOM_DATASET` — the CLI then pairs it with
82
- * the token from `HOLOCRON_AXIOM_TOKEN` / `AXIOM_TOKEN` or the OS keyring
83
- * (`holocron auth set axiom[.<org>] <TOKEN>`). Env vars still win. In CI,
84
- * prefer the `HOLOCRON_AXIOM_DATASET` variable.
85
- */
86
- axiom?: {
87
- /** Target Axiom dataset, e.g. `"holocron-local"`. */
88
- dataset?: string;
89
- };
90
- }
91
- /**
92
- * CLI self-telemetry config — the committed, reviewable override layer over the
93
- * env-var + shipped-fallback activation (ADR-0007 / ADR-0008). No secret lives
94
- * here; the Sentry DSN and PostHog key come from env vars or ship as fallbacks.
95
- *
96
- * Precedence: `HOLOCRON_TELEMETRY=false` (env) → `telemetry.enabled` (this) →
97
- * default on. `enabled` never *re-enables* what the env var turned off.
98
- */
99
- interface TelemetryConfig {
100
- /**
101
- * Repo-level opt-out — the committed peer of `HOLOCRON_TELEMETRY=false`.
102
- * `false` installs the no-op sinks for the whole run. Default on.
103
- */
104
- enabled?: boolean;
105
- /**
106
- * Usage-analytics provider. `"none"` disables PostHog usage analytics while
107
- * leaving error reporting (Sentry) untouched. Default `"posthog"`.
108
- */
109
- analytics?: "posthog" | "none";
110
- }
111
- type ProviderOptions = Record<string, unknown>;
112
- /**
113
- * The shape a capability config package's default export must satisfy.
114
- * Config packages let teams share a pre-bundled provider + options across
115
- * repos (Level 1 of the shareable-configs story, issue #75).
116
- *
117
- * @example
118
- * // @acme/holocron-vault/index.ts
119
- * import type { CapabilityConfigPackage } from '@theholocron/cli'
120
- * export default {
121
- * provider: '1password',
122
- * options: { vault: 'acme-app' },
123
- * } satisfies CapabilityConfigPackage
124
- */
125
- interface CapabilityConfigPackage {
126
- provider: string;
127
- options?: ProviderOptions;
128
- }
129
- type SingleEntry = string | [provider: string, options: ProviderOptions];
130
- type MultiEntry = Array<string | [provider: string, options: ProviderOptions]>;
131
- type RawProviderEntry = SingleEntry | MultiEntry;
132
- type RawProvidersConfig = Partial<Record<CapabilityKey, RawProviderEntry>>;
133
- type RepoProtection = "balanced" | "strict" | "none";
134
- /**
135
- * Raw `docs` config as written by the user. `build` is optional so the
136
- * field can be declared without committing to a build type yet; setup
137
- * will error if `docs` is present but `build` is absent.
138
- */
139
- interface DocsConfig {
140
- /**
141
- * GitHub Pages build source.
142
- * "workflow" → GitHub Actions (PUT { build_type: "workflow" })
143
- * "branch" → classic gh-pages branch (PUT { build_type: "legacy", source: { branch: "gh-pages", path: "/" } })
144
- * When absent, Pages is not managed by `holocron setup`.
145
- */
146
- build?: "workflow" | "branch";
147
- /**
148
- * Custom domain / CNAME (e.g. "docs.theholocron.dev").
149
- * When set and `homepage` is not explicitly provided, setup derives
150
- * `homepage` as `https://{domain}/` for package.json and the repo website field.
151
- */
152
- domain?: string;
153
- /** Enforce HTTPS. Only effective once the custom domain is DNS-verified. */
154
- https?: boolean;
155
- }
156
- interface RepoProperties {
157
- lifecycle?: "active" | "experimental" | "deprecated";
158
- open_source?: boolean;
159
- runtime_environment?: "node" | "browser" | "universal" | "none";
160
- uses_external_packages?: boolean;
161
- }
162
- interface RepoConfig {
163
- /** "owner/name" — the GitHub repository coordinate. Derived from the git remote when absent. */
164
- name?: string;
165
- /**
166
- * Branch protection preset applied by `holocron setup`. When omitted,
167
- * no protection is applied and no `branch_protection_level` property is set.
168
- * Required-status-check contexts for `"strict"` are derived from the task
169
- * manifest — `{ required: true }` tasks + top-level `extraRequiredChecks`
170
- * (see `astromech.requiredChecks()`).
171
- */
172
- protection?: RepoProtection;
173
- /**
174
- * GitHub teams granted repository access. Synced by `holocron setup`, which
175
- * also writes `.github/CODEOWNERS` for teams with write-or-higher permission.
176
- * String shorthand defaults to `push` (Write).
177
- */
178
- teams?: TeamEntry[];
179
- /** GitHub topics set on the repository. */
180
- topics?: string[];
181
- /** GitHub custom properties synced to the org dashboard. */
182
- properties?: RepoProperties;
183
- }
184
- interface AppConfig {
185
- name: string;
186
- path: string;
187
- kind?: string;
188
- }
189
- interface DoctorConfig {
190
- checks?: string[];
191
- }
192
- interface EnvConfig {
193
- /**
194
- * Namespace prefixes used by this project's env vars.
195
- * Listed from least- to most-specific (cascade model — last wins).
196
- * Tooling reads this to generate `.env.example`, validate required
197
- * vars, and produce documentation.
198
- *
199
- * @example
200
- * // Project-only prefix
201
- * namespaces: ["CLI_TEMPLATE"]
202
- *
203
- * // Org-wide defaults + project-specific overrides
204
- * namespaces: ["HOLOCRON", "MY_CLI"]
205
- */
206
- namespaces?: string[];
207
- }
208
- /**
209
- * A single Chromatic project entry in a monorepo `run-chromatic` config.
210
- * Each entry produces one matrix job in CI, publishing to a separate Chromatic project.
211
- *
212
- * The `tokenName` maps to a repository secret named `CHROMATIC_PROJECT_TOKEN_<TOKENNAME>`.
213
- * Additional fields correspond to chromaui/action inputs and are passed through directly.
214
- *
215
- * @see https://www.chromatic.com/docs/monorepos/
216
- */
217
- interface ChromaticProjectConfig {
218
- /**
219
- * Secret suffix. The CI job reads `CHROMATIC_PROJECT_TOKEN_<tokenName>`.
220
- * Must be uppercase (e.g. `"WEB"`, `"UI"`).
221
- */
222
- tokenName: string;
223
- /**
224
- * Path to run the Chromatic build from, relative to the repo root.
225
- * Typically the package directory (e.g. `"apps/web"`, `"packages/ui"`).
226
- */
227
- workingDir: string;
228
- /**
229
- * Script name to build Storybook. Defaults to `"build:storybook"`.
230
- * Must accept `--output-dir` pass-through (use `turbo run … --` at root).
231
- */
232
- buildScript?: string;
233
- /**
234
- * Path to the Storybook folder relative to `workingDir`, for TurboSnap.
235
- * Tells Chromatic where to find `.storybook/` when the Storybook config
236
- * is in a subdirectory. Corresponds to `--storybook-base-dir`.
237
- */
238
- storybookBaseDir?: string;
239
- /**
240
- * Glob patterns of files/dirs that should NOT trigger a TurboSnap bailout
241
- * when changed. Useful for ignoring non-UI changes in a monorepo
242
- * (e.g. `"./packages/!(ui)/**"` to focus TurboSnap on the UI package).
243
- * Corresponds to `--untraced`. Accepts a single glob string or array.
244
- */
245
- untraced?: string | string[];
246
- /**
247
- * Glob patterns matching story files to snapshot. When set, only matching
248
- * stories are captured. Corresponds to `--only-story-files`.
249
- * Cannot be combined with `onlyStoryNames`.
250
- */
251
- onlyStoryFiles?: string;
252
- /**
253
- * Exit with code 0 even when visual changes are detected.
254
- * Useful during initial setup before baselines are approved.
255
- * Corresponds to `--exit-zero-on-changes`.
256
- */
257
- exitZeroOnChanges?: boolean;
258
- }
259
- /**
260
- * A single Storybook app in a deploy workflow config.
261
- * `name` becomes the sandbox sub-path (`_site/sandbox/<name>/`).
262
- * `path` is the working directory relative to the repo root; defaults to `"."` (repo root) when omitted.
263
- */
264
- interface StorybookDeployProject {
265
- name?: string;
266
- path?: string;
267
- }
268
- /**
269
- * Typed `with:` inputs for reusable workflows.
270
- *
271
- * `run-chromatic` accepts either a plain boolean (single-project) or a
272
- * `ChromaticProjectConfig[]` object (multi-project monorepo).
273
- *
274
- * `docs` / `storybook` are high-level deploy shorthand that `holocron setup`
275
- * translates to `type` / `storybook-projects` before writing the thin caller.
276
- * They also drive automatic `paths:` derivation so you never need to write
277
- * `paths:` manually for deploy entries.
278
- */
279
- type WorkflowWithConfig = Record<string, unknown> & {
280
- "run-chromatic"?: boolean | {
281
- projects: ChromaticProjectConfig[];
282
- };
283
- /**
284
- * Docs deployment shorthand. `true` uses the org-standard `docs/` directory;
285
- * `{ path: "custom" }` uses a custom directory. Both derive a `paths:` entry automatically.
286
- */
287
- docs?: true | {
288
- path: string;
289
- };
290
- /** Storybook apps to deploy alongside docs. Each entry's `path` is appended to `paths:`. */
291
- storybook?: StorybookDeployProject[];
292
- };
293
- /**
294
- * A `tasks` manifest entry in object form. A bare string entry is shorthand
295
- * for `{ name, ci: true, local: true }`.
296
- */
297
- interface TaskEntryConfig {
298
- name: string;
299
- with?: WorkflowWithConfig;
300
- paths?: string[];
301
- linters?: string[];
302
- /** Emit a `.github/workflows/<name>.yml` thin caller + include in `holocron ci`. Default `true`. */
303
- ci?: boolean;
304
- /** Write a `package.json` script + let `holocron run <name>` resolve the task. Default `true`. */
305
- local?: boolean;
306
- /** The task's CI check context is a required status check + part of `holocron ci`'s default run. */
307
- required?: boolean;
69
+ export declare function listStoredProviders(): string[];
70
+ interface VerifyTokenSuccess {
71
+ ok: true;
72
+ /** "workplace: acme" / "user: cnewton@x" — surfaced in success output. */
73
+ subject: string;
308
74
  }
309
- interface HolocronConfig {
310
- /** Project name. Derived from package.json when absent. */
311
- name?: string;
312
- description?: string;
313
- /** Project homepage URL. Synced to package.json#homepage and the GitHub repo's website field by `holocron sync`. */
314
- homepage?: string;
315
- /**
316
- * Active org name for namespaced keyring lookup. When set, token resolution
317
- * tries `<service>.<org>` before the unnamespaced `<service>` fallback, so
318
- * a single machine can hold credentials for multiple GitHub orgs without
319
- * collision. Overridden by `--org` CLI flag or `HOLOCRON_ORG` env var.
320
- */
321
- org?: string;
322
- /**
323
- * Org canonical domain (e.g. `"theholocron.dev"`). Subdomains are derived
324
- * from this — `preview: true` on a deploy workflow resolves the preview base
325
- * domain as `preview.<domain>`, giving URLs like `<repo>-pr-<n>.<domain>`.
326
- */
327
- domain?: string;
328
- /**
329
- * Repository identity and metadata. When set, `PluginLoader` injects
330
- * `repo.name` into every plugin's `RuntimeContext.repo` so plugins that
331
- * need a repo (github, etc.) don't require `--repo` on every invocation.
332
- * `--repo` on the command line still overrides.
333
- */
334
- repo?: RepoConfig;
335
- /**
336
- * The task manifest — what this repo runs. Each entry is a task name
337
- * (backed by a reusable workflow in `theholocron/.github`), or the object
338
- * form to pass `with:` inputs. `@theholocron/astromech` reads this as the
339
- * single source for `holocron run` / `holocron ci` / the generated CI
340
- * workflows / `package.json` scripts.
341
- *
342
- * Supported values (intent-facing vocabulary — epic #672, D3):
343
- * "verification.unitTests" | "verification.typeSafety" | "verification.performance" |
344
- * "sourceQuality.staticAnalysis" | "sourceQuality.formatting" |
345
- * "sourceQuality.structuredDataValidation" | "sourceQuality.deadCodeAnalysis" |
346
- * "security.secretDetection" | "security.codeScanning" |
347
- * "delivery.build" | "delivery.publish" | "delivery.deploy" | "delivery.bundleSize" |
348
- * "platform.repoSync" | "platform.commitStandards" | "platform.repoValidation" |
349
- * "knowledge.wiki" | "knowledge.docs" | "knowledge.components" |
350
- * "review" | "tag" | "stale" | "greetings" | "dependencies" | "bookkeeping"
351
- *
352
- * `holocron setup` writes `.github/workflows/<name>.yml` for each entry,
353
- * calling the corresponding reusable workflow in `theholocron/.github`.
354
- * Files are overwritten on each run — they are generated artifacts.
355
- *
356
- * ### delivery.deploy / knowledge.docs / knowledge.components
357
- * `delivery.deploy` uses `docs` and/or `storybook` in `with:` — setup
358
- * derives `paths:` automatically. `docs: true` uses the org-standard
359
- * `docs/` directory; `docs: { path: "custom" }` overrides it.
360
- * `knowledge.docs` / `knowledge.components` are the same underlying
361
- * mechanism, each dedicated to exactly one type — they imply the
362
- * corresponding shorthand, so a repo using them never has to spell out
363
- * `docs: true` / `storybook: […]` itself.
364
- *
365
- * ```ts
366
- * // Docs only (standard layout)
367
- * { name: "delivery.deploy", with: { docs: true } }
368
- * // …or equivalently, the dedicated task:
369
- * "knowledge.docs"
370
- *
371
- * // Docs + monorepo storybooks
372
- * {
373
- * name: "delivery.deploy",
374
- * with: {
375
- * docs: true,
376
- * storybook: [
377
- * { name: "web", path: "apps/web" },
378
- * { name: "ui", path: "packages/ui" },
379
- * ],
380
- * },
381
- * }
382
- *
383
- * // Non-standard docs location
384
- * { name: "delivery.deploy", with: { docs: { path: "packages/site" } } }
385
- * ```
386
- *
387
- * ### run-chromatic
388
- * For a single-project repo, use `"run-chromatic": true` with a
389
- * `CHROMATIC_PROJECT_TOKEN` repository secret.
390
- *
391
- * For monorepos with multiple Storybooks, use the object form:
392
- * ```ts
393
- * "run-chromatic": {
394
- * projects: [
395
- * { tokenName: "WEB", workingDir: "apps/web" },
396
- * { tokenName: "UI", workingDir: "packages/ui" },
397
- * ]
398
- * }
399
- * ```
400
- * Each `tokenName` maps to a repository secret named
401
- * `CHROMATIC_PROJECT_TOKEN_<TOKENNAME>`. `holocron setup` expands this
402
- * to the flat `run-chromatic: true` + `chromatic-projects: <json>` inputs
403
- * that the reusable workflow accepts.
404
- *
405
- * @example
406
- * ["sourceQuality.staticAnalysis", { "name": "delivery.publish", "with": { "run-build": false } }]
407
- * { "name": "delivery.deploy", "with": { "docs": true } }
408
- */
409
- tasks?: Array<string | TaskEntryConfig>;
410
- /**
411
- * Opt out of `holocron sync`'s `package.json` script writes. Default `true`.
412
- */
413
- syncScripts?: boolean;
414
- /**
415
- * The command the synced `"holocron"` `package.json` script runs. Default
416
- * `"holocron"` (the installed bin). This repo overrides it to run its own
417
- * build (`"node packages/cli/dist/cli.mjs"`).
418
- */
419
- holocronScript?: string;
420
- /**
421
- * Required status-check contexts not backed by a `required` task (codecov
422
- * gates, the bundle-build check, …). `holocron setup` appends these to the
423
- * task-derived list from `astromech.requiredChecks()`.
424
- */
425
- extraRequiredChecks?: string[];
426
- /**
427
- * Git hooks `holocron setup` installs. `true` / `{ prePush: true }` writes
428
- * `.husky/pre-push` (runs `holocron ci` before every push); `false` /
429
- * `{ prePush: false }` opts out. Omitted → on for `protection: "strict"`,
430
- * off otherwise. `--hooks` / `--no-hooks` on `holocron setup` override.
431
- */
432
- hooks?: boolean | {
433
- prePush?: boolean;
434
- };
435
- providers: RawProvidersConfig;
436
- apps?: AppConfig[];
437
- doctor?: DoctorConfig;
438
- /**
439
- * Agent runtime that determines where skills are installed by `holocron setup`.
440
- * Skills are installed to `.agents/skills/<name>/` (canonical) with a
441
- * relative symlink at the agent-specific path:
442
- * - `"claude"` → `.claude/skills/<name>` → `../../.agents/skills/<name>`
443
- * - `"codex"` | `"gemini"` → logged as unsupported; skipped gracefully.
444
- */
445
- agent?: "claude" | "codex" | "gemini";
446
- /**
447
- * Skill names from `@theholocron/skills` to install during `holocron setup`.
448
- * Installed paths are gitignored and managed by setup — do not commit them.
449
- *
450
- * @example
451
- * ["git-safety", "pr-workflow", "commit-standards"]
452
- */
453
- skills?: string[];
454
- /**
455
- * GitHub Pages configuration. When present, `holocron setup` calls the
456
- * Pages API using `HOLOCRON_DEPLOY_TOKEN` (requires `pages:write` + `repo` scope).
457
- * When absent, Pages is left as-is.
458
- *
459
- * @example
460
- * { build: "workflow", domain: "docs.theholocron.dev", https: true }
461
- */
462
- docs?: DocsConfig;
463
- /**
464
- * Environment variable namespace configuration.
465
- * Declares the prefix(es) this project uses for its env vars so that
466
- * tooling can generate `.env.example`, validate required vars, and
467
- * produce accurate documentation without hard-coding prefix strings.
468
- *
469
- * @example
470
- * { namespaces: ["HOLOCRON", "MY_CLI"] }
471
- */
472
- env?: EnvConfig;
473
- /**
474
- * Structured-logging config. Only the level belongs here — Axiom
475
- * credentials come from env vars, never a committed file.
476
- *
477
- * @example
478
- * { level: "debug" }
479
- */
480
- log?: LogConfig;
481
- /**
482
- * CLI self-telemetry override layer. Env var (`HOLOCRON_TELEMETRY=false`)
483
- * still wins; this is the committed way to opt a repo out or drop usage
484
- * analytics while keeping error reporting.
485
- *
486
- * @example
487
- * { enabled: false }
488
- * { analytics: "none" }
489
- */
490
- telemetry?: TelemetryConfig;
491
- }
492
- interface ResolvedTuple {
493
- provider: string;
494
- /** Resolved package name (`@theholocron/holocron-plugin-<provider>` for short refs). */
495
- packageName: string;
496
- options: ProviderOptions;
497
- }
498
- type ResolvedProviderEntry = {
499
- cardinality: "single";
500
- tuple: ResolvedTuple;
501
- } | {
502
- cardinality: "many";
503
- tuples: ResolvedTuple[];
504
- };
505
- type ResolvedProvidersConfig = Partial<Record<CapabilityKey, ResolvedProviderEntry>>;
506
- interface ResolvedHolocronConfig {
507
- name: string;
508
- description?: string;
509
- homepage?: string;
510
- org?: string;
511
- domain?: string;
512
- repo?: RepoConfig;
513
- tasks?: Array<string | TaskEntryConfig>;
514
- syncScripts?: boolean;
515
- holocronScript?: string;
516
- extraRequiredChecks?: string[];
517
- hooks?: boolean | {
518
- prePush?: boolean;
519
- };
520
- providers: ResolvedProvidersConfig;
521
- apps: AppConfig[];
522
- doctor: DoctorConfig;
523
- agent?: "claude" | "codex" | "gemini";
524
- skills?: string[];
525
- /** Resolved Pages config. `build` is guaranteed present when this field exists. */
526
- docs?: PagesConfig;
527
- env?: EnvConfig;
528
- log?: LogConfig;
529
- telemetry?: TelemetryConfig;
75
+ interface VerifyTokenFailure {
76
+ ok: false;
77
+ /** Reason the token was rejected. Surfaces to the operator. */
78
+ message: string;
530
79
  }
531
- declare class ConfigError extends Error {
532
- name: string;
80
+ type VerifyTokenResult = VerifyTokenSuccess | VerifyTokenFailure;
81
+ export declare function defineConfig(config: HolocronConfig): HolocronConfig;
82
+ interface LoadedConfig {
83
+ resolved: ResolvedHolocronConfig;
84
+ /** Absolute path to the file the config was read from. */
85
+ filepath: string;
533
86
  }
534
87
  /**
535
- * Resolve `"github"` → `"@theholocron/holocron-plugin-github"`.
536
- * Fully-qualified names (scoped or not) are honored verbatim, which
537
- * is how third-party plugins published outside the org work.
88
+ * Read + parse + resolve `holocron.config.*` starting from the given
89
+ * directory, walking up through ancestors to the nearest `.git` boundary
90
+ * when `cwd` itself has no match — every command is usable from any
91
+ * subdirectory of a repo, not only its exact root (see
92
+ * `@theholocron/datapad`'s own doc comment for the stop conditions).
93
+ * Throws {@link ConfigFileError} when nothing is found or a file cannot
94
+ * be loaded, or `ConfigError` when the config fails schema checks.
538
95
  */
539
- declare function resolvePluginPackage(provider: string): string;
540
- declare function resolveEntry(key: CapabilityKey, raw: RawProviderEntry): ResolvedProviderEntry;
541
- declare function resolveConfig(raw: HolocronConfig): ResolvedHolocronConfig;
542
- //#endregion
543
- //#region src/commands/setup/derived-properties.d.ts
96
+ export declare function loadConfig(cwd: string): Promise<LoadedConfig>;
544
97
  /**
545
98
  * Derived custom-properties (#677). Unlike the existing 6 GitHub
546
99
  * custom-properties fields (`lifecycle`, `open_source`, `runtime_environment`,
@@ -548,17 +101,12 @@ declare function resolveConfig(raw: HolocronConfig): ResolvedHolocronConfig;
548
101
  * mirror what `holocron.config.ts` already states explicitly — these four are
549
102
  * *derived*: signal that isn't an explicit config field today (framework
550
103
  * choice, repo archetype, capability drift). See
551
- * `.notes/tech-holocron-platform.spec.md` → "Custom-properties sync — field
104
+ * `docs/wiki/specifications/tech-holocron-platform.spec.md` → "Custom-properties sync — field
552
105
  * definitions (#677)" for the full design.
553
106
  */
554
107
  type HolocronProfile = "library" | "cli" | "plugin" | "template" | "app" | "docs" | "platform";
555
- interface PackageJsonLike {
556
- name?: string;
557
- private?: boolean;
558
- bin?: unknown;
559
- dependencies?: Record<string, string>;
560
- devDependencies?: Record<string, string>;
561
- }
108
+ /** The `package.json` shape profile derivation reads — `@theholocron/pkg-utils`'s `PackageJson`, under the name Sentinel already imports. */
109
+ type PackageJsonLike = PackageJson;
562
110
  interface DeriveProfileInput {
563
111
  rootPackageJson: PackageJsonLike | null;
564
112
  repoName: string;
@@ -588,7 +136,7 @@ interface DeriveProfileInput {
588
136
  * 6. Private, non-publishable, non-docs → `app`.
589
137
  * 7. Otherwise, a single publishable package → `library`.
590
138
  */
591
- declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
139
+ export declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
592
140
  /**
593
141
  * Detected build/framework tooling — the literal "does this repo need
594
142
  * next/vite/tsdown" signal `holocron.config.ts` has no field for today
@@ -596,17 +144,17 @@ declare function deriveProfile(input: DeriveProfileInput): HolocronProfile;
596
144
  * Curated table, not exhaustive by design — add to `KNOWN_STACK_DEPS` as new
597
145
  * frameworks show up rather than trying to detect anything on npm.
598
146
  */
599
- declare function deriveStack(pkg: PackageJsonLike | null): string[];
147
+ export declare function deriveStack(pkg: PackageJsonLike | null): string[];
600
148
  /** The provider capability keys actually wired in `providers: {}` — zero heuristics. */
601
- declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
602
- declare function deriveCompliance(capabilities: readonly string[]): "compliant" | "non-compliant";
149
+ export declare function deriveCapabilities(providers: ResolvedProvidersConfig | undefined): string[];
150
+ export declare function deriveCompliance(capabilities: readonly string[]): "compliant" | "non-compliant";
603
151
  /**
604
152
  * The Phase B refinement `deriveCompliance()`'s own doc comment names —
605
153
  * *why* a repo is non-compliant, not just that it is. `[]` when compliant.
606
154
  * Same `REQUIRED_BASELINE` `deriveCompliance()` checks against — one
607
155
  * table, not two independently-maintained baselines.
608
156
  */
609
- declare function missingCapabilities(capabilities: readonly string[]): string[];
157
+ export declare function missingCapabilities(capabilities: readonly string[]): string[];
610
158
  /**
611
159
  * Reads each workspace package's actual `package.json` content (not just
612
160
  * `readWorkspacePackages()`'s `{ slug, name, dir }` — `deriveProfile()`'s
@@ -614,84 +162,64 @@ declare function missingCapabilities(capabilities: readonly string[]): string[];
614
162
  * Missing/invalid files are skipped, matching `readWorkspacePackages()`'s
615
163
  * own soft-fail behavior.
616
164
  */
617
- declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
618
- //#endregion
619
- //#region src/config/compose.d.ts
620
- type TaskEntry = NonNullable<HolocronConfig["tasks"]>[number];
621
- /** A single composable capability fragment. */
622
- interface Capability {
623
- /** Unique identifier — used for deduplication and dependency resolution. */
624
- id: string;
625
- /** Other capability IDs that must be present in the same compose() call. */
626
- requires?: string[];
627
- /** Task entries contributed by this capability. Merged by name; last writer wins. */
628
- tasks?: TaskEntry[];
629
- /** Provider config. Shallow-merged at the top level; later capabilities override per-key. */
630
- providers?: RawProvidersConfig;
631
- /**
632
- * Required status-check contexts **not** backed by a `required` task
633
- * (codecov gates, `Storybook Publish`, …). Unioned across all capabilities
634
- * onto the top-level `extraRequiredChecks`. Task-backed checks come from
635
- * `{ required: true }` task entries via `astromech.requiredChecks()`.
636
- */
637
- extraRequiredChecks?: string[];
638
- /** Repo config fragment. Scalar fields: last writer wins. properties/topics/teams: merged. */
639
- repo?: Partial<Omit<RepoConfig, "name">>;
640
- /** Org name. Last writer wins. */
641
- org?: string;
642
- /** Org canonical domain. Last writer wins. */
643
- domain?: string;
644
- /** Docs site config. Last writer wins. */
645
- docs?: DocsConfig;
646
- }
647
- /** The merged result of a compose() call. Spreads into defineConfig(). */
648
- interface ComposedPreset {
649
- tasks: TaskEntry[];
650
- providers: RawProvidersConfig;
651
- repo: Partial<Omit<RepoConfig, "name">>;
652
- /** Non-task required-check contexts, unioned across capabilities. */
653
- extraRequiredChecks: string[];
654
- org?: string;
655
- domain?: string;
656
- docs?: DocsConfig;
657
- }
658
- /**
659
- * Merge any number of capability fragments into a single preset object that
660
- * spreads directly into `defineConfig()`.
661
- *
662
- * - Accepts individual capabilities or nested arrays (for bundle presets).
663
- * - Deduplicates by `id` — when the same ID appears more than once, the last
664
- * occurrence wins. This lets callers override bundle defaults by listing an
665
- * explicit capability after the bundle.
666
- * - Validates all `requires` at call time and throws `ConfigError` if any are
667
- * unmet, listing every missing dependency in a single message.
668
- *
669
- * @example
670
- * // docs-only site — no typecheck
671
- * const preset = compose(node(), docs());
672
- *
673
- * // library with docs
674
- * const preset = compose(node(), typecheck(), docs());
675
- *
676
- * // nextjs() is a bundle that returns Capability[]
677
- * const preset = compose(node(), nextjs());
678
- */
679
- declare function compose(...args: (Capability | Capability[])[]): ComposedPreset;
680
- //#endregion
681
- //#region src/config/define-config.d.ts
682
- declare function defineConfig(config: HolocronConfig): HolocronConfig;
683
- //#endregion
684
- //#region src/config/load-config.d.ts
685
- interface LoadedConfig {
686
- resolved: ResolvedHolocronConfig;
687
- /** Absolute path to the file the config was read from. */
688
- filepath: string;
689
- }
690
- /**
691
- * Read + parse + resolve `holocron.config.*` from the given directory.
692
- * Throws {@link ConfigFileError} when nothing is found or a file cannot
693
- * be loaded, or `ConfigError` when the config is invalid.
694
- */
695
- declare function loadConfig(cwd: string): Promise<LoadedConfig>;
696
- //#endregion
697
- export { Analytics, AppConfig, Auth, AuthDescription, AuthError, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, Capability, CapabilityConfigPackage, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, ChromaticProjectConfig, Ci, CiRun, CiRunFilter, CiRunStatus, ComposedPreset, ConfigError, ConfigFileError, ConnectionStringOptions, CreateAuthUserInput, DeployFunctionConfig, DeployFunctionResult, DeployScriptConfig, DeployScriptResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, DeriveProfileInput, Dns, DnsRecord, DnsRecordType, DocsConfig, DoctorConfig, EnsureResult, EnvConfig, Environment, EnvironmentReviewer, Environments, Errors, FeatureResolverConfig, HolocronConfig, HolocronProfile, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, LoadedConfig, LogConfig, Logs, MultiEntry, NormalizedAuthUser, Notifications, PackageJsonLike, PagesConfig, ParseWebhookInput, ProviderApiError, ProviderIdentity, ProviderOptions, PullRequest, REQUIRED_CAPABILITIES, RawProviderEntry, RawProvidersConfig, RepoConfig, RepoProperties, RepoProtection, RepoRef, RepoSettings, type RequestOptions, ResolveTokenConfig, type ResolveTokenInput, ResolvedCapability, ResolvedHolocronConfig, ResolvedProviderEntry, ResolvedProvidersConfig, ResolvedTuple, type RestClient, type RestClientConfig, Ruleset, SecretScope, Secrets, SingleEntry, Source, StatusCategory, Storage, StorageBranch, StorybookDeployProject, TaskEntryConfig, TeamEntry, TeamPermission, TelemetryConfig, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, WebhookDashboardInfo, WebhookVerificationError, Wiki, WikiDnsRecord, WikiProvisionOpts, WikiProxyConfig, Workers, WorkflowWithConfig, compose, createFeatureResolver, createResolveToken, createRestClient, defineConfig, deleteToken, deriveCapabilities, deriveCompliance, deriveProfile, deriveStack, getToken, isMulti, listStoredProviders, loadConfig, missingCapabilities, readWorkspacePackageJsons, resolveConfig, resolveEntry, resolvePluginPackage, setToken };
165
+ export declare function readWorkspacePackageJsons(repoRoot: string, workspacePackages: readonly WorkspacePackage[]): Promise<PackageJsonLike[]>;
166
+ /** One line a probe reports: `info` for a fact, `ok` / `fail` for a result, `heading` to title the rows that follow. */
167
+ interface ProbeRow {
168
+ status: "ok" | "fail" | "info" | "heading";
169
+ label: string;
170
+ detail?: string;
171
+ }
172
+ /** What a probe is handed. Everything it prints or changes goes through this, so the runner can enforce the rules. */
173
+ interface ProbeContext {
174
+ /** What the person typed after the probe name (`probe deps who vitest` hands `["vitest"]`). */
175
+ args?: readonly string[];
176
+ /** `--dry-run`: `write` calls are announced and skipped. */
177
+ dryRun: boolean;
178
+ /** Report one line. The text is scrubbed of secrets before it is printed. */
179
+ say(row: ProbeRow): void;
180
+ /**
181
+ * Change something on the provider. The only way to: on `--dry-run` it prints `would <label>` and does not call `fn`,
182
+ * and a probe that did not declare `writes: true` cannot call it.
183
+ */
184
+ write<T>(label: string, fn: () => Promise<T>): Promise<T | undefined>;
185
+ /** Register how to undo something this probe made. Runs in reverse order on success, failure and Ctrl-C. */
186
+ cleanup(label: string, fn: () => Promise<void>): void;
187
+ /** Mark a value (a token, a signing secret) as one that must never be printed. */
188
+ secret(value: string | undefined): void;
189
+ }
190
+ interface Probe {
191
+ /** One sentence for `holocron probe`'s listing. */
192
+ summary: string;
193
+ /** Whether it creates or changes anything on the provider. Asked about first, and needs `--yes` without a terminal. */
194
+ writes: boolean;
195
+ run(ctx: ProbeContext): Promise<void>;
196
+ }
197
+ /** A plugin's probes by name (kebab-case), as returned from `createPlugin` next to `capabilities`. */
198
+ type PluginProbes = Record<string, Probe>;
199
+ export interface ConnectionProbeInput {
200
+ /** How the provider is named in output, e.g. `Axiom`. */
201
+ provider: string;
202
+ /** A URL on the provider's API host. Without one, only the token is checked (a provider that has no HTTP API of its own). */
203
+ url?: string;
204
+ /** Finds the token the plugin would use. Throws with a message that says where to put one when there is none. */
205
+ token: () => string | Promise<string>;
206
+ /** The plugin's `verifyToken`: asks the provider who the token belongs to. */
207
+ verify: (token: string) => Promise<VerifyTokenResult>;
208
+ /** Stands in for the network, so with one the name lookup (which cannot be stood in for) is not made. */
209
+ fetch?: typeof fetch;
210
+ /** Resolves a hostname. Defaults to the system resolver, unless `fetch` is given. */
211
+ lookup?: (host: string) => Promise<{
212
+ address: string;
213
+ }>;
214
+ /** Longest to wait for the host to answer. Defaults to 10 s. */
215
+ timeoutMs?: number;
216
+ }
217
+ /** A network failure in plain words, with what usually causes it. Never includes anything from a request. */
218
+ export declare function describeNetworkError(err: unknown, timeoutMs: number): string;
219
+ /**
220
+ * The `connection` probe every provider offers, for telling a network problem from a credential problem: does the name
221
+ * resolve, does the host answer, is there a token, and does the provider accept it. A step that cannot work because an
222
+ * earlier one failed is reported as not tried rather than failing a second time for the same reason.
223
+ */
224
+ export declare function connectionProbe(input: ConnectionProbeInput): Probe;
225
+ export { Analytics, type AppConfig, Auth, AuthDescription, AuthError, AuthEvent, AuthEventType, AuthIdentity, AuthUser, CARDINALITY, type Capability, type CapabilityConfigPackage, CapabilityImpls, CapabilityKey, Cardinality, CardinalityFor, type ChromaticProjectConfig, Ci, CiRun, CiRunFilter, CiRunStatus, type ComposedPreset, ConfigError, ConfigFileError, ConnectionStringOptions, CreateAuthUserInput, DeployFunctionConfig, DeployFunctionResult, DeployScriptConfig, DeployScriptResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, type DeriveProfileInput, Dns, DnsRecord, DnsRecordRequest, DnsRecordType, type DocsConfig, type DoctorConfig, ElevationRequiredError, EnsureRelayInput, EnsureRelayResult, EnsureResult, EnsureWebhookResult, EnsuredResource, type EnvConfig, Environment, EnvironmentReviewer, Environments, Errors, type EslintConfig, type FeatureResolverConfig, type HolocronConfig, type HolocronProfile, Issue, IssueSearchFilter, Issues, LabelDef, LifecycleResult, LifecycleSlot, type LoadedConfig, type LogConfig, Logs, Monitoring, MonitoringAlertChannelInput, MonitoringAlertChannelResult, MonitoringAssertion, MonitoringAssertionComparison, MonitoringAssertionSource, MonitoringCheck, MonitoringCheckInput, MonitoringHttpMethod, type MultiEntry, NormalizedAuthUser, Notifications, NotificationsAccess, NotificationsApplicationLayout, NotificationsChannelLayout, NotificationsDelivery, NotificationsEveryoneLayout, NotificationsLayout, NotificationsLinksLayout, NotificationsMember, NotificationsOnboardingLayout, NotificationsPinnedLayout, NotificationsServerLayout, NotificationsSignIn, NotificationsSignedIn, NotificationsWelcomeLayout, type PackageJsonLike, PagesConfig, ParseWebhookInput, type PluginProbes, type Probe, type ProbeContext, type ProbeRow, ProviderApiError, ProviderIdentity, type ProviderOptions, PullRequest, REQUIRED_CAPABILITIES, type RawProviderEntry, type RawProvidersConfig, type RepoConfig, type RepoProperties, type RepoProtection, RepoRef, RepoSettings, type RepoVariables, type RequestOptions, type ResolveTokenConfig, type ResolveTokenInput, ResolvedCapability, type ResolvedHolocronConfig, type ResolvedProviderEntry, type ResolvedProvidersConfig, type ResolvedTuple, type RestClient, type RestClientConfig, Ruleset, SecretScope, Secrets, ServerInspection, type SingleEntry, Source, SourceFile, SourceTeamMember, StatusCategory, Storage, StorageBranch, type StorybookDeployProject, type TaskEntry, type TaskEntryConfig, TeamEntry, TeamPermission, type TelemetryConfig, Tooling, ToolingDoctorReport, TrackerDoctorReport, TrackerUser, Vault, type VerifyTokenFailure, type VerifyTokenResult, type VerifyTokenSuccess, WebhookDashboardInfo, WebhookVerificationError, Wiki, WikiProvisionOpts, WikiProxyConfig, Workers, type WorkflowWithConfig, compose, createRestClient, isMulti, resolveConfig, resolveEntry, resolvePluginPackage };