refactor(planetscale): rename actualRegion to region, drop displayName, add docs links

Address PR review feedback:
- Rename actualRegion to region on Branch and Database output types
  (outputs overwrite inputs with actual values per alchemy convention)
- Drop displayName from region output (redundant)
- Use concise region: { slug: data.region.slug } in return statements
- Add @see links to PlanetScale regions docs
- Fix example slugs to include GCP regions

Author: mmkal

alchemy/src/planetscale/branch.ts

@@ -88,10 +88,14 @@ export interface BranchProps extends PlanetScaleProps {
    * The region to create the branch in.
    * If not provided, the branch will be created in the default region for its database.
    * On adopt/update, if specified, the actual branch region is validated against this value.
+   *
+   * @see https://planetscale.com/docs/concepts/regions
    */
   region?: {
     /**
-     * The slug identifier of the region (e.g. "us-east", "eu-west")
+     * 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;
   };
@@ -127,17 +131,17 @@ export interface Branch extends BranchProps {
   htmlUrl: string;
 
   /**
-   * The actual region of the branch as reported by PlanetScale
+   * The region of the branch as reported by PlanetScale.
+   *
+   * @see https://planetscale.com/docs/concepts/regions
    */
-  actualRegion: {
+  region: {
     /**
-     * The slug identifier of the region (e.g. "us-east", "eu-west")
+     * 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;
-    /**
-     * Display name of the region (e.g. "US East", "EU West")
-     */
-    displayName: string;
   };
 }
 
@@ -361,10 +365,7 @@ export const Branch = Resource(
         createdAt: data.created_at,
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
-        actualRegion: {
-          slug: data.region.slug,
-          displayName: data.region.display_name,
-        },
+        region: { slug: data.region.slug },
       };
     }
     let clusterSize: string | undefined;
@@ -434,10 +435,7 @@ export const Branch = Resource(
       createdAt: data.created_at,
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
-      actualRegion: {
-        slug: data.region.slug,
-        displayName: data.region.display_name,
-      },
+      region: { slug: data.region.slug },
     };
   },
 );

alchemy/src/planetscale/database.ts

@@ -42,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;
   };
@@ -219,17 +223,17 @@ export type Database = DatabaseProps & {
   organization: string;
 
   /**
-   * The actual region of the database as reported by PlanetScale
+   * The region of the database as reported by PlanetScale.
+   *
+   * @see https://planetscale.com/docs/concepts/regions
    */
-  actualRegion: {
+  region: {
     /**
-     * The slug identifier of the region (e.g. "us-east", "eu-west")
+     * 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;
-    /**
-     * Display name of the region (e.g. "US East", "EU West")
-     */
-    displayName: string;
   };
 };
 
@@ -480,10 +484,7 @@ export const Database = Resource(
         updatedAt: data.updated_at,
         htmlUrl: data.html_url,
         organization,
-        actualRegion: {
-          slug: data.region.slug,
-          displayName: data.region.display_name,
-        },
+        region: { slug: data.region.slug },
       };
     }
 
@@ -607,10 +608,7 @@ export const Database = Resource(
           updatedAt: updatedData.updated_at,
           htmlUrl: updatedData.html_url,
           organization,
-          actualRegion: {
-            slug: updatedData.region.slug,
-            displayName: updatedData.region.display_name,
-          },
+          region: { slug: updatedData.region.slug },
         };
       }
     }
@@ -638,10 +636,7 @@ export const Database = Resource(
       updatedAt: data.updated_at,
       htmlUrl: data.html_url,
       organization,
-      actualRegion: {
-        slug: data.region.slug,
-        displayName: data.region.display_name,
-      },
+      region: { slug: data.region.slug },
     };
   },
 );

alchemy/test/planetscale/database.test.ts

@@ -51,9 +51,8 @@ describe.skipIf(!process.env.PLANETSCALE_TEST).concurrent.each(kinds)(
           updatedAt: expect.any(String),
           htmlUrl: expect.any(String),
           kind,
-          actualRegion: {
+          region: {
             slug: expect.any(String),
-            displayName: expect.any(String),
           },
         });
 
@@ -314,9 +313,8 @@ describe.skipIf(!process.env.PLANETSCALE_TEST).concurrent.each(kinds)(
           delete: true,
         });
 
-        expect(database.actualRegion).toMatchObject({
+        expect(database.region).toMatchObject({
           slug: "us-east",
-          displayName: expect.any(String),
         });
 
         // Now try to adopt it with a different region — should throw
@@ -341,7 +339,7 @@ describe.skipIf(!process.env.PLANETSCALE_TEST).concurrent.each(kinds)(
           delete: true,
         });
 
-        expect(adopted.actualRegion.slug).toBe("us-east");
+        expect(adopted.region.slug).toBe("us-east");
       } finally {
         await destroy(scope);
         await assertDatabaseDeleted(api, organization, name);