@samebase/alchemy-convex 0.1.0 → 0.3.0

package/src/Project.ts

@@ -1,28 +1,39 @@
 // Convex.Project: a project in a Convex team, with its default production deployment.
 //
-// The Management API has no project update endpoint, so every property change
-// is a replacement. Deleting a project deletes all of its deployments and data.
+// Deleting a project deletes all of its deployments and data, so this
+// resource never replaces a project and keeps it by default:
+//
+// - A name change is an update in place: PATCH /projects/{project_id} with
+//   the new name. The slug stays the same.
+// - `team`, `deploymentType`, and `deploymentRegion` cannot change on an
+//   existing project. A change fails with a typed error that names the fix.
+// - The removal policy is `retain`. Alchemy deletes the project only when the
+//   resource has `RemovalPolicy.destroy()`.
+// - With state, every call addresses the project by `output.projectId`. Only
+//   a resource without state looks a project up by name, and it takes over a
+//   project that it finds only when adoption is on.
 import { Resource } from "alchemy";
-import { Unowned } from "alchemy/AdoptPolicy";
+import { OwnedBySomeoneElse, Unowned } from "alchemy/AdoptPolicy";
 import { isResolved } from "alchemy/Diff";
 import * as Provider from "alchemy/Provider";
 import * as Effect from "effect/Effect";
 import * as Schema from "effect/Schema";
 import type { components } from "@convex-dev/platform/managementApi";
-import { absentAsUndefined, ManagementApi } from "./ManagementApi.ts";
+import { shouldAdopt } from "./Adoption.ts";
+import { absentAsUndefined, ConvexApiError, ManagementApi } from "./ManagementApi.ts";
 import type { Providers } from "./Providers.ts";
 
 /** Region names the Management API accepts, from the generated schema. */
 export type DeploymentRegion = components["schemas"]["RegionName"];
 
 export interface ProjectProps {
-  /** Team slug or numeric team id. A slug costs one extra lookup per run. */
+  /** Team slug or numeric team id. A slug costs one extra lookup per run. Cannot change. */
   readonly team: string | number;
-  /** Display name. Convex derives the slug from it. */
+  /** Display name. Convex derives the slug from it at creation. A change renames the project. */
   readonly name: string;
-  /** Region of the deployment created with the project. Defaults to the team default. */
+  /** Region of the deployment created with the project. Defaults to the team default. Cannot change. */
   readonly deploymentRegion?: DeploymentRegion;
-  /** Deployment created with the project. Defaults to `prod`. */
+  /** Deployment created with the project. Defaults to `prod`. Cannot change. */
   readonly deploymentType?: "prod" | "dev";
 }
 
@@ -36,9 +47,59 @@ export interface ProjectAttributes {
 }
 
 export type Project = Resource<"Convex.Project", ProjectProps, ProjectAttributes, never, Providers>;
-export const Project = Resource<Project>("Convex.Project");
+export const Project = Resource<Project>("Convex.Project", { defaultRemovalPolicy: "retain" });
+
+/** The props change the team of an existing project. Convex cannot move a project. */
+export class ProjectTeamChange extends Schema.TaggedError<ProjectTeamChange>()(
+  "ProjectTeamChange",
+  { projectId: Schema.Number, teamId: Schema.Number, requestedTeamId: Schema.Number },
+) {
+  override get message() {
+    return `Convex.Project cannot move project ${this.projectId} from team ${this.teamId} to team ${this.requestedTeamId}. Set team back to ${this.teamId}. To use the other team, create a new resource with a new logical id and move the data yourself.`;
+  }
+}
+
+/**
+ * The props change `deploymentType` or `deploymentRegion` of an existing
+ * project. Convex uses them only when it creates the project.
+ */
+export class ProjectDeploymentChange extends Schema.TaggedError<ProjectDeploymentChange>()(
+  "ProjectDeploymentChange",
+  {
+    projectId: Schema.Number,
+    field: Schema.Literals(["deploymentType", "deploymentRegion"]),
+    current: Schema.UndefinedOr(Schema.String),
+    requested: Schema.UndefinedOr(Schema.String),
+  },
+) {
+  override get message() {
+    const show = (value: string | undefined) => (value === undefined ? "(not set)" : value);
+    return `Convex.Project cannot change ${this.field} of project ${this.projectId} from ${show(this.current)} to ${show(this.requested)}: Convex uses it only when it creates a project. Set ${this.field} back to ${show(this.current)}. For a new deployment, create a new resource with a new logical id and move the data yourself.`;
+  }
+}
+
+/** More than one project in the team has the name, so the lookup cannot choose one. */
+export class AmbiguousProject extends Schema.TaggedError<AmbiguousProject>()("AmbiguousProject", {
+  teamId: Schema.Number,
+  name: Schema.String,
+  projectIds: Schema.Array(Schema.Number),
+}) {
+  override get message() {
+    return `Team ${this.teamId} has ${this.projectIds.length} projects named "${this.name}" (ids ${this.projectIds.join(", ")}). Convex.Project does not choose one. Rename the projects in the Convex dashboard so that only one has this name, or use a different name.`;
+  }
+}
+
+/** Convex answered a create call but then did not return the project. */
+export class CreatedProjectNotFound extends Schema.TaggedError<CreatedProjectNotFound>()(
+  "CreatedProjectNotFound",
+  { projectId: Schema.Number },
+) {
+  override get message() {
+    return `Convex created project ${this.projectId} but GET /projects/${this.projectId} did not return it. Run the deploy again with --adopt to take over project ${this.projectId}.`;
+  }
+}
 
-/** Fields of GET /projects/{id} and GET /teams/{team}/projects that the provider uses. */
+/** Fields of GET /projects/{id}, PATCH /projects/{id}, and GET /teams/{team}/projects rows that the provider uses. */
 const ProjectDetails = Schema.Struct({
   id: Schema.Number,
   name: Schema.String,
@@ -46,15 +107,20 @@ const ProjectDetails = Schema.Struct({
   teamId: Schema.Number,
   prodDeploymentName: Schema.NullOr(Schema.String),
 });
-const ProjectList = Schema.Struct({ items: Schema.Array(ProjectDetails) });
+type ProjectDetails = typeof ProjectDetails.Type;
 
-const CreatedProject = Schema.Struct({
-  projectId: Schema.Number,
-  slug: Schema.String,
-  deploymentName: Schema.NullOr(Schema.String),
-  deploymentUrl: Schema.NullOr(Schema.String),
+/** GET /teams/{team_id}/projects: one page of projects. */
+export const ProjectPage = Schema.Struct({
+  items: Schema.Array(ProjectDetails),
+  pagination: Schema.Struct({
+    hasMore: Schema.Boolean,
+    nextCursor: Schema.optionalKey(Schema.NullOr(Schema.String)),
+  }),
 });
 
+/** POST /teams/{team_id}/create_project. Only the id: everything else comes from GET /projects/{id}. */
+const CreatedProject = Schema.Struct({ projectId: Schema.Number });
+
 const DeploymentRow = Schema.Struct({
   name: Schema.String,
   deploymentType: Schema.String,
@@ -63,6 +129,36 @@ const DeploymentRow = Schema.Struct({
 });
 const DeploymentRows = Schema.Array(DeploymentRow);
 
+/**
+ * Fails with {@link ProjectDeploymentChange} when a create-time prop
+ * changed. An omitted `deploymentType` means `prod`.
+ */
+const checkCreateTimeProps = (projectId: number, olds: ProjectProps, news: ProjectProps) => {
+  const oldType = olds.deploymentType ?? "prod";
+  const newType = news.deploymentType ?? "prod";
+  if (oldType !== newType) {
+    return Effect.fail(
+      new ProjectDeploymentChange({
+        projectId,
+        field: "deploymentType",
+        current: oldType,
+        requested: newType,
+      }),
+    );
+  }
+  if (olds.deploymentRegion !== news.deploymentRegion) {
+    return Effect.fail(
+      new ProjectDeploymentChange({
+        projectId,
+        field: "deploymentRegion",
+        current: olds.deploymentRegion,
+        requested: news.deploymentRegion,
+      }),
+    );
+  }
+  return Effect.void;
+};
+
 export const ProjectProvider = () =>
   Provider.effect(
     Project,
@@ -84,7 +180,7 @@ export const ProjectProvider = () =>
             ),
           );
 
-      const attributesOf = (details: typeof ProjectDetails.Type) =>
+      const attributesOf = (details: ProjectDetails) =>
         prodDeployment(details.id).pipe(
           Effect.map((prod): ProjectAttributes => ({
             projectId: details.id,
@@ -107,31 +203,100 @@ export const ProjectProvider = () =>
           ),
         );
 
-      const findByName = (team: string | number, name: string) =>
+      /**
+       * The one project in the team with exactly this name, or undefined.
+       * Reads every page. `q` narrows the listing on the server, and the
+       * exact match here decides. Pattern from Confect
+       * `packages/alchemy/src/ConvexClient.ts` and `Project.ts`
+       * (https://github.com/rjdellecese/confect, ISC license).
+       */
+      const findByName = (teamId: number, name: string) =>
         Effect.gen(function* () {
-          const teamId = yield* api.resolveTeamId(team);
-          const list = yield* api.request("list projects", (client) =>
-            client.GET("/teams/{team_id}/projects", { params: { path: { team_id: teamId } } }),
-          );
-          return Schema.decodeUnknownSync(ProjectList)(list).items.find(
-            (row) => row.name === name || row.slug === name,
+          const matches: ProjectDetails[] = [];
+          const seenCursors = new Set<string>();
+          let cursor: string | undefined;
+          while (true) {
+            const body = yield* api.request("list projects", (client) =>
+              client.GET("/teams/{team_id}/projects", {
+                params: {
+                  path: { team_id: teamId },
+                  query: { q: name, ...(cursor === undefined ? {} : { cursor }) },
+                },
+              }),
+            );
+            const page = Schema.decodeUnknownSync(ProjectPage)(body);
+            matches.push(...page.items.filter((row) => row.name === name));
+            if (!page.pagination.hasMore) break;
+            const next = page.pagination.nextCursor;
+            if (next === undefined || next === null || seenCursors.has(next)) {
+              return yield* new ConvexApiError({
+                operation: "list projects",
+                status: 0,
+                code: "InvalidPagination",
+                message: `The project listing of team ${teamId} reports more pages but gives no new cursor. Convex.Project stops so that it does not miss a project named "${name}".`,
+              });
+            }
+            seenCursors.add(next);
+            cursor = next;
+          }
+          if (matches.length > 1) {
+            return yield* new AmbiguousProject({
+              teamId,
+              name,
+              projectIds: matches.map((row) => row.id),
+            });
+          }
+          return matches[0];
+        });
+
+      /**
+       * Brings an existing project to the desired name. The team cannot
+       * change, so a project in another team fails.
+       */
+      const converge = (details: ProjectDetails, teamId: number, name: string) =>
+        Effect.gen(function* () {
+          if (details.teamId !== teamId) {
+            return yield* new ProjectTeamChange({
+              projectId: details.id,
+              teamId: details.teamId,
+              requestedTeamId: teamId,
+            });
+          }
+          if (details.name === name) return yield* attributesOf(details);
+          const updated = yield* api.request("update project", (client) =>
+            client.PATCH("/projects/{project_id}", {
+              params: { path: { project_id: details.id } },
+              body: { name },
+            }),
           );
+          return yield* attributesOf(Schema.decodeUnknownSync(ProjectDetails)(updated));
         });
 
       return {
         stables: ["projectId", "slug", "teamId"],
 
-        diff: ({ olds, news }) => {
-          if (!isResolved(news)) return Effect.succeed(undefined);
-          const changed =
-            olds.team !== news.team ||
-            olds.name !== news.name ||
-            olds.deploymentRegion !== news.deploymentRegion ||
-            olds.deploymentType !== news.deploymentType;
-          return Effect.succeed(
-            changed ? ({ action: "replace" } as const) : ({ action: "noop" } as const),
-          );
-        },
+        diff: Effect.fn(function* ({ olds, news, output }) {
+          if (!isResolved(news)) return undefined;
+          // Nothing exists yet, so nothing can be lost.
+          if (output === undefined) return undefined;
+          // A deploymentType or deploymentRegion change fails in reconcile,
+          // before any API call. Reconcile compares with the props of the last
+          // successful deploy. Here, `olds` can be the props of a refused
+          // update, so a check here would also refuse the props that fix it.
+          if (olds.team !== news.team) {
+            const requestedTeamId = yield* api.resolveTeamId(news.team);
+            if (requestedTeamId !== output.teamId) {
+              return yield* new ProjectTeamChange({
+                projectId: output.projectId,
+                teamId: output.teamId,
+                requestedTeamId,
+              });
+            }
+          }
+          // Never "replace". A name change is an update; reconcile renames
+          // the project with PATCH. Otherwise the engine compares the props.
+          return olds.name === news.name ? undefined : ({ action: "update" } as const);
+        }),
 
         read: Effect.fn(function* ({ olds, output }) {
           if (output !== undefined) {
@@ -140,21 +305,42 @@ export const ProjectProvider = () =>
           }
           // No state: an existing project with this name belongs to someone
           // else until the user passes --adopt. Convex has no ownership tags.
-          const existing = yield* findByName(olds.team, olds.name);
+          const existing = yield* findByName(yield* api.resolveTeamId(olds.team), olds.name);
           return existing === undefined ? undefined : Unowned(yield* attributesOf(existing));
         }),
 
-        reconcile: Effect.fn(function* ({ news, output }) {
+        reconcile: Effect.fn(function* ({ fqn, olds, news, output }) {
+          const teamId = yield* api.resolveTeamId(news.team);
           if (output !== undefined) {
-            // Properties are all create-time; diff maps changes to replace.
+            // State names the project. Never look it up by name here.
+            if (olds !== undefined) yield* checkCreateTimeProps(output.projectId, olds, news);
+            if (output.teamId !== teamId) {
+              return yield* new ProjectTeamChange({
+                projectId: output.projectId,
+                teamId: output.teamId,
+                requestedTeamId: teamId,
+              });
+            }
             const details = yield* getById(output.projectId);
-            if (details !== undefined) return yield* attributesOf(details);
+            if (details !== undefined) return yield* converge(details, teamId, news.name);
+            // The project in state was deleted outside Alchemy. Creating a
+            // new project below loses nothing.
+          } else {
+            // No state: a project with this name is someone else's unless
+            // adoption is on. The engine checked this in plan; this check
+            // covers a project that appeared after the plan.
+            const existing = yield* findByName(teamId, news.name);
+            if (existing !== undefined) {
+              if (!(yield* shouldAdopt(fqn))) {
+                return yield* new OwnedBySomeoneElse({
+                  message: `Convex project ${existing.id} in team ${teamId} already has the name "${news.name}". Re-run with --adopt to take it over, or use a different name.`,
+                  resourceType: Project.Type,
+                  physicalName: news.name,
+                });
+              }
+              return yield* converge(existing, teamId, news.name);
+            }
           }
-          // A crash after create and before state write is recovered by read;
-          // a project created by an earlier attempt is reused here too.
-          const existing = yield* findByName(news.team, news.name);
-          if (existing !== undefined) return yield* attributesOf(existing);
-          const teamId = yield* api.resolveTeamId(news.team);
           const created = yield* api.request("create project", (client) =>
             client.POST("/teams/{team_id}/create_project", {
               params: { path: { team_id: teamId } },
@@ -167,16 +353,14 @@ export const ProjectProvider = () =>
               },
             }),
           );
-          const parsed = Schema.decodeUnknownSync(CreatedProject)(created);
-          const details = yield* getById(parsed.projectId);
-          if (details === undefined) {
-            return yield* Effect.die(
-              new Error(`Convex created project ${parsed.projectId} but it cannot be read back`),
-            );
-          }
-          return yield* attributesOf(details);
+          // Identity comes from the create response, never from a name lookup.
+          const { projectId } = Schema.decodeUnknownSync(CreatedProject)(created);
+          const details = yield* getById(projectId);
+          if (details === undefined) return yield* new CreatedProjectNotFound({ projectId });
+          return yield* converge(details, teamId, news.name);
         }),
 
+        // Runs only with `RemovalPolicy.destroy()`: the default policy is `retain`.
         delete: Effect.fn(function* ({ output }) {
           yield* absentAsUndefined(
             api.requestVoid("delete project", (client) =>

package/src/Providers.ts

@@ -3,6 +3,7 @@
 import { CommandExecutorLive } from "alchemy/Command";
 import * as Provider from "alchemy/Provider";
 import * as Layer from "effect/Layer";
+import { Code, CodeProvider } from "./Code.ts";
 import { type Credentials, fromConfig } from "./Credentials.ts";
 import {
   DefaultEnvironmentVariable,
@@ -10,6 +11,7 @@ import {
 } from "./DefaultEnvironmentVariable.ts";
 import { Deploy, DeployProvider } from "./Deploy.ts";
 import { DeployKey, DeployKeyProvider } from "./DeployKey.ts";
+import { Deployment, DeploymentProvider } from "./Deployment.ts";
 import { EnvironmentVariable, EnvironmentVariableProvider } from "./EnvironmentVariable.ts";
 import { ManagementApiLive } from "./ManagementApi.ts";
 import { PreviewDeployKey, PreviewDeployKeyProvider } from "./PreviewDeployKey.ts";
@@ -26,26 +28,32 @@ export const providers = (credentials: Layer.Layer<Credentials> = fromConfig())
     Providers,
     Provider.collection([
       Project,
+      Deployment,
       DeployKey,
       PreviewDeployKey,
       EnvironmentVariable,
       DefaultEnvironmentVariable,
+      Code,
       Deploy,
     ]),
   ).pipe(
     Layer.provide(
       Layer.mergeAll(
         ProjectProvider(),
+        DeploymentProvider(),
         DeployKeyProvider(),
         PreviewDeployKeyProvider(),
         EnvironmentVariableProvider(),
         DefaultEnvironmentVariableProvider(),
+        CodeProvider(),
         DeployProvider(),
       ),
     ),
     Layer.provide(ManagementApiLive()),
     Layer.provide(credentials),
-    // Convex.Deploy runs the Convex CLI through Alchemy's command executor.
+    // The deprecated Convex.Deploy runs the Convex CLI through Alchemy's
+    // command executor. Convex.Code spawns it itself, so that its output
+    // stays out of the logs.
     Layer.provide(CommandExecutorLive()),
     Layer.orDie,
   );

package/src/index.ts

@@ -1,4 +1,16 @@
 // @samebase/alchemy-convex: Convex resources for Alchemy v2.
+export {
+  Code,
+  type CodeAttributes,
+  type CodeDeployment,
+  type CodeProps,
+  CodePushFailed,
+  ConvexCliNotFound,
+  DeployKeyMismatch,
+  EnvironmentNeedsDeployKey,
+  parseDeployOutput,
+  PushTargetMismatch,
+} from "./Code.ts";
 export {
   ACCESS_TOKEN_ENV,
   Credentials,
@@ -14,21 +26,33 @@ export {
 } from "./DefaultEnvironmentVariable.ts";
 export {
   Deploy,
+  DeployArgumentError,
   type DeployAttributes,
   deployArgs,
+  DeployOutputError,
   type DeployProps,
-  parseDeployOutput,
 } from "./Deploy.ts";
 export {
   DeployKey,
   type DeployKeyAction,
   type DeployKeyAttributes,
+  DeployKeyIsCredential,
   type DeployKeyProps,
+  DeployKeyRecoveryRequired,
 } from "./DeployKey.ts";
+export {
+  AmbiguousDeployment,
+  Deployment,
+  type DeploymentAttributes,
+  DeploymentIdentityChange,
+  type DeploymentProps,
+  ProductionDeploymentNotFound,
+} from "./Deployment.ts";
 export {
   EnvironmentVariable,
   type EnvironmentVariableAttributes,
   type EnvironmentVariableProps,
+  VariableIdentityChange,
 } from "./EnvironmentVariable.ts";
 export { ConvexApiError, ManagementApi } from "./ManagementApi.ts";
 export {
@@ -37,9 +61,13 @@ export {
   type PreviewDeployKeyProps,
 } from "./PreviewDeployKey.ts";
 export {
+  AmbiguousProject,
+  CreatedProjectNotFound,
   type DeploymentRegion,
   Project,
+  ProjectDeploymentChange,
   type ProjectAttributes,
   type ProjectProps,
+  ProjectTeamChange,
 } from "./Project.ts";
 export { Providers, providers } from "./Providers.ts";

package/lib/Credentials.d.ts

@@ -1,39 +0,0 @@
-import * as Context from "effect/Context";
-import * as Effect from "effect/Effect";
-import * as Layer from "effect/Layer";
-import * as Redacted from "effect/Redacted";
-import * as Schema from "effect/Schema";
-export interface ResolvedCredentials {
-    /** Bearer token accepted by https://api.convex.dev/v1: a team access token, an OAuth token, or the Convex CLI login. */
-    readonly accessToken: Redacted.Redacted<string>;
-    /** Where the token came from, for error messages only. */
-    readonly source: "env" | "explicit" | "convex-cli-login";
-}
-declare const Credentials_base: Context.ServiceClass<Credentials, "@samebase/alchemy-convex/Credentials", Effect.Effect<ResolvedCredentials, never, never>>;
-export declare class Credentials extends Credentials_base {
-}
-/** Environment variable read by {@link fromConfig}. */
-export declare const ACCESS_TOKEN_ENV = "CONVEX_ACCESS_TOKEN";
-/** The Convex CLI stores its device login here after `npx convex login`. */
-export declare const convexCliConfigPath: () => string;
-/**
- * Token the Convex CLI saved on this machine. It works on the Management API
- * for the teams the logged-in user belongs to. Fails when nobody is logged in.
- */
-export declare const readConvexCliLogin: Effect.Effect<ResolvedCredentials, CredentialsError>;
-declare const CredentialsError_base: Schema.Class<CredentialsError, Schema.TaggedStruct<"CredentialsError", {
-    readonly reason: Schema.String;
-}>, import("effect/Cause").YieldableError>;
-export declare class CredentialsError extends CredentialsError_base {
-}
-/**
- * Default resolution: `CONVEX_ACCESS_TOKEN` from the stack ConfigProvider
- * (process env, `.env`, stack secrets), then the Convex CLI login on this
- * machine. CI sets the variable; a developer who ran `npx convex login` needs
- * nothing.
- */
-export declare const fromConfig: () => Layer.Layer<Credentials>;
-/** Explicit token, for tests or callers that already hold a value. */
-export declare const fromToken: (accessToken: Redacted.Redacted<string>) => Layer.Layer<Credentials>;
-export {};
-//# sourceMappingURL=Credentials.d.ts.map

package/lib/Credentials.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"Credentials.d.ts","sourceRoot":"","sources":["../src/Credentials.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,MAAM,WAAW,mBAAmB;IAClC,wHAAwH;IACxH,QAAQ,CAAC,WAAW,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAChD,0DAA0D;IAC1D,QAAQ,CAAC,MAAM,EAAE,KAAK,GAAG,UAAU,GAAG,kBAAkB,CAAC;CAC1D;;AAED,qBAAa,WAAY,SAAQ,gBAEhC;CAAG;AAEJ,uDAAuD;AACvD,eAAO,MAAM,gBAAgB,wBAAwB,CAAC;AAEtD,4EAA4E;AAC5E,eAAO,MAAM,mBAAmB,cAAkD,CAAC;AAInF;;;GAGG;AACH,eAAO,MAAM,kBAAkB,EAAE,MAAM,CAAC,MAAM,CAAC,mBAAmB,EAAE,gBAAgB,CAYnF,CAAC;;;;AAEF,qBAAa,gBAAiB,SAAQ,qBAEpC;CAAG;AAEL;;;;;GAKG;AACH,eAAO,MAAM,UAAU,QAAO,KAAK,CAAC,KAAK,CAAC,WAAW,CAUlD,CAAC;AAEJ,sEAAsE;AACtE,eAAO,MAAM,SAAS,GAAI,aAAa,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,KAAG,KAAK,CAAC,KAAK,CAAC,WAAW,CACA,CAAC"}

package/lib/Credentials.js

@@ -1,49 +0,0 @@
-// Convex control-plane credentials for the provider.
-//
-// The service value is an Effect so that building the providers layer never
-// touches the environment or the filesystem. The token is read on the first
-// lifecycle call, which keeps `alchemy plan` on an unrelated stack free of
-// Convex credential errors.
-import { readFile } from "node:fs/promises";
-import { homedir } from "node:os";
-import { join } from "node:path";
-import * as Config from "effect/Config";
-import * as Context from "effect/Context";
-import * as Effect from "effect/Effect";
-import * as Layer from "effect/Layer";
-import * as Redacted from "effect/Redacted";
-import * as Schema from "effect/Schema";
-export class Credentials extends Context.Service()("@samebase/alchemy-convex/Credentials") {
-}
-/** Environment variable read by {@link fromConfig}. */
-export const ACCESS_TOKEN_ENV = "CONVEX_ACCESS_TOKEN";
-/** The Convex CLI stores its device login here after `npx convex login`. */
-export const convexCliConfigPath = () => join(homedir(), ".convex", "config.json");
-const CliConfig = Schema.Struct({ accessToken: Schema.String });
-/**
- * Token the Convex CLI saved on this machine. It works on the Management API
- * for the teams the logged-in user belongs to. Fails when nobody is logged in.
- */
-export const readConvexCliLogin = Effect.gen(function* () {
-    const path = convexCliConfigPath();
-    const text = yield* Effect.tryPromise({
-        try: () => readFile(path, "utf8"),
-        catch: () => new CredentialsError({ reason: `no Convex CLI login at ${path}` }),
-    });
-    const parsed = yield* Schema.decodeUnknownEffect(Schema.fromJsonString(CliConfig))(text).pipe(Effect.mapError(() => new CredentialsError({ reason: `${path} has no accessToken` })));
-    return { accessToken: Redacted.make(parsed.accessToken), source: "convex-cli-login" };
-});
-export class CredentialsError extends Schema.TaggedError()("CredentialsError", {
-    reason: Schema.String,
-}) {
-}
-/**
- * Default resolution: `CONVEX_ACCESS_TOKEN` from the stack ConfigProvider
- * (process env, `.env`, stack secrets), then the Convex CLI login on this
- * machine. CI sets the variable; a developer who ran `npx convex login` needs
- * nothing.
- */
-export const fromConfig = () => Layer.succeed(Credentials, Effect.cached(Config.Redacted(ACCESS_TOKEN_ENV).pipe(Effect.map((accessToken) => ({ accessToken, source: "env" })), Effect.catch(() => readConvexCliLogin), Effect.orDie)).pipe(Effect.flatten));
-/** Explicit token, for tests or callers that already hold a value. */
-export const fromToken = (accessToken) => Layer.succeed(Credentials, Effect.succeed({ accessToken, source: "explicit" }));
-//# sourceMappingURL=Credentials.js.map

package/lib/Credentials.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"Credentials.js","sourceRoot":"","sources":["../src/Credentials.ts"],"names":[],"mappings":"AAAA,qDAAqD;AACrD,EAAE;AACF,4EAA4E;AAC5E,4EAA4E;AAC5E,2EAA2E;AAC3E,4BAA4B;AAC5B,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,OAAO,EAAE,MAAM,SAAS,CAAC;AAClC,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AACjC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AASxC,MAAM,OAAO,WAAY,SAAQ,OAAO,CAAC,OAAO,EAAmD,CACjG,sCAAsC,CACvC;CAAG;AAEJ,uDAAuD;AACvD,MAAM,CAAC,MAAM,gBAAgB,GAAG,qBAAqB,CAAC;AAEtD,4EAA4E;AAC5E,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,EAAE,EAAE,SAAS,EAAE,aAAa,CAAC,CAAC;AAEnF,MAAM,SAAS,GAAG,MAAM,CAAC,MAAM,CAAC,EAAE,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC;AAEhE;;;GAGG;AACH,MAAM,CAAC,MAAM,kBAAkB,GAAyD,MAAM,CAAC,GAAG,CAChG,QAAQ,CAAC;IACP,MAAM,IAAI,GAAG,mBAAmB,EAAE,CAAC;IACnC,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,UAAU,CAAC;QACpC,GAAG,EAAE,GAAG,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;QACjC,KAAK,EAAE,GAAG,EAAE,CAAC,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,0BAA0B,IAAI,EAAE,EAAE,CAAC;KAChF,CAAC,CAAC;IACH,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,mBAAmB,CAAC,MAAM,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAC3F,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC,IAAI,gBAAgB,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,qBAAqB,EAAE,CAAC,CAAC,CACtF,CAAC;IACF,OAAO,EAAE,WAAW,EAAE,QAAQ,CAAC,IAAI,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,EAAE,kBAAkB,EAAW,CAAC;AACjG,CAAC,CACF,CAAC;AAEF,MAAM,OAAO,gBAAiB,SAAQ,MAAM,CAAC,WAAW,EAAoB,CAAC,kBAAkB,EAAE;IAC/F,MAAM,EAAE,MAAM,CAAC,MAAM;CACtB,CAAC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,CAAC,MAAM,UAAU,GAAG,GAA6B,EAAE,CACvD,KAAK,CAAC,OAAO,CACX,WAAW,EACX,MAAM,CAAC,MAAM,CACX,MAAM,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC,IAAI,CACpC,MAAM,CAAC,GAAG,CAAC,CAAC,WAAW,EAAuB,EAAE,CAAC,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,CAAC,EAClF,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC,kBAAkB,CAAC,EACtC,MAAM,CAAC,KAAK,CACb,CACF,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CACvB,CAAC;AAEJ,sEAAsE;AACtE,MAAM,CAAC,MAAM,SAAS,GAAG,CAAC,WAAsC,EAA4B,EAAE,CAC5F,KAAK,CAAC,OAAO,CAAC,WAAW,EAAE,MAAM,CAAC,OAAO,CAAC,EAAE,WAAW,EAAE,MAAM,EAAE,UAAU,EAAW,CAAC,CAAC,CAAC"}

package/lib/DefaultEnvironmentVariable.d.ts

@@ -1,58 +0,0 @@
-import { Resource } from "alchemy";
-import * as Provider from "alchemy/Provider";
-import * as Effect from "effect/Effect";
-import * as Redacted from "effect/Redacted";
-import * as Schema from "effect/Schema";
-import type { components } from "@convex-dev/platform/managementApi";
-import { ManagementApi, type ManagementApiService } from "./ManagementApi.ts";
-import type { Providers } from "./Providers.ts";
-/** Deployment types a default can target, from the generated schema. */
-export type DeploymentType = components["schemas"]["DeploymentType"];
-/**
- * Attributes when the listing has `name` for `deploymentType`. An unfiltered
- * listing merges the deployment types that share one value into one row, so
- * the match checks membership in `deploymentTypes`.
- */
-export declare const findDefault: (list: typeof DefaultEnvironmentVariableList.Type, projectId: number, name: string, deploymentType: DeploymentType) => DefaultEnvironmentVariableAttributes | undefined;
-/**
- * Lists the defaults named `name` for `deploymentType`. Convex filters on
- * both, so the listing has at most one row and needs no pagination.
- */
-export declare const listDefaults: (api: ManagementApiService, projectId: number, name: string, deploymentType: DeploymentType) => Effect.Effect<{
-    readonly items: readonly {
-        readonly name: string;
-        readonly deploymentTypes: readonly string[];
-    }[];
-}, import("./ManagementApi.ts").ConvexApiError, never>;
-/**
- * Sets one default, or removes it when `value` is null. Convex answers 200
- * with an empty body, so this reads no response data.
- */
-export declare const updateDefault: (api: ManagementApiService, projectId: number, name: string, deploymentType: DeploymentType, value: string | Redacted.Redacted<string> | null) => Effect.Effect<void, import("./ManagementApi.ts").ConvexApiError, never>;
-/**
- * GET /projects/{project_id}/list_default_environment_variables. Only the
- * fields the provider uses: the row's `value` is the secret in plain text.
- */
-export declare const DefaultEnvironmentVariableList: Schema.Struct<{
-    readonly items: Schema.$Array<Schema.Struct<{
-        readonly name: Schema.String;
-        readonly deploymentTypes: Schema.$Array<Schema.String>;
-    }>>;
-}>;
-export interface DefaultEnvironmentVariableProps {
-    /** Numeric project id, such as `project.projectId`. */
-    readonly projectId: number;
-    readonly name: string;
-    readonly value: string | Redacted.Redacted<string>;
-    /** Deployments of this type that Convex creates from now on get the variable. */
-    readonly deploymentType: DeploymentType;
-}
-export interface DefaultEnvironmentVariableAttributes {
-    readonly projectId: number;
-    readonly name: string;
-    readonly deploymentType: DeploymentType;
-}
-export type DefaultEnvironmentVariable = Resource<"Convex.DefaultEnvironmentVariable", DefaultEnvironmentVariableProps, DefaultEnvironmentVariableAttributes, never, Providers>;
-export declare const DefaultEnvironmentVariable: import("alchemy").ResourceClass<DefaultEnvironmentVariable>;
-export declare const DefaultEnvironmentVariableProvider: () => import("effect/Layer").Layer<Provider.Provider<DefaultEnvironmentVariable>, never, ManagementApi>;
-//# sourceMappingURL=DefaultEnvironmentVariable.d.ts.map

package/lib/DefaultEnvironmentVariable.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"DefaultEnvironmentVariable.d.ts","sourceRoot":"","sources":["../src/DefaultEnvironmentVariable.ts"],"names":[],"mappings":"AAQA,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AAEnC,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AACrE,OAAO,EAAqB,aAAa,EAAE,KAAK,oBAAoB,EAAE,MAAM,oBAAoB,CAAC;AACjG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,wEAAwE;AACxE,MAAM,MAAM,cAAc,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC,gBAAgB,CAAC,CAAC;AAErE;;;;GAIG;AACH,eAAO,MAAM,WAAW,GACtB,MAAM,OAAO,8BAA8B,CAAC,IAAI,EAChD,WAAW,MAAM,EACjB,MAAM,MAAM,EACZ,gBAAgB,cAAc,KAC7B,oCAAoC,GAAG,SAG3B,CAAC;AAEhB;;;GAGG;AACH,eAAO,MAAM,YAAY,GACvB,KAAK,oBAAoB,EACzB,WAAW,MAAM,EACjB,MAAM,MAAM,EACZ,gBAAgB,cAAc;;;;;sDAQ+D,CAAC;AAEhG;;;GAGG;AACH,eAAO,MAAM,aAAa,GACxB,KAAK,oBAAoB,EACzB,WAAW,MAAM,EACjB,MAAM,MAAM,EACZ,gBAAgB,cAAc,EAC9B,OAAO,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,IAAI,4EAe/C,CAAC;AAEJ;;;GAGG;AACH,eAAO,MAAM,8BAA8B;;;;;EAIzC,CAAC;AAEH,MAAM,WAAW,+BAA+B;IAC9C,uDAAuD;IACvD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IACnD,iFAAiF;IACjF,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACzC;AAED,MAAM,WAAW,oCAAoC;IACnD,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAC;IAC3B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,cAAc,EAAE,cAAc,CAAC;CACzC;AAED,MAAM,MAAM,0BAA0B,GAAG,QAAQ,CAC/C,mCAAmC,EACnC,+BAA+B,EAC/B,oCAAoC,EACpC,KAAK,EACL,SAAS,CACV,CAAC;AACF,eAAO,MAAM,0BAA0B,6DAEtC,CAAC;AAEF,eAAO,MAAM,kCAAkC,yGAgD5C,CAAC"}