alchemy-effect 0.6.0 → 0.6.2

package/README.md

@@ -1,185 +0,0 @@
-> ⚠️ `alchemy-effect` is still experimental and not ready for production use (expect breaking changes). Come hang in our [Discord](https://discord.gg/jwKw8dBJdN) to participate in the early stages of development.
-
-# `alchemy-effect`
-
-`alchemy-effect` is an **Infrastructure-as-Effects (IaE)** framework that unifies business logic and infrastructure config into a single, type-safe program with the following benefits:
-
-1. Type-Checked IAM Policies
-2. Optimally Tree-Shaken Bundles
-3. Testable Business Logic
-4. Re-usable Components
-5. Reviewable Deployment Plans
-
-## Install
-
-```bash
-bun add alchemy-effect
-```
-
-## Least-Privilege IAM Policies 🔐
-
-Type-checked Bindings ensure your IAM Policies are least-privilege - you are never missing or granting excessive permissions:
-
-<img src="./images/alchemy-effect.gif" alt="alchemy-effect type checked policies" width="600"/>
-
-You will receive a type error if you mess up your Bindings:
-<img src="./images/alchemy-effect-policy-error.png" alt="alchemy-effect type errors" width="600"/>
-
-> [!TIP]
-> This error means you are missing the `SendMessage<Messages>` binding (you provided `never` instead of `SendMessage<Messages>`).
-
-## Plan & Deploy
-
-An `alchemy-effect` program produces a Plan that can be reviewed prior to deployment:
-
-<img src="./images/alchemy-effect-plan.gif" alt="alchemy-effect plan video" width="600"/>
-
-## Type-Level Plan
-
-All knowable information about the Plan is available at compile-time:
-
-<img src="./images/alchemy-effect-plan-type.png" alt="alchemy-effect plan type" width="600"/>
-
-> [!TIP]
-> These types can be used to implement type-level validation of infrastructure policies, e.g. disallowing publicly accessible S3 buckets.
-
-## Optimal Tree-Shaking
-
-Provide runtime clients as Layers and `export` a handler that can be optimally tree-shaken to only include necessary code.
-
-```ts
-export default Api.handler.pipe(
-  Effect.provide(SQS.clientFromEnv()),
-  Lambda.toHandler,
-);
-```
-
-## Pluggable Layers
-
-Everything (including the CLI) is provided as Effect layers:
-
-<img src="./images/alchemy-effect-layers.png" alt="alchemy-effect layers" width="600"/>
-
-## Literally Typed Outputs
-
-The output of deploying a stack is totally known at compile-time, e.g. the `.fifo` suffix of a SQS FIFO Queue:
-
-<img src="./images/alchemy-effect-output.png" alt="alchemy-effect output" width="600"/>
-
-# Concepts 🔱
-
-<img src="./images/alchemy-effect-triple.png" alt="alchemy-effect logo" width="600"/>
-
-Infrastructure-as-Effects has three main concepts: `Resources`, `Functions (as Effects)`, and `Bindings`:
-
-- `Resources` are the underlying infrastructure components, e.g. a SQS Queue or DynamoDB Table.
-- `Functions` contain the business logic as an Effect running in some runtime, e.g. a Lambda Function or a Cloudflare Worker.
-- `Bindings` connect `Functions` to `Resources`, e.g. `SQS.SendMessage(Messages)`
-
-## Resources
-
-Resources are declared along-side your business logic as classes, e.g. a FIFO SQS Queue:
-
-```ts
-class Messages extends SQS.Queue("Messages", {
-  fifo: true,
-  schema: S.String,
-}) {}
-```
-
-## Functions
-
-Functions are a special kind of Resource that includes a runtime implementation function.
-
-The function always returns an `Effect<A, Err, Req>` which is then used to infer Capabilities and type-check your Bindings.
-
-```ts
-class Api extends Lambda.serve("Api", {
-  fetch: Effect.fn(function* (event) {
-    yield* SQS.sendMessage(Messages, event.body!).pipe(
-      Effect.catchAll(() => Effect.void),
-    );
-  }),
-})({
-  main: import.meta.filename,
-  bindings: $(SQS.SendMessage(Messages)),
-}) {}
-```
-
-## Bindings
-
-A Binding is a connection between a **Resource** and a **Function** that satisfies a **Capability** (aka. runtime dependency, e.g. `SQS.SendMessage(to: Messages)`).
-
-> [!TIP]
-> Bindings are inferred from your business logic and then type-checked to ensure least-privilege IAM policies.
-
-```ts
-class Api extends Lambda.serve("Api", {
-  // ...
-})({
-  main: import.meta.filename,
-  // Policy<Lambda.Function, SQS.SendMessage<Messages>>
-  bindings: $(SQS.SendMessage(Messages)),
-}) {}
-```
-
-> [!CAUTION]
-> Curring (`Lambda.serve(..)({ .. })`) is required because there's a limitation in TypeScript. We hope to simplify this in the future.
-
-# Components
-
-Infrastructure and business logic can be encapsulated as a Component using a simple function.
-
-```ts
-const Monitor = <const ID extends string, ReqAlarm, ReqResolved>(
-  id: ID,
-  {
-    onAlarm,
-    onResolved,
-  }: {
-    onAlarm: (
-      batch: SQS.QueueEvent<Message>,
-    ) => Effect.Effect<void, never, ReqAlarm>;
-    onResolved?: (
-      batch: SQS.QueueEvent<Message>,
-    ) => Effect.Effect<void, never, ReqResolved>;
-  },
-) => {
-  class Messages extends SQS.Queue(`${id}-Messages`, {
-    fifo: true,
-    schema: Message,
-  }) {}
-
-  return <const Props extends Lambda.FunctionProps<ReqAlarm | ReqResolved>>({
-    bindings,
-    ...props
-  }: Props) =>
-    Lambda.consume(id, {
-      queue: Messages,
-      handle: Effect.fn(function* (batch) {
-        yield* SQS.sendMessage(Messages, {
-          id: 1,
-          value: "1",
-        }).pipe(Effect.catchAll(() => Effect.void));
-        if (onAlarm) {
-          yield* onAlarm(batch);
-        }
-        if (onResolved) {
-          yield* onResolved(batch);
-        }
-      }),
-    })({
-      ...props,
-      // Components are not leaky - the inner SQS.SendMessage(Messages) binding is not required to be passed in by the caler
-      bindings: bindings.and(SQS.SendMessage(Messages)),
-    });
-};
-```
-
-> [!TIP]
-> Components are very similar to React components, but for infrastructure. Instead of declaring state in your closure and returning a React element, you declare Resources and return a `Function`.
-
-# Building your own Resources, Capabilities, and Bindings
-
-> [!CAUTION]
-> WIP - docs coming soon!

package/lib/$.d.ts

@@ -1,5 +0,0 @@
-import { Policy } from "./policy.ts";
-import * as Output from "./output.ts";
-export type $ = typeof Policy & typeof Output.interpolate & typeof Output.of;
-export declare const $: $;
-//# sourceMappingURL=$.d.ts.map

package/lib/$.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"$.d.ts","sourceRoot":"","sources":["../src/$.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAEtC,MAAM,MAAM,CAAC,GAAG,OAAO,MAAM,GAAG,OAAO,MAAM,CAAC,WAAW,GAAG,OAAO,MAAM,CAAC,EAAE,CAAC;AAC7E,eAAO,MAAM,CAAC,EAWT,CAAC,CAAC"}

package/lib/$.js

@@ -1,9 +0,0 @@
-import { Policy } from "./policy.js";
-import { isResource } from "./resource.js";
-import * as Output from "./output.js";
-export const $ = Object.assign((...args) => Array.isArray(args[0])
-    ? Output.interpolate(args[0], ...args.slice(1))
-    : isResource(args[0])
-        ? Output.of(args[0])
-        : Policy(...args), Policy);
-//# sourceMappingURL=$.js.map

package/lib/$.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"$.js","sourceRoot":"","sources":["../src/$.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,eAAe,CAAC;AAC3C,OAAO,KAAK,MAAM,MAAM,aAAa,CAAC;AAGtC,MAAM,CAAC,MAAM,CAAC,GAAG,MAAM,CAAC,MAAM,CAC5B,CAAC,GAAG,IAAW,EAAE,EAAE,CACjB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;IACpB,CAAC,CAAC,MAAM,CAAC,WAAW,CAChB,IAAI,CAAC,CAAC,CAAoC,EAC1C,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CACjB;IACH,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACnB,CAAC,CAAC,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,CAAC,CAAC,MAAM,CAAC,GAAG,IAAI,CAAC,EACvB,MAAM,CACF,CAAC"}

package/lib/app.d.ts

@@ -1,15 +0,0 @@
-import * as Context from "effect/Context";
-import * as Layer from "effect/Layer";
-import type { StageConfig } from "./stage.ts";
-export interface AppProps {
-    name: string;
-    stage: string;
-    config: StageConfig;
-}
-declare const App_base: Context.TagClass<App, "App", AppProps>;
-export declare class App extends App_base {
-}
-export declare const app: (input: AppProps) => Layer.Layer<App, never, never>;
-export declare const make: (input: AppProps) => Layer.Layer<App, never, never>;
-export {};
-//# sourceMappingURL=app.d.ts.map

package/lib/app.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"app.d.ts","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AACtC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,YAAY,CAAC;AAE9C,MAAM,WAAW,QAAQ;IACvB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,WAAW,CAAC;CACrB;;AAED,qBAAa,GAAI,SAAQ,QAAmC;CAAG;AAE/D,eAAO,MAAM,GAAG,GAAI,OAAO,QAAQ,mCAAsC,CAAC;AAE1E,eAAO,MAAM,IAAI,UAFU,QAAQ,mCAEZ,CAAC"}

package/lib/app.js

@@ -1,7 +0,0 @@
-import * as Context from "effect/Context";
-import * as Layer from "effect/Layer";
-export class App extends Context.Tag("App")() {
-}
-export const app = (input) => Layer.succeed(App, App.of(input));
-export const make = app;
-//# sourceMappingURL=app.js.map

package/lib/app.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"app.js","sourceRoot":"","sources":["../src/app.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAC;AAC1C,OAAO,KAAK,KAAK,MAAM,cAAc,CAAC;AAStC,MAAM,OAAO,GAAI,SAAQ,OAAO,CAAC,GAAG,CAAC,KAAK,CAAC,EAAiB;CAAG;AAE/D,MAAM,CAAC,MAAM,GAAG,GAAG,CAAC,KAAe,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,GAAG,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAC;AAE1E,MAAM,CAAC,MAAM,IAAI,GAAG,GAAG,CAAC"}

package/lib/apply.d.ts

@@ -1,18 +0,0 @@
-import * as Effect from "effect/Effect";
-import type { Simplify } from "effect/Types";
-import { App } from "./app.ts";
-import { CLI } from "./cli/service.ts";
-import { type Delete, type DerivePlan, type IPlan, type Providers } from "./plan.ts";
-import type { Instance } from "./policy.ts";
-import type { AnyResource, Resource } from "./resource.ts";
-import type { AnyService } from "./service.ts";
-import { State, StateStoreError } from "./state.ts";
-export type ApplyEffect<P extends IPlan, Err = never, Req = never> = Effect.Effect<{
-    [k in keyof AppliedPlan<P>]: AppliedPlan<P>[k];
-}, Err, Req>;
-export type AppliedPlan<P extends IPlan> = {
-    [id in keyof P["resources"]]: P["resources"][id] extends Delete<Resource> | undefined | never ? never : Simplify<P["resources"][id]["resource"]["attr"]>;
-};
-export declare const apply: <const Resources extends (AnyService | AnyResource)[] = never>(...resources: Resources) => ApplyEffect<DerivePlan<Instance<Resources[number]>>, never, State | Providers<Instance<Resources[number]>>>;
-export declare const applyPlan: <P extends IPlan>(plan: P) => Effect.Effect<{ [k in keyof AppliedPlan<P>]: AppliedPlan<P>[k]; } | undefined, StateStoreError, State | App | CLI>;
-//# sourceMappingURL=apply.d.ts.map

package/lib/apply.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"apply.d.ts","sourceRoot":"","sources":["../src/apply.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAC7C,OAAO,EAAE,GAAG,EAAE,MAAM,UAAU,CAAC;AAE/B,OAAO,EAGL,GAAG,EACJ,MAAM,kBAAkB,CAAC;AAI1B,OAAO,EAGL,KAAK,MAAM,EACX,KAAK,UAAU,EACf,KAAK,KAAK,EACV,KAAK,SAAS,EAEf,MAAM,WAAW,CAAC;AACnB,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,aAAa,CAAC;AAE5C,OAAO,KAAK,EAAE,WAAW,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AAC3D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAC/C,OAAO,EASL,KAAK,EACL,eAAe,EAChB,MAAM,YAAY,CAAC;AAGpB,MAAM,MAAM,WAAW,CACrB,CAAC,SAAS,KAAK,EACf,GAAG,GAAG,KAAK,EACX,GAAG,GAAG,KAAK,IACT,MAAM,CAAC,MAAM,CACf;KACG,CAAC,IAAI,MAAM,WAAW,CAAC,CAAC,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAC/C,EACD,GAAG,EACH,GAAG,CACJ,CAAC;AAEF,MAAM,MAAM,WAAW,CAAC,CAAC,SAAS,KAAK,IAAI;KACxC,EAAE,IAAI,MAAM,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,SAC5C,MAAM,CAAC,QAAQ,CAAC,GAChB,SAAS,GACT,KAAK,GACL,KAAK,GACL,QAAQ,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,EAAE,CAAC,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,CAAC;CACrD,CAAC;AAEF,eAAO,MAAM,KAAK,GAChB,KAAK,CAAC,SAAS,SAAS,CAAC,UAAU,GAAG,WAAW,CAAC,EAAE,GAAG,KAAK,EAE5D,GAAG,WAAW,SAAS,KACtB,WAAW,CACZ,UAAU,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,EACvC,KAAK,EACL,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,CAAC,CAKtC,CAAC;AAEX,eAAO,MAAM,SAAS,GAAI,CAAC,SAAS,KAAK,EAAE,MAAM,CAAC,sBAqB3C,CAAC,gGAEJ,CAAC"}