evikit 1.0.2 → 2.0.0

package/README.md

@@ -78,7 +78,6 @@ node_modules
 *~
 *swp
 .env
-*.db
 ```
 
 ### Database schema
@@ -114,16 +113,19 @@ Export the database at `src/lib/db/index.js`:
 ```js
 import { sqlite } from "evikit/sqlite";
 
+import pkg from "../../../package.json" with { type: "json" };
 import * as schema from "./schema.js";
 
-export const db = sqlite("data/local.db", { schema });
+export const db = sqlite({ pkg, schema });
 ```
 
 - See ChoiceServer below for an example of `upsert` returning a created row.
 - See QuestionIdServer below for an example of `select` with a join.
 - See VoteServer below for an example of `update` and `delete`.
 
-Create an empty `data/.gitkeep` file.
+The database is kept under the [OS-specific path](https://github.com/sindresorhus/env-paths) for your application, such as `~/.local/share/mysite-nodejs/db.sqlite3` on GNU/Linux.
+
+If you want a temporary, in-memory database, omit `pkg`, pass just `{ schema }`.
 
 ### Routing
 
@@ -212,7 +214,7 @@ export async function prerender(data) {
   return await ssr(App, data);
 }
 
-/** @param {{ dehydratedState?: ReturnType<import("evikit").dehydrate> | undefined, i18n?: ReturnType<import("evikit").useI18n> | undefined }} props */
+/** @param {{ dehydratedState?: ReturnType<import("evikit").dehydrate> | undefined, i18n: ReturnType<import("evikit").useI18n> }} props */
 function App({ dehydratedState, i18n }) {
   return h(
     Router,

package/db.d.ts

@@ -225,17 +225,17 @@ 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(): MetadataAction<any, { primary: true }>; // eslint-disable-line @typescript-eslint/no-explicit-any
+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,
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-): MetadataAction<any, { key: R["entries"][K]; references: R }>;
+): 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

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "evikit",
   "description": "Preact/SQLite SSR framework for small web apps",
-  "version": "1.0.2",
+  "version": "2.0.0",
   "type": "module",
   "exports": {
     ".": "./index.js",
@@ -24,12 +24,11 @@
     "@fastify/busboy": "^3.2.0",
     "@types/gettext-parser": "^9.0.0",
     "@types/gettext.js": "^2.0.0",
-    "@types/lodash": "^4.17.24",
     "@types/node": "^25",
     "@valibot/to-json-schema": "^1.7.0",
+    "env-paths": "^4.0.0",
     "gettext-parser": "^9.0.2",
     "gettext.js": "^2.0.3",
-    "lodash": "^4.18.1",
     "preact-render-to-string": "^6.7.0"
   },
   "peerDependencies": {

package/server.js

@@ -2,7 +2,6 @@ import { Busboy } from "@fastify/busboy";
 import { toJsonSchema } from "@valibot/to-json-schema";
 import acceptLanguage from "accept-language";
 import { po } from "gettext-parser";
-import groupBy from "lodash/groupBy.js";
 import { readFile } from "node:fs/promises";
 import { Fragment, h } from "preact";
 import { renderToString } from "preact-render-to-string";
@@ -71,7 +70,7 @@ export function endpoint({ input, outputs }, handler) {
                 : undefined),
               ...Object.fromEntries(
                 Object.entries(
-                  groupBy(
+                  Object.groupBy(
                     [
                       ...new URL(
                         `http://${req.headers.host}${req.url}`,
@@ -80,7 +79,7 @@ export function endpoint({ input, outputs }, handler) {
                     ([name]) => name || "",
                   ),
                 ).map(([name, group]) => {
-                  const values = group.map((value) => value[1]);
+                  const values = (group || []).map((value) => value[1]);
                   return [name, values.length == 1 ? values[0] : values];
                 }),
               ),

package/sqlite.d.ts

@@ -5,4 +5,10 @@ import type { Db } from "./db.d.ts";
 export function sqlite<
   // eslint-disable-next-line @typescript-eslint/no-explicit-any
   Schema extends Record<string, ObjectSchema<any, any>>,
->(path: string, { schema }: { schema: Schema }): Db<Schema>;
+>({
+  pkg,
+  schema,
+}: {
+  pkg?: { name: string; version: string };
+  schema: Schema;
+}): Db<Schema>;

package/sqlite.js

@@ -1,12 +1,23 @@
+import envPaths from "env-paths";
 import { fail, ok } from "node:assert/strict";
+import { mkdirSync } from "node:fs";
 import { DatabaseSync } from "node:sqlite";
 import { getMetadata, parse } from "valibot";
 
 import { flatten, relations } from "./db.js";
 
 /** @type {typeof import("./sqlite.d.ts").sqlite} */
-export function sqlite(path, { schema }) {
-  const database = new DatabaseSync(path, { timeout: 1000 });
+export function sqlite({ pkg, schema }) {
+  const data = pkg
+    ? (() => {
+        const { data } = envPaths(pkg.name);
+        mkdirSync(data, { recursive: true });
+        return data;
+      })()
+    : undefined;
+  const database = new DatabaseSync(data ? `${data}/db.sqlite3` : ":memory:", {
+    timeout: 1000,
+  });
   const flat = flatten(relations(schema));
 
   const haveTables = /** @type {{ name: string }[]} */ (