@backmatter/core 0.0.24 → 0.0.26

package/bin/backmatter.js

@@ -1,2 +1,4 @@
 #!/usr/bin/env bun
-import "../src/node/cli.ts";
+import { main } from "../src/node/cli.ts";
+
+process.exit(await main(process.argv.slice(2)));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backmatter/core",
-  "version": "0.0.24",
+  "version": "0.0.26",
   "description": "Experimental Backmatter SDK. APIs will break. Not ready for production.",
   "type": "module",
   "publishConfig": {

package/src/config.ts

@@ -7,6 +7,8 @@ import { detectGitBranch } from "./sync-schema";
 export type DevBarHostConfig = {
   /** Draw a viewport ring and top pill while the site session is in preview. */
   previewFrame?: boolean;
+  /** Bottom corner radius (px) for the preview ring (host window lip below the chrome). */
+  previewFrameRadius?: number;
 };
 
 export type BackmatterDirs = {

package/src/index.ts

@@ -10,6 +10,8 @@ export type {
 export { field, serializeField, parseFieldSnapshot } from "./fields";
 export {
   MAX_MEDIA_BYTES,
+  MAX_MEDIA_TEXT,
+  MAX_VARIANT_WIDTH,
   MEDIA_CONTENT_TYPES,
   MEDIA_WIDTHS,
   isMediaContentType,
@@ -92,6 +94,14 @@ export {
   sortByRouteSpecificity,
 } from "./routes";
 
+export type { PageNavDoc, PageNavItem } from "./page-nav";
+export {
+  PAGE_NAV_DEFAULT_LIMIT,
+  PAGE_NAV_MAX_LIMIT,
+  pageNavItems,
+  paginatePageNavItems,
+} from "./page-nav";
+
 export type { PathMatch, ContentSource, ParsedContentKey } from "./path";
 export {
   compilePathPattern,

package/src/media-url.ts

@@ -1,13 +1,19 @@
 // packages/core/src/media-url.ts
 
-/** Widths the catalog lists for the gallery. A public URL may use any positive width. */
+/** Widths the catalog lists for the gallery. */
 export const MEDIA_WIDTHS = [400, 800, 1200, 2000] as const;
 
+/** Widest variant the CDN will resize. A wider request is refused. */
+export const MAX_VARIANT_WIDTH = 2000;
+
 export type MediaWidth = (typeof MEDIA_WIDTHS)[number];
 
 /** Bytes the catalog accepts for one file. */
 export const MAX_MEDIA_BYTES = 20 * 1024 * 1024;
 
+/** Characters of alt text or caption the catalog stores on one image. */
+export const MAX_MEDIA_TEXT = 500;
+
 export const MEDIA_CONTENT_TYPES = [
   "image/jpeg",
   "image/png",
@@ -39,7 +45,9 @@ export function mediaVariantUrl(
   id: string,
   width: number,
 ): string | null {
-  if (!isMediaId(id) || !Number.isInteger(width) || width < 1) return null;
+  if (!isMediaId(id) || !Number.isInteger(width) || width < 1 || width > MAX_VARIANT_WIDTH) {
+    return null;
+  }
   return `${origin.replace(/\/$/, "")}/img/${id}/width=${width},format=auto`;
 }
 

package/src/node/cli.ts

@@ -554,7 +554,7 @@ export async function runInit(args: CliArgs): Promise<string[]> {
   return notes;
 }
 
-async function main(argv: string[]): Promise<number> {
+export async function main(argv: string[]): Promise<number> {
   if (argv[0] === "login" || argv[0] === "media") {
     return runMediaCli(argv);
   }

package/src/node/media-cli.ts

@@ -12,6 +12,7 @@ export const MEDIA_USAGE = `Usage:
   backmatter media url <id> [--width <px>] [--origin <url>]
 
 login opens the browser and stores a personal token in ~/.backmatter/credentials.json.
+media upload and list use --workspace, else BACKMATTER_WORKSPACE, else BACKMATTER_WORKSPACE_ID.
 media url prints a CDN url. --width <px> appends width and format=auto.`;
 
 type Credentials = { api: string; token: string; origin?: string };
@@ -111,7 +112,7 @@ async function media(
     if (flags.width) {
       const width = Number(flags.width);
       const url = mediaVariantUrl(origin, id, width);
-      if (!url) throw new Error("width must be a positive integer");
+      if (!url) throw new Error("width must be a positive integer up to 2000");
       io.log(url);
       return 0;
     }
@@ -121,9 +122,10 @@ async function media(
   const creds = await readCredentials(io.home);
   const api = (flags.api || creds?.api || io.env.BACKMATTER_API_URL || "").replace(/\/$/, "");
   const token = creds?.token;
-  const workspace = flags.workspace || io.env.BACKMATTER_WORKSPACE;
+  const workspace =
+    flags.workspace || io.env.BACKMATTER_WORKSPACE || io.env.BACKMATTER_WORKSPACE_ID;
   if (!api || !token) throw new Error("run backmatter login first");
-  if (!workspace) throw new Error("pass --workspace <id>");
+  if (!workspace) throw new Error("pass --workspace <id> or set BACKMATTER_WORKSPACE_ID");
   const fetchImpl = io.fetch ?? fetch;
   if (sub === "list") {
     const params = new URLSearchParams();

package/src/page-nav.ts

@@ -0,0 +1,67 @@
+// packages/core/src/page-nav.ts
+import { isRoutable, routeFor, type RouteModel } from "./routes";
+
+export type PageNavDoc = {
+  locale: string;
+  type: string;
+  slug: string;
+};
+
+export type PageNavItem = {
+  key: string;
+  label: string;
+  href: string;
+  current: boolean;
+};
+
+/** Routable documents, in label order. Unroutable models stay out of the menu. */
+export function pageNavItems(input: {
+  docs: readonly PageNavDoc[];
+  models: readonly RouteModel[];
+  current: PageNavDoc | null;
+}): PageNavItem[] {
+  const byType = new Map(input.models.map((model) => [model.type, model]));
+  const locales = new Set(input.docs.map((doc) => doc.locale));
+  const showLocale = locales.size > 1;
+  const items: PageNavItem[] = [];
+  for (const doc of input.docs) {
+    const model = byType.get(doc.type);
+    if (!model || !isRoutable(model)) continue;
+    const href = routeFor(model, doc.locale, doc.slug);
+    if (!href) continue;
+    const name = `${doc.type}/${doc.slug}`;
+    items.push({
+      key: `${doc.locale}/${doc.type}/${doc.slug}`,
+      label: showLocale ? `${name} · ${doc.locale}` : name,
+      href,
+      current: Boolean(
+        input.current &&
+          input.current.locale === doc.locale &&
+          input.current.type === doc.type &&
+          input.current.slug === doc.slug,
+      ),
+    });
+  }
+  items.sort((a, b) => a.label.localeCompare(b.label));
+  return items;
+}
+
+export const PAGE_NAV_DEFAULT_LIMIT = 10;
+export const PAGE_NAV_MAX_LIMIT = 50;
+
+export function paginatePageNavItems(
+  items: readonly PageNavItem[],
+  query: { q?: string; limit?: number; offset?: number },
+): { items: PageNavItem[]; total: number } {
+  const needle = query.q?.trim().toLowerCase() ?? "";
+  const filtered = needle ? items.filter((item) => item.label.toLowerCase().includes(needle)) : [...items];
+  const limit = Math.min(
+    PAGE_NAV_MAX_LIMIT,
+    Math.max(1, query.limit ?? PAGE_NAV_DEFAULT_LIMIT),
+  );
+  const offset = Math.max(0, query.offset ?? 0);
+  return {
+    items: filtered.slice(offset, offset + limit),
+    total: filtered.length,
+  };
+}