import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import * as Data from "effect/Data";
import type * as Effect from "effect/Effect";
import type * as Redacted from "effect/Redacted";
import type { Mongo } from "./Mongo.ts";
/**
* Bind a {@link Mongo} service to a Railway {@link Service} and obtain
* the Effect-native connection string for the MongoDB driver.
*
* `ConnectMongo` is the Context tag, the type, and the callable —
* `yield* Railway.ConnectMongo(Db)`. Provide {@link ConnectMongoHttp}.
*
* **Example:** Bind Mongo in a Service
* ```typescript
* import * as Redacted from "effect/Redacted";
*
* const conn = yield* Railway.ConnectMongo(Db);
*
* fetch: Effect.gen(function* () {
* const url = yield* conn.connectionString;
* const ping = yield* Railway.pingMongo(Redacted.value(url));
* });
* ```
*
* ### Variable references
* `ConnectMongo` packs a typed private URI onto the Service. To store
* Railway's template instead of a resolved URI (IaC `db.env.MONGO_URL`),
* pass `Railway.ref(Db, "MONGO_URL")` as a {@link Variable} `value` or
* `Service.env` entry.
*
* **Example:** Railway.ref
* ```typescript
* const db = yield* Railway.mongo("Db", { project: site });
* yield* Railway.Variable("MongoUrl", {
* project: site,
* service: api,
* name: "MONGO_URL",
* value: Railway.ref(db, "MONGO_URL"),
* });
* ```
*
* @binding
* @product MongoDB
* @category Storage & Databases
*/
export interface ConnectMongo extends Binding.Service<
ConnectMongo,
"Railway.ConnectMongo",
(mongo: Mongo) => Effect.Effect<ConnectMongoClient>
> {}
export const ConnectMongo = Binding.Service<ConnectMongo>("Railway.ConnectMongo");
export const connectEnvKeys = (mongo: Pick<Mongo, "LogicalId">) => {
const id = mongo.LogicalId.replaceAll(/[^a-zA-Z0-9]/g, "_").toUpperCase();
return {
pooled: `RAILWAY_MONGO_${id}_POOLED`,
direct: `RAILWAY_MONGO_${id}_DIRECT`,
};
};
export class MongoUrlMissing extends Data.TaggedError("Railway.MongoUrlMissing")<{
resourceName: string;
}> {}
export interface ConnectMongoClient {
/**
* Private (`{name}.railway.internal`) connection string. Pass this to
* the MongoDB driver from a {@link Service}.
*/
connectionString: Effect.Effect<Redacted.Redacted<string>, MongoUrlMissing, RuntimeContext>;
/**
* Same private URI. Kept so callers matching the Postgres
* `ConnectPostgres` shape keep working.
*/
directConnectionString: Effect.Effect<Redacted.Redacted<string>, MongoUrlMissing, RuntimeContext>;
}