@jhxdev/express 0.1.0

package/index.d.ts

@@ -0,0 +1,131 @@
+import { ElementType, ComponentPropsWithoutRef, PropsWithChildren, JSX, ReactNode } from 'react';
+import { Response, Request, Express } from 'express';
+import * as jhx from 'jhx';
+import { JhxError, JhxConfig, JhxProps as JhxProps$1, JhxDomProps as JhxDomProps$1 } from 'jhx';
+export { ConditionalFunction, DomEventProps, DomObjects, Duration, HtmxAbortEvent, HtmxAfterOnLoadEvent, HtmxAfterProcessNodeEvent, HtmxAfterRequestEvent, HtmxAfterSettleEvent, HtmxAfterSwapEvent, HtmxAjaxEtc, HtmxAjaxHandler, HtmxAttribute, HtmxBeforeCleanupElementEvent, HtmxBeforeHistorySaveEvent, HtmxBeforeOnLoadEvent, HtmxBeforeProcessNodeEvent, HtmxBeforeRequestEvent, HtmxBeforeSendEvent, HtmxBeforeSwapEvent, HtmxBeforeTransitionEvent, HtmxCacheItem, HtmxClass, HtmxConfig, HtmxConfigRequestEvent, HtmxConfirmEvent, HtmxDefaultExtension, HtmxDomEvent, HtmxElementValidationError, HtmxEvent, HtmxEventAttribute, HtmxEventDetail, HtmxEventName, HtmxEventProps, HtmxExtension, HtmxExtensionMetadata, HtmxHistoryCacheErrorEvent, HtmxHistoryCacheHitEvent, HtmxHistoryCacheMissEvent, HtmxHistoryCacheMissLoadErrorEvent, HtmxHistoryCacheMissLoadEvent, HtmxHistoryRestoreEvent, HtmxHttpMethod, HtmxHttpVerb, HtmxInstance, HtmxIssueRequest, HtmxLoadEvent, HtmxMethodAttribute, HtmxNoSseSourceErrorEvent, HtmxOnLoadErrorEvent, HtmxOobAfterSwapEvent, HtmxOobBeforeSwapEvent, HtmxOobErrorNoTargetEvent, HtmxPathInfo, HtmxPromptEvent, HtmxProps, HtmxPushedIntoHistoryEvent, HtmxReplacedInHistoryEvent, HtmxRequestConfig, HtmxRequestHeader, HtmxResponseErrorEvent, HtmxResponseHandlingConfig, HtmxResponseHeader, HtmxSendAbortEvent, HtmxSendErrorEvent, HtmxSettleInfo, HtmxSseErrorEvent, HtmxSseOpenEvent, HtmxSwapErrorEvent, HtmxSwapSpec, HtmxSwapStyle, HtmxSyncStrategy, HtmxTargetErrorEvent, HtmxTimeoutEvent, HtmxValidateUrlEvent, HtmxValidationFailedEvent, HtmxValidationHaltedEvent, HtmxValidationValidateEvent, HtmxXhrAbortEvent, HtmxXhrLoadendEvent, HtmxXhrLoadstartEvent, HtmxXhrProgressEvent, JhxDefaultConfig, JhxError, JhxEvaluableAttribute, JhxExtensionAttribute, JhxIndicatorAttribute, JhxInheritAttribute, JhxParamsAttribute, JhxRequestArgs, JhxRequestAttribute, JhxRequestError, JhxRouteProps, JhxSelectOobAttribute, JhxSwapAttribute, JhxSwapOobAttribute, JhxSwapScroll, JhxSwapShow, JhxSyncAttribute, JhxTargetAttribute, JhxTriggerAttribute, JhxTriggerAttribute_Intersect, JhxTriggerAttribute_Poll, JhxTriggerAttribute_Standard, JhxTriggerFrom, JhxTriggerQueue, JhxValsError, Logger, applyAttributes, attributesToString, htmx } from 'jhx';
+
+type JhxServerErrorType = 'routes:invalid' | 'route:invalid-method' | 'route:invalid-path' | 'route:invalid-handler' | 'route:duplicate' | 'endpoint:invalid' | 'endpoint:malformed' | 'hash:invalid' | 'handler:error' | 'middleware:error';
+interface JhxServerError extends Error {
+    type: JhxServerErrorType;
+    info: string;
+    message: string;
+    method?: string;
+    route?: string;
+    cause?: unknown;
+}
+
+type HttpMethodUpperCase = 'DELETE' | 'GET' | 'HEAD' | 'PATCH' | 'POST' | 'PUT' | 'OPTIONS' | 'PROPFIND' | 'PROPPATCH' | 'MKCOL' | 'COPY' | 'MOVE' | 'LOCK' | 'UNLOCK' | 'TRACE' | 'SEARCH' | 'REPORT' | 'MKCALENDAR' | (Uppercase<string> & {});
+type HttpMethodLowerCase = Lowercase<HttpMethodUpperCase> | (Lowercase<string> & {});
+type HttpMethod = HttpMethodUpperCase | HttpMethodLowerCase;
+type JhxOnRegistered = (method: string, route: string) => void;
+type JhxErrorType$1 = Error | JhxError | JhxServerError;
+type ServerResolved<T> = Awaited<T>;
+type ServerJhxHandler<TReturn, TReq, TRes> = TRes extends undefined ? (context: TReq, _?: TRes) => TReturn : (req: TReq, res: TRes) => TReturn;
+type ServerJhxErrorHandler<TError extends JhxErrorType$1, TReturn, TReq, TRes> = TRes extends undefined ? (error: TError, context: TReq, _?: TRes) => TReturn : (error: TError, req: TReq, res: TRes) => TReturn;
+type ServerJhxRenderHandler<TResolved, TRendered, TReq, TRes> = TRes extends undefined ? (payload: TResolved, context: TReq, _?: TRes) => TRendered : (payload: TResolved, request: TReq, response: TRes) => TRendered;
+type ServerJhxRoute<TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>> = {
+    method: HttpMethodUpperCase;
+    route: string;
+    handler: THandler;
+};
+type ServerJhxPartialRoute<TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>> = {
+    method?: HttpMethod;
+    route: string;
+    handler: THandler;
+};
+type ServerCreateJhxConfig<TReturn, TResolved, TRendered, TError extends JhxErrorType$1, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>, TErrorHandler extends ServerJhxErrorHandler<TError, TReturn, TReq, TRes>, TRenderHandler extends ServerJhxRenderHandler<TResolved, TRendered, TReq, TRes>, TPartialRoute extends ServerJhxPartialRoute<TReturn, TReq, TRes, THandler>, TInstanceOptions = undefined> = JhxConfig & {
+    contentType?: string | false;
+    debug?: boolean;
+    errorHandler?: TErrorHandler;
+    middleware?: THandler | Array<THandler>;
+    notFoundHandler?: THandler;
+    onRegistered?: JhxOnRegistered;
+    prefix?: string;
+    renderError?: boolean;
+    renderMiddleware?: boolean;
+    renderNotFound?: boolean;
+    render?: 'static' | 'string' | TRenderHandler | false;
+    routes?: TPartialRoute | Array<TPartialRoute>;
+    trailingSlash?: 'slash' | 'no-slash' | 'both';
+    instanceOptions?: TInstanceOptions;
+};
+type ServerJhxProps<TDom extends object, TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>> = JhxProps$1<TDom> & {
+    handler?: THandler;
+};
+type ServerJhxDomProps<TDom extends object, TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>> = JhxDomProps$1<TDom> & {
+    handler?: THandler;
+};
+
+type NativeProps<TTag extends ElementType> = Omit<ComponentPropsWithoutRef<TTag>, 'children' | keyof ServerJhxProps<any, any, any, any, any>>;
+type ServerJhxComponentProps<TDom extends object, TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>, TTag extends ElementType = 'div'> = ServerJhxProps<TDom, TReturn, TReq, TRes, THandler> & NativeProps<TTag> & {
+    jhxConfig?: Omit<JhxConfig, 'stringify'>;
+    as?: TTag;
+};
+type ServerJhxComponentType<TDom extends object, TReturn, TReq, TRes, THandler extends ServerJhxHandler<TReturn, TReq, TRes>> = <TTag extends ElementType = 'div'>(props: PropsWithChildren<ServerJhxComponentProps<TDom, TReturn, TReq, TRes, THandler, TTag>>) => JSX.Element;
+
+declare const serverDefaultConfig: {
+    readonly contentType: "text/html";
+    readonly debug: false;
+    readonly middleware: readonly [];
+    readonly onRegistered: JhxOnRegistered;
+    readonly prefix: "/_jhx";
+    readonly render: (data: any, ..._args: any[]) => any;
+    readonly renderError: true;
+    readonly renderMiddleware: true;
+    readonly renderNotFound: true;
+    readonly trailingSlash: "both";
+    readonly logger: jhx.Logger;
+    readonly stringify: boolean;
+    readonly escape: boolean;
+};
+
+type RenderReturn = ArrayBufferView | ArrayBuffer | Buffer | Blob | Response | Record<string, any> | string | number | boolean | null | void;
+type JhxRenderReturn = RenderReturn | Promise<RenderReturn>;
+type JhxHandlerReturn = JhxRenderReturn | ReactNode | Promise<ReactNode>;
+type JhxErrorType = Error | JhxError | JhxServerError;
+type Resolved<TReturn = JhxHandlerReturn> = ServerResolved<TReturn>;
+type JhxHandler<TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxHandler<TReturn, TRequest, TResponse>;
+type JhxErrorHandler<TError extends JhxErrorType = JhxErrorType, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxErrorHandler<TError, TReturn, TRequest, TResponse>;
+type JhxRenderHandler<TResolved extends Resolved = Resolved, TReturn extends JhxRenderReturn = JhxRenderReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxRenderHandler<TResolved, TReturn, TRequest, TResponse>;
+type JhxRoute<TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxRoute<TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>>;
+type JhxPartialRoute<TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxPartialRoute<TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>>;
+type CreateJhxConfig<TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRendered extends JhxRenderReturn = JhxRenderReturn, TError extends JhxErrorType = JhxErrorType, TRequest extends Request = Request, TResponse extends Response = Response> = ServerCreateJhxConfig<TReturn, Resolved<TReturn>, TRendered, TError, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>, JhxErrorHandler<TError, TReturn, TRequest, TResponse>, JhxRenderHandler<Resolved<TReturn>, TRendered, TRequest, TResponse>, JhxPartialRoute<TReturn, TRequest, TResponse>> & {};
+type JhxProps<TDom extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxProps<TDom, TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>>;
+type JhxDomProps<TDom extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxDomProps<TDom, TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>>;
+interface Jhx<TDomBase extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response, TBaseStringify extends boolean | undefined = undefined> {
+    <TDom extends object | TDomBase = TDomBase>(options: JhxDomProps<TDom, TReturn, TRequest, TResponse>, config: JhxConfig & {
+        stringify: true;
+    }): string;
+    <TDom extends object | TDomBase = TDomBase>(options: JhxProps<TDom, TReturn, TRequest, TResponse>, config: JhxConfig & {
+        stringify: false;
+    }): Record<string, string>;
+    <TDom extends object | TDomBase = TDomBase>(options: TBaseStringify extends true ? JhxDomProps<TDom, TReturn, TRequest, TResponse> : JhxProps<TDom, TReturn, TRequest, TResponse>, config?: JhxConfig): TBaseStringify extends true ? string : Record<string, string>;
+    <TDom extends object | TDomBase = TDomBase>(options: JhxProps<TDom, TReturn, TRequest, TResponse> | JhxDomProps<TDom, TReturn, TRequest, TResponse>, config?: JhxConfig): string | Record<string, string>;
+    addRoute(newRoute: JhxPartialRoute<TReturn, TRequest, TResponse>): void;
+    addRoutes(newRoutes: Array<JhxPartialRoute<TReturn, TRequest, TResponse>>): void;
+    clearRoutes(): void;
+    getRoute(method: string, path: string): JhxRoute<TReturn, TRequest, TResponse> | null;
+    getRoutes(): Array<JhxRoute<TReturn, TRequest, TResponse>>;
+    hasRoute(method: string, path: string): boolean;
+    removeRoute(method: string, path: string): boolean;
+}
+type JhxComponentProps<TDom extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response, TTag extends ElementType = 'div'> = ServerJhxComponentProps<TDom, TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>, TTag>;
+type JhxComponentType<TDom extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response> = ServerJhxComponentType<TDom, TReturn, TRequest, TResponse, JhxHandler<TReturn, TRequest, TResponse>>;
+
+declare const createJhx: <TDomBase extends object = object, TError extends JhxErrorType = JhxErrorType, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response, TBaseStringify extends boolean | undefined = undefined>(express: Express, config?: CreateJhxConfig<TReturn, JhxRenderReturn, TError, TRequest, TResponse> & {
+    stringify?: TBaseStringify;
+}) => {
+    jhx: Jhx<TDomBase, TReturn, TRequest, TResponse, TBaseStringify>;
+    JhxComponent: JhxComponentType<TDomBase, TReturn, TRequest, TResponse>;
+};
+
+declare const createJhxComponent: <TDom extends object = object, TReturn extends JhxHandlerReturn = JhxHandlerReturn, TRequest extends Request = Request, TResponse extends Response = Response>(jhx: Jhx<TDom, TReturn, TRequest, TResponse, any>) => JhxComponentType<TDom, TReturn, TRequest, TResponse>;
+
+type CreateJhxDefaultConfig = Omit<typeof serverDefaultConfig, 'render'> & {
+    notFoundHandler: JhxHandler;
+    render: JhxRenderHandler;
+};
+declare const defaultConfig: CreateJhxDefaultConfig;
+
+export { createJhx, createJhxComponent, defaultConfig };
+export type { CreateJhxConfig, CreateJhxDefaultConfig, HttpMethod, HttpMethodLowerCase, HttpMethodUpperCase, Jhx, JhxComponentProps, JhxComponentType, JhxDomProps, JhxErrorHandler, JhxErrorType, JhxHandler, JhxHandlerReturn, JhxOnRegistered, JhxPartialRoute, JhxProps, JhxRenderHandler, JhxRenderReturn, JhxRoute, JhxServerError, JhxServerErrorType, Resolved };