alchemy 0.71.1 → 0.72.0

package/src/planetscale/database.ts

@@ -18,9 +18,10 @@ interface BaseDatabaseProps extends PlanetScaleProps {
   name?: string;
 
   /**
-   * The organization ID where the database will be created
+   * The organization name where the database will be created
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId: string;
+  organization?: string;
 
   /**
    * Whether to adopt the database if it already exists in Planetscale
@@ -157,6 +158,11 @@ export type Database = DatabaseProps & {
    * HTML URL to access the database
    */
   htmlUrl: string;
+
+  /**
+   * The organization of the database
+   */
+  organization: string;
 };
 
 /**
@@ -166,7 +172,7 @@ export type Database = DatabaseProps & {
  * // Create a basic database in a specific organization
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
@@ -174,7 +180,7 @@ export type Database = DatabaseProps & {
  * // Create a database with specific region and settings
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   region: {
  *     slug: "us-east"
  *   },
@@ -188,7 +194,7 @@ export type Database = DatabaseProps & {
  * // Create a database with custom API key
  * const db = await Database("my-app-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   apiKey: alchemy.secret(process.env.CUSTOM_PLANETSCALE_TOKEN),
  *   clusterSize: "PS_10"
  * });
@@ -210,11 +216,22 @@ export const Database = Resource(
       arch: props.arch,
       region: props.region?.slug,
     });
+    const organization =
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      process.env.PLANETSCALE_ORGANIZATION ??
+      process.env.PLANETSCALE_ORG_ID;
+    if (!organization) {
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
+    }
 
     if (this.phase === "update" && this.output.name !== databaseName) {
       await api.updateDatabaseSettings({
         path: {
-          organization: props.organizationId,
+          organization,
           name: this.output.name,
         },
         body: { new_name: databaseName },
@@ -225,7 +242,7 @@ export const Database = Resource(
       if (this.output?.name) {
         const response = await api.deleteDatabase({
           path: {
-            organization: props.organizationId,
+            organization,
             name: this.output.name,
           },
           throwOnError: false,
@@ -243,7 +260,7 @@ export const Database = Resource(
     // Check if database exists
     const getResponse = await api.getDatabase({
       path: {
-        organization: props.organizationId,
+        organization,
         name: databaseName,
       },
       throwOnError: false,
@@ -259,20 +276,20 @@ export const Database = Resource(
       if (props.defaultBranch && props.defaultBranch !== "main") {
         const branchResponse = await api.getBranch({
           path: {
-            organization: props.organizationId,
+            organization,
             database: databaseName,
             name: props.defaultBranch,
           },
           throwOnError: false,
         });
         if (!branchResponse.data) {
-          await waitForDatabaseReady(api, props.organizationId, databaseName);
+          await waitForDatabaseReady(api, organization, databaseName);
         }
         if (branchResponse.error && branchResponse.response.status === 404) {
           // Create the branch
           await api.createBranch({
             path: {
-              organization: props.organizationId,
+              organization,
               database: databaseName,
             },
             body: {
@@ -285,7 +302,7 @@ export const Database = Resource(
 
       const { data } = await api.updateDatabaseSettings({
         path: {
-          organization: props.organizationId,
+          organization,
           name: databaseName,
         },
         body: {
@@ -303,7 +320,7 @@ export const Database = Resource(
 
       await ensureProductionBranchClusterSize(
         api,
-        props.organizationId,
+        organization,
         databaseName,
         props.defaultBranch || "main",
         data.kind,
@@ -320,6 +337,7 @@ export const Database = Resource(
         createdAt: data.created_at,
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
+        organization,
       };
     }
 
@@ -330,7 +348,7 @@ export const Database = Resource(
     // Create new database
     await api.createDatabase({
       path: {
-        organization: props.organizationId,
+        organization,
       },
       body: {
         name: databaseName,
@@ -343,7 +361,7 @@ export const Database = Resource(
     // These settings can't be set on creation, so we need to patch them after creation.
     const { data } = await api.updateDatabaseSettings({
       path: {
-        organization: props.organizationId,
+        organization,
         name: databaseName,
       },
       body: {
@@ -360,12 +378,12 @@ export const Database = Resource(
 
     // If a non-'main' default branch is specified, create it
     if (props.defaultBranch && props.defaultBranch !== "main") {
-      await waitForDatabaseReady(api, props.organizationId, databaseName);
+      await waitForDatabaseReady(api, organization, databaseName);
 
       // Check if branch exists
       const branchResponse = await api.getBranch({
         path: {
-          organization: props.organizationId,
+          organization,
           database: databaseName,
           name: props.defaultBranch,
         },
@@ -376,7 +394,7 @@ export const Database = Resource(
         // Create the branch
         await api.createBranch({
           path: {
-            organization: props.organizationId,
+            organization,
             database: databaseName,
           },
           body: {
@@ -387,7 +405,7 @@ export const Database = Resource(
 
         await ensureProductionBranchClusterSize(
           api,
-          props.organizationId,
+          organization,
           databaseName,
           props.defaultBranch || "main",
           data.kind,
@@ -397,7 +415,7 @@ export const Database = Resource(
         // Update database to use new branch as default
         const { data: updatedData } = await api.updateDatabaseSettings({
           path: {
-            organization: props.organizationId,
+            organization,
             name: databaseName,
           },
           body: {
@@ -415,6 +433,7 @@ export const Database = Resource(
           createdAt: updatedData.created_at,
           updatedAt: updatedData.updated_at,
           htmlUrl: updatedData.html_url,
+          organization,
         };
       }
     }
@@ -429,6 +448,7 @@ export const Database = Resource(
       createdAt: data.created_at,
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
+      organization,
     };
   },
 );

package/src/planetscale/index.ts

@@ -1,6 +1,7 @@
 export * from "./api.ts";
 export * from "./branch.ts";
 export * from "./database.ts";
+export * from "./organization.ts";
 export * from "./password.ts";
 export * from "./role.ts";
 export * from "./utils.ts";

package/src/planetscale/organization.ts

@@ -0,0 +1,17 @@
+import { createPlanetScaleClient, type PlanetScaleProps } from "./api.ts";
+import type { Organization } from "./api/types.gen.ts";
+
+export type OrganizationRef = Organization;
+
+export async function OrganizationRef(
+  name: string | Organization,
+  options: PlanetScaleProps = {},
+) {
+  const api = createPlanetScaleClient(options);
+  const organization = await api.getOrganization({
+    path: {
+      name: typeof name === "string" ? name : name.id,
+    },
+  });
+  return organization.data;
+}

package/src/planetscale/password.ts

@@ -22,8 +22,9 @@ export interface PasswordProps extends PlanetScaleProps {
   /**
    * The organization ID where the password will be created
    * Required when using string database name, optional when using Database or Branch resource
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId?: string;
+  organization?: string;
 
   /**
    * The database where the password will be created
@@ -114,7 +115,7 @@ export interface Password extends PasswordProps {
  *
  * const readerPassword = await Password("app-reader", {
  *   name: "app-reader",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "reader"
@@ -136,7 +137,7 @@ export interface Password extends PasswordProps {
  *
  * const writerPassword = await Password("app-writer", {
  *   name: "app-writer",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "development",
  *   role: "writer",
@@ -157,7 +158,7 @@ export interface Password extends PasswordProps {
  *
  * const adminPassword = await Password("admin-access", {
  *   name: "admin-access",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "admin",
@@ -176,7 +177,7 @@ export interface Password extends PasswordProps {
  *
  * const password = await Password("custom-auth", {
  *   name: "custom-auth",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "readwriter",
@@ -194,7 +195,7 @@ export interface Password extends PasswordProps {
  *
  * const replicaPassword = await Password("replica-reader", {
  *   name: "replica-reader",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   database: "my-app-db",
  *   branch: "main",
  *   role: "reader",
@@ -211,7 +212,7 @@ export interface Password extends PasswordProps {
  *
  * const database = await Database("my-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
@@ -232,13 +233,13 @@ export interface Password extends PasswordProps {
  *
  * const database = await Database("my-db", {
  *   name: "my-app-db",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   clusterSize: "PS_10"
  * });
  *
  * const branch = await Branch("feature-branch", {
  *   name: "feature-branch",
- *   organizationId: "my-org",
+ *   organization: "my-org",
  *   databaseName: "my-app-db",
  *   parentBranch: "main",
  *   isProduction: false
@@ -266,19 +267,36 @@ export const Password = Resource(
     const name = `${(props.name ?? this.output?.name ?? this.scope.createPhysicalName(id)).toLowerCase()}-${nameSlug}`;
 
     const api = createPlanetScaleClient(props);
+    if (!props.organization && typeof props.database === "string") {
+      throw new Error(
+        "Organization ID is required when using string database name",
+      );
+    }
+
+    const organization =
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      (typeof props.database !== "string"
+        ? props.database.organization
+        : typeof props.branch !== "string" && props.branch
+          ? props.branch.organization
+          : (process.env.PLANETSCALE_ORGANIZATION ??
+            process.env.PLANETSCALE_ORG_ID));
     const database =
-      typeof props.database === "string" ? props.database : props.database.name;
+      // @ts-expect-error - databaseName is a legacy thing, we keep this so we can destroy
+      this.output?.databaseName ??
+      (typeof props.database === "string"
+        ? props.database
+        : props.database.name);
     const branch =
       typeof props.branch === "string"
         ? props.branch
         : (props.branch?.name ?? "main");
-    const organization =
-      props.organizationId ??
-      ((typeof props.branch !== "string" && props.branch?.organizationId) ||
-        (typeof props.database !== "string" && props.database.organizationId));
-
     if (!organization) {
-      throw new Error("Organization ID is required");
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
     }
 
     if (this.phase === "delete") {

package/src/planetscale/role.ts

@@ -16,8 +16,9 @@ export interface RoleProps extends PlanetScaleProps {
   /**
    * The organization ID where the role will be created
    * Required when using string database name, optional when using Database resource
+   * @default process.env.PLANETSCALE_ORGANIZATION
    */
-  organizationId?: string;
+  organization?: string;
 
   /**
    * The database where the role will be created
@@ -164,12 +165,21 @@ export const Role = Resource(
     props: RoleProps,
   ): Promise<Role> {
     const api = createPlanetScaleClient(props);
+
     const organization =
-      typeof props.branch === "object"
-        ? props.branch.organizationId
-        : typeof props.database === "object"
-          ? props.database.organizationId
-          : props.organizationId;
+      // @ts-expect-error - organizationId is a legacy thing, we keep this so we can destroy
+      this.output?.organizationId ??
+      props.organization ??
+      (typeof props.database !== "string"
+        ? props.database.organization
+        : (process.env.PLANETSCALE_ORGANIZATION ??
+          process.env.PLANETSCALE_ORG_ID));
+    if (!organization) {
+      throw new Error(
+        "PlanetScale organization is required. Please set the `organization` property or the `PLANETSCALE_ORGANIZATION` environment variable.",
+      );
+    }
+
     const database =
       typeof props.database === "string" ? props.database : props.database.name;
     const branch =
@@ -179,9 +189,6 @@ export const Role = Resource(
     const inheritedRoles = Array.isArray(props.inheritedRoles)
       ? props.inheritedRoles
       : props.inheritedRoles.inheritedRoles;
-    if (!organization) {
-      throw new Error("Organization ID is required");
-    }
 
     switch (this.phase) {
       case "delete": {

package/workers/tunnel-proxy.js

@@ -34,7 +34,7 @@ var h={async fetch(e,r){let n=new URL(e.url);n.host=r.TUNNEL_HOST;let l=new Head
             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.71.1</p>
+        <p class="text-sm text-slate-500">Alchemy 0.72.0</p>
       </div>
     </div>
   </body>