effect snippets

Author: SandroMaglione

effect-rpc-http-client-complete-example/package.json

@@ -0,0 +1,14 @@
+{
+  "author": "Sandro Maglione <sandro@sandromaglione.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "@types/node": "^22.8.6",
+    "typescript": "^5.6.3"
+  },
+  "dependencies": {
+    "@effect/platform": "^0.69.13",
+    "@effect/rpc": "^0.44.13",
+    "@effect/rpc-http": "^0.42.13",
+    "effect": "^3.10.8"
+  }
+}

effect-rpc-http-client-complete-example/pnpm-lock.yaml

@@ -0,0 +1,47 @@
+import {
+  FetchHttpClient,
+  HttpClient,
+  HttpClientRequest,
+} from "@effect/platform";
+import { RpcResolver } from "@effect/rpc";
+import { HttpRpcResolverNoStream } from "@effect/rpc-http";
+import { Effect, flow } from "effect";
+
+// 👇 API derived from `Router` defined in the server
+import { SignUpRequest } from "./schema";
+import type { Router } from "./server";
+
+export class RpcClient extends Effect.Service<RpcClient>()("RpcClient", {
+  effect: Effect.gen(function* () {
+    const baseClient = yield* HttpClient.HttpClient;
+    const client = baseClient.pipe(
+      HttpClient.mapRequest(
+        // 👇 Rpc endpoint as `POST` pointing to a single API endpoint
+        flow(
+          HttpClientRequest.prependUrl("/api/rpc"),
+          HttpClientRequest.setMethod("POST")
+        )
+      )
+    );
+
+    return HttpRpcResolverNoStream.make<Router>(client).pipe(
+      RpcResolver.toClient
+    );
+  }),
+  dependencies: [FetchHttpClient.layer],
+}) {}
+
+/// 👇 Example of how to use `RpcClient` to perform requests
+const main = Effect.gen(function* () {
+  const rpcClient = yield* RpcClient;
+
+  //   👇 `boolean`
+  const response = yield* rpcClient(
+    new SignUpRequest({
+      email: "test@test.com",
+      password: "test",
+    })
+  ).pipe(
+    Effect.tapError((requestError) => Effect.log(requestError.errorMessage))
+  );
+});

effect-rpc-http-client-complete-example/src/client.ts

@@ -0,0 +1,14 @@
+// @ts-ignore
+import type { NextRequest } from "next/server";
+
+import { RpcWebHandler } from "./server";
+
+/**
+ * Example of using the rpc handler in a NextJs api route.
+ *
+ * `RpcWebHandler.handler` takes a standard `Request` and returns `Response`,
+ * so it can be used in any API supporting standard requests
+ */
+export async function POST(request: NextRequest): Promise<Response> {
+  return RpcWebHandler.handler(request);
+}

effect-rpc-http-client-complete-example/src/route.ts

@@ -0,0 +1,17 @@
+import { Schema } from "effect";
+
+class RequestError extends Schema.Class<RequestError>("RequestError")({
+  errorMessage: Schema.String,
+}) {}
+
+export class SignUpRequest extends Schema.TaggedRequest<SignUpRequest>()(
+  "SignUpRequest",
+  {
+    failure: RequestError,
+    success: Schema.Boolean,
+    payload: {
+      email: Schema.NonEmptyString,
+      password: Schema.String,
+    },
+  }
+) {}

effect-rpc-http-client-complete-example/src/schema.ts

@@ -0,0 +1,31 @@
+import { HttpApp } from "@effect/platform";
+import { Rpc, RpcRouter } from "@effect/rpc";
+import { HttpRpcRouterNoStream } from "@effect/rpc-http";
+import { Effect, Logger } from "effect";
+import { SignUpRequest } from "./schema";
+
+// 👇 Example of added custom logger (as `Layer`)
+export const LoggerLayer = Logger.add(
+  Logger.make(({ logLevel, message }) => {
+    globalThis.console.log(`[${logLevel.label}] ${message}`);
+  })
+);
+
+const router = RpcRouter.make(
+  Rpc.effect(SignUpRequest, (params) =>
+    Effect.gen(function* () {
+      // 👇 `params` contains the `TaggedRequest` payload
+      yield* Effect.log(params.email, params.password);
+      return true;
+    })
+  )
+);
+
+// 👇 Export `Router` type for client generation
+export type Router = typeof router;
+
+export const RpcWebHandler = HttpApp.toWebHandlerLayer(
+  HttpRpcRouterNoStream.toHttpApp(router),
+  // 👇 Provide layers used in requests
+  LoggerLayer
+);

effect-rpc-http-client-complete-example/src/server.ts

@@ -0,0 +1,20 @@
+{
+  "compilerOptions": {
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "target": "es2022",
+    "allowJs": true,
+    "resolveJsonModule": true,
+    "moduleDetection": "force",
+    "isolatedModules": true,
+    "verbatimModuleSyntax": true,
+    "strict": true,
+    "noUncheckedIndexedAccess": true,
+    "noImplicitOverride": true,
+    "module": "preserve",
+    "noEmit": true,
+    "lib": ["es2022"]
+  },
+  "include": ["**/*.ts", "**/*.tsx"],
+  "exclude": ["node_modules"]
+}

effect-rpc-http-client-complete-example/tsconfig.json

@@ -0,0 +1,10 @@
+{
+  "author": "Sandro Maglione <sandro@sandromaglione.com>",
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.6.3"
+  },
+  "dependencies": {
+    "effect": "^3.10.8"
+  }
+}