npm - @plurid/plurid-react-server - Versions diffs - 0.0.0-16 → 0.0.0-17 - Mend

@plurid/plurid-react-server 0.0.0-16 → 0.0.0-17

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (7) hide show

package/distribution/index.d.mts +52 -0
package/distribution/index.d.ts +52 -0
package/distribution/index.js +77 -5
package/distribution/index.js.map +1 -1
package/distribution/index.mjs +77 -5
package/distribution/index.mjs.map +1 -1
package/package.json +9 -9

package/distribution/index.d.mts CHANGED Viewed

@@ -46,6 +46,14 @@ interface PluridServerOptions {
      * Name of the directory where the assets files are bundled.
      */
     assetsDirectory: string;
+    /**
+     * Directory of static assets (favicon, og-image, manifest, robots) served at
+     * the URL root `/`. Empty string (the default) resolves to
+     * `<buildDirectory>/public`; the mount is skipped if the directory does not
+     * exist, so apps without a public directory are unaffected. The framework
+     * points this at `source/public` during `plurid dev`.
+     */
+    publicDirectory: string;
     /**
      * Default: `/gateway`.
      */
@@ -136,6 +144,44 @@ interface PluridServerTemplateConfiguration {
      */
     defaultPreloadedPluridMetastate?: string;
     minify?: boolean;
+    /**
+     * Favicon links injected into `<head>`. A bare string is the primary icon
+     * (`rel="icon"`); the object expands to icon / apple-touch-icon / sized /
+     * mask-icon links plus a `theme-color` meta. Paths resolve against the served
+     * public directory (see `PluridServerOptions.publicDirectory`).
+     */
+    favicon?: string | {
+        icon?: string;
+        apple?: string;
+        sizes?: Record<string, string>;
+        maskIcon?: string;
+        themeColor?: string;
+    };
+    /**
+     * Web app manifest href, injected as `<link rel="manifest">`.
+     */
+    manifest?: string;
+    /**
+     * Static `<head>` metadata injected AHEAD of the react-helmet-async output,
+     * so per-route `<Helmet>` tags still override these defaults.
+     */
+    head?: {
+        title?: string;
+        description?: string;
+        meta?: Array<{
+            name?: string;
+            property?: string;
+            content: string;
+        }>;
+        links?: Array<{
+            rel: string;
+            href: string;
+        }>;
+    };
+    /**
+     * Override the built-in 500 error page HTML (sent on a render failure).
+     */
+    errorHtml?: string;
 }
 interface PluridStillerOptions {
     /**
@@ -213,6 +259,12 @@ declare class PluridServer {
     private resolvePreserveAfterServe;
     private handleGateway;
     private renderApplication;
+    /**
+     * Build the static `<head>` markup from the template config (favicon set,
+     * manifest, default title / meta / links). Returns an empty string when none
+     * are configured, so the head is byte-identical to before for existing apps.
+     */
+    private buildStaticHead;
     private getContentAndStyles;
     private computeRequestTime;
     private handleOptions;

package/distribution/index.d.ts CHANGED Viewed

@@ -46,6 +46,14 @@ interface PluridServerOptions {
      * Name of the directory where the assets files are bundled.
      */
     assetsDirectory: string;
+    /**
+     * Directory of static assets (favicon, og-image, manifest, robots) served at
+     * the URL root `/`. Empty string (the default) resolves to
+     * `<buildDirectory>/public`; the mount is skipped if the directory does not
+     * exist, so apps without a public directory are unaffected. The framework
+     * points this at `source/public` during `plurid dev`.
+     */
+    publicDirectory: string;
     /**
      * Default: `/gateway`.
      */
@@ -136,6 +144,44 @@ interface PluridServerTemplateConfiguration {
      */
     defaultPreloadedPluridMetastate?: string;
     minify?: boolean;
+    /**
+     * Favicon links injected into `<head>`. A bare string is the primary icon
+     * (`rel="icon"`); the object expands to icon / apple-touch-icon / sized /
+     * mask-icon links plus a `theme-color` meta. Paths resolve against the served
+     * public directory (see `PluridServerOptions.publicDirectory`).
+     */
+    favicon?: string | {
+        icon?: string;
+        apple?: string;
+        sizes?: Record<string, string>;
+        maskIcon?: string;
+        themeColor?: string;
+    };
+    /**
+     * Web app manifest href, injected as `<link rel="manifest">`.
+     */
+    manifest?: string;
+    /**
+     * Static `<head>` metadata injected AHEAD of the react-helmet-async output,
+     * so per-route `<Helmet>` tags still override these defaults.
+     */
+    head?: {
+        title?: string;
+        description?: string;
+        meta?: Array<{
+            name?: string;
+            property?: string;
+            content: string;
+        }>;
+        links?: Array<{
+            rel: string;
+            href: string;
+        }>;
+    };
+    /**
+     * Override the built-in 500 error page HTML (sent on a render failure).
+     */
+    errorHtml?: string;
 }
 interface PluridStillerOptions {
     /**
@@ -213,6 +259,12 @@ declare class PluridServer {
     private resolvePreserveAfterServe;
     private handleGateway;
     private renderApplication;
+    /**
+     * Build the static `<head>` markup from the template config (favicon set,
+     * manifest, default title / meta / links). Returns an empty string when none
+     * are configured, so the head is byte-identical to before for existing apps.
+     */
+    private buildStaticHead;
     private getContentAndStyles;
     private computeRequestTime;
     private handleOptions;

package/distribution/index.js CHANGED Viewed

@@ -248,7 +248,7 @@ var template = async (data) => {
         ${headScripts.join("\n")}
-        <script src="${vendorScriptSource}"></script>
+        ${vendorScriptSource ? `<script src="${vendorScriptSource}"></script>` : ""}
         <script defer src="${mainScriptSource}"></script>
     </head>
     <body ${bodyAttributes}>
@@ -328,7 +328,7 @@ var PluridRenderer = class {
     this.styles = styles;
     this.headScripts = headScripts;
     this.bodyScripts = bodyScripts;
-    this.vendorScriptSource = vendorScriptSource || DEFAULT_RENDERER_VENDOR_SCRIPT_SOURCE;
+    this.vendorScriptSource = vendorScriptSource ?? DEFAULT_RENDERER_VENDOR_SCRIPT_SOURCE;
     this.mainScriptSource = mainScriptSource || DEFAULT_RENDERER_MAIN_SCRIPT_SOURCE;
     this.root = root || DEFAULT_RENDERER_ROOT;
     this.content = assetsPathRewrite(content) || "";
@@ -883,7 +883,7 @@ var PluridServer = class {
           error
         );
       }
-      response.status(500).send(SERVER_ERROR_TEMPLATE);
+      response.status(500).send(this.template?.errorHtml || SERVER_ERROR_TEMPLATE);
       return;
     }
   }
@@ -991,7 +991,7 @@ var PluridServer = class {
           error
         );
       }
-      response.status(500).send(SERVER_ERROR_TEMPLATE);
+      response.status(500).send(this.template?.errorHtml || SERVER_ERROR_TEMPLATE);
       return;
     }
   }
@@ -1163,7 +1163,7 @@ var PluridServer = class {
     const {
       helmet
     } = this.helmet;
-    const head = helmet ? `
+    const helmetHead = helmet ? `
             ${helmet.meta.toString()}
             ${helmet.title.toString()}
             ${helmet.base.toString()}
@@ -1172,6 +1172,7 @@ var PluridServer = class {
             ${helmet.noscript.toString()}
             ${helmet.script.toString()}
         ` : "";
+    const head = helmetHead + this.buildStaticHead();
     const htmlAttributes = {
       ...this.template?.htmlAttributes,
       ...helmet?.htmlAttributes.toComponent()
@@ -1210,6 +1211,67 @@ var PluridServer = class {
     });
     return renderer;
   }
+  /**
+   * Build the static `<head>` markup from the template config (favicon set,
+   * manifest, default title / meta / links). Returns an empty string when none
+   * are configured, so the head is byte-identical to before for existing apps.
+   */
+  buildStaticHead() {
+    const template2 = this.template;
+    if (!template2) {
+      return "";
+    }
+    const escapeAttribute2 = (value) => value.replace(/&/g, "&amp;").replace(/"/g, "&quot;").replace(/</g, "&lt;");
+    const escapeText = (value) => value.replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;");
+    const parts = [];
+    const favicon = template2.favicon;
+    if (typeof favicon === "string") {
+      parts.push(`<link rel="icon" href="${escapeAttribute2(favicon)}">`);
+    } else if (favicon) {
+      if (favicon.icon) {
+        parts.push(`<link rel="icon" href="${escapeAttribute2(favicon.icon)}">`);
+      }
+      if (favicon.apple) {
+        parts.push(`<link rel="apple-touch-icon" href="${escapeAttribute2(favicon.apple)}">`);
+      }
+      for (const [size, href] of Object.entries(favicon.sizes || {})) {
+        parts.push(`<link rel="icon" sizes="${escapeAttribute2(size)}" href="${escapeAttribute2(href)}">`);
+      }
+      if (favicon.maskIcon) {
+        const color = favicon.themeColor ? ` color="${escapeAttribute2(favicon.themeColor)}"` : "";
+        parts.push(`<link rel="mask-icon" href="${escapeAttribute2(favicon.maskIcon)}"${color}>`);
+      }
+      if (favicon.themeColor) {
+        parts.push(`<meta name="theme-color" content="${escapeAttribute2(favicon.themeColor)}">`);
+      }
+    }
+    if (template2.manifest) {
+      parts.push(`<link rel="manifest" href="${escapeAttribute2(template2.manifest)}">`);
+    }
+    const head = template2.head;
+    if (head) {
+      if (head.title) {
+        parts.push(`<title>${escapeText(head.title)}</title>`);
+      }
+      if (head.description) {
+        parts.push(`<meta name="description" content="${escapeAttribute2(head.description)}">`);
+      }
+      for (const meta of head.meta || []) {
+        const selector = meta.name ? `name="${escapeAttribute2(meta.name)}"` : meta.property ? `property="${escapeAttribute2(meta.property)}"` : "";
+        if (!selector) {
+          continue;
+        }
+        parts.push(`<meta ${selector} content="${escapeAttribute2(meta.content)}">`);
+      }
+      for (const link of head.links || []) {
+        parts.push(`<link rel="${escapeAttribute2(link.rel)}" href="${escapeAttribute2(link.href)}">`);
+      }
+    }
+    if (parts.length === 0) {
+      return "";
+    }
+    return "\n            " + parts.join("\n            ");
+  }
   async getContentAndStyles(isoMatch, pluridMetastate, preserveResult, matchedPlane) {
     const stylesheet = new import_styled_components2.ServerStyleSheet();
     let content = "";
@@ -1283,6 +1345,7 @@ var PluridServer = class {
       open: partialOptions?.open ?? DEFAULT_SERVER_OPTIONS.OPEN,
       buildDirectory: partialOptions?.buildDirectory || DEFAULT_SERVER_OPTIONS.BUILD_DIRECTORY,
       assetsDirectory: partialOptions?.assetsDirectory || DEFAULT_SERVER_OPTIONS.ASSETS_DIRECTORY,
+      publicDirectory: partialOptions?.publicDirectory || "",
       gatewayEndpoint: partialOptions?.gatewayEndpoint || DEFAULT_SERVER_OPTIONS.GATEWAY,
       staticCache: partialOptions?.staticCache || 0,
       ignore: partialOptions?.ignore || [],
@@ -1335,6 +1398,15 @@ var PluridServer = class {
         maxAge: this.options.staticCache
       })
     );
+    const publicPath = this.options.publicDirectory || import_path2.default.join(this.options.buildDirectory, "public");
+    if (import_fs2.default.existsSync(publicPath)) {
+      this.serverApplication.use(
+        import_express.default.static(publicPath, {
+          index: false,
+          maxAge: this.options.staticCache
+        })
+      );
+    }
     this.loadMiddleware();
   }
   loadMiddleware() {