evikit 2.9.2 → 2.10.0

package/README.md

@@ -180,7 +180,7 @@ export function ErrorPage({ children, error }) {
   useTitle(status);
 
   return main(
-    null,
+    { id: "main" },
     p({ class: "nav" }, a({ href: "/" }, i18n.gettext("Questions"))),
     h1({ class: "title" }, status),
     children,
@@ -221,9 +221,7 @@ export function api() {
 Add a Preact router at `src/app.js` (uncomment the routes one-by-one when we add them later):
 
 ```js
-import { hydrate, Router, ssr } from "evikit";
-import { h } from "preact";
-import { Route } from "preact-iso";
+import { route, ssr } from "evikit";
 
 import { acceptLanguages } from "./lib/index.js";
 import { ErrorPage } from "./routes/error.js";
@@ -232,21 +230,11 @@ import { ErrorPage } from "./routes/error.js";
 
 acceptLanguages();
 
-/** @param {import("evikit").SsrProps} props */
-export const prerender = (props) => ssr(App, props);
-
-/** @type {import("evikit").SsrApp} */
-function App(props) {
-  return h(
-    Router,
-    props,
-    // h(Route, { component: HomePage, path: "/" }),
-    // h(Route, { component: QuestionIdPage, path: "/question/:id" }),
-    h(Route, { component: ErrorPage, default: true }),
-  );
-}
-
-hydrate(App, "#app");
+export const prerender = ssr(
+  { ErrorPage },
+  // route("/", HomePage),
+  // route("/question/:id", QuestionIdPage),
+);
 ```
 
 #### HTML entry point
@@ -386,6 +374,8 @@ export const HomeGet = {
 };
 ```
 
+> 😉 Note: for live refresh to know when data changes, use columns from `schema` in `outputs`, instead of writing `string()` or `number()` anew.
+
 Code the API server endpoint in `src/routes/api/server.js`:
 
 ```js
@@ -523,6 +513,8 @@ export function QuestionIdPage() {
   }
 
   return main(
+    { id: "main" },
+
     h1({ class: "title" }, title),
 
     // VOTE_FORM: replace with form view from the "Vote for choice" section.

package/db.d.ts

@@ -1,255 +1,255 @@
-import type {
-  InferInput,
-  InferMetadata,
-  InferOutput,
-  MetadataAction,
-  ObjectSchema,
-} from "valibot";
-
-export type Db<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Schema extends Record<string, ObjectSchema<any, any>>,
-  R extends Relations<Schema> = Relations<Schema>,
-  F extends Flatten<Schema> = Flatten<Schema>,
-> = {
-  [Table in keyof R]: Table extends keyof F & keyof Schema & string
-    ? {
-        delete(where: Where<Schema, Table>): void;
-
-        select<
-          W extends Partial<Join<R, Table>> & { where?: Where<Schema, Table> },
-        >(
-          props?: W,
-        ): Select<Schema, R, F, Table, W>[];
-
-        update(query: {
-          set: Partial<InferOutput<Schema[Table]>>;
-          where: Where<Schema, Table>;
-        }): void;
-
-        upsert(
-          ...values: InferInput<Schema[Table]>[]
-        ): InferOutput<Schema[Table]>[];
-      }
-    : never;
-} & {
-  schema: Schema;
-  subscribe(onMessage: ({ table }: { table: string }) => void): () => void;
-};
-
-export type Flatten<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Schema extends Record<string, ObjectSchema<any, any>>,
-  R extends Relations<Schema> = Relations<Schema>,
-> = {
-  [Self in keyof R]: Self extends string
-    ? UnionToIntersection<
-        {
-          [Own in keyof R[Self]]: Own extends string
-            ? {
-                [Other in keyof R[Self][Own]]: Other extends string
-                  ? R[Self][Own][Other] extends Record<string, { name: string }>
-                    ? {
-                        [
-                          Its in keyof R[Self][Own][Other] as R[Self][Own][Other][Its]["name"]
-                        ]: Its extends string
-                          ? R[Self][Own][Other][Its]
-                          : never;
-                      }
-                    : never
-                  : never;
-              }[keyof R[Self][Own]]
-            : never;
-        }[keyof R[Self]]
-      >
-    : never;
-};
-
-export type Join<Relations, Self extends keyof Relations> = UnionToIntersection<
-  {
-    [Own in keyof Relations[Self]]: Own extends string
-      ? {
-          [Other in keyof Relations[Self][Own]]: Other extends keyof Relations
-            ? {
-                [Its in keyof Relations[Self][Own][Other]]: Its extends string
-                  ? Relations[Self][Own][Other] extends Record<
-                      string,
-                      { name: string }
-                    >
-                    ? {
-                        // Turning this into partial record would cause infinite depth.
-                        // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
-                        with: {
-                          [K in Relations[Self][Own][Other][Its]["name"]]?:
-                            Join<Relations, Other> | true;
-                        };
-                      }
-                    : never
-                  : never;
-              }[keyof Relations[Self][Own][Other]]
-            : never;
-        }[keyof Relations[Self][Own]]
-      : never;
-  }[keyof Relations[Self]]
->;
-
-// eslint-disable-next-line @typescript-eslint/no-explicit-any
-export type Relations<Schema extends Record<string, ObjectSchema<any, any>>> = {
-  [Self in keyof Schema]: Self extends string
-    ? OmitExtendsRecordUndefined<{
-        [Own in keyof Schema[Self]["entries"]]: Own extends string
-          ? OmitExtendsRecordUndefined<{
-              [Other in keyof Schema]: Other extends string
-                ? OmitExtendsUndefined<{
-                    [Its in keyof Schema[Other]["entries"]]: Its extends string
-                      ? InferMetadata<Schema[Self]["entries"][Own]> extends {
-                          key: Schema[Other]["entries"][Its];
-                          references: Schema[Other];
-                        }
-                        ? Schema[Other] extends InferMetadata<
-                            Schema[Self]["entries"][Own]
-                          >["references"]
-                          ? Schema[Other]["entries"][Its] extends InferMetadata<
-                              Schema[Self]["entries"][Own]
-                            >["key"]
-                            ? {
-                                Its: Its;
-                                name: Rewrite<Self, Own, Other, Its>;
-                                Other: Other;
-                                Own: Own;
-                                type: "references";
-                              }
-                            : undefined
-                          : undefined
-                        : InferMetadata<Schema[Other]["entries"][Its]> extends {
-                              key: Schema[Self]["entries"][Own];
-                              references: Schema[Self];
-                            }
-                          ? Schema[Self] extends InferMetadata<
-                              Schema[Other]["entries"][Its]
-                            >["references"]
-                            ? Schema[Self]["entries"][Own] extends InferMetadata<
-                                Schema[Other]["entries"][Its]
-                              >["key"]
-                              ? {
-                                  Its: Its;
-                                  name: Rewrite<Self, Own, Other, Its>;
-                                  Other: Other;
-                                  Own: Own;
-                                  type: "referencedBy";
-                                }
-                              : undefined
-                            : undefined
-                          : undefined
-                      : undefined;
-                  }>
-                : undefined;
-            }>
-          : undefined;
-      }>
-    : undefined;
-};
-
-export type Where<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Schema extends Record<string, ObjectSchema<any, any>>,
-  Table extends keyof Schema,
-> = {
-  [K in keyof Schema[Table]["entries"]]?:
-    | InferOutput<Schema[Table]["entries"][K]>
-    | InferOutput<Schema[Table]["entries"][K]>[]
-    | Partial<
-        Record<
-          "gt" | "gte" | "lt" | "lte" | "not",
-          InferOutput<Schema[Table]["entries"][K]>
-        >
-      >;
-};
-
-type OmitExtends<T, U> = {
-  [K in keyof T as T[K] extends U ? never : K]: T[K];
-};
-
-type OmitExtendsRecordUndefined<T> = OmitExtends<T, Record<string, undefined>>;
-
-type OmitExtendsUndefined<T> = OmitExtends<T, undefined>;
-
-type Rewrite<
-  Self extends string,
-  Own extends string,
-  Other extends string,
-  Its extends string,
-> =
-  // Image.id, Question.imageId -> Image.Question.
-  Its extends `${Uncapitalize<Self>}${Capitalize<Own>}`
-    ? Other
-    : // Question.quizId, Quiz.id -> Question.Quiz.
-      Own extends `${Uncapitalize<Other>}${Capitalize<Its>}`
-      ? Other
-      : // Quiz.coverId, Image.id -> Quiz.cover.
-        Own extends `${infer R}${Capitalize<Its>}`
-        ? R
-        : // Image.id, Quiz.coverId -> Image.CoverQuiz.
-          Its extends `${infer R}${Capitalize<Own>}`
-          ? `${Capitalize<R>}${Other}`
-          : never;
-
-type Select<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  Schema extends Record<string, ObjectSchema<any, any>>,
-  R extends Relations<Schema> = Relations<Schema>,
-  F extends Flatten<Schema> = Flatten<Schema>,
-  Table extends keyof F & keyof Schema = keyof F & keyof Schema,
-  W extends Join<R, Table> = Join<R, Table>,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-> = W extends { with: any }
-  ? InferOutput<Schema[Table]> & {
-      [K in keyof W["with"]]: K extends keyof F[Table]
-        ? F[Table][K] extends {
-            Other: keyof F & keyof Schema;
-            type: "referencedBy";
-          }
-          ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
-            (W["with"][K] extends { with: any }
-              ? Select<Schema, R, F, F[Table][K]["Other"], W["with"][K]>
-              : InferOutput<Schema[F[Table][K]["Other"]]>)[]
-          : F[Table][K] extends {
-                Other: keyof F & keyof Schema;
-                type: "references";
-              }
-            ? | undefined
-              // eslint-disable-next-line @typescript-eslint/no-explicit-any
-              | (W["with"][K] extends { with: any }
-                  ? Select<Schema, R, F, F[Table][K]["Other"], W["with"][K]>
-                  : InferOutput<Schema[F[Table][K]["Other"]]>)
-            : never
-        : never;
-    }
-  : InferOutput<Schema[Table]>;
-
-// https://www.geeksforgeeks.org/typescript/union-type-to-intersection-type-in-typescript/
-type UnionToIntersection<U> = (
-  U extends object ? (k: U) => void : never
-) extends (k: infer I) => void
-  ? I
-  : never;
-
-export function flatten<
-  Schema extends Record<string, ObjectSchema<any, any>>, // eslint-disable-line @typescript-eslint/no-explicit-any
->(relations: Relations<Schema>): Flatten<Schema>;
-
-export function primary<T>(): MetadataAction<T, { primary: true }>;
-
-export function references<
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  R extends { entries: any },
-  K extends keyof R["entries"],
-  T,
->(
-  references: R,
-  key: K,
-): MetadataAction<T, { key: R["entries"][K]; references: R }>;
-
-export function relations<
-  Schema extends Record<string, ObjectSchema<any, any>>, // eslint-disable-line @typescript-eslint/no-explicit-any
->(schema: Schema): Relations<Schema>;
+import type {
+  InferInput,
+  InferMetadata,
+  InferOutput,
+  MetadataAction,
+  ObjectSchema,
+} from "valibot";
+
+export type Db<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Schema extends Record<string, ObjectSchema<any, any>>,
+  R extends Relations<Schema> = Relations<Schema>,
+  F extends Flatten<Schema> = Flatten<Schema>,
+> = {
+  [Table in keyof R]: Table extends keyof F & keyof Schema & string
+    ? {
+        delete(where: Where<Schema, Table>): void;
+
+        select<
+          W extends Partial<Join<R, Table>> & { where?: Where<Schema, Table> },
+        >(
+          props?: W,
+        ): Select<Schema, R, F, Table, W>[];
+
+        update(query: {
+          set: Partial<InferOutput<Schema[Table]>>;
+          where: Where<Schema, Table>;
+        }): void;
+
+        upsert(
+          ...values: InferInput<Schema[Table]>[]
+        ): InferOutput<Schema[Table]>[];
+      }
+    : never;
+} & {
+  schema: Schema;
+  subscribe(onMessage: ({ table }: { table: string }) => void): () => void;
+};
+
+export type Flatten<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Schema extends Record<string, ObjectSchema<any, any>>,
+  R extends Relations<Schema> = Relations<Schema>,
+> = {
+  [Self in keyof R]: Self extends string
+    ? UnionToIntersection<
+        {
+          [Own in keyof R[Self]]: Own extends string
+            ? {
+                [Other in keyof R[Self][Own]]: Other extends string
+                  ? R[Self][Own][Other] extends Record<string, { name: string }>
+                    ? {
+                        [
+                          Its in keyof R[Self][Own][Other] as R[Self][Own][Other][Its]["name"]
+                        ]: Its extends string
+                          ? R[Self][Own][Other][Its]
+                          : never;
+                      }
+                    : never
+                  : never;
+              }[keyof R[Self][Own]]
+            : never;
+        }[keyof R[Self]]
+      >
+    : never;
+};
+
+export type Join<Relations, Self extends keyof Relations> = UnionToIntersection<
+  {
+    [Own in keyof Relations[Self]]: Own extends string
+      ? {
+          [Other in keyof Relations[Self][Own]]: Other extends keyof Relations
+            ? {
+                [Its in keyof Relations[Self][Own][Other]]: Its extends string
+                  ? Relations[Self][Own][Other] extends Record<
+                      string,
+                      { name: string }
+                    >
+                    ? {
+                        // Turning this into partial record would cause infinite depth.
+                        // eslint-disable-next-line @typescript-eslint/consistent-indexed-object-style
+                        with: {
+                          [K in Relations[Self][Own][Other][Its]["name"]]?:
+                            Join<Relations, Other> | true;
+                        };
+                      }
+                    : never
+                  : never;
+              }[keyof Relations[Self][Own][Other]]
+            : never;
+        }[keyof Relations[Self][Own]]
+      : never;
+  }[keyof Relations[Self]]
+>;
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+export type Relations<Schema extends Record<string, ObjectSchema<any, any>>> = {
+  [Self in keyof Schema]: Self extends string
+    ? OmitExtendsRecordUndefined<{
+        [Own in keyof Schema[Self]["entries"]]: Own extends string
+          ? OmitExtendsRecordUndefined<{
+              [Other in keyof Schema]: Other extends string
+                ? OmitExtendsUndefined<{
+                    [Its in keyof Schema[Other]["entries"]]: Its extends string
+                      ? InferMetadata<Schema[Self]["entries"][Own]> extends {
+                          key: Schema[Other]["entries"][Its];
+                          references: Schema[Other];
+                        }
+                        ? Schema[Other] extends InferMetadata<
+                            Schema[Self]["entries"][Own]
+                          >["references"]
+                          ? Schema[Other]["entries"][Its] extends InferMetadata<
+                              Schema[Self]["entries"][Own]
+                            >["key"]
+                            ? {
+                                Its: Its;
+                                name: Rewrite<Self, Own, Other, Its>;
+                                Other: Other;
+                                Own: Own;
+                                type: "references";
+                              }
+                            : undefined
+                          : undefined
+                        : InferMetadata<Schema[Other]["entries"][Its]> extends {
+                              key: Schema[Self]["entries"][Own];
+                              references: Schema[Self];
+                            }
+                          ? Schema[Self] extends InferMetadata<
+                              Schema[Other]["entries"][Its]
+                            >["references"]
+                            ? Schema[Self]["entries"][Own] extends InferMetadata<
+                                Schema[Other]["entries"][Its]
+                              >["key"]
+                              ? {
+                                  Its: Its;
+                                  name: Rewrite<Self, Own, Other, Its>;
+                                  Other: Other;
+                                  Own: Own;
+                                  type: "referencedBy";
+                                }
+                              : undefined
+                            : undefined
+                          : undefined
+                      : undefined;
+                  }>
+                : undefined;
+            }>
+          : undefined;
+      }>
+    : undefined;
+};
+
+export type Where<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Schema extends Record<string, ObjectSchema<any, any>>,
+  Table extends keyof Schema,
+> = {
+  [K in keyof Schema[Table]["entries"]]?:
+    | InferOutput<Schema[Table]["entries"][K]>
+    | InferOutput<Schema[Table]["entries"][K]>[]
+    | Partial<
+        Record<
+          "gt" | "gte" | "lt" | "lte" | "not",
+          InferOutput<Schema[Table]["entries"][K]>
+        >
+      >;
+};
+
+type OmitExtends<T, U> = {
+  [K in keyof T as T[K] extends U ? never : K]: T[K];
+};
+
+type OmitExtendsRecordUndefined<T> = OmitExtends<T, Record<string, undefined>>;
+
+type OmitExtendsUndefined<T> = OmitExtends<T, undefined>;
+
+type Rewrite<
+  Self extends string,
+  Own extends string,
+  Other extends string,
+  Its extends string,
+> =
+  // Image.id, Question.imageId -> Image.Question.
+  Its extends `${Uncapitalize<Self>}${Capitalize<Own>}`
+    ? Other
+    : // Question.quizId, Quiz.id -> Question.Quiz.
+      Own extends `${Uncapitalize<Other>}${Capitalize<Its>}`
+      ? Other
+      : // Quiz.coverId, Image.id -> Quiz.cover.
+        Own extends `${infer R}${Capitalize<Its>}`
+        ? R
+        : // Image.id, Quiz.coverId -> Image.CoverQuiz.
+          Its extends `${infer R}${Capitalize<Own>}`
+          ? `${Capitalize<R>}${Other}`
+          : never;
+
+type Select<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  Schema extends Record<string, ObjectSchema<any, any>>,
+  R extends Relations<Schema> = Relations<Schema>,
+  F extends Flatten<Schema> = Flatten<Schema>,
+  Table extends keyof F & keyof Schema = keyof F & keyof Schema,
+  W extends Join<R, Table> = Join<R, Table>,
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+> = W extends { with: any }
+  ? InferOutput<Schema[Table]> & {
+      [K in keyof W["with"]]: K extends keyof F[Table]
+        ? F[Table][K] extends {
+            Other: keyof F & keyof Schema;
+            type: "referencedBy";
+          }
+          ? // eslint-disable-next-line @typescript-eslint/no-explicit-any
+            (W["with"][K] extends { with: any }
+              ? Select<Schema, R, F, F[Table][K]["Other"], W["with"][K]>
+              : InferOutput<Schema[F[Table][K]["Other"]]>)[]
+          : F[Table][K] extends {
+                Other: keyof F & keyof Schema;
+                type: "references";
+              }
+            ? | undefined
+              // eslint-disable-next-line @typescript-eslint/no-explicit-any
+              | (W["with"][K] extends { with: any }
+                  ? Select<Schema, R, F, F[Table][K]["Other"], W["with"][K]>
+                  : InferOutput<Schema[F[Table][K]["Other"]]>)
+            : never
+        : never;
+    }
+  : InferOutput<Schema[Table]>;
+
+// https://www.geeksforgeeks.org/typescript/union-type-to-intersection-type-in-typescript/
+type UnionToIntersection<U> = (
+  U extends object ? (k: U) => void : never
+) extends (k: infer I) => void
+  ? I
+  : never;
+
+export function flatten<
+  Schema extends Record<string, ObjectSchema<any, any>>, // eslint-disable-line @typescript-eslint/no-explicit-any
+>(relations: Relations<Schema>): Flatten<Schema>;
+
+export function primary<T>(): MetadataAction<T, { primary: true }>;
+
+export function references<
+  // eslint-disable-next-line @typescript-eslint/no-explicit-any
+  R extends { entries: any },
+  K extends keyof R["entries"],
+  T,
+>(
+  references: R,
+  key: K,
+): MetadataAction<T, { key: R["entries"][K]; references: R }>;
+
+export function relations<
+  Schema extends Record<string, ObjectSchema<any, any>>, // eslint-disable-line @typescript-eslint/no-explicit-any
+>(schema: Schema): Relations<Schema>;

package/index.d.ts

@@ -14,6 +14,7 @@ export interface QueryState {
   data: any; // eslint-disable-line @typescript-eslint/no-explicit-any
   dataUpdatedAt: number;
   error: null | unknown;
+  fromEventSource: boolean;
   isInvalidated: boolean;
   status: "error" | "loading" | "success";
 }
@@ -61,6 +62,7 @@ export function dehydrate(
 
 export function getI18n(...langs: string[]): Promise<i18n.Gettext>;
 
+/** @deprecated */
 export function hydrate(
   App: (props: {
     dehydratedState?: DehydratedState | undefined;
@@ -69,6 +71,12 @@ export function hydrate(
   renderTarget: string,
 ): Promise<void>;
 
+export function route(
+  path: string,
+  component: () => VNode<any>, // eslint-disable-line @typescript-eslint/no-explicit-any
+): { component: typeof component; path: string };
+
+/** @deprecated */
 export function Router({
   children,
   dehydratedState,
@@ -80,8 +88,18 @@ export function Router({
 }): VNode<any>; // eslint-disable-line @typescript-eslint/no-explicit-any
 
 /** @deprecated */
-export function ssr(App: SsrApp): (props: SsrProps) => Promise<SsrResponse>;
 export function ssr(App: SsrApp, props: SsrProps): Promise<SsrResponse>;
+/** @deprecated */
+export function ssr(App: SsrApp): (props: SsrProps) => Promise<SsrResponse>;
+export function ssr(
+  props: {
+    ErrorPage: (props: {
+      children?: import("preact").ComponentChildren;
+      error?: unknown;
+    }) => VNode<any>; // eslint-disable-line @typescript-eslint/no-explicit-any
+  },
+  ...routes: ReturnType<typeof route>[]
+): (props: SsrProps) => Promise<SsrResponse>;
 
 export function useI18n(): i18n.Gettext;