npm - @homepages/template-kit - Versions diffs - 0.3.0 → 0.4.0 - Mend

@homepages/template-kit 0.3.0 → 0.4.0

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 (111) hide show

package/CHANGELOG.md +71 -0
package/README.md +39 -4
package/dist/asset-modules.d.ts +81 -0
package/dist/cli/check/config.js +5 -1
package/dist/cli/check/css.js +27 -13
package/dist/cli/check/loader.js +4 -0
package/dist/cli/check/section-assets.js +58 -0
package/dist/cli/check/stages/size.js +124 -8
package/dist/cli/check/stages/tree.js +26 -27
package/dist/cli/dev/build-css.js +91 -0
package/dist/cli/dev/catalog.js +35 -0
package/dist/cli/dev/compose-template.js +38 -0
package/dist/cli/dev/content-override.js +58 -0
package/dist/cli/dev/discover.js +35 -0
package/dist/cli/dev/fill-state.js +75 -0
package/dist/cli/dev/index.js +32 -0
package/dist/cli/dev/inspect.js +38 -0
package/dist/cli/dev/island-bootstrap.js +38 -0
package/dist/cli/dev/island-map.js +35 -0
package/dist/cli/dev/island-transform.js +31 -0
package/dist/cli/dev/manifest-instances.js +31 -0
package/dist/cli/dev/render-section.js +24 -0
package/dist/cli/dev/screenshot-target.js +24 -0
package/dist/cli/dev/section-page.js +54 -0
package/dist/cli/dev/server.js +480 -0
package/dist/cli/dev/slot-schema.js +12 -0
package/dist/cli/dev/structure-summary.js +118 -0
package/dist/cli/dev/tailwind.js +32 -0
package/dist/cli/dev/vite-server.js +33 -0
package/dist/cli/dev/workspace.js +63 -0
package/dist/cli/link/index.js +74 -0
package/dist/cli/link/overlay.js +59 -0
package/dist/cli/link/watch.js +25 -0
package/dist/cli/new/emit.js +48 -0
package/dist/cli/new/index.js +69 -0
package/dist/cli/new/scaffold/section/_Renderer.tsx +20 -0
package/dist/cli/new/scaffold/section/_fill-spec.ts +18 -0
package/dist/cli/new/scaffold/section/_fixtures.ts +13 -0
package/dist/cli/new/scaffold/section/_schema.ts +24 -0
package/dist/cli/new/scaffold/template/_manifest.json +9 -0
package/dist/cli/new/scaffold/template/sections/hero/ExpandableText.tsx +45 -0
package/dist/cli/new/scaffold/template/sections/hero/Renderer.tsx +40 -0
package/dist/cli/new/scaffold/template/sections/hero/components/Feature.tsx +14 -0
package/dist/cli/new/scaffold/template/sections/hero/fill-spec.ts +29 -0
package/dist/cli/new/scaffold/template/sections/hero/fixtures.ts +41 -0
package/dist/cli/new/scaffold/template/sections/hero/schema.ts +60 -0
package/dist/cli/new/scaffold/template/theme.css +24 -0
package/dist/cli/new/scaffold/template/theme.ts +27 -0
package/dist/cli/new/scaffold-assets.js +20 -0
package/dist/cli/pack/collect.js +44 -0
package/dist/cli/pack/guards.js +57 -0
package/dist/cli/pack/index.js +66 -0
package/dist/cli/pack/manifest.js +15 -0
package/dist/cli/pack/zip.js +86 -0
package/dist/cli.js +80 -14
package/dist/dev-client/assets/index-DfEfrp6P.css +1 -0
package/dist/dev-client/assets/index-bpMP0b0W.js +50 -0
package/dist/dev-client/index.html +13 -0
package/dist/eslint/is-client-file.d.ts +4 -0
package/dist/index.d.ts +1 -0
package/dist/islands/detect.d.ts +16 -0
package/dist/islands/detect.js +22 -0
package/dist/islands/discover.d.ts +5 -0
package/dist/islands/discover.js +19 -0
package/dist/islands/esbuild-plugin.d.ts +13 -0
package/dist/islands/esbuild-plugin.js +39 -0
package/dist/islands/wrap.d.ts +11 -0
package/dist/islands/wrap.js +48 -0
package/dist/node_modules/@jridgewell/sourcemap-codec/dist/sourcemap-codec.js +77 -0
package/dist/node_modules/magic-string/dist/magic-string.es.js +939 -0
package/dist/package.js +1 -1
package/dist/ssr.d.ts +31 -0
package/dist/ssr.js +46 -0
package/docs/INDEX.md +9 -1
package/docs/assets.md +128 -0
package/docs/check.md +6 -3
package/docs/dev.md +187 -0
package/docs/islands.md +5 -2
package/docs/llms.txt +41 -3
package/docs/new.md +27 -0
package/docs/overview.md +57 -0
package/docs/pack.md +46 -0
package/docs/primitives.md +5 -6
package/docs/quickstart.md +102 -0
package/docs/recipes/INDEX.md +27 -0
package/docs/recipes/bind-property-fact.md +58 -0
package/docs/recipes/collection-slot.md +100 -0
package/docs/recipes/fill-spec-decision.md +66 -0
package/docs/recipes/fixture-states.md +68 -0
package/docs/recipes/image-slot-crop.md +98 -0
package/docs/recipes/interactive-island.md +100 -0
package/docs/recipes/organize-section-folder.md +72 -0
package/docs/recipes/prepare-submission.md +55 -0
package/docs/recipes/second-template.md +49 -0
package/docs/recipes/select-slot.md +59 -0
package/docs/recipes/static-asset.md +103 -0
package/docs/recipes/third-party-package.md +90 -0
package/docs/rules/INDEX.md +4 -2
package/docs/rules/bundle-binary-asset.md +33 -52
package/docs/rules/bundle-incomplete.md +2 -2
package/docs/rules/css-reason.md +3 -3
package/docs/rules/no-bare-css-import.md +8 -8
package/docs/rules/no-css-import-from-render-path.md +7 -8
package/docs/rules/size-assets.md +88 -0
package/docs/rules/size-island-bundle.md +123 -0
package/docs/rules/size-section-css.md +19 -14
package/docs/schema-system.md +28 -28
package/docs/theme-and-css.md +2 -2
package/docs/vocabulary.md +98 -0
package/package.json +11 -3
package/tsconfig.json +1 -1

package/dist/dev-client/index.html ADDED Viewed

@@ -0,0 +1,13 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <meta name="viewport" content="width=device-width, initial-scale=1" />
+    <title>template-kit dev</title>
+    <script type="module" crossorigin src="/dev-client/assets/index-bpMP0b0W.js"></script>
+    <link rel="stylesheet" crossorigin href="/dev-client/assets/index-DfEfrp6P.css">
+  </head>
+  <body>
+    <div id="root"></div>
+  </body>
+</html>

package/dist/eslint/is-client-file.d.ts ADDED Viewed

@@ -0,0 +1,4 @@
+//#region src/eslint/is-client-file.d.ts
+declare function hasClientDirective(text: string): boolean;
+//#endregion
+export { hasClientDirective };

package/dist/index.d.ts CHANGED Viewed

@@ -1,5 +1,6 @@
 import { ResponsiveImage, ResponsiveSource } from "./contracts/image-descriptor.js";
 import { Coordinates, FloorplanAssignment, PropertyFacts, UnitRow } from "./schema/property-facts.js";
+import "./asset-modules.js";
 import { COLLECTIONS, CONTENT_SLOT_TYPES, CollectionField, CollectionIdKey, CollectionOwnership, ContentSlotType, DECISION_TYPES, DERIVED_INPUT_FIELDS, DecisionType, DerivedInputName, FORMATTER_NAMES, FormatterName, REFERRAL_FIELDS, REFERRAL_IMAGE_FIELDS, REF_SLOT_TYPES, RefSlotType, ReferralField, ReferralImageField, SLOT_TYPES, SOURCE_FIELDS, SlotType, SourceFieldContainer, SourceFieldDescriptor, SourceFieldName, SourceFieldValueType, WritebackTarget, collectionForSlot } from "./contracts/slot-catalog.js";
 import { AddressParts, TRANSFORMS, TRANSFORM_NAMES, TransformDescriptor, TransformFn, TransformInput, TransformName, TransformUnit } from "./contracts/transforms.js";
 import { VariantSelectorFn, VariantsMeta, makeResolveVariants } from "./schema/resolve-variants.js";

package/dist/islands/detect.d.ts ADDED Viewed

@@ -0,0 +1,16 @@
+import { hasClientDirective } from "../eslint/is-client-file.js";
+//#region src/islands/detect.d.ts
+/**
+ * True iff `file` is a client component — an on-disk source file whose directive
+ * prologue is `"use client"`. Returns false for an unreadable or absent path.
+ */
+declare function isClientComponentFile(file: string): boolean;
+/**
+ * Compose an island key: `<sectionKey>:<componentName>` (e.g.
+ * `spw-essential/floorplan:UnitFilter`). The key is what a marker in the DOM
+ * carries and what the browser loader resolves the client module by, so the
+ * emitter and the loader must derive it identically.
+ */
+declare function islandKey(sectionKey: string, componentName: string): string;
+//#endregion
+export { hasClientDirective, isClientComponentFile, islandKey };

package/dist/islands/detect.js ADDED Viewed

@@ -0,0 +1,22 @@
+import { hasClientDirective, isClientFile } from "../eslint/is-client-file.js";
+//#region src/islands/detect.ts
+/**
+* True iff `file` is a client component — an on-disk source file whose directive
+* prologue is `"use client"`. Returns false for an unreadable or absent path.
+*/
+function isClientComponentFile(file) {
+	return isClientFile(file);
+}
+/**
+* Compose an island key: `<sectionKey>:<componentName>` (e.g.
+* `spw-essential/floorplan:UnitFilter`). The key is what a marker in the DOM
+* carries and what the browser loader resolves the client module by, so the
+* emitter and the loader must derive it identically.
+*/
+function islandKey(sectionKey, componentName) {
+	return `${sectionKey}:${componentName}`;
+}
+//#endregion
+export { hasClientDirective, isClientComponentFile, islandKey };

package/dist/islands/discover.d.ts ADDED Viewed

@@ -0,0 +1,5 @@
+//#region src/islands/discover.d.ts
+/** Every `"use client"` component file anywhere under a section directory (recursive). */
+declare function findSectionIslands(sectionDir: string): Promise<string[]>;
+//#endregion
+export { findSectionIslands };

package/dist/islands/discover.js ADDED Viewed

@@ -0,0 +1,19 @@
+import { isClientComponentFile } from "./detect.js";
+import { extname, join } from "node:path";
+import { readdir } from "node:fs/promises";
+//#region src/islands/discover.ts
+const COMPONENT_EXTS = /* @__PURE__ */ new Set([".tsx", ".jsx"]);
+/** Every `"use client"` component file anywhere under a section directory (recursive). */
+async function findSectionIslands(sectionDir) {
+	const out = [];
+	for (const entry of await readdir(sectionDir, { withFileTypes: true })) {
+		const full = join(sectionDir, entry.name);
+		if (entry.isDirectory()) out.push(...await findSectionIslands(full));
+		else if (COMPONENT_EXTS.has(extname(entry.name)) && isClientComponentFile(full)) out.push(full);
+	}
+	return out;
+}
+//#endregion
+export { findSectionIslands };

package/dist/islands/esbuild-plugin.d.ts ADDED Viewed

@@ -0,0 +1,13 @@
+import { Plugin } from "esbuild";
+//#region src/islands/esbuild-plugin.d.ts
+/**
+ * Wrap every `"use client"` `.tsx`/`.jsx` in the build graph so it renders through
+ * `IslandMarker`, keyed `islandKey(sectionKey, <file-basename>)`. `sectionKey` is
+ * fixed per bundle (one section per renderer build). Non-client modules and other
+ * extensions fall through to esbuild untouched.
+ */
+declare function islandTransformEsbuildPlugin(opts: {
+  sectionKey: string;
+}): Plugin;
+//#endregion
+export { islandTransformEsbuildPlugin };

package/dist/islands/esbuild-plugin.js ADDED Viewed

@@ -0,0 +1,39 @@
+import { islandKey } from "./detect.js";
+import { wrapClientModuleSource } from "./wrap.js";
+import { basename, extname } from "node:path";
+import { readFile } from "node:fs/promises";
+//#region src/islands/esbuild-plugin.ts
+const LOADER = {
+	".tsx": "tsx",
+	".jsx": "jsx"
+};
+/**
+* Wrap every `"use client"` `.tsx`/`.jsx` in the build graph so it renders through
+* `IslandMarker`, keyed `islandKey(sectionKey, <file-basename>)`. `sectionKey` is
+* fixed per bundle (one section per renderer build). Non-client modules and other
+* extensions fall through to esbuild untouched.
+*/
+function islandTransformEsbuildPlugin(opts) {
+	return {
+		name: "template-kit:island-transform-esbuild",
+		setup(b) {
+			b.onLoad({ filter: /\.(tsx|jsx)$/ }, async (args) => {
+				const code = await readFile(args.path, "utf8");
+				const wrapped = wrapClientModuleSource(code, islandKey(opts.sectionKey, basename(args.path, extname(args.path))));
+				const ext = extname(args.path);
+				if (wrapped === null) return {
+					contents: code,
+					loader: LOADER[ext]
+				};
+				return {
+					contents: wrapped,
+					loader: LOADER[ext]
+				};
+			});
+		}
+	};
+}
+//#endregion
+export { islandTransformEsbuildPlugin };

package/dist/islands/wrap.d.ts ADDED Viewed

@@ -0,0 +1,11 @@
+//#region src/islands/wrap.d.ts
+/**
+ * Rewrite a client module's source so its default export renders through
+ * `IslandMarker` with `islandKey`. Returns null when `code` is not a client
+ * component (`hasClientDirective` false) or has no default export — the caller
+ * then leaves the module untouched. The rebound original is `__trIslandReal`;
+ * it still flows through the consumer's JSX/TS transform unchanged.
+ */
+declare function wrapClientModuleSource(code: string, islandKey: string): string | null;
+//#endregion
+export { wrapClientModuleSource };

package/dist/islands/wrap.js ADDED Viewed

@@ -0,0 +1,48 @@
+import { hasClientDirective } from "../eslint/is-client-file.js";
+import MagicString from "../node_modules/magic-string/dist/magic-string.es.js";
+//#region src/islands/wrap.ts
+const DEFAULT_EXPORT = /export\s+default\s+/;
+/**
+* The codemod as a `MagicString`, so a caller (the Vite plugin) can emit a
+* hi-res sourcemap alongside the rewritten code. Returns null on the same terms
+* as `wrapClientModuleSource` — a non-client module or one with no default
+* export. The rebound original is `__trIslandReal`; it still flows through the
+* consumer's JSX/TS transform unchanged.
+*/
+function wrapClientModuleMagic(code, islandKey) {
+	if (!hasClientDirective(code)) return null;
+	if (!DEFAULT_EXPORT.test(code)) return null;
+	const s = new MagicString(code);
+	s.replace(DEFAULT_EXPORT, "const __trIslandReal = ");
+	s.append(wrapperSource(islandKey));
+	return s;
+}
+/**
+* Rewrite a client module's source so its default export renders through
+* `IslandMarker` with `islandKey`. Returns null when `code` is not a client
+* component (`hasClientDirective` false) or has no default export — the caller
+* then leaves the module untouched. The rebound original is `__trIslandReal`;
+* it still flows through the consumer's JSX/TS transform unchanged.
+*/
+function wrapClientModuleSource(code, islandKey) {
+	return wrapClientModuleMagic(code, islandKey)?.toString() ?? null;
+}
+function wrapperSource(islandKey) {
+	return `
+;
+import { createElement as __trCreateElement, useId as __trUseId } from "react";
+import { IslandMarker as __TrIslandMarker } from "@homepages/template-kit";
+export default function __trIslandWrapper(__trProps) {
+  const __trIslandId = __trUseId();
+  return __trCreateElement(
+    __TrIslandMarker,
+    { islandKey: ${JSON.stringify(islandKey)}, islandId: __trIslandId, props: __trProps },
+    __trCreateElement(__trIslandReal, __trProps),
+  );
+}
+`;
+}
+//#endregion
+export { wrapClientModuleMagic, wrapClientModuleSource };

package/dist/node_modules/@jridgewell/sourcemap-codec/dist/sourcemap-codec.js ADDED Viewed

@@ -0,0 +1,77 @@
+//#region node_modules/@jridgewell/sourcemap-codec/dist/sourcemap-codec.mjs
+var comma = ",".charCodeAt(0);
+var semicolon = ";".charCodeAt(0);
+var chars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
+var intToChar = /* @__PURE__ */ new Uint8Array(64);
+var charToInt = /* @__PURE__ */ new Uint8Array(128);
+for (let i = 0; i < chars.length; i++) {
+	const c = chars.charCodeAt(i);
+	intToChar[i] = c;
+	charToInt[c] = i;
+}
+function encodeInteger(builder, num, relative) {
+	let delta = num - relative;
+	delta = delta < 0 ? -delta << 1 | 1 : delta << 1;
+	do {
+		let clamped = delta & 31;
+		delta >>>= 5;
+		if (delta > 0) clamped |= 32;
+		builder.write(intToChar[clamped]);
+	} while (delta > 0);
+	return num;
+}
+var bufLength = 1024 * 16;
+var td = typeof TextDecoder !== "undefined" ? /* @__PURE__ */ new TextDecoder() : typeof Buffer !== "undefined" ? { decode(buf) {
+	return Buffer.from(buf.buffer, buf.byteOffset, buf.byteLength).toString();
+} } : { decode(buf) {
+	let out = "";
+	for (let i = 0; i < buf.length; i++) out += String.fromCharCode(buf[i]);
+	return out;
+} };
+var StringWriter = class {
+	constructor() {
+		this.pos = 0;
+		this.out = "";
+		this.buffer = new Uint8Array(bufLength);
+	}
+	write(v) {
+		const { buffer } = this;
+		buffer[this.pos++] = v;
+		if (this.pos === bufLength) {
+			this.out += td.decode(buffer);
+			this.pos = 0;
+		}
+	}
+	flush() {
+		const { buffer, out, pos } = this;
+		return pos > 0 ? out + td.decode(buffer.subarray(0, pos)) : out;
+	}
+};
+function encode(decoded) {
+	const writer = new StringWriter();
+	let sourcesIndex = 0;
+	let sourceLine = 0;
+	let sourceColumn = 0;
+	let namesIndex = 0;
+	for (let i = 0; i < decoded.length; i++) {
+		const line = decoded[i];
+		if (i > 0) writer.write(semicolon);
+		if (line.length === 0) continue;
+		let genColumn = 0;
+		for (let j = 0; j < line.length; j++) {
+			const segment = line[j];
+			if (j > 0) writer.write(comma);
+			genColumn = encodeInteger(writer, segment[0], genColumn);
+			if (segment.length === 1) continue;
+			sourcesIndex = encodeInteger(writer, segment[1], sourcesIndex);
+			sourceLine = encodeInteger(writer, segment[2], sourceLine);
+			sourceColumn = encodeInteger(writer, segment[3], sourceColumn);
+			if (segment.length === 4) continue;
+			namesIndex = encodeInteger(writer, segment[4], namesIndex);
+		}
+	}
+	return writer.flush();
+}
+//#endregion
+export { encode };