@palbase/backend 0.7.0 → 0.9.0

package/dist/endpoint-tZi55HU8.d.cts

@@ -1,115 +0,0 @@
-import { ZodSchema, z } from 'zod';
-
-/** Supported HTTP methods for endpoints. */
-type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-/** Authenticated user attached to the request context. */
-interface User {
-    id: string;
-    email: string;
-    role: string;
-    metadata: Record<string, unknown>;
-}
-/** Authentication configuration for an endpoint. */
-interface AuthConfig {
-    /** Whether authentication is required. Defaults to true. */
-    required: boolean;
-    /** Required role for access. If undefined, any authenticated user is allowed. */
-    role?: string;
-}
-
-/** Middleware context — subset of EndpointContext without input (not yet validated). */
-interface MiddlewareContext {
-    params: Record<string, string>;
-    query: Record<string, string>;
-    headers: Record<string, string>;
-    user: User | null;
-    db: DBClient;
-    env: Record<string, string>;
-    log: Logger;
-    cache: CacheClient;
-    palbase: PalbaseBindings;
-    requestId: string;
-    projectId: string;
-    environmentId: string;
-}
-/** Middleware function signature — receives context and next function. */
-type MiddlewareHandler = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-/**
- * Define a middleware function for use in the middleware/ directory or
- * as endpoint-specific middleware.
- *
- * Middleware runs before the handler. Call `next()` to pass control
- * to the next middleware or handler. If `next()` is not called, the
- * handler will not execute.
- *
- * Errors thrown in middleware are caught by the pipeline and returned
- * as error responses.
- */
-declare function defineMiddleware(fn: MiddlewareHandler): MiddlewareHandler;
-
-/** Rate limit configuration for an endpoint. */
-interface RateLimitConfig {
-    /** Maximum number of requests in the window. */
-    max: number;
-    /** Window duration in seconds. */
-    window: number;
-}
-/** Database client interface injected into endpoint context. */
-interface DBClient {
-    insert(table: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
-    update(table: string, id: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
-    delete(table: string, id: string): Promise<void>;
-    findById(table: string, id: string): Promise<Record<string, unknown> | null>;
-    findMany(table: string, query?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
-}
-/** Logger interface injected into endpoint context. */
-interface Logger {
-    info(message: string, ...args: unknown[]): void;
-    warn(message: string, ...args: unknown[]): void;
-    error(message: string, ...args: unknown[]): void;
-    debug(message: string, ...args: unknown[]): void;
-}
-/** Cache client interface injected into endpoint context. */
-interface CacheClient {
-    get(key: string): Promise<string | null>;
-    set(key: string, value: string, ttl?: number): Promise<void>;
-    del(key: string): Promise<void>;
-    incr(key: string): Promise<number>;
-}
-/** Palbase service bindings for accessing other modules. */
-interface PalbaseBindings {
-    auth: Record<string, unknown>;
-    storage: Record<string, unknown>;
-}
-/** Endpoint context — injected into every handler. */
-interface EndpointContext<TInput = unknown> {
-    input: TInput;
-    params: Record<string, string>;
-    query: Record<string, string>;
-    headers: Record<string, string>;
-    user: User | null;
-    db: DBClient;
-    env: Record<string, string>;
-    log: Logger;
-    cache: CacheClient;
-    palbase: PalbaseBindings;
-    requestId: string;
-    projectId: string;
-    environmentId: string;
-}
-/** Middleware function signature — uses MiddlewareContext (no input, not yet validated). */
-type Middleware = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-/** Configuration for defining an endpoint. */
-interface EndpointConfig<TInputSchema extends ZodSchema = ZodSchema, TOutputSchema extends ZodSchema = ZodSchema> {
-    method: HttpMethod;
-    auth?: Partial<AuthConfig>;
-    rateLimit?: RateLimitConfig;
-    input?: TInputSchema;
-    output?: TOutputSchema;
-    middleware?: Middleware[];
-    handler: (ctx: EndpointContext<z.infer<TInputSchema>>) => Promise<z.infer<TOutputSchema>>;
-}
-/** Define a type-safe endpoint. Input schema infers the ctx.input type. */
-declare function defineEndpoint<TInputSchema extends ZodSchema, TOutputSchema extends ZodSchema>(config: EndpointConfig<TInputSchema, TOutputSchema>): EndpointConfig<TInputSchema, TOutputSchema>;
-
-export { type AuthConfig as A, type CacheClient as C, type DBClient as D, type EndpointContext as E, type HttpMethod as H, type Logger as L, type Middleware as M, type PalbaseBindings as P, type RateLimitConfig as R, type User as U, type EndpointConfig as a, type MiddlewareContext as b, type MiddlewareHandler as c, defineEndpoint as d, defineMiddleware as e };

package/dist/endpoint-tZi55HU8.d.ts

@@ -1,115 +0,0 @@
-import { ZodSchema, z } from 'zod';
-
-/** Supported HTTP methods for endpoints. */
-type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
-/** Authenticated user attached to the request context. */
-interface User {
-    id: string;
-    email: string;
-    role: string;
-    metadata: Record<string, unknown>;
-}
-/** Authentication configuration for an endpoint. */
-interface AuthConfig {
-    /** Whether authentication is required. Defaults to true. */
-    required: boolean;
-    /** Required role for access. If undefined, any authenticated user is allowed. */
-    role?: string;
-}
-
-/** Middleware context — subset of EndpointContext without input (not yet validated). */
-interface MiddlewareContext {
-    params: Record<string, string>;
-    query: Record<string, string>;
-    headers: Record<string, string>;
-    user: User | null;
-    db: DBClient;
-    env: Record<string, string>;
-    log: Logger;
-    cache: CacheClient;
-    palbase: PalbaseBindings;
-    requestId: string;
-    projectId: string;
-    environmentId: string;
-}
-/** Middleware function signature — receives context and next function. */
-type MiddlewareHandler = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-/**
- * Define a middleware function for use in the middleware/ directory or
- * as endpoint-specific middleware.
- *
- * Middleware runs before the handler. Call `next()` to pass control
- * to the next middleware or handler. If `next()` is not called, the
- * handler will not execute.
- *
- * Errors thrown in middleware are caught by the pipeline and returned
- * as error responses.
- */
-declare function defineMiddleware(fn: MiddlewareHandler): MiddlewareHandler;
-
-/** Rate limit configuration for an endpoint. */
-interface RateLimitConfig {
-    /** Maximum number of requests in the window. */
-    max: number;
-    /** Window duration in seconds. */
-    window: number;
-}
-/** Database client interface injected into endpoint context. */
-interface DBClient {
-    insert(table: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
-    update(table: string, id: string, data: Record<string, unknown>): Promise<Record<string, unknown>>;
-    delete(table: string, id: string): Promise<void>;
-    findById(table: string, id: string): Promise<Record<string, unknown> | null>;
-    findMany(table: string, query?: Record<string, unknown>): Promise<Record<string, unknown>[]>;
-}
-/** Logger interface injected into endpoint context. */
-interface Logger {
-    info(message: string, ...args: unknown[]): void;
-    warn(message: string, ...args: unknown[]): void;
-    error(message: string, ...args: unknown[]): void;
-    debug(message: string, ...args: unknown[]): void;
-}
-/** Cache client interface injected into endpoint context. */
-interface CacheClient {
-    get(key: string): Promise<string | null>;
-    set(key: string, value: string, ttl?: number): Promise<void>;
-    del(key: string): Promise<void>;
-    incr(key: string): Promise<number>;
-}
-/** Palbase service bindings for accessing other modules. */
-interface PalbaseBindings {
-    auth: Record<string, unknown>;
-    storage: Record<string, unknown>;
-}
-/** Endpoint context — injected into every handler. */
-interface EndpointContext<TInput = unknown> {
-    input: TInput;
-    params: Record<string, string>;
-    query: Record<string, string>;
-    headers: Record<string, string>;
-    user: User | null;
-    db: DBClient;
-    env: Record<string, string>;
-    log: Logger;
-    cache: CacheClient;
-    palbase: PalbaseBindings;
-    requestId: string;
-    projectId: string;
-    environmentId: string;
-}
-/** Middleware function signature — uses MiddlewareContext (no input, not yet validated). */
-type Middleware = (ctx: MiddlewareContext, next: () => Promise<void>) => Promise<void>;
-/** Configuration for defining an endpoint. */
-interface EndpointConfig<TInputSchema extends ZodSchema = ZodSchema, TOutputSchema extends ZodSchema = ZodSchema> {
-    method: HttpMethod;
-    auth?: Partial<AuthConfig>;
-    rateLimit?: RateLimitConfig;
-    input?: TInputSchema;
-    output?: TOutputSchema;
-    middleware?: Middleware[];
-    handler: (ctx: EndpointContext<z.infer<TInputSchema>>) => Promise<z.infer<TOutputSchema>>;
-}
-/** Define a type-safe endpoint. Input schema infers the ctx.input type. */
-declare function defineEndpoint<TInputSchema extends ZodSchema, TOutputSchema extends ZodSchema>(config: EndpointConfig<TInputSchema, TOutputSchema>): EndpointConfig<TInputSchema, TOutputSchema>;
-
-export { type AuthConfig as A, type CacheClient as C, type DBClient as D, type EndpointContext as E, type HttpMethod as H, type Logger as L, type Middleware as M, type PalbaseBindings as P, type RateLimitConfig as R, type User as U, type EndpointConfig as a, type MiddlewareContext as b, type MiddlewareHandler as c, defineEndpoint as d, defineMiddleware as e };