alchemy 0.67.0 → 0.68.0

package/src/planetscale/role.ts

@@ -3,7 +3,7 @@ import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
 import { logger } from "../util/logger.ts";
-import { PlanetScaleClient, type PlanetScaleProps } from "./api/client.gen.ts";
+import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
 import type { CreateRoleData } from "./api/types.gen.ts";
 import type { Branch } from "./branch.ts";
 import type { Database } from "./database.ts";
@@ -63,9 +63,7 @@ export type InheritedRole =
   | "pg_write_all_data"
   | (string & {});
 
-export interface Role
-  extends Resource<"planetscale::Role">,
-    Omit<RoleProps, "inheritedRoles"> {
+export interface Role extends Omit<RoleProps, "inheritedRoles"> {
   /**
    * The unique identifier for the role
    */
@@ -165,7 +163,7 @@ export const Role = Resource(
     id: string,
     props: RoleProps,
   ): Promise<Role> {
-    const api = new PlanetScaleClient(props);
+    const api = createPlanetScaleClient(props);
     const organization =
       typeof props.branch === "object"
         ? props.branch.organizationId
@@ -188,17 +186,17 @@ export const Role = Resource(
     switch (this.phase) {
       case "delete": {
         if (this.output?.id) {
-          const res = await api.organizations.databases.branches.roles.delete({
+          const res = await api.deleteRole({
             path: {
               organization,
               database,
               branch,
               id: this.output.id,
             },
-            result: "full",
+            throwOnError: false,
           });
           if (res.error) {
-            switch (res.error.status) {
+            switch (res.response.status) {
               case 404:
                 break;
               case 422:
@@ -223,7 +221,9 @@ export const Role = Resource(
         return this.destroy();
       }
       case "create": {
-        const { kind, ready } = await api.organizations.databases.branches.get({
+        const {
+          data: { kind, ready },
+        } = await api.getBranch({
           path: {
             organization,
             database,
@@ -239,7 +239,7 @@ export const Role = Resource(
         if (!ready) {
           await waitForBranchReady(api, organization, database, branch);
         }
-        const role = await api.organizations.databases.branches.roles.post({
+        const { data } = await api.createRole({
           path: {
             organization,
             database,
@@ -250,23 +250,23 @@ export const Role = Resource(
             inherited_roles: inheritedRoles,
           } as CreateRoleData["body"],
         });
-        return this({
+        return {
           ...props,
-          id: role.id,
-          name: role.name,
-          host: role.access_host_url,
-          username: role.username,
-          password: alchemy.secret(role.password),
-          expiresAt: role.expires_at,
-          databaseName: role.database_name,
+          id: data.id,
+          name: data.name,
+          host: data.access_host_url,
+          username: data.username,
+          password: alchemy.secret(data.password),
+          expiresAt: data.expires_at,
+          databaseName: data.database_name,
           inheritedRoles,
           connectionUrl: alchemy.secret(
-            `postgresql://${role.username}:${role.password}@${role.access_host_url}:5432/${role.database_name}?sslmode=verify-full`,
+            `postgresql://${data.username}:${data.password}@${data.access_host_url}:5432/${data.database_name}?sslmode=verify-full`,
           ),
           connectionUrlPooled: alchemy.secret(
-            `postgresql://${role.username}:${role.password}@${role.access_host_url}:6432/${role.database_name}?sslmode=verify-full`,
+            `postgresql://${data.username}:${data.password}@${data.access_host_url}:6432/${data.database_name}?sslmode=verify-full`,
           ),
-        });
+        };
       }
       case "update": {
         // According to the types, the only property that can be updated is the name.

package/src/planetscale/utils.ts

@@ -1,4 +1,5 @@
-import type { PlanetScaleClient } from "./api/client.gen.ts";
+import { poll } from "../util/poll.ts";
+import type { PlanetScaleClient } from "./api/sdk.gen.ts";
 import type { DatabaseBranch } from "./api/types.gen.ts";
 
 export type PlanetScaleClusterSize =
@@ -54,14 +55,15 @@ export async function waitForBranchReady(
   database: string,
   branch: string,
 ): Promise<DatabaseBranch> {
-  return await poll({
+  const { data } = await poll({
     description: `branch "${branch}" ready`,
     fn: () =>
-      api.organizations.databases.branches.get({
+      api.getBranch({
         path: { organization, database, name: branch },
       }),
-    predicate: (branch) => branch.ready,
+    predicate: ({ data }) => data.ready,
   });
+  return data;
 }
 
 /**
@@ -75,10 +77,10 @@ export async function waitForDatabaseReady(
   await poll({
     description: `database "${database}" ready`,
     fn: () =>
-      api.organizations.databases.get({
+      api.getDatabase({
         path: { organization, name: database },
       }),
-    predicate: (database) => database.ready,
+    predicate: ({ data }) => data.ready,
   });
 }
 
@@ -95,11 +97,11 @@ export async function waitForKeyspaceReady(
   await poll({
     description: `keyspace "${keyspace}" ready`,
     fn: () =>
-      api.organizations.databases.branches.keyspaces.resizes.list({
+      api.listKeyspaceResizes({
         path: { organization, database, branch, name: keyspace },
       }),
-    predicate: (response) =>
-      response.data.every((item) => item.state !== "resizing"),
+    predicate: ({ data }) =>
+      data.data.every((item) => item.state !== "resizing"),
     initialDelay: 100,
     maxDelay: 1000,
   });
@@ -155,7 +157,7 @@ async function ensureProductionBranch(
   database: string,
   name: string,
 ): Promise<void> {
-  const data = await api.organizations.databases.branches.get({
+  const { data } = await api.getBranch({
     path: {
       organization,
       database,
@@ -166,7 +168,7 @@ async function ensureProductionBranch(
     if (!data.ready) {
       await waitForBranchReady(api, organization, database, name);
     }
-    await api.organizations.databases.branches.promote.post({
+    await api.promoteBranch({
       path: { organization, database, name },
     });
   }
@@ -183,7 +185,7 @@ async function ensureMySQLClusterSize(
   expectedClusterSize: PlanetScaleClusterSize,
 ): Promise<void> {
   // 1. Load default keyspace
-  const keyspaces = await api.organizations.databases.branches.keyspaces.list({
+  const { data: keyspaces } = await api.listKeyspaces({
     path: {
       organization,
       database,
@@ -207,7 +209,7 @@ async function ensureMySQLClusterSize(
   // 3. If size mismatch, trigger resize and wait again
   // Ideally this would use the undocumented Keyspaces API, but there seems to be a missing oauth scope that we cannot add via the console yet
   if (defaultKeyspace.cluster_name !== expectedClusterSize) {
-    await api.organizations.databases.branches.cluster.patch({
+    await api.updateBranchClusterConfig({
       path: {
         organization,
         database,
@@ -237,7 +239,7 @@ async function ensurePostgresClusterSize(
   branch: string,
   expectedClusterSize: PlanetScaleClusterSize,
 ): Promise<void> {
-  const data = await api.organizations.databases.branches.get({
+  const { data } = await api.getBranch({
     path: {
       organization,
       database,
@@ -248,7 +250,7 @@ async function ensurePostgresClusterSize(
     return;
   }
   await waitForPendingPostgresChanges(api, organization, database, branch);
-  const change = await api.organizations.databases.branches.changes.patch({
+  const { data: change } = await api.updateBranchChangeRequest({
     path: {
       organization,
       database,
@@ -280,11 +282,11 @@ async function waitForPendingPostgresChanges(
   await poll({
     description: `changes for branch "${branch}"`,
     fn: () =>
-      api.organizations.databases.branches.changes.list({
+      api.listBranchChangeRequests({
         path: { organization, database, branch },
       }),
-    predicate: (response) =>
-      response.data.every(
+    predicate: ({ data }) =>
+      data.data.every(
         (change) =>
           change.state === "completed" ||
           change.state === "canceled" ||
@@ -292,59 +294,3 @@ async function waitForPendingPostgresChanges(
       ),
   });
 }
-
-/**
- * Polls a function until it returns a result that satisfies the predicate.
- */
-async function poll<T>(input: {
-  /**
-   * A description of the operation being polled.
-   */
-  description: string;
-
-  /**
-   * The function to poll.
-   */
-  fn: () => Promise<T>;
-
-  /**
-   * A predicate that determines if the operation has completed.
-   */
-  predicate: (result: T) => boolean;
-
-  /**
-   * The initial delay between polls.
-   * @default 250ms
-   */
-  initialDelay?: number;
-
-  /**
-   * The maximum delay between polls.
-   * @default 2_500ms (2.5 seconds)
-   */
-  maxDelay?: number;
-
-  /**
-   * The timeout for the poll in milliseconds.
-   * @default 1_000_000 (~16 minutes)
-   */
-  timeout?: number;
-}): Promise<T> {
-  const start = Date.now();
-  let delay = input.initialDelay ?? 250;
-  while (true) {
-    const result = await input.fn();
-    if (input.predicate(result)) {
-      return result;
-    }
-    if (Date.now() - start >= (input.timeout ?? 1_000_000)) {
-      throw new Error(
-        `Timed out waiting for ${input.description} after ${Math.round(
-          (input.timeout ?? 1_000_000) / 1000,
-        )}s`,
-      );
-    }
-    await new Promise((resolve) => setTimeout(resolve, delay));
-    delay = Math.min(delay * 2, input.maxDelay ?? 5_000);
-  }
-}

package/src/random/random-string.ts

@@ -27,7 +27,7 @@ export interface RandomStringProps {
 /**
  * A cryptographically secure random string resource
  */
-export interface RandomString extends Resource<"random::String"> {
+export interface RandomString {
   /**
    * The generated random string value, stored as a secret
    */
@@ -110,10 +110,10 @@ export const RandomString = Resource(
       // this is an update (input props changed)
       // but the length and encoding did not change
       // so, we can just return the existing output (no-op)
-      return this(this.output);
+      return this.output;
     }
     const crypto = await import("node:crypto");
-    return this({
+    return {
       length,
       encoding,
       value: alchemy.secret(
@@ -121,6 +121,6 @@ export const RandomString = Resource(
           .randomBytes(props.length ?? 32)
           .toString(props.encoding ?? "hex"),
       ),
-    });
+    };
   },
 );

package/src/resource.ts

@@ -79,6 +79,10 @@ export type ResourceProps = {
   [key: string]: any;
 };
 
+export type ResourceAttributes = {
+  [key: string]: any;
+};
+
 export type Provider<
   Type extends string = string,
   F extends ResourceLifecycleHandler = ResourceLifecycleHandler,
@@ -116,7 +120,7 @@ type ResourceLifecycleHandler = (
   this: Context<any, any>,
   id: string,
   props: any,
-) => Promise<Resource<string>>;
+) => Promise<ResourceAttributes>;
 
 // see: https://x.com/samgoodwin89/status/1904640134097887653
 type Handler<F extends (...args: any[]) => any> =
@@ -157,7 +161,7 @@ export function Resource<
   const provider = (async (
     resourceID: string,
     props: ResourceProps,
-  ): Promise<Resource<string>> => {
+  ): Promise<ResourceAttributes> => {
     const scope = _Scope.current;
 
     if (resourceID.includes(":")) {

package/src/sentry/client-key.ts

@@ -62,9 +62,7 @@ export interface ClientKeyProps {
 /**
  * Output returned after ClientKey creation/update
  */
-export interface ClientKey
-  extends Resource<"sentry::ClientKey">,
-    ClientKeyProps {
+export interface ClientKey extends ClientKeyProps {
   /**
    * The ID of the key
    */
@@ -295,7 +293,7 @@ export const ClientKey = Resource(
           ClientKey,
           keyof ClientKeyProps
         >;
-        return this({
+        return {
           ...props,
           id: data.id,
           name: clientKeyName,
@@ -309,7 +307,7 @@ export const ClientKey = Resource(
           browserSdk: data.browserSdk,
           dateCreated: data.dateCreated,
           dynamicSdkLoaderOptions: data.dynamicSdkLoaderOptions,
-        });
+        };
       } catch (error) {
         logger.error("Error creating/updating client key:", error);
         throw error;

package/src/sentry/project.ts

@@ -57,9 +57,7 @@ export interface ProjectProps {
 /**
  * Output returned after Project creation/update
  */
-export interface Project
-  extends Omit<Resource<"sentry::Project">, "team">,
-    Omit<ProjectProps, "team"> {
+export interface Project extends Omit<ProjectProps, "team"> {
   /**
    * The ID of the project
    */
@@ -393,7 +391,7 @@ export const Project = Resource(
           Project,
           keyof ProjectProps
         > & { team: Project["team"] };
-        return this({
+        return {
           ...props,
           id: data.id,
           name: projectName,
@@ -430,7 +428,7 @@ export const Project = Resource(
           latestRelease: data.latestRelease,
           hasUserReports: data.hasUserReports,
           latestDeploys: data.latestDeploys,
-        });
+        } satisfies Project;
       } catch (error) {
         logger.error("Error creating/updating project:", error);
         throw error;

package/src/sentry/team.ts

@@ -42,7 +42,7 @@ export interface TeamProps {
 /**
  * Output returned after Team creation/update
  */
-export interface Team extends Resource<"sentry::Team">, TeamProps {
+export interface Team extends TeamProps {
   /**
    * The ID of the team
    */
@@ -230,7 +230,7 @@ export const Team = Resource(
         }
 
         const data = (await response.json()) as Omit<Team, keyof TeamProps>;
-        return this({
+        return {
           ...props,
           id: data.id,
           name: teamName,
@@ -243,7 +243,7 @@ export const Team = Resource(
           isPending: data.isPending,
           memberCount: data.memberCount,
           avatar: data.avatar,
-        });
+        };
       } catch (error) {
         logger.error("Error creating/updating team:", error);
         throw error;

package/src/state/r2-rest-state-store.ts

@@ -4,6 +4,7 @@ import {
   type CloudflareApiOptions,
   createCloudflareApi,
 } from "../cloudflare/api.ts";
+import { deleteObject, getObject, putObject } from "../cloudflare/bucket.ts";
 import { ResourceScope } from "../resource.ts";
 import type { Scope } from "../scope.ts";
 import { deserialize, serialize } from "../serde.ts";
@@ -192,23 +193,10 @@ export class R2RestStateStore implements StateStore {
     await this.ensureInitialized();
 
     try {
-      const response = await withExponentialBackoff(
-        async () => {
-          const response = await this.api.get(
-            `/accounts/${this.api.accountId}/r2/buckets/${this.bucketName}/objects/${this.getObjectKey(key)}`,
-          );
-
-          if (!response.ok && response.status !== 404) {
-            await handleApiError(response, "get", "object", key);
-          }
-
-          return response;
-        },
-        // Retry on transient errors
-        isRetryableError,
-        5, // 5 retry attempts
-        1000, // Start with 1 second delay
-      );
+      const response = await getObject(this.api, {
+        bucketName: this.bucketName,
+        key: this.getObjectKey(key),
+      });
 
       if (response.status === 404) {
         return undefined;
@@ -281,29 +269,11 @@ export class R2RestStateStore implements StateStore {
     // Serialize the state to handle cyclic structures
     const serializedData = await serialize(this.scope, value);
 
-    // Using withExponentialBackoff for reliability
-    await withExponentialBackoff(
-      async () => {
-        const response = await this.api.put(
-          `/accounts/${this.api.accountId}/r2/buckets/${this.bucketName}/objects/${objectKey}`,
-          serializedData,
-          {
-            headers: {
-              "Content-Type": "application/json",
-            },
-          },
-        );
-
-        if (!response.ok) {
-          await handleApiError(response, "put", "object", objectKey);
-        }
-        return response;
-      },
-      // Retry on transient errors
-      isRetryableError,
-      5, // 5 retry attempts
-      1000, // Start with 1 second delay
-    );
+    await putObject(this.api, {
+      bucketName: this.bucketName,
+      key: objectKey,
+      object: serializedData,
+    });
   }
 
   /**
@@ -314,22 +284,10 @@ export class R2RestStateStore implements StateStore {
   async delete(key: string): Promise<void> {
     await this.ensureInitialized();
 
-    await withExponentialBackoff(
-      async () => {
-        const response = await this.api.delete(
-          `/accounts/${this.api.accountId}/r2/buckets/${this.bucketName}/objects/${this.getObjectKey(key)}`,
-        );
-
-        if (!response.ok && response.status !== 404) {
-          await handleApiError(response, "delete", "object", key);
-        }
-
-        return response;
-      },
-      isRetryableError,
-      5, // 5 retry attempts
-      1000, // Start with 1 second delay
-    );
+    await deleteObject(this.api, {
+      bucketName: this.bucketName,
+      key: this.getObjectKey(key),
+    });
   }
 
   /**
@@ -373,7 +331,7 @@ export class R2RestStateStore implements StateStore {
   }
 }
 
-function isRetryableError(error: any): boolean {
+export function isRetryableError(error: any): boolean {
   if (error instanceof CloudflareApiError) {
     return (
       error.status === 500 ||

package/src/stripe/card.ts

@@ -107,7 +107,7 @@ export interface CardProps {
 /**
  * Output from the Stripe card
  */
-export interface Card extends Resource<"stripe::Card">, CardProps {
+export interface Card extends CardProps {
   /**
    * The ID of the card
    */
@@ -292,7 +292,7 @@ export const Card = Resource(
         }
       }
 
-      return this({
+      return {
         id: card.id,
         object: card.object,
         customer: props.customer,
@@ -315,7 +315,7 @@ export const Card = Resource(
         defaultForCurrency: card.default_for_currency || undefined,
         metadata: card.metadata || undefined,
         tokenizationMethod: card.tokenization_method || undefined,
-      });
+      };
     } catch (error) {
       logger.error("Error creating/updating card:", error);
       throw error;

package/src/stripe/coupon.ts

@@ -89,7 +89,7 @@ export interface CouponProps {
 /**
  * Output from the Stripe coupon
  */
-export interface Coupon extends Resource<"stripe::Coupon">, CouponProps {
+export interface Coupon extends CouponProps {
   /**
    * The ID of the coupon
    */
@@ -257,7 +257,7 @@ export const Coupon = Resource(
         }
       }
 
-      return this({
+      return {
         id: coupon.id,
         object: coupon.object,
         duration: coupon.duration as CouponDuration,
@@ -273,7 +273,7 @@ export const Coupon = Resource(
         metadata: coupon.metadata || undefined,
         created: coupon.created,
         livemode: coupon.livemode,
-      });
+      };
     } catch (error) {
       logger.error("Error creating/updating coupon:", error);
       throw error;

package/src/stripe/customer.ts

@@ -163,7 +163,7 @@ export interface CustomerProps {
 /**
  * Output from the Stripe customer
  */
-export interface Customer extends Resource<"stripe::Customer">, CustomerProps {
+export interface Customer extends CustomerProps {
   /**
    * The ID of the customer
    */
@@ -432,7 +432,7 @@ export const Customer = Resource(
         }
       }
 
-      return this({
+      return {
         id: customer.id,
         object: customer.object,
         address: customer.address
@@ -506,7 +506,7 @@ export const Customer = Resource(
         subscriptions: customer.subscriptions || undefined,
         taxExempt: customer.tax_exempt || undefined,
         taxIds: customer.tax_ids || undefined,
-      });
+      };
     } catch (error) {
       logger.error("Error creating/updating customer:", error);
       throw error;

package/src/stripe/entitlements-feature.ts

@@ -38,9 +38,7 @@ export interface EntitlementsFeatureProps {
 /**
  * Output from the Stripe entitlements feature
  */
-export interface EntitlementsFeature
-  extends Resource<"stripe::EntitlementsFeature">,
-    EntitlementsFeatureProps {
+export interface EntitlementsFeature extends EntitlementsFeatureProps {
   /**
    * The ID of the feature
    */
@@ -157,14 +155,14 @@ export const EntitlementsFeature = Resource(
         }
       }
 
-      return this({
+      return {
         id: feature.id,
         object: feature.object,
         name: feature.name,
         lookupKey: feature.lookup_key || undefined,
         metadata: feature.metadata || undefined,
         livemode: feature.livemode,
-      });
+      };
     } catch (error) {
       logger.error("Error creating/updating entitlements feature:", error);
       throw error;

package/src/stripe/file.ts

@@ -49,7 +49,7 @@ export interface FileProps {
 /**
  * Output from the Stripe file
  */
-export interface File extends Resource<"stripe::File"> {
+export interface File {
   /**
    * The ID of the file
    */
@@ -182,7 +182,7 @@ export const File = Resource(
         }
       }
 
-      return this({
+      return {
         id: file.id,
         object: file.object,
         created: file.created,
@@ -212,7 +212,7 @@ export const File = Resource(
         type: file.type || undefined,
         url: file.url || undefined,
         livemode: true,
-      });
+      };
     } catch (error) {
       logger.error("Error creating/retrieving file:", error);
       throw error;