revojs 0.0.88 → 0.1.1

package/dist/index.d.ts

@@ -1,9 +1,176 @@
-export * from "./app";
-export * from "./html";
-export * from "./http";
-export * from "./locale";
-export * from "./radix";
-export * from "./router";
-export * from "./runtime";
-export * from "./schema";
-export * from "./signals";
+//#region src/shared/index.d.ts
+type Descriptor<T> = string & {
+  [descriptor]: T;
+};
+type Context = Record<string, unknown>;
+type Output<T> = Success<T> | Failure;
+type InferInput<T extends Schema> = NonNullable<T["~standard"]["types"]>["input"];
+type InferOutput<T extends Schema> = NonNullable<T["~standard"]["types"]>["output"];
+type Mergeable<T> = { [P in keyof T]?: Mergeable<T[P]> };
+interface Issue {
+  readonly message: string;
+}
+interface Success<T> {
+  readonly value: T;
+}
+interface Failure {
+  readonly issues: ReadonlyArray<Issue>;
+}
+interface Schema<T = unknown, TOutput = T> {
+  readonly "~standard": {
+    readonly validate: (value: unknown) => Output<TOutput> | Promise<Output<TOutput>>;
+    readonly types?: {
+      readonly input: T;
+      readonly output: TOutput;
+    };
+  };
+}
+declare class StopEvent extends Event {
+  constructor();
+}
+declare class Scope extends EventTarget {
+  parentScope?: Scope;
+  readonly context: Context;
+  constructor(parentScope?: Scope);
+  getContext<T>(input: Descriptor<T>): T;
+  setContext<T>(input: Descriptor<T>, value: T): void;
+  onStop(input: (event: StopEvent) => void): void;
+  stop(): boolean;
+}
+declare function defineContext<T>(name: string): Descriptor<T>;
+declare function isClient(): boolean;
+declare function isServer(): boolean;
+declare function isFailure<T>(result: Output<T>): result is Failure;
+declare function parseSchema<T extends Schema>(scope: Scope, schema: T, value: unknown): InferOutput<T>;
+declare function mergeObjects<TBase, TInput>(base: TBase, input: TInput): TBase & TInput;
+declare const descriptor: unique symbol;
+declare global {
+  interface ElementEventMap {
+    stop: StopEvent;
+  }
+}
+//#endregion
+//#region src/app/index.d.ts
+type Environment = typeof CLIENT | typeof SERVER;
+type Virtual = (environment: Environment) => undefined | string | Promise<string>;
+interface Config {
+  modules: Array<Module>;
+  client?: string;
+  server?: string;
+  sources: Record<string, Source>;
+}
+interface Module {
+  config?: Mergeable<Config>;
+  setup?: (app: App) => void | Promise<void>;
+}
+interface Source {
+  match: string;
+  entries: Array<string>;
+  suffix?: string;
+}
+interface App {
+  config: Config;
+  virtuals: Record<string, Virtual>;
+  alias: Record<string, string>;
+}
+declare function createApp(inputConfig?: Mergeable<Config>): App;
+declare const SERVER = "ssr";
+declare const CLIENT = "client";
+//#endregion
+//#region src/server/index.d.ts
+type CookiePriority = "Low" | "Medium" | "High";
+type CookieSameSite = "Lax" | "Strict" | "None";
+type HttpMethod = "GET" | "HEAD" | "PATCH" | "POST" | "PUT" | "DELETE" | "CONNECT" | "OPTIONS" | "TRACE";
+type Encoding = "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "latin1" | "binary" | "hex";
+type StatusCode = 100 | 101 | 102 | 103 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 226 | 300 | 301 | 302 | 303 | 304 | 305 | 307 | 308 | 400 | 401 | 402 | 403 | 404 | 405 | 406 | 407 | 408 | 409 | 410 | 411 | 412 | 413 | 414 | 415 | 416 | 417 | 418 | 420 | 421 | 422 | 423 | 424 | 425 | 426 | 428 | 429 | 431 | 444 | 450 | 451 | 497 | 498 | 499 | 500 | 501 | 502 | 503 | 504 | 506 | 507 | 508 | 509 | 510 | 511 | 521 | 522 | 523 | 525 | 530 | 599;
+type MimeType = "text/plain" | "text/css" | "text/html" | "text/csv" | "text/javascript" | "application/json" | "application/xml" | "image/jpeg" | "image/png" | "image/gif" | "image/webp" | "image/svg+xml" | "image/bmp" | "image/x-icon" | "font/ttf" | "font/otf" | "font/woff" | "font/woff2" | "audio/mpeg" | "audio/wav" | "audio/ogg" | "audio/mp4" | "video/mp4" | "video/webm" | "video/ogg" | "video/quicktime" | "video/x-msvideo" | "application/zip" | "application/vnd.rar" | "application/x-tar" | "application/gzip" | "application/x-7z-compressed" | "application/pdf" | "application/msword" | "application/vnd.openxmlformats-officedocument.wordprocessingml.document" | "application/vnd.ms-excel" | "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet" | "application/vnd.ms-powerpoint" | "application/vnd.openxmlformats-officedocument.presentationml.presentation" | "application/vnd.microsoft.portable-executable" | "application/vnd.android.package-archive";
+type Result = void | Response | Promise<void | Response>;
+type Node<T> = WildcardNode<T> | ParameterNode<T> | PathNode<T>;
+interface CookieOptions {
+  domain?: string;
+  expires?: Date;
+  httpOnly?: boolean;
+  maxAge?: number;
+  path?: string;
+  priority?: CookiePriority;
+  sameSite?: CookieSameSite;
+  secure?: boolean;
+}
+interface ResponseConfig {
+  status?: StatusCode;
+  message?: string;
+  headers: Headers;
+}
+interface RouterContext {
+  route: Node<Route>;
+  segments: Array<string>;
+  parameters: Record<string, string>;
+}
+interface ServerContext<T extends Context = Context> {
+  request: Request;
+  response: ResponseConfig;
+  variables: T;
+}
+interface Route {
+  fetch: (scope: Scope) => Result;
+}
+interface Middleware {
+  fetch: (scope: Scope, next?: () => Result) => Result;
+}
+interface Server {
+  router: Router;
+  pipeline: Array<Middleware>;
+  fetch: (scope: Scope) => Promise<Response>;
+}
+interface WildcardNode<T> {
+  type: "WILDCARD";
+  value?: T;
+  parameter: string;
+  children: Record<string, Node<T>>;
+}
+interface ParameterNode<T> {
+  type: "PARAMETER";
+  value?: T;
+  parameter: string;
+  children: Record<string, Node<T>>;
+}
+interface PathNode<T> {
+  type: "PATH";
+  value?: T;
+  children: Record<string, Node<T>>;
+}
+declare class Radix<T> {
+  readonly rootNode: Node<T>;
+  constructor();
+  use(path: string, value: T): Node<T>;
+}
+declare class Router extends Radix<Route> implements Middleware {
+  fetch(scope: Scope, next?: () => Result): Result;
+}
+declare function defineRoute<T extends Route>(route: T): T;
+declare function defineMiddleware<T extends Middleware>(middleware: T): T;
+declare function useServer<T extends Context>(scope: Scope): ServerContext<T>;
+declare function useUrl(scope: Scope, base?: string): URL;
+declare function useQuery(scope: Scope): Record<string, string>;
+declare function useQuery<T extends Schema>(scope: Scope, schema: T): InferOutput<T>;
+declare function useCookies(scope: Scope): Record<string, string>;
+declare function useCookies<T extends Schema>(scope: Scope, schema: T): InferOutput<T>;
+declare function useSetCookies(scope: Scope): Record<string, string>;
+declare function useSetCookies<T extends Schema>(scope: Scope, schema: T): InferOutput<T>;
+declare function setCookie(scope: Scope, name: string, value: string, options?: CookieOptions): void;
+declare function sendText(scope: Scope, text: string, config?: Mergeable<ResponseConfig>): Response;
+declare function sendHtml(scope: Scope, text: string, config?: Mergeable<ResponseConfig>): Response;
+declare function sendJson<T>(scope: Scope, value: T, config?: Mergeable<ResponseConfig>): Response;
+declare function sendRedirect(scope: Scope, path: string, config?: Mergeable<ResponseConfig>): Response;
+declare function sendBadRequest(scope: Scope, text: string, config?: Mergeable<ResponseConfig>): Response;
+declare function sendUnauthorized(scope: Scope, config?: Mergeable<ResponseConfig>): Response;
+declare function mimeType(file: string): MimeType;
+declare function toRoutePath(path: string): [string, string | undefined];
+declare function createServer(): Promise<Server>;
+declare const ROUTER_CONTEXT: Descriptor<RouterContext>;
+declare const SERVER_CONTEXT: Descriptor<ServerContext<Context>>;
+declare const WILDCARD = "$";
+declare const PARAMETER = ":";
+declare const mimeTypes: Record<string, MimeType>;
+//#endregion
+export { App, CLIENT, Config, Context, CookieOptions, CookiePriority, CookieSameSite, Descriptor, Encoding, Environment, Failure, HttpMethod, InferInput, InferOutput, Issue, Mergeable, Middleware, MimeType, Module, Node, Output, PARAMETER, ParameterNode, PathNode, ROUTER_CONTEXT, Radix, ResponseConfig, Result, Route, Router, RouterContext, SERVER, SERVER_CONTEXT, Schema, Scope, Server, ServerContext, Source, StatusCode, StopEvent, Success, Virtual, WILDCARD, WildcardNode, createApp, createServer, defineContext, defineMiddleware, defineRoute, isClient, isFailure, isServer, mergeObjects, mimeType, mimeTypes, parseSchema, sendBadRequest, sendHtml, sendJson, sendRedirect, sendText, sendUnauthorized, setCookie, toRoutePath, useCookies, useQuery, useServer, useSetCookies, useUrl };