alchemy 0.67.0 → 0.69.0

package/src/planetscale/api.ts

@@ -0,0 +1,101 @@
+import type { Secret } from "../secret.ts";
+import {
+  createClient,
+  createConfig,
+  type ClientOptions,
+} from "../util/api/client/index.ts";
+import { PlanetScaleClient } from "./api/sdk.gen.ts";
+import type { GeneralError } from "./api/types.gen.ts";
+
+/**
+ * Properties for configuring the PlanetScale API.
+ */
+export interface PlanetScaleProps {
+  /**
+   * The base URL of the PlanetScale API. Defaults to https://api.planetscale.com/v1.
+   */
+  baseUrl?: string;
+  /**
+   * The ID of the service token to use for authentication. Defaults to the value of the PLANETSCALE_SERVICE_TOKEN_ID environment variable.
+   */
+  serviceTokenId?: Secret;
+  /**
+   * The secret of the service token to use for authentication. Defaults to the value of the PLANETSCALE_SERVICE_TOKEN environment variable.
+   */
+  serviceToken?: Secret;
+  /**
+   * The API key to use for authentication. Defaults to the value of the PLANETSCALE_API_TOKEN environment variable.
+   * @deprecated Use serviceTokenId and serviceToken instead.
+   */
+  apiKey?: Secret;
+  /**
+   * The organization to use for authentication. Defaults to the value of the PLANETSCALE_ORGANIZATION or PLANETSCALE_ORG_ID environment variable.
+   */
+  organizationId?: string;
+}
+
+export class PlanetScaleError extends Error {
+  status: number;
+  method: string;
+  url: string;
+  code: string | undefined;
+
+  constructor(props: {
+    error: GeneralError;
+    request: Request;
+    response: Response;
+  }) {
+    super(
+      `A request to the PlanetScale API failed (${props.response.status}: ${props.error.message}`,
+    );
+    this.status = props.response.status;
+    this.method = props.request.method;
+    this.url = props.request.url;
+    this.code = props.error.code;
+  }
+}
+
+export type { PlanetScaleClient };
+
+export function createPlanetScaleClient(
+  options: PlanetScaleProps = {},
+): PlanetScaleClient {
+  const token = extractToken(options);
+  const client = createClient(
+    createConfig<ClientOptions>({
+      baseUrl: options.baseUrl ?? "https://api.planetscale.com/v1",
+      headers: {
+        Authorization: token, // PlanetScale does not use the Bearer prefix
+      },
+    }),
+  );
+  client.interceptors.error.use((error, response, request) => {
+    return new PlanetScaleError({
+      error: error as GeneralError,
+      request,
+      response,
+    });
+  });
+  return new PlanetScaleClient({
+    client,
+  });
+}
+
+const extractToken = (props: PlanetScaleProps) => {
+  if (props.apiKey) {
+    return props.apiKey.unencrypted;
+  } else if (props.serviceTokenId && props.serviceToken) {
+    return `${props.serviceTokenId.unencrypted}:${props.serviceToken.unencrypted}`;
+  } else if (process.env.PLANETSCALE_API_TOKEN) {
+    return process.env.PLANETSCALE_API_TOKEN;
+  } else if (
+    process.env.PLANETSCALE_SERVICE_TOKEN_ID &&
+    process.env.PLANETSCALE_SERVICE_TOKEN
+  ) {
+    return `${process.env.PLANETSCALE_SERVICE_TOKEN_ID}:${process.env.PLANETSCALE_SERVICE_TOKEN}`;
+  } else {
+    throw new Error(
+      "No authentication token provided for PlanetScale. Please provide an API key, service token ID and secret, or set the PLANETSCALE_SERVICE_TOKEN_ID and PLANETSCALE_SERVICE_TOKEN environment variables.",
+    );
+  }
+};

package/src/planetscale/branch.ts

@@ -1,7 +1,6 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
-import type { PlanetScaleProps } from "./api/client.gen.ts";
-import { PlanetScaleClient } from "./api/client.gen.ts";
+import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
 import {
   ensureProductionBranchClusterSize,
   sanitizeClusterSize,
@@ -81,7 +80,7 @@ export interface BranchProps extends PlanetScaleProps {
 /**
  * Represents a PlanetScale Branch
  */
-export interface Branch extends Resource<"planetscale::Branch">, BranchProps {
+export interface Branch extends BranchProps {
   /**
    * The name of the branch
    */
@@ -156,7 +155,7 @@ export const Branch = Resource(
   ): Promise<Branch> {
     const adopt = props.adopt ?? this.scope.adopt;
 
-    const api = new PlanetScaleClient(props);
+    const api = createPlanetScaleClient(props);
 
     const branchName =
       props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
@@ -173,16 +172,16 @@ export const Branch = Resource(
 
     if (this.phase === "delete") {
       if (this.output?.name) {
-        const response = await api.organizations.databases.branches.delete({
+        const response = await api.deleteBranch({
           path: {
             organization: props.organizationId,
             database: props.databaseName,
             name: this.output.name,
           },
-          result: "full",
+          throwOnError: false,
         });
 
-        if (response.error && response.error.status !== 404) {
+        if (response.error && response.response.status !== 404) {
           throw new Error(
             `Failed to delete branch: ${response.error.message}`,
             {
@@ -204,16 +203,16 @@ export const Branch = Resource(
     }
 
     // Check if branch exists
-    const getResponse = await api.organizations.databases.branches.get({
+    const getResponse = await api.getBranch({
       path: {
         organization: props.organizationId,
         database: props.databaseName,
         name: branchName,
       },
-      result: "full",
+      throwOnError: false,
     });
 
-    if (getResponse.error && getResponse.error.status !== 404) {
+    if (getResponse.error && getResponse.response.status !== 404) {
       // Error getting branch
       throw new Error(`Failed to get branch: ${getResponse.error.message}`, {
         cause: getResponse.error,
@@ -251,8 +250,10 @@ export const Branch = Resource(
 
       // Update mutable properties if they've changed
       if (props.safeMigrations !== undefined) {
-        await api.organizations.databases.branches.safeMigrations[
-          props.safeMigrations ? "post" : "delete"
+        await api[
+          props.safeMigrations
+            ? "enableSafeMigrations"
+            : "disableSafeMigrations"
         ]({
           path: {
             organization: props.organizationId,
@@ -286,14 +287,14 @@ export const Branch = Resource(
         );
       }
 
-      return this({
+      return {
         ...props,
         name: branchName,
         parentBranch: currentParentBranch,
         createdAt: data.created_at,
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
-      });
+      };
     }
     let clusterSize: string | undefined;
     const parent = await waitForBranchReady(
@@ -312,7 +313,7 @@ export const Branch = Resource(
     }
 
     // Branch doesn't exist, create it
-    const data = await api.organizations.databases.branches.post({
+    const { data } = await api.createBranch({
       path: {
         organization: props.organizationId,
         database: props.databaseName,
@@ -336,8 +337,8 @@ export const Branch = Resource(
         props.databaseName,
         branchName,
       );
-      await api.organizations.databases.branches.safeMigrations[
-        props.safeMigrations ? "post" : "delete"
+      await api[
+        props.safeMigrations ? "enableSafeMigrations" : "disableSafeMigrations"
       ]({
         path: {
           organization: props.organizationId,
@@ -359,13 +360,13 @@ export const Branch = Resource(
       );
     }
 
-    return this({
+    return {
       ...props,
       name: branchName,
       parentBranch: data.parent_branch,
       createdAt: data.created_at,
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
-    });
+    };
   },
 );

package/src/planetscale/database.ts

@@ -1,7 +1,7 @@
 import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
-import type { PlanetScaleProps } from "./api/client.gen.ts";
-import { PlanetScaleClient } from "./api/client.gen.ts";
+import type { PlanetScaleProps } from "./api.ts";
+import { createPlanetScaleClient } from "./api.ts";
 import {
   ensureProductionBranchClusterSize,
   type PlanetScaleClusterSize,
@@ -117,48 +117,47 @@ export type DatabaseProps = BaseDatabaseProps &
 /**
  * Represents a PlanetScale Database
  */
-export type Database = Resource<"planetscale::Database"> &
-  DatabaseProps & {
-    /**
-     * The unique identifier of the database
-     */
-    id: string;
+export type Database = DatabaseProps & {
+  /**
+   * The unique identifier of the database
+   */
+  id: string;
 
-    /**
-     * The name of the database
-     */
-    name: string;
+  /**
+   * The name of the database
+   */
+  name: string;
 
-    /**
-     * The current state of the database
-     */
-    state: string;
+  /**
+   * The current state of the database
+   */
+  state: string;
 
-    /**
-     * The default branch name
-     */
-    defaultBranch: string;
+  /**
+   * The default branch name
+   */
+  defaultBranch: string;
 
-    /**
-     * The plan type
-     */
-    plan: string;
+  /**
+   * The plan type
+   */
+  plan: string;
 
-    /**
-     * Time at which the database was created
-     */
-    createdAt: string;
+  /**
+   * Time at which the database was created
+   */
+  createdAt: string;
 
-    /**
-     * Time at which the database was last updated
-     */
-    updatedAt: string;
+  /**
+   * Time at which the database was last updated
+   */
+  updatedAt: string;
 
-    /**
-     * HTML URL to access the database
-     */
-    htmlUrl: string;
-  };
+  /**
+   * HTML URL to access the database
+   */
+  htmlUrl: string;
+};
 
 /**
  * Create, manage and delete PlanetScale databases
@@ -201,7 +200,7 @@ export const Database = Resource(
     id: string,
     props: DatabaseProps,
   ): Promise<Database> {
-    const api = new PlanetScaleClient(props);
+    const api = createPlanetScaleClient(props);
 
     const databaseName =
       props.name ?? this.output?.name ?? this.scope.createPhysicalName(id);
@@ -213,7 +212,7 @@ export const Database = Resource(
     });
 
     if (this.phase === "update" && this.output.name !== databaseName) {
-      await api.organizations.databases.patch({
+      await api.updateDatabaseSettings({
         path: {
           organization: props.organizationId,
           name: this.output.name,
@@ -224,15 +223,15 @@ export const Database = Resource(
 
     if (this.phase === "delete") {
       if (this.output?.name) {
-        const response = await api.organizations.databases.delete({
+        const response = await api.deleteDatabase({
           path: {
             organization: props.organizationId,
             name: this.output.name,
           },
-          result: "full",
+          throwOnError: false,
         });
 
-        if (response.error && response.error.status !== 404) {
+        if (response.error && response.response.status !== 404) {
           throw new Error(`Failed to delete database "${this.output.name}"`, {
             cause: response.error,
           });
@@ -242,12 +241,12 @@ export const Database = Resource(
     }
 
     // Check if database exists
-    const getResponse = await api.organizations.databases.get({
+    const getResponse = await api.getDatabase({
       path: {
         organization: props.organizationId,
         name: databaseName,
       },
-      result: "full",
+      throwOnError: false,
     });
     if (this.phase === "update" || (props.adopt && getResponse.data)) {
       if (!getResponse.data) {
@@ -258,20 +257,20 @@ export const Database = Resource(
       // Update database settings
       // If updating to a non-'main' default branch, create it first
       if (props.defaultBranch && props.defaultBranch !== "main") {
-        const branchResponse = await api.organizations.databases.branches.get({
+        const branchResponse = await api.getBranch({
           path: {
             organization: props.organizationId,
             database: databaseName,
             name: props.defaultBranch,
           },
-          result: "full",
+          throwOnError: false,
         });
         if (!branchResponse.data) {
           await waitForDatabaseReady(api, props.organizationId, databaseName);
         }
-        if (branchResponse.error && branchResponse.error.status === 404) {
+        if (branchResponse.error && branchResponse.response.status === 404) {
           // Create the branch
-          await api.organizations.databases.branches.post({
+          await api.createBranch({
             path: {
               organization: props.organizationId,
               database: databaseName,
@@ -284,7 +283,7 @@ export const Database = Resource(
         }
       }
 
-      const updateResponse = await api.organizations.databases.patch({
+      const { data } = await api.updateDatabaseSettings({
         path: {
           organization: props.organizationId,
           name: databaseName,
@@ -307,21 +306,21 @@ export const Database = Resource(
         props.organizationId,
         databaseName,
         props.defaultBranch || "main",
-        updateResponse.kind,
+        data.kind,
         clusterSize,
       );
 
-      return this({
+      return {
         ...props,
-        id: updateResponse.id,
+        id: data.id,
         name: databaseName,
-        state: updateResponse.state,
-        defaultBranch: updateResponse.default_branch,
-        plan: updateResponse.plan,
-        createdAt: updateResponse.created_at,
-        updatedAt: updateResponse.updated_at,
-        htmlUrl: updateResponse.html_url,
-      });
+        state: data.state,
+        defaultBranch: data.default_branch,
+        plan: data.plan,
+        createdAt: data.created_at,
+        updatedAt: data.updated_at,
+        htmlUrl: data.html_url,
+      };
     }
 
     if (getResponse.data) {
@@ -329,7 +328,7 @@ export const Database = Resource(
     }
 
     // Create new database
-    let data = await api.organizations.databases.post({
+    await api.createDatabase({
       path: {
         organization: props.organizationId,
       },
@@ -342,7 +341,7 @@ export const Database = Resource(
     });
 
     // These settings can't be set on creation, so we need to patch them after creation.
-    data = await api.organizations.databases.patch({
+    const { data } = await api.updateDatabaseSettings({
       path: {
         organization: props.organizationId,
         name: databaseName,
@@ -364,18 +363,18 @@ export const Database = Resource(
       await waitForDatabaseReady(api, props.organizationId, databaseName);
 
       // Check if branch exists
-      const branchResponse = await api.organizations.databases.branches.get({
+      const branchResponse = await api.getBranch({
         path: {
           organization: props.organizationId,
           database: databaseName,
           name: props.defaultBranch,
         },
-        result: "full",
+        throwOnError: false,
       });
 
-      if (branchResponse.error && branchResponse.error.status === 404) {
+      if (branchResponse.error && branchResponse.response.status === 404) {
         // Create the branch
-        await api.organizations.databases.branches.post({
+        await api.createBranch({
           path: {
             organization: props.organizationId,
             database: databaseName,
@@ -396,7 +395,7 @@ export const Database = Resource(
         );
 
         // Update database to use new branch as default
-        const updatedData = await api.organizations.databases.patch({
+        const { data: updatedData } = await api.updateDatabaseSettings({
           path: {
             organization: props.organizationId,
             name: databaseName,
@@ -406,7 +405,7 @@ export const Database = Resource(
           },
         });
 
-        return this({
+        return {
           ...props,
           id: data.id,
           name: databaseName,
@@ -416,11 +415,11 @@ export const Database = Resource(
           createdAt: updatedData.created_at,
           updatedAt: updatedData.updated_at,
           htmlUrl: updatedData.html_url,
-        });
+        };
       }
     }
 
-    return this({
+    return {
       ...props,
       id: data.id,
       name: databaseName,
@@ -430,6 +429,6 @@ export const Database = Resource(
       createdAt: data.created_at,
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
-    });
+    };
   },
 );

package/src/planetscale/index.ts

@@ -1,4 +1,4 @@
-export * from "./api/client.gen.ts";
+export * from "./api.ts";
 export * from "./branch.ts";
 export * from "./database.ts";
 export * from "./password.ts";

package/src/planetscale/password.ts

@@ -4,7 +4,7 @@ import type { Context } from "../context.ts";
 import { Resource } from "../resource.ts";
 import type { Secret } from "../secret.ts";
 import { lowercaseId } from "../util/nanoid.ts";
-import { PlanetScaleClient, type PlanetScaleProps } from "./api/client.gen.ts";
+import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
 import type { Branch } from "./branch.ts";
 import type { Database } from "./database.ts";
 
@@ -62,9 +62,7 @@ export interface PasswordProps extends PlanetScaleProps {
 /**
  * Represents a PlanetScale Branch
  */
-export interface Password
-  extends Resource<"planetscale::Password">,
-    PasswordProps {
+export interface Password extends PasswordProps {
   /**
    * The unique identifier for the password
    */
@@ -267,7 +265,7 @@ export const Password = Resource(
       : (this.output?.nameSlug ?? lowercaseId());
     const name = `${(props.name ?? this.output?.name ?? this.scope.createPhysicalName(id)).toLowerCase()}-${nameSlug}`;
 
-    const api = new PlanetScaleClient(props);
+    const api = createPlanetScaleClient(props);
     const database =
       typeof props.database === "string" ? props.database : props.database.name;
     const branch =
@@ -285,19 +283,17 @@ export const Password = Resource(
 
     if (this.phase === "delete") {
       if (this.output?.id) {
-        const res = await api.organizations.databases.branches.passwords.delete(
-          {
-            path: {
-              organization,
-              database,
-              branch,
-              id: this.output.id,
-            },
-            result: "full",
+        const res = await api.deletePassword({
+          path: {
+            organization,
+            database,
+            branch,
+            id: this.output.id,
           },
-        );
+          throwOnError: false,
+        });
 
-        if (res.error && res.error.status !== 404) {
+        if (res.error && res.response.status !== 404) {
           throw new Error(`Failed to delete branch "${branch}"`, {
             cause: res.error,
           });
@@ -314,7 +310,7 @@ export const Password = Resource(
       ) {
         return this.replace();
       }
-      await api.organizations.databases.branches.passwords.patch({
+      await api.updatePassword({
         path: {
           organization,
           database,
@@ -327,14 +323,14 @@ export const Password = Resource(
         },
       });
 
-      return this({
+      return {
         ...this.output,
         ...props,
         name,
-      });
+      };
     }
 
-    const data = await api.organizations.databases.branches.passwords.post({
+    const { data } = await api.createPassword({
       path: {
         organization,
         database,
@@ -349,7 +345,7 @@ export const Password = Resource(
       },
     });
 
-    return this({
+    return {
       id: data.id,
       expiresAt: data.expires_at,
       host: data.access_host_url,
@@ -358,7 +354,7 @@ export const Password = Resource(
       nameSlug,
       ...props,
       name: `${props.name}-${nameSlug}`,
-    });
+    };
   },
 );