@pablozaiden/webapp 0.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +26 -0
  3. package/docs/auth-validation.md +34 -0
  4. package/docs/auth.md +35 -0
  5. package/docs/deployment.md +49 -0
  6. package/docs/getting-started.md +62 -0
  7. package/docs/github-actions.md +421 -0
  8. package/docs/realtime.md +61 -0
  9. package/docs/release.md +64 -0
  10. package/docs/server.md +45 -0
  11. package/docs/settings.md +42 -0
  12. package/docs/sidebar.md +80 -0
  13. package/docs/ui-guidelines.md +55 -0
  14. package/package.json +60 -0
  15. package/src/build/build-binary.ts +42 -0
  16. package/src/build/index.ts +1 -0
  17. package/src/contracts/index.ts +86 -0
  18. package/src/server/auth/api-keys.ts +61 -0
  19. package/src/server/auth/crypto.ts +34 -0
  20. package/src/server/auth/device-auth.ts +324 -0
  21. package/src/server/auth/passkeys.ts +280 -0
  22. package/src/server/auth/request-origin.ts +33 -0
  23. package/src/server/auth/sqlite-store.ts +301 -0
  24. package/src/server/auth/store.ts +91 -0
  25. package/src/server/auth/types.ts +25 -0
  26. package/src/server/create-web-app-server.ts +447 -0
  27. package/src/server/index.ts +7 -0
  28. package/src/server/logger.ts +44 -0
  29. package/src/server/realtime/bus.ts +104 -0
  30. package/src/server/responses.ts +54 -0
  31. package/src/server/routes.ts +67 -0
  32. package/src/server/runtime-config.ts +101 -0
  33. package/src/server/same-origin.ts +35 -0
  34. package/src/types.d.ts +11 -0
  35. package/src/web/WebAppRoot.tsx +706 -0
  36. package/src/web/components/index.tsx +471 -0
  37. package/src/web/index.ts +5 -0
  38. package/src/web/realtime/useRealtime.ts +189 -0
  39. package/src/web/sidebar/types.ts +45 -0
  40. package/src/web/styles.css +1295 -0
@@ -0,0 +1,67 @@
1
+ import type { Server } from "bun";
2
+ import type { AuthenticatedRequestState } from "./auth/types";
3
+ import type { RealtimeBus } from "./realtime/bus";
4
+
5
+ export type RouteAuth = "required" | "public" | "optional";
6
+ export type SameOriginMode = "mutations" | "always" | "never";
7
+ export type HttpMethod = "GET" | "POST" | "PUT" | "PATCH" | "DELETE";
8
+
9
+ export interface RouteContext<TParams extends Record<string, string> = Record<string, string>, TEvent = unknown> {
10
+ params: TParams;
11
+ auth: AuthenticatedRequestState;
12
+ realtime: RealtimeBus<TEvent>;
13
+ server?: Server<unknown>;
14
+ }
15
+
16
+ export type WebAppRouteHandler<TParams extends Record<string, string> = Record<string, string>, TEvent = unknown> = (
17
+ req: Request,
18
+ ctx: RouteContext<TParams, TEvent>,
19
+ ) => Response | Promise<Response>;
20
+
21
+ export type RouteDefinition<TEvent = unknown> = {
22
+ auth?: RouteAuth;
23
+ sameOrigin?: SameOriginMode;
24
+ scopes?: string[];
25
+ } & Partial<Record<HttpMethod, WebAppRouteHandler<Record<string, string>, TEvent>>>;
26
+
27
+ export type RouteTable<TEvent = unknown> = Record<string, RouteDefinition<TEvent>>;
28
+
29
+ export function defineRoutes<TEvent = unknown>(routes: RouteTable<TEvent>): RouteTable<TEvent> {
30
+ return routes;
31
+ }
32
+
33
+ export interface MatchedRoute<TEvent = unknown> {
34
+ pattern: string;
35
+ route: RouteDefinition<TEvent>;
36
+ params: Record<string, string>;
37
+ }
38
+
39
+ function splitPath(pathname: string): string[] {
40
+ return pathname.split("/").filter(Boolean);
41
+ }
42
+
43
+ export function matchRoute<TEvent>(routes: RouteTable<TEvent>, pathname: string): MatchedRoute<TEvent> | undefined {
44
+ const requestParts = splitPath(pathname);
45
+ for (const [pattern, route] of Object.entries(routes)) {
46
+ const patternParts = splitPath(pattern);
47
+ if (patternParts.length !== requestParts.length) {
48
+ continue;
49
+ }
50
+ const params: Record<string, string> = {};
51
+ let matched = true;
52
+ for (let index = 0; index < patternParts.length; index += 1) {
53
+ const patternPart = patternParts[index]!;
54
+ const requestPart = requestParts[index]!;
55
+ if (patternPart.startsWith(":")) {
56
+ params[patternPart.slice(1)] = decodeURIComponent(requestPart);
57
+ } else if (patternPart !== requestPart) {
58
+ matched = false;
59
+ break;
60
+ }
61
+ }
62
+ if (matched) {
63
+ return { pattern, route, params };
64
+ }
65
+ }
66
+ return undefined;
67
+ }
@@ -0,0 +1,101 @@
1
+ import type { LogLevelName } from "../contracts";
2
+
3
+ export interface RuntimeConfig {
4
+ appName: string;
5
+ envPrefix: string;
6
+ host: string;
7
+ port: number;
8
+ dataDir: string;
9
+ logLevel: LogLevelName;
10
+ logLevelFromEnv: boolean;
11
+ passkeyDisabled: boolean;
12
+ sameOriginDisabled: boolean;
13
+ publicBaseUrl?: string;
14
+ authIssuer?: string;
15
+ development: false | { hmr: true; console: true };
16
+ }
17
+
18
+ const LOG_LEVELS = new Set(["trace", "debug", "info", "warn", "error"]);
19
+
20
+ export function isTruthyEnv(value: string | undefined): boolean {
21
+ const normalized = value?.trim().toLowerCase();
22
+ return normalized === "true" || normalized === "1" || normalized === "yes";
23
+ }
24
+
25
+ export function assertEnvPrefix(prefix: string): string {
26
+ if (!/^[A-Z][A-Z0-9_]*$/.test(prefix)) {
27
+ throw new Error(`envPrefix must match /^[A-Z][A-Z0-9_]*$/; received "${prefix}"`);
28
+ }
29
+ return prefix;
30
+ }
31
+
32
+ function envName(prefix: string, name: string): string {
33
+ return `${prefix}_${name}`;
34
+ }
35
+
36
+ function readEnv(prefix: string, name: string): string | undefined {
37
+ return process.env[envName(prefix, name)]?.trim();
38
+ }
39
+
40
+ function parsePort(raw: string | undefined, name: string): number {
41
+ const value = raw || "3000";
42
+ if (!/^\d+$/.test(value)) {
43
+ throw new Error(`${name} must be an integer between 0 and 65535; received "${value}"`);
44
+ }
45
+ const port = Number(value);
46
+ if (!Number.isInteger(port) || port < 0 || port > 65535) {
47
+ throw new Error(`${name} must be an integer between 0 and 65535; received "${value}"`);
48
+ }
49
+ return port;
50
+ }
51
+
52
+ function parseLogLevel(raw: string | undefined, fallback: LogLevelName, name: string): LogLevelName {
53
+ if (!raw) {
54
+ return fallback;
55
+ }
56
+ if (!LOG_LEVELS.has(raw)) {
57
+ throw new Error(`${name} must be one of trace, debug, info, warn, error; received "${raw}"`);
58
+ }
59
+ return raw as LogLevelName;
60
+ }
61
+
62
+ export function readRuntimeConfig(input: {
63
+ appName: string;
64
+ envPrefix: string;
65
+ defaultLogLevel?: LogLevelName;
66
+ }): RuntimeConfig {
67
+ const envPrefix = assertEnvPrefix(input.envPrefix);
68
+ const logLevelRaw = readEnv(envPrefix, "LOG_LEVEL");
69
+ const logLevel = parseLogLevel(logLevelRaw, input.defaultLogLevel ?? "info", envName(envPrefix, "LOG_LEVEL"));
70
+ return {
71
+ appName: input.appName,
72
+ envPrefix,
73
+ host: readEnv(envPrefix, "HOST") || "127.0.0.1",
74
+ port: parsePort(readEnv(envPrefix, "PORT"), envName(envPrefix, "PORT")),
75
+ dataDir: readEnv(envPrefix, "DATA_DIR") || "./data",
76
+ logLevel,
77
+ logLevelFromEnv: Boolean(logLevelRaw),
78
+ passkeyDisabled: isTruthyEnv(readEnv(envPrefix, "DISABLE_PASSKEY")),
79
+ sameOriginDisabled: isTruthyEnv(readEnv(envPrefix, "DISABLE_SAME_ORIGIN_CHECK")),
80
+ publicBaseUrl: readEnv(envPrefix, "PUBLIC_BASE_URL"),
81
+ authIssuer: readEnv(envPrefix, "AUTH_ISSUER"),
82
+ development: process.env["NODE_ENV"] === "production" ? false : { hmr: true, console: true },
83
+ };
84
+ }
85
+
86
+ export function safeRuntimeConfig(config: RuntimeConfig): Record<string, unknown> {
87
+ return {
88
+ appName: config.appName,
89
+ envPrefix: config.envPrefix,
90
+ host: config.host,
91
+ port: config.port,
92
+ dataDir: config.dataDir,
93
+ logLevel: config.logLevel,
94
+ logLevelFromEnv: config.logLevelFromEnv,
95
+ passkeyDisabled: config.passkeyDisabled,
96
+ sameOriginDisabled: config.sameOriginDisabled,
97
+ publicBaseUrl: config.publicBaseUrl,
98
+ authIssuer: config.authIssuer,
99
+ production: config.development === false,
100
+ };
101
+ }
@@ -0,0 +1,35 @@
1
+ import type { AuthenticatedRequestState } from "./auth/types";
2
+ import { getRequestOriginInfo } from "./auth/request-origin";
3
+ import type { RuntimeConfig } from "./runtime-config";
4
+ import { errorResponse } from "./responses";
5
+ import type { SameOriginMode } from "./routes";
6
+
7
+ const MUTATING = new Set(["POST", "PUT", "PATCH", "DELETE"]);
8
+
9
+ export function checkSameOrigin(req: Request, config: RuntimeConfig, auth: AuthenticatedRequestState, mode: SameOriginMode = "mutations"): Response | undefined {
10
+ if (config.sameOriginDisabled || mode === "never") {
11
+ return undefined;
12
+ }
13
+ const mutating = MUTATING.has(req.method.toUpperCase());
14
+ const websocket = req.headers.get("upgrade")?.toLowerCase() === "websocket";
15
+ if (mode !== "always" && !mutating && !websocket) {
16
+ return undefined;
17
+ }
18
+ if (mode !== "always" && (auth.kind === "api-key" || auth.kind === "bearer")) {
19
+ return undefined;
20
+ }
21
+ const expectedOrigin = getRequestOriginInfo(req, config.publicBaseUrl).origin;
22
+ const origin = req.headers.get("origin");
23
+ if (origin) {
24
+ return origin === expectedOrigin ? undefined : errorResponse(403, "same_origin_required", "Request origin is not allowed");
25
+ }
26
+ const referer = req.headers.get("referer");
27
+ if (referer) {
28
+ try {
29
+ return new URL(referer).origin === expectedOrigin ? undefined : errorResponse(403, "same_origin_required", "Request origin is not allowed");
30
+ } catch {
31
+ return errorResponse(403, "same_origin_required", "Request origin is not allowed");
32
+ }
33
+ }
34
+ return errorResponse(403, "same_origin_required", "Request origin is not allowed");
35
+ }
package/src/types.d.ts ADDED
@@ -0,0 +1,11 @@
1
+ declare const WEBAPP_VERSION: string | undefined;
2
+
3
+ declare module "*.html" {
4
+ const value: Response;
5
+ export default value;
6
+ }
7
+
8
+ declare module "*.css" {
9
+ const value: string;
10
+ export default value;
11
+ }