@alchemy.run/boat 0.0.0-stage → 2.0.0-beta.86

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

@@ -1,3 +1,71 @@
-# Temporary Holding Version
+# @alchemy.run/boat
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+[Boat](https://boat.dev) for [Alchemy](https://alchemy.run). Boat runs sandboxes: Linux machines with Docker, passwordless `sudo` and a desktop that start in under a second, stop on a timer with their disk saved, and resume, fork or snapshot from where they stopped. Declare sandboxes, snapshots, environments and webhooks in your Stack, and create sandboxes from any Worker or Lambda.
+
+```sh
+npm install alchemy @alchemy.run/boat effect
+```
+
+A sandbox that runs a program. Alchemy bundles it, uploads it and starts it with Node.js, and serves its port at a URL:
+
+```typescript
+// src/Api.ts
+import * as Boat from "@alchemy.run/boat";
+import * as Effect from "effect/Effect";
+import * as HttpServerResponse from "effect/http/HttpServerResponse";
+
+export default class Api extends Boat.Sandbox<Api>()(
+  "Api",
+  { main: import.meta.url, type: "small", noEnv: true, public: true },
+  Effect.gen(function* () {
+    return {
+      fetch: Effect.gen(function* () {
+        return yield* HttpServerResponse.json({ ok: true });
+      }),
+    };
+  }),
+) {}
+```
+
+```typescript
+// alchemy.run.ts
+import * as Boat from "@alchemy.run/boat";
+import * as Alchemy from "alchemy";
+import * as Effect from "effect/Effect";
+import Api from "./src/Api.ts";
+
+export default Alchemy.Stack(
+  "MyApp",
+  { providers: Boat.providers(), state: Alchemy.localState() },
+  Effect.gen(function* () {
+    const api = yield* Api;
+    return { url: api.url.as<string>() };
+  }),
+);
+```
+
+A deploy that changes the code restarts the program in the same sandbox, so its disk and URL stay the same.
+
+For a sandbox per request or per task, build a snapshot once at deploy and bind `Boat.CreateSandbox(Golden)` in a Worker or Lambda. Each sandbox starts with the snapshot's disk:
+
+```typescript
+// src/Golden.ts
+import * as Boat from "@alchemy.run/boat";
+
+export const Golden = Boat.Snapshot("Golden", {
+  run: ["git clone --depth 1 https://github.com/sindresorhus/is ~/repo"],
+});
+```
+
+```typescript
+const sandboxes = yield* Boat.CreateSandbox(Golden);
+
+// per request
+const sandbox = yield* Effect.acquireRelease(
+  sandboxes.create({ noEnv: true, autoStop: "5 minutes" }),
+  (sandbox) => Effect.ignore(sandbox.delete()),
+);
+const result = yield* sandbox.exec("npm test", { cwd: "/home/user/repo" });
+```
+
+Docs: [alchemy.run/boat](https://alchemy.run/boat) · [Setup](https://alchemy.run/boat/setup) · [Tutorial](https://alchemy.run/boat/tutorial/part-1). Reference: [alchemy.run/providers](https://alchemy.run/providers).

package/lib/AiProxy.d.ts

@@ -0,0 +1,89 @@
+import * as boat from "@distilled.cloud/boat-dev/boat";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import type { Providers } from "./Providers.ts";
+export interface AiProxyProps {
+    /**
+     * Whether the account's AI credentials proxy is on. While it is on, Boat
+     * bills the account $1 a day, and $1 per 1,000 proxied requests to the
+     * wallet each sandbox bills.
+     * @default true
+     */
+    enabled?: boolean;
+}
+export interface AiProxyAttributes {
+    /** The account the switch belongs to: you, or an organization. */
+    accountId: string;
+    /**
+     * The organization whose switch this is, as the stack's `org` named it;
+     * `undefined` for your own.
+     */
+    org: string | undefined;
+    /** Whether the proxy is on. */
+    enabled: boolean;
+    /** Where sandboxes send proxied requests. */
+    proxyUrl: string;
+    /**
+     * What the switch was before Alchemy first changed it. Destroying the
+     * resource puts it back.
+     */
+    initialEnabled: boolean;
+}
+export interface AiProxy extends Resource<"Boat.AiProxy", AiProxyProps, AiProxyAttributes, never, Providers> {
+}
+/**
+ * The AI credentials proxy switch of a Boat account.
+ *
+ * With the proxy on, a sandbox gets placeholders in place of the keys of
+ * its credential profile, and the proxy's URL in place of each base URL.
+ * Boat swaps in the real key as a request passes through, so the key never
+ * enters the sandbox, and a copied placeholder stops working when the
+ * sandbox stops.
+ *
+ * :::caution
+ * The proxy is billed: $1 for each day it is on, and $1 per 1,000 proxied
+ * requests. It is one switch for a whole account, so turning it on changes
+ * every sandbox that uses one of the account's credential profiles, at its
+ * next start.
+ * :::
+ *
+ * The switch is yours, or an organization's. With an `org` on the stack
+ * (`Boat.providers({ org })`, or the profile's) it is the organization's,
+ * which only an owner can change. That is the same account that owns the
+ * stack's `Boat.CredentialProfile`s.
+ *
+ * The switch always exists, so nothing is created or deleted. Destroying
+ * the resource puts the switch back the way it was found.
+ *
+ * ### Turning the proxy on
+ * **Example:** Proxy the credentials of sandboxes you hand to users
+ * ```typescript
+ * export const MyProfile = Boat.CredentialProfile("MyProfile", {
+ *   anthropic: Config.Redacted("ANTHROPIC_API_KEY"),
+ * });
+ *
+ * export const Proxy = Boat.AiProxy("Proxy", { enabled: true });
+ *
+ * export const Tenants = Boat.Environment("Tenants", {
+ *   safeForThirdParties: true,
+ *   credentialProfile: MyProfile,
+ *   proxyAiCredentials: Proxy,
+ * });
+ * ```
+ *
+ * `proxyAiCredentials` takes the proxy itself, so the environment is updated
+ * after the switch, and proxies only while it is on. Boat rejects
+ * `proxyAiCredentials: true` while the proxy is off.
+ *
+ * ### Turning the proxy off
+ * **Example:** Keep it off
+ * ```typescript
+ * export const Proxy = Boat.AiProxy("Proxy", { enabled: false });
+ * ```
+ *
+ * @resource
+ * @product AI Proxy
+ */
+export declare const AiProxy: import("alchemy/Resource").ResourceClass<AiProxy>;
+export declare const AiProxyProvider: () => import("effect/Layer").Layer<Provider.Provider<AiProxy>, never, boat.BoatOpContext>;
+//# sourceMappingURL=AiProxy.d.ts.map

package/lib/AiProxy.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiProxy.d.ts","sources":["../src/AiProxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gCAAgC,CAAC;AACvD,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,MAAM,WAAW,YAAY;IAC3B;;;;;OAKG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC,kEAAkE;IAClE,SAAS,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,+BAA+B;IAC/B,OAAO,EAAE,OAAO,CAAC;IACjB,6CAA6C;IAC7C,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,cAAc,EAAE,OAAO,CAAC;CACzB;AAED,MAAM,WAAW,OAAQ,SAAQ,QAAQ,CACvC,cAAc,EACd,YAAY,EACZ,iBAAiB,EACjB,KAAK,EACL,SAAS,CACV;CAAG;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,eAAO,MAAM,OAAO,mDAAoC,CAAC;AASzD,eAAO,MAAM,eAAe,2FAgEzB,CAAC"}

package/lib/AiProxy.js

@@ -0,0 +1,125 @@
+import * as boat from "@distilled.cloud/boat-dev/boat";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import * as Effect from "effect/Effect";
+import { sameOrg, stackOrg } from "./internal/Org.js";
+/**
+ * The AI credentials proxy switch of a Boat account.
+ *
+ * With the proxy on, a sandbox gets placeholders in place of the keys of
+ * its credential profile, and the proxy's URL in place of each base URL.
+ * Boat swaps in the real key as a request passes through, so the key never
+ * enters the sandbox, and a copied placeholder stops working when the
+ * sandbox stops.
+ *
+ * :::caution
+ * The proxy is billed: $1 for each day it is on, and $1 per 1,000 proxied
+ * requests. It is one switch for a whole account, so turning it on changes
+ * every sandbox that uses one of the account's credential profiles, at its
+ * next start.
+ * :::
+ *
+ * The switch is yours, or an organization's. With an `org` on the stack
+ * (`Boat.providers({ org })`, or the profile's) it is the organization's,
+ * which only an owner can change. That is the same account that owns the
+ * stack's `Boat.CredentialProfile`s.
+ *
+ * The switch always exists, so nothing is created or deleted. Destroying
+ * the resource puts the switch back the way it was found.
+ *
+ * ### Turning the proxy on
+ * **Example:** Proxy the credentials of sandboxes you hand to users
+ * ```typescript
+ * export const MyProfile = Boat.CredentialProfile("MyProfile", {
+ *   anthropic: Config.Redacted("ANTHROPIC_API_KEY"),
+ * });
+ *
+ * export const Proxy = Boat.AiProxy("Proxy", { enabled: true });
+ *
+ * export const Tenants = Boat.Environment("Tenants", {
+ *   safeForThirdParties: true,
+ *   credentialProfile: MyProfile,
+ *   proxyAiCredentials: Proxy,
+ * });
+ * ```
+ *
+ * `proxyAiCredentials` takes the proxy itself, so the environment is updated
+ * after the switch, and proxies only while it is on. Boat rejects
+ * `proxyAiCredentials: true` while the proxy is off.
+ *
+ * ### Turning the proxy off
+ * **Example:** Keep it off
+ * ```typescript
+ * export const Proxy = Boat.AiProxy("Proxy", { enabled: false });
+ * ```
+ *
+ * @resource
+ * @product AI Proxy
+ */
+export const AiProxy = Resource("Boat.AiProxy");
+/**
+ * The account a call addresses. Without an `org`, Boat answers for the
+ * active wallet, which may be an organization's, so your own switch is
+ * named explicitly.
+ */
+const account = (org) => ({ org: org ?? "personal" });
+export const AiProxyProvider = () => Provider.effect(AiProxy, Effect.gen(function* () {
+    return {
+        nuke: { singleton: true },
+        stables: ["accountId", "org", "initialEnabled"],
+        // Each account has its own switch.
+        diff: Effect.fn(function* ({ output }) {
+            if (output !== undefined && !sameOrg(output.org, yield* stackOrg)) {
+                return { action: "replace" };
+            }
+        }),
+        // The switch always exists and belongs to nobody, so a cold read
+        // adopts it; what it shows then is what destroy restores.
+        read: Effect.fn(function* ({ output }) {
+            const org = output ? output.org : yield* stackOrg;
+            const observed = yield* boat.getAiProxy(account(org));
+            return {
+                accountId: observed.accountId,
+                org,
+                enabled: observed.enabled,
+                proxyUrl: observed.proxyUrl,
+                initialEnabled: output !== undefined ? output.initialEnabled : observed.enabled,
+            };
+        }),
+        reconcile: Effect.fn(function* ({ news, output, session }) {
+            const org = yield* stackOrg;
+            const desired = news.enabled ?? true;
+            // Observe.
+            const observed = yield* boat.getAiProxy(account(org));
+            // Capture what it was before the first change, for destroy.
+            const initialEnabled = output !== undefined ? output.initialEnabled : observed.enabled;
+            // Sync — only when it differs.
+            if (observed.enabled === desired) {
+                return {
+                    accountId: observed.accountId,
+                    org,
+                    enabled: observed.enabled,
+                    proxyUrl: observed.proxyUrl,
+                    initialEnabled,
+                };
+            }
+            yield* session.note(`Turning the AI credentials proxy ${desired ? "on" : "off"}...`);
+            const updated = yield* boat.updateAiProxy({ ...account(org), enabled: desired });
+            return {
+                accountId: updated.accountId,
+                org,
+                enabled: updated.enabled,
+                proxyUrl: updated.proxyUrl,
+                initialEnabled,
+            };
+        }),
+        // Put the switch back the way it was found.
+        delete: Effect.fn(function* ({ output }) {
+            const observed = yield* boat.getAiProxy(account(output.org));
+            if (observed.enabled === output.initialEnabled)
+                return;
+            yield* boat.updateAiProxy({ ...account(output.org), enabled: output.initialEnabled });
+        }),
+    };
+}));
+//# sourceMappingURL=AiProxy.js.map

package/lib/AiProxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AiProxy.js","sources":["../src/AiProxy.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gCAAgC,CAAC;AACvD,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,EAAE,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAC;AAwCtD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAU,cAAc,CAAC,CAAC;AAEzD;;;;GAIG;AACH,MAAM,OAAO,GAAG,CAAC,GAAuB,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,GAAG,IAAI,UAAU,EAAE,CAAC,CAAC;AAE1E,MAAM,CAAC,MAAM,eAAe,GAAG,GAAG,EAAE,CAClC,QAAQ,CAAC,MAAM,CACb,OAAO,EACP,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;IAClB,OAAO;QACL,IAAI,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE;QACzB,OAAO,EAAE,CAAC,WAAW,EAAE,KAAK,EAAE,gBAAgB,CAAC;QAC/C,mCAAmC;QACnC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACnC,IAAI,MAAM,KAAK,SAAS,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;gBAClE,OAAO,EAAE,MAAM,EAAE,SAAS,EAAW,CAAC;YACxC,CAAC;QACH,CAAC,CAAC;QACF,iEAAiE;QACjE,0DAA0D;QAC1D,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACnC,MAAM,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC;YAClD,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YACtD,OAAO;gBACL,SAAS,EAAE,QAAQ,CAAC,SAAS;gBAC7B,GAAG;gBACH,OAAO,EAAE,QAAQ,CAAC,OAAO;gBACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;gBAC3B,cAAc,EAAE,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO;aAChF,CAAC;QACJ,CAAC,CAAC;QACF,SAAS,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE;YACvD,MAAM,GAAG,GAAG,KAAK,CAAC,CAAC,QAAQ,CAAC;YAC5B,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC;YAErC,WAAW;YACX,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC;YAEtD,4DAA4D;YAC5D,MAAM,cAAc,GAAG,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC;YAEvF,+BAA+B;YAC/B,IAAI,QAAQ,CAAC,OAAO,KAAK,OAAO,EAAE,CAAC;gBACjC,OAAO;oBACL,SAAS,EAAE,QAAQ,CAAC,SAAS;oBAC7B,GAAG;oBACH,OAAO,EAAE,QAAQ,CAAC,OAAO;oBACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ;oBAC3B,cAAc;iBACf,CAAC;YACJ,CAAC;YACD,KAAK,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,oCAAoC,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,KAAK,KAAK,CAAC,CAAC;YACrF,MAAM,OAAO,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAC;YACjF,OAAO;gBACL,SAAS,EAAE,OAAO,CAAC,SAAS;gBAC5B,GAAG;gBACH,OAAO,EAAE,OAAO,CAAC,OAAO;gBACxB,QAAQ,EAAE,OAAO,CAAC,QAAQ;gBAC1B,cAAc;aACf,CAAC;QACJ,CAAC,CAAC;QACF,4CAA4C;QAC5C,MAAM,EAAE,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE;YACrC,MAAM,QAAQ,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;YAC7D,IAAI,QAAQ,CAAC,OAAO,KAAK,MAAM,CAAC,cAAc;gBAAE,OAAO;YACvD,KAAK,CAAC,CAAC,IAAI,CAAC,aAAa,CAAC,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,cAAc,EAAE,CAAC,CAAC;QACxF,CAAC,CAAC;KACH,CAAC;AACJ,CAAC,CAAC,CACH,CAAC"}

package/lib/ApiKey.d.ts

@@ -0,0 +1,105 @@
+import * as boat from "@distilled.cloud/boat-dev/boat";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import * as Effect from "effect/Effect";
+import * as Redacted from "effect/Redacted";
+import type { Providers } from "./Providers.ts";
+/**
+ * What a key may do. `read-only` inspects; `full-sandbox` operates
+ * sandboxes without creating, resuming, forking or deleting them; `ci` adds
+ * create, resume, fork, and delete of the sandboxes the key created;
+ * `admin` is everything.
+ */
+export type ApiKeyPreset = "read-only" | "full-sandbox" | "ci" | "admin";
+/**
+ * One permission. `sandbox.delete-own` deletes only the sandboxes the key
+ * created; `host` hosts a port; `account.admin` covers billing, teams,
+ * webhooks and keys.
+ * @see https://docs.boat.dev/api-keys/scopes
+ */
+export type ApiKeyAction = "sandbox.create" | "sandbox.read" | "sandbox.update" | "sandbox.stop" | "sandbox.resume" | "sandbox.fork" | "sandbox.delete" | "sandbox.delete-own" | "agent.prompt" | "exec" | "file.read" | "file.write" | "ssh" | "desktop" | "host" | "snapshot.read" | "snapshot.write" | "environment.read" | "environment.write" | "account.read" | "account.admin" | "*";
+export interface ApiKeyProps {
+    /**
+     * Key name. If omitted, a unique name is generated from the stack, stage
+     * and logical ID. Changing it replaces the key.
+     */
+    name?: string;
+    /**
+     * A preset set of actions. Use either `preset` or `actions`; with
+     * neither, the key is an `admin` key. Changing it replaces the key.
+     */
+    preset?: ApiKeyPreset;
+    /** The actions the key may take. Changing them replaces the key. */
+    actions?: ApiKeyAction[];
+    /**
+     * The only sandboxes the key reaches, by id. Omit to reach every
+     * sandbox. Changing them replaces the key.
+     */
+    sandboxIds?: string[];
+    /**
+     * Environments whose sandboxes the key reaches, by id. Changing them
+     * replaces the key.
+     */
+    environmentIds?: string[];
+    /**
+     * How long the key works: `90d`, `24h`, a number of seconds, up to
+     * `365d`, or `never` for a key that works until it is revoked. A key
+     * can't outlive the key that creates it: omitted, the key never expires
+     * when the deployer's key doesn't, and otherwise expires with it.
+     * Changing it replaces the key.
+     */
+    ttl?: string;
+}
+export interface ApiKeyAttributes {
+    /** Boat's key id. */
+    apiKeyId: string;
+    name: string;
+    /** The key (`boat_…`), sent as a bearer token. Boat shows it once; Alchemy keeps it in state. */
+    key: Redacted.Redacted<string>;
+    /** The key's first characters, as the dashboard shows them. */
+    keyPrefix: string;
+    /** The key's last four characters. */
+    keyLastFour: string;
+    /** When the key stops working, or `undefined` for a key that never expires. */
+    expiresAt: string | undefined;
+}
+export interface ApiKey extends Resource<"Boat.ApiKey", ApiKeyProps, ApiKeyAttributes, never, Providers> {
+}
+/**
+ * A scoped Boat API key: the actions it may take, and the sandboxes or
+ * environments it reaches. Give each app or CI system its own key with
+ * only what it needs.
+ *
+ * Boat shows a key once, when it is created, so Alchemy keeps it in state
+ * as a `Redacted` value. Changing any prop creates a new key and revokes
+ * the old one; destroying the resource revokes it.
+ *
+ * Creating a key needs a key with `account.admin`, such as the one
+ * `alchemy profile edit --add Boat` signs in with. A new key cannot have
+ * more actions, more sandboxes or a later expiry than the key creating it.
+ * The key a browser sign-in gets lasts a year, so keys it creates expire
+ * with it. An expired key is minted again on the next deploy.
+ *
+ * ### Creating an API key
+ * **Example:** A key for CI that manages the sandboxes it creates
+ * ```typescript
+ * export const Ci = Boat.ApiKey("Ci", { preset: "ci", ttl: "90d" });
+ * ```
+ *
+ * **Example:** A key that only runs commands in one sandbox
+ * ```typescript
+ * const box = yield* Boat.Sandbox("Box", {});
+ * const key = yield* Boat.ApiKey("BoxExec", {
+ *   actions: ["sandbox.read", "exec", "file.read", "file.write"],
+ *   sandboxIds: [box.sandboxId],
+ * });
+ * ```
+ *
+ * @resource
+ * @product API key
+ */
+export declare const ApiKey: import("alchemy/Resource").ResourceClass<ApiKey>;
+/** Revoke a key; revoking one that is gone succeeds. */
+export declare const revokeApiKey: (apiKeyId: string) => Effect.Effect<void, import("@distilled.cloud/boat-dev").BadGateway | import("@distilled.cloud/core/errors").BadRequest | import("@distilled.cloud/boat-dev").BoatParseError | import("@distilled.cloud/boat-dev").ConfigError | import("@distilled.cloud/core/errors").Conflict | import("@distilled.cloud/core/errors").Forbidden | boat.Forbidden | import("@distilled.cloud/boat-dev").GatewayTimeout | import("effect/http/HttpClientError").HttpClientError | import("@distilled.cloud/boat-dev").InternalServerError | import("@distilled.cloud/core/protocol-http").InvalidInput | import("@distilled.cloud/boat-dev").Locked | import("@distilled.cloud/core/sdk-error").SdkError | import("@distilled.cloud/boat-dev").ServiceUnavailable | import("@distilled.cloud/boat-dev").TooManyRequests | import("@distilled.cloud/boat-dev").Unauthorized | import("@distilled.cloud/boat-dev").UnknownBoatError | import("@distilled.cloud/boat-dev").UnprocessableEntity, boat.BoatOpContext>;
+export declare const ApiKeyProvider: () => import("effect/Layer").Layer<Provider.Provider<ApiKey>, never, import("alchemy/Stack").Stack | import("alchemy/Stage").Stage | boat.BoatOpContext>;
+//# sourceMappingURL=ApiKey.d.ts.map

package/lib/ApiKey.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ApiKey.d.ts","sources":["../src/ApiKey.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,IAAI,MAAM,gCAAgC,CAAC;AAGvD,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAE5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GAAG,WAAW,GAAG,cAAc,GAAG,IAAI,GAAG,OAAO,CAAC;AAEzE;;;;;GAKG;AACH,MAAM,MAAM,YAAY,GACpB,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,cAAc,GACd,gBAAgB,GAChB,oBAAoB,GACpB,cAAc,GACd,MAAM,GACN,WAAW,GACX,YAAY,GACZ,KAAK,GACL,SAAS,GACT,MAAM,GACN,eAAe,GACf,gBAAgB,GAChB,kBAAkB,GAClB,mBAAmB,GACnB,cAAc,GACd,eAAe,GACf,GAAG,CAAC;AAER,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,MAAM,CAAC,EAAE,YAAY,CAAC;IACtB,oEAAoE;IACpE,OAAO,CAAC,EAAE,YAAY,EAAE,CAAC;IACzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,EAAE,CAAC;IACtB;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC;IAC1B;;;;;;OAMG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,gBAAgB;IAC/B,qBAAqB;IACrB,QAAQ,EAAE,MAAM,CAAC;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,iGAAiG;IACjG,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC/B,+DAA+D;IAC/D,SAAS,EAAE,MAAM,CAAC;IAClB,sCAAsC;IACtC,WAAW,EAAE,MAAM,CAAC;IACpB,+EAA+E;IAC/E,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;CAC/B;AAED,MAAM,WAAW,MAAO,SAAQ,QAAQ,CACtC,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,KAAK,EACL,SAAS,CACV;CAAG;AAEJ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,MAAM,kDAAkC,CAAC;AA2CtD,wDAAwD;AACxD,eAAO,MAAM,YAAY,aAAc,MAAM,s8BAI1C,CAAC;AAEJ,eAAO,MAAM,cAAc,0JA+DxB,CAAC"}