@frigear-nu/preferences 0.1.1 → 0.1.3

package/dist/module.d.mts

@@ -15,6 +15,8 @@ type ModuleOptions = {
  */
 interface UserPreferences {
 }
+/** The response of `PATCH /api/preferences`: the preferences now stored for the caller. */
+type PreferencesDto = UserPreferences;
 
 declare module 'nuxt/schema' {
     interface NuxtConfig {
@@ -24,4 +26,4 @@ declare module 'nuxt/schema' {
 declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
 
 export { _default as default };
-export type { ModuleOptions, UserPreferences };
+export type { ModuleOptions, PreferencesDto, UserPreferences };

package/dist/module.json

@@ -1,7 +1,7 @@
 {
   "name": "@frigear-nu/preferences",
   "configKey": "preferences",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "builder": {
     "@nuxt/module-builder": "1.0.3",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,7 +1,7 @@
 import { existsSync } from 'node:fs';
 import { join } from 'node:path';
-import { defineNuxtModule, createResolver, addServerTemplate, addTypeTemplate, addServerImportsDir, addImports, addServerHandler, hasNuxtModule, addServerPlugin } from '@nuxt/kit';
-import { registerModule, extendDatabaseTable, inlineModuleRuntime } from '@frigear-nu/module-kit/utils';
+import { defineNuxtModule, createResolver, addServerTemplate, addTypeTemplate, addServerImportsDir, addImports, hasNuxtModule, addServerPlugin } from '@nuxt/kit';
+import { registerModule, extendDatabaseTable, inlineModuleRuntime, addModuleRoutes } from '@frigear-nu/module-kit/utils';
 
 const module$1 = defineNuxtModule({
   meta: { name: "@frigear-nu/preferences", configKey: "preferences" },
@@ -67,11 +67,9 @@ declare module '#preferences/definitions' {
     addServerImportsDir(resolver.resolve("./runtime/server/utils"));
     inlineModuleRuntime(nuxt, resolver);
     addImports({ name: "useUserPreferences", from: resolver.resolve("./runtime/app/composables/useUserPreferences") });
-    addServerHandler({
-      route: "/api/preferences",
-      method: "patch",
-      handler: resolver.resolve("./runtime/server/routes/preferences.patch")
-    });
+    addModuleRoutes(resolver, [
+      { method: "patch", path: "", file: "preferences.patch" }
+    ], { base: "/api/preferences" });
     if (hasNuxtModule("@frigear-nu/oauth-server")) {
       addServerPlugin(resolver.resolve("./runtime/server/plugins/oauth-claims"));
     }

package/dist/runtime/app/composables/useUserPreferences.js

@@ -1,3 +1,4 @@
+import { preferencesApi } from "../../utils/api.js";
 export const useUserPreferences = () => {
   const { user, fetch: refreshSession } = useUserSession();
   const pending = ref(false);
@@ -8,7 +9,7 @@ export const useUserPreferences = () => {
   async function set(key, value) {
     pending.value = true;
     try {
-      await $fetch("/api/preferences", { method: "PATCH", body: { [key]: value } });
+      await $fetch(preferencesApi.root, { method: "PATCH", body: { [key]: value } });
       await refreshSession();
     } finally {
       pending.value = false;

package/dist/runtime/server/routes/preferences.patch.js

@@ -1,17 +1,15 @@
 import { db, schema } from "@nuxthub/db";
 import { eq } from "drizzle-orm";
-import { parsePreferencePatch } from "../../utils/registry.js";
+import { notFound } from "@frigear-nu/module-kit/server";
+import { applyPreferencePatch, parsePreferencePatch } from "../../utils/registry.js";
 export default defineEventHandler(async (event) => {
   const user = await requireUser(event, { sessionOnly: true });
-  const patch = parsePreferencePatch(getPreferenceRegistry(), await readBody(event));
-  if (!patch.ok) throw createError({ statusCode: 400, statusMessage: patch.message });
+  const patch = await readValidatedBody(event, (body) => parsePreferencePatch(getPreferenceRegistry(), body));
   const [current] = await db.select({ preferences: schema.users.preferences }).from(schema.users).where(eq(schema.users.id, user.id)).limit(1);
-  if (!current) throw createError({ statusCode: 404, statusMessage: "User not found." });
-  const preferences = Object.fromEntries(
-    Object.entries({ ...current.preferences, ...patch.set }).filter(([key]) => !patch.remove.includes(key))
-  );
+  if (!current) throw notFound("User not found.");
+  const preferences = applyPreferencePatch(current.preferences, patch);
   const [updated] = await db.update(schema.users).set({ preferences }).where(eq(schema.users.id, user.id)).returning();
-  if (!updated) throw createError({ statusCode: 404, statusMessage: "User not found." });
+  if (!updated) throw notFound("User not found.");
   await setUserSession(event, { user: mapUserToSession(updated) });
   return preferences;
 });

package/dist/runtime/utils/api.d.ts

@@ -0,0 +1,5 @@
+/** The preferences API. */
+export declare const preferencesApi: {
+    /** `PATCH { [key]: value | null }` (session only): sets (or clears with `null`) preferences, answers the stored preferences. */
+    readonly root: "/api/preferences";
+};

package/dist/runtime/utils/api.js

@@ -0,0 +1,4 @@
+export const preferencesApi = {
+  /** `PATCH { [key]: value | null }` (session only): sets (or clears with `null`) preferences, answers the stored preferences. */
+  root: "/api/preferences"
+};

package/dist/runtime/utils/build.d.ts

@@ -15,3 +15,4 @@ declare module '@nuxt/schema' {
  *     addUserPreferences(nuxt, { path: resolver.resolve('./runtime/preferences') })
  */
 export declare function addUserPreferences(nuxt: Nuxt, source: PreferenceDefinitionSource): void;
+export { preferencesApi } from './api.js';

package/dist/runtime/utils/build.js

@@ -3,3 +3,4 @@ export function addUserPreferences(nuxt, source) {
     sources.push(source);
   });
 }
+export { preferencesApi } from "./api.js";

package/dist/runtime/utils/registry.d.ts

@@ -1,4 +1,4 @@
-import type { z } from 'zod';
+import { z } from 'zod';
 import type { PreferenceDefinitions } from '../define.js';
 export interface ResolvedPreference {
     key: string;
@@ -10,19 +10,20 @@ export interface ResolvedPreference {
 }
 /** Flattens the registered definer files into one lookup. The same key in two files is a mistake worth failing on. */
 export declare function resolvePreferences(sources: PreferenceDefinitions[]): Map<string, ResolvedPreference>;
-export type PreferencePatchResult = {
-    ok: true;
-    set: Record<string, unknown>;
-    remove: string[];
-} | {
-    ok: false;
-    message: string;
-};
 /**
- * Validates a partial update: every key must be registered, a value must satisfy its schema, and `null` clears
- * the preference.
+ * The zod schema of a partial update, built from the registered definitions: a strict object, so an unknown key is
+ * rejected, whose values satisfy their definition's schema or are `null` (which clears the preference).
  */
-export declare function parsePreferencePatch(registry: Map<string, ResolvedPreference>, body: unknown): PreferencePatchResult;
+export declare function preferencePatchSchema(registry: Map<string, ResolvedPreference>): z.ZodObject<{
+    [x: string]: z.ZodType<unknown, unknown, z.core.$ZodTypeInternals<unknown, unknown>>;
+}, z.core.$strict>;
+/**
+ * Validates a partial update with `preferencePatchSchema` and keeps only the keys the caller sent: a definition with
+ * a `.default()` must not be written just because the key was left out. Throws a `ZodError` (h3 answers 400).
+ */
+export declare function parsePreferencePatch(registry: Map<string, ResolvedPreference>, body: unknown): Record<string, unknown>;
+/** Applies a validated patch to the stored preferences: values set, `null` clears. */
+export declare function applyPreferencePatch(stored: Record<string, unknown> | null | undefined, patch: Record<string, unknown>): Record<string, unknown>;
 /** The stored value when it still satisfies the schema, so a changed schema never leaks stale data. */
 export declare function readPreference(registry: Map<string, ResolvedPreference>, stored: unknown, key: string): unknown;
 /** The claims to add for a token: only preferences that opted in, only when the scope was granted. */

package/dist/runtime/utils/registry.js

@@ -1,3 +1,4 @@
+import { z } from "zod";
 const isSchema = (value) => typeof value?.safeParse === "function";
 export function resolvePreferences(sources) {
   const registry = /* @__PURE__ */ new Map();
@@ -10,22 +11,18 @@ export function resolvePreferences(sources) {
   }
   return registry;
 }
+export function preferencePatchSchema(registry) {
+  const shape = {};
+  for (const [key, definition] of registry) shape[key] = definition.schema.nullable().optional();
+  return z.strictObject(shape);
+}
 export function parsePreferencePatch(registry, body) {
-  if (!body || typeof body !== "object" || Array.isArray(body)) return { ok: false, message: "Expected an object of preferences." };
-  const set = {};
-  const remove = [];
-  for (const [key, value] of Object.entries(body)) {
-    const definition = registry.get(key);
-    if (!definition) return { ok: false, message: `Unknown preference "${key}".` };
-    if (value === null) {
-      remove.push(key);
-      continue;
-    }
-    const parsed = definition.schema.safeParse(value);
-    if (!parsed.success) return { ok: false, message: `Invalid value for "${key}".` };
-    set[key] = parsed.data;
-  }
-  return { ok: true, set, remove };
+  const parsed = preferencePatchSchema(registry).parse(body);
+  return Object.fromEntries(Object.keys(body).map((key) => [key, parsed[key]]));
+}
+export function applyPreferencePatch(stored, patch) {
+  const next = { ...stored, ...patch };
+  return Object.fromEntries(Object.entries(next).filter(([, value]) => value !== null && value !== void 0));
 }
 export function readPreference(registry, stored, key) {
   const definition = registry.get(key);

package/dist/types.d.mts

@@ -2,4 +2,4 @@ export { type PreferenceDefinition, type PreferenceDefinitions, type Preferences
 
 export { default } from './module.mjs'
 
-export { type ModuleOptions, type UserPreferences } from './module.mjs'
+export { type ModuleOptions, type PreferencesDto, type UserPreferences } from './module.mjs'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@frigear-nu/preferences",
-  "version": "0.1.1",
+  "version": "0.1.3",
   "description": "Typed per-user preferences that modules and the host app register, stored on the user and optionally forwarded to OAuth applications as claims.",
   "homepage": "https://docs.frigear.dev/modules/preferences",
   "repository": {
@@ -20,6 +20,11 @@
       "types": "./dist/runtime/utils/build.d.ts",
       "import": "./dist/runtime/utils/build.js"
     },
+    "./api": {
+      "types": "./dist/runtime/utils/api.d.ts",
+      "import": "./dist/runtime/utils/api.js",
+      "default": "./dist/runtime/utils/api.js"
+    },
     "./define": {
       "types": "./dist/runtime/define.d.ts",
       "import": "./dist/runtime/define.js"
@@ -29,9 +34,9 @@
     "dist"
   ],
   "dependencies": {
-    "@frigear-nu/auth": "0.1.2",
-    "@frigear-nu/module-kit": "1.1.1",
-    "@frigear-nu/users": "1.1.2",
+    "@frigear-nu/auth": "0.1.4",
+    "@frigear-nu/module-kit": "1.1.3",
+    "@frigear-nu/users": "1.1.4",
     "@libsql/client": "^0.18.0",
     "@nuxt/kit": "^4.6.1",
     "drizzle-kit": "^0.31.11",
@@ -48,7 +53,7 @@
     }
   },
   "devDependencies": {
-    "@frigear-nu/oauth-server": "0.1.1",
+    "@frigear-nu/oauth-server": "0.1.3",
     "@nuxt/devtools": "^3.4.2",
     "@nuxt/eslint-config": "^1.17.0",
     "@nuxt/module-builder": "^1.0.3",