@rsc-kit/core 0.9.0 → 0.11.0

package/dist/webManifest.d.ts

@@ -0,0 +1,54 @@
+/** What `rscKit({ manifest })` takes. */
+export interface WebManifestOptions {
+    /** The app's name, as an install prompt shows it. */
+    name: string;
+    /** The short name a home screen uses when there is no room for the full one. */
+    shortName?: string;
+    description?: string;
+    /**
+     * The icons a browser may install.
+     *
+     * Paths relative to the client output — a file in `public/` is served at its
+     * own name, so `icon-192.png` is usually right. Sizes and types are read from
+     * the filename rather than declared twice.
+     *
+     * A browser will not offer to install an app with no icon of at least 192px,
+     * so the build says so rather than writing a manifest that quietly does
+     * nothing.
+     */
+    icons?: string[];
+    /** Where an installed launch lands. Defaults to `/`. */
+    startUrl?: string;
+    /** Defaults to `standalone`, which is the one that looks like an app. */
+    display?: 'standalone' | 'fullscreen' | 'minimal-ui' | 'browser';
+    /** The colour a browser paints its chrome. Also emitted as a meta tag. */
+    themeColor?: string;
+    /** The colour behind the app while it is starting. */
+    backgroundColor?: string;
+    /** Anything else the spec allows, passed through untouched. */
+    other?: Record<string, unknown>;
+}
+/** Where the manifest is written and linked from. */
+export declare const MANIFEST_PATH = "/manifest.webmanifest";
+/**
+ * The size a filename claims, or null.
+ *
+ * `icon-192.png` and `icon-192x192.png` both read as 192. Declaring it in the
+ * options as well would be the same number written twice, and the one that
+ * drifts is the one nobody looks at.
+ */
+export declare function sizeOf(file: string): number | null;
+/** The manifest's JSON, ready to write. */
+export declare function webManifest(options: WebManifestOptions): string;
+/**
+ * Whether these options produce something a browser would actually install.
+ *
+ * Returned as a sentence rather than thrown: a manifest with no icon is still
+ * a valid manifest and still sets the theme colour, so refusing the build over
+ * it would be refusing something that works. But an author who wrote
+ * `manifest: {...}` meant "installable", and silence here is how they find out
+ * months later that it never was.
+ */
+export declare function manifestWarning(options: WebManifestOptions): string | null;
+/** The type a src/app/manifest.ts file satisfies. */
+export type WebManifest = WebManifestOptions;

package/dist/webManifest.js

@@ -0,0 +1,81 @@
+// The file that makes an app installable.
+//
+// A service worker makes an app work offline; this is what makes a browser
+// offer to put it on a home screen. They are separate decisions and separate
+// options, because an app can want either without the other — a site that
+// should survive a dead network is not necessarily one anybody wants as an
+// icon, and vice versa.
+//
+// Everything here is the web app manifest spec rather than an invention of
+// this package, so the names are its names and anything it accepts that is not
+// spelled out below can be passed through `other`.
+/** Where the manifest is written and linked from. */
+export const MANIFEST_PATH = '/manifest.webmanifest';
+/**
+ * The size a filename claims, or null.
+ *
+ * `icon-192.png` and `icon-192x192.png` both read as 192. Declaring it in the
+ * options as well would be the same number written twice, and the one that
+ * drifts is the one nobody looks at.
+ */
+export function sizeOf(file) {
+    const match = /(\d{2,4})(?:x\d{2,4})?\.(?:png|webp|jpg|jpeg|svg)$/i.exec(file);
+    return match ? Number(match[1]) : null;
+}
+function typeOf(file) {
+    const extension = file.slice(file.lastIndexOf('.') + 1).toLowerCase();
+    return extension === 'svg'
+        ? 'image/svg+xml'
+        : extension === 'jpg' || extension === 'jpeg'
+            ? 'image/jpeg'
+            : `image/${extension}`;
+}
+/** The manifest's JSON, ready to write. */
+export function webManifest(options) {
+    const icons = (options.icons ?? []).map((file) => {
+        const size = sizeOf(file);
+        return {
+            src: file.startsWith('/') ? file : `/${file}`,
+            type: typeOf(file),
+            ...(size ? { sizes: `${size}x${size}` } : {}),
+            // Maskable as well as any: without it Android crops a square icon into a
+            // circle and takes the corners off whatever is in them.
+            purpose: 'any maskable',
+        };
+    });
+    return (JSON.stringify({
+        name: options.name,
+        short_name: options.shortName ?? options.name,
+        ...(options.description ? { description: options.description } : {}),
+        start_url: options.startUrl ?? '/',
+        display: options.display ?? 'standalone',
+        ...(options.themeColor ? { theme_color: options.themeColor } : {}),
+        ...(options.backgroundColor ? { background_color: options.backgroundColor } : {}),
+        ...(icons.length ? { icons } : {}),
+        ...(options.other ?? {}),
+    }, null, 2) + '\n');
+}
+/**
+ * Whether these options produce something a browser would actually install.
+ *
+ * Returned as a sentence rather than thrown: a manifest with no icon is still
+ * a valid manifest and still sets the theme colour, so refusing the build over
+ * it would be refusing something that works. But an author who wrote
+ * `manifest: {...}` meant "installable", and silence here is how they find out
+ * months later that it never was.
+ */
+export function manifestWarning(options) {
+    const icons = options.icons ?? [];
+    if (icons.length === 0) {
+        return 'manifest: no icons, so no browser will offer to install this. Add a 192px and a 512px png.';
+    }
+    const largest = icons.reduce((best, file) => Math.max(best, sizeOf(file) ?? 0), 0);
+    if (largest < 192) {
+        return 'manifest: no icon of 192px or more, which is the smallest a browser will install. Sizes are read from the filename, so name it like icon-192.png.';
+    }
+    if (largest < 512) {
+        return 'manifest: no 512px icon, so a splash screen will be upscaled from a smaller one.';
+    }
+    return null;
+}
+//# sourceMappingURL=webManifest.js.map

package/dist/webManifest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"webManifest.js","sourceRoot":"","sources":["../src/webManifest.ts"],"names":[],"mappings":"AAAA,0CAA0C;AAC1C,EAAE;AACF,2EAA2E;AAC3E,6EAA6E;AAC7E,0EAA0E;AAC1E,2EAA2E;AAC3E,wBAAwB;AACxB,EAAE;AACF,2EAA2E;AAC3E,+EAA+E;AAC/E,mDAAmD;AAiCnD,qDAAqD;AACrD,MAAM,CAAC,MAAM,aAAa,GAAG,uBAAuB,CAAA;AAEpD;;;;;;GAMG;AACH,MAAM,UAAU,MAAM,CAAC,IAAY;IACjC,MAAM,KAAK,GAAG,qDAAqD,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;IAE9E,OAAO,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAA;AACxC,CAAC;AAED,SAAS,MAAM,CAAC,IAAY;IAC1B,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,WAAW,EAAE,CAAA;IAErE,OAAO,SAAS,KAAK,KAAK;QACxB,CAAC,CAAC,eAAe;QACjB,CAAC,CAAC,SAAS,KAAK,KAAK,IAAI,SAAS,KAAK,MAAM;YAC3C,CAAC,CAAC,YAAY;YACd,CAAC,CAAC,SAAS,SAAS,EAAE,CAAA;AAC5B,CAAC;AAED,2CAA2C;AAC3C,MAAM,UAAU,WAAW,CAAC,OAA2B;IACrD,MAAM,KAAK,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE;QAC/C,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,CAAA;QAEzB,OAAO;YACL,GAAG,EAAE,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE;YAC7C,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;YAClB,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,GAAG,IAAI,IAAI,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;YAC7C,yEAAyE;YACzE,wDAAwD;YACxD,OAAO,EAAE,cAAc;SACxB,CAAA;IACH,CAAC,CAAC,CAAA;IAEF,OAAO,CACL,IAAI,CAAC,SAAS,CACZ;QACE,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,UAAU,EAAE,OAAO,CAAC,SAAS,IAAI,OAAO,CAAC,IAAI;QAC7C,GAAG,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACpE,SAAS,EAAE,OAAO,CAAC,QAAQ,IAAI,GAAG;QAClC,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,YAAY;QACxC,GAAG,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,EAAE,WAAW,EAAE,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClE,GAAG,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC,CAAC,EAAE,gBAAgB,EAAE,OAAO,CAAC,eAAe,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QACjF,GAAG,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;QAClC,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC;KACzB,EACD,IAAI,EACJ,CAAC,CACF,GAAG,IAAI,CACT,CAAA;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,eAAe,CAAC,OAA2B;IACzD,MAAM,KAAK,GAAG,OAAO,CAAC,KAAK,IAAI,EAAE,CAAA;IAEjC,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;QACvB,OAAO,4FAA4F,CAAA;IACrG,CAAC;IAED,MAAM,OAAO,GAAG,KAAK,CAAC,MAAM,CAAC,CAAC,IAAI,EAAE,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC,CAAC,CAAA;IAElF,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;QAClB,OAAO,mJAAmJ,CAAA;IAC5J,CAAC;IAED,IAAI,OAAO,GAAG,GAAG,EAAE,CAAC;QAClB,OAAO,kFAAkF,CAAA;IAC3F,CAAC;IAED,OAAO,IAAI,CAAA;AACb,CAAC","sourcesContent":["// The file that makes an app installable.\n//\n// A service worker makes an app work offline; this is what makes a browser\n// offer to put it on a home screen. They are separate decisions and separate\n// options, because an app can want either without the other — a site that\n// should survive a dead network is not necessarily one anybody wants as an\n// icon, and vice versa.\n//\n// Everything here is the web app manifest spec rather than an invention of\n// this package, so the names are its names and anything it accepts that is not\n// spelled out below can be passed through `other`.\n\n/** What `rscKit({ manifest })` takes. */\nexport interface WebManifestOptions {\n  /** The app's name, as an install prompt shows it. */\n  name: string\n  /** The short name a home screen uses when there is no room for the full one. */\n  shortName?: string\n  description?: string\n  /**\n   * The icons a browser may install.\n   *\n   * Paths relative to the client output — a file in `public/` is served at its\n   * own name, so `icon-192.png` is usually right. Sizes and types are read from\n   * the filename rather than declared twice.\n   *\n   * A browser will not offer to install an app with no icon of at least 192px,\n   * so the build says so rather than writing a manifest that quietly does\n   * nothing.\n   */\n  icons?: string[]\n  /** Where an installed launch lands. Defaults to `/`. */\n  startUrl?: string\n  /** Defaults to `standalone`, which is the one that looks like an app. */\n  display?: 'standalone' | 'fullscreen' | 'minimal-ui' | 'browser'\n  /** The colour a browser paints its chrome. Also emitted as a meta tag. */\n  themeColor?: string\n  /** The colour behind the app while it is starting. */\n  backgroundColor?: string\n  /** Anything else the spec allows, passed through untouched. */\n  other?: Record<string, unknown>\n}\n\n/** Where the manifest is written and linked from. */\nexport const MANIFEST_PATH = '/manifest.webmanifest'\n\n/**\n * The size a filename claims, or null.\n *\n * `icon-192.png` and `icon-192x192.png` both read as 192. Declaring it in the\n * options as well would be the same number written twice, and the one that\n * drifts is the one nobody looks at.\n */\nexport function sizeOf(file: string): number | null {\n  const match = /(\\d{2,4})(?:x\\d{2,4})?\\.(?:png|webp|jpg|jpeg|svg)$/i.exec(file)\n\n  return match ? Number(match[1]) : null\n}\n\nfunction typeOf(file: string): string {\n  const extension = file.slice(file.lastIndexOf('.') + 1).toLowerCase()\n\n  return extension === 'svg'\n    ? 'image/svg+xml'\n    : extension === 'jpg' || extension === 'jpeg'\n      ? 'image/jpeg'\n      : `image/${extension}`\n}\n\n/** The manifest's JSON, ready to write. */\nexport function webManifest(options: WebManifestOptions): string {\n  const icons = (options.icons ?? []).map((file) => {\n    const size = sizeOf(file)\n\n    return {\n      src: file.startsWith('/') ? file : `/${file}`,\n      type: typeOf(file),\n      ...(size ? { sizes: `${size}x${size}` } : {}),\n      // Maskable as well as any: without it Android crops a square icon into a\n      // circle and takes the corners off whatever is in them.\n      purpose: 'any maskable',\n    }\n  })\n\n  return (\n    JSON.stringify(\n      {\n        name: options.name,\n        short_name: options.shortName ?? options.name,\n        ...(options.description ? { description: options.description } : {}),\n        start_url: options.startUrl ?? '/',\n        display: options.display ?? 'standalone',\n        ...(options.themeColor ? { theme_color: options.themeColor } : {}),\n        ...(options.backgroundColor ? { background_color: options.backgroundColor } : {}),\n        ...(icons.length ? { icons } : {}),\n        ...(options.other ?? {}),\n      },\n      null,\n      2,\n    ) + '\\n'\n  )\n}\n\n/**\n * Whether these options produce something a browser would actually install.\n *\n * Returned as a sentence rather than thrown: a manifest with no icon is still\n * a valid manifest and still sets the theme colour, so refusing the build over\n * it would be refusing something that works. But an author who wrote\n * `manifest: {...}` meant \"installable\", and silence here is how they find out\n * months later that it never was.\n */\nexport function manifestWarning(options: WebManifestOptions): string | null {\n  const icons = options.icons ?? []\n\n  if (icons.length === 0) {\n    return 'manifest: no icons, so no browser will offer to install this. Add a 192px and a 512px png.'\n  }\n\n  const largest = icons.reduce((best, file) => Math.max(best, sizeOf(file) ?? 0), 0)\n\n  if (largest < 192) {\n    return 'manifest: no icon of 192px or more, which is the smallest a browser will install. Sizes are read from the filename, so name it like icon-192.png.'\n  }\n\n  if (largest < 512) {\n    return 'manifest: no 512px icon, so a splash screen will be upscaled from a smaller one.'\n  }\n\n  return null\n}\n\n/** The type a src/app/manifest.ts file satisfies. */\nexport type WebManifest = WebManifestOptions\n"]}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rsc-kit/core",
-  "version": "0.9.0",
+  "version": "0.11.0",
   "description": "React Server Components on any JavaScript server: a Vite plugin that discovers the route tree, and a host adapter that serves it.",
   "license": "MIT",
   "type": "module",
@@ -25,6 +25,10 @@
       "types": "./dist/runtime.d.ts",
       "default": "./dist/runtime.js"
     },
+    "./RouteErrorBoundary": {
+      "types": "./dist/js/RouteErrorBoundary.d.ts",
+      "default": "./dist/js/RouteErrorBoundary.js"
+    },
     "./metadata": {
       "types": "./dist/metadata.d.ts",
       "default": "./dist/metadata.js"
@@ -160,6 +164,18 @@
     "./action": {
       "types": "./dist/action.d.ts",
       "default": "./dist/action.js"
+    },
+    "./not-found": {
+      "types": "./dist/notFound.d.ts",
+      "default": "./dist/notFound.js"
+    },
+    "./route-schema": {
+      "types": "./dist/routeSchema.d.ts",
+      "default": "./dist/routeSchema.js"
+    },
+    "./manifest-file": {
+      "types": "./dist/webManifest.d.ts",
+      "default": "./dist/webManifest.js"
     }
   },
   "peerDependencies": {