@pikku/core 0.6.9

package/dist/errors/errors.d.ts

@@ -0,0 +1,190 @@
+/**
+ * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
+ */
+import { EError } from './error-handler.js';
+/**
+ * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
+ * @group Error
+ */
+export declare class BadRequestError extends EError {
+}
+/**
+ * Authentication is required and has failed or has not yet been provided.
+ * @group Error
+ */
+export declare class UnauthorizedError extends EError {
+}
+/**
+ * More specific error to why it's unauthorized.
+ * @group Error
+ */
+export declare class MissingSessionError extends EError {
+}
+/**
+ * More specific error to why it's unauthorized.
+ * @group Error
+ */
+export declare class InvalidSessionError extends EError {
+}
+/**
+ * Reserved for future use, often related to digital payment or subscription services.
+ * @group Error
+ */
+export declare class PaymentRequiredError extends EError {
+}
+/**
+ * The client does not have permission to access the requested resource.
+ * @group Error
+ */
+export declare class ForbiddenError extends EError {
+}
+/**
+ * The request was made from an origin that is not permitted to access this resource.
+ * @group Error
+ */
+export declare class InvalidOriginError extends EError {
+}
+/**
+ * The server cannot find the requested resource.
+ * @group Error
+ */
+export declare class NotFoundError extends EError {
+}
+/**
+ * The request method is known by the server but is not supported by the resource.
+ * @group Error
+ */
+export declare class MethodNotAllowedError extends EError {
+}
+/**
+ * The requested resource cannot produce a response matching the list of acceptable values in the request's headers.
+ * @group Error
+ */
+export declare class NotAcceptableError extends EError {
+}
+/**
+ * The client must authenticate itself to get the requested response.
+ * @group Error
+ */
+export declare class ProxyAuthenticationRequiredError extends EError {
+}
+/**
+ * The server did not receive a timely response from an upstream server.
+ * @group Error
+ */
+export declare class RequestTimeoutError extends EError {
+}
+/**
+ * The request could not be completed due to a conflict with the current state of the target resource.
+ * @group Error
+ */
+export declare class ConflictError extends EError {
+}
+/**
+ * The resource that is being accessed is no longer available and will not be available again.
+ * @group Error
+ */
+export declare class GoneError extends EError {
+}
+/**
+ * The request did not specify the length of its content, which is required by the requested resource.
+ * @group Error
+ */
+export declare class LengthRequiredError extends EError {
+}
+/**
+ * The server does not meet one of the preconditions that the requester put on the request.
+ * @group Error
+ */
+export declare class PreconditionFailedError extends EError {
+}
+/**
+ * The request is larger than the server is willing or able to process.
+ * @group Error
+ */
+export declare class PayloadTooLargeError extends EError {
+}
+/**
+ * The URI requested by the client is longer than the server is willing to interpret.
+ * @group Error
+ */
+export declare class URITooLongError extends EError {
+}
+/**
+ * The server does not support the media format of the requested data.
+ * @group Error
+ */
+export declare class UnsupportedMediaTypeError extends EError {
+}
+/**
+ * The client has asked for a portion of the file, but the server cannot supply that portion.
+ * @group Error
+ */
+export declare class RangeNotSatisfiableError extends EError {
+}
+/**
+ * The server cannot meet the requirements of the Expect request-header field.
+ * @group Error
+ */
+export declare class ExpectationFailedError extends EError {
+}
+/**
+ * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
+ * @group Error
+ */
+export declare class UnprocessableContentError extends EError {
+}
+/**
+ * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
+ * @group Error
+ */
+export declare class LockedError extends EError {
+}
+/**
+ * The user has sent too many requests in a given amount of time ("rate limiting").
+ * @group Error
+ */
+export declare class TooManyRequestsError extends EError {
+}
+/**
+ * A generic error message, given when no more specific message is suitable.
+ * @group Error
+ */
+export declare class InternalServerError extends EError {
+}
+/**
+ * The server does not recognize the request method and cannot support it.
+ * @group Error
+ */
+export declare class NotImplementedError extends EError {
+}
+/**
+ * The server was acting as a gateway or proxy and received an invalid response from the upstream server.
+ * @group Error
+ */
+export declare class BadGatewayError extends EError {
+}
+/**
+ * The server is currently unavailable (overloaded or down).
+ * @group Error
+ */
+export declare class ServiceUnavailableError extends EError {
+}
+/**
+ * The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
+ * @group Error
+ */
+export declare class GatewayTimeoutError extends EError {
+}
+/**
+ * The server does not support the HTTP protocol version used in the request.
+ * @group Error
+ */
+export declare class HTTPVersionNotSupportedError extends EError {
+}
+/**
+ * The server took too long to complete the request, reaching the maximum compute time allowed.
+ * @group Error
+ */
+export declare class MaxComputeTimeReachedError extends EError {
+}

package/dist/errors/errors.js

@@ -0,0 +1,315 @@
+/**
+ * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
+ */
+import { addError, EError } from './error-handler.js';
+/**
+ * The server cannot or will not process the request due to client error (e.g., malformed request syntax).
+ * @group Error
+ */
+export class BadRequestError extends EError {
+}
+addError(BadRequestError, {
+    status: 400,
+    message: 'The server cannot or will not process the request due to client error (e.g., malformed request syntax).',
+});
+/**
+ * Authentication is required and has failed or has not yet been provided.
+ * @group Error
+ */
+export class UnauthorizedError extends EError {
+}
+/**
+ * More specific error to why it's unauthorized.
+ * @group Error
+ */
+export class MissingSessionError extends EError {
+}
+/**
+ * More specific error to why it's unauthorized.
+ * @group Error
+ */
+export class InvalidSessionError extends EError {
+}
+addError(UnauthorizedError, {
+    status: 401,
+    message: 'Authentication is required and has failed or has not yet been provided.',
+});
+addError(MissingSessionError, { status: 401, message: 'Session missing.' });
+addError(InvalidSessionError, {
+    status: 401,
+    message: 'The session provided is not valid.',
+});
+/**
+ * Reserved for future use, often related to digital payment or subscription services.
+ * @group Error
+ */
+export class PaymentRequiredError extends EError {
+}
+addError(PaymentRequiredError, {
+    status: 402,
+    message: 'Reserved for future use, often related to digital payment or subscription services.',
+});
+/**
+ * The client does not have permission to access the requested resource.
+ * @group Error
+ */
+export class ForbiddenError extends EError {
+}
+addError(ForbiddenError, {
+    status: 403,
+    message: 'The client does not have permission to access the requested resource.',
+});
+/**
+ * The request was made from an origin that is not permitted to access this resource.
+ * @group Error
+ */
+export class InvalidOriginError extends EError {
+}
+addError(InvalidOriginError, {
+    status: 403,
+    message: 'The request was made from an origin that is not permitted to access this resource.',
+});
+/**
+ * The server cannot find the requested resource.
+ * @group Error
+ */
+export class NotFoundError extends EError {
+}
+/**
+ * The server cannot find the requested route.
+ * @group Error
+ */
+addError(NotFoundError, {
+    status: 404,
+    message: 'The server cannot find the requested resource.',
+});
+/**
+ * The request method is known by the server but is not supported by the resource.
+ * @group Error
+ */
+export class MethodNotAllowedError extends EError {
+}
+addError(MethodNotAllowedError, {
+    status: 405,
+    message: 'The request method is known by the server but is not supported by the resource.',
+});
+/**
+ * The requested resource cannot produce a response matching the list of acceptable values in the request's headers.
+ * @group Error
+ */
+export class NotAcceptableError extends EError {
+}
+addError(NotAcceptableError, {
+    status: 406,
+    message: "The requested resource cannot produce a response matching the list of acceptable values in the request's headers.",
+});
+/**
+ * The client must authenticate itself to get the requested response.
+ * @group Error
+ */
+export class ProxyAuthenticationRequiredError extends EError {
+}
+addError(ProxyAuthenticationRequiredError, {
+    status: 407,
+    message: 'The client must authenticate itself to get the requested response.',
+});
+/**
+ * The server did not receive a timely response from an upstream server.
+ * @group Error
+ */
+export class RequestTimeoutError extends EError {
+}
+addError(RequestTimeoutError, {
+    status: 408,
+    message: 'The server did not receive a timely response from an upstream server.',
+});
+/**
+ * The request could not be completed due to a conflict with the current state of the target resource.
+ * @group Error
+ */
+export class ConflictError extends EError {
+}
+addError(ConflictError, {
+    status: 409,
+    message: 'The request could not be completed due to a conflict with the current state of the target resource.',
+});
+/**
+ * The resource that is being accessed is no longer available and will not be available again.
+ * @group Error
+ */
+export class GoneError extends EError {
+}
+addError(GoneError, {
+    status: 410,
+    message: 'The resource that is being accessed is no longer available and will not be available again.',
+});
+/**
+ * The request did not specify the length of its content, which is required by the requested resource.
+ * @group Error
+ */
+export class LengthRequiredError extends EError {
+}
+addError(LengthRequiredError, {
+    status: 411,
+    message: 'The request did not specify the length of its content, which is required by the requested resource.',
+});
+/**
+ * The server does not meet one of the preconditions that the requester put on the request.
+ * @group Error
+ */
+export class PreconditionFailedError extends EError {
+}
+addError(PreconditionFailedError, {
+    status: 412,
+    message: 'The server does not meet one of the preconditions that the requester put on the request.',
+});
+/**
+ * The request is larger than the server is willing or able to process.
+ * @group Error
+ */
+export class PayloadTooLargeError extends EError {
+}
+addError(PayloadTooLargeError, {
+    status: 413,
+    message: 'The request is larger than the server is willing or able to process.',
+});
+/**
+ * The URI requested by the client is longer than the server is willing to interpret.
+ * @group Error
+ */
+export class URITooLongError extends EError {
+}
+addError(URITooLongError, {
+    status: 414,
+    message: 'The URI requested by the client is longer than the server is willing to interpret.',
+});
+/**
+ * The server does not support the media format of the requested data.
+ * @group Error
+ */
+export class UnsupportedMediaTypeError extends EError {
+}
+addError(UnsupportedMediaTypeError, {
+    status: 415,
+    message: 'The server does not support the media format of the requested data.',
+});
+/**
+ * The client has asked for a portion of the file, but the server cannot supply that portion.
+ * @group Error
+ */
+export class RangeNotSatisfiableError extends EError {
+}
+addError(RangeNotSatisfiableError, {
+    status: 416,
+    message: 'The client has asked for a portion of the file, but the server cannot supply that portion.',
+});
+/**
+ * The server cannot meet the requirements of the Expect request-header field.
+ * @group Error
+ */
+export class ExpectationFailedError extends EError {
+}
+addError(ExpectationFailedError, {
+    status: 417,
+    message: 'The server cannot meet the requirements of the Expect request-header field.',
+});
+/**
+ * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
+ * @group Error
+ */
+export class UnprocessableContentError extends EError {
+}
+addError(UnprocessableContentError, {
+    status: 422,
+    message: 'The server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions..',
+});
+/**
+ * Indicates that the server understood the content type of the request content, and the syntax of the request content was correct, but it was unable to process the contained instructions.
+ * @group Error
+ */
+export class LockedError extends EError {
+}
+addError(LockedError, {
+    status: 423,
+    message: "The resource is locked, meaning it can't be accessed. Its response body should contain information in WebDAV's XML format.",
+});
+/**
+ * The user has sent too many requests in a given amount of time ("rate limiting").
+ * @group Error
+ */
+export class TooManyRequestsError extends EError {
+}
+addError(TooManyRequestsError, {
+    status: 429,
+    message: 'The user has sent too many requests in a given amount of time ("rate limiting").',
+});
+/**
+ * A generic error message, given when no more specific message is suitable.
+ * @group Error
+ */
+export class InternalServerError extends EError {
+}
+addError(InternalServerError, {
+    status: 500,
+    message: 'A generic error message, given when no more specific message is suitable.',
+});
+/**
+ * The server does not recognize the request method and cannot support it.
+ * @group Error
+ */
+export class NotImplementedError extends EError {
+}
+addError(NotImplementedError, {
+    status: 501,
+    message: 'The server does not recognize the request method and cannot support it.',
+});
+/**
+ * The server was acting as a gateway or proxy and received an invalid response from the upstream server.
+ * @group Error
+ */
+export class BadGatewayError extends EError {
+}
+addError(BadGatewayError, {
+    status: 502,
+    message: 'The server was acting as a gateway or proxy and received an invalid response from the upstream server.',
+});
+/**
+ * The server is currently unavailable (overloaded or down).
+ * @group Error
+ */
+export class ServiceUnavailableError extends EError {
+}
+addError(ServiceUnavailableError, {
+    status: 503,
+    message: 'The server is currently unavailable (overloaded or down).',
+});
+/**
+ * The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.
+ * @group Error
+ */
+export class GatewayTimeoutError extends EError {
+}
+addError(GatewayTimeoutError, {
+    status: 504,
+    message: 'The server was acting as a gateway or proxy and did not receive a timely response from the upstream server.',
+});
+/**
+ * The server does not support the HTTP protocol version used in the request.
+ * @group Error
+ */
+export class HTTPVersionNotSupportedError extends EError {
+}
+addError(HTTPVersionNotSupportedError, {
+    status: 505,
+    message: 'The server does not support the HTTP protocol version used in the request.',
+});
+/**
+ * The server took too long to complete the request, reaching the maximum compute time allowed.
+ * @group Error
+ */
+export class MaxComputeTimeReachedError extends EError {
+}
+addError(MaxComputeTimeReachedError, {
+    status: 524,
+    message: 'The server took too long to complete the request, reaching the maximum compute time allowed.',
+});

package/dist/errors/index.d.ts

@@ -0,0 +1,2 @@
+export * from './error-handler.js';
+export * from './errors.js';

package/dist/errors/index.js

@@ -0,0 +1,2 @@
+export * from './error-handler.js';
+export * from './errors.js';

package/dist/http/http-route-runner.d.ts

@@ -0,0 +1,30 @@
+import { CoreHTTPFunctionRoute, HTTPRoutesMeta, RunRouteOptions, RunRouteParams, PikkuHTTP } from './http-routes.types.js';
+import { CoreUserSession } from '../types/core.types.js';
+import { PikkuHTTPAbstractRequest } from './pikku-http-abstract-request.js';
+import { Logger } from '../services/index.js';
+import { CoreAPIChannel } from '../channel/channel.types.js';
+import { PikkuRequest } from '../pikku-request.js';
+import { PikkuResponse } from '../pikku-response.js';
+import { HTTPSessionService } from './http-session-service.js';
+export declare const addRoute: <In, Out, Route extends string, APIFunction, APIFunctionSessionless, APIPermission>(route: CoreHTTPFunctionRoute<In, Out, Route, APIFunction, APIFunctionSessionless, APIPermission>) => void;
+export declare const clearRoutes: () => void;
+/**
+ * @ignore
+ */
+export declare const setHTTPRoutesMeta: (_routeMeta: HTTPRoutesMeta) => void;
+/**
+ * Returns all the registered routes and associated metadata.
+ * @internal
+ */
+export declare const getRoutes: () => {
+    routes: CoreHTTPFunctionRoute<any, any, any>[];
+    routesMeta: HTTPRoutesMeta;
+};
+export declare const getUserSession: <UserSession extends CoreUserSession>(httpSessionService: HTTPSessionService<UserSession> | undefined, auth: boolean, request: PikkuHTTPAbstractRequest) => Promise<CoreUserSession | undefined>;
+export declare const loadUserSession: (skipUserSession: boolean, requiresSession: boolean, http: PikkuHTTP | undefined, matchedPath: any, route: CoreHTTPFunctionRoute<unknown, unknown, any> | CoreAPIChannel<unknown, any>, logger: Logger, httpSessionService: HTTPSessionService | undefined) => Promise<unknown>;
+export declare const createHTTPInteraction: (request: PikkuRequest | undefined, response: PikkuResponse | undefined) => PikkuHTTP | undefined;
+export declare const handleError: (e: any, http: PikkuHTTP | undefined, trackerId: string, logger: Logger, logWarningsForStatusCodes: number[], respondWith404: boolean, bubbleError: boolean) => void;
+/**
+ * @ignore
+ */
+export declare const runHTTPRoute: <In, Out>({ singletonServices, request, response, createSessionServices, route: apiRoute, method: apiType, skipUserSession, respondWith404, logWarningsForStatusCodes, coerceToArray, bubbleErrors, }: Pick<CoreHTTPFunctionRoute<unknown, unknown, any>, "route" | "method"> & RunRouteOptions & RunRouteParams<In>) => Promise<Out | void>;