@shineuix/ssr 0.0.0-stage → 1.0.1

package/dist/hydrate/package.json

@@ -0,0 +1,13 @@
+{
+  "name": "@shineuix/ssr-hydrate",
+  "description": "The Node renderer of @shineuix/ssr. Import it through @shineuix/ssr, not from this folder.",
+  "main": "index.js",
+  "types": "index.d.ts",
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    }
+  },
+  "private": true
+}

package/dist/index.cjs

@@ -0,0 +1,55 @@
+// @shineuix/ssr for require(): the same wrapper as index.mjs, over the CommonJS build of the renderer.
+'use strict';
+
+const hydrate = require('./hydrate/index.js');
+
+// The key the elements read their language registry from (packages/core/src/utils/locale.ts).
+const REGISTRY = '__suiLocale';
+
+const norm = (tag) => String(tag).trim().toLowerCase();
+
+function packsOf(locales) {
+  if (typeof locales !== 'object' || locales === null || Array.isArray(locales)) {
+    throw new TypeError('@shineuix/ssr: `locales` takes an object of language packs keyed by tag, such as { de } with `require("@shineuix/core/locales/de")`.');
+  }
+  const packs = [];
+  for (const [tag, strings] of Object.entries(locales)) {
+    if (!norm(tag)) throw new TypeError('@shineuix/ssr: a key of `locales` is empty; key each pack by its BCP 47 tag.');
+    if (typeof strings !== 'object' || strings === null || Array.isArray(strings)) {
+      throw new TypeError(`@shineuix/ssr: locales["${tag}"] is not a language pack (an object of strings keyed like "dialog.close").`);
+    }
+    packs.push([norm(tag), strings]);
+  }
+  return packs;
+}
+
+function withLocales(options) {
+  if (!options || options.locales == null) return options;
+  const { locales, ...rest } = options;
+  const packs = packsOf(locales);
+  const before = rest.beforeHydrate;
+  return {
+    ...rest,
+    beforeHydrate(doc) {
+      const win = doc && doc.defaultView;
+      if (win) {
+        const registry = win[REGISTRY] || (win[REGISTRY] = {});
+        for (const [tag, strings] of packs) registry[tag] = { ...(registry[tag] || {}), ...strings };
+      }
+      return typeof before === 'function' ? before(doc) : undefined;
+    },
+  };
+}
+
+module.exports = {
+  ...hydrate,
+  renderToString(html, options, asStream) {
+    return hydrate.renderToString(html, withLocales(options), asStream);
+  },
+  streamToString(html, options) {
+    return hydrate.streamToString(html, withLocales(options));
+  },
+  hydrateDocument(doc, options, asStream) {
+    return hydrate.hydrateDocument(doc, withLocales(options), asStream);
+  },
+};

package/dist/index.d.cts

@@ -0,0 +1,28 @@
+// The types of @shineuix/ssr. The build writes this file as dist/index.d.mts and dist/index.d.cts,
+// one per export condition, and both read the renderer's declarations from ./hydrate/index.js.
+import type { Readable } from 'node:stream';
+import type { SuiLocaleStrings } from '@shineuix/core';
+import type { HydrateDocumentOptions, HydrateResults, SerializeDocumentOptions } from './hydrate/index.js';
+
+export * from './hydrate/index.js';
+
+/** What `@shineuix/ssr` adds to the renderer's options. */
+export interface SuiRenderOptions {
+  /**
+   * Language packs for this render and no other, keyed by BCP 47 tag: the objects `registerLocale`
+   * takes in a browser, such as the default export of `@shineuix/core/locales/de`. The elements
+   * speak the pack whose tag matches the document's language, which is `<html lang>` or the
+   * renderer's own `language` option; `fr-CA` falls back to `fr`. Renders that run at the same time
+   * each keep their own packs, because each render has a window of its own.
+   */
+  locales?: Record<string, SuiLocaleStrings>;
+}
+
+/** Renders a document or a fragment to HTML with the elements' markup and hydration annotations. */
+export declare function renderToString(html: string | any, options?: SerializeDocumentOptions & SuiRenderOptions): Promise<HydrateResults>;
+export declare function renderToString(html: string | any, options: (SerializeDocumentOptions & SuiRenderOptions) | undefined, asStream: true): Readable;
+/** `renderToString` as a stream. */
+export declare function streamToString(html: string | any, options?: SerializeDocumentOptions & SuiRenderOptions): Readable;
+/** Renders the elements into a document in place, without serializing it unless asked. */
+export declare function hydrateDocument(doc: any | string, options?: HydrateDocumentOptions & SuiRenderOptions): Promise<HydrateResults>;
+export declare function hydrateDocument(doc: any | string, options: (HydrateDocumentOptions & SuiRenderOptions) | undefined, asStream?: boolean): Readable;

package/dist/index.d.mts

@@ -0,0 +1,28 @@
+// The types of @shineuix/ssr. The build writes this file as dist/index.d.mts and dist/index.d.cts,
+// one per export condition, and both read the renderer's declarations from ./hydrate/index.js.
+import type { Readable } from 'node:stream';
+import type { SuiLocaleStrings } from '@shineuix/core';
+import type { HydrateDocumentOptions, HydrateResults, SerializeDocumentOptions } from './hydrate/index.js';
+
+export * from './hydrate/index.js';
+
+/** What `@shineuix/ssr` adds to the renderer's options. */
+export interface SuiRenderOptions {
+  /**
+   * Language packs for this render and no other, keyed by BCP 47 tag: the objects `registerLocale`
+   * takes in a browser, such as the default export of `@shineuix/core/locales/de`. The elements
+   * speak the pack whose tag matches the document's language, which is `<html lang>` or the
+   * renderer's own `language` option; `fr-CA` falls back to `fr`. Renders that run at the same time
+   * each keep their own packs, because each render has a window of its own.
+   */
+  locales?: Record<string, SuiLocaleStrings>;
+}
+
+/** Renders a document or a fragment to HTML with the elements' markup and hydration annotations. */
+export declare function renderToString(html: string | any, options?: SerializeDocumentOptions & SuiRenderOptions): Promise<HydrateResults>;
+export declare function renderToString(html: string | any, options: (SerializeDocumentOptions & SuiRenderOptions) | undefined, asStream: true): Readable;
+/** `renderToString` as a stream. */
+export declare function streamToString(html: string | any, options?: SerializeDocumentOptions & SuiRenderOptions): Readable;
+/** Renders the elements into a document in place, without serializing it unless asked. */
+export declare function hydrateDocument(doc: any | string, options?: HydrateDocumentOptions & SuiRenderOptions): Promise<HydrateResults>;
+export declare function hydrateDocument(doc: any | string, options: (HydrateDocumentOptions & SuiRenderOptions) | undefined, asStream?: boolean): Readable;

package/dist/index.mjs

@@ -0,0 +1,59 @@
+// @shineuix/ssr: Stencil's renderer for the ShineUI elements, plus the language of each render.
+//
+// Stencil runs every render in a window of its own, and the elements' code, language registry
+// included, runs inside that window. So a pack registered in the server's own process never reaches
+// a render, and nothing one render registers can reach another: the language travels with the render's
+// options, and `locales` puts it into that render's window before the elements start.
+import * as hydrate from './hydrate/index.mjs';
+
+export * from './hydrate/index.mjs';
+
+// The key the elements read their language registry from (packages/core/src/utils/locale.ts).
+const REGISTRY = '__suiLocale';
+
+const norm = (tag) => String(tag).trim().toLowerCase();
+
+function packsOf(locales) {
+  if (typeof locales !== 'object' || locales === null || Array.isArray(locales)) {
+    throw new TypeError('@shineuix/ssr: `locales` takes an object of language packs keyed by tag, such as { de } with `import de from "@shineuix/core/locales/de"`.');
+  }
+  const packs = [];
+  for (const [tag, strings] of Object.entries(locales)) {
+    if (!norm(tag)) throw new TypeError('@shineuix/ssr: a key of `locales` is empty; key each pack by its BCP 47 tag.');
+    if (typeof strings !== 'object' || strings === null || Array.isArray(strings)) {
+      throw new TypeError(`@shineuix/ssr: locales["${tag}"] is not a language pack (an object of strings keyed like "dialog.close").`);
+    }
+    packs.push([norm(tag), strings]);
+  }
+  return packs;
+}
+
+function withLocales(options) {
+  if (!options || options.locales == null) return options;
+  const { locales, ...rest } = options;
+  const packs = packsOf(locales);
+  const before = rest.beforeHydrate;
+  return {
+    ...rest,
+    beforeHydrate(doc) {
+      const win = doc && doc.defaultView;
+      if (win) {
+        const registry = win[REGISTRY] || (win[REGISTRY] = {});
+        for (const [tag, strings] of packs) registry[tag] = { ...(registry[tag] || {}), ...strings };
+      }
+      return typeof before === 'function' ? before(doc) : undefined;
+    },
+  };
+}
+
+export function renderToString(html, options, asStream) {
+  return hydrate.renderToString(html, withLocales(options), asStream);
+}
+
+export function streamToString(html, options) {
+  return hydrate.streamToString(html, withLocales(options));
+}
+
+export function hydrateDocument(doc, options, asStream) {
+  return hydrate.hydrateDocument(doc, withLocales(options), asStream);
+}

package/package.json

@@ -1,6 +1,134 @@
 {
   "name": "@shineuix/ssr",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
+  "version": "1.0.1",
+  "description": "Server rendering for ShineUI: a Node renderer and a hydration-capable client build. Install it only if you server-render; @shineuix/core is unchanged without it.",
+  "license": "MIT",
+  "keywords": [
+    "server-rendering",
+    "ssr",
+    "hydration",
+    "web-components",
+    "stencil",
+    "shineui"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "author": "ShineUI contributors",
+  "homepage": "https://shineui.dev",
+  "bugs": {
+    "email": "info@shineui.dev"
+  },
+  "type": "module",
+  "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.cts",
+  "files": [
+    "LICENSE",
+    "THIRD-PARTY-NOTICES.md",
+    "dist/",
+    "!**/*.map"
+  ],
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    },
+    "./components": {
+      "types": "./dist/components/index.d.ts",
+      "import": "./dist/components/index.js",
+      "default": "./dist/components/index.js"
+    },
+    "./components/*": {
+      "types": "./dist/components/*.d.ts",
+      "import": "./dist/components/*.js",
+      "default": "./dist/components/*.js"
+    },
+    "./components/*.js": {
+      "types": "./dist/components/*.d.ts",
+      "import": "./dist/components/*.js",
+      "default": "./dist/components/*.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "typesVersions": {
+    "*": {
+      "components": [
+        "dist/components/index.d.ts"
+      ],
+      "components/*": [
+        "dist/components/*"
+      ]
+    }
+  },
+  "peerDependencies": {
+    "@shineuix/core": "1.0.1",
+    "prosemirror-commands": "^1.7.2",
+    "prosemirror-history": "^1.5.0",
+    "prosemirror-inputrules": "^1.5.1",
+    "prosemirror-keymap": "^1.2.3",
+    "prosemirror-model": "^1.25.11",
+    "prosemirror-schema-basic": "^1.2.4",
+    "prosemirror-schema-list": "^1.5.1",
+    "prosemirror-state": "^1.4.4",
+    "prosemirror-view": "^1.42.3",
+    "qrcode": "^1.5.4",
+    "shiki": "^3.2.1"
+  },
+  "peerDependenciesMeta": {
+    "prosemirror-commands": {
+      "optional": true
+    },
+    "prosemirror-history": {
+      "optional": true
+    },
+    "prosemirror-inputrules": {
+      "optional": true
+    },
+    "prosemirror-keymap": {
+      "optional": true
+    },
+    "prosemirror-model": {
+      "optional": true
+    },
+    "prosemirror-schema-basic": {
+      "optional": true
+    },
+    "prosemirror-schema-list": {
+      "optional": true
+    },
+    "prosemirror-state": {
+      "optional": true
+    },
+    "prosemirror-view": {
+      "optional": true
+    },
+    "qrcode": {
+      "optional": true
+    },
+    "shiki": {
+      "optional": true
+    }
+  },
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@shineuix/core": "1.0.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/smallandsimple/shineui.git",
+    "directory": "packages/ssr"
+  },
+  "scripts": {
+    "build": "corepack pnpm --filter @shineuix/core build:ssr"
+  }
 }