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

package/lib/Docker/SwarmPool.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwarmPool.d.ts","sources":["../../src/Docker/SwarmPool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAE9C,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,KAAK,KAAK,KAAK,MAAM,cAAc,CAAC;AAC3C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAE/C,OAAO,EAAiB,KAAK,YAAY,EAAE,MAAM,yBAAyB,CAAC;AAC3E,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,gCAAgC,CAAC;AAC/D,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAEjD,MAAM,WAAW,gBAAiB,SAAQ,YAAY;IACpD;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,eAAO,MAAM,SAAS,OAChB,MAAM,YACD,gBAAgB,KACxB,KAAK,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,EAAE,QAAQ,GAAG,KAAK,GAAG,SAAS,GAAG,MAAM,CAAC,SAAS,CAgC3E,CAAC"}

package/lib/Docker/SwarmPool.js

@@ -0,0 +1,56 @@
+import * as Docker from "@alchemy.run/docker";
+import * as Output from "alchemy/Output";
+import * as Effect from "effect/Effect";
+import { GATEWAY_PORT } from "../internal/Gateway.js";
+import { makePoolLayer } from "../internal/PoolHost.js";
+/**
+ * Run a pool of Effect Cluster runners on a Docker swarm: a swarm service whose
+ * tasks host every `Cluster.Entity` given this pool, on the
+ * database's overlay network. Runners find each other through the
+ * database and talk on the network; the gateway is served on the same
+ * network. Requires an `Cluster.Database` on a Docker network —
+ * `ClusterDocker.Database`.
+ *
+ * Every entity given the same pool shares it: declare the pool once
+ * and provide them to each class.
+ *
+ * ### Running entities on Docker
+ * **Example:** Two runners on the local swarm
+ * ```typescript
+ * export const Database = ClusterDocker.Database("Cluster");
+ * export const Default = ClusterDocker.SwarmPool("Default", { replicas: 2 }).pipe(
+ *   Layer.provide(Database),
+ * );
+ * ```
+ *
+ * @primitive
+ */
+export const SwarmPool = (id, options = {}) => makePoolLayer({
+    label: "ClusterDocker.SwarmPool",
+    id,
+    settings: options,
+    expected: "a Docker network (ClusterDocker.Database)",
+    network: (database) => (database.network?.kind === "docker" ? database.network : undefined),
+    // Callers on the swarm reach the gateway by the service's name.
+    gateway: (name) => Effect.succeed({ url: `http://${name}:${GATEWAY_PORT}` }),
+    nodes: ({ network, name, program, environment }) => Effect.gen(function* () {
+        // Tagged with the program's hash, so a changed program is a new image.
+        const image = yield* Docker.Image(`${id}RunnerImage`, {
+            build: { context: program.pipe(Output.map((p) => p.dir)) },
+            tag: program.pipe(Output.map((p) => p.hash)),
+            skipPush: true,
+        });
+        yield* Docker.Service(`${id}Pool`, {
+            name,
+            image: image.imageRef,
+            replicas: options.replicas ?? 1,
+            networks: [{ name: network.name }],
+            ports: options.gatewayPort === undefined
+                ? []
+                : [{ external: options.gatewayPort, internal: GATEWAY_PORT }],
+            // Each runner finds its own address among the service's tasks.
+            environment: environment.pipe(Output.map((env) => ({ ...env, CLUSTER_PEERS: `tasks.${name}` }))),
+        });
+    }),
+});
+//# sourceMappingURL=SwarmPool.js.map

package/lib/Docker/SwarmPool.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"SwarmPool.js","sources":["../../src/Docker/SwarmPool.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,qBAAqB,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,gBAAgB,CAAC;AAEzC,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAGxC,OAAO,EAAE,YAAY,EAAE,MAAM,wBAAwB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAqB,MAAM,yBAAyB,CAAC;AAkB3E;;;;;;;;;;;;;;;;;;;;;GAqBG;AACH,MAAM,CAAC,MAAM,SAAS,GAAG,CACvB,EAAU,EACV,OAAO,GAAqB,EAAE,EACiD,EAAE,CACjF,aAAa,CAAC;IACZ,KAAK,EAAE,yBAAyB;IAChC,EAAE;IACF,QAAQ,EAAE,OAAO;IACjB,QAAQ,EAAE,2CAA2C;IACrD,OAAO,EAAE,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,OAAO,EAAE,IAAI,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;IAC3F,gEAAgE;IAChE,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,GAAG,EAAE,UAAU,IAAI,IAAI,YAAY,EAAE,EAAE,CAAC;IAC5E,KAAK,EAAE,CAAC,EAAE,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,EAAE,EAAE,EAAE,CACjD,MAAM,CAAC,GAAG,CAAC,QAAQ,CAAC;QAClB,uEAAuE;QACvE,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,GAAG,EAAE,aAAa,EAAE;YACpD,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAsB,EAAE;YAC/E,GAAG,EAAE,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,CAAsB;YACjE,QAAQ,EAAE,IAAI;SACf,CAAC,CAAC;QACH,KAAK,CAAC,CAAC,MAAM,CAAC,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE;YACjC,IAAI;YACJ,KAAK,EAAE,KAAK,CAAC,QAAQ;YACrB,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,CAAC;YAC/B,QAAQ,EAAE,CAAC,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC;YAClC,KAAK,EACH,OAAO,CAAC,WAAW,KAAK,SAAS;gBAC/B,CAAC,CAAC,EAAE;gBACJ,CAAC,CAAC,CAAC,EAAE,QAAQ,EAAE,OAAO,CAAC,WAAW,EAAE,QAAQ,EAAE,YAAY,EAAE,CAAC;YACjE,+DAA+D;YAC/D,WAAW,EAAE,WAAW,CAAC,IAAI,CAC3B,MAAM,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,GAAG,EAAE,aAAa,EAAE,SAAS,IAAI,EAAE,EAAE,CAAC,CAAC,CAC7B;SACvC,CAAC,CAAC;IACL,CAAC,CAAC;CACL,CAAC,CAAC"}

package/lib/Docker/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @alchemy.run/effect-cluster/Docker — run an Effect Cluster's database and
+ * runners on a Docker swarm. Requires `@alchemy.run/docker`.
+ */
+export * from "./Database.ts";
+export * from "./SwarmPool.ts";
+//# sourceMappingURL=index.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sources":["../../src/Docker/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}

package/lib/Docker/index.js

@@ -0,0 +1,7 @@
+/**
+ * @alchemy.run/effect-cluster/Docker — run an Effect Cluster's database and
+ * runners on a Docker swarm. Requires `@alchemy.run/docker`.
+ */
+export * from "./Database.js";
+export * from "./SwarmPool.js";
+//# sourceMappingURL=index.js.map

package/lib/Docker/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sources":["../../src/Docker/index.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,cAAc,eAAe,CAAC;AAC9B,cAAc,gBAAgB,CAAC"}

package/lib/Entity.d.ts

@@ -0,0 +1,348 @@
+import type { InputProps } from "alchemy/Input";
+import type { Named } from "alchemy/Named";
+import { Platform, type PlatformIdentity, type PlatformProps, type PlatformServices } from "alchemy/Platform";
+import * as Provider from "alchemy/Provider";
+import type { Resource } from "alchemy/Resource";
+import { RuntimeContext } from "alchemy/RuntimeContext";
+import type { Self } from "alchemy/Self";
+import { Entity as EffectEntity } from "effect/cluster";
+import type { AlreadyProcessingMessage, EntityNotAssignedToRunner, MailboxFull, PersistenceError } from "effect/cluster/ClusterError";
+import type * as ConfigError from "effect/Config";
+import type * as Context from "effect/Context";
+import type * as Duration from "effect/Duration";
+import * as Effect from "effect/Effect";
+import * as Layer from "effect/Layer";
+import * as Redacted from "effect/Redacted";
+import type { Rpc, RpcClient, RpcClientError, RpcGroup } from "effect/rpc";
+import type { Scope } from "effect/Scope";
+import { type HostedRuntimeContext } from "./internal/HostedRuntime.ts";
+import { PoolHost } from "./internal/PoolHostService.ts";
+import type { Providers } from "./Providers.ts";
+export declare const EntityTypeId = "Cluster.Entity";
+export type EntityTypeId = typeof EntityTypeId;
+export interface EntityProps extends PlatformProps {
+    /**
+     * The module that exports this entity: the class, or the Layer its
+     * `.make(...)` returned. Usually `import.meta.url`.
+     */
+    main: string;
+    /**
+     * The export of {@link main} that holds this entity.
+     * @default "default"
+     */
+    handler?: string;
+    /**
+     * How long an instance may sit idle before the runner stops it. Its next
+     * message starts it again.
+     * @default the runner's default (1 minute)
+     */
+    maxIdleTime?: Duration.Input;
+    /**
+     * How many of an instance's messages run at once. A handler that returns
+     * `Rpc.fork(...)` runs outside this limit.
+     * @default 1
+     */
+    concurrency?: number | "unbounded";
+    /**
+     * How many messages an instance may hold, running or waiting to run.
+     * Past that, a message fails with `MailboxFull`, unless it is persisted:
+     * a persisted message is stored and runs once there is room.
+     * @default 4096
+     */
+    mailboxCapacity?: number | "unbounded";
+    /**
+     * Return a handler's defect to its caller instead of restarting the
+     * instance. By default, as on Effect Cluster's runners, a defect rebuilds
+     * the instance and runs its messages again, backing off between restarts.
+     * @default false
+     */
+    disableFatalDefects?: boolean;
+}
+export interface EntityAttributes {
+    /** The entity type: the class's logical id. */
+    type: string;
+    /** The shard group of the pool that hosts it. */
+    pool: string | undefined;
+    /** The gateway URL callers send requests to. */
+    gateway: string | undefined;
+    /** The token callers present to the gateway. */
+    token: Redacted.Redacted<string> | undefined;
+}
+/** Data a pool Layer binds onto the entities it hosts. */
+export interface EntityBindingContract {
+    pool?: string;
+    gateway?: string;
+    token?: Redacted.Redacted<string>;
+}
+export interface Entity extends Resource<EntityTypeId, EntityProps, EntityAttributes, EntityBindingContract, Providers> {
+}
+/** The errors a call through the gateway can fail with, beyond the RPC's own. */
+export type GatewayError = RpcClientError.RpcClientError | MailboxFull | AlreadyProcessingMessage | PersistenceError | EntityNotAssignedToRunner;
+/**
+ * Every instance of one entity type. `getByName(entityId)` returns a client
+ * with the same shape as Effect Cluster's `Entity.client(entityId)`; its
+ * calls take Effect's client options (`discard`, `headers`).
+ */
+export interface EntityNamespace<Rpcs extends Rpc.Any> {
+    readonly getByName: (entityId: string) => Effect.Effect<RpcClient.RpcClient.From<Rpcs, GatewayError>, never, Rpc.MiddlewareClient<Rpcs>>;
+}
+/** What an instance's constructor runs with: once per instance. */
+export type InstanceServices = RuntimeContext | Scope | EffectEntity.CurrentAddress | EffectEntity.CurrentRunnerAddress;
+/** Services the Construction phase may use without the caller providing them. */
+export type EntityServices = Entity | Providers | RuntimeContext | Self | Self<Entity>;
+type ClassRequirements<Req> = Providers | Exclude<Req, EntityServices | PlatformServices>;
+/**
+ * An entity's implementation. The outer Effect runs once per runner and
+ * resolves bindings; the inner one runs once per instance and returns the
+ * instance's handlers as an object, one per RPC in the schema.
+ */
+export type EntityImpl<Rpcs extends Rpc.Any, InitReq> = Effect.Effect<Effect.Effect<EffectEntity.HandlersFrom<Rpcs>, never, InstanceServices>, ConfigError.ConfigError, InitReq>;
+/**
+ * A declared entity: the tag callers `yield*`, carrying Effect Cluster's
+ * entity surface (`.of`, `.protocol`, `.entity`), implemented by
+ * `.make(props, impl)`.
+ */
+export type EntityTag<Self, Type extends string, Rpcs extends Rpc.Any> = Effect.Effect<EntityNamespace<Rpcs>, never, Providers> & Named<Type> & PlatformIdentity<Type> & {
+    /**
+     * The Effect Cluster entity behind the class, for Effect Cluster's own
+     * APIs: `Counter.entity.client` inside runners, `EntityProxy`,
+     * `Entity.makeTestClient`.
+     */
+    readonly entity: EffectEntity.Entity<Type, Rpcs>;
+    /** The entity's RPCs, as an `RpcGroup`. */
+    readonly protocol: RpcGroup.RpcGroup<Rpcs>;
+    /** Type an instance's handlers against the entity's RPCs, as Effect Cluster's `Entity.of`. */
+    of<Handlers extends EffectEntity.HandlersFrom<Rpcs>>(handlers: Handlers): Handlers;
+    /**
+     * The entity's implementation, as a Layer. Provide a pool Layer to
+     * `impl` to deploy it, with its RPCs' middleware provided to the pool;
+     * then provide the returned Layer to the Stack.
+     */
+    make<InitReq = never>(props: InputProps<EntityProps>, impl: EntityImpl<Rpcs, InitReq>): Layer.Layer<Self, never, ClassRequirements<InitReq>>;
+    new (_: never): EntityNamespace<Rpcs>;
+};
+/**
+ * An entity declared with its implementation: the class callers `yield*`,
+ * which also deploys it.
+ */
+export type EntityInline<Type extends string, Rpcs extends Rpc.Any, Req> = Effect.Effect<EntityNamespace<Rpcs>, never, Req> & Named<Type> & PlatformIdentity<Type> & {
+    /** The Effect Cluster entity behind the class, for Effect Cluster's own APIs. */
+    readonly entity: EffectEntity.Entity<Type, Rpcs>;
+    /** The entity's RPCs, as an `RpcGroup`. */
+    readonly protocol: RpcGroup.RpcGroup<Rpcs>;
+    /** Type an instance's handlers against the entity's RPCs, as Effect Cluster's `Entity.of`. */
+    of<Handlers extends EffectEntity.HandlersFrom<Rpcs>>(handlers: Handlers): Handlers;
+    new (_: never): EntityNamespace<Rpcs>;
+};
+/** Props of an external entity: an existing Effect Cluster program, run as it is. */
+export interface ExternalEntityProps {
+    /**
+     * The module that exports the Effect Cluster entity, under its type's
+     * name, relative to where the deploy runs. The gateway imports it to
+     * serve the entity's RPCs.
+     */
+    main: string;
+    /**
+     * Your existing Effect Cluster program, relative to where the deploy
+     * runs: one that launches its entities on `NodeClusterHttp` with HTTP
+     * transport and SQL storage. It is bundled into the pool and run as
+     * its own process on every runner, with `HOST`, `PORT` and `DATABASE_URL` set.
+     */
+    program: string;
+}
+/** The class surface of {@link Entity}. */
+export interface EntityClass {
+    /**
+     * An external entity: an existing Effect Cluster program, run as it is.
+     * Provide a pool Layer to deploy it.
+     */
+    <const Type extends string, Rpcs extends Rpc.Any>(entity: EffectEntity.Entity<Type, Rpcs>, props: ExternalEntityProps): Effect.Effect<EntityNamespace<Rpcs>, never, PoolHost | Providers> & {
+        readonly entity: EffectEntity.Entity<Type, Rpcs>;
+    };
+    <Self>(): {
+        /**
+         * Declared from an Effect Cluster entity, with its implementation, which
+         * types its handlers with the entity's `.of`. Provide a pool Layer to
+         * `impl` to deploy it, with its RPCs' middleware provided to the pool.
+         */
+        <const Type extends string, Rpcs extends Rpc.Any, InitReq = never>(entity: EffectEntity.Entity<Type, Rpcs>, props: InputProps<EntityProps>, impl: EntityImpl<Rpcs, InitReq>): EntityInline<Type, Rpcs, ClassRequirements<InitReq>>;
+        /** Declared from its RPCs, as Effect Cluster's `Entity.make`. */
+        <const Type extends string, const Rpcs extends ReadonlyArray<Rpc.Any>>(type: Type, rpcs: Rpcs): EntityTag<Self, Type, Rpcs[number]>;
+        /** Declared from an existing Effect Cluster entity. */
+        <const Type extends string, Rpcs extends Rpc.Any>(entity: EffectEntity.Entity<Type, Rpcs>): EntityTag<Self, Type, Rpcs>;
+    };
+}
+declare const EntityCalledOutsideRuntime_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: "Cluster.EntityCalledOutsideRuntime";
+} & Readonly<A>;
+/** A class yielded outside any runtime was called. */
+export declare class EntityCalledOutsideRuntime extends EntityCalledOutsideRuntime_base<{
+    readonly message: string;
+}> {
+}
+/**
+ * An entity class as a runner runs it: the Effect entity, the instance
+ * constructor its Construction phase returned, and the services that phase
+ * ran with.
+ * @internal
+ */
+export interface HostedEntity {
+    readonly kind: "entity";
+    readonly entity: EffectEntity.Entity<string, Rpc.Any>;
+    readonly instance: Effect.Effect<Record<string, unknown>, never, any>;
+    readonly context: Context.Context<never>;
+    readonly options: Pick<EntityProps, "maxIdleTime" | "concurrency" | "mailboxCapacity" | "disableFatalDefects">;
+}
+export type EntityRuntimeContext = HostedRuntimeContext<HostedEntity>;
+declare const EntityMiddlewareMissing_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: "Cluster.EntityMiddlewareMissing";
+} & Readonly<A>;
+/** An entity's RPC uses middleware nothing provided to its pool. */
+export declare class EntityMiddlewareMissing extends EntityMiddlewareMissing_base<{
+    readonly message: string;
+}> {
+}
+type EntityPlatform = Platform<Entity, EntityServices, unknown, EntityRuntimeContext>;
+/** The resource type behind every class, which the providers register. @internal */
+export declare const EntityResource: EntityPlatform;
+/** The Platform declaration behind a class, which a runner builds. @internal */
+export declare const PlatformDeclaration: unique symbol;
+/** The Effect entity a class hosts, which a runner reads. @internal */
+export declare const EntityDefinition: unique symbol;
+/**
+ * An **Entity** in an Effect Cluster: a stateful, addressable instance per
+ * entity id, whose messages are typed by its RPCs. Runners place each
+ * instance on one runner and deliver its messages one at a time.
+ *
+ * Declare it from an Effect Cluster entity with its implementation, and
+ * the class is both what callers `yield*` and what deploys it. Or declare
+ * it bare, like Effect Cluster's `Entity.make`, from a type and its RPCs,
+ * and implement it with `.make(props, impl)`, as a Layer: callers import
+ * the bare declaration without bundling the implementation or its pool.
+ *
+ * The implementation has two phases. The outer Effect runs once per runner
+ * and resolves bindings. The inner Effect runs once per instance, on its
+ * first message, and returns its handlers, typed by the entity's `.of`. Providing a
+ * pool Layer to the implementation, such as
+ * `ClusterDocker.SwarmPool("Default")`, is what deploys it.
+ *
+ * `yield* Counter` from any runtime returns the entity's namespace, like a
+ * Durable Object's: `getByName(entityId)` returns a client with the same
+ * shape as Effect Cluster's `Entity.client(entityId)`. Inside the cluster,
+ * calls go through Effect Cluster directly; elsewhere they go through the
+ * pool's gateway over HTTP, so callers need no database access and no
+ * route to the pool.
+ *
+ * ### Declaring an entity
+ * **Example:** A counter, with its implementation
+ * ```typescript
+ * // src/Counter.ts
+ * const Counters = Entity.make("Counter", [
+ *   Rpc.make("Increment", { payload: { amount: Schema.Int }, success: Schema.Int }),
+ * ]);
+ *
+ * export default class Counter extends Cluster.Entity<Counter>()(
+ *   Counters,
+ *   { main: import.meta.url },
+ *   Effect.gen(function* () {
+ *     return Effect.gen(function* () {
+ *       const count = yield* Ref.make(0);
+ *       return Counters.of({
+ *         Increment: ({ payload }) => Ref.updateAndGet(count, (n) => n + payload.amount),
+ *       });
+ *     });
+ *   }).pipe(Effect.provide(Default)),
+ * ) {}
+ * ```
+ *
+ * ### Keeping its code out of its callers
+ * **Example:** A bare declaration, which callers import
+ * ```typescript
+ * // src/Counter.ts
+ * export const Increment = Rpc.make("Increment", {
+ *   payload: { amount: Schema.Int },
+ *   success: Schema.Int,
+ * });
+ *
+ * export class Counter extends Cluster.Entity<Counter>()("Counter", [Increment]) {}
+ * ```
+ *
+ * **Example:** An existing Effect Cluster entity
+ * ```typescript
+ * import { Counter as CounterEntity } from "./entities/counter.ts";
+ *
+ * export class Counter extends Cluster.Entity<Counter>()(CounterEntity) {}
+ * ```
+ *
+ * **Example:** Its implementation, as a Layer, deployed to a pool
+ * ```typescript
+ * // src/CounterLive.ts
+ * export default Counter.make(
+ *   { main: import.meta.url },
+ *   Effect.gen(function* () {
+ *     return Effect.gen(function* () {
+ *       const count = yield* Ref.make(0);
+ *       return Counter.of({
+ *         Increment: ({ payload }) => Ref.updateAndGet(count, (n) => n + payload.amount),
+ *       });
+ *     });
+ *   }).pipe(Effect.provide(Default)),
+ * );
+ * ```
+ *
+ * **Example:** Middleware, provided with the pool
+ * ```typescript
+ * export const Increment = Rpc.make("Increment", {
+ *   payload: { amount: Schema.Int },
+ *   success: Schema.Int,
+ * }).middleware(Auth);
+ *
+ * export default Counter.make(
+ *   { main: import.meta.url },
+ *   Effect.gen(function* () {
+ *     return Effect.gen(function* () {
+ *       return Counter.of({
+ *         Increment: () => Effect.map(CurrentUser, (user) => user.id.length),
+ *       });
+ *     });
+ *   }).pipe(Effect.provide(Default.pipe(Layer.provide(AuthLive)))),
+ * );
+ * ```
+ *
+ * **Example:** An existing Effect Cluster program, run as it is
+ * ```typescript
+ * import { Tally as TallyEntity } from "./entities/tally.ts";
+ *
+ * export const Tally = Cluster.Entity(TallyEntity, {
+ *   main: "./entities/tally.ts",
+ *   program: "./runner.ts",
+ * }).pipe(Effect.provide(Legacy));
+ * ```
+ *
+ * ### Calling an entity
+ * **Example:** From any runtime
+ * ```typescript
+ * const counters = yield* Counter;
+ * const counter = yield* counters.getByName("visits");
+ * const count = yield* counter.Increment({ amount: 1 });
+ * ```
+ *
+ * **Example:** Without waiting for the reply
+ * ```typescript
+ * yield* counter.Increment({ amount: 1 }, { discard: true });
+ * ```
+ *
+ * **Example:** Through client middleware
+ * ```typescript
+ * const counter = yield* counters.getByName("visits");
+ * yield* counter.Increment({ amount: 1 }).pipe(Effect.provide(AuthClient));
+ * ```
+ *
+ * @resource
+ */
+export declare const Entity: EntityClass;
+/** The environment key holding the shard group an entity's pool serves. @internal */
+export declare const shardGroupKey: (type: string) => string;
+export declare const EntityProvider: () => Layer.Layer<Provider.Provider<Entity>, never, never>;
+export type { RpcGroup };
+//# sourceMappingURL=Entity.d.ts.map

package/lib/Entity.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Entity.d.ts","sources":["../src/Entity.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAChD,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,eAAe,CAAC;AAE3C,OAAO,EACL,QAAQ,EACR,KAAK,gBAAgB,EACrB,KAAK,aAAa,EAClB,KAAK,gBAAgB,EACtB,MAAM,kBAAkB,CAAC;AAC1B,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AACjD,OAAO,EAAE,cAAc,EAAe,MAAM,wBAAwB,CAAC;AACrE,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AACzC,OAAO,EAAiB,MAAM,IAAI,YAAY,EAAE,MAAM,gBAAgB,CAAC;AACvE,OAAO,KAAK,EACV,wBAAwB,EACxB,yBAAyB,EACzB,WAAW,EACX,gBAAgB,EACjB,MAAM,6BAA6B,CAAC;AACrC,OAAO,KAAK,KAAK,WAAW,MAAM,eAAe,CAAC;AAClD,OAAO,KAAK,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAE/C,OAAO,KAAK,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAEtC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,EAAE,GAAG,EAAE,SAAS,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,YAAY,CAAC;AAC3E,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,cAAc,CAAC;AAE1C,OAAO,EAAE,KAAK,oBAAoB,EAA4B,MAAM,6BAA6B,CAAC;AAClG,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAEhD,eAAO,MAAM,YAAY,mBAAmB,CAAC;AAC7C,MAAM,MAAM,YAAY,GAAG,OAAO,YAAY,CAAC;AAE/C,MAAM,WAAW,WAAY,SAAQ,aAAa;IAChD;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB;;;;OAIG;IACH,WAAW,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC;IAC7B;;;;OAIG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IACnC;;;;;OAKG;IACH,eAAe,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;IACvC;;;;;OAKG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;CAC/B;AAED,MAAM,WAAW,gBAAgB;IAC/B,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;IACb,iDAAiD;IACjD,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IACzB,gDAAgD;IAChD,OAAO,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B,gDAAgD;IAChD,KAAK,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,SAAS,CAAC;CAC9C;AAED,0DAA0D;AAC1D,MAAM,WAAW,qBAAqB;IACpC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC;CACnC;AAED,MAAM,WAAW,MAAO,SAAQ,QAAQ,CACtC,YAAY,EACZ,WAAW,EACX,gBAAgB,EAChB,qBAAqB,EACrB,SAAS,CACV;CAAG;AAEJ,iFAAiF;AACjF,MAAM,MAAM,YAAY,GACpB,cAAc,CAAC,cAAc,GAC7B,WAAW,GACX,wBAAwB,GACxB,gBAAgB,GAChB,yBAAyB,CAAC;AAE9B;;;;GAIG;AACH,MAAM,WAAW,eAAe,CAAC,IAAI,SAAS,GAAG,CAAC,GAAG;IACnD,QAAQ,CAAC,SAAS,EAAE,CAClB,QAAQ,EAAE,MAAM,KACb,MAAM,CAAC,MAAM,CAChB,SAAS,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,EAAE,YAAY,CAAC,EAC5C,KAAK,EACL,GAAG,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAC3B,CAAC;CACH;AAED,mEAAmE;AACnE,MAAM,MAAM,gBAAgB,GACxB,cAAc,GACd,KAAK,GACL,YAAY,CAAC,cAAc,GAC3B,YAAY,CAAC,oBAAoB,CAAC;AAEtC,iFAAiF;AACjF,MAAM,MAAM,cAAc,GAAG,MAAM,GAAG,SAAS,GAAG,cAAc,GAAG,IAAI,GAAG,IAAI,CAAC,MAAM,CAAC,CAAC;AAEvF,KAAK,iBAAiB,CAAC,GAAG,IAAI,SAAS,GAAG,OAAO,CAAC,GAAG,EAAE,cAAc,GAAG,gBAAgB,CAAC,CAAC;AAE1F;;;;GAIG;AACH,MAAM,MAAM,UAAU,CAAC,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,IAAI,MAAM,CAAC,MAAM,CACnE,MAAM,CAAC,MAAM,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,gBAAgB,CAAC,EACvE,WAAW,CAAC,WAAW,EACvB,OAAO,CACR,CAAC;AAEF;;;;GAIG;AACH,MAAM,MAAM,SAAS,CAAC,IAAI,EAAE,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,IAAI,MAAM,CAAC,MAAM,CACpF,eAAe,CAAC,IAAI,CAAC,EACrB,KAAK,EACL,SAAS,CACV,GACC,KAAK,CAAC,IAAI,CAAC,GACX,gBAAgB,CAAC,IAAI,CAAC,GAAG;IACvB;;;;OAIG;IACH,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3C,8FAA8F;IAC9F,EAAE,CAAC,QAAQ,SAAS,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACnF;;;;OAIG;IACH,IAAI,CAAC,OAAO,GAAG,KAAK,EAClB,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,EAC9B,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,GAC9B,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,KAAK,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;IACxD,KAAK,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;CACvC,CAAC;AAEJ;;;GAGG;AACH,MAAM,MAAM,YAAY,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,GAAG,IAAI,MAAM,CAAC,MAAM,CACtF,eAAe,CAAC,IAAI,CAAC,EACrB,KAAK,EACL,GAAG,CACJ,GACC,KAAK,CAAC,IAAI,CAAC,GACX,gBAAgB,CAAC,IAAI,CAAC,GAAG;IACvB,iFAAiF;IACjF,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACjD,2CAA2C;IAC3C,QAAQ,CAAC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC3C,8FAA8F;IAC9F,EAAE,CAAC,QAAQ,SAAS,YAAY,CAAC,YAAY,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,GAAG,QAAQ,CAAC;IACnF,KAAK,CAAC,EAAE,KAAK,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC;CACvC,CAAC;AAEJ,qFAAqF;AACrF,MAAM,WAAW,mBAAmB;IAClC;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;;;OAKG;IACH,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,2CAA2C;AAC3C,MAAM,WAAW,WAAW;IAC1B;;;OAGG;IACH,CAAC,KAAK,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,EAC9C,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EACvC,KAAK,EAAE,mBAAmB,GACzB,MAAM,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,QAAQ,GAAG,SAAS,CAAC,GAAG;QACrE,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;KAClD,CAAC;IAEF,CAAC,IAAI,KAAK;QACR;;;;WAIG;QACH,CAAC,KAAK,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,EAAE,OAAO,GAAG,KAAK,EAC/D,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,EACvC,KAAK,EAAE,UAAU,CAAC,WAAW,CAAC,EAC9B,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,CAAC,GAC9B,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC,CAAC;QACxD,iEAAiE;QACjE,CAAC,KAAK,CAAC,IAAI,SAAS,MAAM,EAAE,KAAK,CAAC,IAAI,SAAS,aAAa,CAAC,GAAG,CAAC,GAAG,CAAC,EACnE,IAAI,EAAE,IAAI,EACV,IAAI,EAAE,IAAI,GACT,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACvC,uDAAuD;QACvD,CAAC,KAAK,CAAC,IAAI,SAAS,MAAM,EAAE,IAAI,SAAS,GAAG,CAAC,GAAG,EAC9C,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,GACtC,SAAS,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;KAChC,CAAC;CACH;;;;AAED,sDAAsD;AACtD,qBAAa,0BAA2B,SAAQ,gCAE9C;IACA,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;CAAG;AAEL;;;;;GAKG;AACH,MAAM,WAAW,YAAY;IAC3B,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC;IACxB,QAAQ,CAAC,MAAM,EAAE,YAAY,CAAC,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC;IACtD,QAAQ,CAAC,QAAQ,EAAE,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAAE,KAAK,EAAE,GAAG,CAAC,CAAC;IACtE,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;IACzC,QAAQ,CAAC,OAAO,EAAE,IAAI,CACpB,WAAW,EACX,aAAa,GAAG,aAAa,GAAG,iBAAiB,GAAG,qBAAqB,CAC1E,CAAC;CACH;AAED,MAAM,MAAM,oBAAoB,GAAG,oBAAoB,CAAC,YAAY,CAAC,CAAC;;;;AAsCtE,oEAAoE;AACpE,qBAAa,uBAAwB,SAAQ,6BAAoD;IAC/F,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;CAC1B,CAAC;CAAG;AAEL,KAAK,cAAc,GAAG,QAAQ,CAAC,MAAM,EAAE,cAAc,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;AAItF,oFAAoF;AACpF,eAAO,MAAM,cAAc,gBAAW,CAAC;AAEvC,gFAAgF;AAChF,eAAO,MAAM,mBAAmB,eAAgD,CAAC;AAEjF,uEAAuE;AACvE,eAAO,MAAM,gBAAgB,eAAkD,CAAC;AAEhF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAkIG;AACH,eAAO,MAAM,MAAM,EAAE,WAkBa,CAAC;AAInC,qFAAqF;AACrF,eAAO,MAAM,aAAa,SAAU,MAAM,WAA+C,CAAC;AA2G1F,eAAO,MAAM,cAAc,4DAmBvB,CAAC;AAEL,YAAY,EAAE,QAAQ,EAAE,CAAC"}