@urbicon-ui/sveltekit-utils 8.8.0 → 8.10.0

package/README.md

@@ -46,6 +46,7 @@ Bind a typed, reactive value to a URL search param. When the value changes, the
 
 Low-level escape hatch if you prefer to update multiple params at once:
 
+<!-- typecheck -->
 ```typescript
 import { updateUrlSearchParams } from '@urbicon-ui/sveltekit-utils/url.svelte';
 
@@ -90,14 +91,20 @@ Because the binding re-reads the URL rather than capturing it, the browser's bac
 The pure serializers work without SvelteKit — e.g. to parse the incoming query in a server `load` and fetch the first page during SSR. Use `searchParamsToViewSnapshot` from `./table-view`: it takes the *same* defaults object the component hands `createTableView`, so the server cannot resolve an absent param differently from the client, and it hands back the very shape a managed `source.query` receives.
 
 ```typescript
-// view-defaults.ts — imported by both the component and the load function
-export const userView = { pageSize: 25, sort: { column: 'joined', direction: 'desc' } };
+// src/lib/view-defaults.ts — imported by the component and by the load function.
+// `as const` keeps `direction` a `'desc'`, not a `string` the snapshot rejects.
+export const userView = { pageSize: 25, sort: { column: 'joined', direction: 'desc' } } as const;
+```
 
-// +page.server.ts
+<!-- typecheck -->
+```typescript
+// src/routes/users/+page.server.ts
 import { searchParamsToViewSnapshot } from '@urbicon-ui/sveltekit-utils/table-view';
-import { userView } from './view-defaults';
+import { fetchUsers } from '$lib/server/users';
+import { userView } from '$lib/view-defaults';
+import type { PageServerLoad } from './$types';
 
-export const load = async ({ url }) => ({
+export const load: PageServerLoad = async ({ url }) => ({
   initialResult: await fetchUsers(searchParamsToViewSnapshot(url.searchParams, userView))
 });
 ```
@@ -116,13 +123,20 @@ The `./table-query` subpath that used to hold a second copy of this codec — sa
 
 Fire HTTP requests against SvelteKit server endpoints on an interval. Pair with a shared-secret header so endpoints can authenticate scheduled calls.
 
+<!-- typecheck -->
 ```typescript
 // src/lib/server/cron.ts
 import { createCronRunner } from '@urbicon-ui/sveltekit-utils/cron';
 import { env } from '$env/dynamic/private';
 
+// Runtime env, not `$env/static/private`: a node server reads its secret at
+// start, not at build. The runner needs a `string`, so a missing one is a
+// startup failure here — not an unauthenticated cron loop.
+const secret = env.CRON_SECRET;
+if (!secret) throw new Error('CRON_SECRET is not set');
+
 export const cron = createCronRunner({
-  secret: env.CRON_SECRET,
+  secret,
   baseUrl: env.BASE_URL,
   jobs: [
     { path: '/api/cron/send-digest', intervalSeconds: 3600 },
@@ -136,12 +150,15 @@ cron.start();
 
 Receive the call and verify the secret inside your endpoint:
 
+<!-- typecheck -->
 ```typescript
 // src/routes/api/cron/send-digest/+server.ts
 import { env } from '$env/dynamic/private';
+import { sendDigest } from '$lib/server/digest';
+import type { RequestHandler } from './$types';
 
-export const POST = async ({ request }) => {
-  if (request.headers.get('x-cron-secret') !== env.CRON_SECRET) {
+export const POST: RequestHandler = async ({ request }) => {
+  if (!env.CRON_SECRET || request.headers.get('x-cron-secret') !== env.CRON_SECRET) {
     return new Response('Forbidden', { status: 403 });
   }
   await sendDigest();
@@ -182,9 +199,13 @@ controller.abort();
 
 Emit the matching frames from the endpoint:
 
+<!-- typecheck -->
 ```typescript
 // src/routes/api/chat/+server.ts
-export const POST = async ({ request }) => {
+import { runModel } from '$lib/server/model';
+import type { RequestHandler } from './$types';
+
+export const POST: RequestHandler = async ({ request }) => {
   const stream = new ReadableStream({
     async start(controller) {
       const enc = new TextEncoder();

package/dist/cron.d.ts

@@ -80,8 +80,12 @@ export interface CronRunner {
  * import { createCronRunner } from '@urbicon-ui/sveltekit-utils/cron';
  * import { env } from '$env/dynamic/private';
  *
+ * // runtime env: `secret` is a `string`, so a missing one fails at startup
+ * const secret = env.CRON_SECRET;
+ * if (!secret) throw new Error('CRON_SECRET is not set');
+ *
  * export const cron = createCronRunner({
- *   secret: env.CRON_SECRET,
+ *   secret,
  *   baseUrl: env.BASE_URL,
  *   jobs: [
  *     { path: '/api/cron/send-digest', intervalSeconds: 3600 },

package/dist/cron.js

@@ -16,8 +16,12 @@
  * import { createCronRunner } from '@urbicon-ui/sveltekit-utils/cron';
  * import { env } from '$env/dynamic/private';
  *
+ * // runtime env: `secret` is a `string`, so a missing one fails at startup
+ * const secret = env.CRON_SECRET;
+ * if (!secret) throw new Error('CRON_SECRET is not set');
+ *
  * export const cron = createCronRunner({
- *   secret: env.CRON_SECRET,
+ *   secret,
  *   baseUrl: env.BASE_URL,
  *   jobs: [
  *     { path: '/api/cron/send-digest', intervalSeconds: 3600 },

package/dist/table-view.d.ts

@@ -115,7 +115,7 @@ export declare function searchParamsToViewPartial(sp: URLSearchParams, defaults:
  * @example
  * ```ts
  * // shared with the component that calls createTableView({ defaults })
- * export const invoiceView = { pageSize: 25, sort: { column: 'date', direction: 'desc' } };
+ * export const invoiceView = { pageSize: 25, sort: { column: 'date', direction: 'desc' } } as const;
  *
  * export const load = async ({ url }) => ({
  *   initialResult: await fetchInvoices(searchParamsToViewSnapshot(url.searchParams, invoiceView))

package/dist/table-view.js

@@ -155,7 +155,7 @@ export function searchParamsToViewPartial(sp, defaults, prefix = '') {
  * @example
  * ```ts
  * // shared with the component that calls createTableView({ defaults })
- * export const invoiceView = { pageSize: 25, sort: { column: 'date', direction: 'desc' } };
+ * export const invoiceView = { pageSize: 25, sort: { column: 'date', direction: 'desc' } } as const;
  *
  * export const load = async ({ url }) => ({
  *   initialResult: await fetchInvoices(searchParamsToViewSnapshot(url.searchParams, invoiceView))

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@urbicon-ui/sveltekit-utils",
-  "version": "8.8.0",
+  "version": "8.10.0",
   "description": "SvelteKit helper utilities — createCronRunner, streamSse, and URL-state runes",
   "license": "MIT",
   "repository": {