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

package/lib/Redis.d.ts

@@ -0,0 +1,252 @@
+import type { AddOnPlansResponseEdgesItemNode, AddOnsResponseEdgesItemNode } from "@distilled.cloud/fly-io/addons";
+import * as addons from "@distilled.cloud/fly-io/addons";
+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";
+export declare const DEFAULT_REDIS_REGION = "iad";
+export declare const REDIS_ADDON_TYPE = "upstash_redis";
+export declare const REDIS_PROVIDER = "upstash_redis";
+export declare const REDIS_URL_ENV = "REDIS_URL";
+export { CommandError as RedisCommandError, UrlMissing as RedisUrlMissing, } from "@alchemy.run/redis";
+export interface RedisProps {
+    /**
+     * Upstash Redis database name. Globally unique in the org. If omitted,
+     * a unique name is generated from the stack, stage and logical ID.
+     * Changing it replaces the database.
+     */
+    name?: string;
+    /**
+     * Primary region (`iad`, `ord`, `sjc`, …). Fly cannot move a primary.
+     * Changing it replaces the database.
+     *
+     * @default "iad"
+     */
+    primaryRegion?: string;
+    /**
+     * Organization slug. Defaults to the current token's org. Changing it
+     * replaces the database.
+     */
+    orgSlug?: string;
+    /**
+     * Add-on plan id, name, or display name from `addOnPlans`. Default is
+     * the cheapest listed plan (free or pay-as-you-go). Fixed plans are
+     * billed. Default tests use the cheapest listed plan.
+     */
+    plan?: string;
+    /**
+     * Read-replica regions. Updated in place. Must not include the
+     * primary region.
+     */
+    readRegions?: string[];
+    /**
+     * Evict keys when memory is full (cache workload). Updated in place.
+     */
+    eviction?: boolean;
+    /**
+     * Automatically upgrade a fixed plan when hitting resource limits.
+     * Ignored on pay-as-you-go.
+     */
+    autoUpgrade?: boolean;
+    /**
+     * ProdPack add-on ($200/mo). Paid. Not enabled in default tests.
+     */
+    prodPack?: boolean;
+}
+export type Redis = Resource<"Fly.Redis", RedisProps, {
+    /** Fly GraphQL add-on id. */
+    redisId: string;
+    /** Physical Upstash Redis name. */
+    name: string;
+    /** Primary region code. */
+    primaryRegion: string;
+    /** Observed read-replica regions. */
+    readRegions: string[];
+    /** Observed status (`ready`, `provisioning`, …). */
+    status: string | undefined;
+    /** Selected plan id, if the API returned one. */
+    planId: string | undefined;
+    /** Observed plan name (`Pay-as-you-go`, `Fixed 250MB`, …). */
+    planName: string | undefined;
+    /** Private 6PN address, if the API returned one. */
+    privateIp: string | undefined;
+    /** Organization slug. */
+    orgSlug: string | undefined;
+    /** Whether eviction is enabled. */
+    eviction: boolean | undefined;
+    /**
+     * Redacted Upstash connection URL. Bindings transport it to the
+     * runtime automatically. Service attachments also set `REDIS_URL`.
+     */
+    url: Redacted.Redacted<string> | undefined;
+}, never, Providers>;
+/**
+ * Managed Upstash Redis in a Fly org. Bind {@link ReadRedis},
+ * {@link WriteRedis}, or {@link ReadWriteRedis} on a {@link Service}.
+ * Alchemy transports the redacted `url` Output to the runtime client
+ * and also writes `REDIS_URL` as an App secret for compatibility.
+ * Redis is not reachable from CI — drive it over HTTP.
+ *
+ * @see https://fly.io/docs/upstash/redis/
+ *
+ * ### Create Redis
+ * Alchemy generates a unique name unless you pass one. Default region is
+ * `iad`. Default plan is the cheapest `addOnPlans` row (free or
+ * pay-as-you-go).
+ *
+ * **Example:** Generated name
+ * ```typescript
+ * const cache = yield* Fly.Redis("Cache");
+ * ```
+ *
+ * :::note
+ * Prefer omitting `name` in tests and CI so names stay unique and
+ * reclaimable.
+ * :::
+ *
+ * ### A stable name
+ * Pass `name` when you want a stable Upstash database name.
+ *
+ * **Example:** Explicit name
+ * ```typescript
+ * const cache = yield* Fly.Redis("Cache", {
+ *   name: "my-cache",
+ *   primaryRegion: "iad",
+ * });
+ * ```
+ *
+ * :::caution[Changing `name` replaces Redis]
+ * Fly cannot rename an add-on. Alchemy deletes the old database first,
+ * then creates the new one.
+ * :::
+ *
+ * :::caution[Changing `primaryRegion` replaces Redis]
+ * The primary region is immutable. The old database is deleted first
+ * because the name cannot exist twice.
+ * :::
+ *
+ * ### Bind from a Service
+ * Yield {@link ReadWriteRedis} (or {@link ReadRedis} / {@link WriteRedis})
+ * in Service init. Provide the matching `*Http` layer.
+ *
+ * **Example:** Read and write
+ * ```typescript
+ * import * as HttpServerResponse from "effect/http/HttpServerResponse";
+ *
+ * const Cache = Fly.Redis("Cache");
+ *
+ * export default class Api extends Fly.Service<Api>()(
+ *   "Api",
+ *   { app: Site, main: import.meta.url, port: 3000 },
+ *   Effect.gen(function* () {
+ *     const cache = yield* Fly.ReadWriteRedis(Cache);
+ *     return {
+ *       fetch: Effect.gen(function* () {
+ *         yield* cache.set("marker", "hello");
+ *         const value = yield* cache.get("marker");
+ *         return HttpServerResponse.json({ value });
+ *       }),
+ *     };
+ *   }).pipe(Effect.provide(Fly.ReadWriteRedisHttp)),
+ * ) {}
+ * ```
+ *
+ * ### Eviction
+ * Enable eviction for cache workloads. Updated in place.
+ *
+ * **Example:** Eviction
+ * ```typescript
+ * const cache = yield* Fly.Redis("Cache", {
+ *   eviction: true,
+ * });
+ * ```
+ *
+ * ### Read replicas
+ * `readRegions` are extra replica regions. Updated in place.
+ *
+ * **Example:** Replica region
+ * ```typescript
+ * const cache = yield* Fly.Redis("Cache", {
+ *   primaryRegion: "iad",
+ *   readRegions: ["sjc"],
+ * });
+ * ```
+ *
+ * ### Plan
+ * Omit `plan` for the cheapest listed plan. Pass a plan id or display
+ * name to pin one. Fixed plans are billed.
+ *
+ * **Example:** Pin pay-as-you-go
+ * ```typescript
+ * const cache = yield* Fly.Redis("Cache", {
+ *   plan: "Pay-as-you-go",
+ * });
+ * ```
+ *
+ * :::caution[Fixed plans are billed]
+ * Fixed plans are billed monthly. Prefer omitting `plan` unless you
+ * need a specific size.
+ * :::
+ *
+ * @resource
+ * @product Redis
+ */
+export declare const Redis: import("alchemy/Resource").ResourceClass<Redis>;
+declare const RedisNotCreated_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Fly.RedisNotCreated";
+} & Readonly<A>;
+export declare class RedisNotCreated extends RedisNotCreated_base<{
+    name: string;
+    errorMessage?: string;
+}> {
+}
+declare const RedisPlanNotFound_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Fly.RedisPlanNotFound";
+} & Readonly<A>;
+export declare class RedisPlanNotFound extends RedisPlanNotFound_base<{
+    plan: string;
+}> {
+}
+declare const RedisOrgMissing_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Fly.RedisOrgMissing";
+} & Readonly<A>;
+export declare class RedisOrgMissing extends RedisOrgMissing_base<{
+    orgSlug: string;
+}> {
+}
+declare const RedisPending_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Fly.RedisPending";
+} & Readonly<A>;
+declare class RedisPending extends RedisPending_base<{
+    redisId: string;
+    status: string;
+}> {
+}
+type RedisPlan = AddOnPlansResponseEdgesItemNode;
+export declare const isFixedRedisPlan: (plan: Pick<RedisPlan, "name" | "displayName">) => boolean;
+export declare const listRedisAddOns: () => Effect.Effect<AddOnsResponseEdgesItemNode[], addons.FlyIoOpError, addons.FlyIoOpContext>;
+export declare const listRedisPlans: () => Effect.Effect<addons.AddOnResponseAddOnPlan[], addons.FlyIoOpError, addons.FlyIoOpContext>;
+export declare const findRedisAddOn: (input: {
+    id?: string;
+    name?: string;
+}) => Effect.Effect<AddOnsResponseEdgesItemNode | undefined, addons.FlyIoOpError, addons.FlyIoOpContext>;
+declare const RedisSecretVersionMissing_base: new <A extends Record<string, any> = {}>(args: import("effect/Types").VoidIfEmpty<{ readonly [P in keyof A as P extends "_tag" ? never : P]: A[P]; }>) => import("effect/Cause").YieldableError & {
+    readonly _tag: "Fly.RedisSecretVersionMissing";
+} & Readonly<A>;
+declare class RedisSecretVersionMissing extends RedisSecretVersionMissing_base<{
+    appName: string;
+}> {
+}
+/**
+ * Write `REDIS_URL` onto an App from attached Redis add-on names.
+ * Called from {@link Service} reconcile so the secret exists before
+ * Machines boot. Returns the highest accepted secret-version floor, or
+ * `undefined` when no secret was written; this is not a vault snapshot.
+ */
+export declare const attachRedisSecrets: (appName: string, attached: readonly {
+    name: string;
+    id?: string;
+}[]) => Effect.Effect<number | undefined, import("@distilled.cloud/fly-io").BadRequest | import("@distilled.cloud/fly-io").Conflict | import("@distilled.cloud/fly-io").Forbidden | import("@distilled.cloud/fly-io").NotFound | RedisPending | RedisSecretVersionMissing | addons.FlyIoOpError, addons.FlyIoOpContext>;
+export declare const RedisProvider: () => import("effect/Layer").Layer<Provider.Provider<Redis>, never, import("alchemy/Stack").Stack | import("alchemy/Stage").Stage | addons.FlyIoOpContext>;
+//# sourceMappingURL=Redis.d.ts.map

package/lib/Redis.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Redis.d.ts","sourceRoot":"","sources":["../src/Redis.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,+BAA+B,EAC/B,2BAA2B,EAE5B,MAAM,gCAAgC,CAAC;AACxC,OAAO,KAAK,MAAM,MAAM,gCAAgC,CAAC;AAIzD,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAG5C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAK5C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,eAAO,MAAM,oBAAoB,QAAQ,CAAC;AAC1C,eAAO,MAAM,gBAAgB,kBAAkB,CAAC;AAChD,eAAO,MAAM,cAAc,kBAAkB,CAAC;AAC9C,eAAO,MAAM,aAAa,cAAc,CAAC;AAEzC,OAAO,EACL,YAAY,IAAI,iBAAiB,EACjC,UAAU,IAAI,eAAe,GAC9B,MAAM,oBAAoB,CAAC;AAE5B,MAAM,WAAW,UAAU;IACzB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IACvB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IACd;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;IACvB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;IACnB;;;OAGG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IACtB;;OAEG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB;AAED,MAAM,MAAM,KAAK,GAAG,QAAQ,CAC1B,WAAW,EACX,UAAU,EACV;IACE,6BAA6B;IAC7B,OAAO,EAAE,MAAM,CAAC;IAChB,mCAAmC;IACnC,IAAI,EAAE,MAAM,CAAC;IACb,2BAA2B;IAC3B,aAAa,EAAE,MAAM,CAAC;IACtB,qCAAqC;IACrC,WAAW,EAAE,MAAM,EAAE,CAAC;IACtB,oDAAoD;IACpD,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,iDAAiD;IACjD,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC;IAC3B,8DAA8D;IAC9D,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,oDAAoD;IACpD,SAAS,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,yBAAyB;IACzB,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,mCAAmC;IACnC,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B;;;OAGG;IACH,GAAG,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CAC5C,EACD,KAAK,EACL,SAAS,CACV,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA8GG;AACH,eAAO,MAAM,KAAK,iDAA+B,CAAC;;;;AAElD,qBAAa,eAAgB,SAAQ,qBAAwC;IAC3E,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;CAAG;;;;AAEL,qBAAa,iBAAkB,SAAQ,uBAA0C;IAC/E,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;CAAG;;;;AAEL,qBAAa,eAAgB,SAAQ,qBAAwC;IAC3E,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;CAAG;;;;AAEL,cAAM,YAAa,SAAQ,kBAAqC;IAC9D,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;CAAG;AAIL,KAAK,SAAS,GAAG,+BAA+B,CAAC;AA4DjD,eAAO,MAAM,gBAAgB,SAAU,IAAI,CAAC,SAAS,EAAE,MAAM,GAAG,aAAa,CAAC,KAAG,OAIhF,CAAC;AAwDF,eAAO,MAAM,eAAe,gGAiB1B,CAAC;AAEH,eAAO,MAAM,cAAc,kGAiBzB,CAAC;AAEH,eAAO,MAAM,cAAc,UAAW;IAAE,EAAE,CAAC,EAAE,MAAM,CAAC;IAAC,IAAI,CAAC,EAAE,MAAM,CAAA;CAAE,uGASjE,CAAC;;;;AAiIJ,cAAM,yBAA0B,SAAQ,+BAAkD;IACxF,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;CAAG;AAYL;;;;;GAKG;AACH,eAAO,MAAM,kBAAkB;UAEF,MAAM;SAAO,MAAM;uTAqE9C,CAAC;AAEH,eAAO,MAAM,aAAa,4JA2LtB,CAAC"}