@mpen/routekit 0.1.0 → 0.1.2

package/src/router/response/formats/problem/conflict.ts

@@ -1,90 +0,0 @@
-import { HttpStatus } from '@mpen/http'
-import type { RoutekitResponse } from '../../core'
-import { problem, type ProblemResponseInit } from './responses'
-import type { ProblemResponse } from './types'
-
-/**
- * Options accepted by [`conflict`]{@link conflict}.
- *
- * @example
- * ```ts
- * conflict({
- *     message: 'The resource already exists.',
- * })
- * ```
- *
- * @typeParam Code - Machine-readable primary error code.
- */
-export interface ConflictInit<Code extends string = 'conflict'> extends Omit<
-    ProblemResponseInit<Code>,
-    'code' | 'status' | 'message'
-> {
-    /**
-     * Machine-readable error code. Defaults to `'conflict'`.
-     */
-    code?: Code
-
-    /**
-     * Human-readable problem message.
-     */
-    message?: string
-
-    /**
-     * HTTP status code for this response. Defaults to `409`.
-     */
-    status?: number | HttpStatus
-}
-
-/**
- * Create a standard 409 Conflict problem response envelope.
- *
- * @example
- * ```ts
- * return conflict('A user with this email address already exists.')
- * ```
- *
- * @param message - Human-readable problem message.
- * @param init - Optional extra problem response options.
- * @returns Routekit logical response with a `'conflict'` [`ProblemResponse`]{@link ProblemResponse}.
- */
-export function conflict(
-    message: string,
-    init?: Omit<ConflictInit<'conflict'>, 'message'>,
-): RoutekitResponse<ProblemResponse<'conflict'>>
-
-/**
- * Create a standard 409 Conflict problem response envelope.
- *
- * @example
- * ```ts
- * return conflict({ message: 'State conflict.' })
- * ```
- *
- * @param init - Optional problem response options.
- * @returns Routekit logical response with a [`ProblemResponse`]{@link ProblemResponse}.
- * @typeParam Code - Machine-readable primary error code.
- */
-export function conflict<const Code extends string = 'conflict'>(
-    init?: ConflictInit<Code>,
-): RoutekitResponse<ProblemResponse<Code>>
-
-export function conflict<const Code extends string = 'conflict'>(
-    messageOrInit?: string | ConflictInit<Code>,
-    init?: Omit<ConflictInit<Code>, 'message'>,
-): RoutekitResponse<ProblemResponse<Code>> {
-    if (typeof messageOrInit === 'string') {
-        return problem({
-            ...init,
-            code: (init?.code ?? 'conflict') as Code,
-            message: messageOrInit,
-            status: init?.status ?? HttpStatus.CONFLICT,
-        })
-    }
-
-    return problem({
-        ...messageOrInit,
-        code: (messageOrInit?.code ?? 'conflict') as Code,
-        message: messageOrInit?.message ?? 'Conflict',
-        status: messageOrInit?.status ?? HttpStatus.CONFLICT,
-    })
-}

package/src/router/response/formats/problem/created.ts

@@ -1,40 +0,0 @@
-import { HttpStatus } from '@mpen/http'
-import { response, type RoutekitResponse } from '../../core'
-import type { SuccessResponseInit } from './responses'
-import type { SuccessResponse } from './types'
-
-function withDefinedOptional<Value extends object, Key extends string, Field>(
-    value: Value,
-    key: Key,
-    field: Field | undefined,
-): Value | (Value & Record<Key, Field>) {
-    if (field === undefined) return value
-    return { ...value, [key]: field } as Value & Record<Key, Field>
-}
-
-/**
- * Create a `201 Created` standard response envelope.
- *
- * @example
- * ```ts
- * router.post('/users', () => created({ id: 'user_123' }))
- * ```
- *
- * @param data - Successful response payload.
- * @param init - Response headers and optional metadata.
- * @returns Routekit logical response with an [`SuccessResponse`]{@link SuccessResponse} body.
- * @typeParam Data - Successful response payload type.
- * @typeParam Meta - Optional metadata payload type.
- */
-export function created<const Data, const Meta = unknown>(
-    data: Data,
-    init: SuccessResponseInit<Meta> = {},
-): RoutekitResponse<SuccessResponse<Data, Meta>, HttpStatus.CREATED> {
-    const { meta, ...responseInit } = init
-    const body = withDefinedOptional(
-        { success: true, data } as const,
-        'meta',
-        meta,
-    ) as SuccessResponse<Data, Meta>
-    return response(body, { ...responseInit, status: HttpStatus.CREATED })
-}

package/src/router/response/formats/problem/index.ts

@@ -1,27 +0,0 @@
-export {
-    ok,
-    problem,
-    VALIDATION_PROBLEM_CODE,
-    validationProblem,
-    type SuccessResponseInit,
-    type ProblemResponseInit,
-    type ValidationProblemInit,
-} from './responses'
-export { created } from './created'
-export { notFound, type NotFoundInit } from './notFound'
-export { permissionDenied, type PermissionDeniedInit } from './permissionDenied'
-export { unauthenticated, type UnauthenticatedInit } from './unauthenticated'
-export { sessionExpired, type SessionExpiredInit } from './sessionExpired'
-export { badRequest, type BadRequestInit } from './badRequest'
-export { conflict, type ConflictInit } from './conflict'
-export { rateLimited, type RateLimitedInit } from './rateLimited'
-export { problemRootErrors } from './root-errors'
-
-export type {
-    SuccessResponse,
-    ProblemError,
-    ProblemIssue,
-    ProblemIssuePathSegment,
-    ProblemResponse,
-    StandardResponse,
-} from './types'

package/src/router/response/formats/problem/notFound.ts

@@ -1,90 +0,0 @@
-import { HttpStatus } from '@mpen/http'
-import type { RoutekitResponse } from '../../core'
-import { problem, type ProblemResponseInit } from './responses'
-import type { ProblemResponse } from './types'
-
-/**
- * Options accepted by [`notFound`]{@link notFound}.
- *
- * @example
- * ```ts
- * notFound({
- *     message: 'No user exists for the provided id.',
- * })
- * ```
- *
- * @typeParam Code - Machine-readable primary error code.
- */
-export interface NotFoundInit<Code extends string = 'not_found'> extends Omit<
-    ProblemResponseInit<Code>,
-    'code' | 'status' | 'message'
-> {
-    /**
-     * Machine-readable error code. Defaults to `'not_found'`.
-     */
-    code?: Code
-
-    /**
-     * Human-readable problem message.
-     */
-    message?: string
-
-    /**
-     * HTTP status code for this response. Defaults to `404`.
-     */
-    status?: number | HttpStatus
-}
-
-/**
- * Create a standard 404 Not Found problem response envelope.
- *
- * @example
- * ```ts
- * return notFound('Todo not found.')
- * ```
- *
- * @param message - Human-readable problem message.
- * @param init - Optional extra problem response options.
- * @returns Routekit logical response with a `'not_found'` [`ProblemResponse`]{@link ProblemResponse}.
- */
-export function notFound(
-    message: string,
-    init?: Omit<NotFoundInit<'not_found'>, 'message'>,
-): RoutekitResponse<ProblemResponse<'not_found'>>
-
-/**
- * Create a standard 404 Not Found problem response envelope.
- *
- * @example
- * ```ts
- * return notFound({ message: 'Todo not found.' })
- * ```
- *
- * @param init - Optional problem response options.
- * @returns Routekit logical response with a [`ProblemResponse`]{@link ProblemResponse}.
- * @typeParam Code - Machine-readable primary error code.
- */
-export function notFound<const Code extends string = 'not_found'>(
-    init?: NotFoundInit<Code>,
-): RoutekitResponse<ProblemResponse<Code>>
-
-export function notFound<const Code extends string = 'not_found'>(
-    messageOrInit?: string | NotFoundInit<Code>,
-    init?: Omit<NotFoundInit<Code>, 'message'>,
-): RoutekitResponse<ProblemResponse<Code>> {
-    if (typeof messageOrInit === 'string') {
-        return problem({
-            ...init,
-            code: (init?.code ?? 'not_found') as Code,
-            message: messageOrInit,
-            status: init?.status ?? HttpStatus.NOT_FOUND,
-        })
-    }
-
-    return problem({
-        ...messageOrInit,
-        code: (messageOrInit?.code ?? 'not_found') as Code,
-        message: messageOrInit?.message ?? 'Not found',
-        status: messageOrInit?.status ?? HttpStatus.NOT_FOUND,
-    })
-}

package/src/router/response/formats/problem/permissionDenied.ts

@@ -1,90 +0,0 @@
-import { HttpStatus } from '@mpen/http'
-import type { RoutekitResponse } from '../../core'
-import { problem, type ProblemResponseInit } from './responses'
-import type { ProblemResponse } from './types'
-
-/**
- * Options accepted by [`permissionDenied`]{@link permissionDenied}.
- *
- * @example
- * ```ts
- * permissionDenied({
- *     message: 'You do not have permission to perform this action.',
- * })
- * ```
- *
- * @typeParam Code - Machine-readable primary error code.
- */
-export interface PermissionDeniedInit<Code extends string = 'permission_denied'> extends Omit<
-    ProblemResponseInit<Code>,
-    'code' | 'status' | 'message'
-> {
-    /**
-     * Machine-readable error code. Defaults to `'permission_denied'`.
-     */
-    code?: Code
-
-    /**
-     * Human-readable problem message.
-     */
-    message?: string
-
-    /**
-     * HTTP status code for this response. Defaults to `403`.
-     */
-    status?: number | HttpStatus
-}
-
-/**
- * Create a standard 403 Permission Denied problem response envelope.
- *
- * @example
- * ```ts
- * return permissionDenied('You are not authorized to edit this profile.')
- * ```
- *
- * @param message - Human-readable problem message.
- * @param init - Optional extra problem response options.
- * @returns Routekit logical response with a `'permission_denied'` [`ProblemResponse`]{@link ProblemResponse}.
- */
-export function permissionDenied(
-    message: string,
-    init?: Omit<PermissionDeniedInit<'permission_denied'>, 'message'>,
-): RoutekitResponse<ProblemResponse<'permission_denied'>>
-
-/**
- * Create a standard 403 Permission Denied problem response envelope.
- *
- * @example
- * ```ts
- * return permissionDenied({ message: 'Insufficient scope.' })
- * ```
- *
- * @param init - Optional problem response options.
- * @returns Routekit logical response with a [`ProblemResponse`]{@link ProblemResponse}.
- * @typeParam Code - Machine-readable primary error code.
- */
-export function permissionDenied<const Code extends string = 'permission_denied'>(
-    init?: PermissionDeniedInit<Code>,
-): RoutekitResponse<ProblemResponse<Code>>
-
-export function permissionDenied<const Code extends string = 'permission_denied'>(
-    messageOrInit?: string | PermissionDeniedInit<Code>,
-    init?: Omit<PermissionDeniedInit<Code>, 'message'>,
-): RoutekitResponse<ProblemResponse<Code>> {
-    if (typeof messageOrInit === 'string') {
-        return problem({
-            ...init,
-            code: (init?.code ?? 'permission_denied') as Code,
-            message: messageOrInit,
-            status: init?.status ?? HttpStatus.FORBIDDEN,
-        })
-    }
-
-    return problem({
-        ...messageOrInit,
-        code: (messageOrInit?.code ?? 'permission_denied') as Code,
-        message: messageOrInit?.message ?? 'Permission denied',
-        status: messageOrInit?.status ?? HttpStatus.FORBIDDEN,
-    })
-}