alchemy 0.43.4 → 0.44.0

package/lib/planetscale/index.d.ts

@@ -1,5 +1,6 @@
 export * from "./api.ts";
-export * from "./utils.ts";
-export * from "./database.ts";
 export * from "./branch.ts";
+export * from "./database.ts";
+export * from "./password.ts";
+export * from "./utils.ts";
 //# sourceMappingURL=index.d.ts.map

package/lib/planetscale/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/planetscale/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/planetscale/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/lib/planetscale/index.js

@@ -1,5 +1,6 @@
 export * from "./api.js";
-export * from "./utils.js";
-export * from "./database.js";
 export * from "./branch.js";
+export * from "./database.js";
+export * from "./password.js";
+export * from "./utils.js";
 //# sourceMappingURL=index.js.map

package/lib/planetscale/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/planetscale/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,YAAY,CAAC;AAC3B,cAAc,eAAe,CAAC;AAC9B,cAAc,aAAa,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/planetscale/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAC;AACzB,cAAc,aAAa,CAAC;AAC5B,cAAc,eAAe,CAAC;AAC9B,cAAc,eAAe,CAAC;AAC9B,cAAc,YAAY,CAAC"}

package/lib/planetscale/password.d.ts

@@ -0,0 +1,233 @@
+import type { Context } from "../context.ts";
+import { Resource } from "../resource.ts";
+import type { Secret } from "../secret.ts";
+import type { Branch } from "./branch.ts";
+import type { Database } from "./database.ts";
+/**
+ * Properties for creating or updating a PlanetScale Branch
+ */
+export interface PasswordProps {
+    /**
+     * The name of the password
+     */
+    name: string;
+    /**
+     * The organization ID where the password will be created
+     * Required when using string database name, optional when using Database resource
+     */
+    organizationId?: string;
+    /**
+     * The database where the password will be created
+     * Can be either a database name (string) or Database resource
+     */
+    database: string | Database;
+    /**
+     * The branch where the password will be created
+     * Can be either a branch name (string) or Branch resource
+     * Defaults to "main" if not provided
+     */
+    branch?: string | Branch;
+    /**
+     * PlanetScale API token (overrides environment variable)
+     */
+    apiKey?: Secret;
+    /**
+     * The password
+     */
+    role: "reader" | "writer" | "admin" | "readwriter";
+    /**
+     * Whether the password is for a read replica
+     */
+    replica?: boolean;
+    /**
+     * The TTL of the password in seconds
+     */
+    ttl?: number;
+    /**
+     * The CIDRs of the password
+     */
+    cidrs?: string[];
+}
+/**
+ * Represents a PlanetScale Branch
+ */
+export interface Password extends Resource<"planetscale::Password">, PasswordProps {
+    /**
+     * The unique identifier for the password
+     */
+    id: string;
+    /**
+     * The timestamp when the password expires (ISO 8601 format)
+     */
+    expiresAt: string;
+    /**
+     * The host URL for database connection
+     */
+    host: string;
+    /**
+     * The username for database authentication
+     */
+    username: string;
+    /**
+     * The encrypted password for database authentication
+     */
+    password: Secret<string>;
+    /**
+     * The name slug for the password
+     */
+    nameSlug: string;
+}
+/**
+ * Create and manage database passwords for PlanetScale branches. Database passwords provide secure access to your database with specific roles and permissions.
+ *
+ * @example
+ * ## Basic Reader Password
+ *
+ * Create a read-only password for a database branch:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const readerPassword = await Password("app-reader", {
+ *   name: "app-reader",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "reader"
+ * });
+ *
+ * // Access connection details
+ * console.log(`Host: ${readerPassword.password.host}`);
+ * console.log(`Username: ${readerPassword.password.username}`);
+ * console.log(`Password: ${readerPassword.password.password.unencrypted}`);
+ * ```
+ *
+ * @example
+ * ## Writer Password with TTL
+ *
+ * Create a writer password that expires after 24 hours:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const writerPassword = await Password("app-writer", {
+ *   name: "app-writer",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "development",
+ *   role: "writer",
+ *   ttl: 86400 // 24 hours in seconds
+ * });
+ *
+ * // Password will expire at the specified time
+ * console.log(`Expires at: ${writerPassword.expiresAt}`);
+ * ```
+ *
+ * @example
+ * ## Admin Password with IP Restrictions
+ *
+ * Create an admin password that only allows connections from specific IP addresses:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const adminPassword = await Password("admin-access", {
+ *   name: "admin-access",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "admin",
+ *   cidrs: ["203.0.113.0/24", "198.51.100.0/24"],
+ *   ttl: 3600 // 1 hour
+ * });
+ * ```
+ *
+ * @example
+ * ## Database Password with Custom API Key
+ *
+ * Create a password using a specific API key instead of the default environment variable:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const password = await Password("custom-auth", {
+ *   name: "custom-auth",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "readwriter",
+ *   apiKey: alchemy.secret(process.env.CUSTOM_PLANETSCALE_TOKEN)
+ * });
+ * ```
+ *
+ * @example
+ * ## Read Replica Password
+ *
+ * Create a password for accessing a read replica:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const replicaPassword = await Password("replica-reader", {
+ *   name: "replica-reader",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "reader",
+ *   replica: true
+ * });
+ *
+ * @example
+ * ## Using Database Resource Instance
+ *
+ * Create a password using a Database resource instead of string:
+ *
+ * ```ts
+ * import { Database, Password } from "alchemy/planetscale";
+ *
+ * const database = await Database("my-db", {
+ *   name: "my-app-db",
+ *   organizationId: "my-org",
+ *   clusterSize: "PS_10"
+ * });
+ *
+ * const password = await Password("db-reader", {
+ *   name: "db-reader",
+ *   database: database, // Using Database resource
+ *   role: "reader"
+ * });
+ * ```
+ *
+ * @example
+ * ## Using Both Database and Branch Resources
+ *
+ * Create a password using both Database and Branch resources:
+ *
+ * ```ts
+ * import { Database, Branch, Password } from "alchemy/planetscale";
+ *
+ * const database = await Database("my-db", {
+ *   name: "my-app-db",
+ *   organizationId: "my-org",
+ *   clusterSize: "PS_10"
+ * });
+ *
+ * const branch = await Branch("feature-branch", {
+ *   name: "feature-branch",
+ *   organizationId: "my-org",
+ *   databaseName: "my-app-db",
+ *   parentBranch: "main",
+ *   isProduction: false
+ * });
+ *
+ * const password = await Password("feature-writer", {
+ *   name: "feature-writer",
+ *   database: database, // Using Database resource
+ *   branch: branch, // Using Branch resource
+ *   role: "writer"
+ * });
+ * ```
+ * ```
+ */
+export declare const Password: (((this: any, id: string, props?: {}) => never) & (new (_: never) => never)) | ((this: Context<Password>, _id: string, props: PasswordProps) => Promise<Password>);
+//# sourceMappingURL=password.d.ts.map

package/lib/planetscale/password.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"password.d.ts","sourceRoot":"","sources":["../../src/planetscale/password.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC;AAI3C,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAC1C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAE9C;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAC;IAE5B;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IAEzB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,IAAI,EAAE,QAAQ,GAAG,QAAQ,GAAG,OAAO,GAAG,YAAY,CAAC;IAEnD;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,EAAE,CAAC;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,QACf,SAAQ,QAAQ,CAAC,uBAAuB,CAAC,EACvC,aAAa;IACf;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;IAEzB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;CAClB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuJG;AACH,eAAO,MAAM,QAAQ,yFAGX,OAAO,CAAC,QAAQ,CAAC,OAClB,MAAM,SACJ,aAAa,KACnB,OAAO,CAAC,QAAQ,CAAC,CA0GrB,CAAC"}

package/lib/planetscale/password.js

@@ -0,0 +1,238 @@
+import { alchemy } from "../alchemy.js";
+import { Resource } from "../resource.js";
+import { logger } from "../util/logger.js";
+import { lowercaseId } from "../util/nanoid.js";
+import { PlanetScaleApi } from "./api.js";
+/**
+ * Create and manage database passwords for PlanetScale branches. Database passwords provide secure access to your database with specific roles and permissions.
+ *
+ * @example
+ * ## Basic Reader Password
+ *
+ * Create a read-only password for a database branch:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const readerPassword = await Password("app-reader", {
+ *   name: "app-reader",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "reader"
+ * });
+ *
+ * // Access connection details
+ * console.log(`Host: ${readerPassword.password.host}`);
+ * console.log(`Username: ${readerPassword.password.username}`);
+ * console.log(`Password: ${readerPassword.password.password.unencrypted}`);
+ * ```
+ *
+ * @example
+ * ## Writer Password with TTL
+ *
+ * Create a writer password that expires after 24 hours:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const writerPassword = await Password("app-writer", {
+ *   name: "app-writer",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "development",
+ *   role: "writer",
+ *   ttl: 86400 // 24 hours in seconds
+ * });
+ *
+ * // Password will expire at the specified time
+ * console.log(`Expires at: ${writerPassword.expiresAt}`);
+ * ```
+ *
+ * @example
+ * ## Admin Password with IP Restrictions
+ *
+ * Create an admin password that only allows connections from specific IP addresses:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const adminPassword = await Password("admin-access", {
+ *   name: "admin-access",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "admin",
+ *   cidrs: ["203.0.113.0/24", "198.51.100.0/24"],
+ *   ttl: 3600 // 1 hour
+ * });
+ * ```
+ *
+ * @example
+ * ## Database Password with Custom API Key
+ *
+ * Create a password using a specific API key instead of the default environment variable:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const password = await Password("custom-auth", {
+ *   name: "custom-auth",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "readwriter",
+ *   apiKey: alchemy.secret(process.env.CUSTOM_PLANETSCALE_TOKEN)
+ * });
+ * ```
+ *
+ * @example
+ * ## Read Replica Password
+ *
+ * Create a password for accessing a read replica:
+ *
+ * ```ts
+ * import { Password } from "alchemy/planetscale";
+ *
+ * const replicaPassword = await Password("replica-reader", {
+ *   name: "replica-reader",
+ *   organizationId: "my-org",
+ *   database: "my-app-db",
+ *   branch: "main",
+ *   role: "reader",
+ *   replica: true
+ * });
+ *
+ * @example
+ * ## Using Database Resource Instance
+ *
+ * Create a password using a Database resource instead of string:
+ *
+ * ```ts
+ * import { Database, Password } from "alchemy/planetscale";
+ *
+ * const database = await Database("my-db", {
+ *   name: "my-app-db",
+ *   organizationId: "my-org",
+ *   clusterSize: "PS_10"
+ * });
+ *
+ * const password = await Password("db-reader", {
+ *   name: "db-reader",
+ *   database: database, // Using Database resource
+ *   role: "reader"
+ * });
+ * ```
+ *
+ * @example
+ * ## Using Both Database and Branch Resources
+ *
+ * Create a password using both Database and Branch resources:
+ *
+ * ```ts
+ * import { Database, Branch, Password } from "alchemy/planetscale";
+ *
+ * const database = await Database("my-db", {
+ *   name: "my-app-db",
+ *   organizationId: "my-org",
+ *   clusterSize: "PS_10"
+ * });
+ *
+ * const branch = await Branch("feature-branch", {
+ *   name: "feature-branch",
+ *   organizationId: "my-org",
+ *   databaseName: "my-app-db",
+ *   parentBranch: "main",
+ *   isProduction: false
+ * });
+ *
+ * const password = await Password("feature-writer", {
+ *   name: "feature-writer",
+ *   database: database, // Using Database resource
+ *   branch: branch, // Using Branch resource
+ *   role: "writer"
+ * });
+ * ```
+ * ```
+ */
+export const Password = Resource("planetscale::Password", async function (_id, props) {
+    const apiKey = props.apiKey?.unencrypted || process.env.PLANETSCALE_API_TOKEN;
+    if (!apiKey) {
+        throw new Error("PLANETSCALE_API_TOKEN environment variable is required");
+    }
+    const nameSlug = this.isReplacement
+        ? lowercaseId()
+        : (this.output?.nameSlug ?? lowercaseId());
+    const name = `${props.name.toLowerCase()}-${nameSlug}`;
+    const api = new PlanetScaleApi({ apiKey });
+    const branchName = props.branch == null
+        ? "main"
+        : typeof props.branch === "string"
+            ? props.branch
+            : props.branch.name;
+    const databaseName = typeof props.database === "string" ? props.database : props.database.name;
+    if (this.phase === "delete") {
+        try {
+            if (this.output?.name) {
+                const response = await api.delete(`/organizations/${props.organizationId}/databases/${databaseName}/branches/${branchName}/passwords/${this.output.id}`);
+                if (!response.ok && response.status !== 404) {
+                    throw new Error(`Failed to delete branch: ${response.statusText} ${await response.text()}`);
+                }
+            }
+        }
+        catch (error) {
+            logger.error("Error deleting password:", error);
+            throw error;
+        }
+        return this.destroy();
+    }
+    if (this.phase === "update") {
+        if (this.output?.name === name &&
+            ((this.output?.cidrs === undefined && props.cidrs === undefined) ||
+                (Array.isArray(this.output?.cidrs) &&
+                    Array.isArray(props.cidrs) &&
+                    this.output.cidrs.length === props.cidrs.length &&
+                    this.output.cidrs.every((cidr, i) => cidr === props.cidrs[i])))) {
+            return this.replace();
+        }
+        const updateResponse = await api.patch(`/organizations/${props.organizationId}/databases/${databaseName}/branches/${branchName}/passwords/${this.output.id}`, {
+            name,
+            cidrs: props.cidrs,
+        });
+        if (!updateResponse.ok) {
+            throw new Error(`Failed to update password: ${updateResponse.statusText} ${await updateResponse.text()}`);
+        }
+        return this({
+            ...this.output,
+            ...props,
+        });
+    }
+    try {
+        const createResponse = await api.post(`/organizations/${props.organizationId}/databases/${databaseName}/branches/${branchName}/passwords`, {
+            name,
+            role: props.role,
+            replica: props.replica,
+            ttl: props.ttl,
+            cidrs: props.cidrs,
+        });
+        if (!createResponse.ok) {
+            throw new Error(`Failed to create password: ${createResponse.statusText} ${await createResponse.text()}`);
+        }
+        const data = await createResponse.json();
+        return this({
+            id: data.id,
+            expiresAt: data.expires_at,
+            host: data.access_host_url,
+            username: data.username,
+            password: alchemy.secret(data.plain_text),
+            nameSlug,
+            ...props,
+            name: `${props.name}-${nameSlug}`,
+        });
+    }
+    catch (error) {
+        logger.error("Error managing password:", error);
+        throw error;
+    }
+});
+//# sourceMappingURL=password.js.map

package/lib/planetscale/password.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"password.js","sourceRoot":"","sources":["../../src/planetscale/password.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE1C,OAAO,EAAE,MAAM,EAAE,MAAM,mBAAmB,CAAC;AAC3C,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AA+F1C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAuJG;AACH,MAAM,CAAC,MAAM,QAAQ,GAAG,QAAQ,CAC9B,uBAAuB,EACvB,KAAK,WAEH,GAAW,EACX,KAAoB;IAEpB,MAAM,MAAM,GACV,KAAK,CAAC,MAAM,EAAE,WAAW,IAAI,OAAO,CAAC,GAAG,CAAC,qBAAqB,CAAC;IACjE,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa;QACjC,CAAC,CAAC,WAAW,EAAE;QACf,CAAC,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,QAAQ,IAAI,WAAW,EAAE,CAAC,CAAC;IAC7C,MAAM,IAAI,GAAG,GAAG,KAAK,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,QAAQ,EAAE,CAAC;IAEvD,MAAM,GAAG,GAAG,IAAI,cAAc,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC;IAC3C,MAAM,UAAU,GACd,KAAK,CAAC,MAAM,IAAI,IAAI;QAClB,CAAC,CAAC,MAAM;QACR,CAAC,CAAC,OAAO,KAAK,CAAC,MAAM,KAAK,QAAQ;YAChC,CAAC,CAAC,KAAK,CAAC,MAAM;YACd,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC;IAC1B,MAAM,YAAY,GAChB,OAAO,KAAK,CAAC,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC;IAE5E,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,IAAI,CAAC;YACH,IAAI,IAAI,CAAC,MAAM,EAAE,IAAI,EAAE,CAAC;gBACtB,MAAM,QAAQ,GAAG,MAAM,GAAG,CAAC,MAAM,CAC/B,kBAAkB,KAAK,CAAC,cAAc,cAAc,YAAY,aAAa,UAAU,cAAc,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,CACtH,CAAC;gBAEF,IAAI,CAAC,QAAQ,CAAC,EAAE,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;oBAC5C,MAAM,IAAI,KAAK,CACb,4BAA4B,QAAQ,CAAC,UAAU,IAAI,MAAM,QAAQ,CAAC,IAAI,EAAE,EAAE,CAC3E,CAAC;gBACJ,CAAC;YACH,CAAC;QACH,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACf,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;YAChD,MAAM,KAAK,CAAC;QACd,CAAC;QACD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;IACxB,CAAC;IACD,IAAI,IAAI,CAAC,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC5B,IACE,IAAI,CAAC,MAAM,EAAE,IAAI,KAAK,IAAI;YAC1B,CAAC,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,KAAK,KAAK,SAAS,CAAC;gBAC9D,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC;oBAChC,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,KAAK,CAAC;oBAC1B,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,KAAK,KAAK,CAAC,KAAK,CAAC,MAAM;oBAC/C,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,KAAK,CAAC,KAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACpE,CAAC;YACD,OAAO,IAAI,CAAC,OAAO,EAAE,CAAC;QACxB,CAAC;QACD,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,KAAK,CACpC,kBAAkB,KAAK,CAAC,cAAc,cAAc,YAAY,aAAa,UAAU,cAAc,IAAI,CAAC,MAAM,CAAC,EAAE,EAAE,EACrH;YACE,IAAI;YACJ,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CACF,CAAC;QAEF,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,8BAA8B,cAAc,CAAC,UAAU,IAAI,MAAM,cAAc,CAAC,IAAI,EAAE,EAAE,CACzF,CAAC;QACJ,CAAC;QAED,OAAO,IAAI,CAAC;YACV,GAAG,IAAI,CAAC,MAAM;YACd,GAAG,KAAK;SACT,CAAC,CAAC;IACL,CAAC;IAED,IAAI,CAAC;QACH,MAAM,cAAc,GAAG,MAAM,GAAG,CAAC,IAAI,CACnC,kBAAkB,KAAK,CAAC,cAAc,cAAc,YAAY,aAAa,UAAU,YAAY,EACnG;YACE,IAAI;YACJ,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,OAAO,EAAE,KAAK,CAAC,OAAO;YACtB,GAAG,EAAE,KAAK,CAAC,GAAG;YACd,KAAK,EAAE,KAAK,CAAC,KAAK;SACnB,CACF,CAAC;QAEF,IAAI,CAAC,cAAc,CAAC,EAAE,EAAE,CAAC;YACvB,MAAM,IAAI,KAAK,CACb,8BAA8B,cAAc,CAAC,UAAU,IAAI,MAAM,cAAc,CAAC,IAAI,EAAE,EAAE,CACzF,CAAC;QACJ,CAAC;QAED,MAAM,IAAI,GAAG,MAAM,cAAc,CAAC,IAAI,EAAO,CAAC;QAE9C,OAAO,IAAI,CAAC;YACV,EAAE,EAAE,IAAI,CAAC,EAAE;YACX,SAAS,EAAE,IAAI,CAAC,UAAU;YAC1B,IAAI,EAAE,IAAI,CAAC,eAAe;YAC1B,QAAQ,EAAE,IAAI,CAAC,QAAQ;YACvB,QAAQ,EAAE,OAAO,CAAC,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC;YACzC,QAAQ;YACR,GAAG,KAAK;YACR,IAAI,EAAE,GAAG,KAAK,CAAC,IAAI,IAAI,QAAQ,EAAE;SAClC,CAAC,CAAC;IACL,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,0BAA0B,EAAE,KAAK,CAAC,CAAC;QAChD,MAAM,KAAK,CAAC;IACd,CAAC;AACH,CAAC,CACF,CAAC"}

package/lib/scope.d.ts

@@ -10,10 +10,9 @@ export declare class RootScopeStateAttemptError extends Error {
     constructor();
 }
 export interface ScopeOptions {
-    appName?: string;
     stage?: string;
-    parent?: Scope;
-    scopeName?: string;
+    parent: Scope | undefined;
+    scopeName: string;
     password?: string;
     stateStore?: StateStoreType;
     quiet?: boolean;
@@ -26,6 +25,7 @@ export type PendingDeletions = Array<{
     resource: Resource<string>;
     oldProps?: ResourceProps;
 }>;
+export declare const DEFAULT_STAGE: string;
 declare global {
     var __ALCHEMY_STORAGE__: AsyncLocalStorage<Scope>;
     var __ALCHEMY_GLOBALS__: Scope[];
@@ -42,9 +42,9 @@ export declare class Scope {
     static get current(): Scope;
     readonly resources: Map<string, PendingResource<unknown>>;
     readonly children: Map<ResourceID, Scope>;
-    readonly appName: string | undefined;
     readonly stage: string;
-    readonly scopeName: string | null;
+    readonly name: string;
+    readonly scopeName: string;
     readonly parent: Scope | undefined;
     readonly password: string | undefined;
     readonly state: StateStore;
@@ -59,6 +59,7 @@ export declare class Scope {
     private finalized;
     private startedAt;
     private deferred;
+    get appName(): string;
     constructor(options: ScopeOptions);
     get root(): Scope;
     deleteResource(resourceID: ResourceID): Promise<void>;

package/lib/scope.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../src/scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAG1C,OAAO,EAEL,UAAU,EAIV,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,aAAa,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAS,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,qBAAa,0BAA2B,SAAQ,KAAK;;CAIpD;AAED,MAAM,WAAW,YAAY;IAC3B,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,KAAK,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC;IACnC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC,CAAC;AASH,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,mBAAmB,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClD,IAAI,mBAAmB,EAAE,KAAK,EAAE,CAAC;CAClC;AAED,QAAA,MAAM,WAAW,eAA+B,CAAC;AAEjD,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,KAAK,CAElD;AAED,qBAAa,KAAK;IAChB,QAAQ,CAAC,CAAC,WAAW,CAAC,QAAQ;IAE9B,gBAAuB,IAAI,EAAG,gBAAgB,CAAU;IAExD,OAAc,OAAO,2BACa;IAClC,OAAc,OAAO,EAAE,KAAK,EAAE,CAA2C;WAE3D,QAAQ,IAAI,KAAK,GAAG,SAAS;IAW3C,WAAkB,IAAI,IAAI,KAAK,CAE9B;IAED,WAAkB,OAAO,IAAI,KAAK,CAIjC;IAED,SAAgB,SAAS,wCAA0C;IACnE,SAAgB,QAAQ,EAAE,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAa;IAC7D,SAAgB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5C,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,SAAS,EAAE,MAAM,GAAG,IAAI,CAAC;IACzC,SAAgB,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1C,SAAgB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,SAAgB,KAAK,EAAE,UAAU,CAAC;IAClC,SAAgB,UAAU,EAAE,cAAc,CAAC;IAC3C,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,SAAgB,GAAG,CAAC,EAAE,OAAO,CAAC;IAC9B,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,eAAe,EAAE,gBAAgB,CAAC;IAClD,SAAgB,SAAS,EAAE,UAAU,CAAC;IAEtC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO,CAAC,QAAQ,CAA8B;gBAElC,OAAO,EAAE,YAAY;IAsDjC,IAAW,IAAI,IAAI,KAAK,CAMvB;IAEY,cAAc,CAAC,UAAU,EAAE,UAAU;IAKlD,OAAO,CAAC,IAAI,CAAK;IAEV,GAAG;IAIV,IAAW,KAAK,IAAI,MAAM,EAAE,CAO3B;IAEM,IAAI;IAKE,IAAI;IAIJ,MAAM;IAKZ,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;IAI1C;;;;;;;OAOG;YACW,cAAc;IA8Cf,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5C,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/B,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAIjE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAIrB,CAAC,MAAM,CAAC,YAAY,CAAC;IAIrB;;;OAGG;IACH,OAAO,KAAK,mBAAmB,GAK9B;IAEY,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IA4ExB,uBAAuB;IAyBpC;;OAEG;IACI,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBjD;;OAEG;IACI,QAAQ;CAQhB;AAED,OAAO,CAAC,MAAM,CAAC;IAGb,IAAI,iBAAiB,EAAE,OAAO,KAAK,CAAC;CACrC"}
+{"version":3,"file":"scope.d.ts","sourceRoot":"","sources":["../src/scope.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AACrD,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAI1C,OAAO,EAEL,UAAU,EAIV,KAAK,eAAe,EACpB,KAAK,QAAQ,EACb,KAAK,aAAa,EACnB,MAAM,eAAe,CAAC;AACvB,OAAO,KAAK,EAAS,UAAU,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC;AACpE,OAAO,EAGL,KAAK,SAAS,EACf,MAAM,eAAe,CAAC;AACvB,OAAO,EAAE,UAAU,EAAE,MAAM,iBAAiB,CAAC;AAC7C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAEnE,qBAAa,0BAA2B,SAAQ,KAAK;;CAIpD;AAED,MAAM,WAAW,YAAY;IAC3B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1B,SAAS,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,cAAc,CAAC;IAC5B,KAAK,CAAC,EAAE,OAAO,CAAC;IAChB,KAAK,CAAC,EAAE,KAAK,CAAC;IACd,GAAG,CAAC,EAAE,OAAO,CAAC;IACd,eAAe,CAAC,EAAE,gBAAgB,CAAC;IACnC,MAAM,CAAC,EAAE,SAAS,CAAC;CACpB;AAED,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC;IACnC,QAAQ,EAAE,QAAQ,CAAC,MAAM,CAAC,CAAC;IAC3B,QAAQ,CAAC,EAAE,aAAa,CAAC;CAC1B,CAAC,CAAC;AAGH,eAAO,MAAM,aAAa,QAInB,CAAC;AAER,OAAO,CAAC,MAAM,CAAC;IACb,IAAI,mBAAmB,EAAE,iBAAiB,CAAC,KAAK,CAAC,CAAC;IAClD,IAAI,mBAAmB,EAAE,KAAK,EAAE,CAAC;CAClC;AAED,QAAA,MAAM,WAAW,eAA+B,CAAC;AAEjD,wBAAgB,OAAO,CAAC,KAAK,EAAE,GAAG,GAAG,KAAK,IAAI,KAAK,CAElD;AAED,qBAAa,KAAK;IAChB,QAAQ,CAAC,CAAC,WAAW,CAAC,QAAQ;IAE9B,gBAAuB,IAAI,EAAG,gBAAgB,CAAU;IAExD,OAAc,OAAO,2BACa;IAClC,OAAc,OAAO,EAAE,KAAK,EAAE,CAA2C;WAE3D,QAAQ,IAAI,KAAK,GAAG,SAAS;IAW3C,WAAkB,IAAI,IAAI,KAAK,CAE9B;IAED,WAAkB,OAAO,IAAI,KAAK,CAIjC;IAED,SAAgB,SAAS,wCAA0C;IACnE,SAAgB,QAAQ,EAAE,GAAG,CAAC,UAAU,EAAE,KAAK,CAAC,CAAa;IAC7D,SAAgB,KAAK,EAAE,MAAM,CAAC;IAC9B,SAAgB,IAAI,EAAE,MAAM,CAAC;IAC7B,SAAgB,SAAS,EAAE,MAAM,CAAC;IAClC,SAAgB,MAAM,EAAE,KAAK,GAAG,SAAS,CAAC;IAC1C,SAAgB,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7C,SAAgB,KAAK,EAAE,UAAU,CAAC;IAClC,SAAgB,UAAU,EAAE,cAAc,CAAC;IAC3C,SAAgB,KAAK,EAAE,OAAO,CAAC;IAC/B,SAAgB,KAAK,EAAE,KAAK,CAAC;IAC7B,SAAgB,GAAG,CAAC,EAAE,OAAO,CAAC;IAC9B,SAAgB,MAAM,EAAE,SAAS,CAAC;IAClC,SAAgB,eAAe,EAAE,gBAAgB,CAAC;IAClD,SAAgB,SAAS,EAAE,UAAU,CAAC;IAEtC,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAS;IAC1B,OAAO,CAAC,SAAS,CAAqB;IAEtC,OAAO,CAAC,QAAQ,CAA8B;IAE9C,IAAW,OAAO,IAAI,MAAM,CAK3B;gBAEW,OAAO,EAAE,YAAY;IA6DjC,IAAW,IAAI,IAAI,KAAK,CAMvB;IAEY,cAAc,CAAC,UAAU,EAAE,UAAU;IAKlD,OAAO,CAAC,IAAI,CAAK;IAEV,GAAG;IAIV,IAAW,KAAK,IAAI,MAAM,EAAE,CAO3B;IAEM,IAAI;IAKE,IAAI;IAIJ,MAAM;IAKZ,GAAG,CAAC,UAAU,EAAE,UAAU,GAAG,MAAM;IAI1C;;;;;;;OAOG;YACW,cAAc;IA8Cf,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IAO5C,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC;IAI/B,MAAM,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAOlC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAIjE,CAAC,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC;IAIrB,CAAC,MAAM,CAAC,YAAY,CAAC;IAIrB;;;OAGG;IACH,OAAO,KAAK,mBAAmB,GAK9B;IAEY,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO;IA4ExB,uBAAuB;IAyBpC;;OAEG;IACI,KAAK,CAAC,CAAC,EAAE,EAAE,EAAE,MAAM,OAAO,CAAC,CAAC,CAAC,GAAG,OAAO,CAAC,CAAC,CAAC;IAmBjD;;OAEG;IACI,QAAQ;CAQhB;AAED,OAAO,CAAC,MAAM,CAAC;IAGb,IAAI,iBAAiB,EAAE,OAAO,KAAK,CAAC;CACrC"}

package/lib/scope.js

@@ -1,5 +1,6 @@
 import { AsyncLocalStorage } from "node:async_hooks";
 import util from "node:util";
+import { DOStateStore } from "./cloudflare/do-state-store/index.js";
 import { destroy, destroyAll } from "./destroy.js";
 import { FileSystemStateStore } from "./fs/file-system-state-store.js";
 import { ResourceFQN, ResourceID, ResourceKind, ResourceScope, ResourceSeq, } from "./resource.js";
@@ -11,7 +12,7 @@ export class RootScopeStateAttemptError extends Error {
     }
 }
 // TODO: support browser
-const DEFAULT_STAGE = process.env.ALCHEMY_STAGE ??
+export const DEFAULT_STAGE = process.env.ALCHEMY_STAGE ??
     process.env.USER ??
     process.env.USERNAME ??
     "dev";
@@ -46,8 +47,8 @@ export class Scope {
     }
     resources = new Map();
     children = new Map();
-    appName;
     stage;
+    name;
     scopeName;
     parent;
     password;
@@ -63,13 +64,21 @@ export class Scope {
     finalized = false;
     startedAt = performance.now();
     deferred = [];
+    get appName() {
+        if (this.parent) {
+            return this.parent.appName;
+        }
+        return this.scopeName;
+    }
     constructor(options) {
-        this.appName = options.appName ?? options.parent?.appName;
-        this.scopeName = options.scopeName ?? null;
-        if (this.scopeName?.includes(":")) {
+        this.scopeName = options.scopeName;
+        this.name = this.scopeName;
+        this.parent = options.parent ?? Scope.getScope();
+        const isChild = this.parent !== undefined;
+        if (this.scopeName?.includes(":") && isChild) {
+            // TODO(sam): relax this constraint once we move to SQLite3 store
             throw new Error(`Scope name "${this.scopeName}" cannot contain double colons`);
         }
-        this.parent = options.parent ?? Scope.getScope();
         this.stage = options?.stage ?? this.parent?.stage ?? DEFAULT_STAGE;
         this.parent?.children.set(this.scopeName, this);
         this.quiet = options.quiet ?? this.parent?.quiet ?? false;
@@ -96,7 +105,9 @@ export class Scope {
         this.stateStore =
             options.stateStore ??
                 this.parent?.stateStore ??
-                ((scope) => new FileSystemStateStore(scope));
+                ((scope) => process.env.ALCHEMY_STATE_STORE === "cloudflare"
+                    ? new DOStateStore(scope)
+                    : new FileSystemStateStore(scope));
         this.state = this.stateStore(this);
         if (!options.telemetryClient && !this.parent?.telemetryClient) {
             throw new Error("Telemetry client is required");