@kosmojs/api 0.0.20 → 0.0.21

package/pkg/src/bodyparser/types.d.ts

@@ -1,39 +0,0 @@
-import type { Options as FormidableOptions } from "formidable";
-export type TrimOption = Array<string>;
-export type Trimmer = (fields: Record<string, unknown>) => Record<string, unknown>;
-type GenericOptions = {
-    limit?: number;
-    trim?: TrimOption;
-};
-export type JsonOptions = FormidableOptions & GenericOptions;
-export type FormOptions = FormidableOptions & GenericOptions & {
-    uploadDir?: string;
-    multipart?: boolean;
-    urlencoded?: boolean;
-};
-export type RawOptions = {
-    /**
-     * The byte limit of the body.
-     * If the body ends up being larger than this limit, a 413 error code is returned.
-     * */
-    limit?: number;
-    /**
-     * The length of the stream.
-     * If the contents of the stream do not add up to this length,
-     * an 400 error code is returned
-     * */
-    length?: number;
-    /**
-     * The encoding to use to decode the body into a string.
-     * By default, a Buffer instance will be returned when no encoding is specified.
-     * utf-8 would decode as plain text.
-     * use any encoding supported by iconv-lite.
-     * */
-    encoding?: string;
-    /**
-     * zlib options
-     * */
-    chunkSize?: number;
-};
-export type Options = JsonOptions | FormOptions | RawOptions;
-export {};

package/pkg/src/debug.d.ts

@@ -1,10 +0,0 @@
-import type { HandlerDefinition, MiddlewareDefinition, RouterRoute } from "./types";
-declare const _default: (entry: {
-    name: string;
-    path: string;
-    file: string;
-    methods: Array<string>;
-    middleware: Array<MiddlewareDefinition>;
-    handler: HandlerDefinition;
-}) => RouterRoute["debug"];
-export default _default;

package/pkg/src/errors/index.d.ts

@@ -1,18 +0,0 @@
-import type { ValidationErrorData, ValidationErrorEntry, ValidationErrorScope } from "../types";
-/**
- * Standardized error wrapper used by validation generators.
- *
- * Instances of this class are thrown whenever validation fails,
- * carrying both the error scope (e.g. `"params"`, `"payload"`)
- * and the list of validation error details.
- * */
-export declare class ValidationError extends Error {
-    scope: ValidationErrorScope;
-    errors: Array<ValidationErrorEntry>;
-    errorMessage: string;
-    errorSummary: string;
-    constructor([scope, { errors, errorMessage, errorSummary }]: [
-        ValidationErrorScope,
-        ValidationErrorData
-    ]);
-}

package/pkg/src/index.d.ts

@@ -1,5 +0,0 @@
-export * from "./app";
-export * from "./errors";
-export * from "./router";
-export * from "./types";
-export * from "./use";

package/pkg/src/queryparser/index.d.ts

@@ -1,5 +0,0 @@
-import type Koa from "koa";
-import type { IParseOptions, IStringifyOptions } from "qs";
-import type { DefaultContext, DefaultState } from "../types";
-declare const _default: <T extends InstanceType<typeof Koa<DefaultState, DefaultContext>> = never>(app: T, _parseOptions?: IParseOptions, _stringifyOptions?: IStringifyOptions) => T;
-export default _default;

package/pkg/src/router.d.ts

@@ -1,7 +0,0 @@
-import Router from "@koa/router";
-import type { DefineRoute, MiddlewareDefinition, RouterOptions, RouterRoute, RouterRouteSource } from "./types";
-export declare const defineRoute: DefineRoute;
-export declare const createRouter: (options?: RouterOptions) => Router<import("koa").DefaultState, import("koa").DefaultContext>;
-export declare const createRouterRoutes: (routeSources: Array<RouterRouteSource>, { coreMiddleware, }: {
-    coreMiddleware: Array<MiddlewareDefinition>;
-}) => Array<RouterRoute>;

package/pkg/src/types.d.ts

@@ -1,133 +0,0 @@
-import type { RouterContext, RouterMiddleware } from "@koa/router";
-import type { Next } from "koa";
-declare module "koa" {
-    interface Request {
-        body?: unknown;
-        rawBody: string;
-    }
-}
-export interface DefaultState {
-}
-export interface DefaultContext {
-}
-export declare enum HTTPMethods {
-    HEAD = "HEAD",
-    OPTIONS = "OPTIONS",
-    GET = "GET",
-    PUT = "PUT",
-    PATCH = "PATCH",
-    POST = "POST",
-    DELETE = "DELETE"
-}
-export type HTTPMethod = keyof typeof HTTPMethods;
-export type ParameterizedContext<ParamsT, StateT, ContextT, PayloadT = unknown, ResponseT = unknown> = RouterContext<DefaultState & StateT, DefaultContext & ContextT & {
-    typedParams: ParamsT;
-    payload: PayloadT;
-}, ResponseT>;
-export type ParameterizedMiddleware<ParamsT = {}, StateT = {}, ContextT = {}> = (ctx: ParameterizedContext<ParamsT, StateT, ContextT>, next: Next) => Promise<void> | void;
-export type RouteHandler<ParamsT, StateT, ContextT, PayloadT = unknown, ResponseT = unknown> = (ctx: ParameterizedContext<ParamsT, StateT, ContextT, PayloadT, ResponseT>, next: Next) => Promise<void> | void;
-export type MiddlewareDefinition = {
-    kind: "middleware";
-    middleware: Array<ParameterizedMiddleware>;
-    options?: UseOptions | undefined;
-};
-export type HandlerDefinition = {
-    kind: "handler";
-    middleware: Array<ParameterizedMiddleware>;
-    method: HTTPMethod;
-};
-export type RouteDefinitionItem = MiddlewareDefinition | HandlerDefinition;
-export type DefineRouteHelpers<ParamsT, StateT, ContextT, OptionalHandlers = undefined> = {
-    use: (middleware: ParameterizedMiddleware<ParamsT, StateT, ContextT> | Array<ParameterizedMiddleware<ParamsT, StateT, ContextT>>, options?: UseOptions) => RouteDefinitionItem;
-} & {
-    [M in HTTPMethod]: M extends OptionalHandlers ? <PayloadT = unknown, ResponseT = unknown>(handler?: RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT> | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>) => RouteDefinitionItem : <PayloadT = unknown, ResponseT = unknown>(handler: RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT> | Array<RouteHandler<ParamsT, StateT, ContextT, PayloadT, ResponseT>>) => RouteDefinitionItem;
-};
-export type DefineRoute = <ParamsT = Record<string, string>, StateT = object, ContextT = object>(factory: (helpers: DefineRouteHelpers<ParamsT, StateT, ContextT>) => Array<RouteDefinitionItem>) => Array<RouteDefinitionItem>;
-export interface UseSlots {
-    errorHandler: string;
-    params: string;
-    validateParams: string;
-    bodyparser: string;
-    payload: string;
-    validatePayload: string;
-    validateResponse: string;
-}
-export type UseOptions = {
-    on?: Array<HTTPMethod>;
-    slot?: keyof UseSlots;
-    debug?: string | undefined;
-};
-export type Use = <StateT = DefaultState, ContextT = DefaultContext>(middleware: ParameterizedMiddleware<Record<string, string>, StateT, ContextT> | Array<ParameterizedMiddleware<Record<string, string>, StateT, ContextT>>, options?: UseOptions) => MiddlewareDefinition;
-export type RouterRouteSource = {
-    name: string;
-    path: string;
-    file: string;
-    useWrappers: [...a: Array<MiddlewareDefinition>];
-    definitionItems: Array<RouteDefinitionItem>;
-    params: Array<[name: string, isRest?: boolean]>;
-    numericParams: Array<string>;
-    validationSchemas: ValidationSchemas;
-    meta?: Record<string, unknown>;
-};
-export type RouterRoute = {
-    name: string;
-    path: string;
-    file: string;
-    methods: Array<string>;
-    middleware: Array<RouterMiddleware>;
-    debug: {
-        headline: string;
-        methods: string;
-        middleware: string;
-        handler: string;
-        full: string;
-    };
-};
-import type Koa from "koa";
-export type App = Koa<DefaultState, DefaultContext>;
-export type AppOptions = ConstructorParameters<typeof import("koa")>[0];
-export type Router = import("@koa/router").Router<DefaultState, DefaultContext>;
-export type RouterOptions = import("@koa/router").RouterOptions;
-export type DevMiddlewareFactory = (app: App) => (req: import("node:http").IncomingMessage, res: import("node:http").ServerResponse, next: () => Promise<void>) => Promise<void>;
-export type TeardownHandler = (app: App) => void | Promise<void>;
-export type ValidationSchema = {
-    check: (data: unknown) => boolean;
-    errors: (data: unknown) => Array<ValidationErrorEntry>;
-    errorMessage: (data: unknown) => string;
-    errorSummary: (data: unknown) => string;
-    validate: (data: unknown) => void;
-};
-export type ValidationSchemas<Extend = object> = {
-    params?: ValidationSchema & Extend;
-    payload?: Record<string, ValidationSchema & Extend>;
-    response?: Record<string, ValidationSchema & Extend>;
-};
-export type ValidationErrorScope = "params" | "payload" | "response";
-/**
- * Shape of individual validation errors emitted by generators.
- */
-export type ValidationErrorEntry = {
-    /** JSON Schema keyword that triggered the error (e.g. `format`, `maxItems`, `maxLength`). */
-    keyword: string;
-    /** JSON Pointer–style path to the invalid field (matches JSON Schema `instancePath`). */
-    path: string;
-    /** Human-readable error message. */
-    message: string;
-    /** Constraint parameters (e.g. `{ limit: 5 }`, `{ format: "email" }`). */
-    params?: Record<string, unknown>;
-    /** Optional error code for i18n/l10n or custom handling. */
-    code?: string;
-};
-export type ValidationErrorData = {
-    errors: Array<ValidationErrorEntry>;
-    /**
-     * Formats errors into a single human-readable message.
-     * @example: Validation failed: user: missing required properties: "email", "name"; password: must be at least 8 characters long
-     */
-    errorMessage: string;
-    /**
-     * Gets a simple error summary for quick feedback.
-     * @example: 2 validation errors found across 2 fields
-     */
-    errorSummary: string;
-};

package/pkg/src/use.d.ts

@@ -1,2 +0,0 @@
-import type { Use } from "./types";
-export declare const use: Use;

package/pkg/test/createRouterRoutes/params.test.d.ts

@@ -1 +0,0 @@
-export {};

package/pkg/test/createRouterRoutes/routeMiddleware.test.d.ts

@@ -1 +0,0 @@
-export {};

package/pkg/test/createRouterRoutes/useWrappers.test.d.ts

@@ -1 +0,0 @@
-export {};

package/pkg/test/defineRoute.test.d.ts

@@ -1 +0,0 @@
-export {};

package/pkg/test/index.d.ts

@@ -1,7 +0,0 @@
-import Koa, { type Context, type Next } from "koa";
-import { type MiddlewareDefinition, type RouterRouteSource } from "../src/types";
-export declare const defaultMethods: string[];
-export declare const middlewareStackBuilder: (a: Array<Partial<RouterRouteSource>>, b: {
-    coreMiddleware?: Array<MiddlewareDefinition>;
-}) => import("../src/types").RouterRoute[];
-export declare const runMiddleware: <T = any>(middleware: Array<(ctx: T, next: Next) => void | Promise<void>>, ctxOverrides?: Partial<Context>) => Promise<Koa.ParameterizedContext<Koa.DefaultState, Koa.DefaultContext, unknown>>;

package/pkg/test/use.test.d.ts

@@ -1 +0,0 @@
-export {};