@linkforty/core 1.41.3 → 1.42.0

package/README.md

@@ -245,6 +245,33 @@ GET /:templateSlug/:shortCode
 
 Automatically redirects users to the appropriate URL based on device type (iOS/Android/web), evaluates targeting rules, and tracks the click asynchronously.
 
+**Not-found page:** When a link can't be served, a browser gets a small HTML page ("Link not found") with status 404, `noindex`, `Cache-Control: no-store` and a content-security policy that allows no script. That covers an unknown code, an expired or switched-off link, a link on another organization's host, a visitor outside the link's targeting rules, and a link with no destination for the visitor's device. All of these render the same page, so an expired link can't be told apart from a code that never existed. Clients that don't send `Accept: text/html` (API callers, scripts) keep the JSON body: `{ "error": "Link not found" }`, or `{ "error": "No destination URL configured for this link" }` for a link with no destination. A link withdrawn for abuse keeps its own 410 notice.
+
+You can change the page or send browsers somewhere else instead, without writing code. The first of these that is set wins:
+
+1. **The organization's settings**, `organizations.settings.notFound`, on a host that belongs to the organization. On a shared host, only a live link that has nothing for this visitor (a targeting miss, no destination) uses its organization's settings. An unknown, expired or switched-off code there uses the instance's.
+
+   ```json
+   {
+     "notFound": {
+       "redirectUrl": "https://ridealert.example",   // send browsers here (302); the rest is ignored
+       "title": "This ride link has expired",
+       "message": "Open the app to see current rides.",
+       "logoUrl": "https://cdn.example/logo.png",
+       "accentColor": "#0f766e",                     // the button
+       "backgroundColor": "#f6f7f8",                 // light mode only
+       "buttonLabel": "Get the app",                 // shown only with buttonUrl
+       "buttonUrl": "https://ridealert.example/app"
+     }
+   }
+   ```
+
+   Changes show within a minute.
+2. **The instance's defaults**: the `notFound` section of `linkforty.config.json` (see [Configuration file](#configuration-file)), with the same fields.
+3. **The built-in page.**
+
+URLs must be http(s) and colors hex; anything else is dropped, and all text is escaped. The `notFound` option below decides in code ahead of all three.
+
 **Mobile interstitial:** When a link has `appScheme` configured and a store fallback URL (iOS App Store or Google Play), mobile requests receive a smart interstitial page instead of a raw 302 redirect. The interstitial tries to open the app via URI scheme and falls back to the app store after 1.5 seconds. This handles the case where a 302 to a custom URI scheme fails silently when the app is not installed. URL fragments are preserved through the redirect, enabling patterns like E2E encryption where the decryption key lives in the fragment.
 
 **Launchpad page (desktop):** A link to app-only content has nowhere to send a desktop visitor. When the chain resolves no web destination (link → template → workspace `appConfig`), a desktop request gets a hosted landing page instead of an error: the link's title, description and image (`ogTitle` / `ogDescription` / `ogImageUrl`, falling back to `title` / `description`), the app's icon and name, the official App Store / Google Play badges (embedded in the page, so it makes no third-party request), and a QR code so the visitor can finish on their phone. The page is `noindex`, sent with `Cache-Control: no-store` and a content-security policy that allows no script without a per-response nonce, and it never navigates on its own — no timers, no automatic scheme attempts.
@@ -380,6 +407,7 @@ interface ServerOptions {
   trustProxy?: boolean | number;  // Trust X-Forwarded-For when behind a proxy (default: false)
   redirect?: RedirectRouteOptions;  // See below
   sdk?: SdkRouteOptions;            // See below
+  config?: LinkFortyConfig;         // linkforty.config.json, from loadConfig()
 }
 
 interface RedirectRouteOptions {
@@ -406,6 +434,24 @@ interface RedirectRouteOptions {
   // association files on that host, so no installed app can claim its URLs.
   // A hook that throws is logged and treated as false.
   isWebLinkRequest?: (request) => Promise<boolean> | boolean;
+  // The instance's not-found page or redirect, used when the organization has
+  // no settings.notFound of its own. createServer() fills it from the
+  // `notFound` section of the config file (ServerOptions.config).
+  notFoundDefaults?: NotFoundSettings;
+  // Decide the not-found response in code, ahead of the organization's
+  // settings and notFoundDefaults: page content (title,
+  // message, logoUrl, accentColor, backgroundColor, buttonLabel, buttonUrl — all
+  // optional, all escaped; non-http(s) URLs and non-hex colors are dropped),
+  // a URL to 302 to (http(s) only), or null to fall through. Called only
+  // for requests that accept HTML, and never for a link withdrawn for abuse.
+  // `context.reason` is "unknown" | "disabled" | "not_targeted" |
+  // "no_destination"; `context.link` is the link row (null for "unknown");
+  // `context.scope` is the host's organization, if any. Use the reason to
+  // decide whose settings apply, not to vary the page: an expired link must
+  // look like a code that never existed. A hook that throws is logged and
+  // treated as null.
+  notFound?: (request, context: { reason, link, scope }) =>
+    Promise<NotFoundResolution | null> | NotFoundResolution | null;
 }
 
 interface SdkRouteOptions {
@@ -422,7 +468,26 @@ interface SdkRouteOptions {
 
 Install matching only considers clicks from the installing device's own network (its IPv4 /24 or IPv6 /64), since no other click can reach the confidence threshold, so the attribution window holds however much traffic the server takes. It relies on the `idx_fingerprints_ip` index, which `initializeDatabase()` builds concurrently on first start so click writes are never blocked.
 
-`renderLaunchpadPage()`, `defaultLaunchpadContent()` and `shouldServeLaunchpadOnDesktop()` are exported so a host can render the same page elsewhere (a settings preview, for instance).
+`renderLaunchpadPage()`, `defaultLaunchpadContent()` and `shouldServeLaunchpadOnDesktop()` are exported so a host can render the same page elsewhere (a settings preview, for instance). `renderNotFoundPage()` is exported for the same reason, and for a host that answers some requests before they reach the redirect route.
+
+### Configuration file
+
+Core splits its configuration the way most self-hosted platforms do:
+
+- **Environment variables** hold infrastructure and secrets: `DATABASE_URL`, `REDIS_URL`, `PORT`, `TRUST_PROXY`, and so on.
+- **`linkforty.config.json`** holds the instance's defaults and behavior, including text a visitor reads. Today that's the `notFound` section; see [linkforty.config.example.json](linkforty.config.example.json) and [DOCKER.md](DOCKER.md#configuration-file) for every setting.
+- **`organizations.settings`** holds per-organization values, which take precedence over the file where both apply.
+
+The file is optional. Core reads the path in `LINKFORTY_CONFIG`, or `linkforty.config.json` in the working directory. A file with an invalid value or unknown setting stops the server at startup with the setting named, rather than starting with it ignored. The Docker image does this for you. When you create the server yourself, load it and pass it in:
+
+```typescript
+import { createServer, loadConfig } from '@linkforty/core';
+
+const { config } = loadConfig(); // throws ConfigError on a bad file
+const server = await createServer({ database: { url: process.env.DATABASE_URL }, config });
+```
+
+Options passed in code (such as `redirect.notFoundDefaults`) take precedence over the file.
 
 ### Running behind a reverse proxy
 

package/dist/index.d.ts

@@ -2,6 +2,7 @@ import { FastifyInstance } from 'fastify';
 import { DatabaseOptions } from './lib/database.js';
 import { type RedirectRouteOptions } from './routes/redirect.js';
 import { type SdkRouteOptions } from './routes/sdk.js';
+import type { LinkFortyConfig } from './lib/config.js';
 /**
  * Configuration options for creating a LinkForty server instance.
  */
@@ -20,6 +21,11 @@ export interface ServerOptions {
     redirect?: RedirectRouteOptions;
     /** Options for the SDK routes: install match scoping. */
     sdk?: SdkRouteOptions;
+    /**
+     * The instance's settings from linkforty.config.json, as loadConfig() returns
+     * them. Options passed in code take precedence over the file.
+     */
+    config?: LinkFortyConfig;
 }
 /**
  * Create and configure a LinkForty Fastify server instance.
@@ -40,6 +46,8 @@ export * from './lib/link-lookup.js';
 export * from './lib/portable/index.js';
 export * from './lib/link-safety.js';
 export * from './lib/launchpad.js';
+export * from './lib/not-found-page.js';
+export * from './lib/config.js';
 export * from './lib/event-emitter.js';
 export * from './types/index.js';
 export type { RedirectRouteOptions } from './routes/redirect.js';

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EAAsB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAkB,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjF,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAOlE;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,KAAK,CAAC,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC3B,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,yDAAyD;IACzD,GAAG,CAAC,EAAE,eAAe,CAAC;CACvB;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,OAAO,GAAE,aAAkB,kTAiC7D;AAGD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAgB,EAAE,eAAe,EAAE,MAAM,SAAS,CAAC;AAGnD,OAAO,EAAsB,eAAe,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAkB,KAAK,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AAGjF,OAAO,EAAa,KAAK,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAMlE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD;;GAEG;AACH,MAAM,WAAW,aAAa;IAC5B,QAAQ,CAAC,EAAE,eAAe,CAAC;IAC3B,KAAK,CAAC,EAAE;QACN,GAAG,EAAE,MAAM,CAAC;KACb,CAAC;IACF,IAAI,CAAC,EAAE;QACL,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;KAC3B,CAAC;IACF,MAAM,CAAC,EAAE,OAAO,CAAC;IACjB,oJAAoJ;IACpJ,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,CAAC;IAC9B,gFAAgF;IAChF,QAAQ,CAAC,EAAE,oBAAoB,CAAC;IAChC,yDAAyD;IACzD,GAAG,CAAC,EAAE,eAAe,CAAC;IACtB;;;OAGG;IACH,MAAM,CAAC,EAAE,eAAe,CAAC;CAC1B;AAED;;;;;;;;GAQG;AACH,wBAAsB,YAAY,CAAC,OAAO,GAAE,aAAkB,kTAoC7D;AAGD,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AACjC,YAAY,EAAE,oBAAoB,EAAE,MAAM,sBAAsB,CAAC;AACjE,YAAY,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AACvD,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/index.js

@@ -40,7 +40,10 @@ export async function createServer(options = {}) {
     // Routes
     await fastify.register(healthRoutes);
     await fastify.register(wellKnownRoutes);
-    await fastify.register(redirectRoutes, options.redirect ?? {});
+    await fastify.register(redirectRoutes, {
+        ...options.redirect,
+        notFoundDefaults: options.redirect?.notFoundDefaults ?? options.config?.notFound,
+    });
     await fastify.register(linkRoutes);
     await fastify.register(analyticsRoutes);
     await fastify.register(sdkRoutes, options.sdk ?? {});
@@ -59,6 +62,8 @@ export * from './lib/link-lookup.js';
 export * from './lib/portable/index.js';
 export * from './lib/link-safety.js';
 export * from './lib/launchpad.js';
+export * from './lib/not-found-page.js';
+export * from './lib/config.js';
 export * from './lib/event-emitter.js';
 export * from './types/index.js';
 export { redirectRoutes, linkRoutes, analyticsRoutes, sdkRoutes, webhookRoutes, templateRoutes, qrRoutes, previewRoutes, debugRoutes, wellKnownRoutes, healthRoutes } from './routes/index.js';

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAA4B,MAAM,SAAS,CAAC;AACnD,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,cAAc,EAA6B,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAwB,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAsBlD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAyB,EAAE;IAC5D,MAAM,OAAO,GAAG,OAAO,CAAC;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QAC5D,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IAEH,OAAO;IACP,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC3B,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG;KACpC,CAAC,CAAC;IAEH,mBAAmB;IACnB,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE;YAC5B,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG;SACvB,CAAC,CAAC;IACL,CAAC;IAED,WAAW;IACX,MAAM,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE3C,SAAS;IACT,MAAM,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrC,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IACxC,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE,OAAO,CAAC,QAAQ,IAAI,EAAE,CAAC,CAAC;IAC/D,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACnC,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IACxC,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IACrD,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,gCAAgC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,OAA4B,MAAM,SAAS,CAAC;AACnD,OAAO,IAAI,MAAM,eAAe,CAAC;AACjC,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,cAAc,EAA6B,MAAM,sBAAsB,CAAC;AACjF,OAAO,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAC/C,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AACxD,OAAO,EAAE,SAAS,EAAwB,MAAM,iBAAiB,CAAC;AAClE,OAAO,EAAE,aAAa,EAAE,MAAM,sBAAsB,CAAC;AACrD,OAAO,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AACvD,OAAO,EAAE,QAAQ,EAAE,MAAM,gBAAgB,CAAC;AAC1C,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AA4BlD;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,UAAyB,EAAE;IAC5D,MAAM,OAAO,GAAG,OAAO,CAAC;QACtB,MAAM,EAAE,OAAO,CAAC,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI;QAC5D,UAAU,EAAE,OAAO,CAAC,UAAU;KAC/B,CAAC,CAAC;IAEH,OAAO;IACP,MAAM,OAAO,CAAC,QAAQ,CAAC,IAAI,EAAE;QAC3B,MAAM,EAAE,OAAO,CAAC,IAAI,EAAE,MAAM,IAAI,GAAG;KACpC,CAAC,CAAC;IAEH,mBAAmB;IACnB,IAAI,OAAO,CAAC,KAAK,EAAE,GAAG,EAAE,CAAC;QACvB,MAAM,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE;YAC5B,GAAG,EAAE,OAAO,CAAC,KAAK,CAAC,GAAG;SACvB,CAAC,CAAC;IACL,CAAC;IAED,WAAW;IACX,MAAM,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IAE3C,SAAS;IACT,MAAM,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAC;IACrC,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IACxC,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAc,EAAE;QACrC,GAAG,OAAO,CAAC,QAAQ;QACnB,gBAAgB,EAAE,OAAO,CAAC,QAAQ,EAAE,gBAAgB,IAAI,OAAO,CAAC,MAAM,EAAE,QAAQ;KACjF,CAAC,CAAC;IACH,MAAM,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;IACnC,MAAM,OAAO,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;IACxC,MAAM,OAAO,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,GAAG,IAAI,EAAE,CAAC,CAAC;IACrD,MAAM,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;IACtC,MAAM,OAAO,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAC;IACvC,MAAM,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;IAEjC,OAAO,OAAO,CAAC;AACjB,CAAC;AAED,gCAAgC;AAChC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,oBAAoB,CAAC;AACnC,cAAc,mBAAmB,CAAC;AAClC,cAAc,sBAAsB,CAAC;AACrC,cAAc,kBAAkB,CAAC;AACjC,cAAc,sBAAsB,CAAC;AACrC,cAAc,yBAAyB,CAAC;AACxC,cAAc,sBAAsB,CAAC;AACrC,cAAc,oBAAoB,CAAC;AACnC,cAAc,yBAAyB,CAAC;AACxC,cAAc,iBAAiB,CAAC;AAChC,cAAc,wBAAwB,CAAC;AACvC,cAAc,kBAAkB,CAAC;AAGjC,OAAO,EAAE,cAAc,EAAE,UAAU,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,cAAc,EAAE,QAAQ,EAAE,aAAa,EAAE,WAAW,EAAE,eAAe,EAAE,YAAY,EAAE,MAAM,mBAAmB,CAAC"}

package/dist/lib/config.d.ts

@@ -0,0 +1,33 @@
+import type { NotFoundSettings } from './not-found-page.js';
+/** File looked for in the working directory when LINKFORTY_CONFIG is unset. */
+export declare const DEFAULT_CONFIG_FILE = "linkforty.config.json";
+export interface LinkFortyConfig {
+    /** What a browser sees when a link can't be served (lib/not-found-page.ts). */
+    notFound?: NotFoundSettings;
+}
+export declare class ConfigError extends Error {
+    readonly path: string;
+    constructor(message: string, path: string);
+}
+/** Validate an already-parsed configuration object. `path` names it in errors. */
+export declare function parseConfig(raw: unknown, path?: string): LinkFortyConfig;
+/**
+ * Load the configuration file.
+ *
+ * Reads the file named by `options.path`, else by LINKFORTY_CONFIG, else
+ * `linkforty.config.json` in the working directory. A file named explicitly
+ * must exist; the default one is optional. Returns the file's path, or null
+ * when none was read.
+ *
+ * @throws ConfigError when the file can't be read, isn't JSON, or has an
+ *   invalid or unknown setting.
+ */
+export declare function loadConfig(options?: {
+    path?: string;
+    env?: Record<string, string | undefined>;
+    cwd?: string;
+}): {
+    config: LinkFortyConfig;
+    path: string | null;
+};
+//# sourceMappingURL=config.d.ts.map

package/dist/lib/config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.d.ts","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAoBA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,qBAAqB,CAAC;AAE5D,+EAA+E;AAC/E,eAAO,MAAM,mBAAmB,0BAA0B,CAAC;AAE3D,MAAM,WAAW,eAAe;IAC9B,+EAA+E;IAC/E,QAAQ,CAAC,EAAE,gBAAgB,CAAC;CAC7B;AAED,qBAAa,WAAY,SAAQ,KAAK;IAGlC,QAAQ,CAAC,IAAI,EAAE,MAAM;gBADrB,OAAO,EAAE,MAAM,EACN,IAAI,EAAE,MAAM;CAKxB;AAiDD,kFAAkF;AAClF,wBAAgB,WAAW,CAAC,GAAG,EAAE,OAAO,EAAE,IAAI,SAAsB,GAAG,eAAe,CAMrF;AAED;;;;;;;;;;GAUG;AACH,wBAAgB,UAAU,CACxB,OAAO,GAAE;IAAE,IAAI,CAAC,EAAE,MAAM,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,SAAS,CAAC,CAAC;IAAC,GAAG,CAAC,EAAE,MAAM,CAAA;CAAO,GACtF;IAAE,MAAM,EAAE,eAAe,CAAC;IAAC,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;CAAE,CAkBlD"}

package/dist/lib/config.js

@@ -0,0 +1,111 @@
+/**
+ * The instance's configuration file, `linkforty.config.json`.
+ *
+ * Configuration is split the way most self-hosted platforms split it:
+ *
+ *   - environment variables hold infrastructure and secrets: where the
+ *     database is, which port to listen on, and the path to this file;
+ *   - this file holds the instance's defaults and behavior, including text a
+ *     visitor reads;
+ *   - `organizations.settings` holds per-organization values, which take
+ *     precedence over this file where both apply.
+ *
+ * The file is optional: without one every built-in default applies. A file that
+ * exists but is wrong stops the server at startup with a message naming the bad
+ * key. The operator wrote it on purpose, so a mistake should show immediately
+ * rather than as a page that quietly ignores them.
+ */
+import { existsSync, readFileSync } from 'fs';
+import { resolve } from 'path';
+import { z } from 'zod';
+/** File looked for in the working directory when LINKFORTY_CONFIG is unset. */
+export const DEFAULT_CONFIG_FILE = 'linkforty.config.json';
+export class ConfigError extends Error {
+    constructor(message, path) {
+        super(`${path}: ${message}`);
+        this.path = path;
+        this.name = 'ConfigError';
+    }
+}
+const httpUrl = z
+    .string()
+    .trim()
+    .refine((value) => {
+    try {
+        const { protocol } = new URL(value);
+        return protocol === 'http:' || protocol === 'https:';
+    }
+    catch {
+        return false;
+    }
+}, 'must be an http(s) URL');
+const hexColor = z
+    .string()
+    .trim()
+    .regex(/^#(?:[0-9a-f]{3,4}|[0-9a-f]{6}|[0-9a-f]{8})$/i, 'must be a hex color such as #0f766e');
+const notFoundSchema = z
+    .object({
+    redirectUrl: httpUrl.optional(),
+    title: z.string().trim().min(1).max(120).optional(),
+    message: z.string().trim().min(1).max(500).optional(),
+    logoUrl: httpUrl.optional(),
+    accentColor: hexColor.optional(),
+    backgroundColor: hexColor.optional(),
+    buttonLabel: z.string().trim().min(1).max(60).optional(),
+    buttonUrl: httpUrl.optional(),
+})
+    .strict()
+    .refine((value) => !value.buttonLabel === !value.buttonUrl, {
+    message: 'buttonLabel and buttonUrl must be set together',
+});
+const configSchema = z
+    .object({
+    notFound: notFoundSchema.optional(),
+})
+    .strict();
+function describeIssue(issue) {
+    if (issue.code === 'unrecognized_keys') {
+        const where = issue.path.length ? `${issue.path.join('.')}: ` : '';
+        return `${where}unknown setting ${issue.keys.map((k) => `"${k}"`).join(', ')}`;
+    }
+    return issue.path.length ? `${issue.path.join('.')}: ${issue.message}` : issue.message;
+}
+/** Validate an already-parsed configuration object. `path` names it in errors. */
+export function parseConfig(raw, path = DEFAULT_CONFIG_FILE) {
+    const result = configSchema.safeParse(raw);
+    if (!result.success) {
+        throw new ConfigError(result.error.issues.map(describeIssue).join('; '), path);
+    }
+    return result.data;
+}
+/**
+ * Load the configuration file.
+ *
+ * Reads the file named by `options.path`, else by LINKFORTY_CONFIG, else
+ * `linkforty.config.json` in the working directory. A file named explicitly
+ * must exist; the default one is optional. Returns the file's path, or null
+ * when none was read.
+ *
+ * @throws ConfigError when the file can't be read, isn't JSON, or has an
+ *   invalid or unknown setting.
+ */
+export function loadConfig(options = {}) {
+    const env = options.env ?? process.env;
+    const named = options.path || env.LINKFORTY_CONFIG || '';
+    const path = resolve(options.cwd ?? process.cwd(), named || DEFAULT_CONFIG_FILE);
+    if (!existsSync(path)) {
+        if (named)
+            throw new ConfigError('file not found', path);
+        return { config: {}, path: null };
+    }
+    let raw;
+    try {
+        raw = JSON.parse(readFileSync(path, 'utf8'));
+    }
+    catch (error) {
+        const reason = error instanceof SyntaxError ? `not valid JSON (${error.message})` : 'could not be read';
+        throw new ConfigError(reason, path);
+    }
+    return { config: parseConfig(raw, path), path };
+}
+//# sourceMappingURL=config.js.map

package/dist/lib/config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.js","sourceRoot":"","sources":["../../src/lib/config.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;GAgBG;AACH,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,IAAI,CAAC;AAC9C,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAC/B,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB,+EAA+E;AAC/E,MAAM,CAAC,MAAM,mBAAmB,GAAG,uBAAuB,CAAC;AAO3D,MAAM,OAAO,WAAY,SAAQ,KAAK;IACpC,YACE,OAAe,EACN,IAAY;QAErB,KAAK,CAAC,GAAG,IAAI,KAAK,OAAO,EAAE,CAAC,CAAC;QAFpB,SAAI,GAAJ,IAAI,CAAQ;QAGrB,IAAI,CAAC,IAAI,GAAG,aAAa,CAAC;IAC5B,CAAC;CACF;AAED,MAAM,OAAO,GAAG,CAAC;KACd,MAAM,EAAE;KACR,IAAI,EAAE;KACN,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;IAChB,IAAI,CAAC;QACH,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QACpC,OAAO,QAAQ,KAAK,OAAO,IAAI,QAAQ,KAAK,QAAQ,CAAC;IACvD,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC,EAAE,wBAAwB,CAAC,CAAC;AAE/B,MAAM,QAAQ,GAAG,CAAC;KACf,MAAM,EAAE;KACR,IAAI,EAAE;KACN,KAAK,CAAC,+CAA+C,EAAE,qCAAqC,CAAC,CAAC;AAEjG,MAAM,cAAc,GAAG,CAAC;KACrB,MAAM,CAAC;IACN,WAAW,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC/B,KAAK,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACnD,OAAO,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE;IACrD,OAAO,EAAE,OAAO,CAAC,QAAQ,EAAE;IAC3B,WAAW,EAAE,QAAQ,CAAC,QAAQ,EAAE;IAChC,eAAe,EAAE,QAAQ,CAAC,QAAQ,EAAE;IACpC,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,IAAI,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,QAAQ,EAAE;IACxD,SAAS,EAAE,OAAO,CAAC,QAAQ,EAAE;CAC9B,CAAC;KACD,MAAM,EAAE;KACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,WAAW,KAAK,CAAC,KAAK,CAAC,SAAS,EAAE;IAC1D,OAAO,EAAE,gDAAgD;CAC1D,CAAC,CAAC;AAEL,MAAM,YAAY,GAAG,CAAC;KACnB,MAAM,CAAC;IACN,QAAQ,EAAE,cAAc,CAAC,QAAQ,EAAE;CACpC,CAAC;KACD,MAAM,EAAE,CAAC;AAEZ,SAAS,aAAa,CAAC,KAAiB;IACtC,IAAI,KAAK,CAAC,IAAI,KAAK,mBAAmB,EAAE,CAAC;QACvC,MAAM,KAAK,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC;QACnE,OAAO,GAAG,KAAK,mBAAmB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;IACjF,CAAC;IACD,OAAO,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC,OAAO,CAAC;AACzF,CAAC;AAED,kFAAkF;AAClF,MAAM,UAAU,WAAW,CAAC,GAAY,EAAE,IAAI,GAAG,mBAAmB;IAClE,MAAM,MAAM,GAAG,YAAY,CAAC,SAAS,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,MAAM,CAAC,OAAO,EAAE,CAAC;QACpB,MAAM,IAAI,WAAW,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;IACD,OAAO,MAAM,CAAC,IAAI,CAAC;AACrB,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,UAAU,CACxB,UAAqF,EAAE;IAEvF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,CAAC;IACvC,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,IAAI,GAAG,CAAC,gBAAgB,IAAI,EAAE,CAAC;IACzD,MAAM,IAAI,GAAG,OAAO,CAAC,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,EAAE,KAAK,IAAI,mBAAmB,CAAC,CAAC;IAEjF,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,IAAI,KAAK;YAAE,MAAM,IAAI,WAAW,CAAC,gBAAgB,EAAE,IAAI,CAAC,CAAC;QACzD,OAAO,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;IACpC,CAAC;IAED,IAAI,GAAY,CAAC;IACjB,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC;IAC/C,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,MAAM,GAAG,KAAK,YAAY,WAAW,CAAC,CAAC,CAAC,mBAAmB,KAAK,CAAC,OAAO,GAAG,CAAC,CAAC,CAAC,mBAAmB,CAAC;QACxG,MAAM,IAAI,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;IACtC,CAAC;IACD,OAAO,EAAE,MAAM,EAAE,WAAW,CAAC,GAAG,EAAE,IAAI,CAAC,EAAE,IAAI,EAAE,CAAC;AAClD,CAAC"}

package/dist/lib/config.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=config.test.d.ts.map

package/dist/lib/config.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.test.d.ts","sourceRoot":"","sources":["../../src/lib/config.test.ts"],"names":[],"mappings":""}

package/dist/lib/config.test.js

@@ -0,0 +1,86 @@
+import { describe, it, expect, beforeEach, afterEach } from 'vitest';
+import { mkdtempSync, rmSync, writeFileSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import { ConfigError, loadConfig, parseConfig } from './config.js';
+let dir;
+beforeEach(() => {
+    dir = mkdtempSync(join(tmpdir(), 'linkforty-config-'));
+});
+afterEach(() => {
+    rmSync(dir, { recursive: true, force: true });
+});
+function write(name, contents) {
+    const path = join(dir, name);
+    writeFileSync(path, typeof contents === 'string' ? contents : JSON.stringify(contents));
+    return path;
+}
+function errorFrom(fn) {
+    try {
+        fn();
+    }
+    catch (error) {
+        expect(error).toBeInstanceOf(ConfigError);
+        return error;
+    }
+    throw new Error('expected a ConfigError');
+}
+describe('loadConfig', () => {
+    it('uses the defaults when there is no file', () => {
+        expect(loadConfig({ cwd: dir, env: {} })).toEqual({ config: {}, path: null });
+    });
+    it('reads linkforty.config.json from the working directory', () => {
+        const path = write('linkforty.config.json', { notFound: { title: 'Gone' } });
+        expect(loadConfig({ cwd: dir, env: {} })).toEqual({ config: { notFound: { title: 'Gone' } }, path });
+    });
+    it('reads the file named by LINKFORTY_CONFIG', () => {
+        const path = write('custom.json', { notFound: { redirectUrl: 'https://example.com/' } });
+        expect(loadConfig({ cwd: '/', env: { LINKFORTY_CONFIG: path } }).config).toEqual({
+            notFound: { redirectUrl: 'https://example.com/' },
+        });
+    });
+    it('fails when a named file is missing', () => {
+        const error = errorFrom(() => loadConfig({ cwd: dir, env: { LINKFORTY_CONFIG: 'missing.json' } }));
+        expect(error.message).toContain('missing.json: file not found');
+    });
+    it('fails on invalid JSON', () => {
+        write('linkforty.config.json', '{ "notFound": { title: "x" } }');
+        expect(errorFrom(() => loadConfig({ cwd: dir, env: {} })).message).toContain('not valid JSON');
+    });
+    it('trims values', () => {
+        write('linkforty.config.json', { notFound: { title: '  Gone  ' } });
+        expect(loadConfig({ cwd: dir, env: {} }).config.notFound?.title).toBe('Gone');
+    });
+});
+describe('parseConfig', () => {
+    it('accepts every notFound setting', () => {
+        const notFound = {
+            redirectUrl: 'https://example.com/',
+            title: 'Gone',
+            message: 'Try the homepage.',
+            logoUrl: 'https://cdn.example.com/logo.png',
+            accentColor: '#0f766e',
+            backgroundColor: '#f6f7f8',
+            buttonLabel: 'Home',
+            buttonUrl: 'https://example.com/',
+        };
+        expect(parseConfig({ notFound })).toEqual({ notFound });
+    });
+    it.each([
+        [{ notFound: { redirectUrl: 'javascript:alert(1)' } }, 'notFound.redirectUrl: must be an http(s) URL'],
+        [{ notFound: { accentColor: 'teal' } }, 'notFound.accentColor: must be a hex color'],
+        [{ notFound: { buttonLabel: 'Home' } }, 'buttonLabel and buttonUrl must be set together'],
+        [{ notFound: { titel: 'Gone' } }, 'notFound: unknown setting "titel"'],
+        [{ notfound: {} }, 'unknown setting "notfound"'],
+        [{ notFound: { title: 42 } }, 'notFound.title'],
+        [{ notFound: { title: 'x'.repeat(121) } }, 'notFound.title'],
+    ])('names the bad setting: %j', (raw, expected) => {
+        const error = errorFrom(() => parseConfig(raw, 'linkforty.config.json'));
+        expect(error.message).toContain('linkforty.config.json: ');
+        expect(error.message).toContain(expected);
+    });
+    it('rejects a file that is not an object', () => {
+        expect(() => parseConfig([])).toThrow(ConfigError);
+    });
+});
+//# sourceMappingURL=config.test.js.map

package/dist/lib/config.test.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"config.test.js","sourceRoot":"","sources":["../../src/lib/config.test.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,EAAE,EAAE,MAAM,EAAE,UAAU,EAAE,SAAS,EAAE,MAAM,QAAQ,CAAC;AACrE,OAAO,EAAE,WAAW,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,IAAI,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,IAAI,CAAC;AAC5B,OAAO,EAAE,IAAI,EAAE,MAAM,MAAM,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,UAAU,EAAE,WAAW,EAAE,MAAM,aAAa,CAAC;AAEnE,IAAI,GAAW,CAAC;AAEhB,UAAU,CAAC,GAAG,EAAE;IACd,GAAG,GAAG,WAAW,CAAC,IAAI,CAAC,MAAM,EAAE,EAAE,mBAAmB,CAAC,CAAC,CAAC;AACzD,CAAC,CAAC,CAAC;AAEH,SAAS,CAAC,GAAG,EAAE;IACb,MAAM,CAAC,GAAG,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC;AAChD,CAAC,CAAC,CAAC;AAEH,SAAS,KAAK,CAAC,IAAY,EAAE,QAAiB;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7B,aAAa,CAAC,IAAI,EAAE,OAAO,QAAQ,KAAK,QAAQ,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;IACxF,OAAO,IAAI,CAAC;AACd,CAAC;AAED,SAAS,SAAS,CAAC,EAAiB;IAClC,IAAI,CAAC;QACH,EAAE,EAAE,CAAC;IACP,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,MAAM,CAAC,KAAK,CAAC,CAAC,cAAc,CAAC,WAAW,CAAC,CAAC;QAC1C,OAAO,KAAoB,CAAC;IAC9B,CAAC;IACD,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAC;AAC5C,CAAC;AAED,QAAQ,CAAC,YAAY,EAAE,GAAG,EAAE;IAC1B,EAAE,CAAC,yCAAyC,EAAE,GAAG,EAAE;QACjD,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,wDAAwD,EAAE,GAAG,EAAE;QAChE,MAAM,IAAI,GAAG,KAAK,CAAC,uBAAuB,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QAC7E,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;IACvG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,0CAA0C,EAAE,GAAG,EAAE;QAClD,MAAM,IAAI,GAAG,KAAK,CAAC,aAAa,EAAE,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,sBAAsB,EAAE,EAAE,CAAC,CAAC;QACzF,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,gBAAgB,EAAE,IAAI,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC;YAC/E,QAAQ,EAAE,EAAE,WAAW,EAAE,sBAAsB,EAAE;SAClD,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,oCAAoC,EAAE,GAAG,EAAE;QAC5C,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,gBAAgB,EAAE,cAAc,EAAE,EAAE,CAAC,CAAC,CAAC;QACnG,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,8BAA8B,CAAC,CAAC;IAClE,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,uBAAuB,EAAE,GAAG,EAAE;QAC/B,KAAK,CAAC,uBAAuB,EAAE,gCAAgC,CAAC,CAAC;QACjE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IACjG,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,cAAc,EAAE,GAAG,EAAE;QACtB,KAAK,CAAC,uBAAuB,EAAE,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,UAAU,EAAE,EAAE,CAAC,CAAC;QACpE,MAAM,CAAC,UAAU,CAAC,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,EAAE,EAAE,CAAC,CAAC,MAAM,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAChF,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC;AAEH,QAAQ,CAAC,aAAa,EAAE,GAAG,EAAE;IAC3B,EAAE,CAAC,gCAAgC,EAAE,GAAG,EAAE;QACxC,MAAM,QAAQ,GAAG;YACf,WAAW,EAAE,sBAAsB;YACnC,KAAK,EAAE,MAAM;YACb,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE,kCAAkC;YAC3C,WAAW,EAAE,SAAS;YACtB,eAAe,EAAE,SAAS;YAC1B,WAAW,EAAE,MAAM;YACnB,SAAS,EAAE,sBAAsB;SAClC,CAAC;QACF,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;IAC1D,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,IAAI,CAAC;QACN,CAAC,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,qBAAqB,EAAE,EAAE,EAAE,8CAA8C,CAAC;QACtG,CAAC,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,2CAA2C,CAAC;QACpF,CAAC,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,MAAM,EAAE,EAAE,EAAE,gDAAgD,CAAC;QACzF,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,MAAM,EAAE,EAAE,EAAE,mCAAmC,CAAC;QACtE,CAAC,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,4BAA4B,CAAC;QAChD,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,EAAE,gBAAgB,CAAC;QAC/C,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,EAAE,gBAAgB,CAAC;KAC7D,CAAC,CAAC,2BAA2B,EAAE,CAAC,GAAG,EAAE,QAAQ,EAAE,EAAE;QAChD,MAAM,KAAK,GAAG,SAAS,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,GAAG,EAAE,uBAAuB,CAAC,CAAC,CAAC;QACzE,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,yBAAyB,CAAC,CAAC;QAC3D,MAAM,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAC5C,CAAC,CAAC,CAAC;IAEH,EAAE,CAAC,sCAAsC,EAAE,GAAG,EAAE;QAC9C,MAAM,CAAC,GAAG,EAAE,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/dist/lib/not-found-page.d.ts

@@ -0,0 +1,106 @@
+/** Why the link couldn't be served. For the host's hook; the page never shows it. */
+export type NotFoundReason = 
+/** No such code, an expired or switched-off link, or another organization's link on this host. */
+'unknown'
+/** Switched off by a decision that isn't about abuse. */
+ | 'disabled'
+/** The visitor is outside the link's country, device or language rules. */
+ | 'not_targeted'
+/** The link has no destination for this visitor's device. */
+ | 'no_destination';
+/** Everything optional: an empty object renders the default page. */
+export interface NotFoundContent {
+    title?: string;
+    message?: string;
+    /** http(s) only; anything else is dropped. */
+    logoUrl?: string;
+    /** `#rgb`, `#rrggbb` or with alpha; anything else is dropped. */
+    accentColor?: string;
+    backgroundColor?: string;
+    /** The button is shown only when both label and a valid http(s) URL are present. */
+    buttonLabel?: string;
+    buttonUrl?: string;
+}
+/**
+ * Not-found settings, as an organization stores them in `settings.notFound` and
+ * as the instance sets them in linkforty.config.json. With `redirectUrl`, browsers
+ * are sent there (302) and the rest is ignored; without it, the rest is the page.
+ */
+export interface NotFoundSettings extends NotFoundContent {
+    /** http(s) only. */
+    redirectUrl?: string;
+}
+export type NotFoundResolution = {
+    kind: 'page';
+    content: NotFoundContent;
+} | {
+    kind: 'redirect';
+    url: string;
+};
+export interface NotFoundContext {
+    reason: NotFoundReason;
+    /**
+     * The resolved link row, when there is one. Null for `unknown`, including a
+     * link that belongs to another organization: that row is not this host's to
+     * hand out.
+     */
+    link: Record<string, any> | null;
+    /** The organization the request's host belongs to (lib/link-lookup.ts), if any. */
+    scope: string | null;
+}
+export declare const NOT_FOUND_DEFAULTS: {
+    readonly title: "Link not found";
+    readonly message: "This link doesn't exist or is no longer available.";
+};
+/** JSON bodies kept for clients that don't accept HTML. */
+export declare const NOT_FOUND_JSON: {
+    readonly default: {
+        readonly error: "Link not found";
+    };
+    readonly no_destination: {
+        readonly error: "No destination URL configured for this link";
+    };
+};
+/** True when the request will render HTML — a browser navigation. */
+export declare function wantsHtml(accept: string | string[] | undefined): boolean;
+/**
+ * The page's content-security policy. It runs no script at all, so none is
+ * allowed; images may come from any https origin because the logo is the host's.
+ */
+export declare function notFoundContentSecurityPolicy(): string;
+/** A redirect target from the host's hook, or null when it isn't http(s). */
+export declare function safeNotFoundRedirect(url: unknown): string | null;
+/**
+ * Settings from stored JSON (an organization's `settings`): keeps the known
+ * string fields and returns null when none is set. Lenient on purpose, since a
+ * bad value in the database must not break a redirect; values are checked
+ * again where they are used. The config file is validated strictly instead
+ * (lib/config.ts).
+ */
+export declare function readNotFoundSettings(raw: unknown): NotFoundSettings | null;
+/** An organization's not-found settings, from its `settings` column. */
+export declare function readOrganizationNotFoundSettings(orgSettings: unknown): NotFoundSettings | null;
+/** How long an organization's settings are reused before being read again. */
+export declare const NOT_FOUND_SETTINGS_TTL_MS = 60000;
+/**
+ * Read an organization's not-found settings, reusing each answer for a minute.
+ *
+ * Only an unknown code on an organization's host needs this: every other case
+ * already has the link row, which carries its organization's settings. Unknown
+ * codes are what scanners hit, so the answer is held rather than read per
+ * request. A change to the settings shows within NOT_FOUND_SETTINGS_TTL_MS.
+ *
+ * A factory rather than module state, so each registration (and each test) has
+ * its own. A failed read resolves to null and is not held.
+ */
+export declare function createOrganizationNotFoundSettingsLookup(deps: {
+    query: (sql: string, params: unknown[]) => Promise<{
+        rows: Array<Record<string, unknown>>;
+    }>;
+    onError?: (error: unknown) => void;
+    now?: () => number;
+}): (organizationId: string) => Promise<NotFoundSettings | null>;
+/** What settings ask for: a redirect when they name a valid URL, otherwise the page. */
+export declare function resolveNotFoundSettings(settings: NotFoundSettings): NotFoundResolution;
+export declare function renderNotFoundPage(content?: NotFoundContent): string;
+//# sourceMappingURL=not-found-page.d.ts.map

package/dist/lib/not-found-page.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"not-found-page.d.ts","sourceRoot":"","sources":["../../src/lib/not-found-page.ts"],"names":[],"mappings":"AAkCA,qFAAqF;AACrF,MAAM,MAAM,cAAc;AACxB,kGAAkG;AAChG,SAAS;AACX,yDAAyD;GACvD,UAAU;AACZ,2EAA2E;GACzE,cAAc;AAChB,6DAA6D;GAC3D,gBAAgB,CAAC;AAErB,qEAAqE;AACrE,MAAM,WAAW,eAAe;IAC9B,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,8CAA8C;IAC9C,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,iEAAiE;IACjE,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oFAAoF;IACpF,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;;;GAIG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD,oBAAoB;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,MAAM,kBAAkB,GAC1B;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,eAAe,CAAA;CAAE,GAC1C;IAAE,IAAI,EAAE,UAAU,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,WAAW,eAAe;IAC9B,MAAM,EAAE,cAAc,CAAC;IACvB;;;;OAIG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,GAAG,IAAI,CAAC;IACjC,mFAAmF;IACnF,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,eAAO,MAAM,kBAAkB;;;CAGrB,CAAC;AAEX,2DAA2D;AAC3D,eAAO,MAAM,cAAc;;;;;;;CAGjB,CAAC;AAOX,qEAAqE;AACrE,wBAAgB,SAAS,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,SAAS,GAAG,OAAO,CAGxE;AAED;;;GAGG;AACH,wBAAgB,6BAA6B,IAAI,MAAM,CAQtD;AAED,6EAA6E;AAC7E,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,MAAM,GAAG,IAAI,CAEhE;AAuBD;;;;;;GAMG;AACH,wBAAgB,oBAAoB,CAAC,GAAG,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAQ1E;AAED,wEAAwE;AACxE,wBAAgB,gCAAgC,CAAC,WAAW,EAAE,OAAO,GAAG,gBAAgB,GAAG,IAAI,CAG9F;AAED,8EAA8E;AAC9E,eAAO,MAAM,yBAAyB,QAAS,CAAC;AAGhD;;;;;;;;;;GAUG;AACH,wBAAgB,wCAAwC,CAAC,IAAI,EAAE;IAC7D,KAAK,EAAE,CAAC,GAAG,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,OAAO,CAAC;QAAE,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC,CAAA;KAAE,CAAC,CAAC;IAC7F,OAAO,CAAC,EAAE,CAAC,KAAK,EAAE,OAAO,KAAK,IAAI,CAAC;IACnC,GAAG,CAAC,EAAE,MAAM,MAAM,CAAC;CACpB,GAAG,CAAC,cAAc,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,GAAG,IAAI,CAAC,CAiB/D;AAED,wFAAwF;AACxF,wBAAgB,uBAAuB,CAAC,QAAQ,EAAE,gBAAgB,GAAG,kBAAkB,CAKtF;AAED,wBAAgB,kBAAkB,CAAC,OAAO,GAAE,eAAoB,GAAG,MAAM,CA4DxE"}