alchemy 0.87.0 → 0.89.0

package/src/planetscale/database.ts

@@ -2,10 +2,16 @@ import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { PlanetScaleProps } from "./api.ts";
 import { createPlanetScaleClient } from "./api.ts";
+import {
+  type DatabaseExtensions,
+  diffExtensions,
+  updateExtensions,
+} from "./database-extensions.ts";
 import {
   ensureProductionBranchClusterSize,
   type PlanetScaleClusterSize,
   sanitizeClusterSize,
+  waitForBranchReady,
   waitForDatabaseReady,
 } from "./utils.ts";
 
@@ -36,11 +42,15 @@ interface BaseDatabaseProps extends PlanetScaleProps {
   delete?: boolean;
 
   /**
-   * The region where the database will be created (create only)
+   * The region where the database will be created (create only).
+   *
+   * @see https://planetscale.com/docs/concepts/regions
    */
   region?: {
     /**
-     * The slug identifier of the region
+     * The slug identifier of the region (e.g. "us-east", "eu-west", "gcp-us-central1")
+     *
+     * @see https://planetscale.com/docs/concepts/regions#available-regions
      */
     slug: string;
   };
@@ -135,6 +145,27 @@ interface PostgreSQLDatabaseProps extends BaseDatabaseProps {
    * The CPU architecture for the database (PostgreSQL only)
    */
   arch?: "x86" | "arm";
+
+  /**
+   * PostgreSQL extensions to enable on the default branch.
+   * Each key represents an extension — if present (even as `{}`), it is enabled with the given config or defaults.
+   * If absent, the extension is disabled. (PostgreSQL only)
+   *
+   * @example
+   * ```ts
+   * const db = await Database("my-pg-db", {
+   *   kind: "postgresql",
+   *   organization: "my-org",
+   *   clusterSize: "PS_10",
+   *   extensions: {
+   *     vector: { hnswEfSearch: 100 },
+   *     pgCron: {},
+   *     pgStatStatements: { max: 10000 },
+   *   },
+   * });
+   * ```
+   */
+  extensions?: DatabaseExtensions;
 }
 
 /**
@@ -190,6 +221,20 @@ export type Database = DatabaseProps & {
    * The organization of the database
    */
   organization: string;
+
+  /**
+   * The region of the database as reported by PlanetScale.
+   *
+   * @see https://planetscale.com/docs/concepts/regions
+   */
+  region: {
+    /**
+     * The slug identifier of the region (e.g. "us-east", "eu-west", "gcp-us-central1")
+     *
+     * @see https://planetscale.com/docs/concepts/regions#available-regions
+     */
+    slug: string;
+  };
 };
 
 /**
@@ -304,6 +349,49 @@ export const Database = Resource(
           cause: getResponse.error,
         });
       }
+
+      // Validate immutable properties match if specified
+      const actualKind = getResponse.data.kind;
+      if (props.kind && actualKind !== props.kind) {
+        throw new Error(
+          `Database "${databaseName}" has kind "${actualKind}" but expected "${props.kind}". ` +
+            `Database kind cannot be changed after creation.`,
+        );
+      }
+
+      if (props.region) {
+        const actualSlug = getResponse.data.region.slug;
+        if (actualSlug !== props.region.slug) {
+          throw new Error(
+            `Database "${databaseName}" is in region "${actualSlug}" but expected "${props.region.slug}". ` +
+              `PlanetScale database regions cannot be changed after creation. ` +
+              `Either update the region in your configuration to match, or create a new database in the correct region.`,
+          );
+        }
+      }
+
+      if (props.kind === "postgresql" && props.arch) {
+        const defaultBranch = props.defaultBranch || "main";
+        const branchInfo = await api.getBranch({
+          path: {
+            organization,
+            database: databaseName,
+            branch: defaultBranch,
+          },
+          throwOnError: false,
+        });
+        if (branchInfo.data?.cluster_architecture) {
+          const actualArch =
+            branchInfo.data.cluster_architecture === "aarch64" ? "arm" : "x86";
+          if (actualArch !== props.arch) {
+            throw new Error(
+              `Database "${databaseName}" has architecture "${actualArch}" but expected "${props.arch}". ` +
+                `Database architecture cannot be changed after creation.`,
+            );
+          }
+        }
+      }
+
       // Update database settings
       // If updating to a non-'main' default branch, create it first
       if (props.defaultBranch && props.defaultBranch !== "main") {
@@ -365,6 +453,26 @@ export const Database = Resource(
         clusterSize,
       );
 
+      // Sync PostgreSQL extensions on update
+      if (props.kind === "postgresql") {
+        const previousExtensions =
+          this.output?.kind === "postgresql"
+            ? this.output.extensions
+            : undefined;
+        const desiredExtensions = props.extensions;
+        const diff = diffExtensions(previousExtensions, desiredExtensions);
+        if (diff.hasChanges) {
+          const branch = props.defaultBranch || "main";
+          await waitForBranchReady(api, organization, databaseName, branch);
+          await updateExtensions(desiredExtensions ?? {}, {
+            ...props,
+            organization,
+            database: databaseName,
+            branch,
+          });
+        }
+      }
+
       return {
         ...props,
         id: data.id,
@@ -376,6 +484,7 @@ export const Database = Resource(
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
         organization,
+        region: { slug: data.region.slug },
       };
     }
 
@@ -472,6 +581,22 @@ export const Database = Resource(
           },
         });
 
+        // Enable PostgreSQL extensions on the new default branch
+        if (props.kind === "postgresql" && props.extensions) {
+          await waitForBranchReady(
+            api,
+            organization,
+            databaseName,
+            props.defaultBranch,
+          );
+          await updateExtensions(props.extensions, {
+            ...props,
+            organization,
+            database: databaseName,
+            branch: props.defaultBranch,
+          });
+        }
+
         return {
           ...props,
           id: data.id,
@@ -483,10 +608,23 @@ export const Database = Resource(
           updatedAt: updatedData.updated_at,
           htmlUrl: updatedData.html_url,
           organization,
+          region: { slug: updatedData.region.slug },
         };
       }
     }
 
+    // Enable PostgreSQL extensions on the default branch (main)
+    if (props.kind === "postgresql" && props.extensions) {
+      const branch = props.defaultBranch || "main";
+      await waitForBranchReady(api, organization, databaseName, branch);
+      await updateExtensions(props.extensions, {
+        ...props,
+        organization,
+        database: databaseName,
+        branch,
+      });
+    }
+
     return {
       ...props,
       id: data.id,
@@ -498,6 +636,7 @@ export const Database = Resource(
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
       organization,
+      region: { slug: data.region.slug },
     };
   },
 );

package/src/scope.ts

@@ -19,7 +19,6 @@ import {
 } from "./resource.ts";
 import type { State, StateStore, StateStoreType } from "./state.ts";
 import { FileSystemStateStore } from "./state/file-system-state-store.ts";
-import { InstrumentedStateStore } from "./state/instrumented-state-store.ts";
 import {
   createDummyLogger,
   createLoggerInstance,
@@ -333,7 +332,7 @@ export class Scope {
       stateStore ??
       this.parent?.stateStore ??
       ((scope) => new FileSystemStateStore(scope));
-    this.state = new InstrumentedStateStore(this.stateStore(this));
+    this.state = this.stateStore(this);
     this.dataMutex = new AsyncMutex();
   }
 

package/src/util/telemetry.ts

@@ -261,21 +261,6 @@ export type ResourceTelemetryData = {
   replaced: boolean;
 };
 
-export type StateStoreTelemetryData = {
-  event:
-    | "statestore.init"
-    | "statestore.deinit"
-    | "statestore.list"
-    | "statestore.count"
-    | "statestore.get"
-    | "statestore.getBatch"
-    | "statestore.all"
-    | "statestore.set"
-    | "statestore.delete";
-  stateStore: string;
-  duration: number;
-};
-
 export type AlchemyTelemetryData = {
   event: "alchemy.start" | "alchemy.success" | "alchemy.error";
   duration: number;
@@ -290,11 +275,7 @@ async function isTelemetryDisabled() {
 }
 
 export async function createAndSendEvent(
-  data:
-    | CliTelemetryData
-    | ResourceTelemetryData
-    | StateStoreTelemetryData
-    | AlchemyTelemetryData,
+  data: CliTelemetryData | ResourceTelemetryData | AlchemyTelemetryData,
   error?: Error,
 ) {
   if (await isTelemetryDisabled()) {

package/workers/tunnel-proxy.js

@@ -83,7 +83,7 @@ const renderErrorHtml = (props) => `
             Alchemy</a>.</p>
       </div>
       <div class="bg-slate-200 px-5 py-3 flex flex-col w-full max-w-lg">
-        <p class="text-sm text-slate-500">Alchemy 0.87.0</p>
+        <p class="text-sm text-slate-500">Alchemy 0.89.0</p>
       </div>
     </div>
   </body>

package/lib/state/instrumented-state-store.d.ts

@@ -1,19 +0,0 @@
-import type { State, StateStore } from "../state.ts";
-export declare class InstrumentedStateStore<T extends StateStore> implements StateStore {
-    /** @internal */
-    __phantom?: T;
-    private readonly stateStore;
-    private readonly stateStoreClass;
-    constructor(stateStore: StateStore);
-    private callWithTelemetry;
-    init(): Promise<void>;
-    deinit(): Promise<void>;
-    list(): Promise<string[]>;
-    count(): Promise<number>;
-    get(key: string): Promise<State<string, import("../resource.ts").ResourceProps | undefined, import("../resource.ts").Resource<string>> | undefined>;
-    getBatch(ids: string[]): Promise<Record<string, State<string, import("../resource.ts").ResourceProps | undefined, import("../resource.ts").Resource<string>>>>;
-    all(): Promise<Record<string, State<string, import("../resource.ts").ResourceProps | undefined, import("../resource.ts").Resource<string>>>>;
-    set(key: string, value: State): Promise<void>;
-    delete(key: string): Promise<void>;
-}
-//# sourceMappingURL=instrumented-state-store.d.ts.map

package/lib/state/instrumented-state-store.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"instrumented-state-store.d.ts","sourceRoot":"","sources":["../../src/state/instrumented-state-store.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,KAAK,EAAE,UAAU,EAAE,MAAM,aAAa,CAAC;AAOrD,qBAAa,sBAAsB,CACjC,CAAC,SAAS,UAAU,CACpB,YAAW,UAAU;IACrB,gBAAgB;IAChB,SAAS,CAAC,EAAE,CAAC,CAAC;IACd,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IACxC,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAS;gBAE7B,UAAU,EAAE,UAAU;YAKpB,iBAAiB;IA2BzB,IAAI;IASJ,MAAM;IASN,IAAI;IAMJ,KAAK;IAML,GAAG,CAAC,GAAG,EAAE,MAAM;IAMf,QAAQ,CAAC,GAAG,EAAE,MAAM,EAAE;IAMtB,GAAG;IAMH,GAAG,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK;IAM7B,MAAM,CAAC,GAAG,EAAE,MAAM;CAMzB"}

package/lib/state/instrumented-state-store.js

@@ -1,68 +0,0 @@
-import { createAndSendEvent, } from "../util/telemetry.js";
-//todo(michael): we should also handle serde here
-export class InstrumentedStateStore {
-    /** @internal */
-    __phantom;
-    stateStore;
-    stateStoreClass;
-    constructor(stateStore) {
-        this.stateStore = stateStore;
-        this.stateStoreClass = stateStore.constructor.name;
-    }
-    async callWithTelemetry(event, fn) {
-        const start = performance.now();
-        let error;
-        try {
-            return await fn();
-        }
-        catch (err) {
-            error = err;
-            throw err;
-        }
-        finally {
-            await createAndSendEvent({
-                event,
-                stateStore: this.stateStoreClass,
-                duration: performance.now() - start,
-            }, error instanceof Error
-                ? error
-                : error
-                    ? new Error(String(error))
-                    : undefined);
-        }
-    }
-    async init() {
-        if (this.stateStore.init == null) {
-            return;
-        }
-        await this.callWithTelemetry("statestore.init", this.stateStore.init.bind(this.stateStore));
-    }
-    async deinit() {
-        if (this.stateStore.deinit == null) {
-            return;
-        }
-        await this.callWithTelemetry("statestore.deinit", this.stateStore.deinit.bind(this.stateStore));
-    }
-    async list() {
-        return await this.callWithTelemetry("statestore.list", this.stateStore.list.bind(this.stateStore));
-    }
-    async count() {
-        return await this.callWithTelemetry("statestore.count", this.stateStore.count.bind(this.stateStore));
-    }
-    async get(key) {
-        return await this.callWithTelemetry("statestore.get", this.stateStore.get.bind(this.stateStore, key));
-    }
-    async getBatch(ids) {
-        return await this.callWithTelemetry("statestore.getBatch", this.stateStore.getBatch.bind(this.stateStore, ids));
-    }
-    async all() {
-        return await this.callWithTelemetry("statestore.all", this.stateStore.all.bind(this.stateStore));
-    }
-    async set(key, value) {
-        await this.callWithTelemetry("statestore.set", this.stateStore.set.bind(this.stateStore, key, value));
-    }
-    async delete(key) {
-        await this.callWithTelemetry("statestore.delete", this.stateStore.delete.bind(this.stateStore, key));
-    }
-}
-//# sourceMappingURL=instrumented-state-store.js.map

package/lib/state/instrumented-state-store.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"instrumented-state-store.js","sourceRoot":"","sources":["../../src/state/instrumented-state-store.ts"],"names":[],"mappings":"AACA,OAAO,EACL,kBAAkB,GAEnB,MAAM,sBAAsB,CAAC;AAE9B,iDAAiD;AACjD,MAAM,OAAO,sBAAsB;IAGjC,gBAAgB;IAChB,SAAS,CAAK;IACG,UAAU,CAAa;IACvB,eAAe,CAAS;IAEzC,YAAY,UAAsB;QAChC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC;QAC7B,IAAI,CAAC,eAAe,GAAG,UAAU,CAAC,WAAW,CAAC,IAAI,CAAC;IACrD,CAAC;IAEO,KAAK,CAAC,iBAAiB,CAC7B,KAAuC,EACvC,EAAoB;QAEpB,MAAM,KAAK,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QAChC,IAAI,KAAc,CAAC;QACnB,IAAI,CAAC;YACH,OAAO,MAAM,EAAE,EAAE,CAAC;QACpB,CAAC;QAAC,OAAO,GAAG,EAAE,CAAC;YACb,KAAK,GAAG,GAAG,CAAC;YACZ,MAAM,GAAG,CAAC;QACZ,CAAC;gBAAS,CAAC;YACT,MAAM,kBAAkB,CACtB;gBACE,KAAK;gBACL,UAAU,EAAE,IAAI,CAAC,eAAe;gBAChC,QAAQ,EAAE,WAAW,CAAC,GAAG,EAAE,GAAG,KAAK;aACpC,EACD,KAAK,YAAY,KAAK;gBACpB,CAAC,CAAC,KAAK;gBACP,CAAC,CAAC,KAAK;oBACL,CAAC,CAAC,IAAI,KAAK,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;oBAC1B,CAAC,CAAC,SAAS,CAChB,CAAC;QACJ,CAAC;IACH,CAAC;IAED,KAAK,CAAC,IAAI;QACR,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,IAAI,IAAI,EAAE,CAAC;YACjC,OAAO;QACT,CAAC;QACD,MAAM,IAAI,CAAC,iBAAiB,CAC1B,iBAAiB,EACjB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAC3C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,MAAM;QACV,IAAI,IAAI,CAAC,UAAU,CAAC,MAAM,IAAI,IAAI,EAAE,CAAC;YACnC,OAAO;QACT,CAAC;QACD,MAAM,IAAI,CAAC,iBAAiB,CAC1B,mBAAmB,EACnB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAC7C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,IAAI;QACR,OAAO,MAAM,IAAI,CAAC,iBAAiB,CACjC,iBAAiB,EACjB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAC3C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,KAAK;QACT,OAAO,MAAM,IAAI,CAAC,iBAAiB,CACjC,kBAAkB,EAClB,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAC5C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,GAAW;QACnB,OAAO,MAAM,IAAI,CAAC,iBAAiB,CACjC,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAC/C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,QAAQ,CAAC,GAAa;QAC1B,OAAO,MAAM,IAAI,CAAC,iBAAiB,CACjC,qBAAqB,EACrB,IAAI,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CACpD,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,GAAG;QACP,OAAO,MAAM,IAAI,CAAC,iBAAiB,CACjC,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,CAC1C,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,GAAG,CAAC,GAAW,EAAE,KAAY;QACjC,MAAM,IAAI,CAAC,iBAAiB,CAC1B,gBAAgB,EAChB,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,EAAE,KAAK,CAAC,CACtD,CAAC;IACJ,CAAC;IACD,KAAK,CAAC,MAAM,CAAC,GAAW;QACtB,MAAM,IAAI,CAAC,iBAAiB,CAC1B,mBAAmB,EACnB,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,GAAG,CAAC,CAClD,CAAC;IACJ,CAAC;CACF"}

package/src/state/instrumented-state-store.ts

@@ -1,108 +0,0 @@
-import type { State, StateStore } from "../state.ts";
-import {
-  createAndSendEvent,
-  type StateStoreTelemetryData,
-} from "../util/telemetry.ts";
-
-//todo(michael): we should also handle serde here
-export class InstrumentedStateStore<
-  T extends StateStore,
-> implements StateStore {
-  /** @internal */
-  __phantom?: T;
-  private readonly stateStore: StateStore;
-  private readonly stateStoreClass: string;
-
-  constructor(stateStore: StateStore) {
-    this.stateStore = stateStore;
-    this.stateStoreClass = stateStore.constructor.name;
-  }
-
-  private async callWithTelemetry<T>(
-    event: StateStoreTelemetryData["event"],
-    fn: () => Promise<T>,
-  ): Promise<T> {
-    const start = performance.now();
-    let error: unknown;
-    try {
-      return await fn();
-    } catch (err) {
-      error = err;
-      throw err;
-    } finally {
-      await createAndSendEvent(
-        {
-          event,
-          stateStore: this.stateStoreClass,
-          duration: performance.now() - start,
-        },
-        error instanceof Error
-          ? error
-          : error
-            ? new Error(String(error))
-            : undefined,
-      );
-    }
-  }
-
-  async init() {
-    if (this.stateStore.init == null) {
-      return;
-    }
-    await this.callWithTelemetry(
-      "statestore.init",
-      this.stateStore.init.bind(this.stateStore),
-    );
-  }
-  async deinit() {
-    if (this.stateStore.deinit == null) {
-      return;
-    }
-    await this.callWithTelemetry(
-      "statestore.deinit",
-      this.stateStore.deinit.bind(this.stateStore),
-    );
-  }
-  async list() {
-    return await this.callWithTelemetry(
-      "statestore.list",
-      this.stateStore.list.bind(this.stateStore),
-    );
-  }
-  async count() {
-    return await this.callWithTelemetry(
-      "statestore.count",
-      this.stateStore.count.bind(this.stateStore),
-    );
-  }
-  async get(key: string) {
-    return await this.callWithTelemetry(
-      "statestore.get",
-      this.stateStore.get.bind(this.stateStore, key),
-    );
-  }
-  async getBatch(ids: string[]) {
-    return await this.callWithTelemetry(
-      "statestore.getBatch",
-      this.stateStore.getBatch.bind(this.stateStore, ids),
-    );
-  }
-  async all() {
-    return await this.callWithTelemetry(
-      "statestore.all",
-      this.stateStore.all.bind(this.stateStore),
-    );
-  }
-  async set(key: string, value: State) {
-    await this.callWithTelemetry(
-      "statestore.set",
-      this.stateStore.set.bind(this.stateStore, key, value),
-    );
-  }
-  async delete(key: string) {
-    await this.callWithTelemetry(
-      "statestore.delete",
-      this.stateStore.delete.bind(this.stateStore, key),
-    );
-  }
-}