alchemy 0.16.7 → 0.16.8

package/lib/vercel/project.js

@@ -0,0 +1,170 @@
+import { Resource } from "../resource.js";
+import { isSecret } from "../secret.js";
+import { createVercelApi } from "./api.js";
+const decryptEnvironmentVariable = (envVar) => {
+    let { type, value } = envVar;
+    // Decrypt Secret & default `type`
+    if (isSecret(value)) {
+        value = value.unencrypted;
+        type ??= "encrypted";
+    }
+    else {
+        // Otherwise, default to `plain`
+        type ??= "plain";
+    }
+    return { ...envVar, type, value };
+};
+/**
+ * Create and manage Vercel projects.
+ *
+ * @example
+ * // With accessToken
+ * const project = await Project("my-app", {
+ *   accessToken: alchemy.secret(process.env.VERCEL_ACCESS_TOKEN),
+ *   name: "my-app",
+ *   framework: "astro",
+ * });
+ *
+ * @example
+ * // With GitHub
+ * const project = await Project("my-app", {
+ *   name: "my-app",
+ *   framework: "nextjs",
+ *   gitRepository: {
+ *     type: "github",
+ *     repo: "username/my-app",
+ *   },
+ * });
+ *
+ * @example
+ * // With plain text environment variable
+ * const project = await Project("my-app", {
+ *   name: "my-app",
+ *   environmentVariables: [
+ *     {
+ *       key: "PUBLIC_URL",
+ *       target: ["production", "preview", "development"],
+ *       value: "https://example.com",
+ *     },
+ *   ],
+ * });
+ *
+ * @example
+ * // With encrypted environment variable
+ * const project = await Project("my-app", {
+ *   name: "my-app",
+ *   environmentVariables: [
+ *     {
+ *       key: "DATABASE_URL",
+ *       target: ["production", "preview"],
+ *       value: alchemy.secret("DATABASE_URL"),
+ *     },
+ *   ],
+ * });
+ *
+ * @example
+ * // With sensitive environment variable
+ * const project = await Project("my-app", {
+ *   name: "my-app",
+ *   environmentVariables: [
+ *     {
+ *       key: "DATABASE_URL",
+ *       target: ["production", "preview"],
+ *       type: "sensitive",
+ *       value: alchemy.secret("DATABASE_URL"),
+ *     },
+ *   ],
+ * });
+ *
+ * @example
+ * // With custom build settings
+ * const project = await Project("my-app", {
+ *   name: "my-app",
+ *   buildCommand: "npm run build",
+ *   outputDirectory: "dist",
+ *   installCommand: "npm install",
+ *   devCommand: "npm run dev",
+ * });
+ */
+export const Project = Resource("vercel::Project", async function (id, { accessToken, ...props }) {
+    switch (this.phase) {
+        case "delete": {
+            const api = await createVercelApi({
+                baseUrl: "https://api.vercel.com/v9",
+                accessToken,
+            });
+            try {
+                if (this.output?.id) {
+                    await api.delete(`/projects/${this.output.id}`);
+                }
+            }
+            catch (error) {
+                console.error("Error deleting project:", error);
+            }
+            return this.destroy();
+        }
+        case "update": {
+            const api = await createVercelApi({
+                baseUrl: "https://api.vercel.com/v9",
+                accessToken,
+            });
+            if (!this.output?.id) {
+                throw new Error(`Cannot update project ${id}: missing previous output.id`);
+            }
+            // 409 Conflict: Can't update name, so remove it from the props
+            // 400 Invalid Request: Should NOT have additional property `environmentVariables`
+            const { name, environmentVariables, ...rest } = props;
+            const response = await api.patch(`/projects/${this.output.id}`, rest);
+            const data = (await response.json());
+            if (environmentVariables) {
+                const envApi = await createVercelApi({
+                    baseUrl: "https://api.vercel.com/v10",
+                    accessToken,
+                });
+                await updateEnvironmentVariables(envApi, this.output, props);
+            }
+            return this({
+                id: data.id,
+                accountId: data.accountId,
+                createdAt: data.createdAt,
+                updatedAt: data.updatedAt,
+                latestDeployment: data.latestDeployment,
+                ...props,
+            });
+        }
+        case "create": {
+            const api = await createVercelApi({
+                baseUrl: "https://api.vercel.com/v11",
+                accessToken,
+            });
+            const project = await createProject(api, props);
+            return this.create({ ...props, ...project });
+        }
+    }
+});
+export async function createProject(api, props) {
+    const response = await api.post("/projects", {
+        ...props,
+        environmentVariables: props.environmentVariables?.map(decryptEnvironmentVariable),
+    });
+    const data = (await response.json());
+    return data;
+}
+export async function updateEnvironmentVariables(api, output, props) {
+    if (!props.environmentVariables) {
+        return;
+    }
+    // Update explicitly set environment variables
+    await api.post(`/projects/${output.id}/env?upsert=true`, props.environmentVariables.map(decryptEnvironmentVariable));
+    // Find previous env vars that are not in the new list and delete them
+    const { envs } = (await api
+        .get(`/projects/${output.id}/env`)
+        .then((res) => res.json()));
+    for (const previousEnv of envs) {
+        if (props.environmentVariables.some((envVar) => envVar.key === previousEnv.key)) {
+            continue;
+        }
+        await api.delete(`/projects/${output.id}/env/${previousEnv.id}`);
+    }
+}
+//# sourceMappingURL=project.js.map

package/lib/vercel/project.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"project.js","sourceRoot":"","sources":["../../src/vercel/project.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,QAAQ,EAAe,MAAM,cAAc,CAAC;AACrD,OAAO,EAAE,eAAe,EAAkB,MAAM,UAAU,CAAC;AAiR3D,MAAM,0BAA0B,GAAG,CAAC,MAA2B,EAAE,EAAE;IACjE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,MAAM,CAAC;IAE7B,kCAAkC;IAClC,IAAI,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QACpB,KAAK,GAAG,KAAK,CAAC,WAAW,CAAC;QAC1B,IAAI,KAAK,WAAW,CAAC;IACvB,CAAC;SAAM,CAAC;QACN,gCAAgC;QAChC,IAAI,KAAK,OAAO,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,GAAG,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC;AACpC,CAAC,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuEG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAC7B,iBAAiB,EACjB,KAAK,WAEH,EAAU,EACV,EAAE,WAAW,EAAE,GAAG,KAAK,EAA2C;IAElE,QAAQ,IAAI,CAAC,KAAK,EAAE,CAAC;QACnB,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC;gBAChC,OAAO,EAAE,2BAA2B;gBACpC,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC;gBACH,IAAI,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;oBACpB,MAAM,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;gBAClD,CAAC;YACH,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,OAAO,CAAC,KAAK,CAAC,yBAAyB,EAAE,KAAK,CAAC,CAAC;YAClD,CAAC;YAED,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACxB,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC;gBAChC,OAAO,EAAE,2BAA2B;gBACpC,WAAW;aACZ,CAAC,CAAC;YAEH,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,EAAE,CAAC;gBACrB,MAAM,IAAI,KAAK,CACb,yBAAyB,EAAE,8BAA8B,CAC1D,CAAC;YACJ,CAAC;YAED,+DAA+D;YAC/D,kFAAkF;YAClF,MAAM,EAAE,IAAI,EAAE,oBAAoB,EAAE,GAAG,IAAI,EAAE,GAAG,KAAK,CAAC;YACtD,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,KAAK,CAAC,aAAa,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EAAE,IAAI,CAAC,CAAC;YACtE,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAY,CAAC;YAEhD,IAAI,oBAAoB,EAAE,CAAC;gBACzB,MAAM,MAAM,GAAG,MAAM,eAAe,CAAC;oBACnC,OAAO,EAAE,4BAA4B;oBACrC,WAAW;iBACZ,CAAC,CAAC;gBAEH,MAAM,0BAA0B,CAAC,MAAM,EAAE,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;YAC/D,CAAC;YAED,OAAO,IAAI,CAAC;gBACV,EAAE,EAAE,IAAI,CAAC,EAAE;gBACX,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,gBAAgB,EAAE,IAAI,CAAC,gBAAgB;gBACvC,GAAG,KAAK;aACT,CAAC,CAAC;QACL,CAAC;QAED,KAAK,QAAQ,CAAC,CAAC,CAAC;YACd,MAAM,GAAG,GAAG,MAAM,eAAe,CAAC;gBAChC,OAAO,EAAE,4BAA4B;gBACrC,WAAW;aACZ,CAAC,CAAC;YAEH,MAAM,OAAO,GAAG,MAAM,aAAa,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC;YAEhD,OAAO,IAAI,CAAC,MAAM,CAAC,EAAE,GAAG,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;QAC/C,CAAC;IACH,CAAC;AACH,CAAC,CACF,CAAC;AAEF,MAAM,CAAC,KAAK,UAAU,aAAa,CAAC,GAAc,EAAE,KAAmB;IACrE,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE;QAC3C,GAAG,KAAK;QACR,oBAAoB,EAAE,KAAK,CAAC,oBAAoB,EAAE,GAAG,CACnD,0BAA0B,CAC3B;KACF,CAAC,CAAC;IAEH,MAAM,IAAI,GAAG,CAAC,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAY,CAAC;IAEhD,OAAO,IAAI,CAAC;AACd,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAC9C,GAAc,EACd,MAAe,EACf,KAAmB;IAEnB,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;QAChC,OAAO;IACT,CAAC;IAED,8CAA8C;IAC9C,MAAM,GAAG,CAAC,IAAI,CACZ,aAAa,MAAM,CAAC,EAAE,kBAAkB,EACxC,KAAK,CAAC,oBAAoB,CAAC,GAAG,CAAC,0BAA0B,CAAC,CAC3D,CAAC;IAEF,sEAAsE;IACtE,MAAM,EAAE,IAAI,EAAE,GAAG,CAAC,MAAM,GAAG;SACxB,GAAG,CAAC,aAAa,MAAM,CAAC,EAAE,MAAM,CAAC;SACjC,IAAI,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,EAAE,CAAC,CAE3B,CAAC;IAEF,KAAK,MAAM,WAAW,IAAI,IAAI,EAAE,CAAC;QAC/B,IACE,KAAK,CAAC,oBAAoB,CAAC,IAAI,CAC7B,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,GAAG,KAAK,WAAW,CAAC,GAAG,CAC3C,EACD,CAAC;YACD,SAAS;QACX,CAAC;QAED,MAAM,GAAG,CAAC,MAAM,CAAC,aAAa,MAAM,CAAC,EAAE,QAAQ,WAAW,CAAC,EAAE,EAAE,CAAC,CAAC;IACnE,CAAC;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "alchemy",
-  "version": "0.16.7",
+  "version": "0.16.8",
   "type": "module",
   "module": "./lib/index.js",
   "scripts": {
@@ -28,6 +28,7 @@
     "./stripe": "./lib/stripe/index.js",
     "./test/bun": "./lib/test/bun.js",
     "./upstash": "./lib/upstash/index.js",
+    "./vercel": "./lib/vercel/index.js",
     "./web/astro": "./lib/web/astro/index.js",
     "./web/tailwind": "./lib/web/tailwind/index.js",
     "./web/vite": "./lib/web/vite/index.js",

package/src/vercel/api.ts

@@ -0,0 +1,163 @@
+import { alchemy } from "../alchemy.js";
+import type { Secret } from "../secret.js";
+
+/**
+ * Options for Vercel API requests
+ */
+export interface VercelApiOptions {
+  /**
+   * Base URL for API
+   */
+  baseUrl: string;
+
+  /**
+   * API access token to use (overrides environment variable)
+   */
+  accessToken?: Secret;
+}
+
+/**
+ * Creates a VercelApi instance with automatic token validation
+ *
+ * @param options API options
+ * @returns Promise resolving to a VercelApi instance
+ */
+export async function createVercelApi(
+  options: VercelApiOptions,
+): Promise<VercelApi> {
+  const {
+    accessToken = await alchemy.secret.env.VERCEL_ACCESS_TOKEN,
+    baseUrl,
+  } = options;
+
+  return new VercelApi({
+    baseUrl,
+    accessToken,
+  });
+}
+
+/**
+ * Vercel API client using raw fetch
+ */
+export class VercelApi {
+  /** Base URL for API */
+  readonly baseUrl: string;
+
+  /** API access token */
+  readonly accessToken: Secret;
+
+  /**
+   * Create a new API client
+   * Use createVercelApi factory function instead of direct constructor
+   * for automatic token validation.
+   *
+   * @param options API options
+   */
+  constructor(options: VercelApiOptions & { accessToken: Secret }) {
+    this.baseUrl = options.baseUrl;
+    this.accessToken = options.accessToken;
+  }
+
+  /**
+   * Make a request to the API
+   *
+   * @param path API path (without base URL)
+   * @param init Fetch init options
+   * @returns Raw Response object from fetch
+   */
+  async fetch(path: string, init: RequestInit = {}): Promise<Response> {
+    // Set up authentication headers
+    const headers: Record<string, string> = {
+      "Content-Type": "application/json",
+      Authorization: `Bearer ${this.accessToken.unencrypted}`,
+    };
+
+    // Add headers from init if provided
+    if (init.headers) {
+      const initHeaders = init.headers as Record<string, string>;
+      Object.keys(initHeaders).forEach((key) => {
+        headers[key] = initHeaders[key];
+      });
+    }
+
+    // For FormData, remove Content-Type
+    if (init.body instanceof FormData) {
+      delete headers["Content-Type"];
+    }
+
+    const response = await fetch(`${this.baseUrl}${path}`, {
+      ...init,
+      headers,
+    });
+
+    if (!response.ok) {
+      let error = new Error(`API error: ${response.statusText}`, {
+        cause: response,
+      });
+
+      try {
+        error = Object.assign(
+          new Error(response.statusText, { cause: response }),
+          ((await response.json()) as { error: Error })?.error,
+        );
+      } finally {
+        throw error;
+      }
+    }
+
+    return response;
+  }
+
+  /**
+   * Helper for GET requests
+   */
+  async get(path: string, init: RequestInit = {}): Promise<Response> {
+    return this.fetch(path, { ...init, method: "GET" });
+  }
+
+  /**
+   * Helper for POST requests
+   */
+  async post(
+    path: string,
+    body: any,
+    init: RequestInit = {},
+  ): Promise<Response> {
+    const requestBody = body instanceof FormData ? body : JSON.stringify(body);
+    return this.fetch(path, { ...init, method: "POST", body: requestBody });
+  }
+
+  /**
+   * Helper for PUT requests
+   */
+  async put(
+    path: string,
+    body: any,
+    init: RequestInit = {},
+  ): Promise<Response> {
+    const requestBody = body instanceof FormData ? body : JSON.stringify(body);
+    return this.fetch(path, { ...init, method: "PUT", body: requestBody });
+  }
+
+  /**
+   * Helper for PATCH requests
+   */
+  async patch(
+    path: string,
+    body: any,
+    init: RequestInit = {},
+  ): Promise<Response> {
+    return this.fetch(path, {
+      ...init,
+      method: "PATCH",
+      body: JSON.stringify(body),
+    });
+  }
+
+  /**
+   * Helper for DELETE requests
+   */
+  async delete(path: string, init: RequestInit = {}): Promise<Response> {
+    return this.fetch(path, { ...init, method: "DELETE" });
+  }
+}

package/src/vercel/index.ts

@@ -0,0 +1,3 @@
+export * from "./api.js";
+export * from "./project-domain.js";
+export * from "./project.js";

package/src/vercel/project-domain.ts

@@ -0,0 +1,172 @@
+import type { Context } from "../context.js";
+import { Resource } from "../resource.js";
+import type { Secret } from "../secret.js";
+import { createVercelApi } from "./api.js";
+
+/**
+ * Properties for creating or updating a ProjectDomain
+ */
+export interface ProjectDomainProps {
+  /**
+   * The domain name to add to the project
+   */
+  name: string;
+
+  /**
+   * The unique project identifier or the project name
+   */
+  project: string;
+
+  /**
+   * The Git branch to link the domain to
+   */
+  gitBranch?: string;
+
+  /**
+   * The unique custom environment identifier within the project
+   */
+  customEnvironment?: string;
+
+  /**
+   * The redirect target for the domain
+   */
+  redirect?: string;
+
+  /**
+   * The redirect status code
+   */
+  redirectStatusCode?: 301 | 302 | 307 | 308;
+}
+
+/**
+ * Output returned after ProjectDomain creation/update
+ */
+export interface ProjectDomain
+  extends Resource<"vercel::ProjectDomain">,
+    ProjectDomainProps {
+  apexName: string;
+
+  /**
+   * `true` if the domain is verified for use with the project. If `false` it will not be used as an alias on this project until the challenge in `verification` is completed.
+   */
+  verified: boolean;
+
+  /**
+   * The time at which the domain was created
+   */
+  createdAt: number;
+
+  /**
+   * The time at which the domain was last updated
+   */
+  updatedAt: number;
+
+  /**
+   * A list of verification challenges, one of which must be completed to verify the domain for use on the project. After the challenge is complete `POST /projects/:idOrName/domains/:domain/verify` to verify the domain.
+   *
+   * Possible challenges:
+   *   - If `verification.type = TXT` the `verification.domain` will be checked for a TXT record matching `verification.value`.
+   */
+  verification?: {
+    /**
+     * The type of verification
+     */
+    type: string;
+
+    /**
+     * The domain being verified
+     */
+    domain: string;
+
+    /**
+     * The verification value
+     */
+    value: string;
+
+    /**
+     * The reason for verification
+     */
+    reason: string;
+  }[];
+}
+
+/**
+ * Add and manage domains for Vercel projects.
+ *
+ * @example
+ * // Minimal
+ * const domain = await ProjectDomain("my-app.com", {
+ *   name: "my-app.com",
+ *   project: "prj_123",
+ * });
+ *
+ * @example
+ * // With accessToken
+ * const domain = await ProjectDomain("my-app.com", {
+ *   accessToken: alchemy.secret(process.env.VERCEL_ACCESS_TOKEN),
+ *   name: "my-app.com",
+ *   project: "prj_123",
+ * });
+ *
+ * @example
+ * // With redirect
+ * const domain = await ProjectDomain("my-app.com", {
+ *   name: "my-app.com",
+ *   project: "prj_123",
+ *   gitBranch: "main",
+ *   redirect: "https://example.com",
+ *   redirectStatusCode: 301,
+ * });
+ */
+export const ProjectDomain = Resource(
+  "vercel::ProjectDomain",
+  async function (
+    this: Context<ProjectDomain>,
+    id: string,
+    { accessToken, ...props }: ProjectDomainProps & { accessToken?: Secret },
+  ): Promise<ProjectDomain> {
+    switch (this.phase) {
+      case "create": {
+        const api = await createVercelApi({
+          baseUrl: "https://api.vercel.com/v10",
+          accessToken,
+        });
+        const domain = (await api
+          .post(`/projects/${props.project}/domains`, props)
+          .then((res) => res.json())) as ProjectDomain;
+
+        return this.create({ ...props, ...domain });
+      }
+
+      case "update": {
+        const { gitBranch, redirect, redirectStatusCode } = props;
+
+        const api = await createVercelApi({
+          baseUrl: "https://api.vercel.com/v9",
+          accessToken,
+        });
+        const domain = (await api
+          .patch(`/projects/${props.project}/domains/${this.output.name}`, {
+            gitBranch,
+            redirect,
+            redirectStatusCode,
+          })
+          .then((res) => res.json())) as ProjectDomain;
+
+        return this.create({ ...props, ...domain });
+      }
+
+      case "delete": {
+        const api = await createVercelApi({
+          baseUrl: "https://api.vercel.com/v9",
+          accessToken,
+        });
+        await api.delete(
+          `/projects/${props.project}/domains/${this.output.name}`,
+        );
+
+        return this.destroy();
+      }
+    }
+  },
+);