@allejo/decap-extras 0.0.1 → 0.0.2

package/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: Publish Package
+
+on:
+  push:
+    tags:
+      - 'v*'
+
+permissions:
+  id-token: write # Required for OIDC
+  contents: read
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v6
+
+      - uses: actions/setup-node@v6
+        with:
+          node-version: '24'
+          registry-url: 'https://registry.npmjs.org'
+          package-manager-cache: false
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test
+      - run: npm publish

package/README.md

@@ -250,6 +250,49 @@ function getPageProps<F extends PageName>(
 
 ---
 
+## Server utilities
+
+A server-side utility for getting CSS from Next.js build manifests. This is useful for registering CSS stylesheets into Decap's CMS preview system.
+
+```ts
+import { getCssFilesFromManifest } from '@allejo/decap-extras/server';
+```
+
+Use `getCssFilesFromManifest` in `getStaticProps` to collect the CSS paths needed by your page and pass them as props:
+
+```ts
+export async function getStaticProps() {
+	const cssFiles = getCssFilesFromManifest(process.env.NODE_ENV, [
+		'/',
+		'/_app',
+	]);
+
+	return {
+		props: {
+			cssFiles: cssFiles['flattenedCssFiles'],
+		},
+	};
+}
+```
+
+Then register each path as a preview stylesheet in your Decap CMS admin component:
+
+```ts
+export default function Admin({ cssFiles }: Props) {
+	// ...
+
+	cssFiles.forEach((css) => {
+		cms.registerPreviewStyle(css);
+	});
+}
+```
+
+> **Note:** This utility reads `.next/build-manifest.json` (or `.next/dev/build-manifest.json` in development) and is intended for Next.js projects only.
+
+---
+
+## API reference
+
 ### Widget functions
 
 | Function                                     | Decap widget                                                   | TypeScript type           |
@@ -283,6 +326,12 @@ function getPageProps<F extends PageName>(
 | `OptionalWidget<T>`                       | Brands a `CmsField` as optional (added by `optional()`).                             |
 | `WidgetOpts<T>`                           | The options type for a given widget field type, with `widget` and `fields` stripped. |
 
+### Server utilities
+
+| Function                              | Description                                                                                                                                                              |
+| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `getCssFilesFromManifest(env, pages)` | Reads the Next.js build manifest and returns CSS paths for the given page routes, grouped by page (`allCssFiles`) and as a deduplicated flat list (`flattenedCssFiles`). |
+
 ## License
 
 MIT

package/dist/server.d.mts

@@ -0,0 +1,27 @@
+//#region src/server.d.ts
+/**
+ * Reads the Next.js build manifest and extracts CSS file paths for the given
+ * pages, resolving the manifest location based on the current environment.
+ *
+ * In development, reads from `.next/dev/build-manifest.json`; in all other
+ * environments, reads from `.next/build-manifest.json`.
+ *
+ * CSS paths are rewritten from the `static/` prefix used internally by Next.js
+ * to the `/_next/static/` public URL path.
+ *
+ * @param env - The current environment (e.g. `"development"` or `"production"`).
+ * @param pages - List of Next.js page routes to extract CSS files for
+ *   (e.g. `["/", "/_app"]`).
+ *
+ * @returns An object with two properties:
+ *   - `allCssFiles` — a map of page route to its CSS file paths.
+ *   - `flattenedCssFiles` — a deduplicated flat list of all CSS file paths
+ *     across every requested page.
+ */
+declare function getCssFilesFromManifest(env: string, pages: string[]): {
+  flattenedCssFiles: string[];
+  allCssFiles: Record<string, string[]>;
+};
+//#endregion
+export { getCssFilesFromManifest };
+//# sourceMappingURL=server.d.mts.map

package/dist/server.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.d.mts","names":[],"sources":["../src/server.ts"],"mappings":";;AAsBA;;;;;;;;;;;;;;;;;;iBAAgB,uBAAA,CAAwB,GAAA,UAAa,KAAA;;eAAd,MAAA;AAAA"}

package/dist/server.mjs

@@ -0,0 +1,45 @@
+import fs from "node:fs";
+import path from "node:path";
+
+//#region src/server.ts
+/**
+* Reads the Next.js build manifest and extracts CSS file paths for the given
+* pages, resolving the manifest location based on the current environment.
+*
+* In development, reads from `.next/dev/build-manifest.json`; in all other
+* environments, reads from `.next/build-manifest.json`.
+*
+* CSS paths are rewritten from the `static/` prefix used internally by Next.js
+* to the `/_next/static/` public URL path.
+*
+* @param env - The current environment (e.g. `"development"` or `"production"`).
+* @param pages - List of Next.js page routes to extract CSS files for
+*   (e.g. `["/", "/_app"]`).
+*
+* @returns An object with two properties:
+*   - `allCssFiles` — a map of page route to its CSS file paths.
+*   - `flattenedCssFiles` — a deduplicated flat list of all CSS file paths
+*     across every requested page.
+*/
+function getCssFilesFromManifest(env, pages) {
+	const manifestPath = env === "development" ? path.join(process.cwd(), ".next", "dev", "build-manifest.json") : path.join(process.cwd(), ".next", "build-manifest.json");
+	const buildManifest = JSON.parse(fs.readFileSync(manifestPath, "utf8"));
+	const allCssFiles = {};
+	const flattenedCssFilesSet = /* @__PURE__ */ new Set();
+	pages.forEach((page) => {
+		buildManifest?.pages[page].filter((file) => file.endsWith(".css")).forEach((file) => {
+			if (!allCssFiles[page]) allCssFiles[page] = [];
+			const fullPath = file.replace("static/", "/_next/static/");
+			allCssFiles[page].push(fullPath);
+			flattenedCssFilesSet.add(fullPath);
+		});
+	});
+	return {
+		flattenedCssFiles: [...flattenedCssFilesSet],
+		allCssFiles
+	};
+}
+
+//#endregion
+export { getCssFilesFromManifest };
+//# sourceMappingURL=server.mjs.map

package/dist/server.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"server.mjs","names":[],"sources":["../src/server.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\n/**\n * Reads the Next.js build manifest and extracts CSS file paths for the given\n * pages, resolving the manifest location based on the current environment.\n *\n * In development, reads from `.next/dev/build-manifest.json`; in all other\n * environments, reads from `.next/build-manifest.json`.\n *\n * CSS paths are rewritten from the `static/` prefix used internally by Next.js\n * to the `/_next/static/` public URL path.\n *\n * @param env - The current environment (e.g. `\"development\"` or `\"production\"`).\n * @param pages - List of Next.js page routes to extract CSS files for\n *   (e.g. `[\"/\", \"/_app\"]`).\n *\n * @returns An object with two properties:\n *   - `allCssFiles` — a map of page route to its CSS file paths.\n *   - `flattenedCssFiles` — a deduplicated flat list of all CSS file paths\n *     across every requested page.\n */\nexport function getCssFilesFromManifest(env: string, pages: string[]) {\n\tconst manifestPath =\n\t\tenv === 'development'\n\t\t\t? path.join(process.cwd(), '.next', 'dev', 'build-manifest.json')\n\t\t\t: path.join(process.cwd(), '.next', 'build-manifest.json');\n\tconst buildManifest = JSON.parse(fs.readFileSync(manifestPath, 'utf8'));\n\n\tconst allCssFiles: Record<string, string[]> = {};\n\tconst flattenedCssFilesSet = new Set<string>();\n\n\tpages.forEach((page) => {\n\t\tbuildManifest?.pages[page]\n\t\t\t.filter((file: string) => file.endsWith('.css'))\n\t\t\t.forEach((file: string) => {\n\t\t\t\tif (!allCssFiles[page]) {\n\t\t\t\t\tallCssFiles[page] = [];\n\t\t\t\t}\n\n\t\t\t\tconst fullPath = file.replace('static/', '/_next/static/');\n\n\t\t\t\tallCssFiles[page].push(fullPath);\n\t\t\t\tflattenedCssFilesSet.add(fullPath);\n\t\t\t});\n\t});\n\n\treturn {\n\t\tflattenedCssFiles: [...flattenedCssFilesSet],\n\t\tallCssFiles,\n\t};\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;AAsBA,SAAgB,wBAAwB,KAAa,OAAiB;CACrE,MAAM,eACL,QAAQ,gBACL,KAAK,KAAK,QAAQ,IAAI,GAAG,SAAS,OAAO,qBAAqB,IAC9D,KAAK,KAAK,QAAQ,IAAI,GAAG,SAAS,qBAAqB;CAC3D,MAAM,gBAAgB,KAAK,MAAM,GAAG,aAAa,cAAc,MAAM,CAAC;CAEtE,MAAM,cAAwC,CAAC;CAC/C,MAAM,uCAAuB,IAAI,IAAY;CAE7C,MAAM,SAAS,SAAS;EACvB,eAAe,MAAM,MACnB,QAAQ,SAAiB,KAAK,SAAS,MAAM,CAAC,EAC9C,SAAS,SAAiB;GAC1B,IAAI,CAAC,YAAY,OAChB,YAAY,QAAQ,CAAC;GAGtB,MAAM,WAAW,KAAK,QAAQ,WAAW,gBAAgB;GAEzD,YAAY,MAAM,KAAK,QAAQ;GAC/B,qBAAqB,IAAI,QAAQ;EAClC,CAAC;CACH,CAAC;CAED,OAAO;EACN,mBAAmB,CAAC,GAAG,oBAAoB;EAC3C;CACD;AACD"}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@allejo/decap-extras",
-	"version": "0.0.1",
+	"version": "0.0.2",
 	"description": "A TypeScript utility library for Decap CMS with utility types to derive types from Decap CMS configuration files.",
 	"keywords": [
 		"decapcms"
@@ -12,8 +12,16 @@
 	"license": "MIT",
 	"author": "Vladimir \"allejo\" Jimenez",
 	"type": "module",
-	"main": "./dist/index.mjs",
-	"types": "./dist/index.d.mts",
+	"exports": {
+		".": {
+			"types": "./dist/index.d.mts",
+			"import": "./dist/index.mjs"
+		},
+		"./server": {
+			"types": "./dist/server.d.mts",
+			"import": "./dist/server.mjs"
+		}
+	},
 	"scripts": {
 		"build": "tsdown",
 		"format": "prettier --write .",