@theholocron/vercel-client 1.22.0 → 1.24.0

package/README.md

@@ -63,6 +63,16 @@ const fnDeployment = await vercel.deployments.create({
 
 // Poll deployment status
 const status = await vercel.deployments.get(deployment.id);
+
+// List a project's custom domains
+const { domains } = await vercel.domains.list("project-id");
+
+// Add a custom domain — the CNAME target is generated per-project by
+// Vercel, not a fixed well-known host; always read it from the response
+const added = await vercel.domains.add("project-id", "sentinel.example.com");
+if (!added.verified) {
+  console.log(added.verification); // [{ type: "CNAME", domain, value }]
+}
 ```
 
 ## Status

package/dist/index.d.mts

@@ -54,6 +54,60 @@ interface VercelCreateDeploymentInput {
   target?: VercelDeploymentTarget;
 }
 //#endregion
+//#region src/domains/domains.d.ts
+interface VercelDomain {
+  name: string;
+  apexName: string;
+  verified: boolean;
+}
+interface VercelDomainsResponse {
+  domains: VercelDomain[];
+}
+/**
+ * One DNS verification challenge — complete any one of these (usually
+ * just one is returned) to prove ownership. `type: "CNAME"` means
+ * `domain` needs a CNAME record pointing at `value`; `type: "TXT"`
+ * means a TXT record on `domain` with content `value`. The CNAME
+ * target is generated per-project by Vercel, not a fixed well-known
+ * host — always read it from this response, never hardcode it.
+ */
+interface VercelDomainVerification {
+  type: string;
+  domain: string;
+  value: string;
+  reason: string;
+}
+interface VercelAddDomainResult {
+  name: string;
+  apexName: string;
+  verified: boolean;
+  verification?: VercelDomainVerification[];
+}
+/** One ranked CNAME/IPv4 recommendation — `rank: 1` is the preferred value. */
+interface VercelDomainConfigRecommendation<T> {
+  rank: number;
+  value: T;
+}
+/**
+ * DNS *routing* status for a domain — distinct from ownership (`verified`
+ * on `VercelDomain`/`VercelAddDomainResult`). A domain can be verified
+ * (Vercel trusts you own it) with no record actually pointing traffic at
+ * Vercel yet, e.g. re-adding a domain whose apex is already verified on
+ * this team short-circuits to `verified: true` with no `verification`
+ * challenge (`domains.add` returns 409, not a fresh challenge) — this is
+ * the only source for that domain's CNAME target in that case.
+ */
+interface VercelDomainConfig {
+  /** How Vercel currently sees the domain resolving. `null` = not resolving to Vercel at all. */
+  configuredBy: "A" | "CNAME" | "http" | "dns-01" | null;
+  /** `false` once DNS is correctly configured and a TLS cert can be issued. */
+  misconfigured: boolean;
+  /** Recommended CNAME target(s) for a subdomain, ranked; `[0]` is preferred. Per-project, never a fixed host. */
+  recommendedCNAME: VercelDomainConfigRecommendation<string>[];
+  /** Recommended A-record IPv4(s) for an apex domain, ranked. */
+  recommendedIPv4: VercelDomainConfigRecommendation<string[]>[];
+}
+//#endregion
 //#region src/env/env.d.ts
 type VercelEnvTarget = "production" | "preview" | "development";
 interface VercelEnvVar {
@@ -113,6 +167,11 @@ declare function createVercelClient(opts: VercelClientOptions): {
     create: (input: VercelCreateDeploymentInput) => Promise<VercelDeployment>;
     get: (deploymentId: string) => Promise<VercelDeployment>;
   };
+  domains: {
+    list: (projectId: string) => Promise<VercelDomainsResponse>;
+    add: (projectId: string, name: string) => Promise<VercelAddDomainResult>;
+    config: (domain: string, projectIdOrName?: string) => Promise<VercelDomainConfig>;
+  };
   env: {
     list: (projectId: string) => Promise<VercelEnvVarsResponse>;
     set: (projectId: string, target: VercelEnvTarget, name: string, value: string) => Promise<VercelEnvVar>;
@@ -129,4 +188,4 @@ declare function createVercelClient(opts: VercelClientOptions): {
 };
 type VercelClient = ReturnType<typeof createVercelClient>;
 //#endregion
-export { VercelClient, type VercelClientOptions, type VercelCreateDeploymentInput, type VercelCreateProjectInput, type VercelDeployFile, type VercelDeployment, type VercelDeploymentState, type VercelDeploymentTarget, type VercelEnvTarget, type VercelEnvVar, type VercelEnvVarsResponse, type VercelProject, type VercelProjectLink, type VercelProjectsResponse, type VercelTriggerDeploymentInput, type VercelUpdateProjectInput, type VercelUser, type VercelUserResponse, createVercelClient };
+export { type VercelAddDomainResult, VercelClient, type VercelClientOptions, type VercelCreateDeploymentInput, type VercelCreateProjectInput, type VercelDeployFile, type VercelDeployment, type VercelDeploymentState, type VercelDeploymentTarget, type VercelDomain, type VercelDomainConfig, type VercelDomainConfigRecommendation, type VercelDomainVerification, type VercelDomainsResponse, type VercelEnvTarget, type VercelEnvVar, type VercelEnvVarsResponse, type VercelProject, type VercelProjectLink, type VercelProjectsResponse, type VercelTriggerDeploymentInput, type VercelUpdateProjectInput, type VercelUser, type VercelUserResponse, createVercelClient };

package/dist/index.mjs

@@ -37,6 +37,25 @@ function deployments(rest) {
 	};
 }
 //#endregion
+//#region src/domains/domains.ts
+function domains(rest) {
+	return {
+		list: (projectId) => rest.request(`/v9/projects/${encodeURIComponent(projectId)}/domains`),
+		add: (projectId, name) => rest.request(`/v10/projects/${encodeURIComponent(projectId)}/domains`, {
+			method: "POST",
+			body: { name }
+		}),
+		/**
+		* DNS routing status for `domain` — works regardless of whether the
+		* domain is already attached/verified on a project. `projectIdOrName`
+		* is optional per Vercel's docs ("use this when the domain is not yet
+		* associated with a project") but passed through when known to scope
+		* the recommendation to that project.
+		*/
+		config: (domain, projectIdOrName) => rest.request(`/v6/domains/${encodeURIComponent(domain)}/config`, { query: projectIdOrName ? { projectIdOrName } : void 0 })
+	};
+}
+//#endregion
 //#region src/env/env.ts
 function env(rest) {
 	return {
@@ -109,6 +128,7 @@ function createVercelClient(opts) {
 	const rest = createVercelRestClient(opts);
 	return {
 		deployments: deployments(rest),
+		domains: domains(rest),
 		env: env(rest),
 		projects: projects(rest),
 		user: user(rest)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/vercel-client",
-  "version": "1.22.0",
+  "version": "1.24.0",
   "description": "A TypeScript client for the Vercel API",
   "keywords": [
     "vercel",
@@ -33,7 +33,7 @@
   ],
   "dependencies": {
     "@theholocron/observability": "^0.3.0",
-    "@theholocron/http-client": "^1.22.0"
+    "@theholocron/http-client": "^1.24.0"
   },
   "devDependencies": {
     "@theholocron/cli": "5.0.0-alpha.3",