feat(sdk): Effect v4 + @effect/openapi-generator; typed pf.api & example ladder
Drop Orval for the first-party @effect/openapi-generator (OpenAPI 3.1 -> Effect Schema + a typed HttpClient client) and bump effect 3.19 -> 4.0.0-beta.98. Port the hand-written surfaces to the v4 API (Result over Either, Context.Service, Codec, Literals/Union arrays, Stream/Schedule/ Effect renames). Transport (CA-pinning fetch) and the reconnecting SSE source are kept intact. Make the SDK approachable for non-Effect users: - Add pf.api.* on the Promise facade: the generated client surfaced as typed, Promise-native methods (await pf.api.listPairedClients()), so REST calls are autocompleted and checked instead of stringly-typed pf.request(method, path, body) + `as` casts. Zero-drift veneer over make(httpClient), backed by the same pinning fetch. pf.request stays as the untyped escape hatch. - Re-tier examples into a 1-4 complexity ladder, rewritten onto pf.api.* (the typed payloads caught a wrong `launch` shape in provider-sync); the Effect example is labelled advanced. Add examples/ to tsconfig so they are typechecked (stops rot). typecheck + 19 tests green. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
+6
-3
@@ -39,8 +39,11 @@ export {
|
||||
export { type ConnectOptions, configDir, resolveConfig } from "./config.js";
|
||||
export type { EventStreamOptions, SseFrame } from "./sse.js";
|
||||
export * from "./wire.js";
|
||||
/** The generated REST wire schemas (orval `client: 'effect'` over `api/openapi.json`). */
|
||||
export * as api from "./gen/schemas.js";
|
||||
/**
|
||||
* The generated REST surface: wire Schemas plus a typed `HttpClient`-based client (`make`),
|
||||
* from `@effect/openapi-generator` over `api/openapi.json`. Regenerate with `bun run gen`.
|
||||
*/
|
||||
export * as api from "./gen/punktfunk.js";
|
||||
|
||||
/** The decoded lifecycle-event stream of the ambient [`PunktfunkHost`]. */
|
||||
export const events = (
|
||||
@@ -65,6 +68,6 @@ export const request = (
|
||||
/** GET + schema-validate on the ambient service (schemas from [`api`]). */
|
||||
export const get = <A, I>(
|
||||
path: string,
|
||||
schema: S.Schema<A, I>,
|
||||
schema: S.Codec<A, I>,
|
||||
): Effect.Effect<A, RequestError | VersionSkew, PunktfunkHost> =>
|
||||
Effect.flatMap(PunktfunkHost, (s) => s.get(path, schema));
|
||||
|
||||
Reference in New Issue
Block a user