Compare commits
2 commits
dev
...
feat/sdk-o
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
bdbf2d4102 | ||
|
|
321d257beb |
24 changed files with 6549 additions and 968 deletions
18
packages/sdk/js/example/effect-sdk/gen/client.gen.ts
Normal file
18
packages/sdk/js/example/effect-sdk/gen/client.gen.ts
Normal file
|
|
@ -0,0 +1,18 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import { type ClientOptions, type Config, createClient, createConfig } from "./client/index.js"
|
||||||
|
import type { ClientOptions as ClientOptions2 } from "./types.gen.js"
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The `createClientConfig()` function will be called on client initialization
|
||||||
|
* and the returned object will become the client's initial configuration.
|
||||||
|
*
|
||||||
|
* You may want to initialize your client this way instead of calling
|
||||||
|
* `setConfig()`. This is useful for example if you're using Next.js
|
||||||
|
* to ensure your client always has the correct values.
|
||||||
|
*/
|
||||||
|
export type CreateClientConfig<T extends ClientOptions = ClientOptions2> = (
|
||||||
|
override?: Config<ClientOptions & T>,
|
||||||
|
) => Config<Required<ClientOptions> & T>
|
||||||
|
|
||||||
|
export const client = createClient(createConfig<ClientOptions2>({ baseUrl: "https://api.example.com" }))
|
||||||
285
packages/sdk/js/example/effect-sdk/gen/client/client.gen.ts
Normal file
285
packages/sdk/js/example/effect-sdk/gen/client/client.gen.ts
Normal file
|
|
@ -0,0 +1,285 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import { createSseClient } from "../core/serverSentEvents.gen.js"
|
||||||
|
import type { HttpMethod } from "../core/types.gen.js"
|
||||||
|
import { getValidRequestBody } from "../core/utils.gen.js"
|
||||||
|
import type { Client, Config, RequestOptions, ResolvedRequestOptions } from "./types.gen.js"
|
||||||
|
import {
|
||||||
|
buildUrl,
|
||||||
|
createConfig,
|
||||||
|
createInterceptors,
|
||||||
|
getParseAs,
|
||||||
|
mergeConfigs,
|
||||||
|
mergeHeaders,
|
||||||
|
setAuthParams,
|
||||||
|
} from "./utils.gen.js"
|
||||||
|
|
||||||
|
type ReqInit = Omit<RequestInit, "body" | "headers"> & {
|
||||||
|
body?: any
|
||||||
|
headers: ReturnType<typeof mergeHeaders>
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createClient = (config: Config = {}): Client => {
|
||||||
|
let _config = mergeConfigs(createConfig(), config)
|
||||||
|
|
||||||
|
const getConfig = (): Config => ({ ..._config })
|
||||||
|
|
||||||
|
const setConfig = (config: Config): Config => {
|
||||||
|
_config = mergeConfigs(_config, config)
|
||||||
|
return getConfig()
|
||||||
|
}
|
||||||
|
|
||||||
|
const interceptors = createInterceptors<Request, Response, unknown, ResolvedRequestOptions>()
|
||||||
|
|
||||||
|
const beforeRequest = async (options: RequestOptions) => {
|
||||||
|
const opts = {
|
||||||
|
..._config,
|
||||||
|
...options,
|
||||||
|
fetch: options.fetch ?? _config.fetch ?? globalThis.fetch,
|
||||||
|
headers: mergeHeaders(_config.headers, options.headers),
|
||||||
|
serializedBody: undefined,
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.security) {
|
||||||
|
await setAuthParams({
|
||||||
|
...opts,
|
||||||
|
security: opts.security,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.requestValidator) {
|
||||||
|
await opts.requestValidator(opts)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.body !== undefined && opts.bodySerializer) {
|
||||||
|
opts.serializedBody = opts.bodySerializer(opts.body)
|
||||||
|
}
|
||||||
|
|
||||||
|
// remove Content-Type header if body is empty to avoid sending invalid requests
|
||||||
|
if (opts.body === undefined || opts.serializedBody === "") {
|
||||||
|
opts.headers.delete("Content-Type")
|
||||||
|
}
|
||||||
|
|
||||||
|
const url = buildUrl(opts)
|
||||||
|
|
||||||
|
return { opts, url }
|
||||||
|
}
|
||||||
|
|
||||||
|
const request: Client["request"] = async (options) => {
|
||||||
|
// @ts-expect-error
|
||||||
|
const { opts, url } = await beforeRequest(options)
|
||||||
|
const requestInit: ReqInit = {
|
||||||
|
redirect: "follow",
|
||||||
|
...opts,
|
||||||
|
body: getValidRequestBody(opts),
|
||||||
|
}
|
||||||
|
|
||||||
|
let request = new Request(url, requestInit)
|
||||||
|
|
||||||
|
for (const fn of interceptors.request.fns) {
|
||||||
|
if (fn) {
|
||||||
|
request = await fn(request, opts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// fetch must be assigned here, otherwise it would throw the error:
|
||||||
|
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
|
||||||
|
const _fetch = opts.fetch!
|
||||||
|
let response: Response
|
||||||
|
|
||||||
|
try {
|
||||||
|
response = await _fetch(request)
|
||||||
|
} catch (error) {
|
||||||
|
// Handle fetch exceptions (AbortError, network errors, etc.)
|
||||||
|
let finalError = error
|
||||||
|
|
||||||
|
for (const fn of interceptors.error.fns) {
|
||||||
|
if (fn) {
|
||||||
|
finalError = (await fn(error, undefined as any, request, opts)) as unknown
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
finalError = finalError || ({} as unknown)
|
||||||
|
|
||||||
|
if (opts.throwOnError) {
|
||||||
|
throw finalError
|
||||||
|
}
|
||||||
|
|
||||||
|
// Return error response
|
||||||
|
return opts.responseStyle === "data"
|
||||||
|
? undefined
|
||||||
|
: {
|
||||||
|
error: finalError,
|
||||||
|
request,
|
||||||
|
response: undefined as any,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const fn of interceptors.response.fns) {
|
||||||
|
if (fn) {
|
||||||
|
response = await fn(response, request, opts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const result = {
|
||||||
|
request,
|
||||||
|
response,
|
||||||
|
}
|
||||||
|
|
||||||
|
if (response.ok) {
|
||||||
|
const parseAs =
|
||||||
|
(opts.parseAs === "auto" ? getParseAs(response.headers.get("Content-Type")) : opts.parseAs) ?? "json"
|
||||||
|
|
||||||
|
if (response.status === 204 || response.headers.get("Content-Length") === "0") {
|
||||||
|
let emptyData: any
|
||||||
|
switch (parseAs) {
|
||||||
|
case "arrayBuffer":
|
||||||
|
case "blob":
|
||||||
|
case "text":
|
||||||
|
emptyData = await response[parseAs]()
|
||||||
|
break
|
||||||
|
case "formData":
|
||||||
|
emptyData = new FormData()
|
||||||
|
break
|
||||||
|
case "stream":
|
||||||
|
emptyData = response.body
|
||||||
|
break
|
||||||
|
case "json":
|
||||||
|
default:
|
||||||
|
emptyData = {}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
return opts.responseStyle === "data"
|
||||||
|
? emptyData
|
||||||
|
: {
|
||||||
|
data: emptyData,
|
||||||
|
...result,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let data: any
|
||||||
|
switch (parseAs) {
|
||||||
|
case "arrayBuffer":
|
||||||
|
case "blob":
|
||||||
|
case "formData":
|
||||||
|
case "text":
|
||||||
|
data = await response[parseAs]()
|
||||||
|
break
|
||||||
|
case "json": {
|
||||||
|
// Some servers return 200 with no Content-Length and empty body.
|
||||||
|
// response.json() would throw; read as text and parse if non-empty.
|
||||||
|
const text = await response.text()
|
||||||
|
data = text ? JSON.parse(text) : {}
|
||||||
|
break
|
||||||
|
}
|
||||||
|
case "stream":
|
||||||
|
return opts.responseStyle === "data"
|
||||||
|
? response.body
|
||||||
|
: {
|
||||||
|
data: response.body,
|
||||||
|
...result,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (parseAs === "json") {
|
||||||
|
if (opts.responseValidator) {
|
||||||
|
await opts.responseValidator(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (opts.responseTransformer) {
|
||||||
|
data = await opts.responseTransformer(data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return opts.responseStyle === "data"
|
||||||
|
? data
|
||||||
|
: {
|
||||||
|
data,
|
||||||
|
...result,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const textError = await response.text()
|
||||||
|
let jsonError: unknown
|
||||||
|
|
||||||
|
try {
|
||||||
|
jsonError = JSON.parse(textError)
|
||||||
|
} catch {
|
||||||
|
// noop
|
||||||
|
}
|
||||||
|
|
||||||
|
const error = jsonError ?? textError
|
||||||
|
let finalError = error
|
||||||
|
|
||||||
|
for (const fn of interceptors.error.fns) {
|
||||||
|
if (fn) {
|
||||||
|
finalError = (await fn(error, response, request, opts)) as string
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
finalError = finalError || ({} as string)
|
||||||
|
|
||||||
|
if (opts.throwOnError) {
|
||||||
|
throw finalError
|
||||||
|
}
|
||||||
|
|
||||||
|
// TODO: we probably want to return error and improve types
|
||||||
|
return opts.responseStyle === "data"
|
||||||
|
? undefined
|
||||||
|
: {
|
||||||
|
error: finalError,
|
||||||
|
...result,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const makeMethodFn = (method: Uppercase<HttpMethod>) => (options: RequestOptions) => request({ ...options, method })
|
||||||
|
|
||||||
|
const makeSseFn = (method: Uppercase<HttpMethod>) => async (options: RequestOptions) => {
|
||||||
|
const { opts, url } = await beforeRequest(options)
|
||||||
|
return createSseClient({
|
||||||
|
...opts,
|
||||||
|
body: opts.body as BodyInit | null | undefined,
|
||||||
|
headers: opts.headers as unknown as Record<string, string>,
|
||||||
|
method,
|
||||||
|
onRequest: async (url, init) => {
|
||||||
|
let request = new Request(url, init)
|
||||||
|
for (const fn of interceptors.request.fns) {
|
||||||
|
if (fn) {
|
||||||
|
request = await fn(request, opts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return request
|
||||||
|
},
|
||||||
|
serializedBody: getValidRequestBody(opts) as BodyInit | null | undefined,
|
||||||
|
url,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return {
|
||||||
|
buildUrl,
|
||||||
|
connect: makeMethodFn("CONNECT"),
|
||||||
|
delete: makeMethodFn("DELETE"),
|
||||||
|
get: makeMethodFn("GET"),
|
||||||
|
getConfig,
|
||||||
|
head: makeMethodFn("HEAD"),
|
||||||
|
interceptors,
|
||||||
|
options: makeMethodFn("OPTIONS"),
|
||||||
|
patch: makeMethodFn("PATCH"),
|
||||||
|
post: makeMethodFn("POST"),
|
||||||
|
put: makeMethodFn("PUT"),
|
||||||
|
request,
|
||||||
|
setConfig,
|
||||||
|
sse: {
|
||||||
|
connect: makeSseFn("CONNECT"),
|
||||||
|
delete: makeSseFn("DELETE"),
|
||||||
|
get: makeSseFn("GET"),
|
||||||
|
head: makeSseFn("HEAD"),
|
||||||
|
options: makeSseFn("OPTIONS"),
|
||||||
|
patch: makeSseFn("PATCH"),
|
||||||
|
post: makeSseFn("POST"),
|
||||||
|
put: makeSseFn("PUT"),
|
||||||
|
trace: makeSseFn("TRACE"),
|
||||||
|
},
|
||||||
|
trace: makeMethodFn("TRACE"),
|
||||||
|
} as Client
|
||||||
|
}
|
||||||
25
packages/sdk/js/example/effect-sdk/gen/client/index.ts
Normal file
25
packages/sdk/js/example/effect-sdk/gen/client/index.ts
Normal file
|
|
@ -0,0 +1,25 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
export type { Auth } from "../core/auth.gen.js"
|
||||||
|
export type { QuerySerializerOptions } from "../core/bodySerializer.gen.js"
|
||||||
|
export {
|
||||||
|
formDataBodySerializer,
|
||||||
|
jsonBodySerializer,
|
||||||
|
urlSearchParamsBodySerializer,
|
||||||
|
} from "../core/bodySerializer.gen.js"
|
||||||
|
export { buildClientParams } from "../core/params.gen.js"
|
||||||
|
export { serializeQueryKeyValue } from "../core/queryKeySerializer.gen.js"
|
||||||
|
export { createClient } from "./client.gen.js"
|
||||||
|
export type {
|
||||||
|
Client,
|
||||||
|
ClientOptions,
|
||||||
|
Config,
|
||||||
|
CreateClientConfig,
|
||||||
|
Options,
|
||||||
|
RequestOptions,
|
||||||
|
RequestResult,
|
||||||
|
ResolvedRequestOptions,
|
||||||
|
ResponseStyle,
|
||||||
|
TDataShape,
|
||||||
|
} from "./types.gen.js"
|
||||||
|
export { createConfig, mergeHeaders } from "./utils.gen.js"
|
||||||
202
packages/sdk/js/example/effect-sdk/gen/client/types.gen.ts
Normal file
202
packages/sdk/js/example/effect-sdk/gen/client/types.gen.ts
Normal file
|
|
@ -0,0 +1,202 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import type { Auth } from "../core/auth.gen.js"
|
||||||
|
import type { ServerSentEventsOptions, ServerSentEventsResult } from "../core/serverSentEvents.gen.js"
|
||||||
|
import type { Client as CoreClient, Config as CoreConfig } from "../core/types.gen.js"
|
||||||
|
import type { Middleware } from "./utils.gen.js"
|
||||||
|
|
||||||
|
export type ResponseStyle = "data" | "fields"
|
||||||
|
|
||||||
|
export interface Config<T extends ClientOptions = ClientOptions>
|
||||||
|
extends Omit<RequestInit, "body" | "headers" | "method">,
|
||||||
|
CoreConfig {
|
||||||
|
/**
|
||||||
|
* Base URL for all requests made by this client.
|
||||||
|
*/
|
||||||
|
baseUrl?: T["baseUrl"]
|
||||||
|
/**
|
||||||
|
* Fetch API implementation. You can use this option to provide a custom
|
||||||
|
* fetch instance.
|
||||||
|
*
|
||||||
|
* @default globalThis.fetch
|
||||||
|
*/
|
||||||
|
fetch?: typeof fetch
|
||||||
|
/**
|
||||||
|
* Please don't use the Fetch client for Next.js applications. The `next`
|
||||||
|
* options won't have any effect.
|
||||||
|
*
|
||||||
|
* Install {@link https://www.npmjs.com/package/@hey-api/client-next `@hey-api/client-next`} instead.
|
||||||
|
*/
|
||||||
|
next?: never
|
||||||
|
/**
|
||||||
|
* Return the response data parsed in a specified format. By default, `auto`
|
||||||
|
* will infer the appropriate method from the `Content-Type` response header.
|
||||||
|
* You can override this behavior with any of the {@link Body} methods.
|
||||||
|
* Select `stream` if you don't want to parse response data at all.
|
||||||
|
*
|
||||||
|
* @default 'auto'
|
||||||
|
*/
|
||||||
|
parseAs?: "arrayBuffer" | "auto" | "blob" | "formData" | "json" | "stream" | "text"
|
||||||
|
/**
|
||||||
|
* Should we return only data or multiple fields (data, error, response, etc.)?
|
||||||
|
*
|
||||||
|
* @default 'fields'
|
||||||
|
*/
|
||||||
|
responseStyle?: ResponseStyle
|
||||||
|
/**
|
||||||
|
* Throw an error instead of returning it in the response?
|
||||||
|
*
|
||||||
|
* @default false
|
||||||
|
*/
|
||||||
|
throwOnError?: T["throwOnError"]
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RequestOptions<
|
||||||
|
TData = unknown,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
ThrowOnError extends boolean = boolean,
|
||||||
|
Url extends string = string,
|
||||||
|
> extends Config<{
|
||||||
|
responseStyle: TResponseStyle
|
||||||
|
throwOnError: ThrowOnError
|
||||||
|
}>,
|
||||||
|
Pick<
|
||||||
|
ServerSentEventsOptions<TData>,
|
||||||
|
"onSseError" | "onSseEvent" | "sseDefaultRetryDelay" | "sseMaxRetryAttempts" | "sseMaxRetryDelay"
|
||||||
|
> {
|
||||||
|
/**
|
||||||
|
* Any body that you want to add to your request.
|
||||||
|
*
|
||||||
|
* {@link https://developer.mozilla.org/docs/Web/API/fetch#body}
|
||||||
|
*/
|
||||||
|
body?: unknown
|
||||||
|
path?: Record<string, unknown>
|
||||||
|
query?: Record<string, unknown>
|
||||||
|
/**
|
||||||
|
* Security mechanism(s) to use for the request.
|
||||||
|
*/
|
||||||
|
security?: ReadonlyArray<Auth>
|
||||||
|
url: Url
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface ResolvedRequestOptions<
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
ThrowOnError extends boolean = boolean,
|
||||||
|
Url extends string = string,
|
||||||
|
> extends RequestOptions<unknown, TResponseStyle, ThrowOnError, Url> {
|
||||||
|
serializedBody?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type RequestResult<
|
||||||
|
TData = unknown,
|
||||||
|
TError = unknown,
|
||||||
|
ThrowOnError extends boolean = boolean,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
> = ThrowOnError extends true
|
||||||
|
? Promise<
|
||||||
|
TResponseStyle extends "data"
|
||||||
|
? TData extends Record<string, unknown>
|
||||||
|
? TData[keyof TData]
|
||||||
|
: TData
|
||||||
|
: {
|
||||||
|
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData
|
||||||
|
request: Request
|
||||||
|
response: Response
|
||||||
|
}
|
||||||
|
>
|
||||||
|
: Promise<
|
||||||
|
TResponseStyle extends "data"
|
||||||
|
? (TData extends Record<string, unknown> ? TData[keyof TData] : TData) | undefined
|
||||||
|
: (
|
||||||
|
| {
|
||||||
|
data: TData extends Record<string, unknown> ? TData[keyof TData] : TData
|
||||||
|
error: undefined
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
data: undefined
|
||||||
|
error: TError extends Record<string, unknown> ? TError[keyof TError] : TError
|
||||||
|
}
|
||||||
|
) & {
|
||||||
|
request: Request
|
||||||
|
response: Response
|
||||||
|
}
|
||||||
|
>
|
||||||
|
|
||||||
|
export interface ClientOptions {
|
||||||
|
baseUrl?: string
|
||||||
|
responseStyle?: ResponseStyle
|
||||||
|
throwOnError?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
type MethodFn = <
|
||||||
|
TData = unknown,
|
||||||
|
TError = unknown,
|
||||||
|
ThrowOnError extends boolean = false,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
>(
|
||||||
|
options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">,
|
||||||
|
) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>
|
||||||
|
|
||||||
|
type SseFn = <
|
||||||
|
TData = unknown,
|
||||||
|
TError = unknown,
|
||||||
|
ThrowOnError extends boolean = false,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
>(
|
||||||
|
options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method">,
|
||||||
|
) => Promise<ServerSentEventsResult<TData>>
|
||||||
|
|
||||||
|
type RequestFn = <
|
||||||
|
TData = unknown,
|
||||||
|
TError = unknown,
|
||||||
|
ThrowOnError extends boolean = false,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
>(
|
||||||
|
options: Omit<RequestOptions<TData, TResponseStyle, ThrowOnError>, "method"> &
|
||||||
|
Pick<Required<RequestOptions<TData, TResponseStyle, ThrowOnError>>, "method">,
|
||||||
|
) => RequestResult<TData, TError, ThrowOnError, TResponseStyle>
|
||||||
|
|
||||||
|
type BuildUrlFn = <
|
||||||
|
TData extends {
|
||||||
|
body?: unknown
|
||||||
|
path?: Record<string, unknown>
|
||||||
|
query?: Record<string, unknown>
|
||||||
|
url: string
|
||||||
|
},
|
||||||
|
>(
|
||||||
|
options: TData & Options<TData>,
|
||||||
|
) => string
|
||||||
|
|
||||||
|
export type Client = CoreClient<RequestFn, Config, MethodFn, BuildUrlFn, SseFn> & {
|
||||||
|
interceptors: Middleware<Request, Response, unknown, ResolvedRequestOptions>
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* The `createClientConfig()` function will be called on client initialization
|
||||||
|
* and the returned object will become the client's initial configuration.
|
||||||
|
*
|
||||||
|
* You may want to initialize your client this way instead of calling
|
||||||
|
* `setConfig()`. This is useful for example if you're using Next.js
|
||||||
|
* to ensure your client always has the correct values.
|
||||||
|
*/
|
||||||
|
export type CreateClientConfig<T extends ClientOptions = ClientOptions> = (
|
||||||
|
override?: Config<ClientOptions & T>,
|
||||||
|
) => Config<Required<ClientOptions> & T>
|
||||||
|
|
||||||
|
export interface TDataShape {
|
||||||
|
body?: unknown
|
||||||
|
headers?: unknown
|
||||||
|
path?: unknown
|
||||||
|
query?: unknown
|
||||||
|
url: string
|
||||||
|
}
|
||||||
|
|
||||||
|
type OmitKeys<T, K> = Pick<T, Exclude<keyof T, K>>
|
||||||
|
|
||||||
|
export type Options<
|
||||||
|
TData extends TDataShape = TDataShape,
|
||||||
|
ThrowOnError extends boolean = boolean,
|
||||||
|
TResponse = unknown,
|
||||||
|
TResponseStyle extends ResponseStyle = "fields",
|
||||||
|
> = OmitKeys<RequestOptions<TResponse, TResponseStyle, ThrowOnError>, "body" | "path" | "query" | "url"> &
|
||||||
|
([TData] extends [never] ? unknown : Omit<TData, "url">)
|
||||||
289
packages/sdk/js/example/effect-sdk/gen/client/utils.gen.ts
Normal file
289
packages/sdk/js/example/effect-sdk/gen/client/utils.gen.ts
Normal file
|
|
@ -0,0 +1,289 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import { getAuthToken } from "../core/auth.gen.js"
|
||||||
|
import type { QuerySerializerOptions } from "../core/bodySerializer.gen.js"
|
||||||
|
import { jsonBodySerializer } from "../core/bodySerializer.gen.js"
|
||||||
|
import { serializeArrayParam, serializeObjectParam, serializePrimitiveParam } from "../core/pathSerializer.gen.js"
|
||||||
|
import { getUrl } from "../core/utils.gen.js"
|
||||||
|
import type { Client, ClientOptions, Config, RequestOptions } from "./types.gen.js"
|
||||||
|
|
||||||
|
export const createQuerySerializer = <T = unknown>({ parameters = {}, ...args }: QuerySerializerOptions = {}) => {
|
||||||
|
const querySerializer = (queryParams: T) => {
|
||||||
|
const search: string[] = []
|
||||||
|
if (queryParams && typeof queryParams === "object") {
|
||||||
|
for (const name in queryParams) {
|
||||||
|
const value = queryParams[name]
|
||||||
|
|
||||||
|
if (value === undefined || value === null) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
const options = parameters[name] || args
|
||||||
|
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
const serializedArray = serializeArrayParam({
|
||||||
|
allowReserved: options.allowReserved,
|
||||||
|
explode: true,
|
||||||
|
name,
|
||||||
|
style: "form",
|
||||||
|
value,
|
||||||
|
...options.array,
|
||||||
|
})
|
||||||
|
if (serializedArray) search.push(serializedArray)
|
||||||
|
} else if (typeof value === "object") {
|
||||||
|
const serializedObject = serializeObjectParam({
|
||||||
|
allowReserved: options.allowReserved,
|
||||||
|
explode: true,
|
||||||
|
name,
|
||||||
|
style: "deepObject",
|
||||||
|
value: value as Record<string, unknown>,
|
||||||
|
...options.object,
|
||||||
|
})
|
||||||
|
if (serializedObject) search.push(serializedObject)
|
||||||
|
} else {
|
||||||
|
const serializedPrimitive = serializePrimitiveParam({
|
||||||
|
allowReserved: options.allowReserved,
|
||||||
|
name,
|
||||||
|
value: value as string,
|
||||||
|
})
|
||||||
|
if (serializedPrimitive) search.push(serializedPrimitive)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return search.join("&")
|
||||||
|
}
|
||||||
|
return querySerializer
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Infers parseAs value from provided Content-Type header.
|
||||||
|
*/
|
||||||
|
export const getParseAs = (contentType: string | null): Exclude<Config["parseAs"], "auto"> => {
|
||||||
|
if (!contentType) {
|
||||||
|
// If no Content-Type header is provided, the best we can do is return the raw response body,
|
||||||
|
// which is effectively the same as the 'stream' option.
|
||||||
|
return "stream"
|
||||||
|
}
|
||||||
|
|
||||||
|
const cleanContent = contentType.split(";")[0]?.trim()
|
||||||
|
|
||||||
|
if (!cleanContent) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cleanContent.startsWith("application/json") || cleanContent.endsWith("+json")) {
|
||||||
|
return "json"
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cleanContent === "multipart/form-data") {
|
||||||
|
return "formData"
|
||||||
|
}
|
||||||
|
|
||||||
|
if (["application/", "audio/", "image/", "video/"].some((type) => cleanContent.startsWith(type))) {
|
||||||
|
return "blob"
|
||||||
|
}
|
||||||
|
|
||||||
|
if (cleanContent.startsWith("text/")) {
|
||||||
|
return "text"
|
||||||
|
}
|
||||||
|
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
const checkForExistence = (
|
||||||
|
options: Pick<RequestOptions, "auth" | "query"> & {
|
||||||
|
headers: Headers
|
||||||
|
},
|
||||||
|
name?: string,
|
||||||
|
): boolean => {
|
||||||
|
if (!name) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
if (options.headers.has(name) || options.query?.[name] || options.headers.get("Cookie")?.includes(`${name}=`)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
export const setAuthParams = async ({
|
||||||
|
security,
|
||||||
|
...options
|
||||||
|
}: Pick<Required<RequestOptions>, "security"> &
|
||||||
|
Pick<RequestOptions, "auth" | "query"> & {
|
||||||
|
headers: Headers
|
||||||
|
}) => {
|
||||||
|
for (const auth of security) {
|
||||||
|
if (checkForExistence(options, auth.name)) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
const token = await getAuthToken(auth, options.auth)
|
||||||
|
|
||||||
|
if (!token) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
const name = auth.name ?? "Authorization"
|
||||||
|
|
||||||
|
switch (auth.in) {
|
||||||
|
case "query":
|
||||||
|
if (!options.query) {
|
||||||
|
options.query = {}
|
||||||
|
}
|
||||||
|
options.query[name] = token
|
||||||
|
break
|
||||||
|
case "cookie":
|
||||||
|
options.headers.append("Cookie", `${name}=${token}`)
|
||||||
|
break
|
||||||
|
case "header":
|
||||||
|
default:
|
||||||
|
options.headers.set(name, token)
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const buildUrl: Client["buildUrl"] = (options) =>
|
||||||
|
getUrl({
|
||||||
|
baseUrl: options.baseUrl as string,
|
||||||
|
path: options.path,
|
||||||
|
query: options.query,
|
||||||
|
querySerializer:
|
||||||
|
typeof options.querySerializer === "function"
|
||||||
|
? options.querySerializer
|
||||||
|
: createQuerySerializer(options.querySerializer),
|
||||||
|
url: options.url,
|
||||||
|
})
|
||||||
|
|
||||||
|
export const mergeConfigs = (a: Config, b: Config): Config => {
|
||||||
|
const config = { ...a, ...b }
|
||||||
|
if (config.baseUrl?.endsWith("/")) {
|
||||||
|
config.baseUrl = config.baseUrl.substring(0, config.baseUrl.length - 1)
|
||||||
|
}
|
||||||
|
config.headers = mergeHeaders(a.headers, b.headers)
|
||||||
|
return config
|
||||||
|
}
|
||||||
|
|
||||||
|
const headersEntries = (headers: Headers): Array<[string, string]> => {
|
||||||
|
const entries: Array<[string, string]> = []
|
||||||
|
headers.forEach((value, key) => {
|
||||||
|
entries.push([key, value])
|
||||||
|
})
|
||||||
|
return entries
|
||||||
|
}
|
||||||
|
|
||||||
|
export const mergeHeaders = (...headers: Array<Required<Config>["headers"] | undefined>): Headers => {
|
||||||
|
const mergedHeaders = new Headers()
|
||||||
|
for (const header of headers) {
|
||||||
|
if (!header) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
const iterator = header instanceof Headers ? headersEntries(header) : Object.entries(header)
|
||||||
|
|
||||||
|
for (const [key, value] of iterator) {
|
||||||
|
if (value === null) {
|
||||||
|
mergedHeaders.delete(key)
|
||||||
|
} else if (Array.isArray(value)) {
|
||||||
|
for (const v of value) {
|
||||||
|
mergedHeaders.append(key, v as string)
|
||||||
|
}
|
||||||
|
} else if (value !== undefined) {
|
||||||
|
// assume object headers are meant to be JSON stringified, i.e. their
|
||||||
|
// content value in OpenAPI specification is 'application/json'
|
||||||
|
mergedHeaders.set(key, typeof value === "object" ? JSON.stringify(value) : (value as string))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return mergedHeaders
|
||||||
|
}
|
||||||
|
|
||||||
|
type ErrInterceptor<Err, Res, Req, Options> = (
|
||||||
|
error: Err,
|
||||||
|
response: Res,
|
||||||
|
request: Req,
|
||||||
|
options: Options,
|
||||||
|
) => Err | Promise<Err>
|
||||||
|
|
||||||
|
type ReqInterceptor<Req, Options> = (request: Req, options: Options) => Req | Promise<Req>
|
||||||
|
|
||||||
|
type ResInterceptor<Res, Req, Options> = (response: Res, request: Req, options: Options) => Res | Promise<Res>
|
||||||
|
|
||||||
|
class Interceptors<Interceptor> {
|
||||||
|
fns: Array<Interceptor | null> = []
|
||||||
|
|
||||||
|
clear(): void {
|
||||||
|
this.fns = []
|
||||||
|
}
|
||||||
|
|
||||||
|
eject(id: number | Interceptor): void {
|
||||||
|
const index = this.getInterceptorIndex(id)
|
||||||
|
if (this.fns[index]) {
|
||||||
|
this.fns[index] = null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
exists(id: number | Interceptor): boolean {
|
||||||
|
const index = this.getInterceptorIndex(id)
|
||||||
|
return Boolean(this.fns[index])
|
||||||
|
}
|
||||||
|
|
||||||
|
getInterceptorIndex(id: number | Interceptor): number {
|
||||||
|
if (typeof id === "number") {
|
||||||
|
return this.fns[id] ? id : -1
|
||||||
|
}
|
||||||
|
return this.fns.indexOf(id)
|
||||||
|
}
|
||||||
|
|
||||||
|
update(id: number | Interceptor, fn: Interceptor): number | Interceptor | false {
|
||||||
|
const index = this.getInterceptorIndex(id)
|
||||||
|
if (this.fns[index]) {
|
||||||
|
this.fns[index] = fn
|
||||||
|
return id
|
||||||
|
}
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
use(fn: Interceptor): number {
|
||||||
|
this.fns.push(fn)
|
||||||
|
return this.fns.length - 1
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Middleware<Req, Res, Err, Options> {
|
||||||
|
error: Interceptors<ErrInterceptor<Err, Res, Req, Options>>
|
||||||
|
request: Interceptors<ReqInterceptor<Req, Options>>
|
||||||
|
response: Interceptors<ResInterceptor<Res, Req, Options>>
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createInterceptors = <Req, Res, Err, Options>(): Middleware<Req, Res, Err, Options> => ({
|
||||||
|
error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(),
|
||||||
|
request: new Interceptors<ReqInterceptor<Req, Options>>(),
|
||||||
|
response: new Interceptors<ResInterceptor<Res, Req, Options>>(),
|
||||||
|
})
|
||||||
|
|
||||||
|
const defaultQuerySerializer = createQuerySerializer({
|
||||||
|
allowReserved: false,
|
||||||
|
array: {
|
||||||
|
explode: true,
|
||||||
|
style: "form",
|
||||||
|
},
|
||||||
|
object: {
|
||||||
|
explode: true,
|
||||||
|
style: "deepObject",
|
||||||
|
},
|
||||||
|
})
|
||||||
|
|
||||||
|
const defaultHeaders = {
|
||||||
|
"Content-Type": "application/json",
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createConfig = <T extends ClientOptions = ClientOptions>(
|
||||||
|
override: Config<Omit<ClientOptions, keyof T> & T> = {},
|
||||||
|
): Config<Omit<ClientOptions, keyof T> & T> => ({
|
||||||
|
...jsonBodySerializer,
|
||||||
|
headers: defaultHeaders,
|
||||||
|
parseAs: "auto",
|
||||||
|
querySerializer: defaultQuerySerializer,
|
||||||
|
...override,
|
||||||
|
})
|
||||||
41
packages/sdk/js/example/effect-sdk/gen/core/auth.gen.ts
Normal file
41
packages/sdk/js/example/effect-sdk/gen/core/auth.gen.ts
Normal file
|
|
@ -0,0 +1,41 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
export type AuthToken = string | undefined
|
||||||
|
|
||||||
|
export interface Auth {
|
||||||
|
/**
|
||||||
|
* Which part of the request do we use to send the auth?
|
||||||
|
*
|
||||||
|
* @default 'header'
|
||||||
|
*/
|
||||||
|
in?: "header" | "query" | "cookie"
|
||||||
|
/**
|
||||||
|
* Header or query parameter name.
|
||||||
|
*
|
||||||
|
* @default 'Authorization'
|
||||||
|
*/
|
||||||
|
name?: string
|
||||||
|
scheme?: "basic" | "bearer"
|
||||||
|
type: "apiKey" | "http"
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getAuthToken = async (
|
||||||
|
auth: Auth,
|
||||||
|
callback: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken,
|
||||||
|
): Promise<string | undefined> => {
|
||||||
|
const token = typeof callback === "function" ? await callback(auth) : callback
|
||||||
|
|
||||||
|
if (!token) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
|
||||||
|
if (auth.scheme === "bearer") {
|
||||||
|
return `Bearer ${token}`
|
||||||
|
}
|
||||||
|
|
||||||
|
if (auth.scheme === "basic") {
|
||||||
|
return `Basic ${btoa(token)}`
|
||||||
|
}
|
||||||
|
|
||||||
|
return token
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,82 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import type { ArrayStyle, ObjectStyle, SerializerOptions } from "./pathSerializer.gen.js"
|
||||||
|
|
||||||
|
export type QuerySerializer = (query: Record<string, unknown>) => string
|
||||||
|
|
||||||
|
export type BodySerializer = (body: any) => any
|
||||||
|
|
||||||
|
type QuerySerializerOptionsObject = {
|
||||||
|
allowReserved?: boolean
|
||||||
|
array?: Partial<SerializerOptions<ArrayStyle>>
|
||||||
|
object?: Partial<SerializerOptions<ObjectStyle>>
|
||||||
|
}
|
||||||
|
|
||||||
|
export type QuerySerializerOptions = QuerySerializerOptionsObject & {
|
||||||
|
/**
|
||||||
|
* Per-parameter serialization overrides. When provided, these settings
|
||||||
|
* override the global array/object settings for specific parameter names.
|
||||||
|
*/
|
||||||
|
parameters?: Record<string, QuerySerializerOptionsObject>
|
||||||
|
}
|
||||||
|
|
||||||
|
const serializeFormDataPair = (data: FormData, key: string, value: unknown): void => {
|
||||||
|
if (typeof value === "string" || value instanceof Blob) {
|
||||||
|
data.append(key, value)
|
||||||
|
} else if (value instanceof Date) {
|
||||||
|
data.append(key, value.toISOString())
|
||||||
|
} else {
|
||||||
|
data.append(key, JSON.stringify(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const serializeUrlSearchParamsPair = (data: URLSearchParams, key: string, value: unknown): void => {
|
||||||
|
if (typeof value === "string") {
|
||||||
|
data.append(key, value)
|
||||||
|
} else {
|
||||||
|
data.append(key, JSON.stringify(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const formDataBodySerializer = {
|
||||||
|
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T): FormData => {
|
||||||
|
const data = new FormData()
|
||||||
|
|
||||||
|
Object.entries(body).forEach(([key, value]) => {
|
||||||
|
if (value === undefined || value === null) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
value.forEach((v) => serializeFormDataPair(data, key, v))
|
||||||
|
} else {
|
||||||
|
serializeFormDataPair(data, key, value)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return data
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
export const jsonBodySerializer = {
|
||||||
|
bodySerializer: <T>(body: T): string =>
|
||||||
|
JSON.stringify(body, (_key, value) => (typeof value === "bigint" ? value.toString() : value)),
|
||||||
|
}
|
||||||
|
|
||||||
|
export const urlSearchParamsBodySerializer = {
|
||||||
|
bodySerializer: <T extends Record<string, any> | Array<Record<string, any>>>(body: T): string => {
|
||||||
|
const data = new URLSearchParams()
|
||||||
|
|
||||||
|
Object.entries(body).forEach(([key, value]) => {
|
||||||
|
if (value === undefined || value === null) {
|
||||||
|
return
|
||||||
|
}
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
value.forEach((v) => serializeUrlSearchParamsPair(data, key, v))
|
||||||
|
} else {
|
||||||
|
serializeUrlSearchParamsPair(data, key, value)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|
||||||
|
return data.toString()
|
||||||
|
},
|
||||||
|
}
|
||||||
169
packages/sdk/js/example/effect-sdk/gen/core/params.gen.ts
Normal file
169
packages/sdk/js/example/effect-sdk/gen/core/params.gen.ts
Normal file
|
|
@ -0,0 +1,169 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
type Slot = "body" | "headers" | "path" | "query"
|
||||||
|
|
||||||
|
export type Field =
|
||||||
|
| {
|
||||||
|
in: Exclude<Slot, "body">
|
||||||
|
/**
|
||||||
|
* Field name. This is the name we want the user to see and use.
|
||||||
|
*/
|
||||||
|
key: string
|
||||||
|
/**
|
||||||
|
* Field mapped name. This is the name we want to use in the request.
|
||||||
|
* If omitted, we use the same value as `key`.
|
||||||
|
*/
|
||||||
|
map?: string
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
in: Extract<Slot, "body">
|
||||||
|
/**
|
||||||
|
* Key isn't required for bodies.
|
||||||
|
*/
|
||||||
|
key?: string
|
||||||
|
map?: string
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
/**
|
||||||
|
* Field name. This is the name we want the user to see and use.
|
||||||
|
*/
|
||||||
|
key: string
|
||||||
|
/**
|
||||||
|
* Field mapped name. This is the name we want to use in the request.
|
||||||
|
* If `in` is omitted, `map` aliases `key` to the transport layer.
|
||||||
|
*/
|
||||||
|
map: Slot
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface Fields {
|
||||||
|
allowExtra?: Partial<Record<Slot, boolean>>
|
||||||
|
args?: ReadonlyArray<Field>
|
||||||
|
}
|
||||||
|
|
||||||
|
export type FieldsConfig = ReadonlyArray<Field | Fields>
|
||||||
|
|
||||||
|
const extraPrefixesMap: Record<string, Slot> = {
|
||||||
|
$body_: "body",
|
||||||
|
$headers_: "headers",
|
||||||
|
$path_: "path",
|
||||||
|
$query_: "query",
|
||||||
|
}
|
||||||
|
const extraPrefixes = Object.entries(extraPrefixesMap)
|
||||||
|
|
||||||
|
type KeyMap = Map<
|
||||||
|
string,
|
||||||
|
| {
|
||||||
|
in: Slot
|
||||||
|
map?: string
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
in?: never
|
||||||
|
map: Slot
|
||||||
|
}
|
||||||
|
>
|
||||||
|
|
||||||
|
const buildKeyMap = (fields: FieldsConfig, map?: KeyMap): KeyMap => {
|
||||||
|
if (!map) {
|
||||||
|
map = new Map()
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const config of fields) {
|
||||||
|
if ("in" in config) {
|
||||||
|
if (config.key) {
|
||||||
|
map.set(config.key, {
|
||||||
|
in: config.in,
|
||||||
|
map: config.map,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
} else if ("key" in config) {
|
||||||
|
map.set(config.key, {
|
||||||
|
map: config.map,
|
||||||
|
})
|
||||||
|
} else if (config.args) {
|
||||||
|
buildKeyMap(config.args, map)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return map
|
||||||
|
}
|
||||||
|
|
||||||
|
interface Params {
|
||||||
|
body: unknown
|
||||||
|
headers: Record<string, unknown>
|
||||||
|
path: Record<string, unknown>
|
||||||
|
query: Record<string, unknown>
|
||||||
|
}
|
||||||
|
|
||||||
|
const stripEmptySlots = (params: Params) => {
|
||||||
|
for (const [slot, value] of Object.entries(params)) {
|
||||||
|
if (value && typeof value === "object" && !Object.keys(value).length) {
|
||||||
|
delete params[slot as Slot]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const buildClientParams = (args: ReadonlyArray<unknown>, fields: FieldsConfig) => {
|
||||||
|
const params: Params = {
|
||||||
|
body: {},
|
||||||
|
headers: {},
|
||||||
|
path: {},
|
||||||
|
query: {},
|
||||||
|
}
|
||||||
|
|
||||||
|
const map = buildKeyMap(fields)
|
||||||
|
|
||||||
|
let config: FieldsConfig[number] | undefined
|
||||||
|
|
||||||
|
for (const [index, arg] of args.entries()) {
|
||||||
|
if (fields[index]) {
|
||||||
|
config = fields[index]
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!config) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if ("in" in config) {
|
||||||
|
if (config.key) {
|
||||||
|
const field = map.get(config.key)!
|
||||||
|
const name = field.map || config.key
|
||||||
|
if (field.in) {
|
||||||
|
;(params[field.in] as Record<string, unknown>)[name] = arg
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
params.body = arg
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
for (const [key, value] of Object.entries(arg ?? {})) {
|
||||||
|
const field = map.get(key)
|
||||||
|
|
||||||
|
if (field) {
|
||||||
|
if (field.in) {
|
||||||
|
const name = field.map || key
|
||||||
|
;(params[field.in] as Record<string, unknown>)[name] = value
|
||||||
|
} else {
|
||||||
|
params[field.map] = value
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
const extra = extraPrefixes.find(([prefix]) => key.startsWith(prefix))
|
||||||
|
|
||||||
|
if (extra) {
|
||||||
|
const [prefix, slot] = extra
|
||||||
|
;(params[slot] as Record<string, unknown>)[key.slice(prefix.length)] = value
|
||||||
|
} else if ("allowExtra" in config && config.allowExtra) {
|
||||||
|
for (const [slot, allowed] of Object.entries(config.allowExtra)) {
|
||||||
|
if (allowed) {
|
||||||
|
;(params[slot as Slot] as Record<string, unknown>)[key] = value
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
stripEmptySlots(params)
|
||||||
|
|
||||||
|
return params
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,167 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
interface SerializeOptions<T> extends SerializePrimitiveOptions, SerializerOptions<T> {}
|
||||||
|
|
||||||
|
interface SerializePrimitiveOptions {
|
||||||
|
allowReserved?: boolean
|
||||||
|
name: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SerializerOptions<T> {
|
||||||
|
/**
|
||||||
|
* @default true
|
||||||
|
*/
|
||||||
|
explode: boolean
|
||||||
|
style: T
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ArrayStyle = "form" | "spaceDelimited" | "pipeDelimited"
|
||||||
|
export type ArraySeparatorStyle = ArrayStyle | MatrixStyle
|
||||||
|
type MatrixStyle = "label" | "matrix" | "simple"
|
||||||
|
export type ObjectStyle = "form" | "deepObject"
|
||||||
|
type ObjectSeparatorStyle = ObjectStyle | MatrixStyle
|
||||||
|
|
||||||
|
interface SerializePrimitiveParam extends SerializePrimitiveOptions {
|
||||||
|
value: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export const separatorArrayExplode = (style: ArraySeparatorStyle) => {
|
||||||
|
switch (style) {
|
||||||
|
case "label":
|
||||||
|
return "."
|
||||||
|
case "matrix":
|
||||||
|
return ";"
|
||||||
|
case "simple":
|
||||||
|
return ","
|
||||||
|
default:
|
||||||
|
return "&"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const separatorArrayNoExplode = (style: ArraySeparatorStyle) => {
|
||||||
|
switch (style) {
|
||||||
|
case "form":
|
||||||
|
return ","
|
||||||
|
case "pipeDelimited":
|
||||||
|
return "|"
|
||||||
|
case "spaceDelimited":
|
||||||
|
return "%20"
|
||||||
|
default:
|
||||||
|
return ","
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const separatorObjectExplode = (style: ObjectSeparatorStyle) => {
|
||||||
|
switch (style) {
|
||||||
|
case "label":
|
||||||
|
return "."
|
||||||
|
case "matrix":
|
||||||
|
return ";"
|
||||||
|
case "simple":
|
||||||
|
return ","
|
||||||
|
default:
|
||||||
|
return "&"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export const serializeArrayParam = ({
|
||||||
|
allowReserved,
|
||||||
|
explode,
|
||||||
|
name,
|
||||||
|
style,
|
||||||
|
value,
|
||||||
|
}: SerializeOptions<ArraySeparatorStyle> & {
|
||||||
|
value: unknown[]
|
||||||
|
}) => {
|
||||||
|
if (!explode) {
|
||||||
|
const joinedValues = (allowReserved ? value : value.map((v) => encodeURIComponent(v as string))).join(
|
||||||
|
separatorArrayNoExplode(style),
|
||||||
|
)
|
||||||
|
switch (style) {
|
||||||
|
case "label":
|
||||||
|
return `.${joinedValues}`
|
||||||
|
case "matrix":
|
||||||
|
return `;${name}=${joinedValues}`
|
||||||
|
case "simple":
|
||||||
|
return joinedValues
|
||||||
|
default:
|
||||||
|
return `${name}=${joinedValues}`
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const separator = separatorArrayExplode(style)
|
||||||
|
const joinedValues = value
|
||||||
|
.map((v) => {
|
||||||
|
if (style === "label" || style === "simple") {
|
||||||
|
return allowReserved ? v : encodeURIComponent(v as string)
|
||||||
|
}
|
||||||
|
|
||||||
|
return serializePrimitiveParam({
|
||||||
|
allowReserved,
|
||||||
|
name,
|
||||||
|
value: v as string,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.join(separator)
|
||||||
|
return style === "label" || style === "matrix" ? separator + joinedValues : joinedValues
|
||||||
|
}
|
||||||
|
|
||||||
|
export const serializePrimitiveParam = ({ allowReserved, name, value }: SerializePrimitiveParam) => {
|
||||||
|
if (value === undefined || value === null) {
|
||||||
|
return ""
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof value === "object") {
|
||||||
|
throw new Error(
|
||||||
|
"Deeply-nested arrays/objects aren’t supported. Provide your own `querySerializer()` to handle these.",
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return `${name}=${allowReserved ? value : encodeURIComponent(value)}`
|
||||||
|
}
|
||||||
|
|
||||||
|
export const serializeObjectParam = ({
|
||||||
|
allowReserved,
|
||||||
|
explode,
|
||||||
|
name,
|
||||||
|
style,
|
||||||
|
value,
|
||||||
|
valueOnly,
|
||||||
|
}: SerializeOptions<ObjectSeparatorStyle> & {
|
||||||
|
value: Record<string, unknown> | Date
|
||||||
|
valueOnly?: boolean
|
||||||
|
}) => {
|
||||||
|
if (value instanceof Date) {
|
||||||
|
return valueOnly ? value.toISOString() : `${name}=${value.toISOString()}`
|
||||||
|
}
|
||||||
|
|
||||||
|
if (style !== "deepObject" && !explode) {
|
||||||
|
let values: string[] = []
|
||||||
|
Object.entries(value).forEach(([key, v]) => {
|
||||||
|
values = [...values, key, allowReserved ? (v as string) : encodeURIComponent(v as string)]
|
||||||
|
})
|
||||||
|
const joinedValues = values.join(",")
|
||||||
|
switch (style) {
|
||||||
|
case "form":
|
||||||
|
return `${name}=${joinedValues}`
|
||||||
|
case "label":
|
||||||
|
return `.${joinedValues}`
|
||||||
|
case "matrix":
|
||||||
|
return `;${name}=${joinedValues}`
|
||||||
|
default:
|
||||||
|
return joinedValues
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const separator = separatorObjectExplode(style)
|
||||||
|
const joinedValues = Object.entries(value)
|
||||||
|
.map(([key, v]) =>
|
||||||
|
serializePrimitiveParam({
|
||||||
|
allowReserved,
|
||||||
|
name: style === "deepObject" ? `${name}[${key}]` : key,
|
||||||
|
value: v as string,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
.join(separator)
|
||||||
|
return style === "label" || style === "matrix" ? separator + joinedValues : joinedValues
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,111 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
/**
|
||||||
|
* JSON-friendly union that mirrors what Pinia Colada can hash.
|
||||||
|
*/
|
||||||
|
export type JsonValue = null | string | number | boolean | JsonValue[] | { [key: string]: JsonValue }
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Replacer that converts non-JSON values (bigint, Date, etc.) to safe substitutes.
|
||||||
|
*/
|
||||||
|
export const queryKeyJsonReplacer = (_key: string, value: unknown) => {
|
||||||
|
if (value === undefined || typeof value === "function" || typeof value === "symbol") {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
if (typeof value === "bigint") {
|
||||||
|
return value.toString()
|
||||||
|
}
|
||||||
|
if (value instanceof Date) {
|
||||||
|
return value.toISOString()
|
||||||
|
}
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Safely stringifies a value and parses it back into a JsonValue.
|
||||||
|
*/
|
||||||
|
export const stringifyToJsonValue = (input: unknown): JsonValue | undefined => {
|
||||||
|
try {
|
||||||
|
const json = JSON.stringify(input, queryKeyJsonReplacer)
|
||||||
|
if (json === undefined) {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
return JSON.parse(json) as JsonValue
|
||||||
|
} catch {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Detects plain objects (including objects with a null prototype).
|
||||||
|
*/
|
||||||
|
const isPlainObject = (value: unknown): value is Record<string, unknown> => {
|
||||||
|
if (value === null || typeof value !== "object") {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
const prototype = Object.getPrototypeOf(value as object)
|
||||||
|
return prototype === Object.prototype || prototype === null
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Turns URLSearchParams into a sorted JSON object for deterministic keys.
|
||||||
|
*/
|
||||||
|
const serializeSearchParams = (params: URLSearchParams): JsonValue => {
|
||||||
|
const entries = Array.from(params.entries()).sort(([a], [b]) => a.localeCompare(b))
|
||||||
|
const result: Record<string, JsonValue> = {}
|
||||||
|
|
||||||
|
for (const [key, value] of entries) {
|
||||||
|
const existing = result[key]
|
||||||
|
if (existing === undefined) {
|
||||||
|
result[key] = value
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(existing)) {
|
||||||
|
;(existing as string[]).push(value)
|
||||||
|
} else {
|
||||||
|
result[key] = [existing, value]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return result
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Normalizes any accepted value into a JSON-friendly shape for query keys.
|
||||||
|
*/
|
||||||
|
export const serializeQueryKeyValue = (value: unknown): JsonValue | undefined => {
|
||||||
|
if (value === null) {
|
||||||
|
return null
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof value === "string" || typeof value === "number" || typeof value === "boolean") {
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
if (value === undefined || typeof value === "function" || typeof value === "symbol") {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof value === "bigint") {
|
||||||
|
return value.toString()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (value instanceof Date) {
|
||||||
|
return value.toISOString()
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
return stringifyToJsonValue(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof URLSearchParams !== "undefined" && value instanceof URLSearchParams) {
|
||||||
|
return serializeSearchParams(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (isPlainObject(value)) {
|
||||||
|
return stringifyToJsonValue(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
@ -0,0 +1,239 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import type { Config } from "./types.gen.js"
|
||||||
|
|
||||||
|
export type ServerSentEventsOptions<TData = unknown> = Omit<RequestInit, "method"> &
|
||||||
|
Pick<Config, "method" | "responseTransformer" | "responseValidator"> & {
|
||||||
|
/**
|
||||||
|
* Fetch API implementation. You can use this option to provide a custom
|
||||||
|
* fetch instance.
|
||||||
|
*
|
||||||
|
* @default globalThis.fetch
|
||||||
|
*/
|
||||||
|
fetch?: typeof fetch
|
||||||
|
/**
|
||||||
|
* Implementing clients can call request interceptors inside this hook.
|
||||||
|
*/
|
||||||
|
onRequest?: (url: string, init: RequestInit) => Promise<Request>
|
||||||
|
/**
|
||||||
|
* Callback invoked when a network or parsing error occurs during streaming.
|
||||||
|
*
|
||||||
|
* This option applies only if the endpoint returns a stream of events.
|
||||||
|
*
|
||||||
|
* @param error The error that occurred.
|
||||||
|
*/
|
||||||
|
onSseError?: (error: unknown) => void
|
||||||
|
/**
|
||||||
|
* Callback invoked when an event is streamed from the server.
|
||||||
|
*
|
||||||
|
* This option applies only if the endpoint returns a stream of events.
|
||||||
|
*
|
||||||
|
* @param event Event streamed from the server.
|
||||||
|
* @returns Nothing (void).
|
||||||
|
*/
|
||||||
|
onSseEvent?: (event: StreamEvent<TData>) => void
|
||||||
|
serializedBody?: RequestInit["body"]
|
||||||
|
/**
|
||||||
|
* Default retry delay in milliseconds.
|
||||||
|
*
|
||||||
|
* This option applies only if the endpoint returns a stream of events.
|
||||||
|
*
|
||||||
|
* @default 3000
|
||||||
|
*/
|
||||||
|
sseDefaultRetryDelay?: number
|
||||||
|
/**
|
||||||
|
* Maximum number of retry attempts before giving up.
|
||||||
|
*/
|
||||||
|
sseMaxRetryAttempts?: number
|
||||||
|
/**
|
||||||
|
* Maximum retry delay in milliseconds.
|
||||||
|
*
|
||||||
|
* Applies only when exponential backoff is used.
|
||||||
|
*
|
||||||
|
* This option applies only if the endpoint returns a stream of events.
|
||||||
|
*
|
||||||
|
* @default 30000
|
||||||
|
*/
|
||||||
|
sseMaxRetryDelay?: number
|
||||||
|
/**
|
||||||
|
* Optional sleep function for retry backoff.
|
||||||
|
*
|
||||||
|
* Defaults to using `setTimeout`.
|
||||||
|
*/
|
||||||
|
sseSleepFn?: (ms: number) => Promise<void>
|
||||||
|
url: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface StreamEvent<TData = unknown> {
|
||||||
|
data: TData
|
||||||
|
event?: string
|
||||||
|
id?: string
|
||||||
|
retry?: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ServerSentEventsResult<TData = unknown, TReturn = void, TNext = unknown> = {
|
||||||
|
stream: AsyncGenerator<TData extends Record<string, unknown> ? TData[keyof TData] : TData, TReturn, TNext>
|
||||||
|
}
|
||||||
|
|
||||||
|
export const createSseClient = <TData = unknown>({
|
||||||
|
onRequest,
|
||||||
|
onSseError,
|
||||||
|
onSseEvent,
|
||||||
|
responseTransformer,
|
||||||
|
responseValidator,
|
||||||
|
sseDefaultRetryDelay,
|
||||||
|
sseMaxRetryAttempts,
|
||||||
|
sseMaxRetryDelay,
|
||||||
|
sseSleepFn,
|
||||||
|
url,
|
||||||
|
...options
|
||||||
|
}: ServerSentEventsOptions): ServerSentEventsResult<TData> => {
|
||||||
|
let lastEventId: string | undefined
|
||||||
|
|
||||||
|
const sleep = sseSleepFn ?? ((ms: number) => new Promise((resolve) => setTimeout(resolve, ms)))
|
||||||
|
|
||||||
|
const createStream = async function* () {
|
||||||
|
let retryDelay: number = sseDefaultRetryDelay ?? 3000
|
||||||
|
let attempt = 0
|
||||||
|
const signal = options.signal ?? new AbortController().signal
|
||||||
|
|
||||||
|
while (true) {
|
||||||
|
if (signal.aborted) break
|
||||||
|
|
||||||
|
attempt++
|
||||||
|
|
||||||
|
const headers =
|
||||||
|
options.headers instanceof Headers
|
||||||
|
? options.headers
|
||||||
|
: new Headers(options.headers as Record<string, string> | undefined)
|
||||||
|
|
||||||
|
if (lastEventId !== undefined) {
|
||||||
|
headers.set("Last-Event-ID", lastEventId)
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
const requestInit: RequestInit = {
|
||||||
|
redirect: "follow",
|
||||||
|
...options,
|
||||||
|
body: options.serializedBody,
|
||||||
|
headers,
|
||||||
|
signal,
|
||||||
|
}
|
||||||
|
let request = new Request(url, requestInit)
|
||||||
|
if (onRequest) {
|
||||||
|
request = await onRequest(url, requestInit)
|
||||||
|
}
|
||||||
|
// fetch must be assigned here, otherwise it would throw the error:
|
||||||
|
// TypeError: Failed to execute 'fetch' on 'Window': Illegal invocation
|
||||||
|
const _fetch = options.fetch ?? globalThis.fetch
|
||||||
|
const response = await _fetch(request)
|
||||||
|
|
||||||
|
if (!response.ok) throw new Error(`SSE failed: ${response.status} ${response.statusText}`)
|
||||||
|
|
||||||
|
if (!response.body) throw new Error("No body in SSE response")
|
||||||
|
|
||||||
|
const reader = response.body.pipeThrough(new TextDecoderStream()).getReader()
|
||||||
|
|
||||||
|
let buffer = ""
|
||||||
|
|
||||||
|
const abortHandler = () => {
|
||||||
|
try {
|
||||||
|
reader.cancel()
|
||||||
|
} catch {
|
||||||
|
// noop
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
signal.addEventListener("abort", abortHandler)
|
||||||
|
|
||||||
|
try {
|
||||||
|
while (true) {
|
||||||
|
const { done, value } = await reader.read()
|
||||||
|
if (done) break
|
||||||
|
buffer += value
|
||||||
|
// Normalize line endings: CRLF -> LF, then CR -> LF
|
||||||
|
buffer = buffer.replace(/\r\n/g, "\n").replace(/\r/g, "\n")
|
||||||
|
|
||||||
|
const chunks = buffer.split("\n\n")
|
||||||
|
buffer = chunks.pop() ?? ""
|
||||||
|
|
||||||
|
for (const chunk of chunks) {
|
||||||
|
const lines = chunk.split("\n")
|
||||||
|
const dataLines: Array<string> = []
|
||||||
|
let eventName: string | undefined
|
||||||
|
|
||||||
|
for (const line of lines) {
|
||||||
|
if (line.startsWith("data:")) {
|
||||||
|
dataLines.push(line.replace(/^data:\s*/, ""))
|
||||||
|
} else if (line.startsWith("event:")) {
|
||||||
|
eventName = line.replace(/^event:\s*/, "")
|
||||||
|
} else if (line.startsWith("id:")) {
|
||||||
|
lastEventId = line.replace(/^id:\s*/, "")
|
||||||
|
} else if (line.startsWith("retry:")) {
|
||||||
|
const parsed = Number.parseInt(line.replace(/^retry:\s*/, ""), 10)
|
||||||
|
if (!Number.isNaN(parsed)) {
|
||||||
|
retryDelay = parsed
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let data: unknown
|
||||||
|
let parsedJson = false
|
||||||
|
|
||||||
|
if (dataLines.length) {
|
||||||
|
const rawData = dataLines.join("\n")
|
||||||
|
try {
|
||||||
|
data = JSON.parse(rawData)
|
||||||
|
parsedJson = true
|
||||||
|
} catch {
|
||||||
|
data = rawData
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (parsedJson) {
|
||||||
|
if (responseValidator) {
|
||||||
|
await responseValidator(data)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (responseTransformer) {
|
||||||
|
data = await responseTransformer(data)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
onSseEvent?.({
|
||||||
|
data,
|
||||||
|
event: eventName,
|
||||||
|
id: lastEventId,
|
||||||
|
retry: retryDelay,
|
||||||
|
})
|
||||||
|
|
||||||
|
if (dataLines.length) {
|
||||||
|
yield data as any
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
} finally {
|
||||||
|
signal.removeEventListener("abort", abortHandler)
|
||||||
|
reader.releaseLock()
|
||||||
|
}
|
||||||
|
|
||||||
|
break // exit loop on normal completion
|
||||||
|
} catch (error) {
|
||||||
|
// connection failed or aborted; retry after delay
|
||||||
|
onSseError?.(error)
|
||||||
|
|
||||||
|
if (sseMaxRetryAttempts !== undefined && attempt >= sseMaxRetryAttempts) {
|
||||||
|
break // stop after firing error
|
||||||
|
}
|
||||||
|
|
||||||
|
// exponential backoff: double retry each attempt, cap at 30s
|
||||||
|
const backoff = Math.min(retryDelay * 2 ** (attempt - 1), sseMaxRetryDelay ?? 30000)
|
||||||
|
await sleep(backoff)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const stream = createStream()
|
||||||
|
|
||||||
|
return { stream }
|
||||||
|
}
|
||||||
86
packages/sdk/js/example/effect-sdk/gen/core/types.gen.ts
Normal file
86
packages/sdk/js/example/effect-sdk/gen/core/types.gen.ts
Normal file
|
|
@ -0,0 +1,86 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import type { Auth, AuthToken } from "./auth.gen.js"
|
||||||
|
import type { BodySerializer, QuerySerializer, QuerySerializerOptions } from "./bodySerializer.gen.js"
|
||||||
|
|
||||||
|
export type HttpMethod = "connect" | "delete" | "get" | "head" | "options" | "patch" | "post" | "put" | "trace"
|
||||||
|
|
||||||
|
export type Client<RequestFn = never, Config = unknown, MethodFn = never, BuildUrlFn = never, SseFn = never> = {
|
||||||
|
/**
|
||||||
|
* Returns the final request URL.
|
||||||
|
*/
|
||||||
|
buildUrl: BuildUrlFn
|
||||||
|
getConfig: () => Config
|
||||||
|
request: RequestFn
|
||||||
|
setConfig: (config: Config) => Config
|
||||||
|
} & {
|
||||||
|
[K in HttpMethod]: MethodFn
|
||||||
|
} & ([SseFn] extends [never] ? { sse?: never } : { sse: { [K in HttpMethod]: SseFn } })
|
||||||
|
|
||||||
|
export interface Config {
|
||||||
|
/**
|
||||||
|
* Auth token or a function returning auth token. The resolved value will be
|
||||||
|
* added to the request payload as defined by its `security` array.
|
||||||
|
*/
|
||||||
|
auth?: ((auth: Auth) => Promise<AuthToken> | AuthToken) | AuthToken
|
||||||
|
/**
|
||||||
|
* A function for serializing request body parameter. By default,
|
||||||
|
* {@link JSON.stringify()} will be used.
|
||||||
|
*/
|
||||||
|
bodySerializer?: BodySerializer | null
|
||||||
|
/**
|
||||||
|
* An object containing any HTTP headers that you want to pre-populate your
|
||||||
|
* `Headers` object with.
|
||||||
|
*
|
||||||
|
* {@link https://developer.mozilla.org/docs/Web/API/Headers/Headers#init See more}
|
||||||
|
*/
|
||||||
|
headers?:
|
||||||
|
| RequestInit["headers"]
|
||||||
|
| Record<string, string | number | boolean | (string | number | boolean)[] | null | undefined | unknown>
|
||||||
|
/**
|
||||||
|
* The request method.
|
||||||
|
*
|
||||||
|
* {@link https://developer.mozilla.org/docs/Web/API/fetch#method See more}
|
||||||
|
*/
|
||||||
|
method?: Uppercase<HttpMethod>
|
||||||
|
/**
|
||||||
|
* A function for serializing request query parameters. By default, arrays
|
||||||
|
* will be exploded in form style, objects will be exploded in deepObject
|
||||||
|
* style, and reserved characters are percent-encoded.
|
||||||
|
*
|
||||||
|
* This method will have no effect if the native `paramsSerializer()` Axios
|
||||||
|
* API function is used.
|
||||||
|
*
|
||||||
|
* {@link https://swagger.io/docs/specification/serialization/#query View examples}
|
||||||
|
*/
|
||||||
|
querySerializer?: QuerySerializer | QuerySerializerOptions
|
||||||
|
/**
|
||||||
|
* A function validating request data. This is useful if you want to ensure
|
||||||
|
* the request conforms to the desired shape, so it can be safely sent to
|
||||||
|
* the server.
|
||||||
|
*/
|
||||||
|
requestValidator?: (data: unknown) => Promise<unknown>
|
||||||
|
/**
|
||||||
|
* A function transforming response data before it's returned. This is useful
|
||||||
|
* for post-processing data, e.g. converting ISO strings into Date objects.
|
||||||
|
*/
|
||||||
|
responseTransformer?: (data: unknown) => Promise<unknown>
|
||||||
|
/**
|
||||||
|
* A function validating response data. This is useful if you want to ensure
|
||||||
|
* the response conforms to the desired shape, so it can be safely passed to
|
||||||
|
* the transformers and returned to the user.
|
||||||
|
*/
|
||||||
|
responseValidator?: (data: unknown) => Promise<unknown>
|
||||||
|
}
|
||||||
|
|
||||||
|
type IsExactlyNeverOrNeverUndefined<T> = [T] extends [never]
|
||||||
|
? true
|
||||||
|
: [T] extends [never | undefined]
|
||||||
|
? [undefined] extends [T]
|
||||||
|
? false
|
||||||
|
: true
|
||||||
|
: false
|
||||||
|
|
||||||
|
export type OmitNever<T extends Record<string, unknown>> = {
|
||||||
|
[K in keyof T as IsExactlyNeverOrNeverUndefined<T[K]> extends true ? never : K]: T[K]
|
||||||
|
}
|
||||||
137
packages/sdk/js/example/effect-sdk/gen/core/utils.gen.ts
Normal file
137
packages/sdk/js/example/effect-sdk/gen/core/utils.gen.ts
Normal file
|
|
@ -0,0 +1,137 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
import type { BodySerializer, QuerySerializer } from "./bodySerializer.gen.js"
|
||||||
|
import {
|
||||||
|
type ArraySeparatorStyle,
|
||||||
|
serializeArrayParam,
|
||||||
|
serializeObjectParam,
|
||||||
|
serializePrimitiveParam,
|
||||||
|
} from "./pathSerializer.gen.js"
|
||||||
|
|
||||||
|
export interface PathSerializer {
|
||||||
|
path: Record<string, unknown>
|
||||||
|
url: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export const PATH_PARAM_RE = /\{[^{}]+\}/g
|
||||||
|
|
||||||
|
export const defaultPathSerializer = ({ path, url: _url }: PathSerializer) => {
|
||||||
|
let url = _url
|
||||||
|
const matches = _url.match(PATH_PARAM_RE)
|
||||||
|
if (matches) {
|
||||||
|
for (const match of matches) {
|
||||||
|
let explode = false
|
||||||
|
let name = match.substring(1, match.length - 1)
|
||||||
|
let style: ArraySeparatorStyle = "simple"
|
||||||
|
|
||||||
|
if (name.endsWith("*")) {
|
||||||
|
explode = true
|
||||||
|
name = name.substring(0, name.length - 1)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (name.startsWith(".")) {
|
||||||
|
name = name.substring(1)
|
||||||
|
style = "label"
|
||||||
|
} else if (name.startsWith(";")) {
|
||||||
|
name = name.substring(1)
|
||||||
|
style = "matrix"
|
||||||
|
}
|
||||||
|
|
||||||
|
const value = path[name]
|
||||||
|
|
||||||
|
if (value === undefined || value === null) {
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (Array.isArray(value)) {
|
||||||
|
url = url.replace(match, serializeArrayParam({ explode, name, style, value }))
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (typeof value === "object") {
|
||||||
|
url = url.replace(
|
||||||
|
match,
|
||||||
|
serializeObjectParam({
|
||||||
|
explode,
|
||||||
|
name,
|
||||||
|
style,
|
||||||
|
value: value as Record<string, unknown>,
|
||||||
|
valueOnly: true,
|
||||||
|
}),
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
if (style === "matrix") {
|
||||||
|
url = url.replace(
|
||||||
|
match,
|
||||||
|
`;${serializePrimitiveParam({
|
||||||
|
name,
|
||||||
|
value: value as string,
|
||||||
|
})}`,
|
||||||
|
)
|
||||||
|
continue
|
||||||
|
}
|
||||||
|
|
||||||
|
const replaceValue = encodeURIComponent(style === "label" ? `.${value as string}` : (value as string))
|
||||||
|
url = url.replace(match, replaceValue)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
return url
|
||||||
|
}
|
||||||
|
|
||||||
|
export const getUrl = ({
|
||||||
|
baseUrl,
|
||||||
|
path,
|
||||||
|
query,
|
||||||
|
querySerializer,
|
||||||
|
url: _url,
|
||||||
|
}: {
|
||||||
|
baseUrl?: string
|
||||||
|
path?: Record<string, unknown>
|
||||||
|
query?: Record<string, unknown>
|
||||||
|
querySerializer: QuerySerializer
|
||||||
|
url: string
|
||||||
|
}) => {
|
||||||
|
const pathUrl = _url.startsWith("/") ? _url : `/${_url}`
|
||||||
|
let url = (baseUrl ?? "") + pathUrl
|
||||||
|
if (path) {
|
||||||
|
url = defaultPathSerializer({ path, url })
|
||||||
|
}
|
||||||
|
let search = query ? querySerializer(query) : ""
|
||||||
|
if (search.startsWith("?")) {
|
||||||
|
search = search.substring(1)
|
||||||
|
}
|
||||||
|
if (search) {
|
||||||
|
url += `?${search}`
|
||||||
|
}
|
||||||
|
return url
|
||||||
|
}
|
||||||
|
|
||||||
|
export function getValidRequestBody(options: {
|
||||||
|
body?: unknown
|
||||||
|
bodySerializer?: BodySerializer | null
|
||||||
|
serializedBody?: unknown
|
||||||
|
}) {
|
||||||
|
const hasBody = options.body !== undefined
|
||||||
|
const isSerializedBody = hasBody && options.bodySerializer
|
||||||
|
|
||||||
|
if (isSerializedBody) {
|
||||||
|
if ("serializedBody" in options) {
|
||||||
|
const hasSerializedBody = options.serializedBody !== undefined && options.serializedBody !== ""
|
||||||
|
|
||||||
|
return hasSerializedBody ? options.serializedBody : null
|
||||||
|
}
|
||||||
|
|
||||||
|
// not all clients implement a serializedBody property (i.e. client-axios)
|
||||||
|
return options.body !== "" ? options.body : null
|
||||||
|
}
|
||||||
|
|
||||||
|
// plain/text body
|
||||||
|
if (hasBody) {
|
||||||
|
return options.body
|
||||||
|
}
|
||||||
|
|
||||||
|
// no body was provided
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
94
packages/sdk/js/example/effect-sdk/gen/effect.gen.ts
Normal file
94
packages/sdk/js/example/effect-sdk/gen/effect.gen.ts
Normal file
|
|
@ -0,0 +1,94 @@
|
||||||
|
// This file is auto-generated by oagen. Do not edit.
|
||||||
|
|
||||||
|
import { Effect } from "effect"
|
||||||
|
import type { Client, Options, TDataShape } from "./client/index.js"
|
||||||
|
import type { ServerSentEventsResult } from "./core/serverSentEvents.gen.js"
|
||||||
|
import type {
|
||||||
|
CreateProjectTaskData,
|
||||||
|
CreateProjectTaskError,
|
||||||
|
CreateProjectTaskErrors,
|
||||||
|
CreateProjectTaskResponse,
|
||||||
|
CreateProjectTaskResponses,
|
||||||
|
ListProjectTasksData,
|
||||||
|
ListProjectTasksError,
|
||||||
|
ListProjectTasksErrors,
|
||||||
|
ListProjectTasksResponse,
|
||||||
|
ListProjectTasksResponses,
|
||||||
|
StreamProjectEventsData,
|
||||||
|
StreamProjectEventsResponse,
|
||||||
|
StreamProjectEventsResponses,
|
||||||
|
} from "./types.gen.js"
|
||||||
|
|
||||||
|
export type ExampleEffectOptions<TData extends TDataShape, TResponse> = Omit<
|
||||||
|
Options<TData, true, TResponse, "data">,
|
||||||
|
"responseStyle" | "throwOnError"
|
||||||
|
>
|
||||||
|
|
||||||
|
export interface ExampleEffectClient {
|
||||||
|
tasks: {
|
||||||
|
/**
|
||||||
|
* List tasks for a project.
|
||||||
|
*/
|
||||||
|
listProjectTasks(
|
||||||
|
options: ExampleEffectOptions<ListProjectTasksData, ListProjectTasksResponses>,
|
||||||
|
): Effect.Effect<ListProjectTasksResponse, ListProjectTasksError | Error>
|
||||||
|
/**
|
||||||
|
* Create a task in a project.
|
||||||
|
*/
|
||||||
|
createProjectTask(
|
||||||
|
options: ExampleEffectOptions<CreateProjectTaskData, CreateProjectTaskResponses>,
|
||||||
|
): Effect.Effect<CreateProjectTaskResponse, CreateProjectTaskError | Error>
|
||||||
|
}
|
||||||
|
events: {
|
||||||
|
/**
|
||||||
|
* Stream project events as server-sent events.
|
||||||
|
*/
|
||||||
|
streamProjectEvents(
|
||||||
|
options: ExampleEffectOptions<StreamProjectEventsData, StreamProjectEventsResponses>,
|
||||||
|
): Effect.Effect<ServerSentEventsResult<StreamProjectEventsResponses>, Error>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createExampleEffectClient(client: Client): ExampleEffectClient {
|
||||||
|
return {
|
||||||
|
tasks: {
|
||||||
|
listProjectTasks: (options) =>
|
||||||
|
request<ListProjectTasksResponse, ListProjectTasksError>(() =>
|
||||||
|
client.get<ListProjectTasksResponses, ListProjectTasksErrors, true, "data">({
|
||||||
|
url: "/projects/{projectId}/tasks",
|
||||||
|
...options,
|
||||||
|
throwOnError: true,
|
||||||
|
responseStyle: "data",
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
createProjectTask: (options) =>
|
||||||
|
request<CreateProjectTaskResponse, CreateProjectTaskError>(() =>
|
||||||
|
client.post<CreateProjectTaskResponses, CreateProjectTaskErrors, true, "data">({
|
||||||
|
url: "/projects/{projectId}/tasks",
|
||||||
|
...options,
|
||||||
|
throwOnError: true,
|
||||||
|
responseStyle: "data",
|
||||||
|
headers: { "Content-Type": "application/json", ...options?.headers },
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
events: {
|
||||||
|
streamProjectEvents: (options) =>
|
||||||
|
request<ServerSentEventsResult<StreamProjectEventsResponses>, never>(() =>
|
||||||
|
client.sse.get<StreamProjectEventsResponses, unknown, true, "data">({
|
||||||
|
url: "/projects/{projectId}/events",
|
||||||
|
...options,
|
||||||
|
throwOnError: true,
|
||||||
|
responseStyle: "data",
|
||||||
|
}),
|
||||||
|
),
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function request<T, E>(evaluate: () => Promise<T>) {
|
||||||
|
return Effect.tryPromise({
|
||||||
|
try: evaluate,
|
||||||
|
catch: (error) => error as E | Error,
|
||||||
|
})
|
||||||
|
}
|
||||||
93
packages/sdk/js/example/effect-sdk/gen/types.gen.ts
Normal file
93
packages/sdk/js/example/effect-sdk/gen/types.gen.ts
Normal file
|
|
@ -0,0 +1,93 @@
|
||||||
|
// This file is auto-generated by @hey-api/openapi-ts
|
||||||
|
|
||||||
|
export type ClientOptions = {
|
||||||
|
baseUrl: `${string}://${string}` | (string & {})
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ApiError = {
|
||||||
|
message: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CreateTaskRequest = {
|
||||||
|
title: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type Task = {
|
||||||
|
id: string
|
||||||
|
title: string
|
||||||
|
status: "open" | "closed"
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ListProjectTasksData = {
|
||||||
|
body?: never
|
||||||
|
path: {
|
||||||
|
projectId: string
|
||||||
|
}
|
||||||
|
query?: {
|
||||||
|
status?: "open" | "closed"
|
||||||
|
}
|
||||||
|
url: "/projects/{projectId}/tasks"
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ListProjectTasksErrors = {
|
||||||
|
/**
|
||||||
|
* Project not found.
|
||||||
|
*/
|
||||||
|
404: ApiError
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ListProjectTasksError = ListProjectTasksErrors[keyof ListProjectTasksErrors]
|
||||||
|
|
||||||
|
export type ListProjectTasksResponses = {
|
||||||
|
/**
|
||||||
|
* Task list.
|
||||||
|
*/
|
||||||
|
200: Array<Task>
|
||||||
|
}
|
||||||
|
|
||||||
|
export type ListProjectTasksResponse = ListProjectTasksResponses[keyof ListProjectTasksResponses]
|
||||||
|
|
||||||
|
export type CreateProjectTaskData = {
|
||||||
|
body: CreateTaskRequest
|
||||||
|
path: {
|
||||||
|
projectId: string
|
||||||
|
}
|
||||||
|
query?: never
|
||||||
|
url: "/projects/{projectId}/tasks"
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CreateProjectTaskErrors = {
|
||||||
|
/**
|
||||||
|
* Invalid task.
|
||||||
|
*/
|
||||||
|
400: ApiError
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CreateProjectTaskError = CreateProjectTaskErrors[keyof CreateProjectTaskErrors]
|
||||||
|
|
||||||
|
export type CreateProjectTaskResponses = {
|
||||||
|
/**
|
||||||
|
* Created task.
|
||||||
|
*/
|
||||||
|
201: Task
|
||||||
|
}
|
||||||
|
|
||||||
|
export type CreateProjectTaskResponse = CreateProjectTaskResponses[keyof CreateProjectTaskResponses]
|
||||||
|
|
||||||
|
export type StreamProjectEventsData = {
|
||||||
|
body?: never
|
||||||
|
path: {
|
||||||
|
projectId: string
|
||||||
|
}
|
||||||
|
query?: never
|
||||||
|
url: "/projects/{projectId}/events"
|
||||||
|
}
|
||||||
|
|
||||||
|
export type StreamProjectEventsResponses = {
|
||||||
|
/**
|
||||||
|
* Event stream.
|
||||||
|
*/
|
||||||
|
200: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export type StreamProjectEventsResponse = StreamProjectEventsResponses[keyof StreamProjectEventsResponses]
|
||||||
174
packages/sdk/js/example/effect-sdk/openapi.json
Normal file
174
packages/sdk/js/example/effect-sdk/openapi.json
Normal file
|
|
@ -0,0 +1,174 @@
|
||||||
|
{
|
||||||
|
"openapi": "3.1.0",
|
||||||
|
"info": {
|
||||||
|
"title": "Example Effect SDK",
|
||||||
|
"version": "1.0.0"
|
||||||
|
},
|
||||||
|
"paths": {
|
||||||
|
"/projects/{projectId}/tasks": {
|
||||||
|
"get": {
|
||||||
|
"operationId": "listProjectTasks",
|
||||||
|
"tags": ["Tasks"],
|
||||||
|
"description": "List tasks for a project.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "projectId",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"name": "status",
|
||||||
|
"in": "query",
|
||||||
|
"required": false,
|
||||||
|
"schema": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["open", "closed"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Task list.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"type": "array",
|
||||||
|
"items": {
|
||||||
|
"$ref": "#/components/schemas/Task"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"404": {
|
||||||
|
"description": "Project not found.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/ApiError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"post": {
|
||||||
|
"operationId": "createProjectTask",
|
||||||
|
"tags": ["Tasks"],
|
||||||
|
"description": "Create a task in a project.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "projectId",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"requestBody": {
|
||||||
|
"required": true,
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/CreateTaskRequest"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"responses": {
|
||||||
|
"201": {
|
||||||
|
"description": "Created task.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/Task"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"400": {
|
||||||
|
"description": "Invalid task.",
|
||||||
|
"content": {
|
||||||
|
"application/json": {
|
||||||
|
"schema": {
|
||||||
|
"$ref": "#/components/schemas/ApiError"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"/projects/{projectId}/events": {
|
||||||
|
"get": {
|
||||||
|
"operationId": "streamProjectEvents",
|
||||||
|
"tags": ["Events"],
|
||||||
|
"description": "Stream project events as server-sent events.",
|
||||||
|
"parameters": [
|
||||||
|
{
|
||||||
|
"name": "projectId",
|
||||||
|
"in": "path",
|
||||||
|
"required": true,
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"responses": {
|
||||||
|
"200": {
|
||||||
|
"description": "Event stream.",
|
||||||
|
"content": {
|
||||||
|
"text/event-stream": {
|
||||||
|
"schema": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"components": {
|
||||||
|
"schemas": {
|
||||||
|
"ApiError": {
|
||||||
|
"type": "object",
|
||||||
|
"required": ["message"],
|
||||||
|
"properties": {
|
||||||
|
"message": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"CreateTaskRequest": {
|
||||||
|
"type": "object",
|
||||||
|
"required": ["title"],
|
||||||
|
"properties": {
|
||||||
|
"title": {
|
||||||
|
"type": "string"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"Task": {
|
||||||
|
"type": "object",
|
||||||
|
"required": ["id", "title", "status"],
|
||||||
|
"properties": {
|
||||||
|
"id": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"title": {
|
||||||
|
"type": "string"
|
||||||
|
},
|
||||||
|
"status": {
|
||||||
|
"type": "string",
|
||||||
|
"enum": ["open", "closed"]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
@ -11,9 +11,11 @@
|
||||||
"exports": {
|
"exports": {
|
||||||
".": "./src/index.ts",
|
".": "./src/index.ts",
|
||||||
"./client": "./src/client.ts",
|
"./client": "./src/client.ts",
|
||||||
|
"./effect": "./src/effect.ts",
|
||||||
"./server": "./src/server.ts",
|
"./server": "./src/server.ts",
|
||||||
"./v2": "./src/v2/index.ts",
|
"./v2": "./src/v2/index.ts",
|
||||||
"./v2/client": "./src/v2/client.ts",
|
"./v2/client": "./src/v2/client.ts",
|
||||||
|
"./v2/effect": "./src/v2/effect.ts",
|
||||||
"./v2/gen/client": "./src/v2/gen/client/index.ts",
|
"./v2/gen/client": "./src/v2/gen/client/index.ts",
|
||||||
"./v2/server": "./src/v2/server.ts"
|
"./v2/server": "./src/v2/server.ts"
|
||||||
},
|
},
|
||||||
|
|
@ -25,10 +27,12 @@
|
||||||
"@tsconfig/node22": "catalog:",
|
"@tsconfig/node22": "catalog:",
|
||||||
"@types/cross-spawn": "catalog:",
|
"@types/cross-spawn": "catalog:",
|
||||||
"@types/node": "catalog:",
|
"@types/node": "catalog:",
|
||||||
|
"@workos/oagen": "0.21.1",
|
||||||
"@typescript/native-preview": "catalog:",
|
"@typescript/native-preview": "catalog:",
|
||||||
"typescript": "catalog:"
|
"typescript": "catalog:"
|
||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"cross-spawn": "catalog:"
|
"cross-spawn": "catalog:",
|
||||||
|
"effect": "catalog:"
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
|
||||||
|
|
@ -8,6 +8,8 @@ import { $ } from "bun"
|
||||||
import path from "path"
|
import path from "path"
|
||||||
|
|
||||||
import { createClient } from "@hey-api/openapi-ts"
|
import { createClient } from "@hey-api/openapi-ts"
|
||||||
|
import { generateFiles, parseSpec } from "@workos/oagen"
|
||||||
|
import { effectEmitter } from "./effect-emitter.js"
|
||||||
|
|
||||||
const opencode = path.resolve(dir, "../../opencode")
|
const opencode = path.resolve(dir, "../../opencode")
|
||||||
|
|
||||||
|
|
@ -40,26 +42,96 @@ await createClient({
|
||||||
],
|
],
|
||||||
})
|
})
|
||||||
|
|
||||||
// Patch a @hey-api/openapi-ts codegen bug: SseFn incorrectly passes the
|
await patchSseTypes("./src/v2/gen/client/types.gen.ts")
|
||||||
// endpoint's TError into the second generic of ServerSentEventsResult, which
|
|
||||||
// is the AsyncGenerator's TReturn slot. Iterator return values have nothing
|
const openapi = await Bun.file("./openapi.json").json()
|
||||||
// to do with HTTP errors, and any consumer that calls `.return()` or returns
|
const effect = generateFiles(await parseSpec("./openapi.json"), effectEmitter, {
|
||||||
// from a mock generator gets type-checked against the wrong shape. Drop the
|
namespace: "Opencode",
|
||||||
// arg so TReturn defaults to void.
|
outputDir: "./src/v2/gen",
|
||||||
const sseTypesPath = "./src/v2/gen/client/types.gen.ts"
|
emitterOptions: {
|
||||||
const sseTypesFile = Bun.file(sseTypesPath)
|
serverSentEvents: serverSentEvents(openapi),
|
||||||
const sseTypesSource = await sseTypesFile.text()
|
},
|
||||||
const sseTypesPatched = sseTypesSource.replace(
|
})
|
||||||
"=> Promise<ServerSentEventsResult<TData, TError>>",
|
for (const file of effect.files) {
|
||||||
"=> Promise<ServerSentEventsResult<TData>>",
|
await Bun.write(path.join("./src/v2/gen", file.path), file.content)
|
||||||
)
|
}
|
||||||
if (sseTypesPatched === sseTypesSource) {
|
|
||||||
throw new Error(`SseFn patch did not apply; @hey-api/openapi-ts output may have changed (${sseTypesPath})`)
|
await createClient({
|
||||||
|
input: "./example/effect-sdk/openapi.json",
|
||||||
|
output: {
|
||||||
|
path: "./example/effect-sdk/gen",
|
||||||
|
tsConfigPath: path.join(dir, "tsconfig.json"),
|
||||||
|
clean: true,
|
||||||
|
},
|
||||||
|
plugins: [
|
||||||
|
{
|
||||||
|
name: "@hey-api/typescript",
|
||||||
|
exportFromIndex: false,
|
||||||
|
},
|
||||||
|
{
|
||||||
|
name: "@hey-api/client-fetch",
|
||||||
|
exportFromIndex: false,
|
||||||
|
baseUrl: "https://api.example.com",
|
||||||
|
},
|
||||||
|
],
|
||||||
|
})
|
||||||
|
await patchSseTypes("./example/effect-sdk/gen/client/types.gen.ts")
|
||||||
|
|
||||||
|
const exampleOpenapi = await Bun.file("./example/effect-sdk/openapi.json").json()
|
||||||
|
const exampleEffect = generateFiles(await parseSpec("./example/effect-sdk/openapi.json"), effectEmitter, {
|
||||||
|
namespace: "Example",
|
||||||
|
outputDir: "./example/effect-sdk/gen",
|
||||||
|
emitterOptions: {
|
||||||
|
serverSentEvents: serverSentEvents(exampleOpenapi),
|
||||||
|
},
|
||||||
|
})
|
||||||
|
for (const file of exampleEffect.files) {
|
||||||
|
await Bun.write(path.join("./example/effect-sdk/gen", file.path), file.content)
|
||||||
}
|
}
|
||||||
await Bun.write(sseTypesPath, sseTypesPatched)
|
|
||||||
|
|
||||||
await $`bun prettier --write src/gen`
|
await $`bun prettier --write src/gen`
|
||||||
await $`bun prettier --write src/v2`
|
await $`bun prettier --write src/v2`
|
||||||
|
await $`bun prettier --write example/effect-sdk/gen`
|
||||||
await $`rm -rf dist`
|
await $`rm -rf dist`
|
||||||
await $`bun tsc`
|
await $`bun tsc`
|
||||||
await $`rm openapi.json`
|
await $`rm openapi.json`
|
||||||
|
|
||||||
|
async function patchSseTypes(sseTypesPath: string) {
|
||||||
|
// Patch a @hey-api/openapi-ts codegen bug: SseFn incorrectly passes the
|
||||||
|
// endpoint's TError into the second generic of ServerSentEventsResult, which
|
||||||
|
// is the AsyncGenerator's TReturn slot. Iterator return values have nothing
|
||||||
|
// to do with HTTP errors, and any consumer that calls `.return()` or returns
|
||||||
|
// from a mock generator gets type-checked against the wrong shape. Drop the
|
||||||
|
// arg so TReturn defaults to void.
|
||||||
|
const sseTypesFile = Bun.file(sseTypesPath)
|
||||||
|
const sseTypesSource = await sseTypesFile.text()
|
||||||
|
const sseTypesPatched = sseTypesSource.replace(
|
||||||
|
"=> Promise<ServerSentEventsResult<TData, TError>>",
|
||||||
|
"=> Promise<ServerSentEventsResult<TData>>",
|
||||||
|
)
|
||||||
|
if (sseTypesPatched === sseTypesSource) {
|
||||||
|
throw new Error(`SseFn patch did not apply; @hey-api/openapi-ts output may have changed (${sseTypesPath})`)
|
||||||
|
}
|
||||||
|
await Bun.write(sseTypesPath, sseTypesPatched)
|
||||||
|
}
|
||||||
|
|
||||||
|
function serverSentEvents(spec: unknown) {
|
||||||
|
if (!spec || typeof spec !== "object" || !("paths" in spec) || !spec.paths || typeof spec.paths !== "object")
|
||||||
|
return []
|
||||||
|
|
||||||
|
return Object.entries(spec.paths).flatMap(([route, value]) => {
|
||||||
|
if (!value || typeof value !== "object") return []
|
||||||
|
|
||||||
|
return Object.entries(value).flatMap(([method, operation]) => {
|
||||||
|
if (!operation || typeof operation !== "object" || !("responses" in operation)) return []
|
||||||
|
if (!hasEventStream(operation.responses)) return []
|
||||||
|
return [`${method.toUpperCase()} ${route}`]
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
function hasEventStream(value: unknown): boolean {
|
||||||
|
if (!value || typeof value !== "object") return false
|
||||||
|
if ("text/event-stream" in value) return true
|
||||||
|
return Object.values(value).some(hasEventStream)
|
||||||
|
}
|
||||||
|
|
|
||||||
212
packages/sdk/js/script/effect-emitter.ts
Normal file
212
packages/sdk/js/script/effect-emitter.ts
Normal file
|
|
@ -0,0 +1,212 @@
|
||||||
|
import type { ApiSpec, Emitter, EmitterContext, GeneratedFile, Operation, Service } from "@workos/oagen"
|
||||||
|
|
||||||
|
type EffectEmitterOptions = {
|
||||||
|
serverSentEvents?: string[]
|
||||||
|
}
|
||||||
|
|
||||||
|
export const effectEmitter: Emitter = {
|
||||||
|
language: "effect",
|
||||||
|
|
||||||
|
generateModels(): GeneratedFile[] {
|
||||||
|
return []
|
||||||
|
},
|
||||||
|
|
||||||
|
generateEnums(): GeneratedFile[] {
|
||||||
|
return []
|
||||||
|
},
|
||||||
|
|
||||||
|
generateResources(): GeneratedFile[] {
|
||||||
|
return []
|
||||||
|
},
|
||||||
|
|
||||||
|
generateClient(spec: ApiSpec, ctx: EmitterContext): GeneratedFile[] {
|
||||||
|
return [generateEffectClient(spec, ctx)]
|
||||||
|
},
|
||||||
|
|
||||||
|
generateErrors(): GeneratedFile[] {
|
||||||
|
return []
|
||||||
|
},
|
||||||
|
|
||||||
|
generateTests(): GeneratedFile[] {
|
||||||
|
return []
|
||||||
|
},
|
||||||
|
|
||||||
|
fileHeader() {
|
||||||
|
return "// This file is auto-generated by oagen. Do not edit."
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
function generateEffectClient(spec: ApiSpec, ctx: EmitterContext): GeneratedFile {
|
||||||
|
const sse = new Set((ctx.emitterOptions as EffectEmitterOptions | undefined)?.serverSentEvents ?? [])
|
||||||
|
const operations = spec.services.flatMap((service) => service.operations.map((operation) => ({ service, operation })))
|
||||||
|
const typeImports = operations.flatMap(({ operation }) => {
|
||||||
|
const type = operationType(operation)
|
||||||
|
if (operation.errors.length === 0) return [`${type}Data`, `${type}Response`, `${type}Responses`]
|
||||||
|
return [`${type}Data`, `${type}Error`, `${type}Errors`, `${type}Response`, `${type}Responses`]
|
||||||
|
})
|
||||||
|
|
||||||
|
return {
|
||||||
|
path: "effect.gen.ts",
|
||||||
|
content: [
|
||||||
|
`import { Effect } from "effect"`,
|
||||||
|
`import type { Client, Options, TDataShape } from "./client/index.js"`,
|
||||||
|
`import type { ServerSentEventsResult } from "./core/serverSentEvents.gen.js"`,
|
||||||
|
`import type {`,
|
||||||
|
...Array.from(new Set(typeImports))
|
||||||
|
.sort()
|
||||||
|
.map((name) => ` ${name},`),
|
||||||
|
`} from "./types.gen.js"`,
|
||||||
|
``,
|
||||||
|
`export type ${ctx.namespacePascal}EffectOptions<TData extends TDataShape, TResponse> = Omit<`,
|
||||||
|
` Options<TData, true, TResponse, "data">,`,
|
||||||
|
` "responseStyle" | "throwOnError"`,
|
||||||
|
`>`,
|
||||||
|
``,
|
||||||
|
`export interface ${ctx.namespacePascal}EffectClient {`,
|
||||||
|
...spec.services.flatMap((service) => serviceShape(service, sse, `${ctx.namespacePascal}EffectOptions`)),
|
||||||
|
`}`,
|
||||||
|
``,
|
||||||
|
`export function create${ctx.namespacePascal}EffectClient(client: Client): ${ctx.namespacePascal}EffectClient {`,
|
||||||
|
` return {`,
|
||||||
|
...spec.services.flatMap((service) => serviceFactory(service, sse)),
|
||||||
|
` }`,
|
||||||
|
`}`,
|
||||||
|
``,
|
||||||
|
`function request<T, E>(evaluate: () => Promise<T>) {`,
|
||||||
|
` return Effect.tryPromise({`,
|
||||||
|
` try: evaluate,`,
|
||||||
|
` catch: (error) => error as E | Error,`,
|
||||||
|
` })`,
|
||||||
|
`}`,
|
||||||
|
].join("\n"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function serviceShape(service: Service, sse: Set<string>, optionsType: string) {
|
||||||
|
return [
|
||||||
|
` ${propertyName(service.name)}: {`,
|
||||||
|
...service.operations.flatMap((operation) => [
|
||||||
|
doc(operation, " "),
|
||||||
|
` ${methodSignature(operation, sse, optionsType)}`,
|
||||||
|
]),
|
||||||
|
` }`,
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
function serviceFactory(service: Service, sse: Set<string>) {
|
||||||
|
return [
|
||||||
|
` ${propertyName(service.name)}: {`,
|
||||||
|
...service.operations.map(
|
||||||
|
(operation) => ` ${propertyName(operation.name)}: ${methodFactory(operation, sse)},`,
|
||||||
|
),
|
||||||
|
` },`,
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
function methodSignature(operation: Operation, sse: Set<string>, optionsType: string) {
|
||||||
|
const optional = hasRequiredOptions(operation) ? "" : "?"
|
||||||
|
return `${propertyName(operation.name)}(options${optional}: ${optionsType}<${operationType(
|
||||||
|
operation,
|
||||||
|
)}Data, ${operationType(operation)}Responses>): Effect.Effect<${operationResponse(operation, sse)}, ${operationError(
|
||||||
|
operation,
|
||||||
|
)}>`
|
||||||
|
}
|
||||||
|
|
||||||
|
function methodFactory(operation: Operation, sse: Set<string>) {
|
||||||
|
const type = operationType(operation)
|
||||||
|
const args = [
|
||||||
|
`url: ${JSON.stringify(operation.path)}`,
|
||||||
|
`...options`,
|
||||||
|
`throwOnError: true`,
|
||||||
|
`responseStyle: "data"`,
|
||||||
|
contentType(operation),
|
||||||
|
].filter((line): line is string => Boolean(line))
|
||||||
|
const request = isSse(operation, sse)
|
||||||
|
? `client.sse.${operation.httpMethod}<${type}Responses, ${operationErrorTypes(operation)}, true, "data">({ ${args.join(
|
||||||
|
", ",
|
||||||
|
)} })`
|
||||||
|
: `client.${operation.httpMethod}<${type}Responses, ${operationErrorTypes(operation)}, true, "data">({ ${args.join(
|
||||||
|
", ",
|
||||||
|
)} })`
|
||||||
|
return `(options${hasRequiredOptions(operation) ? "" : "?"}) => request<${operationResponse(
|
||||||
|
operation,
|
||||||
|
sse,
|
||||||
|
)}, ${operationErrorValue(operation)}>(() => ${request})`
|
||||||
|
}
|
||||||
|
|
||||||
|
function operationResponse(operation: Operation, sse: Set<string>) {
|
||||||
|
const type = operationType(operation)
|
||||||
|
if (isSse(operation, sse)) return `ServerSentEventsResult<${type}Responses>`
|
||||||
|
return `${type}Response`
|
||||||
|
}
|
||||||
|
|
||||||
|
function operationError(operation: Operation) {
|
||||||
|
if (operation.errors.length === 0) return "Error"
|
||||||
|
return `${operationType(operation)}Error | Error`
|
||||||
|
}
|
||||||
|
|
||||||
|
function operationErrorValue(operation: Operation) {
|
||||||
|
if (operation.errors.length === 0) return "never"
|
||||||
|
return `${operationType(operation)}Error`
|
||||||
|
}
|
||||||
|
|
||||||
|
function operationErrorTypes(operation: Operation) {
|
||||||
|
if (operation.errors.length === 0) return "unknown"
|
||||||
|
return `${operationType(operation)}Errors`
|
||||||
|
}
|
||||||
|
|
||||||
|
function contentType(operation: Operation) {
|
||||||
|
if (!operation.requestBody) return
|
||||||
|
const value = {
|
||||||
|
binary: "application/octet-stream",
|
||||||
|
json: "application/json",
|
||||||
|
text: "text/plain",
|
||||||
|
"form-urlencoded": "application/x-www-form-urlencoded",
|
||||||
|
"form-data": undefined,
|
||||||
|
}[operation.requestBodyEncoding ?? "json"]
|
||||||
|
if (!value) return
|
||||||
|
return `headers: { "Content-Type": ${JSON.stringify(value)}, ...options?.headers }`
|
||||||
|
}
|
||||||
|
|
||||||
|
function hasRequiredOptions(operation: Operation) {
|
||||||
|
return (
|
||||||
|
operation.pathParams.length > 0 ||
|
||||||
|
operation.queryParams.some((item) => item.required) ||
|
||||||
|
operation.headerParams.some((item) => item.required)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
function isSse(operation: Operation, sse: Set<string>) {
|
||||||
|
return sse.has(`${operation.httpMethod.toUpperCase()} ${operation.path}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
function operationType(operation: Operation) {
|
||||||
|
return identifier(operation.name)
|
||||||
|
}
|
||||||
|
|
||||||
|
function propertyName(value: string) {
|
||||||
|
return value.charAt(0).toLowerCase() + value.slice(1)
|
||||||
|
}
|
||||||
|
|
||||||
|
function identifier(value: string) {
|
||||||
|
return value
|
||||||
|
.replace(/([a-z0-9])([A-Z])/g, "$1 $2")
|
||||||
|
.replace(/[^A-Za-z0-9]+/g, " ")
|
||||||
|
.trim()
|
||||||
|
.split(/\s+/)
|
||||||
|
.filter(Boolean)
|
||||||
|
.map((part) => part.charAt(0).toUpperCase() + part.slice(1).toLowerCase())
|
||||||
|
.join("")
|
||||||
|
}
|
||||||
|
|
||||||
|
function doc(operation: Operation, indent: string) {
|
||||||
|
if (!operation.description) return `${indent}/** ${operation.httpMethod.toUpperCase()} ${operation.path} */`
|
||||||
|
return [
|
||||||
|
`${indent}/**`,
|
||||||
|
...operation.description
|
||||||
|
.replaceAll("*/", "* /")
|
||||||
|
.split("\n")
|
||||||
|
.map((line) => `${indent} * ${line}`),
|
||||||
|
`${indent} */`,
|
||||||
|
].join("\n")
|
||||||
|
}
|
||||||
1
packages/sdk/js/src/effect.ts
Normal file
1
packages/sdk/js/src/effect.ts
Normal file
|
|
@ -0,0 +1 @@
|
||||||
|
export * from "./v2/effect.js"
|
||||||
|
|
@ -4,7 +4,8 @@ import { createClient } from "./gen/client/client.gen.js"
|
||||||
import { type Config } from "./gen/client/types.gen.js"
|
import { type Config } from "./gen/client/types.gen.js"
|
||||||
import { OpencodeClient } from "./gen/sdk.gen.js"
|
import { OpencodeClient } from "./gen/sdk.gen.js"
|
||||||
import { wrapClientError } from "../error-interceptor.js"
|
import { wrapClientError } from "../error-interceptor.js"
|
||||||
export { type Config as OpencodeClientConfig, OpencodeClient }
|
export { OpencodeClient }
|
||||||
|
export type OpencodeClientConfig = Config & { directory?: string; experimental_workspaceID?: string }
|
||||||
|
|
||||||
function pick(value: string | null, fallback?: string, encode?: (value: string) => string) {
|
function pick(value: string | null, fallback?: string, encode?: (value: string) => string) {
|
||||||
if (!value) return
|
if (!value) return
|
||||||
|
|
@ -44,7 +45,7 @@ function rewrite(request: Request, values: { directory?: string; workspace?: str
|
||||||
return next
|
return next
|
||||||
}
|
}
|
||||||
|
|
||||||
export function createOpencodeClient(config?: Config & { directory?: string; experimental_workspaceID?: string }) {
|
export function createOpencodeFetchClient(config?: OpencodeClientConfig) {
|
||||||
if (!config?.fetch) {
|
if (!config?.fetch) {
|
||||||
const customFetch: any = (req: any) => {
|
const customFetch: any = (req: any) => {
|
||||||
// @ts-ignore
|
// @ts-ignore
|
||||||
|
|
@ -86,5 +87,9 @@ export function createOpencodeClient(config?: Config & { directory?: string; exp
|
||||||
return response
|
return response
|
||||||
})
|
})
|
||||||
client.interceptors.error.use(wrapClientError)
|
client.interceptors.error.use(wrapClientError)
|
||||||
return new OpencodeClient({ client })
|
return client
|
||||||
|
}
|
||||||
|
|
||||||
|
export function createOpencodeClient(config?: OpencodeClientConfig) {
|
||||||
|
return new OpencodeClient({ client: createOpencodeFetchClient(config) })
|
||||||
}
|
}
|
||||||
|
|
|
||||||
8
packages/sdk/js/src/v2/effect.ts
Normal file
8
packages/sdk/js/src/v2/effect.ts
Normal file
|
|
@ -0,0 +1,8 @@
|
||||||
|
export * from "./gen/effect.gen.js"
|
||||||
|
|
||||||
|
import { createOpencodeFetchClient, type OpencodeClientConfig } from "./client.js"
|
||||||
|
import { createOpencodeEffectClient as createGeneratedOpencodeEffectClient } from "./gen/effect.gen.js"
|
||||||
|
|
||||||
|
export function createOpencodeEffectClient(config?: OpencodeClientConfig) {
|
||||||
|
return createGeneratedOpencodeEffectClient(createOpencodeFetchClient(config))
|
||||||
|
}
|
||||||
3323
packages/sdk/js/src/v2/gen/effect.gen.ts
Normal file
3323
packages/sdk/js/src/v2/gen/effect.gen.ts
Normal file
File diff suppressed because it is too large
Load diff
Loading…
Add table
Add a link
Reference in a new issue