@theholocron/holocron-plugin-vercel 5.0.0-alpha.27 → 5.0.0-alpha.29

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.
Files changed (4) hide show
  1. package/README.md +21 -7
  2. package/dist/index.d.mts +24 -14
  3. package/dist/index.mjs +41 -14
  4. package/package.json +6 -6
package/README.md CHANGED
@@ -64,13 +64,27 @@ Capability covers:
64
64
  an app) — `defaultFramework` only applies to `ensureProject()`'s
65
65
  Git-linked path.
66
66
  - `getDeployment()` — fetch a deployment by id
67
- - `ensureCustomDomain()` — idempotent add (list → check → add). Adding
68
- a domain new to the Vercel account returns `verified: false` with a
69
- DNS verification challenge (usually a CNAME to a per-project target
70
- Vercel generates — never a fixed well-known host); this method only
71
- adds the domain, reading the challenge to finish DNS setup is the
72
- caller's own job today (no `Wiki.dnsRecord()`-style shared surface
73
- for it yet)
67
+ - `ensureCustomDomain()` — idempotent add (list → add-if-missing →
68
+ check DNS routing). Ownership (`verified`) and DNS routing are
69
+ separate: once a team already owns a domain's apex, every new
70
+ subdomain auto-verifies immediately with no fresh challenge, so
71
+ attachment alone can't tell you whether traffic is actually routed
72
+ to Vercel yet. `domains.config()` answers that regardless of
73
+ ownership state, returning a per-project CNAME target — never a
74
+ fixed well-known host — only when DNS isn't already configured. The
75
+ returned DNS record is handed to the configured `dns` provider by
76
+ `holocron setup`.
77
+
78
+ Declare the production domain in the Vercel provider options. On `holocron setup`,
79
+ the domain is attached to the project and any Vercel verification CNAME is
80
+ upserted through the configured DNS provider:
81
+
82
+ ```ts
83
+ providers: {
84
+ deployment: ["vercel", { teamId: "team_…", domain: "sentinel.example.com" }],
85
+ dns: "cloudflare",
86
+ }
87
+ ```
74
88
 
75
89
  Out of scope for alpha.0 (file a follow-up if needed):
76
90
 
package/dist/index.d.mts CHANGED
@@ -1,4 +1,4 @@
1
- import { AuthError, DeployFunctionConfig, DeployFunctionResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, ResolveTokenInput } from "@theholocron/cli";
1
+ import { AuthError, DeployFunctionConfig, DeployFunctionResult, Deployment, DeploymentProject, DeploymentProjectSettings, DeploymentRecord, DeploymentTarget, DeploymentTrigger, DnsRecordRequest, ResolveTokenInput } from "@theholocron/cli";
2
2
  import { VercelClient, VercelClient as VercelClient$1, VercelClientOptions, createVercelClient } from "@theholocron/vercel-client";
3
3
  //#region src/auth.d.ts
4
4
  declare const resolveToken: (input?: ResolveTokenInput) => string;
@@ -7,11 +7,14 @@ declare const resolveToken: (input?: ResolveTokenInput) => string;
7
7
  interface DeploymentOptions {
8
8
  /** Optional framework hint passed to project creates. Defaults to "nextjs". */
9
9
  defaultFramework?: string;
10
+ /** Custom domain that `holocron setup` should attach to this project. */
11
+ domain?: string;
10
12
  }
11
13
  declare class VercelDeployment implements Deployment {
12
14
  private readonly client;
13
15
  readonly key: "deployment";
14
16
  readonly providerName = "vercel";
17
+ readonly domain?: string;
15
18
  private readonly defaultFramework;
16
19
  constructor(client: () => VercelClient$1, opts?: DeploymentOptions);
17
20
  listProjects(): Promise<DeploymentProject[]>;
@@ -32,20 +35,25 @@ declare class VercelDeployment implements Deployment {
32
35
  getDeployment(deploymentId: string): Promise<DeploymentRecord>;
33
36
  deployFunction(projectId: string, config: DeployFunctionConfig): Promise<DeployFunctionResult>;
34
37
  /**
35
- * Idempotent — no-op when `hostname` is already on the project,
36
- * matching `Deployment.ensureCustomDomain`'s contract (never break
37
- * on re-runs, per CLAUDE.md's probe-then-act standard). Adding it
38
- * the first time returns `verified: false` for a domain new to this
39
- * Vercel account — Vercel needs a DNS record (usually CNAME, a
40
- * unique per-project target) created before it routes traffic. This
41
- * method only adds the domain; reading the verification challenge
42
- * needed to finish is the caller's job (`client().domains.add()`'s
43
- * own return value carries it) — Sentinel has no `holocron setup`
44
- * orchestration to hand it to, so there's no shared "here's the DNS
45
- * record" surface to route it through the way `Wiki.dnsRecord()`
46
- * does today.
38
+ * Idempotent — matches `Deployment.ensureCustomDomain`'s contract
39
+ * (never break on re-runs, per CLAUDE.md's probe-then-act standard).
40
+ *
41
+ * Ownership (`domains.add`'s `verified`) and DNS routing are separate
42
+ * concerns: once a team already owns the domain's apex (true for any
43
+ * org with more than one project on the same domain), every new
44
+ * subdomain auto-verifies immediately with no `verification`
45
+ * challenge — re-adding an already-attached domain returns 409, not
46
+ * a fresh one. So attachment alone can't tell us whether traffic is
47
+ * actually routed to Vercel yet. `domains.config()` (Vercel's DNS
48
+ * *configuration* check) answers that regardless of ownership state:
49
+ * `misconfigured` + a `recommendedCNAME`, per-project, never a fixed
50
+ * well-known host — always read it from this response, never
51
+ * hardcode it. Returned as a `DnsRecordRequest` — the caller (e.g.
52
+ * `holocron setup`'s custom-domain step) hands it straight to
53
+ * `dns.upsertRecord()`, same as `Wiki.dnsRecord()` already does for
54
+ * the wiki's own domain.
47
55
  */
48
- ensureCustomDomain(projectId: string, hostname: string): Promise<void>;
56
+ ensureCustomDomain(projectId: string, hostname: string): Promise<DnsRecordRequest | null>;
49
57
  private getProjectByName;
50
58
  }
51
59
  //#endregion
@@ -76,6 +84,8 @@ interface VercelPluginOptions extends ResolveTokenInput {
76
84
  teamId?: string;
77
85
  /** Default framework slug for new project creates. Defaults to "nextjs". */
78
86
  defaultFramework?: string;
87
+ /** Custom domain that `holocron setup` should attach to the Vercel project. */
88
+ domain?: string;
79
89
  /** Override base URL for tests. */
80
90
  baseUrl?: string;
81
91
  /** Override `fetch` for tests. */
package/dist/index.mjs CHANGED
@@ -13,10 +13,12 @@ var VercelDeployment = class {
13
13
  client;
14
14
  key = "deployment";
15
15
  providerName = "vercel";
16
+ domain;
16
17
  defaultFramework;
17
18
  constructor(client, opts = {}) {
18
19
  this.client = client;
19
20
  this.defaultFramework = opts.defaultFramework ?? "nextjs";
21
+ this.domain = opts.domain;
20
22
  }
21
23
  async listProjects() {
22
24
  const { projects } = await this.client().projects.list();
@@ -76,23 +78,47 @@ var VercelDeployment = class {
76
78
  };
77
79
  }
78
80
  /**
79
- * Idempotent — no-op when `hostname` is already on the project,
80
- * matching `Deployment.ensureCustomDomain`'s contract (never break
81
- * on re-runs, per CLAUDE.md's probe-then-act standard). Adding it
82
- * the first time returns `verified: false` for a domain new to this
83
- * Vercel account — Vercel needs a DNS record (usually CNAME, a
84
- * unique per-project target) created before it routes traffic. This
85
- * method only adds the domain; reading the verification challenge
86
- * needed to finish is the caller's job (`client().domains.add()`'s
87
- * own return value carries it) — Sentinel has no `holocron setup`
88
- * orchestration to hand it to, so there's no shared "here's the DNS
89
- * record" surface to route it through the way `Wiki.dnsRecord()`
90
- * does today.
81
+ * Idempotent — matches `Deployment.ensureCustomDomain`'s contract
82
+ * (never break on re-runs, per CLAUDE.md's probe-then-act standard).
83
+ *
84
+ * Ownership (`domains.add`'s `verified`) and DNS routing are separate
85
+ * concerns: once a team already owns the domain's apex (true for any
86
+ * org with more than one project on the same domain), every new
87
+ * subdomain auto-verifies immediately with no `verification`
88
+ * challenge — re-adding an already-attached domain returns 409, not
89
+ * a fresh one. So attachment alone can't tell us whether traffic is
90
+ * actually routed to Vercel yet. `domains.config()` (Vercel's DNS
91
+ * *configuration* check) answers that regardless of ownership state:
92
+ * `misconfigured` + a `recommendedCNAME`, per-project, never a fixed
93
+ * well-known host — always read it from this response, never
94
+ * hardcode it. Returned as a `DnsRecordRequest` — the caller (e.g.
95
+ * `holocron setup`'s custom-domain step) hands it straight to
96
+ * `dns.upsertRecord()`, same as `Wiki.dnsRecord()` already does for
97
+ * the wiki's own domain.
91
98
  */
92
99
  async ensureCustomDomain(projectId, hostname) {
93
100
  const { domains: existing } = await this.client().domains.list(projectId);
94
- if (existing.some((d) => d.name === hostname)) return;
95
- await this.client().domains.add(projectId, hostname);
101
+ let apexName = existing.find((d) => d.name === hostname)?.apexName;
102
+ if (!apexName) try {
103
+ apexName = (await this.client().domains.add(projectId, hostname)).apexName;
104
+ } catch (err) {
105
+ if (!(err instanceof ProviderApiError && err.status === 409)) throw err;
106
+ const { domains: refreshed } = await this.client().domains.list(projectId);
107
+ apexName = refreshed.find((d) => d.name === hostname)?.apexName;
108
+ }
109
+ if (!apexName) return null;
110
+ const config = await this.client().domains.config(hostname, projectId);
111
+ if (!config.misconfigured) return null;
112
+ const cname = config.recommendedCNAME[0]?.value;
113
+ if (!cname) return null;
114
+ return {
115
+ zone: apexName,
116
+ record: {
117
+ type: "CNAME",
118
+ name: hostname,
119
+ content: cname
120
+ }
121
+ };
96
122
  }
97
123
  async getProjectByName(name) {
98
124
  try {
@@ -176,6 +202,7 @@ function createContext(options = {}) {
176
202
  function deployment(ctx) {
177
203
  const opts = {};
178
204
  if (ctx.options.defaultFramework !== void 0) opts.defaultFramework = ctx.options.defaultFramework;
205
+ if (ctx.options.domain !== void 0) opts.domain = ctx.options.domain;
179
206
  return new VercelDeployment(ctx.client, opts);
180
207
  }
181
208
  function createPlugin(options = {}) {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@theholocron/holocron-plugin-vercel",
3
- "version": "5.0.0-alpha.27",
3
+ "version": "5.0.0-alpha.29",
4
4
  "description": "Holocron plugin for Vercel. Implements the deployment capability against the Vercel REST API.",
5
5
  "keywords": [
6
6
  "deployment",
@@ -31,10 +31,10 @@
31
31
  ],
32
32
  "devDependencies": {
33
33
  "@theholocron/eslint-config": "^8.0.0",
34
- "@theholocron/http-client": "^1.23.0",
34
+ "@theholocron/http-client": "^1.24.0",
35
35
  "@theholocron/tsconfig": "^8.0.0",
36
36
  "@theholocron/tsdown-config": "^8.0.0",
37
- "@theholocron/vercel-client": "^1.23.0",
37
+ "@theholocron/vercel-client": "^1.24.0",
38
38
  "@theholocron/vitest-config": "^8.0.0",
39
39
  "@types/node": "^26",
40
40
  "@vitest/coverage-v8": "^4.1.11",
@@ -46,11 +46,11 @@
46
46
  "tsx": "4.23.12",
47
47
  "typescript": "^5.9.3",
48
48
  "vitest": "^4.1.11",
49
- "@theholocron/cli": "5.0.0-alpha.27"
49
+ "@theholocron/cli": "5.0.0-alpha.29"
50
50
  },
51
51
  "peerDependencies": {
52
- "@theholocron/vercel-client": "^1.23.0",
53
- "@theholocron/cli": "5.0.0-alpha.27"
52
+ "@theholocron/vercel-client": "^1.24.0",
53
+ "@theholocron/cli": "5.0.0-alpha.29"
54
54
  },
55
55
  "peerDependenciesMeta": {
56
56
  "@theholocron/vercel-client": {}