@alchemy.run/planetscale 0.0.0 → 2.0.0-beta.84

package/lib/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAClG,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/lib/index.js

@@ -0,0 +1,9 @@
+export * as Auth from "./AuthProvider.js";
+export { makeBranchProvider } from "./Branch.js";
+export { Credentials, CredentialsFromEnv, DEFAULT_API_BASE_URL, fromAuthProvider, fromToken, } from "./Credentials.js";
+export * from "./Database.js";
+export * from "./MySQL/index.js";
+export * from "./Postgres/index.js";
+export * from "./Providers.js";
+export * from "./Util.js";
+//# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,mBAAmB,CAAC;AAC1C,OAAO,EAAmD,kBAAkB,EAAE,MAAM,aAAa,CAAC;AAClG,OAAO,EACL,WAAW,EACX,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,SAAS,GACV,MAAM,kBAAkB,CAAC;AAC1B,cAAc,eAAe,CAAC;AAC9B,cAAc,kBAAkB,CAAC;AACjC,cAAc,qBAAqB,CAAC;AACpC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,WAAW,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alchemy.run/planetscale",
-  "version": "0.0.0",
+  "version": "2.0.0-beta.84",
   "description": "PlanetScale MySQL and Postgres databases for Alchemy.",
   "keywords": [
     "alchemy",
@@ -10,12 +10,88 @@
     "planetscale",
     "postgres"
   ],
+  "homepage": "https://alchemy.run",
+  "bugs": {
+    "url": "https://github.com/alchemy-run/alchemy/issues"
+  },
   "license": "Apache-2.0",
   "author": "Sam Goodwin <sam@alchemy.run>",
-  "homepage": "https://alchemy.run",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/alchemy-run/alchemy.git",
     "directory": "packages/planetscale"
+  },
+  "files": [
+    "lib",
+    "src"
+  ],
+  "type": "module",
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./lib/index.d.ts",
+      "bun": "./src/index.ts",
+      "worker": "./src/index.ts",
+      "default": "./lib/index.js"
+    },
+    "./MySQL": {
+      "types": "./lib/MySQL/index.d.ts",
+      "bun": "./src/MySQL/index.ts",
+      "worker": "./src/MySQL/index.ts",
+      "default": "./lib/MySQL/index.js"
+    },
+    "./Postgres": {
+      "types": "./lib/Postgres/index.d.ts",
+      "bun": "./src/Postgres/index.ts",
+      "worker": "./src/Postgres/index.ts",
+      "default": "./lib/Postgres/index.js"
+    },
+    "./*": {
+      "types": "./lib/*.d.ts",
+      "bun": "./src/*.ts",
+      "worker": "./src/*.ts",
+      "default": "./lib/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@alchemy.run/sql": "2.0.0-beta.84",
+    "@distilled.cloud/core": "1.0.0-rc.17",
+    "@distilled.cloud/planetscale": "1.0.0-rc.17"
+  },
+  "devDependencies": {
+    "@types/bun": "1.4.3",
+    "@types/pg": "^8.20.0",
+    "alchemy": "2.0.0-beta.84",
+    "effect": "^4.0.5",
+    "mysql2": "^3.24.2",
+    "pg": "^8.22.0",
+    "typescript": "^7.0.2"
+  },
+  "peerDependencies": {
+    "alchemy": "2.0.0-beta.84",
+    "effect": "^4.0.5",
+    "mysql2": "^3.24.2",
+    "pg": "^8.22.0"
+  },
+  "peerDependenciesMeta": {
+    "mysql2": {
+      "optional": true
+    },
+    "pg": {
+      "optional": true
+    }
+  },
+  "alchemy": {
+    "contributes": [
+      "@alchemy.run/planetscale/Contributions"
+    ]
+  },
+  "scripts": {
+    "build": "pnpm -r --filter \"{.}...\" run build:package",
+    "build:package": "node scripts/build.ts"
   }
-}
+}

package/src/AuthProvider.ts

@@ -0,0 +1,571 @@
+import { listOrganizations } from "@distilled.cloud/planetscale";
+import * as PsCredentialsModule from "@distilled.cloud/planetscale/Credentials";
+import {
+  AuthError,
+  AuthProviderLayer,
+  refreshHint,
+  type ConfigureField,
+  type ConfigureMethod,
+  NeedsReauth,
+  type ProviderDetails,
+} from "alchemy/Auth/AuthProvider";
+import { browserOAuth } from "alchemy/Auth/BrowserOAuth";
+import { displayRedacted } from "alchemy/Auth/Credentials";
+import { getEnvRedactedRequired, getEnvRequired, mapPromptCancellation } from "alchemy/Auth/Env";
+import { withProfileCredentialsLock } from "alchemy/Auth/Lock";
+import {
+  storedSecret,
+  storedValueText,
+  validateFieldValues,
+} from "alchemy/Auth/StoredAuthProvider";
+import * as Interaction from "alchemy/Interaction";
+import * as Clock from "effect/Clock";
+import * as Duration from "effect/Duration";
+import * as Effect from "effect/Effect";
+import * as FetchHttpClient from "effect/http/FetchHttpClient";
+import * as HttpClient from "effect/http/HttpClient";
+import * as Layer from "effect/Layer";
+import * as Match from "effect/Match";
+import * as Redacted from "effect/Redacted";
+import * as Schema from "effect/Schema";
+import * as OAuthClient from "./OAuthClient.ts";
+
+/**
+ * Canonical name registered in {@link AuthProviders}. Use this key to look
+ * up the PlanetScale {@link AuthProvider} from inside provider Layers.
+ */
+export const PLANETSCALE_AUTH_PROVIDER_NAME = "Planetscale";
+
+/**
+ * Provide PlanetScale `Credentials` + `HttpClient` to an Effect using a
+ * just-obtained OAuth access token. Used during configure to call
+ * org-discovery endpoints before the user has chosen an org.
+ *
+ * `organization` is required by the credential type but isn't consulted by
+ * `listOrganizations` (it's a user-scoped endpoint), so an empty string is
+ * fine here.
+ */
+const withOAuthCredentials = <A, E, R>(
+  accessToken: string,
+  effect: Effect.Effect<A, E, R | PsCredentialsModule.Credentials | HttpClient.HttpClient>,
+): Effect.Effect<A, E, R> =>
+  Effect.provide(
+    effect,
+    Layer.mergeAll(
+      PsCredentialsModule.fromOAuth({
+        accessToken: Redacted.make(accessToken),
+        organization: "",
+      }),
+      FetchHttpClient.layer,
+    ),
+  );
+
+/**
+ * List the organizations the OAuth user belongs to and either auto-pick
+ * (one org) or prompt the user to choose. Returns the org's URL slug
+ * (`name` field, used as `{organization}` in API paths).
+ */
+const selectOrganization = (accessToken: string) =>
+  Effect.gen(function* () {
+    const interaction = Interaction.accessors;
+    const list = yield* listOrganizations;
+    const response = yield* list({});
+    const orgs = response.data;
+    if (orgs.length === 0) {
+      return yield* AuthError.make({
+        message: "Planetscale: no organizations found for this credential.",
+      });
+    }
+    if (orgs.length === 1) {
+      const org = orgs[0];
+      if (org === undefined) {
+        return yield* AuthError.make({
+          message: "Planetscale: organization response was unexpectedly empty.",
+        });
+      }
+      yield* interaction.output.info(`Planetscale: using organization: ${org.name} (${org.id})`);
+      return org.name;
+    }
+    return yield* interaction.prompt
+      .select({
+        message: "Select a Planetscale organization",
+        options: orgs.map((o) => ({
+          value: o.name,
+          label: o.name,
+          description: o.id,
+        })),
+      })
+      .pipe(mapPromptCancellation);
+  }).pipe((e) => withOAuthCredentials(accessToken, e));
+
+const options: Array<{
+  value: PlanetscaleAuthConfig["method"];
+  label: string;
+  description?: string;
+}> = [
+  {
+    value: "oauth",
+    label: "OAuth",
+    description: "recommended — browser-based login with automatic token refresh",
+  },
+  {
+    value: "stored",
+    label: "Service Token",
+    description: "enter a service token and store it inline in the provider file",
+  },
+];
+
+/**
+ * Typed values stored in a PlanetScale provider profile document. Both
+ * service-token and OAuth values are inline. PlanetScale has no PKCE flow,
+ * so the OAuth application's
+ *   `client_secret` ships in the CLI — see {@link OAuthClient}.
+ */
+export const PlanetscaleAuthConfigSchema = Schema.Union([
+  Schema.Struct({
+    method: Schema.Literal("stored"),
+    tokenId: Schema.String,
+    token: Schema.String,
+    organization: Schema.String,
+  }),
+  Schema.Struct({
+    method: Schema.Literal("oauth"),
+    organization: Schema.String,
+    clientId: Schema.optional(Schema.String),
+    access: Schema.String,
+    refresh: Schema.String,
+    expires: Schema.Number,
+    scopes: Schema.String.pipe(Schema.Array, Schema.mutable),
+  }),
+]);
+export type PlanetscaleAuthConfig = typeof PlanetscaleAuthConfigSchema.Type;
+
+/**
+ * Resolved in-memory PlanetScale credentials returned by
+ * {@link AuthProviderImpl.read}. Either a service token (`tokenId`/`token`)
+ * or an OAuth access token.
+ */
+export type PlanetscaleResolvedCredentials =
+  | {
+      type: "apiToken";
+      tokenId: Redacted.Redacted<string>;
+      token: Redacted.Redacted<string>;
+      organization: string;
+      source: {
+        type: PlanetscaleAuthConfig["method"] | "env";
+        details?: string;
+      };
+    }
+  | {
+      type: "oauth";
+      accessToken: Redacted.Redacted<string>;
+      expires: number;
+      organization: string;
+      source: {
+        type: PlanetscaleAuthConfig["method"] | "env";
+        details?: string;
+      };
+    };
+
+/**
+ * Layer that registers the PlanetScale {@link AuthProvider} into the
+ * {@link AuthProviders} registry when built. Include this in the
+ * PlanetScale `providers()` layer so the alchemy CLI can discover it.
+ *
+ * Supported methods:
+ * - `stored`: prompts for a service token and stores it inline.
+ * - `oauth`: browser-based login storing access/refresh values inline.
+ */
+export const PlanetscaleAuth = AuthProviderLayer<
+  PlanetscaleAuthConfig,
+  PlanetscaleResolvedCredentials
+>()(
+  PLANETSCALE_AUTH_PROVIDER_NAME,
+  Effect.gen(function* () {
+    const interaction = Interaction.accessors;
+    const oauthLogin = (_profileName: string) =>
+      Effect.gen(function* () {
+        const authorization = yield* OAuthClient.authorize();
+
+        const credentials = yield* browserOAuth({
+          provider: "Planetscale",
+          url: authorization.url,
+          callback: OAuthClient.callback(authorization),
+          exchange: (input) => OAuthClient.exchangeCallbackInput(input, authorization),
+        });
+        yield* interaction.output.success("Planetscale: OAuth credentials saved.");
+        return credentials;
+      });
+
+    const configureOAuth = Effect.fn(function* (profileName: string) {
+      const oauthCreds = yield* oauthLogin(profileName);
+
+      // Use the just-issued access token to list the user's orgs and let
+      // them pick (mirrors Cloudflare's selectAccount). Requires the
+      // `user:read_organizations` scope. If the call fails for any
+      // reason — missing scope, network, off-spec response — fall back
+      // to a manual prompt so login still completes.
+      const organization = yield* oauthCreds.access.pipe(
+        Redacted.value,
+        selectOrganization,
+        Effect.catch((e) =>
+          Effect.gen(function* () {
+            yield* interaction.output.warning(
+              `Planetscale: could not auto-list organizations (${String(e)}). Falling back to manual entry.`,
+            );
+            return yield* interaction.prompt
+              .text({
+                message: "Planetscale Organization (URL slug)",
+                validate: (v) => (v.length === 0 ? "Required" : undefined),
+              })
+              .pipe(mapPromptCancellation);
+          }),
+        ),
+      );
+
+      return {
+        method: "oauth" as const,
+        organization,
+        clientId: oauthCreds.clientId,
+        access: Redacted.value(oauthCreds.access),
+        refresh: Redacted.value(oauthCreds.refresh),
+        expires: oauthCreds.expires,
+        scopes: oauthCreds.scopes,
+      };
+    });
+
+    const loginStored = Effect.fn(function* (_profileName: string) {
+      const tokenId = yield* interaction.prompt
+        .text({
+          message: "Planetscale Service Token ID",
+          validate: (v) => (v.length === 0 ? "Required" : undefined),
+        })
+        .pipe(mapPromptCancellation);
+
+      const token = yield* interaction.prompt
+        .password({
+          message: "Planetscale Service Token",
+          validate: (v) => (v.length === 0 ? "Required" : undefined),
+        })
+        .pipe(mapPromptCancellation);
+
+      const organization = yield* interaction.prompt
+        .text({
+          message: "Planetscale Organization (URL slug)",
+          validate: (v) => (v.length === 0 ? "Required" : undefined),
+        })
+        .pipe(mapPromptCancellation);
+
+      yield* interaction.output.success("Planetscale: credentials saved.");
+      return { method: "stored" as const, tokenId, token, organization };
+    });
+
+    const configureInteractive = (profileName: string) =>
+      interaction.prompt
+        .select({
+          message: "Planetscale authentication method",
+          options,
+        })
+        .pipe(
+          Effect.flatMap((method) =>
+            Match.value(method).pipe(
+              Match.when("oauth", () => configureOAuth(profileName)),
+              Match.when("stored", () => loginStored(profileName)),
+              Match.exhaustive,
+            ),
+          ),
+        );
+
+    const configureCredentials = (profileName: string) =>
+      configureInteractive(profileName).pipe(
+        Effect.mapError((e) =>
+          AuthError.make({
+            message: "failed to configure credentials",
+            cause: e,
+          }),
+        ),
+      );
+
+    /**
+     * Flag-driven (`--method stored --set ...`) fields, mirroring the
+     * interactive service-token prompts. OAuth requires a browser and stays
+     * interactive-only, so it is deliberately absent from
+     * {@link configureMethods}.
+     */
+    const serviceTokenFields: ReadonlyArray<ConfigureField> = [
+      { name: "tokenId", label: "Planetscale Service Token ID" },
+      { name: "token", label: "Planetscale Service Token", secret: true },
+      { name: "organization", label: "Planetscale Organization (URL slug)" },
+    ];
+
+    const configureMethods: ReadonlyArray<ConfigureMethod> = [
+      { method: "stored", fields: serviceTokenFields },
+    ];
+
+    const configureWith = (
+      _profileName: string,
+      input: {
+        readonly method: string;
+        readonly values: Record<string, string>;
+      },
+    ): Effect.Effect<PlanetscaleAuthConfig, AuthError, Interaction.Interaction> =>
+      input.method === "stored"
+        ? validateFieldValues(
+            PLANETSCALE_AUTH_PROVIDER_NAME,
+            serviceTokenFields,
+            input.values,
+          ).pipe(
+            Effect.map((values) => ({
+              method: "stored" as const,
+              tokenId: Redacted.value(storedSecret(values.tokenId) ?? Redacted.make("")),
+              token: Redacted.value(storedSecret(values.token) ?? Redacted.make("")),
+              organization: storedValueText(values.organization) ?? "",
+            })),
+            Effect.tap(() => interaction.output.success("Planetscale: credentials saved.")),
+          )
+        : Effect.fail(
+            AuthError.make({
+              message: `Planetscale: unknown method '${input.method}'. Valid methods: stored. (OAuth is interactive-only.)`,
+            }),
+          );
+
+    const resolveCredentials = (
+      profileName: string,
+      config: PlanetscaleAuthConfig,
+      updateConfig?: (config: PlanetscaleAuthConfig) => Effect.Effect<void, AuthError>,
+    ) =>
+      Effect.gen(function* () {
+        const reauth = refreshHint(PLANETSCALE_AUTH_PROVIDER_NAME, profileName);
+        return yield* Match.value(config).pipe(
+          Match.when({ method: "stored" }, (stored) =>
+            Effect.succeed({
+              type: "apiToken" as const,
+              tokenId: Redacted.make(stored.tokenId),
+              token: Redacted.make(stored.token),
+              organization: stored.organization,
+              source: { type: "stored" as const, details: undefined },
+            } satisfies PlanetscaleResolvedCredentials),
+          ),
+          Match.when({ method: "oauth" }, (cfg) =>
+            Effect.gen(function* () {
+              const creds: OAuthClient.OAuthCredentials = {
+                type: "oauth",
+                clientId: cfg.clientId,
+                access: Redacted.make(cfg.access),
+                refresh: Redacted.make(cfg.refresh),
+                expires: cfg.expires,
+                scopes: cfg.scopes,
+              };
+              if (!OAuthClient.usesCurrentClient(creds)) {
+                return yield* NeedsReauth.make({
+                  provider: PLANETSCALE_AUTH_PROVIDER_NAME,
+                  profile: profileName,
+                  message: `Planetscale OAuth credentials for profile '${profileName}' were issued to an incompatible OAuth client and have been removed. ${reauth}`,
+                });
+              }
+              // Refresh proactively if the token has expired (or is within
+              // 10s of expiring). Persist the refreshed creds so subsequent
+              // resolves don't repeat the round-trip.
+              const now = yield* Clock.currentTimeMillis;
+              const fresh =
+                creds.expires > now + 10_000
+                  ? creds
+                  : yield* OAuthClient.refresh(creds).pipe(
+                      // Only the refresh round-trip maps to NeedsReauth — a
+                      // failed persist afterwards is a local I/O AuthError and
+                      // passes through untouched.
+                      Effect.mapError((e) =>
+                        NeedsReauth.make({
+                          provider: PLANETSCALE_AUTH_PROVIDER_NAME,
+                          profile: profileName,
+                          message: `Planetscale OAuth refresh failed. ${reauth}`,
+                          cause: e,
+                        }),
+                      ),
+                    );
+              if (fresh !== creds) {
+                yield* (
+                  updateConfig?.({
+                    method: "oauth",
+                    organization: cfg.organization,
+                    clientId: fresh.clientId,
+                    access: Redacted.value(fresh.access),
+                    refresh: Redacted.value(fresh.refresh),
+                    expires: fresh.expires,
+                    scopes: fresh.scopes,
+                  }) ?? Effect.void
+                );
+              }
+              return {
+                type: "oauth" as const,
+                accessToken: fresh.access,
+                expires: fresh.expires,
+                organization: cfg.organization,
+                source: { type: "oauth" as const },
+              } satisfies PlanetscaleResolvedCredentials;
+            }),
+          ),
+          Match.exhaustive,
+        );
+      });
+
+    const logout = (_profileName: string, config: PlanetscaleAuthConfig) =>
+      Match.value(config).pipe(
+        Match.when({ method: "stored" }, () => Effect.void),
+        Match.when({ method: "oauth" }, () => Effect.void),
+        Match.exhaustive,
+      );
+
+    const login = (
+      profileName: string,
+      config: PlanetscaleAuthConfig,
+      updateConfig?: (config: PlanetscaleAuthConfig) => Effect.Effect<void, AuthError>,
+    ) =>
+      Match.value(config).pipe(
+        Match.when({ method: "stored" }, (stored) => Effect.succeed(stored)),
+        Match.when({ method: "oauth" }, (oauth) =>
+          Effect.gen(function* () {
+            const credentials: OAuthClient.OAuthCredentials = {
+              type: "oauth",
+              clientId: oauth.clientId,
+              access: Redacted.make(oauth.access),
+              refresh: Redacted.make(oauth.refresh),
+              expires: oauth.expires,
+              scopes: oauth.scopes,
+            };
+            if (!OAuthClient.usesCurrentClient(credentials)) {
+              return yield* configureOAuth(profileName);
+            }
+            const refreshed = yield* withProfileCredentialsLock(
+              profileName,
+              interaction.output.info("Planetscale: refreshing OAuth credentials...").pipe(
+                Effect.andThen(OAuthClient.refresh(credentials)),
+                Effect.flatMap((credentials) => {
+                  const config = {
+                    ...oauth,
+                    clientId: credentials.clientId,
+                    access: Redacted.value(credentials.access),
+                    refresh: Redacted.value(credentials.refresh),
+                    expires: credentials.expires,
+                    scopes: credentials.scopes,
+                  };
+                  return (updateConfig?.(config) ?? Effect.void).pipe(Effect.as(config));
+                }),
+                Effect.tap(() =>
+                  interaction.output.success("Planetscale: OAuth credentials refreshed."),
+                ),
+              ),
+            ).pipe(
+              Effect.catchTag(
+                [
+                  "OAuthError",
+                  "OAuthNetworkError",
+                  "OAuthServerUnavailable",
+                  "OAuthInvalidResponse",
+                ],
+                () => configureOAuth(profileName),
+              ),
+            );
+            return refreshed;
+          }),
+        ),
+        Match.exhaustive,
+        Effect.mapError((e) => AuthError.make({ message: "login failed", cause: e })),
+      );
+
+    const details = (
+      profileName: string,
+      config: PlanetscaleAuthConfig,
+      updateConfig?: (config: PlanetscaleAuthConfig) => Effect.Effect<void, AuthError>,
+    ) =>
+      Effect.all([
+        resolveCredentials(profileName, config, updateConfig),
+        Clock.currentTimeMillis,
+      ]).pipe(
+        Effect.map(([creds, now]): ProviderDetails => {
+          const sourceStr =
+            "details" in creds.source && creds.source.details
+              ? `${creds.source.type} - ${creds.source.details}`
+              : creds.source.type;
+          return Match.value(creds).pipe(
+            Match.when({ type: "apiToken" }, (c) => ({
+              lines: [
+                { key: "tokenId", value: displayRedacted(c.tokenId, 3) },
+                { key: "token", value: displayRedacted(c.token, 6) },
+                { key: "organization", value: c.organization },
+                { key: "source", value: sourceStr },
+              ],
+            })),
+            Match.when({ type: "oauth" }, (c) => {
+              const remainingMs = c.expires - now;
+              const expiresAt = new Date(c.expires).toISOString();
+              const expiresStr =
+                remainingMs <= 0
+                  ? `expired (${expiresAt})`
+                  : `in ${Duration.format(Duration.millis(remainingMs))} (${expiresAt})`;
+              return {
+                lines: [
+                  { key: "accessToken", value: displayRedacted(c.accessToken) },
+                  { key: "expires", value: expiresStr },
+                  { key: "organization", value: c.organization },
+                  { key: "source", value: sourceStr },
+                ],
+              };
+            }),
+            Match.exhaustive,
+          );
+        }),
+      );
+
+    const readEnvironment = Effect.gen(function* () {
+      const tokenId = yield* getEnvRedactedRequired("PLANETSCALE_API_TOKEN_ID");
+      const token = yield* getEnvRedactedRequired("PLANETSCALE_API_TOKEN");
+      const organization = yield* getEnvRequired("PLANETSCALE_ORGANIZATION");
+      return {
+        type: "apiToken" as const,
+        tokenId,
+        token,
+        organization,
+        source: {
+          type: "env" as const,
+          details: "PLANETSCALE_API_TOKEN_ID/PLANETSCALE_API_TOKEN",
+        },
+      } satisfies PlanetscaleResolvedCredentials;
+    });
+
+    return {
+      configSchema: PlanetscaleAuthConfigSchema,
+      configure: configureCredentials,
+      configureWith,
+      configureMethods,
+      logout,
+      login,
+      details,
+      read: resolveCredentials,
+      readEnvironment,
+      environment: [
+        {
+          name: "PLANETSCALE_API_TOKEN_ID",
+          required: true,
+          description: "Service token id.",
+        },
+        {
+          name: "PLANETSCALE_API_TOKEN",
+          required: true,
+          secret: true,
+          description: "Service token secret.",
+        },
+        {
+          name: "PLANETSCALE_ORGANIZATION",
+          required: true,
+          description: "Organization URL slug.",
+        },
+        {
+          name: "PLANETSCALE_API_BASE_URL",
+          required: false,
+          description: "API base URL override.",
+        },
+      ],
+    };
+  }),
+);