@samebase/alchemy-convex 0.1.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,146 @@
+# @samebase/alchemy-convex
+
+Convex resources for [Alchemy v2](https://alchemy.run): projects, deploy keys, environment
+variables, project default environment variables, and a deploy step that hands the deployment URL
+to your frontend build. The Convex CLI keeps doing typecheck, codegen, bundling, and the code push.
+This package manages the control plane around it.
+
+Alchemy has no built-in Convex provider ([alchemy-run/alchemy-async#1306](https://github.com/alchemy-run/alchemy-async/issues/1306)).
+This is a community provider, maintained by [Samebase](https://samebase.com).
+
+Status: 0.1, pinned to `alchemy@2.0.0-beta.80` and Effect 4. Alchemy ships breaking changes
+between betas; upgrade this package and Alchemy together. Verified end to end on a Vite app with a
+Cloudflare Worker: production on `main`, a Convex preview deployment plus a Worker Preview per pull
+request, destroy on close.
+
+## Install
+
+```sh
+pnpm add -D @samebase/alchemy-convex alchemy@2.0.0-beta.80 effect@^4.0.0 @effect/platform-node@^4.0.0 convex
+```
+
+## Credentials
+
+The provider calls the [Convex Management API](https://docs.convex.dev/management-api) with a
+bearer token. By default it reads `CONVEX_ACCESS_TOKEN` through the stack's config provider
+(process env, `.env`, stack secrets) and then falls back to the token the Convex CLI saved after
+`npx convex login` (`~/.convex/config.json`). A developer who is logged in needs no setup. CI sets
+the variable to a team access token.
+
+To pass a token explicitly:
+
+```ts
+Convex.providers(Convex.fromToken(Redacted.make(token)));
+```
+
+A team access token is team wide. The deploy keys this provider creates are scoped to one
+deployment or one project, and those are what CI deploys with.
+
+## Example
+
+```ts
+import * as Alchemy from "alchemy";
+import * as Cloudflare from "alchemy/Cloudflare";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Convex from "@samebase/alchemy-convex";
+
+export default Alchemy.Stack(
+  "MyApp",
+  {
+    providers: Layer.mergeAll(Cloudflare.providers(), Convex.providers()),
+    state: Cloudflare.state(),
+  },
+  Effect.gen(function* () {
+    const project = yield* Convex.Project("Backend", {
+      team: "my-team",
+      name: "my-app",
+    });
+
+    const deployKey = yield* Convex.DeployKey("DeployKey", {
+      deployment: project.prodDeploymentName.as<string>(),
+      name: "alchemy",
+    });
+
+    const backend = yield* Convex.Deploy("Backend", {
+      cwd: ".",
+      deployKey: deployKey.deployKey,
+    });
+
+    const site = yield* Cloudflare.Website.StaticSite("Website", {
+      command: "npm run build",
+      outdir: "dist/client",
+      env: { VITE_CONVEX_URL: backend.url },
+      assets: { notFoundHandling: "single-page-application" },
+    });
+
+    yield* Convex.EnvironmentVariable("SiteUrl", {
+      deployment: backend.deploymentName,
+      deployKey: deployKey.deployKey,
+      name: "SITE_URL",
+      value: site.url,
+    });
+
+    return { url: site.url, backendUrl: backend.url };
+  }),
+);
+```
+
+Order follows the outputs: the project exists before its key, the key before the deploy, the
+deploy before the frontend build that embeds the URL.
+
+Preview stages: give `Convex.Deploy` a `PreviewDeployKey` and `previewName: <branch>` on pull
+request stages, and the production key on `prod`. Variables that every preview deployment needs,
+such as auth keys, go on the project as `DefaultEnvironmentVariable` for `preview`.
+
+## Resources
+
+- `Convex.Project`: `{ team: slug | id, name, deploymentRegion?, deploymentType? }`. Creates a
+  project with its default deployment. Outputs `projectId`, `slug`, `teamId`,
+  `prodDeploymentName`, `prodDeploymentUrl`. There is no project update API, so a changed property
+  replaces the project. An existing project with the same name is adopted only with `--adopt`.
+  Deleting the resource deletes the project with all of its deployments and data.
+- `Convex.DeployKey`: `{ deployment, name, allowedActions? }`. Outputs `uniqueName` and the
+  `deployKey` secret. Any change replaces the key. Keys are never adopted: a key without its secret
+  is useless.
+- `Convex.PreviewDeployKey`: `{ projectId, name }`. Project-level key for preview deployments.
+  Outputs `uniqueName` and `previewDeployKey`.
+- `Convex.EnvironmentVariable`: `{ deployment, deployKey, name, value }`. One variable on one
+  deployment, set through the deployment API with that deployment's key. An existing variable with
+  the same name is adopted and overwritten.
+- `Convex.DefaultEnvironmentVariable`: `{ projectId, name, value, deploymentType }`. A project
+  default that new deployments of that type inherit. Use it for preview and dev deployments.
+- `Convex.Deploy`: `{ cwd?, env?, deployKey, previewName?, previewCreate?, previewRun?, extraArgs?,
+memo?, timeout? }`. Runs `npx convex deploy` with `CONVEX_DEPLOY_KEY` set and parses the
+  deployment URL from the CLI output. Outputs `url`, `deploymentName`, `hash`. Memoized by content
+  hash like Alchemy's own build steps. Deleting the resource does nothing; the deployment belongs to
+  the project, and preview deployments expire on Convex's schedule.
+
+## Limits
+
+- Team slugs resolve through an unofficial dashboard endpoint. Pass the numeric team id to avoid
+  it.
+- Deploy keys and other secret outputs are part of Alchemy state. Alchemy's Cloudflare state store
+  encrypts state at rest; the local file store does not.
+- A deleted deploy key keeps working on the deployment API for roughly 30 seconds.
+- Not covered: dev deployments, custom domains, log streams, teams and members, components,
+  snapshots.
+
+## Development
+
+```sh
+pnpm install
+pnpm run check            # format, lint, typecheck, unit tests
+pnpm run build            # lib/ with declarations
+pnpm run test:live        # real API calls, see below
+```
+
+Unit tests run against recorded Management API payloads in `test/fixtures/management/`. Live tests
+need `ALCHEMY_CONVEX_LIVE=1`, a Convex login or `CONVEX_ACCESS_TOKEN`, and a throwaway project.
+Point them at yours with `ALCHEMY_CONVEX_LIVE_TEAM`, `ALCHEMY_CONVEX_LIVE_PROJECT_ID`,
+`ALCHEMY_CONVEX_LIVE_DEPLOYMENT`, and `ALCHEMY_CONVEX_LIVE_PROJECT_DIR` (a Convex app directory for
+the deploy test). They create resources named `tmp-alchemy-convex-*` and remove them again.
+
+Releases: push a `v*` tag; `.github/workflows/release.yml` publishes with npm trusted publishing.
+
+License: Apache 2.0.

package/lib/Credentials.d.ts

@@ -0,0 +1,39 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,49 @@
+// 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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,58 @@
+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

@@ -0,0 +1 @@
+{"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"}

package/lib/DefaultEnvironmentVariable.js

@@ -0,0 +1,93 @@
+// Convex.DefaultEnvironmentVariable: a project default environment variable
+// for one deployment type. Convex sets it on each new deployment of that type,
+// such as auth keys that every pull request preview deployment needs.
+//
+// Defaults live on the Management API and authenticate with the team
+// credential, not with a deploy key. Setting a default and removing it are the
+// same call: update_default_environment_variables with `value: null` removes
+// the default, and removing an absent default also answers 200.
+import { Resource } from "alchemy";
+import { isResolved } from "alchemy/Diff";
+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 { absentAsUndefined, ManagementApi } from "./ManagementApi.js";
+/**
+ * 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 const findDefault = (list, projectId, name, deploymentType) => list.items.some((item) => item.name === name && item.deploymentTypes.includes(deploymentType))
+    ? { projectId, name, deploymentType }
+    : 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 const listDefaults = (api, projectId, name, deploymentType) => api
+    .request("list default environment variables", (client) => client.GET("/projects/{project_id}/list_default_environment_variables", {
+    params: { path: { project_id: projectId }, query: { name, deploymentType } },
+}))
+    .pipe(Effect.map((body) => Schema.decodeUnknownSync(DefaultEnvironmentVariableList)(body)));
+/**
+ * Sets one default, or removes it when `value` is null. Convex answers 200
+ * with an empty body, so this reads no response data.
+ */
+export const updateDefault = (api, projectId, name, deploymentType, value) => api.requestVoid("update default environment variables", (client) => client.POST("/projects/{project_id}/update_default_environment_variables", {
+    params: { path: { project_id: projectId } },
+    body: {
+        changes: [
+            {
+                name,
+                deploymentType,
+                value: Redacted.isRedacted(value) ? Redacted.value(value) : value,
+            },
+        ],
+    },
+}));
+/**
+ * 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 const DefaultEnvironmentVariableList = Schema.Struct({
+    items: Schema.Array(Schema.Struct({ name: Schema.String, deploymentTypes: Schema.Array(Schema.String) })),
+});
+export const DefaultEnvironmentVariable = Resource("Convex.DefaultEnvironmentVariable");
+export const DefaultEnvironmentVariableProvider = () => Provider.effect(DefaultEnvironmentVariable, Effect.gen(function* () {
+    const api = yield* ManagementApi;
+    return {
+        stables: ["projectId", "name", "deploymentType"],
+        diff: ({ olds, news }) => {
+            if (!isResolved(news))
+                return Effect.succeed(undefined);
+            // Otherwise undefined: the engine updates when any prop changed and
+            // compares a Redacted value by content.
+            return Effect.succeed(olds.projectId !== news.projectId ||
+                olds.name !== news.name ||
+                olds.deploymentType !== news.deploymentType
+                ? { action: "replace" }
+                : undefined);
+        },
+        read: Effect.fn(function* ({ olds }) {
+            // 404 ProjectNotFound: the project no longer exists, so neither does the default.
+            const list = yield* absentAsUndefined(listDefaults(api, olds.projectId, olds.name, olds.deploymentType));
+            if (list === undefined)
+                return undefined;
+            return findDefault(list, olds.projectId, olds.name, olds.deploymentType);
+        }),
+        reconcile: Effect.fn(function* ({ news }) {
+            yield* updateDefault(api, news.projectId, news.name, news.deploymentType, news.value);
+            return {
+                projectId: news.projectId,
+                name: news.name,
+                deploymentType: news.deploymentType,
+            };
+        }),
+        delete: Effect.fn(function* ({ output }) {
+            // Removing an absent default succeeds; 404 ProjectNotFound means the project is gone.
+            yield* absentAsUndefined(updateDefault(api, output.projectId, output.name, output.deploymentType, null));
+        }),
+    };
+}));
+//# sourceMappingURL=DefaultEnvironmentVariable.js.map

package/lib/DefaultEnvironmentVariable.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"DefaultEnvironmentVariable.js","sourceRoot":"","sources":["../src/DefaultEnvironmentVariable.ts"],"names":[],"mappings":"AAAA,4EAA4E;AAC5E,+EAA+E;AAC/E,sEAAsE;AACtE,EAAE;AACF,qEAAqE;AACrE,+EAA+E;AAC/E,6EAA6E;AAC7E,gEAAgE;AAChE,OAAO,EAAE,QAAQ,EAAE,MAAM,SAAS,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC1C,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;AAExC,OAAO,EAAE,iBAAiB,EAAE,aAAa,EAA6B,MAAM,oBAAoB,CAAC;AAMjG;;;;GAIG;AACH,MAAM,CAAC,MAAM,WAAW,GAAG,CACzB,IAAgD,EAChD,SAAiB,EACjB,IAAY,EACZ,cAA8B,EACoB,EAAE,CACpD,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IAC5F,CAAC,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,cAAc,EAAE;IACrC,CAAC,CAAC,SAAS,CAAC;AAEhB;;;GAGG;AACH,MAAM,CAAC,MAAM,YAAY,GAAG,CAC1B,GAAyB,EACzB,SAAiB,EACjB,IAAY,EACZ,cAA8B,EAC9B,EAAE,CACF,GAAG;KACA,OAAO,CAAC,oCAAoC,EAAE,CAAC,MAAM,EAAE,EAAE,CACxD,MAAM,CAAC,GAAG,CAAC,2DAA2D,EAAE;IACtE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,cAAc,EAAE,EAAE;CAC7E,CAAC,CACH;KACA,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,8BAA8B,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;AAEhG;;;GAGG;AACH,MAAM,CAAC,MAAM,aAAa,GAAG,CAC3B,GAAyB,EACzB,SAAiB,EACjB,IAAY,EACZ,cAA8B,EAC9B,KAAgD,EAChD,EAAE,CACF,GAAG,CAAC,WAAW,CAAC,sCAAsC,EAAE,CAAC,MAAM,EAAE,EAAE,CACjE,MAAM,CAAC,IAAI,CAAC,6DAA6D,EAAE;IACzE,MAAM,EAAE,EAAE,IAAI,EAAE,EAAE,UAAU,EAAE,SAAS,EAAE,EAAE;IAC3C,IAAI,EAAE;QACJ,OAAO,EAAE;YACP;gBACE,IAAI;gBACJ,cAAc;gBACd,KAAK,EAAE,QAAQ,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK;aAClE;SACF;KACF;CACF,CAAC,CACH,CAAC;AAEJ;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,MAAM,CAAC,MAAM,CAAC;IAC1D,KAAK,EAAE,MAAM,CAAC,KAAK,CACjB,MAAM,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,eAAe,EAAE,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC,CACrF;CACF,CAAC,CAAC;AAwBH,MAAM,CAAC,MAAM,0BAA0B,GAAG,QAAQ,CAChD,mCAAmC,CACpC,CAAC;AAEF,MAAM,CAAC,MAAM,kCAAkC,GAAG,GAAG,EAAE,CACrD,QAAQ,CAAC,MAAM,CACb,0BAA0B,EAC1B,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,aAAa,CAAC;IAEjC,OAAO;QACL,OAAO,EAAE,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,CAAC;QAEhD,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE;YACvB,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC;gBAAE,OAAO,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,CAAC;YACxD,oEAAoE;YACpE,wCAAwC;YACxC,OAAO,MAAM,CAAC,OAAO,CACnB,IAAI,CAAC,SAAS,KAAK,IAAI,CAAC,SAAS;gBAC/B,IAAI,CAAC,IAAI,KAAK,IAAI,CAAC,IAAI;gBACvB,IAAI,CAAC,cAAc,KAAK,IAAI,CAAC,cAAc;gBAC3C,CAAC,CAAE,EAAE,MAAM,EAAE,SAAS,EAAY;gBAClC,CAAC,CAAC,SAAS,CACd,CAAC;QACJ,CAAC;QAED,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE;YACjC,kFAAkF;YAClF,MAAM,IAAI,GAAG,KAAK,CAAC,CAAC,iBAAiB,CACnC,YAAY,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAClE,CAAC;YACF,IAAI,IAAI,KAAK,SAAS;gBAAE,OAAO,SAAS,CAAC;YACzC,OAAO,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,CAAC,CAAC;QAC3E,CAAC,CAAC;QAEF,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE;YACtC,KAAK,CAAC,CAAC,aAAa,CAAC,GAAG,EAAE,IAAI,CAAC,SAAS,EAAE,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;YACtF,OAAO;gBACL,SAAS,EAAE,IAAI,CAAC,SAAS;gBACzB,IAAI,EAAE,IAAI,CAAC,IAAI;gBACf,cAAc,EAAE,IAAI,CAAC,cAAc;aACpC,CAAC;QACJ,CAAC,CAAC;QAEF,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACrC,sFAAsF;YACtF,KAAK,CAAC,CAAC,iBAAiB,CACtB,aAAa,CAAC,GAAG,EAAE,MAAM,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,EAAE,MAAM,CAAC,cAAc,EAAE,IAAI,CAAC,CAC/E,CAAC;QACJ,CAAC,CAAC;KACH,CAAC;AACJ,CAAC,CAAC,CACH,CAAC"}