@brickkit/core 0.6.1 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +179 -72
- package/dist/chunks/client.d.ts +902 -0
- package/dist/chunks/client.d.ts.map +1 -0
- package/dist/chunks/effect.d.ts +574 -0
- package/dist/chunks/effect.d.ts.map +1 -0
- package/dist/chunks/effect.js +2912 -0
- package/dist/chunks/effect.js.map +1 -0
- package/dist/chunks/types.js +46 -0
- package/dist/chunks/types.js.map +1 -0
- package/dist/client.d.ts +2 -0
- package/dist/client.js +205 -0
- package/dist/client.js.map +1 -0
- package/dist/effect.d.ts +3 -0
- package/dist/effect.js +1 -0
- package/dist/index.d.ts +3 -347
- package/dist/index.js +53 -367
- package/dist/index.js.map +1 -1
- package/dist/pg.d.ts +4 -4
- package/dist/pg.d.ts.map +1 -1
- package/dist/pg.js +2 -2
- package/package.json +13 -10
- package/dist/chunks/errors.d.ts +0 -162
- package/dist/chunks/errors.d.ts.map +0 -1
- package/dist/chunks/errors.js +0 -177
- package/dist/chunks/errors.js.map +0 -1
- package/dist/chunks/rolldown-runtime.js +0 -13
- package/dist/contracts.d.ts +0 -2
- package/dist/contracts.js +0 -1
- package/dist/index.d.ts.map +0 -1
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
//#region src/types.ts
|
|
2
|
+
var ValidationError = class extends Error {
|
|
3
|
+
code = "VALIDATION_FAILED";
|
|
4
|
+
status;
|
|
5
|
+
errors;
|
|
6
|
+
constructor(message, errors = [], status = 400) {
|
|
7
|
+
super(message);
|
|
8
|
+
this.name = "ValidationError";
|
|
9
|
+
this.status = status;
|
|
10
|
+
this.errors = errors;
|
|
11
|
+
}
|
|
12
|
+
toJSON() {
|
|
13
|
+
return {
|
|
14
|
+
name: this.name,
|
|
15
|
+
code: this.code,
|
|
16
|
+
message: this.message,
|
|
17
|
+
status: this.status,
|
|
18
|
+
errors: this.errors
|
|
19
|
+
};
|
|
20
|
+
}
|
|
21
|
+
};
|
|
22
|
+
var ActionExecutionError = class extends Error {
|
|
23
|
+
code;
|
|
24
|
+
status;
|
|
25
|
+
details;
|
|
26
|
+
constructor(code, message, status = 400, details, options) {
|
|
27
|
+
super(message, options);
|
|
28
|
+
this.name = "ActionExecutionError";
|
|
29
|
+
this.code = code;
|
|
30
|
+
this.status = status;
|
|
31
|
+
this.details = details;
|
|
32
|
+
}
|
|
33
|
+
toJSON() {
|
|
34
|
+
return {
|
|
35
|
+
name: this.name,
|
|
36
|
+
code: this.code,
|
|
37
|
+
message: this.message,
|
|
38
|
+
status: this.status,
|
|
39
|
+
details: this.details
|
|
40
|
+
};
|
|
41
|
+
}
|
|
42
|
+
};
|
|
43
|
+
//#endregion
|
|
44
|
+
export { ValidationError as n, ActionExecutionError as t };
|
|
45
|
+
|
|
46
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","names":[],"sources":["../../src/types.ts"],"sourcesContent":["import type { ServicePlugin, ResourcePlugin } from \"./plugin\";\nimport type { TSchema, Static } from \"@sinclair/typebox\";\nimport type { BunSQLiteDatabase } from \"./db/sqlite\";\nimport type { DatabaseHandle } from \"./db/define\";\n\nexport interface Logger {\n info: (...args: any[]) => void;\n warn: (...args: any[]) => void;\n error: (...args: any[]) => void;\n debug: (...args: any[]) => void;\n}\n\n/**\n * Base framework context supplied to all service resolvers and action executions.\n */\nexport interface BaseContext<TDb = any> {\n request: Request;\n db: TDb;\n logger: Logger;\n traceId: string;\n requestId?: string;\n caller?: string;\n tenantId?: string;\n services?: Record<string, any>;\n metadata?: Record<string, unknown>;\n}\n\n/**\n * Default fallback service context for untyped or simple services.\n */\nexport interface DefaultServiceContext {\n user?: any;\n session?: any;\n [key: string]: any;\n}\n\n/**\n * The combined execution context: BaseContext & TServiceContext.\n */\nexport type ActionContext<\n TDb = any,\n TServiceContext = DefaultServiceContext,\n> = BaseContext<TDb> & TServiceContext;\n\n/**\n * Type utility that automatically narrows ctx.user from User | null to User\n * in execute() when authorize() is declared on the action.\n */\nexport type NarrowAuthorizedContext<TCtx> = TCtx extends { user: infer U }\n ? [U] extends [null | undefined]\n ? TCtx\n : Omit<TCtx, \"user\"> & { user: NonNullable<U> }\n : TCtx;\n\nexport interface ActionErrorDefinition {\n status?: number;\n message: string;\n}\n\nexport interface ValidationErrorItem {\n path: string;\n message: string;\n value?: unknown;\n type?: number;\n}\n\nexport class ValidationError extends Error {\n readonly code = \"VALIDATION_FAILED\";\n readonly status: number;\n readonly errors: ValidationErrorItem[];\n\n constructor(\n message: string,\n errors: ValidationErrorItem[] = [],\n status = 400,\n ) {\n super(message);\n this.name = \"ValidationError\";\n this.status = status;\n this.errors = errors;\n }\n\n toJSON() {\n return {\n name: this.name,\n code: this.code,\n message: this.message,\n status: this.status,\n errors: this.errors,\n };\n }\n}\n\nexport class ActionExecutionError extends Error {\n readonly code: string;\n readonly status: number;\n readonly details?: unknown;\n\n constructor(\n code: string,\n message: string,\n status = 400,\n details?: unknown,\n options?: ErrorOptions,\n ) {\n super(message, options);\n this.name = \"ActionExecutionError\";\n this.code = code;\n this.status = status;\n this.details = details;\n }\n\n toJSON() {\n return {\n name: this.name,\n code: this.code,\n message: this.message,\n status: this.status,\n details: this.details,\n };\n }\n}\n\nexport interface StandardErrorMap {\n BAD_REQUEST: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n UNAUTHORIZED: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n FORBIDDEN: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n NOT_FOUND: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n CONFLICT: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n INTERNAL_SERVER_ERROR: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n [key: string]:\n | ((\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never)\n | undefined;\n}\n\nexport type ErrorBuilder<\n TErrors extends Record<string, ActionErrorDefinition>,\n> = StandardErrorMap & {\n [K in keyof TErrors]: (\n overrideMessage?: string,\n details?: unknown,\n options?: ErrorOptions,\n ) => never;\n};\n\nexport interface BaseActionConfig<\n TInputSchema extends TSchema | undefined = undefined,\n TOutputSchema extends TSchema | undefined = undefined,\n TErrors extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n> {\n name: string;\n description?: string;\n /** Effective HTTP path, including the prefix; replaces the default action path. */\n path?: string;\n /** Single HTTP method exposed for this action (default POST). */\n method?: \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\";\n input?: TInputSchema;\n output?: TOutputSchema;\n errors?: TErrors;\n emits?: string[];\n tags?: string[];\n}\n\nexport interface ActionConfigWithAuthorize<\n TInputSchema extends TSchema | undefined = undefined,\n TOutputSchema extends TSchema | undefined = undefined,\n TErrors extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n TContext extends ActionContext = ActionContext,\n> extends BaseActionConfig<TInputSchema, TOutputSchema, TErrors> {\n authorize: (params: {\n user?: TContext extends { user: infer U } ? U : any;\n input: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx: TContext;\n }) => boolean | Promise<boolean>;\n execute: (params: {\n input: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx: NarrowAuthorizedContext<TContext>;\n error: ErrorBuilder<TErrors>;\n }) =>\n | Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>\n | (TOutputSchema extends TSchema ? Static<TOutputSchema> : any);\n}\n\nexport interface ActionConfigWithoutAuthorize<\n TInputSchema extends TSchema | undefined = undefined,\n TOutputSchema extends TSchema | undefined = undefined,\n TErrors extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n TContext extends ActionContext = ActionContext,\n> extends BaseActionConfig<TInputSchema, TOutputSchema, TErrors> {\n authorize?: undefined;\n execute: (params: {\n input: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx: TContext;\n error: ErrorBuilder<TErrors>;\n }) =>\n | Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>\n | (TOutputSchema extends TSchema ? Static<TOutputSchema> : any);\n}\n\nexport type ActionConfig<\n TInputSchema extends TSchema | undefined = any,\n TOutputSchema extends TSchema | undefined = any,\n TErrors extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n TContext extends ActionContext = ActionContext,\n> =\n | ActionConfigWithAuthorize<TInputSchema, TOutputSchema, TErrors, TContext>\n | ActionConfigWithoutAuthorize<\n TInputSchema,\n TOutputSchema,\n TErrors,\n TContext\n >;\n\nexport interface Action<\n TInputSchema extends TSchema | undefined = any,\n TOutputSchema extends TSchema | undefined = any,\n TErrors extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n TContext extends ActionContext = ActionContext,\n> {\n (params: {\n input?: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx?: Partial<TContext>;\n }): Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>;\n\n name: string;\n serviceName?: string;\n /** Owning plugin descriptor name for plugin actions (e.g. `@brickkit/crud`). */\n plugin?: string;\n /** Owning resource name for resource-plugin actions (e.g. `page`). */\n resource?: string;\n config: ActionConfig<TInputSchema, TOutputSchema, TErrors, TContext>;\n /**\n * Optional runtime-only output schema. When present, `validateOutput` and\n * HTTP output checking validate against it instead of `config.output`,\n * while `config.output` remains the published contract (client types,\n * OpenAPI). Lets projected/subset responses validate at runtime without\n * leaking optionality into the generated contract.\n */\n outputValidationSchema?: TSchema;\n run(\n input?: TInputSchema extends TSchema ? Static<TInputSchema> : any,\n ctx?: Partial<TContext>,\n ): Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>;\n execute(params: {\n input?: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx?: Partial<TContext>;\n }): Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>;\n executeResolved?(params: {\n input?: TInputSchema extends TSchema ? Static<TInputSchema> : any;\n ctx: TContext;\n }): Promise<TOutputSchema extends TSchema ? Static<TOutputSchema> : any>;\n validateInput(\n input: unknown,\n ):\n | { success: true; data: any }\n | { success: false; errors: ValidationErrorItem[] };\n validateOutput(\n output: unknown,\n ):\n | { success: true; data: any }\n | { success: false; errors: ValidationErrorItem[] };\n errorHelpers?: ErrorBuilder<TErrors>;\n}\n\n/** MCP tool metadata, kept with the executable definition. */\nexport interface ToolAnnotations {\n title?: string;\n readOnlyHint?: boolean;\n destructiveHint?: boolean;\n idempotentHint?: boolean;\n openWorldHint?: boolean;\n}\nexport interface ToolOptions {\n title?: string;\n annotations?: ToolAnnotations;\n /** Also register HTTP routes and OpenAPI. Defaults to false. */\n http?: boolean;\n}\nexport type ToolConfigWithAuthorize<\n I extends TSchema | undefined = undefined,\n O extends TSchema | undefined = undefined,\n E extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n C extends ActionContext = ActionContext,\n> = ActionConfigWithAuthorize<I, O, E, C> & ToolOptions;\nexport type ToolConfigWithoutAuthorize<\n I extends TSchema | undefined = undefined,\n O extends TSchema | undefined = undefined,\n E extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n C extends ActionContext = ActionContext,\n> = ActionConfigWithoutAuthorize<I, O, E, C> & ToolOptions;\nexport interface Tool<\n I extends TSchema | undefined = any,\n O extends TSchema | undefined = any,\n E extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n C extends ActionContext = ActionContext,\n> extends Action<I, O, E, C> {\n readonly kind: \"tool\";\n config:\n | ToolConfigWithAuthorize<I, O, E, C>\n | ToolConfigWithoutAuthorize<I, O, E, C>;\n}\n\n/** A resource declares identity and a table; plugins supply behavior. */\nexport interface ResourceConfig<TTable = any, _TCtx = any> {\n name: string;\n table: TTable;\n id?: import(\"drizzle-orm\").Column;\n}\n\nexport type InferTableRow<TTable> = TTable extends { $inferSelect: infer S }\n ? S\n : any;\nexport type InferTableInsert<TTable> = TTable extends { $inferInsert: infer S }\n ? S\n : any;\nexport type ResourceTypeOptions = Pick<ResourceConfig, \"name\" | \"id\">;\n\ntype PrimaryColumn<T> = T extends { _: { columns: infer C } }\n ? {\n [K in keyof C]: C[K] extends { _: { isPrimaryKey: true } } ? C[K] : never;\n }[keyof C]\n : import(\"drizzle-orm\").Column;\nexport type ResourceIdentity<T, O> = O & {\n id: O extends { id: infer I extends import(\"drizzle-orm\").Column }\n ? I\n : PrimaryColumn<T>;\n};\n\n/** Generic preparation declarations consumed by the application compiler. */\nexport interface PreparationContribution {\n readonly name: string;\n describe(): unknown;\n prepare(): void;\n}\n\nexport interface Resource<\n TTable = any,\n TCtx extends ActionContext = ActionContext,\n TOptions = {},\n> {\n use<\n P extends ResourcePlugin<\n Service<TCtx[\"db\"], Omit<TCtx, keyof BaseContext>>,\n this,\n any\n >,\n >(\n plugin: P,\n ): this & import(\"./plugin\").ResourcePluginAPI<P, TTable, TCtx, this>;\n readonly name: string;\n readonly serviceName: string;\n readonly table: TTable;\n readonly id: TOptions extends {\n id: infer I extends import(\"drizzle-orm\").Column;\n }\n ? I\n : import(\"drizzle-orm\").Column;\n readonly idField: string;\n readonly config: ResourceConfig<TTable, TCtx> & TOptions;\n}\n\nexport interface ServiceAuthOptions {\n requireAuth?: boolean;\n allowedRoles?: string[];\n policy?: (ctx: ActionContext) => boolean | Promise<boolean>;\n}\n\nexport interface RateLimitOptions {\n maxRequests: number;\n window: number | string;\n scope?: \"ip\" | \"user\" | \"tenant\";\n}\n\nexport interface CacheOptions {\n driver?: \"memory\" | \"redis\";\n defaultTtl?: number;\n}\n\nexport interface ResilienceOptions {\n timeoutMs?: number;\n retry?: {\n attempts: number;\n backoff: \"linear\" | \"exponential\";\n delayMs: number;\n };\n circuitBreaker?: {\n errorThresholdPercentage: number;\n resetTimeoutMs: number;\n };\n}\n\nexport interface TelemetryOptions {\n traceQueries?: boolean;\n auditLog?: boolean;\n tags?: Record<string, string>;\n}\n\nexport interface LifecycleOptions {\n onInit?: (ctx: { db?: any; logger?: Logger }) => Promise<void>;\n onDestroy?: () => Promise<void>;\n}\n\nexport interface ServiceOptions<\n TServiceContext extends Record<string, any> = Record<string, any>,\n TDb = any,\n> {\n database?: DatabaseHandle<TDb>;\n context?: (\n baseCtx: BaseContext<TDb> & { user?: unknown },\n ) => Promise<TServiceContext> | TServiceContext;\n auth?: ServiceAuthOptions;\n rateLimit?: RateLimitOptions;\n cache?: CacheOptions;\n resilience?: ResilienceOptions;\n telemetry?: TelemetryOptions;\n lifecycle?: LifecycleOptions;\n}\n\nexport type ActionAccessPolicy = \"public\" | \"authorized\" | \"scoped\";\n\nexport interface ActionSchema {\n name: string;\n /** Present only when this action has a registered HTTP route. */\n method?: \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\";\n path?: string;\n serviceName?: string;\n /** Owning plugin descriptor name for plugin actions (e.g. `@brickkit/crud`). */\n plugin?: string;\n /** Owning resource name for resource-plugin actions (e.g. `page`). */\n resource?: string;\n description?: string;\n inputSchema?: unknown;\n outputSchema?: unknown;\n hasAuthorize: boolean;\n hasScope?: boolean;\n accessPolicy?: ActionAccessPolicy;\n errors?: Record<string, ActionErrorDefinition>;\n emits?: string[];\n tags?: string[];\n}\n\nexport interface ServiceSchema {\n name: string;\n options: Omit<ServiceOptions, \"database\">;\n hasDatabase: boolean;\n databaseConfig?: {\n name?: string;\n engine: \"sqlite\" | \"postgres\";\n tables: string[];\n };\n actions: ActionSchema[];\n resources?: { name: string }[];\n}\n\nexport interface ArchitectureSchema {\n version: string;\n services: ServiceSchema[];\n}\n\nexport interface CompiledRoutePlan {\n service: Service<any, any>;\n action: Action<any, any, any, any>;\n actionName: string;\n serviceName: string;\n routePath: string;\n method?: string;\n isGetLike: boolean;\n hasInput: boolean;\n hasContextHook: boolean;\n contextHook?: (baseCtx: any) => Promise<any> | any;\n hasAuthorize: boolean;\n authorize?: (params: any) => boolean | Promise<boolean>;\n execute: (params: any) => Promise<any> | any;\n inputChecker?: {\n Check: (val: any) => boolean;\n Errors: (val: any) => Iterable<any>;\n };\n outputChecker?: {\n Check: (val: any) => boolean;\n Errors: (val: any) => Iterable<any>;\n };\n coercions?: Array<{ key: string; isNumber: boolean; isBoolean: boolean }>;\n logger: Logger;\n errorBuilder: any;\n cachedDb: any;\n}\n\nexport interface Service<\n TDb = BunSQLiteDatabase<Record<string, unknown>>,\n TServiceContext extends Record<string, any> = Record<string, any>,\n> {\n readonly name: string;\n readonly options: ServiceOptions<TServiceContext, TDb>;\n readonly actions: Map<string, Action<any, any, any, any>>;\n readonly tools: Map<string, Tool<any, any, any, any>>;\n readonly tables: Map<string, any>;\n readonly resources: Map<\n string,\n Resource<any, BaseContext<TDb> & TServiceContext>\n >;\n readonly db?: TDb;\n readonly isBuilt?: boolean;\n\n use<A>(plugin: ServicePlugin<this, A>): A;\n\n build(): this;\n\n action<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n action: Action<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>,\n ): this;\n\n action<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n config: ActionConfigWithAuthorize<\n TIn,\n TOut,\n TErr,\n BaseContext<TDb> & TServiceContext\n >,\n ): Action<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>;\n\n action<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n config: ActionConfigWithoutAuthorize<\n TIn,\n TOut,\n TErr,\n BaseContext<TDb> & TServiceContext\n >,\n ): Action<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>;\n\n tool<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n action: Tool<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>,\n ): this;\n\n tool<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n config: ToolConfigWithAuthorize<\n TIn,\n TOut,\n TErr,\n BaseContext<TDb> & TServiceContext\n >,\n ): Tool<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>;\n\n tool<\n TIn extends TSchema | undefined = undefined,\n TOut extends TSchema | undefined = undefined,\n TErr extends Record<string, ActionErrorDefinition> = Record<\n string,\n ActionErrorDefinition\n >,\n >(\n config: ToolConfigWithoutAuthorize<\n TIn,\n TOut,\n TErr,\n BaseContext<TDb> & TServiceContext\n >,\n ): Tool<TIn, TOut, TErr, BaseContext<TDb> & TServiceContext>;\n\n resource<\n TTable = any,\n const TOptions extends ResourceTypeOptions = ResourceTypeOptions,\n >(\n config: ResourceConfig<TTable, BaseContext<TDb> & TServiceContext> &\n TOptions &\n Record<Exclude<keyof TOptions, keyof ResourceConfig>, never>,\n ): Resource<\n TTable,\n BaseContext<TDb> & TServiceContext,\n ResourceIdentity<TTable, TOptions>\n >;\n\n readonly preparations: Map<string, PreparationContribution>;\n contributePreparation(contribution: PreparationContribution): void;\n listPreparations(): PreparationContribution[];\n prepareContributions(): void;\n registerTable(table: any): this;\n getAction(name: string): Action<any, any, any, any> | undefined;\n listActions(): Action<any, any, any, any>[];\n getTool(name: string): Tool<any, any, any, any> | undefined;\n listTools(): Tool<any, any, any, any>[];\n getResource(\n name: string,\n ): Resource<any, BaseContext<TDb> & TServiceContext> | undefined;\n listResources(): Resource<any, BaseContext<TDb> & TServiceContext>[];\n getDb(): TDb | undefined;\n setDb(database: DatabaseHandle<TDb>): void;\n /** The live handle, reflecting setDb swaps (options.database stays declared). */\n getDatabaseHandle(): DatabaseHandle<TDb> | undefined;\n resolveContext(\n callCtx?: Partial<BaseContext<TDb> & TServiceContext>,\n ): Promise<BaseContext<TDb> & TServiceContext>;\n introspect(): ServiceSchema;\n}\n\nexport interface ProxyOptions {\n isMonolith?: boolean;\n /** Name of the service creating this proxy. Populates ctx.caller on the target's envelope. */\n from?: string;\n context?: Partial<ActionContext>;\n}\n"],"mappings":";AAkEA,IAAa,kBAAb,cAAqC,MAAM;CACzC,OAAgB;CAChB;CACA;CAEA,YACE,SACA,SAAgC,CAAC,GACjC,SAAS,KACT;EACA,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,KAAK,SAAS;CAChB;CAEA,SAAS;EACP,OAAO;GACL,MAAM,KAAK;GACX,MAAM,KAAK;GACX,SAAS,KAAK;GACd,QAAQ,KAAK;GACb,QAAQ,KAAK;EACf;CACF;AACF;AAEA,IAAa,uBAAb,cAA0C,MAAM;CAC9C;CACA;CACA;CAEA,YACE,MACA,SACA,SAAS,KACT,SACA,SACA;EACA,MAAM,SAAS,OAAO;EACtB,KAAK,OAAO;EACZ,KAAK,OAAO;EACZ,KAAK,SAAS;EACd,KAAK,UAAU;CACjB;CAEA,SAAS;EACP,OAAO;GACL,MAAM,KAAK;GACX,MAAM,KAAK;GACX,SAAS,KAAK;GACd,QAAQ,KAAK;GACb,SAAS,KAAK;EAChB;CACF;AACF"}
|
package/dist/client.d.ts
ADDED
|
@@ -0,0 +1,2 @@
|
|
|
1
|
+
import { a as BrickClientOptions, c as InferActionErrorCodes, d as InferActionOutput, f as createBrickClient, i as BrickClientAction, l as InferActionFailure, m as isBrickTransportError, n as BrickCallOptions, o as BrickServerError, p as isBrickServerError, r as BrickClient, s as BrickTransportError, t as BrickActionCaller, u as InferActionInput } from "./chunks/client.js";
|
|
2
|
+
export { BrickActionCaller, BrickCallOptions, BrickClient, BrickClientAction, BrickClientOptions, BrickServerError, BrickTransportError, InferActionErrorCodes, InferActionFailure, InferActionInput, InferActionOutput, createBrickClient, isBrickServerError, isBrickTransportError };
|
package/dist/client.js
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
import { n as ValidationError, t as ActionExecutionError } from "./chunks/types.js";
|
|
2
|
+
//#region src/client.ts
|
|
3
|
+
/**
|
|
4
|
+
* The request never received a meaningful server answer: DNS / connection
|
|
5
|
+
* failure, a malformed body, or a 4xx response outside the declared contract
|
|
6
|
+
* (no `code` and no `ValidationError` shape).
|
|
7
|
+
*/
|
|
8
|
+
var BrickTransportError = class extends Error {
|
|
9
|
+
kind = "transport";
|
|
10
|
+
status;
|
|
11
|
+
url;
|
|
12
|
+
body;
|
|
13
|
+
cause;
|
|
14
|
+
constructor(message, opts) {
|
|
15
|
+
super(message);
|
|
16
|
+
this.name = "BrickTransportError";
|
|
17
|
+
this.status = opts.status;
|
|
18
|
+
this.url = opts.url;
|
|
19
|
+
this.body = opts.body;
|
|
20
|
+
this.cause = opts.cause;
|
|
21
|
+
}
|
|
22
|
+
};
|
|
23
|
+
/**
|
|
24
|
+
* The server answered 5xx without a declared `code` / `ValidationError` shape,
|
|
25
|
+
* i.e. an unexpected failure rather than a modelled domain error.
|
|
26
|
+
*/
|
|
27
|
+
var BrickServerError = class extends Error {
|
|
28
|
+
kind = "server";
|
|
29
|
+
status;
|
|
30
|
+
url;
|
|
31
|
+
body;
|
|
32
|
+
constructor(message, opts) {
|
|
33
|
+
super(message);
|
|
34
|
+
this.name = "BrickServerError";
|
|
35
|
+
this.status = opts.status;
|
|
36
|
+
this.url = opts.url;
|
|
37
|
+
this.body = opts.body;
|
|
38
|
+
}
|
|
39
|
+
};
|
|
40
|
+
function isBrickTransportError(err) {
|
|
41
|
+
return err instanceof BrickTransportError;
|
|
42
|
+
}
|
|
43
|
+
function isBrickServerError(err) {
|
|
44
|
+
return err instanceof BrickServerError;
|
|
45
|
+
}
|
|
46
|
+
function normalizeBaseUrl(baseUrl) {
|
|
47
|
+
const trimmed = baseUrl.replace(/\/+$/, "");
|
|
48
|
+
if (!trimmed) throw new Error("[Brick-TS client] `baseUrl` must not be empty.");
|
|
49
|
+
return trimmed;
|
|
50
|
+
}
|
|
51
|
+
function normalizePrefix(prefix) {
|
|
52
|
+
if (!prefix) return "/api";
|
|
53
|
+
const withLeading = prefix.startsWith("/") ? prefix : `/${prefix}`;
|
|
54
|
+
return withLeading.length > 1 ? withLeading.replace(/\/+$/, "") : withLeading;
|
|
55
|
+
}
|
|
56
|
+
function toQueryString(input) {
|
|
57
|
+
if (input == null || typeof input !== "object") return "";
|
|
58
|
+
const params = new URLSearchParams();
|
|
59
|
+
for (const [key, value] of Object.entries(input)) {
|
|
60
|
+
if (value === void 0 || value === null) continue;
|
|
61
|
+
if (Array.isArray(value)) for (const item of value) {
|
|
62
|
+
if (item === void 0 || item === null) continue;
|
|
63
|
+
params.append(key, typeof item === "object" ? JSON.stringify(item) : String(item));
|
|
64
|
+
}
|
|
65
|
+
else if (typeof value === "object") params.append(key, JSON.stringify(value));
|
|
66
|
+
else params.append(key, String(value));
|
|
67
|
+
}
|
|
68
|
+
const qs = params.toString();
|
|
69
|
+
return qs ? `?${qs}` : "";
|
|
70
|
+
}
|
|
71
|
+
function isActionValue(value) {
|
|
72
|
+
return typeof value === "function" && !!value.config && typeof value.config.execute === "function";
|
|
73
|
+
}
|
|
74
|
+
function isClientAction(value) {
|
|
75
|
+
return !!value && typeof value === "object" && value.kind === "action";
|
|
76
|
+
}
|
|
77
|
+
function planRequest(path, target, input, baseUrl, prefix) {
|
|
78
|
+
if (path.length === 0) throw new Error("[Brick-TS client] No action selected: call a leaf such as `api.page.list(input)`.");
|
|
79
|
+
const actionTarget = isActionValue(target) || isClientAction(target) ? target : void 0;
|
|
80
|
+
const actionConfig = actionTarget?.config;
|
|
81
|
+
if (path.length < 2) throw new Error(`[Brick-TS client] Cannot address '${path.join(".")}': custom actions need a service segment, e.g. \`api.${path[0]}.<action>(input)\`.`);
|
|
82
|
+
const service = typeof actionTarget?.serviceName === "string" && actionTarget.serviceName ? actionTarget.serviceName : path[0];
|
|
83
|
+
const action = typeof actionTarget?.name === "string" && actionTarget.name ? actionTarget.name : path.slice(1).join(".");
|
|
84
|
+
const method = actionConfig?.method ?? "POST";
|
|
85
|
+
const configuredPath = actionConfig?.path;
|
|
86
|
+
let actionPath = configuredPath ?? `${prefix}/${encodeURIComponent(service)}/${action.split(".").map(encodeURIComponent).join(".")}`;
|
|
87
|
+
let remaining = input;
|
|
88
|
+
if (configuredPath !== void 0) {
|
|
89
|
+
if (!configuredPath.startsWith("/")) throw new Error("[Brick-TS client] Action paths must start with '/'.");
|
|
90
|
+
const source = { ...input ?? {} };
|
|
91
|
+
const record = { ...source };
|
|
92
|
+
actionPath = actionPath.replace(/:([^/]+)/g, (_match, key) => {
|
|
93
|
+
const value = Object.hasOwn(source, key) ? source[key] : void 0;
|
|
94
|
+
if (value === void 0 || value === null || value === "") throw new Error(`[Brick-TS client] Missing path parameter '${key}'.`);
|
|
95
|
+
delete record[key];
|
|
96
|
+
return encodeURIComponent(String(value));
|
|
97
|
+
});
|
|
98
|
+
remaining = input === void 0 ? void 0 : record;
|
|
99
|
+
}
|
|
100
|
+
const queryOnly = method === "GET" || method === "DELETE";
|
|
101
|
+
return {
|
|
102
|
+
method,
|
|
103
|
+
url: `${baseUrl}${actionPath}${queryOnly ? toQueryString(remaining) : ""}`,
|
|
104
|
+
body: queryOnly ? void 0 : remaining,
|
|
105
|
+
hasBody: !queryOnly && remaining !== void 0
|
|
106
|
+
};
|
|
107
|
+
}
|
|
108
|
+
function toActionError(status, body, url) {
|
|
109
|
+
if (body !== null && typeof body === "object") {
|
|
110
|
+
const record = body;
|
|
111
|
+
if (record.name === "ValidationError") return new ValidationError(typeof record.message === "string" ? record.message : "Validation failed", Array.isArray(record.errors) ? record.errors : [], typeof record.status === "number" ? record.status : status);
|
|
112
|
+
if (typeof record.code === "string") return new ActionExecutionError(record.code, typeof record.message === "string" ? record.message : record.code, typeof record.status === "number" ? record.status : status, record.details ?? void 0);
|
|
113
|
+
}
|
|
114
|
+
if (status >= 500) return new BrickServerError(`Unexpected server error (status ${status}) for ${url}.`, {
|
|
115
|
+
status,
|
|
116
|
+
url,
|
|
117
|
+
body
|
|
118
|
+
});
|
|
119
|
+
return new BrickTransportError(`Request failed with status ${status} for ${url}.`, {
|
|
120
|
+
status,
|
|
121
|
+
url,
|
|
122
|
+
body
|
|
123
|
+
});
|
|
124
|
+
}
|
|
125
|
+
async function dispatch(resolved, path, target, input, callOptions) {
|
|
126
|
+
const { method, url, body, hasBody } = planRequest(path, target, input, resolved.baseUrl, resolved.prefix);
|
|
127
|
+
const headers = {
|
|
128
|
+
accept: "application/json",
|
|
129
|
+
...typeof resolved.headers === "function" ? await resolved.headers() : resolved.headers ?? {},
|
|
130
|
+
...callOptions?.headers
|
|
131
|
+
};
|
|
132
|
+
let payload;
|
|
133
|
+
if (hasBody) {
|
|
134
|
+
headers["content-type"] = "application/json";
|
|
135
|
+
payload = JSON.stringify(body ?? null);
|
|
136
|
+
}
|
|
137
|
+
const timeoutMs = callOptions?.timeoutMs ?? resolved.timeoutMs;
|
|
138
|
+
let timeoutSignal;
|
|
139
|
+
if (timeoutMs !== void 0) timeoutSignal = AbortSignal.timeout(timeoutMs);
|
|
140
|
+
const signal = callOptions?.signal ?? timeoutSignal ?? resolved.signal;
|
|
141
|
+
let response;
|
|
142
|
+
try {
|
|
143
|
+
response = await resolved.fetch(url, {
|
|
144
|
+
method,
|
|
145
|
+
headers,
|
|
146
|
+
body: payload,
|
|
147
|
+
signal
|
|
148
|
+
});
|
|
149
|
+
} catch (err) {
|
|
150
|
+
if (err instanceof Error && err.name === "AbortError") throw err;
|
|
151
|
+
throw new BrickTransportError(`Network request failed for ${url}: ${err instanceof Error ? err.message : String(err)}`, {
|
|
152
|
+
url,
|
|
153
|
+
cause: err
|
|
154
|
+
});
|
|
155
|
+
}
|
|
156
|
+
let parsed;
|
|
157
|
+
const text = await response.text();
|
|
158
|
+
if (response.headers.get("content-type")?.includes("text/plain")) parsed = text;
|
|
159
|
+
else if (text) try {
|
|
160
|
+
parsed = JSON.parse(text);
|
|
161
|
+
} catch (err) {
|
|
162
|
+
if (!response.headers.has("content-type")) parsed = text;
|
|
163
|
+
else throw new BrickTransportError(`Unparsable response body for ${url}.`, {
|
|
164
|
+
status: response.status,
|
|
165
|
+
url,
|
|
166
|
+
cause: err
|
|
167
|
+
});
|
|
168
|
+
}
|
|
169
|
+
if (response.ok) return parsed;
|
|
170
|
+
throw toActionError(response.status, parsed, url);
|
|
171
|
+
}
|
|
172
|
+
function childNode(node, prop) {
|
|
173
|
+
if (node != null && (typeof node === "object" || typeof node === "function")) return node[prop];
|
|
174
|
+
}
|
|
175
|
+
function createNamespace(resolved, path, node) {
|
|
176
|
+
const callable = async (input, options) => dispatch(resolved, path, node, input, options);
|
|
177
|
+
return new Proxy(callable, {
|
|
178
|
+
get(target, prop, receiver) {
|
|
179
|
+
if (typeof prop !== "string") return Reflect.get(target, prop, receiver);
|
|
180
|
+
if (prop === "then" || prop === "catch" || prop === "finally") return void 0;
|
|
181
|
+
return createNamespace(resolved, [...path, prop], childNode(node, prop));
|
|
182
|
+
},
|
|
183
|
+
apply(_target, _thisArg, args) {
|
|
184
|
+
const [input, options] = args;
|
|
185
|
+
return dispatch(resolved, path, node, input, options);
|
|
186
|
+
}
|
|
187
|
+
});
|
|
188
|
+
}
|
|
189
|
+
function createBrickClient(options) {
|
|
190
|
+
if (!options?.baseUrl) throw new Error("[Brick-TS client] `baseUrl` is required, e.g. `{ baseUrl: \"http://localhost:4000\" }`.");
|
|
191
|
+
const fetchImpl = options.fetch ?? globalThis.fetch;
|
|
192
|
+
if (typeof fetchImpl !== "function") throw new Error("[Brick-TS client] No `fetch` implementation available: pass `fetch` explicitly.");
|
|
193
|
+
return createNamespace({
|
|
194
|
+
baseUrl: normalizeBaseUrl(options.baseUrl),
|
|
195
|
+
prefix: normalizePrefix(options.prefix),
|
|
196
|
+
headers: options.headers,
|
|
197
|
+
fetch: fetchImpl,
|
|
198
|
+
signal: options.signal,
|
|
199
|
+
timeoutMs: options.timeoutMs
|
|
200
|
+
}, [], options.contract);
|
|
201
|
+
}
|
|
202
|
+
//#endregion
|
|
203
|
+
export { BrickServerError, BrickTransportError, createBrickClient, isBrickServerError, isBrickTransportError };
|
|
204
|
+
|
|
205
|
+
//# sourceMappingURL=client.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"client.js","names":[],"sources":["../src/client.ts"],"sourcesContent":["import type { Static, TSchema } from \"@sinclair/typebox\";\nimport type { Action, ActionErrorDefinition } from \"./types\";\nimport { ActionExecutionError, ValidationError } from \"./types\";\n\n/**\n * Eden/tRPC-style typed HTTP client inferred from Brick-TS application contracts.\n *\n * The frontend imports only the contract *type* — never a backend implementation:\n *\n * ```ts\n * import { createBrickClient } from \"@brickkit/core/client\";\n * import type { AppServer } from \"./server\"; // `import type`: erased at build\n *\n * const api = createBrickClient<AppServer>({ baseUrl: \"http://localhost:4000\" });\n * const pages = await api.page.list({ limit: 10, sort: \"-createdAt\" });\n * const created = await api.page.create({ title: \"Hello\", content: \"World\" });\n * ```\n *\n * Build the contract from individually-typed actions (each `defineAction` call\n * preserves its input/output/error literal types):\n *\n * ```ts\n * // server.ts (backend)\n * export const listPages = pagesService.action({ name: \"page.list\", ... });\n * export const createPage = pagesService.action({ name: \"page.create\", ... });\n * export const contract = { page: { list: listPages, create: createPage } };\n * export type AppServer = typeof contract;\n * ```\n *\n * ## Result / error convention\n *\n * The client uses a throw-based convention that mirrors local `action.execute`\n * semantics, because TypeScript promises cannot encode thrown exception types:\n *\n * - Success → the promise resolves with the action output.\n * - Declared domain failures (your `errors: { SLUG_EXISTS: ... }`) and framework\n * guards (UNAUTHORIZED/FORBIDDEN/NOT_FOUND/...) → rejected with\n * {@link ActionExecutionError} carrying the declared `code`, `status`,\n * `message`, and `details`. Narrow with `instanceof` and read `err.code`.\n * - Input/output validation failures → rejected with {@link ValidationError},\n * exactly as local execution throws.\n * - Network failures, unparsable bodies, and non-OK responses outside the\n * declared contract → {@link BrickTransportError} (4xx) or\n * {@link BrickServerError} (5xx).\n * - Cancellation via `AbortSignal` → the native `AbortError` propagates\n * unwrapped so `err.name === \"AbortError\"` keeps working.\n *\n * ## URL mapping\n *\n * A client path is a namespace walk ending in an action call. The leaf segment\n * decides the route, matching the server compiler (`packages/cli/src/compiler`):\n *\n * | Client call | HTTP request |\n * |---|---|\n * Generated browser contracts carry each action's HTTP method and path,\n * including plugin routes and consumer overrides. Without runtime metadata,\n * callers use `POST /api/<service>/<action>` with dotted action names.\n * GET/DELETE input is serialized as a query string; other methods send JSON.\n\n */\n\nexport interface BrickClientOptions {\n /** Server origin, e.g. `\"http://localhost:4000\"`. No trailing slash required. */\n baseUrl: string;\n /**\n * Route prefix the server was mounted with (default `\"/api\"`).\n * Must match the `prefix` passed to `brick({ prefix })`.\n */\n prefix?: string;\n /**\n * Default headers sent with every call (e.g. an `Authorization` bearer).\n * A thunk is re-evaluated per call, so rotated tokens stay fresh.\n */\n headers?:\n | Record<string, string>\n | (() => Record<string, string> | Promise<Record<string, string>>);\n /** `fetch` implementation. Defaults to `globalThis.fetch`. */\n fetch?: (input: RequestInfo | URL, init?: RequestInit) => Promise<Response>;\n /** Default signal applied to every call (per-call `signal` wins). */\n signal?: AbortSignal;\n /** Default per-call timeout in milliseconds (per-call `timeoutMs` wins). */\n timeoutMs?: number;\n /**\n * Browser-safe route metadata generated by the Brick Vite plugin.\n * Required for custom methods/paths and plugin routes. Without a contract,\n * calls use POST and service/action names inferred from namespace keys.\n */\n contract?: Record<string, any>;\n}\n\n/** Browser-safe action metadata generated by the Brick Vite plugin. */\nexport interface BrickClientAction<\n TInput = unknown,\n TOutput = unknown,\n TErrors = {},\n> {\n kind: \"action\";\n name: string;\n serviceName: string;\n /** Owning plugin descriptor name for plugin actions (e.g. `@brickkit/crud`). */\n plugin?: string;\n /** Owning resource name for resource-plugin actions (e.g. `page`). */\n resource?: string;\n config: { path: string; method: \"GET\" | \"POST\" | \"PUT\" | \"PATCH\" | \"DELETE\" };\n /** Type information only; never emitted at runtime. */\n readonly __types?: { input: TInput; output: TOutput; errors: TErrors };\n}\n\nexport interface BrickCallOptions {\n /** Extra headers merged over the client defaults for this call only. */\n headers?: Record<string, string>;\n /** Abort signal for this call only. Never wrapped: aborts reject with `AbortError`. */\n signal?: AbortSignal;\n /** Per-call timeout in milliseconds. Implemented with `AbortSignal.timeout`. */\n timeoutMs?: number;\n}\n\n/**\n * The request never received a meaningful server answer: DNS / connection\n * failure, a malformed body, or a 4xx response outside the declared contract\n * (no `code` and no `ValidationError` shape).\n */\nexport class BrickTransportError extends Error {\n readonly kind = \"transport\" as const;\n readonly status?: number;\n readonly url: string;\n readonly body?: unknown;\n override readonly cause?: unknown;\n\n constructor(\n message: string,\n opts: { status?: number; url: string; body?: unknown; cause?: unknown },\n ) {\n super(message);\n this.name = \"BrickTransportError\";\n this.status = opts.status;\n this.url = opts.url;\n this.body = opts.body;\n this.cause = opts.cause;\n }\n}\n\n/**\n * The server answered 5xx without a declared `code` / `ValidationError` shape,\n * i.e. an unexpected failure rather than a modelled domain error.\n */\nexport class BrickServerError extends Error {\n readonly kind = \"server\" as const;\n readonly status: number;\n readonly url: string;\n readonly body: unknown;\n\n constructor(\n message: string,\n opts: { status: number; url: string; body: unknown },\n ) {\n super(message);\n this.name = \"BrickServerError\";\n this.status = opts.status;\n this.url = opts.url;\n this.body = opts.body;\n }\n}\n\nexport function isBrickTransportError(\n err: unknown,\n): err is BrickTransportError {\n return err instanceof BrickTransportError;\n}\n\nexport function isBrickServerError(err: unknown): err is BrickServerError {\n return err instanceof BrickServerError;\n}\n\n/** Static input type from the schema, with a fallback for structural actions. */\nexport type InferActionInput<A> =\n A extends BrickClientAction<infer I, any, any>\n ? I\n : A extends {\n config: { input?: infer S extends TSchema };\n }\n ? Static<S>\n : A extends {\n execute(params: { input?: infer I; ctx?: any }): any;\n }\n ? I\n : A extends { run(input?: infer I, ctx?: any): any }\n ? I\n : A extends (params: { input?: infer I; ctx?: any }) => any\n ? I\n : unknown;\n\n/** Resolved output type of an action. */\nexport type InferActionOutput<A> =\n A extends BrickClientAction<any, infer O, any>\n ? O\n : A extends (...args: any[]) => Promise<infer O>\n ? O\n : A extends { execute(params: any): Promise<infer O> }\n ? O\n : unknown;\n\n/** Union of error `code`s declared in an action's `errors` map. */\nexport type InferActionErrorCodes<A> =\n A extends BrickClientAction<any, any, infer E>\n ? Extract<keyof E, string>\n : A extends {\n config: { errors?: infer E };\n }\n ? E extends Record<string, ActionErrorDefinition>\n ? Extract<keyof E, string>\n : never\n : never;\n\n/**\n * The declared failure shape of an action for `catch` narrowing:\n * ```ts\n * try { await api.page.create(input); }\n * catch (err) {\n * if (err instanceof ActionExecutionError) {\n * const code: InferActionErrorCodes<typeof createPage> | \"UNAUTHORIZED\" | ... = err.code;\n * }\n * }\n * ```\n * (Standard framework codes are always possible alongside declared ones.)\n */\nexport type InferActionFailure<A> = ActionExecutionError & {\n code:\n | InferActionErrorCodes<A>\n | \"BAD_REQUEST\"\n | \"UNAUTHORIZED\"\n | \"FORBIDDEN\"\n | \"NOT_FOUND\"\n | \"CONFLICT\"\n | \"INTERNAL_SERVER_ERROR\"\n | \"VALIDATION_FAILED\";\n};\n\n/**\n * Typed caller for one action. Required inputs stay required; actions whose\n * input includes `undefined` (no schema / all-optional) can be called bare.\n */\nexport type BrickActionCaller<A> =\n undefined extends InferActionInput<A>\n ? (\n input?: InferActionInput<A>,\n options?: BrickCallOptions,\n ) => Promise<InferActionOutput<A>>\n : (\n input: InferActionInput<A>,\n options?: BrickCallOptions,\n ) => Promise<InferActionOutput<A>>;\n\n/** Recursively maps action leaves and their namespaces to browser callers. */\nexport type BrickClient<T> = T extends\n | BrickClientAction<any, any, any>\n | Action<any, any, any, any>\n ? BrickActionCaller<T>\n : T extends (...args: any[]) => any\n ? BrickActionCaller<T>\n : T extends object\n ? { [K in keyof T]: BrickClient<T[K]> }\n : T;\n\ninterface ResolvedClientOptions {\n baseUrl: string;\n prefix: string;\n headers?: BrickClientOptions[\"headers\"];\n fetch: NonNullable<BrickClientOptions[\"fetch\"]>;\n signal?: AbortSignal;\n timeoutMs?: number;\n}\n\nfunction normalizeBaseUrl(baseUrl: string): string {\n const trimmed = baseUrl.replace(/\\/+$/, \"\");\n if (!trimmed)\n throw new Error(\"[Brick-TS client] `baseUrl` must not be empty.\");\n return trimmed;\n}\n\nfunction normalizePrefix(prefix: string | undefined): string {\n if (!prefix) return \"/api\";\n const withLeading = prefix.startsWith(\"/\") ? prefix : `/${prefix}`;\n return withLeading.length > 1 ? withLeading.replace(/\\/+$/, \"\") : withLeading;\n}\n\nfunction toQueryString(input: unknown): string {\n if (input == null || typeof input !== \"object\") return \"\";\n const params = new URLSearchParams();\n for (const [key, value] of Object.entries(input as Record<string, unknown>)) {\n if (value === undefined || value === null) continue;\n if (Array.isArray(value)) {\n for (const item of value) {\n if (item === undefined || item === null) continue;\n params.append(\n key,\n typeof item === \"object\" ? JSON.stringify(item) : String(item),\n );\n }\n } else if (typeof value === \"object\") {\n params.append(key, JSON.stringify(value));\n } else {\n params.append(key, String(value));\n }\n }\n const qs = params.toString();\n return qs ? `?${qs}` : \"\";\n}\n\ninterface PlannedRequest {\n method: string;\n url: string;\n body: unknown;\n hasBody: boolean;\n}\n\nfunction isActionValue(value: unknown): value is {\n serviceName?: unknown;\n name?: unknown;\n config: Action<any, any, any, any>[\"config\"];\n} & Function {\n return (\n typeof value === \"function\" &&\n !!(value as any).config &&\n typeof (value as any).config.execute === \"function\"\n );\n}\n\nfunction isClientAction(value: unknown): value is BrickClientAction {\n return (\n !!value &&\n typeof value === \"object\" &&\n (value as BrickClientAction).kind === \"action\"\n );\n}\n\nfunction planRequest(\n path: string[],\n /** Runtime contract value at `path`, when the `contract` option is set. */\n target: unknown,\n input: unknown,\n baseUrl: string,\n prefix: string,\n): PlannedRequest {\n if (path.length === 0) {\n throw new Error(\n \"[Brick-TS client] No action selected: call a leaf such as `api.page.list(input)`.\",\n );\n }\n const actionTarget =\n isActionValue(target) || isClientAction(target) ? target : undefined;\n const actionConfig = actionTarget?.config;\n if (path.length < 2) {\n throw new Error(\n `[Brick-TS client] Cannot address '${path.join(\".\")}': custom actions need a service segment, e.g. \\`api.${path[0]}.<action>(input)\\`.`,\n );\n }\n // Exact mode: the runtime contract reveals the bound service/action names,\n // so contract keys can differ from backend names.\n const service =\n typeof actionTarget?.serviceName === \"string\" && actionTarget.serviceName\n ? actionTarget.serviceName\n : path[0]!;\n const action =\n typeof actionTarget?.name === \"string\" && actionTarget.name\n ? actionTarget.name\n : path.slice(1).join(\".\");\n const method = actionConfig?.method ?? \"POST\";\n const configuredPath = actionConfig?.path;\n let actionPath =\n configuredPath ??\n `${prefix}/${encodeURIComponent(service)}/${action.split(\".\").map(encodeURIComponent).join(\".\")}`;\n let remaining = input;\n if (configuredPath !== undefined) {\n if (!configuredPath.startsWith(\"/\")) {\n throw new Error(\"[Brick-TS client] Action paths must start with '/'.\");\n }\n const source = { ...((input ?? {}) as Record<string, unknown>) };\n const record = { ...source };\n actionPath = actionPath.replace(/:([^/]+)/g, (_match, key: string) => {\n const value = Object.hasOwn(source, key) ? source[key] : undefined;\n if (value === undefined || value === null || value === \"\") {\n throw new Error(`[Brick-TS client] Missing path parameter '${key}'.`);\n }\n delete record[key];\n return encodeURIComponent(String(value));\n });\n remaining = input === undefined ? undefined : record;\n }\n const queryOnly = method === \"GET\" || method === \"DELETE\";\n return {\n method,\n url: `${baseUrl}${actionPath}${queryOnly ? toQueryString(remaining) : \"\"}`,\n body: queryOnly ? undefined : remaining,\n hasBody: !queryOnly && remaining !== undefined,\n };\n}\n\nfunction toActionError(status: number, body: unknown, url: string): Error {\n if (body !== null && typeof body === \"object\") {\n const record = body as Record<string, unknown>;\n if (record.name === \"ValidationError\") {\n return new ValidationError(\n typeof record.message === \"string\"\n ? record.message\n : \"Validation failed\",\n Array.isArray(record.errors) ? (record.errors as any) : [],\n typeof record.status === \"number\" ? record.status : status,\n );\n }\n if (typeof record.code === \"string\") {\n return new ActionExecutionError(\n record.code,\n typeof record.message === \"string\" ? record.message : record.code,\n typeof record.status === \"number\" ? record.status : status,\n (record.details ?? undefined) as unknown,\n );\n }\n }\n if (status >= 500) {\n return new BrickServerError(\n `Unexpected server error (status ${status}) for ${url}.`,\n {\n status,\n url,\n body,\n },\n );\n }\n return new BrickTransportError(\n `Request failed with status ${status} for ${url}.`,\n {\n status,\n url,\n body,\n },\n );\n}\n\nasync function dispatch(\n resolved: ResolvedClientOptions,\n path: string[],\n target: unknown,\n input: unknown,\n callOptions: BrickCallOptions | undefined,\n): Promise<unknown> {\n const { method, url, body, hasBody } = planRequest(\n path,\n target,\n input,\n resolved.baseUrl,\n resolved.prefix,\n );\n\n const staticHeaders =\n typeof resolved.headers === \"function\"\n ? await resolved.headers()\n : (resolved.headers ?? {});\n const headers: Record<string, string> = {\n accept: \"application/json\",\n ...staticHeaders,\n ...callOptions?.headers,\n };\n let payload: string | undefined;\n if (hasBody) {\n headers[\"content-type\"] = \"application/json\";\n payload = JSON.stringify(body ?? null);\n }\n\n const timeoutMs = callOptions?.timeoutMs ?? resolved.timeoutMs;\n let timeoutSignal: AbortSignal | undefined;\n if (timeoutMs !== undefined) timeoutSignal = AbortSignal.timeout(timeoutMs);\n const signal = callOptions?.signal ?? timeoutSignal ?? resolved.signal;\n\n let response: Response;\n try {\n response = await resolved.fetch(url, {\n method,\n headers,\n body: payload,\n signal,\n });\n } catch (err) {\n if (err instanceof Error && err.name === \"AbortError\") throw err;\n throw new BrickTransportError(\n `Network request failed for ${url}: ${err instanceof Error ? err.message : String(err)}`,\n { url, cause: err },\n );\n }\n\n let parsed: unknown;\n const text = await response.text();\n if (response.headers.get(\"content-type\")?.includes(\"text/plain\")) {\n parsed = text;\n } else if (text) {\n try {\n parsed = JSON.parse(text);\n } catch (err) {\n if (!response.headers.has(\"content-type\")) {\n parsed = text;\n } else {\n throw new BrickTransportError(`Unparsable response body for ${url}.`, {\n status: response.status,\n url,\n cause: err,\n });\n }\n }\n }\n\n if (response.ok) return parsed;\n throw toActionError(response.status, parsed, url);\n}\n\nfunction childNode(node: unknown, prop: string): unknown {\n if (\n node != null &&\n (typeof node === \"object\" || typeof node === \"function\")\n ) {\n return (node as Record<string, unknown>)[prop];\n }\n return undefined;\n}\n\nfunction createNamespace(\n resolved: ResolvedClientOptions,\n path: string[],\n node: unknown,\n): any {\n const callable = async (input?: unknown, options?: BrickCallOptions) =>\n dispatch(resolved, path, node, input, options);\n return new Proxy(callable, {\n get(target, prop, receiver) {\n if (typeof prop !== \"string\") return Reflect.get(target, prop, receiver);\n // Never masquerade as a thenable: awaiting a namespace must not dispatch.\n if (prop === \"then\" || prop === \"catch\" || prop === \"finally\")\n return undefined;\n return createNamespace(resolved, [...path, prop], childNode(node, prop));\n },\n apply(_target, _thisArg, args: unknown[]) {\n const [input, options] = args as [unknown, BrickCallOptions | undefined];\n return dispatch(resolved, path, node, input, options);\n },\n });\n}\n\n/**\n * Create an Eden/tRPC-style typed client for the application contract `TApp`.\n * `TApp` is a type-only parameter: `import type { AppServer }` keeps backend\n * implementations out of the frontend bundle.\n */\nexport function createBrickClient<TApp extends Record<string, any>>(\n options: BrickClientOptions & { contract: TApp },\n): BrickClient<TApp>;\nexport function createBrickClient<TApp extends Record<string, any>>(\n options: BrickClientOptions,\n): BrickClient<TApp>;\nexport function createBrickClient<TApp extends Record<string, any>>(\n options: BrickClientOptions,\n): BrickClient<TApp> {\n if (!options?.baseUrl)\n throw new Error(\n '[Brick-TS client] `baseUrl` is required, e.g. `{ baseUrl: \"http://localhost:4000\" }`.',\n );\n const fetchImpl = options.fetch ?? globalThis.fetch;\n if (typeof fetchImpl !== \"function\") {\n throw new Error(\n \"[Brick-TS client] No `fetch` implementation available: pass `fetch` explicitly.\",\n );\n }\n const resolved: ResolvedClientOptions = {\n baseUrl: normalizeBaseUrl(options.baseUrl),\n prefix: normalizePrefix(options.prefix),\n headers: options.headers,\n fetch: fetchImpl,\n signal: options.signal,\n timeoutMs: options.timeoutMs,\n };\n return createNamespace(resolved, [], options.contract) as BrickClient<TApp>;\n}\n"],"mappings":";;;;;;;AA0HA,IAAa,sBAAb,cAAyC,MAAM;CAC7C,OAAgB;CAChB;CACA;CACA;CACA;CAEA,YACE,SACA,MACA;EACA,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS,KAAK;EACnB,KAAK,MAAM,KAAK;EAChB,KAAK,OAAO,KAAK;EACjB,KAAK,QAAQ,KAAK;CACpB;AACF;;;;;AAMA,IAAa,mBAAb,cAAsC,MAAM;CAC1C,OAAgB;CAChB;CACA;CACA;CAEA,YACE,SACA,MACA;EACA,MAAM,OAAO;EACb,KAAK,OAAO;EACZ,KAAK,SAAS,KAAK;EACnB,KAAK,MAAM,KAAK;EAChB,KAAK,OAAO,KAAK;CACnB;AACF;AAEA,SAAgB,sBACd,KAC4B;CAC5B,OAAO,eAAe;AACxB;AAEA,SAAgB,mBAAmB,KAAuC;CACxE,OAAO,eAAe;AACxB;AAqGA,SAAS,iBAAiB,SAAyB;CACjD,MAAM,UAAU,QAAQ,QAAQ,QAAQ,EAAE;CAC1C,IAAI,CAAC,SACH,MAAM,IAAI,MAAM,gDAAgD;CAClE,OAAO;AACT;AAEA,SAAS,gBAAgB,QAAoC;CAC3D,IAAI,CAAC,QAAQ,OAAO;CACpB,MAAM,cAAc,OAAO,WAAW,GAAG,IAAI,SAAS,IAAI;CAC1D,OAAO,YAAY,SAAS,IAAI,YAAY,QAAQ,QAAQ,EAAE,IAAI;AACpE;AAEA,SAAS,cAAc,OAAwB;CAC7C,IAAI,SAAS,QAAQ,OAAO,UAAU,UAAU,OAAO;CACvD,MAAM,SAAS,IAAI,gBAAgB;CACnC,KAAK,MAAM,CAAC,KAAK,UAAU,OAAO,QAAQ,KAAgC,GAAG;EAC3E,IAAI,UAAU,KAAA,KAAa,UAAU,MAAM;EAC3C,IAAI,MAAM,QAAQ,KAAK,GACrB,KAAK,MAAM,QAAQ,OAAO;GACxB,IAAI,SAAS,KAAA,KAAa,SAAS,MAAM;GACzC,OAAO,OACL,KACA,OAAO,SAAS,WAAW,KAAK,UAAU,IAAI,IAAI,OAAO,IAAI,CAC/D;EACF;OACK,IAAI,OAAO,UAAU,UAC1B,OAAO,OAAO,KAAK,KAAK,UAAU,KAAK,CAAC;OAExC,OAAO,OAAO,KAAK,OAAO,KAAK,CAAC;CAEpC;CACA,MAAM,KAAK,OAAO,SAAS;CAC3B,OAAO,KAAK,IAAI,OAAO;AACzB;AASA,SAAS,cAAc,OAIV;CACX,OACE,OAAO,UAAU,cACjB,CAAC,CAAE,MAAc,UACjB,OAAQ,MAAc,OAAO,YAAY;AAE7C;AAEA,SAAS,eAAe,OAA4C;CAClE,OACE,CAAC,CAAC,SACF,OAAO,UAAU,YAChB,MAA4B,SAAS;AAE1C;AAEA,SAAS,YACP,MAEA,QACA,OACA,SACA,QACgB;CAChB,IAAI,KAAK,WAAW,GAClB,MAAM,IAAI,MACR,mFACF;CAEF,MAAM,eACJ,cAAc,MAAM,KAAK,eAAe,MAAM,IAAI,SAAS,KAAA;CAC7D,MAAM,eAAe,cAAc;CACnC,IAAI,KAAK,SAAS,GAChB,MAAM,IAAI,MACR,qCAAqC,KAAK,KAAK,GAAG,EAAE,uDAAuD,KAAK,GAAG,oBACrH;CAIF,MAAM,UACJ,OAAO,cAAc,gBAAgB,YAAY,aAAa,cAC1D,aAAa,cACb,KAAK;CACX,MAAM,SACJ,OAAO,cAAc,SAAS,YAAY,aAAa,OACnD,aAAa,OACb,KAAK,MAAM,CAAC,CAAC,CAAC,KAAK,GAAG;CAC5B,MAAM,SAAS,cAAc,UAAU;CACvC,MAAM,iBAAiB,cAAc;CACrC,IAAI,aACF,kBACA,GAAG,OAAO,GAAG,mBAAmB,OAAO,EAAE,GAAG,OAAO,MAAM,GAAG,CAAC,CAAC,IAAI,kBAAkB,CAAC,CAAC,KAAK,GAAG;CAChG,IAAI,YAAY;CAChB,IAAI,mBAAmB,KAAA,GAAW;EAChC,IAAI,CAAC,eAAe,WAAW,GAAG,GAChC,MAAM,IAAI,MAAM,qDAAqD;EAEvE,MAAM,SAAS,EAAE,GAAK,SAAS,CAAC,EAA+B;EAC/D,MAAM,SAAS,EAAE,GAAG,OAAO;EAC3B,aAAa,WAAW,QAAQ,cAAc,QAAQ,QAAgB;GACpE,MAAM,QAAQ,OAAO,OAAO,QAAQ,GAAG,IAAI,OAAO,OAAO,KAAA;GACzD,IAAI,UAAU,KAAA,KAAa,UAAU,QAAQ,UAAU,IACrD,MAAM,IAAI,MAAM,6CAA6C,IAAI,GAAG;GAEtE,OAAO,OAAO;GACd,OAAO,mBAAmB,OAAO,KAAK,CAAC;EACzC,CAAC;EACD,YAAY,UAAU,KAAA,IAAY,KAAA,IAAY;CAChD;CACA,MAAM,YAAY,WAAW,SAAS,WAAW;CACjD,OAAO;EACL;EACA,KAAK,GAAG,UAAU,aAAa,YAAY,cAAc,SAAS,IAAI;EACtE,MAAM,YAAY,KAAA,IAAY;EAC9B,SAAS,CAAC,aAAa,cAAc,KAAA;CACvC;AACF;AAEA,SAAS,cAAc,QAAgB,MAAe,KAAoB;CACxE,IAAI,SAAS,QAAQ,OAAO,SAAS,UAAU;EAC7C,MAAM,SAAS;EACf,IAAI,OAAO,SAAS,mBAClB,OAAO,IAAI,gBACT,OAAO,OAAO,YAAY,WACtB,OAAO,UACP,qBACJ,MAAM,QAAQ,OAAO,MAAM,IAAK,OAAO,SAAiB,CAAC,GACzD,OAAO,OAAO,WAAW,WAAW,OAAO,SAAS,MACtD;EAEF,IAAI,OAAO,OAAO,SAAS,UACzB,OAAO,IAAI,qBACT,OAAO,MACP,OAAO,OAAO,YAAY,WAAW,OAAO,UAAU,OAAO,MAC7D,OAAO,OAAO,WAAW,WAAW,OAAO,SAAS,QACnD,OAAO,WAAW,KAAA,CACrB;CAEJ;CACA,IAAI,UAAU,KACZ,OAAO,IAAI,iBACT,mCAAmC,OAAO,QAAQ,IAAI,IACtD;EACE;EACA;EACA;CACF,CACF;CAEF,OAAO,IAAI,oBACT,8BAA8B,OAAO,OAAO,IAAI,IAChD;EACE;EACA;EACA;CACF,CACF;AACF;AAEA,eAAe,SACb,UACA,MACA,QACA,OACA,aACkB;CAClB,MAAM,EAAE,QAAQ,KAAK,MAAM,YAAY,YACrC,MACA,QACA,OACA,SAAS,SACT,SAAS,MACX;CAMA,MAAM,UAAkC;EACtC,QAAQ;EACR,GALA,OAAO,SAAS,YAAY,aACxB,MAAM,SAAS,QAAQ,IACtB,SAAS,WAAW,CAAC;EAI1B,GAAG,aAAa;CAClB;CACA,IAAI;CACJ,IAAI,SAAS;EACX,QAAQ,kBAAkB;EAC1B,UAAU,KAAK,UAAU,QAAQ,IAAI;CACvC;CAEA,MAAM,YAAY,aAAa,aAAa,SAAS;CACrD,IAAI;CACJ,IAAI,cAAc,KAAA,GAAW,gBAAgB,YAAY,QAAQ,SAAS;CAC1E,MAAM,SAAS,aAAa,UAAU,iBAAiB,SAAS;CAEhE,IAAI;CACJ,IAAI;EACF,WAAW,MAAM,SAAS,MAAM,KAAK;GACnC;GACA;GACA,MAAM;GACN;EACF,CAAC;CACH,SAAS,KAAK;EACZ,IAAI,eAAe,SAAS,IAAI,SAAS,cAAc,MAAM;EAC7D,MAAM,IAAI,oBACR,8BAA8B,IAAI,IAAI,eAAe,QAAQ,IAAI,UAAU,OAAO,GAAG,KACrF;GAAE;GAAK,OAAO;EAAI,CACpB;CACF;CAEA,IAAI;CACJ,MAAM,OAAO,MAAM,SAAS,KAAK;CACjC,IAAI,SAAS,QAAQ,IAAI,cAAc,CAAC,EAAE,SAAS,YAAY,GAC7D,SAAS;MACJ,IAAI,MACT,IAAI;EACF,SAAS,KAAK,MAAM,IAAI;CAC1B,SAAS,KAAK;EACZ,IAAI,CAAC,SAAS,QAAQ,IAAI,cAAc,GACtC,SAAS;OAET,MAAM,IAAI,oBAAoB,gCAAgC,IAAI,IAAI;GACpE,QAAQ,SAAS;GACjB;GACA,OAAO;EACT,CAAC;CAEL;CAGF,IAAI,SAAS,IAAI,OAAO;CACxB,MAAM,cAAc,SAAS,QAAQ,QAAQ,GAAG;AAClD;AAEA,SAAS,UAAU,MAAe,MAAuB;CACvD,IACE,QAAQ,SACP,OAAO,SAAS,YAAY,OAAO,SAAS,aAE7C,OAAQ,KAAiC;AAG7C;AAEA,SAAS,gBACP,UACA,MACA,MACK;CACL,MAAM,WAAW,OAAO,OAAiB,YACvC,SAAS,UAAU,MAAM,MAAM,OAAO,OAAO;CAC/C,OAAO,IAAI,MAAM,UAAU;EACzB,IAAI,QAAQ,MAAM,UAAU;GAC1B,IAAI,OAAO,SAAS,UAAU,OAAO,QAAQ,IAAI,QAAQ,MAAM,QAAQ;GAEvE,IAAI,SAAS,UAAU,SAAS,WAAW,SAAS,WAClD,OAAO,KAAA;GACT,OAAO,gBAAgB,UAAU,CAAC,GAAG,MAAM,IAAI,GAAG,UAAU,MAAM,IAAI,CAAC;EACzE;EACA,MAAM,SAAS,UAAU,MAAiB;GACxC,MAAM,CAAC,OAAO,WAAW;GACzB,OAAO,SAAS,UAAU,MAAM,MAAM,OAAO,OAAO;EACtD;CACF,CAAC;AACH;AAaA,SAAgB,kBACd,SACmB;CACnB,IAAI,CAAC,SAAS,SACZ,MAAM,IAAI,MACR,yFACF;CACF,MAAM,YAAY,QAAQ,SAAS,WAAW;CAC9C,IAAI,OAAO,cAAc,YACvB,MAAM,IAAI,MACR,iFACF;CAUF,OAAO,gBAAgB;EAPrB,SAAS,iBAAiB,QAAQ,OAAO;EACzC,QAAQ,gBAAgB,QAAQ,MAAM;EACtC,SAAS,QAAQ;EACjB,OAAO;EACP,QAAQ,QAAQ;EAChB,WAAW,QAAQ;CAES,GAAG,CAAC,GAAG,QAAQ,QAAQ;AACvD"}
|
package/dist/effect.d.ts
ADDED
|
@@ -0,0 +1,3 @@
|
|
|
1
|
+
import { ct as defineDatabase } from "./chunks/client.js";
|
|
2
|
+
import { B as Type, M as createMcpHandler, a as adaptEffectActionConfig, an as defineEffectResourcePlugin, c as EffectMcpRegistry, cn as EffectService, d as runEffectPromise, f as EffectBrickApp, i as EffectTool, l as createEffectMcpRegistry, ln as EffectServiceOptions, m as effectBrick, n as EffectActionConfigWithAuthorize, o as defineEffectAction, on as defineEffectServicePlugin, p as EffectServerOptions, r as EffectActionConfigWithoutAuthorize, s as defineEffectTool, sn as defineResource, t as EffectAction, u as createEffectServiceProxy, un as defineEffectService } from "./chunks/effect.js";
|
|
3
|
+
export { EffectAction, EffectActionConfigWithAuthorize, EffectActionConfigWithoutAuthorize, type EffectBrickApp, type EffectMcpRegistry, type EffectServerOptions, type EffectService, type EffectServiceOptions, EffectTool, Type, Type as t, adaptEffectActionConfig, effectBrick as brick, effectBrick, createEffectMcpRegistry, createEffectMcpRegistry as createMcpRegistry, createEffectServiceProxy, createEffectServiceProxy as createServiceProxy, createMcpHandler, defineEffectAction as defineAction, defineEffectAction, defineDatabase, defineEffectResourcePlugin, defineEffectResourcePlugin as defineResourcePlugin, defineEffectService, defineEffectService as defineService, defineEffectServicePlugin, defineEffectServicePlugin as defineServicePlugin, defineEffectTool, defineEffectTool as defineTool, defineResource, runEffectPromise };
|
package/dist/effect.js
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export { Kt as Type, t as adaptEffectActionConfig, u as brick, u as effectBrick, i as createEffectMcpRegistry, i as createMcpRegistry, a as createEffectServiceProxy, a as createServiceProxy, c as createMcpHandler, n as defineAction, n as defineEffectAction, J as defineDatabase, d as defineEffectResourcePlugin, d as defineResourcePlugin, p as defineEffectService, p as defineService, f as defineEffectServicePlugin, f as defineServicePlugin, r as defineEffectTool, r as defineTool, g as defineResource, Zt as runEffectPromise, Jt as t } from "./chunks/effect.js";
|