@stacksjs/types 0.74.37 → 0.74.38

package/dist/notifications.d.ts

@@ -1,5 +1,10 @@
 export declare interface NotificationOptions {
   default: 'email' | 'sms' | 'chat' | string
+  tracking: {
+    enabled: boolean
+    channels?: NotificationChannelName[]
+    body: boolean
+  }
   email: {
     default:
       | 'emailjs'
@@ -123,4 +128,6 @@ export declare interface NotificationOptions {
     }
   }
 }
+/** A channel a notification can be delivered on. */
+export type NotificationChannelName = 'email' | 'sms' | 'chat' | 'database' | 'push' | 'broadcast';
 export type NotificationConfig = Partial<NotificationOptions>;

package/dist/server.d.ts

@@ -18,8 +18,26 @@ export declare interface ApiProxyOptions {
 export declare interface ServerConfig {
   proxy?: ApiProxyOptions
   redirects?: RedirectsOptions
+  rewrites?: RewritesOptions
+  cache?: ServerCacheOptions
   security?: ServerSecurityOptions
 }
+/**
+ * How the views server caches what it renders.
+ *
+ * Off by default: a page whose content depends on who is asking must not be
+ * handed to the next visitor, and the server cannot know which pages those are
+ * without being told.
+ */
+export declare interface ServerCacheOptions {
+  renders?: boolean
+  renderVary?: 'request' | 'source'
+  prewarm?: boolean
+  documents?: {
+    maxAge?: number
+    staleWhileRevalidate?: number
+  }
+}
 /** Security headers the views server puts on rendered pages. */
 export declare interface ServerSecurityOptions {
   embeddable?: string[]
@@ -60,3 +78,32 @@ export type RedirectsOptions = Record<string, string | {
   /** Carry the incoming query string onto the target. Defaults to true. */
   preserveQuery?: boolean
 }>;
+/**
+ * Paths the API process answers under a different path.
+ *
+ * `proxy.paths` forwards a path unchanged, which is enough when the API
+ * registered that same URL. It is not enough when the public path and the
+ * registered route differ — `routes/api.ts` carries an `/api` prefix, so a
+ * handler whose home is the site root is registered at `/api/...` and the root
+ * path 404s with nothing to say why.
+ *
+ * ```ts
+ * rewrites: {
+ *   '/sitemap.xml': '/api/sitemap.xml',
+ *   '/sitemap-trails-*': '/api/sitemap-trails-*',
+ *   '/.well-known/': '/api/well-known/',
+ * }
+ * ```
+ *
+ * Unlike a redirect this is invisible to the client: the request is answered
+ * where it was made, so the URL a crawler indexes is the one it asked for. Use
+ * a redirect when the URL genuinely moved, and a rewrite when it did not.
+ *
+ * A rule ending in `*` claims every path starting with it and appends the
+ * remainder to the target — one rule for a chunked resource whose count
+ * changes. An exact rule beats a prefix one; the longest prefix wins among
+ * prefixes. Rules are answered before a page is looked for and before
+ * `public/` is searched, so one shadows a static file of the same name.
+ * A rewrite whose source is already under `/api/` is ignored.
+ */
+export type RewritesOptions = Record<string, string>;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@stacksjs/types",
   "type": "module",
-  "version": "0.74.37",
+  "version": "0.74.38",
   "description": "The Stacks framework types.",
   "author": "Chris Breuer",
   "contributors": [
@@ -58,8 +58,8 @@
   "dependencies": {
     "@stacksjs/bunpress": "^0.2.8",
     "@stacksjs/clapp": "^0.2.12",
-    "@stacksjs/events": "0.74.37",
-    "@stacksjs/strings": "0.74.37",
+    "@stacksjs/events": "0.74.38",
+    "@stacksjs/strings": "0.74.38",
     "@stacksjs/stx": "^0.2.274",
     "@stacksjs/ts-validation": "^0.5.6",
     "bun-query-builder": "^0.2.69"
@@ -73,7 +73,7 @@
     }
   },
   "devDependencies": {
-    "@stacksjs/validation": "0.74.37",
+    "@stacksjs/validation": "0.74.38",
     "better-dx": "^0.2.24",
     "meilisearch": "^0.59.0"
   },